1<?php
2// THIS FILE IS GENERATED
3// WARNING! All changes made in this file will be lost!
4
5/**
6 * The number of arguments passed to script
7 **/
8$argc = array();
9
10/**
11 * Array of arguments passed to script
12 **/
13$argv = array();
14
15/**
16 * References all variables available in global scope
17 *
18 * @superglobal
19 **/
20$GLOBALS = array();
21
22/**
23 * HTTP Cookies
24 *
25 * @deprecated
26 **/
27$HTTP_COOKIE_VARS = array();
28
29/**
30 * Environment variables
31 *
32 * @deprecated
33 **/
34$HTTP_ENV_VARS = array();
35
36/**
37 * HTTP GET variables
38 *
39 * @deprecated
40 **/
41$HTTP_GET_VARS = array();
42
43/**
44 * HTTP File Upload variables
45 *
46 * @deprecated
47 **/
48$HTTP_POST_FILES = array();
49
50/**
51 * HTTP POST variables
52 *
53 * @deprecated
54 **/
55$HTTP_POST_VARS = array();
56
57/**
58 * Raw POST data
59 **/
60$HTTP_RAW_POST_DATA = array();
61
62/**
63 * HTTP response headers
64 **/
65$http_response_header = array();
66
67/**
68 * Session variables
69 *
70 * @deprecated
71 **/
72$HTTP_SESSION_VARS = array();
73
74/**
75 * The previous error message
76 **/
77$php_errormsg = array();
78
79/**
80 * HTTP Cookies
81 *
82 * @superglobal
83 **/
84$_COOKIE = array();
85
86/**
87 * Environment variables
88 *
89 * @superglobal
90 **/
91$_ENV = array();
92
93/**
94 * HTTP File Upload variables
95 *
96 * @superglobal
97 **/
98$_FILES = array();
99
100/**
101 * HTTP GET variables
102 *
103 * @superglobal
104 **/
105$_GET = array();
106
107/**
108 * HTTP POST variables
109 *
110 * @superglobal
111 **/
112$_POST = array();
113
114/**
115 * HTTP Request variables
116 *
117 * @superglobal
118 **/
119$_REQUEST = array();
120
121/**
122 * Server and execution environment information
123 *
124 * @superglobal
125 **/
126$_SERVER = array();
127
128/**
129 * Session variables
130 *
131 * @superglobal
132 **/
133$_SESSION = array();
134
135/**
136 * Interface to detect if a class is traversable using . Abstract base
137 * interface that cannot be implemented alone. Instead it must be
138 * implemented by either IteratorAggregate or Iterator. This interface
139 * has no methods, its only purpose is to be the base interface for all
140 * traversable classes.
141 **/
142interface Traversable {
143}
144/**
145 * Interface for external iterators or objects that can be iterated
146 * themselves internally. PHP already provides a number of iterators for
147 * many day to day tasks. See SPL iterators for a list.
148 **/
149interface Iterator extends Traversable {
150    /**
151     * Return the current element
152     *
153     * Returns the current element.
154     *
155     * @return mixed Can return any type.
156     * @since PHP 5, PHP 7
157     **/
158    public function current();
159
160    /**
161     * Return the key of the current element
162     *
163     * Returns the key of the current element.
164     *
165     * @return scalar Returns scalar on success, or NULL on failure.
166     * @since PHP 5, PHP 7
167     **/
168    public function key();
169
170    /**
171     * Move forward to next element
172     *
173     * Moves the current position to the next element.
174     *
175     * @return void Any returned value is ignored.
176     * @since PHP 5, PHP 7
177     **/
178    public function next();
179
180    /**
181     * Rewind the Iterator to the first element
182     *
183     * Rewinds back to the first element of the Iterator.
184     *
185     * @return void Any returned value is ignored.
186     * @since PHP 5, PHP 7
187     **/
188    public function rewind();
189
190    /**
191     * Checks if current position is valid
192     *
193     * This method is called after Iterator::rewind and Iterator::next to
194     * check if the current position is valid.
195     *
196     * @return bool The return value will be casted to boolean and then
197     *   evaluated.
198     * @since PHP 5, PHP 7
199     **/
200    public function valid();
201
202}
203/**
204 * Throwable is the base interface for any object that can be thrown via
205 * a statement in PHP 7, including Error and Exception.
206 **/
207interface Throwable {
208    /**
209     * Gets the exception code
210     *
211     * Returns the error code associated with the thrown object.
212     *
213     * @return int Returns the exception code as integer in Exception but
214     *   possibly as other type in Exception descendants (for example as
215     *   string in PDOException).
216     * @since PHP 7
217     **/
218    public function getCode();
219
220    /**
221     * Gets the file in which the object was created
222     *
223     * Get the name of the file in which the thrown object was created.
224     *
225     * @return string Returns the filename in which the thrown object was
226     *   created.
227     * @since PHP 7
228     **/
229    public function getFile();
230
231    /**
232     * Gets the line on which the object was instantiated
233     *
234     * Returns the line number where the thrown object was instantiated.
235     *
236     * @return int Returns the line number where the thrown object was
237     *   instantiated.
238     * @since PHP 7
239     **/
240    public function getLine();
241
242    /**
243     * Gets the message
244     *
245     * Returns the message associated with the thrown object.
246     *
247     * @return string Returns the message associated with the thrown
248     *   object.
249     * @since PHP 7
250     **/
251    public function getMessage();
252
253    /**
254     * Returns the previous Throwable
255     *
256     * Returns any previous Throwable (for example, one provided as the third
257     * parameter to Exception::__construct).
258     *
259     * @return Throwable Returns the previous Throwable if available, or
260     *   NULL otherwise.
261     * @since PHP 7
262     **/
263    public function getPrevious();
264
265    /**
266     * Gets the stack trace
267     *
268     * Returns the stack trace as an array.
269     *
270     * @return array Returns the stack trace as an array in the same format
271     *   as {@link debug_backtrace}.
272     * @since PHP 7
273     **/
274    public function getTrace();
275
276    /**
277     * Gets the stack trace as a string
278     *
279     * @return string Returns the stack trace as a string.
280     * @since PHP 7
281     **/
282    public function getTraceAsString();
283
284    /**
285     * Gets a string representation of the thrown object
286     *
287     * @return string Returns the string representation of the thrown
288     *   object.
289     * @since PHP 7
290     **/
291    public function __toString();
292
293}
294/**
295 * Error is the base class for all internal PHP errors.
296 **/
297class Error implements Throwable {
298    /**
299     * The error code
300     *
301     * @var int
302     **/
303    protected $code;
304
305    /**
306     * The filename where the error happened
307     *
308     * @var string
309     **/
310    protected $file;
311
312    /**
313     * The line where the error happened
314     *
315     * @var int
316     **/
317    protected $line;
318
319    /**
320     * The error message
321     *
322     * @var string
323     **/
324    protected $message;
325
326    /**
327     * Gets the error code
328     *
329     * Returns the error code.
330     *
331     * @return mixed Returns the error code as integer
332     **/
333    final public function getCode(){}
334
335    /**
336     * Gets the file in which the error occurred
337     *
338     * Get the name of the file the error occurred.
339     *
340     * @return string Returns the filename in which the error occurred.
341     **/
342    final public function getFile(){}
343
344    /**
345     * Gets the line in which the error occurred
346     *
347     * Get line number where the error occurred.
348     *
349     * @return int Returns the line number where the error occurred.
350     **/
351    final public function getLine(){}
352
353    /**
354     * Gets the error message
355     *
356     * Returns the error message.
357     *
358     * @return string Returns the error message as a string.
359     **/
360    final public function getMessage(){}
361
362    /**
363     * Returns previous Throwable
364     *
365     * Returns previous Throwable (the third parameter of
366     * Error::__construct).
367     *
368     * @return Throwable Returns the previous Throwable if available or
369     *   NULL otherwise.
370     **/
371    final public function getPrevious(){}
372
373    /**
374     * Gets the stack trace
375     *
376     * Returns the stack trace.
377     *
378     * @return array Returns the stack trace as an array.
379     **/
380    final public function getTrace(){}
381
382    /**
383     * Gets the stack trace as a string
384     *
385     * Returns the stack trace as a string.
386     *
387     * @return string Returns the stack trace as a string.
388     **/
389    final public function getTraceAsString(){}
390
391    /**
392     * Clone the error
393     *
394     * Error can not be cloned, so this method results in fatal error.
395     *
396     * @return void
397     **/
398    final private function __clone(){}
399
400    /**
401     * String representation of the error
402     *
403     * Returns the string representation of the error.
404     *
405     * @return string Returns the string representation of the error.
406     **/
407    public function __toString(){}
408
409}
410/**
411 * Exception is the base class for all Exceptions in PHP 5, and the base
412 * class for all user exceptions in PHP 7. Before PHP 7, Exception did
413 * not implement the Throwable interface.
414 **/
415class Exception implements Throwable {
416    /**
417     * The exception code
418     *
419     * @var int
420     **/
421    protected $code;
422
423    /**
424     * The filename where the exception was created
425     *
426     * @var string
427     **/
428    protected $file;
429
430    /**
431     * The line where the exception was created
432     *
433     * @var int
434     **/
435    protected $line;
436
437    /**
438     * The exception message
439     *
440     * @var string
441     **/
442    protected $message;
443
444    /**
445     * Gets the Exception code
446     *
447     * Returns the Exception code.
448     *
449     * @return mixed Returns the exception code as integer in Exception but
450     *   possibly as other type in Exception descendants (for example as
451     *   string in PDOException).
452     * @since PHP 5, PHP 7
453     **/
454    final public function getCode(){}
455
456    /**
457     * Gets the file in which the exception was created
458     *
459     * Get the name of the file in which the exception was created.
460     *
461     * @return string Returns the filename in which the exception was
462     *   created.
463     * @since PHP 5, PHP 7
464     **/
465    final public function getFile(){}
466
467    /**
468     * Gets the line in which the exception was created
469     *
470     * Get line number where the exception was created.
471     *
472     * @return int Returns the line number where the exception was created.
473     * @since PHP 5, PHP 7
474     **/
475    final public function getLine(){}
476
477    /**
478     * Gets the Exception message
479     *
480     * Returns the Exception message.
481     *
482     * @return string Returns the Exception message as a string.
483     * @since PHP 5, PHP 7
484     **/
485    final public function getMessage(){}
486
487    /**
488     * Returns previous Exception
489     *
490     * Returns previous exception (the third parameter of
491     * Exception::__construct).
492     *
493     * @return Throwable Returns the previous Throwable if available or
494     *   NULL otherwise.
495     * @since PHP 5 >= 5.3.0, PHP 7
496     **/
497    final public function getPrevious(){}
498
499    /**
500     * Gets the stack trace
501     *
502     * Returns the Exception stack trace.
503     *
504     * @return array Returns the Exception stack trace as an array.
505     * @since PHP 5, PHP 7
506     **/
507    final public function getTrace(){}
508
509    /**
510     * Gets the stack trace as a string
511     *
512     * Returns the Exception stack trace as a string.
513     *
514     * @return string Returns the Exception stack trace as a string.
515     * @since PHP 5, PHP 7
516     **/
517    final public function getTraceAsString(){}
518
519    /**
520     * Clone the exception
521     *
522     * Tries to clone the Exception, which results in Fatal error.
523     *
524     * @return void
525     * @since PHP 5, PHP 7
526     **/
527    final private function __clone(){}
528
529    /**
530     * String representation of the exception
531     *
532     * Returns the string representation of the exception.
533     *
534     * @return string Returns the string representation of the exception.
535     * @since PHP 5, PHP 7
536     **/
537    public function __toString(){}
538
539}
540/**
541 * The APCIterator class makes it easier to iterate over large APC
542 * caches. This is helpful as it allows iterating over large caches in
543 * steps, while grabbing a defined number of entries per lock instance,
544 * so it frees the cache locks for other activities rather than hold up
545 * the entire cache to grab 100 (the default) entries. Also, using
546 * regular expression matching is more efficient as it's been moved to
547 * the C level.
548 **/
549class APCIterator implements Iterator {
550    /**
551     * Get current item
552     *
553     * Gets the current item from the APCIterator stack.
554     *
555     * @return mixed Returns the current item on success, or FALSE if no
556     *   more items or exist, or on failure.
557     * @since PECL apc >= 3.1.1
558     **/
559    public function current(){}
560
561    /**
562     * Get total count
563     *
564     * Get the total count.
565     *
566     * @return int The total count.
567     * @since PECL apc >= 3.1.1
568     **/
569    public function getTotalCount(){}
570
571    /**
572     * Get total cache hits
573     *
574     * Gets the total number of cache hits.
575     *
576     * @return int The number of hits on success, or FALSE on failure.
577     * @since PECL apc >= 3.1.1
578     **/
579    public function getTotalHits(){}
580
581    /**
582     * Get total cache size
583     *
584     * Gets the total cache size.
585     *
586     * @return int The total cache size.
587     * @since PECL apc >= 3.1.1
588     **/
589    public function getTotalSize(){}
590
591    /**
592     * Get iterator key
593     *
594     * Gets the current iterator key.
595     *
596     * @return string Returns the key on success, or FALSE upon failure.
597     * @since PECL apc >= 3.1.1
598     **/
599    public function key(){}
600
601    /**
602     * Move pointer to next item
603     *
604     * Moves the iterator pointer to the next element.
605     *
606     * @return bool
607     * @since PECL apc >= 3.1.1
608     **/
609    public function next(){}
610
611    /**
612     * Rewinds iterator
613     *
614     * Rewinds back the iterator to the first element.
615     *
616     * @return void
617     * @since PECL apc >= 3.1.1
618     **/
619    public function rewind(){}
620
621    /**
622     * Checks if current position is valid
623     *
624     * Checks if the current iterator position is valid.
625     *
626     * @return bool Returns TRUE if the current iterator position is valid,
627     *   otherwise FALSE.
628     * @since PECL apc >= 3.1.1
629     **/
630    public function valid(){}
631
632    /**
633     * Constructs an APCIterator iterator object
634     *
635     * Constructs an APCIterator object.
636     *
637     * @param string $cache The cache type, which will be user or file.
638     * @param mixed $search A PCRE regular expression that matches against
639     *   APC key names, either as a string for a single regular expression,
640     *   or as an array of regular expressions. Or, optionally pass in NULL
641     *   to skip the search.
642     * @param int $format The desired format, as configured with one or
643     *   more of the APC_ITER_* constants.
644     * @param int $chunk_size The chunk size. Must be a value greater than
645     *   0. The default value is 100.
646     * @param int $list The type to list. Either pass in APC_LIST_ACTIVE or
647     *   APC_LIST_DELETED.
648     * @since PECL apc >= 3.1.1
649     **/
650    public function __construct($cache, $search, $format, $chunk_size, $list){}
651
652}
653/**
654 * The APCUIterator class makes it easier to iterate over large APCu
655 * caches. This is helpful as it allows iterating over large caches in
656 * steps, while grabbing a defined number of entries per lock instance,
657 * so it frees the cache locks for other activities rather than hold up
658 * the entire cache to grab 100 (the default) entries. Also, using
659 * regular expression matching is more efficient as it's been moved to
660 * the C level.
661 **/
662class APCUIterator implements Iterator {
663    /**
664     * Get current item
665     *
666     * Gets the current item from the APCUIterator stack.
667     *
668     * @return mixed Returns the current item on success, or FALSE if no
669     *   more items or exist, or on failure.
670     * @since PECL apcu >= 5.0.0
671     **/
672    public function current(){}
673
674    /**
675     * Get total count
676     *
677     * Get the total count.
678     *
679     * @return int The total count.
680     * @since PECL apcu >= 5.0.0
681     **/
682    public function getTotalCount(){}
683
684    /**
685     * Get total cache hits
686     *
687     * Gets the total number of cache hits.
688     *
689     * @return int The number of hits on success, or FALSE on failure.
690     * @since PECL apcu >= 5.0.0
691     **/
692    public function getTotalHits(){}
693
694    /**
695     * Get total cache size
696     *
697     * Gets the total cache size.
698     *
699     * @return int The total cache size.
700     * @since PECL apcu >= 5.0.0
701     **/
702    public function getTotalSize(){}
703
704    /**
705     * Get iterator key
706     *
707     * Gets the current iterator key.
708     *
709     * @return string Returns the key on success, or FALSE upon failure.
710     * @since PECL apcu >= 5.0.0
711     **/
712    public function key(){}
713
714    /**
715     * Move pointer to next item
716     *
717     * Moves the iterator pointer to the next element.
718     *
719     * @return bool
720     * @since PECL apcu >= 5.0.0
721     **/
722    public function next(){}
723
724    /**
725     * Rewinds iterator
726     *
727     * Rewinds back the iterator to the first element.
728     *
729     * @return void
730     * @since PECL apcu >= 5.0.0
731     **/
732    public function rewind(){}
733
734    /**
735     * Checks if current position is valid
736     *
737     * Checks if the current iterator position is valid.
738     *
739     * @return bool Returns TRUE if the current iterator position is valid,
740     *   otherwise FALSE.
741     * @since PECL apcu >= 5.0.0
742     **/
743    public function valid(){}
744
745    /**
746     * Constructs an APCUIterator iterator object
747     *
748     * Constructs an APCUIterator object.
749     *
750     * @param mixed $search A PCRE regular expression that matches against
751     *   APCu key names, either as a string for a single regular expression,
752     *   or as an array of regular expressions. Or, optionally pass in NULL
753     *   to skip the search.
754     * @param int $format The desired format, as configured with one or
755     *   more of the APC_ITER_* constants.
756     * @param int $chunk_size The chunk size. Must be a value greater than
757     *   0. The default value is 100.
758     * @param int $list The type to list. Either pass in APC_LIST_ACTIVE or
759     *   APC_LIST_DELETED.
760     * @since PECL apcu >= 5.0.0
761     **/
762    public function __construct($search, $format, $chunk_size, $list){}
763
764}
765/**
766 * An Iterator that iterates over several iterators one after the other.
767 **/
768class AppendIterator extends IteratorIterator implements OuterIterator {
769    /**
770     * Appends an iterator
771     *
772     * @param Iterator $iterator The iterator to append.
773     * @return void
774     * @since PHP 5 >= 5.1.0, PHP 7
775     **/
776    public function append($iterator){}
777
778    /**
779     * Gets the current value
780     *
781     * @return mixed The current value if it is valid or NULL otherwise.
782     * @since PHP 5 >= 5.1.0, PHP 7
783     **/
784    public function current(){}
785
786    /**
787     * Gets the ArrayIterator
788     *
789     * This method gets the ArrayIterator that is used to store the iterators
790     * added with AppendIterator::append.
791     *
792     * @return ArrayIterator Returns an ArrayIterator containing the
793     *   appended iterators.
794     * @since PHP 5 >= 5.2.0, PHP 7
795     **/
796    public function getArrayIterator(){}
797
798    /**
799     * Gets the inner iterator
800     *
801     * This method returns the current inner iterator.
802     *
803     * @return Iterator The current inner iterator, or NULL if there is not
804     *   one.
805     * @since PHP 5 >= 5.1.0, PHP 7
806     **/
807    public function getInnerIterator(){}
808
809    /**
810     * Gets an index of iterators
811     *
812     * Gets the index of the current inner iterator.
813     *
814     * @return int Returns an integer, which is the zero-based index of the
815     *   current inner iterator.
816     * @since PHP 5 >= 5.2.0, PHP 7
817     **/
818    public function getIteratorIndex(){}
819
820    /**
821     * Gets the current key
822     *
823     * Get the current key.
824     *
825     * @return scalar The current key if it is valid or NULL otherwise.
826     * @since PHP 5 >= 5.1.0, PHP 7
827     **/
828    public function key(){}
829
830    /**
831     * Moves to the next element
832     *
833     * Moves to the next element. If this means to another Iterator then it
834     * rewinds that Iterator.
835     *
836     * @return void
837     * @since PHP 5 >= 5.1.0, PHP 7
838     **/
839    public function next(){}
840
841    /**
842     * Rewinds the Iterator
843     *
844     * Rewind to the first element of the first inner Iterator.
845     *
846     * @return void
847     * @since PHP 5 >= 5.1.0, PHP 7
848     **/
849    public function rewind(){}
850
851    /**
852     * Checks validity of the current element
853     *
854     * @return bool Returns TRUE if the current iteration is valid, FALSE
855     *   otherwise.
856     * @since PHP 5 >= 5.1.0, PHP 7
857     **/
858    public function valid(){}
859
860}
861/**
862 * ArgumentCountError is thrown when too few arguments are passed to a
863 * user-defined function or method.
864 **/
865class ArgumentCountError extends TypeError {
866}
867/**
868 * ArithmeticError is thrown when an error occurs while performing
869 * mathematical operations. In PHP 7.0, these errors include attempting
870 * to perform a bitshift by a negative amount, and any call to {@link
871 * intdiv} that would result in a value outside the possible bounds of an
872 * integer.
873 **/
874class ArithmeticError extends Error {
875}
876/**
877 * Interface to provide accessing objects as arrays.
878 **/
879interface ArrayAccess {
880    /**
881     * Whether an offset exists
882     *
883     * Whether or not an offset exists.
884     *
885     * This method is executed when using {@link isset} or {@link empty} on
886     * objects implementing ArrayAccess.
887     *
888     * @param mixed $offset An offset to check for.
889     * @return bool
890     * @since PHP 5, PHP 7
891     **/
892    public function offsetExists($offset);
893
894    /**
895     * Offset to retrieve
896     *
897     * Returns the value at specified offset.
898     *
899     * This method is executed when checking if offset is {@link empty}.
900     *
901     * @param mixed $offset The offset to retrieve.
902     * @return mixed Can return all value types.
903     * @since PHP 5, PHP 7
904     **/
905    public function offsetGet($offset);
906
907    /**
908     * Assign a value to the specified offset
909     *
910     * Assigns a value to the specified offset.
911     *
912     * @param mixed $offset The offset to assign the value to.
913     * @param mixed $value The value to set.
914     * @return void
915     * @since PHP 5, PHP 7
916     **/
917    public function offsetSet($offset, $value);
918
919    /**
920     * Unset an offset
921     *
922     * Unsets an offset.
923     *
924     * @param mixed $offset The offset to unset.
925     * @return void
926     * @since PHP 5, PHP 7
927     **/
928    public function offsetUnset($offset);
929
930}
931/**
932 * This iterator allows to unset and modify values and keys while
933 * iterating over Arrays and Objects. When you want to iterate over the
934 * same array multiple times you need to instantiate ArrayObject and let
935 * it create ArrayIterator instances that refer to it either by using or
936 * by calling its getIterator() method manually.
937 **/
938class ArrayIterator implements ArrayAccess, SeekableIterator, Countable, Serializable {
939    /**
940     * Entries can be accessed as properties (read and write).
941     *
942     * @var mixed
943     **/
944    const ARRAY_AS_PROPS = 0;
945
946    /**
947     * Properties of the object have their normal functionality when accessed
948     * as list (var_dump, foreach, etc.).
949     *
950     * @var mixed
951     **/
952    const STD_PROP_LIST = 0;
953
954    /**
955     * Append an element
956     *
957     * Appends value as the last element.
958     *
959     * @param mixed $value The value to append.
960     * @return void
961     * @since PHP 5, PHP 7
962     **/
963    public function append($value){}
964
965    /**
966     * Sort array by values
967     *
968     * Sorts an array by values.
969     *
970     * @return void
971     * @since PHP 5 >= 5.2.0, PHP 7
972     **/
973    public function asort(){}
974
975    /**
976     * Count elements
977     *
978     * Gets the number of elements in the array, or the number of public
979     * properties in the object.
980     *
981     * @return int The number of elements or public properties in the
982     *   associated array or object, respectively.
983     * @since PHP 5, PHP 7
984     **/
985    public function count(){}
986
987    /**
988     * Return current array entry
989     *
990     * Get the current array entry.
991     *
992     * @return mixed The current array entry.
993     * @since PHP 5, PHP 7
994     **/
995    public function current(){}
996
997    /**
998     * Get array copy
999     *
1000     * Get a copy of an array.
1001     *
1002     * @return array A copy of the array, or array of public properties if
1003     *   ArrayIterator refers to an object.
1004     * @since PHP 5, PHP 7
1005     **/
1006    public function getArrayCopy(){}
1007
1008    /**
1009     * Get behavior flags
1010     *
1011     * Gets the behavior flags of the ArrayIterator. See the
1012     * ArrayIterator::setFlags method for a list of the available flags.
1013     *
1014     * @return int Returns the behavior flags of the ArrayIterator.
1015     * @since PHP 5 >= 5.1.0, PHP 7
1016     **/
1017    public function getFlags(){}
1018
1019    /**
1020     * Return current array key
1021     *
1022     * This function returns the current array key
1023     *
1024     * @return mixed The current array key.
1025     * @since PHP 5, PHP 7
1026     **/
1027    public function key(){}
1028
1029    /**
1030     * Sort array by keys
1031     *
1032     * Sorts an array by the keys.
1033     *
1034     * @return void
1035     * @since PHP 5 >= 5.2.0, PHP 7
1036     **/
1037    public function ksort(){}
1038
1039    /**
1040     * Sort an array naturally, case insensitive
1041     *
1042     * Sort the entries by values using a case insensitive "natural order"
1043     * algorithm.
1044     *
1045     * @return void
1046     * @since PHP 5 >= 5.2.0, PHP 7
1047     **/
1048    public function natcasesort(){}
1049
1050    /**
1051     * Sort an array naturally
1052     *
1053     * Sort the entries by values using "natural order" algorithm.
1054     *
1055     * @return void
1056     * @since PHP 5 >= 5.2.0, PHP 7
1057     **/
1058    public function natsort(){}
1059
1060    /**
1061     * Move to next entry
1062     *
1063     * The iterator to the next entry.
1064     *
1065     * @return void
1066     * @since PHP 5, PHP 7
1067     **/
1068    public function next(){}
1069
1070    /**
1071     * Check if offset exists
1072     *
1073     * Checks if the offset exists.
1074     *
1075     * @param mixed $index The offset being checked.
1076     * @return bool TRUE if the offset exists, otherwise FALSE
1077     * @since PHP 5, PHP 7
1078     **/
1079    public function offsetExists($index){}
1080
1081    /**
1082     * Get value for an offset
1083     *
1084     * Gets the value from the provided offset.
1085     *
1086     * @param mixed $index The offset to get the value from.
1087     * @return mixed The value at offset {@link index}.
1088     * @since PHP 5, PHP 7
1089     **/
1090    public function offsetGet($index){}
1091
1092    /**
1093     * Set value for an offset
1094     *
1095     * Sets a value for a given offset.
1096     *
1097     * @param mixed $index The index to set for.
1098     * @param mixed $newval The new value to store at the index.
1099     * @return void
1100     * @since PHP 5, PHP 7
1101     **/
1102    public function offsetSet($index, $newval){}
1103
1104    /**
1105     * Unset value for an offset
1106     *
1107     * Unsets a value for an offset.
1108     *
1109     * If iteration is in progress, and ArrayIterator::offsetUnset is used to
1110     * unset the current index of iteration, the iteration position will be
1111     * advanced to the next index. Since the iteration position is also
1112     * advanced at the end of a loop body, use of ArrayIterator::offsetUnset
1113     * inside a foreach loop may result in indices being skipped.
1114     *
1115     * @param mixed $index The offset to unset.
1116     * @return void
1117     * @since PHP 5, PHP 7
1118     **/
1119    public function offsetUnset($index){}
1120
1121    /**
1122     * Rewind array back to the start
1123     *
1124     * This rewinds the iterator to the beginning.
1125     *
1126     * @return void
1127     * @since PHP 5, PHP 7
1128     **/
1129    public function rewind(){}
1130
1131    /**
1132     * Seek to position
1133     *
1134     * @param int $position The position to seek to.
1135     * @return void
1136     * @since PHP 5, PHP 7
1137     **/
1138    public function seek($position){}
1139
1140    /**
1141     * Serialize
1142     *
1143     * @return string The serialized ArrayIterator.
1144     * @since PHP 5 >= 5.3.0, PHP 7
1145     **/
1146    public function serialize(){}
1147
1148    /**
1149     * Set behaviour flags
1150     *
1151     * Set the flags that change the behavior of the ArrayIterator.
1152     *
1153     * @param string $flags The new ArrayIterator behavior. It takes on
1154     *   either a bitmask, or named constants. Using named constants is
1155     *   strongly encouraged to ensure compatibility for future versions. The
1156     *   available behavior flags are listed below. The actual meanings of
1157     *   these flags are described in the predefined constants. ArrayIterator
1158     *   behavior flags value constant 1 ArrayIterator::STD_PROP_LIST 2
1159     *   ArrayIterator::ARRAY_AS_PROPS
1160     * @return void
1161     * @since PHP 5 >= 5.1.0, PHP 7
1162     **/
1163    public function setFlags($flags){}
1164
1165    /**
1166     * Sort with a user-defined comparison function and maintain index
1167     * association
1168     *
1169     * This method sorts the elements such that indices maintain their
1170     * correlation with the values they are associated with, using a
1171     * user-defined comparison function.
1172     *
1173     * @param callable $cmp_function
1174     * @return void
1175     * @since PHP 5 >= 5.2.0, PHP 7
1176     **/
1177    public function uasort($cmp_function){}
1178
1179    /**
1180     * Sort by keys using a user-defined comparison function
1181     *
1182     * This method sorts the elements by keys using a user-supplied
1183     * comparison function.
1184     *
1185     * @param callable $cmp_function
1186     * @return void
1187     * @since PHP 5 >= 5.2.0, PHP 7
1188     **/
1189    public function uksort($cmp_function){}
1190
1191    /**
1192     * Unserialize
1193     *
1194     * @param string $serialized The serialized ArrayIterator object to be
1195     *   unserialized.
1196     * @return void
1197     * @since PHP 5 >= 5.3.0, PHP 7
1198     **/
1199    public function unserialize($serialized){}
1200
1201    /**
1202     * Check whether array contains more entries
1203     *
1204     * Checks if the array contains any more entries.
1205     *
1206     * @return bool Returns TRUE if the iterator is valid, otherwise FALSE
1207     * @since PHP 5, PHP 7
1208     **/
1209    public function valid(){}
1210
1211    /**
1212     * Construct an ArrayIterator
1213     *
1214     * Constructs an ArrayIterator object.
1215     *
1216     * @param mixed $array The array or object to be iterated on.
1217     * @param int $flags Flags to control the behaviour of the
1218     *   ArrayIterator object. See ArrayIterator::setFlags.
1219     * @since PHP 5, PHP 7
1220     **/
1221    public function __construct($array, $flags){}
1222
1223}
1224/**
1225 * This class allows objects to work as arrays.
1226 **/
1227class ArrayObject implements IteratorAggregate, ArrayAccess, Serializable, Countable {
1228    /**
1229     * Entries can be accessed as properties (read and write).
1230     *
1231     * @var mixed
1232     **/
1233    const ARRAY_AS_PROPS = 0;
1234
1235    /**
1236     * Properties of the object have their normal functionality when accessed
1237     * as list (var_dump, foreach, etc.).
1238     *
1239     * @var mixed
1240     **/
1241    const STD_PROP_LIST = 0;
1242
1243    /**
1244     * Appends the value
1245     *
1246     * Appends a new value as the last element.
1247     *
1248     * @param mixed $value The value being appended.
1249     * @return void
1250     * @since PHP 5, PHP 7
1251     **/
1252    public function append($value){}
1253
1254    /**
1255     * Sort the entries by value
1256     *
1257     * Sorts the entries such that the keys maintain their correlation with
1258     * the entries they are associated with. This is used mainly when sorting
1259     * associative arrays where the actual element order is significant.
1260     *
1261     * @return void
1262     * @since PHP 5 >= 5.2.0, PHP 7
1263     **/
1264    public function asort(){}
1265
1266    /**
1267     * Get the number of public properties in the ArrayObject
1268     *
1269     * Get the number of public properties in the ArrayObject.
1270     *
1271     * @return int The number of public properties in the ArrayObject.
1272     * @since PHP 5, PHP 7
1273     **/
1274    public function count(){}
1275
1276    /**
1277     * Exchange the array for another one
1278     *
1279     * Exchange the current array with another array or object.
1280     *
1281     * @param mixed $input The new array or object to exchange with the
1282     *   current array.
1283     * @return array Returns the old array.
1284     * @since PHP 5 >= 5.1.0, PHP 7
1285     **/
1286    public function exchangeArray($input){}
1287
1288    /**
1289     * Creates a copy of the ArrayObject
1290     *
1291     * Exports the ArrayObject to an array.
1292     *
1293     * @return array Returns a copy of the array. When the ArrayObject
1294     *   refers to an object, an array of the public properties of that
1295     *   object will be returned.
1296     * @since PHP 5, PHP 7
1297     **/
1298    public function getArrayCopy(){}
1299
1300    /**
1301     * Gets the behavior flags
1302     *
1303     * Gets the behavior flags of the ArrayObject. See the
1304     * ArrayObject::setFlags method for a list of the available flags.
1305     *
1306     * @return int Returns the behavior flags of the ArrayObject.
1307     * @since PHP 5 >= 5.1.0, PHP 7
1308     **/
1309    public function getFlags(){}
1310
1311    /**
1312     * Create a new iterator from an ArrayObject instance
1313     *
1314     * Create a new iterator from an ArrayObject instance.
1315     *
1316     * @return ArrayIterator An iterator from an ArrayObject.
1317     * @since PHP 5, PHP 7
1318     **/
1319    public function getIterator(){}
1320
1321    /**
1322     * Gets the iterator classname for the ArrayObject
1323     *
1324     * Gets the class name of the array iterator that is used by
1325     * ArrayObject::getIterator().
1326     *
1327     * @return string Returns the iterator class name that is used to
1328     *   iterate over this object.
1329     * @since PHP 5 >= 5.1.0, PHP 7
1330     **/
1331    public function getIteratorClass(){}
1332
1333    /**
1334     * Sort the entries by key
1335     *
1336     * Sorts the entries by key, maintaining key to entry correlations. This
1337     * is useful mainly for associative arrays.
1338     *
1339     * @return void
1340     * @since PHP 5 >= 5.2.0, PHP 7
1341     **/
1342    public function ksort(){}
1343
1344    /**
1345     * Sort an array using a case insensitive "natural order" algorithm
1346     *
1347     * This method is a case insensitive version of ArrayObject::natsort.
1348     *
1349     * This method implements a sort algorithm that orders alphanumeric
1350     * strings in the way a human being would while maintaining key/value
1351     * associations. This is described as a "natural ordering".
1352     *
1353     * @return void
1354     * @since PHP 5 >= 5.2.0, PHP 7
1355     **/
1356    public function natcasesort(){}
1357
1358    /**
1359     * Sort entries using a "natural order" algorithm
1360     *
1361     * This method implements a sort algorithm that orders alphanumeric
1362     * strings in the way a human being would while maintaining key/value
1363     * associations. This is described as a "natural ordering". An example of
1364     * the difference between this algorithm and the regular computer string
1365     * sorting algorithms (used in ArrayObject::asort) method can be seen in
1366     * the example below.
1367     *
1368     * @return void
1369     * @since PHP 5 >= 5.2.0, PHP 7
1370     **/
1371    public function natsort(){}
1372
1373    /**
1374     * Returns whether the requested index exists
1375     *
1376     * @param mixed $index The index being checked.
1377     * @return bool TRUE if the requested index exists, otherwise FALSE
1378     * @since PHP 5, PHP 7
1379     **/
1380    public function offsetExists($index){}
1381
1382    /**
1383     * Returns the value at the specified index
1384     *
1385     * @param mixed $index The index with the value.
1386     * @return mixed The value at the specified index or NULL.
1387     * @since PHP 5, PHP 7
1388     **/
1389    public function offsetGet($index){}
1390
1391    /**
1392     * Sets the value at the specified index to newval
1393     *
1394     * @param mixed $index The index being set.
1395     * @param mixed $newval The new value for the {@link index}.
1396     * @return void
1397     * @since PHP 5, PHP 7
1398     **/
1399    public function offsetSet($index, $newval){}
1400
1401    /**
1402     * Unsets the value at the specified index
1403     *
1404     * @param mixed $index The index being unset.
1405     * @return void
1406     * @since PHP 5, PHP 7
1407     **/
1408    public function offsetUnset($index){}
1409
1410    /**
1411     * Serialize an ArrayObject
1412     *
1413     * Serializes an ArrayObject.
1414     *
1415     * @return string The serialized representation of the ArrayObject.
1416     * @since PHP 5 >= 5.3.0, PHP 7
1417     **/
1418    public function serialize(){}
1419
1420    /**
1421     * Sets the behavior flags
1422     *
1423     * Set the flags that change the behavior of the ArrayObject.
1424     *
1425     * @param int $flags The new ArrayObject behavior. It takes on either a
1426     *   bitmask, or named constants. Using named constants is strongly
1427     *   encouraged to ensure compatibility for future versions. The
1428     *   available behavior flags are listed below. The actual meanings of
1429     *   these flags are described in the predefined constants. ArrayObject
1430     *   behavior flags value constant 1 ArrayObject::STD_PROP_LIST 2
1431     *   ArrayObject::ARRAY_AS_PROPS
1432     * @return void
1433     * @since PHP 5 >= 5.1.0, PHP 7
1434     **/
1435    public function setFlags($flags){}
1436
1437    /**
1438     * Sets the iterator classname for the ArrayObject
1439     *
1440     * Sets the classname of the array iterator that is used by
1441     * ArrayObject::getIterator().
1442     *
1443     * @param string $iterator_class The classname of the array iterator to
1444     *   use when iterating over this object.
1445     * @return void
1446     * @since PHP 5 >= 5.1.0, PHP 7
1447     **/
1448    public function setIteratorClass($iterator_class){}
1449
1450    /**
1451     * Sort the entries with a user-defined comparison function and maintain
1452     * key association
1453     *
1454     * This function sorts the entries such that keys maintain their
1455     * correlation with the entry that they are associated with, using a
1456     * user-defined comparison function.
1457     *
1458     * This is used mainly when sorting associative arrays where the actual
1459     * element order is significant.
1460     *
1461     * @param callable $cmp_function Function {@link cmp_function} should
1462     *   accept two parameters which will be filled by pairs of entries. The
1463     *   comparison function must return an integer less than, equal to, or
1464     *   greater than zero if the first argument is considered to be
1465     *   respectively less than, equal to, or greater than the second.
1466     * @return void
1467     * @since PHP 5 >= 5.2.0, PHP 7
1468     **/
1469    public function uasort($cmp_function){}
1470
1471    /**
1472     * Sort the entries by keys using a user-defined comparison function
1473     *
1474     * This function sorts the keys of the entries using a user-supplied
1475     * comparison function. The key to entry correlations will be maintained.
1476     *
1477     * @param callable $cmp_function The callback comparison function.
1478     *   Function {@link cmp_function} should accept two parameters which
1479     *   will be filled by pairs of entry keys. The comparison function must
1480     *   return an integer less than, equal to, or greater than zero if the
1481     *   first argument is considered to be respectively less than, equal to,
1482     *   or greater than the second.
1483     * @return void
1484     * @since PHP 5 >= 5.2.0, PHP 7
1485     **/
1486    public function uksort($cmp_function){}
1487
1488    /**
1489     * Unserialize an ArrayObject
1490     *
1491     * Unserializes a serialized ArrayObject.
1492     *
1493     * @param string $serialized The serialized ArrayObject.
1494     * @return void The unserialized ArrayObject.
1495     * @since PHP 5 >= 5.3.0, PHP 7
1496     **/
1497    public function unserialize($serialized){}
1498
1499}
1500/**
1501 * AssertionError is thrown when an assertion made via {@link assert}
1502 * fails.
1503 **/
1504class AssertionError extends Error {
1505}
1506/**
1507 * Exception thrown if a callback refers to an undefined function or if
1508 * some arguments are missing.
1509 **/
1510class BadFunctionCallException extends LogicException {
1511}
1512/**
1513 * Exception thrown if a callback refers to an undefined method or if
1514 * some arguments are missing.
1515 **/
1516class BadMethodCallException extends BadFunctionCallException {
1517}
1518/**
1519 * This object supports cached iteration over another iterator.
1520 **/
1521class CachingIterator extends IteratorIterator implements OuterIterator, ArrayAccess, Countable {
1522    /**
1523     * @var integer
1524     **/
1525    const CALL_TOSTRING = 0;
1526
1527    /**
1528     * @var integer
1529     **/
1530    const CATCH_GET_CHILD = 0;
1531
1532    /**
1533     * @var integer
1534     **/
1535    const FULL_CACHE = 0;
1536
1537    /**
1538     * @var integer
1539     **/
1540    const TOSTRING_USE_CURRENT = 0;
1541
1542    /**
1543     * @var integer
1544     **/
1545    const TOSTRING_USE_INNER = 0;
1546
1547    /**
1548     * @var integer
1549     **/
1550    const TOSTRING_USE_KEY = 0;
1551
1552    /**
1553     * The number of elements in the iterator
1554     *
1555     * May return the number of elements in the iterator.
1556     *
1557     * @return int The count of the elements iterated over.
1558     * @since PHP 5 >= 5.2.2, PHP 7
1559     **/
1560    public function count(){}
1561
1562    /**
1563     * Return the current element
1564     *
1565     * May return the current element in the iteration.
1566     *
1567     * @return mixed Mixed
1568     * @since PHP 5, PHP 7
1569     **/
1570    public function current(){}
1571
1572    /**
1573     * Retrieve the contents of the cache
1574     *
1575     * @return array An array containing the cache items.
1576     * @since PHP 5 >= 5.2.0, PHP 7
1577     **/
1578    public function getCache(){}
1579
1580    /**
1581     * Get flags used
1582     *
1583     * Get the bitmask of the flags used for this CachingIterator instance.
1584     *
1585     * @return int Description...
1586     * @since PHP 5 >= 5.2.0, PHP 7
1587     **/
1588    public function getFlags(){}
1589
1590    /**
1591     * Returns the inner iterator
1592     *
1593     * Returns the iterator sent to the constructor.
1594     *
1595     * @return Iterator Returns an object implementing the Iterator
1596     *   interface.
1597     * @since PHP 5, PHP 7
1598     **/
1599    public function getInnerIterator(){}
1600
1601    /**
1602     * Check whether the inner iterator has a valid next element
1603     *
1604     * @return void
1605     * @since PHP 5, PHP 7
1606     **/
1607    public function hasNext(){}
1608
1609    /**
1610     * Return the key for the current element
1611     *
1612     * This method may return a key for the current element.
1613     *
1614     * @return scalar
1615     * @since PHP 5, PHP 7
1616     **/
1617    public function key(){}
1618
1619    /**
1620     * Move the iterator forward
1621     *
1622     * @return void
1623     * @since PHP 5, PHP 7
1624     **/
1625    public function next(){}
1626
1627    /**
1628     * The offsetExists purpose
1629     *
1630     * @param mixed $index The index being checked.
1631     * @return void Returns TRUE if an entry referenced by the offset
1632     *   exists, FALSE otherwise.
1633     * @since PHP 5 >= 5.2.0, PHP 7
1634     **/
1635    public function offsetExists($index){}
1636
1637    /**
1638     * The offsetGet purpose
1639     *
1640     * @param string $index Description...
1641     * @return void Description...
1642     * @since PHP 5 >= 5.2.0, PHP 7
1643     **/
1644    public function offsetGet($index){}
1645
1646    /**
1647     * The offsetSet purpose
1648     *
1649     * @param mixed $index The index of the element to be set.
1650     * @param mixed $newval The new value for the {@link index}.
1651     * @return void
1652     * @since PHP 5 >= 5.2.0, PHP 7
1653     **/
1654    public function offsetSet($index, $newval){}
1655
1656    /**
1657     * The offsetUnset purpose
1658     *
1659     * @param string $index The index of the element to be unset.
1660     * @return void
1661     * @since PHP 5 >= 5.2.0, PHP 7
1662     **/
1663    public function offsetUnset($index){}
1664
1665    /**
1666     * Rewind the iterator
1667     *
1668     * @return void
1669     * @since PHP 5, PHP 7
1670     **/
1671    public function rewind(){}
1672
1673    /**
1674     * The setFlags purpose
1675     *
1676     * Set the flags for the CachingIterator object.
1677     *
1678     * @param int $flags Bitmask of the flags to set.
1679     * @return void
1680     * @since PHP 5 >= 5.2.0, PHP 7
1681     **/
1682    public function setFlags($flags){}
1683
1684    /**
1685     * Check whether the current element is valid
1686     *
1687     * @return void
1688     * @since PHP 5, PHP 7
1689     **/
1690    public function valid(){}
1691
1692    /**
1693     * Construct a new CachingIterator object for the iterator
1694     *
1695     * @param Iterator $iterator Iterator to cache
1696     * @param int $flags Bitmask of flags.
1697     * @since PHP 5, PHP 7
1698     **/
1699    public function __construct($iterator, $flags){}
1700
1701    /**
1702     * Return the string representation of the current element
1703     *
1704     * Get the string representation of the current element.
1705     *
1706     * @return void The string representation of the current element.
1707     * @since PHP 5, PHP 7
1708     **/
1709    public function __toString(){}
1710
1711}
1712/**
1713 * Simple class with some static helper methods.
1714 **/
1715class Cairo {
1716    /**
1717     * Retrieves the availables font types
1718     *
1719     * Returns an array with the available font backends
1720     *
1721     * @return array A list-type array with all available font backends.
1722     * @since PECL cairo >= 0.1.0
1723     **/
1724    public static function availableFonts(){}
1725
1726    /**
1727     * Retrieves all available surfaces
1728     *
1729     * Returns an array with the available surface backends
1730     *
1731     * @return array A list-type array with all available surface backends.
1732     * @since PECL cairo >= 0.1.0
1733     **/
1734    public static function availableSurfaces(){}
1735
1736    /**
1737     * Retrieves the current status as string
1738     *
1739     * Retrieves the current status as a readable string
1740     *
1741     * @param int $status A valid status code given by {@link cairo_status}
1742     *   or CairoContext::status
1743     * @return string A string containing the current status of a
1744     *   CairoContext object
1745     * @since PECL cairo >= 0.1.0
1746     **/
1747    public static function statusToString($status){}
1748
1749    /**
1750     * Retrieves cairo's library version
1751     *
1752     * Retrieves the current version of the cairo library as an integer value
1753     *
1754     * @return int Current Cairo library version integer
1755     * @since PECL cairo >= 0.1.0
1756     **/
1757    public static function version(){}
1758
1759    /**
1760     * Retrieves cairo version as string
1761     *
1762     * Retrieves the current cairo library version as a string.
1763     *
1764     * @return string Current Cairo library version string
1765     * @since PECL cairo >= 0.1.0
1766     **/
1767    public static function versionString(){}
1768
1769}
1770/**
1771 * Enum class that specifies the type of antialiasing to do when
1772 * rendering text or shapes.
1773 **/
1774class CairoAntialias {
1775    /**
1776     * @var integer
1777     **/
1778    const MODE_DEFAULT = 0;
1779
1780    /**
1781     * @var integer
1782     **/
1783    const MODE_GRAY = 0;
1784
1785    /**
1786     * @var integer
1787     **/
1788    const MODE_NONE = 0;
1789
1790    /**
1791     * @var integer
1792     **/
1793    const MODE_SUBPIXEL = 0;
1794
1795}
1796/**
1797 * CairoContent is used to describe the content that a surface will
1798 * contain, whether color information, alpha information (translucence
1799 * vs. opacity), or both. Note: The large values here are designed to
1800 * keep CairoContent values distinct from CairoContent values so that the
1801 * implementation can detect the error if users confuse the two types.
1802 **/
1803class CairoContent {
1804    /**
1805     * The surface will hold alpha content only.
1806     *
1807     * @var integer
1808     **/
1809    const ALPHA = 0;
1810
1811    /**
1812     * The surface will hold color content only.
1813     *
1814     * @var integer
1815     **/
1816    const COLOR = 0;
1817
1818    /**
1819     * @var integer
1820     **/
1821    const COLOR_ALPHA = 0;
1822
1823}
1824/**
1825 * Context is the main object used when drawing with cairo. To draw with
1826 * cairo, you create a CairoContext, set the target CairoSurface, and
1827 * drawing options for the CairoContext, create shapes with functions .
1828 * like CairoContext::moveTo and CairoContext::lineTo, and then draw
1829 * shapes with CairoContext::stroke or CairoContext::fill.
1830 *
1831 * Contexts can be pushed to a stack via CairoContext::save. They may
1832 * then safely be changed, without losing the current state. Use
1833 * CairoContext::restore to restore to the saved state.
1834 **/
1835class CairoContext {
1836    /**
1837     * Appends a path to current path
1838     *
1839     * Appends the {@link path} onto the current path. The {@link path} may
1840     * be either the return value from one of CairoContext::copyPath or
1841     * CairoContext::copyPathFlat;
1842     *
1843     * if {@link path} is not a valid CairoPath instance a CairoException
1844     * will be thrown
1845     *
1846     * @param CairoPath $path CairoContext object
1847     * @return void
1848     * @since PECL cairo >= 0.1.0
1849     **/
1850    public function appendPath($path){}
1851
1852    /**
1853     * Adds a circular arc
1854     *
1855     * Adds a circular arc of the given radius to the current path. The arc
1856     * is centered at ({@link x}, {@link y}), begins at {@link angle1} and
1857     * proceeds in the direction of increasing angles to end at {@link
1858     * angle2}. If {@link angle2} is less than {@link angle1} it will be
1859     * progressively increased by 2*M_PI until it is greater than {@link
1860     * angle1}. If there is a current point, an initial line segment will be
1861     * added to the path to connect the current point to the beginning of the
1862     * arc. If this initial line is undesired, it can be avoided by calling
1863     * CairoContext::newSubPath or procedural {@link cairo_new_sub_path}
1864     * before calling CairoContext::arc or {@link cairo_arc}.
1865     *
1866     * Angles are measured in radians. An angle of 0.0 is in the direction of
1867     * the positive X axis (in user space). An angle of M_PI/2.0 radians (90
1868     * degrees) is in the direction of the positive Y axis (in user space).
1869     * Angles increase in the direction from the positive X axis toward the
1870     * positive Y axis. So with the default transformation matrix, angles
1871     * increase in a clockwise direction.
1872     *
1873     * (To convert from degrees to radians, use degrees * (M_PI / 180.).)
1874     * This function gives the arc in the direction of increasing angles; see
1875     * CairoContext::arcNegative or {@link cairo_arc_negative} to get the arc
1876     * in the direction of decreasing angles.
1877     *
1878     * @param float $x A valid CairoContext object
1879     * @param float $y x position
1880     * @param float $radius y position
1881     * @param float $angle1 Radius of the arc
1882     * @param float $angle2 start angle
1883     * @return void
1884     * @since PECL cairo >= 0.1.0
1885     **/
1886    public function arc($x, $y, $radius, $angle1, $angle2){}
1887
1888    /**
1889     * Adds a negative arc
1890     *
1891     * Adds a circular arc of the given {@link radius} to the current path.
1892     * The arc is centered at ({@link x}, {@link y}), begins at {@link
1893     * angle1} and proceeds in the direction of decreasing angles to end at
1894     * {@link angle2}. If {@link angle2} is greater than {@link angle1} it
1895     * will be progressively decreased by 2*M_PI until it is less than {@link
1896     * angle1}.
1897     *
1898     * See CairoContext::arc or {@link cairo_arc} for more details. This
1899     * function differs only in the direction of the arc between the two
1900     * angles.
1901     *
1902     * @param float $x A valid CairoContext object
1903     * @param float $y double x position
1904     * @param float $radius double y position
1905     * @param float $angle1 The radius of the desired negative arc
1906     * @param float $angle2 Start angle of the arc
1907     * @return void
1908     * @since PECL cairo >= 0.1.0
1909     **/
1910    public function arcNegative($x, $y, $radius, $angle1, $angle2){}
1911
1912    /**
1913     * Establishes a new clip region
1914     *
1915     * Establishes a new clip region by intersecting the current clip region
1916     * with the current path as it would be filled by CairoContext::fill or
1917     * {@link cairo_fill} and according to the current fill rule (see
1918     * CairoContext::setFillRule or {@link cairo_set_fill_rule}).
1919     *
1920     * After CairoContext::clip or {@link cairo_clip}, the current path will
1921     * be cleared from the cairo context.
1922     *
1923     * The current clip region affects all drawing operations by effectively
1924     * masking out any changes to the surface that are outside the current
1925     * clip region.
1926     *
1927     * Calling CairoContext::clip or {@link cairo_clip} can only make the
1928     * clip region smaller, never larger. But the current clip is part of the
1929     * graphics state, so a temporary restriction of the clip region can be
1930     * achieved by calling CairoContext::clip or {@link cairo_clip} within a
1931     * CairoContext::save/CairoContext::restore or {@link cairo_save}/{@link
1932     * cairo_restore} pair. The only other means of increasing the size of
1933     * the clip region is CairoContext::resetClip or procedural {@link
1934     * cairo_reset_clip}.
1935     *
1936     * @return void
1937     * @since PECL cairo >= 0.1.0
1938     **/
1939    public function clip(){}
1940
1941    /**
1942     * Computes the area inside the current clip
1943     *
1944     * Computes a bounding box in user coordinates covering the area inside
1945     * the current clip.
1946     *
1947     * @return array An array containing the (float)x1, (float)y1,
1948     *   (float)x2, (float)y2, coordinates covering the area inside the
1949     *   current clip
1950     * @since PECL cairo >= 0.1.0
1951     **/
1952    public function clipExtents(){}
1953
1954    /**
1955     * Establishes a new clip region from the current clip
1956     *
1957     * Establishes a new clip region by intersecting the current clip region
1958     * with the current path as it would be filled by Context.fill and
1959     * according to the current FILL RULE (see CairoContext::setFillRule or
1960     * {@link cairo_set_fill_rule}).
1961     *
1962     * Unlike CairoContext::clip, CairoContext::clipPreserve preserves the
1963     * path within the Context. The current clip region affects all drawing
1964     * operations by effectively masking out any changes to the surface that
1965     * are outside the current clip region.
1966     *
1967     * Calling CairoContext::clipPreserve can only make the clip region
1968     * smaller, never larger. But the current clip is part of the graphics
1969     * state, so a temporary restriction of the clip region can be achieved
1970     * by calling CairoContext::clipPreserve within a
1971     * CairoContext::save/CairoContext::restore pair. The only other means of
1972     * increasing the size of the clip region is CairoContext::resetClip.
1973     *
1974     * @return void
1975     * @since PECL cairo >= 0.1.0
1976     **/
1977    public function clipPreserve(){}
1978
1979    /**
1980     * Retrieves the current clip as a list of rectangles
1981     *
1982     * Returns a list-type array with the current clip region as a list of
1983     * rectangles in user coordinates
1984     *
1985     * @return array An array of user-space represented rectangles for the
1986     *   current clip
1987     * @since PECL cairo >= 0.1.0
1988     **/
1989    public function clipRectangleList(){}
1990
1991    /**
1992     * Closes the current path
1993     *
1994     * Adds a line segment to the path from the current point to the
1995     * beginning of the current sub-path, (the most recent point passed to
1996     * CairoContext::moveTo), and closes this sub-path. After this call the
1997     * current point will be at the joined endpoint of the sub-path.
1998     *
1999     * The behavior of close_path() is distinct from simply calling
2000     * CairoContext::lineTo with the equivalent coordinate in the case of
2001     * stroking. When a closed sub-path is stroked, there are no caps on the
2002     * ends of the sub-path. Instead, there is a line join connecting the
2003     * final and initial segments of the sub-path.
2004     *
2005     * If there is no current point before the call to
2006     * CairoContext::closePath, this function will have no effect.
2007     *
2008     * @return void
2009     * @since PECL cairo >= 0.1.0
2010     **/
2011    public function closePath(){}
2012
2013    /**
2014     * Emits the current page
2015     *
2016     * Emits the current page for backends that support multiple pages, but
2017     * doesn’t clear it, so, the contents of the current page will be
2018     * retained for the next page too. Use CairoContext::showPage if you want
2019     * to get an empty page after the emission.
2020     *
2021     * This is a convenience function that simply calls
2022     * CairoSurface::copyPage on CairoContext’s target.
2023     *
2024     * @return void
2025     * @since PECL cairo >= 0.1.0
2026     **/
2027    public function copyPage(){}
2028
2029    /**
2030     * Creates a copy of the current path
2031     *
2032     * Creates a copy of the current path and returns it to the user as a
2033     * CairoPath. See CairoPath for hints on how to iterate over the returned
2034     * data structure.
2035     *
2036     * This function will always return a valid CairoPath object, but the
2037     * result will have no data, if either of the following conditions hold:
2038     * 1. If there is insufficient memory to copy the path. In this case
2039     * CairoPath->status will be set to CAIRO_STATUS_NO_MEMORY. 2. If {@link
2040     * context} is already in an error state. In this case CairoPath->status
2041     * will contain the same status that would be returned by {@link
2042     * cairo_status}.
2043     *
2044     * In either case, CairoPath->status will be set to
2045     * CAIRO_STATUS_NO_MEMORY (regardless of what the error status in cr
2046     * might have been).
2047     *
2048     * @return CairoPath A copy of the current CairoPath in the context
2049     * @since PECL cairo >= 0.1.0
2050     **/
2051    public function copyPath(){}
2052
2053    /**
2054     * Gets a flattened copy of the current path
2055     *
2056     * Gets a flattened copy of the current path and returns it to the user
2057     * as a CairoPath.
2058     *
2059     * This function is like CairoContext::copyPath except that any curves in
2060     * the path will be approximated with piecewise-linear approximations,
2061     * (accurate to within the current tolerance value). That is, the result
2062     * is guaranteed to not have any elements of type CAIRO_PATH_CURVE_TO
2063     * which will instead be replaced by a series of CAIRO_PATH_LINE_TO
2064     * elements.
2065     *
2066     * @return CairoPath A copy of the current path
2067     * @since PECL cairo >= 0.1.0
2068     **/
2069    public function copyPathFlat(){}
2070
2071    /**
2072     * Adds a curve
2073     *
2074     * Adds a cubic Bezier spline to the path from the current point to
2075     * position {@link x3} ,{@link y3} in user-space coordinates, using
2076     * {@link x1}, {@link y1} and {@link x2}, {@link y2} as the control
2077     * points. After this call the current point will be {@link x3}, {@link
2078     * y3}.
2079     *
2080     * If there is no current point before the call to CairoContext::curveTo
2081     * this function will behave as if preceded by a call to
2082     * CairoContext::moveTo ({@link x1}, {@link y1}).
2083     *
2084     * @param float $x1 A valid CairoContext object created with
2085     *   CairoContext::__construct or {@link cairo_create}
2086     * @param float $y1 First control point in the x axis for the curve
2087     * @param float $x2 First control point in the y axis for the curve
2088     * @param float $y2 Second control point in x axis for the curve
2089     * @param float $x3 Second control point in y axis for the curve
2090     * @param float $y3 Final point in the x axis for the curve
2091     * @return void
2092     * @since PECL cairo >= 0.1.0
2093     **/
2094    public function curveTo($x1, $y1, $x2, $y2, $x3, $y3){}
2095
2096    /**
2097     * Transform a coordinate
2098     *
2099     * Transform a coordinate from device space to user space by multiplying
2100     * the given point by the inverse of the current transformation matrix
2101     * (CTM).
2102     *
2103     * @param float $x A valid CairoContext object created with
2104     *   CairoContext::__construct or {@link cairo_create}
2105     * @param float $y x value of the coordinate
2106     * @return array An array containing the x and y coordinates in the
2107     *   user-space
2108     * @since PECL cairo >= 0.1.0
2109     **/
2110    public function deviceToUser($x, $y){}
2111
2112    /**
2113     * Transform a distance
2114     *
2115     * Transform a distance vector from device space to user space. This
2116     * function is similar to CairoContext::deviceToUser or {@link
2117     * cairo_device_to_user} except that the translation components of the
2118     * inverse Cairo Transformation Matrix will be ignored when transforming
2119     * ({@link x},{@link y}).
2120     *
2121     * @param float $x A valid CairoContext object created with
2122     *   CairoContext::__construct or {@link cairo_create}
2123     * @param float $y X component of a distance vector
2124     * @return array Returns an array with the x and y values of a distance
2125     *   vector in the user-space
2126     * @since PECL cairo >= 0.1.0
2127     **/
2128    public function deviceToUserDistance($x, $y){}
2129
2130    /**
2131     * Fills the current path
2132     *
2133     * A drawing operator that fills the current path according to the
2134     * current CairoFillRule, (each sub-path is implicitly closed before
2135     * being filled). After CairoContext::fill or {@link cairo_fill}, the
2136     * current path will be cleared from the CairoContext.
2137     *
2138     * @return void
2139     * @since PECL cairo >= 0.1.0
2140     **/
2141    public function fill(){}
2142
2143    /**
2144     * Computes the filled area
2145     *
2146     * Computes a bounding box in user coordinates covering the area that
2147     * would be affected, (the “inked” area), by a CairoContext::fill
2148     * operation given the current path and fill parameters. If the current
2149     * path is empty, returns an empty rectangle (0,0,0,0). Surface
2150     * dimensions and clipping are not taken into account.
2151     *
2152     * Contrast with CairoContext::pathExtents, which is similar, but returns
2153     * non-zero extents for some paths with no inked area, (such as a simple
2154     * line segment).
2155     *
2156     * Note that CairoContext::fillExtents must necessarily do more work to
2157     * compute the precise inked areas in light of the fill rule, so
2158     * CairoContext::pathExtents may be more desirable for sake of
2159     * performance if the non-inked path extents are desired.
2160     *
2161     * @return array An array with the coordinates of the afected area
2162     * @since PECL cairo >= 0.1.0
2163     **/
2164    public function fillExtents(){}
2165
2166    /**
2167     * Fills and preserve the current path
2168     *
2169     * A drawing operator that fills the current path according to the
2170     * current CairoFillRule, (each sub-path is implicitly closed before
2171     * being filled). Unlike CairoContext::fill, CairoContext::fillPreserve
2172     * (Procedural {@link cairo_fill}, {@link cairo_fill_preserve},
2173     * respectively) preserves the path within the Context.
2174     *
2175     * @return void
2176     * @since PECL cairo >= 0.1.0
2177     **/
2178    public function fillPreserve(){}
2179
2180    /**
2181     * Get the font extents
2182     *
2183     * Gets the font extents for the currently selected font.
2184     *
2185     * @return array An array containing the font extents for the current
2186     *   font.
2187     * @since PECL cairo >= 0.1.0
2188     **/
2189    public function fontExtents(){}
2190
2191    /**
2192     * Retrieves the current antialias mode
2193     *
2194     * Returns the current CairoAntialias mode, as set by
2195     * CairoContext::setAntialias.
2196     *
2197     * @return int The current CairoAntialias mode.
2198     * @since PECL cairo >= 0.1.0
2199     **/
2200    public function getAntialias(){}
2201
2202    /**
2203     * The getCurrentPoint purpose
2204     *
2205     * Gets the current point of the current path, which is conceptually the
2206     * final point reached by the path so far.
2207     *
2208     * The current point is returned in the user-space coordinate system. If
2209     * there is no defined current point or if cr is in an error status, x
2210     * and y will both be set to 0.0. It is possible to check this in advance
2211     * with CairoContext::hasCurrentPoint.
2212     *
2213     * Most path construction functions alter the current point. See the
2214     * following for details on how they affect the current point:
2215     * CairoContext::newPath, CairoContext::newSubPath,
2216     * CairoContext::appendPath, CairoContext::closePath,
2217     * CairoContext::moveTo, CairoContext::lineTo, CairoContext::curveTo,
2218     * CairoContext::relMoveTo, CairoContext::relLineTo,
2219     * CairoContext::relCurveTo, CairoContext::arc,
2220     * CairoContext::arcNegative, CairoContext::rectangle,
2221     * CairoContext::textPath, CairoContext::glyphPath.
2222     *
2223     * Some functions use and alter the current point but do not otherwise
2224     * change current path: CairoContext::showText.
2225     *
2226     * Some functions unset the current path and as a result, current point:
2227     * CairoContext::fill, CairoContext::stroke.
2228     *
2229     * @return array An array containing the x (index 0) and y (index 1)
2230     *   coordinates of the current point.
2231     * @since PECL cairo >= 0.1.0
2232     **/
2233    public function getCurrentPoint(){}
2234
2235    /**
2236     * The getDash purpose
2237     *
2238     * @return array Description...
2239     * @since PECL cairo >= 0.1.0
2240     **/
2241    public function getDash(){}
2242
2243    /**
2244     * The getDashCount purpose
2245     *
2246     * @return int Description...
2247     * @since PECL cairo >= 0.1.0
2248     **/
2249    public function getDashCount(){}
2250
2251    /**
2252     * The getFillRule purpose
2253     *
2254     * @return int Description...
2255     * @since PECL cairo >= 0.1.0
2256     **/
2257    public function getFillRule(){}
2258
2259    /**
2260     * The getFontFace purpose
2261     *
2262     * @return void Description...
2263     * @since PECL cairo >= 0.1.0
2264     **/
2265    public function getFontFace(){}
2266
2267    /**
2268     * The getFontMatrix purpose
2269     *
2270     * @return void Description...
2271     * @since PECL cairo >= 0.1.0
2272     **/
2273    public function getFontMatrix(){}
2274
2275    /**
2276     * The getFontOptions purpose
2277     *
2278     * @return void Description...
2279     * @since PECL cairo >= 0.1.0
2280     **/
2281    public function getFontOptions(){}
2282
2283    /**
2284     * The getGroupTarget purpose
2285     *
2286     * @return void Description...
2287     * @since PECL cairo >= 0.1.0
2288     **/
2289    public function getGroupTarget(){}
2290
2291    /**
2292     * The getLineCap purpose
2293     *
2294     * @return int Description...
2295     * @since PECL cairo >= 0.1.0
2296     **/
2297    public function getLineCap(){}
2298
2299    /**
2300     * The getLineJoin purpose
2301     *
2302     * @return int Description...
2303     * @since PECL cairo >= 0.1.0
2304     **/
2305    public function getLineJoin(){}
2306
2307    /**
2308     * The getLineWidth purpose
2309     *
2310     * @return float Description...
2311     * @since PECL cairo >= 0.1.0
2312     **/
2313    public function getLineWidth(){}
2314
2315    /**
2316     * The getMatrix purpose
2317     *
2318     * @return void Description...
2319     * @since PECL cairo >= 0.1.0
2320     **/
2321    public function getMatrix(){}
2322
2323    /**
2324     * The getMiterLimit purpose
2325     *
2326     * @return float Description...
2327     * @since PECL cairo >= 0.1.0
2328     **/
2329    public function getMiterLimit(){}
2330
2331    /**
2332     * The getOperator purpose
2333     *
2334     * @return int Description...
2335     * @since PECL cairo >= 0.1.0
2336     **/
2337    public function getOperator(){}
2338
2339    /**
2340     * The getScaledFont purpose
2341     *
2342     * @return void Description...
2343     * @since PECL cairo >= 0.1.0
2344     **/
2345    public function getScaledFont(){}
2346
2347    /**
2348     * The getSource purpose
2349     *
2350     * @return void Description...
2351     * @since PECL cairo >= 0.1.0
2352     **/
2353    public function getSource(){}
2354
2355    /**
2356     * The getTarget purpose
2357     *
2358     * @return void Description...
2359     * @since PECL cairo >= 0.1.0
2360     **/
2361    public function getTarget(){}
2362
2363    /**
2364     * The getTolerance purpose
2365     *
2366     * @return float Description...
2367     * @since PECL cairo >= 0.1.0
2368     **/
2369    public function getTolerance(){}
2370
2371    /**
2372     * The glyphPath purpose
2373     *
2374     * Adds closed paths for the glyphs to the current path. The generated
2375     * path if filled, achieves an effect similar to that of
2376     * CairoContext::showGlyphs.
2377     *
2378     * @param array $glyphs A CairoContext object
2379     * @return void
2380     * @since PECL cairo >= 0.1.0
2381     **/
2382    public function glyphPath($glyphs){}
2383
2384    /**
2385     * The hasCurrentPoint purpose
2386     *
2387     * Returns whether a current point is defined on the current path. See
2388     * CairoContext::getCurrentPoint for details on the current point.
2389     *
2390     * @return bool Whether a current point is defined
2391     * @since PECL cairo >= 0.1.0
2392     **/
2393    public function hasCurrentPoint(){}
2394
2395    /**
2396     * The identityMatrix purpose
2397     *
2398     * @return void Description...
2399     * @since PECL cairo >= 0.1.0
2400     **/
2401    public function identityMatrix(){}
2402
2403    /**
2404     * The inFill purpose
2405     *
2406     * @param float $x Description...
2407     * @param float $y Description...
2408     * @return bool Description...
2409     * @since PECL cairo >= 0.1.0
2410     **/
2411    public function inFill($x, $y){}
2412
2413    /**
2414     * The inStroke purpose
2415     *
2416     * @param float $x Description...
2417     * @param float $y Description...
2418     * @return bool Description...
2419     * @since PECL cairo >= 0.1.0
2420     **/
2421    public function inStroke($x, $y){}
2422
2423    /**
2424     * The lineTo purpose
2425     *
2426     * @param float $x Description...
2427     * @param float $y Description...
2428     * @return void Description...
2429     * @since PECL cairo >= 0.1.0
2430     **/
2431    public function lineTo($x, $y){}
2432
2433    /**
2434     * The mask purpose
2435     *
2436     * @param CairoPattern $pattern Description...
2437     * @return void Description...
2438     * @since PECL cairo >= 0.1.0
2439     **/
2440    public function mask($pattern){}
2441
2442    /**
2443     * The maskSurface purpose
2444     *
2445     * @param CairoSurface $surface Description...
2446     * @param float $x Description...
2447     * @param float $y Description...
2448     * @return void Description...
2449     * @since PECL cairo >= 0.1.0
2450     **/
2451    public function maskSurface($surface, $x, $y){}
2452
2453    /**
2454     * The moveTo purpose
2455     *
2456     * Begin a new sub-path. After this call the current point will be (x,
2457     * y).
2458     *
2459     * @param float $x A valid CairoContext object.
2460     * @param float $y The x coordinate of the new position.
2461     * @return void
2462     * @since PECL cairo >= 0.1.0
2463     **/
2464    public function moveTo($x, $y){}
2465
2466    /**
2467     * The newPath purpose
2468     *
2469     * Clears the current path. After this call there will be no path and no
2470     * current point.
2471     *
2472     * @return void
2473     * @since PECL cairo >= 0.1.0
2474     **/
2475    public function newPath(){}
2476
2477    /**
2478     * The newSubPath purpose
2479     *
2480     * @return void Description...
2481     * @since PECL cairo >= 0.1.0
2482     **/
2483    public function newSubPath(){}
2484
2485    /**
2486     * The paint purpose
2487     *
2488     * @return void Description...
2489     * @since PECL cairo >= 0.1.0
2490     **/
2491    public function paint(){}
2492
2493    /**
2494     * The paintWithAlpha purpose
2495     *
2496     * @param float $alpha Description...
2497     * @return void Description...
2498     * @since PECL cairo >= 0.1.0
2499     **/
2500    public function paintWithAlpha($alpha){}
2501
2502    /**
2503     * The pathExtents purpose
2504     *
2505     * @return array Description...
2506     * @since PECL cairo >= 0.1.0
2507     **/
2508    public function pathExtents(){}
2509
2510    /**
2511     * The popGroup purpose
2512     *
2513     * @return void Description...
2514     * @since PECL cairo >= 0.1.0
2515     **/
2516    public function popGroup(){}
2517
2518    /**
2519     * The popGroupToSource purpose
2520     *
2521     * @return void Description...
2522     * @since PECL cairo >= 0.1.0
2523     **/
2524    public function popGroupToSource(){}
2525
2526    /**
2527     * The pushGroup purpose
2528     *
2529     * @return void Description...
2530     * @since PECL cairo >= 0.1.0
2531     **/
2532    public function pushGroup(){}
2533
2534    /**
2535     * The pushGroupWithContent purpose
2536     *
2537     * @param int $content Description...
2538     * @return void Description...
2539     * @since PECL cairo >= 0.1.0
2540     **/
2541    public function pushGroupWithContent($content){}
2542
2543    /**
2544     * The rectangle purpose
2545     *
2546     * @param float $x Description...
2547     * @param float $y Description...
2548     * @param float $width Description...
2549     * @param float $height Description...
2550     * @return void Description...
2551     * @since PECL cairo >= 0.1.0
2552     **/
2553    public function rectangle($x, $y, $width, $height){}
2554
2555    /**
2556     * The relCurveTo purpose
2557     *
2558     * @param float $x1 Description...
2559     * @param float $y1 Description...
2560     * @param float $x2 Description...
2561     * @param float $y2 Description...
2562     * @param float $x3 Description...
2563     * @param float $y3 Description...
2564     * @return void Description...
2565     * @since PECL cairo >= 0.1.0
2566     **/
2567    public function relCurveTo($x1, $y1, $x2, $y2, $x3, $y3){}
2568
2569    /**
2570     * The relLineTo purpose
2571     *
2572     * @param float $x Description...
2573     * @param float $y Description...
2574     * @return void Description...
2575     * @since PECL cairo >= 0.1.0
2576     **/
2577    public function relLineTo($x, $y){}
2578
2579    /**
2580     * The relMoveTo purpose
2581     *
2582     * @param float $x Description...
2583     * @param float $y Description...
2584     * @return void Description...
2585     * @since PECL cairo >= 0.1.0
2586     **/
2587    public function relMoveTo($x, $y){}
2588
2589    /**
2590     * The resetClip purpose
2591     *
2592     * @return void Description...
2593     * @since PECL cairo >= 0.1.0
2594     **/
2595    public function resetClip(){}
2596
2597    /**
2598     * The restore purpose
2599     *
2600     * @return void Description...
2601     * @since PECL cairo >= 0.1.0
2602     **/
2603    public function restore(){}
2604
2605    /**
2606     * The rotate purpose
2607     *
2608     * @param float $angle Description...
2609     * @return void Description...
2610     * @since PECL cairo >= 0.1.0
2611     **/
2612    public function rotate($angle){}
2613
2614    /**
2615     * The save purpose
2616     *
2617     * @return void Description...
2618     * @since PECL cairo >= 0.1.0
2619     **/
2620    public function save(){}
2621
2622    /**
2623     * The scale purpose
2624     *
2625     * @param float $x Description...
2626     * @param float $y Description...
2627     * @return void Description...
2628     * @since PECL cairo >= 0.1.0
2629     **/
2630    public function scale($x, $y){}
2631
2632    /**
2633     * The selectFontFace purpose
2634     *
2635     * @param string $family Description...
2636     * @param int $slant Description...
2637     * @param int $weight Description...
2638     * @return void Description...
2639     * @since PECL cairo >= 0.1.0
2640     **/
2641    public function selectFontFace($family, $slant, $weight){}
2642
2643    /**
2644     * The setAntialias purpose
2645     *
2646     * @param int $antialias Description...
2647     * @return void Description...
2648     * @since PECL cairo >= 0.1.0
2649     **/
2650    public function setAntialias($antialias){}
2651
2652    /**
2653     * The setDash purpose
2654     *
2655     * @param array $dashes Description...
2656     * @param float $offset Description...
2657     * @return void Description...
2658     * @since PECL cairo >= 0.1.0
2659     **/
2660    public function setDash($dashes, $offset){}
2661
2662    /**
2663     * The setFillRule purpose
2664     *
2665     * @param int $setting Description...
2666     * @return void Description...
2667     * @since PECL cairo >= 0.1.0
2668     **/
2669    public function setFillRule($setting){}
2670
2671    /**
2672     * The setFontFace purpose
2673     *
2674     * Sets the font-face for a given context.
2675     *
2676     * @param CairoFontFace $fontface A CairoContext object to change the
2677     *   font-face for.
2678     * @return void No value is returned
2679     * @since PECL cairo >= 0.1.0
2680     **/
2681    public function setFontFace($fontface){}
2682
2683    /**
2684     * The setFontMatrix purpose
2685     *
2686     * @param CairoMatrix $matrix Description...
2687     * @return void Description...
2688     * @since PECL cairo >= 0.1.0
2689     **/
2690    public function setFontMatrix($matrix){}
2691
2692    /**
2693     * The setFontOptions purpose
2694     *
2695     * @param CairoFontOptions $fontoptions Description...
2696     * @return void Description...
2697     * @since PECL cairo >= 0.1.0
2698     **/
2699    public function setFontOptions($fontoptions){}
2700
2701    /**
2702     * The setFontSize purpose
2703     *
2704     * @param float $size Description...
2705     * @return void Description...
2706     * @since PECL cairo >= 0.1.0
2707     **/
2708    public function setFontSize($size){}
2709
2710    /**
2711     * The setLineCap purpose
2712     *
2713     * @param int $setting Description...
2714     * @return void Description...
2715     * @since PECL cairo >= 0.1.0
2716     **/
2717    public function setLineCap($setting){}
2718
2719    /**
2720     * The setLineJoin purpose
2721     *
2722     * @param int $setting Description...
2723     * @return void Description...
2724     * @since PECL cairo >= 0.1.0
2725     **/
2726    public function setLineJoin($setting){}
2727
2728    /**
2729     * The setLineWidth purpose
2730     *
2731     * @param float $width Description...
2732     * @return void Description...
2733     * @since PECL cairo >= 0.1.0
2734     **/
2735    public function setLineWidth($width){}
2736
2737    /**
2738     * The setMatrix purpose
2739     *
2740     * @param CairoMatrix $matrix Description...
2741     * @return void Description...
2742     * @since PECL cairo >= 0.1.0
2743     **/
2744    public function setMatrix($matrix){}
2745
2746    /**
2747     * The setMiterLimit purpose
2748     *
2749     * @param float $limit Description...
2750     * @return void Description...
2751     * @since PECL cairo >= 0.1.0
2752     **/
2753    public function setMiterLimit($limit){}
2754
2755    /**
2756     * The setOperator purpose
2757     *
2758     * @param int $setting Description...
2759     * @return void Description...
2760     * @since PECL cairo >= 0.1.0
2761     **/
2762    public function setOperator($setting){}
2763
2764    /**
2765     * The setScaledFont purpose
2766     *
2767     * @param CairoScaledFont $scaledfont Description...
2768     * @return void Description...
2769     * @since PECL cairo >= 0.1.0
2770     **/
2771    public function setScaledFont($scaledfont){}
2772
2773    /**
2774     * The setSource purpose
2775     *
2776     * @param CairoPattern $pattern Description...
2777     * @return void Description...
2778     * @since PECL cairo >= 0.1.0
2779     **/
2780    public function setSource($pattern){}
2781
2782    /**
2783     * The setSourceRGB purpose
2784     *
2785     * @param float $red Description...
2786     * @param float $green Description...
2787     * @param float $blue Description...
2788     * @return void Description...
2789     * @since PECL cairo >= 0.1.0
2790     **/
2791    public function setSourceRGB($red, $green, $blue){}
2792
2793    /**
2794     * The setSourceRGBA purpose
2795     *
2796     * @param float $red Description...
2797     * @param float $green Description...
2798     * @param float $blue Description...
2799     * @param float $alpha Description...
2800     * @return void Description...
2801     * @since PECL cairo >= 0.1.0
2802     **/
2803    public function setSourceRGBA($red, $green, $blue, $alpha){}
2804
2805    /**
2806     * The setSourceSurface purpose
2807     *
2808     * @param CairoSurface $surface Description...
2809     * @param float $x Description...
2810     * @param float $y Description...
2811     * @return void Description...
2812     * @since PECL cairo >= 0.1.0
2813     **/
2814    public function setSourceSurface($surface, $x, $y){}
2815
2816    /**
2817     * The setTolerance purpose
2818     *
2819     * @param float $tolerance Description...
2820     * @return void Description...
2821     * @since PECL cairo >= 0.1.0
2822     **/
2823    public function setTolerance($tolerance){}
2824
2825    /**
2826     * The showPage purpose
2827     *
2828     * @return void Description...
2829     * @since PECL cairo >= 0.1.0
2830     **/
2831    public function showPage(){}
2832
2833    /**
2834     * The showText purpose
2835     *
2836     * @param string $text Description...
2837     * @return void Description...
2838     * @since PECL cairo >= 0.1.0
2839     **/
2840    public function showText($text){}
2841
2842    /**
2843     * The status purpose
2844     *
2845     * @return int Description...
2846     * @since PECL cairo >= 0.1.0
2847     **/
2848    public function status(){}
2849
2850    /**
2851     * The stroke purpose
2852     *
2853     * @return void Description...
2854     * @since PECL cairo >= 0.1.0
2855     **/
2856    public function stroke(){}
2857
2858    /**
2859     * The strokeExtents purpose
2860     *
2861     * @return array Description...
2862     * @since PECL cairo >= 0.1.0
2863     **/
2864    public function strokeExtents(){}
2865
2866    /**
2867     * The strokePreserve purpose
2868     *
2869     * @return void Description...
2870     * @since PECL cairo >= 0.1.0
2871     **/
2872    public function strokePreserve(){}
2873
2874    /**
2875     * The textExtents purpose
2876     *
2877     * @param string $text Description...
2878     * @return array Description...
2879     * @since PECL cairo >= 0.1.0
2880     **/
2881    public function textExtents($text){}
2882
2883    /**
2884     * The textPath purpose
2885     *
2886     * Adds closed paths for text to the current path. The generated path, if
2887     * filled, achieves an effect similar to that of CairoContext::showText.
2888     *
2889     * Text conversion and positioning is done similar to
2890     * CairoContext::showText.
2891     *
2892     * Like CairoContext::showText, after this call the current point is
2893     * moved to the origin of where the next glyph would be placed in this
2894     * same progression. That is, the current point will be at the origin of
2895     * the final glyph offset by its advance values. This allows for chaining
2896     * multiple calls to CairoContext::showText without having to set current
2897     * point in between.
2898     *
2899     * Note: The CairoContext::textPath function call is part of what the
2900     * cairo designers call the "toy" text API. It is convenient for short
2901     * demos and simple programs, but it is not expected to be adequate for
2902     * serious text-using applications. See CairoContext::glyphPath for the
2903     * "real" text path API in cairo.
2904     *
2905     * @param string $string A CairoContext object
2906     * @return void Description...
2907     * @since PECL cairo >= 0.1.0
2908     **/
2909    public function textPath($string){}
2910
2911    /**
2912     * The transform purpose
2913     *
2914     * @param CairoMatrix $matrix Description...
2915     * @return void Description...
2916     * @since PECL cairo >= 0.1.0
2917     **/
2918    public function transform($matrix){}
2919
2920    /**
2921     * The translate purpose
2922     *
2923     * @param float $x Description...
2924     * @param float $y Description...
2925     * @return void Description...
2926     * @since PECL cairo >= 0.1.0
2927     **/
2928    public function translate($x, $y){}
2929
2930    /**
2931     * The userToDevice purpose
2932     *
2933     * @param float $x Description...
2934     * @param float $y Description...
2935     * @return array Description...
2936     * @since PECL cairo >= 0.1.0
2937     **/
2938    public function userToDevice($x, $y){}
2939
2940    /**
2941     * The userToDeviceDistance purpose
2942     *
2943     * @param float $x Description...
2944     * @param float $y Description...
2945     * @return array Description...
2946     * @since PECL cairo >= 0.1.0
2947     **/
2948    public function userToDeviceDistance($x, $y){}
2949
2950    /**
2951     * Creates a new CairoContext
2952     *
2953     * Creates a new CairoContext object to draw
2954     *
2955     * @param CairoSurface $surface A valid CairoSurface like
2956     *   CairoImageSurface or CairoPdfSurface
2957     * @since PECL cairo >= 0.1.0
2958     **/
2959    public function __construct($surface){}
2960
2961}
2962/**
2963 * Exception class thrown by Cairo functions and methods
2964 **/
2965class CairoException extends Exception {
2966}
2967class CairoExtend {
2968    /**
2969     * @var integer
2970     **/
2971    const NONE = 0;
2972
2973    /**
2974     * @var integer
2975     **/
2976    const PAD = 0;
2977
2978    /**
2979     * @var integer
2980     **/
2981    const REFLECT = 0;
2982
2983    /**
2984     * @var integer
2985     **/
2986    const REPEAT = 0;
2987
2988}
2989/**
2990 * A CairoFillRule is used to select how paths are filled. For both fill
2991 * rules, whether or not a point is included in the fill is determined by
2992 * taking a ray from that point to infinity and looking at intersections
2993 * with the path. The ray can be in any direction, as long as it doesn't
2994 * pass through the end point of a segment or have a tricky intersection
2995 * such as intersecting tangent to the path. (Note that filling is not
2996 * actually implemented in this way. This is just a description of the
2997 * rule that is applied.) The default fill rule is
2998 * CairoFillRule::WINDING.
2999 **/
3000class CairoFillRule {
3001    /**
3002     * @var integer
3003     **/
3004    const EVEN_ODD = 0;
3005
3006    /**
3007     * If the path crosses the ray from left-to-right, counts +1. If the path
3008     * crosses the ray from right to left, counts -1. (Left and right are
3009     * determined from the perspective of looking along the ray from the
3010     * starting point.) If the total count is non-zero, the point will be
3011     * filled.
3012     *
3013     * @var integer
3014     **/
3015    const WINDING = 0;
3016
3017}
3018/**
3019 * A CairoFilter is used to indicate what filtering should be applied
3020 * when reading pixel values from patterns. See CairoPattern::setSource
3021 * or {@link cairo_pattern_set_source} for indicating the desired filter
3022 * to be used with a particular pattern.
3023 **/
3024class CairoFilter {
3025    /**
3026     * The highest-quality available, performance may not be suitable for
3027     * interactive use.
3028     *
3029     * @var integer
3030     **/
3031    const BEST = 0;
3032
3033    /**
3034     * Linear interpolation in two dimensions
3035     *
3036     * @var integer
3037     **/
3038    const BILINEAR = 0;
3039
3040    /**
3041     * A high-performance filter, with quality similar to
3042     * CairoFilter::NEAREST
3043     *
3044     * @var integer
3045     **/
3046    const FAST = 0;
3047
3048    /**
3049     * This filter value is currently unimplemented, and should not be used
3050     * in current code.
3051     *
3052     * @var integer
3053     **/
3054    const GAUSSIAN = 0;
3055
3056    /**
3057     * A reasonable-performance filter, with quality similar to
3058     * CairoFilter::BILINEAR
3059     *
3060     * @var integer
3061     **/
3062    const GOOD = 0;
3063
3064    /**
3065     * Nearest-neighbor filtering
3066     *
3067     * @var integer
3068     **/
3069    const NEAREST = 0;
3070
3071}
3072/**
3073 * CairoFontFace abstract class represents a particular font at a
3074 * particular weight, slant, and other characteristic but no
3075 * transformation or size. Note: This class can not be instantiated
3076 * directly, it is created by CairoContext::getFontFace or {@link
3077 * cairo_scaled_font_get_font_face}.
3078 **/
3079class CairoFontFace {
3080    /**
3081     * Retrieves the font face type
3082     *
3083     * This function returns the type of the backend used to create a font
3084     * face. See CairoFontType class constants for available types.
3085     *
3086     * @return int A font type that can be any one defined in CairoFontType
3087     * @since PECL cairo >= 0.1.0
3088     **/
3089    public function getType(){}
3090
3091    /**
3092     * Check for CairoFontFace errors
3093     *
3094     * Checks whether an error has previously occurred for this font face
3095     *
3096     * @return int CAIRO_STATUS_SUCCESS or another error such as
3097     *   CAIRO_STATUS_NO_MEMORY.
3098     * @since PECL cairo >= 0.1.0
3099     **/
3100    public function status(){}
3101
3102    /**
3103     * Creates a new CairoFontFace object
3104     *
3105     * CairoFontFace class represents a particular font at a particular
3106     * weight, slant, and other characteristic but no transformation or size.
3107     *
3108     * Note: This class can't be instantiated directly it is created by
3109     * CairoContext::getFontFace or {@link cairo_scaled_font_get_font_face}
3110     *
3111     * @since PECL cairo >= 0.1.0
3112     **/
3113    public function __construct(){}
3114
3115}
3116/**
3117 * An opaque structure holding all options that are used when rendering
3118 * fonts. Individual features of a cairo_font_options_t can be set or
3119 * accessed using functions named cairo_font_options_set_feature_name and
3120 * cairo_font_options_get_feature_name, like
3121 * cairo_font_options_set_antialias() and
3122 * cairo_font_options_get_antialias(). New features may be added to
3123 * CairoFontOptions in the future. For this reason
3124 * CairoFontOptions::copy, CairoFontOptions::equal,
3125 * CairoFontOptions::merge, CairoFontOptions::hash
3126 * (cairo_font_options_copy(), cairo_font_options_equal(),
3127 * cairo_font_options_merge(), and cairo_font_options_hash() in
3128 * procedural way) should be used to copy, check for equality, merge, or
3129 * compute a hash value of CairoFontOptions objects.
3130 **/
3131class CairoFontOptions {
3132    /**
3133     * The equal purpose
3134     *
3135     * The method description goes here.
3136     *
3137     * @param CairoFontOptions $other Description...
3138     * @return bool Description...
3139     * @since PECL cairo >= 0.1.0
3140     **/
3141    public function equal($other){}
3142
3143    /**
3144     * The getAntialias purpose
3145     *
3146     * @return int Description...
3147     * @since PECL cairo >= 0.1.0
3148     **/
3149    public function getAntialias(){}
3150
3151    /**
3152     * The getHintMetrics purpose
3153     *
3154     * The method description goes here.
3155     *
3156     * @return int Description...
3157     * @since PECL cairo >= 0.1.0
3158     **/
3159    public function getHintMetrics(){}
3160
3161    /**
3162     * The getHintStyle purpose
3163     *
3164     * The method description goes here.
3165     *
3166     * @return int Description...
3167     * @since PECL cairo >= 0.1.0
3168     **/
3169    public function getHintStyle(){}
3170
3171    /**
3172     * The getSubpixelOrder purpose
3173     *
3174     * The method description goes here.
3175     *
3176     * @return int Description...
3177     * @since PECL cairo >= 0.1.0
3178     **/
3179    public function getSubpixelOrder(){}
3180
3181    /**
3182     * The hash purpose
3183     *
3184     * The method description goes here.
3185     *
3186     * @return int Description...
3187     * @since PECL cairo >= 0.1.0
3188     **/
3189    public function hash(){}
3190
3191    /**
3192     * The merge purpose
3193     *
3194     * The method description goes here.
3195     *
3196     * @param CairoFontOptions $other Description...
3197     * @return void Description...
3198     * @since PECL cairo >= 0.1.0
3199     **/
3200    public function merge($other){}
3201
3202    /**
3203     * The setAntialias purpose
3204     *
3205     * @param int $antialias Description...
3206     * @return void Description...
3207     * @since PECL cairo >= 0.1.0
3208     **/
3209    public function setAntialias($antialias){}
3210
3211    /**
3212     * The setHintMetrics purpose
3213     *
3214     * The method description goes here.
3215     *
3216     * @param int $hint_metrics Description...
3217     * @return void Description...
3218     * @since PECL cairo >= 0.1.0
3219     **/
3220    public function setHintMetrics($hint_metrics){}
3221
3222    /**
3223     * The setHintStyle purpose
3224     *
3225     * The method description goes here.
3226     *
3227     * @param int $hint_style Description...
3228     * @return void Description...
3229     * @since PECL cairo >= 0.1.0
3230     **/
3231    public function setHintStyle($hint_style){}
3232
3233    /**
3234     * The setSubpixelOrder purpose
3235     *
3236     * The method description goes here.
3237     *
3238     * @param int $subpixel_order Description...
3239     * @return void Description...
3240     * @since PECL cairo >= 0.1.0
3241     **/
3242    public function setSubpixelOrder($subpixel_order){}
3243
3244    /**
3245     * The status purpose
3246     *
3247     * @return int Description...
3248     * @since PECL cairo >= 0.1.0
3249     **/
3250    public function status(){}
3251
3252    /**
3253     * The __construct purpose
3254     *
3255     * The method description goes here.
3256     *
3257     * @since PECL cairo >= 0.1.0
3258     **/
3259    public function __construct(){}
3260
3261}
3262/**
3263 * Specifies variants of a font face based on their slant.
3264 **/
3265class CairoFontSlant {
3266    /**
3267     * Italic font style
3268     *
3269     * @var integer
3270     **/
3271    const ITALIC = 0;
3272
3273    /**
3274     * Upright font style
3275     *
3276     * @var integer
3277     **/
3278    const NORMAL = 0;
3279
3280    /**
3281     * Oblique font style
3282     *
3283     * @var integer
3284     **/
3285    const OBLIQUE = 0;
3286
3287}
3288/**
3289 * CairoFontType class is an abstract final class that contains constants
3290 * used to describe the type of a given CairoFontFace or CairoScaledFont.
3291 * The font types are also known as "font backends" within cairo. The
3292 * type of a CairoFontFace is determined by the how it is created, an
3293 * example would be the CairoToyFontFace::__construct. The CairoFontFace
3294 * type can be queried with CairoFontFace::getType or {@link
3295 * cairo_font_face_get_type} The various CairoFontFace functions can be
3296 * used with a font face of any type. The type of a CairoScaledFont is
3297 * determined by the type of the CairoFontFace passed to
3298 * CairoScaledFont::__construct or {@link cairo_scaled_font_create}. The
3299 * scaled font type can be queried with CairoScaledFont::getType or
3300 * {@link cairo_scaled_font_get_type}.
3301 **/
3302class CairoFontType {
3303    /**
3304     * The font is of type CairoFreeType
3305     *
3306     * @var integer
3307     **/
3308    const FT = 0;
3309
3310    /**
3311     * The font is of type Quartz
3312     *
3313     * @var integer
3314     **/
3315    const QUARTZ = 0;
3316
3317    /**
3318     * The font was created using CairoToyFont api
3319     *
3320     * @var integer
3321     **/
3322    const TOY = 0;
3323
3324    /**
3325     * The font was create using cairo's user font api
3326     *
3327     * @var mixed
3328     **/
3329    const USER = 0;
3330
3331    /**
3332     * The font is of type Win32
3333     *
3334     * @var integer
3335     **/
3336    const WIN32 = 0;
3337
3338}
3339/**
3340 * Specifies variants of a font face based on their weight.
3341 **/
3342class CairoFontWeight {
3343    /**
3344     * Bold font weight
3345     *
3346     * @var integer
3347     **/
3348    const BOLD = 0;
3349
3350    /**
3351     * Normal font weight
3352     *
3353     * @var integer
3354     **/
3355    const NORMAL = 0;
3356
3357}
3358/**
3359 * CairoFormat enums are used to identify the memory format of the image
3360 * data.
3361 **/
3362class CairoFormat {
3363    /**
3364     * Each pixel is a 1-bit quantity holding an alpha value. Pixels are
3365     * packed together into 32-bit quantities. The ordering of the bits
3366     * matches the endianness of the platform. On a big-endian machine, the
3367     * first pixel is in the uppermost bit, on a little-endian machine the
3368     * first pixel is in the least-significant bit.
3369     *
3370     * @var integer
3371     **/
3372    const A1 = 0;
3373
3374    /**
3375     * Each pixel is a 8-bit quantity holding an alpha value.
3376     *
3377     * @var integer
3378     **/
3379    const A8 = 0;
3380
3381    /**
3382     * Each pixel is a 32-bit quantity, with alpha in the upper 8 bits, then
3383     * red, then green, then blue. The 32-bit quantities are stored
3384     * native-endian. Pre-multiplied alpha is used. (That is, 50% transparent
3385     * red is 0x80800000, not 0x80ff0000.)
3386     *
3387     * @var integer
3388     **/
3389    const ARGB32 = 0;
3390
3391    /**
3392     * Each pixel is a 32-bit quantity, with the upper 8 bits unused. Red,
3393     * Green, and Blue are stored in the remaining 24 bits in that order.
3394     *
3395     * @var integer
3396     **/
3397    const RGB24 = 0;
3398
3399    /**
3400     * Provides an appropriate stride to use
3401     *
3402     * This method provides a stride value that will respect all alignment
3403     * requirements of the accelerated image-rendering code within cairo.
3404     *
3405     * @param int $format The desired CairoFormat to use
3406     * @param int $width The width of the image
3407     * @return int The appropriate stride to use given the desired format
3408     *   and width, or -1 if either the format is invalid or the width too
3409     *   large.
3410     * @since PECL cairo >= 0.1.0
3411     **/
3412    public static function strideForWidth($format, $width){}
3413
3414}
3415/**
3416 * CairoGradientPattern is an abstract base class from which other
3417 * Pattern classes derive. It cannot be instantiated directly.
3418 **/
3419class CairoGradientPattern extends CairoPattern {
3420    /**
3421     * The addColorStopRgb purpose
3422     *
3423     * The method description goes here.
3424     *
3425     * @param float $offset Description...
3426     * @param float $red Description...
3427     * @param float $green Description...
3428     * @param float $blue Description...
3429     * @return void Description...
3430     * @since PECL cairo >= 0.1.0
3431     **/
3432    public function addColorStopRgb($offset, $red, $green, $blue){}
3433
3434    /**
3435     * The addColorStopRgba purpose
3436     *
3437     * The method description goes here.
3438     *
3439     * @param float $offset Description...
3440     * @param float $red Description...
3441     * @param float $green Description...
3442     * @param float $blue Description...
3443     * @param float $alpha Description...
3444     * @return void Description...
3445     * @since PECL cairo >= 0.1.0
3446     **/
3447    public function addColorStopRgba($offset, $red, $green, $blue, $alpha){}
3448
3449    /**
3450     * The getColorStopCount purpose
3451     *
3452     * The method description goes here.
3453     *
3454     * @return int Description...
3455     * @since PECL cairo >= 0.1.0
3456     **/
3457    public function getColorStopCount(){}
3458
3459    /**
3460     * The getColorStopRgba purpose
3461     *
3462     * The method description goes here.
3463     *
3464     * @param int $index Description...
3465     * @return array Description...
3466     * @since PECL cairo >= 0.1.0
3467     **/
3468    public function getColorStopRgba($index){}
3469
3470    /**
3471     * The getExtend purpose
3472     *
3473     * The method description goes here.
3474     *
3475     * @return int Description...
3476     * @since PECL cairo >= 0.1.0
3477     **/
3478    public function getExtend(){}
3479
3480    /**
3481     * The setExtend purpose
3482     *
3483     * The method description goes here.
3484     *
3485     * @param int $extend Description...
3486     * @return void Description...
3487     * @since PECL cairo >= 0.1.0
3488     **/
3489    public function setExtend($extend){}
3490
3491}
3492/**
3493 * Specifies whether to hint font metrics; hinting font metrics means
3494 * quantizing them so that they are integer values in device space. Doing
3495 * this improves the consistency of letter and line spacing, however it
3496 * also means that text will be laid out differently at different zoom
3497 * factors.
3498 **/
3499class CairoHintMetrics {
3500    /**
3501     * @var integer
3502     **/
3503    const METRICS_DEFAULT = 0;
3504
3505    /**
3506     * @var integer
3507     **/
3508    const METRICS_OFF = 0;
3509
3510    /**
3511     * @var integer
3512     **/
3513    const METRICS_ON = 0;
3514
3515}
3516/**
3517 * Specifies the type of hinting to do on font outlines. Hinting is the
3518 * process of fitting outlines to the pixel grid in order to improve the
3519 * appearance of the result. Since hinting outlines involves distorting
3520 * them, it also reduces the faithfulness to the original outline shapes.
3521 * Not all of the outline hinting styles are supported by all font
3522 * backends.
3523 **/
3524class CairoHintStyle {
3525    /**
3526     * @var integer
3527     **/
3528    const STYLE_DEFAULT = 0;
3529
3530    /**
3531     * @var integer
3532     **/
3533    const STYLE_FULL = 0;
3534
3535    /**
3536     * @var integer
3537     **/
3538    const STYLE_MEDIUM = 0;
3539
3540    /**
3541     * @var integer
3542     **/
3543    const STYLE_NONE = 0;
3544
3545    /**
3546     * @var integer
3547     **/
3548    const STYLE_SLIGHT = 0;
3549
3550}
3551/**
3552 * CairoImageSurface provide the ability to render to memory buffers
3553 * either allocated by cairo or by the calling code. The supported image
3554 * formats are those defined in CairoFormat.
3555 **/
3556class CairoImageSurface extends CairoSurface {
3557    /**
3558     * The createForData purpose
3559     *
3560     * The method description goes here.
3561     *
3562     * @param string $data Description...
3563     * @param int $format Description...
3564     * @param int $width Description...
3565     * @param int $height Description...
3566     * @return void Description...
3567     * @since PECL cairo >= 0.1.0
3568     **/
3569    public static function createForData($data, $format, $width, $height){}
3570
3571    /**
3572     * Creates a new CairoImageSurface form a png image file
3573     *
3574     * This method should be called static
3575     *
3576     * @param string $file Path to PNG image file
3577     * @return CairoImageSurface CairoImageSurface object
3578     * @since PECL cairo >= 0.1.0
3579     **/
3580    public static function createFromPng($file){}
3581
3582    /**
3583     * Gets the image data as string
3584     *
3585     * Returns the image data of this surface or NULL if surface is not an
3586     * image surface, or if CairoContext::finish, procedural : {@link
3587     * cairo_surface_finish}, has been called.
3588     *
3589     * @return string The image data as string
3590     * @since PECL cairo >= 0.1.0
3591     **/
3592    public function getData(){}
3593
3594    /**
3595     * Get the image format
3596     *
3597     * Retrieves the image format, as one of the CairoFormat defined
3598     *
3599     * @return int One of the CairoFormat enums
3600     * @since PECL cairo >= 0.1.0
3601     **/
3602    public function getFormat(){}
3603
3604    /**
3605     * Retrieves the height of the CairoImageSurface
3606     *
3607     * This methods returns the CairoImageSurface height.
3608     *
3609     * @return int CairoImageSurface object height
3610     * @since PECL cairo >= 0.1.0
3611     **/
3612    public function getHeight(){}
3613
3614    /**
3615     * The getStride purpose
3616     *
3617     * The method description goes here.
3618     *
3619     * @return int Description...
3620     * @since PECL cairo >= 0.1.0
3621     **/
3622    public function getStride(){}
3623
3624    /**
3625     * Retrieves the width of the CairoImageSurface
3626     *
3627     * Gets the width of the CairoImageSurface
3628     *
3629     * @return int Returns the width of the CairoImageSurface object
3630     * @since PECL cairo >= 0.1.0
3631     **/
3632    public function getWidth(){}
3633
3634    /**
3635     * Creates a new CairoImageSurface
3636     *
3637     * Creates a new CairoImageSuface object of type {@link format}
3638     *
3639     * @param int $format Can be any defined in CairoFormat
3640     * @param int $width The width of the image surface
3641     * @param int $height The height of the image surface
3642     * @since PECL cairo >= 0.1.0
3643     **/
3644    public function __construct($format, $width, $height){}
3645
3646}
3647/**
3648 * Create a new CairoLinearGradient along the line defined
3649 **/
3650class CairoLinearGradient extends CairoGradientPattern {
3651    /**
3652     * The getPoints purpose
3653     *
3654     * The method description goes here.
3655     *
3656     * @return array Description...
3657     * @since PECL cairo >= 0.1.0
3658     **/
3659    public function getPoints(){}
3660
3661    /**
3662     * The __construct purpose
3663     *
3664     * The method description goes here.
3665     *
3666     * @param float $x0 Description...
3667     * @param float $y0 Description...
3668     * @param float $x1 Description...
3669     * @param float $y1 Description...
3670     * @since PECL cairo >= 0.1.0
3671     **/
3672    public function __construct($x0, $y0, $x1, $y1){}
3673
3674}
3675/**
3676 * Specifies how to render the endpoints of the path when stroking. The
3677 * default line cap style is CairoLineCap::BUTT.
3678 **/
3679class CairoLineCap {
3680    /**
3681     * Start(stop) the line exactly at the start(end) point
3682     *
3683     * @var integer
3684     **/
3685    const BUTT = 0;
3686
3687    /**
3688     * Use a round ending, the center of the circle is the end point
3689     *
3690     * @var integer
3691     **/
3692    const ROUND = 0;
3693
3694    /**
3695     * Use squared ending, the center of the square is the end point
3696     *
3697     * @var integer
3698     **/
3699    const SQUARE = 0;
3700
3701}
3702class CairoLineJoin {
3703    /**
3704     * @var integer
3705     **/
3706    const BEVEL = 0;
3707
3708    /**
3709     * @var integer
3710     **/
3711    const MITER = 0;
3712
3713    /**
3714     * @var integer
3715     **/
3716    const ROUND = 0;
3717
3718}
3719/**
3720 * Matrices are used throughout cairo to convert between different
3721 * coordinate spaces.
3722 **/
3723class CairoMatrix {
3724    /**
3725     * Creates a new identity matrix
3726     *
3727     * Creates a new matrix that is an identity transformation. An identity
3728     * transformation means the source data is copied into the destination
3729     * data without change
3730     *
3731     * @return void Returns a new CairoMatrix object that can be used with
3732     *   surfaces, contexts, and patterns.
3733     * @since PECL cairo >= 0.1.0
3734     **/
3735    public static function initIdentity(){}
3736
3737    /**
3738     * Creates a new rotated matrix
3739     *
3740     * Creates a new matrix to a transformation that rotates by radians
3741     * provided
3742     *
3743     * @param float $radians angle of rotation, in radians. The direction
3744     *   of rotation is defined such that positive angles rotate in the
3745     *   direction from the positive X axis toward the positive Y axis. With
3746     *   the default axis orientation of cairo, positive angles rotate in a
3747     *   clockwise direction.
3748     * @return void Returns a new CairoMatrix object that can be used with
3749     *   surfaces, contexts, and patterns.
3750     * @since PECL cairo >= 0.1.0
3751     **/
3752    public static function initRotate($radians){}
3753
3754    /**
3755     * Creates a new scaling matrix
3756     *
3757     * Creates a new matrix to a transformation that scales by sx and sy in
3758     * the X and Y dimensions, respectively.
3759     *
3760     * @param float $sx scale factor in the X direction
3761     * @param float $sy scale factor in the Y direction
3762     * @return void Returns a new CairoMatrix object that can be used with
3763     *   surfaces, contexts, and patterns.
3764     * @since PECL cairo >= 0.1.0
3765     **/
3766    public static function initScale($sx, $sy){}
3767
3768    /**
3769     * Creates a new translation matrix
3770     *
3771     * Creates a new matrix to a transformation that translates by tx and ty
3772     * in the X and Y dimensions, respectively.
3773     *
3774     * @param float $tx amount to translate in the X direction
3775     * @param float $ty amount to translate in the Y direction
3776     * @return void Returns a new CairoMatrix object that can be used with
3777     *   surfaces, contexts, and patterns.
3778     * @since PECL cairo >= 0.1.0
3779     **/
3780    public static function initTranslate($tx, $ty){}
3781
3782    /**
3783     * The invert purpose
3784     *
3785     * The method description goes here.
3786     *
3787     * @return void Description...
3788     * @since PECL cairo >= 0.1.0
3789     **/
3790    public function invert(){}
3791
3792    /**
3793     * The multiply purpose
3794     *
3795     * The method description goes here.
3796     *
3797     * @param CairoMatrix $matrix1 Description...
3798     * @param CairoMatrix $matrix2 Description...
3799     * @return CairoMatrix Description...
3800     * @since PECL cairo >= 0.1.0
3801     **/
3802    public static function multiply($matrix1, $matrix2){}
3803
3804    /**
3805     * The rotate purpose
3806     *
3807     * @param float $radians Description...
3808     * @return void Description...
3809     * @since PECL cairo >= 0.1.0
3810     **/
3811    public function rotate($radians){}
3812
3813    /**
3814     * Applies scaling to a matrix
3815     *
3816     * Applies scaling by sx, sy to the transformation in the matrix. The
3817     * effect of the new transformation is to first scale the coordinates by
3818     * sx and sy, then apply the original transformation to the coordinates.
3819     *
3820     * @param float $sx Procedural only - CairoMatrix instance
3821     * @param float $sy scale factor in the X direction
3822     * @return void
3823     * @since PECL cairo >= 0.1.0
3824     **/
3825    public function scale($sx, $sy){}
3826
3827    /**
3828     * The transformDistance purpose
3829     *
3830     * The method description goes here.
3831     *
3832     * @param float $dx Description...
3833     * @param float $dy Description...
3834     * @return array Description...
3835     * @since PECL cairo >= 0.1.0
3836     **/
3837    public function transformDistance($dx, $dy){}
3838
3839    /**
3840     * The transformPoint purpose
3841     *
3842     * The method description goes here.
3843     *
3844     * @param float $dx Description...
3845     * @param float $dy Description...
3846     * @return array Description...
3847     * @since PECL cairo >= 0.1.0
3848     **/
3849    public function transformPoint($dx, $dy){}
3850
3851    /**
3852     * The translate purpose
3853     *
3854     * @param float $tx Description...
3855     * @param float $ty Description...
3856     * @return void Description...
3857     * @since PECL cairo >= 0.1.0
3858     **/
3859    public function translate($tx, $ty){}
3860
3861    /**
3862     * Creates a new CairoMatrix object
3863     *
3864     * Returns new CairoMatrix object. Matrices are used throughout cairo to
3865     * convert between different coordinate spaces. Sets matrix to be the
3866     * affine transformation given by xx, yx, xy, yy, x0, y0. The
3867     * transformation is given by: x_new = xx * x + xy * y + x0; and y_new =
3868     * yx * x + yy * y + y0;
3869     *
3870     * @param float $xx xx component of the affine transformation
3871     * @param float $yx yx component of the affine transformation
3872     * @param float $xy xy component of the affine transformation
3873     * @param float $yy yy component of the affine transformation
3874     * @param float $x0 X translation component of the affine
3875     *   transformation
3876     * @param float $y0 Y translation component of the affine
3877     *   transformation
3878     * @since PECL cairo >= 0.1.0
3879     **/
3880    public function __construct($xx, $yx, $xy, $yy, $x0, $y0){}
3881
3882}
3883/**
3884 * This is used to set the compositing operator for all cairo drawing
3885 * operations. The default operator is CairoOperator::OVER The operators
3886 * marked as unbounded modify their destination even outside of the mask
3887 * layer (that is, their effect is not bound by the mask layer). However,
3888 * their effect can still be limited by way of clipping. To keep things
3889 * simple, the operator descriptions here document the behavior for when
3890 * both source and destination are either fully transparent or fully
3891 * opaque. The actual implementation works for translucent layers too.
3892 * For a more detailed explanation of the effects of each operator,
3893 * including the mathematical definitions, see
3894 * http://cairographics.org/operators/.
3895 **/
3896class CairoOperator {
3897    /**
3898     * Source and destination layers are accumulated
3899     *
3900     * @var integer
3901     **/
3902    const ADD = 0;
3903
3904    /**
3905     * Draw source on top of destination content and only there
3906     *
3907     * @var integer
3908     **/
3909    const ATOP = 0;
3910
3911    /**
3912     * Clear destination layer (bounded)
3913     *
3914     * @var integer
3915     **/
3916    const CLEAR = 0;
3917
3918    /**
3919     * Ignore the source
3920     *
3921     * @var integer
3922     **/
3923    const DEST = 0;
3924
3925    /**
3926     * @var integer
3927     **/
3928    const DEST_ATOP = 0;
3929
3930    /**
3931     * @var integer
3932     **/
3933    const DEST_IN = 0;
3934
3935    /**
3936     * @var integer
3937     **/
3938    const DEST_OUT = 0;
3939
3940    /**
3941     * @var integer
3942     **/
3943    const DEST_OVER = 0;
3944
3945    /**
3946     * Draw source where there was destination content (unbounded)
3947     *
3948     * @var integer
3949     **/
3950    const IN = 0;
3951
3952    /**
3953     * Draw source where there was no destination content (unbounded)
3954     *
3955     * @var integer
3956     **/
3957    const OUT = 0;
3958
3959    /**
3960     * Draw source layer on top of destination layer (bounded)
3961     *
3962     * @var integer
3963     **/
3964    const OVER = 0;
3965
3966    /**
3967     * Like CairoOperator::OVER, but assuming source and dest are disjoint
3968     * geometries
3969     *
3970     * @var integer
3971     **/
3972    const SATURATE = 0;
3973
3974    /**
3975     * Replace destination layer (bounded)
3976     *
3977     * @var integer
3978     **/
3979    const SOURCE = 0;
3980
3981    /**
3982     * Source and destination are shown where there is only one of them
3983     *
3984     * @var integer
3985     **/
3986    const XOR = 0;
3987
3988}
3989/**
3990 * Note: CairoPath class cannot be instantiated directly, doing so will
3991 * result in Fatal Error if used or passed
3992 **/
3993class CairoPath {
3994}
3995/**
3996 * CairoPattern is the abstract base class from which all the other
3997 * pattern classes derive. It cannot be instantiated directly
3998 **/
3999class CairoPattern {
4000    /**
4001     * The getMatrix purpose
4002     *
4003     * @return void Description...
4004     * @since PECL cairo >= 0.1.0
4005     **/
4006    public function getMatrix(){}
4007
4008    /**
4009     * The getType purpose
4010     *
4011     * The method description goes here.
4012     *
4013     * @return int Description...
4014     * @since PECL cairo >= 0.1.0
4015     **/
4016    public function getType(){}
4017
4018    /**
4019     * The setMatrix purpose
4020     *
4021     * @param CairoMatrix $matrix Description...
4022     * @return void Description...
4023     * @since PECL cairo >= 0.1.0
4024     **/
4025    public function setMatrix($matrix){}
4026
4027    /**
4028     * The status purpose
4029     *
4030     * @return int Description...
4031     * @since PECL cairo >= 0.1.0
4032     **/
4033    public function status(){}
4034
4035    /**
4036     * The __construct purpose
4037     *
4038     * The method description goes here.
4039     *
4040     * @since PECL cairo >= 0.1.0
4041     **/
4042    public function __construct(){}
4043
4044}
4045/**
4046 * CairoPatternType is used to describe the type of a given pattern. The
4047 * type of a pattern is determined by the function used to create it. The
4048 * {@link cairo_pattern_create_rgb} and {@link cairo_pattern_create_rgba}
4049 * functions create CairoPatternType::SOLID patterns. The remaining
4050 * cairo_pattern_create_* functions map to pattern types in obvious ways.
4051 **/
4052class CairoPatternType {
4053    /**
4054     * The pattern is a linear gradient.
4055     *
4056     * @var integer
4057     **/
4058    const LINEAR = 0;
4059
4060    /**
4061     * The pattern is a radial gradient.
4062     *
4063     * @var integer
4064     **/
4065    const RADIAL = 0;
4066
4067    /**
4068     * The pattern is a solid (uniform) color. It may be opaque or
4069     * translucent.
4070     *
4071     * @var integer
4072     **/
4073    const SOLID = 0;
4074
4075    /**
4076     * The pattern is a based on a surface (an image).
4077     *
4078     * @var integer
4079     **/
4080    const SURFACE = 0;
4081
4082}
4083class CairoPdfSurface extends CairoSurface {
4084    /**
4085     * The setSize purpose
4086     *
4087     * The method description goes here.
4088     *
4089     * @param float $width Description...
4090     * @param float $height Description...
4091     * @return void Description...
4092     * @since PECL cairo >= 0.1.0
4093     **/
4094    public function setSize($width, $height){}
4095
4096    /**
4097     * The __construct purpose
4098     *
4099     * The method description goes here.
4100     *
4101     * @param string $file Description...
4102     * @param float $width Description...
4103     * @param float $height Description...
4104     * @since PECL cairo >= 0.1.0
4105     **/
4106    public function __construct($file, $width, $height){}
4107
4108}
4109class CairoPsLevel {
4110    /**
4111     * @var integer
4112     **/
4113    const LEVEL_2 = 0;
4114
4115    /**
4116     * @var integer
4117     **/
4118    const LEVEL_3 = 0;
4119
4120}
4121class CairoPsSurface extends CairoSurface {
4122    /**
4123     * The dscBeginPageSetup purpose
4124     *
4125     * The method description goes here.
4126     *
4127     * @return void Description...
4128     * @since PECL cairo >= 0.1.0
4129     **/
4130    public function dscBeginPageSetup(){}
4131
4132    /**
4133     * The dscBeginSetup purpose
4134     *
4135     * The method description goes here.
4136     *
4137     * @return void Description...
4138     * @since PECL cairo >= 0.1.0
4139     **/
4140    public function dscBeginSetup(){}
4141
4142    /**
4143     * The dscComment purpose
4144     *
4145     * The method description goes here.
4146     *
4147     * @param string $comment Description...
4148     * @return void Description...
4149     * @since PECL cairo >= 0.1.0
4150     **/
4151    public function dscComment($comment){}
4152
4153    /**
4154     * The getEps purpose
4155     *
4156     * The method description goes here.
4157     *
4158     * @return bool Description...
4159     * @since PECL cairo >= 0.1.0
4160     **/
4161    public function getEps(){}
4162
4163    /**
4164     * The getLevels purpose
4165     *
4166     * The method description goes here.
4167     *
4168     * @return array Description...
4169     * @since PECL cairo >= 0.1.0
4170     **/
4171    public static function getLevels(){}
4172
4173    /**
4174     * The levelToString purpose
4175     *
4176     * The method description goes here.
4177     *
4178     * @param int $level Description...
4179     * @return string Description...
4180     * @since PECL cairo >= 0.1.0
4181     **/
4182    public static function levelToString($level){}
4183
4184    /**
4185     * The restrictToLevel purpose
4186     *
4187     * The method description goes here.
4188     *
4189     * @param int $level Description...
4190     * @return void Description...
4191     * @since PECL cairo >= 0.1.0
4192     **/
4193    public function restrictToLevel($level){}
4194
4195    /**
4196     * The setEps purpose
4197     *
4198     * The method description goes here.
4199     *
4200     * @param bool $level Description...
4201     * @return void Description...
4202     * @since PECL cairo >= 0.1.0
4203     **/
4204    public function setEps($level){}
4205
4206    /**
4207     * The setSize purpose
4208     *
4209     * The method description goes here.
4210     *
4211     * @param float $width Description...
4212     * @param float $height Description...
4213     * @return void Description...
4214     * @since PECL cairo >= 0.1.0
4215     **/
4216    public function setSize($width, $height){}
4217
4218    /**
4219     * The __construct purpose
4220     *
4221     * The method description goes here.
4222     *
4223     * @param string $file Description...
4224     * @param float $width Description...
4225     * @param float $height Description...
4226     * @since PECL cairo >= 0.1.0
4227     **/
4228    public function __construct($file, $width, $height){}
4229
4230}
4231class CairoRadialGradient extends CairoGradientPattern {
4232    /**
4233     * The getCircles purpose
4234     *
4235     * The method description goes here.
4236     *
4237     * @return array Description...
4238     * @since PECL cairo >= 0.1.0
4239     **/
4240    public function getCircles(){}
4241
4242    /**
4243     * The __construct purpose
4244     *
4245     * Creates a new radial gradient CairoPattern between the two circles
4246     * defined by (x0, y0, r0) and (x1, y1, r1). Before using the gradient
4247     * pattern, a number of color stops should be defined using
4248     * CairoRadialGradient::addColorStopRgb or
4249     * CairoRadialGradient::addColorStopRgba.
4250     *
4251     * Note: The coordinates here are in pattern space. For a new pattern,
4252     * pattern space is identical to user space, but the relationship between
4253     * the spaces can be changed with CairoRadialGradient::setMatrix.
4254     *
4255     * @param float $x0 x coordinate for the center of the start circle.
4256     * @param float $y0 y coordinate for the center of the start circle.
4257     * @param float $r0 radius of the start circle.
4258     * @param float $x1 x coordinate for the center of the end circle.
4259     * @param float $y1 y coordinate for the center of the end circle.
4260     * @param float $r1 radius of the end circle.
4261     * @since PECL cairo >= 0.1.0
4262     **/
4263    public function __construct($x0, $y0, $r0, $x1, $y1, $r1){}
4264
4265}
4266class CairoScaledFont {
4267    /**
4268     * The extents purpose
4269     *
4270     * The method description goes here.
4271     *
4272     * @return array Description...
4273     * @since PECL cairo >= 0.1.0
4274     **/
4275    public function extents(){}
4276
4277    /**
4278     * The getCtm purpose
4279     *
4280     * The method description goes here.
4281     *
4282     * @return CairoMatrix Description...
4283     * @since PECL cairo >= 0.1.0
4284     **/
4285    public function getCtm(){}
4286
4287    /**
4288     * The getFontFace purpose
4289     *
4290     * @return void Description...
4291     * @since PECL cairo >= 0.1.0
4292     **/
4293    public function getFontFace(){}
4294
4295    /**
4296     * The getFontMatrix purpose
4297     *
4298     * @return void Description...
4299     * @since PECL cairo >= 0.1.0
4300     **/
4301    public function getFontMatrix(){}
4302
4303    /**
4304     * The getFontOptions purpose
4305     *
4306     * @return void Description...
4307     * @since PECL cairo >= 0.1.0
4308     **/
4309    public function getFontOptions(){}
4310
4311    /**
4312     * The getScaleMatrix purpose
4313     *
4314     * The method description goes here.
4315     *
4316     * @return void Description...
4317     * @since PECL cairo >= 0.1.0
4318     **/
4319    public function getScaleMatrix(){}
4320
4321    /**
4322     * The getType purpose
4323     *
4324     * The method description goes here.
4325     *
4326     * @return int Description...
4327     * @since PECL cairo >= 0.1.0
4328     **/
4329    public function getType(){}
4330
4331    /**
4332     * The glyphExtents purpose
4333     *
4334     * The method description goes here.
4335     *
4336     * @param array $glyphs Description...
4337     * @return array Description...
4338     * @since PECL cairo >= 0.1.0
4339     **/
4340    public function glyphExtents($glyphs){}
4341
4342    /**
4343     * The status purpose
4344     *
4345     * @return int Description...
4346     * @since PECL cairo >= 0.1.0
4347     **/
4348    public function status(){}
4349
4350    /**
4351     * The textExtents purpose
4352     *
4353     * @param string $text Description...
4354     * @return array Description...
4355     * @since PECL cairo >= 0.1.0
4356     **/
4357    public function textExtents($text){}
4358
4359    /**
4360     * The __construct purpose
4361     *
4362     * The method description goes here.
4363     *
4364     * @param CairoFontFace $font_face Description...
4365     * @param CairoMatrix $matrix Description...
4366     * @param CairoMatrix $ctm Description...
4367     * @param CairoFontOptions $options Description...
4368     * @since PECL cairo >= 0.1.0
4369     **/
4370    public function __construct($font_face, $matrix, $ctm, $options){}
4371
4372}
4373class CairoSolidPattern extends CairoPattern {
4374    /**
4375     * The getRgba purpose
4376     *
4377     * The method description goes here.
4378     *
4379     * @return array Description...
4380     * @since PECL cairo >= 0.1.0
4381     **/
4382    public function getRgba(){}
4383
4384    /**
4385     * The __construct purpose
4386     *
4387     * The method description goes here.
4388     *
4389     * @param float $red Description...
4390     * @param float $green Description...
4391     * @param float $blue Description...
4392     * @param float $alpha Description...
4393     * @since PECL cairo >= 0.1.0
4394     **/
4395    public function __construct($red, $green, $blue, $alpha){}
4396
4397}
4398/**
4399 * CairoStatus is used to indicate errors that can occur when using
4400 * Cairo. In some cases it is returned directly by functions. but when
4401 * using CairoContext, the last error, if any, is stored in the object
4402 * and can be retrieved with CairoContext::status or {@link
4403 * cairo_status}. New entries may be added in future versions. Use
4404 * Cairo::statusToString or {@link cairo_status_to_string} to get a
4405 * human-readable representation of an error message.
4406 **/
4407class CairoStatus {
4408    /**
4409     * @var integer
4410     **/
4411    const CLIP_NOT_REPRESENTABLE = 0;
4412
4413    /**
4414     * @var integer
4415     **/
4416    const FILE_NOT_FOUND = 0;
4417
4418    /**
4419     * @var integer
4420     **/
4421    const INVALID_CONTENT = 0;
4422
4423    /**
4424     * @var integer
4425     **/
4426    const INVALID_DASH = 0;
4427
4428    /**
4429     * @var integer
4430     **/
4431    const INVALID_DSC_COMMENT = 0;
4432
4433    /**
4434     * @var integer
4435     **/
4436    const INVALID_FORMAT = 0;
4437
4438    /**
4439     * @var integer
4440     **/
4441    const INVALID_INDEX = 0;
4442
4443    /**
4444     * @var integer
4445     **/
4446    const INVALID_MATRIX = 0;
4447
4448    /**
4449     * @var integer
4450     **/
4451    const INVALID_PATH_DATA = 0;
4452
4453    /**
4454     * @var integer
4455     **/
4456    const INVALID_POP_GROUP = 0;
4457
4458    /**
4459     * @var integer
4460     **/
4461    const INVALID_RESTORE = 0;
4462
4463    /**
4464     * @var integer
4465     **/
4466    const INVALID_STATUS = 0;
4467
4468    /**
4469     * @var integer
4470     **/
4471    const INVALID_STRIDE = 0;
4472
4473    /**
4474     * @var integer
4475     **/
4476    const INVALID_STRING = 0;
4477
4478    /**
4479     * @var integer
4480     **/
4481    const INVALID_VISUAL = 0;
4482
4483    /**
4484     * @var integer
4485     **/
4486    const NO_CURRENT_POINT = 0;
4487
4488    /**
4489     * @var integer
4490     **/
4491    const NO_MEMORY = 0;
4492
4493    /**
4494     * @var integer
4495     **/
4496    const NULL_POINTER = 0;
4497
4498    /**
4499     * @var integer
4500     **/
4501    const PATTERN_TYPE_MISMATCH = 0;
4502
4503    /**
4504     * @var integer
4505     **/
4506    const READ_ERROR = 0;
4507
4508    /**
4509     * No error has occurred
4510     *
4511     * @var integer
4512     **/
4513    const SUCCESS = 0;
4514
4515    /**
4516     * @var integer
4517     **/
4518    const SURFACE_FINISHED = 0;
4519
4520    /**
4521     * @var integer
4522     **/
4523    const SURFACE_TYPE_MISMATCH = 0;
4524
4525    /**
4526     * @var integer
4527     **/
4528    const TEMP_FILE_ERROR = 0;
4529
4530    /**
4531     * @var integer
4532     **/
4533    const WRITE_ERROR = 0;
4534
4535}
4536class CairoSubpixelOrder {
4537    /**
4538     * @var integer
4539     **/
4540    const ORDER_BGR = 0;
4541
4542    /**
4543     * @var integer
4544     **/
4545    const ORDER_DEFAULT = 0;
4546
4547    /**
4548     * @var integer
4549     **/
4550    const ORDER_RGB = 0;
4551
4552    /**
4553     * @var integer
4554     **/
4555    const ORDER_VBGR = 0;
4556
4557    /**
4558     * @var integer
4559     **/
4560    const ORDER_VRGB = 0;
4561
4562}
4563/**
4564 * This is the base-class for all other Surface types. CairoSurface is
4565 * the abstract type representing all different drawing targets that
4566 * cairo can render to. The actual drawings are performed using a
4567 * CairoContext.
4568 **/
4569class CairoSurface {
4570    /**
4571     * The copyPage purpose
4572     *
4573     * Emits the current page for backends that support multiple pages, but
4574     * doesn't clear it, so that the contents of the current page will be
4575     * retained for the next page. Use CairoSurface::showPage() if you want
4576     * to get an empty page after the emission.
4577     *
4578     * @return void Description...
4579     * @since PECL cairo >= 0.1.0
4580     **/
4581    public function copyPage(){}
4582
4583    /**
4584     * The createSimilar purpose
4585     *
4586     * Create a new surface that is as compatible as possible with an
4587     * existing surface. For example the new surface will have the same
4588     * fallback resolution and font options as other. Generally, the new
4589     * surface will also use the same backend as other, unless that is not
4590     * possible for some reason. The type of the returned surface may be
4591     * examined with CairoSurface::getType(). Initially the surface contents
4592     * are all 0 (transparent if contents have transparency, black
4593     * otherwise.)
4594     *
4595     * @param CairoSurface $other An existing surface used to select the
4596     *   backend of the new surface
4597     * @param int $content The content for the new surface. See the
4598     *   CairoContent class for possible values.
4599     * @param string $width Width of the new surface, (in device-space
4600     *   units).
4601     * @param string $height Height of the new surface, (in device-space
4602     *   units).
4603     * @return void A new CairoSurface
4604     * @since PECL cairo >= 0.1.0
4605     **/
4606    public function createSimilar($other, $content, $width, $height){}
4607
4608    /**
4609     * The finish purpose
4610     *
4611     * The method description goes here.
4612     *
4613     * @return void Description...
4614     * @since PECL cairo >= 0.1.0
4615     **/
4616    public function finish(){}
4617
4618    /**
4619     * The flush purpose
4620     *
4621     * The method description goes here.
4622     *
4623     * @return void Description...
4624     * @since PECL cairo >= 0.1.0
4625     **/
4626    public function flush(){}
4627
4628    /**
4629     * The getContent purpose
4630     *
4631     * The method description goes here.
4632     *
4633     * @return int Description...
4634     * @since PECL cairo >= 0.1.0
4635     **/
4636    public function getContent(){}
4637
4638    /**
4639     * The getDeviceOffset purpose
4640     *
4641     * The method description goes here.
4642     *
4643     * @return array Description...
4644     * @since PECL cairo >= 0.1.0
4645     **/
4646    public function getDeviceOffset(){}
4647
4648    /**
4649     * The getFontOptions purpose
4650     *
4651     * @return void Description...
4652     * @since PECL cairo >= 0.1.0
4653     **/
4654    public function getFontOptions(){}
4655
4656    /**
4657     * The getType purpose
4658     *
4659     * The method description goes here.
4660     *
4661     * @return int Description...
4662     * @since PECL cairo >= 0.1.0
4663     **/
4664    public function getType(){}
4665
4666    /**
4667     * The markDirty purpose
4668     *
4669     * The method description goes here.
4670     *
4671     * @return void Description...
4672     * @since PECL cairo >= 0.1.0
4673     **/
4674    public function markDirty(){}
4675
4676    /**
4677     * The markDirtyRectangle purpose
4678     *
4679     * The method description goes here.
4680     *
4681     * @param float $x Description...
4682     * @param float $y Description...
4683     * @param float $width Description...
4684     * @param float $height Description...
4685     * @return void Description...
4686     * @since PECL cairo >= 0.1.0
4687     **/
4688    public function markDirtyRectangle($x, $y, $width, $height){}
4689
4690    /**
4691     * The setDeviceOffset purpose
4692     *
4693     * The method description goes here.
4694     *
4695     * @param float $x Description...
4696     * @param float $y Description...
4697     * @return void Description...
4698     * @since PECL cairo >= 0.1.0
4699     **/
4700    public function setDeviceOffset($x, $y){}
4701
4702    /**
4703     * The setFallbackResolution purpose
4704     *
4705     * The method description goes here.
4706     *
4707     * @param float $x Description...
4708     * @param float $y Description...
4709     * @return void Description...
4710     * @since PECL cairo >= 0.1.0
4711     **/
4712    public function setFallbackResolution($x, $y){}
4713
4714    /**
4715     * The showPage purpose
4716     *
4717     * @return void Description...
4718     * @since PECL cairo >= 0.1.0
4719     **/
4720    public function showPage(){}
4721
4722    /**
4723     * The status purpose
4724     *
4725     * @return int Description...
4726     * @since PECL cairo >= 0.1.0
4727     **/
4728    public function status(){}
4729
4730    /**
4731     * The writeToPng purpose
4732     *
4733     * The method description goes here.
4734     *
4735     * @param string $file Description...
4736     * @return void Description...
4737     * @since PECL cairo >= 0.1.0
4738     **/
4739    public function writeToPng($file){}
4740
4741    /**
4742     * The __construct purpose
4743     *
4744     * CairoSurface is an abstract type and, as such, should not be
4745     * instantiated in your PHP scripts.
4746     *
4747     * @since PECL cairo >= 0.1.0
4748     **/
4749    public function __construct(){}
4750
4751}
4752class CairoSurfacePattern extends CairoPattern {
4753    /**
4754     * The getExtend purpose
4755     *
4756     * The method description goes here.
4757     *
4758     * @return int Description...
4759     * @since PECL cairo >= 0.1.0
4760     **/
4761    public function getExtend(){}
4762
4763    /**
4764     * The getFilter purpose
4765     *
4766     * The method description goes here.
4767     *
4768     * @return int Description...
4769     * @since PECL cairo >= 0.1.0
4770     **/
4771    public function getFilter(){}
4772
4773    /**
4774     * The getSurface purpose
4775     *
4776     * The method description goes here.
4777     *
4778     * @return void Description...
4779     * @since PECL cairo >= 0.1.0
4780     **/
4781    public function getSurface(){}
4782
4783    /**
4784     * The setExtend purpose
4785     *
4786     * The method description goes here.
4787     *
4788     * @param int $extend Description...
4789     * @return void Description...
4790     * @since PECL cairo >= 0.1.0
4791     **/
4792    public function setExtend($extend){}
4793
4794    /**
4795     * The setFilter purpose
4796     *
4797     * The method description goes here.
4798     *
4799     * @param int $filter Description...
4800     * @return void Description...
4801     * @since PECL cairo >= 0.1.0
4802     **/
4803    public function setFilter($filter){}
4804
4805    /**
4806     * The __construct purpose
4807     *
4808     * The method description goes here.
4809     *
4810     * @param CairoSurface $surface Description...
4811     * @since PECL cairo >= 0.1.0
4812     **/
4813    public function __construct($surface){}
4814
4815}
4816class CairoSurfaceType {
4817    /**
4818     * @var integer
4819     **/
4820    const BEOS = 0;
4821
4822    /**
4823     * @var integer
4824     **/
4825    const DIRECTFB = 0;
4826
4827    /**
4828     * @var integer
4829     **/
4830    const GLITZ = 0;
4831
4832    /**
4833     * @var integer
4834     **/
4835    const IMAGE = 0;
4836
4837    /**
4838     * @var integer
4839     **/
4840    const OS2 = 0;
4841
4842    /**
4843     * @var integer
4844     **/
4845    const PDF = 0;
4846
4847    /**
4848     * @var integer
4849     **/
4850    const PS = 0;
4851
4852    /**
4853     * @var integer
4854     **/
4855    const QUARTZ = 0;
4856
4857    /**
4858     * @var integer
4859     **/
4860    const QUARTZ_IMAGE = 0;
4861
4862    /**
4863     * @var integer
4864     **/
4865    const SVG = 0;
4866
4867    /**
4868     * @var integer
4869     **/
4870    const WIN32 = 0;
4871
4872    /**
4873     * @var integer
4874     **/
4875    const WIN32_PRINTING = 0;
4876
4877    /**
4878     * @var integer
4879     **/
4880    const XCB = 0;
4881
4882    /**
4883     * @var integer
4884     **/
4885    const XLIB = 0;
4886
4887}
4888/**
4889 * Svg specific surface class, uses the SVG (standard vector graphics)
4890 * surface backend.
4891 **/
4892class CairoSvgSurface extends CairoSurface {
4893    /**
4894     * Used to retrieve a list of supported SVG versions
4895     *
4896     * Returns a numerically indexed array of currently available
4897     * CairoSvgVersion constants. In order to retrieve the string values for
4898     * each item, use CairoSvgSurface::versionToString.
4899     *
4900     * @return array Returns a numerically indexed array of integer values.
4901     * @since PECL cairo >= 0.1.0
4902     **/
4903    public static function getVersions(){}
4904
4905    /**
4906     * The restrictToVersion purpose
4907     *
4908     * The method description goes here.
4909     *
4910     * @param int $version Description...
4911     * @return void Description...
4912     * @since PECL cairo >= 0.1.0
4913     **/
4914    public function restrictToVersion($version){}
4915
4916    /**
4917     * The versionToString purpose
4918     *
4919     * The method description goes here.
4920     *
4921     * @param int $version Description...
4922     * @return string Description...
4923     * @since PECL cairo >= 0.1.0
4924     **/
4925    public static function versionToString($version){}
4926
4927    /**
4928     * The __construct purpose
4929     *
4930     * The method description goes here.
4931     *
4932     * @param string $file Description...
4933     * @param float $width Description...
4934     * @param float $height Description...
4935     * @since PECL cairo >= 0.1.0
4936     **/
4937    public function __construct($file, $width, $height){}
4938
4939}
4940class CairoSvgVersion {
4941    /**
4942     * @var integer
4943     **/
4944    const VERSION_1_1 = 0;
4945
4946    /**
4947     * @var integer
4948     **/
4949    const VERSION_1_2 = 0;
4950
4951}
4952/**
4953 * The CairoToyFontFace class can be used instead of
4954 * CairoContext::selectFontFace to create a toy font independently of a
4955 * context.
4956 **/
4957class CairoToyFontFace extends CairoFontFace {
4958}
4959/**
4960 * The callback should accept up to three arguments: the current item,
4961 * the current key and the iterator, respectively. Any callable may be
4962 * used; such as a string containing a function name, an array for a
4963 * method, or an anonymous function.
4964 **/
4965class CallbackFilterIterator extends FilterIterator implements OuterIterator {
4966    /**
4967     * Calls the callback with the current value, the current key and the
4968     * inner iterator as arguments
4969     *
4970     * This method calls the callback with the current value, current key and
4971     * the inner iterator.
4972     *
4973     * The callback is expected to return TRUE if the current item is to be
4974     * accepted, or FALSE otherwise.
4975     *
4976     * @return bool Returns TRUE to accept the current item, or FALSE
4977     *   otherwise.
4978     * @since PHP 5 >= 5.4.0, PHP 7
4979     **/
4980    public function accept(){}
4981
4982}
4983/**
4984 * Represents a loaded chdb file.
4985 **/
4986class chdb {
4987    /**
4988     * Gets the value associated with a key
4989     *
4990     * Gets the value associated with a key from a chdb database.
4991     *
4992     * @param string $key The key for which to get the value.
4993     * @return string Returns a string containing the value associated with
4994     *   the given {@link key}, or NULL if not found.
4995     * @since PECL chdb >= 0.1.0
4996     **/
4997    public function get($key){}
4998
4999    /**
5000     * Creates a instance
5001     *
5002     * Loads a chdb file, by mapping it into memory. While some validity
5003     * checks are performed on the specified file, they are mostly there to
5004     * avoid the possibility of common mistakes (for example, loading a file
5005     * which is not a chdb database, or that is somehow incompatible with the
5006     * current system). A maliciously crafted chdb file can thus be dangerous
5007     * if loaded, so chdb files should be trusted and treated with the same
5008     * security protections used for PHP shared libraries.
5009     *
5010     * @param string $pathname The name of the file to load.
5011     * @since PECL chdb >= 0.1.0
5012     **/
5013    public function __construct($pathname){}
5014
5015}
5016/**
5017 * Class used to represent anonymous functions. Anonymous functions,
5018 * implemented in PHP 5.3, yield objects of this type. This fact used to
5019 * be considered an implementation detail, but it can now be relied upon.
5020 * Starting with PHP 5.4, this class has methods that allow further
5021 * control of the anonymous function after it has been created. Besides
5022 * the methods listed here, this class also has an __invoke method. This
5023 * is for consistency with other classes that implement calling magic, as
5024 * this method is not used for calling the function.
5025 **/
5026class Closure {
5027    /**
5028     * Duplicates a closure with a specific bound object and class scope
5029     *
5030     * This method is a static version of Closure::bindTo. See the
5031     * documentation of that method for more information.
5032     *
5033     * @param Closure $closure The anonymous functions to bind.
5034     * @param object $newthis The object to which the given anonymous
5035     *   function should be bound, or NULL for the closure to be unbound.
5036     * @param mixed $newscope The class scope to which associate the
5037     *   closure is to be associated, or 'static' to keep the current one. If
5038     *   an object is given, the type of the object will be used instead.
5039     *   This determines the visibility of protected and private methods of
5040     *   the bound object. It is not allowed to pass (an object of) an
5041     *   internal class as this parameter.
5042     * @return Closure Returns a new Closure object
5043     * @since PHP 5 >= 5.4.0, PHP 7
5044     **/
5045    public static function bind($closure, $newthis, $newscope){}
5046
5047    /**
5048     * Duplicates the closure with a new bound object and class scope
5049     *
5050     * Create and return a new anonymous function with the same body and
5051     * bound variables as this one, but possibly with a different bound
5052     * object and a new class scope.
5053     *
5054     * The “bound object” determines the value $this will have in the
5055     * function body and the “class scope” represents a class which
5056     * determines which private and protected members the anonymous function
5057     * will be able to access. Namely, the members that will be visible are
5058     * the same as if the anonymous function were a method of the class given
5059     * as value of the {@link newscope} parameter.
5060     *
5061     * Static closures cannot have any bound object (the value of the
5062     * parameter {@link newthis} should be NULL), but this function can
5063     * nevertheless be used to change their class scope.
5064     *
5065     * This function will ensure that for a non-static closure, having a
5066     * bound instance will imply being scoped and vice-versa. To this end,
5067     * non-static closures that are given a scope but a NULL instance are
5068     * made static and non-static non-scoped closures that are given a
5069     * non-null instance are scoped to an unspecified class.
5070     *
5071     * @param object $newthis The object to which the given anonymous
5072     *   function should be bound, or NULL for the closure to be unbound.
5073     * @param mixed $newscope The class scope to which the closure is to be
5074     *   associated, or 'static' to keep the current one. If an object is
5075     *   given, the type of the object will be used instead. This determines
5076     *   the visibility of protected and private methods of the bound object.
5077     *   It is not allowed to pass (an object of) an internal class as this
5078     *   parameter.
5079     * @return Closure Returns the newly created Closure object
5080     * @since PHP 5 >= 5.4.0, PHP 7
5081     **/
5082    public function bindTo($newthis, $newscope){}
5083
5084    /**
5085     * Binds and calls the closure
5086     *
5087     * Temporarily binds the closure to {@link newthis}, and calls it with
5088     * any given parameters.
5089     *
5090     * @param object $newthis The object to bind the closure to for the
5091     *   duration of the call.
5092     * @param mixed ...$vararg Zero or more parameters, which will be given
5093     *   as parameters to the closure.
5094     * @return mixed Returns the return value of the closure.
5095     * @since PHP 7
5096     **/
5097    public function call($newthis, ...$vararg){}
5098
5099    /**
5100     * Converts a callable into a closure
5101     *
5102     * Create and return a new anonymous function from given {@link callable}
5103     * using the current scope. This method checks if the {@link callable} is
5104     * callable in the current scope and throws a TypeError if it is not.
5105     *
5106     * @param callable $callable The callable to convert.
5107     * @return Closure Returns the newly created Closure or throws a
5108     *   TypeError if the {@link callable} is not callable in the current
5109     *   scope.
5110     * @since PHP 7 >= 7.1.0
5111     **/
5112    public static function fromCallable($callable){}
5113
5114    /**
5115     * Constructor that disallows instantiation
5116     *
5117     * This method exists only to disallow instantiation of the Closure
5118     * class. Objects of this class are created in the fashion described on
5119     * the anonymous functions page.
5120     *
5121     * @since PHP 5 >= 5.3.0, PHP 7
5122     **/
5123    private function __construct(){}
5124
5125}
5126/**
5127 * Provides string comparison capability with support for appropriate
5128 * locale-sensitive sort orderings.
5129 **/
5130class Collator {
5131    /**
5132     * Sort array maintaining index association
5133     *
5134     * This function sorts an array such that array indices maintain their
5135     * correlation with the array elements they are associated with. This is
5136     * used mainly when sorting associative arrays where the actual element
5137     * order is significant. Array elements will have sort order according to
5138     * current locale rules.
5139     *
5140     * Equivalent to standard PHP {@link asort}.
5141     *
5142     * @param array $arr Collator object.
5143     * @param int $sort_flag Array of strings to sort.
5144     * @return bool
5145     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
5146     **/
5147    public function asort(&$arr, $sort_flag){}
5148
5149    /**
5150     * Compare two Unicode strings
5151     *
5152     * Compare two Unicode strings according to collation rules.
5153     *
5154     * @param string $str1 Collator object.
5155     * @param string $str2 The first string to compare.
5156     * @return int Return comparison result:
5157     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
5158     **/
5159    public function compare($str1, $str2){}
5160
5161    /**
5162     * Create a collator
5163     *
5164     * The strings will be compared using the options already specified.
5165     *
5166     * @param string $locale The locale containing the required collation
5167     *   rules. Special values for locales can be passed in - if null is
5168     *   passed for the locale, the default locale collation rules will be
5169     *   used. If empty string ("") or "root" are passed, UCA rules will be
5170     *   used.
5171     * @return Collator Return new instance of Collator object, or NULL on
5172     *   error.
5173     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
5174     **/
5175    public static function create($locale){}
5176
5177    /**
5178     * Get collation attribute value
5179     *
5180     * Get a value of an integer collator attribute.
5181     *
5182     * @param int $attr Collator object.
5183     * @return int Attribute value, or boolean FALSE on error.
5184     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
5185     **/
5186    public function getAttribute($attr){}
5187
5188    /**
5189     * Get collator's last error code
5190     *
5191     * @return int Error code returned by the last Collator API function
5192     *   call.
5193     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
5194     **/
5195    public function getErrorCode(){}
5196
5197    /**
5198     * Get text for collator's last error code
5199     *
5200     * Retrieves the message for the last error.
5201     *
5202     * @return string Description of an error occurred in the last Collator
5203     *   API function call.
5204     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
5205     **/
5206    public function getErrorMessage(){}
5207
5208    /**
5209     * Get the locale name of the collator
5210     *
5211     * Get collector locale name.
5212     *
5213     * @param int $type Collator object.
5214     * @return string Real locale name from which the collation data comes.
5215     *   If the collator was instantiated from rules or an error occurred,
5216     *   returns boolean FALSE.
5217     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
5218     **/
5219    public function getLocale($type){}
5220
5221    /**
5222     * Get sorting key for a string
5223     *
5224     * Return collation key for a string. Collation keys can be compared
5225     * directly instead of strings, though are implementation specific and
5226     * may change between ICU library versions. Sort keys are generally only
5227     * useful in databases or other circumstances where function calls are
5228     * extremely expensive.
5229     *
5230     * @param string $str Collator object.
5231     * @return string Returns the collation key for the string, .
5232     * @since PHP 5 >= 5.3.2, PHP 7, PECL intl >= 1.0.3
5233     **/
5234    public function getSortKey($str){}
5235
5236    /**
5237     * Get current collation strength
5238     *
5239     * @return int Returns current collation strength, or boolean FALSE on
5240     *   error.
5241     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
5242     **/
5243    public function getStrength(){}
5244
5245    /**
5246     * Set collation attribute
5247     *
5248     * @param int $attr Collator object.
5249     * @param int $val Attribute.
5250     * @return bool
5251     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
5252     **/
5253    public function setAttribute($attr, $val){}
5254
5255    /**
5256     * Set collation strength
5257     *
5258     * The ICU Collation Service supports many levels of comparison (named
5259     * "Levels", but also known as "Strengths"). Having these categories
5260     * enables ICU to sort strings precisely according to local conventions.
5261     * However, by allowing the levels to be selectively employed, searching
5262     * for a string in text can be performed with various matching
5263     * conditions.
5264     *
5265     * Primary Level: Typically, this is used to denote differences between
5266     * base characters (for example, "a" < "b"). It is the strongest
5267     * difference. For example, dictionaries are divided into different
5268     * sections by base character. This is also called the level1 strength.
5269     * Secondary Level: Accents in the characters are considered secondary
5270     * differences (for example, "as" < "às" < "at"). Other differences
5271     * between letters can also be considered secondary differences,
5272     * depending on the language. A secondary difference is ignored when
5273     * there is a primary difference anywhere in the strings. This is also
5274     * called the level2 strength. Note: In some languages (such as Danish),
5275     * certain accented letters are considered to be separate base
5276     * characters. In most languages, however, an accented letter only has a
5277     * secondary difference from the unaccented version of that letter.
5278     * Tertiary Level: Upper and lower case differences in characters are
5279     * distinguished at the tertiary level (for example, "ao" < "Ao" <
5280     * "aò"). In addition, a variant of a letter differs from the base form
5281     * on the tertiary level (such as "A" and " "). Another example is the
5282     * difference between large and small Kana. A tertiary difference is
5283     * ignored when there is a primary or secondary difference anywhere in
5284     * the strings. This is also called the level3 strength. Quaternary
5285     * Level: When punctuation is ignored (see Ignoring Punctuations ) at
5286     * level 13, an additional level can be used to distinguish words with
5287     * and without punctuation (for example, "ab" < "a-b" < "aB"). This
5288     * difference is ignored when there is a primary, secondary or tertiary
5289     * difference. This is also known as the level4 strength. The quaternary
5290     * level should only be used if ignoring punctuation is required or when
5291     * processing Japanese text (see Hiragana processing). Identical Level:
5292     * When all other levels are equal, the identical level is used as a
5293     * tiebreaker. The Unicode code point values of the NFD form of each
5294     * string are compared at this level, just in case there is no difference
5295     * at levels 14. For example, Hebrew cantillation marks are only
5296     * distinguished at this level. This level should be used sparingly, as
5297     * only code point values differences between two strings is an extremely
5298     * rare occurrence. Using this level substantially decreases the
5299     * performance for both incremental comparison and sort key generation
5300     * (as well as increasing the sort key length). It is also known as level
5301     * 5 strength.
5302     *
5303     * For example, people may choose to ignore accents or ignore accents and
5304     * case when searching for text. Almost all characters are distinguished
5305     * by the first three levels, and in most locales the default value is
5306     * thus Tertiary. However, if Alternate is set to be Shifted, then the
5307     * Quaternary strength can be used to break ties among whitespace,
5308     * punctuation, and symbols that would otherwise be ignored. If very fine
5309     * distinctions among characters are required, then the Identical
5310     * strength can be used (for example, Identical Strength distinguishes
5311     * between the Mathematical Bold Small A and the Mathematical Italic
5312     * Small A.). However, using levels higher than Tertiary the Identical
5313     * strength result in significantly longer sort keys, and slower string
5314     * comparison performance for equal strings.
5315     *
5316     * @param int $strength Collator object.
5317     * @return bool
5318     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
5319     **/
5320    public function setStrength($strength){}
5321
5322    /**
5323     * Sort array using specified collator
5324     *
5325     * This function sorts an array according to current locale rules.
5326     *
5327     * Equivalent to standard PHP {@link sort} .
5328     *
5329     * @param array $arr Collator object.
5330     * @param int $sort_flag Array of strings to sort.
5331     * @return bool
5332     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
5333     **/
5334    public function sort(&$arr, $sort_flag){}
5335
5336    /**
5337     * Sort array using specified collator and sort keys
5338     *
5339     * Similar to {@link collator_sort} but uses ICU sorting keys produced by
5340     * ucol_getSortKey() to gain more speed on large arrays.
5341     *
5342     * @param array $arr Collator object.
5343     * @return bool
5344     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
5345     **/
5346    public function sortWithSortKeys(&$arr){}
5347
5348}
5349/**
5350 * Represents a garbage-collectable object.
5351 **/
5352interface Collectable {
5353    /**
5354     * Determine whether an object has been marked as garbage
5355     *
5356     * Can be called in Pool::collect to determine if this object is garbage.
5357     *
5358     * @return bool
5359     * @since PECL pthreads >= 2.0.8
5360     **/
5361    public function isGarbage();
5362
5363    /**
5364     * Mark an object as garbage
5365     *
5366     * Should be called once per object when the object is finished being
5367     * executed or referenced.
5368     *
5369     * @return void
5370     * @since PECL pthreads < 3.0.0
5371     **/
5372    public function setGarbage();
5373
5374}
5375/**
5376 * The com class allows you to instantiate an OLE compatible COM object
5377 * and call its methods and access its properties.
5378 **/
5379class com extends variant {
5380}
5381namespace CommonMark {
5382class CQL {
5383    /**
5384     * CQL Execution
5385     *
5386     * Shall invoke the current CQL function on the given {@link root},
5387     * executing the given {@link handler} on entry to a \CommonMark\Node
5388     *
5389     * @param \CommonMark\Node $root the root node of a tree
5390     * @param callable $handler should have the prototype: ?boolhandler
5391     *   \CommonMark\Node{@link root} \CommonMark\Node{@link entering} Should
5392     *   {@link handler} fail to return (void), or return null, CQL will
5393     *   continue executing Should the handler return a truthy value, CQL
5394     *   will continue executing. Should the handler return a falsy value,
5395     *   CQL will stop executing
5396     **/
5397    public function __invoke($root, $handler){}
5398
5399}
5400}
5401namespace CommonMark\Interfaces {
5402interface IVisitable {
5403    /**
5404     * Visitation
5405     *
5406     * @param CommonMark\Interfaces\IVisitor $visitor An object
5407     *   implementing CommonMark\Interfaces\IVisitor
5408     * @return void
5409     **/
5410    public function accept($visitor);
5411
5412}
5413}
5414namespace CommonMark\Interfaces {
5415interface IVisitor {
5416    /**
5417     * Visitation
5418     *
5419     * @param IVisitable $visitable The current
5420     *   CommonMark\Interfaces\IVisitable being entered
5421     * @return ?int|IVisitable Returning
5422     *   CommonMark\Interfaces\IVisitor::Done will cause the backing iterator
5423     *   to exit.
5424     **/
5425    public function enter($visitable);
5426
5427    /**
5428     * Visitation
5429     *
5430     * @param IVisitable $visitable The current
5431     *   CommonMark\Interfaces\IVisitable being exited
5432     * @return ?int|IVisitable Returning
5433     *   CommonMark\Interfaces\IVisitor::Done will cause the backing iterator
5434     *   to exit.
5435     **/
5436    public function leave($visitable);
5437
5438}
5439}
5440namespace CommonMark {
5441final class Node implements CommonMark\Interfaces\IVisitable, Traversable {
5442    /**
5443     * @var int
5444     **/
5445    public $endColumn;
5446
5447    /**
5448     * @var int
5449     **/
5450    public $endLine;
5451
5452    /**
5453     * @var ?Node
5454     **/
5455    public $firstChild;
5456
5457    /**
5458     * @var ?Node
5459     **/
5460    public $lastChild;
5461
5462    /**
5463     * @var ?Node
5464     **/
5465    public $next;
5466
5467    /**
5468     * @var ?Node
5469     **/
5470    public $parent;
5471
5472    /**
5473     * @var ?Node
5474     **/
5475    public $previous;
5476
5477    /**
5478     * @var int
5479     **/
5480    public $startColumn;
5481
5482    /**
5483     * @var int
5484     **/
5485    public $startLine;
5486
5487    /**
5488     * Visitation
5489     *
5490     * @param CommonMark\Interfaces\IVisitor $visitor An object
5491     *   implementing CommonMark\Interfaces\IVisitor
5492     * @return void
5493     **/
5494    public function accept($visitor){}
5495
5496    /**
5497     * AST Manipulation
5498     *
5499     * @param CommonMark\Node $child
5500     * @return CommonMark\Node
5501     **/
5502    public function appendChild($child){}
5503
5504    /**
5505     * AST Manipulation
5506     *
5507     * @param CommonMark\Node $sibling
5508     * @return CommonMark\Node
5509     **/
5510    public function insertAfter($sibling){}
5511
5512    /**
5513     * AST Manipulation
5514     *
5515     * @param CommonMark\Node $sibling
5516     * @return CommonMark\Node
5517     **/
5518    public function insertBefore($sibling){}
5519
5520    /**
5521     * AST Manipulation
5522     *
5523     * @param CommonMark\Node $child
5524     * @return CommonMark\Node
5525     **/
5526    public function prependChild($child){}
5527
5528    /**
5529     * AST Manipulation
5530     *
5531     * @param CommonMark\Node $target
5532     * @return CommonMark\Node
5533     **/
5534    public function replace($target){}
5535
5536    /**
5537     * AST Manipulation
5538     *
5539     * @return void
5540     **/
5541    public function unlink(){}
5542
5543}
5544}
5545namespace CommonMark\Node {
5546final class BlockQuote extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
5547}
5548}
5549namespace CommonMark\Node {
5550final class BulletList extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
5551}
5552}
5553namespace CommonMark\Node {
5554final class Code extends CommonMark\Node\Text implements CommonMark\Interfaces\IVisitable, Traversable {
5555}
5556}
5557namespace CommonMark\Node {
5558final class CodeBlock extends CommonMark\Node\Text implements CommonMark\Interfaces\IVisitable, Traversable {
5559}
5560}
5561namespace CommonMark\Node {
5562final class CustomBlock extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
5563}
5564}
5565namespace CommonMark\Node {
5566final class CustomInline extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
5567}
5568}
5569namespace CommonMark\Node {
5570final class Document extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
5571}
5572}
5573namespace CommonMark\Node {
5574final class Heading extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
5575}
5576}
5577namespace CommonMark\Node {
5578final class HTMLBlock extends CommonMark\Node\Text implements CommonMark\Interfaces\IVisitable, Traversable {
5579}
5580}
5581namespace CommonMark\Node {
5582final class HTMLInline extends CommonMark\Node\Text implements CommonMark\Interfaces\IVisitable, Traversable {
5583}
5584}
5585namespace CommonMark\Node {
5586final class Image extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
5587}
5588}
5589namespace CommonMark\Node {
5590final class Item extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
5591}
5592}
5593namespace CommonMark\Node {
5594final class LineBreak extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
5595}
5596}
5597namespace CommonMark\Node {
5598final class Link extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
5599}
5600}
5601namespace CommonMark\Node {
5602final class OrderedList extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
5603}
5604}
5605namespace CommonMark\Node {
5606final class Paragraph extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
5607}
5608}
5609namespace CommonMark\Node {
5610final class SoftBreak extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
5611}
5612}
5613namespace CommonMark\Node {
5614final class Text extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
5615}
5616}
5617namespace CommonMark\Node\Text {
5618final class Emphasis extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
5619}
5620}
5621namespace CommonMark\Node\Text {
5622final class Strong extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
5623}
5624}
5625namespace CommonMark\Node {
5626final class ThematicBreak extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
5627}
5628}
5629namespace CommonMark {
5630final class Parser {
5631    /**
5632     * Parsing
5633     *
5634     * @return CommonMark\Node
5635     **/
5636    public function finish(){}
5637
5638    /**
5639     * Parsing
5640     *
5641     * @param string $buffer
5642     * @return void
5643     **/
5644    public function parse($buffer){}
5645
5646}
5647}
5648/**
5649 * COMPersistHelper improves the interoperability of COM and PHP with
5650 * regard to the directive open_basedir, and stream s.
5651 **/
5652final class COMPersistHelper {
5653    /**
5654     * Get current filename
5655     *
5656     * Retrieves the current name of the file associated with the object.
5657     *
5658     * @return string Returns the current name of the file associated with
5659     *   the object.
5660     * @since PHP 5, PHP 7
5661     **/
5662    public function GetCurFileName(){}
5663
5664    /**
5665     * Get maximum stream size
5666     *
5667     * Retrieves the size of the stream (in bytes) needed to save the object.
5668     *
5669     * @return int Returns the size of the stream (in bytes) needed to save
5670     *   the object.
5671     * @since PHP 5, PHP 7
5672     **/
5673    public function GetMaxStreamSize(){}
5674
5675    /**
5676     * Initialize object to default state
5677     *
5678     * Initializes an object to a default state.
5679     *
5680     * @return bool
5681     * @since PHP 5, PHP 7
5682     **/
5683    public function InitNew(){}
5684
5685    /**
5686     * Load object from file
5687     *
5688     * Opens the specified file and initializes an object from the file
5689     * contents.
5690     *
5691     * @param string $path
5692     * @param int $flags
5693     * @return bool
5694     * @since PHP 5, PHP 7
5695     **/
5696    public function LoadFromFile($path, $flags){}
5697
5698    /**
5699     * Load object from stream
5700     *
5701     * Initializes an object from the stream where it was saved previously.
5702     *
5703     * @param resource $stream
5704     * @return bool
5705     * @since PHP 5, PHP 7
5706     **/
5707    public function LoadFromStream($stream){}
5708
5709    /**
5710     * Save object to file
5711     *
5712     * Saves a copy of the object to the specified file.
5713     *
5714     * @param string $filename
5715     * @param bool $remember
5716     * @return bool
5717     * @since PHP 5, PHP 7
5718     **/
5719    public function SaveToFile($filename, $remember){}
5720
5721    /**
5722     * Save object to stream
5723     *
5724     * Saves an object to the specified stream.
5725     *
5726     * @param resource $stream
5727     * @return bool
5728     * @since PHP 5, PHP 7
5729     **/
5730    public function SaveToStream($stream){}
5731
5732}
5733/**
5734 * CompileError is thrown for some compilation errors, which formerly
5735 * issued a fatal error.
5736 **/
5737class CompileError extends Error {
5738}
5739namespace Componere {
5740final class Definition {
5741    /**
5742     * Add Constant
5743     *
5744     * Shall declare a class constant on the current Definition
5745     *
5746     * @param string $name The case sensitive name for the constant
5747     * @param \Componere\Value $value The Value for the constant, must not
5748     *   be undefined or static
5749     * @return Definition The current Definition
5750     **/
5751    public function addConstant($name, $value){}
5752
5753    /**
5754     * Add Interface
5755     *
5756     * Shall implement the given interface on the current definition
5757     *
5758     * @param string $interface The case insensitive name of an interface
5759     * @return Definition The current Definition
5760     **/
5761    public function addInterface($interface){}
5762
5763    /**
5764     * Add Method
5765     *
5766     * Shall create or override a method on the current definition.
5767     *
5768     * @param string $name The case insensitive name for method
5769     * @param \Componere\Method $method \Componere\Method not previously
5770     *   added to another Definition
5771     * @return Definition The current Definition
5772     **/
5773    public function addMethod($name, $method){}
5774
5775    /**
5776     * Add Property
5777     *
5778     * Shall declare a class property on the current Definition
5779     *
5780     * @param string $name The case sensitive name for the property
5781     * @param \Componere\Value $value The default Value for the property
5782     * @return Definition The current Definition
5783     **/
5784    public function addProperty($name, $value){}
5785
5786    /**
5787     * Add Trait
5788     *
5789     * Shall use the given trait for the current definition
5790     *
5791     * @param string $trait The case insensitive name of a trait
5792     * @return Definition The current Definition
5793     **/
5794    public function addTrait($trait){}
5795
5796    /**
5797     * Get Closure
5798     *
5799     * Shall return a Closure for the method specified by name
5800     *
5801     * @param string $name The case insensitive name of the method
5802     * @return \Closure A Closure bound to the correct scope
5803     **/
5804    public function getClosure($name){}
5805
5806    /**
5807     * Get Closures
5808     *
5809     * Shall return an array of Closures
5810     *
5811     * @return array Shall return all methods as an array of Closure
5812     *   objects bound to the correct scope
5813     **/
5814    public function getClosures(){}
5815
5816    /**
5817     * Reflection
5818     *
5819     * Shall create or return a ReflectionClass
5820     *
5821     * @return \ReflectionClass A ReflectionClass for the current
5822     *   definition (cached)
5823     **/
5824    public function getReflector(){}
5825
5826    /**
5827     * State Detection
5828     *
5829     * Shall detect the registration state of this Definition
5830     *
5831     * @return bool Shall return true if this Definition is registered
5832     **/
5833    public function isRegistered(){}
5834
5835    /**
5836     * Registration
5837     *
5838     * Shall register the current Definition
5839     *
5840     * @return void
5841     **/
5842    public function register(){}
5843
5844}
5845}
5846namespace Componere {
5847final class Method {
5848    /**
5849     * Reflection
5850     *
5851     * Shall create or return a ReflectionMethod
5852     *
5853     * @return \ReflectionMethod A ReflectionMethod for the current method
5854     *   (cached)
5855     **/
5856    public function getReflector(){}
5857
5858    /**
5859     * Accessibility Modification
5860     *
5861     * @return Method The current Method
5862     **/
5863    public function setPrivate(){}
5864
5865    /**
5866     * Accessibility Modification
5867     *
5868     * @return Method The current Method
5869     **/
5870    public function setProtected(){}
5871
5872    /**
5873     * Accessibility Modification
5874     *
5875     * @return Method The current Method
5876     **/
5877    public function setStatic(){}
5878
5879}
5880}
5881namespace Componere {
5882final class Patch {
5883    /**
5884     * Add Interface
5885     *
5886     * Shall implement the given interface on the current definition
5887     *
5888     * @param string $interface The case insensitive name of an interface
5889     * @return Definition The current Definition
5890     **/
5891    public function addInterface($interface){}
5892
5893    /**
5894     * Add Method
5895     *
5896     * Shall create or override a method on the current definition.
5897     *
5898     * @param string $name The case insensitive name for method
5899     * @param \Componere\Method $method \Componere\Method not previously
5900     *   added to another Definition
5901     * @return Definition The current Definition
5902     **/
5903    public function addMethod($name, $method){}
5904
5905    /**
5906     * Add Trait
5907     *
5908     * Shall use the given trait for the current definition
5909     *
5910     * @param string $trait The case insensitive name of a trait
5911     * @return Definition The current Definition
5912     **/
5913    public function addTrait($trait){}
5914
5915    /**
5916     * Application
5917     *
5918     * Shall apply the current patch
5919     *
5920     * @return void
5921     **/
5922    public function apply(){}
5923
5924    /**
5925     * Patch Derivation
5926     *
5927     * Shall derive a Patch for the given {@link instance}
5928     *
5929     * @param object $instance The target for the derived Patch
5930     * @return Patch Patch for {@link instance} derived from the current
5931     *   Patch
5932     **/
5933    public function derive($instance){}
5934
5935    /**
5936     * Get Closure
5937     *
5938     * Shall return a Closure for the method specified by name
5939     *
5940     * @param string $name The case insensitive name of the method
5941     * @return \Closure A Closure bound to the correct scope and object
5942     **/
5943    public function getClosure($name){}
5944
5945    /**
5946     * Get Closures
5947     *
5948     * Shall return an array of Closures
5949     *
5950     * @return array Shall return all methods as an array of Closure
5951     *   objects bound to the correct scope and object
5952     **/
5953    public function getClosures(){}
5954
5955    /**
5956     * Reflection
5957     *
5958     * Shall create or return a ReflectionClass
5959     *
5960     * @return \ReflectionClass A ReflectionClass for the current
5961     *   definition (cached)
5962     **/
5963    public function getReflector(){}
5964
5965    /**
5966     * State Detection
5967     *
5968     * @return bool
5969     **/
5970    public function isApplied(){}
5971
5972    /**
5973     * Reversal
5974     *
5975     * Shall revert the current patch
5976     *
5977     * @return void
5978     **/
5979    public function revert(){}
5980
5981}
5982}
5983namespace Componere {
5984final class Value {
5985    /**
5986     * Value Interaction
5987     *
5988     * @return bool
5989     **/
5990    public function hasDefault(){}
5991
5992    /**
5993     * Accessibility Detection
5994     *
5995     * @return bool
5996     **/
5997    public function isPrivate(){}
5998
5999    /**
6000     * Accessibility Detection
6001     *
6002     * @return bool
6003     **/
6004    public function isProtected(){}
6005
6006    /**
6007     * Accessibility Detection
6008     *
6009     * @return bool
6010     **/
6011    public function isStatic(){}
6012
6013    /**
6014     * Accessibility Modification
6015     *
6016     * @return Value The current Value
6017     **/
6018    public function setPrivate(){}
6019
6020    /**
6021     * Accessibility Modification
6022     *
6023     * @return Value The current Value
6024     **/
6025    public function setProtected(){}
6026
6027    /**
6028     * Accessibility Modification
6029     *
6030     * @return Value The current Value
6031     **/
6032    public function setStatic(){}
6033
6034}
6035}
6036class com_exception extends Exception implements Throwable {
6037}
6038/**
6039 * The static methods contained in the Cond class provide direct access
6040 * to Posix Condition Variables.
6041 **/
6042class Cond {
6043    /**
6044     * Broadcast a Condition
6045     *
6046     * Broadcast to all Threads blocking on a call to {@link Cond::wait}.
6047     *
6048     * @param int $condition A handle to a Condition Variable returned by a
6049     *   previous call to {@link Cond::create}
6050     * @return bool A boolean indication of success.
6051     * @since PECL pthreads < 3.0.0
6052     **/
6053    final public static function broadcast($condition){}
6054
6055    /**
6056     * Create a Condition
6057     *
6058     * Creates a new Condition Variable for the caller.
6059     *
6060     * @return int A handle to a Condition Variable
6061     * @since PECL pthreads < 3.0.0
6062     **/
6063    final public static function create(){}
6064
6065    /**
6066     * Destroy a Condition
6067     *
6068     * Destroying Condition Variable handles must be carried out explicitly
6069     * by the programmer when they are finished with the Condition Variable.
6070     * No Threads should be blocking on a call to {@link Cond::wait} when the
6071     * call to {@link Cond::destroy} takes place.
6072     *
6073     * @param int $condition A handle to a Condition Variable returned by a
6074     *   previous call to {@link Cond::create}
6075     * @return bool A boolean indication of success.
6076     * @since PECL pthreads < 3.0.0
6077     **/
6078    final public static function destroy($condition){}
6079
6080    /**
6081     * Signal a Condition
6082     *
6083     * @param int $condition A handle returned by a previous call to {@link
6084     *   Cond::create}
6085     * @return bool A boolean indication of success.
6086     * @since PECL pthreads < 3.0.0
6087     **/
6088    final public static function signal($condition){}
6089
6090    /**
6091     * Wait for Condition
6092     *
6093     * Wait for a signal on a Condition Variable, optionally specifying a
6094     * timeout to limit waiting time.
6095     *
6096     * @param int $condition A handle returned by a previous call to {@link
6097     *   Cond::create}.
6098     * @param int $mutex A handle returned by a previous call to {@link
6099     *   Mutex::create} and owned (locked) by the caller.
6100     * @param int $timeout An optional timeout, in microseconds (
6101     *   millionths of a second ).
6102     * @return bool A boolean indication of success.
6103     * @since PECL pthreads < 3.0.0
6104     **/
6105    final public static function wait($condition, $mutex, $timeout){}
6106
6107}
6108/**
6109 * Classes implementing Countable can be used with the {@link count}
6110 * function.
6111 **/
6112interface Countable {
6113    /**
6114     * Count elements of an object
6115     *
6116     * This method is executed when using the {@link count} function on an
6117     * object implementing Countable.
6118     *
6119     * @return int The custom count as an integer.
6120     * @since PHP 5 >= 5.1.0, PHP 7
6121     **/
6122    public function count();
6123
6124}
6125/**
6126 * CURLFile should be used to upload a file with CURLOPT_POSTFIELDS.
6127 * {@link curl_setopt}
6128 **/
6129class CURLFile {
6130    /**
6131     * MIME type of the file (default is application/octet-stream).
6132     *
6133     * @var mixed
6134     **/
6135    public $mime;
6136
6137    /**
6138     * Name of the file to be uploaded.
6139     *
6140     * @var mixed
6141     **/
6142    public $name;
6143
6144    /**
6145     * The name of the file in the upload data (defaults to the name
6146     * property).
6147     *
6148     * @var mixed
6149     **/
6150    public $postname;
6151
6152    /**
6153     * Get file name
6154     *
6155     * @return string Returns file name.
6156     * @since PHP 5 >= 5.5.0, PHP 7
6157     **/
6158    public function getFilename(){}
6159
6160    /**
6161     * Get MIME type
6162     *
6163     * @return string Returns MIME type.
6164     * @since PHP 5 >= 5.5.0, PHP 7
6165     **/
6166    public function getMimeType(){}
6167
6168    /**
6169     * Get file name for POST
6170     *
6171     * @return string Returns file name for POST.
6172     * @since PHP 5 >= 5.5.0, PHP 7
6173     **/
6174    public function getPostFilename(){}
6175
6176    /**
6177     * Set MIME type
6178     *
6179     * @param string $mime MIME type to be used in POST data.
6180     * @return void
6181     * @since PHP 5 >= 5.5.0, PHP 7
6182     **/
6183    public function setMimeType($mime){}
6184
6185    /**
6186     * Set file name for POST
6187     *
6188     * @param string $postname Filename to be used in POST data.
6189     * @return void
6190     * @since PHP 5 >= 5.5.0, PHP 7
6191     **/
6192    public function setPostFilename($postname){}
6193
6194    /**
6195     * Create a CURLFile object
6196     *
6197     * Creates a CURLFile object, used to upload a file with
6198     * CURLOPT_POSTFIELDS.
6199     *
6200     * @param string $filename Path to the file which will be uploaded.
6201     * @param string $mimetype Mimetype of the file.
6202     * @param string $postname Name of the file to be used in the upload
6203     *   data.
6204     * @since PHP 5 >= 5.5.0, PHP 7
6205     **/
6206    public function __construct($filename, $mimetype, $postname){}
6207
6208    /**
6209     * Unserialization handler
6210     *
6211     * @return void
6212     * @since PHP 5 >= 5.5.0, PHP 7
6213     **/
6214    public function __wakeup(){}
6215
6216}
6217/**
6218 * Represents a date interval. A date interval stores either a fixed
6219 * amount of time (in years, months, days, hours etc) or a relative time
6220 * string in the format that DateTime's constructor supports. More
6221 * specifically, the information in an object of the DateInterval class
6222 * is an instruction to get from one date/time to another date/time. This
6223 * process is not always reversible. A common way to create a
6224 * DateInterval object is by calculating the difference between two
6225 * date/time objects through {@link DateTimeInterface::diff}. 7.1.0 The f
6226 * property was added.
6227 **/
6228class DateInterval {
6229    /**
6230     * Number of days.
6231     *
6232     * @var integer
6233     **/
6234    public $d;
6235
6236    /**
6237     * If the DateInterval object was created by {@link DateTime::diff}, then
6238     * this is the total number of days between the start and end dates.
6239     * Otherwise, days will be FALSE.
6240     *
6241     * Before PHP 5.4.20/5.5.4 instead of FALSE you will receive -99999 upon
6242     * accessing the property.
6243     *
6244     * @var mixed
6245     **/
6246    public $days;
6247
6248    /**
6249     * Number of microseconds, as a fraction of a second.
6250     *
6251     * @var float
6252     **/
6253    public $f;
6254
6255    /**
6256     * Number of hours.
6257     *
6258     * @var integer
6259     **/
6260    public $h;
6261
6262    /**
6263     * Number of minutes.
6264     *
6265     * @var integer
6266     **/
6267    public $i;
6268
6269    /**
6270     * Is 1 if the interval represents a negative time period and 0
6271     * otherwise. See DateInterval::format.
6272     *
6273     * @var integer
6274     **/
6275    public $invert;
6276
6277    /**
6278     * Number of months.
6279     *
6280     * @var integer
6281     **/
6282    public $m;
6283
6284    /**
6285     * Number of seconds.
6286     *
6287     * @var integer
6288     **/
6289    public $s;
6290
6291    /**
6292     * Number of years.
6293     *
6294     * @var integer
6295     **/
6296    public $y;
6297
6298    /**
6299     * Sets up a DateInterval from the relative parts of the string
6300     *
6301     * Uses the normal date parsers and sets up a DateInterval from the
6302     * relative parts of the parsed string.
6303     *
6304     * @param string $datetime A date with relative parts. Specifically,
6305     *   the relative formats supported by the parser used for {@link
6306     *   strtotime} and DateTime will be used to construct the DateInterval.
6307     * @return DateInterval Returns a new DateInterval instance.
6308     * @since PHP 5 >= 5.3.0, PHP 7
6309     **/
6310    public static function createFromDateString($datetime){}
6311
6312    /**
6313     * Formats the interval
6314     *
6315     * @param string $format The following characters are recognized in the
6316     *   {@link format} parameter string. Each format character must be
6317     *   prefixed by a percent sign (%). {@link format} character Description
6318     *   Example values % Literal % % Y Years, numeric, at least 2 digits
6319     *   with leading 0 01, 03 y Years, numeric 1, 3 M Months, numeric, at
6320     *   least 2 digits with leading 0 01, 03, 12 m Months, numeric 1, 3, 12
6321     *   D Days, numeric, at least 2 digits with leading 0 01, 03, 31 d Days,
6322     *   numeric 1, 3, 31 a Total number of days as a result of a
6323     *   DateTime::diff or (unknown) otherwise 4, 18, 8123 H Hours, numeric,
6324     *   at least 2 digits with leading 0 01, 03, 23 h Hours, numeric 1, 3,
6325     *   23 I Minutes, numeric, at least 2 digits with leading 0 01, 03, 59 i
6326     *   Minutes, numeric 1, 3, 59 S Seconds, numeric, at least 2 digits with
6327     *   leading 0 01, 03, 57 s Seconds, numeric 1, 3, 57 F Microseconds,
6328     *   numeric, at least 6 digits with leading 0 007701, 052738, 428291 f
6329     *   Microseconds, numeric 7701, 52738, 428291 R Sign "-" when negative,
6330     *   "+" when positive -, + r Sign "-" when negative, empty when positive
6331     *   -,
6332     * @return string Returns the formatted interval.
6333     * @since PHP 5 >= 5.3.0, PHP 7
6334     **/
6335    public function format($format){}
6336
6337}
6338/**
6339 * Represents a date period. A date period allows iteration over a set of
6340 * dates and times, recurring at regular intervals, over a given period.
6341 * 5.3.27, 5.4.17 The public properties recurrences, include_start_date,
6342 * start, current, end and interval have been exposed.
6343 **/
6344class DatePeriod implements Traversable {
6345    /**
6346     * @var integer
6347     **/
6348    const EXCLUDE_START_DATE = 0;
6349
6350    /**
6351     * During iteration this will contain the current date within the period.
6352     *
6353     * @var DateTimeInterface
6354     **/
6355    public $current;
6356
6357    /**
6358     * The end date of the period.
6359     *
6360     * @var DateTimeInterface
6361     **/
6362    public $end;
6363
6364    /**
6365     * Whether to include the start date in the set of recurring dates or
6366     * not.
6367     *
6368     * @var boolean
6369     **/
6370    public $include_start_date;
6371
6372    /**
6373     * An ISO 8601 repeating interval specification.
6374     *
6375     * @var DateInterval
6376     **/
6377    public $interval;
6378
6379    /**
6380     * The number of recurrences, if the DatePeriod instance had been created
6381     * by explicitly passing $recurrences. See also
6382     * DatePeriod::getRecurrences.
6383     *
6384     * @var integer
6385     **/
6386    public $recurrences;
6387
6388    /**
6389     * The start date of the period.
6390     *
6391     * @var DateTimeInterface
6392     **/
6393    public $start;
6394
6395    /**
6396     * Gets the interval
6397     *
6398     * Gets a DateInterval object representing the interval used for the
6399     * period.
6400     *
6401     * @return DateInterval Returns a DateInterval object
6402     * @since PHP 5 >= 5.6.5, PHP 7
6403     **/
6404    public function getDateInterval(){}
6405
6406    /**
6407     * Gets the end date
6408     *
6409     * Gets the end date of the period.
6410     *
6411     * @return DateTimeInterface Returns NULL if the DatePeriod does not
6412     *   have an end date. For example, when initialized with the {@link
6413     *   recurrences} parameter, or the {@link isostr} parameter without an
6414     *   end date.
6415     * @since PHP 5 >= 5.6.5, PHP 7
6416     **/
6417    public function getEndDate(){}
6418
6419    /**
6420     * Gets the number of recurrences
6421     *
6422     * Get the number of recurrences.
6423     *
6424     * @return int Returns the number of recurrences.
6425     * @since PHP 7 >= 7.2.17/7.3.4
6426     **/
6427    public function getRecurrences(){}
6428
6429    /**
6430     * Gets the start date
6431     *
6432     * Gets the start date of the period.
6433     *
6434     * @return DateTimeInterface Returns a DateTimeImmutable object when
6435     *   the DatePeriod is initialized with a DateTimeImmutable object as the
6436     *   {@link start} parameter.
6437     * @since PHP 5 >= 5.6.5, PHP 7
6438     **/
6439    public function getStartDate(){}
6440
6441}
6442/**
6443 * This class behaves the same as DateTimeImmutable except objects are
6444 * modified itself when modification methods such as {@link
6445 * DateTime::modify} are called. 7.2.0 The class constants of DateTime
6446 * are now defined on DateTimeInterface. 7.0.0 Added constants:
6447 * DATE_RFC3339_EXTENDED and DateTime::RFC3339_EXTENDED. 5.5.0 The class
6448 * now implements DateTimeInterface. 5.4.24 The COOKIE constant was
6449 * changed to reflect RFC 1036 using a four digit year rather than a two
6450 * digit year (RFC 850) as prior versions. 5.2.2 DateTime object
6451 * comparison with the comparison operators changed to work as expected.
6452 * Previously, all DateTime objects were considered equal (using ==).
6453 **/
6454class DateTime implements DateTimeInterface {
6455    /**
6456     * Adds an amount of days, months, years, hours, minutes and seconds to a
6457     * DateTime object
6458     *
6459     * Adds the specified DateInterval object to the specified DateTime
6460     * object.
6461     *
6462     * @param DateInterval $interval A DateInterval object
6463     * @return DateTime
6464     * @since PHP 5 >= 5.3.0, PHP 7
6465     **/
6466    public function add($interval){}
6467
6468    /**
6469     * Parses a time string according to a specified format
6470     *
6471     * Returns a new DateTime object representing the date and time specified
6472     * by the {@link datetime} string, which was formatted in the given
6473     * {@link format}.
6474     *
6475     * @param string $format The format that the passed in string should be
6476     *   in. See the formatting options below. In most cases, the same
6477     *   letters as for the {@link date} can be used.
6478     *
6479     *   The following characters are recognized in the {@link format}
6480     *   parameter string {@link format} character Description Example
6481     *   parsable values Day --- --- d and j Day of the month, 2 digits with
6482     *   or without leading zeros 01 to 31 or 1 to 31 D and l A textual
6483     *   representation of a day Mon through Sun or Sunday through Saturday S
6484     *   English ordinal suffix for the day of the month, 2 characters. It's
6485     *   ignored while processing. st, nd, rd or th. z The day of the year
6486     *   (starting from 0) 0 through 365 Month --- --- F and M A textual
6487     *   representation of a month, such as January or Sept January through
6488     *   December or Jan through Dec m and n Numeric representation of a
6489     *   month, with or without leading zeros 01 through 12 or 1 through 12
6490     *   Year --- --- Y A full numeric representation of a year, 4 digits
6491     *   Examples: 1999 or 2003 y A two digit representation of a year (which
6492     *   is assumed to be in the range 1970-2069, inclusive) Examples: 99 or
6493     *   03 (which will be interpreted as 1999 and 2003, respectively) Time
6494     *   --- --- a and A Ante meridiem and Post meridiem am or pm g and h
6495     *   12-hour format of an hour with or without leading zero 1 through 12
6496     *   or 01 through 12 G and H 24-hour format of an hour with or without
6497     *   leading zeros 0 through 23 or 00 through 23 i Minutes with leading
6498     *   zeros 00 to 59 s Seconds, with leading zeros 00 through 59 v
6499     *   Milliseconds (up to three digits) Example: 12, 345 u Microseconds
6500     *   (up to six digits) Example: 45, 654321 Timezone --- --- e, O, P and
6501     *   T Timezone identifier, or difference to UTC in hours, or difference
6502     *   to UTC with colon between hours and minutes, or timezone
6503     *   abbreviation Examples: UTC, GMT, Atlantic/Azores or +0200 or +02:00
6504     *   or EST, MDT Full Date/Time --- --- U Seconds since the Unix Epoch
6505     *   (January 1 1970 00:00:00 GMT) Example: 1292177455 Whitespace and
6506     *   Separators --- --- (space) One space or one tab Example: # One of
6507     *   the following separation symbol: ;, :, /, ., ,, -, ( or ) Example: /
6508     *   ;, :, /, ., ,, -, ( or ) The specified character. Example: - ? A
6509     *   random byte Example: ^ (Be aware that for UTF-8 characters you might
6510     *   need more than one ?. In this case, using * is probably what you
6511     *   want instead) * Random bytes until the next separator or digit
6512     *   Example: * in Y-*-d with the string 2009-aWord-08 will match aWord !
6513     *   Resets all fields (year, month, day, hour, minute, second, fraction
6514     *   and timezone information) to the Unix Epoch Without !, all fields
6515     *   will be set to the current date and time. | Resets all fields (year,
6516     *   month, day, hour, minute, second, fraction and timezone information)
6517     *   to the Unix Epoch if they have not been parsed yet Y-m-d| will set
6518     *   the year, month and day to the information found in the string to
6519     *   parse, and sets the hour, minute and second to 0. + If this format
6520     *   specifier is present, trailing data in the string will not cause an
6521     *   error, but a warning instead Use DateTime::getLastErrors to find out
6522     *   whether trailing data was present. Unrecognized characters in the
6523     *   format string will cause the parsing to fail and an error message is
6524     *   appended to the returned structure. You can query error messages
6525     *   with DateTime::getLastErrors. To include literal characters in
6526     *   {@link format}, you have to escape them with a backslash (\). If
6527     *   {@link format} does not contain the character ! then portions of the
6528     *   generated time which are not specified in {@link format} will be set
6529     *   to the current system time. If {@link format} contains the character
6530     *   !, then portions of the generated time not provided in {@link
6531     *   format}, as well as values to the left-hand side of the !, will be
6532     *   set to corresponding values from the Unix epoch. The Unix epoch is
6533     *   1970-01-01 00:00:00 UTC.
6534     * @param string $datetime String representing the time.
6535     * @param DateTimeZone $timezone A DateTimeZone object representing the
6536     *   desired time zone. If {@link timezone} is omitted and {@link
6537     *   datetime} contains no timezone, the current timezone will be used.
6538     * @return DateTime Returns a new DateTime instance.
6539     * @since PHP 5 >= 5.3.0, PHP 7
6540     **/
6541    public static function createFromFormat($format, $datetime, $timezone){}
6542
6543    /**
6544     * Returns new DateTime object encapsulating the given DateTimeImmutable
6545     * object
6546     *
6547     * @param DateTimeImmutable $object The immutable DateTimeImmutable
6548     *   object that needs to be converted to a mutable version. This object
6549     *   is not modified, but instead a new DateTime object is created
6550     *   containing the same date, time, and timezone information.
6551     * @return DateTime Returns a new DateTime instance.
6552     * @since PHP 7 >= 7.3.0
6553     **/
6554    public static function createFromImmutable($object){}
6555
6556    /**
6557     * Returns the difference between two DateTime objects
6558     *
6559     * Returns the difference between two DateTimeInterface objects.
6560     *
6561     * @param DateTimeInterface $targetObject The date to compare to.
6562     * @param bool $absolute Should the interval be forced to be positive?
6563     * @return DateInterval The DateInterval object represents the
6564     *   difference between the two dates.
6565     * @since PHP 5 >= 5.3.0, PHP 7
6566     **/
6567    public function diff($targetObject, $absolute){}
6568
6569    /**
6570     * Returns date formatted according to given format
6571     *
6572     * @param string $format The format of the outputted date string. See
6573     *   the formatting options below. There are also several predefined date
6574     *   constants that may be used instead, so for example DATE_RSS contains
6575     *   the format string 'D, d M Y H:i:s'.
6576     *
6577     *   The following characters are recognized in the {@link format}
6578     *   parameter string {@link format} character Description Example
6579     *   returned values Day --- --- d Day of the month, 2 digits with
6580     *   leading zeros 01 to 31 D A textual representation of a day, three
6581     *   letters Mon through Sun j Day of the month without leading zeros 1
6582     *   to 31 l (lowercase 'L') A full textual representation of the day of
6583     *   the week Sunday through Saturday N ISO-8601 numeric representation
6584     *   of the day of the week (added in PHP 5.1.0) 1 (for Monday) through 7
6585     *   (for Sunday) S English ordinal suffix for the day of the month, 2
6586     *   characters st, nd, rd or th. Works well with j w Numeric
6587     *   representation of the day of the week 0 (for Sunday) through 6 (for
6588     *   Saturday) z The day of the year (starting from 0) 0 through 365 Week
6589     *   --- --- W ISO-8601 week number of year, weeks starting on Monday
6590     *   Example: 42 (the 42nd week in the year) Month --- --- F A full
6591     *   textual representation of a month, such as January or March January
6592     *   through December m Numeric representation of a month, with leading
6593     *   zeros 01 through 12 M A short textual representation of a month,
6594     *   three letters Jan through Dec n Numeric representation of a month,
6595     *   without leading zeros 1 through 12 t Number of days in the given
6596     *   month 28 through 31 Year --- --- L Whether it's a leap year 1 if it
6597     *   is a leap year, 0 otherwise. o ISO-8601 week-numbering year. This
6598     *   has the same value as Y, except that if the ISO week number (W)
6599     *   belongs to the previous or next year, that year is used instead.
6600     *   (added in PHP 5.1.0) Examples: 1999 or 2003 Y A full numeric
6601     *   representation of a year, 4 digits Examples: 1999 or 2003 y A two
6602     *   digit representation of a year Examples: 99 or 03 Time --- --- a
6603     *   Lowercase Ante meridiem and Post meridiem am or pm A Uppercase Ante
6604     *   meridiem and Post meridiem AM or PM B Swatch Internet time 000
6605     *   through 999 g 12-hour format of an hour without leading zeros 1
6606     *   through 12 G 24-hour format of an hour without leading zeros 0
6607     *   through 23 h 12-hour format of an hour with leading zeros 01 through
6608     *   12 H 24-hour format of an hour with leading zeros 00 through 23 i
6609     *   Minutes with leading zeros 00 to 59 s Seconds with leading zeros 00
6610     *   through 59 u Microseconds (added in PHP 5.2.2). Note that {@link
6611     *   date} will always generate 000000 since it takes an integer
6612     *   parameter, whereas DateTime::format does support microseconds if
6613     *   DateTime was created with microseconds. Example: 654321 v
6614     *   Milliseconds (added in PHP 7.0.0). Same note applies as for u.
6615     *   Example: 654 Timezone --- --- e Timezone identifier (added in PHP
6616     *   5.1.0) Examples: UTC, GMT, Atlantic/Azores I (capital i) Whether or
6617     *   not the date is in daylight saving time 1 if Daylight Saving Time, 0
6618     *   otherwise. O Difference to Greenwich time (GMT) without colon
6619     *   between hours and minutes Example: +0200 P Difference to Greenwich
6620     *   time (GMT) with colon between hours and minutes (added in PHP 5.1.3)
6621     *   Example: +02:00 T Timezone abbreviation Examples: EST, MDT ... Z
6622     *   Timezone offset in seconds. The offset for timezones west of UTC is
6623     *   always negative, and for those east of UTC is always positive.
6624     *   -43200 through 50400 Full Date/Time --- --- c ISO 8601 date (added
6625     *   in PHP 5) 2004-02-12T15:19:21+00:00 r RFC 2822 formatted date
6626     *   Example: Thu, 21 Dec 2000 16:01:07 +0200 U Seconds since the Unix
6627     *   Epoch (January 1 1970 00:00:00 GMT) See also {@link time}
6628     *   Unrecognized characters in the format string will be printed as-is.
6629     *   The Z format will always return 0 when using {@link gmdate}.
6630     * @return string Returns the formatted date string on success.
6631     * @since PHP 5 >= 5.2.1, PHP 7
6632     **/
6633    public function format($format){}
6634
6635    /**
6636     * Returns the warnings and errors
6637     *
6638     * Returns an array of warnings and errors found while parsing a
6639     * date/time string.
6640     *
6641     * @return array Returns array containing info about warnings and
6642     *   errors.
6643     * @since PHP 5 >= 5.3.0, PHP 7
6644     **/
6645    public static function getLastErrors(){}
6646
6647    /**
6648     * Returns the timezone offset
6649     *
6650     * @return int Returns the timezone offset in seconds from UTC on
6651     *   success .
6652     * @since PHP 5 >= 5.2.1, PHP 7
6653     **/
6654    public function getOffset(){}
6655
6656    /**
6657     * Gets the Unix timestamp
6658     *
6659     * @return int Returns the Unix timestamp representing the date.
6660     * @since PHP 5 >= 5.3.0, PHP 7
6661     **/
6662    public function getTimestamp(){}
6663
6664    /**
6665     * Return time zone relative to given DateTime
6666     *
6667     * @return DateTimeZone Returns a DateTimeZone object on success .
6668     * @since PHP 5 >= 5.2.1, PHP 7
6669     **/
6670    public function getTimezone(){}
6671
6672    /**
6673     * Alters the timestamp
6674     *
6675     * Alter the timestamp of a DateTime object by incrementing or
6676     * decrementing in a format accepted by {@link
6677     * DateTimeImmutable::__construct}.
6678     *
6679     * @param string $modifier
6680     * @return DateTime
6681     * @since PHP 5 >= 5.2.0, PHP 7
6682     **/
6683    public function modify($modifier){}
6684
6685    /**
6686     * Sets the date
6687     *
6688     * Resets the current date of the DateTime object to a different date.
6689     *
6690     * @param int $year Year of the date.
6691     * @param int $month Month of the date.
6692     * @param int $day Day of the date.
6693     * @return DateTime
6694     * @since PHP 5 >= 5.2.0, PHP 7
6695     **/
6696    public function setDate($year, $month, $day){}
6697
6698    /**
6699     * Sets the ISO date
6700     *
6701     * Set a date according to the ISO 8601 standard - using weeks and day
6702     * offsets rather than specific dates.
6703     *
6704     * @param int $year Year of the date.
6705     * @param int $week Week of the date.
6706     * @param int $dayOfWeek Offset from the first day of the week.
6707     * @return DateTime
6708     * @since PHP 5 >= 5.2.0, PHP 7
6709     **/
6710    public function setISODate($year, $week, $dayOfWeek){}
6711
6712    /**
6713     * Sets the time
6714     *
6715     * Resets the current time of the DateTime object to a different time.
6716     *
6717     * @param int $hour Hour of the time.
6718     * @param int $minute Minute of the time.
6719     * @param int $second Second of the time.
6720     * @param int $microsecond Microsecond of the time.
6721     * @return DateTime
6722     * @since PHP 5 >= 5.2.0, PHP 7
6723     **/
6724    public function setTime($hour, $minute, $second, $microsecond){}
6725
6726    /**
6727     * Sets the date and time based on an Unix timestamp
6728     *
6729     * @param int $timestamp Unix timestamp representing the date.
6730     * @return DateTime
6731     * @since PHP 5 >= 5.3.0, PHP 7
6732     **/
6733    public function setTimestamp($timestamp){}
6734
6735    /**
6736     * Sets the time zone for the DateTime object
6737     *
6738     * Sets a new timezone for a DateTime object.
6739     *
6740     * @param DateTimeZone $timezone A DateTimeZone object representing the
6741     *   desired time zone.
6742     * @return DateTime
6743     * @since PHP 5 >= 5.2.0, PHP 7
6744     **/
6745    public function setTimezone($timezone){}
6746
6747    /**
6748     * Subtracts an amount of days, months, years, hours, minutes and seconds
6749     * from a DateTime object
6750     *
6751     * Subtracts the specified DateInterval object from the specified
6752     * DateTime object.
6753     *
6754     * @param DateInterval $interval A DateInterval object
6755     * @return DateTime
6756     * @since PHP 5 >= 5.3.0, PHP 7
6757     **/
6758    public function sub($interval){}
6759
6760    /**
6761     * The __set_state handler
6762     *
6763     * The __set_state() handler.
6764     *
6765     * @param array $array Initialization array.
6766     * @return DateTime Returns a new instance of a DateTime object.
6767     * @since PHP 5 >= 5.3.0, PHP 7
6768     **/
6769    public static function __set_state($array){}
6770
6771    /**
6772     * The __wakeup handler
6773     *
6774     * The __wakeup() handler.
6775     *
6776     * @since PHP 5 >= 5.3.0, PHP 7
6777     **/
6778    public function __wakeup(){}
6779
6780}
6781/**
6782 * Representation of date and time.
6783 **/
6784class DateTimeImmutable implements DateTimeInterface {
6785    /**
6786     * Adds an amount of days, months, years, hours, minutes and seconds
6787     *
6788     * Like DateTime::add but works with DateTimeImmutable.
6789     *
6790     * @param DateInterval $interval
6791     * @return DateTimeImmutable
6792     * @since PHP 5 >= 5.5.0, PHP 7
6793     **/
6794    public function add($interval){}
6795
6796    /**
6797     * Parses a time string according to a specified format
6798     *
6799     * Like DateTime::createFromFormat but works with DateTimeImmutable.
6800     *
6801     * @param string $format
6802     * @param string $datetime
6803     * @param DateTimeZone $timezone
6804     * @return DateTimeImmutable
6805     * @since PHP 5 >= 5.5.0, PHP 7
6806     **/
6807    public static function createFromFormat($format, $datetime, $timezone){}
6808
6809    /**
6810     * Returns new DateTimeImmutable object encapsulating the given DateTime
6811     * object
6812     *
6813     * @param DateTime $object The mutable DateTime object that you want to
6814     *   convert to an immutable version. This object is not modified, but
6815     *   instead a new DateTimeImmutable object is created containing the
6816     *   same date time and timezone information.
6817     * @return DateTimeImmutable Returns a new DateTimeImmutable instance.
6818     * @since PHP 5 >= 5.6.0, PHP 7
6819     **/
6820    public static function createFromMutable($object){}
6821
6822    /**
6823     * Returns the difference between two DateTime objects
6824     *
6825     * Returns the difference between two DateTimeInterface objects.
6826     *
6827     * @param DateTimeInterface $targetObject The date to compare to.
6828     * @param bool $absolute Should the interval be forced to be positive?
6829     * @return DateInterval The DateInterval object represents the
6830     *   difference between the two dates.
6831     * @since PHP 5 >= 5.5.0, PHP 7
6832     **/
6833    public function diff($targetObject, $absolute){}
6834
6835    /**
6836     * Returns date formatted according to given format
6837     *
6838     * @param string $format The format of the outputted date string. See
6839     *   the formatting options below. There are also several predefined date
6840     *   constants that may be used instead, so for example DATE_RSS contains
6841     *   the format string 'D, d M Y H:i:s'.
6842     *
6843     *   The following characters are recognized in the {@link format}
6844     *   parameter string {@link format} character Description Example
6845     *   returned values Day --- --- d Day of the month, 2 digits with
6846     *   leading zeros 01 to 31 D A textual representation of a day, three
6847     *   letters Mon through Sun j Day of the month without leading zeros 1
6848     *   to 31 l (lowercase 'L') A full textual representation of the day of
6849     *   the week Sunday through Saturday N ISO-8601 numeric representation
6850     *   of the day of the week (added in PHP 5.1.0) 1 (for Monday) through 7
6851     *   (for Sunday) S English ordinal suffix for the day of the month, 2
6852     *   characters st, nd, rd or th. Works well with j w Numeric
6853     *   representation of the day of the week 0 (for Sunday) through 6 (for
6854     *   Saturday) z The day of the year (starting from 0) 0 through 365 Week
6855     *   --- --- W ISO-8601 week number of year, weeks starting on Monday
6856     *   Example: 42 (the 42nd week in the year) Month --- --- F A full
6857     *   textual representation of a month, such as January or March January
6858     *   through December m Numeric representation of a month, with leading
6859     *   zeros 01 through 12 M A short textual representation of a month,
6860     *   three letters Jan through Dec n Numeric representation of a month,
6861     *   without leading zeros 1 through 12 t Number of days in the given
6862     *   month 28 through 31 Year --- --- L Whether it's a leap year 1 if it
6863     *   is a leap year, 0 otherwise. o ISO-8601 week-numbering year. This
6864     *   has the same value as Y, except that if the ISO week number (W)
6865     *   belongs to the previous or next year, that year is used instead.
6866     *   (added in PHP 5.1.0) Examples: 1999 or 2003 Y A full numeric
6867     *   representation of a year, 4 digits Examples: 1999 or 2003 y A two
6868     *   digit representation of a year Examples: 99 or 03 Time --- --- a
6869     *   Lowercase Ante meridiem and Post meridiem am or pm A Uppercase Ante
6870     *   meridiem and Post meridiem AM or PM B Swatch Internet time 000
6871     *   through 999 g 12-hour format of an hour without leading zeros 1
6872     *   through 12 G 24-hour format of an hour without leading zeros 0
6873     *   through 23 h 12-hour format of an hour with leading zeros 01 through
6874     *   12 H 24-hour format of an hour with leading zeros 00 through 23 i
6875     *   Minutes with leading zeros 00 to 59 s Seconds with leading zeros 00
6876     *   through 59 u Microseconds (added in PHP 5.2.2). Note that {@link
6877     *   date} will always generate 000000 since it takes an integer
6878     *   parameter, whereas DateTime::format does support microseconds if
6879     *   DateTime was created with microseconds. Example: 654321 v
6880     *   Milliseconds (added in PHP 7.0.0). Same note applies as for u.
6881     *   Example: 654 Timezone --- --- e Timezone identifier (added in PHP
6882     *   5.1.0) Examples: UTC, GMT, Atlantic/Azores I (capital i) Whether or
6883     *   not the date is in daylight saving time 1 if Daylight Saving Time, 0
6884     *   otherwise. O Difference to Greenwich time (GMT) without colon
6885     *   between hours and minutes Example: +0200 P Difference to Greenwich
6886     *   time (GMT) with colon between hours and minutes (added in PHP 5.1.3)
6887     *   Example: +02:00 T Timezone abbreviation Examples: EST, MDT ... Z
6888     *   Timezone offset in seconds. The offset for timezones west of UTC is
6889     *   always negative, and for those east of UTC is always positive.
6890     *   -43200 through 50400 Full Date/Time --- --- c ISO 8601 date (added
6891     *   in PHP 5) 2004-02-12T15:19:21+00:00 r RFC 2822 formatted date
6892     *   Example: Thu, 21 Dec 2000 16:01:07 +0200 U Seconds since the Unix
6893     *   Epoch (January 1 1970 00:00:00 GMT) See also {@link time}
6894     *   Unrecognized characters in the format string will be printed as-is.
6895     *   The Z format will always return 0 when using {@link gmdate}.
6896     * @return string Returns the formatted date string on success.
6897     * @since PHP 5 >= 5.5.0, PHP 7
6898     **/
6899    public function format($format){}
6900
6901    /**
6902     * Returns the warnings and errors
6903     *
6904     * Like DateTime::getLastErrors but works with DateTimeImmutable.
6905     *
6906     * @return array
6907     * @since PHP 5 >= 5.5.0, PHP 7
6908     **/
6909    public static function getLastErrors(){}
6910
6911    /**
6912     * Returns the timezone offset
6913     *
6914     * @return int Returns the timezone offset in seconds from UTC on
6915     *   success .
6916     * @since PHP 5 >= 5.5.0, PHP 7
6917     **/
6918    public function getOffset(){}
6919
6920    /**
6921     * Gets the Unix timestamp
6922     *
6923     * @return int Returns the Unix timestamp representing the date.
6924     * @since PHP 5 >= 5.5.0, PHP 7
6925     **/
6926    public function getTimestamp(){}
6927
6928    /**
6929     * Return time zone relative to given DateTime
6930     *
6931     * @return DateTimeZone Returns a DateTimeZone object on success .
6932     * @since PHP 5 >= 5.5.0, PHP 7
6933     **/
6934    public function getTimezone(){}
6935
6936    /**
6937     * Creates a new object with modified timestamp
6938     *
6939     * Creates a new DateTimeImmutable object with modified timestamp. The
6940     * original object is not modified.
6941     *
6942     * @param string $modifier
6943     * @return DateTimeImmutable Returns the newly created object.
6944     * @since PHP 5 >= 5.5.0, PHP 7
6945     **/
6946    public function modify($modifier){}
6947
6948    /**
6949     * Sets the date
6950     *
6951     * Like DateTime::setDate but works with DateTimeImmutable.
6952     *
6953     * @param int $year
6954     * @param int $month
6955     * @param int $day
6956     * @return DateTimeImmutable
6957     * @since PHP 5 >= 5.5.0, PHP 7
6958     **/
6959    public function setDate($year, $month, $day){}
6960
6961    /**
6962     * Sets the ISO date
6963     *
6964     * Like DateTime::setISODate but works with DateTimeImmutable.
6965     *
6966     * @param int $year
6967     * @param int $week
6968     * @param int $day
6969     * @return DateTimeImmutable
6970     * @since PHP 5 >= 5.5.0, PHP 7
6971     **/
6972    public function setISODate($year, $week, $day){}
6973
6974    /**
6975     * Sets the time
6976     *
6977     * Like DateTime::setTime but works with DateTimeImmutable.
6978     *
6979     * @param int $hour
6980     * @param int $minute
6981     * @param int $second
6982     * @param int $microsecond
6983     * @return DateTimeImmutable
6984     * @since PHP 5 >= 5.5.0, PHP 7
6985     **/
6986    public function setTime($hour, $minute, $second, $microsecond){}
6987
6988    /**
6989     * Sets the date and time based on a Unix timestamp
6990     *
6991     * Like DateTime::setTimestamp but works with DateTimeImmutable.
6992     *
6993     * @param int $timestamp
6994     * @return DateTimeImmutable
6995     * @since PHP 5 >= 5.5.0, PHP 7
6996     **/
6997    public function setTimestamp($timestamp){}
6998
6999    /**
7000     * Sets the time zone
7001     *
7002     * Like DateTime::setTimezone but works with DateTimeImmutable.
7003     *
7004     * @param DateTimeZone $timezone
7005     * @return DateTimeImmutable
7006     * @since PHP 5 >= 5.5.0, PHP 7
7007     **/
7008    public function setTimezone($timezone){}
7009
7010    /**
7011     * Subtracts an amount of days, months, years, hours, minutes and seconds
7012     *
7013     * Like DateTime::sub but works with DateTimeImmutable.
7014     *
7015     * @param DateInterval $interval
7016     * @return DateTimeImmutable
7017     * @since PHP 5 >= 5.5.0, PHP 7
7018     **/
7019    public function sub($interval){}
7020
7021    /**
7022     * The __set_state handler
7023     *
7024     * Like DateTime::__set_state but works with DateTimeImmutable.
7025     *
7026     * @param array $array
7027     * @return DateTimeImmutable
7028     * @since PHP 5 >= 5.5.0, PHP 7
7029     **/
7030    public static function __set_state($array){}
7031
7032    /**
7033     * The __wakeup handler
7034     *
7035     * The __wakeup() handler.
7036     *
7037     * @since PHP 5 >= 5.5.0, PHP 7
7038     **/
7039    public function __wakeup(){}
7040
7041}
7042/**
7043 * DateTimeInterface is meant so that both DateTime and DateTimeImmutable
7044 * can be type hinted for. It is not possible to implement this interface
7045 * with userland classes. 7.2.0 The class constants of DateTime are now
7046 * defined on DateTimeInterface. 5.5.8 Trying to implement
7047 * DateTimeInterface raises a fatal error now. Formerly implementing the
7048 * interface didn't raise an error, but the behavior was erroneous.
7049 **/
7050interface DateTimeInterface {
7051    /**
7052     * @var string
7053     **/
7054    const ATOM = '';
7055
7056    /**
7057     * @var string
7058     **/
7059    const COOKIE = '';
7060
7061    /**
7062     * @var string
7063     **/
7064    const ISO8601 = '';
7065
7066    /**
7067     * @var string
7068     **/
7069    const RFC822 = '';
7070
7071    /**
7072     * @var string
7073     **/
7074    const RFC850 = '';
7075
7076    /**
7077     * @var string
7078     **/
7079    const RFC1036 = '';
7080
7081    /**
7082     * @var string
7083     **/
7084    const RFC1123 = '';
7085
7086    /**
7087     * @var string
7088     **/
7089    const RFC2822 = '';
7090
7091    /**
7092     * @var string
7093     **/
7094    const RFC3339 = '';
7095
7096    /**
7097     * @var string
7098     **/
7099    const RFC3339_EXTENDED = '';
7100
7101    /**
7102     * @var string
7103     **/
7104    const RFC7231 = '';
7105
7106    /**
7107     * @var string
7108     **/
7109    const RSS = '';
7110
7111    /**
7112     * @var string
7113     **/
7114    const W3C = '';
7115
7116    /**
7117     * Returns the difference between two DateTime objects
7118     *
7119     * Returns the difference between two DateTimeInterface objects.
7120     *
7121     * @param DateTimeInterface $targetObject The date to compare to.
7122     * @param bool $absolute Should the interval be forced to be positive?
7123     * @return DateInterval The DateInterval object represents the
7124     *   difference between the two dates.
7125     * @since PHP 5 >= 5.3.0, PHP 7
7126     **/
7127    public function diff($targetObject, $absolute);
7128
7129    /**
7130     * Returns date formatted according to given format
7131     *
7132     * @param string $format The format of the outputted date string. See
7133     *   the formatting options below. There are also several predefined date
7134     *   constants that may be used instead, so for example DATE_RSS contains
7135     *   the format string 'D, d M Y H:i:s'.
7136     *
7137     *   The following characters are recognized in the {@link format}
7138     *   parameter string {@link format} character Description Example
7139     *   returned values Day --- --- d Day of the month, 2 digits with
7140     *   leading zeros 01 to 31 D A textual representation of a day, three
7141     *   letters Mon through Sun j Day of the month without leading zeros 1
7142     *   to 31 l (lowercase 'L') A full textual representation of the day of
7143     *   the week Sunday through Saturday N ISO-8601 numeric representation
7144     *   of the day of the week (added in PHP 5.1.0) 1 (for Monday) through 7
7145     *   (for Sunday) S English ordinal suffix for the day of the month, 2
7146     *   characters st, nd, rd or th. Works well with j w Numeric
7147     *   representation of the day of the week 0 (for Sunday) through 6 (for
7148     *   Saturday) z The day of the year (starting from 0) 0 through 365 Week
7149     *   --- --- W ISO-8601 week number of year, weeks starting on Monday
7150     *   Example: 42 (the 42nd week in the year) Month --- --- F A full
7151     *   textual representation of a month, such as January or March January
7152     *   through December m Numeric representation of a month, with leading
7153     *   zeros 01 through 12 M A short textual representation of a month,
7154     *   three letters Jan through Dec n Numeric representation of a month,
7155     *   without leading zeros 1 through 12 t Number of days in the given
7156     *   month 28 through 31 Year --- --- L Whether it's a leap year 1 if it
7157     *   is a leap year, 0 otherwise. o ISO-8601 week-numbering year. This
7158     *   has the same value as Y, except that if the ISO week number (W)
7159     *   belongs to the previous or next year, that year is used instead.
7160     *   (added in PHP 5.1.0) Examples: 1999 or 2003 Y A full numeric
7161     *   representation of a year, 4 digits Examples: 1999 or 2003 y A two
7162     *   digit representation of a year Examples: 99 or 03 Time --- --- a
7163     *   Lowercase Ante meridiem and Post meridiem am or pm A Uppercase Ante
7164     *   meridiem and Post meridiem AM or PM B Swatch Internet time 000
7165     *   through 999 g 12-hour format of an hour without leading zeros 1
7166     *   through 12 G 24-hour format of an hour without leading zeros 0
7167     *   through 23 h 12-hour format of an hour with leading zeros 01 through
7168     *   12 H 24-hour format of an hour with leading zeros 00 through 23 i
7169     *   Minutes with leading zeros 00 to 59 s Seconds with leading zeros 00
7170     *   through 59 u Microseconds (added in PHP 5.2.2). Note that {@link
7171     *   date} will always generate 000000 since it takes an integer
7172     *   parameter, whereas DateTime::format does support microseconds if
7173     *   DateTime was created with microseconds. Example: 654321 v
7174     *   Milliseconds (added in PHP 7.0.0). Same note applies as for u.
7175     *   Example: 654 Timezone --- --- e Timezone identifier (added in PHP
7176     *   5.1.0) Examples: UTC, GMT, Atlantic/Azores I (capital i) Whether or
7177     *   not the date is in daylight saving time 1 if Daylight Saving Time, 0
7178     *   otherwise. O Difference to Greenwich time (GMT) without colon
7179     *   between hours and minutes Example: +0200 P Difference to Greenwich
7180     *   time (GMT) with colon between hours and minutes (added in PHP 5.1.3)
7181     *   Example: +02:00 T Timezone abbreviation Examples: EST, MDT ... Z
7182     *   Timezone offset in seconds. The offset for timezones west of UTC is
7183     *   always negative, and for those east of UTC is always positive.
7184     *   -43200 through 50400 Full Date/Time --- --- c ISO 8601 date (added
7185     *   in PHP 5) 2004-02-12T15:19:21+00:00 r RFC 2822 formatted date
7186     *   Example: Thu, 21 Dec 2000 16:01:07 +0200 U Seconds since the Unix
7187     *   Epoch (January 1 1970 00:00:00 GMT) See also {@link time}
7188     *   Unrecognized characters in the format string will be printed as-is.
7189     *   The Z format will always return 0 when using {@link gmdate}.
7190     * @return string Returns the formatted date string on success.
7191     * @since PHP 5 >= 5.2.0, PHP 7
7192     **/
7193    public function format($format);
7194
7195    /**
7196     * Returns the timezone offset
7197     *
7198     * @return int Returns the timezone offset in seconds from UTC on
7199     *   success .
7200     * @since PHP 5 >= 5.2.0, PHP 7
7201     **/
7202    public function getOffset();
7203
7204    /**
7205     * Gets the Unix timestamp
7206     *
7207     * @return int Returns the Unix timestamp representing the date.
7208     * @since PHP 5 >= 5.3.0, PHP 7
7209     **/
7210    public function getTimestamp();
7211
7212    /**
7213     * Return time zone relative to given DateTime
7214     *
7215     * @return DateTimeZone Returns a DateTimeZone object on success .
7216     * @since PHP 5 >= 5.2.0, PHP 7
7217     **/
7218    public function getTimezone();
7219
7220    /**
7221     * The __wakeup handler
7222     *
7223     * The __wakeup() handler.
7224     *
7225     * @since PHP 5 >= 5.2.0, PHP 7
7226     **/
7227    public function __wakeup();
7228
7229}
7230/**
7231 * Representation of time zone.
7232 **/
7233class DateTimeZone {
7234    /**
7235     * Africa time zones.
7236     *
7237     * @var integer
7238     **/
7239    const AFRICA = 0;
7240
7241    /**
7242     * All time zones.
7243     *
7244     * @var integer
7245     **/
7246    const ALL = 0;
7247
7248    /**
7249     * @var integer
7250     **/
7251    const ALL_WITH_BC = 0;
7252
7253    /**
7254     * America time zones.
7255     *
7256     * @var integer
7257     **/
7258    const AMERICA = 0;
7259
7260    /**
7261     * Antarctica time zones.
7262     *
7263     * @var integer
7264     **/
7265    const ANTARCTICA = 0;
7266
7267    /**
7268     * Arctic time zones.
7269     *
7270     * @var integer
7271     **/
7272    const ARCTIC = 0;
7273
7274    /**
7275     * Asia time zones.
7276     *
7277     * @var integer
7278     **/
7279    const ASIA = 0;
7280
7281    /**
7282     * Atlantic time zones.
7283     *
7284     * @var integer
7285     **/
7286    const ATLANTIC = 0;
7287
7288    /**
7289     * Australia time zones.
7290     *
7291     * @var integer
7292     **/
7293    const AUSTRALIA = 0;
7294
7295    /**
7296     * Europe time zones.
7297     *
7298     * @var integer
7299     **/
7300    const EUROPE = 0;
7301
7302    /**
7303     * Indian time zones.
7304     *
7305     * @var integer
7306     **/
7307    const INDIAN = 0;
7308
7309    /**
7310     * Pacific time zones.
7311     *
7312     * @var integer
7313     **/
7314    const PACIFIC = 0;
7315
7316    /**
7317     * @var integer
7318     **/
7319    const PER_COUNTRY = 0;
7320
7321    /**
7322     * UTC time zones.
7323     *
7324     * @var integer
7325     **/
7326    const UTC = 0;
7327
7328    /**
7329     * Returns location information for a timezone
7330     *
7331     * Returns location information for a timezone, including country code,
7332     * latitude/longitude and comments.
7333     *
7334     * @return array Array containing location information about timezone.
7335     * @since PHP 5 >= 5.3.0, PHP 7
7336     **/
7337    public function getLocation(){}
7338
7339    /**
7340     * Returns the name of the timezone
7341     *
7342     * @return string One of the timezone names in the list of timezones.
7343     * @since PHP 5 >= 5.2.0, PHP 7
7344     **/
7345    public function getName(){}
7346
7347    /**
7348     * Returns the timezone offset from GMT
7349     *
7350     * This function returns the offset to GMT for the date/time specified in
7351     * the {@link datetime} parameter. The GMT offset is calculated with the
7352     * timezone information contained in the DateTimeZone object being used.
7353     *
7354     * @param DateTimeInterface $datetime DateTime that contains the
7355     *   date/time to compute the offset from.
7356     * @return int Returns time zone offset in seconds on success.
7357     * @since PHP 5 >= 5.2.0, PHP 7
7358     **/
7359    public function getOffset($datetime){}
7360
7361    /**
7362     * Returns all transitions for the timezone
7363     *
7364     * @param int $timestampBegin Begin timestamp.
7365     * @param int $timestampEnd End timestamp.
7366     * @return array Returns numerically indexed array containing
7367     *   associative array with all transitions on success.
7368     * @since PHP 5 >= 5.2.0, PHP 7
7369     **/
7370    public function getTransitions($timestampBegin, $timestampEnd){}
7371
7372    /**
7373     * Returns associative array containing dst, offset and the timezone name
7374     *
7375     * @return array Returns array on success.
7376     * @since PHP 5 >= 5.2.0, PHP 7
7377     **/
7378    public static function listAbbreviations(){}
7379
7380    /**
7381     * Returns a numerically indexed array containing all defined timezone
7382     * identifiers
7383     *
7384     * @param int $timezoneGroup One of the DateTimeZone class constants
7385     *   (or a combination).
7386     * @param string $countryCode A two-letter ISO 3166-1 compatible
7387     *   country code.
7388     * @return array Returns array on success.
7389     * @since PHP 5 >= 5.2.0, PHP 7
7390     **/
7391    public static function listIdentifiers($timezoneGroup, $countryCode){}
7392
7393}
7394/**
7395 * Created by {@link dir}.
7396 **/
7397class Directory {
7398    /**
7399     * Can be used with other directory functions such as {@link readdir},
7400     * {@link rewinddir} and {@link closedir}.
7401     *
7402     * @var resource
7403     **/
7404    public $handle;
7405
7406    /**
7407     * The directory that was opened.
7408     *
7409     * @var string
7410     **/
7411    public $path;
7412
7413    /**
7414     * Close directory handle
7415     *
7416     * Same as {@link closedir}, only dir_handle defaults to $this->handle.
7417     *
7418     * @param resource $dir_handle
7419     * @return void
7420     * @since PHP 4, PHP 5, PHP 7
7421     **/
7422    public function close($dir_handle){}
7423
7424    /**
7425     * Read entry from directory handle
7426     *
7427     * Same as {@link readdir}, only dir_handle defaults to $this->handle.
7428     *
7429     * @param resource $dir_handle
7430     * @return string
7431     * @since PHP 4, PHP 5, PHP 7
7432     **/
7433    public function read($dir_handle){}
7434
7435    /**
7436     * Rewind directory handle
7437     *
7438     * Same as {@link rewinddir}, only dir_handle defaults to $this->handle.
7439     *
7440     * @param resource $dir_handle
7441     * @return void
7442     * @since PHP 4, PHP 5, PHP 7
7443     **/
7444    public function rewind($dir_handle){}
7445
7446}
7447/**
7448 * The DirectoryIterator class provides a simple interface for viewing
7449 * the contents of filesystem directories. 5.1.2 DirectoryIterator
7450 * extends SplFileInfo.
7451 **/
7452class DirectoryIterator extends SplFileInfo implements SeekableIterator {
7453    /**
7454     * Return the current DirectoryIterator item
7455     *
7456     * Get the current DirectoryIterator item.
7457     *
7458     * @return DirectoryIterator The current DirectoryIterator item.
7459     * @since PHP 5, PHP 7
7460     **/
7461    public function current(){}
7462
7463    /**
7464     * Get last access time of the current DirectoryIterator item
7465     *
7466     * Get the last access time of the current DirectoryIterator item.
7467     *
7468     * @return int Returns the time the file was last accessed, as a Unix
7469     *   timestamp.
7470     * @since PHP 5, PHP 7
7471     **/
7472    public function getATime(){}
7473
7474    /**
7475     * Get base name of current DirectoryIterator item
7476     *
7477     * Get the base name of the current DirectoryIterator item.
7478     *
7479     * @param string $suffix If the base name ends in {@link suffix}, this
7480     *   will be cut.
7481     * @return string The base name of the current DirectoryIterator item.
7482     * @since PHP 5 >= 5.2.2, PHP 7
7483     **/
7484    public function getBasename($suffix){}
7485
7486    /**
7487     * Get inode change time of the current DirectoryIterator item
7488     *
7489     * Get the inode change time for the current DirectoryIterator item.
7490     *
7491     * @return int Returns the last change time of the file, as a Unix
7492     *   timestamp.
7493     * @since PHP 5, PHP 7
7494     **/
7495    public function getCTime(){}
7496
7497    /**
7498     * Gets the file extension
7499     *
7500     * Retrieves the file extension.
7501     *
7502     * @return string Returns a string containing the file extension, or an
7503     *   empty string if the file has no extension.
7504     * @since PHP 5 >= 5.3.6, PHP 7
7505     **/
7506    public function getExtension(){}
7507
7508    /**
7509     * Return file name of current DirectoryIterator item
7510     *
7511     * Get the file name of the current DirectoryIterator item.
7512     *
7513     * @return string Returns the file name of the current
7514     *   DirectoryIterator item.
7515     * @since PHP 5, PHP 7
7516     **/
7517    public function getFilename(){}
7518
7519    /**
7520     * Get group for the current DirectoryIterator item
7521     *
7522     * Get the group id of the file.
7523     *
7524     * @return int Returns the group id of the current DirectoryIterator
7525     *   item in numerical format.
7526     * @since PHP 5, PHP 7
7527     **/
7528    public function getGroup(){}
7529
7530    /**
7531     * Get inode for the current DirectoryIterator item
7532     *
7533     * Get the inode number for the current DirectoryIterator item.
7534     *
7535     * @return int Returns the inode number for the file.
7536     * @since PHP 5, PHP 7
7537     **/
7538    public function getInode(){}
7539
7540    /**
7541     * Get last modification time of current DirectoryIterator item
7542     *
7543     * Get the last modification time of the current DirectoryIterator item,
7544     * as a Unix timestamp.
7545     *
7546     * @return int The last modification time of the file, as a Unix
7547     *   timestamp.
7548     * @since PHP 5, PHP 7
7549     **/
7550    public function getMTime(){}
7551
7552    /**
7553     * Get owner of current DirectoryIterator item
7554     *
7555     * Get the owner of the current DirectoryIterator item, in numerical
7556     * format.
7557     *
7558     * @return int The file owner of the file, in numerical format.
7559     * @since PHP 5, PHP 7
7560     **/
7561    public function getOwner(){}
7562
7563    /**
7564     * Get path of current Iterator item without filename
7565     *
7566     * Get the path to the current DirectoryIterator item.
7567     *
7568     * @return string Returns the path to the file, omitting the file name
7569     *   and any trailing slash.
7570     * @since PHP 5, PHP 7
7571     **/
7572    public function getPath(){}
7573
7574    /**
7575     * Return path and file name of current DirectoryIterator item
7576     *
7577     * Get the path and file name of the current file.
7578     *
7579     * @return string Returns the path and file name of current file.
7580     *   Directories do not have a trailing slash.
7581     * @since PHP 5, PHP 7
7582     **/
7583    public function getPathname(){}
7584
7585    /**
7586     * Get the permissions of current DirectoryIterator item
7587     *
7588     * Get the permissions of the current DirectoryIterator item.
7589     *
7590     * @return int Returns the permissions of the file, as a decimal
7591     *   integer.
7592     * @since PHP 5, PHP 7
7593     **/
7594    public function getPerms(){}
7595
7596    /**
7597     * Get size of current DirectoryIterator item
7598     *
7599     * Get the file size for the current DirectoryIterator item.
7600     *
7601     * @return int Returns the size of the file, in bytes.
7602     * @since PHP 5, PHP 7
7603     **/
7604    public function getSize(){}
7605
7606    /**
7607     * Determine the type of the current DirectoryIterator item
7608     *
7609     * Determines which file type the current DirectoryIterator item belongs
7610     * to. One of file, link, or dir.
7611     *
7612     * @return string Returns a string representing the type of the file.
7613     *   May be one of file, link, or dir.
7614     * @since PHP 5, PHP 7
7615     **/
7616    public function getType(){}
7617
7618    /**
7619     * Determine if current DirectoryIterator item is a directory
7620     *
7621     * Determines if the current DirectoryIterator item is a directory.
7622     *
7623     * @return bool Returns TRUE if it is a directory, otherwise FALSE
7624     * @since PHP 5, PHP 7
7625     **/
7626    public function isDir(){}
7627
7628    /**
7629     * Determine if current DirectoryIterator item is '.' or '..'
7630     *
7631     * Determines if the current DirectoryIterator item is a directory and
7632     * either . or ..
7633     *
7634     * @return bool TRUE if the entry is . or .., otherwise FALSE
7635     * @since PHP 5, PHP 7
7636     **/
7637    public function isDot(){}
7638
7639    /**
7640     * Determine if current DirectoryIterator item is executable
7641     *
7642     * Determines if the current DirectoryIterator item is executable.
7643     *
7644     * @return bool Returns TRUE if the entry is executable, otherwise
7645     *   FALSE
7646     * @since PHP 5, PHP 7
7647     **/
7648    public function isExecutable(){}
7649
7650    /**
7651     * Determine if current DirectoryIterator item is a regular file
7652     *
7653     * Determines if the current DirectoryIterator item is a regular file.
7654     *
7655     * @return bool Returns TRUE if the file exists and is a regular file
7656     *   (not a link or dir), otherwise FALSE
7657     * @since PHP 5, PHP 7
7658     **/
7659    public function isFile(){}
7660
7661    /**
7662     * Determine if current DirectoryIterator item is a symbolic link
7663     *
7664     * Determines if the current DirectoryIterator item is a symbolic link.
7665     *
7666     * @return bool Returns TRUE if the item is a symbolic link, otherwise
7667     *   FALSE
7668     * @since PHP 5, PHP 7
7669     **/
7670    public function isLink(){}
7671
7672    /**
7673     * Determine if current DirectoryIterator item can be read
7674     *
7675     * Determines if the current DirectoryIterator item is readable.
7676     *
7677     * @return bool Returns TRUE if the file is readable, otherwise FALSE
7678     * @since PHP 5, PHP 7
7679     **/
7680    public function isReadable(){}
7681
7682    /**
7683     * Determine if current DirectoryIterator item can be written to
7684     *
7685     * Determines if the current DirectoryIterator item is writable.
7686     *
7687     * @return bool Returns TRUE if the file/directory is writable,
7688     *   otherwise FALSE
7689     * @since PHP 5, PHP 7
7690     **/
7691    public function isWritable(){}
7692
7693    /**
7694     * Return the key for the current DirectoryIterator item
7695     *
7696     * Get the key for the current DirectoryIterator item.
7697     *
7698     * @return string The key for the current DirectoryIterator item.
7699     * @since PHP 5, PHP 7
7700     **/
7701    public function key(){}
7702
7703    /**
7704     * Move forward to next DirectoryIterator item
7705     *
7706     * Move forward to the next DirectoryIterator item.
7707     *
7708     * @return void
7709     * @since PHP 5, PHP 7
7710     **/
7711    public function next(){}
7712
7713    /**
7714     * Rewind the DirectoryIterator back to the start
7715     *
7716     * Rewind the DirectoryIterator back to the start.
7717     *
7718     * @return void
7719     * @since PHP 5, PHP 7
7720     **/
7721    public function rewind(){}
7722
7723    /**
7724     * Seek to a DirectoryIterator item
7725     *
7726     * Seek to a given position in the DirectoryIterator.
7727     *
7728     * @param int $position The zero-based numeric position to seek to.
7729     * @return void
7730     * @since PHP 5 >= 5.3.0, PHP 7
7731     **/
7732    public function seek($position){}
7733
7734    /**
7735     * Check whether current DirectoryIterator position is a valid file
7736     *
7737     * Check whether current DirectoryIterator position is a valid file.
7738     *
7739     * @return bool Returns TRUE if the position is valid, otherwise FALSE
7740     * @since PHP 5, PHP 7
7741     **/
7742    public function valid(){}
7743
7744    /**
7745     * Get file name as a string
7746     *
7747     * Get the file name of the current DirectoryIterator item.
7748     *
7749     * @return string Returns the file name of the current
7750     *   DirectoryIterator item.
7751     * @since PHP 5, PHP 7
7752     **/
7753    public function __toString(){}
7754
7755}
7756/**
7757 * DivisionByZeroError is thrown when an attempt is made to divide a
7758 * number by zero.
7759 **/
7760class DivisionByZeroError extends ArithmeticError {
7761}
7762/**
7763 * Exception thrown if a value does not adhere to a defined valid data
7764 * domain.
7765 **/
7766class DomainException extends LogicException {
7767}
7768/**
7769 * DOMAttr represents an attribute in the DOMElement object.
7770 **/
7771class DomAttr extends DOMNode {
7772    /**
7773     * The name of the attribute
7774     *
7775     * @var string
7776     **/
7777    public $name;
7778
7779    /**
7780     * @var DOMElement
7781     **/
7782    public $ownerElement;
7783
7784    /**
7785     * @var bool
7786     **/
7787    public $schemaTypeInfo;
7788
7789    /**
7790     * Not implemented yet, always is NULL
7791     *
7792     * @var bool
7793     **/
7794    public $specified;
7795
7796    /**
7797     * The value of the attribute
7798     *
7799     * @var string
7800     **/
7801    public $value;
7802
7803    /**
7804     * Checks if attribute is a defined ID
7805     *
7806     * This function checks if the attribute is a defined ID.
7807     *
7808     * According to the DOM standard this requires a DTD which defines the
7809     * attribute ID to be of type ID. You need to validate your document with
7810     * or DOMDocument::validateOnParse before using this function.
7811     *
7812     * @return bool
7813     * @since PHP 5, PHP 7
7814     **/
7815    public function isId(){}
7816
7817    /**
7818     * Creates a new object
7819     *
7820     * Creates a new DOMAttr object. This object is read only. It may be
7821     * appended to a document, but additional nodes may not be appended to
7822     * this node until the node is associated with a document. To create a
7823     * writable node, use .
7824     *
7825     * @param string $name The tag name of the attribute.
7826     * @param string $value The value of the attribute.
7827     * @since PHP 5, PHP 7
7828     **/
7829    public function __construct($name, $value){}
7830
7831}
7832/**
7833 * The DOMCdataSection inherits from DOMText for textural representation
7834 * of CData constructs.
7835 **/
7836class DOMCdataSection extends DOMText {
7837}
7838/**
7839 * Represents nodes with character data. No nodes directly correspond to
7840 * this class, but other nodes do inherit from it.
7841 **/
7842class DomCharacterData extends DOMNode {
7843    /**
7844     * The contents of the node.
7845     *
7846     * @var string
7847     **/
7848    public $data;
7849
7850    /**
7851     * The length of the contents.
7852     *
7853     * @var int
7854     **/
7855    public $length;
7856
7857    /**
7858     * Append the string to the end of the character data of the node
7859     *
7860     * Append the string {@link data} to the end of the character data of the
7861     * node.
7862     *
7863     * @param string $data The string to append.
7864     * @return void
7865     * @since PHP 5, PHP 7
7866     **/
7867    public function appendData($data){}
7868
7869    /**
7870     * Remove a range of characters from the node
7871     *
7872     * Deletes {@link count} characters starting from position {@link
7873     * offset}.
7874     *
7875     * @param int $offset The offset from which to start removing.
7876     * @param int $count The number of characters to delete. If the sum of
7877     *   {@link offset} and {@link count} exceeds the length, then all
7878     *   characters to the end of the data are deleted.
7879     * @return void
7880     * @since PHP 5, PHP 7
7881     **/
7882    public function deleteData($offset, $count){}
7883
7884    /**
7885     * Insert a string at the specified 16-bit unit offset
7886     *
7887     * Inserts string {@link data} at position {@link offset}.
7888     *
7889     * @param int $offset The character offset at which to insert.
7890     * @param string $data The string to insert.
7891     * @return void
7892     * @since PHP 5, PHP 7
7893     **/
7894    public function insertData($offset, $data){}
7895
7896    /**
7897     * Replace a substring within the DOMCharacterData node
7898     *
7899     * Replace {@link count} characters starting from position {@link offset}
7900     * with {@link data}.
7901     *
7902     * @param int $offset The offset from which to start replacing.
7903     * @param int $count The number of characters to replace. If the sum of
7904     *   {@link offset} and {@link count} exceeds the length, then all
7905     *   characters to the end of the data are replaced.
7906     * @param string $data The string with which the range must be
7907     *   replaced.
7908     * @return void
7909     * @since PHP 5, PHP 7
7910     **/
7911    public function replaceData($offset, $count, $data){}
7912
7913    /**
7914     * Extracts a range of data from the node
7915     *
7916     * Returns the specified substring.
7917     *
7918     * @param int $offset Start offset of substring to extract.
7919     * @param int $count The number of characters to extract.
7920     * @return string The specified substring. If the sum of {@link offset}
7921     *   and {@link count} exceeds the length, then all 16-bit units to the
7922     *   end of the data are returned.
7923     * @since PHP 5, PHP 7
7924     **/
7925    public function substringData($offset, $count){}
7926
7927}
7928/**
7929 * Represents comment nodes, characters delimited by .
7930 **/
7931class DomComment extends DOMCharacterData {
7932    /**
7933     * Creates a new DOMComment object
7934     *
7935     * Creates a new DOMComment object. This object is read only. It may be
7936     * appended to a document, but additional nodes may not be appended to
7937     * this node until the node is associated with a document. To create a
7938     * writeable node, use .
7939     *
7940     * @param string $value The value of the comment.
7941     * @since PHP 5, PHP 7
7942     **/
7943    public function __construct($value){}
7944
7945}
7946/**
7947 * Represents an entire HTML or XML document; serves as the root of the
7948 * document tree.
7949 **/
7950class DomDocument extends DOMNode {
7951    /**
7952     * @var string
7953     **/
7954    public $actualEncoding;
7955
7956    /**
7957     * Deprecated. Configuration used when {@link
7958     * DOMDocument::normalizeDocument} is invoked.
7959     *
7960     * @var DOMConfiguration
7961     **/
7962    public $config;
7963
7964    /**
7965     * The Document Type Declaration associated with this document.
7966     *
7967     * @var DOMDocumentType
7968     **/
7969    public $doctype;
7970
7971    /**
7972     * @var DOMElement
7973     **/
7974    public $documentElement;
7975
7976    /**
7977     * @var string
7978     **/
7979    public $documentURI;
7980
7981    /**
7982     * Encoding of the document, as specified by the XML declaration. This
7983     * attribute is not present in the final DOM Level 3 specification, but
7984     * is the only way of manipulating XML document encoding in this
7985     * implementation.
7986     *
7987     * @var string
7988     **/
7989    public $encoding;
7990
7991    /**
7992     * @var bool
7993     **/
7994    public $formatOutput;
7995
7996    /**
7997     * The DOMImplementation object that handles this document.
7998     *
7999     * @var DOMImplementation
8000     **/
8001    public $implementation;
8002
8003    /**
8004     * @var bool
8005     **/
8006    public $preserveWhiteSpace;
8007
8008    /**
8009     * Proprietary. Enables recovery mode, i.e. trying to parse non-well
8010     * formed documents. This attribute is not part of the DOM specification
8011     * and is specific to libxml.
8012     *
8013     * @var bool
8014     **/
8015    public $recover;
8016
8017    /**
8018     * @var bool
8019     **/
8020    public $resolveExternals;
8021
8022    /**
8023     * Deprecated. Whether or not the document is standalone, as specified by
8024     * the XML declaration, corresponds to xmlStandalone.
8025     *
8026     * @var bool
8027     **/
8028    public $standalone;
8029
8030    /**
8031     * @var bool
8032     **/
8033    public $strictErrorChecking;
8034
8035    /**
8036     * @var bool
8037     **/
8038    public $substituteEntities;
8039
8040    /**
8041     * @var bool
8042     **/
8043    public $validateOnParse;
8044
8045    /**
8046     * Deprecated. Version of XML, corresponds to xmlVersion.
8047     *
8048     * @var string
8049     **/
8050    public $version;
8051
8052    /**
8053     * @var string
8054     **/
8055    public $xmlEncoding;
8056
8057    /**
8058     * @var bool
8059     **/
8060    public $xmlStandalone;
8061
8062    /**
8063     * @var string
8064     **/
8065    public $xmlVersion;
8066
8067    /**
8068     * Create new attribute
8069     *
8070     * This function creates a new instance of class DOMAttr.
8071     *
8072     * @param string $name The name of the attribute.
8073     * @return DOMAttr The new DOMAttr or FALSE if an error occurred.
8074     * @since PHP 5, PHP 7
8075     **/
8076    public function createAttribute($name){}
8077
8078    /**
8079     * Create new attribute node with an associated namespace
8080     *
8081     * This function creates a new instance of class DOMAttr.
8082     *
8083     * @param string $namespaceURI The URI of the namespace.
8084     * @param string $qualifiedName The tag name and prefix of the
8085     *   attribute, as prefix:tagname.
8086     * @return DOMAttr The new DOMAttr or FALSE if an error occurred.
8087     * @since PHP 5, PHP 7
8088     **/
8089    public function createAttributeNS($namespaceURI, $qualifiedName){}
8090
8091    /**
8092     * Create new cdata node
8093     *
8094     * This function creates a new instance of class DOMCDATASection.
8095     *
8096     * @param string $data The content of the cdata.
8097     * @return DOMCDATASection The new DOMCDATASection or FALSE if an error
8098     *   occurred.
8099     * @since PHP 5, PHP 7
8100     **/
8101    public function createCDATASection($data){}
8102
8103    /**
8104     * Create new comment node
8105     *
8106     * This function creates a new instance of class DOMComment.
8107     *
8108     * @param string $data The content of the comment.
8109     * @return DOMComment The new DOMComment or FALSE if an error occurred.
8110     * @since PHP 5, PHP 7
8111     **/
8112    public function createComment($data){}
8113
8114    /**
8115     * Create new document fragment
8116     *
8117     * This function creates a new instance of class DOMDocumentFragment.
8118     *
8119     * @return DOMDocumentFragment The new DOMDocumentFragment or FALSE if
8120     *   an error occurred.
8121     * @since PHP 5, PHP 7
8122     **/
8123    public function createDocumentFragment(){}
8124
8125    /**
8126     * Create new element node
8127     *
8128     * This function creates a new instance of class DOMElement.
8129     *
8130     * @param string $name The tag name of the element.
8131     * @param string $value The value of the element. By default, an empty
8132     *   element will be created. The value can also be set later with
8133     *   DOMElement::$nodeValue. The value is used verbatim except that the <
8134     *   and > entity references will escaped. Note that & has to be manually
8135     *   escaped; otherwise it is regarded as starting an entity reference.
8136     *   Also " won't be escaped.
8137     * @return DOMElement Returns a new instance of class DOMElement or
8138     *   FALSE if an error occurred.
8139     * @since PHP 5, PHP 7
8140     **/
8141    public function createElement($name, $value){}
8142
8143    /**
8144     * Create new element node with an associated namespace
8145     *
8146     * This function creates a new element node with an associated namespace.
8147     *
8148     * @param string $namespaceURI The URI of the namespace.
8149     * @param string $qualifiedName The qualified name of the element, as
8150     *   prefix:tagname.
8151     * @param string $value The value of the element. By default, an empty
8152     *   element will be created. You can also set the value later with
8153     *   DOMElement::$nodeValue.
8154     * @return DOMElement The new DOMElement or FALSE if an error occurred.
8155     * @since PHP 5, PHP 7
8156     **/
8157    public function createElementNS($namespaceURI, $qualifiedName, $value){}
8158
8159    /**
8160     * Create new entity reference node
8161     *
8162     * This function creates a new instance of class DOMEntityReference.
8163     *
8164     * @param string $name The content of the entity reference, e.g. the
8165     *   entity reference minus the leading & and the trailing ; characters.
8166     * @return DOMEntityReference The new DOMEntityReference or FALSE if an
8167     *   error occurred.
8168     * @since PHP 5, PHP 7
8169     **/
8170    public function createEntityReference($name){}
8171
8172    /**
8173     * Creates new PI node
8174     *
8175     * This function creates a new instance of class
8176     * DOMProcessingInstruction.
8177     *
8178     * @param string $target The target of the processing instruction.
8179     * @param string $data The content of the processing instruction.
8180     * @return DOMProcessingInstruction The new DOMProcessingInstruction or
8181     *   FALSE if an error occurred.
8182     * @since PHP 5, PHP 7
8183     **/
8184    public function createProcessingInstruction($target, $data){}
8185
8186    /**
8187     * Create new text node
8188     *
8189     * This function creates a new instance of class DOMText.
8190     *
8191     * @param string $content The content of the text.
8192     * @return DOMText The new DOMText or FALSE if an error occurred.
8193     * @since PHP 5, PHP 7
8194     **/
8195    public function createTextNode($content){}
8196
8197    /**
8198     * Searches for an element with a certain id
8199     *
8200     * This function is similar to but searches for an element with a given
8201     * id.
8202     *
8203     * For this function to work, you will need either to set some ID
8204     * attributes with or a DTD which defines an attribute to be of type ID.
8205     * In the later case, you will need to validate your document with or
8206     * DOMDocument::$validateOnParse before using this function.
8207     *
8208     * @param string $elementId The unique id value for an element.
8209     * @return DOMElement Returns the DOMElement or NULL if the element is
8210     *   not found.
8211     * @since PHP 5, PHP 7
8212     **/
8213    public function getElementById($elementId){}
8214
8215    /**
8216     * Searches for all elements with given local tag name
8217     *
8218     * This function returns a new instance of class DOMNodeList containing
8219     * all the elements with a given local tag name.
8220     *
8221     * @param string $name The local name (without namespace) of the tag to
8222     *   match on. The special value * matches all tags.
8223     * @return DOMNodeList A new DOMNodeList object containing all the
8224     *   matched elements.
8225     * @since PHP 5, PHP 7
8226     **/
8227    public function getElementsByTagName($name){}
8228
8229    /**
8230     * Searches for all elements with given tag name in specified namespace
8231     *
8232     * Returns a DOMNodeList of all elements with a given local name and a
8233     * namespace URI.
8234     *
8235     * @param string $namespaceURI The namespace URI of the elements to
8236     *   match on. The special value * matches all namespaces.
8237     * @param string $localName The local name of the elements to match on.
8238     *   The special value * matches all local names.
8239     * @return DOMNodeList A new DOMNodeList object containing all the
8240     *   matched elements.
8241     * @since PHP 5, PHP 7
8242     **/
8243    public function getElementsByTagNameNS($namespaceURI, $localName){}
8244
8245    /**
8246     * Import node into current document
8247     *
8248     * This function returns a copy of the node to import and associates it
8249     * with the current document.
8250     *
8251     * @param DOMNode $importedNode The node to import.
8252     * @param bool $deep If set to TRUE, this method will recursively
8253     *   import the subtree under the {@link importedNode}.
8254     * @return DOMNode The copied node or FALSE, if it cannot be copied.
8255     * @since PHP 5, PHP 7
8256     **/
8257    public function importNode($importedNode, $deep){}
8258
8259    /**
8260     * Load XML from a file
8261     *
8262     * Loads an XML document from a file.
8263     *
8264     * @param string $filename The path to the XML document.
8265     * @param int $options Bitwise OR of the libxml option constants.
8266     * @return mixed If called statically, returns a DOMDocument.
8267     * @since PHP 5, PHP 7
8268     **/
8269    public function load($filename, $options){}
8270
8271    /**
8272     * Load HTML from a string
8273     *
8274     * The function parses the HTML contained in the string {@link source}.
8275     * Unlike loading XML, HTML does not have to be well-formed to load. This
8276     * function may also be called statically to load and create a
8277     * DOMDocument object. The static invocation may be used when no
8278     * DOMDocument properties need to be set prior to loading.
8279     *
8280     * @param string $source The HTML string.
8281     * @param int $options Since PHP 5.4.0 and Libxml 2.6.0, you may also
8282     *   use the {@link options} parameter to specify additional Libxml
8283     *   parameters.
8284     * @return bool If called statically, returns a DOMDocument.
8285     * @since PHP 5, PHP 7
8286     **/
8287    public function loadHTML($source, $options){}
8288
8289    /**
8290     * Load HTML from a file
8291     *
8292     * The function parses the HTML document in the file named {@link
8293     * filename}. Unlike loading XML, HTML does not have to be well-formed to
8294     * load.
8295     *
8296     * @param string $filename The path to the HTML file.
8297     * @param int $options Since PHP 5.4.0 and Libxml 2.6.0, you may also
8298     *   use the {@link options} parameter to specify additional Libxml
8299     *   parameters.
8300     * @return bool If called statically, returns a DOMDocument.
8301     * @since PHP 5, PHP 7
8302     **/
8303    public function loadHTMLFile($filename, $options){}
8304
8305    /**
8306     * Load XML from a string
8307     *
8308     * Loads an XML document from a string.
8309     *
8310     * @param string $source The string containing the XML.
8311     * @param int $options Bitwise OR of the libxml option constants.
8312     * @return mixed If called statically, returns a DOMDocument.
8313     * @since PHP 5, PHP 7
8314     **/
8315    public function loadXML($source, $options){}
8316
8317    /**
8318     * Normalizes the document
8319     *
8320     * This method acts as if you saved and then loaded the document, putting
8321     * the document in a "normal" form.
8322     *
8323     * @return void
8324     * @since PHP 5, PHP 7
8325     **/
8326    public function normalizeDocument(){}
8327
8328    /**
8329     * Register extended class used to create base node type
8330     *
8331     * This method allows you to register your own extended DOM class to be
8332     * used afterward by the PHP DOM extension.
8333     *
8334     * This method is not part of the DOM standard.
8335     *
8336     * @param string $baseclass The DOM class that you want to extend. You
8337     *   can find a list of these classes in the chapter introduction.
8338     * @param string $extendedclass Your extended class name. If NULL is
8339     *   provided, any previously registered class extending {@link
8340     *   baseclass} will be removed.
8341     * @return bool
8342     * @since PHP 5 >= 5.2.0, PHP 7
8343     **/
8344    public function registerNodeClass($baseclass, $extendedclass){}
8345
8346    /**
8347     * Performs relaxNG validation on the document
8348     *
8349     * Performs relaxNG validation on the document based on the given RNG
8350     * schema.
8351     *
8352     * @param string $filename The RNG file.
8353     * @return bool
8354     * @since PHP 5, PHP 7
8355     **/
8356    public function relaxNGValidate($filename){}
8357
8358    /**
8359     * Performs relaxNG validation on the document
8360     *
8361     * Performs relaxNG validation on the document based on the given RNG
8362     * source.
8363     *
8364     * @param string $source A string containing the RNG schema.
8365     * @return bool
8366     * @since PHP 5, PHP 7
8367     **/
8368    public function relaxNGValidateSource($source){}
8369
8370    /**
8371     * Dumps the internal XML tree back into a file
8372     *
8373     * Creates an XML document from the DOM representation. This function is
8374     * usually called after building a new dom document from scratch as in
8375     * the example below.
8376     *
8377     * @param string $filename The path to the saved XML document.
8378     * @param int $options Additional Options. Currently only
8379     *   LIBXML_NOEMPTYTAG is supported.
8380     * @return int Returns the number of bytes written or FALSE if an error
8381     *   occurred.
8382     * @since PHP 5, PHP 7
8383     **/
8384    public function save($filename, $options){}
8385
8386    /**
8387     * Dumps the internal document into a string using HTML formatting
8388     *
8389     * Creates an HTML document from the DOM representation. This function is
8390     * usually called after building a new dom document from scratch as in
8391     * the example below.
8392     *
8393     * @param DOMNode $node Optional parameter to output a subset of the
8394     *   document.
8395     * @return string Returns the HTML, or FALSE if an error occurred.
8396     * @since PHP 5, PHP 7
8397     **/
8398    public function saveHTML($node){}
8399
8400    /**
8401     * Dumps the internal document into a file using HTML formatting
8402     *
8403     * Creates an HTML document from the DOM representation. This function is
8404     * usually called after building a new dom document from scratch as in
8405     * the example below.
8406     *
8407     * @param string $filename The path to the saved HTML document.
8408     * @return int Returns the number of bytes written or FALSE if an error
8409     *   occurred.
8410     * @since PHP 5, PHP 7
8411     **/
8412    public function saveHTMLFile($filename){}
8413
8414    /**
8415     * Dumps the internal XML tree back into a string
8416     *
8417     * Creates an XML document from the DOM representation. This function is
8418     * usually called after building a new dom document from scratch as in
8419     * the example below.
8420     *
8421     * @param DOMNode $node Use this parameter to output only a specific
8422     *   node without XML declaration rather than the entire document.
8423     * @param int $options Additional Options. Currently only
8424     *   LIBXML_NOEMPTYTAG is supported.
8425     * @return string Returns the XML, or FALSE if an error occurred.
8426     * @since PHP 5, PHP 7
8427     **/
8428    public function saveXML($node, $options){}
8429
8430    /**
8431     * Validates a document based on a schema
8432     *
8433     * Validates a document based on the given schema file.
8434     *
8435     * @param string $filename The path to the schema.
8436     * @param int $flags A bitmask of Libxml schema validation flags.
8437     *   Currently the only supported value is LIBXML_SCHEMA_CREATE.
8438     *   Available since PHP 5.5.2 and Libxml 2.6.14.
8439     * @return bool
8440     * @since PHP 5, PHP 7
8441     **/
8442    public function schemaValidate($filename, $flags){}
8443
8444    /**
8445     * Validates a document based on a schema
8446     *
8447     * Validates a document based on a schema defined in the given string.
8448     *
8449     * @param string $source A string containing the schema.
8450     * @param int $flags A bitmask of Libxml schema validation flags.
8451     *   Currently the only supported value is LIBXML_SCHEMA_CREATE.
8452     *   Available since PHP 5.5.2 and Libxml 2.6.14.
8453     * @return bool
8454     * @since PHP 5, PHP 7
8455     **/
8456    public function schemaValidateSource($source, $flags){}
8457
8458    /**
8459     * Validates the document based on its DTD
8460     *
8461     * Validates the document based on its DTD.
8462     *
8463     * You can also use the validateOnParse property of DOMDocument to make a
8464     * DTD validation.
8465     *
8466     * @return bool If the document has no DTD attached, this method will
8467     *   return FALSE.
8468     * @since PHP 5, PHP 7
8469     **/
8470    public function validate(){}
8471
8472    /**
8473     * Substitutes XIncludes in a DOMDocument Object
8474     *
8475     * This method substitutes XIncludes in a DOMDocument object.
8476     *
8477     * @param int $options libxml parameters. Available since PHP 5.1.0 and
8478     *   Libxml 2.6.7.
8479     * @return int Returns the number of XIncludes in the document, -1 if
8480     *   some processing failed, or FALSE if there were no substitutions.
8481     * @since PHP 5, PHP 7
8482     **/
8483    public function xinclude($options){}
8484
8485    /**
8486     * Creates a new DOMDocument object
8487     *
8488     * Creates a new DOMDocument object.
8489     *
8490     * @param string $version The version number of the document as part of
8491     *   the XML declaration.
8492     * @param string $encoding The encoding of the document as part of the
8493     *   XML declaration.
8494     * @since PHP 5, PHP 7
8495     **/
8496    public function __construct($version, $encoding){}
8497
8498}
8499class DOMDocumentFragment extends DOMNode {
8500    /**
8501     * Append raw XML data
8502     *
8503     * Appends raw XML data to a DOMDocumentFragment.
8504     *
8505     * This method is not part of the DOM standard. It was created as a
8506     * simpler approach for appending an XML DocumentFragment in a
8507     * DOMDocument.
8508     *
8509     * If you want to stick to the standards, you will have to create a
8510     * temporary DOMDocument with a dummy root and then loop through the
8511     * child nodes of the root of your XML data to append them.
8512     *
8513     * @param string $data XML to append.
8514     * @return bool
8515     * @since PHP 5 >= 5.1.0, PHP 7
8516     **/
8517    public function appendXML($data){}
8518
8519}
8520/**
8521 * Each DOMDocument has a doctype attribute whose value is either NULL or
8522 * a DOMDocumentType object.
8523 **/
8524class DOMDocumentType extends DOMNode {
8525    /**
8526     * A DOMNamedNodeMap containing the general entities, both external and
8527     * internal, declared in the DTD.
8528     *
8529     * @var DOMNamedNodeMap
8530     **/
8531    public $entities;
8532
8533    /**
8534     * @var string
8535     **/
8536    public $internalSubset;
8537
8538    /**
8539     * The name of DTD; i.e., the name immediately following the DOCTYPE
8540     * keyword.
8541     *
8542     * @var string
8543     **/
8544    public $name;
8545
8546    /**
8547     * A DOMNamedNodeMap containing the notations declared in the DTD.
8548     *
8549     * @var DOMNamedNodeMap
8550     **/
8551    public $notations;
8552
8553    /**
8554     * @var string
8555     **/
8556    public $publicId;
8557
8558    /**
8559     * @var string
8560     **/
8561    public $systemId;
8562
8563}
8564class DomElement extends DOMNode {
8565    /**
8566     * Returns value of attribute
8567     *
8568     * Gets the value of the attribute with name {@link name} for the current
8569     * node.
8570     *
8571     * @param string $name The name of the attribute.
8572     * @return string The value of the attribute, or an empty string if no
8573     *   attribute with the given {@link name} is found.
8574     * @since PHP 5, PHP 7
8575     **/
8576    public function getAttribute($name){}
8577
8578    /**
8579     * Returns attribute node
8580     *
8581     * Returns the attribute node with name {@link name} for the current
8582     * element.
8583     *
8584     * @param string $name The name of the attribute.
8585     * @return DOMAttr The attribute node. Note that for XML namespace
8586     *   declarations (xmlns and xmlns:* attributes) an instance of
8587     *   DOMNameSpaceNode is returned instead of a DOMAttr.
8588     * @since PHP 5, PHP 7
8589     **/
8590    public function getAttributeNode($name){}
8591
8592    /**
8593     * Returns attribute node
8594     *
8595     * Returns the attribute node in namespace {@link namespaceURI} with
8596     * local name {@link localName} for the current node.
8597     *
8598     * @param string $namespaceURI The namespace URI.
8599     * @param string $localName The local name.
8600     * @return DOMAttr The attribute node. Note that for XML namespace
8601     *   declarations (xmlns and xmlns:* attributes) an instance of
8602     *   DOMNameSpaceNode is returned instead of a DOMAttr object.
8603     * @since PHP 5, PHP 7
8604     **/
8605    public function getAttributeNodeNS($namespaceURI, $localName){}
8606
8607    /**
8608     * Returns value of attribute
8609     *
8610     * Gets the value of the attribute in namespace {@link namespaceURI} with
8611     * local name {@link localName} for the current node.
8612     *
8613     * @param string $namespaceURI The namespace URI.
8614     * @param string $localName The local name.
8615     * @return string The value of the attribute, or an empty string if no
8616     *   attribute with the given {@link localName} and {@link namespaceURI}
8617     *   is found.
8618     * @since PHP 5, PHP 7
8619     **/
8620    public function getAttributeNS($namespaceURI, $localName){}
8621
8622    /**
8623     * Gets elements by tagname
8624     *
8625     * This function returns a new instance of the class DOMNodeList of all
8626     * descendant elements with a given tag {@link name}, in the order in
8627     * which they are encountered in a preorder traversal of this element
8628     * tree.
8629     *
8630     * @param string $name The tag name. Use * to return all elements
8631     *   within the element tree.
8632     * @return DOMNodeList This function returns a new instance of the
8633     *   class DOMNodeList of all matched elements.
8634     * @since PHP 5, PHP 7
8635     **/
8636    public function getElementsByTagName($name){}
8637
8638    /**
8639     * Get elements by namespaceURI and localName
8640     *
8641     * This function fetch all the descendant elements with a given {@link
8642     * localName} and {@link namespaceURI}.
8643     *
8644     * @param string $namespaceURI The namespace URI.
8645     * @param string $localName The local name. Use * to return all
8646     *   elements within the element tree.
8647     * @return DOMNodeList This function returns a new instance of the
8648     *   class DOMNodeList of all matched elements in the order in which they
8649     *   are encountered in a preorder traversal of this element tree.
8650     * @since PHP 5, PHP 7
8651     **/
8652    public function getElementsByTagNameNS($namespaceURI, $localName){}
8653
8654    /**
8655     * Checks to see if attribute exists
8656     *
8657     * Indicates whether attribute named {@link name} exists as a member of
8658     * the element.
8659     *
8660     * @param string $name The attribute name.
8661     * @return bool
8662     * @since PHP 5, PHP 7
8663     **/
8664    public function hasAttribute($name){}
8665
8666    /**
8667     * Checks to see if attribute exists
8668     *
8669     * Indicates whether attribute in namespace {@link namespaceURI} named
8670     * {@link localName} exists as a member of the element.
8671     *
8672     * @param string $namespaceURI The namespace URI.
8673     * @param string $localName The local name.
8674     * @return bool
8675     * @since PHP 5, PHP 7
8676     **/
8677    public function hasAttributeNS($namespaceURI, $localName){}
8678
8679    /**
8680     * Removes attribute
8681     *
8682     * Removes attribute named {@link name} from the element.
8683     *
8684     * @param string $name The name of the attribute.
8685     * @return bool
8686     * @since PHP 5, PHP 7
8687     **/
8688    public function removeAttribute($name){}
8689
8690    /**
8691     * Removes attribute
8692     *
8693     * Removes attribute {@link oldnode} from the element.
8694     *
8695     * @param DOMAttr $oldnode The attribute node.
8696     * @return bool
8697     * @since PHP 5, PHP 7
8698     **/
8699    public function removeAttributeNode($oldnode){}
8700
8701    /**
8702     * Removes attribute
8703     *
8704     * Removes attribute {@link localName} in namespace {@link namespaceURI}
8705     * from the element.
8706     *
8707     * @param string $namespaceURI The namespace URI.
8708     * @param string $localName The local name.
8709     * @return bool
8710     * @since PHP 5, PHP 7
8711     **/
8712    public function removeAttributeNS($namespaceURI, $localName){}
8713
8714    /**
8715     * Adds new attribute
8716     *
8717     * Sets an attribute with name {@link name} to the given value. If the
8718     * attribute does not exist, it will be created.
8719     *
8720     * @param string $name The name of the attribute.
8721     * @param string $value The value of the attribute.
8722     * @return DOMAttr The new DOMAttr or FALSE if an error occurred.
8723     * @since PHP 5, PHP 7
8724     **/
8725    public function setAttribute($name, $value){}
8726
8727    /**
8728     * Adds new attribute node to element
8729     *
8730     * Adds new attribute node {@link attr} to element.
8731     *
8732     * @param DOMAttr $attr The attribute node.
8733     * @return DOMAttr Returns old node if the attribute has been replaced
8734     *   or NULL.
8735     * @since PHP 5, PHP 7
8736     **/
8737    public function setAttributeNode($attr){}
8738
8739    /**
8740     * Adds new attribute node to element
8741     *
8742     * Adds new attribute node {@link attr} to element.
8743     *
8744     * @param DOMAttr $attr The attribute node.
8745     * @return DOMAttr Returns the old node if the attribute has been
8746     *   replaced.
8747     * @since PHP 5, PHP 7
8748     **/
8749    public function setAttributeNodeNS($attr){}
8750
8751    /**
8752     * Adds new attribute
8753     *
8754     * Sets an attribute with namespace {@link namespaceURI} and name {@link
8755     * name} to the given value. If the attribute does not exist, it will be
8756     * created.
8757     *
8758     * @param string $namespaceURI The namespace URI.
8759     * @param string $qualifiedName The qualified name of the attribute, as
8760     *   prefix:tagname.
8761     * @param string $value The value of the attribute.
8762     * @return void
8763     * @since PHP 5, PHP 7
8764     **/
8765    public function setAttributeNS($namespaceURI, $qualifiedName, $value){}
8766
8767    /**
8768     * Declares the attribute specified by name to be of type ID
8769     *
8770     * Declares the attribute {@link name} to be of type ID.
8771     *
8772     * @param string $name The name of the attribute.
8773     * @param bool $isId Set it to TRUE if you want {@link name} to be of
8774     *   type ID, FALSE otherwise.
8775     * @return void
8776     * @since PHP 5, PHP 7
8777     **/
8778    public function setIdAttribute($name, $isId){}
8779
8780    /**
8781     * Declares the attribute specified by node to be of type ID
8782     *
8783     * Declares the attribute specified by {@link attr} to be of type ID.
8784     *
8785     * @param DOMAttr $attr The attribute node.
8786     * @param bool $isId Set it to TRUE if you want {@link name} to be of
8787     *   type ID, FALSE otherwise.
8788     * @return void
8789     * @since PHP 5, PHP 7
8790     **/
8791    public function setIdAttributeNode($attr, $isId){}
8792
8793    /**
8794     * Declares the attribute specified by local name and namespace URI to be
8795     * of type ID
8796     *
8797     * Declares the attribute specified by {@link localName} and {@link
8798     * namespaceURI} to be of type ID.
8799     *
8800     * @param string $namespaceURI The namespace URI of the attribute.
8801     * @param string $localName The local name of the attribute, as
8802     *   prefix:tagname.
8803     * @param bool $isId Set it to TRUE if you want {@link name} to be of
8804     *   type ID, FALSE otherwise.
8805     * @return void
8806     * @since PHP 5, PHP 7
8807     **/
8808    public function setIdAttributeNS($namespaceURI, $localName, $isId){}
8809
8810    /**
8811     * Creates a new DOMElement object
8812     *
8813     * Creates a new DOMElement object. This object is read only. It may be
8814     * appended to a document, but additional nodes may not be appended to
8815     * this node until the node is associated with a document. To create a
8816     * writeable node, use or .
8817     *
8818     * @param string $name The tag name of the element. When also passing
8819     *   in namespaceURI, the element name may take a prefix to be associated
8820     *   with the URI.
8821     * @param string $value The value of the element.
8822     * @param string $namespaceURI A namespace URI to create the element
8823     *   within a specific namespace.
8824     * @since PHP 5, PHP 7
8825     **/
8826    public function __construct($name, $value, $namespaceURI){}
8827
8828}
8829/**
8830 * This interface represents a known entity, either parsed or unparsed,
8831 * in an XML document.
8832 **/
8833class DOMEntity extends DOMNode {
8834    /**
8835     * @var string
8836     **/
8837    public $actualEncoding;
8838
8839    /**
8840     * An attribute specifying, as part of the text declaration, the encoding
8841     * of this entity, when it is an external parsed entity. This is NULL
8842     * otherwise.
8843     *
8844     * @var string
8845     **/
8846    public $encoding;
8847
8848    /**
8849     * @var string
8850     **/
8851    public $notationName;
8852
8853    /**
8854     * @var string
8855     **/
8856    public $publicId;
8857
8858    /**
8859     * @var string
8860     **/
8861    public $systemId;
8862
8863    /**
8864     * An attribute specifying, as part of the text declaration, the version
8865     * number of this entity, when it is an external parsed entity. This is
8866     * NULL otherwise.
8867     *
8868     * @var string
8869     **/
8870    public $version;
8871
8872}
8873class DomEntityReference extends DOMNode {
8874    /**
8875     * Creates a new DOMEntityReference object
8876     *
8877     * Creates a new DOMEntityReference object.
8878     *
8879     * @param string $name The name of the entity reference.
8880     * @since PHP 5, PHP 7
8881     **/
8882    public function __construct($name){}
8883
8884}
8885/**
8886 * DOM operations raise exceptions under particular circumstances, i.e.,
8887 * when an operation is impossible to perform for logical reasons. See
8888 * also .
8889 **/
8890class DOMException extends Exception {
8891    /**
8892     * An integer indicating the type of error generated
8893     *
8894     * @var int
8895     **/
8896    public $code;
8897
8898}
8899/**
8900 * The DOMImplementation class provides a number of methods for
8901 * performing operations that are independent of any particular instance
8902 * of the document object model.
8903 **/
8904class DOMImplementation {
8905    /**
8906     * Creates a DOMDocument object of the specified type with its document
8907     * element
8908     *
8909     * Creates a DOMDocument object of the specified type with its document
8910     * element.
8911     *
8912     * @param string $namespaceURI The namespace URI of the document
8913     *   element to create.
8914     * @param string $qualifiedName The qualified name of the document
8915     *   element to create.
8916     * @param DOMDocumentType $doctype The type of document to create or
8917     *   NULL.
8918     * @return DOMDocument A new DOMDocument object. If {@link
8919     *   namespaceURI}, {@link qualifiedName}, and {@link doctype} are null,
8920     *   the returned DOMDocument is empty with no document element
8921     * @since PHP 5, PHP 7
8922     **/
8923    public function createDocument($namespaceURI, $qualifiedName, $doctype){}
8924
8925    /**
8926     * Creates an empty DOMDocumentType object
8927     *
8928     * Creates an empty DOMDocumentType object. Entity declarations and
8929     * notations are not made available. Entity reference expansions and
8930     * default attribute additions do not occur.
8931     *
8932     * @param string $qualifiedName The qualified name of the document type
8933     *   to create.
8934     * @param string $publicId The external subset public identifier.
8935     * @param string $systemId The external subset system identifier.
8936     * @return DOMDocumentType A new DOMDocumentType node with its
8937     *   ownerDocument set to NULL.
8938     * @since PHP 5, PHP 7
8939     **/
8940    public function createDocumentType($qualifiedName, $publicId, $systemId){}
8941
8942    /**
8943     * Test if the DOM implementation implements a specific feature
8944     *
8945     * Test if the DOM implementation implements a specific {@link feature}.
8946     *
8947     * You can find a list of all features in the Conformance section of the
8948     * DOM specification.
8949     *
8950     * @param string $feature The feature to test.
8951     * @param string $version The version number of the {@link feature} to
8952     *   test. In level 2, this can be either 2.0 or 1.0.
8953     * @return bool
8954     * @since PHP 5, PHP 7
8955     **/
8956    public function hasFeature($feature, $version){}
8957
8958    /**
8959     * Creates a new DOMImplementation object
8960     *
8961     * Creates a new DOMImplementation object.
8962     *
8963     * @since PHP 5, PHP 7
8964     **/
8965    function __construct(){}
8966
8967}
8968class DomNamedNodeMap implements Traversable, Countable {
8969    /**
8970     * Get number of nodes in the map
8971     *
8972     * Gets the number of nodes in the map.
8973     *
8974     * @return int Returns the number of nodes in the map, which is
8975     *   identical to the length property.
8976     * @since PHP 7 >= 7.2.0
8977     **/
8978    public function count(){}
8979
8980    /**
8981     * Retrieves a node specified by name
8982     *
8983     * Retrieves a node specified by its nodeName.
8984     *
8985     * @param string $name The nodeName of the node to retrieve.
8986     * @return DOMNode A node (of any type) with the specified nodeName, or
8987     *   NULL if no node is found.
8988     * @since PHP 5, PHP 7
8989     **/
8990    function getNamedItem($name){}
8991
8992    /**
8993     * Retrieves a node specified by local name and namespace URI
8994     *
8995     * Retrieves a node specified by {@link localName} and {@link
8996     * namespaceURI}.
8997     *
8998     * @param string $namespaceURI The namespace URI of the node to
8999     *   retrieve.
9000     * @param string $localName The local name of the node to retrieve.
9001     * @return DOMNode A node (of any type) with the specified local name
9002     *   and namespace URI, or NULL if no node is found.
9003     * @since PHP 5, PHP 7
9004     **/
9005    function getNamedItemNS($namespaceURI, $localName){}
9006
9007    /**
9008     * Retrieves a node specified by index
9009     *
9010     * Retrieves a node specified by {@link index} within the DOMNamedNodeMap
9011     * object.
9012     *
9013     * @param int $index Index into this map.
9014     * @return DOMNode The node at the {@link index}th position in the map,
9015     *   or NULL if that is not a valid index (greater than or equal to the
9016     *   number of nodes in this map).
9017     * @since PHP 5, PHP 7
9018     **/
9019    function item($index){}
9020
9021}
9022class DOMNode {
9023    /**
9024     * Adds new child at the end of the children
9025     *
9026     * This function appends a child to an existing list of children or
9027     * creates a new list of children. The child can be created with e.g.
9028     * DOMDocument::createElement, DOMDocument::createTextNode etc. or simply
9029     * by using any other node.
9030     *
9031     * @param DOMNode $newnode The appended child.
9032     * @return DOMNode The node added.
9033     * @since PHP 5, PHP 7
9034     **/
9035    public function appendChild($newnode){}
9036
9037    /**
9038     * Canonicalize nodes to a string
9039     *
9040     * @param bool $exclusive Enable exclusive parsing of only the nodes
9041     *   matched by the provided xpath or namespace prefixes.
9042     * @param bool $with_comments Retain comments in output.
9043     * @param array $xpath An array of xpaths to filter the nodes by.
9044     * @param array $ns_prefixes An array of namespace prefixes to filter
9045     *   the nodes by.
9046     * @return string Returns canonicalized nodes as a string
9047     * @since PHP 5 >= 5.2.0, PHP 7
9048     **/
9049    public function C14N($exclusive, $with_comments, $xpath, $ns_prefixes){}
9050
9051    /**
9052     * Canonicalize nodes to a file
9053     *
9054     * @param string $uri Path to write the output to.
9055     * @param bool $exclusive Enable exclusive parsing of only the nodes
9056     *   matched by the provided xpath or namespace prefixes.
9057     * @param bool $with_comments Retain comments in output.
9058     * @param array $xpath An array of xpaths to filter the nodes by.
9059     * @param array $ns_prefixes An array of namespace prefixes to filter
9060     *   the nodes by.
9061     * @return int Number of bytes written
9062     * @since PHP 5 >= 5.2.0, PHP 7
9063     **/
9064    public function C14NFile($uri, $exclusive, $with_comments, $xpath, $ns_prefixes){}
9065
9066    /**
9067     * Clones a node
9068     *
9069     * Creates a copy of the node.
9070     *
9071     * @param bool $deep Indicates whether to copy all descendant nodes.
9072     *   This parameter is defaulted to FALSE.
9073     * @return DOMNode The cloned node.
9074     * @since PHP 5, PHP 7
9075     **/
9076    public function cloneNode($deep){}
9077
9078    /**
9079     * Get line number for a node
9080     *
9081     * Gets line number for where the node is defined.
9082     *
9083     * @return int Always returns the line number where the node was
9084     *   defined in.
9085     * @since PHP 5 >= 5.3.0, PHP 7
9086     **/
9087    public function getLineNo(){}
9088
9089    /**
9090     * Get an XPath for a node
9091     *
9092     * Gets an XPath location path for the node.
9093     *
9094     * @return string Returns a string containing the XPath, or NULL in
9095     *   case of an error.
9096     * @since PHP 5 >= 5.2.0, PHP 7
9097     **/
9098    public function getNodePath(){}
9099
9100    /**
9101     * Checks if node has attributes
9102     *
9103     * This method checks if the node has attributes. The tested node has to
9104     * be an XML_ELEMENT_NODE.
9105     *
9106     * @return bool
9107     * @since PHP 5, PHP 7
9108     **/
9109    public function hasAttributes(){}
9110
9111    /**
9112     * Checks if node has children
9113     *
9114     * This function checks if the node has children.
9115     *
9116     * @return bool
9117     * @since PHP 5, PHP 7
9118     **/
9119    public function hasChildNodes(){}
9120
9121    /**
9122     * Adds a new child before a reference node
9123     *
9124     * This function inserts a new node right before the reference node. If
9125     * you plan to do further modifications on the appended child you must
9126     * use the returned node.
9127     *
9128     * @param DOMNode $newnode The new node.
9129     * @param DOMNode $refnode The reference node. If not supplied, {@link
9130     *   newnode} is appended to the children.
9131     * @return DOMNode The inserted node.
9132     * @since PHP 5, PHP 7
9133     **/
9134    public function insertBefore($newnode, $refnode){}
9135
9136    /**
9137     * Checks if the specified namespaceURI is the default namespace or not
9138     *
9139     * Tells whether {@link namespaceURI} is the default namespace.
9140     *
9141     * @param string $namespaceURI The namespace URI to look for.
9142     * @return bool Return TRUE if {@link namespaceURI} is the default
9143     *   namespace, FALSE otherwise.
9144     * @since PHP 5, PHP 7
9145     **/
9146    public function isDefaultNamespace($namespaceURI){}
9147
9148    /**
9149     * Indicates if two nodes are the same node
9150     *
9151     * This function indicates if two nodes are the same node. The comparison
9152     * is not based on content
9153     *
9154     * @param DOMNode $node The compared node.
9155     * @return bool
9156     * @since PHP 5, PHP 7
9157     **/
9158    public function isSameNode($node){}
9159
9160    /**
9161     * Checks if feature is supported for specified version
9162     *
9163     * Checks if the asked {@link feature} is supported for the specified
9164     * {@link version}.
9165     *
9166     * @param string $feature The feature to test. See the example of
9167     *   DOMImplementation::hasFeature for a list of features.
9168     * @param string $version The version number of the {@link feature} to
9169     *   test.
9170     * @return bool
9171     * @since PHP 5, PHP 7
9172     **/
9173    public function isSupported($feature, $version){}
9174
9175    /**
9176     * Gets the namespace URI of the node based on the prefix
9177     *
9178     * Gets the namespace URI of the node based on the {@link prefix}.
9179     *
9180     * @param string $prefix The prefix of the namespace.
9181     * @return string The namespace URI of the node.
9182     * @since PHP 5, PHP 7
9183     **/
9184    public function lookupNamespaceUri($prefix){}
9185
9186    /**
9187     * Gets the namespace prefix of the node based on the namespace URI
9188     *
9189     * Gets the namespace prefix of the node based on the namespace URI.
9190     *
9191     * @param string $namespaceURI The namespace URI.
9192     * @return string The prefix of the namespace.
9193     * @since PHP 5, PHP 7
9194     **/
9195    public function lookupPrefix($namespaceURI){}
9196
9197    /**
9198     * Normalizes the node
9199     *
9200     * Remove empty text nodes and merge adjacent text nodes in this node and
9201     * all its children.
9202     *
9203     * @return void
9204     * @since PHP 5, PHP 7
9205     **/
9206    public function normalize(){}
9207
9208    /**
9209     * Removes child from list of children
9210     *
9211     * This functions removes a child from a list of children.
9212     *
9213     * @param DOMNode $oldnode The removed child.
9214     * @return DOMNode If the child could be removed the function returns
9215     *   the old child.
9216     * @since PHP 5, PHP 7
9217     **/
9218    public function removeChild($oldnode){}
9219
9220    /**
9221     * Replaces a child
9222     *
9223     * This function replaces the child {@link oldnode} with the passed new
9224     * node. If the {@link newnode} is already a child it will not be added a
9225     * second time. If the replacement succeeds the old node is returned.
9226     *
9227     * @param DOMNode $newnode The new node. It must be a member of the
9228     *   target document, i.e. created by one of the DOMDocument->createXXX()
9229     *   methods or imported in the document by .
9230     * @param DOMNode $oldnode The old node.
9231     * @return DOMNode The old node or FALSE if an error occur.
9232     * @since PHP 5, PHP 7
9233     **/
9234    public function replaceChild($newnode, $oldnode){}
9235
9236}
9237/**
9238 * 7.2.0 The Countable interface is implemented and returns the value of
9239 * the length property.
9240 **/
9241class DomNodeList implements Traversable, Countable {
9242    /**
9243     * Get number of nodes in the list
9244     *
9245     * Gets the number of nodes in the list.
9246     *
9247     * @return int Returns the number of nodes in the list, which is
9248     *   identical to the length property.
9249     * @since PHP 7 >= 7.2.0
9250     **/
9251    public function count(){}
9252
9253    /**
9254     * Retrieves a node specified by index
9255     *
9256     * Retrieves a node specified by {@link index} within the DOMNodeList
9257     * object.
9258     *
9259     * @param int $index Index of the node into the collection.
9260     * @return DOMNode The node at the {@link index}th position in the
9261     *   DOMNodeList, or NULL if that is not a valid index.
9262     * @since PHP 5, PHP 7
9263     **/
9264    function item($index){}
9265
9266}
9267class DOMNotation extends DOMNode {
9268}
9269class DomProcessingInstruction extends DOMNode {
9270    /**
9271     * Creates a new object
9272     *
9273     * Creates a new DOMProcessingInstruction object. This object is read
9274     * only. It may be appended to a document, but additional nodes may not
9275     * be appended to this node until the node is associated with a document.
9276     * To create a writeable node, use .
9277     *
9278     * @param string $name The tag name of the processing instruction.
9279     * @param string $value The value of the processing instruction.
9280     * @since PHP 5, PHP 7
9281     **/
9282    public function __construct($name, $value){}
9283
9284}
9285/**
9286 * The DOMText class inherits from DOMCharacterData and represents the
9287 * textual content of a DOMElement or DOMAttr.
9288 **/
9289class DOMText extends DOMCharacterData {
9290    /**
9291     * @var string
9292     **/
9293    public $wholeText;
9294
9295    /**
9296     * Returns whether this text node contains whitespace in element content
9297     *
9298     * @return bool
9299     **/
9300    public function isElementContentWhitespace(){}
9301
9302    /**
9303     * Indicates whether this text node contains whitespace
9304     *
9305     * Indicates whether this text node contains only whitespace or it is
9306     * empty. The text node is determined to contain whitespace in element
9307     * content during the load of the document.
9308     *
9309     * @return bool Returns TRUE if node contains zero or more whitespace
9310     *   characters and nothing else. Returns FALSE otherwise.
9311     * @since PHP 5, PHP 7
9312     **/
9313    public function isWhitespaceInElementContent(){}
9314
9315    /**
9316     * Breaks this node into two nodes at the specified offset
9317     *
9318     * Breaks this node into two nodes at the specified {@link offset},
9319     * keeping both in the tree as siblings.
9320     *
9321     * After being split, this node will contain all the content up to the
9322     * {@link offset}. If the original node had a parent node, the new node
9323     * is inserted as the next sibling of the original node. When the {@link
9324     * offset} is equal to the length of this node, the new node has no data.
9325     *
9326     * @param int $offset The offset at which to split, starting from 0.
9327     * @return DOMText The new node of the same type, which contains all
9328     *   the content at and after the {@link offset}.
9329     * @since PHP 5, PHP 7
9330     **/
9331    public function splitText($offset){}
9332
9333}
9334/**
9335 * Supports XPath 1.0
9336 **/
9337class DomXPath {
9338    /**
9339     * @var DOMDocument
9340     **/
9341    public $document;
9342
9343    /**
9344     * Evaluates the given XPath expression and returns a typed result if
9345     * possible
9346     *
9347     * Executes the given XPath {@link expression} and returns a typed result
9348     * if possible.
9349     *
9350     * @param string $expression The XPath expression to execute.
9351     * @param DOMNode $contextnode The optional {@link contextnode} can be
9352     *   specified for doing relative XPath queries. By default, the queries
9353     *   are relative to the root element.
9354     * @param bool $registerNodeNS The optional {@link registerNodeNS} can
9355     *   be specified to disable automatic registration of the context node.
9356     * @return mixed Returns a typed result if possible or a DOMNodeList
9357     *   containing all nodes matching the given XPath {@link expression}.
9358     * @since PHP 5 >= 5.1.0, PHP 7
9359     **/
9360    public function evaluate($expression, $contextnode, $registerNodeNS){}
9361
9362    /**
9363     * Evaluates the given XPath expression
9364     *
9365     * Executes the given XPath {@link expression}.
9366     *
9367     * @param string $expression The XPath expression to execute.
9368     * @param DOMNode $contextnode The optional {@link contextnode} can be
9369     *   specified for doing relative XPath queries. By default, the queries
9370     *   are relative to the root element.
9371     * @param bool $registerNodeNS The optional {@link registerNodeNS} can
9372     *   be specified to disable automatic registration of the context node.
9373     * @return DOMNodeList Returns a DOMNodeList containing all nodes
9374     *   matching the given XPath {@link expression}. Any expression which
9375     *   does not return nodes will return an empty DOMNodeList.
9376     * @since PHP 5, PHP 7
9377     **/
9378    public function query($expression, $contextnode, $registerNodeNS){}
9379
9380    /**
9381     * Registers the namespace with the object
9382     *
9383     * Registers the {@link namespaceURI} and {@link prefix} with the
9384     * DOMXPath object.
9385     *
9386     * @param string $prefix The prefix.
9387     * @param string $namespaceURI The URI of the namespace.
9388     * @return bool
9389     * @since PHP 5, PHP 7
9390     **/
9391    public function registerNamespace($prefix, $namespaceURI){}
9392
9393    /**
9394     * Register PHP functions as XPath functions
9395     *
9396     * This method enables the ability to use PHP functions within XPath
9397     * expressions.
9398     *
9399     * @param mixed $restrict Use this parameter to only allow certain
9400     *   functions to be called from XPath. This parameter can be either a
9401     *   string (a function name) or an array of function names.
9402     * @return void
9403     * @since PHP 5 >= 5.3.0, PHP 7
9404     **/
9405    public function registerPhpFunctions($restrict){}
9406
9407    /**
9408     * Creates a new object
9409     *
9410     * Creates a new DOMXPath object.
9411     *
9412     * @param DOMDocument $doc The DOMDocument associated with the
9413     *   DOMXPath.
9414     * @since PHP 5, PHP 7
9415     **/
9416    public function __construct($doc){}
9417
9418}
9419/**
9420 * The dotnet class allows you to instantiate a class from a .Net
9421 * assembly and call its methods and access its properties, if the class
9422 * and the methods and properties are visible to COM. Neither
9423 * instantiating static classes nor calling static methods is supported.
9424 * Some .Net classes do not implement IDispatch, so while they can be
9425 * instantiated, calling methods or accessing properties on these classes
9426 * is not supported.
9427 **/
9428class dotnet extends variant {
9429}
9430namespace Ds {
9431interface Collection extends Traversable, Countable, JsonSerializable {
9432    /**
9433     * Removes all values
9434     *
9435     * Removes all values from the collection.
9436     *
9437     * @return void
9438     **/
9439    public function clear();
9440
9441    /**
9442     * Returns a shallow copy of the collection
9443     *
9444     * @return Ds\Collection Returns a shallow copy of the collection.
9445     **/
9446    public function copy();
9447
9448    /**
9449     * Returns whether the collection is empty
9450     *
9451     * @return bool Returns TRUE if the collection is empty, FALSE
9452     *   otherwise.
9453     **/
9454    public function isEmpty();
9455
9456    /**
9457     * Converts the collection to an
9458     *
9459     * Converts the collection to an .
9460     *
9461     * @return array An containing all the values in the same order as the
9462     *   collection.
9463     **/
9464    public function toArray();
9465
9466}
9467}
9468namespace Ds {
9469class Deque implements Ds\Sequence {
9470    /**
9471     * Allocates enough memory for a required capacity
9472     *
9473     * Ensures that enough memory is allocated for a required capacity. This
9474     * removes the need to reallocate the internal as values are added.
9475     *
9476     * @param int $capacity The number of values for which capacity should
9477     *   be allocated.
9478     * @return void
9479     **/
9480    public function allocate($capacity){}
9481
9482    /**
9483     * Updates all values by applying a callback function to each value
9484     *
9485     * Updates all values by applying a {@link callback} function to each
9486     * value in the deque.
9487     *
9488     * @param callable $callback mixed callback mixed{@link value} A
9489     *   callable to apply to each value in the deque. The callback should
9490     *   return what the value should be replaced by.
9491     * @return void
9492     **/
9493    public function apply($callback){}
9494
9495    /**
9496     * Returns the current capacity
9497     *
9498     * @return int The current capacity.
9499     **/
9500    public function capacity(){}
9501
9502    /**
9503     * Removes all values from the deque
9504     *
9505     * @return void
9506     **/
9507    public function clear(){}
9508
9509    /**
9510     * Determines if the deque contains given values
9511     *
9512     * Determines if the deque contains all values.
9513     *
9514     * @param mixed ...$values Values to check.
9515     * @return bool FALSE if any of the provided {@link values} are not in
9516     *   the deque, TRUE otherwise.
9517     **/
9518    public function contains(...$values){}
9519
9520    /**
9521     * Returns a shallow copy of the deque
9522     *
9523     * @return Ds\Deque A shallow copy of the deque.
9524     **/
9525    public function copy(){}
9526
9527    /**
9528     * Creates a new deque using a to determine which values to include
9529     *
9530     * Creates a new deque using a callable to determine which values to
9531     * include.
9532     *
9533     * @param callable $callback bool callback mixed{@link value} Optional
9534     *   callable which returns TRUE if the value should be included, FALSE
9535     *   otherwise. If a callback is not provided, only values which are TRUE
9536     *   (see converting to boolean) will be included.
9537     * @return Ds\Deque A new deque containing all the values for which
9538     *   either the {@link callback} returned TRUE, or all values that
9539     *   convert to TRUE if a {@link callback} was not provided.
9540     **/
9541    public function filter($callback){}
9542
9543    /**
9544     * Attempts to find a value's index
9545     *
9546     * Returns the index of the {@link value}, or FALSE if not found.
9547     *
9548     * @param mixed $value The value to find.
9549     * @return mixed The index of the value, or FALSE if not found.
9550     **/
9551    public function find($value){}
9552
9553    /**
9554     * Returns the first value in the deque
9555     *
9556     * @return mixed The first value in the deque.
9557     **/
9558    public function first(){}
9559
9560    /**
9561     * Returns the value at a given index
9562     *
9563     * @param int $index The index to access, starting at 0.
9564     * @return mixed The value at the requested index.
9565     **/
9566    public function get($index){}
9567
9568    /**
9569     * Inserts values at a given index
9570     *
9571     * Inserts values into the deque at a given index.
9572     *
9573     * @param int $index The index at which to insert. 0 <= index <= count
9574     * @param mixed ...$values The value or values to insert.
9575     * @return void
9576     **/
9577    public function insert($index, ...$values){}
9578
9579    /**
9580     * Returns whether the deque is empty
9581     *
9582     * @return bool Returns TRUE if the deque is empty, FALSE otherwise.
9583     **/
9584    public function isEmpty(){}
9585
9586    /**
9587     * Joins all values together as a string
9588     *
9589     * Joins all values together as a string using an optional separator
9590     * between each value.
9591     *
9592     * @param string $glue An optional string to separate each value.
9593     * @return string All values of the deque joined together as a string.
9594     **/
9595    public function join($glue){}
9596
9597    /**
9598     * Returns the last value
9599     *
9600     * Returns the last value in the deque.
9601     *
9602     * @return mixed The last value in the deque.
9603     **/
9604    public function last(){}
9605
9606    /**
9607     * Returns the result of applying a callback to each value
9608     *
9609     * Returns the result of applying a {@link callback} function to each
9610     * value in the deque.
9611     *
9612     * @param callable $callback mixed callback mixed{@link value} A
9613     *   callable to apply to each value in the deque. The callable should
9614     *   return what the new value will be in the new deque.
9615     * @return Ds\Deque The result of applying a {@link callback} to each
9616     *   value in the deque.
9617     **/
9618    public function map($callback){}
9619
9620    /**
9621     * Returns the result of adding all given values to the deque
9622     *
9623     * @param mixed $values A traversable object or an .
9624     * @return Ds\Deque The result of adding all given values to the deque,
9625     *   effectively the same as adding the values to a copy, then returning
9626     *   that copy.
9627     **/
9628    public function merge($values){}
9629
9630    /**
9631     * Removes and returns the last value
9632     *
9633     * @return mixed The removed last value.
9634     **/
9635    public function pop(){}
9636
9637    /**
9638     * Adds values to the end of the deque
9639     *
9640     * @param mixed ...$values The values to add.
9641     * @return void
9642     **/
9643    public function push(...$values){}
9644
9645    /**
9646     * Reduces the deque to a single value using a callback function
9647     *
9648     * @param callable $callback
9649     * @param mixed $initial The return value of the previous callback, or
9650     *   {@link initial} if it's the first iteration.
9651     * @return mixed The return value of the final callback.
9652     **/
9653    public function reduce($callback, $initial){}
9654
9655    /**
9656     * Removes and returns a value by index
9657     *
9658     * @param int $index The index of the value to remove.
9659     * @return mixed The value that was removed.
9660     **/
9661    public function remove($index){}
9662
9663    /**
9664     * Reverses the deque in-place
9665     *
9666     * Reverses the deque in-place.
9667     *
9668     * @return void
9669     **/
9670    public function reverse(){}
9671
9672    /**
9673     * Returns a reversed copy
9674     *
9675     * Returns a reversed copy of the deque.
9676     *
9677     * @return Ds\Deque A reversed copy of the deque.
9678     *
9679     *   The current instance is not affected.
9680     **/
9681    public function reversed(){}
9682
9683    /**
9684     * Rotates the deque by a given number of rotations
9685     *
9686     * Rotates the deque by a given number of rotations, which is equivalent
9687     * to successively calling $deque->push($deque->shift()) if the number of
9688     * rotations is positive, or $deque->unshift($deque->pop()) if negative.
9689     *
9690     * @param int $rotations The number of times the deque should be
9691     *   rotated.
9692     * @return void . The deque of the current instance will be rotated.
9693     **/
9694    public function rotate($rotations){}
9695
9696    /**
9697     * Updates a value at a given index
9698     *
9699     * @param int $index The index of the value to update.
9700     * @param mixed $value The new value.
9701     * @return void
9702     **/
9703    public function set($index, $value){}
9704
9705    /**
9706     * Removes and returns the first value
9707     *
9708     * @return mixed The first value, which was removed.
9709     **/
9710    public function shift(){}
9711
9712    /**
9713     * Returns a sub-deque of a given range
9714     *
9715     * Creates a sub-deque of a given range.
9716     *
9717     * @param int $index The index at which the sub-deque starts. If
9718     *   positive, the deque will start at that index in the deque. If
9719     *   negative, the deque will start that far from the end.
9720     * @param int $length If a length is given and is positive, the
9721     *   resulting deque will have up to that many values in it.
9722     *
9723     *   If the length results in an overflow, only values up to the end of
9724     *   the deque will be included.
9725     *
9726     *   If a length is given and is negative, the deque will stop that many
9727     *   values from the end.
9728     *
9729     *   If a length is not provided, the resulting deque will contain all
9730     *   values between the index and the end of the deque.
9731     * @return Ds\Deque A sub-deque of the given range.
9732     **/
9733    public function slice($index, $length){}
9734
9735    /**
9736     * Sorts the deque in-place
9737     *
9738     * Sorts the deque in-place, using an optional {@link comparator}
9739     * function.
9740     *
9741     * @param callable $comparator
9742     * @return void
9743     **/
9744    public function sort($comparator){}
9745
9746    /**
9747     * Returns a sorted copy
9748     *
9749     * Returns a sorted copy, using an optional {@link comparator} function.
9750     *
9751     * @param callable $comparator
9752     * @return Ds\Deque Returns a sorted copy of the deque.
9753     **/
9754    public function sorted($comparator){}
9755
9756    /**
9757     * Returns the sum of all values in the deque
9758     *
9759     * @return number The sum of all the values in the deque as either a
9760     *   float or int depending on the values in the deque.
9761     **/
9762    public function sum(){}
9763
9764    /**
9765     * Converts the deque to an
9766     *
9767     * Converts the deque to an .
9768     *
9769     * @return array An containing all the values in the same order as the
9770     *   deque.
9771     **/
9772    public function toArray(){}
9773
9774    /**
9775     * Adds values to the front of the deque
9776     *
9777     * Adds values to the front of the deque, moving all the current values
9778     * forward to make room for the new values.
9779     *
9780     * @param mixed $values The values to add to the front of the deque.
9781     *   Multiple values will be added in the same order that they are
9782     *   passed.
9783     * @return void
9784     **/
9785    public function unshift($values){}
9786
9787}
9788}
9789namespace Ds {
9790interface Hashable {
9791    /**
9792     * Determines whether an object is equal to the current instance
9793     *
9794     * Determines whether another object is equal to the current instance.
9795     *
9796     * This method allows objects to be used as keys in structures such as
9797     * Ds\Map and Ds\Set, or any other lookup structure that honors this
9798     * interface.
9799     *
9800     * @param object $obj The object to compare the current instance to,
9801     *   which is always an instance of the same class.
9802     * @return bool TRUE if equal, FALSE otherwise.
9803     **/
9804    public function equals($obj);
9805
9806    /**
9807     * Returns a scalar value to be used as a hash value
9808     *
9809     * Returns a scalar value to be used as the hash value of the objects.
9810     *
9811     * While the hash value does not define equality, all objects that are
9812     * equal according to {@link Ds\Hashable::equals} must have the same hash
9813     * value. Hash values of equal objects don't have to be unique, for
9814     * example you could just return TRUE for all objects and nothing would
9815     * break - the only implication would be that hash tables then turn into
9816     * linked lists because all your objects will be hashed to the same
9817     * bucket. It's therefore very important that you pick a good hash value,
9818     * such as an ID or email address.
9819     *
9820     * This method allows objects to be used as keys in structures such as
9821     * Ds\Map and Ds\Set, or any other lookup structure that honors this
9822     * interface.
9823     *
9824     * @return mixed A scalar value to be used as this object's hash value.
9825     **/
9826    public function hash();
9827
9828}
9829}
9830namespace Ds {
9831class Map implements Ds\Collection {
9832    /**
9833     * Allocates enough memory for a required capacity
9834     *
9835     * @param int $capacity The number of values for which capacity should
9836     *   be allocated.
9837     * @return void
9838     **/
9839    public function allocate($capacity){}
9840
9841    /**
9842     * Updates all values by applying a callback function to each value
9843     *
9844     * Updates all values by applying a {@link callback} function to each
9845     * value in the map.
9846     *
9847     * @param callable $callback mixed callback mixed{@link key}
9848     *   mixed{@link value} A callable to apply to each value in the map. The
9849     *   callback should return what the value should be replaced by.
9850     * @return void
9851     **/
9852    public function apply($callback){}
9853
9854    /**
9855     * Returns the current capacity
9856     *
9857     * @return int The current capacity.
9858     **/
9859    public function capacity(){}
9860
9861    /**
9862     * Removes all values
9863     *
9864     * Removes all values from the map.
9865     *
9866     * @return void
9867     **/
9868    public function clear(){}
9869
9870    /**
9871     * Returns a shallow copy of the map
9872     *
9873     * @return Ds\Map Returns a shallow copy of the map.
9874     **/
9875    public function copy(){}
9876
9877    /**
9878     * Creates a new map using keys that aren't in another map
9879     *
9880     * Returns the result of removing all keys from the current instance that
9881     * are present in a given {@link map}.
9882     *
9883     * A \ B = {x ∈ A | x ∉ B}
9884     *
9885     * @param Ds\Map $map The map containing the keys to exclude in the
9886     *   resulting map.
9887     * @return Ds\Map The result of removing all keys from the current
9888     *   instance that are present in a given {@link map}.
9889     **/
9890    public function diff($map){}
9891
9892    /**
9893     * Creates a new map using a to determine which pairs to include
9894     *
9895     * Creates a new map using a callable to determine which pairs to
9896     * include.
9897     *
9898     * @param callable $callback bool callback mixed{@link key} mixed{@link
9899     *   value} Optional callable which returns TRUE if the pair should be
9900     *   included, FALSE otherwise. If a callback is not provided, only
9901     *   values which are TRUE (see converting to boolean) will be included.
9902     * @return Ds\Map A new map containing all the pairs for which either
9903     *   the {@link callback} returned TRUE, or all values that convert to
9904     *   TRUE if a {@link callback} was not provided.
9905     **/
9906    public function filter($callback){}
9907
9908    /**
9909     * Returns the first pair in the map
9910     *
9911     * @return Ds\Pair The first pair in the map.
9912     **/
9913    public function first(){}
9914
9915    /**
9916     * Returns the value for a given key
9917     *
9918     * Returns the value for a given key, or an optional default value if the
9919     * key could not be found.
9920     *
9921     * @param mixed $key The key to look up.
9922     * @param mixed $default The optional default value, returned if the
9923     *   key could not be found.
9924     * @return mixed The value mapped to the given {@link key}, or the
9925     *   {@link default} value if provided and the key could not be found in
9926     *   the map.
9927     **/
9928    public function get($key, $default){}
9929
9930    /**
9931     * Determines whether the map contains a given key
9932     *
9933     * @param mixed $key The key to look for.
9934     * @return bool Returns TRUE if the key could found, FALSE otherwise.
9935     **/
9936    public function hasKey($key){}
9937
9938    /**
9939     * Determines whether the map contains a given value
9940     *
9941     * @param mixed $value The value to look for.
9942     * @return bool Returns TRUE if the value could found, FALSE otherwise.
9943     **/
9944    public function hasValue($value){}
9945
9946    /**
9947     * Creates a new map by intersecting keys with another map
9948     *
9949     * Creates a new map containing the pairs of the current instance whose
9950     * keys are also present in the given {@link map}.
9951     *
9952     * In other words, returns a copy of the current instance with all keys
9953     * removed that are not also in the other {@link map}.
9954     *
9955     * A ∩ B = {x : x ∈ A ∧ x ∈ B}
9956     *
9957     * @param Ds\Map $map The other map, containing the keys to intersect
9958     *   with.
9959     * @return Ds\Map The key intersection of the current instance and
9960     *   another {@link map}.
9961     **/
9962    public function intersect($map){}
9963
9964    /**
9965     * Returns whether the map is empty
9966     *
9967     * @return bool Returns TRUE if the map is empty, FALSE otherwise.
9968     **/
9969    public function isEmpty(){}
9970
9971    /**
9972     * Returns a set of the map's keys
9973     *
9974     * Returns a set containing all the keys of the map, in the same order.
9975     *
9976     * @return Ds\Set A Ds\Set containing all the keys of the map.
9977     **/
9978    public function keys(){}
9979
9980    /**
9981     * Sorts the map in-place by key
9982     *
9983     * Sorts the map in-place by key, using an optional {@link comparator}
9984     * function.
9985     *
9986     * @param callable $comparator
9987     * @return void
9988     **/
9989    public function ksort($comparator){}
9990
9991    /**
9992     * Returns a copy, sorted by key
9993     *
9994     * Returns a copy sorted by key, using an optional {@link comparator}
9995     * function.
9996     *
9997     * @param callable $comparator
9998     * @return Ds\Map Returns a copy of the map, sorted by key.
9999     **/
10000    public function ksorted($comparator){}
10001
10002    /**
10003     * Returns the last pair of the map
10004     *
10005     * @return Ds\Pair The last pair of the map.
10006     **/
10007    public function last(){}
10008
10009    /**
10010     * Returns the result of applying a callback to each value
10011     *
10012     * Returns the result of applying a {@link callback} function to each
10013     * value of the map.
10014     *
10015     * @param callable $callback mixed callback mixed{@link key}
10016     *   mixed{@link value} A callable to apply to each value in the map. The
10017     *   callable should return what the key will be mapped to in the
10018     *   resulting map.
10019     * @return Ds\Map The result of applying a {@link callback} to each
10020     *   value in the map.
10021     **/
10022    public function map($callback){}
10023
10024    /**
10025     * Returns the result of adding all given associations
10026     *
10027     * Returns the result of associating all keys of a given traversable
10028     * object or with their corresponding values, combined with the current
10029     * instance.
10030     *
10031     * @param mixed $values A traversable object or an .
10032     * @return Ds\Map The result of associating all keys of a given
10033     *   traversable object or with their corresponding values, combined with
10034     *   the current instance.
10035     **/
10036    public function merge($values){}
10037
10038    /**
10039     * Returns a sequence containing all the pairs of the map
10040     *
10041     * Returns a Ds\Sequence containing all the pairs of the map.
10042     *
10043     * @return Ds\Sequence Ds\Sequence containing all the pairs of the map.
10044     **/
10045    public function pairs(){}
10046
10047    /**
10048     * Associates a key with a value
10049     *
10050     * Associates a {@link key} with a {@link value}, overwriting a previous
10051     * association if one exists.
10052     *
10053     * @param mixed $key The key to associate the value with.
10054     * @param mixed $value The value to be associated with the key.
10055     * @return void
10056     **/
10057    public function put($key, $value){}
10058
10059    /**
10060     * Associates all key-value pairs of a traversable object or array
10061     *
10062     * Associates all key-value {@link pairs} of a traversable object or .
10063     *
10064     * @param mixed $pairs traversable object or .
10065     * @return void
10066     **/
10067    public function putAll($pairs){}
10068
10069    /**
10070     * Reduces the map to a single value using a callback function
10071     *
10072     * @param callable $callback
10073     * @param mixed $initial The return value of the previous callback, or
10074     *   {@link initial} if it's the first iteration.
10075     * @return mixed The return value of the final callback.
10076     **/
10077    public function reduce($callback, $initial){}
10078
10079    /**
10080     * Removes and returns a value by key
10081     *
10082     * Removes and returns a value by key, or return an optional default
10083     * value if the key could not be found.
10084     *
10085     * @param mixed $key The key to remove.
10086     * @param mixed $default The optional default value, returned if the
10087     *   key could not be found.
10088     * @return mixed The value that was removed, or the {@link default}
10089     *   value if provided and the {@link key} could not be found in the map.
10090     **/
10091    public function remove($key, $default){}
10092
10093    /**
10094     * Reverses the map in-place
10095     *
10096     * Reverses the map in-place.
10097     *
10098     * @return void
10099     **/
10100    public function reverse(){}
10101
10102    /**
10103     * Returns a reversed copy
10104     *
10105     * Returns a reversed copy of the map.
10106     *
10107     * @return Ds\Map A reversed copy of the map.
10108     *
10109     *   The current instance is not affected.
10110     **/
10111    public function reversed(){}
10112
10113    /**
10114     * Returns the pair at a given positional index
10115     *
10116     * Returns the pair at a given zero-based {@link position}.
10117     *
10118     * @param int $position The zero-based positional index to return.
10119     * @return Ds\Pair Returns the Ds\Pair at the given {@link position}.
10120     **/
10121    public function skip($position){}
10122
10123    /**
10124     * Returns a subset of the map defined by a starting index and length
10125     *
10126     * Returns a subset of the map defined by a starting {@link index} and
10127     * {@link length}.
10128     *
10129     * @param int $index The index at which the range starts. If positive,
10130     *   the range will start at that index in the map. If negative, the
10131     *   range will start that far from the end.
10132     * @param int $length If a length is given and is positive, the
10133     *   resulting map will have up to that many pairs in it.
10134     *
10135     *   If a length is given and is negative, the range will stop that many
10136     *   pairs from the end.
10137     *
10138     *   If the length results in an overflow, only pairs up to the end of
10139     *   the map will be included.
10140     *
10141     *   If a length is not provided, the resulting map will contain all
10142     *   pairs between the index and the end of the map.
10143     * @return Ds\Map A subset of the map defined by a starting index and
10144     *   length.
10145     **/
10146    public function slice($index, $length){}
10147
10148    /**
10149     * Sorts the map in-place by value
10150     *
10151     * Sorts the map in-place by value, using an optional {@link comparator}
10152     * function.
10153     *
10154     * @param callable $comparator
10155     * @return void
10156     **/
10157    public function sort($comparator){}
10158
10159    /**
10160     * Returns a copy, sorted by value
10161     *
10162     * Returns a copy, sorted by value using an optional {@link comparator}
10163     * function.
10164     *
10165     * @param callable $comparator
10166     * @return Ds\Map Returns a copy of the map, sorted by value.
10167     **/
10168    public function sorted($comparator){}
10169
10170    /**
10171     * Returns the sum of all values in the map
10172     *
10173     * @return number The sum of all the values in the map as either a
10174     *   float or int depending on the values in the map.
10175     **/
10176    public function sum(){}
10177
10178    /**
10179     * Converts the map to an
10180     *
10181     * Converts the map to an .
10182     *
10183     * @return array An containing all the values in the same order as the
10184     *   map.
10185     **/
10186    public function toArray(){}
10187
10188    /**
10189     * Creates a new map using values from the current instance and another
10190     * map
10191     *
10192     * Creates a new map that contains the pairs of the current instance as
10193     * well as the pairs of another {@link map}.
10194     *
10195     * A ∪ B = {x: x ∈ A ∨ x ∈ B}
10196     *
10197     * @param Ds\Map $map The other map, to combine with the current
10198     *   instance.
10199     * @return Ds\Map A new map containing all the pairs of the current
10200     *   instance as well as another {@link map}.
10201     **/
10202    public function union($map){}
10203
10204    /**
10205     * Returns a sequence of the map's values
10206     *
10207     * Returns a sequence containing all the values of the map, in the same
10208     * order.
10209     *
10210     * @return Ds\Sequence A Ds\Sequence containing all the values of the
10211     *   map.
10212     **/
10213    public function values(){}
10214
10215    /**
10216     * Creates a new map using keys of either the current instance or of
10217     * another map, but not of both
10218     *
10219     * Creates a new map containing keys of the current instance as well as
10220     * another {@link map}, but not of both.
10221     *
10222     * A ⊖ B = {x : x ∈ (A \ B) ∪ (B \ A)}
10223     *
10224     * @param Ds\Map $map The other map.
10225     * @return Ds\Map A new map containing keys in the current instance as
10226     *   well as another {@link map}, but not in both.
10227     **/
10228    public function xor($map){}
10229
10230}
10231}
10232namespace Ds {
10233class Pair implements JsonSerializable {
10234    /**
10235     * Removes all values
10236     *
10237     * Removes all values from the pair.
10238     *
10239     * @return void
10240     **/
10241    public function clear(){}
10242
10243    /**
10244     * Returns a shallow copy of the pair
10245     *
10246     * @return Ds\Pair Returns a shallow copy of the pair.
10247     **/
10248    public function copy(){}
10249
10250    /**
10251     * Returns whether the pair is empty
10252     *
10253     * @return bool Returns TRUE if the pair is empty, FALSE otherwise.
10254     **/
10255    public function isEmpty(){}
10256
10257    /**
10258     * Converts the pair to an
10259     *
10260     * Converts the pair to an .
10261     *
10262     * @return array An containing all the values in the same order as the
10263     *   pair.
10264     **/
10265    public function toArray(){}
10266
10267}
10268}
10269namespace Ds {
10270class PriorityQueue implements Ds\Collection {
10271    /**
10272     * Allocates enough memory for a required capacity
10273     *
10274     * Ensures that enough memory is allocated for a required capacity. This
10275     * removes the need to reallocate the internal as values are added.
10276     *
10277     * @param int $capacity The number of values for which capacity should
10278     *   be allocated.
10279     * @return void
10280     **/
10281    public function allocate($capacity){}
10282
10283    /**
10284     * Returns the current capacity
10285     *
10286     * @return int The current capacity.
10287     **/
10288    public function capacity(){}
10289
10290    /**
10291     * Removes all values
10292     *
10293     * Removes all values from the queue.
10294     *
10295     * @return void
10296     **/
10297    public function clear(){}
10298
10299    /**
10300     * Returns a shallow copy of the queue
10301     *
10302     * @return Ds\PriorityQueue Returns a shallow copy of the queue.
10303     **/
10304    public function copy(){}
10305
10306    /**
10307     * Returns whether the queue is empty
10308     *
10309     * @return bool Returns TRUE if the queue is empty, FALSE otherwise.
10310     **/
10311    public function isEmpty(){}
10312
10313    /**
10314     * Returns the value at the front of the queue
10315     *
10316     * Returns the value at the front of the queue, but does not remove it.
10317     *
10318     * @return mixed The value at the front of the queue.
10319     **/
10320    public function peek(){}
10321
10322    /**
10323     * Removes and returns the value with the highest priority
10324     *
10325     * Removes and returns the value at the front of the queue, ie. the value
10326     * with the highest priority.
10327     *
10328     * @return mixed The removed value which was at the front of the queue.
10329     **/
10330    public function pop(){}
10331
10332    /**
10333     * Pushes values into the queue
10334     *
10335     * Pushes a {@link value} with a given {@link priority} into the queue.
10336     *
10337     * @param mixed $value The value to push into the queue.
10338     * @param int $priority The priority associated with the value.
10339     * @return void
10340     **/
10341    public function push($value, $priority){}
10342
10343    /**
10344     * Converts the queue to an
10345     *
10346     * Converts the queue to an .
10347     *
10348     * @return array An containing all the values in the same order as the
10349     *   queue.
10350     **/
10351    public function toArray(){}
10352
10353}
10354}
10355namespace Ds {
10356class Queue implements Ds\Collection {
10357    /**
10358     * Allocates enough memory for a required capacity
10359     *
10360     * Ensures that enough memory is allocated for a required capacity. This
10361     * removes the need to reallocate the internal as values are added.
10362     *
10363     * @param int $capacity The number of values for which capacity should
10364     *   be allocated.
10365     * @return void
10366     **/
10367    public function allocate($capacity){}
10368
10369    /**
10370     * Returns the current capacity
10371     *
10372     * @return int The current capacity.
10373     **/
10374    public function capacity(){}
10375
10376    /**
10377     * Removes all values
10378     *
10379     * Removes all values from the queue.
10380     *
10381     * @return void
10382     **/
10383    public function clear(){}
10384
10385    /**
10386     * Returns a shallow copy of the queue
10387     *
10388     * @return Ds\Queue Returns a shallow copy of the queue.
10389     **/
10390    public function copy(){}
10391
10392    /**
10393     * Returns whether the queue is empty
10394     *
10395     * @return bool Returns TRUE if the queue is empty, FALSE otherwise.
10396     **/
10397    public function isEmpty(){}
10398
10399    /**
10400     * Returns the value at the front of the queue
10401     *
10402     * Returns the value at the front of the queue, but does not remove it.
10403     *
10404     * @return mixed The value at the front of the queue.
10405     **/
10406    public function peek(){}
10407
10408    /**
10409     * Removes and returns the value at the front of the queue
10410     *
10411     * @return mixed The removed value which was at the front of the queue.
10412     **/
10413    public function pop(){}
10414
10415    /**
10416     * Pushes values into the queue
10417     *
10418     * Pushes {@link values} into the queue.
10419     *
10420     * @param mixed ...$values The values to push into the queue.
10421     * @return void
10422     **/
10423    public function push(...$values){}
10424
10425    /**
10426     * Converts the queue to an
10427     *
10428     * Converts the queue to an .
10429     *
10430     * @return array An containing all the values in the same order as the
10431     *   queue.
10432     **/
10433    public function toArray(){}
10434
10435}
10436}
10437namespace Ds {
10438interface Sequence extends Ds\Collection {
10439    /**
10440     * Allocates enough memory for a required capacity
10441     *
10442     * Ensures that enough memory is allocated for a required capacity. This
10443     * removes the need to reallocate the internal as values are added.
10444     *
10445     * @param int $capacity The number of values for which capacity should
10446     *   be allocated.
10447     * @return void
10448     **/
10449    public function allocate($capacity);
10450
10451    /**
10452     * Updates all values by applying a callback function to each value
10453     *
10454     * Updates all values by applying a {@link callback} function to each
10455     * value in the sequence.
10456     *
10457     * @param callable $callback mixed callback mixed{@link value} A
10458     *   callable to apply to each value in the sequence. The callback should
10459     *   return what the value should be replaced by.
10460     * @return void
10461     **/
10462    public function apply($callback);
10463
10464    /**
10465     * Returns the current capacity
10466     *
10467     * @return int The current capacity.
10468     **/
10469    public function capacity();
10470
10471    /**
10472     * Determines if the sequence contains given values
10473     *
10474     * Determines if the sequence contains all values.
10475     *
10476     * @param mixed ...$values Values to check.
10477     * @return bool FALSE if any of the provided {@link values} are not in
10478     *   the sequence, TRUE otherwise.
10479     **/
10480    public function contains(...$values);
10481
10482    /**
10483     * Creates a new sequence using a to determine which values to include
10484     *
10485     * Creates a new sequence using a callable to determine which values to
10486     * include.
10487     *
10488     * @param callable $callback bool callback mixed{@link value} Optional
10489     *   callable which returns TRUE if the value should be included, FALSE
10490     *   otherwise. If a callback is not provided, only values which are TRUE
10491     *   (see converting to boolean) will be included.
10492     * @return Ds\Sequence A new sequence containing all the values for
10493     *   which either the {@link callback} returned TRUE, or all values that
10494     *   convert to TRUE if a {@link callback} was not provided.
10495     **/
10496    public function filter($callback);
10497
10498    /**
10499     * Attempts to find a value's index
10500     *
10501     * Returns the index of the {@link value}, or FALSE if not found.
10502     *
10503     * @param mixed $value The value to find.
10504     * @return mixed The index of the value, or FALSE if not found.
10505     **/
10506    public function find($value);
10507
10508    /**
10509     * Returns the first value in the sequence
10510     *
10511     * @return mixed The first value in the sequence.
10512     **/
10513    public function first();
10514
10515    /**
10516     * Returns the value at a given index
10517     *
10518     * @param int $index The index to access, starting at 0.
10519     * @return mixed The value at the requested index.
10520     **/
10521    public function get($index);
10522
10523    /**
10524     * Inserts values at a given index
10525     *
10526     * Inserts values into the sequence at a given index.
10527     *
10528     * @param int $index The index at which to insert. 0 <= index <= count
10529     * @param mixed ...$values The value or values to insert.
10530     * @return void
10531     **/
10532    public function insert($index, ...$values);
10533
10534    /**
10535     * Joins all values together as a string
10536     *
10537     * Joins all values together as a string using an optional separator
10538     * between each value.
10539     *
10540     * @param string $glue An optional string to separate each value.
10541     * @return string All values of the sequence joined together as a
10542     *   string.
10543     **/
10544    public function join($glue);
10545
10546    /**
10547     * Returns the last value
10548     *
10549     * Returns the last value in the sequence.
10550     *
10551     * @return mixed The last value in the sequence.
10552     **/
10553    public function last();
10554
10555    /**
10556     * Returns the result of applying a callback to each value
10557     *
10558     * Returns the result of applying a {@link callback} function to each
10559     * value in the sequence.
10560     *
10561     * @param callable $callback mixed callback mixed{@link value} A
10562     *   callable to apply to each value in the sequence. The callable should
10563     *   return what the new value will be in the new sequence.
10564     * @return Ds\Sequence The result of applying a {@link callback} to
10565     *   each value in the sequence.
10566     **/
10567    public function map($callback);
10568
10569    /**
10570     * Returns the result of adding all given values to the sequence
10571     *
10572     * @param mixed $values A traversable object or an .
10573     * @return Ds\Sequence The result of adding all given values to the
10574     *   sequence, effectively the same as adding the values to a copy, then
10575     *   returning that copy.
10576     **/
10577    public function merge($values);
10578
10579    /**
10580     * Removes and returns the last value
10581     *
10582     * @return mixed The removed last value.
10583     **/
10584    public function pop();
10585
10586    /**
10587     * Adds values to the end of the sequence
10588     *
10589     * @param mixed ...$values The values to add.
10590     * @return void
10591     **/
10592    public function push(...$values);
10593
10594    /**
10595     * Reduces the sequence to a single value using a callback function
10596     *
10597     * @param callable $callback
10598     * @param mixed $initial The return value of the previous callback, or
10599     *   {@link initial} if it's the first iteration.
10600     * @return mixed The return value of the final callback.
10601     **/
10602    public function reduce($callback, $initial);
10603
10604    /**
10605     * Removes and returns a value by index
10606     *
10607     * @param int $index The index of the value to remove.
10608     * @return mixed The value that was removed.
10609     **/
10610    public function remove($index);
10611
10612    /**
10613     * Reverses the sequence in-place
10614     *
10615     * Reverses the sequence in-place.
10616     *
10617     * @return void
10618     **/
10619    public function reverse();
10620
10621    /**
10622     * Returns a reversed copy
10623     *
10624     * Returns a reversed copy of the sequence.
10625     *
10626     * @return Ds\Sequence A reversed copy of the sequence.
10627     *
10628     *   The current instance is not affected.
10629     **/
10630    public function reversed();
10631
10632    /**
10633     * Rotates the sequence by a given number of rotations
10634     *
10635     * Rotates the sequence by a given number of rotations, which is
10636     * equivalent to successively calling $sequence->push($sequence->shift())
10637     * if the number of rotations is positive, or
10638     * $sequence->unshift($sequence->pop()) if negative.
10639     *
10640     * @param int $rotations The number of times the sequence should be
10641     *   rotated.
10642     * @return void . The sequence of the current instance will be rotated.
10643     **/
10644    public function rotate($rotations);
10645
10646    /**
10647     * Updates a value at a given index
10648     *
10649     * @param int $index The index of the value to update.
10650     * @param mixed $value The new value.
10651     * @return void
10652     **/
10653    public function set($index, $value);
10654
10655    /**
10656     * Removes and returns the first value
10657     *
10658     * @return mixed The first value, which was removed.
10659     **/
10660    public function shift();
10661
10662    /**
10663     * Returns a sub-sequence of a given range
10664     *
10665     * Creates a sub-sequence of a given range.
10666     *
10667     * @param int $index The index at which the sub-sequence starts. If
10668     *   positive, the sequence will start at that index in the sequence. If
10669     *   negative, the sequence will start that far from the end.
10670     * @param int $length If a length is given and is positive, the
10671     *   resulting sequence will have up to that many values in it.
10672     *
10673     *   If the length results in an overflow, only values up to the end of
10674     *   the sequence will be included.
10675     *
10676     *   If a length is given and is negative, the sequence will stop that
10677     *   many values from the end.
10678     *
10679     *   If a length is not provided, the resulting sequence will contain all
10680     *   values between the index and the end of the sequence.
10681     * @return Ds\Sequence A sub-sequence of the given range.
10682     **/
10683    public function slice($index, $length);
10684
10685    /**
10686     * Sorts the sequence in-place
10687     *
10688     * Sorts the sequence in-place, using an optional {@link comparator}
10689     * function.
10690     *
10691     * @param callable $comparator
10692     * @return void
10693     **/
10694    public function sort($comparator);
10695
10696    /**
10697     * Returns a sorted copy
10698     *
10699     * Returns a sorted copy, using an optional {@link comparator} function.
10700     *
10701     * @param callable $comparator
10702     * @return Ds\Sequence Returns a sorted copy of the sequence.
10703     **/
10704    public function sorted($comparator);
10705
10706    /**
10707     * Returns the sum of all values in the sequence
10708     *
10709     * @return number The sum of all the values in the sequence as either a
10710     *   float or int depending on the values in the sequence.
10711     **/
10712    public function sum();
10713
10714    /**
10715     * Adds values to the front of the sequence
10716     *
10717     * Adds values to the front of the sequence, moving all the current
10718     * values forward to make room for the new values.
10719     *
10720     * @param mixed $values The values to add to the front of the sequence.
10721     *   Multiple values will be added in the same order that they are
10722     *   passed.
10723     * @return void
10724     **/
10725    public function unshift($values);
10726
10727}
10728}
10729namespace Ds {
10730class Set implements Ds\Collection {
10731    /**
10732     * Adds values to the set
10733     *
10734     * Adds all given values to the set that haven't already been added.
10735     *
10736     * @param mixed ...$values Values to add to the set.
10737     * @return void
10738     **/
10739    public function add(...$values){}
10740
10741    /**
10742     * Allocates enough memory for a required capacity
10743     *
10744     * @param int $capacity The number of values for which capacity should
10745     *   be allocated.
10746     * @return void
10747     **/
10748    public function allocate($capacity){}
10749
10750    /**
10751     * Returns the current capacity
10752     *
10753     * @return int The current capacity.
10754     **/
10755    public function capacity(){}
10756
10757    /**
10758     * Removes all values
10759     *
10760     * Removes all values from the set.
10761     *
10762     * @return void
10763     **/
10764    public function clear(){}
10765
10766    /**
10767     * Determines if the set contains all values
10768     *
10769     * @param mixed ...$values Values to check.
10770     * @return bool FALSE if any of the provided {@link values} are not in
10771     *   the set, TRUE otherwise.
10772     **/
10773    public function contains(...$values){}
10774
10775    /**
10776     * Returns a shallow copy of the set
10777     *
10778     * @return Ds\Set Returns a shallow copy of the set.
10779     **/
10780    public function copy(){}
10781
10782    /**
10783     * Creates a new set using values that aren't in another set
10784     *
10785     * A \ B = {x ∈ A | x ∉ B}
10786     *
10787     * @param Ds\Set $set Set containing the values to exclude.
10788     * @return Ds\Set A new set containing all values that were not in the
10789     *   other {@link set}.
10790     **/
10791    public function diff($set){}
10792
10793    /**
10794     * Creates a new set using a to determine which values to include
10795     *
10796     * Creates a new set using a callable to determine which values to
10797     * include.
10798     *
10799     * @param callable $callback bool callback mixed{@link value} Optional
10800     *   callable which returns TRUE if the value should be included, FALSE
10801     *   otherwise. If a callback is not provided, only values which are TRUE
10802     *   (see converting to boolean) will be included.
10803     * @return Ds\Set A new set containing all the values for which either
10804     *   the {@link callback} returned TRUE, or all values that convert to
10805     *   TRUE if a {@link callback} was not provided.
10806     **/
10807    public function filter($callback){}
10808
10809    /**
10810     * Returns the first value in the set
10811     *
10812     * @return mixed The first value in the set.
10813     **/
10814    public function first(){}
10815
10816    /**
10817     * Returns the value at a given index
10818     *
10819     * @param int $index The index to access, starting at 0.
10820     * @return mixed The value at the requested index.
10821     **/
10822    public function get($index){}
10823
10824    /**
10825     * Creates a new set by intersecting values with another set
10826     *
10827     * Creates a new set using values common to both the current instance and
10828     * another {@link set}.
10829     *
10830     * In other words, returns a copy of the current instance with all values
10831     * removed that are not in the other {@link set}.
10832     *
10833     * A ∩ B = {x : x ∈ A ∧ x ∈ B}
10834     *
10835     * @param Ds\Set $set The other set.
10836     * @return Ds\Set The intersection of the current instance and another
10837     *   {@link set}.
10838     **/
10839    public function intersect($set){}
10840
10841    /**
10842     * Returns whether the set is empty
10843     *
10844     * @return bool Returns TRUE if the set is empty, FALSE otherwise.
10845     **/
10846    public function isEmpty(){}
10847
10848    /**
10849     * Joins all values together as a string
10850     *
10851     * Joins all values together as a string using an optional separator
10852     * between each value.
10853     *
10854     * @param string $glue An optional string to separate each value.
10855     * @return string All values of the set joined together as a string.
10856     **/
10857    public function join($glue){}
10858
10859    /**
10860     * Returns the last value in the set
10861     *
10862     * @return mixed The last value in the set.
10863     **/
10864    public function last(){}
10865
10866    /**
10867     * Returns the result of adding all given values to the set
10868     *
10869     * @param mixed $values A traversable object or an .
10870     * @return Ds\Set The result of adding all given values to the set,
10871     *   effectively the same as adding the values to a copy, then returning
10872     *   that copy.
10873     **/
10874    public function merge($values){}
10875
10876    /**
10877     * Reduces the set to a single value using a callback function
10878     *
10879     * @param callable $callback
10880     * @param mixed $initial The return value of the previous callback, or
10881     *   {@link initial} if it's the first iteration.
10882     * @return mixed The return value of the final callback.
10883     **/
10884    public function reduce($callback, $initial){}
10885
10886    /**
10887     * Removes all given values from the set
10888     *
10889     * Removes all given {@link values} from the set, ignoring any that are
10890     * not in the set.
10891     *
10892     * @param mixed ...$values The values to remove.
10893     * @return void
10894     **/
10895    public function remove(...$values){}
10896
10897    /**
10898     * Reverses the set in-place
10899     *
10900     * Reverses the set in-place.
10901     *
10902     * @return void
10903     **/
10904    public function reverse(){}
10905
10906    /**
10907     * Returns a reversed copy
10908     *
10909     * Returns a reversed copy of the set.
10910     *
10911     * @return Ds\Set A reversed copy of the set.
10912     *
10913     *   The current instance is not affected.
10914     **/
10915    public function reversed(){}
10916
10917    /**
10918     * Returns a sub-set of a given range
10919     *
10920     * Creates a sub-set of a given range.
10921     *
10922     * @param int $index The index at which the sub-set starts. If
10923     *   positive, the set will start at that index in the set. If negative,
10924     *   the set will start that far from the end.
10925     * @param int $length If a length is given and is positive, the
10926     *   resulting set will have up to that many values in it.
10927     *
10928     *   If the length results in an overflow, only values up to the end of
10929     *   the set will be included.
10930     *
10931     *   If a length is given and is negative, the set will stop that many
10932     *   values from the end.
10933     *
10934     *   If a length is not provided, the resulting set will contain all
10935     *   values between the index and the end of the set.
10936     * @return Ds\Set A sub-set of the given range.
10937     **/
10938    public function slice($index, $length){}
10939
10940    /**
10941     * Sorts the set in-place
10942     *
10943     * Sorts the set in-place, using an optional {@link comparator} function.
10944     *
10945     * @param callable $comparator
10946     * @return void
10947     **/
10948    public function sort($comparator){}
10949
10950    /**
10951     * Returns a sorted copy
10952     *
10953     * Returns a sorted copy, using an optional {@link comparator} function.
10954     *
10955     * @param callable $comparator
10956     * @return Ds\Set Returns a sorted copy of the set.
10957     **/
10958    public function sorted($comparator){}
10959
10960    /**
10961     * Returns the sum of all values in the set
10962     *
10963     * @return number The sum of all the values in the set as either a
10964     *   float or int depending on the values in the set.
10965     **/
10966    public function sum(){}
10967
10968    /**
10969     * Converts the set to an
10970     *
10971     * Converts the set to an .
10972     *
10973     * @return array An containing all the values in the same order as the
10974     *   set.
10975     **/
10976    public function toArray(){}
10977
10978    /**
10979     * Creates a new set using values from the current instance and another
10980     * set
10981     *
10982     * Creates a new set that contains the values of the current instance as
10983     * well as the values of another {@link set}.
10984     *
10985     * A ∪ B = {x: x ∈ A ∨ x ∈ B}
10986     *
10987     * @param Ds\Set $set The other set, to combine with the current
10988     *   instance.
10989     * @return Ds\Set A new set containing all the values of the current
10990     *   instance as well as another {@link set}.
10991     **/
10992    public function union($set){}
10993
10994    /**
10995     * Creates a new set using values in either the current instance or in
10996     * another set, but not in both
10997     *
10998     * Creates a new set containing values in the current instance as well as
10999     * another {@link set}, but not in both.
11000     *
11001     * A ⊖ B = {x : x ∈ (A \ B) ∪ (B \ A)}
11002     *
11003     * @param Ds\Set $set The other set.
11004     * @return Ds\Set A new set containing values in the current instance
11005     *   as well as another {@link set}, but not in both.
11006     **/
11007    public function xor($set){}
11008
11009}
11010}
11011namespace Ds {
11012class Stack implements Ds\Collection {
11013    /**
11014     * Allocates enough memory for a required capacity
11015     *
11016     * Ensures that enough memory is allocated for a required capacity. This
11017     * removes the need to reallocate the internal as values are added.
11018     *
11019     * @param int $capacity The number of values for which capacity should
11020     *   be allocated.
11021     * @return void
11022     **/
11023    public function allocate($capacity){}
11024
11025    /**
11026     * Returns the current capacity
11027     *
11028     * @return int The current capacity.
11029     **/
11030    public function capacity(){}
11031
11032    /**
11033     * Removes all values
11034     *
11035     * Removes all values from the stack.
11036     *
11037     * @return void
11038     **/
11039    public function clear(){}
11040
11041    /**
11042     * Returns a shallow copy of the stack
11043     *
11044     * @return Ds\Stack Returns a shallow copy of the stack.
11045     **/
11046    public function copy(){}
11047
11048    /**
11049     * Returns whether the stack is empty
11050     *
11051     * @return bool Returns TRUE if the stack is empty, FALSE otherwise.
11052     **/
11053    public function isEmpty(){}
11054
11055    /**
11056     * Returns the value at the top of the stack
11057     *
11058     * Returns the value at the top of the stack, but does not remove it.
11059     *
11060     * @return mixed The value at the top of the stack.
11061     **/
11062    public function peek(){}
11063
11064    /**
11065     * Removes and returns the value at the top of the stack
11066     *
11067     * @return mixed The removed value which was at the top of the stack.
11068     **/
11069    public function pop(){}
11070
11071    /**
11072     * Pushes values onto the stack
11073     *
11074     * Pushes {@link values} onto the stack.
11075     *
11076     * @param mixed ...$values The values to push onto the stack.
11077     * @return void
11078     **/
11079    public function push(...$values){}
11080
11081    /**
11082     * Converts the stack to an
11083     *
11084     * Converts the stack to an .
11085     *
11086     * @return array An containing all the values in the same order as the
11087     *   stack.
11088     **/
11089    public function toArray(){}
11090
11091}
11092}
11093namespace Ds {
11094class Vector implements Ds\Sequence {
11095    /**
11096     * Allocates enough memory for a required capacity
11097     *
11098     * Ensures that enough memory is allocated for a required capacity. This
11099     * removes the need to reallocate the internal as values are added.
11100     *
11101     * @param int $capacity The number of values for which capacity should
11102     *   be allocated.
11103     * @return void
11104     **/
11105    public function allocate($capacity){}
11106
11107    /**
11108     * Updates all values by applying a callback function to each value
11109     *
11110     * Updates all values by applying a {@link callback} function to each
11111     * value in the vector.
11112     *
11113     * @param callable $callback mixed callback mixed{@link value} A
11114     *   callable to apply to each value in the vector. The callback should
11115     *   return what the value should be replaced by.
11116     * @return void
11117     **/
11118    public function apply($callback){}
11119
11120    /**
11121     * Returns the current capacity
11122     *
11123     * @return int The current capacity.
11124     **/
11125    public function capacity(){}
11126
11127    /**
11128     * Removes all values
11129     *
11130     * Removes all values from the vector.
11131     *
11132     * @return void
11133     **/
11134    public function clear(){}
11135
11136    /**
11137     * Determines if the vector contains given values
11138     *
11139     * Determines if the vector contains all values.
11140     *
11141     * @param mixed ...$values Values to check.
11142     * @return bool FALSE if any of the provided {@link values} are not in
11143     *   the vector, TRUE otherwise.
11144     **/
11145    public function contains(...$values){}
11146
11147    /**
11148     * Returns a shallow copy of the vector
11149     *
11150     * @return Ds\Vector Returns a shallow copy of the vector.
11151     **/
11152    public function copy(){}
11153
11154    /**
11155     * Creates a new vector using a to determine which values to include
11156     *
11157     * Creates a new vector using a callable to determine which values to
11158     * include.
11159     *
11160     * @param callable $callback bool callback mixed{@link value} Optional
11161     *   callable which returns TRUE if the value should be included, FALSE
11162     *   otherwise. If a callback is not provided, only values which are TRUE
11163     *   (see converting to boolean) will be included.
11164     * @return Ds\Vector A new vector containing all the values for which
11165     *   either the {@link callback} returned TRUE, or all values that
11166     *   convert to TRUE if a {@link callback} was not provided.
11167     **/
11168    public function filter($callback){}
11169
11170    /**
11171     * Attempts to find a value's index
11172     *
11173     * Returns the index of the {@link value}, or FALSE if not found.
11174     *
11175     * @param mixed $value The value to find.
11176     * @return mixed The index of the value, or FALSE if not found.
11177     **/
11178    public function find($value){}
11179
11180    /**
11181     * Returns the first value in the vector
11182     *
11183     * @return mixed The first value in the vector.
11184     **/
11185    public function first(){}
11186
11187    /**
11188     * Returns the value at a given index
11189     *
11190     * @param int $index The index to access, starting at 0.
11191     * @return mixed The value at the requested index.
11192     **/
11193    public function get($index){}
11194
11195    /**
11196     * Inserts values at a given index
11197     *
11198     * Inserts values into the vector at a given index.
11199     *
11200     * @param int $index The index at which to insert. 0 <= index <= count
11201     * @param mixed ...$values The value or values to insert.
11202     * @return void
11203     **/
11204    public function insert($index, ...$values){}
11205
11206    /**
11207     * Returns whether the vector is empty
11208     *
11209     * @return bool Returns TRUE if the vector is empty, FALSE otherwise.
11210     **/
11211    public function isEmpty(){}
11212
11213    /**
11214     * Joins all values together as a string
11215     *
11216     * Joins all values together as a string using an optional separator
11217     * between each value.
11218     *
11219     * @param string $glue An optional string to separate each value.
11220     * @return string All values of the vector joined together as a string.
11221     **/
11222    public function join($glue){}
11223
11224    /**
11225     * Returns the last value
11226     *
11227     * Returns the last value in the vector.
11228     *
11229     * @return mixed The last value in the vector.
11230     **/
11231    public function last(){}
11232
11233    /**
11234     * Returns the result of applying a callback to each value
11235     *
11236     * Returns the result of applying a {@link callback} function to each
11237     * value in the vector.
11238     *
11239     * @param callable $callback mixed callback mixed{@link value} A
11240     *   callable to apply to each value in the vector. The callable should
11241     *   return what the new value will be in the new vector.
11242     * @return Ds\Vector The result of applying a {@link callback} to each
11243     *   value in the vector.
11244     **/
11245    public function map($callback){}
11246
11247    /**
11248     * Returns the result of adding all given values to the vector
11249     *
11250     * @param mixed $values A traversable object or an .
11251     * @return Ds\Vector The result of adding all given values to the
11252     *   vector, effectively the same as adding the values to a copy, then
11253     *   returning that copy.
11254     **/
11255    public function merge($values){}
11256
11257    /**
11258     * Removes and returns the last value
11259     *
11260     * @return mixed The removed last value.
11261     **/
11262    public function pop(){}
11263
11264    /**
11265     * Adds values to the end of the vector
11266     *
11267     * @param mixed ...$values The values to add.
11268     * @return void
11269     **/
11270    public function push(...$values){}
11271
11272    /**
11273     * Reduces the vector to a single value using a callback function
11274     *
11275     * @param callable $callback
11276     * @param mixed $initial The return value of the previous callback, or
11277     *   {@link initial} if it's the first iteration.
11278     * @return mixed The return value of the final callback.
11279     **/
11280    public function reduce($callback, $initial){}
11281
11282    /**
11283     * Removes and returns a value by index
11284     *
11285     * @param int $index The index of the value to remove.
11286     * @return mixed The value that was removed.
11287     **/
11288    public function remove($index){}
11289
11290    /**
11291     * Reverses the vector in-place
11292     *
11293     * Reverses the vector in-place.
11294     *
11295     * @return void
11296     **/
11297    public function reverse(){}
11298
11299    /**
11300     * Returns a reversed copy
11301     *
11302     * Returns a reversed copy of the vector.
11303     *
11304     * @return Ds\Vector A reversed copy of the vector.
11305     *
11306     *   The current instance is not affected.
11307     **/
11308    public function reversed(){}
11309
11310    /**
11311     * Rotates the vector by a given number of rotations
11312     *
11313     * Rotates the vector by a given number of rotations, which is equivalent
11314     * to successively calling $vector->push($vector->shift()) if the number
11315     * of rotations is positive, or $vector->unshift($vector->pop()) if
11316     * negative.
11317     *
11318     * @param int $rotations The number of times the vector should be
11319     *   rotated.
11320     * @return void . The vector of the current instance will be rotated.
11321     **/
11322    public function rotate($rotations){}
11323
11324    /**
11325     * Updates a value at a given index
11326     *
11327     * @param int $index The index of the value to update.
11328     * @param mixed $value The new value.
11329     * @return void
11330     **/
11331    public function set($index, $value){}
11332
11333    /**
11334     * Removes and returns the first value
11335     *
11336     * @return mixed The first value, which was removed.
11337     **/
11338    public function shift(){}
11339
11340    /**
11341     * Returns a sub-vector of a given range
11342     *
11343     * Creates a sub-vector of a given range.
11344     *
11345     * @param int $index The index at which the sub-vector starts. If
11346     *   positive, the vector will start at that index in the vector. If
11347     *   negative, the vector will start that far from the end.
11348     * @param int $length If a length is given and is positive, the
11349     *   resulting vector will have up to that many values in it.
11350     *
11351     *   If the length results in an overflow, only values up to the end of
11352     *   the vector will be included.
11353     *
11354     *   If a length is given and is negative, the vector will stop that many
11355     *   values from the end.
11356     *
11357     *   If a length is not provided, the resulting vector will contain all
11358     *   values between the index and the end of the vector.
11359     * @return Ds\Vector A sub-vector of the given range.
11360     **/
11361    public function slice($index, $length){}
11362
11363    /**
11364     * Sorts the vector in-place
11365     *
11366     * Sorts the vector in-place, using an optional {@link comparator}
11367     * function.
11368     *
11369     * @param callable $comparator
11370     * @return void
11371     **/
11372    public function sort($comparator){}
11373
11374    /**
11375     * Returns a sorted copy
11376     *
11377     * Returns a sorted copy, using an optional {@link comparator} function.
11378     *
11379     * @param callable $comparator
11380     * @return Ds\Vector Returns a sorted copy of the vector.
11381     **/
11382    public function sorted($comparator){}
11383
11384    /**
11385     * Returns the sum of all values in the vector
11386     *
11387     * @return number The sum of all the values in the vector as either a
11388     *   float or int depending on the values in the vector.
11389     **/
11390    public function sum(){}
11391
11392    /**
11393     * Converts the vector to an
11394     *
11395     * Converts the vector to an .
11396     *
11397     * @return array An containing all the values in the same order as the
11398     *   vector.
11399     **/
11400    public function toArray(){}
11401
11402    /**
11403     * Adds values to the front of the vector
11404     *
11405     * Adds values to the front of the vector, moving all the current values
11406     * forward to make room for the new values.
11407     *
11408     * @param mixed $values The values to add to the front of the vector.
11409     *   Multiple values will be added in the same order that they are
11410     *   passed.
11411     * @return void
11412     **/
11413    public function unshift($values){}
11414
11415}
11416}
11417/**
11418 * The EmptyIterator class for an empty iterator.
11419 **/
11420class EmptyIterator implements Iterator {
11421    /**
11422     * The current() method
11423     *
11424     * This function must not be called. It throws an exception upon access.
11425     *
11426     * @return mixed
11427     * @since PHP 5 >= 5.1.0, PHP 7
11428     **/
11429    public function current(){}
11430
11431    /**
11432     * The key() method
11433     *
11434     * This function must not be called. It throws an exception upon access.
11435     *
11436     * @return scalar
11437     * @since PHP 5 >= 5.1.0, PHP 7
11438     **/
11439    public function key(){}
11440
11441    /**
11442     * The next() method
11443     *
11444     * No operation, nothing to do.
11445     *
11446     * @return void
11447     * @since PHP 5 >= 5.1.0, PHP 7
11448     **/
11449    public function next(){}
11450
11451    /**
11452     * The rewind() method
11453     *
11454     * No operation, nothing to do.
11455     *
11456     * @return void
11457     * @since PHP 5 >= 5.1.0, PHP 7
11458     **/
11459    public function rewind(){}
11460
11461    /**
11462     * The valid() method
11463     *
11464     * The EmptyIterator valid() method.
11465     *
11466     * @return bool FALSE
11467     * @since PHP 5 >= 5.1.0, PHP 7
11468     **/
11469    public function valid(){}
11470
11471}
11472/**
11473 * Available since PHP 5.1.0. An Error Exception. Use {@link
11474 * set_error_handler} to change error messages into ErrorException.
11475 *
11476 * Fatal error: Uncaught exception 'ErrorException' with message
11477 * 'strpos() expects at least 2 parameters, 0 given' in
11478 * /home/bjori/tmp/ex.php:12 Stack trace: #0 [internal function]:
11479 * exception_error_handler(2, 'strpos() expect...', '/home/bjori/php...',
11480 * 12, Array) #1 /home/bjori/php/cleandocs/test.php(12): strpos() #2
11481 * {main} thrown in /home/bjori/tmp/ex.php on line 12
11482 **/
11483class ErrorException extends Exception {
11484    /**
11485     * The severity of the exception
11486     *
11487     * @var int
11488     **/
11489    protected $severity;
11490
11491    /**
11492     * Gets the exception severity
11493     *
11494     * Returns the severity of the exception.
11495     *
11496     * @return int Returns the severity level of the exception.
11497     * @since PHP 5 >= 5.1.0, PHP 7
11498     **/
11499    final public function getSeverity(){}
11500
11501}
11502/**
11503 * Ev is a static class providing access to the default loop and to some
11504 * common operations. Flags passed to create a loop:
11505 *
11506 * Ev::FLAG_AUTO The default flags value Ev::FLAG_NOENV If this flag
11507 * used(or the program runs setuid or setgid), libev won't look at the
11508 * environment variable LIBEV_FLAGS . Otherwise(by default), LIBEV_FLAGS
11509 * will override the flags completely if it is found. Useful for
11510 * performance tests and searching for bugs. Ev::FLAG_FORKCHECK Makes
11511 * libev check for a fork in each iteration, instead of calling
11512 * EvLoop::fork manually. This works by calling getpid() on every
11513 * iteration of the loop, and thus this might slow down the event loop
11514 * with lots of loop iterations, but usually is not noticeable. This flag
11515 * setting cannot be overridden or specified in the LIBEV_FLAGS
11516 * environment variable. Ev::FLAG_NOINOTIFY When this flag is specified,
11517 * libev won't attempt to use the inotify API for its ev_stat watchers.
11518 * The flag can be useful to conserve inotify file descriptors, as
11519 * otherwise each loop using ev_stat watchers consumes one inotify
11520 * handle. Ev::FLAG_SIGNALFD When this flag is specified, libev will
11521 * attempt to use the signalfd API for its ev_signal (and ev_child )
11522 * watchers. This API delivers signals synchronously, which makes it both
11523 * faster and might make it possible to get the queued signal data. It
11524 * can also simplify signal handling with threads, as long as signals are
11525 * properly blocked in threads. Signalfd will not be used by default.
11526 * Ev::FLAG_NOSIGMASK When this flag is specified, libev will avoid to
11527 * modify the signal mask. Specifically, this means having to make sure
11528 * signals are unblocked before receiving them. This behaviour is useful
11529 * for custom signal handling, or handling signals only in specific
11530 * threads. Flags passed to Ev::run , or EvLoop::run
11531 *
11532 * Ev::RUN_NOWAIT Means that event loop will look for new events, will
11533 * handle those events and any already outstanding ones, but will not
11534 * wait and block the process in case there are no events and will return
11535 * after one iteration of the loop. This is sometimes useful to poll and
11536 * handle new events while doing lengthy calculations, to keep the
11537 * program responsive. Ev::RUN_ONCE Means that event loop will look for
11538 * new events (waiting if necessary) and will handle those and any
11539 * already outstanding ones. It will block the process until at least one
11540 * new event arrives (which could be an event internal to libev itself,
11541 * so there is no guarantee that a user-registered callback will be
11542 * called), and will return after one iteration of the loop. Flags passed
11543 * to Ev::stop , or EvLoop::stop
11544 *
11545 * Ev::BREAK_CANCEL Cancel the break operation. Ev::BREAK_ONE Makes the
11546 * innermost Ev::run (or EvLoop::run ) call return. Ev::BREAK_ALL Makes
11547 * all nested Ev::run (or EvLoop::run ) calls return. Watcher priorities:
11548 *
11549 * Ev::MINPRI Minimum allowed watcher priority. Ev::MAXPRI Maximum
11550 * allowed watcher priority. Bit masks of (received) events:
11551 *
11552 * Ev::READ The file descriptor in the EvIo watcher has become readable.
11553 * Ev::WRITE The file descriptor in the EvIo watcher has become writable.
11554 * Ev::TIMER EvTimer watcher has been timed out. Ev::PERIODIC EvPeriodic
11555 * watcher has been timed out. Ev::SIGNAL A signal specified in
11556 * EvSignal::__construct has been received. Ev::CHILD The {@link pid}
11557 * specified in EvChild::__construct has received a status change.
11558 * Ev::STAT The path specified in EvStat watcher changed its attributes.
11559 * Ev::IDLE EvIdle watcher works when there is nothing to do with other
11560 * watchers. Ev::PREPARE All EvPrepare watchers are invoked just before
11561 * Ev::run starts. Thus, EvPrepare watchers are the last watchers invoked
11562 * before the event loop sleeps or polls for new events. Ev::CHECK All
11563 * EvCheck watchers are queued just after Ev::run has gathered the new
11564 * events, but before it queues any callbacks for any received events.
11565 * Thus, EvCheck watchers will be invoked before any other watchers of
11566 * the same or lower priority within an event loop iteration. Ev::EMBED
11567 * The embedded event loop specified in the EvEmbed watcher needs
11568 * attention. Ev::CUSTOM Not ever sent(or otherwise used) by libev
11569 * itself, but can be freely used by libev users to signal watchers (e.g.
11570 * via EvWatcher::feed ). Ev::ERROR An unspecified error has occurred,
11571 * the watcher has been stopped. This might happen because the watcher
11572 * could not be properly started because libev ran out of memory, a file
11573 * descriptor was found to be closed or any other problem. Libev
11574 * considers these application bugs. See also ANATOMY OF A WATCHER
11575 * Backend flags:
11576 *
11577 * Ev::BACKEND_SELECT select(2) backend Ev::BACKEND_POLL poll(2) backend
11578 * Ev::BACKEND_EPOLL Linux-specific epoll(7) backend for both pre- and
11579 * post-2.6.9 kernels Ev::BACKEND_KQUEUE kqueue backend used on most BSD
11580 * systems. EvEmbed watcher could be used to embed one loop(with kqueue
11581 * backend) into another. For instance, one can try to create an event
11582 * loop with kqueue backend and use it for sockets only.
11583 * Ev::BACKEND_DEVPOLL Solaris 8 backend. This is not implemented yet.
11584 * Ev::BACKEND_PORT Solaris 10 event port mechanism with a good scaling.
11585 * Ev::BACKEND_ALL Try all backends(even currupted ones). It's not
11586 * recommended to use it explicitly. Bitwise operators should be applied
11587 * here(e.g. Ev::BACKEND_ALL & ~ Ev::BACKEND_KQUEUE ) Use
11588 * Ev::recommendedBackends , or don't specify any backends at all.
11589 * Ev::BACKEND_MASK Not a backend, but a mask to select all backend bits
11590 * from {@link flags} value to mask out any backends(e.g. when modifying
11591 * the LIBEV_FLAGS environment variable).
11592 **/
11593final class Ev {
11594    /**
11595     * @var integer
11596     **/
11597    const BACKEND_ALL = 0;
11598
11599    /**
11600     * @var integer
11601     **/
11602    const BACKEND_DEVPOLL = 0;
11603
11604    /**
11605     * @var integer
11606     **/
11607    const BACKEND_EPOLL = 0;
11608
11609    /**
11610     * @var integer
11611     **/
11612    const BACKEND_KQUEUE = 0;
11613
11614    /**
11615     * @var integer
11616     **/
11617    const BACKEND_MASK = 0;
11618
11619    /**
11620     * @var integer
11621     **/
11622    const BACKEND_POLL = 0;
11623
11624    /**
11625     * @var integer
11626     **/
11627    const BACKEND_PORT = 0;
11628
11629    /**
11630     * @var integer
11631     **/
11632    const BACKEND_SELECT = 0;
11633
11634    /**
11635     * @var integer
11636     **/
11637    const BREAK_ALL = 0;
11638
11639    /**
11640     * @var integer
11641     **/
11642    const BREAK_CANCEL = 0;
11643
11644    /**
11645     * @var integer
11646     **/
11647    const BREAK_ONE = 0;
11648
11649    /**
11650     * All EvCheck watchers are queued just after Ev::run has gathered the
11651     * new events, but before it queues any callbacks for any received
11652     * events. Thus, EvCheck watchers will be invoked before any other
11653     * watchers of the same or lower priority within an event loop iteration.
11654     *
11655     * @var integer
11656     **/
11657    const CHECK = 0;
11658
11659    /**
11660     * The {@link pid} specified in EvChild::__construct has received a
11661     * status change.
11662     *
11663     * @var integer
11664     **/
11665    const CHILD = 0;
11666
11667    /**
11668     * Not ever sent(or otherwise used) by libev itself, but can be freely
11669     * used by libev users to signal watchers (e.g. via EvWatcher::feed ).
11670     *
11671     * @var integer
11672     **/
11673    const CUSTOM = 0;
11674
11675    /**
11676     * The embedded event loop specified in the EvEmbed watcher needs
11677     * attention.
11678     *
11679     * @var integer
11680     **/
11681    const EMBED = 0;
11682
11683    /**
11684     * An unspecified error has occurred, the watcher has been stopped. This
11685     * might happen because the watcher could not be properly started because
11686     * libev ran out of memory, a file descriptor was found to be closed or
11687     * any other problem. Libev considers these application bugs. See also
11688     * ANATOMY OF A WATCHER
11689     *
11690     * @var integer
11691     **/
11692    const ERROR = 0;
11693
11694    /**
11695     * @var integer
11696     **/
11697    const FLAG_AUTO = 0;
11698
11699    /**
11700     * @var integer
11701     **/
11702    const FLAG_FORKCHECK = 0;
11703
11704    /**
11705     * @var integer
11706     **/
11707    const FLAG_NOENV = 0;
11708
11709    /**
11710     * @var integer
11711     **/
11712    const FLAG_NOINOTIFY = 0;
11713
11714    /**
11715     * @var integer
11716     **/
11717    const FLAG_NOSIGMASK = 0;
11718
11719    /**
11720     * @var integer
11721     **/
11722    const FLAG_SIGNALFD = 0;
11723
11724    /**
11725     * EvIdle watcher works when there is nothing to do with other watchers.
11726     *
11727     * @var integer
11728     **/
11729    const IDLE = 0;
11730
11731    /**
11732     * Maximum allowed watcher priority.
11733     *
11734     * @var integer
11735     **/
11736    const MAXPRI = 0;
11737
11738    /**
11739     * Minimum allowed watcher priority.
11740     *
11741     * @var integer
11742     **/
11743    const MINPRI = 0;
11744
11745    /**
11746     * EvPeriodic watcher has been timed out.
11747     *
11748     * @var integer
11749     **/
11750    const PERIODIC = 0;
11751
11752    /**
11753     * All EvPrepare watchers are invoked just before Ev::run starts. Thus,
11754     * EvPrepare watchers are the last watchers invoked before the event loop
11755     * sleeps or polls for new events.
11756     *
11757     * @var integer
11758     **/
11759    const PREPARE = 0;
11760
11761    /**
11762     * The file descriptor in the EvIo watcher has become readable.
11763     *
11764     * @var integer
11765     **/
11766    const READ = 0;
11767
11768    /**
11769     * @var integer
11770     **/
11771    const RUN_NOWAIT = 0;
11772
11773    /**
11774     * @var integer
11775     **/
11776    const RUN_ONCE = 0;
11777
11778    /**
11779     * A signal specified in EvSignal::__construct has been received.
11780     *
11781     * @var integer
11782     **/
11783    const SIGNAL = 0;
11784
11785    /**
11786     * The path specified in EvStat watcher changed its attributes.
11787     *
11788     * @var integer
11789     **/
11790    const STAT = 0;
11791
11792    /**
11793     * EvTimer watcher has been timed out.
11794     *
11795     * @var integer
11796     **/
11797    const TIMER = 0;
11798
11799    /**
11800     * The file descriptor in the EvIo watcher has become writable.
11801     *
11802     * @var integer
11803     **/
11804    const WRITE = 0;
11805
11806    /**
11807     * Returns an integer describing the backend used by libev
11808     *
11809     * Returns an integer describing the backend used by libev . See Backend
11810     * flags
11811     *
11812     * @return int Returns an integer(bit mask) describing the backend used
11813     *   by libev .
11814     * @since PECL ev >= 0.2.0
11815     **/
11816    final public static function backend(){}
11817
11818    /**
11819     * Returns recursion depth
11820     *
11821     * The number of times Ev::run was entered minus the number of times
11822     * Ev::run was exited normally, in other words, the recursion depth.
11823     * Outside Ev::run , this number is 0 . In a callback, this number is 1 ,
11824     * unless Ev::run was invoked recursively (or from another thread), in
11825     * which case it is higher.
11826     *
11827     * @return int {@link ev_depth} returns recursion depth of the default
11828     *   loop.
11829     * @since PECL ev >= 0.2.0
11830     **/
11831    final public static function depth(){}
11832
11833    /**
11834     * Returns the set of backends that are embeddable in other event loops
11835     *
11836     * @return int Returns a bit mask which can containing backend flags
11837     *   combined using bitwise OR operator.
11838     * @since PECL ev >= 0.2.0
11839     **/
11840    final public static function embeddableBackends(){}
11841
11842    /**
11843     * Feed a signal event info Ev
11844     *
11845     * Simulates a signal receive. It is safe to call this function at any
11846     * time, from any context, including signal handlers or random threads.
11847     * Its main use is to customise signal handling in the process.
11848     *
11849     * Unlike Ev::feedSignalEvent , this works regardless of which loop has
11850     * registered the signal.
11851     *
11852     * @param int $signum Signal number. See signal(7) man page for detals.
11853     *   You can use constants exported by pcntl extension.
11854     * @return void
11855     * @since PECL ev >= 0.2.0
11856     **/
11857    final public static function feedSignal($signum){}
11858
11859    /**
11860     * Feed signal event into the default loop
11861     *
11862     * Feed signal event into the default loop. Ev will react to this call as
11863     * if the signal specified by {@link signal} had occurred.
11864     *
11865     * @param int $signum Signal number. See signal(7) man page for detals.
11866     *   See also constants exported by pcntl extension.
11867     * @return void
11868     **/
11869    final public static function feedSignalEvent($signum){}
11870
11871    /**
11872     * Return the number of times the default event loop has polled for new
11873     * events
11874     *
11875     * Return the number of times the event loop has polled for new events.
11876     * Sometimes useful as a generation counter.
11877     *
11878     * @return int Returns number of polls of the default event loop.
11879     * @since PECL ev >= 0.2.0
11880     **/
11881    final public static function iteration(){}
11882
11883    /**
11884     * Returns the time when the last iteration of the default event loop has
11885     * started
11886     *
11887     * Returns the time when the last iteration of the default event loop has
11888     * started. This is the time that timers( EvTimer and EvPeriodic ) are
11889     * based on, and referring to it is usually faster then calling Ev::time
11890     * .
11891     *
11892     * @return float Returns number of seconds(fractional) representing the
11893     *   time when the last iteration of the default event loop has started.
11894     * @since PECL ev >= 0.2.0
11895     **/
11896    final public static function now(){}
11897
11898    /**
11899     * Establishes the current time by querying the kernel, updating the time
11900     * returned by Ev::now in the progress
11901     *
11902     * Establishes the current time by querying the kernel, updating the time
11903     * returned by Ev::now in the progress. This is a costly operation and is
11904     * usually done automatically within Ev::run .
11905     *
11906     * This method is rarely useful, but when some event callback runs for a
11907     * very long time without entering the event loop, updating libev 's
11908     * consideration of the current time is a good idea.
11909     *
11910     * @return void
11911     * @since PECL ev >= 0.2.0
11912     **/
11913    final public static function nowUpdate(){}
11914
11915    /**
11916     * Returns a bit mask of recommended backends for current platform
11917     *
11918     * Returns the set of all backends compiled into this binary of libev and
11919     * also recommended for this platform, meaning it will work for most file
11920     * descriptor types. This set is often smaller than the one returned by
11921     * {@link ev_supported_backends} , as for example kqueue is broken on
11922     * most BSD systems and will not be auto-detected unless it is requested
11923     * explicitly. This is the set of backends that libev will probe no
11924     * backends specified explicitly.
11925     *
11926     * @return int Returns a bit mask which can containing backend flags
11927     *   combined using bitwise OR operator.
11928     * @since PECL ev >= 0.2.0
11929     **/
11930    final public static function recommendedBackends(){}
11931
11932    /**
11933     * Resume previously suspended default event loop
11934     *
11935     * Ev::suspend and Ev::resume methods suspend and resume a loop
11936     * correspondingly.
11937     *
11938     * All timer watchers will be delayed by the time spend between suspend
11939     * and resume , and all periodic watchers will be rescheduled(that is,
11940     * they will lose any events that would have occurred while suspended).
11941     *
11942     * After calling Ev::suspend it is not allowed to call any function on
11943     * the given loop other than Ev::resume . Also it is not allowed to call
11944     * Ev::resume without a previous call to Ev::suspend .
11945     *
11946     * Calling suspend / resume has the side effect of updating the event
11947     * loop time(see Ev::nowUpdate ).
11948     *
11949     * @return void
11950     * @since PECL ev >= 0.2.0
11951     **/
11952    final public static function resume(){}
11953
11954    /**
11955     * Begin checking for events and calling callbacks for the default loop
11956     *
11957     * Begin checking for events and calling callbacks for the default loop .
11958     * Returns when a callback calls Ev::stop method, or the flags are
11959     * nonzero(in which case the return value is true) or when there are no
11960     * active watchers which reference the loop( EvWatcher::keepalive is
11961     * TRUE), in which case the return value will be FALSE. The return value
11962     * can generally be interpreted as if TRUE, there is more work left to do
11963     * .
11964     *
11965     * @param int $flags Optional parameter {@link flags} can be one of the
11966     *   following: List for possible values of {@link flags} {@link flags}
11967     *   Description 0 The default behavior described above Ev::RUN_ONCE
11968     *   Block at most one(wait, but don't loop) Ev::RUN_NOWAIT Don't block
11969     *   at all(fetch/handle events, but don't wait) See the run flag
11970     *   constants .
11971     * @return void
11972     * @since PECL ev >= 0.2.0
11973     **/
11974    final public static function run($flags){}
11975
11976    /**
11977     * Block the process for the given number of seconds
11978     *
11979     * @param float $seconds Fractional number of seconds
11980     * @return void
11981     * @since PECL ev >= 0.2.0
11982     **/
11983    final public static function sleep($seconds){}
11984
11985    /**
11986     * Stops the default event loop
11987     *
11988     * @param int $how One of Ev::BREAK_* constants .
11989     * @return void
11990     * @since PECL ev >= 0.2.0
11991     **/
11992    final public static function stop($how){}
11993
11994    /**
11995     * Returns the set of backends supported by current libev configuration
11996     *
11997     * Returns the set of backends supported by current libev configuration.
11998     *
11999     * @return int Returns a bit mask which can containing backend flags
12000     *   combined using bitwise OR operator.
12001     * @since PECL ev >= 0.2.0
12002     **/
12003    final public static function supportedBackends(){}
12004
12005    /**
12006     * Suspend the default event loop
12007     *
12008     * Ev::suspend and Ev::resume methods suspend and resume the default loop
12009     * correspondingly.
12010     *
12011     * All timer watchers will be delayed by the time spend between suspend
12012     * and resume , and all periodic watchers will be rescheduled(that is,
12013     * they will lose any events that would have occurred while suspended).
12014     *
12015     * After calling Ev::suspend it is not allowed to call any function on
12016     * the given loop other than Ev::resume . Also it is not allowed to call
12017     * Ev::resume without a previous call to Ev::suspend .
12018     *
12019     * @return void
12020     * @since PECL ev >= 0.2.0
12021     **/
12022    final public static function suspend(){}
12023
12024    /**
12025     * Returns the current time in fractional seconds since the epoch
12026     *
12027     * Returns the current time in fractional seconds since the epoch.
12028     * Consider using Ev::now
12029     *
12030     * @return float Returns the current time in fractional seconds since
12031     *   the epoch.
12032     * @since PECL ev >= 0.2.0
12033     **/
12034    final public static function time(){}
12035
12036    /**
12037     * Performs internal consistency checks(for debugging)
12038     *
12039     * Performs internal consistency checks(for debugging libev ) and abort
12040     * the program if any data structures were found to be corrupted.
12041     *
12042     * @return void
12043     * @since PECL ev >= 0.2.0
12044     **/
12045    final public static function verify(){}
12046
12047}
12048/**
12049 * EvPrepare and EvCheck watchers are usually used in pairs. EvPrepare
12050 * watchers get invoked before the process blocks, EvCheck afterwards. It
12051 * is not allowed to call EvLoop::run or similar methods or functions
12052 * that enter the current event loop from either EvPrepare or EvCheck
12053 * watchers. Other loops than the current one are fine, however. The
12054 * rationale behind this is that one dont need to check for recursion in
12055 * those watchers, i.e. the sequence will always be: EvPrepare ->
12056 * blocking -> EvCheck , so having a watcher of each kind they will
12057 * always be called in pairs bracketing the blocking call. The main
12058 * purpose is to integrate other event mechanisms into libev and their
12059 * use is somewhat advanced. They could be used, for example, to track
12060 * variable changes, implement custom watchers, integrate net-snmp or a
12061 * coroutine library and lots more. They are also occasionally useful to
12062 * cache some data and want to flush it before blocking. It is
12063 * recommended to give EvCheck watchers highest( Ev::MAXPRI ) priority,
12064 * to ensure that they are being run before any other watchers after the
12065 * poll (this doesn’t matter for EvPrepare watchers). Also, EvCheck
12066 * watchers should not activate/feed events. While libev fully supports
12067 * this, they might get executed before other EvCheck watchers did their
12068 * job.
12069 **/
12070class EvCheck extends EvWatcher {
12071    /**
12072     * Create instance of a stopped EvCheck watcher
12073     *
12074     * @param string $callback See Watcher callbacks .
12075     * @param string $data Custom data associated with the watcher.
12076     * @param string $priority Watcher priority
12077     * @return object Returns EvCheck object on success.
12078     * @since PECL ev >= 0.2.0
12079     **/
12080    final public static function createStopped($callback, $data, $priority){}
12081
12082    /**
12083     * Constructs the EvCheck watcher object
12084     *
12085     * Constructs the EvCheck watcher object.
12086     *
12087     * @param callable $callback See Watcher callbacks .
12088     * @param mixed $data Custom data associated with the watcher.
12089     * @param int $priority Watcher priority
12090     * @since PECL ev >= 0.2.0
12091     **/
12092    public function __construct($callback, $data, $priority){}
12093
12094}
12095/**
12096 * EvChild watchers trigger when the process receives a SIGCHLD in
12097 * response to some child status changes (most typically when a child
12098 * dies or exits). It is permissible to install an EvChild watcher after
12099 * the child has been forked(which implies it might have already exited),
12100 * as long as the event loop isn't entered(or is continued from a
12101 * watcher), i.e. forking and then immediately registering a watcher for
12102 * the child is fine, but forking and registering a watcher a few event
12103 * loop iterations later or in the next callback invocation is not. It is
12104 * allowed to register EvChild watchers in the default loop only.
12105 **/
12106class EvChild extends EvWatcher {
12107    /**
12108     * Readonly . The process ID this watcher watches out for, or 0 , meaning
12109     * any process ID.
12110     *
12111     * @var mixed
12112     **/
12113    public $pid;
12114
12115    /**
12116     * Readonly .The process ID that detected a status change.
12117     *
12118     * @var mixed
12119     **/
12120    public $rpid;
12121
12122    /**
12123     * Readonly . The process exit status caused by rpid .
12124     *
12125     * @var mixed
12126     **/
12127    public $rstatus;
12128
12129    /**
12130     * Create instance of a stopped EvCheck watcher
12131     *
12132     * The same as EvChild::__construct , but doesn't start the watcher
12133     * automatically.
12134     *
12135     * @param int $pid The same as for EvChild::__construct
12136     * @param bool $trace The same as for EvChild::__construct
12137     * @param callable $callback See Watcher callbacks .
12138     * @param mixed $data Custom data associated with the watcher.
12139     * @param int $priority Watcher priority
12140     * @return object
12141     * @since PECL ev >= 0.2.0
12142     **/
12143    final public static function createStopped($pid, $trace, $callback, $data, $priority){}
12144
12145    /**
12146     * Configures the watcher
12147     *
12148     * @param int $pid The same as for EvChild::__construct
12149     * @param bool $trace The same as for EvChild::__construct
12150     * @return void
12151     * @since PECL ev >= 0.2.0
12152     **/
12153    public function set($pid, $trace){}
12154
12155    /**
12156     * Constructs the EvChild watcher object
12157     *
12158     * Constructs the EvChild watcher object.
12159     *
12160     * Call the callback when a status change for process ID {@link pid} (or
12161     * any PID if {@link pid} is 0 ) has been received(a status change
12162     * happens when the process terminates or is killed, or, when {@link
12163     * trace} is TRUE, additionally when it is stopped or continued). In
12164     * other words, when the process receives a SIGCHLD , Ev will fetch the
12165     * outstanding exit/wait status for all changed/zombie children and call
12166     * the callback.
12167     *
12168     * It is valid to install a child watcher after an EvChild has exited but
12169     * before the event loop has started its next iteration. For example,
12170     * first one calls fork , then the new child process might exit, and only
12171     * then an EvChild watcher is installed in the parent for the new PID .
12172     *
12173     * You can access both exit/tracing status and {@link pid} by using the
12174     * rstatus and rpid properties of the watcher object.
12175     *
12176     * The number of PID watchers per PID is unlimited. All of them will be
12177     * called.
12178     *
12179     * The EvChild::createStopped method doesnt start(activate) the newly
12180     * created watcher.
12181     *
12182     * @param int $pid Wait for status changes of process PID(or any
12183     *   process if PID is specified as 0 ).
12184     * @param bool $trace If FALSE, only activate the watcher when the
12185     *   process terminates. Otherwise(TRUE) additionally activate the
12186     *   watcher when the process is stopped or continued.
12187     * @param callable $callback See Watcher callbacks .
12188     * @param mixed $data Custom data associated with the watcher.
12189     * @param int $priority Watcher priority
12190     * @since PECL ev >= 0.2.0
12191     **/
12192    public function __construct($pid, $trace, $callback, $data, $priority){}
12193
12194}
12195/**
12196 * Used to embed one event loop into another.
12197 **/
12198class EvEmbed extends EvWatcher {
12199    /**
12200     * @var mixed
12201     **/
12202    public $embed;
12203
12204    /**
12205     * Create stopped EvEmbed watcher object
12206     *
12207     * The same as EvEmbed::__construct , but doesn't start the watcher
12208     * automatically.
12209     *
12210     * @param object $other The same as for EvEmbed::__construct
12211     * @param callable $callback See Watcher callbacks .
12212     * @param mixed $data Custom data associated with the watcher.
12213     * @param int $priority Watcher priority
12214     * @return void Returns stopped EvEmbed object on success.
12215     * @since PECL ev >= 0.2.0
12216     **/
12217    final public static function createStopped($other, $callback, $data, $priority){}
12218
12219    /**
12220     * Configures the watcher
12221     *
12222     * Configures the watcher to use {@link other} event loop object.
12223     *
12224     * @param object $other The same as for EvEmbed::__construct
12225     * @return void
12226     * @since PECL ev >= 0.2.0
12227     **/
12228    public function set($other){}
12229
12230    /**
12231     * Make a single, non-blocking sweep over the embedded loop
12232     *
12233     * Make a single, non-blocking sweep over the embedded loop. Works
12234     * similarly to the following, but in the most appropriate way for
12235     * embedded loops:
12236     *
12237     * <?php $other->start(Ev::RUN_NOWAIT); ?>
12238     *
12239     * @return void
12240     * @since PECL ev >= 0.2.0
12241     **/
12242    public function sweep(){}
12243
12244    /**
12245     * Constructs the EvEmbed object
12246     *
12247     * This is a rather advanced watcher type that lets to embed one event
12248     * loop into another(currently only IO events are supported in the
12249     * embedded loop, other types of watchers might be handled in a delayed
12250     * or incorrect fashion and must not be used).
12251     *
12252     * See the libev documentation for details.
12253     *
12254     * This watcher is most useful on BSD systems without working kqueue to
12255     * still be able to handle a large number of sockets. See example below.
12256     *
12257     * @param object $other Instance of EvLoop . The loop to embed, this
12258     *   loop must be embeddable(see Ev::embeddableBackends ).
12259     * @param callable $callback See Watcher callbacks .
12260     * @param mixed $data Custom data associated with the watcher.
12261     * @param int $priority Watcher priority
12262     * @since PECL ev >= 0.2.0
12263     **/
12264    public function __construct($other, $callback, $data, $priority){}
12265
12266}
12267/**
12268 * Event class represents and event firing on a file descriptor being
12269 * ready to read from or write to; a file descriptor becoming ready to
12270 * read from or write to(edge-triggered I/O only); a timeout expiring; a
12271 * signal occuring; a user-triggered event. Every event is associated
12272 * with EventBase . However, event will never fire until it is added (via
12273 * Event::add ). An added event remains in pending state until the
12274 * registered event occurs, thus turning it to active state. To handle
12275 * events user may register a callback which is called when event becomes
12276 * active. If event is configured persistent , it remains pending. If it
12277 * is not persistent, it stops being pending when it's callback runs.
12278 * Event::del method deletes event, thus making it non-pending. By means
12279 * of Event::add method it could be added again.
12280 **/
12281final class Event {
12282    /**
12283     * Indicates that the event should be edge-triggered, if the underlying
12284     * event base backend supports edge-triggered events. This affects the
12285     * semantics of Event::READ and Event::WRITE .
12286     *
12287     * @var integer
12288     **/
12289    const ET = 0;
12290
12291    /**
12292     * Indicates that the event is persistent. See About event persistence .
12293     *
12294     * @var integer
12295     **/
12296    const PERSIST = 0;
12297
12298    /**
12299     * This flag indicates an event that becomes active when the provided
12300     * file descriptor(usually a stream resource, or socket) is ready for
12301     * reading.
12302     *
12303     * @var integer
12304     **/
12305    const READ = 0;
12306
12307    /**
12308     * Used to implement signal detection. See "Constructing signal events"
12309     * below.
12310     *
12311     * @var integer
12312     **/
12313    const SIGNAL = 0;
12314
12315    /**
12316     * This flag indicates an event that becomes active after a timeout
12317     * elapses.
12318     *
12319     * The Event::TIMEOUT flag is ignored when constructing an event: one can
12320     * either set a timeout when event is added , or not. It is set in the
12321     * $what argument to the callback function when a timeout has occurred.
12322     *
12323     * @var integer
12324     **/
12325    const TIMEOUT = 0;
12326
12327    /**
12328     * This flag indicates an event that becomes active when the provided
12329     * file descriptor(usually a stream resource, or socket) is ready for
12330     * reading.
12331     *
12332     * @var integer
12333     **/
12334    const WRITE = 0;
12335
12336    /**
12337     * Whether event is pending. See About event persistence .
12338     *
12339     * @var bool
12340     **/
12341    public $pending;
12342
12343    /**
12344     * Makes event pending
12345     *
12346     * Marks event pending. Non-pending event will never occur, and the event
12347     * callback will never be called. In conjuction with Event::del an event
12348     * could be re-scheduled by user at any time.
12349     *
12350     * If Event::add is called on an already pending event, libevent will
12351     * leave it pending and re-schedule it with the given timeout(if
12352     * specified). If in this case timeout is not specified, Event::add has
12353     * no effect.
12354     *
12355     * @param float $timeout Timeout in seconds.
12356     * @return bool Returns TRUE on success. Otherwise FALSE
12357     * @since PECL event >= 1.2.6-beta
12358     **/
12359    public function add($timeout){}
12360
12361    /**
12362     * Makes signal event pending
12363     *
12364     * Event::addSignal is an alias of Event::add
12365     *
12366     * @param float $timeout
12367     * @return bool
12368     * @since PECL event >= 1.2.6-beta
12369     **/
12370    public function addSignal($timeout){}
12371
12372    /**
12373     * Makes timer event pending
12374     *
12375     * Event::addTimer is an alias of Event::add
12376     *
12377     * @param float $timeout
12378     * @return bool
12379     * @since PECL event >= 1.2.6-beta
12380     **/
12381    public function addTimer($timeout){}
12382
12383    /**
12384     * Makes event non-pending
12385     *
12386     * Removes an event from the set of monitored events, i.e. makes it
12387     * non-pending.
12388     *
12389     * @return bool Returns TRUE on success. Otherwise FALSE
12390     * @since PECL event >= 1.2.6-beta
12391     **/
12392    public function del(){}
12393
12394    /**
12395     * Makes signal event non-pending
12396     *
12397     * Event::delSignal is an alias of Event::del
12398     *
12399     * @return bool
12400     * @since PECL event >= 1.2.6-beta
12401     **/
12402    public function delSignal(){}
12403
12404    /**
12405     * Makes timer event non-pending
12406     *
12407     * Event::delTimer is an alias of Event::del .
12408     *
12409     * @return bool
12410     * @since PECL event >= 1.2.6-beta
12411     **/
12412    public function delTimer(){}
12413
12414    /**
12415     * Make event non-pending and free resources allocated for this event
12416     *
12417     * Removes event from the list of events monitored by libevent, and free
12418     * resources allocated for the event.
12419     *
12420     * @return void
12421     * @since PECL event >= 1.2.6-beta
12422     **/
12423    public function free(){}
12424
12425    /**
12426     * Returns array with of the names of the methods supported in this
12427     * version of Libevent
12428     *
12429     * Returns array with of the names of the methods(backends) supported in
12430     * this version of Libevent.
12431     *
12432     * @return array Returns array.
12433     * @since PECL event >= 1.2.6-beta
12434     **/
12435    public static function getSupportedMethods(){}
12436
12437    /**
12438     * Detects whether event is pending or scheduled
12439     *
12440     * @param int $flags One of, or a composition of the following
12441     *   constants: Event::READ , Event::WRITE , Event::TIMEOUT ,
12442     *   Event::SIGNAL .
12443     * @return bool Returns TRUE if event is pending or scheduled.
12444     *   Otherwise FALSE.
12445     * @since PECL event >= 1.2.6-beta
12446     **/
12447    public function pending($flags){}
12448
12449    /**
12450     * Re-configures event
12451     *
12452     * Re-configures event. Note, this function doesn't invoke obsolete
12453     * libevent's event_set. It calls event_assign instead.
12454     *
12455     * @param EventBase $base The event base to associate the event with.
12456     * @param mixed $fd Stream resource, socket resource, or numeric file
12457     *   descriptor. For timer events pass -1 . For signal events pass the
12458     *   signal number, e.g. SIGHUP .
12459     * @param int $what See Event flags .
12460     * @param callable $cb The event callback. See Event callbacks .
12461     * @param mixed $arg Custom data associated with the event. It will be
12462     *   passed to the callback when the event becomes active.
12463     * @return bool Returns TRUE on success. Otherwise FALSE.
12464     * @since PECL event >= 1.2.6-beta
12465     **/
12466    public function set($base, $fd, $what, $cb, $arg){}
12467
12468    /**
12469     * Set event priority
12470     *
12471     * @param int $priority The event priority.
12472     * @return bool Returns TRUE on success. Otherwise FALSE.
12473     * @since PECL event >= 1.2.6-beta
12474     **/
12475    public function setPriority($priority){}
12476
12477    /**
12478     * Re-configures timer event
12479     *
12480     * Re-configures timer event. Note, this function doesn't invoke obsolete
12481     * libevent's event_set . It calls event_assign instead.
12482     *
12483     * @param EventBase $base The event base to associate with.
12484     * @param callable $cb The timer event callback. See Event callbacks .
12485     * @param mixed $arg Custom data. If specified, it will be passed to
12486     *   the callback when event triggers.
12487     * @return bool Returns TRUE on success. Otherwise FALSE.
12488     * @since PECL event >= 1.2.6-beta
12489     **/
12490    public function setTimer($base, $cb, $arg){}
12491
12492    /**
12493     * Constructs signal event object
12494     *
12495     * Constructs signal event object. This is a straightforward method to
12496     * create a signal event. Note, the generic Event::__construct method can
12497     * contruct signal event objects too.
12498     *
12499     * @param EventBase $base The associated event base object.
12500     * @param int $signum The signal number.
12501     * @param callable $cb The signal event callback. See Event callbacks .
12502     * @param mixed $arg Custom data. If specified, it will be passed to
12503     *   the callback when event triggers.
12504     * @return Event Returns Event object on success. Otherwise FALSE.
12505     * @since PECL event >= 1.2.6-beta
12506     **/
12507    public static function signal($base, $signum, $cb, $arg){}
12508
12509    /**
12510     * Constructs timer event object
12511     *
12512     * Constructs timer event object. This is a straightforward method to
12513     * create a timer event. Note, the generic Event::__construct method can
12514     * contruct signal event objects too.
12515     *
12516     * @param EventBase $base The associated event base object.
12517     * @param callable $cb The signal event callback. See Event callbacks .
12518     * @param mixed $arg Custom data. If specified, it will be passed to
12519     *   the callback when event triggers.
12520     * @return Event Returns Event object on success. Otherwise FALSE.
12521     * @since PECL event >= 1.2.6-beta
12522     **/
12523    public static function timer($base, $cb, $arg){}
12524
12525    /**
12526     * Constructs Event object
12527     *
12528     * @param EventBase $base The event base to associate with.
12529     * @param mixed $fd stream resource, socket resource, or numeric file
12530     *   descriptor. For timer events pass -1 . For signal events pass the
12531     *   signal number, e.g. SIGHUP .
12532     * @param int $what Event flags. See Event flags .
12533     * @param callable $cb The event callback. See Event callbacks .
12534     * @param mixed $arg Custom data. If specified, it will be passed to
12535     *   the callback when event triggers.
12536     * @since PECL event >= 1.2.6-beta
12537     **/
12538    public function __construct($base, $fd, $what, $cb, $arg){}
12539
12540}
12541/**
12542 * EventBase class represents libevent's event base structure. It holds a
12543 * set of events and can poll to determine which events are active. Each
12544 * event base has a method , or a backend that it uses to determine which
12545 * events are ready. The recognized methods are: select , poll , epoll ,
12546 * kqueue , devpoll , evport and win32 . To configure event base to use,
12547 * or avoid specific backend EventConfig class can be used.
12548 **/
12549final class EventBase {
12550    /**
12551     * @var integer
12552     **/
12553    const EPOLL_USE_CHANGELIST = 0;
12554
12555    /**
12556     * @var integer
12557     **/
12558    const LOOP_NONBLOCK = 0;
12559
12560    /**
12561     * @var integer
12562     **/
12563    const LOOP_ONCE = 0;
12564
12565    /**
12566     * Configuration flag. Do not allocate a lock for the event base, even if
12567     * we have locking set up".
12568     *
12569     * @var integer
12570     **/
12571    const NOLOCK = 0;
12572
12573    /**
12574     * @var integer
12575     **/
12576    const NO_CACHE_TIME = 0;
12577
12578    /**
12579     * @var integer
12580     **/
12581    const STARTUP_IOCP = 0;
12582
12583    /**
12584     * Dispatch pending events
12585     *
12586     * Wait for events to become active, and run their callbacks. The same as
12587     * EventBase::loop with no flags set.
12588     *
12589     * @return void Returns TRUE on success. Otherwise FALSE.
12590     * @since PECL event >= 1.2.6-beta
12591     **/
12592    public function dispatch(){}
12593
12594    /**
12595     * Stop dispatching events
12596     *
12597     * Tells event base to stop optionally after given number of seconds.
12598     *
12599     * @param float $timeout Optional number of seconds after which the
12600     *   event base should stop dispatching events.
12601     * @return bool Returns TRUE on success. Otherwise FALSE.
12602     * @since PECL event >= 1.2.6-beta
12603     **/
12604    public function exit($timeout){}
12605
12606    /**
12607     * Free resources allocated for this event base
12608     *
12609     * Deallocates resources allocated by libevent for the EventBase object.
12610     *
12611     * @return void
12612     * @since PECL event >= 1.10.0
12613     **/
12614    public function free(){}
12615
12616    /**
12617     * Returns bitmask of features supported
12618     *
12619     * @return int Returns integer representing a bitmask of supported
12620     *   features. See EventConfig::FEATURE_* constants .
12621     * @since PECL event >= 1.2.6-beta
12622     **/
12623    public function getFeatures(){}
12624
12625    /**
12626     * Returns event method in use
12627     *
12628     * @return string String representing used event method(backend).
12629     * @since PECL event >= 1.2.6-beta
12630     **/
12631    public function getMethod(){}
12632
12633    /**
12634     * Returns the current event base time
12635     *
12636     * On success returns the current time(as returned by gettimeofday() ),
12637     * looking at the cached value in base if possible, and calling
12638     * gettimeofday() or clock_gettime() as appropriate if there is no cached
12639     * time.
12640     *
12641     * @return float Returns the current event base time. On failure
12642     *   returns NULL.
12643     * @since PECL event >= 1.2.6-beta
12644     **/
12645    public function getTimeOfDayCached(){}
12646
12647    /**
12648     * Checks if the event loop was told to exit
12649     *
12650     * Checks if the event loop was told to exit by EventBase::exit .
12651     *
12652     * @return bool Returns TRUE, event loop was told to exit by
12653     *   EventBase::exit . Otherwise FALSE.
12654     * @since PECL event >= 1.2.6-beta
12655     **/
12656    public function gotExit(){}
12657
12658    /**
12659     * Checks if the event loop was told to exit
12660     *
12661     * Checks if the event loop was told to exit by EventBase::stop .
12662     *
12663     * @return bool Returns TRUE, event loop was told to stop by
12664     *   EventBase::stop . Otherwise FALSE.
12665     * @since PECL event >= 1.2.6-beta
12666     **/
12667    public function gotStop(){}
12668
12669    /**
12670     * Dispatch pending events
12671     *
12672     * Wait for events to become active, and run their callbacks.
12673     *
12674     * @param int $flags Optional flags. One of EventBase::LOOP_*
12675     *   constants. See EventBase constants .
12676     * @return bool Returns TRUE on success. Otherwise FALSE.
12677     * @since PECL event >= 1.2.6-beta
12678     **/
12679    public function loop($flags){}
12680
12681    /**
12682     * Sets number of priorities per event base
12683     *
12684     * @param int $n_priorities The number of priorities per event base.
12685     * @return bool Returns TRUE on success, otherwise FALSE.
12686     * @since PECL event >= 1.2.6-beta
12687     **/
12688    public function priorityInit($n_priorities){}
12689
12690    /**
12691     * Re-initialize event base(after a fork)
12692     *
12693     * Re-initialize event base. Should be called after a fork.
12694     *
12695     * @return bool Returns TRUE on success. Otherwise FALSE.
12696     * @since PECL event >= 1.2.6-beta
12697     **/
12698    public function reInit(){}
12699
12700    /**
12701     * Tells event_base to stop dispatching events
12702     *
12703     * @return bool Returns TRUE on success. Otherwise FALSE.
12704     * @since PECL event >= 1.2.6-beta
12705     **/
12706    public function stop(){}
12707
12708    /**
12709     * Constructs EventBase object
12710     *
12711     * @param EventConfig $cfg Optional EventConfig object.
12712     * @since PECL event >= 1.2.6-beta
12713     **/
12714    public function __construct($cfg){}
12715
12716}
12717/**
12718 * EventBuffer represents Libevent's "evbuffer", an utility functionality
12719 * for buffered I/O. Event buffers are meant to be generally useful for
12720 * doing the "buffer" part of buffered network I/O.
12721 **/
12722class EventBuffer {
12723    /**
12724     * @var integer
12725     **/
12726    const EOL_ANY = 0;
12727
12728    /**
12729     * @var integer
12730     **/
12731    const EOL_CRLF = 0;
12732
12733    /**
12734     * @var integer
12735     **/
12736    const EOL_CRLF_STRICT = 0;
12737
12738    /**
12739     * @var integer
12740     **/
12741    const EOL_LF = 0;
12742
12743    /**
12744     * @var integer
12745     **/
12746    const PTR_ADD = 0;
12747
12748    /**
12749     * @var integer
12750     **/
12751    const PTR_SET = 0;
12752
12753    /**
12754     * @var int
12755     **/
12756    public $contiguous_space;
12757
12758    /**
12759     * The number of bytes stored in an event buffer.
12760     *
12761     * @var int
12762     **/
12763    public $length;
12764
12765    /**
12766     * Append data to the end of an event buffer
12767     *
12768     * @param string $data String to be appended to the end of the buffer.
12769     * @return bool Returns TRUE on success. Otherwise FALSE.
12770     * @since PECL event >= 1.2.6-beta
12771     **/
12772    public function add($data){}
12773
12774    /**
12775     * Move all data from a buffer provided to the current instance of
12776     * EventBuffer
12777     *
12778     * Move all data from the buffer provided in {@link buf} parameter to the
12779     * end of current EventBuffer . This is a destructive add. The data from
12780     * one buffer moves into the other buffer. However, no unnecessary memory
12781     * copies occur.
12782     *
12783     * @param EventBuffer $buf The source EventBuffer object.
12784     * @return bool Returns TRUE on success. Otherwise FALSE.
12785     * @since PECL event >= 1.2.6-beta
12786     **/
12787    public function addBuffer($buf){}
12788
12789    /**
12790     * Moves the specified number of bytes from a source buffer to the end of
12791     * the current buffer
12792     *
12793     * Moves the specified number of bytes from a source buffer to the end of
12794     * the current buffer. If there are fewer number of bytes, it moves all
12795     * the bytes available from the source buffer.
12796     *
12797     * @param EventBuffer $buf Source buffer.
12798     * @param int $len
12799     * @return int Returns the number of bytes read.
12800     * @since PECL event >= 1.6.0
12801     **/
12802    public function appendFrom($buf, $len){}
12803
12804    /**
12805     * Copies out specified number of bytes from the front of the buffer
12806     *
12807     * Behaves just like EventBuffer::read , but does not drain any data from
12808     * the buffer. I.e. it copies the first {@link max_bytes} bytes from the
12809     * front of the buffer into {@link data} . If there are fewer than {@link
12810     * max_bytes} bytes available, the function copies all the bytes there
12811     * are.
12812     *
12813     * @param string $data Output string.
12814     * @param int $max_bytes The number of bytes to copy.
12815     * @return int Returns the number of bytes copied, or -1 on failure.
12816     * @since PECL event >= 1.2.6-beta
12817     **/
12818    public function copyout(&$data, $max_bytes){}
12819
12820    /**
12821     * Removes specified number of bytes from the front of the buffer without
12822     * copying it anywhere
12823     *
12824     * Behaves as EventBuffer::read , except that it does not copy the data:
12825     * it just removes it from the front of the buffer.
12826     *
12827     * @param int $len The number of bytes to remove from the buffer.
12828     * @return bool Returns TRUE on success. Otherwise FALSE.
12829     * @since PECL event >= 1.2.6-beta
12830     **/
12831    public function drain($len){}
12832
12833    /**
12834     * Enable locking on an EventBuffer so that it can safely be used by
12835     * multiple threads at the same time. When locking is enabled, the lock
12836     * will be held when callbacks are invoked. This could result in deadlock
12837     * if you aren't careful. Plan accordingly!
12838     *
12839     * @return void
12840     * @since PECL event >= 1.2.6-beta
12841     **/
12842    public function enableLocking(){}
12843
12844    /**
12845     * Reserves space in buffer
12846     *
12847     * Alters the last chunk of memory in the buffer, or adds a new chunk,
12848     * such that the buffer is now large enough to contain {@link len} bytes
12849     * without any further allocations.
12850     *
12851     * @param int $len The number of bytes to reserve for the buffer
12852     * @return bool Returns TRUE on success. Otherwise FALSE.
12853     * @since PECL event >= 1.2.6-beta
12854     **/
12855    public function expand($len){}
12856
12857    /**
12858     * Prevent calls that modify an event buffer from succeeding
12859     *
12860     * @param bool $at_front Whether to disable changes to the front or end
12861     *   of the buffer.
12862     * @return bool Returns TRUE on success. Otherwise FALSE.
12863     * @since PECL event >= 1.2.6-beta
12864     **/
12865    public function freeze($at_front){}
12866
12867    /**
12868     * Acquires a lock on buffer
12869     *
12870     * Acquires a lock on buffer. Can be used in pair with
12871     * EventBuffer::unlock to make a set of operations atomic, i.e.
12872     * thread-safe. Note, it is not needed to lock buffers for individual
12873     * operations. When locking is enabled(see EventBuffer::enableLocking ),
12874     * individual operations on event buffers are already atomic.
12875     *
12876     * @return void
12877     * @since PECL event >= 1.2.6-beta
12878     **/
12879    public function lock(){}
12880
12881    /**
12882     * Prepend data to the front of the buffer
12883     *
12884     * @param string $data String to be prepended to the front of the
12885     *   buffer.
12886     * @return bool Returns TRUE on success. Otherwise FALSE.
12887     * @since PECL event >= 1.2.6-beta
12888     **/
12889    public function prepend($data){}
12890
12891    /**
12892     * Moves all data from source buffer to the front of current buffer
12893     *
12894     * Behaves as EventBuffer::addBuffer , except that it moves data to the
12895     * front of the buffer.
12896     *
12897     * @param EventBuffer $buf Source buffer.
12898     * @return bool Returns TRUE on success. Otherwise FALSE.
12899     * @since PECL event >= 1.2.6-beta
12900     **/
12901    public function prependBuffer($buf){}
12902
12903    /**
12904     * Linearizes data within buffer and returns it's contents as a string
12905     *
12906     * "Linearizes" the first {@link size} bytes of the buffer, copying or
12907     * moving them as needed to ensure that they are all contiguous and
12908     * occupying the same chunk of memory. If size is negative, the function
12909     * linearizes the entire buffer.
12910     *
12911     * @param int $size The number of bytes required to be contiguous
12912     *   within the buffer.
12913     * @return string If {@link size} is greater than the number of bytes
12914     *   in the buffer, the function returns NULL. Otherwise,
12915     *   EventBuffer::pullup returns string.
12916     * @since PECL event >= 1.2.6-beta
12917     **/
12918    public function pullup($size){}
12919
12920    /**
12921     * Read data from a file onto the end of the buffer
12922     *
12923     * Read data from the file specified by {@link fd} onto the end of the
12924     * buffer.
12925     *
12926     * @param mixed $fd Socket resource, stream, or numeric file
12927     *   descriptor.
12928     * @param int $howmuch Maxmimum number of bytes to read.
12929     * @return int Returns the number of bytes read, or FALSE on failure.
12930     * @since PECL event >= 1.6.0
12931     **/
12932    public function read($fd, $howmuch){}
12933
12934    /**
12935     * Extracts a line from the front of the buffer
12936     *
12937     * Extracts a line from the front of the buffer and returns it in a newly
12938     * allocated string. If there is not a whole line to read, the function
12939     * returns NULL. The line terminator is not included in the copied
12940     * string.
12941     *
12942     * @param int $eol_style One of EventBuffer:EOL_* constants .
12943     * @return string On success returns the line read from the buffer,
12944     *   otherwise NULL.
12945     * @since PECL event >= 1.2.6-beta
12946     **/
12947    public function readLine($eol_style){}
12948
12949    /**
12950     * Scans the buffer for an occurrence of a string
12951     *
12952     * Scans the buffer for an occurrence of the string {@link what} . It
12953     * returns numeric position of the string, or FALSE if the string was not
12954     * found.
12955     *
12956     * If the {@link start} argument is provided, it points to the position
12957     * at which the search should begin; otherwise, the search is performed
12958     * from the start of the string. If {@link end} argument provided, the
12959     * search is performed between start and end buffer positions.
12960     *
12961     * @param string $what String to search.
12962     * @param int $start Start search position.
12963     * @param int $end End search position.
12964     * @return mixed Returns numeric position of the first occurance of the
12965     *   string in the buffer, or FALSE if string is not found.
12966     * @since PECL event >= 1.2.6-beta
12967     **/
12968    public function search($what, $start, $end){}
12969
12970    /**
12971     * Scans the buffer for an occurrence of an end of line
12972     *
12973     * Scans the buffer for an occurrence of an end of line specified by
12974     * {@link eol_style} parameter . It returns numeric position of the
12975     * string, or FALSE if the string was not found.
12976     *
12977     * If the {@link start} argument is provided, it represents the position
12978     * at which the search should begin; otherwise, the search is performed
12979     * from the start of the string. If {@link end} argument provided, the
12980     * search is performed between start and end buffer positions.
12981     *
12982     * @param int $start Start search position.
12983     * @param int $eol_style One of EventBuffer:EOL_* constants .
12984     * @return mixed Returns numeric position of the first occurance of
12985     *   end-of-line symbol in the buffer, or FALSE if not found.
12986     * @since PECL event >= 1.5.0
12987     **/
12988    public function searchEol($start, $eol_style){}
12989
12990    /**
12991     * Substracts a portion of the buffer data
12992     *
12993     * Substracts up to {@link length} bytes of the buffer data beginning at
12994     * {@link start} position.
12995     *
12996     * @param int $start The start position of data to be substracted.
12997     * @param int $length Maximum number of bytes to substract.
12998     * @return string Returns the data substracted as a string on success,
12999     *   or FALSE on failure.
13000     * @since PECL event >= 1.6.0
13001     **/
13002    public function substr($start, $length){}
13003
13004    /**
13005     * Re-enable calls that modify an event buffer
13006     *
13007     * @param bool $at_front Whether to enable events at the front or at
13008     *   the end of the buffer.
13009     * @return bool Returns TRUE on success. Otherwise FALSE.
13010     * @since PECL event >= 1.2.6-beta
13011     **/
13012    public function unfreeze($at_front){}
13013
13014    /**
13015     * Releases lock acquired by EventBuffer::lock
13016     *
13017     * Releases lock acquired by EventBuffer::lock .
13018     *
13019     * @return bool Returns TRUE on success. Otherwise FALSE.
13020     * @since PECL event >= 1.2.6-beta
13021     **/
13022    public function unlock(){}
13023
13024    /**
13025     * Write contents of the buffer to a file or socket
13026     *
13027     * Write contents of the buffer to a file descriptor. The buffer will be
13028     * drained after the bytes have been successfully written.
13029     *
13030     * @param mixed $fd Socket resource, stream or numeric file descriptor
13031     *   associated normally associated with a socket.
13032     * @param int $howmuch The maximum number of bytes to write.
13033     * @return int Returns the number of bytes written, or FALSE on error.
13034     * @since PECL event >= 1.6.0
13035     **/
13036    public function write($fd, $howmuch){}
13037
13038    /**
13039     * Constructs EventBuffer object
13040     *
13041     * @since PECL event >= 1.2.6-beta
13042     **/
13043    public function __construct(){}
13044
13045}
13046/**
13047 * Represents Libevents buffer event. Usually an application wants to
13048 * perform some amount of data buffering in addition to just responding
13049 * to events. When we want to write data, for example, the usual pattern
13050 * looks like: This buffered I/O pattern is common enough that Libevent
13051 * provides a generic mechanism for it. A "buffer event" consists of an
13052 * underlying transport (like a socket), a read buffer, and a write
13053 * buffer. Instead of regular events, which give callbacks when the
13054 * underlying transport is ready to be read or written, a buffer event
13055 * invokes its user-supplied callbacks when it has read or written enough
13056 * data.
13057 **/
13058final class EventBufferEvent {
13059    /**
13060     * Finished a requested connection on the bufferevent.
13061     *
13062     * @var integer
13063     **/
13064    const CONNECTED = 0;
13065
13066    /**
13067     * Got an end-of-file indication on the buffer event.
13068     *
13069     * @var integer
13070     **/
13071    const EOF = 0;
13072
13073    /**
13074     * An error occurred during a bufferevent operation. For more information
13075     * on what the error was, call EventUtil::getLastSocketErrno and/or
13076     * EventUtil::getLastSocketError .
13077     *
13078     * @var integer
13079     **/
13080    const ERROR = 0;
13081
13082    /**
13083     * @var integer
13084     **/
13085    const OPT_CLOSE_ON_FREE = 0;
13086
13087    /**
13088     * @var integer
13089     **/
13090    const OPT_DEFER_CALLBACKS = 0;
13091
13092    /**
13093     * @var integer
13094     **/
13095    const OPT_THREADSAFE = 0;
13096
13097    /**
13098     * @var integer
13099     **/
13100    const OPT_UNLOCK_CALLBACKS = 0;
13101
13102    /**
13103     * An event occurred during a read operation on the bufferevent. See the
13104     * other flags for which event it was.
13105     *
13106     * @var integer
13107     **/
13108    const READING = 0;
13109
13110    /**
13111     * @var integer
13112     **/
13113    const SSL_ACCEPTING = 0;
13114
13115    /**
13116     * @var integer
13117     **/
13118    const SSL_CONNECTING = 0;
13119
13120    /**
13121     * @var integer
13122     **/
13123    const SSL_OPEN = 0;
13124
13125    /**
13126     * @var integer
13127     **/
13128    const TIMEOUT = 0;
13129
13130    /**
13131     * An event occurred during a write operation on the bufferevent. See the
13132     * other flags for which event it was.
13133     *
13134     * @var integer
13135     **/
13136    const WRITING = 0;
13137
13138    /**
13139     * Numeric file descriptor associated with the buffer event. Normally
13140     * represents a bound socket. Equals to NULL, if there is no file
13141     * descriptor(socket) associated with the buffer event.
13142     *
13143     * @var integer
13144     **/
13145    public $fd;
13146
13147    /**
13148     * Underlying input buffer object( EventBuffer )
13149     *
13150     * @var EventBuffer
13151     **/
13152    public $input;
13153
13154    /**
13155     * Underlying output buffer object( EventBuffer )
13156     *
13157     * @var EventBuffer
13158     **/
13159    public $output;
13160
13161    /**
13162     * The priority of the events used to implement the buffer event.
13163     *
13164     * @var integer
13165     **/
13166    public $priority;
13167
13168    /**
13169     * Closes file descriptor associated with the current buffer event
13170     *
13171     * This method may be used in cases when the
13172     * EventBufferEvent::OPT_CLOSE_ON_FREE option is not appropriate.
13173     *
13174     * @return void
13175     * @since PECL event >= 1.10.0
13176     **/
13177    public function close(){}
13178
13179    /**
13180     * Connect buffer events file descriptor to given address or UNIX socket
13181     *
13182     * Connect buffer events file descriptor to given address(optionally with
13183     * port), or a UNIX domain socket.
13184     *
13185     * If socket is not assigned to the buffer event, this function allocates
13186     * a new socket and makes it non-blocking internally.
13187     *
13188     * To resolve DNS names(asyncronously), use EventBufferEvent::connectHost
13189     * method.
13190     *
13191     * @param string $addr Should contain an IP address with optional port
13192     *   number, or a path to UNIX domain socket. Recognized formats are:
13193     *
13194     *   [IPv6Address]:port [IPv6Address] IPv6Address IPv4Address:port
13195     *   IPv4Address unix:path
13196     *
13197     *   Note, 'unix:' prefix is currently not case sensitive.
13198     * @return bool Returns TRUE on success. Otherwise FALSE.
13199     * @since PECL event >= 1.2.6-beta
13200     **/
13201    public function connect($addr){}
13202
13203    /**
13204     * Connects to a hostname with optionally asyncronous DNS resolving
13205     *
13206     * Resolves the DNS name hostname, looking for addresses of type {@link
13207     * family} ( EventUtil::AF_* constants). If the name resolution fails, it
13208     * invokes the event callback with an error event. If it succeeds, it
13209     * launches a connection attempt just as EventBufferEvent::connect would.
13210     *
13211     * {@link dns_base} is optional. May be NULL, or an object created with
13212     * EventDnsBase::__construct . For asyncronous hostname resolving pass a
13213     * valid event dns base resource. Otherwise the hostname resolving will
13214     * block.
13215     *
13216     * @param EventDnsBase $dns_base Object of EventDnsBase in case if DNS
13217     *   is to be resolved asyncronously. Otherwise NULL.
13218     * @param string $hostname Hostname to connect to. Recognized formats
13219     *   are:
13220     *
13221     *   www.example.com (hostname) 1.2.3.4 (ipv4address) ::1 (ipv6address)
13222     *   [::1] ([ipv6address])
13223     * @param int $port Port number
13224     * @param int $family Address family. EventUtil::AF_UNSPEC ,
13225     *   EventUtil::AF_INET , or EventUtil::AF_INET6 . See EventUtil
13226     *   constants .
13227     * @return bool Returns TRUE on success. Otherwise FALSE.
13228     * @since PECL event >= 1.2.6-beta
13229     **/
13230    public function connectHost($dns_base, $hostname, $port, $family){}
13231
13232    /**
13233     * Creates two buffer events connected to each other
13234     *
13235     * Returns array of two EventBufferEvent objects connected to each other.
13236     * All the usual options are supported, except for
13237     * EventBufferEvent::OPT_CLOSE_ON_FREE , which has no effect, and
13238     * EventBufferEvent::OPT_DEFER_CALLBACKS , which is always on.
13239     *
13240     * @param EventBase $base Associated event base
13241     * @param int $options EventBufferEvent::OPT_* constants combined with
13242     *   bitwise OR operator.
13243     * @return array Returns array of two EventBufferEvent objects
13244     *   connected to each other.
13245     * @since PECL event >= 1.2.6-beta
13246     **/
13247    public static function createPair($base, $options){}
13248
13249    /**
13250     * Disable events read, write, or both on a buffer event
13251     *
13252     * Disable events Event::READ , Event::WRITE , or Event::READ |
13253     * Event::WRITE on a buffer event.
13254     *
13255     * @param int $events
13256     * @return bool Returns TRUE on success. Otherwise FALSE.
13257     * @since PECL event >= 1.2.6-beta
13258     **/
13259    public function disable($events){}
13260
13261    /**
13262     * Enable events read, write, or both on a buffer event
13263     *
13264     * Enable events Event::READ , Event::WRITE , or Event::READ |
13265     * Event::WRITE on a buffer event.
13266     *
13267     * @param int $events Event::READ , Event::WRITE , or Event::READ |
13268     *   Event::WRITE on a buffer event.
13269     * @return bool Returns TRUE on success. Otherwise FALSE.
13270     * @since PECL event >= 1.2.6-beta
13271     **/
13272    public function enable($events){}
13273
13274    /**
13275     * Free a buffer event
13276     *
13277     * Free resources allocated by buffer event.
13278     *
13279     * Usually there is no need to call this method, since normally it is
13280     * done within internal object destructors. However, sometimes we have a
13281     * long-time script allocating lots of instances, or a script with a
13282     * heavy memory usage, where we need to free resources as soon as
13283     * possible. In such cases EventBufferEvent::free may be used to protect
13284     * the script against running up to the memory_limit .
13285     *
13286     * @return void
13287     * @since PECL event >= 1.2.6-beta
13288     **/
13289    public function free(){}
13290
13291    /**
13292     * Returns string describing the last failed DNS lookup attempt
13293     *
13294     * Returns string describing the last failed DNS lookup attempt made by
13295     * EventBufferEvent::connectHost , or an empty string, if there is no DNS
13296     * error detected.
13297     *
13298     * @return string Returns a string describing DNS lookup error, or an
13299     *   empty string for no error.
13300     * @since PECL event >= 1.2.6-beta
13301     **/
13302    public function getDnsErrorString(){}
13303
13304    /**
13305     * Returns bitmask of events currently enabled on the buffer event
13306     *
13307     * @return int Returns integer representing a bitmask of events
13308     *   currently enabled on the buffer event
13309     * @since PECL event >= 1.2.6-beta
13310     **/
13311    public function getEnabled(){}
13312
13313    /**
13314     * Returns underlying input buffer associated with current buffer event
13315     *
13316     * Returns underlying input buffer associated with current buffer event.
13317     * An input buffer is a storage for data to read.
13318     *
13319     * Note, there is also input property of EventBufferEvent class.
13320     *
13321     * @return EventBuffer Returns instance of EventBuffer input buffer
13322     *   associated with current buffer event.
13323     * @since PECL event >= 1.2.6-beta
13324     **/
13325    public function getInput(){}
13326
13327    /**
13328     * Returns underlying output buffer associated with current buffer event
13329     *
13330     * Returns underlying output buffer associated with current buffer event.
13331     * An output buffer is a storage for data to be written.
13332     *
13333     * Note, there is also output property of EventBufferEvent class.
13334     *
13335     * @return EventBuffer Returns instance of EventBuffer output buffer
13336     *   associated with current buffer event.
13337     * @since PECL event >= 1.2.6-beta
13338     **/
13339    public function getOutput(){}
13340
13341    /**
13342     * Read buffers data
13343     *
13344     * Removes up to {@link size} bytes from the input buffer. Returns a
13345     * string of data read from the input buffer.
13346     *
13347     * @param int $size Maximum number of bytes to read
13348     * @return string Returns string of data read from the input buffer.
13349     * @since PECL event >= 1.2.6-beta
13350     **/
13351    public function read($size){}
13352
13353    /**
13354     * Drains the entire contents of the input buffer and places them into
13355     * buf
13356     *
13357     * Drains the entire contents of the input buffer and places them into
13358     * {@link buf} .
13359     *
13360     * @param EventBuffer $buf Target buffer
13361     * @return bool Returns TRUE on success; Otherwise FALSE.
13362     * @since PECL event >= 1.2.6-beta
13363     **/
13364    public function readBuffer($buf){}
13365
13366    /**
13367     * Assigns read, write and event(status) callbacks
13368     *
13369     * @param callable $readcb Read event callback. See About buffer event
13370     *   callbacks .
13371     * @param callable $writecb Write event callback. See About buffer
13372     *   event callbacks .
13373     * @param callable $eventcb Status-change event callback. See About
13374     *   buffer event callbacks .
13375     * @param string $arg A variable that will be passed to all the
13376     *   callbacks.
13377     * @return void
13378     * @since PECL event >= 1.2.6-beta
13379     **/
13380    public function setCallbacks($readcb, $writecb, $eventcb, $arg){}
13381
13382    /**
13383     * Assign a priority to a bufferevent
13384     *
13385     * @param int $priority Priority value.
13386     * @return bool Returns TRUE on success. Otherwise FALSE.
13387     * @since PECL event >= 1.2.6-beta
13388     **/
13389    public function setPriority($priority){}
13390
13391    /**
13392     * Set the read and write timeout for a buffer event
13393     *
13394     * @param float $timeout_read Read timeout
13395     * @param float $timeout_write Write timeout
13396     * @return bool Returns TRUE on success. Otherwise FALSE.
13397     * @since PECL event >= 1.2.6-beta
13398     **/
13399    public function setTimeouts($timeout_read, $timeout_write){}
13400
13401    /**
13402     * Adjusts read and/or write watermarks
13403     *
13404     * Adjusts the read watermarks, the write watermarks , or both, of a
13405     * single buffer event.
13406     *
13407     * A buffer event watermark is an edge, a value specifying number of
13408     * bytes to be read or written before callback is invoked. By default
13409     * every read/write event triggers a callback invokation. See Fast
13410     * portable non-blocking network programming with Libevent: Callbacks and
13411     * watermarks
13412     *
13413     * @param int $events Bitmask of Event::READ , Event::WRITE , or both.
13414     * @param int $lowmark Minimum watermark value.
13415     * @param int $highmark Maximum watermark value. 0 means "unlimited".
13416     * @return void
13417     * @since PECL event >= 1.2.6-beta
13418     **/
13419    public function setWatermark($events, $lowmark, $highmark){}
13420
13421    /**
13422     * Returns most recent OpenSSL error reported on the buffer event
13423     *
13424     * @return string Returns OpenSSL error string reported on the buffer
13425     *   event, or FALSE, if there is no more error to return.
13426     * @since PECL event >= 1.2.6-beta
13427     **/
13428    public function sslError(){}
13429
13430    /**
13431     * Create a new SSL buffer event to send its data over another buffer
13432     * event
13433     *
13434     * @param EventBase $base Associated event base.
13435     * @param EventBufferEvent $underlying A socket buffer event to use for
13436     *   this SSL.
13437     * @param EventSslContext $ctx Object of EventSslContext class.
13438     * @param int $state The current state of SSL connection:
13439     *   EventBufferEvent::SSL_OPEN , EventBufferEvent::SSL_ACCEPTING or
13440     *   EventBufferEvent::SSL_CONNECTING .
13441     * @param int $options One or more buffer event options.
13442     * @return EventBufferEvent Returns a new SSL EventBufferEvent object.
13443     * @since PECL event >= 1.2.6-beta
13444     **/
13445    public static function sslFilter($base, $underlying, $ctx, $state, $options){}
13446
13447    /**
13448     * Returns a textual description of the cipher
13449     *
13450     * Retrieves description of the current cipher by means of the
13451     * SSL_CIPHER_description SSL API function (see SSL_CIPHER_get_name(3)
13452     * man page).
13453     *
13454     * @return string Returns a textual description of the cipher on
13455     *   success, or FALSE on error.
13456     * @since PECL event >= 1.10.0
13457     **/
13458    public function sslGetCipherInfo(){}
13459
13460    /**
13461     * Returns the current cipher name of the SSL connection
13462     *
13463     * Retrieves name of cipher used by current SSL connection.
13464     *
13465     * @return string Returns the current cipher name of the SSL
13466     *   connection, or FALSE on error.
13467     * @since PECL event >= 1.10.0
13468     **/
13469    public function sslGetCipherName(){}
13470
13471    /**
13472     * Returns version of cipher used by current SSL connection
13473     *
13474     * Retrieves version of cipher used by current SSL connection.
13475     *
13476     * @return string Returns the current cipher version of the SSL
13477     *   connection, or FALSE on error.
13478     * @since PECL event >= 1.10.0
13479     **/
13480    public function sslGetCipherVersion(){}
13481
13482    /**
13483     * Returns the name of the protocol used for current SSL connection
13484     *
13485     * @return string Returns the name of the protocol used for current SSL
13486     *   connection.
13487     * @since PECL event >= 1.10.0
13488     **/
13489    public function sslGetProtocol(){}
13490
13491    /**
13492     * Tells a bufferevent to begin SSL renegotiation
13493     *
13494     * @return void
13495     * @since PECL event >= 1.2.6-beta
13496     **/
13497    public function sslRenegotiate(){}
13498
13499    /**
13500     * Creates a new SSL buffer event to send its data over an SSL on a
13501     * socket
13502     *
13503     * @param EventBase $base Associated event base.
13504     * @param mixed $socket Socket to use for this SSL. Can be stream or
13505     *   socket resource, numeric file descriptor, or NULL. If {@link socket}
13506     *   is NULL, it is assumed that the file descriptor for the socket will
13507     *   be assigned later, for instance, by means of
13508     *   EventBufferEvent::connectHost method.
13509     * @param EventSslContext $ctx Object of EventSslContext class.
13510     * @param int $state The current state of SSL connection:
13511     *   EventBufferEvent::SSL_OPEN , EventBufferEvent::SSL_ACCEPTING or
13512     *   EventBufferEvent::SSL_CONNECTING .
13513     * @param int $options The buffer event options.
13514     * @return EventBufferEvent Returns EventBufferEvent object.
13515     * @since PECL event >= 1.2.6-beta
13516     **/
13517    public static function sslSocket($base, $socket, $ctx, $state, $options){}
13518
13519    /**
13520     * Adds data to a buffer events output buffer
13521     *
13522     * Adds {@link data} to a buffer events output buffer
13523     *
13524     * @param string $data Data to be added to the underlying buffer.
13525     * @return bool Returns TRUE on success. Otherwise FALSE.
13526     * @since PECL event >= 1.2.6-beta
13527     **/
13528    public function write($data){}
13529
13530    /**
13531     * Adds contents of the entire buffer to a buffer events output buffer
13532     *
13533     * Adds contents of the entire buffer to a buffer events output buffer
13534     *
13535     * @param EventBuffer $buf Source EventBuffer object.
13536     * @return bool Returns TRUE on success. Otherwise FALSE.
13537     * @since PECL event >= 1.2.6-beta
13538     **/
13539    public function writeBuffer($buf){}
13540
13541    /**
13542     * Constructs EventBufferEvent object
13543     *
13544     * Create a buffer event on a socket, stream or a file descriptor.
13545     * Passing NULL to {@link socket} means that the socket should be created
13546     * later, e.g. by means of EventBufferEvent::connect .
13547     *
13548     * @param EventBase $base Event base that should be associated with the
13549     *   new buffer event.
13550     * @param mixed $socket May be created as a stream(not necessarily by
13551     *   means of sockets extension)
13552     * @param int $options One of EventBufferEvent::OPT_* constants , or 0
13553     *   .
13554     * @param callable $readcb Read event callback. See About buffer event
13555     *   callbacks .
13556     * @param callable $writecb Write event callback. See About buffer
13557     *   event callbacks .
13558     * @param callable $eventcb Status-change event callback. See About
13559     *   buffer event callbacks .
13560     * @since PECL event >= 1.2.6-beta
13561     **/
13562    public function __construct($base, $socket, $options, $readcb, $writecb, $eventcb){}
13563
13564}
13565/**
13566 * Represents configuration structure which could be used in construction
13567 * of the EventBase .
13568 **/
13569final class EventConfig {
13570    /**
13571     * @var integer
13572     **/
13573    const FEATURE_ET = 0;
13574
13575    /**
13576     * @var integer
13577     **/
13578    const FEATURE_FDS = 0;
13579
13580    /**
13581     * @var integer
13582     **/
13583    const FEATURE_O1 = 0;
13584
13585    /**
13586     * Tells libevent to avoid specific event method
13587     *
13588     * Tells libevent to avoid specific event method(backend). See Creating
13589     * an event base .
13590     *
13591     * @param string $method The backend method to avoid. See EventConfig
13592     *   constants .
13593     * @return bool Returns TRUE on success, otherwise FALSE.
13594     * @since PECL event >= 1.2.6-beta
13595     **/
13596    public function avoidMethod($method){}
13597
13598    /**
13599     * Enters a required event method feature that the application demands
13600     *
13601     * @param int $feature Bitmask of required features. See
13602     *   EventConfig::FEATURE_* constants
13603     * @return bool
13604     * @since PECL event >= 1.2.6-beta
13605     **/
13606    public function requireFeatures($feature){}
13607
13608    /**
13609     * Prevents priority inversion
13610     *
13611     * Prevents priority inversion by limiting how many low-priority event
13612     * callbacks can be invoked before checking for more high-priority
13613     * events.
13614     *
13615     * @param int $max_interval An interval after which Libevent should
13616     *   stop running callbacks and check for more events, or 0 , if there
13617     *   should be no such interval.
13618     * @param int $max_callbacks A number of callbacks after which Libevent
13619     *   should stop running callbacks and check for more events, or -1 , if
13620     *   there should be no such limit.
13621     * @param int $min_priority A priority below which {@link max_interval}
13622     *   and {@link max_callbacks} should not be enforced. If this is set to
13623     *   0 , they are enforced for events of every priority; if its set to 1
13624     *   , theyre enforced for events of priority 1 and above, and so on.
13625     * @return void Returns TRUE on success, otherwise FALSE.
13626     **/
13627    public function setMaxDispatchInterval($max_interval, $max_callbacks, $min_priority){}
13628
13629    /**
13630     * Constructs EventConfig object
13631     *
13632     * Constructs EventConfig object which could be passed to
13633     * EventBase::__construct constructor.
13634     *
13635     * @since PECL event >= 1.2.6-beta
13636     **/
13637    public function __construct(){}
13638
13639}
13640/**
13641 * Represents Libevents DNS base structure. Used to resolve DNS
13642 * asyncronously, parse configuration files like resolv.conf etc.
13643 **/
13644final class EventDnsBase {
13645    /**
13646     * @var integer
13647     **/
13648    const OPTIONS_ALL = 0;
13649
13650    /**
13651     * @var integer
13652     **/
13653    const OPTION_HOSTSFILE = 0;
13654
13655    /**
13656     * @var integer
13657     **/
13658    const OPTION_MISC = 0;
13659
13660    /**
13661     * @var integer
13662     **/
13663    const OPTION_NAMESERVERS = 0;
13664
13665    /**
13666     * @var integer
13667     **/
13668    const OPTION_SEARCH = 0;
13669
13670    /**
13671     * Adds a nameserver to the DNS base
13672     *
13673     * Adds a nameserver to the evdns_base.
13674     *
13675     * @param string $ip The nameserver string, either as an IPv4 address,
13676     *   an IPv6 address, an IPv4 address with a port ( IPv4:Port ), or an
13677     *   IPv6 address with a port ( [IPv6]:Port ).
13678     * @return bool Returns TRUE on success. Otherwise FALSE.
13679     * @since PECL event >= 1.2.6-beta
13680     **/
13681    public function addNameserverIp($ip){}
13682
13683    /**
13684     * Adds a domain to the list of search domains
13685     *
13686     * @param string $domain Search domain.
13687     * @return void
13688     * @since PECL event >= 1.2.6-beta
13689     **/
13690    public function addSearch($domain){}
13691
13692    /**
13693     * Removes all current search suffixes
13694     *
13695     * Removes all current search suffixes from the DNS base; the
13696     * EventDnsBase::addSearch function adds a suffix.
13697     *
13698     * @return void
13699     * @since PECL event >= 1.2.6-beta
13700     **/
13701    public function clearSearch(){}
13702
13703    /**
13704     * Gets the number of configured nameservers
13705     *
13706     * @return int Returns the number of configured nameservers(not
13707     *   necessarily the number of running nameservers). This is useful for
13708     *   double-checking whether our calls to the various nameserver
13709     *   configuration functions have been successful.
13710     * @since PECL event >= 1.2.6-beta
13711     **/
13712    public function countNameservers(){}
13713
13714    /**
13715     * Loads a hosts file (in the same format as /etc/hosts) from hosts file
13716     *
13717     * Loads a hosts file (in the same format as /etc/hosts ) from hosts
13718     * file.
13719     *
13720     * @param string $hosts Path to the hosts' file.
13721     * @return bool Returns TRUE on success. Otherwise FALSE.
13722     * @since PECL event >= 1.2.6-beta
13723     **/
13724    public function loadHosts($hosts){}
13725
13726    /**
13727     * Scans the resolv.conf-formatted file
13728     *
13729     * Scans the resolv.conf-formatted file stored in filename, and read in
13730     * all the options from it that are listed in flags
13731     *
13732     * @param int $flags Determines what information is parsed from the
13733     *   resolv.conf file. See the man page for resolv.conf for the format of
13734     *   this file. The following directives are not parsed from the file:
13735     *   sortlist, rotate, no-check-names, inet6, debug . If this function
13736     *   encounters an error, the possible return values are: 1 = failed to
13737     *   open file 2 = failed to stat file 3 = file too large 4 = out of
13738     *   memory 5 = short read from file 6 = no nameservers listed in the
13739     *   file
13740     * @param string $filename Path to resolv.conf file.
13741     * @return bool Returns TRUE on success. Otherwise FALSE.
13742     * @since PECL event >= 1.2.6-beta
13743     **/
13744    public function parseResolvConf($flags, $filename){}
13745
13746    /**
13747     * Set the value of a configuration option
13748     *
13749     * @param string $option The currently available configuration options
13750     *   are: "ndots" , "timeout" , "max-timeouts" , "max-inflight" , and
13751     *   "attempts" .
13752     * @param string $value Option value.
13753     * @return bool Returns TRUE on success. Otherwise FALSE.
13754     * @since PECL event >= 1.2.6-beta
13755     **/
13756    public function setOption($option, $value){}
13757
13758    /**
13759     * Set the 'ndots' parameter for searches
13760     *
13761     * Set the 'ndots' parameter for searches. Sets the number of dots which,
13762     * when found in a name, causes the first query to be without any search
13763     * domain.
13764     *
13765     * @param int $ndots The number of dots.
13766     * @return bool Returns TRUE on success. Otherwise FALSE.
13767     * @since PECL event >= 1.2.6-beta
13768     **/
13769    public function setSearchNdots($ndots){}
13770
13771    /**
13772     * Constructs EventDnsBase object
13773     *
13774     * @param EventBase $base Event base.
13775     * @param bool $initialize If the {@link initialize} argument is TRUE,
13776     *   it tries to configure the DNS base sensibly given your operating
13777     *   system’s default. Otherwise, it leaves the event DNS base empty,
13778     *   with no nameservers or options configured. In the latter case DNS
13779     *   base should be configured manually, e.g. with
13780     *   EventDnsBase::parseResolvConf .
13781     * @since PECL event >= 1.2.6-beta
13782     **/
13783    public function __construct($base, $initialize){}
13784
13785}
13786/**
13787 * Represents HTTP server.
13788 **/
13789final class EventHttp {
13790    /**
13791     * Makes an HTTP server accept connections on the specified socket stream
13792     * or resource
13793     *
13794     * Makes an HTTP server accept connections on the specified socket stream
13795     * or resource. The socket should be ready to accept connections.
13796     *
13797     * Can be called multiple times to accept connections on different
13798     * sockets.
13799     *
13800     * @param mixed $socket Socket resource, stream or numeric file
13801     *   descriptor representing a socket ready to accept connections.
13802     * @return bool Returns TRUE on success. Otherwise FALSE.
13803     * @since PECL event >= 1.2.6-beta
13804     **/
13805    public function accept($socket){}
13806
13807    /**
13808     * Adds a server alias to the HTTP server object
13809     *
13810     * @param string $alias The alias to add.
13811     * @return bool Returns TRUE on success. Otherwise FALSE.
13812     * @since PECL event >= 1.4.0-beta
13813     **/
13814    public function addServerAlias($alias){}
13815
13816    /**
13817     * Binds an HTTP server on the specified address and port
13818     *
13819     * Can be called multiple times to bind the same HTTP server to multiple
13820     * different ports.
13821     *
13822     * @param string $address A string containing the IP address to
13823     *   listen(2) on.
13824     * @param int $port The port number to listen on.
13825     * @return void Returns TRUE on success. Otherwise FALSE.
13826     * @since PECL event >= 1.2.6-beta
13827     **/
13828    public function bind($address, $port){}
13829
13830    /**
13831     * Removes server alias
13832     *
13833     * Removes server alias added with EventHttp::addServerAlias
13834     *
13835     * @param string $alias The alias to remove.
13836     * @return bool Returns TRUE on success. Otherwise FALSE.
13837     * @since PECL event >= 1.4.0-beta
13838     **/
13839    public function removeServerAlias($alias){}
13840
13841    /**
13842     * Sets the what HTTP methods are supported in requests accepted by this
13843     * server, and passed to user callbacks
13844     *
13845     * Sets the what HTTP methods are supported in requests accepted by this
13846     * server, and passed to user callbacks
13847     *
13848     * If not supported they will generate a "405 Method not allowed"
13849     * response.
13850     *
13851     * By default this includes the following methods: GET , POST , HEAD ,
13852     * PUT , DELETE . See EventHttpRequest::CMD_* constants.
13853     *
13854     * @param int $methods A bit mask of EventHttpRequest::CMD_* constants
13855     *   .
13856     * @return void
13857     * @since PECL event >= 1.4.0-beta
13858     **/
13859    public function setAllowedMethods($methods){}
13860
13861    /**
13862     * Sets a callback for specified URI
13863     *
13864     * @param string $path The path for which to invoke the callback.
13865     * @param string $cb The callback callable that gets invoked on
13866     *   requested {@link path} . It should match the following prototype:
13867     *
13868     *   {@link req} EventHttpRequest object. {@link arg} Custom data.
13869     * @param string $arg EventHttpRequest object.
13870     * @return void Returns TRUE on success. Otherwise FALSE.
13871     * @since PECL event >= 1.4.0-beta
13872     **/
13873    public function setCallback($path, $cb, $arg){}
13874
13875    /**
13876     * Sets default callback to handle requests that are not caught by
13877     * specific callbacks
13878     *
13879     * Sets default callback to handle requests that are not caught by
13880     * specific callbacks
13881     *
13882     * @param string $cb The callback callable . It should match the
13883     *   following prototype:
13884     *
13885     *   {@link req} EventHttpRequest object. {@link arg} Custom data.
13886     * @param string $arg EventHttpRequest object.
13887     * @return void Returns TRUE on success. Otherwise FALSE.
13888     * @since PECL event >= 1.4.0-beta
13889     **/
13890    public function setDefaultCallback($cb, $arg){}
13891
13892    /**
13893     * Sets maximum request body size
13894     *
13895     * @param int $value The body size in bytes.
13896     * @return void
13897     * @since PECL event >= 1.4.0-beta
13898     **/
13899    public function setMaxBodySize($value){}
13900
13901    /**
13902     * Sets maximum HTTP header size
13903     *
13904     * @param int $value The header size in bytes.
13905     * @return void
13906     * @since PECL event >= 1.4.0-beta
13907     **/
13908    public function setMaxHeadersSize($value){}
13909
13910    /**
13911     * Sets the timeout for an HTTP request
13912     *
13913     * @param int $value The timeout in seconds.
13914     * @return void
13915     * @since PECL event >= 1.4.0-beta
13916     **/
13917    public function setTimeout($value){}
13918
13919    /**
13920     * Constructs EventHttp object(the HTTP server)
13921     *
13922     * Constructs the HTTP server object.
13923     *
13924     * @param EventBase $base Associated event base.
13925     * @param EventSslContext $ctx EventSslContext class object. Turns
13926     *   plain HTTP server into HTTPS server. It means that if {@link ctx} is
13927     *   configured correctly, then the underlying buffer events will be
13928     *   based on OpenSSL sockets. Thus, all traffic will pass through the
13929     *   SSL or TLS.
13930     * @since PECL event >= 1.2.6-beta
13931     **/
13932    public function __construct($base, $ctx){}
13933
13934}
13935/**
13936 * Represents an HTTP connection.
13937 **/
13938class EventHttpConnection {
13939    /**
13940     * Returns event base associated with the connection
13941     *
13942     * @return EventBase On success returns EventBase object associated
13943     *   with the connection. Otherwise FALSE.
13944     * @since PECL event >= 1.2.6-beta
13945     **/
13946    public function getBase(){}
13947
13948    /**
13949     * Gets the remote address and port associated with the connection
13950     *
13951     * @param string $address Address of the peer.
13952     * @param int $port Port of the peer.
13953     * @return void
13954     * @since PECL event >= 1.2.6-beta
13955     **/
13956    public function getPeer(&$address, &$port){}
13957
13958    /**
13959     * Makes an HTTP request over the specified connection
13960     *
13961     * Makes an HTTP request over the specified connection. {@link type} is
13962     * one of EventHttpRequest::CMD_* constants.
13963     *
13964     * @param EventHttpRequest $req The connection object over which to
13965     *   send the request.
13966     * @param int $type One of EventHttpRequest::CMD_* constants .
13967     * @param string $uri The URI associated with the request.
13968     * @return bool Returns TRUE on success. Otherwise FALSE.
13969     * @since PECL event >= 1.4.0-beta
13970     **/
13971    public function makeRequest($req, $type, $uri){}
13972
13973    /**
13974     * Set callback for connection close
13975     *
13976     * Sets callback for connection close.
13977     *
13978     * @param callable $callback Callback which is called when connection
13979     *   is closed. Should match the following prototype:
13980     * @param mixed $data
13981     * @return void
13982     * @since PECL event >= 1.8.0
13983     **/
13984    public function setCloseCallback($callback, $data){}
13985
13986    /**
13987     * Sets the IP address from which HTTP connections are made
13988     *
13989     * Sets the IP address from which http connections are made.
13990     *
13991     * @param string $address The IP address from which HTTP connections
13992     *   are made.
13993     * @return void
13994     * @since PECL event >= 1.2.6-beta
13995     **/
13996    public function setLocalAddress($address){}
13997
13998    /**
13999     * Sets the local port from which connections are made
14000     *
14001     * @param int $port The port number.
14002     * @return void
14003     * @since PECL event >= 1.2.6-beta
14004     **/
14005    public function setLocalPort($port){}
14006
14007    /**
14008     * Sets maximum body size for the connection
14009     *
14010     * @param string $max_size The maximum body size in bytes.
14011     * @return void
14012     * @since PECL event >= 1.2.6-beta
14013     **/
14014    public function setMaxBodySize($max_size){}
14015
14016    /**
14017     * Sets maximum header size
14018     *
14019     * Sets maximum header size for the connection.
14020     *
14021     * @param string $max_size The maximum header size in bytes.
14022     * @return void
14023     * @since PECL event >= 1.2.6-beta
14024     **/
14025    public function setMaxHeadersSize($max_size){}
14026
14027    /**
14028     * Sets the retry limit for the connection
14029     *
14030     * @param int $retries The retry limit. -1 means infinity.
14031     * @return void
14032     * @since PECL event >= 1.2.6-beta
14033     **/
14034    public function setRetries($retries){}
14035
14036    /**
14037     * Sets the timeout for the connection
14038     *
14039     * @param int $timeout Timeout in seconds.
14040     * @return void
14041     * @since PECL event >= 1.2.6-beta
14042     **/
14043    public function setTimeout($timeout){}
14044
14045    /**
14046     * Constructs EventHttpConnection object
14047     *
14048     * @param EventBase $base Associated event base.
14049     * @param EventDnsBase $dns_base If {@link dns_base} is NULL, hostname
14050     *   resolution will block.
14051     * @param string $address The address to connect to.
14052     * @param int $port The port to connect to.
14053     * @param EventSslContext $ctx EventSslContext class object. Enables
14054     *   OpenSSL.
14055     * @since PECL event >= 1.2.6-beta
14056     **/
14057    public function __construct($base, $dns_base, $address, $port, $ctx){}
14058
14059}
14060/**
14061 * Represents an HTTP request.
14062 **/
14063class EventHttpRequest {
14064    /**
14065     * @var integer
14066     **/
14067    const CMD_CONNECT = 0;
14068
14069    /**
14070     * @var integer
14071     **/
14072    const CMD_DELETE = 0;
14073
14074    /**
14075     * @var integer
14076     **/
14077    const CMD_GET = 0;
14078
14079    /**
14080     * @var integer
14081     **/
14082    const CMD_HEAD = 0;
14083
14084    /**
14085     * @var integer
14086     **/
14087    const CMD_OPTIONS = 0;
14088
14089    /**
14090     * @var integer
14091     **/
14092    const CMD_PATCH = 0;
14093
14094    /**
14095     * @var integer
14096     **/
14097    const CMD_POST = 0;
14098
14099    /**
14100     * @var integer
14101     **/
14102    const CMD_PUT = 0;
14103
14104    /**
14105     * @var integer
14106     **/
14107    const CMD_TRACE = 0;
14108
14109    /**
14110     * @var integer
14111     **/
14112    const INPUT_HEADER = 0;
14113
14114    /**
14115     * @var integer
14116     **/
14117    const OUTPUT_HEADER = 0;
14118
14119    /**
14120     * Adds an HTTP header to the headers of the request
14121     *
14122     * @param string $key Header name.
14123     * @param string $value Header value.
14124     * @param int $type One of EventHttpRequest::*_HEADER constants .
14125     * @return bool Returns TRUE on success. Otherwise FALSE.
14126     * @since PECL event >= 1.4.0-beta
14127     **/
14128    public function addHeader($key, $value, $type){}
14129
14130    /**
14131     * Cancels a pending HTTP request
14132     *
14133     * Cancels an ongoing HTTP request. The callback associated with this
14134     * request is not executed and the request object is freed. If the
14135     * request is currently being processed, e.g. it is ongoing, the
14136     * corresponding EventHttpConnection object is going to get reset.
14137     *
14138     * A request cannot be canceled if its callback has executed already. A
14139     * request may be canceled reentrantly from its chunked callback.
14140     *
14141     * @return void
14142     * @since PECL event >= 1.4.0-beta
14143     **/
14144    public function cancel(){}
14145
14146    /**
14147     * Removes all output headers from the header list of the request
14148     *
14149     * @return void
14150     * @since PECL event >= 1.4.0-beta
14151     **/
14152    public function clearHeaders(){}
14153
14154    /**
14155     * Closes associated HTTP connection
14156     *
14157     * Closes HTTP connection associated with the request.
14158     *
14159     * @return void
14160     * @since PECL event >= 1.8.0
14161     **/
14162    public function closeConnection(){}
14163
14164    /**
14165     * Finds the value belonging a header
14166     *
14167     * @param string $key The header name.
14168     * @param string $type One of EventHttpRequest::*_HEADER constants .
14169     * @return void Returns NULL if header not found.
14170     * @since PECL event >= 1.4.0-beta
14171     **/
14172    public function findHeader($key, $type){}
14173
14174    /**
14175     * Frees the object and removes associated events
14176     *
14177     * @return void
14178     * @since PECL event >= 1.4.0-beta
14179     **/
14180    public function free(){}
14181
14182    /**
14183     * Returns the request command(method)
14184     *
14185     * Returns the request command, one of EventHttpRequest::CMD_* constants.
14186     *
14187     * @return void Returns the request command, one of
14188     *   EventHttpRequest::CMD_* constants.
14189     * @since PECL event >= 1.4.0-beta
14190     **/
14191    public function getCommand(){}
14192
14193    /**
14194     * Returns the request host
14195     *
14196     * @return string Returns the request host.
14197     * @since PECL event >= 1.4.0-beta
14198     **/
14199    public function getHost(){}
14200
14201    /**
14202     * Returns the input buffer
14203     *
14204     * @return EventBuffer Returns the input buffer.
14205     * @since PECL event >= 1.4.0-beta
14206     **/
14207    public function getInputBuffer(){}
14208
14209    /**
14210     * Returns associative array of the input headers
14211     *
14212     * @return array Returns associative array of the input headers.
14213     * @since PECL event >= 1.4.0-beta
14214     **/
14215    public function getInputHeaders(){}
14216
14217    /**
14218     * Returns the output buffer of the request
14219     *
14220     * @return EventBuffer Returns the output buffer of the request.
14221     * @since PECL event >= 1.4.0-beta
14222     **/
14223    public function getOutputBuffer(){}
14224
14225    /**
14226     * Returns associative array of the output headers
14227     *
14228     * @return void
14229     * @since PECL event >= 1.4.0-beta
14230     **/
14231    public function getOutputHeaders(){}
14232
14233    /**
14234     * Returns the response code
14235     *
14236     * @return int Returns the response code of the request.
14237     * @since PECL event >= 1.4.0-beta
14238     **/
14239    public function getResponseCode(){}
14240
14241    /**
14242     * Returns the request URI
14243     *
14244     * @return string Returns the request URI
14245     * @since PECL event >= 1.4.0-beta
14246     **/
14247    public function getUri(){}
14248
14249    /**
14250     * Removes an HTTP header from the headers of the request
14251     *
14252     * @param string $key The header name.
14253     * @param string $type {@link type} is one of
14254     *   EventHttpRequest::*_HEADER constants.
14255     * @return void Removes an HTTP header from the headers of the request.
14256     * @since PECL event >= 1.4.0-beta
14257     **/
14258    public function removeHeader($key, $type){}
14259
14260    /**
14261     * Send an HTML error message to the client
14262     *
14263     * @param int $error The HTTP error code.
14264     * @param string $reason A brief explanation ofthe error. If NULL, the
14265     *   standard meaning of the error code will be used.
14266     * @return void
14267     * @since PECL event >= 1.4.0-beta
14268     **/
14269    public function sendError($error, $reason){}
14270
14271    /**
14272     * Send an HTML reply to the client
14273     *
14274     * Send an HTML reply to the client. The body of the reply consists of
14275     * data in optional {@link buf} parameter.
14276     *
14277     * @param int $code The HTTP response code to send.
14278     * @param string $reason A brief message to send with the response
14279     *   code.
14280     * @param EventBuffer $buf The body of the response.
14281     * @return void
14282     * @since PECL event >= 1.4.0-beta
14283     **/
14284    public function sendReply($code, $reason, $buf){}
14285
14286    /**
14287     * Send another data chunk as part of an ongoing chunked reply
14288     *
14289     * Send another data chunk as part of an ongoing chunked reply. After
14290     * calling this method {@link buf} will be empty.
14291     *
14292     * @param EventBuffer $buf The data chunk to send as part of the reply.
14293     * @return void
14294     * @since PECL event >= 1.4.0-beta
14295     **/
14296    public function sendReplyChunk($buf){}
14297
14298    /**
14299     * Complete a chunked reply, freeing the request as appropriate
14300     *
14301     * @return void
14302     * @since PECL event >= 1.4.0-beta
14303     **/
14304    public function sendReplyEnd(){}
14305
14306    /**
14307     * Initiate a chunked reply
14308     *
14309     * Initiate a reply that uses Transfer-Encoding chunked .
14310     *
14311     * This allows the caller to stream the reply back to the client and is
14312     * useful when either not all of the reply data is immediately available
14313     * or when sending very large replies.
14314     *
14315     * The caller needs to supply data chunks with
14316     * EventHttpRequest::sendReplyChunk and complete the reply by calling
14317     * EventHttpRequest::sendReplyEnd .
14318     *
14319     * @param int $code The HTTP response code to send.
14320     * @param string $reason A brief message to send with the response
14321     *   code.
14322     * @return void
14323     * @since PECL event >= 1.4.0-beta
14324     **/
14325    public function sendReplyStart($code, $reason){}
14326
14327    /**
14328     * Constructs EventHttpRequest object
14329     *
14330     * @param callable $callback Gets invoked on requesting path. Should
14331     *   match the following prototype:
14332     * @param mixed $data User custom data passed to the callback.
14333     * @since PECL event >= 1.4.0-beta
14334     **/
14335    public function __construct($callback, $data){}
14336
14337}
14338/**
14339 * Represents a connection listener.
14340 **/
14341final class EventListener {
14342    /**
14343     * @var integer
14344     **/
14345    const OPT_CLOSE_ON_EXEC = 0;
14346
14347    /**
14348     * @var integer
14349     **/
14350    const OPT_CLOSE_ON_FREE = 0;
14351
14352    /**
14353     * @var integer
14354     **/
14355    const OPT_LEAVE_SOCKETS_BLOCKING = 0;
14356
14357    /**
14358     * @var integer
14359     **/
14360    const OPT_REUSEABLE = 0;
14361
14362    /**
14363     * @var integer
14364     **/
14365    const OPT_THREADSAFE = 0;
14366
14367    /**
14368     * Numeric file descriptor of the underlying socket. (Added in
14369     * event-1.6.0 .)
14370     *
14371     * @var int
14372     **/
14373    public $fd;
14374
14375    /**
14376     * Disables an event connect listener object
14377     *
14378     * @return bool Returns TRUE on success. Otherwise FALSE.
14379     * @since PECL event >= 1.2.6-beta
14380     **/
14381    public function disable(){}
14382
14383    /**
14384     * Enables an event connect listener object
14385     *
14386     * @return bool Returns TRUE on success. Otherwise FALSE.
14387     * @since PECL event >= 1.2.6-beta
14388     **/
14389    public function enable(){}
14390
14391    /**
14392     * Returns event base associated with the event listener
14393     *
14394     * @return void Returns event base associated with the event listener.
14395     * @since PECL event >= 1.2.6-beta
14396     **/
14397    public function getBase(){}
14398
14399    /**
14400     * Retreives the current address to which the listeners socket is bound
14401     *
14402     * Retreives the current address to which the listeners socket is bound.
14403     *
14404     * @param string $address Output parameter. IP-address depending on the
14405     *   socket address family.
14406     * @param mixed $port Output parameter. The port the socket is bound
14407     *   to.
14408     * @return bool Returns TRUE on success. Otherwise FALSE.
14409     * @since PECL event >= 1.5.0
14410     **/
14411    public static function getSocketName(&$address, &$port){}
14412
14413    /**
14414     * The setCallback purpose
14415     *
14416     * Adjust event connect listeners callback and optionally the callback
14417     * argument.
14418     *
14419     * @param callable $cb The new callback for new connections. Ignored if
14420     *   NULL. Should match the following prototype:
14421     *
14422     *   {@link listener} The EventListener object. {@link fd} The file
14423     *   descriptor or a resource associated with the listener. {@link
14424     *   address} Array of two elements: IP address and the server port.
14425     *   {@link arg} User custom data attached to the callback.
14426     * @param mixed $arg The EventListener object.
14427     * @return void
14428     * @since PECL event >= 1.2.6-beta
14429     **/
14430    public function setCallback($cb, $arg){}
14431
14432    /**
14433     * Set event listener's error callback
14434     *
14435     * @param string $cb The error callback. Should match the following
14436     *   prototype:
14437     *
14438     *   {@link listener} The EventListener object. {@link data} User custom
14439     *   data attached to the callback.
14440     * @return void
14441     * @since PECL event >= 1.2.6-beta
14442     **/
14443    public function setErrorCallback($cb){}
14444
14445    /**
14446     * Creates new connection listener associated with an event base
14447     *
14448     * @param EventBase $base Associated event base.
14449     * @param callable $cb A callable that will be invoked when new
14450     *   connection received.
14451     * @param mixed $data Custom user data attached to {@link cb} .
14452     * @param int $flags Bit mask of EventListener::OPT_* constants. See
14453     *   EventListener constants .
14454     * @param int $backlog Controls the maximum number of pending
14455     *   connections that the network stack should allow to wait in a
14456     *   not-yet-accepted state at any time; see documentation for your
14457     *   system’s listen function for more details. If {@link backlog} is
14458     *   negative, Libevent tries to pick a good value for the {@link
14459     *   backlog} ; if it is zero, Event assumes that listen is already
14460     *   called on the socket( {@link target} )
14461     * @param mixed $target May be string, socket resource, or a stream
14462     *   associated with a socket. In case if {@link target} is a string, the
14463     *   string will be parsed as network address. It will be interpreted as
14464     *   a UNIX domain socket path, if prefixed with 'unix:' , e.g.
14465     *   'unix:/tmp/my.sock' .
14466     * @since PECL event >= 1.2.6-beta
14467     **/
14468    public function __construct($base, $cb, $data, $flags, $backlog, $target){}
14469
14470}
14471/**
14472 * Represents SSL_CTX structure. Provides methods and properties to
14473 * configure the SSL context.
14474 **/
14475final class EventSslContext {
14476    /**
14477     * @var integer
14478     **/
14479    const OPT_ALLOW_SELF_SIGNED = 0;
14480
14481    /**
14482     * @var integer
14483     **/
14484    const OPT_CA_FILE = 0;
14485
14486    /**
14487     * @var integer
14488     **/
14489    const OPT_CA_PATH = 0;
14490
14491    /**
14492     * @var integer
14493     **/
14494    const OPT_CIPHERS = 0;
14495
14496    /**
14497     * @var integer
14498     **/
14499    const OPT_LOCAL_CERT = 0;
14500
14501    /**
14502     * @var integer
14503     **/
14504    const OPT_LOCAL_PK = 0;
14505
14506    /**
14507     * @var integer
14508     **/
14509    const OPT_PASSPHRASE = 0;
14510
14511    /**
14512     * @var integer
14513     **/
14514    const OPT_VERIFY_DEPTH = 0;
14515
14516    /**
14517     * @var integer
14518     **/
14519    const OPT_VERIFY_PEER = 0;
14520
14521    /**
14522     * @var integer
14523     **/
14524    const SSLv2_CLIENT_METHOD = 0;
14525
14526    /**
14527     * @var integer
14528     **/
14529    const SSLv2_SERVER_METHOD = 0;
14530
14531    /**
14532     * @var integer
14533     **/
14534    const SSLv3_CLIENT_METHOD = 0;
14535
14536    /**
14537     * @var integer
14538     **/
14539    const SSLv3_SERVER_METHOD = 0;
14540
14541    /**
14542     * @var integer
14543     **/
14544    const SSLv23_CLIENT_METHOD = 0;
14545
14546    /**
14547     * @var integer
14548     **/
14549    const SSLv23_SERVER_METHOD = 0;
14550
14551    /**
14552     * @var integer
14553     **/
14554    const TLS_CLIENT_METHOD = 0;
14555
14556    /**
14557     * @var integer
14558     **/
14559    const TLS_SERVER_METHOD = 0;
14560
14561    /**
14562     * @var string
14563     **/
14564    public $local_cert;
14565
14566    /**
14567     * @var string
14568     **/
14569    public $local_pk;
14570
14571    /**
14572     * Constructs an OpenSSL context for use with Event classes
14573     *
14574     * Creates SSL context holding pointer to SSL_CTX (see the system
14575     * manual).
14576     *
14577     * @param string $method One of EventSslContext::*_METHOD constants .
14578     * @param string $options Associative array of SSL context options One
14579     *   of EventSslContext::OPT_* constants .
14580     * @since PECL event >= 1.2.6-beta
14581     **/
14582    public function __construct($method, $options){}
14583
14584}
14585/**
14586 * EventUtil is a singleton with supplimentary methods and constants.
14587 **/
14588final class EventUtil {
14589    /**
14590     * @var integer
14591     **/
14592    const AF_INET = 0;
14593
14594    /**
14595     * @var integer
14596     **/
14597    const AF_INET6 = 0;
14598
14599    /**
14600     * @var integer
14601     **/
14602    const AF_UNSPEC = 0;
14603
14604    /**
14605     * @var integer
14606     **/
14607    const IPPROTO_IP = 0;
14608
14609    /**
14610     * @var integer
14611     **/
14612    const IPPROTO_IPV6 = 0;
14613
14614    /**
14615     * @var integer
14616     **/
14617    const LIBEVENT_VERSION_NUMBER = 0;
14618
14619    /**
14620     * @var integer
14621     **/
14622    const SOL_SOCKET = 0;
14623
14624    /**
14625     * @var integer
14626     **/
14627    const SOL_TCP = 0;
14628
14629    /**
14630     * @var integer
14631     **/
14632    const SOL_UDP = 0;
14633
14634    /**
14635     * @var integer
14636     **/
14637    const SO_BROADCAST = 0;
14638
14639    /**
14640     * @var integer
14641     **/
14642    const SO_DEBUG = 0;
14643
14644    /**
14645     * @var integer
14646     **/
14647    const SO_DONTROUTE = 0;
14648
14649    /**
14650     * @var integer
14651     **/
14652    const SO_ERROR = 0;
14653
14654    /**
14655     * @var integer
14656     **/
14657    const SO_KEEPALIVE = 0;
14658
14659    /**
14660     * @var integer
14661     **/
14662    const SO_LINGER = 0;
14663
14664    /**
14665     * @var integer
14666     **/
14667    const SO_OOBINLINE = 0;
14668
14669    /**
14670     * @var integer
14671     **/
14672    const SO_RCVBUF = 0;
14673
14674    /**
14675     * @var integer
14676     **/
14677    const SO_RCVLOWAT = 0;
14678
14679    /**
14680     * @var integer
14681     **/
14682    const SO_RCVTIMEO = 0;
14683
14684    /**
14685     * @var integer
14686     **/
14687    const SO_REUSEADDR = 0;
14688
14689    /**
14690     * @var integer
14691     **/
14692    const SO_SNDBUF = 0;
14693
14694    /**
14695     * @var integer
14696     **/
14697    const SO_SNDLOWAT = 0;
14698
14699    /**
14700     * @var integer
14701     **/
14702    const SO_SNDTIMEO = 0;
14703
14704    /**
14705     * @var integer
14706     **/
14707    const SO_TYPE = 0;
14708
14709    /**
14710     * Returns the most recent socket error number
14711     *
14712     * Returns the most recent socket error number( errno ).
14713     *
14714     * @param mixed $socket Socket resource, stream or a file descriptor of
14715     *   a socket.
14716     * @return int Returns the most recent socket error number( errno ).
14717     * @since PECL event >= 1.2.6-beta
14718     **/
14719    public static function getLastSocketErrno($socket){}
14720
14721    /**
14722     * Returns the most recent socket error
14723     *
14724     * @param mixed $socket Socket resource, stream or a file descriptor of
14725     *   a socket.
14726     * @return string Returns the most recent socket error.
14727     * @since PECL event >= 1.2.6-beta
14728     **/
14729    public static function getLastSocketError($socket){}
14730
14731    /**
14732     * Returns numeric file descriptor of a socket, or stream
14733     *
14734     * Returns numeric file descriptor of a socket or stream specified by
14735     * {@link socket} argument just like the Event extension does it
14736     * internally for all methods accepting socket resource or stream.
14737     *
14738     * @param mixed $socket Socket resource or stream.
14739     * @return int Returns numeric file descriptor of a socket, or stream.
14740     *   EventUtil::getSocketFd returns FALSE in case if it is whether failed
14741     *   to recognize the type of the underlying file, or detected that the
14742     *   file descriptor associated with {@link socket} is not valid.
14743     * @since PECL event >= 1.7.0
14744     **/
14745    public static function getSocketFd($socket){}
14746
14747    /**
14748     * Retreives the current address to which the socket is bound
14749     *
14750     * Retreives the current address to which the {@link socket} is bound.
14751     *
14752     * @param mixed $socket Socket resource, stream or a file descriptor of
14753     *   a socket.
14754     * @param string $address Output parameter. IP-address, or the UNIX
14755     *   domain socket path depending on the socket address family.
14756     * @param mixed $port Output parameter. The port the socket is bound
14757     *   to. Has no meaning for UNIX domain sockets.
14758     * @return bool Returns TRUE on success. Otherwise FALSE.
14759     * @since PECL event >= 1.5.0
14760     **/
14761    public static function getSocketName($socket, &$address, &$port){}
14762
14763    /**
14764     * Sets socket options
14765     *
14766     * @param mixed $socket Socket resource, stream, or numeric file
14767     *   descriptor associated with the socket.
14768     * @param int $level One of EventUtil::SOL_* constants. Specifies the
14769     *   protocol level at which the option resides. For example, to retrieve
14770     *   options at the socket level, a {@link level} parameter of
14771     *   EventUtil::SOL_SOCKET would be used. Other levels, such as TCP, can
14772     *   be used by specifying the protocol number of that level. Protocol
14773     *   numbers can be found by using the {@link getprotobyname} function.
14774     *   See EventUtil constants .
14775     * @param int $optname Option name(type). Has the same meaning as
14776     *   corresponding parameter of {@link socket_get_option} function. See
14777     *   EventUtil constants .
14778     * @param mixed $optval Accepts the same values as {@link optval}
14779     *   parameter of the {@link socket_get_option} function.
14780     * @return bool Returns TRUE on success. Otherwise FALSE.
14781     * @since PECL event >= 1.6.0
14782     **/
14783    public static function setSocketOption($socket, $level, $optname, $optval){}
14784
14785    /**
14786     * Generates entropy by means of OpenSSL's RAND_poll()
14787     *
14788     * Generates entropy by means of OpenSSL's RAND_poll() (see the system
14789     * manual).
14790     *
14791     * @return void
14792     * @since PECL event >= 1.2.6-beta
14793     **/
14794    public static function sslRandPoll(){}
14795
14796    /**
14797     * The abstract constructor
14798     *
14799     * EventUtil is a singleton. Therefore the constructor is abstract, and
14800     * it is impossible to create objects based on this class.
14801     *
14802     * @since PECL event >= 1.2.6-beta
14803     **/
14804    private function __construct(){}
14805
14806}
14807/**
14808 * Fork watchers are called when a fork() was detected (usually because
14809 * whoever signalled libev about it by calling EvLoop::fork ). The
14810 * invocation is done before the event loop blocks next and before
14811 * EvCheck watchers are being called, and only in the child after the
14812 * fork. Note, that if whoever calling EvLoop::fork calls it in the wrong
14813 * process, the fork handlers will be invoked, too.
14814 **/
14815class EvFork extends EvWatcher {
14816    /**
14817     * Creates a stopped instance of EvFork watcher class
14818     *
14819     * The same as EvFork::__construct , but doesn't start the watcher
14820     * automatically.
14821     *
14822     * @param string $callback See Watcher callbacks .
14823     * @param string $data Custom data associated with the watcher.
14824     * @param string $priority Watcher priority
14825     * @return object Returns EvFork(stopped) object on success.
14826     * @since PECL ev >= 0.2.0
14827     **/
14828    final public static function createStopped($callback, $data, $priority){}
14829
14830    /**
14831     * Constructs the EvFork watcher object
14832     *
14833     * Constructs the EvFork watcher object and starts the watcher
14834     * automatically.
14835     *
14836     * @param callable $callback See Watcher callbacks .
14837     * @param mixed $data Custom data associated with the watcher.
14838     * @param int $priority Watcher priority
14839     * @since PECL ev >= 0.2.0
14840     **/
14841    public function __construct($callback, $data, $priority){}
14842
14843}
14844/**
14845 * EvIdle watchers trigger events when no other events of the same or
14846 * higher priority are pending ( EvPrepare , EvCheck and other EvIdle
14847 * watchers do not count as receiving events ). Thus, as long as the
14848 * process is busy handling sockets or timeouts(or even signals) of the
14849 * same or higher priority it will not be triggered. But when the process
14850 * is in idle(or only lower-priority watchers are pending), the EvIdle
14851 * watchers are being called once per event loop iteration - until
14852 * stopped, that is, or the process receives more events and becomes busy
14853 * again with higher priority stuff. Apart from keeping the process
14854 * non-blocking(which is a useful on its own sometimes), EvIdle watchers
14855 * are a good place to do "pseudo-background processing" , or delay
14856 * processing stuff to after the event loop has handled all outstanding
14857 * events. The most noticeable effect is that as long as any idle
14858 * watchers are active, the process will not block when waiting for new
14859 * events.
14860 **/
14861class EvIdle extends EvWatcher {
14862    /**
14863     * Creates instance of a stopped EvIdle watcher object
14864     *
14865     * The same as EvIdle::__construct , but doesn't start the watcher
14866     * automatically.
14867     *
14868     * @param string $callback See Watcher callbacks .
14869     * @param mixed $data Custom data associated with the watcher.
14870     * @param int $priority Watcher priority
14871     * @return object Returns EvIdle object on success.
14872     * @since PECL ev >= 0.2.0
14873     **/
14874    final public static function createStopped($callback, $data, $priority){}
14875
14876    /**
14877     * Constructs the EvIdle watcher object
14878     *
14879     * Constructs the EvIdle watcher object and starts the watcher
14880     * automatically.
14881     *
14882     * @param callable $callback See Watcher callbacks .
14883     * @param mixed $data Custom data associated with the watcher.
14884     * @param int $priority Watcher priority
14885     * @since PECL ev >= 0.2.0
14886     **/
14887    public function __construct($callback, $data, $priority){}
14888
14889}
14890/**
14891 * EvIo watchers check whether a file descriptor(or socket, or a stream
14892 * castable to numeric file descriptor) is readable or writable in each
14893 * iteration of the event loop, or, more precisely, when reading would
14894 * not block the process and writing would at least be able to write some
14895 * data. This behaviour is called level-triggering because events are
14896 * kept receiving as long as the condition persists. To stop receiving
14897 * events just stop the watcher. The number of read and/or write event
14898 * watchers per {@link fd} is unlimited. Setting all file descriptors to
14899 * non-blocking mode is also usually a good idea(but not required).
14900 * Another thing to watch out for is that it is quite easy to receive
14901 * false readiness notifications, i.e. the callback might be called with
14902 * Ev::READ but a subsequent read() will actually block because there is
14903 * no data. It is very easy to get into this situation. Thus it is best
14904 * to always use non-blocking I/O: An extra read() returning EAGAIN (or
14905 * similar) is far preferable to a program hanging until some data
14906 * arrives. If for some reason it is impossible to run the {@link fd} in
14907 * non-blocking mode, then separately re-test whether a file descriptor
14908 * is really ready. Some people additionally use SIGALRM and an interval
14909 * timer, just to be sure thry won't block infinitely. Always consider
14910 * using non-blocking mode.
14911 **/
14912class EvIo extends EvWatcher {
14913    /**
14914     * @var mixed
14915     **/
14916    public $events;
14917
14918    /**
14919     * @var mixed
14920     **/
14921    public $fd;
14922
14923    /**
14924     * Create stopped EvIo watcher object
14925     *
14926     * The same as EvIo::__construct , but doesn't start the watcher
14927     * automatically.
14928     *
14929     * @param mixed $fd The same as for EvIo::__construct
14930     * @param int $events The same as for EvIo::__construct
14931     * @param callable $callback See Watcher callbacks .
14932     * @param mixed $data Custom data associated with the watcher.
14933     * @param int $priority Watcher priority
14934     * @return EvIo Returns EvIo object on success.
14935     * @since PECL ev >= 0.2.0
14936     **/
14937    final public static function createStopped($fd, $events, $callback, $data, $priority){}
14938
14939    /**
14940     * Configures the watcher
14941     *
14942     * Configures the EvIo watcher
14943     *
14944     * @param mixed $fd The same as for EvIo::__construct
14945     * @param int $events The same as for EvIo::__construct
14946     * @return void
14947     * @since PECL ev >= 0.2.0
14948     **/
14949    public function set($fd, $events){}
14950
14951    /**
14952     * Constructs EvIo watcher object
14953     *
14954     * Constructs EvIo watcher object and starts the watcher automatically.
14955     *
14956     * @param mixed $fd Can be a stream opened with {@link fopen} or
14957     *   similar functions, numeric file descriptor, or socket.
14958     * @param int $events Ev::READ and/or Ev::WRITE . See the bit masks .
14959     * @param callable $callback See Watcher callbacks .
14960     * @param mixed $data Custom data associated with the watcher.
14961     * @param int $priority Watcher priority
14962     * @since PECL ev >= 0.2.0
14963     **/
14964    public function __construct($fd, $events, $callback, $data, $priority){}
14965
14966}
14967/**
14968 * Represents an event loop that is always distinct from the default loop
14969 * . Unlike the default loop , it cannot handle EvChild watchers. Having
14970 * threads we have to create a loop per thread, and use the default loop
14971 * in the parent thread. The default event loop is initialized
14972 * automatically by Ev . It is accessible via methods of the Ev class, or
14973 * via EvLoop::defaultLoop method.
14974 **/
14975final class EvLoop {
14976    /**
14977     * Readonly . The backend flags indicating the event backend in use.
14978     *
14979     * @var mixed
14980     **/
14981    public $backend;
14982
14983    /**
14984     * Custom data attached to loop
14985     *
14986     * @var mixed
14987     **/
14988    public $data;
14989
14990    /**
14991     * The recursion depth. See Ev::depth .
14992     *
14993     * @var mixed
14994     **/
14995    public $depth;
14996
14997    /**
14998     * @var mixed
14999     **/
15000    public $io_interval;
15001
15002    /**
15003     * @var mixed
15004     **/
15005    public $is_default_loop;
15006
15007    /**
15008     * The current iteration count of the loop. See Ev::iteration
15009     *
15010     * @var mixed
15011     **/
15012    public $iteration;
15013
15014    /**
15015     * The number of pending watchers. 0 indicates that there are no watchers
15016     * pending.
15017     *
15018     * @var mixed
15019     **/
15020    public $pending;
15021
15022    /**
15023     * @var mixed
15024     **/
15025    public $timeout_interval;
15026
15027    /**
15028     * Returns an integer describing the backend used by libev
15029     *
15030     * The same as Ev::backend , but for the loop instance.
15031     *
15032     * @return int Returns an integer describing the backend used by libev.
15033     *   See Ev::backend .
15034     * @since PECL ev >= 0.2.0
15035     **/
15036    public function backend(){}
15037
15038    /**
15039     * Creates EvCheck object associated with the current event loop instance
15040     *
15041     * Creates EvCheck object associated with the current event loop
15042     * instance.
15043     *
15044     * @param string $callback
15045     * @param string $data
15046     * @param string $priority
15047     * @return EvCheck Returns EvCheck object on success.
15048     * @since PECL ev >= 0.2.0
15049     **/
15050    final public function check($callback, $data, $priority){}
15051
15052    /**
15053     * Creates EvChild object associated with the current event loop
15054     *
15055     * @param string $pid
15056     * @param string $trace
15057     * @param string $callback
15058     * @param string $data
15059     * @param string $priority
15060     * @return EvChild Returns EvChild object on success.
15061     * @since PECL ev >= 0.2.0
15062     **/
15063    final public function child($pid, $trace, $callback, $data, $priority){}
15064
15065    /**
15066     * Returns or creates the default event loop
15067     *
15068     * If the default event loop is not created, EvLoop::defaultLoop creates
15069     * it with the specified parameters. Otherwise, it just returns the
15070     * object representing previously created instance ignoring all the
15071     * parameters.
15072     *
15073     * @param int $flags One of the event loop flags
15074     * @param mixed $data Custom data to associate with the loop.
15075     * @param float $io_interval See io_interval
15076     * @param float $timeout_interval See timeout_interval
15077     * @return EvLoop Returns EvLoop object on success.
15078     * @since PECL ev >= 0.2.0
15079     **/
15080    public static function defaultLoop($flags, $data, $io_interval, $timeout_interval){}
15081
15082    /**
15083     * Creates an instance of EvEmbed watcher associated with the current
15084     * EvLoop object
15085     *
15086     * Creates an instance of EvEmbed watcher associated with the current
15087     * EvLoop object.
15088     *
15089     * @param string $other
15090     * @param string $callback
15091     * @param string $data
15092     * @param string $priority
15093     * @return EvEmbed Returns EvEmbed object on success.
15094     * @since PECL ev >= 0.2.0
15095     **/
15096    final public function embed($other, $callback, $data, $priority){}
15097
15098    /**
15099     * Creates EvFork watcher object associated with the current event loop
15100     * instance
15101     *
15102     * Creates EvFork watcher object associated with the current event loop
15103     * instance
15104     *
15105     * @param callable $callback
15106     * @param mixed $data
15107     * @param int $priority
15108     * @return EvFork Returns EvFork object on success.
15109     * @since PECL ev >= 0.2.0
15110     **/
15111    final public function fork($callback, $data, $priority){}
15112
15113    /**
15114     * Creates EvIdle watcher object associated with the current event loop
15115     * instance
15116     *
15117     * Creates EvIdle watcher object associated with the current event loop
15118     * instance
15119     *
15120     * @param callable $callback
15121     * @param mixed $data
15122     * @param int $priority
15123     * @return EvIdle Returns EvIdle object on success.
15124     * @since PECL ev >= 0.2.0
15125     **/
15126    final public function idle($callback, $data, $priority){}
15127
15128    /**
15129     * Invoke all pending watchers while resetting their pending state
15130     *
15131     * @return void
15132     * @since PECL ev >= 0.2.0
15133     **/
15134    public function invokePending(){}
15135
15136    /**
15137     * Create EvIo watcher object associated with the current event loop
15138     * instance
15139     *
15140     * Create EvIo watcher object associated with the current event loop
15141     * instance.
15142     *
15143     * @param mixed $fd
15144     * @param int $events
15145     * @param callable $callback
15146     * @param mixed $data
15147     * @param int $priority
15148     * @return EvIo Returns EvIo object on success.
15149     * @since PECL ev >= 0.2.0
15150     **/
15151    final public function io($fd, $events, $callback, $data, $priority){}
15152
15153    /**
15154     * Must be called after a fork
15155     *
15156     * Must be called after a fork in the child, before entering or
15157     * continuing the event loop. An alternative is to use Ev::FLAG_FORKCHECK
15158     * which calls this function automatically, at some performance loss
15159     * (refer to the libev documentation ).
15160     *
15161     * @return void
15162     * @since PECL ev >= 0.2.0
15163     **/
15164    public function loopFork(){}
15165
15166    /**
15167     * Returns the current "event loop time"
15168     *
15169     * Returns the current "event loop time", which is the time the event
15170     * loop received events and started processing them. This timestamp does
15171     * not change as long as callbacks are being processed, and this is also
15172     * the base time used for relative timers. You can treat it as the
15173     * timestamp of the event occurring(or more correctly, libev finding out
15174     * about it).
15175     *
15176     * @return float Returns time of the event loop in (fractional)
15177     *   seconds.
15178     * @since PECL ev >= 0.2.0
15179     **/
15180    public function now(){}
15181
15182    /**
15183     * Establishes the current time by querying the kernel, updating the time
15184     * returned by EvLoop::now in the progress
15185     *
15186     * Establishes the current time by querying the kernel, updating the time
15187     * returned by EvLoop::now in the progress. This is a costly operation
15188     * and is usually done automatically within EvLoop::run .
15189     *
15190     * @return void
15191     * @since PECL ev >= 0.2.0
15192     **/
15193    public function nowUpdate(){}
15194
15195    /**
15196     * Creates EvPeriodic watcher object associated with the current event
15197     * loop instance
15198     *
15199     * Creates EvPeriodic watcher object associated with the current event
15200     * loop instance
15201     *
15202     * @param float $offset
15203     * @param float $interval
15204     * @param callable $callback
15205     * @param mixed $data
15206     * @param int $priority
15207     * @return EvPeriodic Returns EvPeriodic object on success.
15208     * @since PECL ev >= 0.2.0
15209     **/
15210    final public function periodic($offset, $interval, $callback, $data, $priority){}
15211
15212    /**
15213     * Creates EvPrepare watcher object associated with the current event
15214     * loop instance
15215     *
15216     * Creates EvPrepare watcher object associated with the current event
15217     * loop instance
15218     *
15219     * @param callable $callback
15220     * @param mixed $data
15221     * @param int $priority
15222     * @return EvPrepare Returns EvPrepare object on success
15223     * @since PECL ev >= 0.2.0
15224     **/
15225    final public function prepare($callback, $data, $priority){}
15226
15227    /**
15228     * Resume previously suspended default event loop
15229     *
15230     * EvLoop::suspend and EvLoop::resume methods suspend and resume a loop
15231     * correspondingly.
15232     *
15233     * @return void
15234     * @since PECL ev >= 0.2.0
15235     **/
15236    public function resume(){}
15237
15238    /**
15239     * Begin checking for events and calling callbacks for the loop
15240     *
15241     * Begin checking for events and calling callbacks for the current event
15242     * loop. Returns when a callback calls Ev::stop method, or the flags are
15243     * nonzero(in which case the return value is true) or when there are no
15244     * active watchers which reference the loop( EvWatcher::keepalive is
15245     * TRUE), in which case the return value will be FALSE. The return value
15246     * can generally be interpreted as if TRUE, there is more work left to do
15247     * .
15248     *
15249     * @param int $flags Optional parameter {@link flags} can be one of the
15250     *   following: List for possible values of {@link flags} {@link flags}
15251     *   Description 0 The default behavior described above Ev::RUN_ONCE
15252     *   Block at most one(wait, but don't loop) Ev::RUN_NOWAIT Don't block
15253     *   at all(fetch/handle events, but don't wait) See the run flag
15254     *   constants .
15255     * @return void
15256     * @since PECL ev >= 0.2.0
15257     **/
15258    public function run($flags){}
15259
15260    /**
15261     * Creates EvSignal watcher object associated with the current event loop
15262     * instance
15263     *
15264     * Creates EvSignal watcher object associated with the current event loop
15265     * instance
15266     *
15267     * @param int $signum
15268     * @param callable $callback
15269     * @param mixed $data
15270     * @param int $priority
15271     * @return EvSignal Returns EvSignal object on success
15272     * @since PECL ev >= 0.2.0
15273     **/
15274    final public function signal($signum, $callback, $data, $priority){}
15275
15276    /**
15277     * Creates EvStat watcher object associated with the current event loop
15278     * instance
15279     *
15280     * Creates EvStat watcher object associated with the current event loop
15281     * instance
15282     *
15283     * @param string $path
15284     * @param float $interval
15285     * @param callable $callback
15286     * @param mixed $data
15287     * @param int $priority
15288     * @return EvStat Returns EvStat object on success
15289     * @since PECL ev >= 0.2.0
15290     **/
15291    final public function stat($path, $interval, $callback, $data, $priority){}
15292
15293    /**
15294     * Stops the event loop
15295     *
15296     * @param int $how One of Ev::BREAK_* constants .
15297     * @return void
15298     * @since PECL ev >= 0.2.0
15299     **/
15300    public function stop($how){}
15301
15302    /**
15303     * Suspend the loop
15304     *
15305     * EvLoop::suspend and EvLoop::resume methods suspend and resume a loop
15306     * correspondingly.
15307     *
15308     * @return void
15309     * @since PECL ev >= 0.2.0
15310     **/
15311    public function suspend(){}
15312
15313    /**
15314     * Creates EvTimer watcher object associated with the current event loop
15315     * instance
15316     *
15317     * Creates EvTimer watcher object associated with the current event loop
15318     * instance
15319     *
15320     * @param float $after
15321     * @param float $repeat
15322     * @param callable $callback
15323     * @param mixed $data
15324     * @param int $priority
15325     * @return EvTimer Returns EvTimer object on success
15326     * @since PECL ev >= 0.2.0
15327     **/
15328    final public function timer($after, $repeat, $callback, $data, $priority){}
15329
15330    /**
15331     * Performs internal consistency checks(for debugging)
15332     *
15333     * Performs internal consistency checks(for debugging libev ) and abort
15334     * the program if any data structures were found to be corrupted.
15335     *
15336     * @return void
15337     * @since PECL ev >= 0.2.0
15338     **/
15339    public function verify(){}
15340
15341    /**
15342     * Constructs the event loop object
15343     *
15344     * @param int $flags One of the event loop flags
15345     * @param mixed $data Custom data associated with the loop.
15346     * @param float $io_interval See io_interval
15347     * @param float $timeout_interval See timeout_interval
15348     * @since PECL ev >= 0.2.0
15349     **/
15350    public function __construct($flags, $data, $io_interval, $timeout_interval){}
15351
15352}
15353/**
15354 * Periodic watchers are also timers of a kind, but they are very
15355 * versatile. Unlike EvTimer , EvPeriodic watchers are not based on real
15356 * time(or relative time, the physical time that passes) but on wall
15357 * clock time(absolute time, calendar or clock). The difference is that
15358 * wall clock time can run faster or slower than real time, and time
15359 * jumps are not uncommon(e.g. when adjusting it). EvPeriodic watcher can
15360 * be configured to trigger after some specific point in time. For
15361 * example, if an EvPeriodic watcher is configured to trigger "in 10
15362 * seconds" (e.g. EvLoop::now + 10.0 , i.e. an absolute time, not a
15363 * delay), and the system clock is reset to January of the previous year
15364 * , then it will take a year or more to trigger the event (unlike an
15365 * EvTimer , which would still trigger roughly 10 seconds after starting
15366 * it as it uses a relative timeout). As with timers, the callback is
15367 * guaranteed to be invoked only when the point in time where it is
15368 * supposed to trigger has passed. If multiple timers become ready during
15369 * the same loop iteration then the ones with earlier time-out values are
15370 * invoked before ones with later time-out values (but this is no longer
15371 * true when a callback calls EvLoop::run recursively).
15372 **/
15373class EvPeriodic extends EvWatcher {
15374    /**
15375     * The current interval value. Can be modified any time, but changes only
15376     * take effect when the periodic timer fires or EvPeriodic::again is
15377     * being called.
15378     *
15379     * @var mixed
15380     **/
15381    public $interval;
15382
15383    /**
15384     * When repeating, this contains the offset value, otherwise this is the
15385     * absolute point in time(the offset value passed to EvPeriodic::set ,
15386     * although libev might modify this value for better numerical
15387     * stability).
15388     *
15389     * @var mixed
15390     **/
15391    public $offset;
15392
15393    /**
15394     * Simply stops and restarts the periodic watcher again
15395     *
15396     * Simply stops and restarts the periodic watcher again. This is only
15397     * useful when attributes are changed.
15398     *
15399     * @return void
15400     * @since PECL ev >= 0.2.0
15401     **/
15402    public function again(){}
15403
15404    /**
15405     * Returns the absolute time that this watcher is supposed to trigger
15406     * next
15407     *
15408     * When the watcher is active, returns the absolute time that this
15409     * watcher is supposed to trigger next. This is not the same as the
15410     * offset argument to EvPeriodic::set or EvPeriodic::__construct , but
15411     * indeed works even in interval mode.
15412     *
15413     * @return float Returns the absolute time this watcher is supposed to
15414     *   trigger next in seconds.
15415     * @since PECL ev >= 0.2.0
15416     **/
15417    public function at(){}
15418
15419    /**
15420     * Create a stopped EvPeriodic watcher
15421     *
15422     * Create EvPeriodic object. Unlike EvPeriodic::__construct this method
15423     * doesnt start the watcher automatically.
15424     *
15425     * @param float $offset See Periodic watcher operation modes
15426     * @param float $interval See Periodic watcher operation modes
15427     * @param callable $reschedule_cb Reschedule callback. You can pass
15428     *   NULL. See Periodic watcher operation modes
15429     * @param callable $callback See Watcher callbacks .
15430     * @param mixed $data Custom data associated with the watcher.
15431     * @param int $priority Watcher priority
15432     * @return EvPeriodic Returns EvPeriodic watcher object on success.
15433     * @since PECL ev >= 0.2.0
15434     **/
15435    final public static function createStopped($offset, $interval, $reschedule_cb, $callback, $data, $priority){}
15436
15437    /**
15438     * Configures the watcher
15439     *
15440     * (Re-)Configures EvPeriodic watcher
15441     *
15442     * @param float $offset The same meaning as for EvPeriodic::__construct
15443     *   . See Periodic watcher operation modes
15444     * @param float $interval The same meaning as for
15445     *   EvPeriodic::__construct . See Periodic watcher operation modes
15446     * @return void
15447     * @since PECL ev >= 0.2.0
15448     **/
15449    public function set($offset, $interval){}
15450
15451    /**
15452     * Constructs EvPeriodic watcher object
15453     *
15454     * Constructs EvPeriodic watcher object and starts it automatically.
15455     * EvPeriodic::createStopped method creates stopped periodic watcher.
15456     *
15457     * @param float $offset See Periodic watcher operation modes
15458     * @param string $interval See Periodic watcher operation modes
15459     * @param callable $reschedule_cb Reschedule callback. You can pass
15460     *   NULL. See Periodic watcher operation modes
15461     * @param callable $callback See Watcher callbacks .
15462     * @param mixed $data Custom data associated with the watcher.
15463     * @param int $priority Watcher priority
15464     * @since PECL ev >= 0.2.0
15465     **/
15466    public function __construct($offset, $interval, $reschedule_cb, $callback, $data, $priority){}
15467
15468}
15469class EvPrepare extends EvWatcher {
15470    /**
15471     * Creates a stopped instance of EvPrepare watcher
15472     *
15473     * Creates a stopped instance of EvPrepare watcher. Unlike
15474     * EvPrepare::__construct , this method doesn start the watcher
15475     * automatically.
15476     *
15477     * @param callable $callback See Watcher callbacks .
15478     * @param mixed $data Custom data associated with the watcher.
15479     * @param int $priority Watcher priority
15480     * @return EvPrepare Return EvPrepare object on success.
15481     * @since PECL ev >= 0.2.0
15482     **/
15483    final public static function createStopped($callback, $data, $priority){}
15484
15485    /**
15486     * Constructs EvPrepare watcher object
15487     *
15488     * Constructs EvPrepare watcher object. And starts the watcher
15489     * automatically. If need a stopped watcher consider using
15490     * EvPrepare::createStopped
15491     *
15492     * @param string $callback See Watcher callbacks .
15493     * @param string $data Custom data associated with the watcher.
15494     * @param string $priority Watcher priority
15495     * @since PECL ev >= 0.2.0
15496     **/
15497    public function __construct($callback, $data, $priority){}
15498
15499}
15500/**
15501 * EvSignal watchers will trigger an event when the process receives a
15502 * specific signal one or more times. Even though signals are very
15503 * asynchronous, libev will try its best to deliver signals
15504 * synchronously, i.e. as part of the normal event processing, like any
15505 * other event. There is no limit for the number of watchers for the same
15506 * signal, but only within the same loop, i.e. one can watch for SIGINT
15507 * in the default loop and for SIGIO in another loop, but it is not
15508 * allowed to watch for SIGINT in both the default loop and another loop
15509 * at the same time. At the moment, SIGCHLD is permanently tied to the
15510 * default loop. If possible and supported, libev will install its
15511 * handlers with SA_RESTART (or equivalent) behaviour enabled, so system
15512 * calls should not be unduly interrupted. In case of a problem with
15513 * system calls getting interrupted by signals, all the signals can be
15514 * blocked in an EvCheck watcher and unblocked in a EvPrepare watcher.
15515 **/
15516class EvSignal extends EvWatcher {
15517    /**
15518     * Signal number. See the constants exported by pcntl extension. See also
15519     * signal(7) man page.
15520     *
15521     * @var mixed
15522     **/
15523    public $signum;
15524
15525    /**
15526     * Create stopped EvSignal watcher object
15527     *
15528     * Create stopped EvSignal watcher object. Unlike EvSignal::__construct ,
15529     * this method doest start the watcher automatically.
15530     *
15531     * @param int $signum Signal number. See constants exported by pcntl
15532     *   extension. See also signal(7) man page.
15533     * @param callable $callback See Watcher callbacks .
15534     * @param mixed $data Custom data associated with the watcher.
15535     * @param int $priority Watcher priority
15536     * @return EvSignal Returns EvSignal object on success.
15537     * @since PECL ev >= 0.2.0
15538     **/
15539    final public static function createStopped($signum, $callback, $data, $priority){}
15540
15541    /**
15542     * Configures the watcher
15543     *
15544     * @param int $signum Signal number. The same as for
15545     *   EvSignal::__construct
15546     * @return void
15547     * @since PECL ev >= 0.2.0
15548     **/
15549    public function set($signum){}
15550
15551    /**
15552     * Constructs EvSignal watcher object
15553     *
15554     * Constructs EvSignal watcher object and starts it automatically. For a
15555     * stopped periodic watcher consider using EvSignal::createStopped
15556     * method.
15557     *
15558     * @param int $signum Signal number. See constants exported by pcntl
15559     *   extension. See also signal(7) man page.
15560     * @param callable $callback See Watcher callbacks .
15561     * @param mixed $data Custom data associated with the watcher.
15562     * @param int $priority Watcher priority
15563     * @since PECL ev >= 0.2.0
15564     **/
15565    public function __construct($signum, $callback, $data, $priority){}
15566
15567}
15568/**
15569 * EvStat monitors a file system path for attribute changes. It calls
15570 * stat() on that path in regular intervals(or when the OS signals it
15571 * changed) and sees if it changed compared to the last time, invoking
15572 * the callback if it did. The path does not need to exist: changing from
15573 * "path exists" to "path does not exist" is a status change like any
15574 * other. The condition "path does not exist" is signified by the 'nlink'
15575 * item being 0(returned by EvStat::attr method). The path must not end
15576 * in a slash or contain special components such as '.' or .. . The path
15577 * should be absolute: if it is relative and the working directory
15578 * changes, then the behaviour is undefined. Since there is no portable
15579 * change notification interface available, the portable implementation
15580 * simply calls stat() regularly on the path to see if it changed
15581 * somehow. For this case a recommended polling interval can be
15582 * specified. If one specifies a polling interval of 0.0 (highly
15583 * recommended) then a suitable, unspecified default value will be
15584 * used(which could be expected to be around 5 seconds, although this
15585 * might change dynamically). libev will also impose a minimum interval
15586 * which is currently around 0.1 , but that’s usually overkill. This
15587 * watcher type is not meant for massive numbers of EvStat watchers, as
15588 * even with OS-supported change notifications, this can be
15589 * resource-intensive.
15590 **/
15591class EvStat extends EvWatcher {
15592    /**
15593     * Readonly . Hint on how quickly a change is expected to be detected and
15594     * should normally be specified as 0.0 to let libev choose a suitable
15595     * value.
15596     *
15597     * @var mixed
15598     **/
15599    public $interval;
15600
15601    /**
15602     * Readonly . The path to wait for status changes on.
15603     *
15604     * @var mixed
15605     **/
15606    public $path;
15607
15608    /**
15609     * Returns the values most recently detected by Ev
15610     *
15611     * Returns array of the values most recently detected by Ev
15612     *
15613     * @return array Returns array with the values most recently detect by
15614     *   Ev(without actual stat ing): List for item keys of the array
15615     *   returned by EvStat::attr Key Description 'dev' ID of device
15616     *   containing file 'ino' inode number 'mode' protection 'nlink' number
15617     *   of hard links 'uid' user ID of owner 'size' total size, in bytes
15618     *   'gid' group ID of owner 'rdev' device ID (if special file) 'blksize'
15619     *   blocksize for file system I/O 'blocks' number of 512B blocks
15620     *   allocated 'atime' time of last access 'ctime' time of last status
15621     *   change 'mtime' time of last modification
15622     * @since PECL ev >= 0.2.0
15623     **/
15624    public function attr(){}
15625
15626    /**
15627     * Create a stopped EvStat watcher object
15628     *
15629     * Creates EvStat watcher object, but doesnt start it
15630     * automatically(unlike EvStat::__construct ).
15631     *
15632     * @param string $path The path to wait for status changes on.
15633     * @param float $interval Hint on how quickly a change is expected to
15634     *   be detected and should normally be specified as 0.0 to let libev
15635     *   choose a suitable value.
15636     * @param callable $callback See Watcher callbacks .
15637     * @param mixed $data Custom data associated with the watcher.
15638     * @param int $priority Watcher priority
15639     * @return void Returns a stopped EvStat watcher object on success.
15640     * @since PECL ev >= 0.2.0
15641     **/
15642    final public static function createStopped($path, $interval, $callback, $data, $priority){}
15643
15644    /**
15645     * Returns the previous set of values returned by EvStat::attr
15646     *
15647     * Just like EvStat::attr , but returns the previous set of values.
15648     *
15649     * @return void Returns an array with the same structure as the array
15650     *   returned by EvStat::attr . The array contains previously detected
15651     *   values.
15652     * @since PECL ev >= 0.2.0
15653     **/
15654    public function prev(){}
15655
15656    /**
15657     * Configures the watcher
15658     *
15659     * @param string $path The path to wait for status changes on.
15660     * @param float $interval Hint on how quickly a change is expected to
15661     *   be detected and should normally be specified as 0.0 to let libev
15662     *   choose a suitable value.
15663     * @return void
15664     * @since PECL ev >= 0.2.0
15665     **/
15666    public function set($path, $interval){}
15667
15668    /**
15669     * Initiates the stat call
15670     *
15671     * Initiates the stat call(updates internal cache). It stats(using lstat
15672     * ) the path specified in the watcher and sets to the values found.
15673     *
15674     * @return bool Returns TRUE if path exists. Otherwise FALSE.
15675     * @since PECL ev >= 0.2.0
15676     **/
15677    public function stat(){}
15678
15679    /**
15680     * Constructs EvStat watcher object
15681     *
15682     * Constructs EvStat watcher object and starts the watcher automatically.
15683     *
15684     * @param string $path The path to wait for status changes on.
15685     * @param float $interval Hint on how quickly a change is expected to
15686     *   be detected and should normally be specified as 0.0 to let libev
15687     *   choose a suitable value.
15688     * @param callable $callback See Watcher callbacks .
15689     * @param mixed $data Custom data associated with the watcher.
15690     * @param int $priority Watcher priority
15691     * @since PECL ev >= 0.2.0
15692     **/
15693    public function __construct($path, $interval, $callback, $data, $priority){}
15694
15695}
15696/**
15697 * EvTimer watchers are simple relative timers that generate an event
15698 * after a given time, and optionally repeating in regular intervals
15699 * after that. The timers are based on real time, that is, if one
15700 * registers an event that times out after an hour and resets the system
15701 * clock to January last year , it will still time out after(roughly) one
15702 * hour. "Roughly" because detecting time jumps is hard, and some
15703 * inaccuracies are unavoidable. The callback is guaranteed to be invoked
15704 * only after its timeout has passed (not at, so on systems with very
15705 * low-resolution clocks this might introduce a small delay). If multiple
15706 * timers become ready during the same loop iteration then the ones with
15707 * earlier time-out values are invoked before ones of the same priority
15708 * with later time-out values (but this is no longer true when a callback
15709 * calls EvLoop::run recursively). The timer itself will do a best-effort
15710 * at avoiding drift, that is, if a timer is configured to trigger every
15711 * 10 seconds, then it will normally trigger at exactly 10 second
15712 * intervals. If, however, the script cannot keep up with the timer
15713 * because it takes longer than those 10 seconds to do) the timer will
15714 * not fire more than once per event loop iteration.
15715 **/
15716class EvTimer extends EvWatcher {
15717    /**
15718     * Returns the remaining time until a timer fires. If the timer is
15719     * active, then this time is relative to the current event loop time,
15720     * otherwise its the timeout value currently configured.
15721     *
15722     * That is, after instanciating an EvTimer with an {@link after} value of
15723     * 5.0 and {@link repeat} value of 7.0 , remaining returns 5.0 . When the
15724     * timer is started and one second passes, remaining will return 4.0 .
15725     * When the timer expires and is restarted, it will return roughly 7.0
15726     * (likely slightly less as callback invocation takes some time too), and
15727     * so on.
15728     *
15729     * @var mixed
15730     **/
15731    public $remaining;
15732
15733    /**
15734     * If repeat is 0.0 , then it will automatically be stopped once the
15735     * timeout is reached. If it is positive, then the timer will
15736     * automatically be configured to trigger again every repeat seconds
15737     * later, until stopped manually.
15738     *
15739     * @var mixed
15740     **/
15741    public $repeat;
15742
15743    /**
15744     * Restarts the timer watcher
15745     *
15746     * This will act as if the timer timed out and restart it again if it is
15747     * repeating. The exact semantics are:
15748     *
15749     * @return void
15750     * @since PECL ev >= 0.2.0
15751     **/
15752    public function again(){}
15753
15754    /**
15755     * Creates EvTimer stopped watcher object
15756     *
15757     * Creates EvTimer stopped watcher object. Unlike EvTimer::__construct ,
15758     * this method doesn't start the watcher automatically.
15759     *
15760     * @param float $after Configures the timer to trigger after {@link
15761     *   after} seconds.
15762     * @param float $repeat If repeat is 0.0 , then it will automatically
15763     *   be stopped once the timeout is reached. If it is positive, then the
15764     *   timer will automatically be configured to trigger again every repeat
15765     *   seconds later, until stopped manually.
15766     * @param callable $callback See Watcher callbacks .
15767     * @param mixed $data Custom data associated with the watcher.
15768     * @param int $priority Watcher priority
15769     * @return EvTimer Returns EvTimer watcher object on success.
15770     * @since PECL ev >= 0.2.0
15771     **/
15772    final public static function createStopped($after, $repeat, $callback, $data, $priority){}
15773
15774    /**
15775     * Configures the watcher
15776     *
15777     * @param float $after Configures the timer to trigger after {@link
15778     *   after} seconds.
15779     * @param float $repeat If repeat is 0.0 , then it will automatically
15780     *   be stopped once the timeout is reached. If it is positive, then the
15781     *   timer will automatically be configured to trigger again every repeat
15782     *   seconds later, until stopped manually.
15783     * @return void
15784     * @since PECL ev >= 0.2.0
15785     **/
15786    public function set($after, $repeat){}
15787
15788    /**
15789     * Constructs an EvTimer watcher object
15790     *
15791     * @param float $after Configures the timer to trigger after {@link
15792     *   after} seconds.
15793     * @param float $repeat If repeat is 0.0 , then it will automatically
15794     *   be stopped once the timeout is reached. If it is positive, then the
15795     *   timer will automatically be configured to trigger again every repeat
15796     *   seconds later, until stopped manually.
15797     * @param callable $callback See Watcher callbacks .
15798     * @param mixed $data Custom data associated with the watcher.
15799     * @param int $priority Watcher priority
15800     * @since PECL ev >= 0.2.0
15801     **/
15802    public function __construct($after, $repeat, $callback, $data, $priority){}
15803
15804}
15805/**
15806 * EvWatcher is a base class for all watchers( EvCheck , EvChild etc.).
15807 * Since EvWatcher s constructor is abstract , one cant(and dont need to)
15808 * create EvWatcher objects directly.
15809 **/
15810abstract class EvWatcher {
15811    /**
15812     * User custom data associated with the watcher
15813     *
15814     * @var mixed
15815     **/
15816    public $data;
15817
15818    /**
15819     * @var mixed
15820     **/
15821    public $is_active;
15822
15823    /**
15824     * @var mixed
15825     **/
15826    public $is_pending;
15827
15828    /**
15829     * Integer between Ev::MINPRI and Ev::MAXPRI . Pending watchers with
15830     * higher priority will be invoked before watchers with lower priority,
15831     * but priority will not keep watchers from being executed(except for
15832     * EvIdle watchers). EvIdle watchers provide functionality to suppress
15833     * invocation when higher priority events are pending.
15834     *
15835     * @var mixed
15836     **/
15837    public $priority;
15838
15839    /**
15840     * Clear watcher pending status
15841     *
15842     * If the watcher is pending, this method clears its pending status and
15843     * returns its revents bitset(as if its callback was invoked). If the
15844     * watcher isnt pending it does nothing and returns 0 .
15845     *
15846     * Sometimes it can be useful to "poll" a watcher instead of waiting for
15847     * its callback to be invoked, which can be accomplished with this
15848     * function.
15849     *
15850     * @return int In case if the watcher is pending, returns revents
15851     *   bitset as if the watcher callback had been invoked. Otherwise
15852     *   returns 0 .
15853     * @since PECL ev >= 0.2.0
15854     **/
15855    public function clear(){}
15856
15857    /**
15858     * Feeds the given revents set into the event loop
15859     *
15860     * Feeds the given revents set into the event loop, as if the specified
15861     * event had happened for the watcher.
15862     *
15863     * @param int $revents Bit mask of watcher received events .
15864     * @return void
15865     * @since PECL ev >= 0.2.0
15866     **/
15867    public function feed($revents){}
15868
15869    /**
15870     * Returns the loop responsible for the watcher
15871     *
15872     * @return EvLoop Returns EvLoop event loop object responsible for the
15873     *   watcher.
15874     * @since PECL ev >= 0.2.0
15875     **/
15876    public function getLoop(){}
15877
15878    /**
15879     * Invokes the watcher callback with the given received events bit mask
15880     *
15881     * Invokes the watcher callback with the given received events bit mask.
15882     *
15883     * @param int $revents Bit mask of watcher received events .
15884     * @return void
15885     * @since PECL ev >= 0.2.0
15886     **/
15887    public function invoke($revents){}
15888
15889    /**
15890     * Configures whether to keep the loop from returning
15891     *
15892     * Configures whether to keep the loop from returning. With keepalive
15893     * {@link value} set to FALSE the watcher wont keep Ev::run / EvLoop::run
15894     * from returning even though the watcher is active.
15895     *
15896     * Watchers have keepalive {@link value} TRUE by default.
15897     *
15898     * Clearing keepalive status is useful when returning from Ev::run /
15899     * EvLoop::run just because of the watcher is undesirable. It could be a
15900     * long running UDP socket watcher or so.
15901     *
15902     * @param bool $value With keepalive {@link value} set to FALSE the
15903     *   watcher wont keep Ev::run / EvLoop::run from returning even though
15904     *   the watcher is active.
15905     * @return bool Returns the previous state.
15906     * @since PECL ev >= 0.2.0
15907     **/
15908    public function keepalive($value){}
15909
15910    /**
15911     * Sets new callback for the watcher
15912     *
15913     * @param callable $callback See Watcher callbacks .
15914     * @return void
15915     * @since PECL ev >= 0.2.0
15916     **/
15917    public function setCallback($callback){}
15918
15919    /**
15920     * Starts the watcher
15921     *
15922     * Marks the watcher as active. Note that only active watchers will
15923     * receive events.
15924     *
15925     * @return void
15926     * @since PECL ev >= 0.2.0
15927     **/
15928    public function start(){}
15929
15930    /**
15931     * Stops the watcher
15932     *
15933     * Marks the watcher as inactive. Note that only active watchers will
15934     * receive events.
15935     *
15936     * @return void
15937     * @since PECL ev >= 0.2.0
15938     **/
15939    public function stop(){}
15940
15941    /**
15942     * Abstract constructor of a watcher object
15943     *
15944     * EvWatcher::__construct is an abstract constructor of a watcher object
15945     * implemented in the derived classes.
15946     *
15947     * @since PECL ev >= 0.2.0
15948     **/
15949    abstract public function __construct();
15950
15951}
15952/**
15953 * FANNConnection is used for the neural network connection. The objects
15954 * of this class are used in {@link fann_get_connection_array} and {@link
15955 * fann_set_weight_array}.
15956 **/
15957class FANNConnection {
15958    /**
15959     * @var mixed
15960     **/
15961    public $from_neuron;
15962
15963    /**
15964     * @var mixed
15965     **/
15966    public $to_neuron;
15967
15968    /**
15969     * The weight of the connection.
15970     *
15971     * @var mixed
15972     **/
15973    public $weight;
15974
15975    /**
15976     * Returns the postions of starting neuron
15977     *
15978     * @return int The postions of starting neuron.
15979     * @since PECL fann >= 1.0.0
15980     **/
15981    public function getFromNeuron(){}
15982
15983    /**
15984     * Returns the postions of terminating neuron
15985     *
15986     * @return int The postions of terminating neuron.
15987     * @since PECL fann >= 1.0.0
15988     **/
15989    public function getToNeuron(){}
15990
15991    /**
15992     * Returns the connection weight
15993     *
15994     * @return void The connection weight.
15995     * @since PECL fann >= 1.0.0
15996     **/
15997    public function getWeight(){}
15998
15999    /**
16000     * Sets the connections weight
16001     *
16002     * Sets the connection weight.
16003     *
16004     * This method is different than {@link fann_set_weight}. It does not
16005     * update the weight value in the network. The network value is updated
16006     * only after calling {@link fann_set_weight_array}.
16007     *
16008     * @param float $weight The connection weight.
16009     * @return void
16010     * @since PECL fann >= 1.0.0
16011     **/
16012    public function setWeight($weight){}
16013
16014    /**
16015     * The connection constructor
16016     *
16017     * Create new connection and initialize its params. After creating the
16018     * connection, only weight can be changed.
16019     *
16020     * @param int $from_neuron The postion number of starting neuron.
16021     * @param int $to_neuron The postion number of terminating neuron.
16022     * @param float $weight The connection weight value.
16023     * @since PECL fann >= 1.0.0
16024     **/
16025    public function __construct($from_neuron, $to_neuron, $weight){}
16026
16027}
16028/**
16029 * Objects of this class are created by the factory methods FFI::cdef,
16030 * FFI::load or FFI::scope. Defined C variables are made available as
16031 * properties of the FFI instance, and defined C functions are made
16032 * available as methods of the FFI instance. Declared C types can be used
16033 * to create new C data structures using FFI::new and FFI::type. FFI
16034 * definition parsing and shared library loading may take significant
16035 * time. It is not useful to do it on each HTTP request in a Web
16036 * environment. However, it is possible to preload FFI definitions and
16037 * libraries at PHP startup, and to instantiate FFI objects when
16038 * necessary. Header files may be extended with special FFI_SCOPE defines
16039 * (e.g. #define FFI_SCOPE "foo"”"; the default scope is "C") and then
16040 * loaded by FFI::load during preloading. This leads to the creation of a
16041 * persistent binding, that will be available to all the following
16042 * requests through FFI::scope. Refer to the complete PHP/FFI/preloading
16043 * example for details. It is possible to preload more than one C header
16044 * file into the same scope.
16045 **/
16046class FFI {
16047    /**
16048     * Creates an unmanaged pointer to C data
16049     *
16050     * Creates an unmanaged pointer to the C data represented by the given
16051     * FFI\CData. The source {@link ptr} must survive the resulting pointer.
16052     * This function is mainly useful to pass arguments to C functions by
16053     * pointer.
16054     *
16055     * @param FFI\CData $ptr The handle of the pointer to a C data
16056     *   structure.
16057     * @return FFI\CData Returns the freshly created FFI\CData object.
16058     * @since PHP 7 >= 7.4.0
16059     **/
16060    public static function addr(&$ptr){}
16061
16062    /**
16063     * Gets the alignment
16064     *
16065     * Gets the alignment of the given FFI\CData or FFI\CType object.
16066     *
16067     * @param mixed $ptr The handle of the C data or type.
16068     * @return int Returns the alignment of the given FFI\CData or
16069     *   FFI\CType object.
16070     * @since PHP 7 >= 7.4.0
16071     **/
16072    public static function alignof(&$ptr){}
16073
16074    /**
16075     * Dynamically constructs a new C array type
16076     *
16077     * Dynamically constructs a new C array type with elements of type
16078     * defined by {@link type}, and dimensions specified by {@link dims}. In
16079     * the following example $t1 and $t2 are equivalent array types:
16080     *
16081     * <?php $t1 = FFI::type("int[2][3]"); $t2 =
16082     * FFI::arrayType(FFI::type("int"), [2, 3]); ?>
16083     *
16084     * @param FFI\CType $type A valid C declaration as string, or an
16085     *   instance of FFI\CType which has already been created.
16086     * @param array $dims The dimensions of the type as array.
16087     * @return FFI\CType Returns the freshly created FFI\CType object.
16088     * @since PHP 7 >= 7.4.0
16089     **/
16090    public static function arrayType($type, $dims){}
16091
16092    /**
16093     * Performs a C type cast
16094     *
16095     * FFI::cast creates a new FFI\CData object, that references the same C
16096     * data structure, but is associated with a different type. The resulting
16097     * object does not own the C data, and the source {@link ptr} must
16098     * survive the result. The C type may be specified as a string with any
16099     * valid C type declaration or as FFI\CType object, created before. If
16100     * this method is called statically, it must only use predefined C type
16101     * names (e.g. int, char, etc.); if the method is called as instance
16102     * method, any type declared for the instance is allowed.
16103     *
16104     * @param mixed $type A valid C declaration as string, or an instance
16105     *   of FFI\CType which has already been created.
16106     * @param FFI\CData $ptr The handle of the pointer to a C data
16107     *   structure.
16108     * @return FFI\CData Returns the freshly created FFI\CData object.
16109     * @since PHP 7 >= 7.4.0
16110     **/
16111    public static function cast($type, &$ptr){}
16112
16113    /**
16114     * Creates a new FFI object
16115     *
16116     * @param string $code A string containing a sequence of declarations
16117     *   in regular C language (types, structures, functions, variables,
16118     *   etc). Actually, this string may be copy-pasted from C header files.
16119     * @param string $lib The name of a shared library file, to be loaded
16120     *   and linked with the definitions.
16121     * @return FFI Returns the freshly created FFI object.
16122     * @since PHP 7 >= 7.4.0
16123     **/
16124    public static function cdef($code, $lib){}
16125
16126    /**
16127     * Releases an unmanaged data structure
16128     *
16129     * Manually releases a previously created unmanaged data structure.
16130     *
16131     * @param FFI\CData $ptr The handle of the unmanaged pointer to a C
16132     *   data structure.
16133     * @return void
16134     * @since PHP 7 >= 7.4.0
16135     **/
16136    public static function free(&$ptr){}
16137
16138    /**
16139     * Checks whether a FFI\CData is a null pointer
16140     *
16141     * @param FFI\CData $ptr The handle of the pointer to a C data
16142     *   structure.
16143     * @return bool Returns whether a FFI\CData is a null pointer.
16144     * @since PHP 7 >= 7.4.0
16145     **/
16146    public static function isNull(&$ptr){}
16147
16148    /**
16149     * Loads C declarations from a C header file
16150     *
16151     * Loads C declarations from a C header file. It is possible to specify
16152     * shared libraries that should be loaded, using special FFI_LIB defines
16153     * in the loaded C header file.
16154     *
16155     * @param string $filename The name of a C header file. C preprocessor
16156     *   directives are not supported, i.e. #include, #define and CPP macros
16157     *   do not work, except for special cases listed below. The header file
16158     *   should contain a #define statement for the FFI_SCOPE variable, e.g.:
16159     *   #define FFI_SCOPE "MYLIB". Refer to the class introduction for
16160     *   details. The header file may contain a #define statement for the
16161     *   FFI_LIB variable to specify the library it exposes. If it is a
16162     *   system library only the file name is required, e.g.: #define FFI_LIB
16163     *   "libc.so.6". If it is a custom library, a relative path is required,
16164     *   e.g.: #define FFI_LIB "./mylib.so".
16165     * @return FFI Returns the freshly created FFI object.
16166     * @since PHP 7 >= 7.4.0
16167     **/
16168    public static function load($filename){}
16169
16170    /**
16171     * Compares memory areas
16172     *
16173     * Compares {@link size} bytes from the memory areas {@link ptr1} and
16174     * {@link ptr2}. Both {@link ptr1} and {@link ptr2} can be any native
16175     * data structures (FFI\CData) or PHP strings.
16176     *
16177     * @param mixed $ptr1 The start of one memory area.
16178     * @param mixed $ptr2 The start of another memory area.
16179     * @param int $size The number of bytes to compare.
16180     * @return int Returns < 0 if the contents of the memory area starting
16181     *   at {@link ptr1} are considered less than the contents of the memory
16182     *   area starting at {@link ptr2}, > 0 if the contents of the first
16183     *   memory area are considered greater than the second, and 0 if they
16184     *   are equal.
16185     * @since PHP 7 >= 7.4.0
16186     **/
16187    public static function memcmp(&$ptr1, &$ptr2, $size){}
16188
16189    /**
16190     * Copies one memory area to another
16191     *
16192     * Copies {@link size} bytes from the memory area {@link src} to the
16193     * memory area {@link dst}. Both {@link src} and {@link dst} can be any
16194     * native data structures (FFI\CData) or PHP strings.
16195     *
16196     * @param FFI\CData $dst The start of the memory area to copy to.
16197     * @param mixed $src The start of the memory area to copy from.
16198     * @param int $size The number of bytes to copy.
16199     * @return void
16200     * @since PHP 7 >= 7.4.0
16201     **/
16202    public static function memcpy(&$dst, &$src, $size){}
16203
16204    /**
16205     * Fills a memory area
16206     *
16207     * Fills {@link size} bytes of the memory area pointed to by {@link ptr}
16208     * with the given byte {@link ch}.
16209     *
16210     * @param FFI\CData $ptr The start of the memory area to fill.
16211     * @param int $ch The byte to fill with.
16212     * @param int $size The number of bytes to fill.
16213     * @return void
16214     * @since PHP 7 >= 7.4.0
16215     **/
16216    public static function memset(&$ptr, $ch, $size){}
16217
16218    /**
16219     * Creates a C data structure
16220     *
16221     * Creates a native data structure of the given C type. If this method is
16222     * called statically, it must only use predefined C type names (e.g. int,
16223     * char, etc.); if the method is called as instance method, any type
16224     * declared for the instance is allowed.
16225     *
16226     * @param mixed $type {@link type} is a valid C declaration as string,
16227     *   or an instance of FFI\CType which has already been created.
16228     * @param bool $owned Whether to create owned (i.e. managed) or
16229     *   unmanaged data. Managed data lives together with the returned
16230     *   FFI\CData object, and is released when the last reference to that
16231     *   object is released by regular PHP reference counting or GC.
16232     *   Unmanaged data should be released by calling FFI::free, when no
16233     *   longer needed.
16234     * @param bool $persistent Whether to allocate the C data structure
16235     *   permanently on the system heap (using {@link malloc}), or on the PHP
16236     *   request heap (using {@link emalloc}).
16237     * @return FFI\CData Returns the freshly created FFI\CData object.
16238     * @since PHP 7 >= 7.4.0
16239     **/
16240    public static function new($type, $owned, $persistent){}
16241
16242    /**
16243     * Instantiates an FFI object with C declarations parsed during
16244     * preloading
16245     *
16246     * The FFI::scope method is safe to call multiple times for the same
16247     * scope. Multiple references to the same scope may be loaded at the same
16248     * time.
16249     *
16250     * @param string $scope_name The scope name defined by a special
16251     *   FFI_SCOPE define.
16252     * @return FFI Returns the freshly created FFI object.
16253     * @since PHP 7 >= 7.4.0
16254     **/
16255    public static function scope($scope_name){}
16256
16257    /**
16258     * Gets the size of C data or types
16259     *
16260     * Returns the size of the given FFI\CData or FFI\CType object.
16261     *
16262     * @param mixed $ptr The handle of the C data or type.
16263     * @return int The size of the memory area pointed at by {@link ptr}.
16264     * @since PHP 7 >= 7.4.0
16265     **/
16266    public static function sizeof(&$ptr){}
16267
16268    /**
16269     * Creates a PHP string from a memory area
16270     *
16271     * Creates a PHP string from {@link size} bytes of the memory area
16272     * pointed to by {@link ptr}.
16273     *
16274     * @param FFI\CData $ptr The start of the memory area from which to
16275     *   create a string.
16276     * @param int $size The number of bytes to copy to the string. If
16277     *   {@link size} is omitted, {@link ptr} must be a zero terminated array
16278     *   of C chars.
16279     * @return string The freshly created PHP string.
16280     * @since PHP 7 >= 7.4.0
16281     **/
16282    public static function string(&$ptr, $size){}
16283
16284    /**
16285     * Creates an FFI\CType object from a C declaration
16286     *
16287     * This function creates and returns a FFI\CType object for the given
16288     * string containing a C type declaration. If this method is called
16289     * statically, it must only use predefined C type names (e.g. int, char,
16290     * etc.); if the method is called as instance method, any type declared
16291     * for the instance is allowed.
16292     *
16293     * @param mixed $type A valid C declaration as string, or an instance
16294     *   of FFI\CType which has already been created.
16295     * @return FFI\CType Returns the freshly created FFI\CType object.
16296     * @since PHP 7 >= 7.4.0
16297     **/
16298    public static function type($type){}
16299
16300    /**
16301     * Gets the FFI\CType of FFI\CData
16302     *
16303     * Gets the FFI\CType object representing the type of the given FFI\CData
16304     * object.
16305     *
16306     * @param FFI\CData $ptr The handle of the pointer to a C data
16307     *   structure.
16308     * @return FFI\CType Returns the FFI\CType object representing the type
16309     *   of the given FFI\CData object.
16310     * @since PHP 7 >= 7.4.0
16311     **/
16312    public static function typeof(&$ptr){}
16313
16314}
16315namespace FFI {
16316class CData {
16317}
16318}
16319namespace FFI {
16320class CType {
16321}
16322}
16323namespace FFI {
16324class Exception extends Error implements Throwable {
16325}
16326}
16327namespace FFI {
16328class ParserException extends FFI\Exception implements Throwable {
16329}
16330}
16331/**
16332 * The Filesystem iterator
16333 **/
16334class FilesystemIterator extends DirectoryIterator implements SeekableIterator {
16335    /**
16336     * @var integer
16337     **/
16338    const CURRENT_AS_FILEINFO = 0;
16339
16340    /**
16341     * @var integer
16342     **/
16343    const CURRENT_AS_PATHNAME = 0;
16344
16345    /**
16346     * @var integer
16347     **/
16348    const CURRENT_AS_SELF = 0;
16349
16350    /**
16351     * @var integer
16352     **/
16353    const CURRENT_MODE_MASK = 0;
16354
16355    /**
16356     * @var integer
16357     **/
16358    const FOLLOW_SYMLINKS = 0;
16359
16360    /**
16361     * @var integer
16362     **/
16363    const KEY_AS_FILENAME = 0;
16364
16365    /**
16366     * @var integer
16367     **/
16368    const KEY_AS_PATHNAME = 0;
16369
16370    /**
16371     * @var integer
16372     **/
16373    const KEY_MODE_MASK = 0;
16374
16375    /**
16376     * @var integer
16377     **/
16378    const NEW_CURRENT_AND_KEY = 0;
16379
16380    /**
16381     * @var integer
16382     **/
16383    const SKIP_DOTS = 0;
16384
16385    /**
16386     * @var integer
16387     **/
16388    const UNIX_PATHS = 0;
16389
16390    /**
16391     * The current file
16392     *
16393     * Get file information of the current element.
16394     *
16395     * @return mixed The filename, file information, or $this depending on
16396     *   the set flags. See the FilesystemIterator constants.
16397     * @since PHP 5 >= 5.3.0, PHP 7
16398     **/
16399    public function current(){}
16400
16401    /**
16402     * Get the handling flags
16403     *
16404     * Gets the handling flags, as set in FilesystemIterator::__construct or
16405     * FilesystemIterator::setFlags.
16406     *
16407     * @return int The integer value of the set flags.
16408     * @since PHP 5 >= 5.3.0, PHP 7
16409     **/
16410    public function getFlags(){}
16411
16412    /**
16413     * Retrieve the key for the current file
16414     *
16415     * @return string Returns the pathname or filename depending on the set
16416     *   flags. See the FilesystemIterator constants.
16417     * @since PHP 5 >= 5.3.0, PHP 7
16418     **/
16419    public function key(){}
16420
16421    /**
16422     * Move to the next file
16423     *
16424     * @return void
16425     * @since PHP 5 >= 5.3.0, PHP 7
16426     **/
16427    public function next(){}
16428
16429    /**
16430     * Rewinds back to the beginning
16431     *
16432     * Rewinds the directory back to the start.
16433     *
16434     * @return void
16435     * @since PHP 5 >= 5.3.0, PHP 7
16436     **/
16437    public function rewind(){}
16438
16439    /**
16440     * Sets handling flags
16441     *
16442     * @param int $flags The handling flags to set. See the
16443     *   FilesystemIterator constants.
16444     * @return void
16445     * @since PHP 5 >= 5.3.0, PHP 7
16446     **/
16447    public function setFlags($flags){}
16448
16449    /**
16450     * Constructs a new filesystem iterator
16451     *
16452     * Constructs a new filesystem iterator from the {@link path}.
16453     *
16454     * @param string $path The path of the filesystem item to be iterated
16455     *   over.
16456     * @param int $flags Flags may be provided which will affect the
16457     *   behavior of some methods. A list of the flags can found under
16458     *   FilesystemIterator predefined constants. They can also be set later
16459     *   with FilesystemIterator::setFlags
16460     * @since PHP 5 >= 5.3.0, PHP 7
16461     **/
16462    public function __construct($path, $flags){}
16463
16464}
16465/**
16466 * This abstract iterator filters out unwanted values. This class should
16467 * be extended to implement custom iterator filters. The
16468 * FilterIterator::accept must be implemented in the subclass.
16469 **/
16470abstract class FilterIterator extends IteratorIterator implements OuterIterator {
16471    /**
16472     * Check whether the current element of the iterator is acceptable
16473     *
16474     * Returns whether the current element of the iterator is acceptable
16475     * through this filter.
16476     *
16477     * @return bool TRUE if the current element is acceptable, otherwise
16478     *   FALSE.
16479     * @since PHP 5 >= 5.1.0, PHP 7
16480     **/
16481    public abstract function accept();
16482
16483    /**
16484     * Get the current element value
16485     *
16486     * @return mixed The current element value.
16487     * @since PHP 5 >= 5.1.0, PHP 7
16488     **/
16489    public function current(){}
16490
16491    /**
16492     * Get the inner iterator
16493     *
16494     * @return Iterator The inner iterator.
16495     * @since PHP 5 >= 5.1.0, PHP 7
16496     **/
16497    public function getInnerIterator(){}
16498
16499    /**
16500     * Get the current key
16501     *
16502     * @return mixed The current key.
16503     * @since PHP 5 >= 5.1.0, PHP 7
16504     **/
16505    public function key(){}
16506
16507    /**
16508     * Move the iterator forward
16509     *
16510     * @return void
16511     * @since PHP 5 >= 5.1.0, PHP 7
16512     **/
16513    public function next(){}
16514
16515    /**
16516     * Rewind the iterator
16517     *
16518     * @return void
16519     * @since PHP 5 >= 5.1.0, PHP 7
16520     **/
16521    public function rewind(){}
16522
16523    /**
16524     * Check whether the current element is valid
16525     *
16526     * Checks whether the current element is valid.
16527     *
16528     * @return bool TRUE if the current element is valid, otherwise FALSE
16529     * @since PHP 5 >= 5.1.0, PHP 7
16530     **/
16531    public function valid(){}
16532
16533    /**
16534     * Construct a filterIterator
16535     *
16536     * Constructs a new FilterIterator, which consists of a passed in {@link
16537     * iterator} with filters applied to it.
16538     *
16539     * @param Iterator $iterator The iterator that is being filtered.
16540     * @since PHP 5 >= 5.1.0, PHP 7
16541     **/
16542    public function __construct($iterator){}
16543
16544}
16545/**
16546 * This class provides an object oriented interface into the fileinfo
16547 * functions.
16548 **/
16549class finfo {
16550    /**
16551     * finfo_buffer()
16552     *
16553     * @param string $string
16554     * @param int $options
16555     * @param resource $context
16556     * @return string
16557     * @since PHP 5 >= 5.3.0, PHP 7, PECL fileinfo >= 0.1.0
16558     **/
16559    public function buffer($string, $options, $context){}
16560
16561    /**
16562     * finfo_file()
16563     *
16564     * @param string $file_name
16565     * @param int $options
16566     * @param resource $context
16567     * @return string
16568     * @since PHP >= 5.3.0, PECL fileinfo >= 0.1.0
16569     **/
16570    public function file($file_name, $options, $context){}
16571
16572    /**
16573     * finfo_set_flags()
16574     *
16575     * @param int $options
16576     * @return bool
16577     * @since PHP >= 5.3.0, PECL fileinfo >= 0.1.0
16578     **/
16579    public function set_flags($options){}
16580
16581}
16582/**
16583 * Represents a class for connecting to a Gearman job server and making
16584 * requests to perform some function on provided data. The function
16585 * performed must be one registered by a Gearman worker and the data
16586 * passed is opaque to the job server.
16587 **/
16588class GearmanClient {
16589    /**
16590     * Add client options
16591     *
16592     * Adds one or more options to those already set.
16593     *
16594     * @param int $options The options to add. One of the following
16595     *   constants, or a combination of them using the bitwise OR operator
16596     *   (|): GEARMAN_CLIENT_GENERATE_UNIQUE, GEARMAN_CLIENT_NON_BLOCKING,
16597     *   GEARMAN_CLIENT_UNBUFFERED_RESULT or GEARMAN_CLIENT_FREE_TASKS.
16598     * @return bool Always returns TRUE.
16599     * @since PECL gearman >= 0.6.0
16600     **/
16601    public function addOptions($options){}
16602
16603    /**
16604     * Add a job server to the client
16605     *
16606     * Adds a job server to a list of servers that can be used to run a task.
16607     * No socket I/O happens here; the server is simply added to the list.
16608     *
16609     * @param string $host
16610     * @param int $port
16611     * @return bool
16612     * @since PECL gearman >= 0.5.0
16613     **/
16614    public function addServer($host, $port){}
16615
16616    /**
16617     * Add a list of job servers to the client
16618     *
16619     * Adds a list of job servers that can be used to run a task. No socket
16620     * I/O happens here; the servers are simply added to the full list of
16621     * servers.
16622     *
16623     * @param string $servers A comma-separated list of servers, each
16624     *   server specified in the format host:port.
16625     * @return bool
16626     * @since PECL gearman >= 0.5.0
16627     **/
16628    public function addServers($servers){}
16629
16630    /**
16631     * Add a task to be run in parallel
16632     *
16633     * Adds a task to be run in parallel with other tasks. Call this method
16634     * for all the tasks to be run in parallel, then call
16635     * GearmanClient::runTasks to perform the work. Note that enough workers
16636     * need to be available for the tasks to all run in parallel.
16637     *
16638     * @param string $function_name
16639     * @param string $workload
16640     * @param mixed $context
16641     * @param string $unique
16642     * @return GearmanTask A GearmanTask object or FALSE if the task could
16643     *   not be added.
16644     * @since PECL gearman >= 0.5.0
16645     **/
16646    public function addTask($function_name, $workload, &$context, $unique){}
16647
16648    /**
16649     * Add a background task to be run in parallel
16650     *
16651     * Adds a background task to be run in parallel with other tasks. Call
16652     * this method for all the tasks to be run in parallel, then call
16653     * GearmanClient::runTasks to perform the work.
16654     *
16655     * @param string $function_name
16656     * @param string $workload
16657     * @param mixed $context
16658     * @param string $unique
16659     * @return GearmanTask A GearmanTask object or FALSE if the task could
16660     *   not be added.
16661     * @since PECL gearman >= 0.5.0
16662     **/
16663    public function addTaskBackground($function_name, $workload, &$context, $unique){}
16664
16665    /**
16666     * Add a high priority task to run in parallel
16667     *
16668     * Adds a high priority task to be run in parallel with other tasks. Call
16669     * this method for all the high priority tasks to be run in parallel,
16670     * then call GearmanClient::runTasks to perform the work. Tasks with a
16671     * high priority will be selected from the queue before those of normal
16672     * or low priority.
16673     *
16674     * @param string $function_name
16675     * @param string $workload
16676     * @param mixed $context
16677     * @param string $unique
16678     * @return GearmanTask A GearmanTask object or FALSE if the task could
16679     *   not be added.
16680     * @since PECL gearman >= 0.5.0
16681     **/
16682    public function addTaskHigh($function_name, $workload, &$context, $unique){}
16683
16684    /**
16685     * Add a high priority background task to be run in parallel
16686     *
16687     * Adds a high priority background task to be run in parallel with other
16688     * tasks. Call this method for all the tasks to be run in parallel, then
16689     * call GearmanClient::runTasks to perform the work. Tasks with a high
16690     * priority will be selected from the queue before those of normal or low
16691     * priority.
16692     *
16693     * @param string $function_name
16694     * @param string $workload
16695     * @param mixed $context
16696     * @param string $unique
16697     * @return GearmanTask A GearmanTask object or FALSE if the task could
16698     *   not be added.
16699     * @since PECL gearman >= 0.5.0
16700     **/
16701    public function addTaskHighBackground($function_name, $workload, &$context, $unique){}
16702
16703    /**
16704     * Add a low priority task to run in parallel
16705     *
16706     * Adds a low priority background task to be run in parallel with other
16707     * tasks. Call this method for all the tasks to be run in parallel, then
16708     * call GearmanClient::runTasks to perform the work. Tasks with a low
16709     * priority will be selected from the queue after those of normal or low
16710     * priority.
16711     *
16712     * @param string $function_name
16713     * @param string $workload
16714     * @param mixed $context
16715     * @param string $unique
16716     * @return GearmanTask A GearmanTask object or FALSE if the task could
16717     *   not be added.
16718     * @since PECL gearman >= 0.5.0
16719     **/
16720    public function addTaskLow($function_name, $workload, &$context, $unique){}
16721
16722    /**
16723     * Add a low priority background task to be run in parallel
16724     *
16725     * Adds a low priority background task to be run in parallel with other
16726     * tasks. Call this method for all the tasks to be run in parallel, then
16727     * call GearmanClient::runTasks to perform the work. Tasks with a low
16728     * priority will be selected from the queue after those of normal or high
16729     * priority.
16730     *
16731     * @param string $function_name
16732     * @param string $workload
16733     * @param mixed $context
16734     * @param string $unique
16735     * @return GearmanTask A GearmanTask object or FALSE if the task could
16736     *   not be added.
16737     * @since PECL gearman >= 0.5.0
16738     **/
16739    public function addTaskLowBackground($function_name, $workload, &$context, $unique){}
16740
16741    /**
16742     * Add a task to get status
16743     *
16744     * Used to request status information from the Gearman server, which will
16745     * call the specified status callback (set using
16746     * GearmanClient::setStatusCallback).
16747     *
16748     * @param string $job_handle The job handle for the task to get status
16749     *   for
16750     * @param string $context Data to be passed to the status callback,
16751     *   generally a reference to an array or object
16752     * @return GearmanTask A GearmanTask object.
16753     * @since PECL gearman >= 0.5.0
16754     **/
16755    public function addTaskStatus($job_handle, &$context){}
16756
16757    /**
16758     * Clear all task callback functions
16759     *
16760     * Clears all the task callback functions that have previously been set.
16761     *
16762     * @return bool Always returns TRUE.
16763     * @since PECL gearman >= 0.5.0
16764     **/
16765    public function clearCallbacks(){}
16766
16767    /**
16768     * Get the application context
16769     *
16770     * Get the application context previously set with
16771     * GearmanClient::setContext.
16772     *
16773     * @return string The same context data structure set with
16774     *   GearmanClient::setContext
16775     * @since PECL gearman >= 0.6.0
16776     **/
16777    public function context(){}
16778
16779    /**
16780     * Get the application data (deprecated)
16781     *
16782     * Get the application data previously set with GearmanClient::setData.
16783     *
16784     * @return string The same string data set with GearmanClient::setData
16785     * @since PECL gearman
16786     **/
16787    public function data(){}
16788
16789    /**
16790     * Run a task in the background
16791     *
16792     * Runs a task in the background, returning a job handle which can be
16793     * used to get the status of the running task.
16794     *
16795     * @param string $function_name
16796     * @param string $workload
16797     * @param string $unique
16798     * @return string The job handle for the submitted task.
16799     * @since PECL gearman >= 0.5.0
16800     **/
16801    public function doBackground($function_name, $workload, $unique){}
16802
16803    /**
16804     * Run a single high priority task
16805     *
16806     * Runs a single high priority task and returns a string representation
16807     * of the result. It is up to the GearmanClient and GearmanWorker to
16808     * agree on the format of the result. High priority tasks will get
16809     * precedence over normal and low priority tasks in the job queue.
16810     *
16811     * @param string $function_name
16812     * @param string $workload
16813     * @param string $unique
16814     * @return string A string representing the results of running a task.
16815     * @since PECL gearman >= 0.5.0
16816     **/
16817    public function doHigh($function_name, $workload, $unique){}
16818
16819    /**
16820     * Run a high priority task in the background
16821     *
16822     * Runs a high priority task in the background, returning a job handle
16823     * which can be used to get the status of the running task. High priority
16824     * tasks take precedence over normal and low priority tasks in the job
16825     * queue.
16826     *
16827     * @param string $function_name
16828     * @param string $workload
16829     * @param string $unique
16830     * @return string The job handle for the submitted task.
16831     * @since PECL gearman >= 0.5.0
16832     **/
16833    public function doHighBackground($function_name, $workload, $unique){}
16834
16835    /**
16836     * Get the job handle for the running task
16837     *
16838     * Gets that job handle for a running task. This should be used between
16839     * repeated GearmanClient::doNormal calls. The job handle can then be
16840     * used to get information on the task.
16841     *
16842     * @return string The job handle for the running task.
16843     * @since PECL gearman >= 0.5.0
16844     **/
16845    public function doJobHandle(){}
16846
16847    /**
16848     * Run a single low priority task
16849     *
16850     * Runs a single low priority task and returns a string representation of
16851     * the result. It is up to the GearmanClient and GearmanWorker to agree
16852     * on the format of the result. Normal and high priority tasks will get
16853     * precedence over low priority tasks in the job queue.
16854     *
16855     * @param string $function_name
16856     * @param string $workload
16857     * @param string $unique
16858     * @return string A string representing the results of running a task.
16859     * @since PECL gearman >= 0.5.0
16860     **/
16861    public function doLow($function_name, $workload, $unique){}
16862
16863    /**
16864     * Run a low priority task in the background
16865     *
16866     * Runs a low priority task in the background, returning a job handle
16867     * which can be used to get the status of the running task. Normal and
16868     * high priority tasks take precedence over low priority tasks in the job
16869     * queue.
16870     *
16871     * @param string $function_name
16872     * @param string $workload
16873     * @param string $unique
16874     * @return string The job handle for the submitted task.
16875     * @since PECL gearman >= 0.5.0
16876     **/
16877    public function doLowBackground($function_name, $workload, $unique){}
16878
16879    /**
16880     * Run a single task and return a result
16881     *
16882     * Runs a single task and returns a string representation of the result.
16883     * It is up to the GearmanClient and GearmanWorker to agree on the format
16884     * of the result.
16885     *
16886     * @param string $function_name
16887     * @param string $workload
16888     * @param string $unique
16889     * @return string A string representing the results of running a task.
16890     **/
16891    public function doNormal($function_name, $workload, $unique){}
16892
16893    /**
16894     * Get the status for the running task
16895     *
16896     * Returns the status for the running task. This should be used between
16897     * repeated GearmanClient::doNormal calls.
16898     *
16899     * @return array An array representing the percentage completion given
16900     *   as a fraction, with the first element the numerator and the second
16901     *   element the denomintor.
16902     * @since PECL gearman >= 0.5.0
16903     **/
16904    public function doStatus(){}
16905
16906    /**
16907     * Returns an error string for the last error encountered
16908     *
16909     * @return string A human readable error string.
16910     * @since PECL gearman >= 0.5.0
16911     **/
16912    public function error(){}
16913
16914    /**
16915     * Get an errno value
16916     *
16917     * Value of errno in the case of a GEARMAN_ERRNO return value.
16918     *
16919     * @return int A valid Gearman errno.
16920     * @since PECL gearman >= 0.5.0
16921     **/
16922    public function getErrno(){}
16923
16924    /**
16925     * Get the status of a background job
16926     *
16927     * Gets the status for a background job given a job handle. The status
16928     * information will specify whether the job is known, whether the job is
16929     * currently running, and the percentage completion.
16930     *
16931     * @param string $job_handle
16932     * @return array An array containing status information for the job
16933     *   corresponding to the supplied job handle. The first array element is
16934     *   a boolean indicating whether the job is even known, the second is a
16935     *   boolean indicating whether the job is still running, and the third
16936     *   and fourth elements correspond to the numerator and denominator of
16937     *   the fractional completion percentage, respectively.
16938     * @since PECL gearman >= 0.5.0
16939     **/
16940    public function jobStatus($job_handle){}
16941
16942    /**
16943     * Send data to all job servers to see if they echo it back
16944     *
16945     * Sends some arbitrary data to all job servers to see if they echo it
16946     * back. The data sent is not used or processed in any other way.
16947     * Primarily used for testing and debugging.
16948     *
16949     * @param string $workload Some arbitrary serialized data to be echo
16950     *   back
16951     * @return bool
16952     **/
16953    public function ping($workload){}
16954
16955    /**
16956     * Remove client options
16957     *
16958     * Removes (unsets) one or more options.
16959     *
16960     * @param int $options The options to be removed (unset)
16961     * @return bool Always returns TRUE.
16962     * @since PECL gearman >= 0.6.0
16963     **/
16964    public function removeOptions($options){}
16965
16966    /**
16967     * Get the last Gearman return code
16968     *
16969     * Returns the last Gearman return code.
16970     *
16971     * @return int A valid Gearman return code.
16972     * @since PECL gearman >= 0.5.0
16973     **/
16974    public function returnCode(){}
16975
16976    /**
16977     * Run a list of tasks in parallel
16978     *
16979     * For a set of tasks previously added with GearmanClient::addTask,
16980     * GearmanClient::addTaskHigh, GearmanClient::addTaskLow,
16981     * GearmanClient::addTaskBackground,
16982     * GearmanClient::addTaskHighBackground, or
16983     * GearmanClient::addTaskLowBackground, this call starts running the
16984     * tasks in parallel.
16985     *
16986     * @return bool
16987     * @since PECL gearman >= 0.5.0
16988     **/
16989    public function runTasks(){}
16990
16991    /**
16992     * Callback function when there is a data packet for a task (deprecated)
16993     *
16994     * Sets the callback function for accepting data packets for a task. The
16995     * callback function should take a single argument, a GearmanTask object.
16996     *
16997     * @param callable $callback A function or method to call
16998     * @return void
16999     * @since PECL gearman
17000     **/
17001    public function setClientCallback($callback){}
17002
17003    /**
17004     * Set a function to be called on task completion
17005     *
17006     * Use to set a function to be called when a GearmanTask is completed, or
17007     * when GearmanJob::sendComplete is invoked by a worker (whichever
17008     * happens first).
17009     *
17010     * This callback executes only when executing a GearmanTask using
17011     * GearmanClient::runTasks. It is not used for individual jobs.
17012     *
17013     * @param callable $callback A function to be called
17014     * @return bool
17015     * @since PECL gearman >= 0.5.0
17016     **/
17017    public function setCompleteCallback($callback){}
17018
17019    /**
17020     * Set application context
17021     *
17022     * Sets an arbitrary string to provide application context that can later
17023     * be retrieved by GearmanClient::context.
17024     *
17025     * @param string $context Arbitrary context data
17026     * @return bool Always returns TRUE.
17027     * @since PECL gearman >= 0.6.0
17028     **/
17029    public function setContext($context){}
17030
17031    /**
17032     * Set a callback for when a task is queued
17033     *
17034     * Sets a function to be called when a task is received and queued by the
17035     * Gearman job server. The callback should accept a single argument, a
17036     * GearmanTask object.
17037     *
17038     * @param string $callback A function to call
17039     * @return bool
17040     * @since PECL gearman >= 0.5.0
17041     **/
17042    public function setCreatedCallback($callback){}
17043
17044    /**
17045     * Set application data (deprecated)
17046     *
17047     * Sets some arbitrary application data that can later be retrieved by
17048     * GearmanClient::data.
17049     *
17050     * @param string $data
17051     * @return bool Always returns TRUE.
17052     * @since PECL gearman
17053     **/
17054    public function setData($data){}
17055
17056    /**
17057     * Callback function when there is a data packet for a task
17058     *
17059     * Sets the callback function for accepting data packets for a task. The
17060     * callback function should take a single argument, a GearmanTask object.
17061     *
17062     * @param callable $callback A function or method to call
17063     * @return bool
17064     * @since PECL gearman >= 0.6.0
17065     **/
17066    public function setDataCallback($callback){}
17067
17068    /**
17069     * Set a callback for worker exceptions
17070     *
17071     * Specifies a function to call when a worker for a task sends an
17072     * exception.
17073     *
17074     * @param callable $callback Function to call when the worker throws an
17075     *   exception
17076     * @return bool
17077     * @since PECL gearman >= 0.5.0
17078     **/
17079    public function setExceptionCallback($callback){}
17080
17081    /**
17082     * Set callback for job failure
17083     *
17084     * Sets the callback function to be used when a task does not complete
17085     * successfully. The function should accept a single argument, a
17086     * GearmanTask object.
17087     *
17088     * @param callable $callback A function to call
17089     * @return bool
17090     * @since PECL gearman >= 0.5.0
17091     **/
17092    public function setFailCallback($callback){}
17093
17094    /**
17095     * Set client options
17096     *
17097     * Sets one or more client options.
17098     *
17099     * @param int $options The options to be set
17100     * @return bool Always returns TRUE.
17101     * @since PECL gearman >= 0.5.0
17102     **/
17103    public function setOptions($options){}
17104
17105    /**
17106     * Set a callback for collecting task status
17107     *
17108     * Sets a callback function used for getting updated status information
17109     * from a worker. The function should accept a single argument, a
17110     * GearmanTask object.
17111     *
17112     * @param callable $callback A function to call
17113     * @return bool
17114     * @since PECL gearman >= 0.5.0
17115     **/
17116    public function setStatusCallback($callback){}
17117
17118    /**
17119     * Set socket I/O activity timeout
17120     *
17121     * Sets the timeout for socket I/O activity.
17122     *
17123     * @param int $timeout An interval of time in milliseconds
17124     * @return bool Always returns TRUE.
17125     * @since PECL gearman >= 0.6.0
17126     **/
17127    public function setTimeout($timeout){}
17128
17129    /**
17130     * Set a callback for worker warnings
17131     *
17132     * Sets a function to be called when a worker sends a warning. The
17133     * callback should accept a single argument, a GearmanTask object.
17134     *
17135     * @param callable $callback A function to call
17136     * @return bool
17137     * @since PECL gearman >= 0.5.0
17138     **/
17139    public function setWarningCallback($callback){}
17140
17141    /**
17142     * Set a callback for accepting incremental data updates
17143     *
17144     * Sets a function to be called when a worker needs to send back data
17145     * prior to job completion. A worker can do this when it needs to send
17146     * updates, send partial results, or flush data during long running jobs.
17147     * The callback should accept a single argument, a GearmanTask object.
17148     *
17149     * @param callable $callback A function to call
17150     * @return bool
17151     * @since PECL gearman >= 0.5.0
17152     **/
17153    public function setWorkloadCallback($callback){}
17154
17155    /**
17156     * Get current socket I/O activity timeout value
17157     *
17158     * Returns the timeout in milliseconds to wait for I/O activity.
17159     *
17160     * @return int Timeout in milliseconds to wait for I/O activity. A
17161     *   negative value means an infinite timeout.
17162     * @since PECL gearman >= 0.6.0
17163     **/
17164    public function timeout(){}
17165
17166    /**
17167     * Create a GearmanClient instance
17168     *
17169     * Creates a GearmanClient instance representing a client that connects
17170     * to the job server and submits tasks to complete.
17171     *
17172     * @since PECL gearman >= 0.5.0
17173     **/
17174    public function __construct(){}
17175
17176}
17177class GearmanException extends Exception {
17178}
17179class GearmanJob {
17180    /**
17181     * Send the result and complete status (deprecated)
17182     *
17183     * Sends result data and the complete status update for this job.
17184     *
17185     * @param string $result Serialized result data.
17186     * @return bool
17187     * @since PECL gearman
17188     **/
17189    public function complete($result){}
17190
17191    /**
17192     * Send data for a running job (deprecated)
17193     *
17194     * Sends data to the job server (and any listening clients) for this job.
17195     *
17196     * @param string $data Arbitrary serialized data.
17197     * @return bool
17198     * @since PECL gearman
17199     **/
17200    public function data($data){}
17201
17202    /**
17203     * Send exception for running job (deprecated)
17204     *
17205     * Sends the supplied exception when this job is running.
17206     *
17207     * @param string $exception An exception description.
17208     * @return bool
17209     * @since PECL gearman
17210     **/
17211    public function exception($exception){}
17212
17213    /**
17214     * Send fail status (deprecated)
17215     *
17216     * Sends failure status for this job, indicating that the job failed in a
17217     * known way (as opposed to failing due to a thrown exception).
17218     *
17219     * @return bool
17220     * @since PECL gearman
17221     **/
17222    public function fail(){}
17223
17224    /**
17225     * Get function name
17226     *
17227     * Returns the function name for this job. This is the function the work
17228     * will execute to perform the job.
17229     *
17230     * @return string The name of a function.
17231     * @since PECL gearman >= 0.5.0
17232     **/
17233    public function functionName(){}
17234
17235    /**
17236     * Get the job handle
17237     *
17238     * Returns the opaque job handle assigned by the job server.
17239     *
17240     * @return string An opaque job handle.
17241     * @since PECL gearman >= 0.5.0
17242     **/
17243    public function handle(){}
17244
17245    /**
17246     * Get last return code
17247     *
17248     * Returns the last return code issued by the job server.
17249     *
17250     * @return int A valid Gearman return code.
17251     * @since PECL gearman >= 0.5.0
17252     **/
17253    public function returnCode(){}
17254
17255    /**
17256     * Send the result and complete status
17257     *
17258     * Sends result data and the complete status update for this job.
17259     *
17260     * @param string $result Serialized result data.
17261     * @return bool
17262     * @since PECL gearman >= 0.6.0
17263     **/
17264    public function sendComplete($result){}
17265
17266    /**
17267     * Send data for a running job
17268     *
17269     * Sends data to the job server (and any listening clients) for this job.
17270     *
17271     * @param string $data Arbitrary serialized data.
17272     * @return bool
17273     * @since PECL gearman >= 0.6.0
17274     **/
17275    public function sendData($data){}
17276
17277    /**
17278     * Send exception for running job (exception)
17279     *
17280     * Sends the supplied exception when this job is running.
17281     *
17282     * @param string $exception An exception description.
17283     * @return bool
17284     * @since PECL gearman >= 0.6.0
17285     **/
17286    public function sendException($exception){}
17287
17288    /**
17289     * Send fail status
17290     *
17291     * Sends failure status for this job, indicating that the job failed in a
17292     * known way (as opposed to failing due to a thrown exception).
17293     *
17294     * @return bool
17295     * @since PECL gearman >= 0.6.0
17296     **/
17297    public function sendFail(){}
17298
17299    /**
17300     * Send status
17301     *
17302     * Sends status information to the job server and any listening clients.
17303     * Use this to specify what percentage of the job has been completed.
17304     *
17305     * @param int $numerator The numerator of the precentage completed
17306     *   expressed as a fraction.
17307     * @param int $denominator The denominator of the precentage completed
17308     *   expressed as a fraction.
17309     * @return bool
17310     * @since PECL gearman >= 0.6.0
17311     **/
17312    public function sendStatus($numerator, $denominator){}
17313
17314    /**
17315     * Send a warning
17316     *
17317     * Sends a warning for this job while it is running.
17318     *
17319     * @param string $warning A warning message.
17320     * @return bool
17321     * @since PECL gearman >= 0.6.0
17322     **/
17323    public function sendWarning($warning){}
17324
17325    /**
17326     * Set a return value
17327     *
17328     * Sets the return value for this job, indicates how the job completed.
17329     *
17330     * @param int $gearman_return_t A valid Gearman return value.
17331     * @return bool Description...
17332     * @since PECL gearman >= 0.5.0
17333     **/
17334    public function setReturn($gearman_return_t){}
17335
17336    /**
17337     * Send status (deprecated)
17338     *
17339     * Sends status information to the job server and any listening clients.
17340     * Use this to specify what percentage of the job has been completed.
17341     *
17342     * @param int $numerator The numerator of the precentage completed
17343     *   expressed as a fraction.
17344     * @param int $denominator The denominator of the precentage completed
17345     *   expressed as a fraction.
17346     * @return bool
17347     * @since PECL gearman
17348     **/
17349    public function status($numerator, $denominator){}
17350
17351    /**
17352     * Get the unique identifier
17353     *
17354     * Returns the unique identifiter for this job. The identifier is
17355     * assigned by the client.
17356     *
17357     * @return string An opaque unique identifier.
17358     * @since PECL gearman >= 0.5.0
17359     **/
17360    public function unique(){}
17361
17362    /**
17363     * Send a warning (deprecated)
17364     *
17365     * Sends a warning for this job while it is running.
17366     *
17367     * @param string $warning A warning messages.
17368     * @return bool
17369     * @since PECL gearman
17370     **/
17371    public function warning($warning){}
17372
17373    /**
17374     * Get workload
17375     *
17376     * Returns the workload for the job. This is serialized data that is to
17377     * be processed by the worker.
17378     *
17379     * @return string Serialized data.
17380     * @since PECL gearman >= 0.5.0
17381     **/
17382    public function workload(){}
17383
17384    /**
17385     * Get size of work load
17386     *
17387     * Returns the size of the job's work load (the data the worker is to
17388     * process) in bytes.
17389     *
17390     * @return int The size in bytes.
17391     * @since PECL gearman >= 0.5.0
17392     **/
17393    public function workloadSize(){}
17394
17395    /**
17396     * Create a GearmanJob instance
17397     *
17398     * Creates a GearmanJob instance representing a job the worker is to
17399     * complete.
17400     *
17401     * @since PECL gearman >= 0.5.0
17402     **/
17403    public function __construct(){}
17404
17405}
17406class GearmanTask {
17407    /**
17408     * Create a task (deprecated)
17409     *
17410     * Returns a new GearmanTask object.
17411     *
17412     * @return GearmanTask A GearmanTask oject.
17413     * @since PECL gearman
17414     **/
17415    public function create(){}
17416
17417    /**
17418     * Get data returned for a task
17419     *
17420     * Returns data being returned for a task by a worker.
17421     *
17422     * @return string The serialized data, or FALSE if no data is present.
17423     * @since PECL gearman >= 0.5.0
17424     **/
17425    public function data(){}
17426
17427    /**
17428     * Get the size of returned data
17429     *
17430     * Returns the size of the data being returned for a task.
17431     *
17432     * @return int The data size, or FALSE if there is no data.
17433     * @since PECL gearman >= 0.5.0
17434     **/
17435    public function dataSize(){}
17436
17437    /**
17438     * Get associated function name
17439     *
17440     * Returns the name of the function this task is associated with, i.e.,
17441     * the function the Gearman worker calls.
17442     *
17443     * @return string A function name.
17444     * @since PECL gearman >= 0.6.0
17445     **/
17446    public function functionName(){}
17447
17448    /**
17449     * Determine if task is known
17450     *
17451     * Gets the status information for whether or not this task is known to
17452     * the job server.
17453     *
17454     * @return bool TRUE if the task is known, FALSE otherwise.
17455     * @since PECL gearman >= 0.5.0
17456     **/
17457    public function isKnown(){}
17458
17459    /**
17460     * Test whether the task is currently running
17461     *
17462     * Indicates whether or not this task is currently running.
17463     *
17464     * @return bool TRUE if the task is running, FALSE otherwise.
17465     * @since PECL gearman >= 0.5.0
17466     **/
17467    public function isRunning(){}
17468
17469    /**
17470     * Get the job handle
17471     *
17472     * Returns the job handle for this task.
17473     *
17474     * @return string The opaque job handle.
17475     * @since PECL gearman >= 0.5.0
17476     **/
17477    public function jobHandle(){}
17478
17479    /**
17480     * Read work or result data into a buffer for a task
17481     *
17482     * @param int $data_len Length of data to be read.
17483     * @return array An array whose first element is the length of data
17484     *   read and the second is the data buffer. Returns FALSE if the read
17485     *   failed.
17486     * @since PECL gearman >= 0.5.0
17487     **/
17488    public function recvData($data_len){}
17489
17490    /**
17491     * Get the last return code
17492     *
17493     * Returns the last Gearman return code for this task.
17494     *
17495     * @return int A valid Gearman return code.
17496     * @since PECL gearman >= 0.5.0
17497     **/
17498    public function returnCode(){}
17499
17500    /**
17501     * Send data for a task (deprecated)
17502     *
17503     * @param string $data Data to send to the worker.
17504     * @return int The length of data sent, or FALSE if the send failed.
17505     * @since PECL gearman
17506     **/
17507    public function sendData($data){}
17508
17509    /**
17510     * Send data for a task
17511     *
17512     * @param string $data Data to send to the worker.
17513     * @return int The length of data sent, or FALSE if the send failed.
17514     * @since PECL gearman >= 0.6.0
17515     **/
17516    public function sendWorkload($data){}
17517
17518    /**
17519     * Get completion percentage denominator
17520     *
17521     * Returns the denominator of the percentage of the task that is complete
17522     * expressed as a fraction.
17523     *
17524     * @return int A number between 0 and 100, or FALSE if cannot be
17525     *   determined.
17526     * @since PECL gearman >= 0.5.0
17527     **/
17528    public function taskDenominator(){}
17529
17530    /**
17531     * Get completion percentage numerator
17532     *
17533     * Returns the numerator of the percentage of the task that is complete
17534     * expressed as a fraction.
17535     *
17536     * @return int A number between 0 and 100, or FALSE if cannot be
17537     *   determined.
17538     * @since PECL gearman >= 0.5.0
17539     **/
17540    public function taskNumerator(){}
17541
17542    /**
17543     * Get the unique identifier for a task
17544     *
17545     * Returns the unique identifier for this task. This is assigned by the
17546     * GearmanClient, as opposed to the job handle which is set by the
17547     * Gearman job server.
17548     *
17549     * @return string The unique identifier, or FALSE if no identifier is
17550     *   assigned.
17551     * @since PECL gearman >= 0.6.0
17552     **/
17553    public function unique(){}
17554
17555    /**
17556     * Get the unique identifier for a task (deprecated)
17557     *
17558     * Returns the unique identifier for this task. This is assigned by the
17559     * GearmanClient, as opposed to the job handle which is set by the
17560     * Gearman job server.
17561     *
17562     * @return string The unique identifier, or FALSE if no identifier is
17563     *   assigned.
17564     * @since PECL gearman
17565     **/
17566    public function uuid(){}
17567
17568    /**
17569     * Create a GearmanTask instance
17570     *
17571     * Creates a GearmanTask instance representing a task to be submitted to
17572     * a job server.
17573     *
17574     * @since PECL gearman >= 0.5.0
17575     **/
17576    public function __construct(){}
17577
17578}
17579class GearmanWorker {
17580    /**
17581     * Register and add callback function
17582     *
17583     * Registers a function name with the job server and specifies a callback
17584     * corresponding to that function. Optionally specify extra application
17585     * context data to be used when the callback is called and a timeout.
17586     *
17587     * @param string $function_name The name of a function to register with
17588     *   the job server
17589     * @param callable $function A callback that gets called when a job for
17590     *   the registered function name is submitted
17591     * @param mixed $context A reference to arbitrary application context
17592     *   data that can be modified by the worker function
17593     * @param int $timeout An interval of time in seconds
17594     * @return bool
17595     * @since PECL gearman >= 0.5.0
17596     **/
17597    public function addFunction($function_name, $function, &$context, $timeout){}
17598
17599    /**
17600     * Add worker options
17601     *
17602     * Adds one or more options to the options previously set.
17603     *
17604     * @param int $option The options to be added
17605     * @return bool Always returns TRUE.
17606     * @since PECL gearman >= 0.6.0
17607     **/
17608    public function addOptions($option){}
17609
17610    /**
17611     * Add a job server
17612     *
17613     * Adds a job server to this worker. This goes into a list of servers
17614     * than can be used to run jobs. No socket I/O happens here.
17615     *
17616     * @param string $host
17617     * @param int $port
17618     * @return bool
17619     * @since PECL gearman >= 0.5.0
17620     **/
17621    public function addServer($host, $port){}
17622
17623    /**
17624     * Add job servers
17625     *
17626     * Adds one or more job servers to this worker. These go into a list of
17627     * servers that can be used to run jobs. No socket I/O happens here.
17628     *
17629     * @param string $servers A comma separated list of job servers in the
17630     *   format host:port. If no port is specified, it defaults to 4730.
17631     * @return bool
17632     * @since PECL gearman >= 0.5.0
17633     **/
17634    public function addServers($servers){}
17635
17636    /**
17637     * Get the last error encountered
17638     *
17639     * Returns an error string for the last error encountered.
17640     *
17641     * @return string An error string.
17642     * @since PECL gearman >= 0.5.0
17643     **/
17644    public function error(){}
17645
17646    /**
17647     * Get errno
17648     *
17649     * Returns the value of errno in the case of a GEARMAN_ERRNO return
17650     * value.
17651     *
17652     * @return int A valid errno.
17653     * @since PECL gearman >= 0.5.0
17654     **/
17655    public function getErrno(){}
17656
17657    /**
17658     * Get worker options
17659     *
17660     * Gets the options previously set for the worker.
17661     *
17662     * @return int The options currently set for the worker.
17663     * @since PECL gearman >= 0.6.0
17664     **/
17665    public function options(){}
17666
17667    /**
17668     * Register a function with the job server
17669     *
17670     * Registers a function name with the job server with an optional
17671     * timeout. The timeout specifies how many seconds the server will wait
17672     * before marking a job as failed. If the timeout is set to zero, there
17673     * is no timeout.
17674     *
17675     * @param string $function_name The name of a function to register with
17676     *   the job server
17677     * @param int $timeout An interval of time in seconds
17678     * @return bool A standard Gearman return value.
17679     * @since PECL gearman >= 0.6.0
17680     **/
17681    public function register($function_name, $timeout){}
17682
17683    /**
17684     * Remove worker options
17685     *
17686     * Removes (unsets) one or more worker options.
17687     *
17688     * @param int $option The options to be removed (unset)
17689     * @return bool Always returns TRUE.
17690     * @since PECL gearman >= 0.6.0
17691     **/
17692    public function removeOptions($option){}
17693
17694    /**
17695     * Get last Gearman return code
17696     *
17697     * Returns the last Gearman return code.
17698     *
17699     * @return int A valid Gearman return code.
17700     * @since PECL gearman >= 0.5.0
17701     **/
17702    public function returnCode(){}
17703
17704    /**
17705     * Give the worker an identifier so it can be tracked when asking
17706     * gearmand for the list of available workers
17707     *
17708     * Assigns the worker an identifier.
17709     *
17710     * @param string $id A string identifier.
17711     * @return bool
17712     **/
17713    public function setId($id){}
17714
17715    /**
17716     * Set worker options
17717     *
17718     * Sets one or more options to the supplied value.
17719     *
17720     * @param int $option The options to be set
17721     * @return bool Always returns TRUE.
17722     * @since PECL gearman >= 0.5.0
17723     **/
17724    public function setOptions($option){}
17725
17726    /**
17727     * Set socket I/O activity timeout
17728     *
17729     * Sets the interval of time to wait for socket I/O activity.
17730     *
17731     * @param int $timeout An interval of time in milliseconds. A negative
17732     *   value indicates an infinite timeout.
17733     * @return bool Always returns TRUE.
17734     * @since PECL gearman >= 0.6.0
17735     **/
17736    public function setTimeout($timeout){}
17737
17738    /**
17739     * Get socket I/O activity timeout
17740     *
17741     * Returns the current time to wait, in milliseconds, for socket I/O
17742     * activity.
17743     *
17744     * @return int A time period is milliseconds. A negative value
17745     *   indicates an infinite timeout.
17746     * @since PECL gearman >= 0.6.0
17747     **/
17748    public function timeout(){}
17749
17750    /**
17751     * Unregister a function name with the job servers
17752     *
17753     * Unregisters a function name with the job servers ensuring that no more
17754     * jobs (for that function) are sent to this worker.
17755     *
17756     * @param string $function_name The name of a function to register with
17757     *   the job server
17758     * @return bool A standard Gearman return value.
17759     * @since PECL gearman >= 0.6.0
17760     **/
17761    public function unregister($function_name){}
17762
17763    /**
17764     * Unregister all function names with the job servers
17765     *
17766     * Unregisters all previously registered functions, ensuring that no more
17767     * jobs are sent to this worker.
17768     *
17769     * @return bool A standard Gearman return value.
17770     * @since PECL gearman >= 0.6.0
17771     **/
17772    public function unregisterAll(){}
17773
17774    /**
17775     * Wait for activity from one of the job servers
17776     *
17777     * Causes the worker to wait for activity from one of the Gearman job
17778     * servers when operating in non-blocking I/O mode. On failure, issues a
17779     * E_WARNING with the last Gearman error encountered.
17780     *
17781     * @return bool
17782     * @since PECL gearman >= 0.6.0
17783     **/
17784    public function wait(){}
17785
17786    /**
17787     * Wait for and perform jobs
17788     *
17789     * Waits for a job to be assigned and then calls the appropriate callback
17790     * function. Issues an E_WARNING with the last Gearman error if the
17791     * return code is not one of GEARMAN_SUCCESS, GEARMAN_IO_WAIT, or
17792     * GEARMAN_WORK_FAIL.
17793     *
17794     * @return bool
17795     * @since PECL gearman >= 0.5.0
17796     **/
17797    public function work(){}
17798
17799    /**
17800     * Create a GearmanWorker instance
17801     *
17802     * Creates a GearmanWorker instance representing a worker that connects
17803     * to the job server and accepts tasks to run.
17804     *
17805     * @since PECL gearman >= 0.5.0
17806     **/
17807    public function __construct(){}
17808
17809}
17810namespace Gender {
17811class Gender {
17812    /**
17813     * Connect to an external name dictionary
17814     *
17815     * Connect to an external name dictionary. Currently only streams are
17816     * supported.
17817     *
17818     * @param string $dsn DSN to open.
17819     * @return bool Boolean as success of failure.
17820     **/
17821    public function connect($dsn){}
17822
17823    /**
17824     * Get textual country representation
17825     *
17826     * Returns the textual representation of a country from a Gender class
17827     * constant.
17828     *
17829     * @param int $country A country ID specified by a Gender\Gender class
17830     *   constant.
17831     * @return array Returns an array with the short and full names of the
17832     *   country on success .
17833     **/
17834    public function country($country){}
17835
17836    /**
17837     * Get gender of a name
17838     *
17839     * Get the gender of the name in a particular country.
17840     *
17841     * @param string $name Name to check.
17842     * @param int $country Country id identified by Gender class constant.
17843     * @return int Returns gender of the name.
17844     **/
17845    public function get($name, $country){}
17846
17847    /**
17848     * Check if the name0 is an alias of the name1
17849     *
17850     * Check whether the name0 is a nick of the name1.
17851     *
17852     * @param string $name0 Name to check.
17853     * @param string $name1 Name to check.
17854     * @param int $country Country id identified by Gender class constant.
17855     *   If ommited ANY_COUNTRY is used.
17856     * @return array
17857     **/
17858    public function isNick($name0, $name1, $country){}
17859
17860    /**
17861     * Get similar names
17862     *
17863     * Get similar names for the given name and country.
17864     *
17865     * @param string $name Name to check.
17866     * @param int $country Country id identified by Gender class constant.
17867     *   If ommited ANY_COUNTRY is used.
17868     * @return array Returns an array with the similar names found.
17869     **/
17870    public function similarNames($name, $country){}
17871
17872    /**
17873     * Construct the Gender object
17874     *
17875     * Create a Gender object optionally connecting to an external name
17876     * dictionary. When no external database was given, compiled in data will
17877     * be used.
17878     *
17879     * @param string $dsn DSN to open.
17880     **/
17881    public function __construct($dsn){}
17882
17883}
17884}
17885/**
17886 * Generator objects are returned from generators.
17887 **/
17888class Generator implements Iterator {
17889    /**
17890     * Get the yielded value
17891     *
17892     * @return mixed Returns the yielded value.
17893     * @since PHP 5 >= 5.5.0, PHP 7
17894     **/
17895    public function current(){}
17896
17897    /**
17898     * Get the return value of a generator
17899     *
17900     * @return mixed Returns the generator's return value once it has
17901     *   finished executing.
17902     * @since PHP 7
17903     **/
17904    public function getReturn(){}
17905
17906    /**
17907     * Get the yielded key
17908     *
17909     * Gets the key of the yielded value.
17910     *
17911     * @return mixed Returns the yielded key.
17912     * @since PHP 5 >= 5.5.0, PHP 7
17913     **/
17914    public function key(){}
17915
17916    /**
17917     * Resume execution of the generator
17918     *
17919     * Calling Generator::next has the same effect as calling Generator::send
17920     * with NULL as argument.
17921     *
17922     * @return void
17923     * @since PHP 5 >= 5.5.0, PHP 7
17924     **/
17925    public function next(){}
17926
17927    /**
17928     * Rewind the iterator
17929     *
17930     * If iteration has already begun, this will throw an exception.
17931     *
17932     * @return void
17933     * @since PHP 5 >= 5.5.0, PHP 7
17934     **/
17935    public function rewind(){}
17936
17937    /**
17938     * Send a value to the generator
17939     *
17940     * Sends the given value to the generator as the result of the current
17941     * expression and resumes execution of the generator.
17942     *
17943     * If the generator is not at a expression when this method is called, it
17944     * will first be let to advance to the first expression before sending
17945     * the value. As such it is not necessary to "prime" PHP generators with
17946     * a Generator::next call (like it is done in Python).
17947     *
17948     * @param mixed $value Value to send into the generator. This value
17949     *   will be the return value of the expression the generator is
17950     *   currently at.
17951     * @return mixed Returns the yielded value.
17952     * @since PHP 5 >= 5.5.0, PHP 7
17953     **/
17954    public function send($value){}
17955
17956    /**
17957     * Throw an exception into the generator
17958     *
17959     * Throws an exception into the generator and resumes execution of the
17960     * generator. The behavior will be the same as if the current expression
17961     * was replaced with a throw $exception statement.
17962     *
17963     * If the generator is already closed when this method is invoked, the
17964     * exception will be thrown in the caller's context instead.
17965     *
17966     * @param Throwable $exception Exception to throw into the generator.
17967     * @return mixed Returns the yielded value.
17968     * @since PHP 5 >= 5.5.0, PHP 7
17969     **/
17970    public function throw($exception){}
17971
17972    /**
17973     * Check if the iterator has been closed
17974     *
17975     * @return bool Returns FALSE if the iterator has been closed.
17976     *   Otherwise returns TRUE.
17977     * @since PHP 5 >= 5.5.0, PHP 7
17978     **/
17979    public function valid(){}
17980
17981    /**
17982     * Serialize callback
17983     *
17984     * Throws an exception as generators can't be serialized.
17985     *
17986     * @return void
17987     * @since PHP 5 >= 5.5.0, PHP 7
17988     **/
17989    public function __wakeup(){}
17990
17991}
17992/**
17993 * Absolute value
17994 *
17995 * Returns the absolute value of {@link number}.
17996 *
17997 * @param mixed $number The numeric value to process
17998 * @return number The absolute value of {@link number}. If the argument
17999 *   {@link number} is of type float, the return type is also float,
18000 *   otherwise it is integer (as float usually has a bigger value range
18001 *   than integer).
18002 * @since PHP 4, PHP 5, PHP 7
18003 **/
18004function abs($number){}
18005
18006/**
18007 * Arc cosine
18008 *
18009 * Returns the arc cosine of {@link arg} in radians. {@link acos} is the
18010 * inverse function of {@link cos}, which means that a==cos(acos(a)) for
18011 * every value of a that is within {@link acos}' range.
18012 *
18013 * @param float $arg The argument to process
18014 * @return float The arc cosine of {@link arg} in radians.
18015 * @since PHP 4, PHP 5, PHP 7
18016 **/
18017function acos($arg){}
18018
18019/**
18020 * Inverse hyperbolic cosine
18021 *
18022 * Returns the inverse hyperbolic cosine of {@link arg}, i.e. the value
18023 * whose hyperbolic cosine is {@link arg}.
18024 *
18025 * @param float $arg The value to process
18026 * @return float The inverse hyperbolic cosine of {@link arg}
18027 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
18028 **/
18029function acosh($arg){}
18030
18031/**
18032 * Quote string with slashes in a C style
18033 *
18034 * Returns a string with backslashes before characters that are listed in
18035 * {@link charlist} parameter.
18036 *
18037 * @param string $str The string to be escaped.
18038 * @param string $charlist A list of characters to be escaped. If
18039 *   {@link charlist} contains characters \n, \r etc., they are converted
18040 *   in C-like style, while other non-alphanumeric characters with ASCII
18041 *   codes lower than 32 and higher than 126 converted to octal
18042 *   representation. When you define a sequence of characters in the
18043 *   charlist argument make sure that you know what characters come
18044 *   between the characters that you set as the start and end of the
18045 *   range.
18046 *
18047 *   <?php echo addcslashes('foo[ ]', 'A..z'); // output: \f\o\o\[ \] //
18048 *   All upper and lower-case letters will be escaped // ... but so will
18049 *   the [\]^_` ?>
18050 *
18051 *   Also, if the first character in a range has a higher ASCII value
18052 *   than the second character in the range, no range will be
18053 *   constructed. Only the start, end and period characters will be
18054 *   escaped. Use the {@link ord} function to find the ASCII value for a
18055 *   character.
18056 *
18057 *   <?php echo addcslashes("zoo['.']", 'z..A'); // output: \zoo['\.'] ?>
18058 *
18059 *   Be careful if you choose to escape characters 0, a, b, f, n, r, t
18060 *   and v. They will be converted to \0, \a, \b, \f, \n, \r, \t and \v,
18061 *   all of which are predefined escape sequences in C. Many of these
18062 *   sequences are also defined in other C-derived languages, including
18063 *   PHP, meaning that you may not get the desired result if you use the
18064 *   output of {@link addcslashes} to generate code in those languages
18065 *   with these characters defined in {@link charlist}.
18066 * @return string Returns the escaped string.
18067 * @since PHP 4, PHP 5, PHP 7
18068 **/
18069function addcslashes($str, $charlist){}
18070
18071/**
18072 * Adds a solid fill to the shape
18073 *
18074 * {@link SWFShape::addFill} adds a solid fill to the shape's list of
18075 * fill styles. {@link SWFShape::addFill} accepts three different types
18076 * of arguments.
18077 *
18078 * {@link red}, {@link green}, {@link blue} is a color (RGB mode).
18079 *
18080 * The {@link bitmap} argument is an {@link SWFBitmap} object. The {@link
18081 * flags} argument can be one of the following values:
18082 * SWFFILL_CLIPPED_BITMAP, SWFFILL_TILED_BITMAP, SWFFILL_LINEAR_GRADIENT
18083 * or SWFFILL_RADIAL_GRADIENT. Default is SWFFILL_TILED_BITMAP for
18084 * SWFBitmap and SWFFILL_LINEAR_GRADIENT for SWFGradient.
18085 *
18086 * The {@link gradient} argument is an {@link SWFGradient} object. The
18087 * flags argument can be one of the following values :
18088 * SWFFILL_RADIAL_GRADIENT or SWFFILL_LINEAR_GRADIENT. Default is
18089 * SWFFILL_LINEAR_GRADIENT. I'm sure about this one. Really.
18090 *
18091 * {@link SWFShape::addFill} returns an {@link SWFFill} object for use
18092 * with the {@link SWFShape::setLeftFill} and {@link
18093 * SWFShape::setRightFill} functions described below.
18094 *
18095 * @param SWFBitmap $bitmap
18096 * @param int $flags
18097 * @return SWFFill
18098 **/
18099function addFill($bitmap, $flags){}
18100
18101/**
18102 * Quote string with slashes
18103 *
18104 * Returns a string with backslashes added before characters that need to
18105 * be escaped. These characters are: single quote (') double quote (")
18106 * backslash (\) NUL (the NUL byte)
18107 *
18108 * A use case of {@link addslashes} is escaping the aforementioned
18109 * characters in a string that is to be evaluated by PHP:
18110 *
18111 * <?php $str = "O'Reilly?"; eval("echo '" . addslashes($str) . "';"); ?>
18112 *
18113 * Prior to PHP 5.4.0, the PHP directive magic_quotes_gpc was on by
18114 * default and it essentially ran {@link addslashes} on all GET, POST and
18115 * COOKIE data. {@link addslashes} must not be used on strings that have
18116 * already been escaped with magic_quotes_gpc, as the strings will be
18117 * double escaped. {@link get_magic_quotes_gpc} can be used to check if
18118 * magic_quotes_gpc is on.
18119 *
18120 * The {@link addslashes} is sometimes incorrectly used to try to prevent
18121 * SQL Injection. Instead, database-specific escaping functions and/or
18122 * prepared statements should be used.
18123 *
18124 * @param string $str The string to be escaped.
18125 * @return string Returns the escaped string.
18126 * @since PHP 4, PHP 5, PHP 7
18127 **/
18128function addslashes($str){}
18129
18130/**
18131 * Terminate apache process after this request
18132 *
18133 * {@link apache_child_terminate} will register the Apache process
18134 * executing the current PHP request for termination once execution of
18135 * PHP code is completed. It may be used to terminate a process after a
18136 * script with high memory consumption has been run as memory will
18137 * usually only be freed internally but not given back to the operating
18138 * system.
18139 *
18140 * @return bool Returns TRUE if PHP is running as an Apache 1 module,
18141 *   the Apache version is non-multithreaded, and the child_terminate PHP
18142 *   directive is enabled (disabled by default). If these conditions are
18143 *   not met, FALSE is returned and an error of level E_WARNING is
18144 *   generated.
18145 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
18146 **/
18147function apache_child_terminate(){}
18148
18149/**
18150 * Get an Apache subprocess_env variable
18151 *
18152 * Retrieve an Apache environment variable specified by {@link variable}.
18153 *
18154 * This function requires Apache 2 otherwise it's undefined.
18155 *
18156 * @param string $variable The Apache environment variable
18157 * @param bool $walk_to_top Whether to get the top-level variable
18158 *   available to all Apache layers.
18159 * @return string The value of the Apache environment variable on
18160 *   success, or FALSE on failure
18161 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
18162 **/
18163function apache_getenv($variable, $walk_to_top){}
18164
18165/**
18166 * Get a list of loaded Apache modules
18167 *
18168 * @return array An array of loaded Apache modules.
18169 * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
18170 **/
18171function apache_get_modules(){}
18172
18173/**
18174 * Fetch Apache version
18175 *
18176 * Fetch the Apache version.
18177 *
18178 * @return string Returns the Apache version on success.
18179 * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
18180 **/
18181function apache_get_version(){}
18182
18183/**
18184 * Perform a partial request for the specified URI and return all info
18185 * about it
18186 *
18187 * This performs a partial request for a URI. It goes just far enough to
18188 * obtain all the important information about the given resource.
18189 *
18190 * @param string $filename The filename (URI) that's being requested.
18191 * @return object An object of related URI information. The properties
18192 *   of this object are:
18193 * @since PHP 4, PHP 5, PHP 7
18194 **/
18195function apache_lookup_uri($filename){}
18196
18197/**
18198 * Get and set apache request notes
18199 *
18200 * This function is a wrapper for Apache's table_get and table_set. It
18201 * edits the table of notes that exists during a request. The table's
18202 * purpose is to allow Apache modules to communicate.
18203 *
18204 * The main use for {@link apache_note} is to pass information from one
18205 * module to another within the same request.
18206 *
18207 * @param string $note_name The name of the note.
18208 * @return string If called with one argument, it returns the current
18209 *   value of note note_name. If called with two arguments, it sets the
18210 *   value of note note_name to note_value and returns the previous value
18211 *   of note note_name. If the note cannot be retrieved, FALSE is
18212 *   returned.
18213 * @since PHP 4, PHP 5, PHP 7
18214 **/
18215function apache_note($note_name){}
18216
18217/**
18218 * Fetch all HTTP request headers
18219 *
18220 * Fetches all HTTP request headers from the current request.
18221 *
18222 * @return array An associative array of all the HTTP headers in the
18223 *   current request, or FALSE on failure.
18224 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
18225 **/
18226function apache_request_headers(){}
18227
18228/**
18229 * Reset the Apache write timer
18230 *
18231 * {@link apache_reset_timeout} resets the Apache write timer, which
18232 * defaults to 300 seconds. With set_time_limit(0);
18233 * ignore_user_abort(true) and periodic {@link apache_reset_timeout}
18234 * calls, Apache can theoretically run forever.
18235 *
18236 * This function requires Apache 1.
18237 *
18238 * @return bool
18239 * @since PHP 5 >= 5.1.0, PHP 7
18240 **/
18241function apache_reset_timeout(){}
18242
18243/**
18244 * Fetch all HTTP response headers
18245 *
18246 * @return array An array of all Apache response headers on success.
18247 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
18248 **/
18249function apache_response_headers(){}
18250
18251/**
18252 * Set an Apache subprocess_env variable
18253 *
18254 * {@link apache_setenv} sets the value of the Apache environment
18255 * variable specified by {@link variable}.
18256 *
18257 * @param string $variable The environment variable that's being set.
18258 * @param string $value The new {@link variable} value.
18259 * @param bool $walk_to_top Whether to set the top-level variable
18260 *   available to all Apache layers.
18261 * @return bool
18262 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
18263 **/
18264function apache_setenv($variable, $value, $walk_to_top){}
18265
18266/**
18267 * Cache a new variable in the data store
18268 *
18269 * Caches a variable in the data store, only if it's not already stored.
18270 *
18271 * @param string $key Store the variable using this name. {@link key}s
18272 *   are cache-unique, so attempting to use {@link apcu_add} to store
18273 *   data with a key that already exists will not overwrite the existing
18274 *   data, and will instead return FALSE. (This is the only difference
18275 *   between {@link apcu_add} and {@link apcu_store}.)
18276 * @param mixed $var The variable to store
18277 * @param int $ttl Time To Live; store {@link var} in the cache for
18278 *   {@link ttl} seconds. After the {@link ttl} has passed, the stored
18279 *   variable will be expunged from the cache (on the next request). If
18280 *   no {@link ttl} is supplied (or if the {@link ttl} is 0), the value
18281 *   will persist until it is removed from the cache manually, or
18282 *   otherwise fails to exist in the cache (clear, restart, etc.).
18283 * @return bool Returns TRUE if something has effectively been added
18284 *   into the cache, FALSE otherwise. Second syntax returns array with
18285 *   error keys.
18286 * @since PECL apcu >= 4.0.0
18287 **/
18288function apcu_add($key, $var, $ttl){}
18289
18290/**
18291 * Retrieves cached information from APCu's data store
18292 *
18293 * Retrieves cached information and meta-data from APC's data store.
18294 *
18295 * @param bool $limited If {@link limited} is TRUE, the return value
18296 *   will exclude the individual list of cache entries. This is useful
18297 *   when trying to optimize calls for statistics gathering.
18298 * @return array Array of cached data (and meta-data)
18299 * @since PECL apcu >= 4.0.0
18300 **/
18301function apcu_cache_info($limited){}
18302
18303/**
18304 * Updates an old value with a new value
18305 *
18306 * {@link apcu_cas} updates an already existing integer value if the
18307 * {@link old} parameter matches the currently stored value with the
18308 * value of the {@link new} parameter.
18309 *
18310 * @param string $key The key of the value being updated.
18311 * @param int $old The old value (the value currently stored).
18312 * @param int $new The new value to update to.
18313 * @return bool
18314 * @since PECL apcu >= 4.0.0
18315 **/
18316function apcu_cas($key, $old, $new){}
18317
18318/**
18319 * Clears the APCu cache
18320 *
18321 * Clears the cache.
18322 *
18323 * @return bool Returns TRUE always
18324 * @since PECL apcu >= 4.0.0
18325 **/
18326function apcu_clear_cache(){}
18327
18328/**
18329 * Decrease a stored number
18330 *
18331 * Decreases a stored integer value.
18332 *
18333 * @param string $key The key of the value being decreased.
18334 * @param int $step The step, or value to decrease.
18335 * @param bool $success Optionally pass the success or fail boolean
18336 *   value to this referenced variable.
18337 * @param int $ttl TTL to use if the operation inserts a new value
18338 *   (rather than decrementing an existing one).
18339 * @return int Returns the current value of {@link key}'s value on
18340 *   success,
18341 * @since PECL apcu >= 4.0.0
18342 **/
18343function apcu_dec($key, $step, &$success, $ttl){}
18344
18345/**
18346 * Removes a stored variable from the cache
18347 *
18348 * Removes a stored variable from the cache.
18349 *
18350 * @param mixed $key A {@link key} used to store the value as a string
18351 *   for a single key, or as an array of strings for several keys, or as
18352 *   an APCUIterator object.
18353 * @return mixed If {@link key} is an , an indexed of the keys is
18354 *   returned. Otherwise TRUE is returned on success, or FALSE on
18355 *   failure.
18356 * @since PECL apcu >= 4.0.0
18357 **/
18358function apcu_delete($key){}
18359
18360/**
18361 * Whether APCu is usable in the current environment
18362 *
18363 * Returns whether APCu is usable in the current environment.
18364 *
18365 * @return bool Returns TRUE when APCu is usable in the current
18366 *   environment, FALSE otherwise.
18367 * @since PECL apcu >= 4.0.3
18368 **/
18369function apcu_enabled(){}
18370
18371/**
18372 * Atomically fetch or generate a cache entry
18373 *
18374 * Atomically attempts to find {@link key} in the cache, if it cannot be
18375 * found {@link generator} is called, passing {@link key} as the only
18376 * argument. The return value of the call is then cached with the
18377 * optionally specified {@link ttl}, and returned.
18378 *
18379 * @param string $key Identity of cache entry
18380 * @param callable $generator A callable that accepts {@link key} as
18381 *   the only argument and returns the value to cache.
18382 * @param int $ttl Time To Live; store {@link var} in the cache for
18383 *   {@link ttl} seconds. After the {@link ttl} has passed, the stored
18384 *   variable will be expunged from the cache (on the next request). If
18385 *   no {@link ttl} is supplied (or if the {@link ttl} is 0), the value
18386 *   will persist until it is removed from the cache manually, or
18387 *   otherwise fails to exist in the cache (clear, restart, etc.).
18388 * @return mixed Returns the cached value
18389 * @since PECL apcu >= 5.1.0
18390 **/
18391function apcu_entry($key, $generator, $ttl){}
18392
18393/**
18394 * Checks if entry exists
18395 *
18396 * Checks if one or more APCu entries exist.
18397 *
18398 * @param mixed $keys A string, or an array of strings, that contain
18399 *   keys.
18400 * @return mixed Returns TRUE if the key exists, otherwise FALSE Or if
18401 *   an array was passed to {@link keys}, then an array is returned that
18402 *   contains all existing keys, or an empty array if none exist.
18403 * @since PECL apcu >= 4.0.0
18404 **/
18405function apcu_exists($keys){}
18406
18407/**
18408 * Fetch a stored variable from the cache
18409 *
18410 * Fetches an entry from the cache.
18411 *
18412 * @param mixed $key The {@link key} used to store the value (with
18413 *   {@link apcu_store}). If an array is passed then each element is
18414 *   fetched and returned.
18415 * @param bool $success Set to TRUE in success and FALSE in failure.
18416 * @return mixed The stored variable or array of variables on success;
18417 *   FALSE on failure
18418 * @since PECL apcu >= 4.0.0
18419 **/
18420function apcu_fetch($key, &$success){}
18421
18422/**
18423 * Increase a stored number
18424 *
18425 * Increases a stored number.
18426 *
18427 * @param string $key The key of the value being increased.
18428 * @param int $step The step, or value to increase.
18429 * @param bool $success Optionally pass the success or fail boolean
18430 *   value to this referenced variable.
18431 * @param int $ttl TTL to use if the operation inserts a new value
18432 *   (rather than incrementing an existing one).
18433 * @return int Returns the current value of {@link key}'s value on
18434 *   success,
18435 * @since PECL apcu >= 4.0.0
18436 **/
18437function apcu_inc($key, $step, &$success, $ttl){}
18438
18439/**
18440 * Retrieves APCu Shared Memory Allocation information
18441 *
18442 * Retrieves APCu Shared Memory Allocation information.
18443 *
18444 * @param bool $limited When set to FALSE (default) {@link
18445 *   apcu_sma_info} will return a detailed information about each
18446 *   segment.
18447 * @return array Array of Shared Memory Allocation data; FALSE on
18448 *   failure.
18449 * @since PECL apcu >= 4.0.0
18450 **/
18451function apcu_sma_info($limited){}
18452
18453/**
18454 * Cache a variable in the data store
18455 *
18456 * Cache a variable in the data store.
18457 *
18458 * @param string $key Store the variable using this name. {@link key}s
18459 *   are cache-unique, so storing a second value with the same {@link
18460 *   key} will overwrite the original value.
18461 * @param mixed $var The variable to store
18462 * @param int $ttl Time To Live; store {@link var} in the cache for
18463 *   {@link ttl} seconds. After the {@link ttl} has passed, the stored
18464 *   variable will be expunged from the cache (on the next request). If
18465 *   no {@link ttl} is supplied (or if the {@link ttl} is 0), the value
18466 *   will persist until it is removed from the cache manually, or
18467 *   otherwise fails to exist in the cache (clear, restart, etc.).
18468 * @return bool Second syntax returns array with error keys.
18469 * @since PECL apcu >= 4.0.0
18470 **/
18471function apcu_store($key, $var, $ttl){}
18472
18473/**
18474 * Cache a new variable in the data store
18475 *
18476 * Caches a variable in the data store, only if it's not already stored.
18477 *
18478 * @param string $key Store the variable using this name. {@link key}s
18479 *   are cache-unique, so attempting to use {@link apc_add} to store data
18480 *   with a key that already exists will not overwrite the existing data,
18481 *   and will instead return FALSE. (This is the only difference between
18482 *   {@link apc_add} and {@link apc_store}.)
18483 * @param mixed $var The variable to store
18484 * @param int $ttl Time To Live; store {@link var} in the cache for
18485 *   {@link ttl} seconds. After the {@link ttl} has passed, the stored
18486 *   variable will be expunged from the cache (on the next request). If
18487 *   no {@link ttl} is supplied (or if the {@link ttl} is 0), the value
18488 *   will persist until it is removed from the cache manually, or
18489 *   otherwise fails to exist in the cache (clear, restart, etc.).
18490 * @return bool Returns TRUE if something has effectively been added
18491 *   into the cache, FALSE otherwise. Second syntax returns array with
18492 *   error keys.
18493 * @since PECL apc >= 3.0.13
18494 **/
18495function apc_add($key, $var, $ttl){}
18496
18497/**
18498 * Get a binary dump of the given files and user variables
18499 *
18500 * Returns a binary dump of the given files and user variables from the
18501 * APC cache. A NULL for files or user_vars signals a dump of every
18502 * entry, whereas array() will dump nothing.
18503 *
18504 * @param array $files The files. Passing in NULL signals a dump of
18505 *   every entry, while passing in {@link array} will dump nothing.
18506 * @param array $user_vars The user vars. Passing in NULL signals a
18507 *   dump of every entry, while passing in {@link array} will dump
18508 *   nothing.
18509 * @return string Returns a binary dump of the given files and user
18510 *   variables from the APC cache, FALSE if APC is not enabled, or NULL
18511 *   if an unknown error is encountered.
18512 * @since PECL apc >= 3.1.4
18513 **/
18514function apc_bin_dump($files, $user_vars){}
18515
18516/**
18517 * Output a binary dump of cached files and user variables to a file
18518 *
18519 * Outputs a binary dump of the given files and user variables from the
18520 * APC cache to the named file.
18521 *
18522 * @param array $files The file names being dumped.
18523 * @param array $user_vars The user variables being dumped.
18524 * @param string $filename The filename where the dump is being saved.
18525 * @param int $flags Flags passed to the {@link filename} stream. See
18526 *   the {@link file_put_contents} documentation for details.
18527 * @param resource $context The context passed to the {@link filename}
18528 *   stream. See the {@link file_put_contents} documentation for details.
18529 * @return int The number of bytes written to the file, otherwise FALSE
18530 *   if APC is not enabled, {@link filename} is an invalid file name,
18531 *   {@link filename} can't be opened, the file dump can't be completed
18532 *   (e.g., the hard drive is out of disk space), or an unknown error was
18533 *   encountered.
18534 * @since PECL apc >= 3.1.4
18535 **/
18536function apc_bin_dumpfile($files, $user_vars, $filename, $flags, $context){}
18537
18538/**
18539 * Load a binary dump into the APC file/user cache
18540 *
18541 * Loads the given binary dump into the APC file/user cache.
18542 *
18543 * @param string $data The binary dump being loaded, likely from {@link
18544 *   apc_bin_dump}.
18545 * @param int $flags Either APC_BIN_VERIFY_CRC32, APC_BIN_VERIFY_MD5,
18546 *   or both.
18547 * @return bool Returns TRUE if the binary dump {@link data} was loaded
18548 *   with success, otherwise FALSE is returned. FALSE is returned if APC
18549 *   is not enabled, or if the {@link data} is not a valid APC binary
18550 *   dump (e.g., unexpected size).
18551 * @since PECL apc >= 3.1.4
18552 **/
18553function apc_bin_load($data, $flags){}
18554
18555/**
18556 * Load a binary dump from a file into the APC file/user cache
18557 *
18558 * Loads a binary dump from a file into the APC file/user cache.
18559 *
18560 * @param string $filename The file name containing the dump, likely
18561 *   from {@link apc_bin_dumpfile}.
18562 * @param resource $context The files context.
18563 * @param int $flags Either APC_BIN_VERIFY_CRC32, APC_BIN_VERIFY_MD5,
18564 *   or both.
18565 * @return bool Returns TRUE on success, otherwise FALSE Reasons it may
18566 *   return FALSE include APC is not enabled, {@link filename} is an
18567 *   invalid file name or empty, {@link filename} can't be opened, the
18568 *   file dump can't be completed, or if the {@link data} is not a valid
18569 *   APC binary dump (e.g., unexpected size).
18570 * @since PECL apc >= 3.1.4
18571 **/
18572function apc_bin_loadfile($filename, $context, $flags){}
18573
18574/**
18575 * Retrieves cached information from APC's data store
18576 *
18577 * Retrieves cached information and meta-data from APC's data store.
18578 *
18579 * @param string $cache_type If {@link cache_type} is "user",
18580 *   information about the user cache will be returned. If {@link
18581 *   cache_type} is "filehits", information about which files have been
18582 *   served from the bytecode cache for the current request will be
18583 *   returned. This feature must be enabled at compile time using
18584 *   --enable-filehits. If an invalid or no {@link cache_type} is
18585 *   specified, information about the system cache (cached files) will be
18586 *   returned.
18587 * @param bool $limited If {@link limited} is TRUE, the return value
18588 *   will exclude the individual list of cache entries. This is useful
18589 *   when trying to optimize calls for statistics gathering.
18590 * @return array Array of cached data (and meta-data)
18591 * @since PECL apc >= 2.0.0
18592 **/
18593function apc_cache_info($cache_type, $limited){}
18594
18595/**
18596 * Updates an old value with a new value
18597 *
18598 * {@link apc_cas} updates an already existing integer value if the
18599 * {@link old} parameter matches the currently stored value with the
18600 * value of the {@link new} parameter.
18601 *
18602 * @param string $key The key of the value being updated.
18603 * @param int $old The old value (the value currently stored).
18604 * @param int $new The new value to update to.
18605 * @return bool
18606 * @since PECL apc >= 3.1.1
18607 **/
18608function apc_cas($key, $old, $new){}
18609
18610/**
18611 * Clears the APC cache
18612 *
18613 * Clears the user/system cache.
18614 *
18615 * @param string $cache_type If {@link cache_type} is "user", the user
18616 *   cache will be cleared; otherwise, the system cache (cached files)
18617 *   will be cleared.
18618 * @return bool Returns TRUE always
18619 * @since PECL apc >= 2.0.0
18620 **/
18621function apc_clear_cache($cache_type){}
18622
18623/**
18624 * Stores a file in the bytecode cache, bypassing all filters
18625 *
18626 * Stores a file in the bytecode cache, bypassing all filters.
18627 *
18628 * @param string $filename Full or relative path to a PHP file that
18629 *   will be compiled and stored in the bytecode cache.
18630 * @param bool $atomic
18631 * @return mixed
18632 * @since PECL apc >= 3.0.13
18633 **/
18634function apc_compile_file($filename, $atomic){}
18635
18636/**
18637 * Decrease a stored number
18638 *
18639 * Decreases a stored integer value.
18640 *
18641 * @param string $key The key of the value being decreased.
18642 * @param int $step The step, or value to decrease.
18643 * @param bool $success Optionally pass the success or fail boolean
18644 *   value to this referenced variable.
18645 * @return int Returns the current value of {@link key}'s value on
18646 *   success,
18647 * @since PECL apc >= 3.1.1
18648 **/
18649function apc_dec($key, $step, &$success){}
18650
18651/**
18652 * Defines a set of constants for retrieval and mass-definition
18653 *
18654 * {@link define} is notoriously slow. Since the main benefit of APC is
18655 * to increase the performance of scripts/applications, this mechanism is
18656 * provided to streamline the process of mass constant definition.
18657 * However, this function does not perform as well as anticipated.
18658 *
18659 * For a better-performing solution, try the hidef extension from PECL.
18660 *
18661 * @param string $key The {@link key} serves as the name of the
18662 *   constant set being stored. This {@link key} is used to retrieve the
18663 *   stored constants in {@link apc_load_constants}.
18664 * @param array $constants An associative array of constant_name =>
18665 *   value pairs. The constant_name must follow the normal constant
18666 *   naming rules. value must evaluate to a scalar value.
18667 * @param bool $case_sensitive The default behaviour for constants is
18668 *   to be declared case-sensitive; i.e. CONSTANT and Constant represent
18669 *   different values. If this parameter evaluates to FALSE the constants
18670 *   will be declared as case-insensitive symbols.
18671 * @return bool
18672 * @since PECL apc >= 3.0.0
18673 **/
18674function apc_define_constants($key, $constants, $case_sensitive){}
18675
18676/**
18677 * Removes a stored variable from the cache
18678 *
18679 * Removes a stored variable from the cache.
18680 *
18681 * @param string $key The {@link key} used to store the value (with
18682 *   {@link apc_store}).
18683 * @return mixed
18684 * @since PECL apc >= 3.0.0
18685 **/
18686function apc_delete($key){}
18687
18688/**
18689 * Deletes files from the opcode cache
18690 *
18691 * Deletes the given files from the opcode cache.
18692 *
18693 * @param mixed $keys The files to be deleted. Accepts a string, array
18694 *   of strings, or an APCIterator object.
18695 * @return mixed Or if {@link keys} is an array, then an empty array is
18696 *   returned on success, or an array of failed files is returned.
18697 * @since PECL apc >= 3.1.1
18698 **/
18699function apc_delete_file($keys){}
18700
18701/**
18702 * Checks if APC key exists
18703 *
18704 * Checks if one or more APC keys exist.
18705 *
18706 * @param mixed $keys A string, or an array of strings, that contain
18707 *   keys.
18708 * @return mixed Returns TRUE if the key exists, otherwise FALSE Or if
18709 *   an array was passed to {@link keys}, then an array is returned that
18710 *   contains all existing keys, or an empty array if none exist.
18711 * @since PECL apc >= 3.1.4
18712 **/
18713function apc_exists($keys){}
18714
18715/**
18716 * Fetch a stored variable from the cache
18717 *
18718 * Fetches a stored variable from the cache.
18719 *
18720 * @param mixed $key The {@link key} used to store the value (with
18721 *   {@link apc_store}). If an array is passed then each element is
18722 *   fetched and returned.
18723 * @param bool $success Set to TRUE in success and FALSE in failure.
18724 * @return mixed The stored variable or array of variables on success;
18725 *   FALSE on failure
18726 * @since PECL apc >= 3.0.0
18727 **/
18728function apc_fetch($key, &$success){}
18729
18730/**
18731 * Increase a stored number
18732 *
18733 * Increases a stored number.
18734 *
18735 * @param string $key The key of the value being increased.
18736 * @param int $step The step, or value to increase.
18737 * @param bool $success Optionally pass the success or fail boolean
18738 *   value to this referenced variable.
18739 * @return int Returns the current value of {@link key}'s value on
18740 *   success,
18741 * @since PECL apc >= 3.1.1
18742 **/
18743function apc_inc($key, $step, &$success){}
18744
18745/**
18746 * Loads a set of constants from the cache
18747 *
18748 * Loads a set of constants from the cache.
18749 *
18750 * @param string $key The name of the constant set (that was stored
18751 *   with {@link apc_define_constants}) to be retrieved.
18752 * @param bool $case_sensitive The default behaviour for constants is
18753 *   to be declared case-sensitive; i.e. CONSTANT and Constant represent
18754 *   different values. If this parameter evaluates to FALSE the constants
18755 *   will be declared as case-insensitive symbols.
18756 * @return bool
18757 * @since PECL apc >= 3.0.0
18758 **/
18759function apc_load_constants($key, $case_sensitive){}
18760
18761/**
18762 * Retrieves APC's Shared Memory Allocation information
18763 *
18764 * Retrieves APC's Shared Memory Allocation information.
18765 *
18766 * @param bool $limited When set to FALSE (default) {@link
18767 *   apc_sma_info} will return a detailed information about each segment.
18768 * @return array Array of Shared Memory Allocation data; FALSE on
18769 *   failure.
18770 * @since PECL apc >= 2.0.0
18771 **/
18772function apc_sma_info($limited){}
18773
18774/**
18775 * Cache a variable in the data store
18776 *
18777 * Cache a variable in the data store.
18778 *
18779 * @param string $key Store the variable using this name. {@link key}s
18780 *   are cache-unique, so storing a second value with the same {@link
18781 *   key} will overwrite the original value.
18782 * @param mixed $var The variable to store
18783 * @param int $ttl Time To Live; store {@link var} in the cache for
18784 *   {@link ttl} seconds. After the {@link ttl} has passed, the stored
18785 *   variable will be expunged from the cache (on the next request). If
18786 *   no {@link ttl} is supplied (or if the {@link ttl} is 0), the value
18787 *   will persist until it is removed from the cache manually, or
18788 *   otherwise fails to exist in the cache (clear, restart, etc.).
18789 * @return bool Second syntax returns array with error keys.
18790 * @since PECL apc >= 3.0.0
18791 **/
18792function apc_store($key, $var, $ttl){}
18793
18794/**
18795 * Stops the interpreter and waits on a CR from the socket
18796 *
18797 * This can be used to stop the running of your script, and await
18798 * responses on the connected socket. To step the program, just send
18799 * enter (a blank line), or enter a php command to be executed.
18800 *
18801 * @param int $debug_level
18802 * @return bool
18803 * @since PECL apd >= 0.2
18804 **/
18805function apd_breakpoint($debug_level){}
18806
18807/**
18808 * Returns the current call stack as an array
18809 *
18810 * @return array An array containing the current call stack.
18811 * @since PECL apd 0.2-0.4
18812 **/
18813function apd_callstack(){}
18814
18815/**
18816 * Throw a warning and a callstack
18817 *
18818 * Behaves like perl's Carp::cluck. Throw a warning and a callstack.
18819 *
18820 * @param string $warning The warning to throw.
18821 * @param string $delimiter The delimiter. Default to <BR />.
18822 * @return void
18823 * @since PECL apd 0.2-0.4
18824 **/
18825function apd_clunk($warning, $delimiter){}
18826
18827/**
18828 * Restarts the interpreter
18829 *
18830 * Usually sent via the socket to restart the interpreter.
18831 *
18832 * @param int $debug_level
18833 * @return bool
18834 * @since PECL apd >= 0.2
18835 **/
18836function apd_continue($debug_level){}
18837
18838/**
18839 * Throw an error, a callstack and then exit
18840 *
18841 * Behaves like perl's Carp::croak. Throw an error, a callstack and then
18842 * exit.
18843 *
18844 * @param string $warning The warning to throw.
18845 * @param string $delimiter The delimiter. Default to <BR />.
18846 * @return void
18847 * @since PECL apd 0.2-0.4
18848 **/
18849function apd_croak($warning, $delimiter){}
18850
18851/**
18852 * Outputs the current function table
18853 *
18854 * @return void
18855 * @since Unknown
18856 **/
18857function apd_dump_function_table(){}
18858
18859/**
18860 * Return all persistent resources as an array
18861 *
18862 * @return array An array containing the current persistent resources.
18863 * @since PECL apd 0.2-0.4
18864 **/
18865function apd_dump_persistent_resources(){}
18866
18867/**
18868 * Return all current regular resources as an array
18869 *
18870 * @return array An array containing the current regular resources.
18871 * @since PECL apd 0.2-0.4
18872 **/
18873function apd_dump_regular_resources(){}
18874
18875/**
18876 * Echo to the debugging socket
18877 *
18878 * Usually sent via the socket to request information about the running
18879 * script.
18880 *
18881 * @param string $output The debugged variable.
18882 * @return bool
18883 * @since PECL apd >= 0.2
18884 **/
18885function apd_echo($output){}
18886
18887/**
18888 * Get an array of the current variables names in the local scope
18889 *
18890 * Returns the names of all the variables defined in the active scope,
18891 * (not their values).
18892 *
18893 * @return array A multidimensional array with all the variables.
18894 * @since PECL apd 0.2
18895 **/
18896function apd_get_active_symbols(){}
18897
18898/**
18899 * Starts the session debugging
18900 *
18901 * Starts debugging to pprof_{process_id} in the dump directory.
18902 *
18903 * @param string $dump_directory The directory in which the profile
18904 *   dump file is written. If not set, the apd.dumpdir setting from the
18905 *   file is used.
18906 * @param string $fragment
18907 * @return string Returns path of the destination file.
18908 * @since PECL apd >= 0.2
18909 **/
18910function apd_set_pprof_trace($dump_directory, $fragment){}
18911
18912/**
18913 * Changes or sets the current debugging level
18914 *
18915 * This can be used to increase or decrease debugging in a different area
18916 * of your application.
18917 *
18918 * @param int $debug_level
18919 * @return void
18920 * @since PECL apd 0.2-0.4
18921 **/
18922function apd_set_session($debug_level){}
18923
18924/**
18925 * Starts the session debugging
18926 *
18927 * Starts debugging to apd_dump_{process_id} in the dump directory.
18928 *
18929 * @param int $debug_level The directory in which the profile dump file
18930 *   is written. If not set, the apd.dumpdir setting from the file is
18931 *   used.
18932 * @param string $dump_directory
18933 * @return void
18934 * @since PECL apd 0.2-0.4
18935 **/
18936function apd_set_session_trace($debug_level, $dump_directory){}
18937
18938/**
18939 * Starts the remote session debugging
18940 *
18941 * Connects to the specified {@link tcp_server} (eg. tcplisten) and sends
18942 * debugging data to the socket.
18943 *
18944 * @param string $tcp_server IP or Unix Domain socket (like a file) of
18945 *   the TCP server.
18946 * @param int $socket_type Can be AF_UNIX for file based sockets or
18947 *   APD_AF_INET for standard tcp/ip.
18948 * @param int $port You can use any port, but higher numbers are better
18949 *   as most of the lower numbers may be used by other system services.
18950 * @param int $debug_level
18951 * @return bool
18952 * @since PECL apd >= 0.2
18953 **/
18954function apd_set_session_trace_socket($tcp_server, $socket_type, $port, $debug_level){}
18955
18956/**
18957 * Changes the case of all keys in an array
18958 *
18959 * Returns an array with all keys from {@link array} lowercased or
18960 * uppercased. Numbered indices are left as is.
18961 *
18962 * @param array $array The array to work on
18963 * @param int $case Either CASE_UPPER or CASE_LOWER (default)
18964 * @return array Returns an array with its keys lower or uppercased, or
18965 *   FALSE if {@link array} is not an array.
18966 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
18967 **/
18968function array_change_key_case($array, $case){}
18969
18970/**
18971 * Split an array into chunks
18972 *
18973 * Chunks an array into arrays with {@link size} elements. The last chunk
18974 * may contain less than {@link size} elements.
18975 *
18976 * @param array $array The array to work on
18977 * @param int $size The size of each chunk
18978 * @param bool $preserve_keys When set to TRUE keys will be preserved.
18979 *   Default is FALSE which will reindex the chunk numerically
18980 * @return array Returns a multidimensional numerically indexed array,
18981 *   starting with zero, with each dimension containing {@link size}
18982 *   elements.
18983 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
18984 **/
18985function array_chunk($array, $size, $preserve_keys){}
18986
18987/**
18988 * Return the values from a single column in the input array
18989 *
18990 * {@link array_column} returns the values from a single column of the
18991 * {@link input}, identified by the {@link column_key}. Optionally, an
18992 * {@link index_key} may be provided to index the values in the returned
18993 * array by the values from the {@link index_key} column of the input
18994 * array.
18995 *
18996 * @param array $input A multi-dimensional array or an array of objects
18997 *   from which to pull a column of values from. If an array of objects
18998 *   is provided, then public properties can be directly pulled. In order
18999 *   for protected or private properties to be pulled, the class must
19000 *   implement both the {@link __get} and {@link __isset} magic methods.
19001 * @param mixed $column_key The column of values to return. This value
19002 *   may be an integer key of the column you wish to retrieve, or it may
19003 *   be a string key name for an associative array or property name. It
19004 *   may also be NULL to return complete arrays or objects (this is
19005 *   useful together with {@link index_key} to reindex the array).
19006 * @param mixed $index_key The column to use as the index/keys for the
19007 *   returned array. This value may be the integer key of the column, or
19008 *   it may be the string key name. The value is cast as usual for array
19009 *   keys (however, objects supporting conversion to string are also
19010 *   allowed).
19011 * @return array Returns an array of values representing a single
19012 *   column from the input array.
19013 * @since PHP 5 >= 5.5.0, PHP 7
19014 **/
19015function array_column($input, $column_key, $index_key){}
19016
19017/**
19018 * Creates an array by using one array for keys and another for its
19019 * values
19020 *
19021 * Creates an array by using the values from the {@link keys} array as
19022 * keys and the values from the {@link values} array as the corresponding
19023 * values.
19024 *
19025 * @param array $keys Array of keys to be used. Illegal values for key
19026 *   will be converted to string.
19027 * @param array $values Array of values to be used
19028 * @return array Returns the combined array, FALSE if the number of
19029 *   elements for each array isn't equal.
19030 * @since PHP 5, PHP 7
19031 **/
19032function array_combine($keys, $values){}
19033
19034/**
19035 * Counts all the values of an array
19036 *
19037 * {@link array_count_values} returns an array using the values of {@link
19038 * array} as keys and their frequency in {@link array} as values.
19039 *
19040 * @param array $array The array of values to count
19041 * @return array Returns an associative array of values from {@link
19042 *   array} as keys and their count as value.
19043 * @since PHP 4, PHP 5, PHP 7
19044 **/
19045function array_count_values($array){}
19046
19047/**
19048 * Computes the difference of arrays
19049 *
19050 * Compares {@link array1} against one or more other arrays and returns
19051 * the values in {@link array1} that are not present in any of the other
19052 * arrays.
19053 *
19054 * @param array $array1 The array to compare from
19055 * @param array $array2 An array to compare against
19056 * @param array ...$vararg More arrays to compare against
19057 * @return array Returns an array containing all the entries from
19058 *   {@link array1} that are not present in any of the other arrays.
19059 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
19060 **/
19061function array_diff($array1, $array2, ...$vararg){}
19062
19063/**
19064 * Computes the difference of arrays with additional index check
19065 *
19066 * Compares {@link array1} against {@link array2} and returns the
19067 * difference. Unlike {@link array_diff} the array keys are also used in
19068 * the comparison.
19069 *
19070 * @param array $array1 The array to compare from
19071 * @param array $array2 An array to compare against
19072 * @param array ...$vararg More arrays to compare against
19073 * @return array Returns an array containing all the values from {@link
19074 *   array1} that are not present in any of the other arrays.
19075 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
19076 **/
19077function array_diff_assoc($array1, $array2, ...$vararg){}
19078
19079/**
19080 * Computes the difference of arrays using keys for comparison
19081 *
19082 * Compares the keys from {@link array1} against the keys from {@link
19083 * array2} and returns the difference. This function is like {@link
19084 * array_diff} except the comparison is done on the keys instead of the
19085 * values.
19086 *
19087 * @param array $array1 The array to compare from
19088 * @param array $array2 An array to compare against
19089 * @param array ...$vararg More arrays to compare against
19090 * @return array Returns an array containing all the entries from
19091 *   {@link array1} whose keys are absent from all of the other arrays.
19092 * @since PHP 5 >= 5.1.0, PHP 7
19093 **/
19094function array_diff_key($array1, $array2, ...$vararg){}
19095
19096/**
19097 * Computes the difference of arrays with additional index check which is
19098 * performed by a user supplied callback function
19099 *
19100 * Compares {@link array1} against {@link array2} and returns the
19101 * difference. Unlike {@link array_diff} the array keys are used in the
19102 * comparison.
19103 *
19104 * Unlike {@link array_diff_assoc} a user supplied callback function is
19105 * used for the indices comparison, not internal function.
19106 *
19107 * @param array $array1 The array to compare from
19108 * @param array $array2 An array to compare against
19109 * @param array ...$vararg More arrays to compare against
19110 * @param callable $key_compare_func
19111 * @return array Returns an array containing all the entries from
19112 *   {@link array1} that are not present in any of the other arrays.
19113 * @since PHP 5, PHP 7
19114 **/
19115function array_diff_uassoc($array1, $array2, $key_compare_func){}
19116
19117/**
19118 * Computes the difference of arrays using a callback function on the
19119 * keys for comparison
19120 *
19121 * Compares the keys from {@link array1} against the keys from {@link
19122 * array2} and returns the difference. This function is like {@link
19123 * array_diff} except the comparison is done on the keys instead of the
19124 * values.
19125 *
19126 * Unlike {@link array_diff_key} a user supplied callback function is
19127 * used for the indices comparison, not internal function.
19128 *
19129 * @param array $array1 The array to compare from
19130 * @param array $array2 An array to compare against
19131 * @param array ...$vararg More arrays to compare against
19132 * @param callable $key_compare_func
19133 * @return array Returns an array containing all the entries from
19134 *   {@link array1} that are not present in any of the other arrays.
19135 * @since PHP 5 >= 5.1.0, PHP 7
19136 **/
19137function array_diff_ukey($array1, $array2, $key_compare_func){}
19138
19139/**
19140 * Fill an array with values
19141 *
19142 * Fills an array with {@link num} entries of the value of the {@link
19143 * value} parameter, keys starting at the {@link start_index} parameter.
19144 *
19145 * @param int $start_index The first index of the returned array. If
19146 *   {@link start_index} is negative, the first index of the returned
19147 *   array will be {@link start_index} and the following indices will
19148 *   start from zero (see example).
19149 * @param int $num Number of elements to insert. Must be greater than
19150 *   or equal to zero.
19151 * @param mixed $value Value to use for filling
19152 * @return array Returns the filled array
19153 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
19154 **/
19155function array_fill($start_index, $num, $value){}
19156
19157/**
19158 * Fill an array with values, specifying keys
19159 *
19160 * Fills an array with the value of the {@link value} parameter, using
19161 * the values of the {@link keys} array as keys.
19162 *
19163 * @param array $keys Array of values that will be used as keys.
19164 *   Illegal values for key will be converted to string.
19165 * @param mixed $value Value to use for filling
19166 * @return array Returns the filled array
19167 * @since PHP 5 >= 5.2.0, PHP 7
19168 **/
19169function array_fill_keys($keys, $value){}
19170
19171/**
19172 * Filters elements of an array using a callback function
19173 *
19174 * Iterates over each value in the {@link array} passing them to the
19175 * {@link callback} function. If the {@link callback} function returns
19176 * TRUE, the current value from {@link array} is returned into the result
19177 * . Array keys are preserved.
19178 *
19179 * @param array $array The array to iterate over
19180 * @param callable $callback The callback function to use If no {@link
19181 *   callback} is supplied, all entries of {@link array} equal to FALSE
19182 *   (see converting to boolean) will be removed.
19183 * @param int $flag Flag determining what arguments are sent to {@link
19184 *   callback}: ARRAY_FILTER_USE_KEY - pass key as the only argument to
19185 *   {@link callback} instead of the value ARRAY_FILTER_USE_BOTH - pass
19186 *   both value and key as arguments to {@link callback} instead of the
19187 *   value Default is 0 which will pass value as the only argument to
19188 *   {@link callback} instead.
19189 * @return array Returns the filtered array.
19190 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
19191 **/
19192function array_filter($array, $callback, $flag){}
19193
19194/**
19195 * Exchanges all keys with their associated values in an array
19196 *
19197 * {@link array_flip} returns an array in flip order, i.e. keys from
19198 * {@link array} become values and values from {@link array} become keys.
19199 *
19200 * Note that the values of {@link array} need to be valid keys, i.e. they
19201 * need to be either integer or string. A warning will be emitted if a
19202 * value has the wrong type, and the key/value pair in question will not
19203 * be included in the result.
19204 *
19205 * If a value has several occurrences, the latest key will be used as its
19206 * value, and all others will be lost.
19207 *
19208 * @param array $array An array of key/value pairs to be flipped.
19209 * @return array Returns the flipped array on success and NULL on
19210 *   failure.
19211 * @since PHP 4, PHP 5, PHP 7
19212 **/
19213function array_flip($array){}
19214
19215/**
19216 * Computes the intersection of arrays
19217 *
19218 * {@link array_intersect} returns an array containing all the values of
19219 * {@link array1} that are present in all the arguments. Note that keys
19220 * are preserved.
19221 *
19222 * @param array $array1 The array with master values to check.
19223 * @param array $array2 An array to compare values against.
19224 * @param array ...$vararg A variable list of arrays to compare.
19225 * @return array Returns an array containing all of the values in
19226 *   {@link array1} whose values exist in all of the parameters.
19227 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
19228 **/
19229function array_intersect($array1, $array2, ...$vararg){}
19230
19231/**
19232 * Computes the intersection of arrays with additional index check
19233 *
19234 * @param array $array1 The array with master values to check.
19235 * @param array $array2 An array to compare values against.
19236 * @param array ...$vararg A variable list of arrays to compare.
19237 * @return array Returns an associative array containing all the values
19238 *   in {@link array1} that are present in all of the arguments.
19239 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
19240 **/
19241function array_intersect_assoc($array1, $array2, ...$vararg){}
19242
19243/**
19244 * Computes the intersection of arrays using keys for comparison
19245 *
19246 * {@link array_intersect_key} returns an array containing all the
19247 * entries of {@link array1} which have keys that are present in all the
19248 * arguments.
19249 *
19250 * @param array $array1 The array with master keys to check.
19251 * @param array $array2 An array to compare keys against.
19252 * @param array ...$vararg A variable list of arrays to compare.
19253 * @return array Returns an associative array containing all the
19254 *   entries of {@link array1} which have keys that are present in all
19255 *   arguments.
19256 * @since PHP 5 >= 5.1.0, PHP 7
19257 **/
19258function array_intersect_key($array1, $array2, ...$vararg){}
19259
19260/**
19261 * Computes the intersection of arrays with additional index check,
19262 * compares indexes by a callback function
19263 *
19264 * {@link array_intersect_uassoc} returns an array containing all the
19265 * values of {@link array1} that are present in all the arguments. Note
19266 * that the keys are used in the comparison unlike in {@link
19267 * array_intersect}.
19268 *
19269 * @param array $array1 Initial array for comparison of the arrays.
19270 * @param array $array2 First array to compare keys against.
19271 * @param array ...$vararg Variable list of array arguments to compare
19272 *   values against.
19273 * @param callable $key_compare_func
19274 * @return array Returns the values of {@link array1} whose values
19275 *   exist in all of the arguments.
19276 * @since PHP 5, PHP 7
19277 **/
19278function array_intersect_uassoc($array1, $array2, $key_compare_func){}
19279
19280/**
19281 * Computes the intersection of arrays using a callback function on the
19282 * keys for comparison
19283 *
19284 * {@link array_intersect_ukey} returns an array containing all the
19285 * values of {@link array1} which have matching keys that are present in
19286 * all the arguments.
19287 *
19288 * @param array $array1 Initial array for comparison of the arrays.
19289 * @param array $array2 First array to compare keys against.
19290 * @param array ...$vararg Variable list of array arguments to compare
19291 *   keys against.
19292 * @param callable $key_compare_func
19293 * @return array Returns the values of {@link array1} whose keys exist
19294 *   in all the arguments.
19295 * @since PHP 5 >= 5.1.0, PHP 7
19296 **/
19297function array_intersect_ukey($array1, $array2, $key_compare_func){}
19298
19299/**
19300 * Return all the keys or a subset of the keys of an array
19301 *
19302 * {@link array_keys} returns the keys, numeric and string, from the
19303 * {@link array}.
19304 *
19305 * If a {@link search_value} is specified, then only the keys for that
19306 * value are returned. Otherwise, all the keys from the {@link array} are
19307 * returned.
19308 *
19309 * @param array $array An array containing keys to return.
19310 * @return array Returns an array of all the keys in {@link array}.
19311 * @since PHP 4, PHP 5, PHP 7
19312 **/
19313function array_keys($array){}
19314
19315/**
19316 * Checks if the given key or index exists in the array
19317 *
19318 * {@link array_key_exists} returns TRUE if the given {@link key} is set
19319 * in the array. {@link key} can be any value possible for an array
19320 * index.
19321 *
19322 * @param mixed $key Value to check.
19323 * @param array $array An array with keys to check.
19324 * @return bool
19325 * @since PHP 4 >= 4.0.7, PHP 5, PHP 7
19326 **/
19327function array_key_exists($key, $array){}
19328
19329/**
19330 * Gets the first key of an array
19331 *
19332 * Get the first key of the given {@link array} without affecting the
19333 * internal array pointer.
19334 *
19335 * @param array $array An array.
19336 * @return mixed Returns the first key of {@link array} if the array is
19337 *   not empty; NULL otherwise.
19338 * @since PHP 7 >= 7.3.0
19339 **/
19340function array_key_first($array){}
19341
19342/**
19343 * Gets the last key of an array
19344 *
19345 * Get the last key of the given {@link array} without affecting the
19346 * internal array pointer.
19347 *
19348 * @param array $array An array.
19349 * @return mixed Returns the last key of {@link array} if the array is
19350 *   not empty; NULL otherwise.
19351 * @since PHP 7 >= 7.3.0
19352 **/
19353function array_key_last($array){}
19354
19355/**
19356 * Applies the callback to the elements of the given arrays
19357 *
19358 * {@link array_map} returns an containing the results of applying the
19359 * {@link callback} function to the corresponding index of {@link array1}
19360 * (and {@link ...} if more arrays are provided) used as arguments for
19361 * the callback. The number of parameters that the {@link callback}
19362 * function accepts should match the number of arrays passed to {@link
19363 * array_map}.
19364 *
19365 * @param callable $callback Callback function to run for each element
19366 *   in each array. NULL can be passed as a value to {@link callback} to
19367 *   perform a zip operation on multiple arrays. If only {@link array1}
19368 *   is provided, array_map will return the input array.
19369 * @param array $array1 An array to run through the {@link callback}
19370 *   function.
19371 * @param array ...$vararg Supplementary variable list of array
19372 *   arguments to run through the {@link callback} function.
19373 * @return array Returns an array containing the results of applying
19374 *   the {@link callback} function to the corresponding index of {@link
19375 *   array1} (and {@link ...} if more arrays are provided) used as
19376 *   arguments for the callback.
19377 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
19378 **/
19379function array_map($callback, $array1, ...$vararg){}
19380
19381/**
19382 * Merge one or more arrays
19383 *
19384 * Merges the elements of one or more arrays together so that the values
19385 * of one are appended to the end of the previous one. It returns the
19386 * resulting array.
19387 *
19388 * If the input arrays have the same string keys, then the later value
19389 * for that key will overwrite the previous one. If, however, the arrays
19390 * contain numeric keys, the later value will not overwrite the original
19391 * value, but will be appended.
19392 *
19393 * Values in the input arrays with numeric keys will be renumbered with
19394 * incrementing keys starting from zero in the result array.
19395 *
19396 * @param array ...$vararg Variable list of arrays to merge.
19397 * @return array Returns the resulting array. If called without any
19398 *   arguments, returns an empty .
19399 * @since PHP 4, PHP 5, PHP 7
19400 **/
19401function array_merge(...$vararg){}
19402
19403/**
19404 * Merge one or more arrays recursively
19405 *
19406 * {@link array_merge_recursive} merges the elements of one or more
19407 * arrays together so that the values of one are appended to the end of
19408 * the previous one. It returns the resulting array.
19409 *
19410 * If the input arrays have the same string keys, then the values for
19411 * these keys are merged together into an array, and this is done
19412 * recursively, so that if one of the values is an array itself, the
19413 * function will merge it with a corresponding entry in another array
19414 * too. If, however, the arrays have the same numeric key, the later
19415 * value will not overwrite the original value, but will be appended.
19416 *
19417 * @param array ...$vararg Variable list of arrays to recursively
19418 *   merge.
19419 * @return array An array of values resulted from merging the arguments
19420 *   together. If called without any arguments, returns an empty .
19421 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
19422 **/
19423function array_merge_recursive(...$vararg){}
19424
19425/**
19426 * Sort multiple or multi-dimensional arrays
19427 *
19428 * {@link array_multisort} can be used to sort several arrays at once, or
19429 * a multi-dimensional array by one or more dimensions.
19430 *
19431 * Associative (string) keys will be maintained, but numeric keys will be
19432 * re-indexed.
19433 *
19434 * @param array $array1 An array being sorted.
19435 * @param mixed $array1_sort_order The order used to sort the previous
19436 *   array argument. Either SORT_ASC to sort ascendingly or SORT_DESC to
19437 *   sort descendingly. This argument can be swapped with {@link
19438 *   array1_sort_flags} or omitted entirely, in which case SORT_ASC is
19439 *   assumed.
19440 * @param mixed $array1_sort_flags Sort options for the previous array
19441 *   argument: Sorting type flags: SORT_REGULAR - compare items normally
19442 *   (don't change types) SORT_NUMERIC - compare items numerically
19443 *   SORT_STRING - compare items as strings SORT_LOCALE_STRING - compare
19444 *   items as strings, based on the current locale. It uses the locale,
19445 *   which can be changed using {@link setlocale} SORT_NATURAL - compare
19446 *   items as strings using "natural ordering" like {@link natsort}
19447 *   SORT_FLAG_CASE - can be combined (bitwise OR) with SORT_STRING or
19448 *   SORT_NATURAL to sort strings case-insensitively This argument can be
19449 *   swapped with {@link array1_sort_order} or omitted entirely, in which
19450 *   case SORT_REGULAR is assumed.
19451 * @param mixed ...$vararg More arrays, optionally followed by sort
19452 *   order and flags. Only elements corresponding to equivalent elements
19453 *   in previous arrays are compared. In other words, the sort is
19454 *   lexicographical.
19455 * @return bool
19456 * @since PHP 4, PHP 5, PHP 7
19457 **/
19458function array_multisort(&$array1, $array1_sort_order, $array1_sort_flags, ...$vararg){}
19459
19460/**
19461 * Pad array to the specified length with a value
19462 *
19463 * {@link array_pad} returns a copy of the {@link array} padded to size
19464 * specified by {@link size} with value {@link value}. If {@link size} is
19465 * positive then the array is padded on the right, if it's negative then
19466 * on the left. If the absolute value of {@link size} is less than or
19467 * equal to the length of the {@link array} then no padding takes place.
19468 * It is possible to add at most 1048576 elements at a time.
19469 *
19470 * @param array $array Initial array of values to pad.
19471 * @param int $size New size of the array.
19472 * @param mixed $value Value to pad if {@link array} is less than
19473 *   {@link size}.
19474 * @return array Returns a copy of the {@link array} padded to size
19475 *   specified by {@link size} with value {@link value}. If {@link size}
19476 *   is positive then the array is padded on the right, if it's negative
19477 *   then on the left. If the absolute value of {@link size} is less than
19478 *   or equal to the length of the {@link array} then no padding takes
19479 *   place.
19480 * @since PHP 4, PHP 5, PHP 7
19481 **/
19482function array_pad($array, $size, $value){}
19483
19484/**
19485 * Pop the element off the end of array
19486 *
19487 * {@link array_pop} pops and returns the value of the last element of
19488 * {@link array}, shortening the {@link array} by one element.
19489 *
19490 * @param array $array The array to get the value from.
19491 * @return mixed Returns the value of the last element of {@link
19492 *   array}. If {@link array} is empty (or is not an array), NULL will be
19493 *   returned.
19494 * @since PHP 4, PHP 5, PHP 7
19495 **/
19496function array_pop(&$array){}
19497
19498/**
19499 * Calculate the product of values in an array
19500 *
19501 * {@link array_product} returns the product of values in an array.
19502 *
19503 * @param array $array The array.
19504 * @return number Returns the product as an integer or float.
19505 * @since PHP 5 >= 5.1.0, PHP 7
19506 **/
19507function array_product($array){}
19508
19509/**
19510 * Push one or more elements onto the end of array
19511 *
19512 * {@link array_push} treats {@link array} as a stack, and pushes the
19513 * passed variables onto the end of {@link array}. The length of {@link
19514 * array} increases by the number of variables pushed. Has the same
19515 * effect as:
19516 *
19517 * <?php $array[] = $var; ?>
19518 *
19519 * repeated for each passed value.
19520 *
19521 * @param array $array The input array.
19522 * @param mixed ...$vararg The values to push onto the end of the
19523 *   {@link array}.
19524 * @return int Returns the new number of elements in the array.
19525 * @since PHP 4, PHP 5, PHP 7
19526 **/
19527function array_push(&$array, ...$vararg){}
19528
19529/**
19530 * Pick one or more random keys out of an array
19531 *
19532 * Picks one or more random entries out of an array, and returns the key
19533 * (or keys) of the random entries. It uses a pseudo random number
19534 * generator that is not suitable for cryptographic purposes.
19535 *
19536 * @param array $array The input array.
19537 * @param int $num Specifies how many entries should be picked.
19538 * @return mixed When picking only one entry, {@link array_rand}
19539 *   returns the key for a random entry. Otherwise, an array of keys for
19540 *   the random entries is returned. This is done so that random keys can
19541 *   be picked from the array as well as random values. Trying to pick
19542 *   more elements than there are in the array will result in an
19543 *   E_WARNING level error, and NULL will be returned.
19544 * @since PHP 4, PHP 5, PHP 7
19545 **/
19546function array_rand($array, $num){}
19547
19548/**
19549 * Iteratively reduce the array to a single value using a callback
19550 * function
19551 *
19552 * {@link array_reduce} applies iteratively the {@link callback} function
19553 * to the elements of the {@link array}, so as to reduce the array to a
19554 * single value.
19555 *
19556 * @param array $array The input array.
19557 * @param callable $callback
19558 * @param mixed $initial Holds the return value of the previous
19559 *   iteration; in the case of the first iteration it instead holds the
19560 *   value of {@link initial}.
19561 * @return mixed Returns the resulting value.
19562 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
19563 **/
19564function array_reduce($array, $callback, $initial){}
19565
19566/**
19567 * Replaces elements from passed arrays into the first array
19568 *
19569 * {@link array_replace} replaces the values of {@link array1} with
19570 * values having the same keys in each of the following arrays. If a key
19571 * from the first array exists in the second array, its value will be
19572 * replaced by the value from the second array. If the key exists in the
19573 * second array, and not the first, it will be created in the first
19574 * array. If a key only exists in the first array, it will be left as is.
19575 * If several arrays are passed for replacement, they will be processed
19576 * in order, the later arrays overwriting the previous values.
19577 *
19578 * {@link array_replace} is not recursive : it will replace values in the
19579 * first array by whatever type is in the second array.
19580 *
19581 * @param array $array1 The array in which elements are replaced.
19582 * @param array ...$vararg Arrays from which elements will be
19583 *   extracted. Values from later arrays overwrite the previous values.
19584 * @return array Returns an array, or NULL if an error occurs.
19585 * @since PHP 5 >= 5.3.0, PHP 7
19586 **/
19587function array_replace($array1, ...$vararg){}
19588
19589/**
19590 * Replaces elements from passed arrays into the first array recursively
19591 *
19592 * {@link array_replace_recursive} replaces the values of {@link array1}
19593 * with the same values from all the following arrays. If a key from the
19594 * first array exists in the second array, its value will be replaced by
19595 * the value from the second array. If the key exists in the second
19596 * array, and not the first, it will be created in the first array. If a
19597 * key only exists in the first array, it will be left as is. If several
19598 * arrays are passed for replacement, they will be processed in order,
19599 * the later array overwriting the previous values.
19600 *
19601 * {@link array_replace_recursive} is recursive : it will recurse into
19602 * arrays and apply the same process to the inner value.
19603 *
19604 * When the value in the first array is scalar, it will be replaced by
19605 * the value in the second array, may it be scalar or array. When the
19606 * value in the first array and the second array are both arrays, {@link
19607 * array_replace_recursive} will replace their respective value
19608 * recursively.
19609 *
19610 * @param array $array1 The array in which elements are replaced.
19611 * @param array ...$vararg Optional. Arrays from which elements will be
19612 *   extracted.
19613 * @return array Returns an array, or NULL if an error occurs.
19614 * @since PHP 5 >= 5.3.0, PHP 7
19615 **/
19616function array_replace_recursive($array1, ...$vararg){}
19617
19618/**
19619 * Return an array with elements in reverse order
19620 *
19621 * Takes an input {@link array} and returns a new array with the order of
19622 * the elements reversed.
19623 *
19624 * @param array $array The input array.
19625 * @param bool $preserve_keys If set to TRUE numeric keys are
19626 *   preserved. Non-numeric keys are not affected by this setting and
19627 *   will always be preserved.
19628 * @return array Returns the reversed array.
19629 * @since PHP 4, PHP 5, PHP 7
19630 **/
19631function array_reverse($array, $preserve_keys){}
19632
19633/**
19634 * Searches the array for a given value and returns the first
19635 * corresponding key if successful
19636 *
19637 * Searches for {@link needle} in {@link haystack}.
19638 *
19639 * @param mixed $needle The searched value.
19640 * @param array $haystack The array.
19641 * @param bool $strict If the third parameter {@link strict} is set to
19642 *   TRUE then the {@link array_search} function will search for
19643 *   identical elements in the {@link haystack}. This means it will also
19644 *   perform a strict type comparison of the {@link needle} in the {@link
19645 *   haystack}, and objects must be the same instance.
19646 * @return mixed Returns the key for {@link needle} if it is found in
19647 *   the array, FALSE otherwise.
19648 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
19649 **/
19650function array_search($needle, $haystack, $strict){}
19651
19652/**
19653 * Shift an element off the beginning of array
19654 *
19655 * {@link array_shift} shifts the first value of the {@link array} off
19656 * and returns it, shortening the {@link array} by one element and moving
19657 * everything down. All numerical array keys will be modified to start
19658 * counting from zero while literal keys won't be affected.
19659 *
19660 * @param array $array The input array.
19661 * @return mixed Returns the shifted value, or NULL if {@link array} is
19662 *   empty or is not an array.
19663 * @since PHP 4, PHP 5, PHP 7
19664 **/
19665function array_shift(&$array){}
19666
19667/**
19668 * Extract a slice of the array
19669 *
19670 * {@link array_slice} returns the sequence of elements from the array
19671 * {@link array} as specified by the {@link offset} and {@link length}
19672 * parameters.
19673 *
19674 * @param array $array The input array.
19675 * @param int $offset If {@link offset} is non-negative, the sequence
19676 *   will start at that offset in the {@link array}. If {@link offset} is
19677 *   negative, the sequence will start that far from the end of the
19678 *   {@link array}.
19679 * @param int $length If {@link length} is given and is positive, then
19680 *   the sequence will have up to that many elements in it. If the array
19681 *   is shorter than the {@link length}, then only the available array
19682 *   elements will be present. If {@link length} is given and is negative
19683 *   then the sequence will stop that many elements from the end of the
19684 *   array. If it is omitted, then the sequence will have everything from
19685 *   {@link offset} up until the end of the {@link array}.
19686 * @param bool $preserve_keys
19687 * @return array Returns the slice. If the offset is larger than the
19688 *   size of the array, an empty array is returned.
19689 * @since PHP 4, PHP 5, PHP 7
19690 **/
19691function array_slice($array, $offset, $length, $preserve_keys){}
19692
19693/**
19694 * Remove a portion of the array and replace it with something else
19695 *
19696 * Removes the elements designated by {@link offset} and {@link length}
19697 * from the {@link input} array, and replaces them with the elements of
19698 * the {@link replacement} array, if supplied.
19699 *
19700 * @param array $input The input array.
19701 * @param int $offset If {@link offset} is positive then the start of
19702 *   the removed portion is at that offset from the beginning of the
19703 *   {@link input} array. If {@link offset} is negative then the start of
19704 *   the removed portion is at that offset from the end of the {@link
19705 *   input} array.
19706 * @param int $length If {@link length} is omitted, removes everything
19707 *   from {@link offset} to the end of the array. If {@link length} is
19708 *   specified and is positive, then that many elements will be removed.
19709 *   If {@link length} is specified and is negative, then the end of the
19710 *   removed portion will be that many elements from the end of the
19711 *   array. If {@link length} is specified and is zero, no elements will
19712 *   be removed.
19713 * @param mixed $replacement If {@link replacement} array is specified,
19714 *   then the removed elements are replaced with elements from this
19715 *   array. If {@link offset} and {@link length} are such that nothing is
19716 *   removed, then the elements from the {@link replacement} array are
19717 *   inserted in the place specified by the {@link offset}. If {@link
19718 *   replacement} is just one element it is not necessary to put array()
19719 *   or square brackets around it, unless the element is an array itself,
19720 *   an object or NULL.
19721 * @return array Returns an array consisting of the extracted elements.
19722 * @since PHP 4, PHP 5, PHP 7
19723 **/
19724function array_splice(&$input, $offset, $length, $replacement){}
19725
19726/**
19727 * Calculate the sum of values in an array
19728 *
19729 * {@link array_sum} returns the sum of values in an array.
19730 *
19731 * @param array $array The input array.
19732 * @return number Returns the sum of values as an integer or float; 0
19733 *   if the {@link array} is empty.
19734 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
19735 **/
19736function array_sum($array){}
19737
19738/**
19739 * Computes the difference of arrays by using a callback function for
19740 * data comparison
19741 *
19742 * Computes the difference of arrays by using a callback function for
19743 * data comparison. This is unlike {@link array_diff} which uses an
19744 * internal function for comparing the data.
19745 *
19746 * @param array $array1 The first array.
19747 * @param array $array2 The second array.
19748 * @param array ...$vararg The callback comparison function.
19749 * @param callable $value_compare_func
19750 * @return array Returns an array containing all the values of {@link
19751 *   array1} that are not present in any of the other arguments.
19752 * @since PHP 5, PHP 7
19753 **/
19754function array_udiff($array1, $array2, $value_compare_func){}
19755
19756/**
19757 * Computes the difference of arrays with additional index check,
19758 * compares data by a callback function
19759 *
19760 * Computes the difference of arrays with additional index check,
19761 * compares data by a callback function.
19762 *
19763 * @param array $array1 The first array.
19764 * @param array $array2 The second array.
19765 * @param array ...$vararg
19766 * @param callable $value_compare_func
19767 * @return array {@link array_udiff_assoc} returns an array containing
19768 *   all the values from {@link array1} that are not present in any of
19769 *   the other arguments. Note that the keys are used in the comparison
19770 *   unlike {@link array_diff} and {@link array_udiff}. The comparison of
19771 *   arrays' data is performed by using an user-supplied callback. In
19772 *   this aspect the behaviour is opposite to the behaviour of {@link
19773 *   array_diff_assoc} which uses internal function for comparison.
19774 * @since PHP 5, PHP 7
19775 **/
19776function array_udiff_assoc($array1, $array2, $value_compare_func){}
19777
19778/**
19779 * Computes the difference of arrays with additional index check,
19780 * compares data and indexes by a callback function
19781 *
19782 * Computes the difference of arrays with additional index check,
19783 * compares data and indexes by a callback function.
19784 *
19785 * Note that the keys are used in the comparison unlike {@link
19786 * array_diff} and {@link array_udiff}.
19787 *
19788 * @param array $array1 The first array.
19789 * @param array $array2 The second array.
19790 * @param array ...$vararg
19791 * @param callable $value_compare_func The comparison of keys (indices)
19792 *   is done also by the callback function {@link key_compare_func}. This
19793 *   behaviour is unlike what {@link array_udiff_assoc} does, since the
19794 *   latter compares the indices by using an internal function.
19795 * @param callable $key_compare_func
19796 * @return array Returns an array containing all the values from {@link
19797 *   array1} that are not present in any of the other arguments.
19798 * @since PHP 5, PHP 7
19799 **/
19800function array_udiff_uassoc($array1, $array2, $value_compare_func, $key_compare_func){}
19801
19802/**
19803 * Computes the intersection of arrays, compares data by a callback
19804 * function
19805 *
19806 * @param array $array1 The first array.
19807 * @param array $array2 The second array.
19808 * @param array ...$vararg
19809 * @param callable $value_compare_func
19810 * @return array Returns an array containing all the values of {@link
19811 *   array1} that are present in all the arguments.
19812 * @since PHP 5, PHP 7
19813 **/
19814function array_uintersect($array1, $array2, $value_compare_func){}
19815
19816/**
19817 * Computes the intersection of arrays with additional index check,
19818 * compares data by a callback function
19819 *
19820 * Computes the intersection of arrays with additional index check,
19821 * compares data by a callback function.
19822 *
19823 * Note that the keys are used in the comparison unlike in {@link
19824 * array_uintersect}. The data is compared by using a callback function.
19825 *
19826 * @param array $array1 The first array.
19827 * @param array $array2 The second array.
19828 * @param array ...$vararg
19829 * @param callable $value_compare_func
19830 * @return array Returns an array containing all the values of {@link
19831 *   array1} that are present in all the arguments.
19832 * @since PHP 5, PHP 7
19833 **/
19834function array_uintersect_assoc($array1, $array2, $value_compare_func){}
19835
19836/**
19837 * Computes the intersection of arrays with additional index check,
19838 * compares data and indexes by separate callback functions
19839 *
19840 * Computes the intersection of arrays with additional index check,
19841 * compares data and indexes by separate callback functions.
19842 *
19843 * @param array $array1 The first array.
19844 * @param array $array2 The second array.
19845 * @param array ...$vararg
19846 * @param callable $value_compare_func Key comparison callback
19847 *   function.
19848 * @param callable $key_compare_func
19849 * @return array Returns an array containing all the values of {@link
19850 *   array1} that are present in all the arguments.
19851 * @since PHP 5, PHP 7
19852 **/
19853function array_uintersect_uassoc($array1, $array2, $value_compare_func, $key_compare_func){}
19854
19855/**
19856 * Removes duplicate values from an array
19857 *
19858 * Takes an input {@link array} and returns a new array without duplicate
19859 * values.
19860 *
19861 * Note that keys are preserved. If multiple elements compare equal under
19862 * the given {@link sort_flags}, then the key and value of the first
19863 * equal element will be retained.
19864 *
19865 * @param array $array The input array.
19866 * @param int $sort_flags The optional second parameter {@link
19867 *   sort_flags} may be used to modify the sorting behavior using these
19868 *   values: Sorting type flags: SORT_REGULAR - compare items normally
19869 *   (don't change types) SORT_NUMERIC - compare items numerically
19870 *   SORT_STRING - compare items as strings SORT_LOCALE_STRING - compare
19871 *   items as strings, based on the current locale.
19872 * @return array Returns the filtered array.
19873 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
19874 **/
19875function array_unique($array, $sort_flags){}
19876
19877/**
19878 * Prepend one or more elements to the beginning of an array
19879 *
19880 * {@link array_unshift} prepends passed elements to the front of the
19881 * {@link array}. Note that the list of elements is prepended as a whole,
19882 * so that the prepended elements stay in the same order. All numerical
19883 * array keys will be modified to start counting from zero while literal
19884 * keys won't be changed.
19885 *
19886 * @param array $array The input array.
19887 * @param mixed ...$vararg The values to prepend.
19888 * @return int Returns the new number of elements in the {@link array}.
19889 * @since PHP 4, PHP 5, PHP 7
19890 **/
19891function array_unshift(&$array, ...$vararg){}
19892
19893/**
19894 * Return all the values of an array
19895 *
19896 * {@link array_values} returns all the values from the {@link array} and
19897 * indexes the array numerically.
19898 *
19899 * @param array $array The array.
19900 * @return array Returns an indexed array of values.
19901 * @since PHP 4, PHP 5, PHP 7
19902 **/
19903function array_values($array){}
19904
19905/**
19906 * Apply a user supplied function to every member of an array
19907 *
19908 * {@link array_walk} is not affected by the internal array pointer of
19909 * {@link array}. {@link array_walk} will walk through the entire array
19910 * regardless of pointer position.
19911 *
19912 * @param array $array The input array.
19913 * @param callable $callback Typically, {@link callback} takes on two
19914 *   parameters. The {@link array} parameter's value being the first, and
19915 *   the key/index second. Only the values of the {@link array} may
19916 *   potentially be changed; its structure cannot be altered, i.e., the
19917 *   programmer cannot add, unset or reorder elements. If the callback
19918 *   does not respect this requirement, the behavior of this function is
19919 *   undefined, and unpredictable.
19920 * @param mixed $userdata If the optional {@link userdata} parameter is
19921 *   supplied, it will be passed as the third parameter to the {@link
19922 *   callback}.
19923 * @return bool Returns TRUE.
19924 * @since PHP 4, PHP 5, PHP 7
19925 **/
19926function array_walk(&$array, $callback, $userdata){}
19927
19928/**
19929 * Apply a user function recursively to every member of an array
19930 *
19931 * Applies the user-defined {@link callback} function to each element of
19932 * the {@link array}. This function will recurse into deeper arrays.
19933 *
19934 * @param array $array The input array.
19935 * @param callable $callback Typically, {@link callback} takes on two
19936 *   parameters. The {@link array} parameter's value being the first, and
19937 *   the key/index second.
19938 * @param mixed $userdata If the optional {@link userdata} parameter is
19939 *   supplied, it will be passed as the third parameter to the {@link
19940 *   callback}.
19941 * @return bool
19942 * @since PHP 5, PHP 7
19943 **/
19944function array_walk_recursive(&$array, $callback, $userdata){}
19945
19946/**
19947 * Sort an array in reverse order and maintain index association
19948 *
19949 * This function sorts an array such that array indices maintain their
19950 * correlation with the array elements they are associated with.
19951 *
19952 * This is used mainly when sorting associative arrays where the actual
19953 * element order is significant.
19954 *
19955 * @param array $array The input array.
19956 * @param int $sort_flags You may modify the behavior of the sort using
19957 *   the optional parameter {@link sort_flags}, for details see {@link
19958 *   sort}.
19959 * @return bool
19960 * @since PHP 4, PHP 5, PHP 7
19961 **/
19962function arsort(&$array, $sort_flags){}
19963
19964/**
19965 * Arc sine
19966 *
19967 * Returns the arc sine of {@link arg} in radians. {@link asin} is the
19968 * inverse function of {@link sin}, which means that a==sin(asin(a)) for
19969 * every value of a that is within {@link asin}'s range.
19970 *
19971 * @param float $arg The argument to process
19972 * @return float The arc sine of {@link arg} in radians
19973 * @since PHP 4, PHP 5, PHP 7
19974 **/
19975function asin($arg){}
19976
19977/**
19978 * Inverse hyperbolic sine
19979 *
19980 * Returns the inverse hyperbolic sine of {@link arg}, i.e. the value
19981 * whose hyperbolic sine is {@link arg}.
19982 *
19983 * @param float $arg The argument to process
19984 * @return float The inverse hyperbolic sine of {@link arg}
19985 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
19986 **/
19987function asinh($arg){}
19988
19989/**
19990 * Sort an array and maintain index association
19991 *
19992 * This function sorts an array such that array indices maintain their
19993 * correlation with the array elements they are associated with. This is
19994 * used mainly when sorting associative arrays where the actual element
19995 * order is significant.
19996 *
19997 * @param array $array The input array.
19998 * @param int $sort_flags You may modify the behavior of the sort using
19999 *   the optional parameter {@link sort_flags}, for details see {@link
20000 *   sort}.
20001 * @return bool
20002 * @since PHP 4, PHP 5, PHP 7
20003 **/
20004function asort(&$array, $sort_flags){}
20005
20006/**
20007 * Checks if assertion is FALSE
20008 *
20009 * PHP 5 and 7
20010 *
20011 * PHP 7
20012 *
20013 * {@link assert} will check the given {@link assertion} and take
20014 * appropriate action if its result is FALSE.
20015 *
20016 * @param mixed $assertion The assertion. In PHP 5, this must be either
20017 *   a string to be evaluated or a boolean to be tested. In PHP 7, this
20018 *   may also be any expression that returns a value, which will be
20019 *   executed and the result used to indicate whether the assertion
20020 *   succeeded or failed.
20021 * @param string $description An optional description that will be
20022 *   included in the failure message if the {@link assertion} fails. From
20023 *   PHP 7, if no description is provided, a default description equal to
20024 *   the source code for the invocation of {@link assert} is provided.
20025 * @return bool FALSE if the assertion is false, TRUE otherwise.
20026 * @since PHP 4, PHP 5, PHP 7
20027 **/
20028function assert($assertion, $description){}
20029
20030/**
20031 * Set/get the various assert flags
20032 *
20033 * Set the various {@link assert} control options or just query their
20034 * current settings.
20035 *
20036 * @param int $what Assert Options Option INI Setting Default value
20037 *   Description ASSERT_ACTIVE assert.active 1 enable {@link assert}
20038 *   evaluation ASSERT_WARNING assert.warning 1 issue a PHP warning for
20039 *   each failed assertion ASSERT_BAIL assert.bail 0 terminate execution
20040 *   on failed assertions ASSERT_QUIET_EVAL assert.quiet_eval 0 disable
20041 *   error_reporting during assertion expression evaluation
20042 *   ASSERT_CALLBACK assert.callback (NULL) Callback to call on failed
20043 *   assertions
20044 * @param mixed $value An optional new value for the option. The
20045 *   callback function set via ASSERT_CALLBACK or assert.callback should
20046 *   have the following signature: voidassert_callback string{@link file}
20047 *   int{@link line} string{@link assertion} string{@link description}
20048 *   {@link file} The file where {@link assert} has been called. {@link
20049 *   line} The line where {@link assert} has been called. {@link
20050 *   assertion} The assertion that has been passed to {@link assert},
20051 *   converted to a string. {@link description} The description that has
20052 *   been passed to {@link assert}.
20053 * @return mixed Returns the original setting of any option or FALSE on
20054 *   errors.
20055 * @since PHP 4, PHP 5, PHP 7
20056 **/
20057function assert_options($what, $value){}
20058
20059/**
20060 * Arc tangent
20061 *
20062 * Returns the arc tangent of {@link arg} in radians. {@link atan} is the
20063 * inverse function of {@link tan}, which means that a==tan(atan(a)) for
20064 * every value of a that is within {@link atan}'s range.
20065 *
20066 * @param float $arg The argument to process
20067 * @return float The arc tangent of {@link arg} in radians.
20068 * @since PHP 4, PHP 5, PHP 7
20069 **/
20070function atan($arg){}
20071
20072/**
20073 * Arc tangent of two variables
20074 *
20075 * @param float $y Dividend parameter
20076 * @param float $x Divisor parameter
20077 * @return float The arc tangent of {@link y}/{@link x} in radians.
20078 * @since PHP 4, PHP 5, PHP 7
20079 **/
20080function atan2($y, $x){}
20081
20082/**
20083 * Inverse hyperbolic tangent
20084 *
20085 * Returns the inverse hyperbolic tangent of {@link arg}, i.e. the value
20086 * whose hyperbolic tangent is {@link arg}.
20087 *
20088 * @param float $arg The argument to process
20089 * @return float Inverse hyperbolic tangent of {@link arg}
20090 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
20091 **/
20092function atanh($arg){}
20093
20094/**
20095 * Decodes data encoded with MIME base64
20096 *
20097 * Decodes a base64 encoded {@link data}.
20098 *
20099 * @param string $data The encoded data.
20100 * @param bool $strict If the {@link strict} parameter is set to TRUE
20101 *   then the {@link base64_decode} function will return FALSE if the
20102 *   input contains character from outside the base64 alphabet. Otherwise
20103 *   invalid characters will be silently discarded.
20104 * @return string Returns the decoded data. The returned data may be
20105 *   binary.
20106 * @since PHP 4, PHP 5, PHP 7
20107 **/
20108function base64_decode($data, $strict){}
20109
20110/**
20111 * Encodes data with MIME base64
20112 *
20113 * Encodes the given {@link data} with base64.
20114 *
20115 * This encoding is designed to make binary data survive transport
20116 * through transport layers that are not 8-bit clean, such as mail
20117 * bodies.
20118 *
20119 * Base64-encoded data takes about 33% more space than the original data.
20120 *
20121 * @param string $data The data to encode.
20122 * @return string The encoded data, as a string.
20123 * @since PHP 4, PHP 5, PHP 7
20124 **/
20125function base64_encode($data){}
20126
20127/**
20128 * Returns trailing name component of path
20129 *
20130 * Given a string containing the path to a file or directory, this
20131 * function will return the trailing name component.
20132 *
20133 * @param string $path A path. On Windows, both slash (/) and backslash
20134 *   (\) are used as directory separator character. In other
20135 *   environments, it is the forward slash (/).
20136 * @param string $suffix If the name component ends in {@link suffix}
20137 *   this will also be cut off.
20138 * @return string Returns the base name of the given {@link path}.
20139 * @since PHP 4, PHP 5, PHP 7
20140 **/
20141function basename($path, $suffix){}
20142
20143/**
20144 * Convert a number between arbitrary bases
20145 *
20146 * Returns a string containing {@link number} represented in base {@link
20147 * tobase}. The base in which {@link number} is given is specified in
20148 * {@link frombase}. Both {@link frombase} and {@link tobase} have to be
20149 * between 2 and 36, inclusive. Digits in numbers with a base higher than
20150 * 10 will be represented with the letters a-z, with a meaning 10, b
20151 * meaning 11 and z meaning 35. The case of the letters doesn't matter,
20152 * i.e. {@link number} is interpreted case-insensitively.
20153 *
20154 * @param string $number The number to convert. Any invalid characters
20155 *   in {@link number} are silently ignored. As of PHP 7.4.0 supplying
20156 *   any invalid characters is deprecated.
20157 * @param int $frombase The base {@link number} is in
20158 * @param int $tobase The base to convert {@link number} to
20159 * @return string {@link number} converted to base {@link tobase}
20160 * @since PHP 4, PHP 5, PHP 7
20161 **/
20162function base_convert($number, $frombase, $tobase){}
20163
20164/**
20165 * Adds a bbcode element
20166 *
20167 * Adds a tag to an existing BBCode_Container tag_set using tag_rules.
20168 *
20169 * @param resource $bbcode_container BBCode_Container resource,
20170 *   returned by {@link bbcode_create}.
20171 * @param string $tag_name The new tag to add to the BBCode_Container
20172 *   tag_set.
20173 * @param array $tag_rules An associative array containing the parsing
20174 *   rules; see {@link bbcode_create} for the available keys.
20175 * @return bool
20176 * @since PECL bbcode >= 0.9.0
20177 **/
20178function bbcode_add_element($bbcode_container, $tag_name, $tag_rules){}
20179
20180/**
20181 * Adds a smiley to the parser
20182 *
20183 * @param resource $bbcode_container BBCode_Container resource,
20184 *   returned by {@link bbcode_create}.
20185 * @param string $smiley The string that will be replaced when found.
20186 * @param string $replace_by The string that replace smiley when found.
20187 * @return bool
20188 * @since PECL bbcode >= 0.10.2
20189 **/
20190function bbcode_add_smiley($bbcode_container, $smiley, $replace_by){}
20191
20192/**
20193 * Create a BBCode Resource
20194 *
20195 * This function returns a new BBCode Resource used to parse BBCode
20196 * strings.
20197 *
20198 * @param array $bbcode_initial_tags An associative array containing
20199 *   the tag names as keys and parameters required to correctly parse
20200 *   BBCode as their value. The following key/value pairs are supported:
20201 *   flags optional - a flag set based on the BBCODE_FLAGS_* constants.
20202 *   type required - an int indicating the type of tag. Use the
20203 *   BBCODE_TYPE_* constants. open_tag required - the HTML replacement
20204 *   string for the open tag. close_tag required - the HTML replacement
20205 *   string for the close tag. default_arg optional - use this value as
20206 *   the default argument if none is provided and tag_type is of type
20207 *   OPTARG. content_handling optional - Gives the callback used for
20208 *   modification of the content. Object Oriented Notation supported only
20209 *   since 0.10.1 callback prototype is string name(string $content,
20210 *   string $argument) param_handling optional - Gives the callback used
20211 *   for modification of the argument. Object Oriented Notation supported
20212 *   only since 0.10.1 callback prototype is string name(string $content,
20213 *   string $argument) childs optional - List of accepted children for
20214 *   the tag. The format of the list is a comma separated string. If the
20215 *   list starts with ! it will be the list of rejected children for the
20216 *   tag. parent optional - List of accepted parents for the tag. The
20217 *   format of the list is a comma separated string.
20218 * @return resource Returns a BBCode_Container
20219 * @since PECL bbcode >= 0.9.0
20220 **/
20221function bbcode_create($bbcode_initial_tags){}
20222
20223/**
20224 * Close BBCode_container resource
20225 *
20226 * This function closes the resource opened by {@link bbcode_create}.
20227 *
20228 * @param resource $bbcode_container BBCode_Container resource returned
20229 *   by {@link bbcode_create}.
20230 * @return bool
20231 * @since PECL bbcode >= 0.9.0
20232 **/
20233function bbcode_destroy($bbcode_container){}
20234
20235/**
20236 * Parse a string following a given rule set
20237 *
20238 * This function parse the string to_parse following the rules in the
20239 * bbcode_container created by {@link bbcode_create}
20240 *
20241 * @param resource $bbcode_container BBCode_Container resource returned
20242 *   by {@link bbcode_create}.
20243 * @param string $to_parse The string we need to parse.
20244 * @return string Returns the parsed string, .
20245 * @since PECL bbcode >= 0.9.0
20246 **/
20247function bbcode_parse($bbcode_container, $to_parse){}
20248
20249/**
20250 * Attach another parser in order to use another rule set for argument
20251 * parsing
20252 *
20253 * Attaches another parser to the bbcode_container. This parser is used
20254 * only when arguments must be parsed. If this function is not used, the
20255 * default argument parser is the parser itself.
20256 *
20257 * @param resource $bbcode_container BBCode_Container resource,
20258 *   returned by {@link bbcode_create}.
20259 * @param resource $bbcode_arg_parser BBCode_Container resource,
20260 *   returned by {@link bbcode_create}. It will be used only for parsed
20261 *   arguments
20262 * @return bool
20263 * @since PECL bbcode >= 0.10.2
20264 **/
20265function bbcode_set_arg_parser($bbcode_container, $bbcode_arg_parser){}
20266
20267/**
20268 * Set or alter parser options
20269 *
20270 * @param resource $bbcode_container BBCode_Container resource,
20271 *   returned by {@link bbcode_create}.
20272 * @param int $flags The flag set that must be applied to the
20273 *   bbcode_container options
20274 * @param int $mode One of the BBCODE_SET_FLAGS_* constant to set,
20275 *   unset a specific flag set or to replace the flag set by flags.
20276 * @return bool
20277 * @since PECL bbcode >= 0.10.2
20278 **/
20279function bbcode_set_flags($bbcode_container, $flags, $mode){}
20280
20281/**
20282 * Add two arbitrary precision numbers
20283 *
20284 * Sums {@link left_operand} and {@link right_operand}.
20285 *
20286 * @param string $left_operand The left operand, as a string.
20287 * @param string $right_operand The right operand, as a string.
20288 * @param int $scale
20289 * @return string The sum of the two operands, as a string.
20290 * @since PHP 4, PHP 5, PHP 7
20291 **/
20292function bcadd($left_operand, $right_operand, $scale){}
20293
20294/**
20295 * Compare two arbitrary precision numbers
20296 *
20297 * Compares the {@link left_operand} to the {@link right_operand} and
20298 * returns the result as an integer.
20299 *
20300 * @param string $left_operand The left operand, as a string.
20301 * @param string $right_operand The right operand, as a string.
20302 * @param int $scale The optional {@link scale} parameter is used to
20303 *   set the number of digits after the decimal place which will be used
20304 *   in the comparison.
20305 * @return int Returns 0 if the two operands are equal, 1 if the {@link
20306 *   left_operand} is larger than the {@link right_operand}, -1
20307 *   otherwise.
20308 * @since PHP 4, PHP 5, PHP 7
20309 **/
20310function bccomp($left_operand, $right_operand, $scale){}
20311
20312/**
20313 * Divide two arbitrary precision numbers
20314 *
20315 * Divides the {@link dividend} by the {@link divisor}.
20316 *
20317 * @param string $dividend The dividend, as a string.
20318 * @param string $divisor The divisor, as a string.
20319 * @param int $scale
20320 * @return string Returns the result of the division as a string, or
20321 *   NULL if {@link divisor} is 0.
20322 * @since PHP 4, PHP 5, PHP 7
20323 **/
20324function bcdiv($dividend, $divisor, $scale){}
20325
20326/**
20327 * Get modulus of an arbitrary precision number
20328 *
20329 * Get the remainder of dividing {@link dividend} by {@link divisor}.
20330 * Unless {@link divisor} is zero, the result has the same sign as {@link
20331 * dividend}.
20332 *
20333 * @param string $dividend The dividend, as a string.
20334 * @param string $divisor The divisor, as a string.
20335 * @param int $scale
20336 * @return string Returns the modulus as a string, or NULL if {@link
20337 *   divisor} is 0.
20338 * @since PHP 4, PHP 5, PHP 7
20339 **/
20340function bcmod($dividend, $divisor, $scale){}
20341
20342/**
20343 * Multiply two arbitrary precision numbers
20344 *
20345 * Multiply the {@link left_operand} by the {@link right_operand}.
20346 *
20347 * @param string $left_operand The left operand, as a string.
20348 * @param string $right_operand The right operand, as a string.
20349 * @param int $scale
20350 * @return string Returns the result as a string.
20351 * @since PHP 4, PHP 5, PHP 7
20352 **/
20353function bcmul($left_operand, $right_operand, $scale){}
20354
20355/**
20356 * Reads and creates classes from a bz compressed file
20357 *
20358 * Reads data from a bzcompressed file and creates classes from the
20359 * bytecodes.
20360 *
20361 * @param string $filename The bzcompressed file path, as a string.
20362 * @return bool
20363 * @since PECL bcompiler >= 0.4
20364 **/
20365function bcompiler_load($filename){}
20366
20367/**
20368 * Reads and creates classes from a bcompiler exe file
20369 *
20370 * Reads data from a bcompiler exe file and creates classes from the
20371 * bytecodes.
20372 *
20373 * @param string $filename The exe file path, as a string.
20374 * @return bool
20375 * @since PECL bcompiler >= 0.4
20376 **/
20377function bcompiler_load_exe($filename){}
20378
20379/**
20380 * Reads the bytecodes of a class and calls back to a user function
20381 *
20382 * @param string $class The class name, as a string.
20383 * @param string $callback
20384 * @return bool
20385 * @since PECL bcompiler >= 0.4
20386 **/
20387function bcompiler_parse_class($class, $callback){}
20388
20389/**
20390 * Reads and creates classes from a filehandle
20391 *
20392 * Reads data from a open file handle and creates classes from the
20393 * bytecodes.
20394 *
20395 * @param resource $filehandle A file handle as returned by {@link
20396 *   fopen}.
20397 * @return bool
20398 * @since PECL bcompiler >= 0.4
20399 **/
20400function bcompiler_read($filehandle){}
20401
20402/**
20403 * Writes a defined class as bytecodes
20404 *
20405 * Reads the bytecodes from PHP for an existing class, and writes them to
20406 * the open file handle.
20407 *
20408 * @param resource $filehandle A file handle as returned by {@link
20409 *   fopen}.
20410 * @param string $className The class name, as a string.
20411 * @param string $extends
20412 * @return bool
20413 * @since PECL bcompiler >= 0.4
20414 **/
20415function bcompiler_write_class($filehandle, $className, $extends){}
20416
20417/**
20418 * Writes a defined constant as bytecodes
20419 *
20420 * Reads the bytecodes from PHP for an existing constant, and writes them
20421 * to the open file handle.
20422 *
20423 * @param resource $filehandle A file handle as returned by {@link
20424 *   fopen}.
20425 * @param string $constantName The name of the defined constant, as a
20426 *   string.
20427 * @return bool
20428 * @since PECL bcompiler >= 0.5
20429 **/
20430function bcompiler_write_constant($filehandle, $constantName){}
20431
20432/**
20433 * Writes the start pos, and sig to the end of a exe type file
20434 *
20435 * An EXE (or self executable) file consists of 3 parts: The stub
20436 * (executable code, e.g. a compiled C program) that loads PHP
20437 * interpreter, bcompiler extension, stored Bytecodes and initiates a
20438 * call for the specified function (e.g. main) or class method (e.g.
20439 * main::main) The Bytecodes (uncompressed only for the moment) The
20440 * bcompiler EXE footer
20441 *
20442 * To obtain a suitable stub you can compile php_embed-based stub phpe.c
20443 * located in the examples/embed directory on bcompiler's CVS.
20444 *
20445 * @param resource $filehandle A file handle as returned by {@link
20446 *   fopen}.
20447 * @param int $startpos The file position at which the Bytecodes start,
20448 *   and can be obtained using {@link ftell}.
20449 * @return bool
20450 * @since PECL bcompiler >= 0.4
20451 **/
20452function bcompiler_write_exe_footer($filehandle, $startpos){}
20453
20454/**
20455 * Writes a php source file as bytecodes
20456 *
20457 * This function compiles specified source file into bytecodes, and
20458 * writes them to the open file handle.
20459 *
20460 * @param resource $filehandle A file handle as returned by {@link
20461 *   fopen}.
20462 * @param string $filename The source file path, as a string.
20463 * @return bool
20464 * @since PECL bcompiler >= 0.6
20465 **/
20466function bcompiler_write_file($filehandle, $filename){}
20467
20468/**
20469 * Writes the single character \x00 to indicate End of compiled data
20470 *
20471 * Writes the single character \x00 to indicate End of compiled data.
20472 *
20473 * @param resource $filehandle A file handle as returned by {@link
20474 *   fopen}.
20475 * @return bool
20476 * @since PECL bcompiler >= 0.4
20477 **/
20478function bcompiler_write_footer($filehandle){}
20479
20480/**
20481 * Writes a defined function as bytecodes
20482 *
20483 * Reads the bytecodes from PHP for an existing function, and writes them
20484 * to the open file handle. Order is not important, (eg. if function b
20485 * uses function a, and you compile it like the example below, it will
20486 * work perfectly OK).
20487 *
20488 * @param resource $filehandle A file handle as returned by {@link
20489 *   fopen}.
20490 * @param string $functionName The function name, as a string.
20491 * @return bool
20492 * @since PECL bcompiler >= 0.5
20493 **/
20494function bcompiler_write_function($filehandle, $functionName){}
20495
20496/**
20497 * Writes all functions defined in a file as bytecodes
20498 *
20499 * Searches for all functions declared in the given file, and writes
20500 * their correspondent bytecodes to the open file handle.
20501 *
20502 * @param resource $filehandle A file handle as returned by {@link
20503 *   fopen}.
20504 * @param string $fileName The file to be compiled. You must always
20505 *   include or require the file you intend to compile.
20506 * @return bool
20507 * @since PECL bcompiler >= 0.5
20508 **/
20509function bcompiler_write_functions_from_file($filehandle, $fileName){}
20510
20511/**
20512 * Writes the bcompiler header
20513 *
20514 * Writes the header part of a bcompiler file.
20515 *
20516 * @param resource $filehandle A file handle as returned by {@link
20517 *   fopen}.
20518 * @param string $write_ver Can be used to write bytecode in a
20519 *   previously used format, so that you can use it with older versions
20520 *   of bcompiler.
20521 * @return bool
20522 * @since PECL bcompiler >= 0.3
20523 **/
20524function bcompiler_write_header($filehandle, $write_ver){}
20525
20526/**
20527 * Writes an included file as bytecodes
20528 *
20529 * @param resource $filehandle
20530 * @param string $filename
20531 * @return bool
20532 * @since PECL bcompiler >= 0.5
20533 **/
20534function bcompiler_write_included_filename($filehandle, $filename){}
20535
20536/**
20537 * Raise an arbitrary precision number to another
20538 *
20539 * Raise {@link base} to the power {@link exponent}.
20540 *
20541 * @param string $base The base, as a string.
20542 * @param string $exponent The exponent, as a string. If the exponent
20543 *   is non-integral, it is truncated. The valid range of the exponent is
20544 *   platform specific, but is at least -2147483648 to 2147483647.
20545 * @param int $scale
20546 * @return string Returns the result as a string.
20547 * @since PHP 4, PHP 5, PHP 7
20548 **/
20549function bcpow($base, $exponent, $scale){}
20550
20551/**
20552 * Raise an arbitrary precision number to another, reduced by a specified
20553 * modulus
20554 *
20555 * Use the fast-exponentiation method to raise {@link base} to the power
20556 * {@link exponent} with respect to the modulus {@link modulus}.
20557 *
20558 * @param string $base The base, as an integral string (i.e. the scale
20559 *   has to be zero).
20560 * @param string $exponent The exponent, as an non-negative, integral
20561 *   string (i.e. the scale has to be zero).
20562 * @param string $modulus The modulus, as an integral string (i.e. the
20563 *   scale has to be zero).
20564 * @param int $scale
20565 * @return string Returns the result as a string, or FALSE if {@link
20566 *   modulus} is 0 or {@link exponent} is negative.
20567 * @since PHP 5, PHP 7
20568 **/
20569function bcpowmod($base, $exponent, $modulus, $scale){}
20570
20571/**
20572 * Set or get default scale parameter for all bc math functions
20573 *
20574 * Sets the default scale parameter for all subsequent calls to bc math
20575 * functions that do not explicitly specify a scale parameter.
20576 *
20577 * Gets the current scale factor.
20578 *
20579 * @param int $scale The scale factor.
20580 * @return int Returns the old scale when used as setter. Otherwise the
20581 *   current scale is returned.
20582 * @since PHP 4, PHP 5, PHP 7
20583 **/
20584function bcscale($scale){}
20585
20586/**
20587 * Get the square root of an arbitrary precision number
20588 *
20589 * Return the square root of the {@link operand}.
20590 *
20591 * @param string $operand The operand, as a string.
20592 * @param int $scale
20593 * @return string Returns the square root as a string, or NULL if
20594 *   {@link operand} is negative.
20595 * @since PHP 4, PHP 5, PHP 7
20596 **/
20597function bcsqrt($operand, $scale){}
20598
20599/**
20600 * Subtract one arbitrary precision number from another
20601 *
20602 * Subtracts the {@link right_operand} from the {@link left_operand}.
20603 *
20604 * @param string $left_operand The left operand, as a string.
20605 * @param string $right_operand The right operand, as a string.
20606 * @param int $scale
20607 * @return string The result of the subtraction, as a string.
20608 * @since PHP 4, PHP 5, PHP 7
20609 **/
20610function bcsub($left_operand, $right_operand, $scale){}
20611
20612/**
20613 * Convert binary data into hexadecimal representation
20614 *
20615 * Returns an ASCII string containing the hexadecimal representation of
20616 * {@link str}. The conversion is done byte-wise with the high-nibble
20617 * first.
20618 *
20619 * @param string $str A string.
20620 * @return string Returns the hexadecimal representation of the given
20621 *   string.
20622 * @since PHP 4, PHP 5, PHP 7
20623 **/
20624function bin2hex($str){}
20625
20626/**
20627 * Binary to decimal
20628 *
20629 * Returns the decimal equivalent of the binary number represented by the
20630 * {@link binary_string} argument.
20631 *
20632 * {@link bindec} converts a binary number to an integer or, if needed
20633 * for size reasons, float.
20634 *
20635 * {@link bindec} interprets all {@link binary_string} values as unsigned
20636 * integers. This is because {@link bindec} sees the most significant bit
20637 * as another order of magnitude rather than as the sign bit.
20638 *
20639 * @param string $binary_string The binary string to convert. Any
20640 *   invalid characters in {@link binary_string} are silently ignored. As
20641 *   of PHP 7.4.0 supplying any invalid characters is deprecated.
20642 * @return number The decimal value of {@link binary_string}
20643 * @since PHP 4, PHP 5, PHP 7
20644 **/
20645function bindec($binary_string){}
20646
20647/**
20648 * Sets the path for a domain
20649 *
20650 * The {@link bindtextdomain} function sets the path for a domain.
20651 *
20652 * @param string $domain The domain
20653 * @param string $directory The directory path
20654 * @return string The full pathname for the {@link domain} currently
20655 *   being set.
20656 * @since PHP 4, PHP 5, PHP 7
20657 **/
20658function bindtextdomain($domain, $directory){}
20659
20660/**
20661 * Specify the character encoding in which the messages from the DOMAIN
20662 * message catalog will be returned
20663 *
20664 * With {@link bind_textdomain_codeset}, you can set in which encoding
20665 * will be messages from {@link domain} returned by {@link gettext} and
20666 * similar functions.
20667 *
20668 * @param string $domain The domain
20669 * @param string $codeset The code set
20670 * @return string A string on success.
20671 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
20672 **/
20673function bind_textdomain_codeset($domain, $codeset){}
20674
20675/**
20676 * Encrypt a PHP script with BLENC
20677 *
20678 * Encrypt the {@link plaintext} content and write it into {@link
20679 * encodedfile}
20680 *
20681 * @param string $plaintext A source code to encrypt. Does not need to
20682 *   contain opening/closing PHP tags
20683 * @param string $encodedfile The filename where BLENC will save the
20684 *   encoded source.
20685 * @param string $encryption_key The key that BLENC will use to encrypt
20686 *   plaintext content. If not given BLENC will create a valid key.
20687 * @return string BLENC will return the redistributable key that must
20688 *   be saved into key_file: the path of key_file is specified at runtime
20689 *   with the option blenc.key_file
20690 * @since PECL blenc >= 5
20691 **/
20692function blenc_encrypt($plaintext, $encodedfile, $encryption_key){}
20693
20694/**
20695 * Get the boolean value of a variable
20696 *
20697 * Returns the boolean value of {@link var}.
20698 *
20699 * @param mixed $var The scalar value being converted to a boolean.
20700 * @return bool The boolean value of {@link var}.
20701 * @since PHP 5 >= 5.5.0, PHP 7
20702 **/
20703function boolval($var){}
20704
20705/**
20706 * Deserializes a BSON object into a PHP array
20707 *
20708 * This function is very beta and entirely useless for 99% of users. It
20709 * is only useful if you're doing something weird, such as writing your
20710 * own driver on top of the PHP driver.
20711 *
20712 * @param string $bson The BSON to be deserialized.
20713 * @return array Returns the deserialized BSON object.
20714 * @since PECL mongo >=1.0.1
20715 **/
20716function bson_decode($bson){}
20717
20718/**
20719 * Serializes a PHP variable into a BSON string
20720 *
20721 * This function is very beta and entirely useless for 99% of users. It
20722 * is only useful if you're doing something weird, such as writing your
20723 * own driver on top of the PHP driver.
20724 *
20725 * @param mixed $anything The variable to be serialized.
20726 * @return string Returns the serialized string.
20727 * @since PECL mongo >=1.0.1
20728 **/
20729function bson_encode($anything){}
20730
20731/**
20732 * Close a bzip2 file
20733 *
20734 * Closes the given bzip2 file pointer.
20735 *
20736 * @param resource $bz The file pointer. It must be valid and must
20737 *   point to a file successfully opened by {@link bzopen}.
20738 * @return bool
20739 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
20740 **/
20741function bzclose($bz){}
20742
20743/**
20744 * Compress a string into bzip2 encoded data
20745 *
20746 * {@link bzcompress} compresses the given string and returns it as bzip2
20747 * encoded data.
20748 *
20749 * @param string $source The string to compress.
20750 * @param int $blocksize Specifies the blocksize used during
20751 *   compression and should be a number from 1 to 9 with 9 giving the
20752 *   best compression, but using more resources to do so.
20753 * @param int $workfactor Controls how the compression phase behaves
20754 *   when presented with worst case, highly repetitive, input data. The
20755 *   value can be between 0 and 250 with 0 being a special case.
20756 *   Regardless of the {@link workfactor}, the generated output is the
20757 *   same.
20758 * @return mixed The compressed string, or an error number if an error
20759 *   occurred.
20760 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
20761 **/
20762function bzcompress($source, $blocksize, $workfactor){}
20763
20764/**
20765 * Decompresses bzip2 encoded data
20766 *
20767 * {@link bzdecompress} decompresses the given string containing bzip2
20768 * encoded data.
20769 *
20770 * @param string $source The string to decompress.
20771 * @param int $small If TRUE, an alternative decompression algorithm
20772 *   will be used which uses less memory (the maximum memory requirement
20773 *   drops to around 2300K) but works at roughly half the speed. See the
20774 *   bzip2 documentation for more information about this feature.
20775 * @return mixed The decompressed string, or an error number if an
20776 *   error occurred.
20777 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
20778 **/
20779function bzdecompress($source, $small){}
20780
20781/**
20782 * Returns a bzip2 error number
20783 *
20784 * Returns the error number of any bzip2 error returned by the given file
20785 * pointer.
20786 *
20787 * @param resource $bz The file pointer. It must be valid and must
20788 *   point to a file successfully opened by {@link bzopen}.
20789 * @return int Returns the error number as an integer.
20790 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
20791 **/
20792function bzerrno($bz){}
20793
20794/**
20795 * Returns the bzip2 error number and error string in an array
20796 *
20797 * Returns the error number and error string of any bzip2 error returned
20798 * by the given file pointer.
20799 *
20800 * @param resource $bz The file pointer. It must be valid and must
20801 *   point to a file successfully opened by {@link bzopen}.
20802 * @return array Returns an associative array, with the error code in
20803 *   the errno entry, and the error message in the errstr entry.
20804 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
20805 **/
20806function bzerror($bz){}
20807
20808/**
20809 * Returns a bzip2 error string
20810 *
20811 * Gets the error string of any bzip2 error returned by the given file
20812 * pointer.
20813 *
20814 * @param resource $bz The file pointer. It must be valid and must
20815 *   point to a file successfully opened by {@link bzopen}.
20816 * @return string Returns a string containing the error message.
20817 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
20818 **/
20819function bzerrstr($bz){}
20820
20821/**
20822 * Force a write of all buffered data
20823 *
20824 * Forces a write of all buffered bzip2 data for the file pointer {@link
20825 * bz}.
20826 *
20827 * @param resource $bz The file pointer. It must be valid and must
20828 *   point to a file successfully opened by {@link bzopen}.
20829 * @return bool
20830 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
20831 **/
20832function bzflush($bz){}
20833
20834/**
20835 * Opens a bzip2 compressed file
20836 *
20837 * {@link bzopen} opens a bzip2 (.bz2) file for reading or writing.
20838 *
20839 * @param mixed $file The name of the file to open, or an existing
20840 *   stream resource.
20841 * @param string $mode The modes 'r' (read), and 'w' (write) are
20842 *   supported. Everything else will cause {@link bzopen} to return
20843 *   FALSE.
20844 * @return resource If the open fails, {@link bzopen} returns FALSE,
20845 *   otherwise it returns a pointer to the newly opened file.
20846 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
20847 **/
20848function bzopen($file, $mode){}
20849
20850/**
20851 * Binary safe bzip2 file read
20852 *
20853 * {@link bzread} reads from the given bzip2 file pointer.
20854 *
20855 * Reading stops when {@link length} (uncompressed) bytes have been read
20856 * or EOF is reached, whichever comes first.
20857 *
20858 * @param resource $bz The file pointer. It must be valid and must
20859 *   point to a file successfully opened by {@link bzopen}.
20860 * @param int $length If not specified, {@link bzread} will read 1024
20861 *   (uncompressed) bytes at a time. A maximum of 8192 uncompressed bytes
20862 *   will be read at a time.
20863 * @return string Returns the uncompressed data, or FALSE on error.
20864 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
20865 **/
20866function bzread($bz, $length){}
20867
20868/**
20869 * Binary safe bzip2 file write
20870 *
20871 * {@link bzwrite} writes a string into the given bzip2 file stream.
20872 *
20873 * @param resource $bz The file pointer. It must be valid and must
20874 *   point to a file successfully opened by {@link bzopen}.
20875 * @param string $data The written data.
20876 * @param int $length If supplied, writing will stop after {@link
20877 *   length} (uncompressed) bytes have been written or the end of {@link
20878 *   data} is reached, whichever comes first.
20879 * @return int Returns the number of bytes written, or FALSE on error.
20880 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
20881 **/
20882function bzwrite($bz, $data, $length){}
20883
20884/**
20885 * Appends a path to current path
20886 *
20887 * Appends the {@link path} onto the current path. The {@link path} may
20888 * be either the return value from one of CairoContext::copyPath or
20889 * CairoContext::copyPathFlat;
20890 *
20891 * if {@link path} is not a valid CairoPath instance a CairoException
20892 * will be thrown
20893 *
20894 * @param CairoContext $context CairoContext object
20895 * @param CairoPath $path CairoPath object
20896 * @return void
20897 * @since PECL cairo >= 0.1.0
20898 **/
20899function cairo_append_path($context, $path){}
20900
20901/**
20902 * Adds a circular arc
20903 *
20904 * Adds a circular arc of the given radius to the current path. The arc
20905 * is centered at ({@link x}, {@link y}), begins at {@link angle1} and
20906 * proceeds in the direction of increasing angles to end at {@link
20907 * angle2}. If {@link angle2} is less than {@link angle1} it will be
20908 * progressively increased by 2*M_PI until it is greater than {@link
20909 * angle1}. If there is a current point, an initial line segment will be
20910 * added to the path to connect the current point to the beginning of the
20911 * arc. If this initial line is undesired, it can be avoided by calling
20912 * CairoContext::newSubPath or procedural {@link cairo_new_sub_path}
20913 * before calling CairoContext::arc or {@link cairo_arc}.
20914 *
20915 * Angles are measured in radians. An angle of 0.0 is in the direction of
20916 * the positive X axis (in user space). An angle of M_PI/2.0 radians (90
20917 * degrees) is in the direction of the positive Y axis (in user space).
20918 * Angles increase in the direction from the positive X axis toward the
20919 * positive Y axis. So with the default transformation matrix, angles
20920 * increase in a clockwise direction.
20921 *
20922 * (To convert from degrees to radians, use degrees * (M_PI / 180.).)
20923 * This function gives the arc in the direction of increasing angles; see
20924 * CairoContext::arcNegative or {@link cairo_arc_negative} to get the arc
20925 * in the direction of decreasing angles.
20926 *
20927 * @param CairoContext $context A valid CairoContext object
20928 * @param float $x x position
20929 * @param float $y y position
20930 * @param float $radius Radius of the arc
20931 * @param float $angle1 start angle
20932 * @param float $angle2 end angle
20933 * @return void
20934 * @since PECL cairo >= 0.1.0
20935 **/
20936function cairo_arc($context, $x, $y, $radius, $angle1, $angle2){}
20937
20938/**
20939 * Adds a negative arc
20940 *
20941 * Adds a circular arc of the given {@link radius} to the current path.
20942 * The arc is centered at ({@link x}, {@link y}), begins at {@link
20943 * angle1} and proceeds in the direction of decreasing angles to end at
20944 * {@link angle2}. If {@link angle2} is greater than {@link angle1} it
20945 * will be progressively decreased by 2*M_PI until it is less than {@link
20946 * angle1}.
20947 *
20948 * See CairoContext::arc or {@link cairo_arc} for more details. This
20949 * function differs only in the direction of the arc between the two
20950 * angles.
20951 *
20952 * @param CairoContext $context A valid CairoContext object
20953 * @param float $x double x position
20954 * @param float $y double y position
20955 * @param float $radius The radius of the desired negative arc
20956 * @param float $angle1 Start angle of the arc
20957 * @param float $angle2 End angle of the arc
20958 * @return void
20959 * @since PECL cairo >= 0.1.0
20960 **/
20961function cairo_arc_negative($context, $x, $y, $radius, $angle1, $angle2){}
20962
20963/**
20964 * Retrieves the availables font types
20965 *
20966 * Returns an array with the available font backends
20967 *
20968 * @return array A list-type array with all available font backends.
20969 **/
20970function cairo_available_fonts(){}
20971
20972/**
20973 * Retrieves all available surfaces
20974 *
20975 * Returns an array with the available surface backends
20976 *
20977 * @return array A list-type array with all available surface backends.
20978 **/
20979function cairo_available_surfaces(){}
20980
20981/**
20982 * Establishes a new clip region
20983 *
20984 * Establishes a new clip region by intersecting the current clip region
20985 * with the current path as it would be filled by CairoContext::fill or
20986 * {@link cairo_fill} and according to the current fill rule (see
20987 * CairoContext::setFillRule or {@link cairo_set_fill_rule}).
20988 *
20989 * After CairoContext::clip or {@link cairo_clip}, the current path will
20990 * be cleared from the cairo context.
20991 *
20992 * The current clip region affects all drawing operations by effectively
20993 * masking out any changes to the surface that are outside the current
20994 * clip region.
20995 *
20996 * Calling CairoContext::clip or {@link cairo_clip} can only make the
20997 * clip region smaller, never larger. But the current clip is part of the
20998 * graphics state, so a temporary restriction of the clip region can be
20999 * achieved by calling CairoContext::clip or {@link cairo_clip} within a
21000 * CairoContext::save/CairoContext::restore or {@link cairo_save}/{@link
21001 * cairo_restore} pair. The only other means of increasing the size of
21002 * the clip region is CairoContext::resetClip or procedural {@link
21003 * cairo_reset_clip}.
21004 *
21005 * @param CairoContext $context A valid CairoContext object
21006 * @return void
21007 * @since PECL cairo >= 0.1.0
21008 **/
21009function cairo_clip($context){}
21010
21011/**
21012 * Computes the area inside the current clip
21013 *
21014 * Computes a bounding box in user coordinates covering the area inside
21015 * the current clip.
21016 *
21017 * @param CairoContext $context A valid CairoContext object
21018 * @return array An array containing the (float)x1, (float)y1,
21019 *   (float)x2, (float)y2, coordinates covering the area inside the
21020 *   current clip
21021 * @since PECL cairo >= 0.1.0
21022 **/
21023function cairo_clip_extents($context){}
21024
21025/**
21026 * Establishes a new clip region from the current clip
21027 *
21028 * Establishes a new clip region by intersecting the current clip region
21029 * with the current path as it would be filled by Context.fill and
21030 * according to the current FILL RULE (see CairoContext::setFillRule or
21031 * {@link cairo_set_fill_rule}).
21032 *
21033 * Unlike CairoContext::clip, CairoContext::clipPreserve preserves the
21034 * path within the Context. The current clip region affects all drawing
21035 * operations by effectively masking out any changes to the surface that
21036 * are outside the current clip region.
21037 *
21038 * Calling CairoContext::clipPreserve can only make the clip region
21039 * smaller, never larger. But the current clip is part of the graphics
21040 * state, so a temporary restriction of the clip region can be achieved
21041 * by calling CairoContext::clipPreserve within a
21042 * CairoContext::save/CairoContext::restore pair. The only other means of
21043 * increasing the size of the clip region is CairoContext::resetClip.
21044 *
21045 * @param CairoContext $context A valid CairoContext object
21046 * @return void
21047 * @since PECL cairo >= 0.1.0
21048 **/
21049function cairo_clip_preserve($context){}
21050
21051/**
21052 * Retrieves the current clip as a list of rectangles
21053 *
21054 * Returns a list-type array with the current clip region as a list of
21055 * rectangles in user coordinates
21056 *
21057 * @param CairoContext $context A valid CairoContext object created
21058 *   with CairoContext::__construct or {@link cairo_create}
21059 * @return array An array of user-space represented rectangles for the
21060 *   current clip
21061 * @since PECL cairo >= 0.1.0
21062 **/
21063function cairo_clip_rectangle_list($context){}
21064
21065/**
21066 * Closes the current path
21067 *
21068 * Adds a line segment to the path from the current point to the
21069 * beginning of the current sub-path, (the most recent point passed to
21070 * CairoContext::moveTo), and closes this sub-path. After this call the
21071 * current point will be at the joined endpoint of the sub-path.
21072 *
21073 * The behavior of close_path() is distinct from simply calling
21074 * CairoContext::lineTo with the equivalent coordinate in the case of
21075 * stroking. When a closed sub-path is stroked, there are no caps on the
21076 * ends of the sub-path. Instead, there is a line join connecting the
21077 * final and initial segments of the sub-path.
21078 *
21079 * If there is no current point before the call to
21080 * CairoContext::closePath, this function will have no effect.
21081 *
21082 * @param CairoContext $context A valid CairoContext object created
21083 *   with CairoContext::__construct or {@link cairo_create}
21084 * @return void
21085 * @since PECL cairo >= 0.1.0
21086 **/
21087function cairo_close_path($context){}
21088
21089/**
21090 * The copyPage purpose
21091 *
21092 * Emits the current page for backends that support multiple pages, but
21093 * doesn't clear it, so that the contents of the current page will be
21094 * retained for the next page. Use CairoSurface::showPage() if you want
21095 * to get an empty page after the emission.
21096 *
21097 * @param CairoContext $context A CairoContext object
21098 * @return void Description...
21099 * @since PECL cairo >= 0.1.0
21100 **/
21101function cairo_copy_page($context){}
21102
21103/**
21104 * Creates a copy of the current path
21105 *
21106 * Creates a copy of the current path and returns it to the user as a
21107 * CairoPath. See CairoPath for hints on how to iterate over the returned
21108 * data structure.
21109 *
21110 * This function will always return a valid CairoPath object, but the
21111 * result will have no data, if either of the following conditions hold:
21112 * 1. If there is insufficient memory to copy the path. In this case
21113 * CairoPath->status will be set to CAIRO_STATUS_NO_MEMORY. 2. If {@link
21114 * context} is already in an error state. In this case CairoPath->status
21115 * will contain the same status that would be returned by {@link
21116 * cairo_status}.
21117 *
21118 * In either case, CairoPath->status will be set to
21119 * CAIRO_STATUS_NO_MEMORY (regardless of what the error status in cr
21120 * might have been).
21121 *
21122 * @param CairoContext $context A valid CairoContext object created
21123 *   with CairoContext::__construct or {@link cairo_create}
21124 * @return CairoPath A copy of the current CairoPath in the context
21125 * @since PECL cairo >= 0.1.0
21126 **/
21127function cairo_copy_path($context){}
21128
21129/**
21130 * Gets a flattened copy of the current path
21131 *
21132 * Gets a flattened copy of the current path and returns it to the user
21133 * as a CairoPath.
21134 *
21135 * This function is like CairoContext::copyPath except that any curves in
21136 * the path will be approximated with piecewise-linear approximations,
21137 * (accurate to within the current tolerance value). That is, the result
21138 * is guaranteed to not have any elements of type CAIRO_PATH_CURVE_TO
21139 * which will instead be replaced by a series of CAIRO_PATH_LINE_TO
21140 * elements.
21141 *
21142 * @param CairoContext $context A CairoContext object
21143 * @return CairoPath A copy of the current path
21144 * @since PECL cairo >= 0.1.0
21145 **/
21146function cairo_copy_path_flat($context){}
21147
21148/**
21149 * Returns a new CairoContext object on the requested surface
21150 *
21151 * @param CairoSurface $surface Description...
21152 * @return CairoContext What is returned on success and failure
21153 * @since PECL cairo >= 0.1.0
21154 **/
21155function cairo_create($surface){}
21156
21157/**
21158 * Adds a curve
21159 *
21160 * Adds a cubic Bezier spline to the path from the current point to
21161 * position {@link x3} ,{@link y3} in user-space coordinates, using
21162 * {@link x1}, {@link y1} and {@link x2}, {@link y2} as the control
21163 * points. After this call the current point will be {@link x3}, {@link
21164 * y3}.
21165 *
21166 * If there is no current point before the call to CairoContext::curveTo
21167 * this function will behave as if preceded by a call to
21168 * CairoContext::moveTo ({@link x1}, {@link y1}).
21169 *
21170 * @param CairoContext $context A valid CairoContext object created
21171 *   with CairoContext::__construct or {@link cairo_create}
21172 * @param float $x1 First control point in the x axis for the curve
21173 * @param float $y1 First control point in the y axis for the curve
21174 * @param float $x2 Second control point in x axis for the curve
21175 * @param float $y2 Second control point in y axis for the curve
21176 * @param float $x3 Final point in the x axis for the curve
21177 * @param float $y3 Final point in the y axis for the curve
21178 * @return void
21179 * @since PECL cairo >= 0.1.0
21180 **/
21181function cairo_curve_to($context, $x1, $y1, $x2, $y2, $x3, $y3){}
21182
21183/**
21184 * Transform a coordinate
21185 *
21186 * Transform a coordinate from device space to user space by multiplying
21187 * the given point by the inverse of the current transformation matrix
21188 * (CTM).
21189 *
21190 * @param CairoContext $context A valid CairoContext object created
21191 *   with CairoContext::__construct or {@link cairo_create}
21192 * @param float $x x value of the coordinate
21193 * @param float $y y value of the coordinate
21194 * @return array An array containing the x and y coordinates in the
21195 *   user-space
21196 * @since PECL cairo >= 0.1.0
21197 **/
21198function cairo_device_to_user($context, $x, $y){}
21199
21200/**
21201 * Transform a distance
21202 *
21203 * Transform a distance vector from device space to user space. This
21204 * function is similar to CairoContext::deviceToUser or {@link
21205 * cairo_device_to_user} except that the translation components of the
21206 * inverse Cairo Transformation Matrix will be ignored when transforming
21207 * ({@link x},{@link y}).
21208 *
21209 * @param CairoContext $context A valid CairoContext object created
21210 *   with CairoContext::__construct or {@link cairo_create}
21211 * @param float $x X component of a distance vector
21212 * @param float $y Y component of a distance vector
21213 * @return array Returns an array with the x and y values of a distance
21214 *   vector in the user-space
21215 * @since PECL cairo >= 0.1.0
21216 **/
21217function cairo_device_to_user_distance($context, $x, $y){}
21218
21219/**
21220 * Fills the current path
21221 *
21222 * A drawing operator that fills the current path according to the
21223 * current CairoFillRule, (each sub-path is implicitly closed before
21224 * being filled). After CairoContext::fill or {@link cairo_fill}, the
21225 * current path will be cleared from the CairoContext.
21226 *
21227 * @param CairoContext $context A valid CairoContext object created
21228 *   with CairoContext::__construct or {@link cairo_create}
21229 * @return void
21230 * @since PECL cairo >= 0.1.0
21231 **/
21232function cairo_fill($context){}
21233
21234/**
21235 * Computes the filled area
21236 *
21237 * Computes a bounding box in user coordinates covering the area that
21238 * would be affected, (the “inked” area), by a CairoContext::fill
21239 * operation given the current path and fill parameters. If the current
21240 * path is empty, returns an empty rectangle (0,0,0,0). Surface
21241 * dimensions and clipping are not taken into account.
21242 *
21243 * Contrast with CairoContext::pathExtents, which is similar, but returns
21244 * non-zero extents for some paths with no inked area, (such as a simple
21245 * line segment).
21246 *
21247 * Note that CairoContext::fillExtents must necessarily do more work to
21248 * compute the precise inked areas in light of the fill rule, so
21249 * CairoContext::pathExtents may be more desirable for sake of
21250 * performance if the non-inked path extents are desired.
21251 *
21252 * @param CairoContext $context A valid CairoContext object created
21253 *   with CairoContext::__construct or {@link cairo_create}
21254 * @return array An array with the coordinates of the afected area
21255 * @since PECL cairo >= 0.1.0
21256 **/
21257function cairo_fill_extents($context){}
21258
21259/**
21260 * Fills and preserve the current path
21261 *
21262 * A drawing operator that fills the current path according to the
21263 * current CairoFillRule, (each sub-path is implicitly closed before
21264 * being filled). Unlike CairoContext::fill, CairoContext::fillPreserve
21265 * (Procedural {@link cairo_fill}, {@link cairo_fill_preserve},
21266 * respectively) preserves the path within the Context.
21267 *
21268 * @param CairoContext $context A valid CairoContext object created
21269 *   with CairoContext::__construct or {@link cairo_create}
21270 * @return void
21271 * @since PECL cairo >= 0.1.0
21272 **/
21273function cairo_fill_preserve($context){}
21274
21275/**
21276 * Get the font extents
21277 *
21278 * Gets the font extents for the currently selected font.
21279 *
21280 * @param CairoContext $context Description...
21281 * @return array An array containing the font extents for the current
21282 *   font.
21283 * @since PECL cairo >= 0.1.0
21284 **/
21285function cairo_font_extents($context){}
21286
21287/**
21288 * Retrieves the font face type
21289 *
21290 * This function returns the type of the backend used to create a font
21291 * face. See CairoFontType class constants for available types.
21292 *
21293 * @param CairoFontFace $fontface
21294 * @return int A font type that can be any one defined in CairoFontType
21295 * @since PECL cairo >= 0.1.0
21296 **/
21297function cairo_font_face_get_type($fontface){}
21298
21299/**
21300 * Check for CairoFontFace errors
21301 *
21302 * Checks whether an error has previously occurred for this font face
21303 *
21304 * @param CairoFontFace $fontface A valid CairoFontFace object
21305 * @return int CAIRO_STATUS_SUCCESS or another error such as
21306 *   CAIRO_STATUS_NO_MEMORY.
21307 * @since PECL cairo >= 0.1.0
21308 **/
21309function cairo_font_face_status($fontface){}
21310
21311/**
21312 * @return CairoFontOptions What is returned on success and failure
21313 * @since PECL cairo >= 0.1.0
21314 **/
21315function cairo_font_options_create(){}
21316
21317/**
21318 * @param CairoFontOptions $options Description...
21319 * @param CairoFontOptions $other Description...
21320 * @return bool What is returned on success and failure
21321 * @since PECL cairo >= 0.1.0
21322 **/
21323function cairo_font_options_equal($options, $other){}
21324
21325/**
21326 * @param CairoFontOptions $options Description...
21327 * @return int What is returned on success and failure
21328 * @since PECL cairo >= 0.1.0
21329 **/
21330function cairo_font_options_get_antialias($options){}
21331
21332/**
21333 * @param CairoFontOptions $options Description...
21334 * @return int What is returned on success and failure
21335 * @since PECL cairo >= 0.1.0
21336 **/
21337function cairo_font_options_get_hint_metrics($options){}
21338
21339/**
21340 * @param CairoFontOptions $options Description...
21341 * @return int What is returned on success and failure
21342 * @since PECL cairo >= 0.1.0
21343 **/
21344function cairo_font_options_get_hint_style($options){}
21345
21346/**
21347 * @param CairoFontOptions $options Description...
21348 * @return int What is returned on success and failure
21349 * @since PECL cairo >= 0.1.0
21350 **/
21351function cairo_font_options_get_subpixel_order($options){}
21352
21353/**
21354 * @param CairoFontOptions $options Description...
21355 * @return int What is returned on success and failure
21356 * @since PECL cairo >= 0.1.0
21357 **/
21358function cairo_font_options_hash($options){}
21359
21360/**
21361 * @param CairoFontOptions $options Description...
21362 * @param CairoFontOptions $other Description...
21363 * @return void What is returned on success and failure
21364 * @since PECL cairo >= 0.1.0
21365 **/
21366function cairo_font_options_merge($options, $other){}
21367
21368/**
21369 * @param CairoFontOptions $options Description...
21370 * @param int $antialias Description...
21371 * @return void What is returned on success and failure
21372 * @since PECL cairo >= 0.1.0
21373 **/
21374function cairo_font_options_set_antialias($options, $antialias){}
21375
21376/**
21377 * @param CairoFontOptions $options Description...
21378 * @param int $hint_metrics Description...
21379 * @return void What is returned on success and failure
21380 * @since PECL cairo >= 0.1.0
21381 **/
21382function cairo_font_options_set_hint_metrics($options, $hint_metrics){}
21383
21384/**
21385 * @param CairoFontOptions $options Description...
21386 * @param int $hint_style Description...
21387 * @return void What is returned on success and failure
21388 * @since PECL cairo >= 0.1.0
21389 **/
21390function cairo_font_options_set_hint_style($options, $hint_style){}
21391
21392/**
21393 * @param CairoFontOptions $options Description...
21394 * @param int $subpixel_order Description...
21395 * @return void What is returned on success and failure
21396 * @since PECL cairo >= 0.1.0
21397 **/
21398function cairo_font_options_set_subpixel_order($options, $subpixel_order){}
21399
21400/**
21401 * @param CairoFontOptions $options Description...
21402 * @return int What is returned on success and failure
21403 * @since PECL cairo >= 0.1.0
21404 **/
21405function cairo_font_options_status($options){}
21406
21407/**
21408 * @param int $format Description...
21409 * @param int $width Description...
21410 * @return int What is returned on success and failure
21411 * @since PECL cairo >= 0.1.0
21412 **/
21413function cairo_format_stride_for_width($format, $width){}
21414
21415/**
21416 * The getAntialias purpose
21417 *
21418 * @param CairoContext $context Description...
21419 * @return int Description...
21420 * @since PECL cairo >= 0.1.0
21421 **/
21422function cairo_get_antialias($context){}
21423
21424/**
21425 * The getCurrentPoint purpose
21426 *
21427 * Gets the current point of the current path, which is conceptually the
21428 * final point reached by the path so far.
21429 *
21430 * The current point is returned in the user-space coordinate system. If
21431 * there is no defined current point or if cr is in an error status, x
21432 * and y will both be set to 0.0. It is possible to check this in advance
21433 * with CairoContext::hasCurrentPoint.
21434 *
21435 * Most path construction functions alter the current point. See the
21436 * following for details on how they affect the current point:
21437 * CairoContext::newPath, CairoContext::newSubPath,
21438 * CairoContext::appendPath, CairoContext::closePath,
21439 * CairoContext::moveTo, CairoContext::lineTo, CairoContext::curveTo,
21440 * CairoContext::relMoveTo, CairoContext::relLineTo,
21441 * CairoContext::relCurveTo, CairoContext::arc,
21442 * CairoContext::arcNegative, CairoContext::rectangle,
21443 * CairoContext::textPath, CairoContext::glyphPath.
21444 *
21445 * Some functions use and alter the current point but do not otherwise
21446 * change current path: CairoContext::showText.
21447 *
21448 * Some functions unset the current path and as a result, current point:
21449 * CairoContext::fill, CairoContext::stroke.
21450 *
21451 * @param CairoContext $context A valid CairoContext object.
21452 * @return array An array containing the x (index 0) and y (index 1)
21453 *   coordinates of the current point.
21454 * @since PECL cairo >= 0.1.0
21455 **/
21456function cairo_get_current_point($context){}
21457
21458/**
21459 * The getDash purpose
21460 *
21461 * @param CairoContext $context Description...
21462 * @return array Description...
21463 * @since PECL cairo >= 0.1.0
21464 **/
21465function cairo_get_dash($context){}
21466
21467/**
21468 * The getDashCount purpose
21469 *
21470 * @param CairoContext $context Description...
21471 * @return int Description...
21472 * @since PECL cairo >= 0.1.0
21473 **/
21474function cairo_get_dash_count($context){}
21475
21476/**
21477 * The getFillRule purpose
21478 *
21479 * @param CairoContext $context Description...
21480 * @return int Description...
21481 * @since PECL cairo >= 0.1.0
21482 **/
21483function cairo_get_fill_rule($context){}
21484
21485/**
21486 * The getFontFace purpose
21487 *
21488 * @param CairoContext $context Description...
21489 * @return void Description...
21490 * @since PECL cairo >= 0.1.0
21491 **/
21492function cairo_get_font_face($context){}
21493
21494/**
21495 * The getFontMatrix purpose
21496 *
21497 * @param CairoContext $context Description...
21498 * @return void Description...
21499 * @since PECL cairo >= 0.1.0
21500 **/
21501function cairo_get_font_matrix($context){}
21502
21503/**
21504 * The getFontOptions purpose
21505 *
21506 * @param CairoContext $context Description...
21507 * @return void Description...
21508 * @since PECL cairo >= 0.1.0
21509 **/
21510function cairo_get_font_options($context){}
21511
21512/**
21513 * The getGroupTarget purpose
21514 *
21515 * @param CairoContext $context Description...
21516 * @return void Description...
21517 * @since PECL cairo >= 0.1.0
21518 **/
21519function cairo_get_group_target($context){}
21520
21521/**
21522 * The getLineCap purpose
21523 *
21524 * @param CairoContext $context Description...
21525 * @return int Description...
21526 * @since PECL cairo >= 0.1.0
21527 **/
21528function cairo_get_line_cap($context){}
21529
21530/**
21531 * The getLineJoin purpose
21532 *
21533 * @param CairoContext $context Description...
21534 * @return int Description...
21535 * @since PECL cairo >= 0.1.0
21536 **/
21537function cairo_get_line_join($context){}
21538
21539/**
21540 * The getLineWidth purpose
21541 *
21542 * @param CairoContext $context Description...
21543 * @return float Description...
21544 * @since PECL cairo >= 0.1.0
21545 **/
21546function cairo_get_line_width($context){}
21547
21548/**
21549 * The getMatrix purpose
21550 *
21551 * @param CairoContext $context Description...
21552 * @return void Description...
21553 * @since PECL cairo >= 0.1.0
21554 **/
21555function cairo_get_matrix($context){}
21556
21557/**
21558 * The getMiterLimit purpose
21559 *
21560 * @param CairoContext $context Description...
21561 * @return float Description...
21562 * @since PECL cairo >= 0.1.0
21563 **/
21564function cairo_get_miter_limit($context){}
21565
21566/**
21567 * The getOperator purpose
21568 *
21569 * @param CairoContext $context Description...
21570 * @return int Description...
21571 * @since PECL cairo >= 0.1.0
21572 **/
21573function cairo_get_operator($context){}
21574
21575/**
21576 * The getScaledFont purpose
21577 *
21578 * @param CairoContext $context Description...
21579 * @return void Description...
21580 * @since PECL cairo >= 0.1.0
21581 **/
21582function cairo_get_scaled_font($context){}
21583
21584/**
21585 * The getSource purpose
21586 *
21587 * @param CairoContext $context Description...
21588 * @return void Description...
21589 * @since PECL cairo >= 0.1.0
21590 **/
21591function cairo_get_source($context){}
21592
21593/**
21594 * The getTarget purpose
21595 *
21596 * @param CairoContext $context Description...
21597 * @return void Description...
21598 * @since PECL cairo >= 0.1.0
21599 **/
21600function cairo_get_target($context){}
21601
21602/**
21603 * The getTolerance purpose
21604 *
21605 * @param CairoContext $context Description...
21606 * @return float Description...
21607 * @since PECL cairo >= 0.1.0
21608 **/
21609function cairo_get_tolerance($context){}
21610
21611/**
21612 * The glyphPath purpose
21613 *
21614 * Adds closed paths for the glyphs to the current path. The generated
21615 * path if filled, achieves an effect similar to that of
21616 * CairoContext::showGlyphs.
21617 *
21618 * @param CairoContext $context A CairoContext object
21619 * @param array $glyphs Array of glyphs
21620 * @return void
21621 * @since PECL cairo >= 0.1.0
21622 **/
21623function cairo_glyph_path($context, $glyphs){}
21624
21625/**
21626 * The hasCurrentPoint purpose
21627 *
21628 * Returns whether a current point is defined on the current path. See
21629 * CairoContext::getCurrentPoint for details on the current point.
21630 *
21631 * @param CairoContext $context A valid CairoContext object.
21632 * @return bool Whether a current point is defined
21633 * @since PECL cairo >= 0.1.0
21634 **/
21635function cairo_has_current_point($context){}
21636
21637/**
21638 * The identityMatrix purpose
21639 *
21640 * @param CairoContext $context Description...
21641 * @return void Description...
21642 * @since PECL cairo >= 0.1.0
21643 **/
21644function cairo_identity_matrix($context){}
21645
21646/**
21647 * @param int $format Description...
21648 * @param int $width Description...
21649 * @param int $height Description...
21650 * @return CairoImageSurface What is returned on success and failure
21651 * @since PECL cairo >= 0.1.0
21652 **/
21653function cairo_image_surface_create($format, $width, $height){}
21654
21655/**
21656 * @param string $data Description...
21657 * @param int $format Description...
21658 * @param int $width Description...
21659 * @param int $height Description...
21660 * @param int $stride Description...
21661 * @return CairoImageSurface What is returned on success and failure
21662 * @since PECL cairo >= 0.1.0
21663 **/
21664function cairo_image_surface_create_for_data($data, $format, $width, $height, $stride){}
21665
21666/**
21667 * @param mixed $file Description...
21668 * @return CairoImageSurface What is returned on success and failure
21669 * @since PECL cairo >= 0.1.0
21670 **/
21671function cairo_image_surface_create_from_png($file){}
21672
21673/**
21674 * @param CairoImageSurface $surface Description...
21675 * @return string What is returned on success and failure
21676 * @since PECL cairo >= 0.1.0
21677 **/
21678function cairo_image_surface_get_data($surface){}
21679
21680/**
21681 * @param CairoImageSurface $surface Description...
21682 * @return int What is returned on success and failure
21683 * @since PECL cairo >= 0.1.0
21684 **/
21685function cairo_image_surface_get_format($surface){}
21686
21687/**
21688 * @param CairoImageSurface $surface Description...
21689 * @return int What is returned on success and failure
21690 * @since PECL cairo >= 0.1.0
21691 **/
21692function cairo_image_surface_get_height($surface){}
21693
21694/**
21695 * @param CairoImageSurface $surface Description...
21696 * @return int What is returned on success and failure
21697 * @since PECL cairo >= 0.1.0
21698 **/
21699function cairo_image_surface_get_stride($surface){}
21700
21701/**
21702 * @param CairoImageSurface $surface Description...
21703 * @return int What is returned on success and failure
21704 * @since PECL cairo >= 0.1.0
21705 **/
21706function cairo_image_surface_get_width($surface){}
21707
21708/**
21709 * The inFill purpose
21710 *
21711 * @param CairoContext $context Description...
21712 * @param float $x Description...
21713 * @param float $y Description...
21714 * @return bool Description...
21715 * @since PECL cairo >= 0.1.0
21716 **/
21717function cairo_in_fill($context, $x, $y){}
21718
21719/**
21720 * The inStroke purpose
21721 *
21722 * @param CairoContext $context Description...
21723 * @param float $x Description...
21724 * @param float $y Description...
21725 * @return bool Description...
21726 * @since PECL cairo >= 0.1.0
21727 **/
21728function cairo_in_stroke($context, $x, $y){}
21729
21730/**
21731 * The lineTo purpose
21732 *
21733 * @param CairoContext $context Description...
21734 * @param float $x Description...
21735 * @param float $y Description...
21736 * @return void Description...
21737 * @since PECL cairo >= 0.1.0
21738 **/
21739function cairo_line_to($context, $x, $y){}
21740
21741/**
21742 * The mask purpose
21743 *
21744 * @param CairoContext $context Description...
21745 * @param CairoPattern $pattern Description...
21746 * @return void Description...
21747 * @since PECL cairo >= 0.1.0
21748 **/
21749function cairo_mask($context, $pattern){}
21750
21751/**
21752 * The maskSurface purpose
21753 *
21754 * @param CairoContext $context Description...
21755 * @param CairoSurface $surface Description...
21756 * @param float $x Description...
21757 * @param float $y Description...
21758 * @return void Description...
21759 * @since PECL cairo >= 0.1.0
21760 **/
21761function cairo_mask_surface($context, $surface, $x, $y){}
21762
21763/**
21764 * Creates a new scaling matrix
21765 *
21766 * Creates a new matrix to a transformation that scales by sx and sy in
21767 * the X and Y dimensions, respectively.
21768 *
21769 * @param float $sx scale factor in the X direction
21770 * @param float $sy scale factor in the Y direction
21771 * @return void Returns a new CairoMatrix object that can be used with
21772 *   surfaces, contexts, and patterns.
21773 * @since PECL cairo >= 0.1.0
21774 **/
21775function cairo_matrix_create_scale($sx, $sy){}
21776
21777/**
21778 * Creates a new translation matrix
21779 *
21780 * Creates a new matrix to a transformation that translates by tx and ty
21781 * in the X and Y dimensions, respectively.
21782 *
21783 * @param float $tx amount to translate in the X direction
21784 * @param float $ty amount to translate in the Y direction
21785 * @return void Returns a new CairoMatrix object that can be used with
21786 *   surfaces, contexts, and patterns.
21787 * @since PECL cairo >= 0.1.0
21788 **/
21789function cairo_matrix_create_translate($tx, $ty){}
21790
21791/**
21792 * Creates a new CairoMatrix object
21793 *
21794 * Returns new CairoMatrix object. Matrices are used throughout cairo to
21795 * convert between different coordinate spaces. Sets matrix to be the
21796 * affine transformation given by xx, yx, xy, yy, x0, y0. The
21797 * transformation is given by: x_new = xx * x + xy * y + x0; and y_new =
21798 * yx * x + yy * y + y0;
21799 *
21800 * @param float $xx xx component of the affine transformation
21801 * @param float $yx yx component of the affine transformation
21802 * @param float $xy xy component of the affine transformation
21803 * @param float $yy yy component of the affine transformation
21804 * @param float $x0 X translation component of the affine
21805 *   transformation
21806 * @param float $y0 Y translation component of the affine
21807 *   transformation
21808 * @return object Returns a new CairoMatrix object that can be used
21809 *   with surfaces, contexts, and patterns.
21810 **/
21811function cairo_matrix_init($xx, $yx, $xy, $yy, $x0, $y0){}
21812
21813/**
21814 * Creates a new identity matrix
21815 *
21816 * Creates a new matrix that is an identity transformation. An identity
21817 * transformation means the source data is copied into the destination
21818 * data without change
21819 *
21820 * @return object Returns a new CairoMatrix object that can be used
21821 *   with surfaces, contexts, and patterns.
21822 **/
21823function cairo_matrix_init_identity(){}
21824
21825/**
21826 * Creates a new rotated matrix
21827 *
21828 * Creates a new matrix to a transformation that rotates by radians
21829 * provided
21830 *
21831 * @param float $radians angle of rotation, in radians. The direction
21832 *   of rotation is defined such that positive angles rotate in the
21833 *   direction from the positive X axis toward the positive Y axis. With
21834 *   the default axis orientation of cairo, positive angles rotate in a
21835 *   clockwise direction.
21836 * @return object Returns a new CairoMatrix object that can be used
21837 *   with surfaces, contexts, and patterns.
21838 **/
21839function cairo_matrix_init_rotate($radians){}
21840
21841/**
21842 * Creates a new scaling matrix
21843 *
21844 * Creates a new matrix to a transformation that scales by sx and sy in
21845 * the X and Y dimensions, respectively.
21846 *
21847 * @param float $sx scale factor in the X direction
21848 * @param float $sy scale factor in the Y direction
21849 * @return object Returns a new CairoMatrix object that can be used
21850 *   with surfaces, contexts, and patterns.
21851 **/
21852function cairo_matrix_init_scale($sx, $sy){}
21853
21854/**
21855 * Creates a new translation matrix
21856 *
21857 * Creates a new matrix to a transformation that translates by tx and ty
21858 * in the X and Y dimensions, respectively.
21859 *
21860 * @param float $tx amount to translate in the X direction
21861 * @param float $ty amount to translate in the Y direction
21862 * @return object Returns a new CairoMatrix object that can be used
21863 *   with surfaces, contexts, and patterns.
21864 **/
21865function cairo_matrix_init_translate($tx, $ty){}
21866
21867/**
21868 * @param CairoMatrix $matrix Description...
21869 * @return void What is returned on success and failure
21870 * @since PECL cairo >= 0.1.0
21871 **/
21872function cairo_matrix_invert($matrix){}
21873
21874/**
21875 * @param CairoMatrix $matrix1 Description...
21876 * @param CairoMatrix $matrix2 Description...
21877 * @return CairoMatrix What is returned on success and failure
21878 * @since PECL cairo >= 0.1.0
21879 **/
21880function cairo_matrix_multiply($matrix1, $matrix2){}
21881
21882/**
21883 * The rotate purpose
21884 *
21885 * @param CairoContext $context Description...
21886 * @param string $radians Description...
21887 * @return void Description...
21888 * @since PECL cairo >= 0.1.0
21889 **/
21890function cairo_matrix_rotate($context, $radians){}
21891
21892/**
21893 * Applies scaling to a matrix
21894 *
21895 * Applies scaling by sx, sy to the transformation in the matrix. The
21896 * effect of the new transformation is to first scale the coordinates by
21897 * sx and sy, then apply the original transformation to the coordinates.
21898 *
21899 * @param CairoContext $context Procedural only - CairoMatrix instance
21900 * @param float $sx scale factor in the X direction
21901 * @param float $sy scale factor in the Y direction
21902 * @return void
21903 * @since PECL cairo >= 0.1.0
21904 **/
21905function cairo_matrix_scale($context, $sx, $sy){}
21906
21907/**
21908 * @param CairoMatrix $matrix Description...
21909 * @param float $dx Description...
21910 * @param float $dy Description...
21911 * @return array What is returned on success and failure
21912 * @since PECL cairo >= 0.1.0
21913 **/
21914function cairo_matrix_transform_distance($matrix, $dx, $dy){}
21915
21916/**
21917 * @param CairoMatrix $matrix Description...
21918 * @param float $dx Description...
21919 * @param float $dy Description...
21920 * @return array What is returned on success and failure
21921 * @since PECL cairo >= 0.1.0
21922 **/
21923function cairo_matrix_transform_point($matrix, $dx, $dy){}
21924
21925/**
21926 * @param CairoMatrix $matrix Description...
21927 * @param float $tx Description...
21928 * @param float $ty Description...
21929 * @return void What is returned on success and failure
21930 * @since PECL cairo >= 0.1.0
21931 **/
21932function cairo_matrix_translate($matrix, $tx, $ty){}
21933
21934/**
21935 * The moveTo purpose
21936 *
21937 * Begin a new sub-path. After this call the current point will be (x,
21938 * y).
21939 *
21940 * @param CairoContext $context A valid CairoContext object.
21941 * @param float $x The x coordinate of the new position.
21942 * @param float $y The y coordinate of the new position
21943 * @return void
21944 * @since PECL cairo >= 0.1.0
21945 **/
21946function cairo_move_to($context, $x, $y){}
21947
21948/**
21949 * The newPath purpose
21950 *
21951 * Clears the current path. After this call there will be no path and no
21952 * current point.
21953 *
21954 * @param CairoContext $context A valid CairoContext object.
21955 * @return void
21956 * @since PECL cairo >= 0.1.0
21957 **/
21958function cairo_new_path($context){}
21959
21960/**
21961 * The newSubPath purpose
21962 *
21963 * @param CairoContext $context Description...
21964 * @return void Description...
21965 * @since PECL cairo >= 0.1.0
21966 **/
21967function cairo_new_sub_path($context){}
21968
21969/**
21970 * The paint purpose
21971 *
21972 * @param CairoContext $context Description...
21973 * @return void Description...
21974 * @since PECL cairo >= 0.1.0
21975 **/
21976function cairo_paint($context){}
21977
21978/**
21979 * The paintWithAlpha purpose
21980 *
21981 * @param CairoContext $context Description...
21982 * @param float $alpha Description...
21983 * @return void Description...
21984 * @since PECL cairo >= 0.1.0
21985 **/
21986function cairo_paint_with_alpha($context, $alpha){}
21987
21988/**
21989 * The pathExtents purpose
21990 *
21991 * @param CairoContext $context Description...
21992 * @return array Description...
21993 * @since PECL cairo >= 0.1.0
21994 **/
21995function cairo_path_extents($context){}
21996
21997/**
21998 * @param CairoGradientPattern $pattern Description...
21999 * @param float $offset Description...
22000 * @param float $red Description...
22001 * @param float $green Description...
22002 * @param float $blue Description...
22003 * @return void What is returned on success and failure
22004 * @since PECL cairo >= 0.1.0
22005 **/
22006function cairo_pattern_add_color_stop_rgb($pattern, $offset, $red, $green, $blue){}
22007
22008/**
22009 * @param CairoGradientPattern $pattern Description...
22010 * @param float $offset Description...
22011 * @param float $red Description...
22012 * @param float $green Description...
22013 * @param float $blue Description...
22014 * @param float $alpha Description...
22015 * @return void What is returned on success and failure
22016 * @since PECL cairo >= 0.1.0
22017 **/
22018function cairo_pattern_add_color_stop_rgba($pattern, $offset, $red, $green, $blue, $alpha){}
22019
22020/**
22021 * @param CairoSurface $surface Description...
22022 * @return CairoPattern What is returned on success and failure
22023 * @since PECL cairo >= 0.1.0
22024 **/
22025function cairo_pattern_create_for_surface($surface){}
22026
22027/**
22028 * @param float $x0 Description...
22029 * @param float $y0 Description...
22030 * @param float $x1 Description...
22031 * @param float $y1 Description...
22032 * @return CairoPattern What is returned on success and failure
22033 * @since PECL cairo >= 0.1.0
22034 **/
22035function cairo_pattern_create_linear($x0, $y0, $x1, $y1){}
22036
22037/**
22038 * @param float $x0 Description...
22039 * @param float $y0 Description...
22040 * @param float $r0 Description...
22041 * @param float $x1 Description...
22042 * @param float $y1 Description...
22043 * @param float $r1 Description...
22044 * @return CairoPattern What is returned on success and failure
22045 * @since PECL cairo >= 0.1.0
22046 **/
22047function cairo_pattern_create_radial($x0, $y0, $r0, $x1, $y1, $r1){}
22048
22049/**
22050 * @param float $red Description...
22051 * @param float $green Description...
22052 * @param float $blue Description...
22053 * @return CairoPattern What is returned on success and failure
22054 * @since PECL cairo >= 0.1.0
22055 **/
22056function cairo_pattern_create_rgb($red, $green, $blue){}
22057
22058/**
22059 * @param float $red Description...
22060 * @param float $green Description...
22061 * @param float $blue Description...
22062 * @param float $alpha Description...
22063 * @return CairoPattern What is returned on success and failure
22064 * @since PECL cairo >= 0.1.0
22065 **/
22066function cairo_pattern_create_rgba($red, $green, $blue, $alpha){}
22067
22068/**
22069 * @param CairoGradientPattern $pattern Description...
22070 * @return int What is returned on success and failure
22071 * @since PECL cairo >= 0.1.0
22072 **/
22073function cairo_pattern_get_color_stop_count($pattern){}
22074
22075/**
22076 * @param CairoGradientPattern $pattern Description...
22077 * @param int $index Description...
22078 * @return array What is returned on success and failure
22079 * @since PECL cairo >= 0.1.0
22080 **/
22081function cairo_pattern_get_color_stop_rgba($pattern, $index){}
22082
22083/**
22084 * @param string $pattern Description...
22085 * @return int What is returned on success and failure
22086 * @since PECL cairo >= 0.1.0
22087 **/
22088function cairo_pattern_get_extend($pattern){}
22089
22090/**
22091 * @param CairoSurfacePattern $pattern Description...
22092 * @return int What is returned on success and failure
22093 * @since PECL cairo >= 0.1.0
22094 **/
22095function cairo_pattern_get_filter($pattern){}
22096
22097/**
22098 * @param CairoLinearGradient $pattern Description...
22099 * @return array What is returned on success and failure
22100 * @since PECL cairo >= 0.1.0
22101 **/
22102function cairo_pattern_get_linear_points($pattern){}
22103
22104/**
22105 * @param CairoPattern $pattern Description...
22106 * @return CairoMatrix What is returned on success and failure
22107 * @since PECL cairo >= 0.1.0
22108 **/
22109function cairo_pattern_get_matrix($pattern){}
22110
22111/**
22112 * @param CairoRadialGradient $pattern Description...
22113 * @return array What is returned on success and failure
22114 * @since PECL cairo >= 0.1.0
22115 **/
22116function cairo_pattern_get_radial_circles($pattern){}
22117
22118/**
22119 * @param CairoSolidPattern $pattern Description...
22120 * @return array What is returned on success and failure
22121 * @since PECL cairo >= 0.1.0
22122 **/
22123function cairo_pattern_get_rgba($pattern){}
22124
22125/**
22126 * @param CairoSurfacePattern $pattern Description...
22127 * @return CairoSurface What is returned on success and failure
22128 * @since PECL cairo >= 0.1.0
22129 **/
22130function cairo_pattern_get_surface($pattern){}
22131
22132/**
22133 * @param CairoPattern $pattern Description...
22134 * @return int What is returned on success and failure
22135 * @since PECL cairo >= 0.1.0
22136 **/
22137function cairo_pattern_get_type($pattern){}
22138
22139/**
22140 * @param string $pattern Description...
22141 * @param string $extend Description...
22142 * @return void What is returned on success and failure
22143 * @since PECL cairo >= 0.1.0
22144 **/
22145function cairo_pattern_set_extend($pattern, $extend){}
22146
22147/**
22148 * @param CairoSurfacePattern $pattern Description...
22149 * @param int $filter Description...
22150 * @return void What is returned on success and failure
22151 * @since PECL cairo >= 0.1.0
22152 **/
22153function cairo_pattern_set_filter($pattern, $filter){}
22154
22155/**
22156 * @param CairoPattern $pattern Description...
22157 * @param CairoMatrix $matrix Description...
22158 * @return void What is returned on success and failure
22159 * @since PECL cairo >= 0.1.0
22160 **/
22161function cairo_pattern_set_matrix($pattern, $matrix){}
22162
22163/**
22164 * @param CairoPattern $pattern Description...
22165 * @return int What is returned on success and failure
22166 * @since PECL cairo >= 0.1.0
22167 **/
22168function cairo_pattern_status($pattern){}
22169
22170/**
22171 * @param string $file Description...
22172 * @param float $width Description...
22173 * @param float $height Description...
22174 * @return CairoPdfSurface What is returned on success and failure
22175 * @since PECL cairo >= 0.1.0
22176 **/
22177function cairo_pdf_surface_create($file, $width, $height){}
22178
22179/**
22180 * @param CairoPdfSurface $surface Description...
22181 * @param float $width Description...
22182 * @param float $height Description...
22183 * @return void What is returned on success and failure
22184 * @since PECL cairo >= 0.1.0
22185 **/
22186function cairo_pdf_surface_set_size($surface, $width, $height){}
22187
22188/**
22189 * The popGroup purpose
22190 *
22191 * @param CairoContext $context Description...
22192 * @return void Description...
22193 * @since PECL cairo >= 0.1.0
22194 **/
22195function cairo_pop_group($context){}
22196
22197/**
22198 * The popGroupToSource purpose
22199 *
22200 * @param CairoContext $context Description...
22201 * @return void Description...
22202 * @since PECL cairo >= 0.1.0
22203 **/
22204function cairo_pop_group_to_source($context){}
22205
22206/**
22207 * @return array What is returned on success and failure
22208 * @since PECL cairo >= 0.1.0
22209 **/
22210function cairo_ps_get_levels(){}
22211
22212/**
22213 * @param int $level Description...
22214 * @return string What is returned on success and failure
22215 * @since PECL cairo >= 0.1.0
22216 **/
22217function cairo_ps_level_to_string($level){}
22218
22219/**
22220 * @param string $file Description...
22221 * @param float $width Description...
22222 * @param float $height Description...
22223 * @return CairoPsSurface What is returned on success and failure
22224 * @since PECL cairo >= 0.1.0
22225 **/
22226function cairo_ps_surface_create($file, $width, $height){}
22227
22228/**
22229 * @param CairoPsSurface $surface Description...
22230 * @return void What is returned on success and failure
22231 * @since PECL cairo >= 0.1.0
22232 **/
22233function cairo_ps_surface_dsc_begin_page_setup($surface){}
22234
22235/**
22236 * @param CairoPsSurface $surface Description...
22237 * @return void What is returned on success and failure
22238 * @since PECL cairo >= 0.1.0
22239 **/
22240function cairo_ps_surface_dsc_begin_setup($surface){}
22241
22242/**
22243 * @param CairoPsSurface $surface Description...
22244 * @param string $comment Description...
22245 * @return void What is returned on success and failure
22246 * @since PECL cairo >= 0.1.0
22247 **/
22248function cairo_ps_surface_dsc_comment($surface, $comment){}
22249
22250/**
22251 * @param CairoPsSurface $surface Description...
22252 * @return bool What is returned on success and failure
22253 * @since PECL cairo >= 0.1.0
22254 **/
22255function cairo_ps_surface_get_eps($surface){}
22256
22257/**
22258 * @param CairoPsSurface $surface Description...
22259 * @param int $level Description...
22260 * @return void What is returned on success and failure
22261 * @since PECL cairo >= 0.1.0
22262 **/
22263function cairo_ps_surface_restrict_to_level($surface, $level){}
22264
22265/**
22266 * @param CairoPsSurface $surface Description...
22267 * @param bool $level Description...
22268 * @return void What is returned on success and failure
22269 * @since PECL cairo >= 0.1.0
22270 **/
22271function cairo_ps_surface_set_eps($surface, $level){}
22272
22273/**
22274 * @param CairoPsSurface $surface Description...
22275 * @param float $width Description...
22276 * @param float $height Description...
22277 * @return void What is returned on success and failure
22278 * @since PECL cairo >= 0.1.0
22279 **/
22280function cairo_ps_surface_set_size($surface, $width, $height){}
22281
22282/**
22283 * The pushGroup purpose
22284 *
22285 * @param CairoContext $context Description...
22286 * @return void Description...
22287 * @since PECL cairo >= 0.1.0
22288 **/
22289function cairo_push_group($context){}
22290
22291/**
22292 * The pushGroupWithContent purpose
22293 *
22294 * @param CairoContext $context Description...
22295 * @param int $content Description...
22296 * @return void Description...
22297 * @since PECL cairo >= 0.1.0
22298 **/
22299function cairo_push_group_with_content($context, $content){}
22300
22301/**
22302 * The rectangle purpose
22303 *
22304 * @param CairoContext $context Description...
22305 * @param float $x Description...
22306 * @param float $y Description...
22307 * @param float $width Description...
22308 * @param float $height Description...
22309 * @return void Description...
22310 * @since PECL cairo >= 0.1.0
22311 **/
22312function cairo_rectangle($context, $x, $y, $width, $height){}
22313
22314/**
22315 * The relCurveTo purpose
22316 *
22317 * @param CairoContext $context Description...
22318 * @param float $x1 Description...
22319 * @param float $y1 Description...
22320 * @param float $x2 Description...
22321 * @param float $y2 Description...
22322 * @param float $x3 Description...
22323 * @param float $y3 Description...
22324 * @return void Description...
22325 * @since PECL cairo >= 0.1.0
22326 **/
22327function cairo_rel_curve_to($context, $x1, $y1, $x2, $y2, $x3, $y3){}
22328
22329/**
22330 * The relLineTo purpose
22331 *
22332 * @param CairoContext $context Description...
22333 * @param float $x Description...
22334 * @param float $y Description...
22335 * @return void Description...
22336 * @since PECL cairo >= 0.1.0
22337 **/
22338function cairo_rel_line_to($context, $x, $y){}
22339
22340/**
22341 * The relMoveTo purpose
22342 *
22343 * @param CairoContext $context Description...
22344 * @param float $x Description...
22345 * @param float $y Description...
22346 * @return void Description...
22347 * @since PECL cairo >= 0.1.0
22348 **/
22349function cairo_rel_move_to($context, $x, $y){}
22350
22351/**
22352 * The resetClip purpose
22353 *
22354 * @param CairoContext $context Description...
22355 * @return void Description...
22356 * @since PECL cairo >= 0.1.0
22357 **/
22358function cairo_reset_clip($context){}
22359
22360/**
22361 * The restore purpose
22362 *
22363 * @param CairoContext $context Description...
22364 * @return void Description...
22365 * @since PECL cairo >= 0.1.0
22366 **/
22367function cairo_restore($context){}
22368
22369/**
22370 * The rotate purpose
22371 *
22372 * @param CairoContext $context Description...
22373 * @param float $angle Description...
22374 * @return void Description...
22375 * @since PECL cairo >= 0.1.0
22376 **/
22377function cairo_rotate($context, $angle){}
22378
22379/**
22380 * The save purpose
22381 *
22382 * @param CairoContext $context Description...
22383 * @return void Description...
22384 * @since PECL cairo >= 0.1.0
22385 **/
22386function cairo_save($context){}
22387
22388/**
22389 * The scale purpose
22390 *
22391 * @param CairoContext $context Description...
22392 * @param float $x Description...
22393 * @param float $y Description...
22394 * @return void Description...
22395 * @since PECL cairo >= 0.1.0
22396 **/
22397function cairo_scale($context, $x, $y){}
22398
22399/**
22400 * @param CairoFontFace $fontface Description...
22401 * @param CairoMatrix $matrix Description...
22402 * @param CairoMatrix $ctm Description...
22403 * @param CairoFontOptions $fontoptions Description...
22404 * @return CairoScaledFont What is returned on success and failure
22405 * @since PECL cairo >= 0.1.0
22406 **/
22407function cairo_scaled_font_create($fontface, $matrix, $ctm, $fontoptions){}
22408
22409/**
22410 * @param CairoScaledFont $scaledfont Description...
22411 * @return array What is returned on success and failure
22412 * @since PECL cairo >= 0.1.0
22413 **/
22414function cairo_scaled_font_extents($scaledfont){}
22415
22416/**
22417 * @param CairoScaledFont $scaledfont Description...
22418 * @return CairoMatrix What is returned on success and failure
22419 * @since PECL cairo >= 0.1.0
22420 **/
22421function cairo_scaled_font_get_ctm($scaledfont){}
22422
22423/**
22424 * @param CairoScaledFont $scaledfont Description...
22425 * @return CairoFontFace What is returned on success and failure
22426 * @since PECL cairo >= 0.1.0
22427 **/
22428function cairo_scaled_font_get_font_face($scaledfont){}
22429
22430/**
22431 * @param CairoScaledFont $scaledfont Description...
22432 * @return CairoFontOptions What is returned on success and failure
22433 * @since PECL cairo >= 0.1.0
22434 **/
22435function cairo_scaled_font_get_font_matrix($scaledfont){}
22436
22437/**
22438 * @param CairoScaledFont $scaledfont Description...
22439 * @return CairoFontOptions What is returned on success and failure
22440 * @since PECL cairo >= 0.1.0
22441 **/
22442function cairo_scaled_font_get_font_options($scaledfont){}
22443
22444/**
22445 * @param CairoScaledFont $scaledfont Description...
22446 * @return CairoMatrix What is returned on success and failure
22447 * @since PECL cairo >= 0.1.0
22448 **/
22449function cairo_scaled_font_get_scale_matrix($scaledfont){}
22450
22451/**
22452 * @param CairoScaledFont $scaledfont Description...
22453 * @return int What is returned on success and failure
22454 * @since PECL cairo >= 0.1.0
22455 **/
22456function cairo_scaled_font_get_type($scaledfont){}
22457
22458/**
22459 * @param CairoScaledFont $scaledfont Description...
22460 * @param array $glyphs Description...
22461 * @return array What is returned on success and failure
22462 * @since PECL cairo >= 0.1.0
22463 **/
22464function cairo_scaled_font_glyph_extents($scaledfont, $glyphs){}
22465
22466/**
22467 * @param CairoScaledFont $scaledfont Description...
22468 * @return int What is returned on success and failure
22469 * @since PECL cairo >= 0.1.0
22470 **/
22471function cairo_scaled_font_status($scaledfont){}
22472
22473/**
22474 * @param CairoScaledFont $scaledfont Description...
22475 * @param string $text Description...
22476 * @return array What is returned on success and failure
22477 * @since PECL cairo >= 0.1.0
22478 **/
22479function cairo_scaled_font_text_extents($scaledfont, $text){}
22480
22481/**
22482 * The selectFontFace purpose
22483 *
22484 * @param CairoContext $context Description...
22485 * @param string $family Description...
22486 * @param int $slant Description...
22487 * @param int $weight Description...
22488 * @return void Description...
22489 * @since PECL cairo >= 0.1.0
22490 **/
22491function cairo_select_font_face($context, $family, $slant, $weight){}
22492
22493/**
22494 * The setAntialias purpose
22495 *
22496 * @param CairoContext $context Description...
22497 * @param int $antialias Description...
22498 * @return void Description...
22499 * @since PECL cairo >= 0.1.0
22500 **/
22501function cairo_set_antialias($context, $antialias){}
22502
22503/**
22504 * The setDash purpose
22505 *
22506 * @param CairoContext $context Description...
22507 * @param array $dashes Description...
22508 * @param float $offset Description...
22509 * @return void Description...
22510 * @since PECL cairo >= 0.1.0
22511 **/
22512function cairo_set_dash($context, $dashes, $offset){}
22513
22514/**
22515 * The setFillRule purpose
22516 *
22517 * @param CairoContext $context Description...
22518 * @param int $setting Description...
22519 * @return void Description...
22520 * @since PECL cairo >= 0.1.0
22521 **/
22522function cairo_set_fill_rule($context, $setting){}
22523
22524/**
22525 * The setFontFace purpose
22526 *
22527 * Sets the font-face for a given context.
22528 *
22529 * @param CairoContext $context A CairoContext object to change the
22530 *   font-face for.
22531 * @param CairoFontFace $fontface A CairoFontFace object
22532 * @return void No value is returned
22533 * @since PECL cairo >= 0.1.0
22534 **/
22535function cairo_set_font_face($context, $fontface){}
22536
22537/**
22538 * The setFontMatrix purpose
22539 *
22540 * @param CairoContext $context Description...
22541 * @param CairoMatrix $matrix Description...
22542 * @return void Description...
22543 * @since PECL cairo >= 0.1.0
22544 **/
22545function cairo_set_font_matrix($context, $matrix){}
22546
22547/**
22548 * The setFontOptions purpose
22549 *
22550 * @param CairoContext $context Description...
22551 * @param CairoFontOptions $fontoptions Description...
22552 * @return void Description...
22553 * @since PECL cairo >= 0.1.0
22554 **/
22555function cairo_set_font_options($context, $fontoptions){}
22556
22557/**
22558 * The setFontSize purpose
22559 *
22560 * @param CairoContext $context Description...
22561 * @param float $size Description...
22562 * @return void Description...
22563 * @since PECL cairo >= 0.1.0
22564 **/
22565function cairo_set_font_size($context, $size){}
22566
22567/**
22568 * The setLineCap purpose
22569 *
22570 * @param CairoContext $context Description...
22571 * @param int $setting Description...
22572 * @return void Description...
22573 * @since PECL cairo >= 0.1.0
22574 **/
22575function cairo_set_line_cap($context, $setting){}
22576
22577/**
22578 * The setLineJoin purpose
22579 *
22580 * @param CairoContext $context Description...
22581 * @param int $setting Description...
22582 * @return void Description...
22583 * @since PECL cairo >= 0.1.0
22584 **/
22585function cairo_set_line_join($context, $setting){}
22586
22587/**
22588 * The setLineWidth purpose
22589 *
22590 * @param CairoContext $context Description...
22591 * @param float $width Description...
22592 * @return void Description...
22593 * @since PECL cairo >= 0.1.0
22594 **/
22595function cairo_set_line_width($context, $width){}
22596
22597/**
22598 * The setMatrix purpose
22599 *
22600 * @param CairoContext $context Description...
22601 * @param CairoMatrix $matrix Description...
22602 * @return void Description...
22603 * @since PECL cairo >= 0.1.0
22604 **/
22605function cairo_set_matrix($context, $matrix){}
22606
22607/**
22608 * The setMiterLimit purpose
22609 *
22610 * @param CairoContext $context Description...
22611 * @param float $limit Description...
22612 * @return void Description...
22613 * @since PECL cairo >= 0.1.0
22614 **/
22615function cairo_set_miter_limit($context, $limit){}
22616
22617/**
22618 * The setOperator purpose
22619 *
22620 * @param CairoContext $context Description...
22621 * @param int $setting Description...
22622 * @return void Description...
22623 * @since PECL cairo >= 0.1.0
22624 **/
22625function cairo_set_operator($context, $setting){}
22626
22627/**
22628 * The setScaledFont purpose
22629 *
22630 * @param CairoContext $context Description...
22631 * @param CairoScaledFont $scaledfont Description...
22632 * @return void Description...
22633 * @since PECL cairo >= 0.1.0
22634 **/
22635function cairo_set_scaled_font($context, $scaledfont){}
22636
22637/**
22638 * The setSourceRGB purpose
22639 *
22640 * @param CairoContext $context Description...
22641 * @param float $red Description...
22642 * @param float $green Description...
22643 * @param float $blue Description...
22644 * @return void Description...
22645 * @since PECL cairo >= 0.1.0
22646 **/
22647function cairo_set_source($context, $red, $green, $blue){}
22648
22649/**
22650 * The setSourceSurface purpose
22651 *
22652 * @param CairoContext $context Description...
22653 * @param CairoSurface $surface Description...
22654 * @param float $x Description...
22655 * @param float $y Description...
22656 * @return void Description...
22657 * @since PECL cairo >= 0.1.0
22658 **/
22659function cairo_set_source_surface($context, $surface, $x, $y){}
22660
22661/**
22662 * The setTolerance purpose
22663 *
22664 * @param CairoContext $context Description...
22665 * @param float $tolerance Description...
22666 * @return void Description...
22667 * @since PECL cairo >= 0.1.0
22668 **/
22669function cairo_set_tolerance($context, $tolerance){}
22670
22671/**
22672 * The showPage purpose
22673 *
22674 * @param CairoContext $context Description...
22675 * @return void Description...
22676 * @since PECL cairo >= 0.1.0
22677 **/
22678function cairo_show_page($context){}
22679
22680/**
22681 * The showText purpose
22682 *
22683 * @param CairoContext $context Description...
22684 * @param string $text Description...
22685 * @return void Description...
22686 * @since PECL cairo >= 0.1.0
22687 **/
22688function cairo_show_text($context, $text){}
22689
22690/**
22691 * The status purpose
22692 *
22693 * @param CairoContext $context Description...
22694 * @return int Description...
22695 * @since PECL cairo >= 0.1.0
22696 **/
22697function cairo_status($context){}
22698
22699/**
22700 * Retrieves the current status as string
22701 *
22702 * Retrieves the current status as a readable string
22703 *
22704 * @param int $status A valid status code given by {@link cairo_status}
22705 *   or CairoContext::status
22706 * @return string A string containing the current status of a
22707 *   CairoContext object
22708 **/
22709function cairo_status_to_string($status){}
22710
22711/**
22712 * The stroke purpose
22713 *
22714 * @param CairoContext $context Description...
22715 * @return void Description...
22716 * @since PECL cairo >= 0.1.0
22717 **/
22718function cairo_stroke($context){}
22719
22720/**
22721 * The strokeExtents purpose
22722 *
22723 * @param CairoContext $context Description...
22724 * @return array Description...
22725 * @since PECL cairo >= 0.1.0
22726 **/
22727function cairo_stroke_extents($context){}
22728
22729/**
22730 * The strokePreserve purpose
22731 *
22732 * @param CairoContext $context Description...
22733 * @return void Description...
22734 * @since PECL cairo >= 0.1.0
22735 **/
22736function cairo_stroke_preserve($context){}
22737
22738/**
22739 * @param CairoSurface $surface Description...
22740 * @return void What is returned on success and failure
22741 * @since PECL cairo >= 0.1.0
22742 **/
22743function cairo_surface_copy_page($surface){}
22744
22745/**
22746 * @param CairoSurface $surface Description...
22747 * @param int $content Description...
22748 * @param float $width Description...
22749 * @param float $height Description...
22750 * @return CairoSurface What is returned on success and failure
22751 * @since PECL cairo >= 0.1.0
22752 **/
22753function cairo_surface_create_similar($surface, $content, $width, $height){}
22754
22755/**
22756 * @param CairoSurface $surface Description...
22757 * @return void What is returned on success and failure
22758 * @since PECL cairo >= 0.1.0
22759 **/
22760function cairo_surface_finish($surface){}
22761
22762/**
22763 * @param CairoSurface $surface Description...
22764 * @return void What is returned on success and failure
22765 * @since PECL cairo >= 0.1.0
22766 **/
22767function cairo_surface_flush($surface){}
22768
22769/**
22770 * @param CairoSurface $surface Description...
22771 * @return int What is returned on success and failure
22772 * @since PECL cairo >= 0.1.0
22773 **/
22774function cairo_surface_get_content($surface){}
22775
22776/**
22777 * @param CairoSurface $surface Description...
22778 * @return array What is returned on success and failure
22779 * @since PECL cairo >= 0.1.0
22780 **/
22781function cairo_surface_get_device_offset($surface){}
22782
22783/**
22784 * @param CairoSurface $surface Description...
22785 * @return CairoFontOptions What is returned on success and failure
22786 * @since PECL cairo >= 0.1.0
22787 **/
22788function cairo_surface_get_font_options($surface){}
22789
22790/**
22791 * @param CairoSurface $surface Description...
22792 * @return int What is returned on success and failure
22793 * @since PECL cairo >= 0.1.0
22794 **/
22795function cairo_surface_get_type($surface){}
22796
22797/**
22798 * @param CairoSurface $surface Description...
22799 * @return void What is returned on success and failure
22800 * @since PECL cairo >= 0.1.0
22801 **/
22802function cairo_surface_mark_dirty($surface){}
22803
22804/**
22805 * @param CairoSurface $surface Description...
22806 * @param float $x Description...
22807 * @param float $y Description...
22808 * @param float $width Description...
22809 * @param float $height Description...
22810 * @return void What is returned on success and failure
22811 * @since PECL cairo >= 0.1.0
22812 **/
22813function cairo_surface_mark_dirty_rectangle($surface, $x, $y, $width, $height){}
22814
22815/**
22816 * @param CairoSurface $surface Description...
22817 * @param float $x Description...
22818 * @param float $y Description...
22819 * @return void What is returned on success and failure
22820 * @since PECL cairo >= 0.1.0
22821 **/
22822function cairo_surface_set_device_offset($surface, $x, $y){}
22823
22824/**
22825 * @param CairoSurface $surface Description...
22826 * @param float $x Description...
22827 * @param float $y Description...
22828 * @return void What is returned on success and failure
22829 * @since PECL cairo >= 0.1.0
22830 **/
22831function cairo_surface_set_fallback_resolution($surface, $x, $y){}
22832
22833/**
22834 * @param CairoSurface $surface Description...
22835 * @return void What is returned on success and failure
22836 * @since PECL cairo >= 0.1.0
22837 **/
22838function cairo_surface_show_page($surface){}
22839
22840/**
22841 * @param CairoSurface $surface Description...
22842 * @return int What is returned on success and failure
22843 * @since PECL cairo >= 0.1.0
22844 **/
22845function cairo_surface_status($surface){}
22846
22847/**
22848 * @param CairoSurface $surface Description...
22849 * @param resource $stream Description...
22850 * @return void What is returned on success and failure
22851 * @since PECL cairo >= 0.1.0
22852 **/
22853function cairo_surface_write_to_png($surface, $stream){}
22854
22855/**
22856 * Used to retrieve a list of supported SVG versions
22857 *
22858 * Returns a numerically indexed array of currently available
22859 * CairoSvgVersion constants. In order to retrieve the string values for
22860 * each item, use CairoSvgSurface::versionToString.
22861 *
22862 * @return array Returns a numerically indexed array of integer values.
22863 * @since PECL cairo >= 0.1.0
22864 **/
22865function cairo_svg_get_versions(){}
22866
22867/**
22868 * @param string $file Description...
22869 * @param float $width Description...
22870 * @param float $height Description...
22871 * @return CairoSvgSurface What is returned on success and failure
22872 * @since PECL cairo >= 0.1.0
22873 **/
22874function cairo_svg_surface_create($file, $width, $height){}
22875
22876/**
22877 * @param CairoSvgSurface $surface Description...
22878 * @param int $version Description...
22879 * @return void What is returned on success and failure
22880 * @since PECL cairo >= 0.1.0
22881 **/
22882function cairo_svg_surface_restrict_to_version($surface, $version){}
22883
22884/**
22885 * @param int $version Description...
22886 * @return string What is returned on success and failure
22887 * @since PECL cairo >= 0.1.0
22888 **/
22889function cairo_svg_version_to_string($version){}
22890
22891/**
22892 * The textExtents purpose
22893 *
22894 * @param CairoContext $context Description...
22895 * @return array Description...
22896 * @since PECL cairo >= 0.1.0
22897 **/
22898function cairo_text_extents($context){}
22899
22900/**
22901 * The textPath purpose
22902 *
22903 * Adds closed paths for text to the current path. The generated path, if
22904 * filled, achieves an effect similar to that of CairoContext::showText.
22905 *
22906 * Text conversion and positioning is done similar to
22907 * CairoContext::showText.
22908 *
22909 * Like CairoContext::showText, after this call the current point is
22910 * moved to the origin of where the next glyph would be placed in this
22911 * same progression. That is, the current point will be at the origin of
22912 * the final glyph offset by its advance values. This allows for chaining
22913 * multiple calls to CairoContext::showText without having to set current
22914 * point in between.
22915 *
22916 * Note: The CairoContext::textPath function call is part of what the
22917 * cairo designers call the "toy" text API. It is convenient for short
22918 * demos and simple programs, but it is not expected to be adequate for
22919 * serious text-using applications. See CairoContext::glyphPath for the
22920 * "real" text path API in cairo.
22921 *
22922 * @param CairoContext $context A CairoContext object
22923 * @param string $text Description...
22924 * @return void Description...
22925 * @since PECL cairo >= 0.1.0
22926 **/
22927function cairo_text_path($context, $text){}
22928
22929/**
22930 * The transform purpose
22931 *
22932 * @param CairoContext $context Description...
22933 * @param CairoMatrix $matrix Description...
22934 * @return void Description...
22935 * @since PECL cairo >= 0.1.0
22936 **/
22937function cairo_transform($context, $matrix){}
22938
22939/**
22940 * The translate purpose
22941 *
22942 * @param CairoContext $context Description...
22943 * @param float $x Description...
22944 * @param float $y Description...
22945 * @return void Description...
22946 * @since PECL cairo >= 0.1.0
22947 **/
22948function cairo_translate($context, $x, $y){}
22949
22950/**
22951 * The userToDevice purpose
22952 *
22953 * @param CairoContext $context Description...
22954 * @param float $x Description...
22955 * @param float $y Description...
22956 * @return array Description...
22957 * @since PECL cairo >= 0.1.0
22958 **/
22959function cairo_user_to_device($context, $x, $y){}
22960
22961/**
22962 * The userToDeviceDistance purpose
22963 *
22964 * @param CairoContext $context Description...
22965 * @param float $x Description...
22966 * @param float $y Description...
22967 * @return array Description...
22968 * @since PECL cairo >= 0.1.0
22969 **/
22970function cairo_user_to_device_distance($context, $x, $y){}
22971
22972/**
22973 * Retrieves cairo's library version
22974 *
22975 * Retrieves the current version of the cairo library as an integer value
22976 *
22977 * @return int Current Cairo library version integer
22978 **/
22979function cairo_version(){}
22980
22981/**
22982 * Retrieves cairo version as string
22983 *
22984 * Retrieves the current cairo library version as a string.
22985 *
22986 * @return string Current Cairo library version string
22987 **/
22988function cairo_version_string(){}
22989
22990/**
22991 * Call the callback given by the first parameter
22992 *
22993 * Calls the {@link callback} given by the first parameter and passes the
22994 * remaining parameters as arguments.
22995 *
22996 * @param callable $callback The callable to be called.
22997 * @param mixed ...$vararg Zero or more parameters to be passed to the
22998 *   callback.
22999 * @return mixed Returns the return value of the callback.
23000 * @since PHP 4, PHP 5, PHP 7
23001 **/
23002function call_user_func($callback, ...$vararg){}
23003
23004/**
23005 * Call a callback with an array of parameters
23006 *
23007 * Calls the {@link callback} given by the first parameter with the
23008 * parameters in {@link param_arr}.
23009 *
23010 * @param callable $callback The callable to be called.
23011 * @param array $param_arr The parameters to be passed to the callback,
23012 *   as an indexed array.
23013 * @return mixed Returns the return value of the callback, or FALSE on
23014 *   error.
23015 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
23016 **/
23017function call_user_func_array($callback, $param_arr){}
23018
23019/**
23020 * Call a user method on an specific object
23021 *
23022 * @param string $method_name The method name being called.
23023 * @param object $obj The object that {@link method_name} is being
23024 *   called on.
23025 * @param mixed ...$vararg The optional parameters.
23026 * @return mixed
23027 * @since PHP 4, PHP 5
23028 **/
23029function call_user_method($method_name, &$obj, ...$vararg){}
23030
23031/**
23032 * Call a user method given with an array of parameters
23033 *
23034 * @param string $method_name The method name being called.
23035 * @param object $obj The object that {@link method_name} is being
23036 *   called on.
23037 * @param array $params An array of parameters.
23038 * @return mixed
23039 * @since PHP 4 >= 4.0.5, PHP 5
23040 **/
23041function call_user_method_array($method_name, &$obj, $params){}
23042
23043/**
23044 * Return the number of days in a month for a given year and calendar
23045 *
23046 * This function will return the number of days in the {@link month} of
23047 * {@link year} for the specified {@link calendar}.
23048 *
23049 * @param int $calendar Calendar to use for calculation
23050 * @param int $month Month in the selected calendar
23051 * @param int $year Year in the selected calendar
23052 * @return int The length in days of the selected month in the given
23053 *   calendar
23054 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
23055 **/
23056function cal_days_in_month($calendar, $month, $year){}
23057
23058/**
23059 * Converts from Julian Day Count to a supported calendar
23060 *
23061 * {@link cal_from_jd} converts the Julian day given in {@link jd} into a
23062 * date of the specified {@link calendar}. Supported {@link calendar}
23063 * values are CAL_GREGORIAN, CAL_JULIAN, CAL_JEWISH and CAL_FRENCH.
23064 *
23065 * @param int $jd Julian day as integer
23066 * @param int $calendar Calendar to convert to
23067 * @return array Returns an array containing calendar information like
23068 *   month, day, year, day of week (dow), abbreviated and full names of
23069 *   weekday and month and the date in string form "month/day/year". The
23070 *   day of week ranges from 0 (Sunday) to 6 (Saturday).
23071 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
23072 **/
23073function cal_from_jd($jd, $calendar){}
23074
23075/**
23076 * Returns information about a particular calendar
23077 *
23078 * {@link cal_info} returns information on the specified {@link
23079 * calendar}.
23080 *
23081 * Calendar information is returned as an array containing the elements
23082 * calname, calsymbol, month, abbrevmonth and maxdaysinmonth. The names
23083 * of the different calendars which can be used as {@link calendar} are
23084 * as follows: 0 or CAL_GREGORIAN - Gregorian Calendar 1 or CAL_JULIAN -
23085 * Julian Calendar 2 or CAL_JEWISH - Jewish Calendar 3 or CAL_FRENCH -
23086 * French Revolutionary Calendar
23087 *
23088 * If no {@link calendar} is specified information on all supported
23089 * calendars is returned as an array.
23090 *
23091 * @param int $calendar Calendar to return information for. If no
23092 *   calendar is specified information about all calendars is returned.
23093 * @return array
23094 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
23095 **/
23096function cal_info($calendar){}
23097
23098/**
23099 * Converts from a supported calendar to Julian Day Count
23100 *
23101 * {@link cal_to_jd} calculates the Julian day count for a date in the
23102 * specified {@link calendar}. Supported {@link calendar}s are
23103 * CAL_GREGORIAN, CAL_JULIAN, CAL_JEWISH and CAL_FRENCH.
23104 *
23105 * @param int $calendar Calendar to convert from, one of CAL_GREGORIAN,
23106 *   CAL_JULIAN, CAL_JEWISH or CAL_FRENCH.
23107 * @param int $month The month as a number, the valid range depends on
23108 *   the {@link calendar}
23109 * @param int $day The day as a number, the valid range depends on the
23110 *   {@link calendar}
23111 * @param int $year The year as a number, the valid range depends on
23112 *   the {@link calendar}
23113 * @return int A Julian Day number.
23114 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
23115 **/
23116function cal_to_jd($calendar, $month, $day, $year){}
23117
23118/**
23119 * Round fractions up
23120 *
23121 * @param float $value The value to round
23122 * @return float {@link value} rounded up to the next highest integer.
23123 *   The return value of {@link ceil} is still of type float as the value
23124 *   range of float is usually bigger than that of integer.
23125 * @since PHP 4, PHP 5, PHP 7
23126 **/
23127function ceil($value){}
23128
23129/**
23130 * Creates a chdb file
23131 *
23132 * {@link chdb_create} creates a chdb file containing the specified
23133 * key-value pairs.
23134 *
23135 * @param string $pathname The name of the file to create. If a file
23136 *   with the same name already exists, it is overwritten.
23137 * @param array $data An array containing the key-value pairs to store
23138 *   in the chdb file. Keys and values are converted to strings before
23139 *   being written to the file, as chdb only support the string type.
23140 *   Note that binary strings are supported as well, both as keys and
23141 *   values.
23142 * @return bool
23143 * @since PECL chdb >= 0.1.0
23144 **/
23145function chdb_create($pathname, $data){}
23146
23147/**
23148 * Change directory
23149 *
23150 * Changes PHP's current directory to {@link directory}.
23151 *
23152 * @param string $directory The new current directory
23153 * @return bool
23154 * @since PHP 4, PHP 5, PHP 7
23155 **/
23156function chdir($directory){}
23157
23158/**
23159 * Validate a Gregorian date
23160 *
23161 * Checks the validity of the date formed by the arguments. A date is
23162 * considered valid if each parameter is properly defined.
23163 *
23164 * @param int $month The month is between 1 and 12 inclusive.
23165 * @param int $day The day is within the allowed number of days for the
23166 *   given {@link month}. Leap {@link year}s are taken into
23167 *   consideration.
23168 * @param int $year The year is between 1 and 32767 inclusive.
23169 * @return bool Returns TRUE if the date given is valid; otherwise
23170 *   returns FALSE.
23171 * @since PHP 4, PHP 5, PHP 7
23172 **/
23173function checkdate($month, $day, $year){}
23174
23175/**
23176 * Check DNS records corresponding to a given Internet host name or IP
23177 * address
23178 *
23179 * Searches DNS for records of type {@link type} corresponding to {@link
23180 * host}.
23181 *
23182 * @param string $host {@link host} may either be the IP address in
23183 *   dotted-quad notation or the host name.
23184 * @param string $type {@link type} may be any one of: A, MX, NS, SOA,
23185 *   PTR, CNAME, AAAA, A6, SRV, NAPTR, TXT or ANY.
23186 * @return bool Returns TRUE if any records are found; returns FALSE if
23187 *   no records were found or if an error occurred.
23188 * @since PHP 4, PHP 5, PHP 7
23189 **/
23190function checkdnsrr($host, $type){}
23191
23192/**
23193 * Changes file group
23194 *
23195 * Attempts to change the group of the file {@link filename} to {@link
23196 * group}.
23197 *
23198 * Only the superuser may change the group of a file arbitrarily; other
23199 * users may change the group of a file to any group of which that user
23200 * is a member.
23201 *
23202 * @param string $filename Path to the file.
23203 * @param mixed $group A group name or number.
23204 * @return bool
23205 * @since PHP 4, PHP 5, PHP 7
23206 **/
23207function chgrp($filename, $group){}
23208
23209/**
23210 * Changes file mode
23211 *
23212 * Attempts to change the mode of the specified file to that given in
23213 * {@link mode}.
23214 *
23215 * @param string $filename Path to the file.
23216 * @param int $mode Note that {@link mode} is not automatically assumed
23217 *   to be an octal value, so to ensure the expected operation, you need
23218 *   to prefix {@link mode} with a zero (0). Strings such as "g+w" will
23219 *   not work properly.
23220 *
23221 *   <?php chmod("/somedir/somefile", 755); // decimal; probably
23222 *   incorrect chmod("/somedir/somefile", "u+rwx,go+rx"); // string;
23223 *   incorrect chmod("/somedir/somefile", 0755); // octal; correct value
23224 *   of mode ?>
23225 *
23226 *   The {@link mode} parameter consists of three octal number components
23227 *   specifying access restrictions for the owner, the user group in
23228 *   which the owner is in, and to everybody else in this order. One
23229 *   component can be computed by adding up the needed permissions for
23230 *   that target user base. Number 1 means that you grant execute rights,
23231 *   number 2 means that you make the file writeable, number 4 means that
23232 *   you make the file readable. Add up these numbers to specify needed
23233 *   rights. You can also read more about modes on Unix systems with 'man
23234 *   1 chmod' and 'man 2 chmod'.
23235 *
23236 *   <?php // Read and write for owner, nothing for everybody else
23237 *   chmod("/somedir/somefile", 0600);
23238 *
23239 *   // Read and write for owner, read for everybody else
23240 *   chmod("/somedir/somefile", 0644);
23241 *
23242 *   // Everything for owner, read and execute for others
23243 *   chmod("/somedir/somefile", 0755);
23244 *
23245 *   // Everything for owner, read and execute for owner's group
23246 *   chmod("/somedir/somefile", 0750); ?>
23247 * @return bool
23248 * @since PHP 4, PHP 5, PHP 7
23249 **/
23250function chmod($filename, $mode){}
23251
23252/**
23253 * Strip whitespace (or other characters) from the end of a string
23254 *
23255 * This function returns a string with whitespace (or other characters)
23256 * stripped from the end of {@link str}.
23257 *
23258 * Without the second parameter, {@link chop} will strip these
23259 * characters: " " (ASCII 32 (0x20)), an ordinary space. "\t" (ASCII 9
23260 * (0x09)), a tab. "\n" (ASCII 10 (0x0A)), a new line (line feed). "\r"
23261 * (ASCII 13 (0x0D)), a carriage return. "\0" (ASCII 0 (0x00)), the
23262 * NULL-byte. "\x0B" (ASCII 11 (0x0B)), a vertical tab.
23263 *
23264 * @param string $str The input string.
23265 * @param string $character_mask You can also specify the characters
23266 *   you want to strip, by means of the {@link character_mask} parameter.
23267 *   Simply list all characters that you want to be stripped. With .. you
23268 *   can specify a range of characters.
23269 * @return string Returns the modified string.
23270 * @since PHP 4, PHP 5, PHP 7
23271 **/
23272function chop($str, $character_mask){}
23273
23274/**
23275 * Changes file owner
23276 *
23277 * Attempts to change the owner of the file {@link filename} to user
23278 * {@link user}. Only the superuser may change the owner of a file.
23279 *
23280 * @param string $filename Path to the file.
23281 * @param mixed $user A user name or number.
23282 * @return bool
23283 * @since PHP 4, PHP 5, PHP 7
23284 **/
23285function chown($filename, $user){}
23286
23287/**
23288 * Generate a single-byte string from a number
23289 *
23290 * Returns a one-character string containing the character specified by
23291 * interpreting {@link bytevalue} as an unsigned integer.
23292 *
23293 * This can be used to create a one-character string in a single-byte
23294 * encoding such as ASCII, ISO-8859, or Windows 1252, by passing the
23295 * position of a desired character in the encoding's mapping table.
23296 * However, note that this function is not aware of any string encoding,
23297 * and in particular cannot be passed a Unicode code point value to
23298 * generate a string in a multibyte encoding like UTF-8 or UTF-16.
23299 *
23300 * This function complements {@link ord}.
23301 *
23302 * @param int $bytevalue An integer between 0 and 255. Values outside
23303 *   the valid range (0..255) will be bitwise and'ed with 255, which is
23304 *   equivalent to the following algorithm:
23305 *
23306 *   while ($bytevalue < 0) { $bytevalue += 256; } $bytevalue %= 256;
23307 * @return string A single-character string containing the specified
23308 *   byte.
23309 * @since PHP 4, PHP 5, PHP 7
23310 **/
23311function chr($bytevalue){}
23312
23313/**
23314 * Change the root directory
23315 *
23316 * Changes the root directory of the current process to {@link
23317 * directory}, and changes the current working directory to "/".
23318 *
23319 * This function is only available to GNU and BSD systems, and only when
23320 * using the CLI, CGI or Embed SAPI. Also, this function requires root
23321 * privileges.
23322 *
23323 * @param string $directory The path to change the root directory to.
23324 * @return bool
23325 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
23326 **/
23327function chroot($directory){}
23328
23329/**
23330 * Split a string into smaller chunks
23331 *
23332 * Can be used to split a string into smaller chunks which is useful for
23333 * e.g. converting {@link base64_encode} output to match RFC 2045
23334 * semantics. It inserts {@link end} every {@link chunklen} characters.
23335 *
23336 * @param string $body The string to be chunked.
23337 * @param int $chunklen The chunk length.
23338 * @param string $end The line ending sequence.
23339 * @return string Returns the chunked string.
23340 * @since PHP 4, PHP 5, PHP 7
23341 **/
23342function chunk_split($body, $chunklen, $end){}
23343
23344/**
23345 * Import new class method definitions from a file
23346 *
23347 * @param string $filename The filename of the class method definitions
23348 *   to import
23349 * @return array Associative array of imported methods
23350 * @since PECL classkit >= 0.3
23351 **/
23352function classkit_import($filename){}
23353
23354/**
23355 * Dynamically adds a new method to a given class
23356 *
23357 * @param string $classname The class to which this method will be
23358 *   added
23359 * @param string $methodname The name of the method to add
23360 * @param string $args Comma-delimited list of arguments for the
23361 *   newly-created method
23362 * @param string $code The code to be evaluated when {@link methodname}
23363 *   is called
23364 * @param int $flags The type of method to create, can be
23365 *   CLASSKIT_ACC_PUBLIC, CLASSKIT_ACC_PROTECTED or CLASSKIT_ACC_PRIVATE
23366 * @return bool
23367 * @since PECL classkit >= 0.1
23368 **/
23369function classkit_method_add($classname, $methodname, $args, $code, $flags){}
23370
23371/**
23372 * Copies a method from class to another
23373 *
23374 * @param string $dClass Destination class for copied method
23375 * @param string $dMethod Destination method name
23376 * @param string $sClass Source class of the method to copy
23377 * @param string $sMethod Name of the method to copy from the source
23378 *   class. If this parameter is omitted, the value of {@link dMethod} is
23379 *   assumed.
23380 * @return bool
23381 * @since PECL classkit >= 0.2
23382 **/
23383function classkit_method_copy($dClass, $dMethod, $sClass, $sMethod){}
23384
23385/**
23386 * Dynamically changes the code of the given method
23387 *
23388 * @param string $classname The class in which to redefine the method
23389 * @param string $methodname The name of the method to redefine
23390 * @param string $args Comma-delimited list of arguments for the
23391 *   redefined method
23392 * @param string $code The new code to be evaluated when {@link
23393 *   methodname} is called
23394 * @param int $flags The redefined method can be CLASSKIT_ACC_PUBLIC,
23395 *   CLASSKIT_ACC_PROTECTED or CLASSKIT_ACC_PRIVATE
23396 * @return bool
23397 * @since PECL classkit >= 0.1
23398 **/
23399function classkit_method_redefine($classname, $methodname, $args, $code, $flags){}
23400
23401/**
23402 * Dynamically removes the given method
23403 *
23404 * @param string $classname The class in which to remove the method
23405 * @param string $methodname The name of the method to remove
23406 * @return bool
23407 * @since PECL classkit >= 0.1
23408 **/
23409function classkit_method_remove($classname, $methodname){}
23410
23411/**
23412 * Dynamically changes the name of the given method
23413 *
23414 * @param string $classname The class in which to rename the method
23415 * @param string $methodname The name of the method to rename
23416 * @param string $newname The new name to give to the renamed method
23417 * @return bool
23418 * @since PECL classkit >= 0.1
23419 **/
23420function classkit_method_rename($classname, $methodname, $newname){}
23421
23422/**
23423 * Creates an alias for a class
23424 *
23425 * Creates an alias named {@link alias} based on the user defined class
23426 * {@link original}. The aliased class is exactly the same as the
23427 * original class.
23428 *
23429 * @param string $original The original class.
23430 * @param string $alias The alias name for the class.
23431 * @param bool $autoload Whether to autoload if the original class is
23432 *   not found.
23433 * @return bool
23434 * @since PHP 5 >= 5.3.0, PHP 7
23435 **/
23436function class_alias($original, $alias, $autoload){}
23437
23438/**
23439 * Checks if the class has been defined
23440 *
23441 * This function checks whether or not the given class has been defined.
23442 *
23443 * @param string $class_name The class name. The name is matched in a
23444 *   case-insensitive manner.
23445 * @param bool $autoload Whether or not to call by default.
23446 * @return bool Returns TRUE if {@link class_name} is a defined class,
23447 *   FALSE otherwise.
23448 * @since PHP 4, PHP 5, PHP 7
23449 **/
23450function class_exists($class_name, $autoload){}
23451
23452/**
23453 * Return the interfaces which are implemented by the given class or
23454 * interface
23455 *
23456 * This function returns an array with the names of the interfaces that
23457 * the given {@link class} and its parents implement.
23458 *
23459 * @param mixed $class An object (class instance) or a string (class or
23460 *   interface name).
23461 * @param bool $autoload Whether to allow this function to load the
23462 *   class automatically through the {@link __autoload} magic method.
23463 * @return array An array on success, or FALSE on error.
23464 * @since PHP 5, PHP 7
23465 **/
23466function class_implements($class, $autoload){}
23467
23468/**
23469 * Return the parent classes of the given class
23470 *
23471 * This function returns an array with the name of the parent classes of
23472 * the given {@link class}.
23473 *
23474 * @param mixed $class An object (class instance) or a string (class
23475 *   name).
23476 * @param bool $autoload Whether to allow this function to load the
23477 *   class automatically through the {@link __autoload} magic method.
23478 * @return array An array on success, or FALSE on error.
23479 * @since PHP 5, PHP 7
23480 **/
23481function class_parents($class, $autoload){}
23482
23483/**
23484 * Return the traits used by the given class
23485 *
23486 * This function returns an array with the names of the traits that the
23487 * given {@link class} uses. This does however not include any traits
23488 * used by a parent class.
23489 *
23490 * @param mixed $class An object (class instance) or a string (class
23491 *   name).
23492 * @param bool $autoload Whether to allow this function to load the
23493 *   class automatically through the {@link __autoload} magic method.
23494 * @return array An array on success, or FALSE on error.
23495 * @since PHP 5 >= 5.4.0, PHP 7
23496 **/
23497function class_uses($class, $autoload){}
23498
23499/**
23500 * Clears file status cache
23501 *
23502 * When you use {@link stat}, {@link lstat}, or any of the other
23503 * functions listed in the affected functions list (below), PHP caches
23504 * the information those functions return in order to provide faster
23505 * performance. However, in certain cases, you may want to clear the
23506 * cached information. For instance, if the same file is being checked
23507 * multiple times within a single script, and that file is in danger of
23508 * being removed or changed during that script's operation, you may elect
23509 * to clear the status cache. In these cases, you can use the {@link
23510 * clearstatcache} function to clear the information that PHP caches
23511 * about a file.
23512 *
23513 * You should also note that PHP doesn't cache information about
23514 * non-existent files. So, if you call {@link file_exists} on a file that
23515 * doesn't exist, it will return FALSE until you create the file. If you
23516 * create the file, it will return TRUE even if you then delete the file.
23517 * However {@link unlink} clears the cache automatically.
23518 *
23519 * Affected functions include {@link stat}, {@link lstat}, {@link
23520 * file_exists}, {@link is_writable}, {@link is_readable}, {@link
23521 * is_executable}, {@link is_file}, {@link is_dir}, {@link is_link},
23522 * {@link filectime}, {@link fileatime}, {@link filemtime}, {@link
23523 * fileinode}, {@link filegroup}, {@link fileowner}, {@link filesize},
23524 * {@link filetype}, and {@link fileperms}.
23525 *
23526 * @param bool $clear_realpath_cache Whether to clear the realpath
23527 *   cache or not.
23528 * @param string $filename Clear the realpath and the stat cache for a
23529 *   specific filename only; only used if {@link clear_realpath_cache} is
23530 *   TRUE.
23531 * @return void
23532 * @since PHP 4, PHP 5, PHP 7
23533 **/
23534function clearstatcache($clear_realpath_cache, $filename){}
23535
23536/**
23537 * Returns the current process title
23538 *
23539 * Returns the current process title, as set by {@link
23540 * cli_set_process_title}. Note that this may not exactly match what is
23541 * shown in ps or top, depending on your operating system.
23542 *
23543 * This function is available only in CLI mode.
23544 *
23545 * @return string Return a string with the current process title or
23546 *   NULL on error.
23547 * @since PHP 5 >= 5.5.0, PHP 7
23548 **/
23549function cli_get_process_title(){}
23550
23551/**
23552 * Sets the process title
23553 *
23554 * Sets the process title visible in tools such as top and ps. This
23555 * function is available only in CLI mode.
23556 *
23557 * @param string $title The new title.
23558 * @return bool
23559 * @since PHP 5 >= 5.5.0, PHP 7
23560 **/
23561function cli_set_process_title($title){}
23562
23563/**
23564 * Close directory handle
23565 *
23566 * Closes the directory stream indicated by {@link dir_handle}. The
23567 * stream must have previously been opened by {@link opendir}.
23568 *
23569 * @param resource $dir_handle The directory handle resource previously
23570 *   opened with {@link opendir}. If the directory handle is not
23571 *   specified, the last link opened by {@link opendir} is assumed.
23572 * @return void
23573 * @since PHP 4, PHP 5, PHP 7
23574 **/
23575function closedir($dir_handle){}
23576
23577/**
23578 * Close connection to system logger
23579 *
23580 * {@link closelog} closes the descriptor being used to write to the
23581 * system logger. The use of {@link closelog} is optional.
23582 *
23583 * @return bool
23584 * @since PHP 4, PHP 5, PHP 7
23585 **/
23586function closelog(){}
23587
23588/**
23589 * Sort array maintaining index association
23590 *
23591 * This function sorts an array such that array indices maintain their
23592 * correlation with the array elements they are associated with. This is
23593 * used mainly when sorting associative arrays where the actual element
23594 * order is significant. Array elements will have sort order according to
23595 * current locale rules.
23596 *
23597 * Equivalent to standard PHP {@link asort}.
23598 *
23599 * @param Collator $coll Collator object.
23600 * @param array $arr Array of strings to sort.
23601 * @param int $sort_flag Optional sorting type, one of the following:
23602 *   Collator::SORT_REGULAR - compare items normally (don't change types)
23603 *   Collator::SORT_NUMERIC - compare items numerically
23604 *   Collator::SORT_STRING - compare items as strings Default $sort_flag
23605 *   value is Collator::SORT_REGULAR. It is also used if an invalid
23606 *   $sort_flag value has been specified.
23607 * @return bool
23608 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
23609 **/
23610function collator_asort($coll, &$arr, $sort_flag){}
23611
23612/**
23613 * Compare two Unicode strings
23614 *
23615 * Compare two Unicode strings according to collation rules.
23616 *
23617 * @param Collator $coll Collator object.
23618 * @param string $str1 The first string to compare.
23619 * @param string $str2 The second string to compare.
23620 * @return int Return comparison result:
23621 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
23622 **/
23623function collator_compare($coll, $str1, $str2){}
23624
23625/**
23626 * Create a collator
23627 *
23628 * The strings will be compared using the options already specified.
23629 *
23630 * @param string $locale The locale containing the required collation
23631 *   rules. Special values for locales can be passed in - if null is
23632 *   passed for the locale, the default locale collation rules will be
23633 *   used. If empty string ("") or "root" are passed, UCA rules will be
23634 *   used.
23635 * @return Collator Return new instance of Collator object, or NULL on
23636 *   error.
23637 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
23638 **/
23639function collator_create($locale){}
23640
23641/**
23642 * Get collation attribute value
23643 *
23644 * Get a value of an integer collator attribute.
23645 *
23646 * @param Collator $coll Collator object.
23647 * @param int $attr Attribute to get value for.
23648 * @return int Attribute value, or boolean FALSE on error.
23649 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
23650 **/
23651function collator_get_attribute($coll, $attr){}
23652
23653/**
23654 * Get collator's last error code
23655 *
23656 * @param Collator $coll Collator object.
23657 * @return int Error code returned by the last Collator API function
23658 *   call.
23659 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
23660 **/
23661function collator_get_error_code($coll){}
23662
23663/**
23664 * Get text for collator's last error code
23665 *
23666 * Retrieves the message for the last error.
23667 *
23668 * @param Collator $coll Collator object.
23669 * @return string Description of an error occurred in the last Collator
23670 *   API function call.
23671 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
23672 **/
23673function collator_get_error_message($coll){}
23674
23675/**
23676 * Get the locale name of the collator
23677 *
23678 * Get collector locale name.
23679 *
23680 * @param Collator $coll Collator object.
23681 * @param int $type You can choose between valid and actual locale (
23682 *   Locale::VALID_LOCALE and Locale::ACTUAL_LOCALE, respectively).
23683 * @return string Real locale name from which the collation data comes.
23684 *   If the collator was instantiated from rules or an error occurred,
23685 *   returns boolean FALSE.
23686 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
23687 **/
23688function collator_get_locale($coll, $type){}
23689
23690/**
23691 * Get sorting key for a string
23692 *
23693 * Return collation key for a string. Collation keys can be compared
23694 * directly instead of strings, though are implementation specific and
23695 * may change between ICU library versions. Sort keys are generally only
23696 * useful in databases or other circumstances where function calls are
23697 * extremely expensive.
23698 *
23699 * @param Collator $coll Collator object.
23700 * @param string $str The string to produce the key from.
23701 * @return string Returns the collation key for the string, .
23702 * @since PHP 5 >= 5.3.2, PHP 7
23703 **/
23704function collator_get_sort_key($coll, $str){}
23705
23706/**
23707 * Get current collation strength
23708 *
23709 * @param Collator $coll Collator object.
23710 * @return int Returns current collation strength, or boolean FALSE on
23711 *   error.
23712 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
23713 **/
23714function collator_get_strength($coll){}
23715
23716/**
23717 * Set collation attribute
23718 *
23719 * @param Collator $coll Collator object.
23720 * @param int $attr Attribute.
23721 * @param int $val Attribute value.
23722 * @return bool
23723 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
23724 **/
23725function collator_set_attribute($coll, $attr, $val){}
23726
23727/**
23728 * Set collation strength
23729 *
23730 * The ICU Collation Service supports many levels of comparison (named
23731 * "Levels", but also known as "Strengths"). Having these categories
23732 * enables ICU to sort strings precisely according to local conventions.
23733 * However, by allowing the levels to be selectively employed, searching
23734 * for a string in text can be performed with various matching
23735 * conditions.
23736 *
23737 * Primary Level: Typically, this is used to denote differences between
23738 * base characters (for example, "a" < "b"). It is the strongest
23739 * difference. For example, dictionaries are divided into different
23740 * sections by base character. This is also called the level1 strength.
23741 * Secondary Level: Accents in the characters are considered secondary
23742 * differences (for example, "as" < "às" < "at"). Other differences
23743 * between letters can also be considered secondary differences,
23744 * depending on the language. A secondary difference is ignored when
23745 * there is a primary difference anywhere in the strings. This is also
23746 * called the level2 strength. Note: In some languages (such as Danish),
23747 * certain accented letters are considered to be separate base
23748 * characters. In most languages, however, an accented letter only has a
23749 * secondary difference from the unaccented version of that letter.
23750 * Tertiary Level: Upper and lower case differences in characters are
23751 * distinguished at the tertiary level (for example, "ao" < "Ao" <
23752 * "aò"). In addition, a variant of a letter differs from the base form
23753 * on the tertiary level (such as "A" and " "). Another example is the
23754 * difference between large and small Kana. A tertiary difference is
23755 * ignored when there is a primary or secondary difference anywhere in
23756 * the strings. This is also called the level3 strength. Quaternary
23757 * Level: When punctuation is ignored (see Ignoring Punctuations ) at
23758 * level 13, an additional level can be used to distinguish words with
23759 * and without punctuation (for example, "ab" < "a-b" < "aB"). This
23760 * difference is ignored when there is a primary, secondary or tertiary
23761 * difference. This is also known as the level4 strength. The quaternary
23762 * level should only be used if ignoring punctuation is required or when
23763 * processing Japanese text (see Hiragana processing). Identical Level:
23764 * When all other levels are equal, the identical level is used as a
23765 * tiebreaker. The Unicode code point values of the NFD form of each
23766 * string are compared at this level, just in case there is no difference
23767 * at levels 14. For example, Hebrew cantillation marks are only
23768 * distinguished at this level. This level should be used sparingly, as
23769 * only code point values differences between two strings is an extremely
23770 * rare occurrence. Using this level substantially decreases the
23771 * performance for both incremental comparison and sort key generation
23772 * (as well as increasing the sort key length). It is also known as level
23773 * 5 strength.
23774 *
23775 * For example, people may choose to ignore accents or ignore accents and
23776 * case when searching for text. Almost all characters are distinguished
23777 * by the first three levels, and in most locales the default value is
23778 * thus Tertiary. However, if Alternate is set to be Shifted, then the
23779 * Quaternary strength can be used to break ties among whitespace,
23780 * punctuation, and symbols that would otherwise be ignored. If very fine
23781 * distinctions among characters are required, then the Identical
23782 * strength can be used (for example, Identical Strength distinguishes
23783 * between the Mathematical Bold Small A and the Mathematical Italic
23784 * Small A.). However, using levels higher than Tertiary the Identical
23785 * strength result in significantly longer sort keys, and slower string
23786 * comparison performance for equal strings.
23787 *
23788 * @param Collator $coll Collator object.
23789 * @param int $strength Strength to set. Possible values are:
23790 *   Collator::PRIMARY Collator::SECONDARY Collator::TERTIARY
23791 *   Collator::QUATERNARY Collator::IDENTICAL Collator::DEFAULT_STRENGTH
23792 * @return bool
23793 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
23794 **/
23795function collator_set_strength($coll, $strength){}
23796
23797/**
23798 * Sort array using specified collator
23799 *
23800 * This function sorts an array according to current locale rules.
23801 *
23802 * Equivalent to standard PHP {@link sort} .
23803 *
23804 * @param Collator $coll Collator object.
23805 * @param array $arr Array of strings to sort.
23806 * @param int $sort_flag Optional sorting type, one of the following:
23807 *
23808 *   Collator::SORT_REGULAR - compare items normally (don't change types)
23809 *   Collator::SORT_NUMERIC - compare items numerically
23810 *   Collator::SORT_STRING - compare items as strings Default sorting
23811 *   type is Collator::SORT_REGULAR. It is also used if an invalid {@link
23812 *   sort_flag} value has been specified.
23813 * @return bool
23814 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
23815 **/
23816function collator_sort($coll, &$arr, $sort_flag){}
23817
23818/**
23819 * Sort array using specified collator and sort keys
23820 *
23821 * Similar to {@link collator_sort} but uses ICU sorting keys produced by
23822 * ucol_getSortKey() to gain more speed on large arrays.
23823 *
23824 * @param Collator $coll Collator object.
23825 * @param array $arr Array of strings to sort
23826 * @return bool
23827 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
23828 **/
23829function collator_sort_with_sort_keys($coll, &$arr){}
23830
23831namespace CommonMark {
23832
23833/**
23834 * Parsing
23835 *
23836 * Shall parse {@link content}
23837 *
23838 * @param string $content markdown string
23839 * @param int $options A mask of:
23840 * @return CommonMark\Node Shall return root CommonMark\Node
23841 **/
23842function Parse($content, $options){}
23843
23844}
23845
23846namespace CommonMark {
23847
23848/**
23849 * Rendering
23850 *
23851 * @param CommonMark\Node $node
23852 * @param int $options A mask of:
23853 * @param int $width
23854 * @return string
23855 **/
23856function Render($node, $options, $width){}
23857
23858}
23859
23860namespace CommonMark\Render {
23861
23862/**
23863 * Rendering
23864 *
23865 * @param CommonMark\Node $node
23866 * @param int $options A mask of:
23867 * @return string
23868 **/
23869function HTML($node, $options){}
23870
23871}
23872
23873namespace CommonMark\Render {
23874
23875/**
23876 * Rendering
23877 *
23878 * @param CommonMark\Node $node
23879 * @param int $options A mask of:
23880 * @param int $width
23881 * @return string
23882 **/
23883function Latex($node, $options, $width){}
23884
23885}
23886
23887namespace CommonMark\Render {
23888
23889/**
23890 * Rendering
23891 *
23892 * @param CommonMark\Node $node
23893 * @param int $options A mask of:
23894 * @param int $width
23895 * @return string
23896 **/
23897function Man($node, $options, $width){}
23898
23899}
23900
23901namespace CommonMark\Render {
23902
23903/**
23904 * Rendering
23905 *
23906 * @param CommonMark\Node $node
23907 * @param int $options A mask of:
23908 * @return string
23909 **/
23910function XML($node, $options){}
23911
23912}
23913
23914/**
23915 * Create array containing variables and their values
23916 *
23917 * Creates an array containing variables and their values.
23918 *
23919 * For each of these, {@link compact} looks for a variable with that name
23920 * in the current symbol table and adds it to the output array such that
23921 * the variable name becomes the key and the contents of the variable
23922 * become the value for that key. In short, it does the opposite of
23923 * {@link extract}.
23924 *
23925 * @param mixed $varname1 {@link compact} takes a variable number of
23926 *   parameters. Each parameter can be either a string containing the
23927 *   name of the variable, or an array of variable names. The array can
23928 *   contain other arrays of variable names inside it; {@link compact}
23929 *   handles it recursively.
23930 * @param mixed ...$vararg
23931 * @return array Returns the output array with all the variables added
23932 *   to it.
23933 * @since PHP 4, PHP 5, PHP 7
23934 **/
23935function compact($varname1, ...$vararg){}
23936
23937namespace Componere {
23938
23939/**
23940 * Casting
23941 *
23942 * @param Type $type A user defined type
23943 * @param $object An object with a user defined type compatible with
23944 *   Type
23945 * @return Type An object of type Type, cast from {@link object}
23946 **/
23947function cast($type, $object){}
23948
23949}
23950
23951namespace Componere {
23952
23953/**
23954 * Casting
23955 *
23956 * @param Type $type A user defined type
23957 * @param $object An object with a user defined type compatible with
23958 *   Type
23959 * @return Type An object of type Type, cast from {@link object}, where
23960 *   members are references to {@link object} members
23961 **/
23962function cast_by_ref($type, $object){}
23963
23964}
23965
23966/**
23967 * Generate a globally unique identifier (GUID)
23968 *
23969 * Generates a Globally Unique Identifier (GUID).
23970 *
23971 * A GUID is generated in the same way as DCE UUID's, except that the
23972 * Microsoft convention is to enclose a GUID in curly braces.
23973 *
23974 * @return string Returns the GUID as a string.
23975 * @since PHP 5, PHP 7
23976 **/
23977function com_create_guid(){}
23978
23979/**
23980 * Connect events from a COM object to a PHP object
23981 *
23982 * Instructs COM to sink events generated by {@link comobject} into the
23983 * PHP object {@link sinkobject}.
23984 *
23985 * Be careful how you use this feature; if you are doing something
23986 * similar to the example below, then it doesn't really make sense to run
23987 * it in a web server context.
23988 *
23989 * @param variant $comobject
23990 * @param object $sinkobject {@link sinkobject} should be an instance
23991 *   of a class with methods named after those of the desired
23992 *   dispinterface; you may use {@link com_print_typeinfo} to help
23993 *   generate a template class for this purpose.
23994 * @param mixed $sinkinterface PHP will attempt to use the default
23995 *   dispinterface type specified by the typelibrary associated with
23996 *   {@link comobject}, but you may override this choice by setting
23997 *   {@link sinkinterface} to the name of the dispinterface that you want
23998 *   to use.
23999 * @return bool
24000 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
24001 **/
24002function com_event_sink($comobject, $sinkobject, $sinkinterface){}
24003
24004/**
24005 * Returns a handle to an already running instance of a COM object
24006 *
24007 * {@link com_get_active_object} is similar to creating a new instance of
24008 * a object, except that it will only return an object to your script if
24009 * the object is already running. OLE applications use something known as
24010 * the "Running Object Table" to allow well-known applications to be
24011 * launched only once; this function exposes the COM library function
24012 * GetActiveObject() to get a handle on a running instance.
24013 *
24014 * @param string $progid {@link progid} must be either the ProgID or
24015 *   CLSID for the object that you want to access (for example
24016 *   Word.Application).
24017 * @param int $code_page Acts in precisely the same way that it does
24018 *   for the class.
24019 * @return variant If the requested object is running, it will be
24020 *   returned to your script just like any other COM object.
24021 * @since PHP 5, PHP 7
24022 **/
24023function com_get_active_object($progid, $code_page){}
24024
24025/**
24026 * Loads a Typelib
24027 *
24028 * Loads a type-library and registers its constants in the engine, as
24029 * though they were defined using {@link define}.
24030 *
24031 * Note that it is much more efficient to use the configuration setting
24032 * to pre-load and register the constants, although not so flexible.
24033 *
24034 * If you have turned on , then PHP will attempt to automatically
24035 * register the constants associated with a COM object when you
24036 * instantiate it. This depends on the interfaces provided by the COM
24037 * object itself, and may not always be possible.
24038 *
24039 * @param string $typelib_name {@link typelib_name} can be one of the
24040 *   following: The filename of a .tlb file or the executable module that
24041 *   contains the type library. The type library GUID, followed by its
24042 *   version number, for example
24043 *   {00000200-0000-0010-8000-00AA006D2EA4},2,0. The type library name,
24044 *   e.g. Microsoft OLE DB ActiveX Data Objects 1.0 Library. PHP will
24045 *   attempt to resolve the type library in this order, as the process
24046 *   gets more and more expensive as you progress down the list;
24047 *   searching for the type library by name is handled by physically
24048 *   enumerating the registry until we find a match.
24049 * @param bool $case_sensitive The {@link case_sensitive} behaves
24050 *   inversely to the parameter $case_insensitive in the {@link define}
24051 *   function.
24052 * @return bool
24053 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
24054 **/
24055function com_load_typelib($typelib_name, $case_sensitive){}
24056
24057/**
24058 * Process COM messages, sleeping for up to timeoutms milliseconds
24059 *
24060 * This function will sleep for up to {@link timeoutms} milliseconds, or
24061 * until a message arrives in the queue.
24062 *
24063 * The purpose of this function is to route COM calls between apartments
24064 * and handle various synchronization issues. This allows your script to
24065 * wait efficiently for events to be triggered, while still handling
24066 * other events or running other code in the background. You should use
24067 * it in a loop, as demonstrated by the example in the {@link
24068 * com_event_sink} function, until you are finished using event bound COM
24069 * objects.
24070 *
24071 * @param int $timeoutms The timeout, in milliseconds. If you do not
24072 *   specify a value for {@link timeoutms}, then 0 will be assumed. A 0
24073 *   value means that no waiting will be performed; if there are messages
24074 *   pending they will be dispatched as before; if there are no messages
24075 *   pending, the function will return FALSE immediately without
24076 *   sleeping.
24077 * @return bool If a message or messages arrives before the timeout,
24078 *   they will be dispatched, and the function will return TRUE. If the
24079 *   timeout occurs and no messages were processed, the return value will
24080 *   be FALSE.
24081 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
24082 **/
24083function com_message_pump($timeoutms){}
24084
24085/**
24086 * Print out a PHP class definition for a dispatchable interface
24087 *
24088 * The purpose of this function is to help generate a skeleton class for
24089 * use as an event sink. You may also use it to generate a dump of any
24090 * COM object, provided that it supports enough of the introspection
24091 * interfaces, and that you know the name of the interface you want to
24092 * display.
24093 *
24094 * @param object $comobject {@link comobject} should be either an
24095 *   instance of a COM object, or be the name of a typelibrary (which
24096 *   will be resolved according to the rules set out in {@link
24097 *   com_load_typelib}).
24098 * @param string $dispinterface The name of an IDispatch descendant
24099 *   interface that you want to display.
24100 * @param bool $wantsink If set to TRUE, the corresponding sink
24101 *   interface will be displayed instead.
24102 * @return bool
24103 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
24104 **/
24105function com_print_typeinfo($comobject, $dispinterface, $wantsink){}
24106
24107/**
24108 * Check whether client disconnected
24109 *
24110 * Checks whether the client disconnected.
24111 *
24112 * @return int Returns 1 if client disconnected, 0 otherwise.
24113 * @since PHP 4, PHP 5, PHP 7
24114 **/
24115function connection_aborted(){}
24116
24117/**
24118 * Returns connection status bitfield
24119 *
24120 * Gets the connection status bitfield.
24121 *
24122 * @return int Returns the connection status bitfield, which can be
24123 *   used against the CONNECTION_XXX constants to determine the
24124 *   connection status.
24125 * @since PHP 4, PHP 5, PHP 7
24126 **/
24127function connection_status(){}
24128
24129/**
24130 * Returns the value of a constant
24131 *
24132 * @param string $name The constant name.
24133 * @return mixed Returns the value of the constant, or NULL if the
24134 *   constant is not defined.
24135 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
24136 **/
24137function constant($name){}
24138
24139/**
24140 * Convert from one Cyrillic character set to another
24141 *
24142 * Converts from one Cyrillic character set to another.
24143 *
24144 * @param string $str The string to be converted.
24145 * @param string $from The source Cyrillic character set, as a single
24146 *   character.
24147 * @param string $to The target Cyrillic character set, as a single
24148 *   character.
24149 * @return string Returns the converted string.
24150 * @since PHP 4, PHP 5, PHP 7
24151 **/
24152function convert_cyr_string($str, $from, $to){}
24153
24154/**
24155 * Decode a uuencoded string
24156 *
24157 * {@link convert_uudecode} decodes a uuencoded string.
24158 *
24159 * @param string $data The uuencoded data.
24160 * @return string Returns the decoded data as a string .
24161 * @since PHP 5, PHP 7
24162 **/
24163function convert_uudecode($data){}
24164
24165/**
24166 * Uuencode a string
24167 *
24168 * {@link convert_uuencode} encodes a string using the uuencode
24169 * algorithm.
24170 *
24171 * Uuencode translates all strings (including binary data) into printable
24172 * characters, making them safe for network transmissions. Uuencoded data
24173 * is about 35% larger than the original.
24174 *
24175 * @param string $data The data to be encoded.
24176 * @return string Returns the uuencoded data .
24177 * @since PHP 5, PHP 7
24178 **/
24179function convert_uuencode($data){}
24180
24181/**
24182 * Copies file
24183 *
24184 * Makes a copy of the file {@link source} to {@link dest}.
24185 *
24186 * If you wish to move a file, use the {@link rename} function.
24187 *
24188 * @param string $source Path to the source file.
24189 * @param string $dest The destination path. If {@link dest} is a URL,
24190 *   the copy operation may fail if the wrapper does not support
24191 *   overwriting of existing files.
24192 * @param resource $context A valid context resource created with
24193 *   {@link stream_context_create}.
24194 * @return bool
24195 * @since PHP 4, PHP 5, PHP 7
24196 **/
24197function copy($source, $dest, $context){}
24198
24199/**
24200 * Cosine
24201 *
24202 * {@link cos} returns the cosine of the {@link arg} parameter. The
24203 * {@link arg} parameter is in radians.
24204 *
24205 * @param float $arg An angle in radians
24206 * @return float The cosine of {@link arg}
24207 * @since PHP 4, PHP 5, PHP 7
24208 **/
24209function cos($arg){}
24210
24211/**
24212 * Hyperbolic cosine
24213 *
24214 * Returns the hyperbolic cosine of {@link arg}, defined as (exp(arg) +
24215 * exp(-arg))/2.
24216 *
24217 * @param float $arg The argument to process
24218 * @return float The hyperbolic cosine of {@link arg}
24219 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
24220 **/
24221function cosh($arg){}
24222
24223/**
24224 * Count all elements in an array, or something in an object
24225 *
24226 * Counts all elements in an array, or something in an object.
24227 *
24228 * For objects, if you have SPL installed, you can hook into {@link
24229 * count} by implementing interface Countable. The interface has exactly
24230 * one method, Countable::count, which returns the return value for the
24231 * {@link count} function.
24232 *
24233 * Please see the Array section of the manual for a detailed explanation
24234 * of how arrays are implemented and used in PHP.
24235 *
24236 * @param mixed $array_or_countable An array or Countable object.
24237 * @param int $mode If the optional {@link mode} parameter is set to
24238 *   COUNT_RECURSIVE (or 1), {@link count} will recursively count the
24239 *   array. This is particularly useful for counting all the elements of
24240 *   a multidimensional array.
24241 * @return int Returns the number of elements in {@link
24242 *   array_or_countable}. When the parameter is neither an array nor an
24243 *   object with implemented Countable interface, 1 will be returned.
24244 *   There is one exception, if {@link array_or_countable} is NULL, 0
24245 *   will be returned.
24246 * @since PHP 4, PHP 5, PHP 7
24247 **/
24248function count($array_or_countable, $mode){}
24249
24250/**
24251 * Return information about characters used in a string
24252 *
24253 * Counts the number of occurrences of every byte-value (0..255) in
24254 * {@link string} and returns it in various ways.
24255 *
24256 * @param string $string The examined string.
24257 * @param int $mode See return values.
24258 * @return mixed Depending on {@link mode} {@link count_chars} returns
24259 *   one of the following: 0 - an array with the byte-value as key and
24260 *   the frequency of every byte as value. 1 - same as 0 but only
24261 *   byte-values with a frequency greater than zero are listed. 2 - same
24262 *   as 0 but only byte-values with a frequency equal to zero are listed.
24263 *   3 - a string containing all unique characters is returned. 4 - a
24264 *   string containing all not used characters is returned.
24265 * @since PHP 4, PHP 5, PHP 7
24266 **/
24267function count_chars($string, $mode){}
24268
24269/**
24270 * Performs an obscure check with the given password
24271 *
24272 * Performs an obscure check with the given password on the specified
24273 * dictionary. The alternative signature also takes into account the
24274 * username and the GECOS information.
24275 *
24276 * @param resource $dictionary The crack lib dictionary. If not
24277 *   specified, the last opened dictionary is used.
24278 * @param string $password The password to be checked.
24279 * @return bool Returns TRUE if {@link password} is strong, or FALSE
24280 *   otherwise.
24281 * @since PECL crack >= 0.1
24282 **/
24283function crack_check($dictionary, $password){}
24284
24285/**
24286 * Closes an open CrackLib dictionary
24287 *
24288 * {@link crack_closedict} closes the specified {@link dictionary}
24289 * identifier.
24290 *
24291 * @param resource $dictionary The dictionary to close. If not
24292 *   specified, the current dictionary is closed.
24293 * @return bool
24294 * @since PECL crack >= 0.1
24295 **/
24296function crack_closedict($dictionary){}
24297
24298/**
24299 * Returns the message from the last obscure check
24300 *
24301 * {@link crack_getlastmessage} returns the message from the last obscure
24302 * check.
24303 *
24304 * @return string The message from the last obscure check or FALSE if
24305 *   there was no obscure checks made so far.
24306 * @since PECL crack >= 0.1
24307 **/
24308function crack_getlastmessage(){}
24309
24310/**
24311 * Opens a new CrackLib dictionary
24312 *
24313 * {@link crack_opendict} opens the specified CrackLib {@link dictionary}
24314 * for use with {@link crack_check}.
24315 *
24316 * @param string $dictionary The path to the Cracklib dictionary.
24317 * @return resource Returns a dictionary resource identifier on
24318 *   success.
24319 * @since PECL crack >= 0.1
24320 **/
24321function crack_opendict($dictionary){}
24322
24323/**
24324 * Calculates the crc32 polynomial of a string
24325 *
24326 * Generates the cyclic redundancy checksum polynomial of 32-bit lengths
24327 * of the {@link str}. This is usually used to validate the integrity of
24328 * data being transmitted.
24329 *
24330 * @param string $str The data.
24331 * @return int Returns the crc32 checksum of {@link str} as an integer.
24332 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
24333 **/
24334function crc32($str){}
24335
24336/**
24337 * Create an anonymous (lambda-style) function
24338 *
24339 * Creates an anonymous function from the parameters passed, and returns
24340 * a unique name for it.
24341 *
24342 * @param string $args The function arguments.
24343 * @param string $code The function code.
24344 * @return string Returns a unique function name as a string, or FALSE
24345 *   on error.
24346 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
24347 **/
24348function create_function($args, $code){}
24349
24350/**
24351 * One-way string hashing
24352 *
24353 * {@link crypt} will return a hashed string using the standard Unix
24354 * DES-based algorithm or alternative algorithms that may be available on
24355 * the system.
24356 *
24357 * The {@link salt} parameter is optional. However, {@link crypt} creates
24358 * a weak hash without the {@link salt}. PHP 5.6 or later raise an
24359 * E_NOTICE error without it. Make sure to specify a strong enough salt
24360 * for better security.
24361 *
24362 * {@link password_hash} uses a strong hash, generates a strong salt, and
24363 * applies proper rounds automatically. {@link password_hash} is a simple
24364 * {@link crypt} wrapper and compatible with existing password hashes.
24365 * Use of {@link password_hash} is encouraged.
24366 *
24367 * Some operating systems support more than one type of hash. In fact,
24368 * sometimes the standard DES-based algorithm is replaced by an MD5-based
24369 * algorithm. The hash type is triggered by the salt argument. Prior to
24370 * 5.3, PHP would determine the available algorithms at install-time
24371 * based on the system's crypt(). If no salt is provided, PHP will
24372 * auto-generate either a standard two character (DES) salt, or a twelve
24373 * character (MD5), depending on the availability of MD5 crypt(). PHP
24374 * sets a constant named CRYPT_SALT_LENGTH which indicates the longest
24375 * valid salt allowed by the available hashes.
24376 *
24377 * The standard DES-based {@link crypt} returns the salt as the first two
24378 * characters of the output. It also only uses the first eight characters
24379 * of {@link str}, so longer strings that start with the same eight
24380 * characters will generate the same result (when the same salt is used).
24381 *
24382 * @param string $str The string to be hashed.
24383 * @param string $salt An optional salt string to base the hashing on.
24384 *   If not provided, the behaviour is defined by the algorithm
24385 *   implementation and can lead to unexpected results.
24386 * @return string Returns the hashed string or a string that is shorter
24387 *   than 13 characters and is guaranteed to differ from the salt on
24388 *   failure.
24389 * @since PHP 4, PHP 5, PHP 7
24390 **/
24391function crypt($str, $salt){}
24392
24393/**
24394 * Check for alphanumeric character(s)
24395 *
24396 * Checks if all of the characters in the provided string, {@link text},
24397 * are alphanumeric.
24398 *
24399 * @param string $text The tested string.
24400 * @return bool Returns TRUE if every character in {@link text} is
24401 *   either a letter or a digit, FALSE otherwise.
24402 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
24403 **/
24404function ctype_alnum($text){}
24405
24406/**
24407 * Check for alphabetic character(s)
24408 *
24409 * Checks if all of the characters in the provided string, {@link text},
24410 * are alphabetic. In the standard C locale letters are just [A-Za-z] and
24411 * {@link ctype_alpha} is equivalent to (ctype_upper($text) ||
24412 * ctype_lower($text)) if $text is just a single character, but other
24413 * languages have letters that are considered neither upper nor lower
24414 * case.
24415 *
24416 * @param string $text The tested string.
24417 * @return bool Returns TRUE if every character in {@link text} is a
24418 *   letter from the current locale, FALSE otherwise.
24419 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
24420 **/
24421function ctype_alpha($text){}
24422
24423/**
24424 * Check for control character(s)
24425 *
24426 * Checks if all of the characters in the provided string, {@link text},
24427 * are control characters. Control characters are e.g. line feed, tab,
24428 * escape.
24429 *
24430 * @param string $text The tested string.
24431 * @return bool Returns TRUE if every character in {@link text} is a
24432 *   control character from the current locale, FALSE otherwise.
24433 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
24434 **/
24435function ctype_cntrl($text){}
24436
24437/**
24438 * Check for numeric character(s)
24439 *
24440 * Checks if all of the characters in the provided string, {@link text},
24441 * are numerical.
24442 *
24443 * @param string $text The tested string.
24444 * @return bool Returns TRUE if every character in the string {@link
24445 *   text} is a decimal digit, FALSE otherwise.
24446 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
24447 **/
24448function ctype_digit($text){}
24449
24450/**
24451 * Check for any printable character(s) except space
24452 *
24453 * Checks if all of the characters in the provided string, {@link text},
24454 * creates visible output.
24455 *
24456 * @param string $text The tested string.
24457 * @return bool Returns TRUE if every character in {@link text} is
24458 *   printable and actually creates visible output (no white space),
24459 *   FALSE otherwise.
24460 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
24461 **/
24462function ctype_graph($text){}
24463
24464/**
24465 * Check for lowercase character(s)
24466 *
24467 * Checks if all of the characters in the provided string, {@link text},
24468 * are lowercase letters.
24469 *
24470 * @param string $text The tested string.
24471 * @return bool Returns TRUE if every character in {@link text} is a
24472 *   lowercase letter in the current locale.
24473 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
24474 **/
24475function ctype_lower($text){}
24476
24477/**
24478 * Check for printable character(s)
24479 *
24480 * Checks if all of the characters in the provided string, {@link text},
24481 * are printable.
24482 *
24483 * @param string $text The tested string.
24484 * @return bool Returns TRUE if every character in {@link text} will
24485 *   actually create output (including blanks). Returns FALSE if {@link
24486 *   text} contains control characters or characters that do not have any
24487 *   output or control function at all.
24488 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
24489 **/
24490function ctype_print($text){}
24491
24492/**
24493 * Check for any printable character which is not whitespace or an
24494 * alphanumeric character
24495 *
24496 * Checks if all of the characters in the provided string, {@link text},
24497 * are punctuation character.
24498 *
24499 * @param string $text The tested string.
24500 * @return bool Returns TRUE if every character in {@link text} is
24501 *   printable, but neither letter, digit or blank, FALSE otherwise.
24502 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
24503 **/
24504function ctype_punct($text){}
24505
24506/**
24507 * Check for whitespace character(s)
24508 *
24509 * Checks if all of the characters in the provided string, {@link text},
24510 * creates whitespace.
24511 *
24512 * @param string $text The tested string.
24513 * @return bool Returns TRUE if every character in {@link text} creates
24514 *   some sort of white space, FALSE otherwise. Besides the blank
24515 *   character this also includes tab, vertical tab, line feed, carriage
24516 *   return and form feed characters.
24517 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
24518 **/
24519function ctype_space($text){}
24520
24521/**
24522 * Check for uppercase character(s)
24523 *
24524 * Checks if all of the characters in the provided string, {@link text},
24525 * are uppercase characters.
24526 *
24527 * @param string $text The tested string.
24528 * @return bool Returns TRUE if every character in {@link text} is an
24529 *   uppercase letter in the current locale.
24530 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
24531 **/
24532function ctype_upper($text){}
24533
24534/**
24535 * Check for character(s) representing a hexadecimal digit
24536 *
24537 * Checks if all of the characters in the provided string, {@link text},
24538 * are hexadecimal 'digits'.
24539 *
24540 * @param string $text The tested string.
24541 * @return bool Returns TRUE if every character in {@link text} is a
24542 *   hexadecimal 'digit', that is a decimal digit or a character from
24543 *   [A-Fa-f] , FALSE otherwise.
24544 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
24545 **/
24546function ctype_xdigit($text){}
24547
24548/**
24549 * Return the number of rows affected by the last SQL statement
24550 *
24551 * The {@link cubrid_affected_rows} function is used to get the number of
24552 * rows affected by the SQL statement (INSERT, DELETE, UPDATE).
24553 *
24554 * @param resource $conn_identifier The CUBRID connection. If the
24555 *   connection identifier is not specified, the last link opend by
24556 *   {@link cubrid_connect} is assumed.
24557 * @return int Number of rows affected by the SQL statement, when
24558 *   process is successful.
24559 * @since PECL CUBRID >= 8.3.0
24560 **/
24561function cubrid_affected_rows($conn_identifier){}
24562
24563/**
24564 * Bind variables to a prepared statement as parameters
24565 *
24566 * The {@link cubrid_bind} function is used to bind values to a
24567 * corresponding named or question mark placeholder in the SQL statement
24568 * that was passed to {@link cubrid_prepare}. If {@link bind_value_type}
24569 * is not given, string will be the default.
24570 *
24571 * The following table shows the types of substitute values.
24572 *
24573 * CUBRID Bind Date Types Support Bind Type Corresponding SQL Type
24574 * Supported STRING CHAR, VARCHAR NCHAR NCHAR, NVARCHAR BIT BIT, VARBIT
24575 * NUMERIC or NUMBER SHORT, INT, NUMERIC FLOAT FLOAT DOUBLE DOUBLE TIME
24576 * TIME DATE DATE TIMESTAMP TIMESTAMP OBJECT OBJECT ENUM ENUM BLOB BLOB
24577 * CLOB CLOB NULL NULL Not supported SET SET MULTISET MULTISET SEQUENCE
24578 * SEQUENCE
24579 *
24580 * @param resource $req_identifier Request identifier as a result of
24581 *   {@link cubrid_prepare}.
24582 * @param int $bind_index Location of binding parameters. It starts
24583 *   with 1.
24584 * @param mixed $bind_value Actual value for binding.
24585 * @param string $bind_value_type A type of the value to bind. (It is
24586 *   omitted by default. Thus, the system internally uses string by
24587 *   default. However, you need to specify the exact type of the value as
24588 *   an argument when they are NCHAR, BIT, or BLOB/CLOB).
24589 * @return bool TRUE, when process is successful.
24590 * @since PECL CUBRID >= 8.3.0
24591 **/
24592function cubrid_bind($req_identifier, $bind_index, $bind_value, $bind_value_type){}
24593
24594/**
24595 * Return the current CUBRID connection charset
24596 *
24597 * This function returns the current CUBRID connection charset and is
24598 * similar to the CUBRID function {@link cubrid_get_charset}.
24599 *
24600 * @param resource $conn_identifier The CUBRID connection. If the
24601 *   connection identifier is not specified, the last link opened by
24602 *   {@link cubrid_connect} is assumed.
24603 * @return string A string that represents the CUBRID connection
24604 *   charset; on success.
24605 * @since PECL CUBRID >= 8.3.1
24606 **/
24607function cubrid_client_encoding($conn_identifier){}
24608
24609/**
24610 * Close CUBRID connection
24611 *
24612 * The {@link cubrid_close} function ends the transaction currently in
24613 * process, closes the connection handle and disconnects from server. If
24614 * there is any request handles not closed yet at this point, they will
24615 * be closed. It is similar to the CUBRID function {@link
24616 * cubrid_disconnect}.
24617 *
24618 * @param resource $conn_identifier The CUBRID connection identifier.
24619 *   If the connection identifier is not specified, the last connection
24620 *   opened by {@link cubrid_connect} is assumed.
24621 * @return bool TRUE, when process is successful.
24622 * @since PECL CUBRID >= 8.3.1
24623 **/
24624function cubrid_close($conn_identifier){}
24625
24626/**
24627 * Close the request handle
24628 *
24629 * The {@link cubrid_close_prepare} function closes the request handle
24630 * given by the {@link req_identifier} argument, and releases the memory
24631 * region related to the handle. It is an alias of {@link
24632 * cubrid_close_request}.
24633 *
24634 * @param resource $req_identifier Request identifier.
24635 * @return bool Return TRUE on success.
24636 * @since PECL CUBRID >= 8.3.0
24637 **/
24638function cubrid_close_prepare($req_identifier){}
24639
24640/**
24641 * Close the request handle
24642 *
24643 * The {@link cubrid_close_request} function closes the request handle
24644 * given by the {@link req_identifier} argument, and releases the memory
24645 * region related to the handle. It is an alias of {@link
24646 * cubrid_close_prepare}.
24647 *
24648 * @param resource $req_identifier Request identifier.
24649 * @return bool Return TRUE on success.
24650 * @since PECL CUBRID >= 8.3.0
24651 **/
24652function cubrid_close_request($req_identifier){}
24653
24654/**
24655 * Get the column names in result
24656 *
24657 * The {@link cubrid_column_names} function is used to get the column
24658 * names of the query result by using {@link req_identifier}.
24659 *
24660 * @param resource $req_identifier Request identifier.
24661 * @return array Array of string values containing the column names,
24662 *   when process is successful.
24663 * @since PECL CUBRID >= 8.3.0
24664 **/
24665function cubrid_column_names($req_identifier){}
24666
24667/**
24668 * Get column types in result
24669 *
24670 * The {@link cubrid_column_types} function gets column types of query
24671 * results by using {@link req_identifier}.
24672 *
24673 * @param resource $req_identifier Request identifier.
24674 * @return array Array of string values containing the column types,
24675 *   when process is successful.
24676 * @since PECL CUBRID >= 8.3.0
24677 **/
24678function cubrid_column_types($req_identifier){}
24679
24680/**
24681 * Get contents of collection type column using OID
24682 *
24683 * The {@link cubrid_col_get} function is used to get contents of the
24684 * elements of the collection type (set, multiset, sequence) attribute
24685 * you requested as an array.
24686 *
24687 * @param resource $conn_identifier Connection identifier.
24688 * @param string $oid OID of the instance that you want to read.
24689 * @param string $attr_name Attribute name that you want to read from
24690 *   the instance.
24691 * @return array Array (0-based numerical array) containing the
24692 *   elements you requested, when process is successful;
24693 * @since PECL CUBRID >= 8.3.0
24694 **/
24695function cubrid_col_get($conn_identifier, $oid, $attr_name){}
24696
24697/**
24698 * Get the number of elements in collection type column using OID
24699 *
24700 * The {@link cubrid_col_size} function is used to get the number of
24701 * elements in a collection type (set, multiset, sequence) attribute.
24702 *
24703 * @param resource $conn_identifier Connection identifier.
24704 * @param string $oid OID the instance that you want to work with.
24705 * @param string $attr_name Name of the attribute that you want to work
24706 *   with.
24707 * @return int Number of elements, when process is successful.
24708 * @since PECL CUBRID >= 8.3.0
24709 **/
24710function cubrid_col_size($conn_identifier, $oid, $attr_name){}
24711
24712/**
24713 * Commit a transaction
24714 *
24715 * The {@link cubrid_commit} function is used to execute commit on the
24716 * transaction pointed by {@link conn_identifier}, currently in progress.
24717 * Connection to the server is closed after the {@link cubrid_commit}
24718 * function is called; However, the connection handle is still valid.
24719 *
24720 * In CUBRID PHP, auto-commit mode is disabled by default for transaction
24721 * management. You can set it by using {@link cubrid_set_autocommit}. You
24722 * can get its status by using {@link cubrid_get_autocommit}. Before you
24723 * start a transaction, remember to disable the auto-commit mode.
24724 *
24725 * @param resource $conn_identifier Connection identifier.
24726 * @return bool TRUE, when process is successful.
24727 * @since PECL CUBRID >= 8.3.0
24728 **/
24729function cubrid_commit($conn_identifier){}
24730
24731/**
24732 * Open a connection to a CUBRID Server
24733 *
24734 * The {@link cubrid_connect} function is used to establish the
24735 * environment for connecting to your server by using your server
24736 * address, port number, database name, user name, and password. If the
24737 * user name and password is not given, then the "PUBLIC" connection will
24738 * be made by default.
24739 *
24740 * @param string $host Host name or IP address of CUBRID CAS server.
24741 * @param int $port Port number of CUBRID CAS server (BROKER_PORT
24742 *   configured in $CUBRID/conf/cubrid_broker.conf).
24743 * @param string $dbname Name of database.
24744 * @param string $userid User name for the database. If not given, the
24745 *   default value is "public".
24746 * @param string $passwd User password. If not given, the default value
24747 *   is "".
24748 * @param bool $new_link If a second call is made to {@link
24749 *   cubrid_connect} with the same arguments, no new connection will be
24750 *   established, but instead, the connection identifier of the already
24751 *   opened connection will be returned. The {@link new_link} parameter
24752 *   modifies this behavior and makes {@link cubrid_connect} always open
24753 *   a new connection, even if {@link cubrid_connect} was called before
24754 *   with the same parameters.
24755 * @return resource Connection identifier, when process is successful.
24756 * @since PECL CUBRID >= 8.3.1
24757 **/
24758function cubrid_connect($host, $port, $dbname, $userid, $passwd, $new_link){}
24759
24760/**
24761 * Establish the environment for connecting to CUBRID server
24762 *
24763 * The {@link cubrid_connect_with_url} function is used to establish the
24764 * environment for connecting to your server by using connection
24765 * information passed with an url string argument. If the HA feature is
24766 * enabled in CUBRID, you must specify the connection information of the
24767 * standby server, which is used for failover when failure occurs, in the
24768 * url string argument of this function. If the user name and password is
24769 * not given, then the "PUBLIC" connection will be made by default.
24770 *
24771 * <url> ::=
24772 * CUBRID:<host>:<db_name>:<db_user>:<db_password>:[?<properties>]
24773 *
24774 * <properties> ::= <property> [&<property>]
24775 *
24776 * <properties> ::= alhosts=<alternative_hosts>[ &rctime=<time>]
24777 *
24778 * <properties> ::= login_timeout=<milli_sec>
24779 *
24780 * <properties> ::= query_timeout=<milli_sec>
24781 *
24782 * <properties> ::= disconnect_on_query_timeout=true|false
24783 *
24784 * <alternative_hosts> ::= <standby_broker1_host>:<port>
24785 * [,<standby_broker2_host>:<port>]
24786 *
24787 * <host> := HOSTNAME | IP_ADDR
24788 *
24789 * <time> := SECOND
24790 *
24791 * <milli_sec> := MILLI SECOND
24792 *
24793 * host : A host name or IP address of the master database db_name : A
24794 * name of the database db_user : A name of the database user db_password
24795 * : A database user password alhosts : Specifies the broker information
24796 * of the standby server, which is used for failover when it is
24797 * impossible to connect to the active server. You can specify multiple
24798 * brokers for failover, and the connection to the brokers is attempted
24799 * in the order listed in alhosts rctime : An interval between the
24800 * attempts to connect to the active broker in which failure occurred.
24801 * After a failure occurs, the system connects to the broker specified by
24802 * althosts (failover), terminates the transaction, and then attempts to
24803 * connect to the active broker of the master database at every rctime.
24804 * The default value is 600 seconds. login_timeout : Timeout value (unit:
24805 * msec.) for database login. The default value is 0, which means
24806 * infinite postponement. query_timeout : Timeout value (unit: msec.) for
24807 * query request. Upon timeout, a message to cancel requesting a query
24808 * transferred to server is sent. The return value can depend on the
24809 * disconnect_on_query_timeout configuration; even though the message to
24810 * cancel a request is sent to server, that request may succeed.
24811 * disconnect_on_query_timeout : Configures a value whether to
24812 * immediately return an error of function being executed upon timeout.
24813 * The default value is false.
24814 *
24815 * @param string $conn_url A character string that contains server
24816 *   connection information.
24817 * @param string $userid User name for the database.
24818 * @param string $passwd User password.
24819 * @param bool $new_link If a second call is made to {@link
24820 *   cubrid_connect_with_url} with the same arguments, no new connection
24821 *   will be established, but instead, the connection identifier of the
24822 *   already opened connection will be returned. The {@link new_link}
24823 *   parameter modifies this behavior and makes {@link
24824 *   cubrid_connect_with_url} always open a new connection, even if
24825 *   {@link cubrid_connect_with_url} was called before with the same
24826 *   parameters.
24827 * @return resource Connection identifier, when process is successful.
24828 **/
24829function cubrid_connect_with_url($conn_url, $userid, $passwd, $new_link){}
24830
24831/**
24832 * Get OID of the current cursor location
24833 *
24834 * The {@link cubrid_current_oid} function is used to get the oid of the
24835 * current cursor location from the query result. To use {@link
24836 * cubrid_current_oid}, the query executed must be a updatable query, and
24837 * the CUBRID_INCLUDE_OID option must be included during the query
24838 * execution.
24839 *
24840 * @param resource $req_identifier Request identifier.
24841 * @return string Oid of current cursor location, when process is
24842 *   successful
24843 * @since PECL CUBRID >= 8.3.0
24844 **/
24845function cubrid_current_oid($req_identifier){}
24846
24847/**
24848 * Move the internal row pointer of the CUBRID result
24849 *
24850 * This function performs the moving of the internal row pointer of the
24851 * CUBRID result (associated with the specified result identifier) to
24852 * point to a specific row number. There are functions, such as {@link
24853 * cubrid_fetch_assoc}, which use the current stored value of {@link row
24854 * number}.
24855 *
24856 * @param resource $result The result.
24857 * @param int $row_number This is the desired row number of the new
24858 *   result pointer.
24859 * @return bool Returns TRUE on success or FALSE on failure.
24860 * @since PECL CUBRID >= 8.3.0
24861 **/
24862function cubrid_data_seek($result, $row_number){}
24863
24864/**
24865 * Get db name from results of cubrid_list_dbs
24866 *
24867 * Retrieve the database name from a call to {@link cubrid_list_dbs}.
24868 *
24869 * @param array $result The result pointer from a call to {@link
24870 *   cubrid_list_dbs}.
24871 * @param int $index The index into the result set.
24872 * @return string Returns the database name on success, and FALSE on
24873 *   failure. If FALSE is returned, use {@link cubrid_error} to determine
24874 *   the nature of the error.
24875 * @since PECL CUBRID >= 8.3.1
24876 **/
24877function cubrid_db_name($result, $index){}
24878
24879/**
24880 * Close a database connection
24881 *
24882 * The {@link cubrid_disconnect} function closes the connection handle
24883 * and disconnects from server. If any request handle is not closed at
24884 * this point, it will be closed. It is similar to the CUBRID MySQL
24885 * compatible function {@link cubrid_close}.
24886 *
24887 * @param resource $conn_identifier Connection identifier.
24888 * @return bool TRUE, when process is successful.
24889 * @since PECL CUBRID >= 8.3.0
24890 **/
24891function cubrid_disconnect($conn_identifier){}
24892
24893/**
24894 * Delete an instance using OID
24895 *
24896 * The {@link cubrid_drop} function is used to delete an instance from
24897 * database by using the {@link oid} of the instance.
24898 *
24899 * @param resource $conn_identifier Connection identifier.
24900 * @param string $oid Oid of the instance that you want to delete.
24901 * @return bool TRUE, when process is successful.
24902 * @since PECL CUBRID >= 8.3.0
24903 **/
24904function cubrid_drop($conn_identifier, $oid){}
24905
24906/**
24907 * Return the numerical value of the error message from previous CUBRID
24908 * operation
24909 *
24910 * Returns the error number from the last CUBRID function.
24911 *
24912 * The {@link cubrid_errno} function is used to get the error code of the
24913 * error that occurred during the API execution. Usually, it gets the
24914 * error code when API returns false as its return value.
24915 *
24916 * @param resource $conn_identifier The CUBRID connection identifier.
24917 *   If the connection identifier is not specified, the last connection
24918 *   opened by {@link cubrid_connect} is assumed.
24919 * @return int Returns the error number from the last CUBRID function,
24920 *   or 0 (zero) if no error occurred.
24921 * @since PECL CUBRID >= 8.3.1
24922 **/
24923function cubrid_errno($conn_identifier){}
24924
24925/**
24926 * Get the error message
24927 *
24928 * The {@link cubrid_error} function is used to get the error message
24929 * that occurred during the use of CUBRID API. Usually, it gets error
24930 * message when API returns false as its return value.
24931 *
24932 * @param resource $connection The CUBRID connection.
24933 * @return string Error message that occurred.
24934 * @since PECL CUBRID >= 8.3.1
24935 **/
24936function cubrid_error($connection){}
24937
24938/**
24939 * Get error code for the most recent function call
24940 *
24941 * The {@link cubrid_error_code} function is used to get the error code
24942 * of the error that occurred during the API execution. Usually, it gets
24943 * the error code when API returns false as its return value.
24944 *
24945 * @return int Error code of the error that occurred, or 0 (zero) if no
24946 *   error occurred.
24947 * @since PECL CUBRID >= 8.3.0
24948 **/
24949function cubrid_error_code(){}
24950
24951/**
24952 * Get the facility code of error
24953 *
24954 * The {@link cubrid_error_code_facility} function is used to get the
24955 * facility code (level in which the error occurred) from the error code
24956 * of the error that occurred during the API execution. Usually, you can
24957 * get the error code when API returns false as its return value.
24958 *
24959 * @return int Facility code of the error code that occurred:
24960 *   CUBRID_FACILITY_DBMS, CUBRID_FACILITY_CAS, CUBRID_FACILITY_CCI,
24961 *   CUBRID_FACILITY_CLIENT
24962 * @since PECL CUBRID >= 8.3.0
24963 **/
24964function cubrid_error_code_facility(){}
24965
24966/**
24967 * Get last error message for the most recent function call
24968 *
24969 * The {@link cubrid_error_msg} function is used to get the error message
24970 * that occurred during the use of CUBRID API. Usually, it gets error
24971 * message when API returns false as its return value.
24972 *
24973 * @return string Error message that occurred.
24974 * @since PECL CUBRID >= 8.3.0
24975 **/
24976function cubrid_error_msg(){}
24977
24978/**
24979 * Execute a prepared SQL statement
24980 *
24981 * The {@link cubrid_execute} function is used to execute the given SQL
24982 * statement. It executes the query by using {@link conn_identifier} and
24983 * SQL, and then returns the request identifier created. It is used for
24984 * simple execution of query, where the parameter binding is not needed.
24985 * In addition, the {@link cubrid_execute} function is used to execute
24986 * the prepared statement by means of {@link cubrid_prepare} and {@link
24987 * cubrid_bind}. At this time, you need to specify arguments of {@link
24988 * request_identifier} and {@link option}.
24989 *
24990 * The {@link option} is used to determine whether to get OID after query
24991 * execution and whether to execute the query in synchronous or
24992 * asynchronous mode. CUBRID_INCLUDE_OID and CUBRID_ASYNC (or
24993 * CUBRID_EXEC_QUERY_ALL if you want to execute multiple SQL statements)
24994 * can be specified by using a bitwise OR operator. If not specified,
24995 * neither of them isselected. If the flag CUBRID_EXEC_QUERY_ALL is set,
24996 * a synchronous mode (sync_mode) is used to retrieve query results, and
24997 * in such cases the following rules are applied:
24998 *
24999 * The return value is the result of the first query. If an error occurs
25000 * in any query, the execution is processed as a failure. In a query
25001 * composed of q1 q2 q3, if an error occurs in q2 after q1 succeeds the
25002 * execution, the result of q1 remains valid. That is, the previous
25003 * successful query executions are not rolled back when an error occurs.
25004 * If a query is executed successfully, the result of the second query
25005 * can be obtained using {@link cubrid_next_result}.
25006 *
25007 * If the first argument is {@link request_identifier} to execute the
25008 * {@link cubrid_prepare} function, you can specify an option,
25009 * CUBRID_ASYNC only.
25010 *
25011 * @param resource $conn_identifier Connection identifier.
25012 * @param string $sql SQL to be executed.
25013 * @param int $option Query execution option CUBRID_INCLUDE_OID,
25014 *   CUBRID_ASYNC, CUBRID_EXEC_QUERY_ALL.
25015 * @return resource Request identifier, when process is successful and
25016 *   first param is conn_identifier; TRUE, when process is successful and
25017 *   first argument is request_identifier.
25018 * @since PECL CUBRID >= 8.3.0
25019 **/
25020function cubrid_execute($conn_identifier, $sql, $option){}
25021
25022/**
25023 * Fetch the next row from a result set
25024 *
25025 * The {@link cubrid_fetch} function is used to get a single row from the
25026 * query result. The cursor automatically moves to the next row after
25027 * getting the result.
25028 *
25029 * @param resource $result {@link result} comes from a call to {@link
25030 *   cubrid_execute}
25031 * @param int $type Array type of the fetched result CUBRID_NUM,
25032 *   CUBRID_ASSOC, CUBRID_BOTH, CUBRID_OBJECT. If you want to operate the
25033 *   lob object, you can use CUBRID_LOB.
25034 * @return mixed Result array or object, when process is successful.
25035 * @since PECL CUBRID >= 8.3.0
25036 **/
25037function cubrid_fetch($result, $type){}
25038
25039/**
25040 * Fetch a result row as an associative array, a numeric array, or both
25041 *
25042 * The {@link cubrid_fetch_array} function is used to get a single row
25043 * from the query result and returns an array. The cursor automatically
25044 * moves to the next row after getting the result.
25045 *
25046 * @param resource $result {@link Result} comes from a call to {@link
25047 *   cubrid_execute}
25048 * @param int $type Array type of the fetched result CUBRID_NUM,
25049 *   CUBRID_ASSOC, CUBRID_BOTH. If you need to operate the lob object,
25050 *   you can use CUBRID_LOB.
25051 * @return array Returns an array of strings that corresponds to the
25052 *   fetched row, when process is successful.
25053 * @since PECL CUBRID >=8.3.0
25054 **/
25055function cubrid_fetch_array($result, $type){}
25056
25057/**
25058 * Return the associative array that corresponds to the fetched row
25059 *
25060 * This function returns the associative array, that corresponds to the
25061 * fetched row, and then moves the internal data pointer ahead, or
25062 * returns FALSE when the end is reached.
25063 *
25064 * @param resource $result {@link result} comes from a call to {@link
25065 *   cubrid_execute}
25066 * @param int $type Type can only be CUBRID_LOB, this parameter will be
25067 *   used only when you need to operate the lob object.
25068 * @return array Associative array, when process is successful.
25069 * @since PECL CUBRID >= 8.3.0
25070 **/
25071function cubrid_fetch_assoc($result, $type){}
25072
25073/**
25074 * Get column information from a result and return as an object
25075 *
25076 * This function returns an object with certain properties of the
25077 * specific column. The properties of the object are:
25078 *
25079 * {@link name} column name {@link table} name of the table that the
25080 * column belongs to {@link def} default value of the column {@link
25081 * max_length} maximum length of the column {@link not_null} 1 if the
25082 * column cannot be NULL {@link primary_key} 1 if the column is a primary
25083 * key {@link unique_key} 1 if the column is an unique key {@link
25084 * multiple_key} 1 if the column is a non-unique key {@link numeric} 1 if
25085 * the column is numeric {@link blob} 1 if the column is a BLOB {@link
25086 * type} the type of the column {@link unsigned} 1 if the column is
25087 * unsigned {@link zerofill} 1 if the column is zero-filled
25088 *
25089 * @param resource $result {@link result} comes from a call to {@link
25090 *   cubrid_execute}
25091 * @param int $field_offset The numerical field offset. If the field
25092 *   offset is not specified, the next field (that was not yet retrieved
25093 *   by this function) is retrieved. The {@link field_offset} starts at
25094 *   0.
25095 * @return object Object with certain properties of the specific
25096 *   column, when process is successful.
25097 * @since PECL CUBRID >= 8.3.1
25098 **/
25099function cubrid_fetch_field($result, $field_offset){}
25100
25101/**
25102 * Return an array with the lengths of the values of each field from the
25103 * current row
25104 *
25105 * This function returns an numeric array with the lengths of the values
25106 * of each field from the current row of the result set or it returns
25107 * FALSE on failure.
25108 *
25109 * @param resource $result {@link result} comes from a call to {@link
25110 *   cubrid_execute}
25111 * @return array An numeric array, when process is successful.
25112 * @since PECL CUBRID >= 8.3.0
25113 **/
25114function cubrid_fetch_lengths($result){}
25115
25116/**
25117 * Fetch the next row and return it as an object
25118 *
25119 * This function returns an object with the column names of the result
25120 * set as properties. The values of these properties are extracted from
25121 * the current row of the result.
25122 *
25123 * @param resource $result {@link result} comes from a call to {@link
25124 *   cubrid_execute}
25125 * @param string $class_name The name of the class to instantiate. If
25126 *   not specified, a stdClass (stdClass is PHP's generic empty class
25127 *   that's used when casting other types to objects) object is returned.
25128 * @param array $params An optional array of parameters to pass to the
25129 *   constructor for {@link class_name} objects.
25130 * @param int $type Type can only be CUBRID_LOB, this parameter will be
25131 *   used only when you need to operate the lob object.
25132 * @return object An object, when process is successful.
25133 * @since PECL CUBRID >= 8.3.0
25134 **/
25135function cubrid_fetch_object($result, $class_name, $params, $type){}
25136
25137/**
25138 * Return a numerical array with the values of the current row
25139 *
25140 * This function returns a numerical array with the values of the current
25141 * row from the result set, starting from 0, and moves the internal data
25142 * pointer ahead.
25143 *
25144 * @param resource $result {@link result} comes from a call to {@link
25145 *   cubrid_execute}
25146 * @param int $type Type can only be CUBRID_LOB, this parameter will be
25147 *   used only when you need to operate the lob object.
25148 * @return array A numerical array, when process is successful.
25149 * @since PECL CUBRID >= 8.3.0
25150 **/
25151function cubrid_fetch_row($result, $type){}
25152
25153/**
25154 * Return a string with the flags of the given field offset
25155 *
25156 * This function returns a string with the flags of the given field
25157 * offset separated by space. You can split the returned value using
25158 * explode. The possible flags could be: not_null, primary_key,
25159 * unique_key, foreign_key, auto_increment, shared, reverse_index,
25160 * reverse_unique and timestamp.
25161 *
25162 * @param resource $result {@link result} comes from a call to {@link
25163 *   cubrid_execute}
25164 * @param int $field_offset The numerical field offset. The {@link
25165 *   field_offset} starts at 0. If {@link field_offset} does not exist,
25166 *   an error of level E_WARNING is also issued.
25167 * @return string A string with flags, when process is successful.
25168 * @since PECL CUBRID >= 8.3.0
25169 **/
25170function cubrid_field_flags($result, $field_offset){}
25171
25172/**
25173 * Get the maximum length of the specified field
25174 *
25175 * This function returns the maximum length of the specified field on
25176 * success, or it returns FALSE on failure.
25177 *
25178 * @param resource $result {@link result} comes from a call to {@link
25179 *   cubrid_execute}
25180 * @param int $field_offset The numerical field offset. The {@link
25181 *   field_offset} starts at 0. If {@link field_offset} does not exist,
25182 *   an error of level E_WARNING is also issued.
25183 * @return int Maximum length, when process is successful.
25184 * @since PECL CUBRID >= 8.3.0
25185 **/
25186function cubrid_field_len($result, $field_offset){}
25187
25188/**
25189 * Return the name of the specified field index
25190 *
25191 * This function returns the name of the specified field index on success
25192 * or it returns FALSE on failure.
25193 *
25194 * @param resource $result {@link result} comes from a call to {@link
25195 *   cubrid_execute}
25196 * @param int $field_offset The numerical field offset. The {@link
25197 *   field_offset} starts at 0. If {@link field_offset} does not exist,
25198 *   an error of level E_WARNING is also issued.
25199 * @return string Name of specified field index, on success.
25200 * @since PECL CUBRID >= 8.3.0
25201 **/
25202function cubrid_field_name($result, $field_offset){}
25203
25204/**
25205 * Move the result set cursor to the specified field offset
25206 *
25207 * This function moves the result set cursor to the specified field
25208 * offset. This offset is used by {@link cubrid_fetch_field} if it
25209 * doesn't include a field offset. It returns TRUE on success or FALSE on
25210 * failure.
25211 *
25212 * @param resource $result {@link result} comes from a call to {@link
25213 *   cubrid_execute}
25214 * @param int $field_offset The numerical field offset. The {@link
25215 *   field_offset} starts at 0. If {@link field_offset} does not exist,
25216 *   an error of level E_WARNING is also issued.
25217 * @return bool TRUE on success.
25218 * @since PECL CUBRID >= 8.3.0
25219 **/
25220function cubrid_field_seek($result, $field_offset){}
25221
25222/**
25223 * Return the name of the table of the specified field
25224 *
25225 * This function returns the name of the table of the specified field.
25226 * This is useful when using large select queries with JOINS.
25227 *
25228 * @param resource $result {@link result} comes from a call to {@link
25229 *   cubrid_execute}
25230 * @param int $field_offset The numerical field offset. The {@link
25231 *   field_offset} starts at 0. If {@link field_offset} does not exist,
25232 *   an error of level E_WARNING is also issued.
25233 * @return string Name of the table of the specified field, on success.
25234 * @since PECL CUBRID >= 8.3.0
25235 **/
25236function cubrid_field_table($result, $field_offset){}
25237
25238/**
25239 * Return the type of the column corresponding to the given field offset
25240 *
25241 * This function returns the type of the column corresponding to the
25242 * given field offset. The returned field type could be one of the
25243 * following: "int", "real", "string", etc.
25244 *
25245 * @param resource $result {@link result} comes from a call to {@link
25246 *   cubrid_execute}
25247 * @param int $field_offset The numerical field offset. The {@link
25248 *   field_offset} starts at 0. If {@link field_offset} does not exist,
25249 *   an error of level E_WARNING is also issued.
25250 * @return string Type of the column, on success.
25251 * @since PECL CUBRID >= 8.3.0
25252 **/
25253function cubrid_field_type($result, $field_offset){}
25254
25255/**
25256 * Free the memory occupied by the result data
25257 *
25258 * This function frees the memory occupied by the result data. It returns
25259 * TRUE on success or FALSE on failure. Note that it can only frees the
25260 * client fetch buffer now, and if you want free all memory, use function
25261 * {@link cubrid_close_request}.
25262 *
25263 * @param resource $req_identifier This is the request identifier.
25264 * @return bool TRUE on success.
25265 * @since PECL CUBRID >= 8.3.0
25266 **/
25267function cubrid_free_result($req_identifier){}
25268
25269/**
25270 * Get a column using OID
25271 *
25272 * The {@link cubrid_get} function is used to get the attribute of the
25273 * instance of the given {@link oid}. You can get single attribute by
25274 * using string data type for the {@link attr} argument, or many
25275 * attributes by using array data type for the {@link attr} argument.
25276 *
25277 * @param resource $conn_identifier Connection identifier.
25278 * @param string $oid OID of the instance that you want to read.
25279 * @param mixed $attr Name of the attribute that you want to read.
25280 * @return mixed Content of the requested attribute, when process is
25281 *   successful; When {@link attr} is set with string data type, the
25282 *   result is returned as a string; when {@link attr} is set with array
25283 *   data type (0-based numerical array), then the result is returned in
25284 *   associative array. When {@link attr} is omitted, then all attributes
25285 *   are received in array form.
25286 * @since PECL CUBRID >= 8.3.0
25287 **/
25288function cubrid_get($conn_identifier, $oid, $attr){}
25289
25290/**
25291 * Get auto-commit mode of the connection
25292 *
25293 * The {@link cubrid_get_autocommit} function is used to get the status
25294 * of CUBRID database connection auto-commit mode.
25295 *
25296 * For CUBRID 8.4.0, auto-commit mode is disabled by default for
25297 * transaction management.
25298 *
25299 * For CUBRID 8.4.1, auto-commit mode is enabled by default for
25300 * transaction management.
25301 *
25302 * @param resource $conn_identifier Connection identifier.
25303 * @return bool TRUE, when auto-commit is on.
25304 * @since PECL CUBRID >= 8.4.0
25305 **/
25306function cubrid_get_autocommit($conn_identifier){}
25307
25308/**
25309 * Return the current CUBRID connection charset
25310 *
25311 * This function returns the current CUBRID connection charset and is
25312 * similar to the CUBRID MySQL compatible function {@link
25313 * cubrid_client_encoding}.
25314 *
25315 * @param resource $conn_identifier The CUBRID connection.
25316 * @return string A string that represents the CUBRID connection
25317 *   charset; on success.
25318 * @since PECL CUBRID >= 8.3.0
25319 **/
25320function cubrid_get_charset($conn_identifier){}
25321
25322/**
25323 * Get the class name using OID
25324 *
25325 * The {@link cubrid_get_class_name} function is used to get the class
25326 * name from {@link oid}. It doesn't work when selecting data from the
25327 * system tables, for example db_class.
25328 *
25329 * @param resource $conn_identifier Connection identifier.
25330 * @param string $oid OID of the instance that you want to check the
25331 *   existence.
25332 * @return string Class name when process is successful.
25333 * @since PECL CUBRID >= 8.3.0
25334 **/
25335function cubrid_get_class_name($conn_identifier, $oid){}
25336
25337/**
25338 * Return the client library version
25339 *
25340 * This function returns a string that represents the client library
25341 * version.
25342 *
25343 * @return string A string that represents the client library version;
25344 *   on success.
25345 * @since PECL CUBRID >= 8.3.0
25346 **/
25347function cubrid_get_client_info(){}
25348
25349/**
25350 * Returns the CUBRID database parameters
25351 *
25352 * This function returns the CUBRID database parameters or it returns
25353 * FALSE on failure. It returns an associative array with the values for
25354 * the following parameters:
25355 *
25356 * PARAM_ISOLATION_LEVEL PARAM_LOCK_TIMEOUT PARAM_MAX_STRING_LENGTH
25357 * PARAM_AUTO_COMMIT
25358 *
25359 * Database parameters Parameter Description PARAM_ISOLATION_LEVEL The
25360 * transaction isolation level. LOCK_TIMEOUT CUBRID provides the lock
25361 * timeout feature, which sets the waiting time (in seconds) for the lock
25362 * until the transaction lock setting is allowed. The default value of
25363 * the lock_timeout_in_secs parameter is -1, which means the application
25364 * client will wait indefinitely until the transaction lock is allowed.
25365 * PARAM_AUTO_COMMIT In CUBRID PHP, auto-commit mode is disabled by
25366 * default for transaction management. It can be set by using {@link
25367 * cubrid_set_autocommit}.
25368 *
25369 * The following table shows the isolation levels from 1 to 6. It
25370 * consists of table schema (row) and isolation level: Levels of
25371 * Isolation Supported by CUBRID Name Description SERIALIZABLE (6) In
25372 * this isolation level, problems concerning concurrency (e.g. dirty
25373 * read, non-repeatable read, phantom read, etc.) do not occur.
25374 * REPEATABLE READ CLASS with REPEATABLE READ INSTANCES (5) Another
25375 * transaction T2 cannot update the schema of table A while transaction
25376 * T1 is viewing table A. Transaction T1 may experience phantom read for
25377 * the record R that was inserted by another transaction T2 when it is
25378 * repeatedly retrieving a specific record. REPEATABLE READ CLASS with
25379 * READ COMMITTED INSTANCES (or CURSOR STABILITY) (4) Another transaction
25380 * T2 cannot update the schema of table A while transaction T1 is viewing
25381 * table A. Transaction T1 may experience R read (non-repeatable read)
25382 * that was updated and committed by another transaction T2 when it is
25383 * repeatedly retrieving the record R. REPEATABLE READ CLASS with READ
25384 * UNCOMMITTED INSTANCES (3) Default isolation level. Another transaction
25385 * T2 cannot update the schema of table A while transaction T1 is viewing
25386 * table A. Transaction T1 may experience R' read (dirty read) for the
25387 * record that was updated but not committed by another transaction T2.
25388 * READ COMMITTED CLASS with READ COMMITTED INSTANCES (2) Transaction T1
25389 * may experience A' read (non-repeatable read) for the table that was
25390 * updated and committed by another transaction T2 while it is viewing
25391 * table A repeatedly. Transaction T1 may experience R' read
25392 * (non-repeatable read) for the record that was updated and committed by
25393 * another transaction T2 while it is retrieving the record R repeatedly.
25394 * READ COMMITTED CLASS with READ UNCOMMITTED INSTANCES (1) Transaction
25395 * T1 may experience A' read (non-repeatable read) for the table that was
25396 * updated and committed by another transaction T2 while it is repeatedly
25397 * viewing table A. Transaction T1 may experience R' read (dirty read)
25398 * for the record that was updated but not committed by another
25399 * transaction T2.
25400 *
25401 * @param resource $conn_identifier The CUBRID connection. If the
25402 *   connection identifier is not specified, the last link opened by
25403 *   {@link cubrid_connect} is assumed.
25404 * @return array An associative array with CUBRID database parameters;
25405 *   on success.
25406 * @since PECL CUBRID >= 8.3.0
25407 **/
25408function cubrid_get_db_parameter($conn_identifier){}
25409
25410/**
25411 * Get the query timeout value of the request
25412 *
25413 * The {@link cubrid_get_query_timeout} function is used to get the query
25414 * timeout of the request.
25415 *
25416 * @param resource $req_identifier Request identifier.
25417 * @return int Success: the query timeout value of the current request.
25418 *   Units of msec.
25419 * @since PECL CUBRID >= 8.4.1
25420 **/
25421function cubrid_get_query_timeout($req_identifier){}
25422
25423/**
25424 * Return the CUBRID server version
25425 *
25426 * This function returns a string that represents the CUBRID server
25427 * version.
25428 *
25429 * @param resource $conn_identifier The CUBRID connection.
25430 * @return string A string that represents the CUBRID server version;
25431 *   on success.
25432 * @since PECL CUBRID >= 8.3.0
25433 **/
25434function cubrid_get_server_info($conn_identifier){}
25435
25436/**
25437 * Return the ID generated for the last updated column
25438 *
25439 * The {@link cubrid_insert_id} function retrieves the ID generated for
25440 * the AUTO_INCREMENT column which is updated by the previous INSERT
25441 * query. It returns 0 if the previous query does not generate new rows,
25442 * or FALSE on failure.
25443 *
25444 * @param resource $conn_identifier The connection identifier
25445 *   previously obtained by a call to {@link cubrid_connect}.
25446 * @return string A string representing the ID generated for an
25447 *   AUTO_INCREMENT column by the previous query, on success.
25448 * @since PECL CUBRID >= 8.3.0
25449 **/
25450function cubrid_insert_id($conn_identifier){}
25451
25452/**
25453 * Check whether the instance pointed by OID exists
25454 *
25455 * The {@link cubrid_is_instance} function is used to check whether the
25456 * instance pointed by the given {@link oid} exists or not.
25457 *
25458 * @param resource $conn_identifier Connection identifier.
25459 * @param string $oid OID of the instance that you want to check the
25460 *   existence.
25461 * @return int 1, if such instance exists;
25462 * @since PECL CUBRID >= 8.3.0
25463 **/
25464function cubrid_is_instance($conn_identifier, $oid){}
25465
25466/**
25467 * Return an array with the list of all existing CUBRID databases
25468 *
25469 * This function returns an array with the list of all existing Cubrid
25470 * databases.
25471 *
25472 * @param resource $conn_identifier The CUBRID connection.
25473 * @return array An numeric array with all existing Cubrid databases;
25474 *   on success.
25475 * @since PECL CUBRID >= 8.3.0
25476 **/
25477function cubrid_list_dbs($conn_identifier){}
25478
25479/**
25480 * Read data from a GLO instance and save it in a file
25481 *
25482 * The {@link cubrid_load_from_glo} function is used to read a data from
25483 * a glo instance, and saves it in a designated file.
25484 *
25485 * @param resource $conn_identifier Connection identifier.
25486 * @param string $oid Oid of the glo instance that you want to read the
25487 *   data from.
25488 * @param string $file_name Name of the file where you want to save the
25489 *   data in.
25490 * @return int TRUE, when process is successful.
25491 * @since PECL CUBRID >= 8.3.0
25492 **/
25493function cubrid_load_from_glo($conn_identifier, $oid, $file_name){}
25494
25495/**
25496 * Bind a lob object or a string as a lob object to a prepared statement
25497 * as parameters
25498 *
25499 * The {@link cubrid_lob2_bind} function is used to bind BLOB/CLOB datas
25500 * to a corresponding question mark placeholder in the SQL statement that
25501 * was passed to {@link cubrid_prepare}. If {@link bind_value_type} is
25502 * not given, string will be "BLOB" as the default. But if you use {@link
25503 * cubrid_lob2_new} before, {@link bind_value_type} will be consistent
25504 * with {@link type} in {@link cubrid_lob2_new} as the default.
25505 *
25506 * @param resource $req_identifier Request identifier as a result of
25507 *   {@link cubrid_prepare}.
25508 * @param int $bind_index Location of binding parameters. It starts
25509 *   with 1.
25510 * @param mixed $bind_value Actual value for binding.
25511 * @param string $bind_value_type It must be "BLOB" or "CLOB" and it
25512 *   won't be case-sensitive. If it not be given, the default value is
25513 *   "BLOB".
25514 * @return bool TRUE, when process is successful.
25515 * @since PECL CUBRID >= 8.4.1
25516 **/
25517function cubrid_lob2_bind($req_identifier, $bind_index, $bind_value, $bind_value_type){}
25518
25519/**
25520 * Close LOB object
25521 *
25522 * The {@link cubrid_lob2_close} function is used to close LOB object
25523 * returned from {@link cubrid_lob2_new} or got from the result set.
25524 *
25525 * @param resource $lob_identifier Lob identifier as a result of {@link
25526 *   cubrid_lob2_new} or get from the result set.
25527 * @return bool TRUE, on success.
25528 * @since PECL CUBRID >= 8.4.1
25529 **/
25530function cubrid_lob2_close($lob_identifier){}
25531
25532/**
25533 * Export the lob object to a file
25534 *
25535 * The {@link cubrid_lob2_export} function is used to save the contents
25536 * of BLOB/CLOB data to a file. To use this function, you must use {@link
25537 * cubrid_lob2_new} or fetch a lob object from CUBRID database first. If
25538 * the file already exists, the operation will fail. This function will
25539 * not influence the cursor position of the lob object. It operates the
25540 * entire lob object.
25541 *
25542 * @param resource $lob_identifier Lob identifier as a result of {@link
25543 *   cubrid_lob2_new} or get from the result set.
25544 * @param string $file_name File name you want to store BLOB/CLOB data.
25545 *   It also supports the path of the file.
25546 * @return bool TRUE if the process is successful and FALSE for
25547 *   failure.
25548 * @since PECL CUBRID >= 8.4.1
25549 **/
25550function cubrid_lob2_export($lob_identifier, $file_name){}
25551
25552/**
25553 * Import BLOB/CLOB data from a file
25554 *
25555 * The {@link cubrid_lob2_import} function is used to save the contents
25556 * of BLOB/CLOB data from a file. To use this function, you must use
25557 * {@link cubrid_lob2_new} or fetch a lob object from CUBRID database
25558 * first. If the file already exists, the operation will fail. This
25559 * function will not influence the cursor position of the lob object. It
25560 * operates the entire lob object.
25561 *
25562 * @param resource $lob_identifier Lob identifier as a result of {@link
25563 *   cubrid_lob2_new} or get from the result set.
25564 * @param string $file_name File name you want to import BLOB/CLOB
25565 *   data. It also supports the path of the file.
25566 * @return bool TRUE if the process is successful and FALSE for
25567 *   failure.
25568 * @since PECL CUBRID >= 8.4.1
25569 **/
25570function cubrid_lob2_import($lob_identifier, $file_name){}
25571
25572/**
25573 * Create a lob object
25574 *
25575 * The {@link cubrid_lob2_new} function is used to create a lob object
25576 * (both BLOB and CLOB). This function should be used before you bind a
25577 * lob object.
25578 *
25579 * @param resource $conn_identifier Connection identifier. If the
25580 *   connection identifier is not specified, the last connection opened
25581 *   by {@link cubrid_connect} or {@link cubrid_connect_with_url} is
25582 *   assumed.
25583 * @param string $type It may be "BLOB" or "CLOB", it won't be
25584 *   case-sensitive. The default value is "BLOB".
25585 * @return resource Lob identifier when it is successful.
25586 * @since PECL CUBRID >= 8.4.1
25587 **/
25588function cubrid_lob2_new($conn_identifier, $type){}
25589
25590/**
25591 * Read from BLOB/CLOB data
25592 *
25593 * The {@link cubrid_lob2_read} function reads {@link len} bytes from the
25594 * LOB data and returns the bytes read.
25595 *
25596 * @param resource $lob_identifier Lob identifier as a result of {@link
25597 *   cubrid_lob2_new} or get from the result set.
25598 * @param int $len Length from buffer you want to read from the lob
25599 *   data.
25600 * @return string Returns the contents as a string.
25601 * @since PECL CUBRID >= 8.4.1
25602 **/
25603function cubrid_lob2_read($lob_identifier, $len){}
25604
25605/**
25606 * Move the cursor of a lob object
25607 *
25608 * The {@link cubrid_lob2_seek} function is used to move the cursor
25609 * position of a lob object by the value set in the {@link offset}
25610 * argument, to the direction set in the {@link origin} argument.
25611 *
25612 * To set the {@link origin} argument, you can use CUBRID_CURSOR_FIRST to
25613 * set the cursor position moving forward {@link offset} units from the
25614 * first beginning. In this case, {@link offset} must be a positive
25615 * value.
25616 *
25617 * If you use CUBRID_CURSOR_CURRENT for {@link origin}, you can move
25618 * forward or backward. and {@link offset} can be positive or negative.
25619 *
25620 * If you use CUBRID_CURSOR_LAST for {@link origin}, you can move
25621 * backward {@link offset} units from the end of LOB object and {@link
25622 * offset} only can be positive.
25623 *
25624 * @param resource $lob_identifier Lob identifier as a result of {@link
25625 *   cubrid_lob2_new} or get from the result set.
25626 * @param int $offset Number of units you want to move the cursor.
25627 * @param int $origin This parameter can be the following values:
25628 *   CUBRID_CURSOR_FIRST: move forward from the first beginning.
25629 *   CUBRID_CURSOR_CURRENT: move forward or backward from the current
25630 *   position. CUBRID_CURSOR_LAST: move backward at the end of LOB
25631 *   object.
25632 * @return bool TRUE if the process is successful and FALSE for
25633 *   failure.
25634 * @since PECL CUBRID >= 8.4.1
25635 **/
25636function cubrid_lob2_seek($lob_identifier, $offset, $origin){}
25637
25638/**
25639 * Move the cursor of a lob object
25640 *
25641 * The {@link cubrid_lob2_seek64} function is used to move the cursor
25642 * position of a lob object by the value set in the {@link offset}
25643 * argument, to the direction set in the {@link origin} argument. If the
25644 * {@link offset} you want to move is larger than an integer data can be
25645 * stored, you can use this function.
25646 *
25647 * To set the {@link origin} argument, you can use CUBRID_CURSOR_FIRST to
25648 * set the cursor position moving forward {@link offset} units from the
25649 * first beginning. In this case, {@link offset} must be a positive
25650 * value.
25651 *
25652 * If you use CUBRID_CURSOR_CURRENT for {@link origin}, you can move
25653 * forward or backward. and {@link offset} can be positive or negative.
25654 *
25655 * If you use CUBRID_CURSOR_LAST for {@link origin}, you can move
25656 * backward {@link offset} units from the end of LOB object and {@link
25657 * offset} only can be positive.
25658 *
25659 * @param resource $lob_identifier Lob identifier as a result of {@link
25660 *   cubrid_lob2_new} or get from the result set.
25661 * @param string $offset Number of units you want to move the cursor.
25662 * @param int $origin This parameter can be the following values:
25663 *   CUBRID_CURSOR_FIRST: move forward from the first beginning.
25664 *   CUBRID_CURSOR_CURRENT: move forward or backward from the current
25665 *   position. CUBRID_CURSOR_LAST: move backward at the end of LOB
25666 *   object.
25667 * @return bool TRUE if the process is successful and FALSE for
25668 *   failure.
25669 * @since PECL CUBRID >= 8.4.1
25670 **/
25671function cubrid_lob2_seek64($lob_identifier, $offset, $origin){}
25672
25673/**
25674 * Get a lob object's size
25675 *
25676 * The {@link cubrid_lob2_size} function is used to get the size of a lob
25677 * object.
25678 *
25679 * @param resource $lob_identifier Lob identifier as a result of {@link
25680 *   cubrid_lob2_new} or get from the result set.
25681 * @return int It will return the size of the LOB object when it
25682 *   processes successfully.
25683 * @since PECL CUBRID >= 8.4.1
25684 **/
25685function cubrid_lob2_size($lob_identifier){}
25686
25687/**
25688 * Get a lob object's size
25689 *
25690 * The {@link cubrid_lob2_size64} function is used to get the size of a
25691 * lob object. If the size of a lob object is larger than an integer data
25692 * can be stored, you can use this function and it will return the size
25693 * as a string.
25694 *
25695 * @param resource $lob_identifier Lob identifier as a result of {@link
25696 *   cubrid_lob2_new} or get from the result set.
25697 * @return string It will return the size of the LOB object as a string
25698 *   when it processes successfully.
25699 * @since PECL CUBRID >= 8.4.1
25700 **/
25701function cubrid_lob2_size64($lob_identifier){}
25702
25703/**
25704 * Tell the cursor position of the LOB object
25705 *
25706 * The {@link cubrid_lob2_tell} function is used to tell the cursor
25707 * position of the LOB object.
25708 *
25709 * @param resource $lob_identifier Lob identifier as a result of {@link
25710 *   cubrid_lob2_new} or get from the result set.
25711 * @return int It will return the cursor position on the LOB object
25712 *   when it processes successfully.
25713 * @since PECL CUBRID >= 8.4.1
25714 **/
25715function cubrid_lob2_tell($lob_identifier){}
25716
25717/**
25718 * Tell the cursor position of the LOB object
25719 *
25720 * The {@link cubrid_lob2_tell64} function is used to tell the cursor
25721 * position of the LOB object. If the size of a lob object is larger than
25722 * an integer data can be stored, you can use this function and it will
25723 * return the position information as a string.
25724 *
25725 * @param resource $lob_identifier Lob identifier as a result of {@link
25726 *   cubrid_lob2_new} or get from the result set.
25727 * @return string It will return the cursor position on the LOB object
25728 *   as a string when it processes successfully.
25729 * @since PECL CUBRID >= 8.4.1
25730 **/
25731function cubrid_lob2_tell64($lob_identifier){}
25732
25733/**
25734 * Write to a lob object
25735 *
25736 * The {@link cubrid_lob2_write} function reads as much as data from
25737 * {@link buf} and stores it to the LOB object. Note that this function
25738 * can only append characters now.
25739 *
25740 * @param resource $lob_identifier Lob identifier as a result of {@link
25741 *   cubrid_lob2_new} or get from the result set.
25742 * @param string $buf Data that need to be written to the lob object.
25743 * @return bool TRUE if the process is successful and FALSE for
25744 *   failure.
25745 * @since PECL CUBRID >= 8.4.1
25746 **/
25747function cubrid_lob2_write($lob_identifier, $buf){}
25748
25749/**
25750 * Close BLOB/CLOB data
25751 *
25752 * {@link cubrid_lob_close} is used to close all BLOB/CLOB returned from
25753 * {@link cubrid_lob_get}.
25754 *
25755 * @param array $lob_identifier_array LOB identifier array return from
25756 *   cubrid_lob_get.
25757 * @return bool TRUE, when process is successful.
25758 * @since PECL CUBRID >= 8.3.1
25759 **/
25760function cubrid_lob_close($lob_identifier_array){}
25761
25762/**
25763 * Export BLOB/CLOB data to file
25764 *
25765 * {@link cubrid_lob_export} is used to get BLOB/CLOB data from CUBRID
25766 * database, and saves its contents to a file. To use this function, you
25767 * must use {@link cubrid_lob_get} first to get BLOB/CLOB info from
25768 * CUBRID.
25769 *
25770 * @param resource $conn_identifier Connection identifier.
25771 * @param resource $lob_identifier LOB identifier.
25772 * @param string $path_name Path name of the file.
25773 * @return bool TRUE, when process is successful.
25774 * @since PECL CUBRID >= 8.3.1
25775 **/
25776function cubrid_lob_export($conn_identifier, $lob_identifier, $path_name){}
25777
25778/**
25779 * Get BLOB/CLOB data
25780 *
25781 * {@link cubrid_lob_get} is used to get BLOB/CLOB meta info from CUBRID
25782 * database, CUBRID gets BLOB/CLOB by executing the SQL statement, and
25783 * returns all LOBs as a resource array. Be sure that the SQL retrieves
25784 * only one column and its data type is BLOB or CLOB.
25785 *
25786 * Remember to use {@link cubrid_lob_close} to release the LOBs if you
25787 * don't need it any more.
25788 *
25789 * @param resource $conn_identifier Connection identifier.
25790 * @param string $sql SQL statement to be executed.
25791 * @return array Return an array of LOB resources, when process is
25792 *   successful.
25793 * @since PECL CUBRID >= 8.3.1
25794 **/
25795function cubrid_lob_get($conn_identifier, $sql){}
25796
25797/**
25798 * Read BLOB/CLOB data and send straight to browser
25799 *
25800 * {@link cubrid_lob_send} reads BLOB/CLOB data and passes it straight
25801 * through to the browser. To use this function, you must use {@link
25802 * cubrid_lob_get} first to get BLOB/CLOB info from CUBRID.
25803 *
25804 * @param resource $conn_identifier Connection identifier.
25805 * @param resource $lob_identifier LOB identifier.
25806 * @return bool TRUE, when process is successful.
25807 * @since PECL CUBRID >= 8.3.1
25808 **/
25809function cubrid_lob_send($conn_identifier, $lob_identifier){}
25810
25811/**
25812 * Get BLOB/CLOB data size
25813 *
25814 * {@link cubrid_lob_size} is used to get BLOB/CLOB data size.
25815 *
25816 * @param resource $lob_identifier LOB identifier.
25817 * @return string A string representing LOB data size, when process is
25818 *   successful.
25819 * @since PECL CUBRID >= 8.3.1
25820 **/
25821function cubrid_lob_size($lob_identifier){}
25822
25823/**
25824 * Set a read lock on the given OID
25825 *
25826 * The {@link cubrid_lock_read} function is used to put read lock on the
25827 * instance pointed by given {@link oid}.
25828 *
25829 * @param resource $conn_identifier Connection identifier.
25830 * @param string $oid OID of the instance that you want to put read
25831 *   lock on.
25832 * @return bool TRUE, when process is successful.
25833 * @since PECL CUBRID >= 8.3.0
25834 **/
25835function cubrid_lock_read($conn_identifier, $oid){}
25836
25837/**
25838 * Set a write lock on the given OID
25839 *
25840 * The {@link cubrid_lock_write} function is used to put write lock on
25841 * the instance pointed by the given {@link oid}.
25842 *
25843 * @param resource $conn_identifier Connection identifier.
25844 * @param string $oid OID of the instance that you want to put write
25845 *   lock on.
25846 * @return bool TRUE, when process is successful.
25847 * @since PECL CUBRID >= 8.3.0
25848 **/
25849function cubrid_lock_write($conn_identifier, $oid){}
25850
25851/**
25852 * Move the cursor in the result
25853 *
25854 * The {@link cubrid_move_cursor} function is used to move the current
25855 * cursor location of {@link req_identifier} by the value set in the
25856 * {@link offset} argument, to the direction set in the {@link origin}
25857 * argument. To set the {@link origin} argument, you can use
25858 * CUBRID_CURSOR_FIRST for the first part of the result,
25859 * CUBRID_CURSOR_CURRENT for the current location of the result, or
25860 * CUBRID_CURSOR_LAST for the last part of the result. If {@link origin}
25861 * argument is not explicitly designated, then the function uses
25862 * CUBRID_CURSOR_CURRENT as its default value.
25863 *
25864 * If the value of cursor movement range goes over the valid limit, then
25865 * the cursor moves to the next location after the valid range for the
25866 * cursor. For example, if you move 20 units in the result with the size
25867 * of 10, then the cursor will move to 11th place and return
25868 * CUBRID_NO_MORE_DATA.
25869 *
25870 * @param resource $req_identifier Request identifier.
25871 * @param int $offset Number of units you want to move the cursor.
25872 * @param int $origin Location where you want to move the cursor from
25873 *   CUBRID_CURSOR_FIRST, CUBRID_CURSOR_CURRENT, CUBRID_CURSOR_LAST.
25874 * @return bool TRUE, when process is successful.
25875 * @since PECL CUBRID >= 8.3.0
25876 **/
25877function cubrid_move_cursor($req_identifier, $offset, $origin){}
25878
25879/**
25880 * Create a glo instance
25881 *
25882 * The {@link cubrid_new_glo} function is used to create a glo instance
25883 * in the requested class (glo class). The glo created is a LO type, and
25884 * is stored in the {@link file_name} file.
25885 *
25886 * @param resource $conn_identifier Connection identifier.
25887 * @param string $class_name Name of the class that you want to create
25888 *   a glo in.
25889 * @param string $file_name The file name that you want to save in the
25890 *   newly created glo.
25891 * @return string Oid of the instance created, when process is
25892 *   successful.
25893 * @since PECL CUBRID >= 8.3.0
25894 **/
25895function cubrid_new_glo($conn_identifier, $class_name, $file_name){}
25896
25897/**
25898 * Get result of next query when executing multiple SQL statements
25899 *
25900 * The {@link cubrid_next_result} function is used to get results of next
25901 * query if multiple SQL statements are executed and
25902 * CUBRID_EXEC_QUERY_ALL flag is set upon {@link cubrid_execute}.
25903 *
25904 * @param resource $result {@link result} comes from a call to {@link
25905 *   cubrid_execute}
25906 * @return bool TRUE, when process is successful.
25907 * @since PECL CUBRID >= 8.4.0
25908 **/
25909function cubrid_next_result($result){}
25910
25911/**
25912 * Return the number of columns in the result set
25913 *
25914 * The {@link cubrid_num_cols} function is used to get the number of
25915 * columns from the query result. It can only be used when the query
25916 * executed is a select statement.
25917 *
25918 * @param resource $result Result.
25919 * @return int Number of columns, when process is successful.
25920 * @since PECL CUBRID >= 8.3.0
25921 **/
25922function cubrid_num_cols($result){}
25923
25924/**
25925 * Return the number of columns in the result set
25926 *
25927 * This function returns the number of columns in the result set, on
25928 * success, or it returns FALSE on failure.
25929 *
25930 * @param resource $result {@link result} comes from a call to {@link
25931 *   cubrid_execute}, {@link cubrid_query} and {@link cubrid_prepare}
25932 * @return int Number of columns, on success.
25933 * @since PECL CUBRID >= 8.3.0
25934 **/
25935function cubrid_num_fields($result){}
25936
25937/**
25938 * Get the number of rows in the result set
25939 *
25940 * The {@link cubrid_num_rows} function is used to get the number of rows
25941 * from the query result. You can use it only when the query executed is
25942 * a select statement. When you want to know such value for INSERT,
25943 * UPDATE, or DELETE query, you have to use the {@link
25944 * cubrid_affected_rows} function.
25945 *
25946 * Note: The {@link cubrid_num_rows} function can only be used for
25947 * synchronous query; it returns 0 when it is used for asynchronous
25948 * query.
25949 *
25950 * @param resource $result {@link result} comes from a call to {@link
25951 *   cubrid_execute}, {@link cubrid_query} and {@link cubrid_prepare}
25952 * @return int Number of rows, when process is successful.
25953 * @since PECL CUBRID >= 8.3.0
25954 **/
25955function cubrid_num_rows($result){}
25956
25957/**
25958 * Open a persistent connection to a CUBRID server
25959 *
25960 * Establishes a persistent connection to a CUBRID server.
25961 *
25962 * {@link cubrid_pconnect} acts very much like {@link cubrid_connect}
25963 * with two major differences.
25964 *
25965 * First, when connecting, the function would first try to find a
25966 * (persistent) link that's already open with the same host, port, dbname
25967 * and userid. If one is found, an identifier for it will be returned
25968 * instead of opening a new connection.
25969 *
25970 * Second, the connection to the SQL server will not be closed when the
25971 * execution of the script ends. Instead, the link will remain open for
25972 * future use ({@link cubrid_close} or {@link cubrid_disconnect} will not
25973 * close links established by {@link cubrid_pconnect}).
25974 *
25975 * This type of link is therefore called 'persistent'.
25976 *
25977 * @param string $host Host name or IP address of CUBRID CAS server.
25978 * @param int $port Port number of CUBRID CAS server (BROKER_PORT
25979 *   configured in $CUBRID/conf/cubrid_broker.conf).
25980 * @param string $dbname Name of database.
25981 * @param string $userid User name for the database.
25982 * @param string $passwd User password.
25983 * @return resource Connection identifier, when process is successful.
25984 * @since PECL CUBRID >= 8.3.1
25985 **/
25986function cubrid_pconnect($host, $port, $dbname, $userid, $passwd){}
25987
25988/**
25989 * Open a persistent connection to CUBRID server
25990 *
25991 * Establishes a persistent connection to a CUBRID server.
25992 *
25993 * {@link cubrid_pconnect_with_url} acts very much like {@link
25994 * cubrid_connect_with_url} with two major differences.
25995 *
25996 * First, when connecting, the function would first try to find a
25997 * (persistent) link that's already open with the same host, port, dbname
25998 * and userid. If one is found, an identifier for it will be returned
25999 * instead of opening a new connection.
26000 *
26001 * Second, the connection to the SQL server will not be closed when the
26002 * execution of the script ends. Instead, the link will remain open for
26003 * future use ({@link cubrid_close} or {@link cubrid_disconnect} will not
26004 * close links established by {@link cubrid_pconnect_with_url}).
26005 *
26006 * This type of link is therefore called 'persistent'.
26007 *
26008 * <url> ::=
26009 * CUBRID:<host>:<db_name>:<db_user>:<db_password>:[?<properties>]
26010 *
26011 * <properties> ::= <property> [&<property>]
26012 *
26013 * <properties> ::= alhosts=<alternative_hosts>[ &rctime=<time>]
26014 *
26015 * <properties> ::= login_timeout=<milli_sec>
26016 *
26017 * <properties> ::= query_timeout=<milli_sec>
26018 *
26019 * <properties> ::= disconnect_on_query_timeout=true|false
26020 *
26021 * <alternative_hosts> ::= <standby_broker1_host>:<port>
26022 * [,<standby_broker2_host>:<port>]
26023 *
26024 * <host> := HOSTNAME | IP_ADDR
26025 *
26026 * <time> := SECOND
26027 *
26028 * <milli_sec> := MILLI SECOND
26029 *
26030 * host : A host name or IP address of the master database db_name : A
26031 * name of the database db_user : A name of the database user db_password
26032 * : A database user password alhosts : Specifies the broker information
26033 * of the standby server, which is used for failover when it is
26034 * impossible to connect to the active server. You can specify multiple
26035 * brokers for failover, and the connection to the brokers is attempted
26036 * in the order listed in alhosts rctime : An interval between the
26037 * attempts to connect to the active broker in which failure occurred.
26038 * After a failure occurs, the system connects to the broker specified by
26039 * althosts (failover), terminates the transaction, and then attempts to
26040 * connect to the active broker of the master database at every rctime.
26041 * The default value is 600 seconds. login_timeout : Timeout value (unit:
26042 * msec.) for database login. The default value is 0, which means
26043 * infinite postponement. query_timeout : Timeout value (unit: msec.) for
26044 * query request. Upon timeout, a message to cancel requesting a query
26045 * transferred to server is sent. The return value can depend on the
26046 * disconnect_on_query_timeout configuration; even though the message to
26047 * cancel a request is sent to server, that request may succeed.
26048 * disconnect_on_query_timeout : Configures a value whether to
26049 * immediately return an error of function being executed upon timeout.
26050 * The default value is false.
26051 *
26052 * @param string $conn_url A character string that contains server
26053 *   connection information.
26054 * @param string $userid User name for the database.
26055 * @param string $passwd User password.
26056 * @return resource Connection identifier, when process is successful.
26057 * @since PECL CUBRID >= 8.3.1
26058 **/
26059function cubrid_pconnect_with_url($conn_url, $userid, $passwd){}
26060
26061/**
26062 * Ping a server connection or reconnect if there is no connection
26063 *
26064 * Checks whether or not the connection to the server is working.
26065 *
26066 * @param resource $conn_identifier The CUBRID connection identifier.
26067 *   If the connection identifier is not specified, the last connection
26068 *   opened by {@link cubrid_connect} is assumed.
26069 * @return bool Returns TRUE if the connection to the server CUBRID
26070 *   server is working, otherwise FALSE.
26071 * @since PECL CUBRID >= 8.3.1
26072 **/
26073function cubrid_ping($conn_identifier){}
26074
26075/**
26076 * Prepare a SQL statement for execution
26077 *
26078 * The {@link cubrid_prepare} function is a sort of API which represents
26079 * SQL statements compiled previously to a given connection handle. This
26080 * pre-compiled SQL statement will be included in the {@link
26081 * cubrid_prepare}.
26082 *
26083 * Accordingly, you can use this statement effectively to execute several
26084 * times repeatedly or to process long data. Only a single statement can
26085 * be used and a parameter may put a question mark (?) to appropriate
26086 * area in the SQL statement. Add a parameter when you bind a value in
26087 * the VALUES clause of INSERT statement or in the WHERE clause. Note
26088 * that it is allowed to bind a value to a MARK(?) by using the {@link
26089 * cubrid_bind} function only.
26090 *
26091 * @param resource $conn_identifier Connection identifier.
26092 * @param string $prepare_stmt Prepare query.
26093 * @param int $option OID return option CUBRID_INCLUDE_OID.
26094 * @return resource Request identifier, if process is successful;
26095 * @since PECL CUBRID >= 8.3.0
26096 **/
26097function cubrid_prepare($conn_identifier, $prepare_stmt, $option){}
26098
26099/**
26100 * Update a column using OID
26101 *
26102 * The {@link cubrid_put} function is used to update an attribute of the
26103 * instance of the given {@link oid}.
26104 *
26105 * You can update single attribute by using string data type to set
26106 * {@link attr}. In such case, you can use integer, floating point or
26107 * string type data for the {@link value} argument. To update multiple
26108 * number of attributes, you can disregard the {@link attr} argument, and
26109 * set {@link value} argument with associative array data type.
26110 *
26111 * @param resource $conn_identifier Connection identifier.
26112 * @param string $oid OID of the instance that you want to update.
26113 * @param string $attr Name of the attribute that you want to update.
26114 * @param mixed $value New value that you want to assign to the
26115 *   attribute.
26116 * @return bool TRUE, when process is successful.
26117 * @since PECL CUBRID >= 8.3.0
26118 **/
26119function cubrid_put($conn_identifier, $oid, $attr, $value){}
26120
26121/**
26122 * Send a CUBRID query
26123 *
26124 * {@link cubrid_query} sends a unique query (multiple queries are not
26125 * supported) to the currently active database on the server that's
26126 * associated with the specified {@link conn_identifier}.
26127 *
26128 * @param string $query An SQL query Data inside the query should be
26129 *   properly escaped.
26130 * @param resource $conn_identifier The CUBRID connection. If the
26131 *   connection identifier is not specified, the last connection opened
26132 *   by {@link cubrid_connect} is assumed.
26133 * @return resource For SELECT, SHOW, DESCRIBE, EXPLAIN and other
26134 *   statements returning resultset, {@link cubrid_query} returns a
26135 *   resource on success, or FALSE on error.
26136 * @since PECL CUBRID >= 8.3.1
26137 **/
26138function cubrid_query($query, $conn_identifier){}
26139
26140/**
26141 * Escape special characters in a string for use in an SQL statement
26142 *
26143 * This function returns the escaped string version of the given string.
26144 * It will escape the following characters: '.
26145 *
26146 * In general, single quotations are used to enclose character string.
26147 * Double quotations may be used as well depending on the value of
26148 * ansi_quotes, which is a parameter related to SQL statement. If the
26149 * ansi_quotes value is set to no, character string enclosed by double
26150 * quotations is handled as character string, not as an identifier. The
26151 * default value is yes.
26152 *
26153 * If you want to include a single quote as part of a character string,
26154 * enter two single quotes in a row.
26155 *
26156 * @param string $unescaped_string The string that is to be escaped.
26157 * @param resource $conn_identifier The CUBRID connection. If the
26158 *   connection identifier is not specified, the last connection opened
26159 *   by {@link cubrid_connect} is assumed.
26160 * @return string Escaped string version of the given string, on
26161 *   success.
26162 * @since PECL CUBRID >= 8.3.0
26163 **/
26164function cubrid_real_escape_string($unescaped_string, $conn_identifier){}
26165
26166/**
26167 * Return the value of a specific field in a specific row
26168 *
26169 * This function returns the value of a specific field in a specific row
26170 * from a result set.
26171 *
26172 * @param resource $result {@link result} comes from a call to {@link
26173 *   cubrid_execute}
26174 * @param int $row The row number from the result that is being
26175 *   retrieved. Row numbers start at 0.
26176 * @param mixed $field The name or offset of the {@link field} being
26177 *   retrieved. It can be the field's offset, the field's name, or the
26178 *   field's table dot field name (tablename.fieldname). If the column
26179 *   name has been aliased ('select foo as bar from...'), use the alias
26180 *   instead of the column name. If undefined, the first field is
26181 *   retrieved.
26182 * @return string Value of a specific field, on success (NULL if value
26183 *   if null).
26184 * @since PECL CUBRID >= 8.3.0
26185 **/
26186function cubrid_result($result, $row, $field){}
26187
26188/**
26189 * Roll back a transaction
26190 *
26191 * The {@link cubrid_rollback} function executes rollback on the
26192 * transaction pointed by {@link conn_identifier}, currently in progress.
26193 *
26194 * Connection to server is closed after calling {@link cubrid_rollback}.
26195 * Connection handle, however, is still valid.
26196 *
26197 * @param resource $conn_identifier Connection identifier.
26198 * @return bool TRUE, when process is successful.
26199 * @since PECL CUBRID >= 8.3.0
26200 **/
26201function cubrid_rollback($conn_identifier){}
26202
26203/**
26204 * Save requested file in a GLO instance
26205 *
26206 * The {@link cubrid_save_to_glo} function is used to save requested file
26207 * in a glo instance.
26208 *
26209 * @param resource $conn_identifier Connection identifier.
26210 * @param string $oid Oid of the glo instance that you want to save a
26211 *   file in.
26212 * @param string $file_name The name of the file that you want to save.
26213 * @return int TRUE, when process is successful.
26214 * @since PECL CUBRID >= 8.3.0
26215 **/
26216function cubrid_save_to_glo($conn_identifier, $oid, $file_name){}
26217
26218/**
26219 * Get the requested schema information
26220 *
26221 * The {@link cubrid_schema} function is used to get the requested schema
26222 * information from database. You have to designate {@link class_name},
26223 * if you want to get information on certain class, {@link attr_name}, if
26224 * you want to get information on certain attribute (can be used only
26225 * with CUBRID_ SCH_ATTR_PRIVILEGE).
26226 *
26227 * The result of the cubrid_schema function is returned as a
26228 * two-dimensional array (column (associative array) * row (numeric
26229 * array)). The following tables shows types of schema and the column
26230 * structure of the result array to be returned based on the schema type.
26231 *
26232 * Result Composition of Each Type Schema Column Number Column Name Value
26233 * CUBRID_SCH_CLASS 1 NAME 2 TYPE 0:system class 1:vclass 2:class
26234 *
26235 * CUBRID_SCH_VCLASS 1 NAME 2 TYPE 1:vclass
26236 *
26237 * CUBRID_SCH_QUERY_SPEC 1 QUERY_SPEC
26238 *
26239 * CUBRID_SCH_ATTRIBUTE / CUBRID_SCH_CLASS_ATTRIBUTE 1 ATTR_NAME 2 DOMAIN
26240 * 3 SCALE 4 PRECISION 5 INDEXED 1:indexed 6 NOT NULL 1:not null 7 SHARED
26241 * 1:shared 8 UNIQUE 1:unique 9 DEFAULT 10 ATTR_ORDER base:1 11
26242 * CLASS_NAME 12 SOURCE_CLASS 13 IS_KEY 1:key
26243 *
26244 * CUBRID_SCH_METHOD / CUBRID_SCH_CLASS_METHOD 1 NAME 2 RET_DOMAIN 3
26245 * ARG_DOMAIN
26246 *
26247 * CUBRID_SCH_METHOD_FILE 1 METHOD_FILE
26248 *
26249 * CUBRID_SCH_SUPERCLASS / CUBRID_SCH_DIRECT_SUPER_CLASS /
26250 * CUBRID_SCH_SUBCLASS 1 CLASS_NAME 2 TYPE 0:system class 1:vclass
26251 * 2:class
26252 *
26253 * CUBRID_SCH_CONSTRAINT 1 TYPE 0:unique 1:index 2:reverse unique
26254 * 3:reverse index 2 NAME 3 ATTR_NAME 4 NUM_PAGES 5 NUM_KEYS 6
26255 * PRIMARY_KEY 1:primary key 7 KEY_ORDER base:1
26256 *
26257 * CUBRID_SCH_TRIGGER 1 NAME 2 STATUS 3 EVENT 4 TARGET_CLASS 5
26258 * TARGET_ATTR 6 ACTION_TIME 7 ACTION 8 PRIORITY 9 CONDITION_TIME 10
26259 * CONDITION
26260 *
26261 * CUBRID_SCH_CLASS_PRIVILEGE / CUBRID_SCH_ATTR_PRIVILEGE 1 CLASS_NAME /
26262 * ATTR_NAME 2 PRIVILEGE 3 GRANTABLE
26263 *
26264 * CUBRID_SCH_PRIMARY_KEY 1 CLASS_NAME 2 ATTR_NAME 3 KEY_SEQ base:1 4
26265 * KEY_NAME
26266 *
26267 * CUBRID_SCH_IMPORTED_KEYS / CUBRID_SCH_EXPORTED_KEYS /
26268 * CUBRID_SCH_CROSS_REFERENCE 1 PKTABLE_NAME 2 PKCOLUMN_NAME 3
26269 * FKTABLE_NAME base:1 4 FKCOLUMN_NAME 5 KEY_SEQ base:1 6 UPDATE_ACTION
26270 * 0:cascade 1:restrict 2:no action 3:set null 7 DELETE_ACTION 0:cascade
26271 * 1:restrict 2:no action 3:set null 8 FK_NAME 9 PK_NAME
26272 *
26273 * @param resource $conn_identifier Connection identifier.
26274 * @param int $schema_type Schema data that you want to know.
26275 * @param string $class_name Class you want to know the schema of.
26276 * @param string $attr_name Attribute you want to know the schema of.
26277 * @return array Array containing the schema information, when process
26278 *   is successful;
26279 * @since PECL CUBRID >= 8.3.0
26280 **/
26281function cubrid_schema($conn_identifier, $schema_type, $class_name, $attr_name){}
26282
26283/**
26284 * Read data from glo and send it to std output
26285 *
26286 * The {@link cubrid_send_glo} function is used to read data from glo
26287 * instance and sends it to the PHP standard output.
26288 *
26289 * @param resource $conn_identifier Connection identifier.
26290 * @param string $oid Oid of the glo instance that you want to read
26291 *   data from.
26292 * @return int TRUE, when process is successful.
26293 * @since PECL CUBRID >= 8.3.0
26294 **/
26295function cubrid_send_glo($conn_identifier, $oid){}
26296
26297/**
26298 * Delete an element from sequence type column using OID
26299 *
26300 * The {@link cubrid_seq_drop} function is used to delete an element you
26301 * request from the given sequence type attribute in the database.
26302 *
26303 * @param resource $conn_identifier Connection identifier.
26304 * @param string $oid OID of the instance you want to work with.
26305 * @param string $attr_name Name of the attribute that you want to
26306 *   delete an element from.
26307 * @param int $index Index of the element that you want to delete
26308 *   (1-based).
26309 * @return bool TRUE, when process is successful.
26310 * @since PECL CUBRID >= 8.3.0
26311 **/
26312function cubrid_seq_drop($conn_identifier, $oid, $attr_name, $index){}
26313
26314/**
26315 * Insert an element to a sequence type column using OID
26316 *
26317 * The {@link cubrid_col_insert} function is used to insert an element to
26318 * a sequence type attribute in a requested location.
26319 *
26320 * @param resource $conn_identifier Connection identifier.
26321 * @param string $oid OID of the instance you want to work with.
26322 * @param string $attr_name Name of the attribute you want to insert an
26323 *   instance to.
26324 * @param int $index Location of the element, you want to insert the
26325 *   element to (1-based).
26326 * @param string $seq_element Content of the element that you want to
26327 *   insert.
26328 * @return bool TRUE, when process is successful.
26329 * @since PECL CUBRID >= 8.3.0
26330 **/
26331function cubrid_seq_insert($conn_identifier, $oid, $attr_name, $index, $seq_element){}
26332
26333/**
26334 * Update the element value of sequence type column using OID
26335 *
26336 * The {@link cubrid_seq_put} function is used to update the content of
26337 * the requested element in a sequent type attribute using OID.
26338 *
26339 * @param resource $conn_identifier Connection identifier.
26340 * @param string $oid OID of the instance you want to work with.
26341 * @param string $attr_name Name of the attribute that you want to
26342 *   update an element.
26343 * @param int $index Index (1-based) of the element that you want to
26344 *   update.
26345 * @param string $seq_element New content that you want to use for the
26346 *   update.
26347 * @return bool TRUE, when process is successful.
26348 * @since PECL CUBRID >= 8.3.0
26349 **/
26350function cubrid_seq_put($conn_identifier, $oid, $attr_name, $index, $seq_element){}
26351
26352/**
26353 * Insert a single element to set type column using OID
26354 *
26355 * The {@link cubrid_set_add} function is used to insert a single element
26356 * to a set type attribute (set, multiset, sequence) you requested.
26357 *
26358 * @param resource $conn_identifier Connection identifier.
26359 * @param string $oid OID of the instance you want to work with.
26360 * @param string $attr_name Name of the attribute you want to insert an
26361 *   element.
26362 * @param string $set_element Content of the element you want to
26363 *   insert.
26364 * @return bool TRUE, when process is successful.
26365 * @since PECL CUBRID >= 8.3.0
26366 **/
26367function cubrid_set_add($conn_identifier, $oid, $attr_name, $set_element){}
26368
26369/**
26370 * Set autocommit mode of the connection
26371 *
26372 * The {@link cubrid_set_autocommit} function is used to set the CUBRID
26373 * database auto-commit mode of the current database connection.
26374 *
26375 * In CUBRID PHP, auto-commit mode is disabled by default for transaction
26376 * management. When auto-commit mode is truned from off to on, any
26377 * pending work is automatically committed.
26378 *
26379 * @param resource $conn_identifier Connection identifier.
26380 * @param bool $mode Auto-commit mode. The following constants can be
26381 *   used:
26382 *
26383 *   CUBRID_AUTOCOMMIT_FALSE CUBRID_AUTOCOMMIT_TRUE
26384 * @return bool TRUE, when process is successful.
26385 * @since PECL CUBRID >= 8.4.0
26386 **/
26387function cubrid_set_autocommit($conn_identifier, $mode){}
26388
26389/**
26390 * Sets the CUBRID database parameters
26391 *
26392 * The {@link cubrid_set_db_parameter} function is used to set the CUBRID
26393 * database parameters. It can set the following CUBRID database
26394 * parameters:
26395 *
26396 * PARAM_ISOLATION_LEVEL PARAM_LOCK_TIMEOUT
26397 *
26398 * @param resource $conn_identifier The CUBRID connection. If the
26399 *   connection identifier is not specified, the last link opened by
26400 *   {@link cubrid_connect} is assumed.
26401 * @param int $param_type Database parameter type.
26402 * @param int $param_value Isolation level value (1-6) or lock timeout
26403 *   (in seconds) value.
26404 * @return bool TRUE on success.
26405 * @since PECL CUBRID >= 8.4.0
26406 **/
26407function cubrid_set_db_parameter($conn_identifier, $param_type, $param_value){}
26408
26409/**
26410 * Delete an element from set type column using OID
26411 *
26412 * The {@link cubrid_set_drop} function is used to delete an element that
26413 * you request from the given set type (set, multiset) attribute of the
26414 * database.
26415 *
26416 * @param resource $conn_identifier Connection identifier.
26417 * @param string $oid OID of the instance you want to work with.
26418 * @param string $attr_name Name of the attribute you want to delete an
26419 *   element from.
26420 * @param string $set_element Content of the element you want to
26421 *   delete.
26422 * @return bool TRUE, when process is successful.
26423 * @since PECL CUBRID >= 8.3.0
26424 **/
26425function cubrid_set_drop($conn_identifier, $oid, $attr_name, $set_element){}
26426
26427/**
26428 * Set the timeout time of query execution
26429 *
26430 * The {@link cubrid_set_query_timeout} function is used to set the
26431 * timeout time of query execution.
26432 *
26433 * @param resource $req_identifier Request identifier.
26434 * @param int $timeout Timeout time, unit of msec.
26435 * @return bool TRUE, when process is successful.
26436 * @since PECL CUBRID >= 8.4.1
26437 **/
26438function cubrid_set_query_timeout($req_identifier, $timeout){}
26439
26440/**
26441 * Perform a query without fetching the results into memory
26442 *
26443 * This function performs a query without waiting for that all query
26444 * results have been complete. It will return when the results are being
26445 * generated.
26446 *
26447 * @param string $query A SQL query.
26448 * @param resource $conn_identifier The CUBRID connection. If the
26449 *   connection identifier is not specified, the last connection opened
26450 *   by {@link cubrid_connect} is assumed.
26451 * @return resource For SELECT, SHOW, DESCRIBE or EXPLAIN statements
26452 *   returns a request identifier resource on success.
26453 * @since PECL CUBRID >= 8.3.0
26454 **/
26455function cubrid_unbuffered_query($query, $conn_identifier){}
26456
26457/**
26458 * Get the CUBRID PHP module's version
26459 *
26460 * The {@link cubrid_version} function is used to get the CUBRID PHP
26461 * module's version.
26462 *
26463 * @return string Version information (eg. "8.3.1.0001").
26464 * @since PECL CUBRID >= 8.3.0
26465 **/
26466function cubrid_version(){}
26467
26468/**
26469 * Close a cURL session
26470 *
26471 * Closes a cURL session and frees all resources. The cURL handle, {@link
26472 * ch}, is also deleted.
26473 *
26474 * @param resource $ch
26475 * @return void
26476 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
26477 **/
26478function curl_close($ch){}
26479
26480/**
26481 * Copy a cURL handle along with all of its preferences
26482 *
26483 * Copies a cURL handle keeping the same preferences.
26484 *
26485 * @param resource $ch
26486 * @return resource Returns a new cURL handle.
26487 * @since PHP 5, PHP 7
26488 **/
26489function curl_copy_handle($ch){}
26490
26491/**
26492 * Return the last error number
26493 *
26494 * Returns the error number for the last cURL operation.
26495 *
26496 * @param resource $ch
26497 * @return int Returns the error number or 0 (zero) if no error
26498 *   occurred.
26499 * @since PHP 4 >= 4.0.3, PHP 5, PHP 7
26500 **/
26501function curl_errno($ch){}
26502
26503/**
26504 * Return a string containing the last error for the current session
26505 *
26506 * Returns a clear text error message for the last cURL operation.
26507 *
26508 * @param resource $ch
26509 * @return string Returns the error message or '' (the empty string) if
26510 *   no error occurred.
26511 * @since PHP 4 >= 4.0.3, PHP 5, PHP 7
26512 **/
26513function curl_error($ch){}
26514
26515/**
26516 * URL encodes the given string
26517 *
26518 * This function URL encodes the given string according to RFC 3986.
26519 *
26520 * @param resource $ch The string to be encoded.
26521 * @param string $str
26522 * @return string Returns escaped string.
26523 * @since PHP 5 >= 5.5.0, PHP 7
26524 **/
26525function curl_escape($ch, $str){}
26526
26527/**
26528 * Perform a cURL session
26529 *
26530 * Execute the given cURL session.
26531 *
26532 * This function should be called after initializing a cURL session and
26533 * all the options for the session are set.
26534 *
26535 * @param resource $ch
26536 * @return mixed However, if the CURLOPT_RETURNTRANSFER option is set,
26537 *   it will return the result on success, FALSE on failure.
26538 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
26539 **/
26540function curl_exec($ch){}
26541
26542/**
26543 * Create a CURLFile object
26544 *
26545 * Creates a CURLFile object, used to upload a file with
26546 * CURLOPT_POSTFIELDS.
26547 *
26548 * @param string $filename Path to the file which will be uploaded.
26549 * @param string $mimetype Mimetype of the file.
26550 * @param string $postname Name of the file to be used in the upload
26551 *   data.
26552 * @return CURLFile Returns a CURLFile object.
26553 * @since PHP 5 >= 5.5.0, PHP 7
26554 **/
26555function curl_file_create($filename, $mimetype, $postname){}
26556
26557/**
26558 * Get information regarding a specific transfer
26559 *
26560 * Gets information about the last transfer.
26561 *
26562 * @param resource $ch This may be one of the following constants:
26563 *   CURLINFO_EFFECTIVE_URL - Last effective URL CURLINFO_HTTP_CODE - The
26564 *   last response code. As of PHP 5.5.0 and cURL 7.10.8, this is a
26565 *   legacy alias of CURLINFO_RESPONSE_CODE CURLINFO_FILETIME - Remote
26566 *   time of the retrieved document, with the CURLOPT_FILETIME enabled;
26567 *   if -1 is returned the time of the document is unknown
26568 *   CURLINFO_TOTAL_TIME - Total transaction time in seconds for last
26569 *   transfer CURLINFO_NAMELOOKUP_TIME - Time in seconds until name
26570 *   resolving was complete CURLINFO_CONNECT_TIME - Time in seconds it
26571 *   took to establish the connection CURLINFO_PRETRANSFER_TIME - Time in
26572 *   seconds from start until just before file transfer begins
26573 *   CURLINFO_STARTTRANSFER_TIME - Time in seconds until the first byte
26574 *   is about to be transferred CURLINFO_REDIRECT_COUNT - Number of
26575 *   redirects, with the CURLOPT_FOLLOWLOCATION option enabled
26576 *   CURLINFO_REDIRECT_TIME - Time in seconds of all redirection steps
26577 *   before final transaction was started, with the
26578 *   CURLOPT_FOLLOWLOCATION option enabled CURLINFO_REDIRECT_URL - With
26579 *   the CURLOPT_FOLLOWLOCATION option disabled: redirect URL found in
26580 *   the last transaction, that should be requested manually next. With
26581 *   the CURLOPT_FOLLOWLOCATION option enabled: this is empty. The
26582 *   redirect URL in this case is available in CURLINFO_EFFECTIVE_URL
26583 *   CURLINFO_PRIMARY_IP - IP address of the most recent connection
26584 *   CURLINFO_PRIMARY_PORT - Destination port of the most recent
26585 *   connection CURLINFO_LOCAL_IP - Local (source) IP address of the most
26586 *   recent connection CURLINFO_LOCAL_PORT - Local (source) port of the
26587 *   most recent connection CURLINFO_SIZE_UPLOAD - Total number of bytes
26588 *   uploaded CURLINFO_SIZE_DOWNLOAD - Total number of bytes downloaded
26589 *   CURLINFO_SPEED_DOWNLOAD - Average download speed
26590 *   CURLINFO_SPEED_UPLOAD - Average upload speed CURLINFO_HEADER_SIZE -
26591 *   Total size of all headers received CURLINFO_HEADER_OUT - The request
26592 *   string sent. For this to work, add the CURLINFO_HEADER_OUT option to
26593 *   the handle by calling {@link curl_setopt} CURLINFO_REQUEST_SIZE -
26594 *   Total size of issued requests, currently only for HTTP requests
26595 *   CURLINFO_SSL_VERIFYRESULT - Result of SSL certification verification
26596 *   requested by setting CURLOPT_SSL_VERIFYPEER
26597 *   CURLINFO_CONTENT_LENGTH_DOWNLOAD - Content length of download, read
26598 *   from Content-Length: field CURLINFO_CONTENT_LENGTH_UPLOAD -
26599 *   Specified size of upload CURLINFO_CONTENT_TYPE - Content-Type: of
26600 *   the requested document. NULL indicates server did not send valid
26601 *   Content-Type: header CURLINFO_PRIVATE - Private data associated with
26602 *   this cURL handle, previously set with the CURLOPT_PRIVATE option of
26603 *   {@link curl_setopt} CURLINFO_RESPONSE_CODE - The last response code
26604 *   CURLINFO_HTTP_CONNECTCODE - The CONNECT response code
26605 *   CURLINFO_HTTPAUTH_AVAIL - Bitmask indicating the authentication
26606 *   method(s) available according to the previous response
26607 *   CURLINFO_PROXYAUTH_AVAIL - Bitmask indicating the proxy
26608 *   authentication method(s) available according to the previous
26609 *   response CURLINFO_OS_ERRNO - Errno from a connect failure. The
26610 *   number is OS and system specific. CURLINFO_NUM_CONNECTS - Number of
26611 *   connections curl had to create to achieve the previous transfer
26612 *   CURLINFO_SSL_ENGINES - OpenSSL crypto-engines supported
26613 *   CURLINFO_COOKIELIST - All known cookies CURLINFO_FTP_ENTRY_PATH -
26614 *   Entry path in FTP server CURLINFO_APPCONNECT_TIME - Time in seconds
26615 *   it took from the start until the SSL/SSH connect/handshake to the
26616 *   remote host was completed CURLINFO_CERTINFO - TLS certificate chain
26617 *   CURLINFO_CONDITION_UNMET - Info on unmet time conditional
26618 *   CURLINFO_RTSP_CLIENT_CSEQ - Next RTSP client CSeq
26619 *   CURLINFO_RTSP_CSEQ_RECV - Recently received CSeq
26620 *   CURLINFO_RTSP_SERVER_CSEQ - Next RTSP server CSeq
26621 *   CURLINFO_RTSP_SESSION_ID - RTSP session ID
26622 *   CURLINFO_CONTENT_LENGTH_DOWNLOAD_T - The content-length of the
26623 *   download. This is the value read from the Content-Type: field. -1 if
26624 *   the size isn't known CURLINFO_CONTENT_LENGTH_UPLOAD_T - The
26625 *   specified size of the upload. -1 if the size isn't known
26626 *   CURLINFO_HTTP_VERSION - The version used in the last HTTP
26627 *   connection. The return value will be one of the defined
26628 *   CURL_HTTP_VERSION_* constants or 0 if the version can't be
26629 *   determined CURLINFO_PROTOCOL - The protocol used in the last HTTP
26630 *   connection. The returned value will be exactly one of the
26631 *   CURLPROTO_* values CURLINFO_PROXY_SSL_VERIFYRESULT - The result of
26632 *   the certificate verification that was requested (using the
26633 *   CURLOPT_PROXY_SSL_VERIFYPEER option). Only used for HTTPS proxies
26634 *   CURLINFO_SCHEME - The URL scheme used for the most recent connection
26635 *   CURLINFO_SIZE_DOWNLOAD_T - Total number of bytes that were
26636 *   downloaded. The number is only for the latest transfer and will be
26637 *   reset again for each new transfer CURLINFO_SIZE_UPLOAD_T - Total
26638 *   number of bytes that were uploaded CURLINFO_SPEED_DOWNLOAD_T - The
26639 *   average download speed in bytes/second that curl measured for the
26640 *   complete download CURLINFO_SPEED_UPLOAD_T - The average upload speed
26641 *   in bytes/second that curl measured for the complete upload
26642 *   CURLINFO_APPCONNECT_TIME_T - Time, in microseconds, it took from the
26643 *   start until the SSL/SSH connect/handshake to the remote host was
26644 *   completed CURLINFO_CONNECT_TIME_T - Total time taken, in
26645 *   microseconds, from the start until the connection to the remote host
26646 *   (or proxy) was completed CURLINFO_FILETIME_T - Remote time of the
26647 *   retrieved document (as Unix timestamp), an alternative to
26648 *   CURLINFO_FILETIME to allow systems with 32 bit long variables to
26649 *   extract dates outside of the 32bit timestamp range
26650 *   CURLINFO_NAMELOOKUP_TIME_T - Time in microseconds from the start
26651 *   until the name resolving was completed CURLINFO_PRETRANSFER_TIME_T -
26652 *   Time taken from the start until the file transfer is just about to
26653 *   begin, in microseconds CURLINFO_REDIRECT_TIME_T - Total time, in
26654 *   microseconds, it took for all redirection steps include name lookup,
26655 *   connect, pretransfer and transfer before final transaction was
26656 *   started CURLINFO_STARTTRANSFER_TIME_T - Time, in microseconds, it
26657 *   took from the start until the first byte is received
26658 *   CURLINFO_TOTAL_TIME_T - Total time in microseconds for the previous
26659 *   transfer, including name resolving, TCP connect etc.
26660 * @param int $opt
26661 * @return mixed If {@link opt} is given, returns its value. Otherwise,
26662 *   returns an associative array with the following elements (which
26663 *   correspond to {@link opt}), or FALSE on failure: "url"
26664 *   "content_type" "http_code" "header_size" "request_size" "filetime"
26665 *   "ssl_verify_result" "redirect_count" "total_time" "namelookup_time"
26666 *   "connect_time" "pretransfer_time" "size_upload" "size_download"
26667 *   "speed_download" "speed_upload" "download_content_length"
26668 *   "upload_content_length" "starttransfer_time" "redirect_time"
26669 *   "certinfo" "primary_ip" "primary_port" "local_ip" "local_port"
26670 *   "redirect_url" "request_header" (This is only set if the
26671 *   CURLINFO_HEADER_OUT is set by a previous call to {@link
26672 *   curl_setopt}) Note that private data is not included in the
26673 *   associative array and must be retrieved individually with the
26674 *   CURLINFO_PRIVATE option.
26675 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
26676 **/
26677function curl_getinfo($ch, $opt){}
26678
26679/**
26680 * Initialize a cURL session
26681 *
26682 * Initializes a new session and return a cURL handle for use with the
26683 * {@link curl_setopt}, {@link curl_exec}, and {@link curl_close}
26684 * functions.
26685 *
26686 * @param string $url If provided, the CURLOPT_URL option will be set
26687 *   to its value. You can manually set this using the {@link
26688 *   curl_setopt} function.
26689 * @return resource Returns a cURL handle on success, FALSE on errors.
26690 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
26691 **/
26692function curl_init($url){}
26693
26694/**
26695 * Add a normal cURL handle to a cURL multi handle
26696 *
26697 * Adds the {@link ch} handle to the multi handle {@link mh}
26698 *
26699 * @param resource $mh
26700 * @param resource $ch
26701 * @return int Returns 0 on success, or one of the CURLM_XXX errors
26702 *   code.
26703 * @since PHP 5, PHP 7
26704 **/
26705function curl_multi_add_handle($mh, $ch){}
26706
26707/**
26708 * Close a set of cURL handles
26709 *
26710 * Closes a set of cURL handles.
26711 *
26712 * @param resource $mh
26713 * @return void
26714 * @since PHP 5, PHP 7
26715 **/
26716function curl_multi_close($mh){}
26717
26718/**
26719 * Return the last multi curl error number
26720 *
26721 * Return an integer containing the last multi curl error number.
26722 *
26723 * @param resource $mh
26724 * @return int Return an integer containing the last multi curl error
26725 *   number, .
26726 * @since PHP 7 >= 7.1.0
26727 **/
26728function curl_multi_errno($mh){}
26729
26730/**
26731 * Run the sub-connections of the current cURL handle
26732 *
26733 * Processes each of the handles in the stack. This method can be called
26734 * whether or not a handle needs to read or write data.
26735 *
26736 * @param resource $mh A reference to a flag to tell whether the
26737 *   operations are still running.
26738 * @param int $still_running
26739 * @return int A cURL code defined in the cURL Predefined Constants.
26740 * @since PHP 5, PHP 7
26741 **/
26742function curl_multi_exec($mh, &$still_running){}
26743
26744/**
26745 * Return the content of a cURL handle if is set
26746 *
26747 * If CURLOPT_RETURNTRANSFER is an option that is set for a specific
26748 * handle, then this function will return the content of that cURL handle
26749 * in the form of a string.
26750 *
26751 * @param resource $ch
26752 * @return string Return the content of a cURL handle if
26753 *   CURLOPT_RETURNTRANSFER is set.
26754 * @since PHP 5, PHP 7
26755 **/
26756function curl_multi_getcontent($ch){}
26757
26758/**
26759 * Get information about the current transfers
26760 *
26761 * Ask the multi handle if there are any messages or information from the
26762 * individual transfers. Messages may include information such as an
26763 * error code from the transfer or just the fact that a transfer is
26764 * completed.
26765 *
26766 * Repeated calls to this function will return a new result each time,
26767 * until a FALSE is returned as a signal that there is no more to get at
26768 * this point. The integer pointed to with {@link msgs_in_queue} will
26769 * contain the number of remaining messages after this function was
26770 * called.
26771 *
26772 * @param resource $mh Number of messages that are still in the queue
26773 * @param int $msgs_in_queue
26774 * @return array On success, returns an associative array for the
26775 *   message, FALSE on failure.
26776 * @since PHP 5, PHP 7
26777 **/
26778function curl_multi_info_read($mh, &$msgs_in_queue){}
26779
26780/**
26781 * Returns a new cURL multi handle
26782 *
26783 * Allows the processing of multiple cURL handles asynchronously.
26784 *
26785 * @return resource Returns a cURL multi handle resource on success,
26786 *   FALSE on failure.
26787 * @since PHP 5, PHP 7
26788 **/
26789function curl_multi_init(){}
26790
26791/**
26792 * Remove a multi handle from a set of cURL handles
26793 *
26794 * Removes a given {@link ch} handle from the given {@link mh} handle.
26795 * When the {@link ch} handle has been removed, it is again perfectly
26796 * legal to run {@link curl_exec} on this handle. Removing the {@link ch}
26797 * handle while being used, will effectively halt the transfer in
26798 * progress involving that handle.
26799 *
26800 * @param resource $mh
26801 * @param resource $ch
26802 * @return int Returns 0 on success, or one of the CURLM_XXX error
26803 *   codes.
26804 * @since PHP 5, PHP 7
26805 **/
26806function curl_multi_remove_handle($mh, $ch){}
26807
26808/**
26809 * Wait for activity on any curl_multi connection
26810 *
26811 * Blocks until there is activity on any of the curl_multi connections.
26812 *
26813 * @param resource $mh Time, in seconds, to wait for a response.
26814 * @param float $timeout
26815 * @return int On success, returns the number of descriptors contained
26816 *   in the descriptor sets. This may be 0 if there was no activity on
26817 *   any of the descriptors. On failure, this function will return -1 on
26818 *   a select failure (from the underlying select system call).
26819 * @since PHP 5, PHP 7
26820 **/
26821function curl_multi_select($mh, $timeout){}
26822
26823/**
26824 * Set an option for the cURL multi handle
26825 *
26826 * @param resource $mh
26827 * @param int $option One of the CURLMOPT_* constants.
26828 * @param mixed $value The value to be set on {@link option}. {@link
26829 *   value} should be an int for the following values of the {@link
26830 *   option} parameter: Option Set {@link value} to CURLMOPT_PIPELINING
26831 *   Pass 1 to enable or 0 to disable. Enabling pipelining on a multi
26832 *   handle will make it attempt to perform HTTP Pipelining as far as
26833 *   possible for transfers using this handle. This means that if you add
26834 *   a second request that can use an already existing connection, the
26835 *   second request will be "piped" on the same connection. As of cURL
26836 *   7.43.0, the value is a bitmask, and you can also pass 2 to try to
26837 *   multiplex the new transfer over an existing HTTP/2 connection if
26838 *   possible. Passing 3 instructs cURL to ask for pipelining and
26839 *   multiplexing independently of each other. As of cURL 7.62.0, setting
26840 *   the pipelining bit has no effect. Instead of integer literals, you
26841 *   can also use the CURLPIPE_* constants if available.
26842 *   CURLMOPT_MAXCONNECTS Pass a number that will be used as the maximum
26843 *   amount of simultaneously open connections that libcurl may cache. By
26844 *   default the size will be enlarged to fit four times the number of
26845 *   handles added via {@link curl_multi_add_handle}. When the cache is
26846 *   full, curl closes the oldest one in the cache to prevent the number
26847 *   of open connections from increasing.
26848 *   CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE Pass a number that specifies the
26849 *   chunk length threshold for pipelining in bytes.
26850 *   CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE Pass a number that specifies
26851 *   the size threshold for pipelining penalty in bytes.
26852 *   CURLMOPT_MAX_HOST_CONNECTIONS Pass a number that specifies the
26853 *   maximum number of connections to a single host.
26854 *   CURLMOPT_MAX_PIPELINE_LENGTH Pass a number that specifies the
26855 *   maximum number of requests in a pipeline.
26856 *   CURLMOPT_MAX_TOTAL_CONNECTIONS Pass a number that specifies the
26857 *   maximum number of simultaneously open connections.
26858 *   CURLMOPT_PUSHFUNCTION Pass a callable that will be registered to
26859 *   handle server pushes and should have the following signature:
26860 *   intpushfunction resource{@link parent_ch} resource{@link pushed_ch}
26861 *   array{@link headers} {@link parent_ch} The parent cURL handle (the
26862 *   request the client made). {@link pushed_ch} A new cURL handle for
26863 *   the pushed request. {@link headers} The push promise headers. The
26864 *   push function is supposed to return either CURL_PUSH_OK if it can
26865 *   handle the push, or CURL_PUSH_DENY to reject it.
26866 * @return bool
26867 * @since PHP 5 >= 5.5.0, PHP 7
26868 **/
26869function curl_multi_setopt($mh, $option, $value){}
26870
26871/**
26872 * Return string describing error code
26873 *
26874 * Returns a text error message describing the given CURLM error code.
26875 *
26876 * @param int $errornum One of the CURLM error codes constants.
26877 * @return string Returns error string for valid error code, NULL
26878 *   otherwise.
26879 * @since PHP 5 >= 5.5.0, PHP 7
26880 **/
26881function curl_multi_strerror($errornum){}
26882
26883/**
26884 * Pause and unpause a connection
26885 *
26886 * @param resource $ch One of CURLPAUSE_* constants.
26887 * @param int $bitmask
26888 * @return int Returns an error code (CURLE_OK for no error).
26889 * @since PHP 5 >= 5.5.0, PHP 7
26890 **/
26891function curl_pause($ch, $bitmask){}
26892
26893/**
26894 * Reset all options of a libcurl session handle
26895 *
26896 * This function re-initializes all options set on the given cURL handle
26897 * to the default values.
26898 *
26899 * @param resource $ch
26900 * @return void
26901 * @since PHP 5 >= 5.5.0, PHP 7
26902 **/
26903function curl_reset($ch){}
26904
26905/**
26906 * Set an option for a cURL transfer
26907 *
26908 * Sets an option on the given cURL session handle.
26909 *
26910 * @param resource $ch The CURLOPT_XXX option to set.
26911 * @param int $option The value to be set on {@link option}. {@link
26912 *   value} should be a bool for the following values of the {@link
26913 *   option} parameter: Option Set {@link value} to Notes
26914 *   CURLOPT_AUTOREFERER TRUE to automatically set the Referer: field in
26915 *   requests where it follows a Location: redirect.
26916 *   CURLOPT_BINARYTRANSFER TRUE to return the raw output when
26917 *   CURLOPT_RETURNTRANSFER is used. From PHP 5.1.3, this option has no
26918 *   effect: the raw output will always be returned when
26919 *   CURLOPT_RETURNTRANSFER is used. CURLOPT_COOKIESESSION TRUE to mark
26920 *   this as a new cookie "session". It will force libcurl to ignore all
26921 *   cookies it is about to load that are "session cookies" from the
26922 *   previous session. By default, libcurl always stores and loads all
26923 *   cookies, independent if they are session cookies or not. Session
26924 *   cookies are cookies without expiry date and they are meant to be
26925 *   alive and existing for this "session" only. CURLOPT_CERTINFO TRUE to
26926 *   output SSL certification information to STDERR on secure transfers.
26927 *   Added in cURL 7.19.1. Available since PHP 5.3.2. Requires
26928 *   CURLOPT_VERBOSE to be on to have an effect. CURLOPT_CONNECT_ONLY
26929 *   TRUE tells the library to perform all the required proxy
26930 *   authentication and connection setup, but no data transfer. This
26931 *   option is implemented for HTTP, SMTP and POP3. Added in 7.15.2.
26932 *   Available since PHP 5.5.0. CURLOPT_CRLF TRUE to convert Unix
26933 *   newlines to CRLF newlines on transfers.
26934 *   CURLOPT_DISALLOW_USERNAME_IN_URL TRUE to not allow URLs that include
26935 *   a username. Usernames are allowed by default (0). Added in cURL
26936 *   7.61.0. Available since PHP 7.3.0. CURLOPT_DNS_SHUFFLE_ADDRESSES
26937 *   TRUE to shuffle the order of all returned addresses so that they
26938 *   will be used in a random order, when a name is resolved and more
26939 *   than one IP address is returned. This may cause IPv4 to be used
26940 *   before IPv6 or vice versa. Added in cURL 7.60.0. Available since PHP
26941 *   7.3.0. CURLOPT_HAPROXYPROTOCOL TRUE to send an HAProxy PROXY
26942 *   protocol v1 header at the start of the connection. The default
26943 *   action is not to send this header. Added in cURL 7.60.0. Available
26944 *   since PHP 7.3.0. CURLOPT_SSH_COMPRESSION TRUE to enable built-in SSH
26945 *   compression. This is a request, not an order; the server may or may
26946 *   not do it. Added in cURL 7.56.0. Available since PHP 7.3.0.
26947 *   CURLOPT_DNS_USE_GLOBAL_CACHE TRUE to use a global DNS cache. This
26948 *   option is not thread-safe. It is conditionally enabled by default if
26949 *   PHP is built for non-threaded use (CLI, FCGI, Apache2-Prefork,
26950 *   etc.). CURLOPT_FAILONERROR TRUE to fail verbosely if the HTTP code
26951 *   returned is greater than or equal to 400. The default behavior is to
26952 *   return the page normally, ignoring the code. CURLOPT_SSL_FALSESTART
26953 *   TRUE to enable TLS false start. Added in cURL 7.42.0. Available
26954 *   since PHP 7.0.7. CURLOPT_FILETIME TRUE to attempt to retrieve the
26955 *   modification date of the remote document. This value can be
26956 *   retrieved using the CURLINFO_FILETIME option with {@link
26957 *   curl_getinfo}. CURLOPT_FOLLOWLOCATION TRUE to follow any "Location:
26958 *   " header that the server sends as part of the HTTP header (note this
26959 *   is recursive, PHP will follow as many "Location: " headers that it
26960 *   is sent, unless CURLOPT_MAXREDIRS is set). CURLOPT_FORBID_REUSE TRUE
26961 *   to force the connection to explicitly close when it has finished
26962 *   processing, and not be pooled for reuse. CURLOPT_FRESH_CONNECT TRUE
26963 *   to force the use of a new connection instead of a cached one.
26964 *   CURLOPT_FTP_USE_EPRT TRUE to use EPRT (and LPRT) when doing active
26965 *   FTP downloads. Use FALSE to disable EPRT and LPRT and use PORT only.
26966 *   CURLOPT_FTP_USE_EPSV TRUE to first try an EPSV command for FTP
26967 *   transfers before reverting back to PASV. Set to FALSE to disable
26968 *   EPSV. CURLOPT_FTP_CREATE_MISSING_DIRS TRUE to create missing
26969 *   directories when an FTP operation encounters a path that currently
26970 *   doesn't exist. CURLOPT_FTPAPPEND TRUE to append to the remote file
26971 *   instead of overwriting it. CURLOPT_TCP_NODELAY TRUE to disable TCP's
26972 *   Nagle algorithm, which tries to minimize the number of small packets
26973 *   on the network. Available since PHP 5.2.1 for versions compiled with
26974 *   libcurl 7.11.2 or greater. CURLOPT_FTPASCII An alias of
26975 *   CURLOPT_TRANSFERTEXT. Use that instead. CURLOPT_FTPLISTONLY TRUE to
26976 *   only list the names of an FTP directory. CURLOPT_HEADER TRUE to
26977 *   include the header in the output. CURLINFO_HEADER_OUT TRUE to track
26978 *   the handle's request string. Available since PHP 5.1.3. The
26979 *   CURLINFO_ prefix is intentional. CURLOPT_HTTP09_ALLOWED Whether to
26980 *   allow HTTP/0.9 responses. Defaults to FALSE as of libcurl 7.66.0;
26981 *   formerly it defaulted to TRUE. Available since PHP 7.3.15 and 7.4.3,
26982 *   respectively, if built against libcurl >= 7.64.0 CURLOPT_HTTPGET
26983 *   TRUE to reset the HTTP request method to GET. Since GET is the
26984 *   default, this is only necessary if the request method has been
26985 *   changed. CURLOPT_HTTPPROXYTUNNEL TRUE to tunnel through a given HTTP
26986 *   proxy. CURLOPT_HTTP_CONTENT_DECODING FALSE to get the raw HTTP
26987 *   response body. Available as of PHP 5.5.0 if built against libcurl >=
26988 *   7.16.2. CURLOPT_KEEP_SENDING_ON_ERROR TRUE to keep sending the
26989 *   request body if the HTTP code returned is equal to or larger than
26990 *   300. The default action would be to stop sending and close the
26991 *   stream or connection. Suitable for manual NTLM authentication. Most
26992 *   applications do not need this option. Available as of PHP 7.3.0 if
26993 *   built against libcurl >= 7.51.0. CURLOPT_MUTE TRUE to be completely
26994 *   silent with regards to the cURL functions. Removed in cURL 7.15.5
26995 *   (You can use CURLOPT_RETURNTRANSFER instead) CURLOPT_NETRC TRUE to
26996 *   scan the ~/.netrc file to find a username and password for the
26997 *   remote site that a connection is being established with.
26998 *   CURLOPT_NOBODY TRUE to exclude the body from the output. Request
26999 *   method is then set to HEAD. Changing this to FALSE does not change
27000 *   it to GET. CURLOPT_NOPROGRESS TRUE to disable the progress meter for
27001 *   cURL transfers. PHP automatically sets this option to TRUE, this
27002 *   should only be changed for debugging purposes. CURLOPT_NOSIGNAL TRUE
27003 *   to ignore any cURL function that causes a signal to be sent to the
27004 *   PHP process. This is turned on by default in multi-threaded SAPIs so
27005 *   timeout options can still be used. Added in cURL 7.10.
27006 *   CURLOPT_PATH_AS_IS TRUE to not handle dot dot sequences. Added in
27007 *   cURL 7.42.0. Available since PHP 7.0.7. CURLOPT_PIPEWAIT TRUE to
27008 *   wait for pipelining/multiplexing. Added in cURL 7.43.0. Available
27009 *   since PHP 7.0.7. CURLOPT_POST TRUE to do a regular HTTP POST. This
27010 *   POST is the normal application/x-www-form-urlencoded kind, most
27011 *   commonly used by HTML forms. CURLOPT_PUT TRUE to HTTP PUT a file.
27012 *   The file to PUT must be set with CURLOPT_INFILE and
27013 *   CURLOPT_INFILESIZE. CURLOPT_RETURNTRANSFER TRUE to return the
27014 *   transfer as a string of the return value of {@link curl_exec}
27015 *   instead of outputting it directly. CURLOPT_SAFE_UPLOAD TRUE to
27016 *   disable support for the @ prefix for uploading files in
27017 *   CURLOPT_POSTFIELDS, which means that values starting with @ can be
27018 *   safely passed as fields. CURLFile may be used for uploads instead.
27019 *   Added in PHP 5.5.0 with FALSE as the default value. PHP 5.6.0
27020 *   changes the default value to TRUE. PHP 7 removes this option; the
27021 *   CURLFile interface must be used to upload files. CURLOPT_SASL_IR
27022 *   TRUE to enable sending the initial response in the first packet.
27023 *   Added in cURL 7.31.10. Available since PHP 7.0.7.
27024 *   CURLOPT_SSL_ENABLE_ALPN FALSE to disable ALPN in the SSL handshake
27025 *   (if the SSL backend libcurl is built to use supports it), which can
27026 *   be used to negotiate http2. Added in cURL 7.36.0. Available since
27027 *   PHP 7.0.7. CURLOPT_SSL_ENABLE_NPN FALSE to disable NPN in the SSL
27028 *   handshake (if the SSL backend libcurl is built to use supports it),
27029 *   which can be used to negotiate http2. Added in cURL 7.36.0.
27030 *   Available since PHP 7.0.7. CURLOPT_SSL_VERIFYPEER FALSE to stop cURL
27031 *   from verifying the peer's certificate. Alternate certificates to
27032 *   verify against can be specified with the CURLOPT_CAINFO option or a
27033 *   certificate directory can be specified with the CURLOPT_CAPATH
27034 *   option. TRUE by default as of cURL 7.10. Default bundle installed as
27035 *   of cURL 7.10. CURLOPT_SSL_VERIFYSTATUS TRUE to verify the
27036 *   certificate's status. Added in cURL 7.41.0. Available since PHP
27037 *   7.0.7. CURLOPT_PROXY_SSL_VERIFYPEER FALSE to stop cURL from
27038 *   verifying the peer's certificate. Alternate certificates to verify
27039 *   against can be specified with the CURLOPT_CAINFO option or a
27040 *   certificate directory can be specified with the CURLOPT_CAPATH
27041 *   option. When set to false, the peer certificate verification
27042 *   succeeds regardless. TRUE by default. Available since PHP 7.3.0 and
27043 *   libcurl >= cURL 7.52.0. CURLOPT_SUPPRESS_CONNECT_HEADERS TRUE to
27044 *   suppress proxy CONNECT response headers from the user callback
27045 *   functions CURLOPT_HEADERFUNCTION and CURLOPT_WRITEFUNCTION, when
27046 *   CURLOPT_HTTPPROXYTUNNEL is used and a CONNECT request is made. Added
27047 *   in cURL 7.54.0. Available since PHP 7.3.0. CURLOPT_TCP_FASTOPEN TRUE
27048 *   to enable TCP Fast Open. Added in cURL 7.49.0. Available since PHP
27049 *   7.0.7. CURLOPT_TFTP_NO_OPTIONS TRUE to not send TFTP options
27050 *   requests. Added in cURL 7.48.0. Available since PHP 7.0.7.
27051 *   CURLOPT_TRANSFERTEXT TRUE to use ASCII mode for FTP transfers. For
27052 *   LDAP, it retrieves data in plain text instead of HTML. On Windows
27053 *   systems, it will not set STDOUT to binary mode.
27054 *   CURLOPT_UNRESTRICTED_AUTH TRUE to keep sending the username and
27055 *   password when following locations (using CURLOPT_FOLLOWLOCATION),
27056 *   even when the hostname has changed. CURLOPT_UPLOAD TRUE to prepare
27057 *   for an upload. CURLOPT_VERBOSE TRUE to output verbose information.
27058 *   Writes output to STDERR, or the file specified using CURLOPT_STDERR.
27059 *   {@link value} should be an integer for the following values of the
27060 *   {@link option} parameter: Option Set {@link value} to Notes
27061 *   CURLOPT_BUFFERSIZE The size of the buffer to use for each read.
27062 *   There is no guarantee this request will be fulfilled, however. Added
27063 *   in cURL 7.10. CURLOPT_CLOSEPOLICY One of the CURLCLOSEPOLICY_*
27064 *   values. This option is deprecated, as it was never implemented in
27065 *   cURL and never had any effect. Removed in PHP 5.6.0.
27066 *   CURLOPT_CONNECTTIMEOUT The number of seconds to wait while trying to
27067 *   connect. Use 0 to wait indefinitely. CURLOPT_CONNECTTIMEOUT_MS The
27068 *   number of milliseconds to wait while trying to connect. Use 0 to
27069 *   wait indefinitely. If libcurl is built to use the standard system
27070 *   name resolver, that portion of the connect will still use
27071 *   full-second resolution for timeouts with a minimum timeout allowed
27072 *   of one second. Added in cURL 7.16.2. Available since PHP 5.2.3.
27073 *   CURLOPT_DNS_CACHE_TIMEOUT The number of seconds to keep DNS entries
27074 *   in memory. This option is set to 120 (2 minutes) by default.
27075 *   CURLOPT_EXPECT_100_TIMEOUT_MS The timeout for Expect: 100-continue
27076 *   responses in milliseconds. Defaults to 1000 milliseconds. Added in
27077 *   cURL 7.36.0. Available since PHP 7.0.7.
27078 *   CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS Head start for ipv6 for the happy
27079 *   eyeballs algorithm. Happy eyeballs attempts to connect to both IPv4
27080 *   and IPv6 addresses for dual-stack hosts, preferring IPv6 first for
27081 *   timeout milliseconds. Defaults to CURL_HET_DEFAULT, which is
27082 *   currently 200 milliseconds. Added in cURL 7.59.0. Available since
27083 *   PHP 7.3.0. CURLOPT_FTPSSLAUTH The FTP authentication method (when is
27084 *   activated): CURLFTPAUTH_SSL (try SSL first), CURLFTPAUTH_TLS (try
27085 *   TLS first), or CURLFTPAUTH_DEFAULT (let cURL decide). Added in cURL
27086 *   7.12.2. CURLOPT_HEADEROPT How to deal with headers. One of the
27087 *   following constants: CURLHEADER_UNIFIED: the headers specified in
27088 *   CURLOPT_HTTPHEADER will be used in requests both to servers and
27089 *   proxies. With this option enabled, CURLOPT_PROXYHEADER will not have
27090 *   any effect. CURLHEADER_SEPARATE: makes CURLOPT_HTTPHEADER headers
27091 *   only get sent to a server and not to a proxy. Proxy headers must be
27092 *   set with CURLOPT_PROXYHEADER to get used. Note that if a non-CONNECT
27093 *   request is sent to a proxy, libcurl will send both server headers
27094 *   and proxy headers. When doing CONNECT, libcurl will send
27095 *   CURLOPT_PROXYHEADER headers only to the proxy and then
27096 *   CURLOPT_HTTPHEADER headers only to the server. Defaults to
27097 *   CURLHEADER_SEPARATE as of cURL 7.42.1, and CURLHEADER_UNIFIED
27098 *   before. Added in cURL 7.37.0. Available since PHP 7.0.7.
27099 *   CURLOPT_HTTP_VERSION CURL_HTTP_VERSION_NONE (default, lets CURL
27100 *   decide which version to use), CURL_HTTP_VERSION_1_0 (forces
27101 *   HTTP/1.0), CURL_HTTP_VERSION_1_1 (forces HTTP/1.1),
27102 *   CURL_HTTP_VERSION_2_0 (attempts HTTP 2), CURL_HTTP_VERSION_2 (alias
27103 *   of CURL_HTTP_VERSION_2_0), CURL_HTTP_VERSION_2TLS (attempts HTTP 2
27104 *   over TLS (HTTPS) only) or CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE
27105 *   (issues non-TLS HTTP requests using HTTP/2 without HTTP/1.1
27106 *   Upgrade). CURLOPT_HTTPAUTH The HTTP authentication method(s) to use.
27107 *   The options are: CURLAUTH_BASIC, CURLAUTH_DIGEST,
27108 *   CURLAUTH_GSSNEGOTIATE, CURLAUTH_NTLM, CURLAUTH_ANY, and
27109 *   CURLAUTH_ANYSAFE. The bitwise | (or) operator can be used to combine
27110 *   more than one method. If this is done, cURL will poll the server to
27111 *   see what methods it supports and pick the best one. CURLAUTH_ANY is
27112 *   an alias for CURLAUTH_BASIC | CURLAUTH_DIGEST |
27113 *   CURLAUTH_GSSNEGOTIATE | CURLAUTH_NTLM. CURLAUTH_ANYSAFE is an alias
27114 *   for CURLAUTH_DIGEST | CURLAUTH_GSSNEGOTIATE | CURLAUTH_NTLM.
27115 *   CURLOPT_INFILESIZE The expected size, in bytes, of the file when
27116 *   uploading a file to a remote site. Note that using this option will
27117 *   not stop libcurl from sending more data, as exactly what is sent
27118 *   depends on CURLOPT_READFUNCTION. CURLOPT_LOW_SPEED_LIMIT The
27119 *   transfer speed, in bytes per second, that the transfer should be
27120 *   below during the count of CURLOPT_LOW_SPEED_TIME seconds before PHP
27121 *   considers the transfer too slow and aborts. CURLOPT_LOW_SPEED_TIME
27122 *   The number of seconds the transfer speed should be below
27123 *   CURLOPT_LOW_SPEED_LIMIT before PHP considers the transfer too slow
27124 *   and aborts. CURLOPT_MAXCONNECTS The maximum amount of persistent
27125 *   connections that are allowed. When the limit is reached,
27126 *   CURLOPT_CLOSEPOLICY is used to determine which connection to close.
27127 *   CURLOPT_MAXREDIRS The maximum amount of HTTP redirections to follow.
27128 *   Use this option alongside CURLOPT_FOLLOWLOCATION. CURLOPT_PORT An
27129 *   alternative port number to connect to. CURLOPT_POSTREDIR A bitmask
27130 *   of 1 (301 Moved Permanently), 2 (302 Found) and 4 (303 See Other) if
27131 *   the HTTP POST method should be maintained when
27132 *   CURLOPT_FOLLOWLOCATION is set and a specific type of redirect
27133 *   occurs. Added in cURL 7.19.1. Available since PHP 5.3.2.
27134 *   CURLOPT_PROTOCOLS Bitmask of CURLPROTO_* values. If used, this
27135 *   bitmask limits what protocols libcurl may use in the transfer. This
27136 *   allows you to have a libcurl built to support a wide range of
27137 *   protocols but still limit specific transfers to only be allowed to
27138 *   use a subset of them. By default libcurl will accept all protocols
27139 *   it supports. See also CURLOPT_REDIR_PROTOCOLS. Valid protocol
27140 *   options are: CURLPROTO_HTTP, CURLPROTO_HTTPS, CURLPROTO_FTP,
27141 *   CURLPROTO_FTPS, CURLPROTO_SCP, CURLPROTO_SFTP, CURLPROTO_TELNET,
27142 *   CURLPROTO_LDAP, CURLPROTO_LDAPS, CURLPROTO_DICT, CURLPROTO_FILE,
27143 *   CURLPROTO_TFTP, CURLPROTO_ALL Added in cURL 7.19.4.
27144 *   CURLOPT_PROXYAUTH The HTTP authentication method(s) to use for the
27145 *   proxy connection. Use the same bitmasks as described in
27146 *   CURLOPT_HTTPAUTH. For proxy authentication, only CURLAUTH_BASIC and
27147 *   CURLAUTH_NTLM are currently supported. Added in cURL 7.10.7.
27148 *   CURLOPT_PROXYPORT The port number of the proxy to connect to. This
27149 *   port number can also be set in CURLOPT_PROXY. CURLOPT_PROXYTYPE
27150 *   Either CURLPROXY_HTTP (default), CURLPROXY_SOCKS4, CURLPROXY_SOCKS5,
27151 *   CURLPROXY_SOCKS4A or CURLPROXY_SOCKS5_HOSTNAME. Added in cURL 7.10.
27152 *   CURLOPT_REDIR_PROTOCOLS Bitmask of CURLPROTO_* values. If used, this
27153 *   bitmask limits what protocols libcurl may use in a transfer that it
27154 *   follows to in a redirect when CURLOPT_FOLLOWLOCATION is enabled.
27155 *   This allows you to limit specific transfers to only be allowed to
27156 *   use a subset of protocols in redirections. By default libcurl will
27157 *   allow all protocols except for FILE and SCP. This is a difference
27158 *   compared to pre-7.19.4 versions which unconditionally would follow
27159 *   to all protocols supported. See also CURLOPT_PROTOCOLS for protocol
27160 *   constant values. Added in cURL 7.19.4. CURLOPT_RESUME_FROM The
27161 *   offset, in bytes, to resume a transfer from. CURLOPT_SOCKS5_AUTH The
27162 *   SOCKS5 authentication method(s) to use. The options are:
27163 *   CURLAUTH_BASIC, CURLAUTH_GSSAPI, CURLAUTH_NONE. The bitwise | (or)
27164 *   operator can be used to combine more than one method. If this is
27165 *   done, cURL will poll the server to see what methods it supports and
27166 *   pick the best one. CURLAUTH_BASIC allows username/password
27167 *   authentication. CURLAUTH_GSSAPI allows GSS-API authentication.
27168 *   CURLAUTH_NONE allows no authentication. Defaults to
27169 *   CURLAUTH_BASIC|CURLAUTH_GSSAPI. Set the actual username and password
27170 *   with the CURLOPT_PROXYUSERPWD option. Available as of 7.3.0 and curl
27171 *   >= 7.55.0. CURLOPT_SSL_OPTIONS Set SSL behavior options, which is a
27172 *   bitmask of any of the following constants: CURLSSLOPT_ALLOW_BEAST:
27173 *   do not attempt to use any workarounds for a security flaw in the
27174 *   SSL3 and TLS1.0 protocols. CURLSSLOPT_NO_REVOKE: disable certificate
27175 *   revocation checks for those SSL backends where such behavior is
27176 *   present. Added in cURL 7.25.0. Available since PHP 7.0.7.
27177 *   CURLOPT_SSL_VERIFYHOST 1 to check the existence of a common name in
27178 *   the SSL peer certificate. 2 to check the existence of a common name
27179 *   and also verify that it matches the hostname provided. 0 to not
27180 *   check the names. In production environments the value of this option
27181 *   should be kept at 2 (default value). Support for value 1 removed in
27182 *   cURL 7.28.1. CURLOPT_SSLVERSION One of CURL_SSLVERSION_DEFAULT (0),
27183 *   CURL_SSLVERSION_TLSv1 (1), CURL_SSLVERSION_SSLv2 (2),
27184 *   CURL_SSLVERSION_SSLv3 (3), CURL_SSLVERSION_TLSv1_0 (4),
27185 *   CURL_SSLVERSION_TLSv1_1 (5) or CURL_SSLVERSION_TLSv1_2 (6). The
27186 *   maximum TLS version can be set by using one of the
27187 *   CURL_SSLVERSION_MAX_* constants. It is also possible to OR one of
27188 *   the CURL_SSLVERSION_* constants with one of the
27189 *   CURL_SSLVERSION_MAX_* constants. CURL_SSLVERSION_MAX_DEFAULT (the
27190 *   maximum version supported by the library),
27191 *   CURL_SSLVERSION_MAX_TLSv1_0, CURL_SSLVERSION_MAX_TLSv1_1,
27192 *   CURL_SSLVERSION_MAX_TLSv1_2, or CURL_SSLVERSION_MAX_TLSv1_3. Your
27193 *   best bet is to not set this and let it use the default. Setting it
27194 *   to 2 or 3 is very dangerous given the known vulnerabilities in SSLv2
27195 *   and SSLv3. CURLOPT_PROXY_SSL_OPTIONS Set proxy SSL behavior options,
27196 *   which is a bitmask of any of the following constants:
27197 *   CURLSSLOPT_ALLOW_BEAST: do not attempt to use any workarounds for a
27198 *   security flaw in the SSL3 and TLS1.0 protocols.
27199 *   CURLSSLOPT_NO_REVOKE: disable certificate revocation checks for
27200 *   those SSL backends where such behavior is present. (curl >= 7.44.0)
27201 *   CURLSSLOPT_NO_PARTIALCHAIN: do not accept "partial" certificate
27202 *   chains, which it otherwise does by default. (curl >= 7.68.0)
27203 *   Available since PHP 7.3.0 and libcurl >= cURL 7.52.0.
27204 *   CURLOPT_PROXY_SSL_VERIFYHOST Set to 2 to verify in the HTTPS proxy's
27205 *   certificate name fields against the proxy name. When set to 0 the
27206 *   connection succeeds regardless of the names used in the certificate.
27207 *   Use that ability with caution! 1 treated as a debug option in curl
27208 *   7.28.0 and earlier. From curl 7.28.1 to 7.65.3
27209 *   CURLE_BAD_FUNCTION_ARGUMENT is returned. From curl 7.66.0 onwards 1
27210 *   and 2 is treated as the same value. In production environments the
27211 *   value of this option should be kept at 2 (default value). Available
27212 *   since PHP 7.3.0 and libcurl >= cURL 7.52.0. CURLOPT_PROXY_SSLVERSION
27213 *   One of CURL_SSLVERSION_DEFAULT, CURL_SSLVERSION_TLSv1,
27214 *   CURL_SSLVERSION_TLSv1_0, CURL_SSLVERSION_TLSv1_1,
27215 *   CURL_SSLVERSION_TLSv1_2, CURL_SSLVERSION_TLSv1_3,
27216 *   CURL_SSLVERSION_MAX_DEFAULT, CURL_SSLVERSION_MAX_TLSv1_0,
27217 *   CURL_SSLVERSION_MAX_TLSv1_1, CURL_SSLVERSION_MAX_TLSv1_2,
27218 *   CURL_SSLVERSION_MAX_TLSv1_3 or CURL_SSLVERSION_SSLv3. Your best bet
27219 *   is to not set this and let it use the default
27220 *   CURL_SSLVERSION_DEFAULT which will attempt to figure out the remote
27221 *   SSL protocol version. Available since PHP 7.3.0 and libcurl >= cURL
27222 *   7.52.0. CURLOPT_STREAM_WEIGHT Set the numerical stream weight (a
27223 *   number between 1 and 256). Added in cURL 7.46.0. Available since PHP
27224 *   7.0.7. CURLOPT_TCP_KEEPALIVE If set to 1, TCP keepalive probes will
27225 *   be sent. The delay and frequency of these probes can be controlled
27226 *   by the CURLOPT_TCP_KEEPIDLE and CURLOPT_TCP_KEEPINTVL options,
27227 *   provided the operating system supports them. If set to 0 (default)
27228 *   keepalive probes are disabled. Added in cURL 7.25.0. Available since
27229 *   PHP 5.5.0. CURLOPT_TCP_KEEPIDLE Sets the delay, in seconds, that the
27230 *   operating system will wait while the connection is idle before
27231 *   sending keepalive probes, if CURLOPT_TCP_KEEPALIVE is enabled. Not
27232 *   all operating systems support this option. The default is 60. Added
27233 *   in cURL 7.25.0. Available since PHP 5.5.0. CURLOPT_TCP_KEEPINTVL
27234 *   Sets the interval, in seconds, that the operating system will wait
27235 *   between sending keepalive probes, if CURLOPT_TCP_KEEPALIVE is
27236 *   enabled. Not all operating systems support this option. The default
27237 *   is 60. Added in cURL 7.25.0. Available since PHP 5.5.0.
27238 *   CURLOPT_TIMECONDITION How CURLOPT_TIMEVALUE is treated. Use
27239 *   CURL_TIMECOND_IFMODSINCE to return the page only if it has been
27240 *   modified since the time specified in CURLOPT_TIMEVALUE. If it hasn't
27241 *   been modified, a "304 Not Modified" header will be returned assuming
27242 *   CURLOPT_HEADER is TRUE. Use CURL_TIMECOND_IFUNMODSINCE for the
27243 *   reverse effect. CURL_TIMECOND_IFMODSINCE is the default.
27244 *   CURLOPT_TIMEOUT The maximum number of seconds to allow cURL
27245 *   functions to execute. CURLOPT_TIMEOUT_MS The maximum number of
27246 *   milliseconds to allow cURL functions to execute. If libcurl is built
27247 *   to use the standard system name resolver, that portion of the
27248 *   connect will still use full-second resolution for timeouts with a
27249 *   minimum timeout allowed of one second. Added in cURL 7.16.2.
27250 *   Available since PHP 5.2.3. CURLOPT_TIMEVALUE The time in seconds
27251 *   since January 1st, 1970. The time will be used by
27252 *   CURLOPT_TIMECONDITION. By default, CURL_TIMECOND_IFMODSINCE is used.
27253 *   CURLOPT_TIMEVALUE_LARGE The time in seconds since January 1st, 1970.
27254 *   The time will be used by CURLOPT_TIMECONDITION. Defaults to zero.
27255 *   The difference between this option and CURLOPT_TIMEVALUE is the type
27256 *   of the argument. On systems where 'long' is only 32 bit wide, this
27257 *   option has to be used to set dates beyond the year 2038. Added in
27258 *   cURL 7.59.0. Available since PHP 7.3.0. CURLOPT_MAX_RECV_SPEED_LARGE
27259 *   If a download exceeds this speed (counted in bytes per second) on
27260 *   cumulative average during the transfer, the transfer will pause to
27261 *   keep the average rate less than or equal to the parameter value.
27262 *   Defaults to unlimited speed. Added in cURL 7.15.5. Available since
27263 *   PHP 5.4.0. CURLOPT_MAX_SEND_SPEED_LARGE If an upload exceeds this
27264 *   speed (counted in bytes per second) on cumulative average during the
27265 *   transfer, the transfer will pause to keep the average rate less than
27266 *   or equal to the parameter value. Defaults to unlimited speed. Added
27267 *   in cURL 7.15.5. Available since PHP 5.4.0. CURLOPT_SSH_AUTH_TYPES A
27268 *   bitmask consisting of one or more of CURLSSH_AUTH_PUBLICKEY,
27269 *   CURLSSH_AUTH_PASSWORD, CURLSSH_AUTH_HOST, CURLSSH_AUTH_KEYBOARD. Set
27270 *   to CURLSSH_AUTH_ANY to let libcurl pick one. Added in cURL 7.16.1.
27271 *   CURLOPT_IPRESOLVE Allows an application to select what kind of IP
27272 *   addresses to use when resolving host names. This is only interesting
27273 *   when using host names that resolve addresses using more than one
27274 *   version of IP, possible values are CURL_IPRESOLVE_WHATEVER,
27275 *   CURL_IPRESOLVE_V4, CURL_IPRESOLVE_V6, by default
27276 *   CURL_IPRESOLVE_WHATEVER. Added in cURL 7.10.8.
27277 *   CURLOPT_FTP_FILEMETHOD Tell curl which method to use to reach a file
27278 *   on a FTP(S) server. Possible values are CURLFTPMETHOD_MULTICWD,
27279 *   CURLFTPMETHOD_NOCWD and CURLFTPMETHOD_SINGLECWD. Added in cURL
27280 *   7.15.1. Available since PHP 5.3.0. {@link value} should be a string
27281 *   for the following values of the {@link option} parameter: Option Set
27282 *   {@link value} to Notes CURLOPT_ABSTRACT_UNIX_SOCKET Enables the use
27283 *   of an abstract Unix domain socket instead of establishing a TCP
27284 *   connection to a host and sets the path to the given string. This
27285 *   option shares the same semantics as CURLOPT_UNIX_SOCKET_PATH. These
27286 *   two options share the same storage and therefore only one of them
27287 *   can be set per handle. Available since PHP 7.3.0 and cURL 7.53.0
27288 *   CURLOPT_CAINFO The name of a file holding one or more certificates
27289 *   to verify the peer with. This only makes sense when used in
27290 *   combination with CURLOPT_SSL_VERIFYPEER. Might require an absolute
27291 *   path. CURLOPT_CAPATH A directory that holds multiple CA
27292 *   certificates. Use this option alongside CURLOPT_SSL_VERIFYPEER.
27293 *   CURLOPT_COOKIE The contents of the "Cookie: " header to be used in
27294 *   the HTTP request. Note that multiple cookies are separated with a
27295 *   semicolon followed by a space (e.g., "fruit=apple; colour=red")
27296 *   CURLOPT_COOKIEFILE The name of the file containing the cookie data.
27297 *   The cookie file can be in Netscape format, or just plain HTTP-style
27298 *   headers dumped into a file. If the name is an empty string, no
27299 *   cookies are loaded, but cookie handling is still enabled.
27300 *   CURLOPT_COOKIEJAR The name of a file to save all internal cookies to
27301 *   when the handle is closed, e.g. after a call to curl_close.
27302 *   CURLOPT_COOKIELIST A cookie string (i.e. a single line in
27303 *   Netscape/Mozilla format, or a regular HTTP-style Set-Cookie header)
27304 *   adds that single cookie to the internal cookie store. "ALL" erases
27305 *   all cookies held in memory. "SESS" erases all session cookies held
27306 *   in memory. "FLUSH" writes all known cookies to the file specified by
27307 *   CURLOPT_COOKIEJAR. "RELOAD" loads all cookies from the files
27308 *   specified by CURLOPT_COOKIEFILE. Available since PHP 5.5.0 and cURL
27309 *   7.14.1. CURLOPT_CUSTOMREQUEST A custom request method to use instead
27310 *   of "GET" or "HEAD" when doing a HTTP request. This is useful for
27311 *   doing "DELETE" or other, more obscure HTTP requests. Valid values
27312 *   are things like "GET", "POST", "CONNECT" and so on; i.e. Do not
27313 *   enter a whole HTTP request line here. For instance, entering "GET
27314 *   /index.html HTTP/1.0\r\n\r\n" would be incorrect. Don't do this
27315 *   without making sure the server supports the custom request method
27316 *   first. CURLOPT_DEFAULT_PROTOCOL The default protocol to use if the
27317 *   URL is missing a scheme name. Added in cURL 7.45.0. Available since
27318 *   PHP 7.0.7. CURLOPT_DNS_INTERFACE Set the name of the network
27319 *   interface that the DNS resolver should bind to. This must be an
27320 *   interface name (not an address). Added in cURL 7.33.0. Available
27321 *   since PHP 7.0.7. CURLOPT_DNS_LOCAL_IP4 Set the local IPv4 address
27322 *   that the resolver should bind to. The argument should contain a
27323 *   single numerical IPv4 address as a string. Added in cURL 7.33.0.
27324 *   Available since PHP 7.0.7. CURLOPT_DNS_LOCAL_IP6 Set the local IPv6
27325 *   address that the resolver should bind to. The argument should
27326 *   contain a single numerical IPv6 address as a string. Added in cURL
27327 *   7.33.0. Available since PHP 7.0.7. CURLOPT_EGDSOCKET Like
27328 *   CURLOPT_RANDOM_FILE, except a filename to an Entropy Gathering
27329 *   Daemon socket. CURLOPT_ENCODING The contents of the
27330 *   "Accept-Encoding: " header. This enables decoding of the response.
27331 *   Supported encodings are "identity", "deflate", and "gzip". If an
27332 *   empty string, "", is set, a header containing all supported encoding
27333 *   types is sent. Added in cURL 7.10. CURLOPT_FTPPORT The value which
27334 *   will be used to get the IP address to use for the FTP "PORT"
27335 *   instruction. The "PORT" instruction tells the remote server to
27336 *   connect to our specified IP address. The string may be a plain IP
27337 *   address, a hostname, a network interface name (under Unix), or just
27338 *   a plain '-' to use the systems default IP address. CURLOPT_INTERFACE
27339 *   The name of the outgoing network interface to use. This can be an
27340 *   interface name, an IP address or a host name. CURLOPT_KEYPASSWD The
27341 *   password required to use the CURLOPT_SSLKEY or
27342 *   CURLOPT_SSH_PRIVATE_KEYFILE private key. Added in cURL 7.16.1.
27343 *   CURLOPT_KRB4LEVEL The KRB4 (Kerberos 4) security level. Any of the
27344 *   following values (in order from least to most powerful) are valid:
27345 *   "clear", "safe", "confidential", "private".. If the string does not
27346 *   match one of these, "private" is used. Setting this option to NULL
27347 *   will disable KRB4 security. Currently KRB4 security only works with
27348 *   FTP transactions. CURLOPT_LOGIN_OPTIONS Can be used to set protocol
27349 *   specific login options, such as the preferred authentication
27350 *   mechanism via "AUTH=NTLM" or "AUTH=*", and should be used in
27351 *   conjunction with the CURLOPT_USERNAME option. Added in cURL 7.34.0.
27352 *   Available since PHP 7.0.7. CURLOPT_PINNEDPUBLICKEY Set the pinned
27353 *   public key. The string can be the file name of your pinned public
27354 *   key. The file format expected is "PEM" or "DER". The string can also
27355 *   be any number of base64 encoded sha256 hashes preceded by "sha256//"
27356 *   and separated by ";". Added in cURL 7.39.0. Available since PHP
27357 *   7.0.7. CURLOPT_POSTFIELDS The full data to post in a HTTP "POST"
27358 *   operation. To post a file, prepend a filename with @ and use the
27359 *   full path. The filetype can be explicitly specified by following the
27360 *   filename with the type in the format ';type=mimetype'. This
27361 *   parameter can either be passed as a urlencoded string like
27362 *   'para1=val1&para2=val2&...' or as an array with the field name as
27363 *   key and field data as value. If {@link value} is an array, the
27364 *   Content-Type header will be set to multipart/form-data. As of PHP
27365 *   5.2.0, {@link value} must be an array if files are passed to this
27366 *   option with the @ prefix. As of PHP 5.5.0, the @ prefix is
27367 *   deprecated and files can be sent using CURLFile. The @ prefix can be
27368 *   disabled for safe passing of values beginning with @ by setting the
27369 *   CURLOPT_SAFE_UPLOAD option to TRUE. CURLOPT_PRIVATE Any data that
27370 *   should be associated with this cURL handle. This data can
27371 *   subsequently be retrieved with the CURLINFO_PRIVATE option of {@link
27372 *   curl_getinfo}. cURL does nothing with this data. When using a cURL
27373 *   multi handle, this private data is typically a unique key to
27374 *   identify a standard cURL handle. Added in cURL 7.10.3.
27375 *   CURLOPT_PRE_PROXY Set a string holding the host name or dotted
27376 *   numerical IP address to be used as the preproxy that curl connects
27377 *   to before it connects to the HTTP(S) proxy specified in the
27378 *   CURLOPT_PROXY option for the upcoming request. The preproxy can only
27379 *   be a SOCKS proxy and it should be prefixed with [scheme]:// to
27380 *   specify which kind of socks is used. A numerical IPv6 address must
27381 *   be written within [brackets]. Setting the preproxy to an empty
27382 *   string explicitly disables the use of a preproxy. To specify port
27383 *   number in this string, append :[port] to the end of the host name.
27384 *   The proxy's port number may optionally be specified with the
27385 *   separate option CURLOPT_PROXYPORT. Defaults to using port 1080 for
27386 *   proxies if a port is not specified. Available since PHP 7.3.0 and
27387 *   libcurl >= cURL 7.52.0. CURLOPT_PROXY The HTTP proxy to tunnel
27388 *   requests through. CURLOPT_PROXY_SERVICE_NAME The proxy
27389 *   authentication service name. Added in cURL 7.34.0. Available since
27390 *   PHP 7.0.7. CURLOPT_PROXY_CAINFO The path to proxy Certificate
27391 *   Authority (CA) bundle. Set the path as a string naming a file
27392 *   holding one or more certificates to verify the HTTPS proxy with.
27393 *   This option is for connecting to an HTTPS proxy, not an HTTPS
27394 *   server. Defaults set to the system path where libcurl's cacert
27395 *   bundle is assumed to be stored. Available since PHP 7.3.0 and
27396 *   libcurl >= cURL 7.52.0. CURLOPT_PROXY_CAPATH The directory holding
27397 *   multiple CA certificates to verify the HTTPS proxy with. Available
27398 *   since PHP 7.3.0 and libcurl >= cURL 7.52.0. CURLOPT_PROXY_CRLFILE
27399 *   Set the file name with the concatenation of CRL (Certificate
27400 *   Revocation List) in PEM format to use in the certificate validation
27401 *   that occurs during the SSL exchange. Available since PHP 7.3.0 and
27402 *   libcurl >= cURL 7.52.0. CURLOPT_PROXY_KEYPASSWD Set the string be
27403 *   used as the password required to use the CURLOPT_PROXY_SSLKEY
27404 *   private key. You never needed a passphrase to load a certificate but
27405 *   you need one to load your private key. This option is for connecting
27406 *   to an HTTPS proxy, not an HTTPS server. Available since PHP 7.3.0
27407 *   and libcurl >= cURL 7.52.0. CURLOPT_PROXY_PINNEDPUBLICKEY Set the
27408 *   pinned public key for HTTPS proxy. The string can be the file name
27409 *   of your pinned public key. The file format expected is "PEM" or
27410 *   "DER". The string can also be any number of base64 encoded sha256
27411 *   hashes preceded by "sha256//" and separated by ";" Available since
27412 *   PHP 7.3.0 and libcurl >= cURL 7.52.0. CURLOPT_PROXY_SSLCERT The file
27413 *   name of your client certificate used to connect to the HTTPS proxy.
27414 *   The default format is "P12" on Secure Transport and "PEM" on other
27415 *   engines, and can be changed with CURLOPT_PROXY_SSLCERTTYPE. With NSS
27416 *   or Secure Transport, this can also be the nickname of the
27417 *   certificate you wish to authenticate with as it is named in the
27418 *   security database. If you want to use a file from the current
27419 *   directory, please precede it with "./" prefix, in order to avoid
27420 *   confusion with a nickname. Available since PHP 7.3.0 and libcurl >=
27421 *   cURL 7.52.0. CURLOPT_PROXY_SSLCERTTYPE The format of your client
27422 *   certificate used when connecting to an HTTPS proxy. Supported
27423 *   formats are "PEM" and "DER", except with Secure Transport. OpenSSL
27424 *   (versions 0.9.3 and later) and Secure Transport (on iOS 5 or later,
27425 *   or OS X 10.7 or later) also support "P12" for PKCS#12-encoded files.
27426 *   Defaults to "PEM". Available since PHP 7.3.0 and libcurl >= cURL
27427 *   7.52.0. CURLOPT_PROXY_SSL_CIPHER_LIST The list of ciphers to use for
27428 *   the connection to the HTTPS proxy. The list must be syntactically
27429 *   correct, it consists of one or more cipher strings separated by
27430 *   colons. Commas or spaces are also acceptable separators but colons
27431 *   are normally used, !, - and + can be used as operators. Available
27432 *   since PHP 7.3.0 and libcurl >= cURL 7.52.0.
27433 *   CURLOPT_PROXY_TLS13_CIPHERS The list of cipher suites to use for the
27434 *   TLS 1.3 connection to a proxy. The list must be syntactically
27435 *   correct, it consists of one or more cipher suite strings separated
27436 *   by colons. This option is currently used only when curl is built to
27437 *   use OpenSSL 1.1.1 or later. If you are using a different SSL backend
27438 *   you can try setting TLS 1.3 cipher suites by using the
27439 *   CURLOPT_PROXY_SSL_CIPHER_LIST option. Available since PHP 7.3.0 and
27440 *   libcurl >= cURL 7.61.0. Available when built with OpenSSL >= 1.1.1.
27441 *   CURLOPT_PROXY_SSLKEY The file name of your private key used for
27442 *   connecting to the HTTPS proxy. The default format is "PEM" and can
27443 *   be changed with CURLOPT_PROXY_SSLKEYTYPE. (iOS and Mac OS X only)
27444 *   This option is ignored if curl was built against Secure Transport.
27445 *   Available since PHP 7.3.0 and libcurl >= cURL 7.52.0. Available if
27446 *   built TLS enabled. CURLOPT_PROXY_SSLKEYTYPE The format of your
27447 *   private key. Supported formats are "PEM", "DER" and "ENG". Available
27448 *   since PHP 7.3.0 and libcurl >= cURL 7.52.0.
27449 *   CURLOPT_PROXY_TLSAUTH_PASSWORD The password to use for the TLS
27450 *   authentication method specified with the CURLOPT_PROXY_TLSAUTH_TYPE
27451 *   option. Requires that the CURLOPT_PROXY_TLSAUTH_USERNAME option to
27452 *   also be set. Available since PHP 7.3.0 and libcurl >= cURL 7.52.0.
27453 *   CURLOPT_PROXY_TLSAUTH_TYPE The method of the TLS authentication used
27454 *   for the HTTPS connection. Supported method is "SRP". Secure Remote
27455 *   Password (SRP) authentication for TLS provides mutual authentication
27456 *   if both sides have a shared secret. To use TLS-SRP, you must also
27457 *   set the CURLOPT_PROXY_TLSAUTH_USERNAME and
27458 *   CURLOPT_PROXY_TLSAUTH_PASSWORD options. Available since PHP 7.3.0
27459 *   and libcurl >= cURL 7.52.0. CURLOPT_PROXY_TLSAUTH_USERNAME Tusername
27460 *   to use for the HTTPS proxy TLS authentication method specified with
27461 *   the CURLOPT_PROXY_TLSAUTH_TYPE option. Requires that the
27462 *   CURLOPT_PROXY_TLSAUTH_PASSWORD option to also be set. Available
27463 *   since PHP 7.3.0 and libcurl >= cURL 7.52.0. CURLOPT_PROXYUSERPWD A
27464 *   username and password formatted as "[username]:[password]" to use
27465 *   for the connection to the proxy. CURLOPT_RANDOM_FILE A filename to
27466 *   be used to seed the random number generator for SSL. CURLOPT_RANGE
27467 *   Range(s) of data to retrieve in the format "X-Y" where X or Y are
27468 *   optional. HTTP transfers also support several intervals, separated
27469 *   with commas in the format "X-Y,N-M". CURLOPT_REFERER The contents of
27470 *   the "Referer: " header to be used in a HTTP request.
27471 *   CURLOPT_SERVICE_NAME The authentication service name. Added in cURL
27472 *   7.43.0. Available since PHP 7.0.7. CURLOPT_SSH_HOST_PUBLIC_KEY_MD5 A
27473 *   string containing 32 hexadecimal digits. The string should be the
27474 *   MD5 checksum of the remote host's public key, and libcurl will
27475 *   reject the connection to the host unless the md5sums match. This
27476 *   option is only for SCP and SFTP transfers. Added in cURL 7.17.1.
27477 *   CURLOPT_SSH_PUBLIC_KEYFILE The file name for your public key. If not
27478 *   used, libcurl defaults to $HOME/.ssh/id_dsa.pub if the HOME
27479 *   environment variable is set, and just "id_dsa.pub" in the current
27480 *   directory if HOME is not set. Added in cURL 7.16.1.
27481 *   CURLOPT_SSH_PRIVATE_KEYFILE The file name for your private key. If
27482 *   not used, libcurl defaults to $HOME/.ssh/id_dsa if the HOME
27483 *   environment variable is set, and just "id_dsa" in the current
27484 *   directory if HOME is not set. If the file is password-protected, set
27485 *   the password with CURLOPT_KEYPASSWD. Added in cURL 7.16.1.
27486 *   CURLOPT_SSL_CIPHER_LIST A list of ciphers to use for SSL. For
27487 *   example, RC4-SHA and TLSv1 are valid cipher lists. CURLOPT_SSLCERT
27488 *   The name of a file containing a PEM formatted certificate.
27489 *   CURLOPT_SSLCERTPASSWD The password required to use the
27490 *   CURLOPT_SSLCERT certificate. CURLOPT_SSLCERTTYPE The format of the
27491 *   certificate. Supported formats are "PEM" (default), "DER", and
27492 *   "ENG". As of OpenSSL 0.9.3, "P12" (for PKCS#12-encoded files) is
27493 *   also supported. Added in cURL 7.9.3. CURLOPT_SSLENGINE The
27494 *   identifier for the crypto engine of the private SSL key specified in
27495 *   CURLOPT_SSLKEY. CURLOPT_SSLENGINE_DEFAULT The identifier for the
27496 *   crypto engine used for asymmetric crypto operations. CURLOPT_SSLKEY
27497 *   The name of a file containing a private SSL key.
27498 *   CURLOPT_SSLKEYPASSWD The secret password needed to use the private
27499 *   SSL key specified in CURLOPT_SSLKEY. Since this option contains a
27500 *   sensitive password, remember to keep the PHP script it is contained
27501 *   within safe. CURLOPT_SSLKEYTYPE The key type of the private SSL key
27502 *   specified in CURLOPT_SSLKEY. Supported key types are "PEM"
27503 *   (default), "DER", and "ENG". CURLOPT_TLS13_CIPHERS The list of
27504 *   cipher suites to use for the TLS 1.3 connection. The list must be
27505 *   syntactically correct, it consists of one or more cipher suite
27506 *   strings separated by colons. This option is currently used only when
27507 *   curl is built to use OpenSSL 1.1.1 or later. If you are using a
27508 *   different SSL backend you can try setting TLS 1.3 cipher suites by
27509 *   using the CURLOPT_SSL_CIPHER_LIST option. Available since PHP 7.3.0
27510 *   and libcurl >= cURL 7.61.0. Available when built with OpenSSL >=
27511 *   1.1.1. CURLOPT_UNIX_SOCKET_PATH Enables the use of Unix domain
27512 *   sockets as connection endpoint and sets the path to the given
27513 *   string. Added in cURL 7.40.0. Available since PHP 7.0.7. CURLOPT_URL
27514 *   The URL to fetch. This can also be set when initializing a session
27515 *   with {@link curl_init}. CURLOPT_USERAGENT The contents of the
27516 *   "User-Agent: " header to be used in a HTTP request. CURLOPT_USERNAME
27517 *   The user name to use in authentication. Added in cURL 7.19.1.
27518 *   Available since PHP 5.5.0. CURLOPT_USERPWD A username and password
27519 *   formatted as "[username]:[password]" to use for the connection.
27520 *   CURLOPT_XOAUTH2_BEARER Specifies the OAuth 2.0 access token. Added
27521 *   in cURL 7.33.0. Available since PHP 7.0.7. {@link value} should be
27522 *   an array for the following values of the {@link option} parameter:
27523 *   Option Set {@link value} to Notes CURLOPT_CONNECT_TO Connect to a
27524 *   specific host and port instead of the URL's host and port. Accepts
27525 *   an array of strings with the format
27526 *   HOST:PORT:CONNECT-TO-HOST:CONNECT-TO-PORT. Added in cURL 7.49.0.
27527 *   Available since PHP 7.0.7. CURLOPT_HTTP200ALIASES An array of HTTP
27528 *   200 responses that will be treated as valid responses and not as
27529 *   errors. Added in cURL 7.10.3. CURLOPT_HTTPHEADER An array of HTTP
27530 *   header fields to set, in the format array('Content-type:
27531 *   text/plain', 'Content-length: 100') CURLOPT_POSTQUOTE An array of
27532 *   FTP commands to execute on the server after the FTP request has been
27533 *   performed. CURLOPT_PROXYHEADER An array of custom HTTP headers to
27534 *   pass to proxies. Added in cURL 7.37.0. Available since PHP 7.0.7.
27535 *   CURLOPT_QUOTE An array of FTP commands to execute on the server
27536 *   prior to the FTP request. CURLOPT_RESOLVE Provide a custom address
27537 *   for a specific host and port pair. An array of hostname, port, and
27538 *   IP address strings, each element separated by a colon. In the
27539 *   format: array("example.com:80:127.0.0.1") Added in cURL 7.21.3.
27540 *   Available since PHP 5.5.0. {@link value} should be a stream resource
27541 *   (using {@link fopen}, for example) for the following values of the
27542 *   {@link option} parameter: Option Set {@link value} to CURLOPT_FILE
27543 *   The file that the transfer should be written to. The default is
27544 *   STDOUT (the browser window). CURLOPT_INFILE The file that the
27545 *   transfer should be read from when uploading. CURLOPT_STDERR An
27546 *   alternative location to output errors to instead of STDERR.
27547 *   CURLOPT_WRITEHEADER The file that the header part of the transfer is
27548 *   written to. {@link value} should be the name of a valid function or
27549 *   a Closure for the following values of the {@link option} parameter:
27550 *   Option Set {@link value} to CURLOPT_HEADERFUNCTION A callback
27551 *   accepting two parameters. The first is the cURL resource, the second
27552 *   is a string with the header data to be written. The header data must
27553 *   be written by this callback. Return the number of bytes written.
27554 *   CURLOPT_PASSWDFUNCTION A callback accepting three parameters. The
27555 *   first is the cURL resource, the second is a string containing a
27556 *   password prompt, and the third is the maximum password length.
27557 *   Return the string containing the password. CURLOPT_PROGRESSFUNCTION
27558 *   A callback accepting five parameters. The first is the cURL
27559 *   resource, the second is the total number of bytes expected to be
27560 *   downloaded in this transfer, the third is the number of bytes
27561 *   downloaded so far, the fourth is the total number of bytes expected
27562 *   to be uploaded in this transfer, and the fifth is the number of
27563 *   bytes uploaded so far. The callback is only called when the
27564 *   CURLOPT_NOPROGRESS option is set to FALSE. Return a non-zero value
27565 *   to abort the transfer. In which case, the transfer will set a
27566 *   CURLE_ABORTED_BY_CALLBACK error. CURLOPT_READFUNCTION A callback
27567 *   accepting three parameters. The first is the cURL resource, the
27568 *   second is a stream resource provided to cURL through the option
27569 *   CURLOPT_INFILE, and the third is the maximum amount of data to be
27570 *   read. The callback must return a string with a length equal or
27571 *   smaller than the amount of data requested, typically by reading it
27572 *   from the passed stream resource. It should return an empty string to
27573 *   signal EOF. CURLOPT_WRITEFUNCTION A callback accepting two
27574 *   parameters. The first is the cURL resource, and the second is a
27575 *   string with the data to be written. The data must be saved by this
27576 *   callback. It must return the exact number of bytes written or the
27577 *   transfer will be aborted with an error. Other values: Option Set
27578 *   {@link value} to CURLOPT_SHARE A result of {@link curl_share_init}.
27579 *   Makes the cURL handle to use the data from the shared handle.
27580 * @param mixed $value
27581 * @return bool
27582 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
27583 **/
27584function curl_setopt($ch, $option, $value){}
27585
27586/**
27587 * Set multiple options for a cURL transfer
27588 *
27589 * Sets multiple options for a cURL session. This function is useful for
27590 * setting a large number of cURL options without repetitively calling
27591 * {@link curl_setopt}.
27592 *
27593 * @param resource $ch An array specifying which options to set and
27594 *   their values. The keys should be valid {@link curl_setopt} constants
27595 *   or their integer equivalents.
27596 * @param array $options
27597 * @return bool Returns TRUE if all options were successfully set. If
27598 *   an option could not be successfully set, FALSE is immediately
27599 *   returned, ignoring any future options in the {@link options} array.
27600 * @since PHP 5 >= 5.1.3, PHP 7
27601 **/
27602function curl_setopt_array($ch, $options){}
27603
27604/**
27605 * Close a cURL share handle
27606 *
27607 * Closes a cURL share handle and frees all resources.
27608 *
27609 * @param resource $sh A cURL share handle returned by {@link
27610 *   curl_share_init}
27611 * @return void
27612 * @since PHP 5 >= 5.5.0, PHP 7
27613 **/
27614function curl_share_close($sh){}
27615
27616/**
27617 * Return the last share curl error number
27618 *
27619 * Return an integer containing the last share curl error number.
27620 *
27621 * @param resource $sh A cURL share handle returned by {@link
27622 *   curl_share_init}.
27623 * @return int Returns an integer containing the last share curl error
27624 *   number, .
27625 * @since PHP 7 >= 7.1.0
27626 **/
27627function curl_share_errno($sh){}
27628
27629/**
27630 * Initialize a cURL share handle
27631 *
27632 * Allows to share data between cURL handles.
27633 *
27634 * @return resource Returns resource of type "cURL Share Handle".
27635 * @since PHP 5 >= 5.5.0, PHP 7
27636 **/
27637function curl_share_init(){}
27638
27639/**
27640 * Set an option for a cURL share handle
27641 *
27642 * Sets an option on the given cURL share handle.
27643 *
27644 * @param resource $sh A cURL share handle returned by {@link
27645 *   curl_share_init}.
27646 * @param int $option Option Description CURLSHOPT_SHARE Specifies a
27647 *   type of data that should be shared. CURLSHOPT_UNSHARE Specifies a
27648 *   type of data that will be no longer shared.
27649 * @param mixed $value Value Description CURL_LOCK_DATA_COOKIE Shares
27650 *   cookie data. CURL_LOCK_DATA_DNS Shares DNS cache. Note that when you
27651 *   use cURL multi handles, all handles added to the same multi handle
27652 *   will share DNS cache by default. CURL_LOCK_DATA_SSL_SESSION Shares
27653 *   SSL session IDs, reducing the time spent on the SSL handshake when
27654 *   reconnecting to the same server. Note that SSL session IDs are
27655 *   reused within the same handle by default.
27656 * @return bool
27657 * @since PHP 5 >= 5.5.0, PHP 7
27658 **/
27659function curl_share_setopt($sh, $option, $value){}
27660
27661/**
27662 * Return string describing the given error code
27663 *
27664 * Returns a text error message describing the given error code.
27665 *
27666 * @param int $errornum One of the cURL error codes constants.
27667 * @return string Returns error description or NULL for invalid error
27668 *   code.
27669 * @since PHP 7 >= 7.1.0
27670 **/
27671function curl_share_strerror($errornum){}
27672
27673/**
27674 * Return string describing the given error code
27675 *
27676 * Returns a text error message describing the given error code.
27677 *
27678 * @param int $errornum One of the cURL error codes constants.
27679 * @return string Returns error description or NULL for invalid error
27680 *   code.
27681 * @since PHP 5 >= 5.5.0, PHP 7
27682 **/
27683function curl_strerror($errornum){}
27684
27685/**
27686 * Decodes the given URL encoded string
27687 *
27688 * This function decodes the given URL encoded string.
27689 *
27690 * @param resource $ch The URL encoded string to be decoded.
27691 * @param string $str
27692 * @return string Returns decoded string .
27693 * @since PHP 5 >= 5.5.0, PHP 7
27694 **/
27695function curl_unescape($ch, $str){}
27696
27697/**
27698 * Gets cURL version information
27699 *
27700 * Returns information about the cURL version.
27701 *
27702 * @param int $age
27703 * @return array Returns an associative array with the following
27704 *   elements: Key Value description version_number cURL 24 bit version
27705 *   number version cURL version number, as a string ssl_version_number
27706 *   OpenSSL 24 bit version number ssl_version OpenSSL version number, as
27707 *   a string libz_version zlib version number, as a string host
27708 *   Information about the host where cURL was built age features A
27709 *   bitmask of the CURL_VERSION_XXX constants protocols An array of
27710 *   protocols names supported by cURL
27711 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
27712 **/
27713function curl_version($age){}
27714
27715/**
27716 * Return the current element in an array
27717 *
27718 * Every array has an internal pointer to its "current" element, which is
27719 * initialized to the first element inserted into the array.
27720 *
27721 * @param array $array The array.
27722 * @return mixed The {@link current} function simply returns the value
27723 *   of the array element that's currently being pointed to by the
27724 *   internal pointer. It does not move the pointer in any way. If the
27725 *   internal pointer points beyond the end of the elements list or the
27726 *   array is empty, {@link current} returns FALSE.
27727 * @since PHP 4, PHP 5, PHP 7
27728 **/
27729function current($array){}
27730
27731/**
27732 * Authenticate against a Cyrus IMAP server
27733 *
27734 * @param resource $connection
27735 * @param string $mechlist
27736 * @param string $service
27737 * @param string $user
27738 * @param int $minssf
27739 * @param int $maxssf
27740 * @param string $authname
27741 * @param string $password
27742 * @return void
27743 * @since PHP 4 >= 4.1.0, PECL cyrus 1.0
27744 **/
27745function cyrus_authenticate($connection, $mechlist, $service, $user, $minssf, $maxssf, $authname, $password){}
27746
27747/**
27748 * Bind callbacks to a Cyrus IMAP connection
27749 *
27750 * Binds callbacks to a Cyrus IMAP connection.
27751 *
27752 * @param resource $connection The connection handle.
27753 * @param array $callbacks An array of callbacks.
27754 * @return bool
27755 * @since PHP 4 >= 4.1.0, PECL cyrus 1.0
27756 **/
27757function cyrus_bind($connection, $callbacks){}
27758
27759/**
27760 * Close connection to a Cyrus IMAP server
27761 *
27762 * Closes the connection to a Cyrus IMAP server.
27763 *
27764 * @param resource $connection The connection handle.
27765 * @return bool
27766 * @since PHP 4 >= 4.1.0, PECL cyrus 1.0
27767 **/
27768function cyrus_close($connection){}
27769
27770/**
27771 * Connect to a Cyrus IMAP server
27772 *
27773 * Connects to a Cyrus IMAP server.
27774 *
27775 * @param string $host The Cyrus IMAP host name.
27776 * @param string $port The port number.
27777 * @param int $flags
27778 * @return resource Returns a connection handler on success.
27779 * @since PHP 4 >= 4.1.0, PECL cyrus 1.0
27780 **/
27781function cyrus_connect($host, $port, $flags){}
27782
27783/**
27784 * Send a query to a Cyrus IMAP server
27785 *
27786 * Sends a query to a Cyrus IMAP server.
27787 *
27788 * @param resource $connection The connection handle.
27789 * @param string $query The query string.
27790 * @return array Returns an associative array with the following keys:
27791 *   text, msgno, and keyword.
27792 * @since PHP 4 >= 4.1.0, PECL cyrus 1.0
27793 **/
27794function cyrus_query($connection, $query){}
27795
27796/**
27797 * Unbind ...
27798 *
27799 * @param resource $connection The connection handle.
27800 * @param string $trigger_name The trigger name.
27801 * @return bool
27802 * @since PHP 4 >= 4.1.0, PECL cyrus 1.0
27803 **/
27804function cyrus_unbind($connection, $trigger_name){}
27805
27806/**
27807 * Format a local time/date
27808 *
27809 * Returns a string formatted according to the given format string using
27810 * the given integer {@link timestamp} or the current time if no
27811 * timestamp is given. In other words, {@link timestamp} is optional and
27812 * defaults to the value of {@link time}.
27813 *
27814 * @param string $format Format accepted by {@link
27815 *   DateTimeInterface::format}.
27816 * @param int $timestamp
27817 * @return string Returns a formatted date string. If a non-numeric
27818 *   value is used for {@link timestamp}, FALSE is returned and an
27819 *   E_WARNING level error is emitted.
27820 * @since PHP 4, PHP 5, PHP 7
27821 **/
27822function date($format, $timestamp){}
27823
27824/**
27825 * Create a date formatter
27826 *
27827 * (constructor)
27828 *
27829 * @param string $locale Locale to use when formatting or parsing or
27830 *   NULL to use the value specified in the ini setting
27831 *   intl.default_locale.
27832 * @param int $datetype Date type to use (none, short, medium, long,
27833 *   full). This is one of the IntlDateFormatter constants. It can also
27834 *   be NULL, in which case ICUʼs default date type will be used.
27835 * @param int $timetype Time type to use (none, short, medium, long,
27836 *   full). This is one of the IntlDateFormatter constants. It can also
27837 *   be NULL, in which case ICUʼs default time type will be used.
27838 * @param mixed $timezone Time zone ID. The default (and the one used
27839 *   if NULL is given) is the one returned by {@link
27840 *   date_default_timezone_get} or, if applicable, that of the
27841 *   IntlCalendar object passed for the {@link calendar} parameter. This
27842 *   ID must be a valid identifier on ICUʼs database or an ID
27843 *   representing an explicit offset, such as GMT-05:30. This can also be
27844 *   an IntlTimeZone or a DateTimeZone object.
27845 * @param mixed $calendar Calendar to use for formatting or parsing.
27846 *   The default value is NULL, which corresponds to
27847 *   IntlDateFormatter::GREGORIAN. This can either be one of the
27848 *   IntlDateFormatter calendar constants or an IntlCalendar. Any
27849 *   IntlCalendar object passed will be clone; it will not be changed by
27850 *   the IntlDateFormatter. This will determine the calendar type used
27851 *   (gregorian, islamic, persian, etc.) and, if NULL is given for the
27852 *   {@link timezone} parameter, also the timezone used.
27853 * @param string $pattern Optional pattern to use when formatting or
27854 *   parsing. Possible patterns are documented at .
27855 * @return IntlDateFormatter The created IntlDateFormatter or FALSE in
27856 *   case of failure.
27857 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
27858 **/
27859function datefmt_create($locale, $datetype, $timetype, $timezone, $calendar, $pattern){}
27860
27861/**
27862 * Format the date/time value as a string
27863 *
27864 * Formats the time value as a string.
27865 *
27866 * @param IntlDateFormatter $fmt The date formatter resource.
27867 * @param mixed $value Value to format. This may be a DateTimeInterface
27868 *   object, an IntlCalendar object, a numeric type representing a
27869 *   (possibly fractional) number of seconds since epoch or an array in
27870 *   the format output by {@link localtime}. If a DateTime or an
27871 *   IntlCalendar object is passed, its timezone is not considered. The
27872 *   object will be formatted using the formaterʼs configured timezone.
27873 *   If one wants to use the timezone of the object to be formatted,
27874 *   {@link IntlDateFormatter::setTimeZone} must be called before with
27875 *   the objectʼs timezone. Alternatively, the static function {@link
27876 *   IntlDateFormatter::formatObject} may be used instead.
27877 * @return string The formatted string or, if an error occurred, FALSE.
27878 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
27879 **/
27880function datefmt_format($fmt, $value){}
27881
27882/**
27883 * Formats an object
27884 *
27885 * This function allows formatting an IntlCalendar or DateTime object
27886 * without first explicitly creating a IntlDateFormatter object.
27887 *
27888 * The temporary IntlDateFormatter that will be created will take the
27889 * timezone from the passed in object. The timezone database bundled with
27890 * PHP will not be used – ICU's will be used instead. The timezone
27891 * identifier used in DateTime objects must therefore also exist in ICU's
27892 * database.
27893 *
27894 * @param object $object An object of type IntlCalendar or DateTime.
27895 *   The timezone information in the object will be used.
27896 * @param mixed $format How to format the date/time. This can either be
27897 *   an array with two elements (first the date style, then the time
27898 *   style, these being one of the constants IntlDateFormatter::NONE,
27899 *   IntlDateFormatter::SHORT, IntlDateFormatter::MEDIUM,
27900 *   IntlDateFormatter::LONG, IntlDateFormatter::FULL), an integer with
27901 *   the value of one of these constants (in which case it will be used
27902 *   both for the time and the date) or a string with the format
27903 *   described in the ICU documentation. If NULL, the default style will
27904 *   be used.
27905 * @param string $locale The locale to use, or NULL to use the default
27906 *   one.
27907 * @return string A string with result.
27908 * @since PHP 5 >= 5.5.0, PHP 7
27909 **/
27910function datefmt_format_object($object, $format, $locale){}
27911
27912/**
27913 * Get the calendar type used for the IntlDateFormatter
27914 *
27915 * @param IntlDateFormatter $fmt The formatter resource
27916 * @return int The calendar type being used by the formatter. Either
27917 *   IntlDateFormatter::TRADITIONAL or IntlDateFormatter::GREGORIAN.
27918 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
27919 **/
27920function datefmt_get_calendar($fmt){}
27921
27922/**
27923 * Get copy of formatterʼs calendar object
27924 *
27925 * Obtain a copy of the calendar object used internally by this
27926 * formatter. This calendar will have a type (as in gregorian, japanese,
27927 * buddhist, roc, persian, islamic, etc.) and a timezone that match the
27928 * type and timezone used by the formatter. The date/time of the object
27929 * is unspecified.
27930 *
27931 * @return IntlCalendar A copy of the internal calendar object used by
27932 *   this formatter.
27933 * @since PHP 5 >= 5.5.0, PHP 7
27934 **/
27935function datefmt_get_calendar_object(){}
27936
27937/**
27938 * Get the datetype used for the IntlDateFormatter
27939 *
27940 * Returns date type used by the formatter.
27941 *
27942 * @param IntlDateFormatter $fmt The formatter resource.
27943 * @return int The current date type value of the formatter.
27944 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
27945 **/
27946function datefmt_get_datetype($fmt){}
27947
27948/**
27949 * Get the error code from last operation
27950 *
27951 * Get the error code from last operation. Returns error code from the
27952 * last number formatting operation.
27953 *
27954 * @param IntlDateFormatter $fmt The formatter resource.
27955 * @return int The error code, one of UErrorCode values. Initial value
27956 *   is U_ZERO_ERROR.
27957 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
27958 **/
27959function datefmt_get_error_code($fmt){}
27960
27961/**
27962 * Get the error text from the last operation
27963 *
27964 * @param IntlDateFormatter $fmt The formatter resource.
27965 * @return string Description of the last error.
27966 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
27967 **/
27968function datefmt_get_error_message($fmt){}
27969
27970/**
27971 * Get the locale used by formatter
27972 *
27973 * Get locale used by the formatter.
27974 *
27975 * @param IntlDateFormatter $fmt The formatter resource
27976 * @param int $which You can choose between valid and actual locale (
27977 *   Locale::VALID_LOCALE, Locale::ACTUAL_LOCALE, respectively). The
27978 *   default is the actual locale.
27979 * @return string the locale of this formatter or 'false' if error
27980 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
27981 **/
27982function datefmt_get_locale($fmt, $which){}
27983
27984/**
27985 * Get the pattern used for the IntlDateFormatter
27986 *
27987 * Get pattern used by the formatter.
27988 *
27989 * @param IntlDateFormatter $fmt The formatter resource.
27990 * @return string The pattern string being used to format/parse.
27991 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
27992 **/
27993function datefmt_get_pattern($fmt){}
27994
27995/**
27996 * Get the timetype used for the IntlDateFormatter
27997 *
27998 * Return time type used by the formatter.
27999 *
28000 * @param IntlDateFormatter $fmt The formatter resource.
28001 * @return int The current date type value of the formatter.
28002 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
28003 **/
28004function datefmt_get_timetype($fmt){}
28005
28006/**
28007 * Get formatterʼs timezone
28008 *
28009 * Returns an IntlTimeZone object representing the timezone that will be
28010 * used by this object to format dates and times. When formatting
28011 * IntlCalendar and DateTime objects with this IntlDateFormatter, the
28012 * timezone used will be the one returned by this method, not the one
28013 * associated with the objects being formatted.
28014 *
28015 * @return IntlTimeZone The associated IntlTimeZone object.
28016 * @since PHP 5 >= 5.5.0, PHP 7
28017 **/
28018function datefmt_get_timezone(){}
28019
28020/**
28021 * Get the timezone-id used for the IntlDateFormatter
28022 *
28023 * @param IntlDateFormatter $fmt The formatter resource.
28024 * @return string ID string for the time zone used by this formatter.
28025 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
28026 **/
28027function datefmt_get_timezone_id($fmt){}
28028
28029/**
28030 * Get the lenient used for the IntlDateFormatter
28031 *
28032 * Check if the parser is strict or lenient in interpreting inputs that
28033 * do not match the pattern exactly.
28034 *
28035 * @param IntlDateFormatter $fmt The formatter resource.
28036 * @return bool TRUE if parser is lenient, FALSE if parser is strict.
28037 *   By default the parser is lenient.
28038 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
28039 **/
28040function datefmt_is_lenient($fmt){}
28041
28042/**
28043 * Parse string to a field-based time value
28044 *
28045 * Converts string $value to a field-based time value ( an array of
28046 * various fields), starting at $parse_pos and consuming as much of the
28047 * input value as possible.
28048 *
28049 * @param IntlDateFormatter $fmt The formatter resource
28050 * @param string $value string to convert to a time
28051 * @param int $position Position at which to start the parsing in
28052 *   $value (zero-based). If no error occurs before $value is consumed,
28053 *   $parse_pos will contain -1 otherwise it will contain the position at
28054 *   which parsing ended . If $parse_pos > strlen($value), the parse
28055 *   fails immediately.
28056 * @return array Localtime compatible array of integers : contains 24
28057 *   hour clock value in tm_hour field
28058 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
28059 **/
28060function datefmt_localtime($fmt, $value, &$position){}
28061
28062/**
28063 * Parse string to a timestamp value
28064 *
28065 * Converts string $value to an incremental time value, starting at
28066 * $parse_pos and consuming as much of the input value as possible.
28067 *
28068 * @param IntlDateFormatter $fmt The formatter resource
28069 * @param string $value string to convert to a time
28070 * @param int $position Position at which to start the parsing in
28071 *   $value (zero-based). If no error occurs before $value is consumed,
28072 *   $parse_pos will contain -1 otherwise it will contain the position at
28073 *   which parsing ended (and the error occurred). This variable will
28074 *   contain the end position if the parse fails. If $parse_pos >
28075 *   strlen($value), the parse fails immediately.
28076 * @return int timestamp parsed value, or FALSE if value can't be
28077 *   parsed.
28078 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
28079 **/
28080function datefmt_parse($fmt, $value, &$position){}
28081
28082/**
28083 * Sets the calendar type used by the formatter
28084 *
28085 * Sets the calendar or calendar type used by the formatter.
28086 *
28087 * @param IntlDateFormatter $fmt The formatter resource.
28088 * @param mixed $which This can either be: the calendar type to use
28089 *   (default is IntlDateFormatter::GREGORIAN, which is also used if NULL
28090 *   is specified) or an IntlCalendar object. Any IntlCalendar object
28091 *   passed in will be cloned; no modifications will be made to the
28092 *   argument object. The timezone of the formatter will only be kept if
28093 *   an IntlCalendar object is not passed, otherwise the new timezone
28094 *   will be that of the passed object.
28095 * @return bool
28096 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
28097 **/
28098function datefmt_set_calendar($fmt, $which){}
28099
28100/**
28101 * Set the leniency of the parser
28102 *
28103 * Define if the parser is strict or lenient in interpreting inputs that
28104 * do not match the pattern exactly. Enabling lenient parsing allows the
28105 * parser to accept otherwise flawed date or time patterns, parsing as
28106 * much as possible to obtain a value. Extra space, unrecognized tokens,
28107 * or invalid values ("February 30th") are not accepted.
28108 *
28109 * @param IntlDateFormatter $fmt The formatter resource
28110 * @param bool $lenient Sets whether the parser is lenient or not,
28111 *   default is TRUE (lenient).
28112 * @return bool
28113 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
28114 **/
28115function datefmt_set_lenient($fmt, $lenient){}
28116
28117/**
28118 * Set the pattern used for the IntlDateFormatter
28119 *
28120 * @param IntlDateFormatter $fmt The formatter resource.
28121 * @param string $pattern New pattern string to use. Possible patterns
28122 *   are documented at .
28123 * @return bool Bad formatstrings are usually the cause of the failure.
28124 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
28125 **/
28126function datefmt_set_pattern($fmt, $pattern){}
28127
28128/**
28129 * Sets formatterʼs timezone
28130 *
28131 * Sets the timezone used for the IntlDateFormatter. object.
28132 *
28133 * @param IntlDateFormatter $fmt The formatter resource.
28134 * @param mixed $zone The timezone to use for this formatter. This can
28135 *   be specified in the following forms:
28136 * @return bool Returns TRUE on success and FALSE on failure.
28137 * @since PHP 5 >= 5.5.0, PHP 7
28138 **/
28139function datefmt_set_timezone($fmt, $zone){}
28140
28141/**
28142 * Sets the time zone to use
28143 *
28144 * @param IntlDateFormatter $fmt The formatter resource.
28145 * @param string $zone The time zone ID string of the time zone to use.
28146 *   If NULL or the empty string, the default time zone for the runtime
28147 *   is used.
28148 * @return bool
28149 * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
28150 **/
28151function datefmt_set_timezone_id($fmt, $zone){}
28152
28153/**
28154 * Adds an amount of days, months, years, hours, minutes and seconds to a
28155 * DateTime object
28156 *
28157 * Adds the specified DateInterval object to the specified DateTime
28158 * object.
28159 *
28160 * @param DateTime $object A DateInterval object
28161 * @param DateInterval $interval
28162 * @return DateTime
28163 * @since PHP 5 >= 5.3.0, PHP 7
28164 **/
28165function date_add($object, $interval){}
28166
28167/**
28168 * Returns new DateTime object
28169 *
28170 * @param string $datetime Enter "now" here to obtain the current time
28171 *   when using the {@link $timezone} parameter.
28172 * @param DateTimeZone $timezone A DateTimeZone object representing the
28173 *   timezone of {@link $datetime}. If {@link $timezone} is omitted, the
28174 *   current timezone will be used.
28175 * @return DateTime Returns a new DateTime instance.
28176 * @since PHP 5 >= 5.2.0, PHP 7
28177 **/
28178function date_create($datetime, $timezone){}
28179
28180/**
28181 * Parses a time string according to a specified format
28182 *
28183 * Returns a new DateTime object representing the date and time specified
28184 * by the {@link datetime} string, which was formatted in the given
28185 * {@link format}.
28186 *
28187 * @param string $format The format that the passed in string should be
28188 *   in. See the formatting options below. In most cases, the same
28189 *   letters as for the {@link date} can be used.
28190 *
28191 *   The following characters are recognized in the {@link format}
28192 *   parameter string {@link format} character Description Example
28193 *   parsable values Day --- --- d and j Day of the month, 2 digits with
28194 *   or without leading zeros 01 to 31 or 1 to 31 D and l A textual
28195 *   representation of a day Mon through Sun or Sunday through Saturday S
28196 *   English ordinal suffix for the day of the month, 2 characters. It's
28197 *   ignored while processing. st, nd, rd or th. z The day of the year
28198 *   (starting from 0) 0 through 365 Month --- --- F and M A textual
28199 *   representation of a month, such as January or Sept January through
28200 *   December or Jan through Dec m and n Numeric representation of a
28201 *   month, with or without leading zeros 01 through 12 or 1 through 12
28202 *   Year --- --- Y A full numeric representation of a year, 4 digits
28203 *   Examples: 1999 or 2003 y A two digit representation of a year (which
28204 *   is assumed to be in the range 1970-2069, inclusive) Examples: 99 or
28205 *   03 (which will be interpreted as 1999 and 2003, respectively) Time
28206 *   --- --- a and A Ante meridiem and Post meridiem am or pm g and h
28207 *   12-hour format of an hour with or without leading zero 1 through 12
28208 *   or 01 through 12 G and H 24-hour format of an hour with or without
28209 *   leading zeros 0 through 23 or 00 through 23 i Minutes with leading
28210 *   zeros 00 to 59 s Seconds, with leading zeros 00 through 59 v
28211 *   Milliseconds (up to three digits) Example: 12, 345 u Microseconds
28212 *   (up to six digits) Example: 45, 654321 Timezone --- --- e, O, P and
28213 *   T Timezone identifier, or difference to UTC in hours, or difference
28214 *   to UTC with colon between hours and minutes, or timezone
28215 *   abbreviation Examples: UTC, GMT, Atlantic/Azores or +0200 or +02:00
28216 *   or EST, MDT Full Date/Time --- --- U Seconds since the Unix Epoch
28217 *   (January 1 1970 00:00:00 GMT) Example: 1292177455 Whitespace and
28218 *   Separators --- --- (space) One space or one tab Example: # One of
28219 *   the following separation symbol: ;, :, /, ., ,, -, ( or ) Example: /
28220 *   ;, :, /, ., ,, -, ( or ) The specified character. Example: - ? A
28221 *   random byte Example: ^ (Be aware that for UTF-8 characters you might
28222 *   need more than one ?. In this case, using * is probably what you
28223 *   want instead) * Random bytes until the next separator or digit
28224 *   Example: * in Y-*-d with the string 2009-aWord-08 will match aWord !
28225 *   Resets all fields (year, month, day, hour, minute, second, fraction
28226 *   and timezone information) to the Unix Epoch Without !, all fields
28227 *   will be set to the current date and time. | Resets all fields (year,
28228 *   month, day, hour, minute, second, fraction and timezone information)
28229 *   to the Unix Epoch if they have not been parsed yet Y-m-d| will set
28230 *   the year, month and day to the information found in the string to
28231 *   parse, and sets the hour, minute and second to 0. + If this format
28232 *   specifier is present, trailing data in the string will not cause an
28233 *   error, but a warning instead Use DateTime::getLastErrors to find out
28234 *   whether trailing data was present. Unrecognized characters in the
28235 *   format string will cause the parsing to fail and an error message is
28236 *   appended to the returned structure. You can query error messages
28237 *   with DateTime::getLastErrors. To include literal characters in
28238 *   {@link format}, you have to escape them with a backslash (\). If
28239 *   {@link format} does not contain the character ! then portions of the
28240 *   generated time which are not specified in {@link format} will be set
28241 *   to the current system time. If {@link format} contains the character
28242 *   !, then portions of the generated time not provided in {@link
28243 *   format}, as well as values to the left-hand side of the !, will be
28244 *   set to corresponding values from the Unix epoch. The Unix epoch is
28245 *   1970-01-01 00:00:00 UTC.
28246 * @param string $datetime String representing the time.
28247 * @param DateTimeZone $timezone A DateTimeZone object representing the
28248 *   desired time zone. If {@link timezone} is omitted and {@link
28249 *   datetime} contains no timezone, the current timezone will be used.
28250 * @return DateTime Returns a new DateTime instance.
28251 * @since PHP 5 >= 5.3.0, PHP 7
28252 **/
28253function date_create_from_format($format, $datetime, $timezone){}
28254
28255/**
28256 * Returns new DateTimeImmutable object
28257 *
28258 * Like DateTime::__construct but works with DateTimeImmutable.
28259 *
28260 * @param string $datetime
28261 * @param DateTimeZone $timezone
28262 * @return DateTimeImmutable
28263 * @since PHP 5 >= 5.5.0, PHP 7
28264 **/
28265function date_create_immutable($datetime, $timezone){}
28266
28267/**
28268 * Parses a time string according to a specified format
28269 *
28270 * Like DateTime::createFromFormat but works with DateTimeImmutable.
28271 *
28272 * @param string $format
28273 * @param string $datetime
28274 * @param DateTimeZone $timezone
28275 * @return DateTimeImmutable
28276 * @since PHP 5 >= 5.5.0, PHP 7
28277 **/
28278function date_create_immutable_from_format($format, $datetime, $timezone){}
28279
28280/**
28281 * Sets the date
28282 *
28283 * Resets the current date of the DateTime object to a different date.
28284 *
28285 * @param DateTime $object Year of the date.
28286 * @param int $year Month of the date.
28287 * @param int $month Day of the date.
28288 * @param int $day
28289 * @return DateTime
28290 * @since PHP 5 >= 5.2.0, PHP 7
28291 **/
28292function date_date_set($object, $year, $month, $day){}
28293
28294/**
28295 * Gets the default timezone used by all date/time functions in a script
28296 *
28297 * In order of preference, this function returns the default timezone by:
28298 * Reading the timezone set using the {@link date_default_timezone_set}
28299 * function (if any) Prior to PHP 5.4.0 only: Reading the TZ environment
28300 * variable (if non empty) Reading the value of the date.timezone ini
28301 * option (if set) Prior to PHP 5.4.0 only: Querying the host operating
28302 * system (if supported and allowed by the OS). This uses an algorithm
28303 * that has to guess the timezone. This is by no means going to work
28304 * correctly for every situation. A warning is shown when this stage is
28305 * reached. Do not rely on it to be guessed correctly, and set
28306 * date.timezone to the correct timezone instead.
28307 *
28308 * If none of the above succeed, date_default_timezone_get will return a
28309 * default timezone of UTC.
28310 *
28311 * @return string Returns a string.
28312 * @since PHP 5 >= 5.1.0, PHP 7
28313 **/
28314function date_default_timezone_get(){}
28315
28316/**
28317 * Sets the default timezone used by all date/time functions in a script
28318 *
28319 * {@link date_default_timezone_set} sets the default timezone used by
28320 * all date/time functions.
28321 *
28322 * Instead of using this function to set the default timezone in your
28323 * script, you can also use the INI setting date.timezone to set the
28324 * default timezone.
28325 *
28326 * @param string $timezoneID The timezone identifier, like UTC,
28327 *   Africa/Lagos, Asia/Hong_Kong, or Europe/Lisbon. The list of valid
28328 *   identifiers is available in the .
28329 * @return bool This function returns FALSE if the {@link timezoneID}
28330 *   isn't valid, or TRUE otherwise.
28331 * @since PHP 5 >= 5.1.0, PHP 7
28332 **/
28333function date_default_timezone_set($timezoneID){}
28334
28335/**
28336 * Returns the difference between two DateTime objects
28337 *
28338 * Returns the difference between two DateTimeInterface objects.
28339 *
28340 * @param DateTimeInterface $originObject The date to compare to.
28341 * @param DateTimeInterface $targetObject Should the interval be forced
28342 *   to be positive?
28343 * @param bool $absolute
28344 * @return DateInterval The DateInterval object represents the
28345 *   difference between the two dates.
28346 * @since PHP 5 >= 5.3.0, PHP 7
28347 **/
28348function date_diff($originObject, $targetObject, $absolute){}
28349
28350/**
28351 * Returns date formatted according to given format
28352 *
28353 * @param DateTimeInterface $object The format of the outputted date
28354 *   string. See the formatting options below. There are also several
28355 *   predefined date constants that may be used instead, so for example
28356 *   DATE_RSS contains the format string 'D, d M Y H:i:s'.
28357 *
28358 *   The following characters are recognized in the {@link format}
28359 *   parameter string {@link format} character Description Example
28360 *   returned values Day --- --- d Day of the month, 2 digits with
28361 *   leading zeros 01 to 31 D A textual representation of a day, three
28362 *   letters Mon through Sun j Day of the month without leading zeros 1
28363 *   to 31 l (lowercase 'L') A full textual representation of the day of
28364 *   the week Sunday through Saturday N ISO-8601 numeric representation
28365 *   of the day of the week (added in PHP 5.1.0) 1 (for Monday) through 7
28366 *   (for Sunday) S English ordinal suffix for the day of the month, 2
28367 *   characters st, nd, rd or th. Works well with j w Numeric
28368 *   representation of the day of the week 0 (for Sunday) through 6 (for
28369 *   Saturday) z The day of the year (starting from 0) 0 through 365 Week
28370 *   --- --- W ISO-8601 week number of year, weeks starting on Monday
28371 *   Example: 42 (the 42nd week in the year) Month --- --- F A full
28372 *   textual representation of a month, such as January or March January
28373 *   through December m Numeric representation of a month, with leading
28374 *   zeros 01 through 12 M A short textual representation of a month,
28375 *   three letters Jan through Dec n Numeric representation of a month,
28376 *   without leading zeros 1 through 12 t Number of days in the given
28377 *   month 28 through 31 Year --- --- L Whether it's a leap year 1 if it
28378 *   is a leap year, 0 otherwise. o ISO-8601 week-numbering year. This
28379 *   has the same value as Y, except that if the ISO week number (W)
28380 *   belongs to the previous or next year, that year is used instead.
28381 *   (added in PHP 5.1.0) Examples: 1999 or 2003 Y A full numeric
28382 *   representation of a year, 4 digits Examples: 1999 or 2003 y A two
28383 *   digit representation of a year Examples: 99 or 03 Time --- --- a
28384 *   Lowercase Ante meridiem and Post meridiem am or pm A Uppercase Ante
28385 *   meridiem and Post meridiem AM or PM B Swatch Internet time 000
28386 *   through 999 g 12-hour format of an hour without leading zeros 1
28387 *   through 12 G 24-hour format of an hour without leading zeros 0
28388 *   through 23 h 12-hour format of an hour with leading zeros 01 through
28389 *   12 H 24-hour format of an hour with leading zeros 00 through 23 i
28390 *   Minutes with leading zeros 00 to 59 s Seconds with leading zeros 00
28391 *   through 59 u Microseconds (added in PHP 5.2.2). Note that {@link
28392 *   date} will always generate 000000 since it takes an integer
28393 *   parameter, whereas DateTime::format does support microseconds if
28394 *   DateTime was created with microseconds. Example: 654321 v
28395 *   Milliseconds (added in PHP 7.0.0). Same note applies as for u.
28396 *   Example: 654 Timezone --- --- e Timezone identifier (added in PHP
28397 *   5.1.0) Examples: UTC, GMT, Atlantic/Azores I (capital i) Whether or
28398 *   not the date is in daylight saving time 1 if Daylight Saving Time, 0
28399 *   otherwise. O Difference to Greenwich time (GMT) without colon
28400 *   between hours and minutes Example: +0200 P Difference to Greenwich
28401 *   time (GMT) with colon between hours and minutes (added in PHP 5.1.3)
28402 *   Example: +02:00 T Timezone abbreviation Examples: EST, MDT ... Z
28403 *   Timezone offset in seconds. The offset for timezones west of UTC is
28404 *   always negative, and for those east of UTC is always positive.
28405 *   -43200 through 50400 Full Date/Time --- --- c ISO 8601 date (added
28406 *   in PHP 5) 2004-02-12T15:19:21+00:00 r RFC 2822 formatted date
28407 *   Example: Thu, 21 Dec 2000 16:01:07 +0200 U Seconds since the Unix
28408 *   Epoch (January 1 1970 00:00:00 GMT) See also {@link time}
28409 *   Unrecognized characters in the format string will be printed as-is.
28410 *   The Z format will always return 0 when using {@link gmdate}.
28411 * @param string $format
28412 * @return string Returns the formatted date string on success.
28413 * @since PHP 5 >= 5.2.0, PHP 7
28414 **/
28415function date_format($object, $format){}
28416
28417/**
28418 * Returns the warnings and errors
28419 *
28420 * Returns an array of warnings and errors found while parsing a
28421 * date/time string.
28422 *
28423 * @return array Returns array containing info about warnings and
28424 *   errors.
28425 * @since PHP 5 >= 5.3.0, PHP 7
28426 **/
28427function date_get_last_errors(){}
28428
28429/**
28430 * Sets up a DateInterval from the relative parts of the string
28431 *
28432 * Uses the normal date parsers and sets up a DateInterval from the
28433 * relative parts of the parsed string.
28434 *
28435 * @param string $datetime A date with relative parts. Specifically,
28436 *   the relative formats supported by the parser used for {@link
28437 *   strtotime} and DateTime will be used to construct the DateInterval.
28438 * @return DateInterval Returns a new DateInterval instance.
28439 * @since PHP 5 >= 5.3.0, PHP 7
28440 **/
28441function date_interval_create_from_date_string($datetime){}
28442
28443/**
28444 * Formats the interval
28445 *
28446 * @param string $format The following characters are recognized in the
28447 *   {@link format} parameter string. Each format character must be
28448 *   prefixed by a percent sign (%). {@link format} character Description
28449 *   Example values % Literal % % Y Years, numeric, at least 2 digits
28450 *   with leading 0 01, 03 y Years, numeric 1, 3 M Months, numeric, at
28451 *   least 2 digits with leading 0 01, 03, 12 m Months, numeric 1, 3, 12
28452 *   D Days, numeric, at least 2 digits with leading 0 01, 03, 31 d Days,
28453 *   numeric 1, 3, 31 a Total number of days as a result of a
28454 *   DateTime::diff or (unknown) otherwise 4, 18, 8123 H Hours, numeric,
28455 *   at least 2 digits with leading 0 01, 03, 23 h Hours, numeric 1, 3,
28456 *   23 I Minutes, numeric, at least 2 digits with leading 0 01, 03, 59 i
28457 *   Minutes, numeric 1, 3, 59 S Seconds, numeric, at least 2 digits with
28458 *   leading 0 01, 03, 57 s Seconds, numeric 1, 3, 57 F Microseconds,
28459 *   numeric, at least 6 digits with leading 0 007701, 052738, 428291 f
28460 *   Microseconds, numeric 7701, 52738, 428291 R Sign "-" when negative,
28461 *   "+" when positive -, + r Sign "-" when negative, empty when positive
28462 *   -,
28463 * @return string Returns the formatted interval.
28464 * @since PHP 5 >= 5.3.0, PHP 7
28465 **/
28466function date_interval_format($format){}
28467
28468/**
28469 * Sets the ISO date
28470 *
28471 * Set a date according to the ISO 8601 standard - using weeks and day
28472 * offsets rather than specific dates.
28473 *
28474 * @param DateTime $object Year of the date.
28475 * @param int $year Week of the date.
28476 * @param int $week Offset from the first day of the week.
28477 * @param int $dayOfWeek
28478 * @return DateTime
28479 * @since PHP 5 >= 5.2.0, PHP 7
28480 **/
28481function date_isodate_set($object, $year, $week, $dayOfWeek){}
28482
28483/**
28484 * Alters the timestamp
28485 *
28486 * Alter the timestamp of a DateTime object by incrementing or
28487 * decrementing in a format accepted by {@link
28488 * DateTimeImmutable::__construct}.
28489 *
28490 * @param DateTime $object
28491 * @param string $modifier
28492 * @return DateTime
28493 * @since PHP 5 >= 5.2.0, PHP 7
28494 **/
28495function date_modify($object, $modifier){}
28496
28497/**
28498 * Returns the timezone offset
28499 *
28500 * @param DateTimeInterface $object
28501 * @return int Returns the timezone offset in seconds from UTC on
28502 *   success .
28503 * @since PHP 5 >= 5.2.0, PHP 7
28504 **/
28505function date_offset_get($object){}
28506
28507/**
28508 * Returns associative array with detailed info about given date/time
28509 *
28510 * @param string $datetime Date/time in format accepted by {@link
28511 *   DateTimeImmutable::__construct}.
28512 * @return array Returns array with information about the parsed
28513 *   date/time on success.
28514 * @since PHP 5 >= 5.2.0, PHP 7
28515 **/
28516function date_parse($datetime){}
28517
28518/**
28519 * Get info about given date formatted according to the specified format
28520 *
28521 * Returns associative array with detailed info about given date/time.
28522 *
28523 * @param string $format Format accepted by {@link
28524 *   DateTime::createFromFormat}.
28525 * @param string $datetime String representing the date/time.
28526 * @return array Returns associative array with detailed info about
28527 *   given date/time.
28528 * @since PHP 5 >= 5.3.0, PHP 7
28529 **/
28530function date_parse_from_format($format, $datetime){}
28531
28532/**
28533 * Subtracts an amount of days, months, years, hours, minutes and seconds
28534 * from a DateTime object
28535 *
28536 * Subtracts the specified DateInterval object from the specified
28537 * DateTime object.
28538 *
28539 * @param DateTime $object A DateInterval object
28540 * @param DateInterval $interval
28541 * @return DateTime
28542 * @since PHP 5 >= 5.3.0, PHP 7
28543 **/
28544function date_sub($object, $interval){}
28545
28546/**
28547 * Returns time of sunrise for a given day and location
28548 *
28549 * {@link date_sunrise} returns the sunrise time for a given day
28550 * (specified as a {@link timestamp}) and location.
28551 *
28552 * @param int $timestamp The {@link timestamp} of the day from which
28553 *   the sunrise time is taken.
28554 * @param int $returnFormat {@link returnFormat} constants constant
28555 *   description example SUNFUNCS_RET_STRING returns the result as string
28556 *   16:46 SUNFUNCS_RET_DOUBLE returns the result as float 16.78243132
28557 *   SUNFUNCS_RET_TIMESTAMP returns the result as integer (timestamp)
28558 *   1095034606
28559 * @param float $latitude Defaults to North, pass in a negative value
28560 *   for South. See also: date.default_latitude
28561 * @param float $longitude Defaults to East, pass in a negative value
28562 *   for West. See also: date.default_longitude
28563 * @param float $zenith {@link zenith} is the angle between the center
28564 *   of the sun and a line perpendicular to earth's surface. It defaults
28565 *   to date.sunrise_zenith Common {@link zenith} angles Angle
28566 *   Description 90°50' Sunrise: the point where the sun becomes
28567 *   visible. 96° Civil twilight: conventionally used to signify the
28568 *   start of dawn. 102° Nautical twilight: the point at which the
28569 *   horizon starts being visible at sea. 108° Astronomical twilight:
28570 *   the point at which the sun starts being the source of any
28571 *   illumination.
28572 * @param float $utcOffset Specified in hours. The {@link utcOffset} is
28573 *   ignored, if {@link returnFormat} is SUNFUNCS_RET_TIMESTAMP.
28574 * @return mixed Returns the sunrise time in a specified {@link
28575 *   returnFormat} on success. One potential reason for failure is that
28576 *   the sun does not rise at all, which happens inside the polar circles
28577 *   for part of the year.
28578 * @since PHP 5, PHP 7
28579 **/
28580function date_sunrise($timestamp, $returnFormat, $latitude, $longitude, $zenith, $utcOffset){}
28581
28582/**
28583 * Returns time of sunset for a given day and location
28584 *
28585 * {@link date_sunset} returns the sunset time for a given day (specified
28586 * as a {@link timestamp}) and location.
28587 *
28588 * @param int $timestamp The {@link timestamp} of the day from which
28589 *   the sunset time is taken.
28590 * @param int $returnFormat {@link returnFormat} constants constant
28591 *   description example SUNFUNCS_RET_STRING returns the result as string
28592 *   16:46 SUNFUNCS_RET_DOUBLE returns the result as float 16.78243132
28593 *   SUNFUNCS_RET_TIMESTAMP returns the result as integer (timestamp)
28594 *   1095034606
28595 * @param float $latitude Defaults to North, pass in a negative value
28596 *   for South. See also: date.default_latitude
28597 * @param float $longitude Defaults to East, pass in a negative value
28598 *   for West. See also: date.default_longitude
28599 * @param float $zenith {@link zenith} is the angle between the center
28600 *   of the sun and a line perpendicular to earth's surface. It defaults
28601 *   to date.sunset_zenith Common {@link zenith} angles Angle Description
28602 *   90°50' Sunset: the point where the sun becomes invisible. 96°
28603 *   Civil twilight: conventionally used to signify the end of dusk.
28604 *   102° Nautical twilight: the point at which the horizon ends being
28605 *   visible at sea. 108° Astronomical twilight: the point at which the
28606 *   sun ends being the source of any illumination.
28607 * @param float $utcOffset Specified in hours. The {@link utcOffset} is
28608 *   ignored, if {@link returnFormat} is SUNFUNCS_RET_TIMESTAMP.
28609 * @return mixed Returns the sunset time in a specified {@link
28610 *   returnFormat} on success. One potential reason for failure is that
28611 *   the sun does not set at all, which happens inside the polar circles
28612 *   for part of the year.
28613 * @since PHP 5, PHP 7
28614 **/
28615function date_sunset($timestamp, $returnFormat, $latitude, $longitude, $zenith, $utcOffset){}
28616
28617/**
28618 * Returns an array with information about sunset/sunrise and twilight
28619 * begin/end
28620 *
28621 * @param int $timestamp Unix timestamp.
28622 * @param float $latitude Latitude in degrees.
28623 * @param float $longitude Longitude in degrees.
28624 * @return array Returns array on success. The structure of the array
28625 *   is detailed in the following list:
28626 * @since PHP 5 >= 5.1.2, PHP 7
28627 **/
28628function date_sun_info($timestamp, $latitude, $longitude){}
28629
28630/**
28631 * Gets the Unix timestamp
28632 *
28633 * @param DateTimeInterface $object
28634 * @return int Returns the Unix timestamp representing the date.
28635 * @since PHP 5 >= 5.3.0, PHP 7
28636 **/
28637function date_timestamp_get($object){}
28638
28639/**
28640 * Sets the date and time based on an Unix timestamp
28641 *
28642 * @param DateTime $object Unix timestamp representing the date.
28643 * @param int $timestamp
28644 * @return DateTime
28645 * @since PHP 5 >= 5.3.0, PHP 7
28646 **/
28647function date_timestamp_set($object, $timestamp){}
28648
28649/**
28650 * Return time zone relative to given DateTime
28651 *
28652 * @param DateTimeInterface $object
28653 * @return DateTimeZone Returns a DateTimeZone object on success .
28654 * @since PHP 5 >= 5.2.0, PHP 7
28655 **/
28656function date_timezone_get($object){}
28657
28658/**
28659 * Sets the time zone for the DateTime object
28660 *
28661 * Sets a new timezone for a DateTime object.
28662 *
28663 * @param DateTime $object A DateTimeZone object representing the
28664 *   desired time zone.
28665 * @param DateTimeZone $timezone
28666 * @return DateTime
28667 * @since PHP 5 >= 5.2.0, PHP 7
28668 **/
28669function date_timezone_set($object, $timezone){}
28670
28671/**
28672 * Sets the time
28673 *
28674 * Resets the current time of the DateTime object to a different time.
28675 *
28676 * @param DateTime $object Hour of the time.
28677 * @param int $hour Minute of the time.
28678 * @param int $minute Second of the time.
28679 * @param int $second Microsecond of the time.
28680 * @param int $microsecond
28681 * @return DateTime
28682 * @since PHP 5 >= 5.2.0, PHP 7
28683 **/
28684function date_time_set($object, $hour, $minute, $second, $microsecond){}
28685
28686/**
28687 * Returns or sets the AUTOCOMMIT state for a database connection
28688 *
28689 * Sets or gets the AUTOCOMMIT behavior of the specified connection
28690 * resource.
28691 *
28692 * @param resource $connection A valid database connection resource
28693 *   variable as returned from {@link db2_connect} or {@link
28694 *   db2_pconnect}.
28695 * @param bool $value One of the following constants:
28696 *   DB2_AUTOCOMMIT_OFF Turns AUTOCOMMIT off. DB2_AUTOCOMMIT_ON Turns
28697 *   AUTOCOMMIT on.
28698 * @return mixed When {@link db2_autocommit} receives only the {@link
28699 *   connection} parameter, it returns the current state of AUTOCOMMIT
28700 *   for the requested connection as an integer value. A value of
28701 *   DB2_AUTOCOMMIT_OFF indicates that AUTOCOMMIT is off, while a value
28702 *   of DB2_AUTOCOMMIT_ON indicates that AUTOCOMMIT is on.
28703 * @since PECL ibm_db2 >= 1.0.0
28704 **/
28705function db2_autocommit($connection, $value){}
28706
28707/**
28708 * Binds a PHP variable to an SQL statement parameter
28709 *
28710 * Binds a PHP variable to an SQL statement parameter in a statement
28711 * resource returned by {@link db2_prepare}. This function gives you more
28712 * control over the parameter type, data type, precision, and scale for
28713 * the parameter than simply passing the variable as part of the optional
28714 * input array to {@link db2_execute}.
28715 *
28716 * @param resource $stmt A prepared statement returned from {@link
28717 *   db2_prepare}.
28718 * @param int $parameter_number Specifies the 1-indexed position of the
28719 *   parameter in the prepared statement.
28720 * @param string $variable_name A string specifying the name of the PHP
28721 *   variable to bind to the parameter specified by {@link
28722 *   parameter_number}.
28723 * @param int $parameter_type A constant specifying whether the PHP
28724 *   variable should be bound to the SQL parameter as an input parameter
28725 *   (DB2_PARAM_IN), an output parameter (DB2_PARAM_OUT), or as a
28726 *   parameter that accepts input and returns output (DB2_PARAM_INOUT).
28727 *   To avoid memory overhead, you can also specify DB2_PARAM_FILE to
28728 *   bind the PHP variable to the name of a file that contains large
28729 *   object (BLOB, CLOB, or DBCLOB) data.
28730 * @param int $data_type A constant specifying the SQL data type that
28731 *   the PHP variable should be bound as: one of DB2_BINARY, DB2_CHAR,
28732 *   DB2_DOUBLE, or DB2_LONG .
28733 * @param int $precision Specifies the precision with which the
28734 *   variable should be bound to the database. This parameter can also be
28735 *   used for retrieving XML output values from stored procedures. A
28736 *   non-negative value specifies the maximum size of the XML data that
28737 *   will be retrieved from the database. If this parameter is not used,
28738 *   a default of 1MB will be assumed for retrieving the XML output value
28739 *   from the stored procedure.
28740 * @param int $scale Specifies the scale with which the variable should
28741 *   be bound to the database.
28742 * @return bool
28743 * @since PECL ibm_db2 >= 1.0.0
28744 **/
28745function db2_bind_param($stmt, $parameter_number, $variable_name, $parameter_type, $data_type, $precision, $scale){}
28746
28747/**
28748 * Returns an object with properties that describe the DB2 database
28749 * client
28750 *
28751 * This function returns an object with read-only properties that return
28752 * information about the DB2 database client. The following table lists
28753 * the DB2 client properties: DB2 client properties Property name Return
28754 * type Description APPL_CODEPAGE int The application code page.
28755 * CONN_CODEPAGE int The code page for the current connection.
28756 * DATA_SOURCE_NAME string The data source name (DSN) used to create the
28757 * current connection to the database. DRIVER_NAME string The name of the
28758 * library that implements the DB2 Call Level Interface (CLI)
28759 * specification. DRIVER_ODBC_VER string The version of ODBC that the DB2
28760 * client supports. This returns a string "MM.mm" where MM is the major
28761 * version and mm is the minor version. The DB2 client always returns
28762 * "03.51". DRIVER_VER string The version of the client, in the form of a
28763 * string "MM.mm.uuuu" where MM is the major version, mm is the minor
28764 * version, and uuuu is the update. For example, "08.02.0001" represents
28765 * major version 8, minor version 2, update 1. ODBC_SQL_CONFORMANCE
28766 * string The level of ODBC SQL grammar supported by the client: MINIMUM
28767 * Supports the minimum ODBC SQL grammar. CORE Supports the core ODBC SQL
28768 * grammar. EXTENDED Supports extended ODBC SQL grammar. ODBC_VER string
28769 * The version of ODBC that the ODBC driver manager supports. This
28770 * returns a string "MM.mm.rrrr" where MM is the major version, mm is the
28771 * minor version, and rrrr is the release. The DB2 client always returns
28772 * "03.01.0000".
28773 *
28774 * @param resource $connection Specifies an active DB2 client
28775 *   connection.
28776 * @return object Returns an object on a successful call. Returns FALSE
28777 *   on failure.
28778 * @since PECL ibm_db2 >= 1.1.1
28779 **/
28780function db2_client_info($connection){}
28781
28782/**
28783 * Closes a database connection
28784 *
28785 * This function closes a DB2 client connection created with {@link
28786 * db2_connect} and returns the corresponding resources to the database
28787 * server.
28788 *
28789 * If you attempt to close a persistent DB2 client connection created
28790 * with {@link db2_pconnect}, the close request is ignored and the
28791 * persistent DB2 client connection remains available for the next
28792 * caller.
28793 *
28794 * @param resource $connection Specifies an active DB2 client
28795 *   connection.
28796 * @return bool
28797 * @since PECL ibm_db2 >= 1.0.0
28798 **/
28799function db2_close($connection){}
28800
28801/**
28802 * Returns a result set listing the columns and associated metadata for a
28803 * table
28804 *
28805 * Returns a result set listing the columns and associated metadata for a
28806 * table.
28807 *
28808 * @param resource $connection A valid connection to an IBM DB2,
28809 *   Cloudscape, or Apache Derby database.
28810 * @param string $qualifier A qualifier for DB2 databases running on
28811 *   OS/390 or z/OS servers. For other databases, pass NULL or an empty
28812 *   string.
28813 * @param string $schema The schema which contains the tables. To match
28814 *   all schemas, pass '%'.
28815 * @param string $tablename The name of the table or view. To match all
28816 *   tables in the database, pass NULL or an empty string.
28817 * @param string $columnname The name of the column. To match all
28818 *   columns in the table, pass NULL or an empty string.
28819 * @return resource Returns a statement resource with a result set
28820 *   containing rows describing the columns matching the specified
28821 *   parameters. The rows are composed of the following columns: Column
28822 *   name Description TABLE_CAT Name of the catalog. The value is NULL if
28823 *   this table does not have catalogs. TABLE_SCHEM Name of the schema.
28824 *   TABLE_NAME Name of the table or view. COLUMN_NAME Name of the
28825 *   column. DATA_TYPE The SQL data type for the column represented as an
28826 *   integer value. TYPE_NAME A string representing the data type for the
28827 *   column. COLUMN_SIZE An integer value representing the size of the
28828 *   column. BUFFER_LENGTH Maximum number of bytes necessary to store
28829 *   data from this column. DECIMAL_DIGITS The scale of the column, or
28830 *   NULL where scale is not applicable. NUM_PREC_RADIX An integer value
28831 *   of either 10 (representing an exact numeric data type), 2
28832 *   (representing an approximate numeric data type), or NULL
28833 *   (representing a data type for which radix is not applicable).
28834 *   NULLABLE An integer value representing whether the column is
28835 *   nullable or not. REMARKS Description of the column. COLUMN_DEF
28836 *   Default value for the column. SQL_DATA_TYPE An integer value
28837 *   representing the size of the column. SQL_DATETIME_SUB Returns an
28838 *   integer value representing a datetime subtype code, or NULL for SQL
28839 *   data types to which this does not apply. CHAR_OCTET_LENGTH Maximum
28840 *   length in octets for a character data type column, which matches
28841 *   COLUMN_SIZE for single-byte character set data, or NULL for
28842 *   non-character data types. ORDINAL_POSITION The 1-indexed position of
28843 *   the column in the table. IS_NULLABLE A string value where 'YES'
28844 *   means that the column is nullable and 'NO' means that the column is
28845 *   not nullable.
28846 * @since PECL ibm_db2 >= 1.0.0
28847 **/
28848function db2_columns($connection, $qualifier, $schema, $tablename, $columnname){}
28849
28850/**
28851 * Returns a result set listing the columns and associated privileges for
28852 * a table
28853 *
28854 * Returns a result set listing the columns and associated privileges for
28855 * a table.
28856 *
28857 * @param resource $connection A valid connection to an IBM DB2,
28858 *   Cloudscape, or Apache Derby database.
28859 * @param string $qualifier A qualifier for DB2 databases running on
28860 *   OS/390 or z/OS servers. For other databases, pass NULL or an empty
28861 *   string.
28862 * @param string $schema The schema which contains the tables. To match
28863 *   all schemas, pass NULL or an empty string.
28864 * @param string $tablename The name of the table or view. To match all
28865 *   tables in the database, pass NULL or an empty string.
28866 * @param string $columnname The name of the column. To match all
28867 *   columns in the table, pass NULL or an empty string.
28868 * @return resource Returns a statement resource with a result set
28869 *   containing rows describing the column privileges for columns
28870 *   matching the specified parameters. The rows are composed of the
28871 *   following columns: Column name Description TABLE_CAT Name of the
28872 *   catalog. The value is NULL if this table does not have catalogs.
28873 *   TABLE_SCHEM Name of the schema. TABLE_NAME Name of the table or
28874 *   view. COLUMN_NAME Name of the column. GRANTOR Authorization ID of
28875 *   the user who granted the privilege. GRANTEE Authorization ID of the
28876 *   user to whom the privilege was granted. PRIVILEGE The privilege for
28877 *   the column. IS_GRANTABLE Whether the GRANTEE is permitted to grant
28878 *   this privilege to other users.
28879 * @since PECL ibm_db2 >= 1.0.0
28880 **/
28881function db2_column_privileges($connection, $qualifier, $schema, $tablename, $columnname){}
28882
28883/**
28884 * Commits a transaction
28885 *
28886 * Commits an in-progress transaction on the specified connection
28887 * resource and begins a new transaction. PHP applications normally
28888 * default to AUTOCOMMIT mode, so {@link db2_commit} is not necessary
28889 * unless AUTOCOMMIT has been turned off for the connection resource.
28890 *
28891 * @param resource $connection A valid database connection resource
28892 *   variable as returned from {@link db2_connect} or {@link
28893 *   db2_pconnect}.
28894 * @return bool
28895 * @since PECL ibm_db2 >= 1.0.0
28896 **/
28897function db2_commit($connection){}
28898
28899/**
28900 * Returns a connection to a database
28901 *
28902 * Creates a new connection to an IBM DB2 Universal Database, IBM
28903 * Cloudscape, or Apache Derby database.
28904 *
28905 * @param string $database For a cataloged connection to a database,
28906 *   {@link database} represents the database alias in the DB2 client
28907 *   catalog. For an uncataloged connection to a database, {@link
28908 *   database} represents a complete connection string in the following
28909 *   format: DATABASE={@link database};HOSTNAME={@link
28910 *   hostname};PORT={@link port};PROTOCOL=TCPIP;UID={@link
28911 *   username};PWD={@link password}; where the parameters represent the
28912 *   following values: {@link database} The name of the database. {@link
28913 *   hostname} The hostname or IP address of the database server. {@link
28914 *   port} The TCP/IP port on which the database is listening for
28915 *   requests. {@link username} The username with which you are
28916 *   connecting to the database. {@link password} The password with which
28917 *   you are connecting to the database.
28918 * @param string $username The name of the database.
28919 * @param string $password The hostname or IP address of the database
28920 *   server.
28921 * @param array $options The TCP/IP port on which the database is
28922 *   listening for requests.
28923 * @return resource Returns a connection handle resource if the
28924 *   connection attempt is successful. If the connection attempt fails,
28925 *   {@link db2_connect} returns FALSE.
28926 * @since PECL ibm_db2 >= 1.0.0
28927 **/
28928function db2_connect($database, $username, $password, $options){}
28929
28930/**
28931 * Returns a string containing the SQLSTATE returned by the last
28932 * connection attempt
28933 *
28934 * {@link db2_conn_error} returns an SQLSTATE value representing the
28935 * reason the last attempt to connect to a database failed. As {@link
28936 * db2_connect} returns FALSE in the event of a failed connection
28937 * attempt, you do not pass any parameters to {@link db2_conn_error} to
28938 * retrieve the SQLSTATE value.
28939 *
28940 * If, however, the connection was successful but becomes invalid over
28941 * time, you can pass the {@link connection} parameter to retrieve the
28942 * SQLSTATE value for a specific connection.
28943 *
28944 * To learn what the SQLSTATE value means, you can issue the following
28945 * command at a DB2 Command Line Processor prompt: db2 '? {@link
28946 * sqlstate-value}'. You can also call {@link db2_conn_errormsg} to
28947 * retrieve an explicit error message and the associated SQLCODE value.
28948 *
28949 * @param resource $connection A connection resource associated with a
28950 *   connection that initially succeeded, but which over time became
28951 *   invalid.
28952 * @return string Returns the SQLSTATE value resulting from a failed
28953 *   connection attempt. Returns an empty string if there is no error
28954 *   associated with the last connection attempt.
28955 * @since PECL ibm_db2 >= 1.0.0
28956 **/
28957function db2_conn_error($connection){}
28958
28959/**
28960 * Returns the last connection error message and SQLCODE value
28961 *
28962 * {@link db2_conn_errormsg} returns an error message and SQLCODE value
28963 * representing the reason the last database connection attempt failed.
28964 * As {@link db2_connect} returns FALSE in the event of a failed
28965 * connection attempt, do not pass any parameters to {@link
28966 * db2_conn_errormsg} to retrieve the associated error message and
28967 * SQLCODE value.
28968 *
28969 * If, however, the connection was successful but becomes invalid over
28970 * time, you can pass the {@link connection} parameter to retrieve the
28971 * associated error message and SQLCODE value for a specific connection.
28972 *
28973 * @param resource $connection A connection resource associated with a
28974 *   connection that initially succeeded, but which over time became
28975 *   invalid.
28976 * @return string Returns a string containing the error message and
28977 *   SQLCODE value resulting from a failed connection attempt. If there
28978 *   is no error associated with the last connection attempt, {@link
28979 *   db2_conn_errormsg} returns an empty string.
28980 * @since PECL ibm_db2 >= 1.0.0
28981 **/
28982function db2_conn_errormsg($connection){}
28983
28984/**
28985 * Returns the cursor type used by a statement resource
28986 *
28987 * Returns the cursor type used by a statement resource. Use this to
28988 * determine if you are working with a forward-only cursor or scrollable
28989 * cursor.
28990 *
28991 * @param resource $stmt A valid statement resource.
28992 * @return int Returns either DB2_FORWARD_ONLY if the statement
28993 *   resource uses a forward-only cursor or DB2_SCROLLABLE if the
28994 *   statement resource uses a scrollable cursor.
28995 * @since PECL ibm_db2 >= 1.0.0
28996 **/
28997function db2_cursor_type($stmt){}
28998
28999/**
29000 * Used to escape certain characters
29001 *
29002 * Prepends backslashes to special characters in the string argument.
29003 *
29004 * @param string $string_literal The string that contains special
29005 *   characters that need to be modified. Characters that are prepended
29006 *   with a backslash are \x00, \n, \r, \, ', " and \x1a.
29007 * @return string Returns {@link string_literal} with the special
29008 *   characters noted above prepended with backslashes.
29009 * @since PECL ibm_db2 >= 1.6.0
29010 **/
29011function db2_escape_string($string_literal){}
29012
29013/**
29014 * Executes an SQL statement directly
29015 *
29016 * Executes an SQL statement directly.
29017 *
29018 * If you plan to interpolate PHP variables into the SQL statement,
29019 * understand that this is one of the more common security exposures.
29020 * Consider calling {@link db2_prepare} to prepare an SQL statement with
29021 * parameter markers for input values. Then you can call {@link
29022 * db2_execute} to pass in the input values and avoid SQL injection
29023 * attacks.
29024 *
29025 * If you plan to repeatedly issue the same SQL statement with different
29026 * parameters, consider calling {@link db2_prepare} and {@link
29027 * db2_execute} to enable the database server to reuse its access plan
29028 * and increase the efficiency of your database access.
29029 *
29030 * @param resource $connection A valid database connection resource
29031 *   variable as returned from {@link db2_connect} or {@link
29032 *   db2_pconnect}.
29033 * @param string $statement An SQL statement. The statement cannot
29034 *   contain any parameter markers.
29035 * @param array $options An associative array containing statement
29036 *   options. You can use this parameter to request a scrollable cursor
29037 *   on database servers that support this functionality. For a
29038 *   description of valid statement options, see {@link db2_set_option}.
29039 * @return resource Returns a statement resource if the SQL statement
29040 *   was issued successfully, or FALSE if the database failed to execute
29041 *   the SQL statement.
29042 * @since PECL ibm_db2 >= 1.0.0
29043 **/
29044function db2_exec($connection, $statement, $options){}
29045
29046/**
29047 * Executes a prepared SQL statement
29048 *
29049 * {@link db2_execute} executes an SQL statement that was prepared by
29050 * {@link db2_prepare}.
29051 *
29052 * If the SQL statement returns a result set, for example, a SELECT
29053 * statement or a CALL to a stored procedure that returns one or more
29054 * result sets, you can retrieve a row as an array from the stmt resource
29055 * using {@link db2_fetch_assoc}, {@link db2_fetch_both}, or {@link
29056 * db2_fetch_array}. Alternatively, you can use {@link db2_fetch_row} to
29057 * move the result set pointer to the next row and fetch a column at a
29058 * time from that row with {@link db2_result}.
29059 *
29060 * Refer to {@link db2_prepare} for a brief discussion of the advantages
29061 * of using {@link db2_prepare} and {@link db2_execute} rather than
29062 * {@link db2_exec}.
29063 *
29064 * @param resource $stmt A prepared statement returned from {@link
29065 *   db2_prepare}.
29066 * @param array $parameters An array of input parameters matching any
29067 *   parameter markers contained in the prepared statement.
29068 * @return bool
29069 * @since PECL ibm_db2 >= 1.0.0
29070 **/
29071function db2_execute($stmt, $parameters){}
29072
29073/**
29074 * Returns an array, indexed by column position, representing a row in a
29075 * result set
29076 *
29077 * Returns an array, indexed by column position, representing a row in a
29078 * result set. The columns are 0-indexed.
29079 *
29080 * @param resource $stmt A valid stmt resource containing a result set.
29081 * @param int $row_number Requests a specific 1-indexed row from the
29082 *   result set. Passing this parameter results in a PHP warning if the
29083 *   result set uses a forward-only cursor.
29084 * @return array Returns a 0-indexed array with column values indexed
29085 *   by the column position representing the next or requested row in the
29086 *   result set. Returns FALSE if there are no rows left in the result
29087 *   set, or if the row requested by {@link row_number} does not exist in
29088 *   the result set.
29089 * @since PECL ibm_db2 >= 1.0.1
29090 **/
29091function db2_fetch_array($stmt, $row_number){}
29092
29093/**
29094 * Returns an array, indexed by column name, representing a row in a
29095 * result set
29096 *
29097 * Returns an array, indexed by column name, representing a row in a
29098 * result set.
29099 *
29100 * @param resource $stmt A valid stmt resource containing a result set.
29101 * @param int $row_number Requests a specific 1-indexed row from the
29102 *   result set. Passing this parameter results in a PHP warning if the
29103 *   result set uses a forward-only cursor.
29104 * @return array Returns an associative array with column values
29105 *   indexed by the column name representing the next or requested row in
29106 *   the result set. Returns FALSE if there are no rows left in the
29107 *   result set, or if the row requested by {@link row_number} does not
29108 *   exist in the result set.
29109 * @since PECL ibm_db2 >= 1.0.0
29110 **/
29111function db2_fetch_assoc($stmt, $row_number){}
29112
29113/**
29114 * Returns an array, indexed by both column name and position,
29115 * representing a row in a result set
29116 *
29117 * Returns an array, indexed by both column name and position,
29118 * representing a row in a result set. Note that the row returned by
29119 * {@link db2_fetch_both} requires more memory than the single-indexed
29120 * arrays returned by {@link db2_fetch_assoc} or {@link db2_fetch_array}.
29121 *
29122 * @param resource $stmt A valid stmt resource containing a result set.
29123 * @param int $row_number Requests a specific 1-indexed row from the
29124 *   result set. Passing this parameter results in a PHP warning if the
29125 *   result set uses a forward-only cursor.
29126 * @return array Returns an associative array with column values
29127 *   indexed by both the column name and 0-indexed column number. The
29128 *   array represents the next or requested row in the result set.
29129 *   Returns FALSE if there are no rows left in the result set, or if the
29130 *   row requested by {@link row_number} does not exist in the result
29131 *   set.
29132 * @since PECL ibm_db2 >= 1.0.0
29133 **/
29134function db2_fetch_both($stmt, $row_number){}
29135
29136/**
29137 * Returns an object with properties representing columns in the fetched
29138 * row
29139 *
29140 * Returns an object in which each property represents a column returned
29141 * in the row fetched from a result set.
29142 *
29143 * @param resource $stmt A valid stmt resource containing a result set.
29144 * @param int $row_number Requests a specific 1-indexed row from the
29145 *   result set. Passing this parameter results in a PHP warning if the
29146 *   result set uses a forward-only cursor.
29147 * @return object Returns an object representing a single row in the
29148 *   result set. The properties of the object map to the names of the
29149 *   columns in the result set.
29150 * @since PECL ibm_db2 >= 1.0.0
29151 **/
29152function db2_fetch_object($stmt, $row_number){}
29153
29154/**
29155 * Sets the result set pointer to the next row or requested row
29156 *
29157 * Use {@link db2_fetch_row} to iterate through a result set, or to point
29158 * to a specific row in a result set if you requested a scrollable
29159 * cursor.
29160 *
29161 * To retrieve individual fields from the result set, call the {@link
29162 * db2_result} function.
29163 *
29164 * Rather than calling {@link db2_fetch_row} and {@link db2_result}, most
29165 * applications will call one of {@link db2_fetch_assoc}, {@link
29166 * db2_fetch_both}, or {@link db2_fetch_array} to advance the result set
29167 * pointer and return a complete row as an array.
29168 *
29169 * @param resource $stmt A valid stmt resource.
29170 * @param int $row_number With scrollable cursors, you can request a
29171 *   specific row number in the result set. Row numbering is 1-indexed.
29172 * @return bool Returns TRUE if the requested row exists in the result
29173 *   set. Returns FALSE if the requested row does not exist in the result
29174 *   set.
29175 * @since PECL ibm_db2 >= 1.0.0
29176 **/
29177function db2_fetch_row($stmt, $row_number){}
29178
29179/**
29180 * Returns the maximum number of bytes required to display a column
29181 *
29182 * Returns the maximum number of bytes required to display a column in a
29183 * result set.
29184 *
29185 * @param resource $stmt Specifies a statement resource containing a
29186 *   result set.
29187 * @param mixed $column Specifies the column in the result set. This
29188 *   can either be an integer representing the 0-indexed position of the
29189 *   column, or a string containing the name of the column.
29190 * @return int Returns an integer value with the maximum number of
29191 *   bytes required to display the specified column. If the column does
29192 *   not exist in the result set, {@link db2_field_display_size} returns
29193 *   FALSE.
29194 * @since PECL ibm_db2 >= 1.0.0
29195 **/
29196function db2_field_display_size($stmt, $column){}
29197
29198/**
29199 * Returns the name of the column in the result set
29200 *
29201 * Returns the name of the specified column in the result set.
29202 *
29203 * @param resource $stmt Specifies a statement resource containing a
29204 *   result set.
29205 * @param mixed $column Specifies the column in the result set. This
29206 *   can either be an integer representing the 0-indexed position of the
29207 *   column, or a string containing the name of the column.
29208 * @return string Returns a string containing the name of the specified
29209 *   column. If the specified column does not exist in the result set,
29210 *   {@link db2_field_name} returns FALSE.
29211 * @since PECL ibm_db2 >= 1.0.0
29212 **/
29213function db2_field_name($stmt, $column){}
29214
29215/**
29216 * Returns the position of the named column in a result set
29217 *
29218 * Returns the position of the named column in a result set.
29219 *
29220 * @param resource $stmt Specifies a statement resource containing a
29221 *   result set.
29222 * @param mixed $column Specifies the column in the result set. This
29223 *   can either be an integer representing the 0-indexed position of the
29224 *   column, or a string containing the name of the column.
29225 * @return int Returns an integer containing the 0-indexed position of
29226 *   the named column in the result set. If the specified column does not
29227 *   exist in the result set, {@link db2_field_num} returns FALSE.
29228 * @since PECL ibm_db2 >= 1.0.0
29229 **/
29230function db2_field_num($stmt, $column){}
29231
29232/**
29233 * Returns the precision of the indicated column in a result set
29234 *
29235 * Returns the precision of the indicated column in a result set.
29236 *
29237 * @param resource $stmt Specifies a statement resource containing a
29238 *   result set.
29239 * @param mixed $column Specifies the column in the result set. This
29240 *   can either be an integer representing the 0-indexed position of the
29241 *   column, or a string containing the name of the column.
29242 * @return int Returns an integer containing the precision of the
29243 *   specified column. If the specified column does not exist in the
29244 *   result set, {@link db2_field_precision} returns FALSE.
29245 * @since PECL ibm_db2 >= 1.0.0
29246 **/
29247function db2_field_precision($stmt, $column){}
29248
29249/**
29250 * Returns the scale of the indicated column in a result set
29251 *
29252 * Returns the scale of the indicated column in a result set.
29253 *
29254 * @param resource $stmt Specifies a statement resource containing a
29255 *   result set.
29256 * @param mixed $column Specifies the column in the result set. This
29257 *   can either be an integer representing the 0-indexed position of the
29258 *   column, or a string containing the name of the column.
29259 * @return int Returns an integer containing the scale of the specified
29260 *   column. If the specified column does not exist in the result set,
29261 *   {@link db2_field_scale} returns FALSE.
29262 * @since PECL ibm_db2 >= 1.0.0
29263 **/
29264function db2_field_scale($stmt, $column){}
29265
29266/**
29267 * Returns the data type of the indicated column in a result set
29268 *
29269 * Returns the data type of the indicated column in a result set.
29270 *
29271 * @param resource $stmt Specifies a statement resource containing a
29272 *   result set.
29273 * @param mixed $column Specifies the column in the result set. This
29274 *   can either be an integer representing the 0-indexed position of the
29275 *   column, or a string containing the name of the column.
29276 * @return string Returns a string containing the defined data type of
29277 *   the specified column. If the specified column does not exist in the
29278 *   result set, {@link db2_field_type} returns FALSE.
29279 * @since PECL ibm_db2 >= 1.0.0
29280 **/
29281function db2_field_type($stmt, $column){}
29282
29283/**
29284 * Returns the width of the current value of the indicated column in a
29285 * result set
29286 *
29287 * Returns the width of the current value of the indicated column in a
29288 * result set. This is the maximum width of the column for a fixed-length
29289 * data type, or the actual width of the column for a variable-length
29290 * data type.
29291 *
29292 * @param resource $stmt Specifies a statement resource containing a
29293 *   result set.
29294 * @param mixed $column Specifies the column in the result set. This
29295 *   can either be an integer representing the 0-indexed position of the
29296 *   column, or a string containing the name of the column.
29297 * @return int Returns an integer containing the width of the specified
29298 *   character or binary data type column in a result set. If the
29299 *   specified column does not exist in the result set, {@link
29300 *   db2_field_width} returns FALSE.
29301 * @since PECL ibm_db2 >= 1.0.0
29302 **/
29303function db2_field_width($stmt, $column){}
29304
29305/**
29306 * Returns a result set listing the foreign keys for a table
29307 *
29308 * Returns a result set listing the foreign keys for a table.
29309 *
29310 * @param resource $connection A valid connection to an IBM DB2,
29311 *   Cloudscape, or Apache Derby database.
29312 * @param string $qualifier A qualifier for DB2 databases running on
29313 *   OS/390 or z/OS servers. For other databases, pass NULL or an empty
29314 *   string.
29315 * @param string $schema The schema which contains the tables. If
29316 *   {@link schema} is NULL, {@link db2_foreign_keys} matches the schema
29317 *   for the current connection.
29318 * @param string $tablename The name of the table.
29319 * @return resource Returns a statement resource with a result set
29320 *   containing rows describing the foreign keys for the specified table.
29321 *   The result set is composed of the following columns: Column name
29322 *   Description PKTABLE_CAT Name of the catalog for the table containing
29323 *   the primary key. The value is NULL if this table does not have
29324 *   catalogs. PKTABLE_SCHEM Name of the schema for the table containing
29325 *   the primary key. PKTABLE_NAME Name of the table containing the
29326 *   primary key. PKCOLUMN_NAME Name of the column containing the primary
29327 *   key. FKTABLE_CAT Name of the catalog for the table containing the
29328 *   foreign key. The value is NULL if this table does not have catalogs.
29329 *   FKTABLE_SCHEM Name of the schema for the table containing the
29330 *   foreign key. FKTABLE_NAME Name of the table containing the foreign
29331 *   key. FKCOLUMN_NAME Name of the column containing the foreign key.
29332 *   KEY_SEQ 1-indexed position of the column in the key. UPDATE_RULE
29333 *   Integer value representing the action applied to the foreign key
29334 *   when the SQL operation is UPDATE. DELETE_RULE Integer value
29335 *   representing the action applied to the foreign key when the SQL
29336 *   operation is DELETE. FK_NAME The name of the foreign key. PK_NAME
29337 *   The name of the primary key. DEFERRABILITY An integer value
29338 *   representing whether the foreign key deferrability is
29339 *   SQL_INITIALLY_DEFERRED, SQL_INITIALLY_IMMEDIATE, or
29340 *   SQL_NOT_DEFERRABLE.
29341 * @since PECL ibm_db2 >= 1.0.0
29342 **/
29343function db2_foreign_keys($connection, $qualifier, $schema, $tablename){}
29344
29345/**
29346 * Frees resources associated with a result set
29347 *
29348 * Frees the system and database resources that are associated with a
29349 * result set. These resources are freed implicitly when a script
29350 * finishes, but you can call {@link db2_free_result} to explicitly free
29351 * the result set resources before the end of the script.
29352 *
29353 * @param resource $stmt A valid statement resource.
29354 * @return bool
29355 * @since PECL ibm_db2 >= 1.0.0
29356 **/
29357function db2_free_result($stmt){}
29358
29359/**
29360 * Frees resources associated with the indicated statement resource
29361 *
29362 * Frees the system and database resources that are associated with a
29363 * statement resource. These resources are freed implicitly when a script
29364 * finishes, but you can call {@link db2_free_stmt} to explicitly free
29365 * the statement resources before the end of the script.
29366 *
29367 * @param resource $stmt A valid statement resource.
29368 * @return bool
29369 * @since PECL ibm_db2 >= 1.0.0
29370 **/
29371function db2_free_stmt($stmt){}
29372
29373/**
29374 * Retrieves an option value for a statement resource or a connection
29375 * resource
29376 *
29377 * Retrieves the value of a specified option value for a statement
29378 * resource or a connection resource.
29379 *
29380 * @param resource $resource A valid statement resource as returned
29381 *   from {@link db2_prepare} or a valid connection resource as returned
29382 *   from {@link db2_connect} or {@link db2_pconnect}.
29383 * @param string $option A valid statement or connection options. The
29384 *   following new options are available as of ibm_db2 version 1.6.0.
29385 *   They provide useful tracking information that can be set during
29386 *   execution with {@link db2_get_option}. Prior versions of ibm_db2 do
29387 *   not support these new options. When the value in each option is
29388 *   being set, some servers might not handle the entire length provided
29389 *   and might truncate the value. To ensure that the data specified in
29390 *   each option is converted correctly when transmitted to a host
29391 *   system, use only the characters A through Z, 0 through 9, and the
29392 *   underscore (_) or period (.). {@link userid} SQL_ATTR_INFO_USERID -
29393 *   A pointer to a null-terminated character string used to identify the
29394 *   client user ID sent to the host database server when using DB2
29395 *   Connect. DB2 for z/OS and OS/390 servers support up to a length of
29396 *   16 characters. This user-id is not to be confused with the
29397 *   authentication user-id, it is for identification purposes only and
29398 *   is not used for any authorization. {@link acctstr}
29399 *   SQL_ATTR_INFO_ACCTSTR - A pointer to a null-terminated character
29400 *   string used to identify the client accounting string sent to the
29401 *   host database server when using DB2 Connect. DB2 for z/OS and OS/390
29402 *   servers support up to a length of 200 characters. {@link applname}
29403 *   SQL_ATTR_INFO_APPLNAME - A pointer to a null-terminated character
29404 *   string used to identify the client application name sent to the host
29405 *   database server when using DB2 Connect. DB2 for z/OS and OS/390
29406 *   servers support up to a length of 32 characters. {@link wrkstnname}
29407 *   SQL_ATTR_INFO_WRKSTNNAME - A pointer to a null-terminated character
29408 *   string used to identify the client workstation name sent to the host
29409 *   database server when using DB2 Connect. DB2 for z/OS and OS/390
29410 *   servers support up to a length of 18 characters.
29411 * @return string Returns the current setting of the connection
29412 *   attribute provided on success .
29413 * @since PECL ibm_db2 >= 1.6.0
29414 **/
29415function db2_get_option($resource, $option){}
29416
29417/**
29418 * Returns the auto generated ID of the last insert query that
29419 * successfully executed on this connection
29420 *
29421 * The result of this function is not affected by any of the following: A
29422 * single row INSERT statement with a VALUES clause for a table without
29423 * an identity column. A multiple row INSERT statement with a VALUES
29424 * clause. An INSERT statement with a fullselect. A ROLLBACK TO SAVEPOINT
29425 * statement.
29426 *
29427 * @param resource $resource A valid connection resource as returned
29428 *   from {@link db2_connect} or {@link db2_pconnect}. The value of this
29429 *   parameter cannot be a statement resource or result set resource.
29430 * @return string Returns the auto generated ID of last insert query
29431 *   that successfully executed on this connection.
29432 * @since PECL ibm_db2 >= 1.7.1
29433 **/
29434function db2_last_insert_id($resource){}
29435
29436/**
29437 * Gets a user defined size of LOB files with each invocation
29438 *
29439 * Use {@link db2_lob_read} to iterate through a specified column of a
29440 * result set and retrieve a user defined size of LOB data.
29441 *
29442 * @param resource $stmt A valid stmt resource containing LOB data.
29443 * @param int $colnum A valid column number in the result set of the
29444 *   stmt resource.
29445 * @param int $length The size of the LOB data to be retrieved from the
29446 *   stmt resource.
29447 * @return string Returns the amount of data the user specifies.
29448 *   Returns FALSE if the data cannot be retrieved.
29449 * @since PECL ibm_db2 >= 1.6.0
29450 **/
29451function db2_lob_read($stmt, $colnum, $length){}
29452
29453/**
29454 * Requests the next result set from a stored procedure
29455 *
29456 * A stored procedure can return zero or more result sets. While you
29457 * handle the first result set in exactly the same way you would handle
29458 * the results returned by a simple SELECT statement, to fetch the second
29459 * and subsequent result sets from a stored procedure you must call the
29460 * {@link db2_next_result} function and return the result to a uniquely
29461 * named PHP variable.
29462 *
29463 * @param resource $stmt A prepared statement returned from {@link
29464 *   db2_exec} or {@link db2_execute}.
29465 * @return resource Returns a new statement resource containing the
29466 *   next result set if the stored procedure returned another result set.
29467 *   Returns FALSE if the stored procedure did not return another result
29468 *   set.
29469 * @since PECL ibm_db2 >= 1.0.0
29470 **/
29471function db2_next_result($stmt){}
29472
29473/**
29474 * Returns the number of fields contained in a result set
29475 *
29476 * Returns the number of fields contained in a result set. This is most
29477 * useful for handling the result sets returned by dynamically generated
29478 * queries, or for result sets returned by stored procedures, where your
29479 * application cannot otherwise know how to retrieve and use the results.
29480 *
29481 * @param resource $stmt A valid statement resource containing a result
29482 *   set.
29483 * @return int Returns an integer value representing the number of
29484 *   fields in the result set associated with the specified statement
29485 *   resource. Returns FALSE if the statement resource is not a valid
29486 *   input value.
29487 * @since PECL ibm_db2 >= 1.0.0
29488 **/
29489function db2_num_fields($stmt){}
29490
29491/**
29492 * Returns the number of rows affected by an SQL statement
29493 *
29494 * Returns the number of rows deleted, inserted, or updated by an SQL
29495 * statement.
29496 *
29497 * To determine the number of rows that will be returned by a SELECT
29498 * statement, issue SELECT COUNT(*) with the same predicates as your
29499 * intended SELECT statement and retrieve the value.
29500 *
29501 * If your application logic checks the number of rows returned by a
29502 * SELECT statement and branches if the number of rows is 0, consider
29503 * modifying your application to attempt to return the first row with one
29504 * of {@link db2_fetch_assoc}, {@link db2_fetch_both}, {@link
29505 * db2_fetch_array}, or {@link db2_fetch_row}, and branch if the fetch
29506 * function returns FALSE.
29507 *
29508 * @param resource $stmt A valid stmt resource containing a result set.
29509 * @return int Returns the number of rows affected by the last SQL
29510 *   statement issued by the specified statement handle.
29511 * @since PECL ibm_db2 >= 1.0.0
29512 **/
29513function db2_num_rows($stmt){}
29514
29515/**
29516 * Closes a persistent database connection
29517 *
29518 * This function closes a DB2 client connection created with {@link
29519 * db2_pconnect} and returns the corresponding resources to the database
29520 * server. This function is only available on i5/OS in response to i5/OS
29521 * system administration requests.
29522 *
29523 * If you have a persistent DB2 client connection created with {@link
29524 * db2_pconnect}, you may use this function to close the connection. To
29525 * avoid substantial connection performance penalties, this function
29526 * should only be used in rare cases when the persistent connection has
29527 * become unresponsive or the persistent connection will not be needed
29528 * for a long period of time.
29529 *
29530 * @param resource $resource Specifies an active DB2 client connection.
29531 * @return bool
29532 * @since PECL ibm_db2 >= 1.8.0
29533 **/
29534function db2_pclose($resource){}
29535
29536/**
29537 * Returns a persistent connection to a database
29538 *
29539 * Returns a persistent connection to an IBM DB2 Universal Database, IBM
29540 * Cloudscape, or Apache Derby database.
29541 *
29542 * For more information on persistent connections, refer to .
29543 *
29544 * Calling {@link db2_close} on a persistent connection always returns
29545 * TRUE, but the underlying DB2 client connection remains open and
29546 * waiting to serve the next matching {@link db2_pconnect} request.
29547 *
29548 * Users running version 1.9.0 or later of ibm_db2 should be aware that
29549 * the extension will perform a transaction rollback on persistent
29550 * connections at the end of a request, thus ending the transaction. This
29551 * prevents the transaction block from carrying over to the next request
29552 * which uses that connection if script execution ends before the
29553 * transaction block does.
29554 *
29555 * @param string $database The database alias in the DB2 client
29556 *   catalog.
29557 * @param string $username The username with which you are connecting
29558 *   to the database.
29559 * @param string $password The password with which you are connecting
29560 *   to the database.
29561 * @param array $options An associative array of connection options
29562 *   that affect the behavior of the connection, where valid array keys
29563 *   include: {@link autocommit} Passing the DB2_AUTOCOMMIT_ON value
29564 *   turns autocommit on for this connection handle. Passing the
29565 *   DB2_AUTOCOMMIT_OFF value turns autocommit off for this connection
29566 *   handle. {@link DB2_ATTR_CASE} Passing the DB2_CASE_NATURAL value
29567 *   specifies that column names are returned in natural case. Passing
29568 *   the DB2_CASE_LOWER value specifies that column names are returned in
29569 *   lower case. Passing the DB2_CASE_UPPER value specifies that column
29570 *   names are returned in upper case. {@link CURSOR} Passing the
29571 *   DB2_FORWARD_ONLY value specifies a forward-only cursor for a
29572 *   statement resource. This is the default cursor type and is supported
29573 *   on all database servers. Passing the DB2_SCROLLABLE value specifies
29574 *   a scrollable cursor for a statement resource. This mode enables
29575 *   random access to rows in a result set, but currently is supported
29576 *   only by IBM DB2 Universal Database. The following new option is
29577 *   available in ibm_db2 version 1.7.0 and later. {@link trustedcontext}
29578 *   Passing the DB2_TRUSTED_CONTEXT_ENABLE value turns trusted context
29579 *   on for this connection handle. This parameter cannot be set using
29580 *   {@link db2_set_option}. This key works only if the database is
29581 *   cataloged (even if the database is local), or if you specify the
29582 *   full DSN when you create the connection. To catalog the database,
29583 *   use following commands: db2 catalog tcpip node loopback remote
29584 *   <SERVERNAME> server <SERVICENAME> db2 catalog database <LOCALDBNAME>
29585 *   as <REMOTEDBNAME> at node loopback db2 "update dbm cfg using
29586 *   svcename <SERVICENAME>" db2set DB2COMM=TCPIP The following new i5/OS
29587 *   options are available in ibm_db2 version 1.5.1 and later.
29588 *   Conflicting connection attributes used in conjunction with
29589 *   persistent connections can produce indeterminate results on i5/OS.
29590 *   Site policies should be establish for all applications using each
29591 *   persistent connection user profile. The default DB2_AUTOCOMMIT_ON is
29592 *   suggested when using persistent connections. {@link i5_lib} A
29593 *   character value that indicates the default library that will be used
29594 *   for resolving unqualified file references. This is not valid if the
29595 *   connection is using system naming mode. {@link i5_naming}
29596 *   DB2_I5_NAMING_ON value turns on DB2 UDB CLI iSeries system naming
29597 *   mode. Files are qualified using the slash (/) delimiter. Unqualified
29598 *   files are resolved using the library list for the job.
29599 *   DB2_I5_NAMING_OFF value turns off DB2 UDB CLI default naming mode,
29600 *   which is SQL naming. Files are qualified using the period (.)
29601 *   delimiter. Unqualified files are resolved using either the default
29602 *   library or the current user ID. {@link i5_commit} The {@link
29603 *   i5_commit} attribute should be set before the {@link db2_pconnect}.
29604 *   If the value is changed after the connection has been established,
29605 *   and the connection is to a remote data source, the change does not
29606 *   take effect until the next successful {@link db2_pconnect} for the
29607 *   connection handle. The php.ini setting {@link
29608 *   ibm_db2.i5_allow_commit}==0 or DB2_I5_TXN_NO_COMMIT is the default,
29609 *   but may be overridden with the {@link i5_commit} option.
29610 *   DB2_I5_TXN_NO_COMMIT - Commitment control is not used.
29611 *   DB2_I5_TXN_READ_UNCOMMITTED - Dirty reads, nonrepeatable reads, and
29612 *   phantoms are possible. DB2_I5_TXN_READ_COMMITTED - Dirty reads are
29613 *   not possible. Nonrepeatable reads, and phantoms are possible.
29614 *   DB2_I5_TXN_REPEATABLE_READ - Dirty reads and nonrepeatable reads are
29615 *   not possible. Phantoms are possible. DB2_I5_TXN_SERIALIZABLE -
29616 *   Transactions are serializable. Dirty reads, non-repeatable reads,
29617 *   and phantoms are not possible {@link i5_query_optimize} DB2_FIRST_IO
29618 *   All queries are optimized with the goal of returning the first page
29619 *   of output as fast as possible. This goal works well when the output
29620 *   is controlled by a user who is most likely to cancel the query after
29621 *   viewing the first page of output data. Queries coded with an
29622 *   OPTIMIZE FOR nnn ROWS clause honor the goal specified by the clause.
29623 *   DB2_ALL_IO All queries are optimized with the goal of running the
29624 *   entire query to completion in the shortest amount of elapsed time.
29625 *   This is a good option when the output of a query is being written to
29626 *   a file or report, or the interface is queuing the output data.
29627 *   Queries coded with an OPTIMIZE FOR nnn ROWS clause honor the goal
29628 *   specified by the clause. This is the default. {@link i5_dbcs_alloc}
29629 *   DB2_I5_DBCS_ALLOC_ON value turns on DB2 6X allocation scheme for
29630 *   DBCS translation column size growth. DB2_I5_DBCS_ALLOC_OFF value
29631 *   turns off DB2 6X allocation scheme for DBCS translation column size
29632 *   growth. The php.ini setting {@link ibm_db2.i5_dbcs_alloc}==0 or
29633 *   DB2_I5_DBCS_ALLOC_OFF is the default, but may be overridden with the
29634 *   {@link i5_dbcs_alloc} option. {@link i5_date_fmt} DB2_I5_FMT_ISO -
29635 *   The International Organization for Standardization (ISO) date format
29636 *   yyyy-mm-dd is used. This is the default. DB2_I5_FMT_USA - The United
29637 *   States date format mm/dd/yyyy is used. DB2_I5_FMT_EUR - The European
29638 *   date format dd.mm.yyyy is used. DB2_I5_FMT_JIS - The Japanese
29639 *   Industrial Standard date format yyyy-mm-dd is used. DB2_I5_FMT_MDY -
29640 *   The date format mm/dd/yyyy is used. DB2_I5_FMT_DMY - The date format
29641 *   dd/mm/yyyy is used. DB2_I5_FMT_YMD - The date format yy/mm/dd is
29642 *   used. DB2_I5_FMT_JUL - The Julian date format yy/ddd is used.
29643 *   DB2_I5_FMT_JOB - The job default is used. {@link i5_date_sep}
29644 *   DB2_I5_SEP_SLASH - A slash ( / ) is used as the date separator. This
29645 *   is the default. DB2_I5_SEP_DASH - A dash ( - ) is used as the date
29646 *   separator. DB2_I5_SEP_PERIOD - A period ( . ) is used as the date
29647 *   separator. DB2_I5_SEP_COMMA - A comma ( , ) is used as the date
29648 *   separator. DB2_I5_SEP_BLANK - A blank is used as the date separator.
29649 *   DB2_I5_SEP_JOB - The job default is used {@link i5_time_fmt}
29650 *   DB2_I5_FMT_ISO - The International Organization for Standardization
29651 *   (ISO) time format hh.mm.ss is used. This is the default.
29652 *   DB2_I5_FMT_USA - The United States time format hh:mmxx is used,
29653 *   where xx is AM or PM. DB2_I5_FMT_EUR - The European time format
29654 *   hh.mm.ss is used. DB2_I5_FMT_JIS - The Japanese Industrial Standard
29655 *   time format hh:mm:ss is used. DB2_I5_FMT_HMS - The hh:mm:ss format
29656 *   is used. {@link i5_time_sep} DB2_I5_SEP_COLON - A colon ( : ) is
29657 *   used as the time separator. This is the default. DB2_I5_SEP_PERIOD -
29658 *   A period ( . ) is used as the time separator. DB2_I5_SEP_COMMA - A
29659 *   comma ( , ) is used as the time separator. DB2_I5_SEP_BLANK - A
29660 *   blank is used as the time separator. DB2_I5_SEP_JOB - The job
29661 *   default is used. {@link i5_decimal_sep} DB2_I5_SEP_PERIOD - A period
29662 *   ( . ) is used as the decimal separator. This is the default.
29663 *   DB2_I5_SEP_COMMA - A comma ( , ) is used as the decimal separator.
29664 *   DB2_I5_SEP_JOB - The job default is used. The following new i5/OS
29665 *   option is available in ibm_db2 version 1.8.0 and later. {@link
29666 *   i5_libl} A character value that indicates the library list that will
29667 *   be used for resolving unqualified file references. Specify the
29668 *   library list elements separated by blanks 'i5_libl'=>"MYLIB YOURLIB
29669 *   ANYLIB". i5_libl calls qsys2/qcmdexc('cmd',cmdlen), which is only
29670 *   available in i5/OS V5R4 and later.
29671 * @return resource Returns a connection handle resource if the
29672 *   connection attempt is successful. {@link db2_pconnect} tries to
29673 *   reuse an existing connection resource that exactly matches the
29674 *   {@link database}, {@link username}, and {@link password} parameters.
29675 *   If the connection attempt fails, {@link db2_pconnect} returns FALSE.
29676 * @since PECL ibm_db2 >= 1.0.0
29677 **/
29678function db2_pconnect($database, $username, $password, $options){}
29679
29680/**
29681 * Prepares an SQL statement to be executed
29682 *
29683 * {@link db2_prepare} creates a prepared SQL statement which can include
29684 * 0 or more parameter markers (? characters) representing parameters for
29685 * input, output, or input/output. You can pass parameters to the
29686 * prepared statement using {@link db2_bind_param}, or for input values
29687 * only, as an array passed to {@link db2_execute}.
29688 *
29689 * There are three main advantages to using prepared statements in your
29690 * application: Performance: when you prepare a statement, the database
29691 * server creates an optimized access plan for retrieving data with that
29692 * statement. Subsequently issuing the prepared statement with {@link
29693 * db2_execute} enables the statements to reuse that access plan and
29694 * avoids the overhead of dynamically creating a new access plan for
29695 * every statement you issue. Security: when you prepare a statement, you
29696 * can include parameter markers for input values. When you execute a
29697 * prepared statement with input values for placeholders, the database
29698 * server checks each input value to ensure that the type matches the
29699 * column definition or parameter definition. Advanced functionality:
29700 * Parameter markers not only enable you to pass input values to prepared
29701 * SQL statements, they also enable you to retrieve OUT and INOUT
29702 * parameters from stored procedures using {@link db2_bind_param}.
29703 *
29704 * @param resource $connection A valid database connection resource
29705 *   variable as returned from {@link db2_connect} or {@link
29706 *   db2_pconnect}.
29707 * @param string $statement An SQL statement, optionally containing one
29708 *   or more parameter markers..
29709 * @param array $options An associative array containing statement
29710 *   options. You can use this parameter to request a scrollable cursor
29711 *   on database servers that support this functionality. For a
29712 *   description of valid statement options, see {@link db2_set_option}.
29713 * @return resource Returns a statement resource if the SQL statement
29714 *   was successfully parsed and prepared by the database server. Returns
29715 *   FALSE if the database server returned an error. You can determine
29716 *   which error was returned by calling {@link db2_stmt_error} or {@link
29717 *   db2_stmt_errormsg}.
29718 * @since PECL ibm_db2 >= 1.0.0
29719 **/
29720function db2_prepare($connection, $statement, $options){}
29721
29722/**
29723 * Returns a result set listing primary keys for a table
29724 *
29725 * Returns a result set listing the primary keys for a table.
29726 *
29727 * @param resource $connection A valid connection to an IBM DB2,
29728 *   Cloudscape, or Apache Derby database.
29729 * @param string $qualifier A qualifier for DB2 databases running on
29730 *   OS/390 or z/OS servers. For other databases, pass NULL or an empty
29731 *   string.
29732 * @param string $schema The schema which contains the tables. If
29733 *   {@link schema} is NULL, {@link db2_primary_keys} matches the schema
29734 *   for the current connection.
29735 * @param string $tablename The name of the table.
29736 * @return resource Returns a statement resource with a result set
29737 *   containing rows describing the primary keys for the specified table.
29738 *   The result set is composed of the following columns: Column name
29739 *   Description TABLE_CAT Name of the catalog for the table containing
29740 *   the primary key. The value is NULL if this table does not have
29741 *   catalogs. TABLE_SCHEM Name of the schema for the table containing
29742 *   the primary key. TABLE_NAME Name of the table containing the primary
29743 *   key. COLUMN_NAME Name of the column containing the primary key.
29744 *   KEY_SEQ 1-indexed position of the column in the key. PK_NAME The
29745 *   name of the primary key.
29746 * @since PECL ibm_db2 >= 1.0.0
29747 **/
29748function db2_primary_keys($connection, $qualifier, $schema, $tablename){}
29749
29750/**
29751 * Returns a result set listing the stored procedures registered in a
29752 * database
29753 *
29754 * Returns a result set listing the stored procedures registered in a
29755 * database.
29756 *
29757 * @param resource $connection A valid connection to an IBM DB2,
29758 *   Cloudscape, or Apache Derby database.
29759 * @param string $qualifier A qualifier for DB2 databases running on
29760 *   OS/390 or z/OS servers. For other databases, pass NULL or an empty
29761 *   string.
29762 * @param string $schema The schema which contains the procedures. This
29763 *   parameter accepts a search pattern containing _ and % as wildcards.
29764 * @param string $procedure The name of the procedure. This parameter
29765 *   accepts a search pattern containing _ and % as wildcards.
29766 * @return resource Returns a statement resource with a result set
29767 *   containing rows describing the stored procedures matching the
29768 *   specified parameters. The rows are composed of the following
29769 *   columns: Column name Description PROCEDURE_CAT The catalog that
29770 *   contains the procedure. The value is NULL if this table does not
29771 *   have catalogs. PROCEDURE_SCHEM Name of the schema that contains the
29772 *   stored procedure. PROCEDURE_NAME Name of the procedure.
29773 *   NUM_INPUT_PARAMS Number of input (IN) parameters for the stored
29774 *   procedure. NUM_OUTPUT_PARAMS Number of output (OUT) parameters for
29775 *   the stored procedure. NUM_RESULT_SETS Number of result sets returned
29776 *   by the stored procedure. REMARKS Any comments about the stored
29777 *   procedure. PROCEDURE_TYPE Always returns 1, indicating that the
29778 *   stored procedure does not return a return value.
29779 * @since PECL ibm_db2 >= 1.0.0
29780 **/
29781function db2_procedures($connection, $qualifier, $schema, $procedure){}
29782
29783/**
29784 * Returns a result set listing stored procedure parameters
29785 *
29786 * Returns a result set listing the parameters for one or more stored
29787 * procedures.
29788 *
29789 * @param resource $connection A valid connection to an IBM DB2,
29790 *   Cloudscape, or Apache Derby database.
29791 * @param string $qualifier A qualifier for DB2 databases running on
29792 *   OS/390 or z/OS servers. For other databases, pass NULL or an empty
29793 *   string.
29794 * @param string $schema The schema which contains the procedures. This
29795 *   parameter accepts a search pattern containing _ and % as wildcards.
29796 * @param string $procedure The name of the procedure. This parameter
29797 *   accepts a search pattern containing _ and % as wildcards.
29798 * @param string $parameter The name of the parameter. This parameter
29799 *   accepts a search pattern containing _ and % as wildcards. If this
29800 *   parameter is NULL, all parameters for the specified stored
29801 *   procedures are returned.
29802 * @return resource Returns a statement resource with a result set
29803 *   containing rows describing the parameters for the stored procedures
29804 *   matching the specified parameters. The rows are composed of the
29805 *   following columns: Column name Description PROCEDURE_CAT The catalog
29806 *   that contains the procedure. The value is NULL if this table does
29807 *   not have catalogs. PROCEDURE_SCHEM Name of the schema that contains
29808 *   the stored procedure. PROCEDURE_NAME Name of the procedure.
29809 *   COLUMN_NAME Name of the parameter. COLUMN_TYPE An integer value
29810 *   representing the type of the parameter: Return value Parameter type
29811 *   1 (SQL_PARAM_INPUT) Input (IN) parameter. 2 (SQL_PARAM_INPUT_OUTPUT)
29812 *   Input/output (INOUT) parameter. 3 (SQL_PARAM_OUTPUT) Output (OUT)
29813 *   parameter. DATA_TYPE The SQL data type for the parameter represented
29814 *   as an integer value. TYPE_NAME A string representing the data type
29815 *   for the parameter. COLUMN_SIZE An integer value representing the
29816 *   size of the parameter. BUFFER_LENGTH Maximum number of bytes
29817 *   necessary to store data for this parameter. DECIMAL_DIGITS The scale
29818 *   of the parameter, or NULL where scale is not applicable.
29819 *   NUM_PREC_RADIX An integer value of either 10 (representing an exact
29820 *   numeric data type), 2 (representing an approximate numeric data
29821 *   type), or NULL (representing a data type for which radix is not
29822 *   applicable). NULLABLE An integer value representing whether the
29823 *   parameter is nullable or not. REMARKS Description of the parameter.
29824 *   COLUMN_DEF Default value for the parameter. SQL_DATA_TYPE An integer
29825 *   value representing the size of the parameter. SQL_DATETIME_SUB
29826 *   Returns an integer value representing a datetime subtype code, or
29827 *   NULL for SQL data types to which this does not apply.
29828 *   CHAR_OCTET_LENGTH Maximum length in octets for a character data type
29829 *   parameter, which matches COLUMN_SIZE for single-byte character set
29830 *   data, or NULL for non-character data types. ORDINAL_POSITION The
29831 *   1-indexed position of the parameter in the CALL statement.
29832 *   IS_NULLABLE A string value where 'YES' means that the parameter
29833 *   accepts or returns NULL values and 'NO' means that the parameter
29834 *   does not accept or return NULL values.
29835 * @since PECL ibm_db2 >= 1.0.0
29836 **/
29837function db2_procedure_columns($connection, $qualifier, $schema, $procedure, $parameter){}
29838
29839/**
29840 * Returns a single column from a row in the result set
29841 *
29842 * Use {@link db2_result} to return the value of a specified column in
29843 * the current row of a result set. You must call {@link db2_fetch_row}
29844 * before calling {@link db2_result} to set the location of the result
29845 * set pointer.
29846 *
29847 * @param resource $stmt A valid stmt resource.
29848 * @param mixed $column Either an integer mapping to the 0-indexed
29849 *   field in the result set, or a string matching the name of the
29850 *   column.
29851 * @return mixed Returns the value of the requested field if the field
29852 *   exists in the result set. Returns NULL if the field does not exist,
29853 *   and issues a warning.
29854 * @since PECL ibm_db2 >= 1.0.0
29855 **/
29856function db2_result($stmt, $column){}
29857
29858/**
29859 * Rolls back a transaction
29860 *
29861 * Rolls back an in-progress transaction on the specified connection
29862 * resource and begins a new transaction. PHP applications normally
29863 * default to AUTOCOMMIT mode, so {@link db2_rollback} normally has no
29864 * effect unless AUTOCOMMIT has been turned off for the connection
29865 * resource.
29866 *
29867 * @param resource $connection A valid database connection resource
29868 *   variable as returned from {@link db2_connect} or {@link
29869 *   db2_pconnect}.
29870 * @return bool
29871 * @since PECL ibm_db2 >= 1.0.0
29872 **/
29873function db2_rollback($connection){}
29874
29875/**
29876 * Returns an object with properties that describe the DB2 database
29877 * server
29878 *
29879 * This function returns an object with read-only properties that return
29880 * information about the IBM DB2, Cloudscape, or Apache Derby database
29881 * server. The following table lists the database server properties:
29882 * Database server properties Property name Return type Description
29883 * DBMS_NAME string The name of the database server to which you are
29884 * connected. For DB2 servers this is a combination of DB2 followed by
29885 * the operating system on which the database server is running. DBMS_VER
29886 * string The version of the database server, in the form of a string
29887 * "MM.mm.uuuu" where MM is the major version, mm is the minor version,
29888 * and uuuu is the update. For example, "08.02.0001" represents major
29889 * version 8, minor version 2, update 1. DB_CODEPAGE int The code page of
29890 * the database to which you are connected. DB_NAME string The name of
29891 * the database to which you are connected. DFT_ISOLATION string The
29892 * default transaction isolation level supported by the server: UR
29893 * Uncommitted read: changes are immediately visible by all concurrent
29894 * transactions. CS Cursor stability: a row read by one transaction can
29895 * be altered and committed by a second concurrent transaction. RS Read
29896 * stability: a transaction can add or remove rows matching a search
29897 * condition or a pending transaction. RR Repeatable read: data affected
29898 * by pending transaction is not available to other transactions. NC No
29899 * commit: any changes are visible at the end of a successful operation.
29900 * Explicit commits and rollbacks are not allowed. IDENTIFIER_QUOTE_CHAR
29901 * string The character used to delimit an identifier. INST_NAME string
29902 * The instance on the database server that contains the database.
29903 * ISOLATION_OPTION array An array of the isolation options supported by
29904 * the database server. The isolation options are described in the
29905 * DFT_ISOLATION property. KEYWORDS array An array of the keywords
29906 * reserved by the database server. LIKE_ESCAPE_CLAUSE bool TRUE if the
29907 * database server supports the use of % and _ wildcard characters. FALSE
29908 * if the database server does not support these wildcard characters.
29909 * MAX_COL_NAME_LEN int Maximum length of a column name supported by the
29910 * database server, expressed in bytes. MAX_IDENTIFIER_LEN int Maximum
29911 * length of an SQL identifier supported by the database server,
29912 * expressed in characters. MAX_INDEX_SIZE int Maximum size of columns
29913 * combined in an index supported by the database server, expressed in
29914 * bytes. MAX_PROC_NAME_LEN int Maximum length of a procedure name
29915 * supported by the database server, expressed in bytes. MAX_ROW_SIZE int
29916 * Maximum length of a row in a base table supported by the database
29917 * server, expressed in bytes. MAX_SCHEMA_NAME_LEN int Maximum length of
29918 * a schema name supported by the database server, expressed in bytes.
29919 * MAX_STATEMENT_LEN int Maximum length of an SQL statement supported by
29920 * the database server, expressed in bytes. MAX_TABLE_NAME_LEN int
29921 * Maximum length of a table name supported by the database server,
29922 * expressed in bytes. NON_NULLABLE_COLUMNS bool TRUE if the database
29923 * server supports columns that can be defined as NOT NULL, FALSE if the
29924 * database server does not support columns defined as NOT NULL.
29925 * PROCEDURES bool TRUE if the database server supports the use of the
29926 * CALL statement to call stored procedures, FALSE if the database server
29927 * does not support the CALL statement. SPECIAL_CHARS string A string
29928 * containing all of the characters other than a-Z, 0-9, and underscore
29929 * that can be used in an identifier name. SQL_CONFORMANCE string The
29930 * level of conformance to the ANSI/ISO SQL-92 specification offered by
29931 * the database server: ENTRY Entry-level SQL-92 compliance. FIPS127
29932 * FIPS-127-2 transitional compliance. FULL Full level SQL-92 compliance.
29933 * INTERMEDIATE Intermediate level SQL-92 compliance.
29934 *
29935 * @param resource $connection Specifies an active DB2 client
29936 *   connection.
29937 * @return object Returns an object on a successful call. Returns FALSE
29938 *   on failure.
29939 * @since PECL ibm_db2 >= 1.1.1
29940 **/
29941function db2_server_info($connection){}
29942
29943/**
29944 * Set options for connection or statement resources
29945 *
29946 * Sets options for a statement resource or a connection resource. You
29947 * cannot set options for result set resources.
29948 *
29949 * @param resource $resource A valid statement resource as returned
29950 *   from {@link db2_prepare} or a valid connection resource as returned
29951 *   from {@link db2_connect} or {@link db2_pconnect}.
29952 * @param array $options An associative array containing valid
29953 *   statement or connection options. This parameter can be used to
29954 *   change autocommit values, cursor types (scrollable or forward), and
29955 *   to specify the case of the column names (lower, upper, or natural)
29956 *   that will appear in a result set. {@link autocommit} Passing
29957 *   DB2_AUTOCOMMIT_ON turns autocommit on for the specified connection
29958 *   resource. Passing DB2_AUTOCOMMIT_OFF turns autocommit off for the
29959 *   specified connection resource. {@link cursor} Passing
29960 *   DB2_FORWARD_ONLY specifies a forward-only cursor for a statement
29961 *   resource. This is the default cursor type, and is supported by all
29962 *   database servers. Passing DB2_SCROLLABLE specifies a scrollable
29963 *   cursor for a statement resource. Scrollable cursors enable result
29964 *   set rows to be accessed in non-sequential order, but are only
29965 *   supported by IBM DB2 Universal Database databases. {@link binmode}
29966 *   Passing DB2_BINARY specifies that binary data will be returned as
29967 *   is. This is the default mode. This is the equivalent of setting
29968 *   ibm_db2.binmode=1 in . Passing DB2_CONVERT specifies that binary
29969 *   data will be converted to hexadecimal encoding, and will be returned
29970 *   as such. This is the equivalent of setting ibm_db2.binmode=2 in .
29971 *   Passing DB2_PASSTHRU specifies that binary data will be converted to
29972 *   NULL. This is the equivalent of setting ibm_db2.binmode=3 in .
29973 *   {@link db2_attr_case} Passing DB2_CASE_LOWER specifies that column
29974 *   names of the result set are returned in lower case. Passing
29975 *   DB2_CASE_UPPER specifies that column names of the result set are
29976 *   returned in upper case. Passing DB2_CASE_NATURAL specifies that
29977 *   column names of the result set are returned in natural case. {@link
29978 *   deferred_prepare} Passing DB2_DEFERRED_PREPARE_ON turns deferred
29979 *   prepare on for the specified statement resource. Passing
29980 *   DB2_DEFERRED_PREPARE_OFF turns deferred prepare off for the
29981 *   specified statement resource. The following new i5/OS options are
29982 *   available in ibm_db2 version 1.5.1 and later. These options apply
29983 *   only when running PHP and ibm_db2 natively on i5 systems. {@link
29984 *   i5_fetch_only} DB2_I5_FETCH_ON - Cursors are read-only and cannot be
29985 *   used for positioned updates or deletes. This is the default unless
29986 *   SQL_ATTR_FOR_FETCH_ONLY environment has been set to SQL_FALSE.
29987 *   DB2_I5_FETCH_OFF - Cursors can be used for positioned updates and
29988 *   deletes. The following new option is available in ibm_db2 version
29989 *   1.8.0 and later. {@link rowcount} DB2_ROWCOUNT_PREFETCH_ON - Client
29990 *   can request the full row count prior to fetching, which means that
29991 *   {@link db2_num_rows} returns the number of rows selected even when a
29992 *   ROLLFORWARD_ONLY cursor is used. DB2_ROWCOUNT_PREFETCH_OFF - Client
29993 *   cannot request the full row count prior to fetching. The following
29994 *   new options are available in ibm_db2 version 1.7.0 and later. {@link
29995 *   trusted_user} To switch the user to a trusted user, pass the User ID
29996 *   (String) of the trusted user as the value of this key. This option
29997 *   can be set on a connection resource only. To use this option,
29998 *   trusted context must be enabled on the connection resource. {@link
29999 *   trusted_password} The password (String) that corresponds to the user
30000 *   specified by the trusted_user key. The following new options are
30001 *   available in ibm_db2 version 1.6.0 and later. These options provide
30002 *   useful tracking information that can be accessed during execution
30003 *   with {@link db2_get_option}. When the value in each option is being
30004 *   set, some servers might not handle the entire length provided and
30005 *   might truncate the value. To ensure that the data specified in each
30006 *   option is converted correctly when transmitted to a host system, use
30007 *   only the characters A through Z, 0 through 9, and the underscore (_)
30008 *   or period (.). {@link userid} SQL_ATTR_INFO_USERID - A pointer to a
30009 *   null-terminated character string used to identify the client user ID
30010 *   sent to the host database server when using DB2 Connect. DB2 for
30011 *   z/OS and OS/390 servers support up to a length of 16 characters.
30012 *   This user-id is not to be confused with the authentication user-id,
30013 *   it is for identification purposes only and is not used for any
30014 *   authorization. {@link acctstr} SQL_ATTR_INFO_ACCTSTR - A pointer to
30015 *   a null-terminated character string used to identify the client
30016 *   accounting string sent to the host database server when using DB2
30017 *   Connect. DB2 for z/OS and OS/390 servers support up to a length of
30018 *   200 characters. {@link applname} SQL_ATTR_INFO_APPLNAME - A pointer
30019 *   to a null-terminated character string used to identify the client
30020 *   application name sent to the host database server when using DB2
30021 *   Connect. DB2 for z/OS and OS/390 servers support up to a length of
30022 *   32 characters. {@link wrkstnname} SQL_ATTR_INFO_WRKSTNNAME - A
30023 *   pointer to a null-terminated character string used to identify the
30024 *   client workstation name sent to the host database server when using
30025 *   DB2 Connect. DB2 for z/OS and OS/390 servers support up to a length
30026 *   of 18 characters.
30027 * @param int $type Passing DB2_AUTOCOMMIT_ON turns autocommit on for
30028 *   the specified connection resource. Passing DB2_AUTOCOMMIT_OFF turns
30029 *   autocommit off for the specified connection resource.
30030 * @return bool
30031 * @since PECL ibm_db2 >= 1.0.0
30032 **/
30033function db2_set_option($resource, $options, $type){}
30034
30035/**
30036 * Returns a result set listing the unique row identifier columns for a
30037 * table
30038 *
30039 * Returns a result set listing the unique row identifier columns for a
30040 * table.
30041 *
30042 * @param resource $connection A valid connection to an IBM DB2,
30043 *   Cloudscape, or Apache Derby database.
30044 * @param string $qualifier A qualifier for DB2 databases running on
30045 *   OS/390 or z/OS servers. For other databases, pass NULL or an empty
30046 *   string.
30047 * @param string $schema The schema which contains the tables.
30048 * @param string $table_name The name of the table.
30049 * @param int $scope Integer value representing the minimum duration
30050 *   for which the unique row identifier is valid. This can be one of the
30051 *   following values: Integer value SQL constant Description 0
30052 *   SQL_SCOPE_CURROW Row identifier is valid only while the cursor is
30053 *   positioned on the row. 1 SQL_SCOPE_TRANSACTION Row identifier is
30054 *   valid for the duration of the transaction. 2 SQL_SCOPE_SESSION Row
30055 *   identifier is valid for the duration of the connection.
30056 * @return resource Returns a statement resource with a result set
30057 *   containing rows with unique row identifier information for a table.
30058 *   The rows are composed of the following columns: Column name
30059 *   Description SCOPE Integer value SQL constant Description 0
30060 *   SQL_SCOPE_CURROW Row identifier is valid only while the cursor is
30061 *   positioned on the row. 1 SQL_SCOPE_TRANSACTION Row identifier is
30062 *   valid for the duration of the transaction. 2 SQL_SCOPE_SESSION Row
30063 *   identifier is valid for the duration of the connection. COLUMN_NAME
30064 *   Name of the unique column. DATA_TYPE SQL data type for the column.
30065 *   TYPE_NAME Character string representation of the SQL data type for
30066 *   the column. COLUMN_SIZE An integer value representing the size of
30067 *   the column. BUFFER_LENGTH Maximum number of bytes necessary to store
30068 *   data from this column. DECIMAL_DIGITS The scale of the column, or
30069 *   NULL where scale is not applicable. NUM_PREC_RADIX An integer value
30070 *   of either 10 (representing an exact numeric data type), 2
30071 *   (representing an approximate numeric data type), or NULL
30072 *   (representing a data type for which radix is not applicable).
30073 *   PSEUDO_COLUMN Always returns 1.
30074 * @since PECL ibm_db2 >= 1.0.0
30075 **/
30076function db2_special_columns($connection, $qualifier, $schema, $table_name, $scope){}
30077
30078/**
30079 * Returns a result set listing the index and statistics for a table
30080 *
30081 * Returns a result set listing the index and statistics for a table.
30082 *
30083 * @param resource $connection A valid connection to an IBM DB2,
30084 *   Cloudscape, or Apache Derby database.
30085 * @param string $qualifier A qualifier for DB2 databases running on
30086 *   OS/390 or z/OS servers. For other databases, pass NULL or an empty
30087 *   string.
30088 * @param string $schema The schema that contains the targeted table.
30089 *   If this parameter is NULL, the statistics and indexes are returned
30090 *   for the schema of the current user.
30091 * @param string $tablename The name of the table.
30092 * @param bool $unique An integer value representing the type of index
30093 *   information to return. {@link 0} Return only the information for
30094 *   unique indexes on the table. {@link 1} Return the information for
30095 *   all indexes on the table.
30096 * @return resource Returns a statement resource with a result set
30097 *   containing rows describing the statistics and indexes for the base
30098 *   tables matching the specified parameters. The rows are composed of
30099 *   the following columns: Column name Description TABLE_CAT The catalog
30100 *   that contains the table. The value is NULL if this table does not
30101 *   have catalogs. TABLE_SCHEM Name of the schema that contains the
30102 *   table. TABLE_NAME Name of the table. NON_UNIQUE An integer value
30103 *   representing whether the index prohibits unique values, or whether
30104 *   the row represents statistics on the table itself: Return value
30105 *   Parameter type 0 (SQL_FALSE) The index allows duplicate values. 1
30106 *   (SQL_TRUE) The index values must be unique. NULL This row is
30107 *   statistics information for the table itself. INDEX_QUALIFIER A
30108 *   string value representing the qualifier that would have to be
30109 *   prepended to INDEX_NAME to fully qualify the index. INDEX_NAME A
30110 *   string representing the name of the index. TYPE An integer value
30111 *   representing the type of information contained in this row of the
30112 *   result set: Return value Parameter type 0 (SQL_TABLE_STAT) The row
30113 *   contains statistics about the table itself. 1 (SQL_INDEX_CLUSTERED)
30114 *   The row contains information about a clustered index. 2
30115 *   (SQL_INDEX_HASH) The row contains information about a hashed index.
30116 *   3 (SQL_INDEX_OTHER) The row contains information about a type of
30117 *   index that is neither clustered nor hashed. ORDINAL_POSITION The
30118 *   1-indexed position of the column in the index. NULL if the row
30119 *   contains statistics information about the table itself. COLUMN_NAME
30120 *   The name of the column in the index. NULL if the row contains
30121 *   statistics information about the table itself. ASC_OR_DESC A if the
30122 *   column is sorted in ascending order, D if the column is sorted in
30123 *   descending order, NULL if the row contains statistics information
30124 *   about the table itself. CARDINALITY If the row contains information
30125 *   about an index, this column contains an integer value representing
30126 *   the number of unique values in the index. If the row contains
30127 *   information about the table itself, this column contains an integer
30128 *   value representing the number of rows in the table. PAGES If the row
30129 *   contains information about an index, this column contains an integer
30130 *   value representing the number of pages used to store the index. If
30131 *   the row contains information about the table itself, this column
30132 *   contains an integer value representing the number of pages used to
30133 *   store the table. FILTER_CONDITION Always returns NULL.
30134 * @since PECL ibm_db2 >= 1.0.0
30135 **/
30136function db2_statistics($connection, $qualifier, $schema, $tablename, $unique){}
30137
30138/**
30139 * Returns a string containing the SQLSTATE returned by an SQL statement
30140 *
30141 * Returns a string containing the SQLSTATE value returned by an SQL
30142 * statement.
30143 *
30144 * If you do not pass a statement resource as an argument to {@link
30145 * db2_stmt_error}, the driver returns the SQLSTATE value associated with
30146 * the last attempt to return a statement resource, for example, from
30147 * {@link db2_prepare} or {@link db2_exec}.
30148 *
30149 * To learn what the SQLSTATE value means, you can issue the following
30150 * command at a DB2 Command Line Processor prompt: db2 '? {@link
30151 * sqlstate-value}'. You can also call {@link db2_stmt_errormsg} to
30152 * retrieve an explicit error message and the associated SQLCODE value.
30153 *
30154 * @param resource $stmt A valid statement resource.
30155 * @return string Returns a string containing an SQLSTATE value.
30156 * @since PECL ibm_db2 >= 1.0.0
30157 **/
30158function db2_stmt_error($stmt){}
30159
30160/**
30161 * Returns a string containing the last SQL statement error message
30162 *
30163 * Returns a string containing the last SQL statement error message.
30164 *
30165 * If you do not pass a statement resource as an argument to {@link
30166 * db2_stmt_errormsg}, the driver returns the error message associated
30167 * with the last attempt to return a statement resource, for example,
30168 * from {@link db2_prepare} or {@link db2_exec}.
30169 *
30170 * @param resource $stmt A valid statement resource.
30171 * @return string Returns a string containing the error message and
30172 *   SQLCODE value for the last error that occurred issuing an SQL
30173 *   statement.
30174 * @since PECL ibm_db2 >= 1.0.0
30175 **/
30176function db2_stmt_errormsg($stmt){}
30177
30178/**
30179 * Returns a result set listing the tables and associated metadata in a
30180 * database
30181 *
30182 * Returns a result set listing the tables and associated metadata in a
30183 * database.
30184 *
30185 * @param resource $connection A valid connection to an IBM DB2,
30186 *   Cloudscape, or Apache Derby database.
30187 * @param string $qualifier A qualifier for DB2 databases running on
30188 *   OS/390 or z/OS servers. For other databases, pass NULL or an empty
30189 *   string.
30190 * @param string $schema The schema which contains the tables. This
30191 *   parameter accepts a search pattern containing _ and % as wildcards.
30192 * @param string $tablename The name of the table. This parameter
30193 *   accepts a search pattern containing _ and % as wildcards.
30194 * @param string $tabletype A list of comma-delimited table type
30195 *   identifiers. To match all table types, pass NULL or an empty string.
30196 *   Valid table type identifiers include: ALIAS, HIERARCHY TABLE,
30197 *   INOPERATIVE VIEW, NICKNAME, MATERIALIZED QUERY TABLE, SYSTEM TABLE,
30198 *   TABLE, TYPED TABLE, TYPED VIEW, and VIEW.
30199 * @return resource Returns a statement resource with a result set
30200 *   containing rows describing the tables that match the specified
30201 *   parameters. The rows are composed of the following columns: Column
30202 *   name Description TABLE_CAT The catalog that contains the table. The
30203 *   value is NULL if this table does not have catalogs. TABLE_SCHEM Name
30204 *   of the schema that contains the table. TABLE_NAME Name of the table.
30205 *   TABLE_TYPE Table type identifier for the table. REMARKS Description
30206 *   of the table.
30207 * @since PECL ibm_db2 >= 1.0.0
30208 **/
30209function db2_tables($connection, $qualifier, $schema, $tablename, $tabletype){}
30210
30211/**
30212 * Returns a result set listing the tables and associated privileges in a
30213 * database
30214 *
30215 * Returns a result set listing the tables and associated privileges in a
30216 * database.
30217 *
30218 * @param resource $connection A valid connection to an IBM DB2,
30219 *   Cloudscape, or Apache Derby database.
30220 * @param string $qualifier A qualifier for DB2 databases running on
30221 *   OS/390 or z/OS servers. For other databases, pass NULL or an empty
30222 *   string.
30223 * @param string $schema The schema which contains the tables. This
30224 *   parameter accepts a search pattern containing _ and % as wildcards.
30225 * @param string $table_name The name of the table. This parameter
30226 *   accepts a search pattern containing _ and % as wildcards.
30227 * @return resource Returns a statement resource with a result set
30228 *   containing rows describing the privileges for the tables that match
30229 *   the specified parameters. The rows are composed of the following
30230 *   columns: Column name Description TABLE_CAT The catalog that contains
30231 *   the table. The value is NULL if this table does not have catalogs.
30232 *   TABLE_SCHEM Name of the schema that contains the table. TABLE_NAME
30233 *   Name of the table. GRANTOR Authorization ID of the user who granted
30234 *   the privilege. GRANTEE Authorization ID of the user to whom the
30235 *   privilege was granted. PRIVILEGE The privilege that has been
30236 *   granted. This can be one of ALTER, CONTROL, DELETE, INDEX, INSERT,
30237 *   REFERENCES, SELECT, or UPDATE. IS_GRANTABLE A string value of "YES"
30238 *   or "NO" indicating whether the grantee can grant the privilege to
30239 *   other users.
30240 * @since PECL ibm_db2 >= 1.0.0
30241 **/
30242function db2_table_privileges($connection, $qualifier, $schema, $table_name){}
30243
30244/**
30245 * Adds a record to a database
30246 *
30247 * Adds the given data to the database.
30248 *
30249 * @param resource $dbase_identifier The database link identifier,
30250 *   returned by {@link dbase_open} or {@link dbase_create}.
30251 * @param array $record An indexed array of data. The number of items
30252 *   must be equal to the number of fields in the database, otherwise
30253 *   {@link dbase_add_record} will fail.
30254 * @return bool
30255 * @since PHP 5 < 5.3.0, dbase 5, dbase 7
30256 **/
30257function dbase_add_record($dbase_identifier, $record){}
30258
30259/**
30260 * Closes a database
30261 *
30262 * Closes the given database link identifier.
30263 *
30264 * @param resource $dbase_identifier The database link identifier,
30265 *   returned by {@link dbase_open} or {@link dbase_create}.
30266 * @return bool
30267 * @since PHP 5 < 5.3.0, dbase 5, dbase 7
30268 **/
30269function dbase_close($dbase_identifier){}
30270
30271/**
30272 * Creates a database
30273 *
30274 * {@link dbase_create} creates a dBase database with the given
30275 * definition. If the file already exists, it is not truncated. {@link
30276 * dbase_pack} can be called to force truncation.
30277 *
30278 * @param string $filename The name of the database. It can be a
30279 *   relative or absolute path to the file where dBase will store your
30280 *   data.
30281 * @param array $fields An array of arrays, each array describing the
30282 *   format of one field of the database. Each field consists of a name,
30283 *   a character indicating the field type, and optionally, a length, a
30284 *   precision and a nullable flag. The supported field types are listed
30285 *   in the introduction section.
30286 * @param int $type The type of database to be created. Either
30287 *   DBASE_TYPE_DBASE or DBASE_TYPE_FOXPRO.
30288 * @return resource Returns a database link identifier if the database
30289 *   is successfully created, or FALSE if an error occurred.
30290 * @since PHP 5 < 5.3.0, dbase 5, dbase 7
30291 **/
30292function dbase_create($filename, $fields, $type){}
30293
30294/**
30295 * Deletes a record from a database
30296 *
30297 * Marks the given record to be deleted from the database.
30298 *
30299 * @param resource $dbase_identifier The database link identifier,
30300 *   returned by {@link dbase_open} or {@link dbase_create}.
30301 * @param int $record_number An integer which spans from 1 to the
30302 *   number of records in the database (as returned by {@link
30303 *   dbase_numrecords}).
30304 * @return bool
30305 * @since PHP 5 < 5.3.0, dbase 5, dbase 7
30306 **/
30307function dbase_delete_record($dbase_identifier, $record_number){}
30308
30309/**
30310 * Gets the header info of a database
30311 *
30312 * Returns information on the column structure of the given database link
30313 * identifier.
30314 *
30315 * @param resource $dbase_identifier The database link identifier,
30316 *   returned by {@link dbase_open} or {@link dbase_create}.
30317 * @return array An indexed array with an entry for each column in the
30318 *   database. The array index starts at 0.
30319 * @since PHP 5 < 5.3.0, dbase 5, dbase 7
30320 **/
30321function dbase_get_header_info($dbase_identifier){}
30322
30323/**
30324 * Gets a record from a database as an indexed array
30325 *
30326 * Gets a record from a database as an indexed array.
30327 *
30328 * @param resource $dbase_identifier The database link identifier,
30329 *   returned by {@link dbase_open} or {@link dbase_create}.
30330 * @param int $record_number The index of the record between 1 and
30331 *   dbase_numrecords($dbase_identifier).
30332 * @return array An indexed array with the record. This array will also
30333 *   include an associative key named deleted which is set to 1 if the
30334 *   record has been marked for deletion (see {@link
30335 *   dbase_delete_record}).
30336 * @since PHP 5 < 5.3.0, dbase 5, dbase 7
30337 **/
30338function dbase_get_record($dbase_identifier, $record_number){}
30339
30340/**
30341 * Gets a record from a database as an associative array
30342 *
30343 * Gets a record from a dBase database as an associative array.
30344 *
30345 * @param resource $dbase_identifier The database link identifier,
30346 *   returned by {@link dbase_open} or {@link dbase_create}.
30347 * @param int $record_number The index of the record between 1 and
30348 *   dbase_numrecords($dbase_identifier).
30349 * @return array An associative array with the record. This will also
30350 *   include a key named deleted which is set to 1 if the record has been
30351 *   marked for deletion (see {@link dbase_delete_record}). Therefore it
30352 *   is not possible to retrieve the value of a field named deleted with
30353 *   this function.
30354 * @since PHP 5 < 5.3.0, dbase 5, dbase 7
30355 **/
30356function dbase_get_record_with_names($dbase_identifier, $record_number){}
30357
30358/**
30359 * Gets the number of fields of a database
30360 *
30361 * Gets the number of fields (columns) in the specified database.
30362 *
30363 * @param resource $dbase_identifier The database link identifier,
30364 *   returned by {@link dbase_open} or {@link dbase_create}.
30365 * @return int The number of fields in the database, or FALSE if an
30366 *   error occurs.
30367 * @since PHP 5 < 5.3.0, dbase 5, dbase 7
30368 **/
30369function dbase_numfields($dbase_identifier){}
30370
30371/**
30372 * Gets the number of records in a database
30373 *
30374 * Gets the number of records (rows) in the specified database.
30375 *
30376 * @param resource $dbase_identifier The database link identifier,
30377 *   returned by {@link dbase_open} or {@link dbase_create}.
30378 * @return int The number of records in the database, or FALSE if an
30379 *   error occurs.
30380 * @since PHP 5 < 5.3.0, dbase 5, dbase 7
30381 **/
30382function dbase_numrecords($dbase_identifier){}
30383
30384/**
30385 * Opens a database
30386 *
30387 * {@link dbase_open} opens a dBase database with the given access mode.
30388 *
30389 * @param string $filename The name of the database. It can be a
30390 *   relative or absolute path to the file where dBase will store your
30391 *   data.
30392 * @param int $mode An integer which correspond to those for the open()
30393 *   system call (Typically 0 means read-only, 1 means write-only, and 2
30394 *   means read and write). As of dbase 7.0.0 you can use DBASE_RDONLY
30395 *   and DBASE_RDWR, respectively, to specify the {@link mode}.
30396 * @return resource Returns a database link identifier if the database
30397 *   is successfully opened, or FALSE if an error occurred.
30398 * @since PHP 5 < 5.3.0, dbase 5, dbase 7
30399 **/
30400function dbase_open($filename, $mode){}
30401
30402/**
30403 * Packs a database
30404 *
30405 * Packs the specified database by permanently deleting all records
30406 * marked for deletion using {@link dbase_delete_record}. Note that the
30407 * file will be truncated after successful packing (contrary to dBASE
30408 * III's PACK command).
30409 *
30410 * @param resource $dbase_identifier The database link identifier,
30411 *   returned by {@link dbase_open} or {@link dbase_create}.
30412 * @return bool
30413 * @since PHP 5 < 5.3.0, dbase 5, dbase 7
30414 **/
30415function dbase_pack($dbase_identifier){}
30416
30417/**
30418 * Replaces a record in a database
30419 *
30420 * Replaces the given record in the database with the given data.
30421 *
30422 * @param resource $dbase_identifier The database link identifier,
30423 *   returned by {@link dbase_open} or {@link dbase_create}.
30424 * @param array $record An indexed array of data. The number of items
30425 *   must be equal to the number of fields in the database, otherwise
30426 *   {@link dbase_replace_record} will fail.
30427 * @param int $record_number An integer which spans from 1 to the
30428 *   number of records in the database (as returned by {@link
30429 *   dbase_numrecords}).
30430 * @return bool
30431 * @since PHP 5 < 5.3.0, dbase 5, dbase 7
30432 **/
30433function dbase_replace_record($dbase_identifier, $record, $record_number){}
30434
30435/**
30436 * Close a DBA database
30437 *
30438 * {@link dba_close} closes the established database and frees all
30439 * resources of the specified database handle.
30440 *
30441 * @param resource $handle The database handler, returned by {@link
30442 *   dba_open} or {@link dba_popen}.
30443 * @return void
30444 * @since PHP 4, PHP 5, PHP 7
30445 **/
30446function dba_close($handle){}
30447
30448/**
30449 * Delete DBA entry specified by key
30450 *
30451 * {@link dba_delete} deletes the specified entry from the database.
30452 *
30453 * @param string $key The key of the entry which is deleted.
30454 * @param resource $handle The database handler, returned by {@link
30455 *   dba_open} or {@link dba_popen}.
30456 * @return bool
30457 * @since PHP 4, PHP 5, PHP 7
30458 **/
30459function dba_delete($key, $handle){}
30460
30461/**
30462 * Check whether key exists
30463 *
30464 * {@link dba_exists} checks whether the specified {@link key} exists in
30465 * the database.
30466 *
30467 * @param string $key The key the check is performed for.
30468 * @param resource $handle The database handler, returned by {@link
30469 *   dba_open} or {@link dba_popen}.
30470 * @return bool Returns TRUE if the key exists, FALSE otherwise.
30471 * @since PHP 4, PHP 5, PHP 7
30472 **/
30473function dba_exists($key, $handle){}
30474
30475/**
30476 * Fetch data specified by key
30477 *
30478 * {@link dba_fetch} fetches the data specified by {@link key} from the
30479 * database specified with {@link handle}.
30480 *
30481 * @param string $key The key the data is specified by.
30482 * @param resource $handle The number of key-value pairs to ignore when
30483 *   using cdb databases. This value is ignored for all other databases
30484 *   which do not support multiple keys with the same name.
30485 * @return string Returns the associated string if the key/data pair is
30486 *   found, FALSE otherwise.
30487 * @since PHP 4, PHP 5, PHP 7
30488 **/
30489function dba_fetch($key, $handle){}
30490
30491/**
30492 * Fetch first key
30493 *
30494 * {@link dba_firstkey} returns the first key of the database and resets
30495 * the internal key pointer. This permits a linear search through the
30496 * whole database.
30497 *
30498 * @param resource $handle The database handler, returned by {@link
30499 *   dba_open} or {@link dba_popen}.
30500 * @return string Returns the key on success.
30501 * @since PHP 4, PHP 5, PHP 7
30502 **/
30503function dba_firstkey($handle){}
30504
30505/**
30506 * List all the handlers available
30507 *
30508 * {@link dba_handlers} list all the handlers supported by this
30509 * extension.
30510 *
30511 * @param bool $full_info Turns on/off full information display in the
30512 *   result.
30513 * @return array Returns an array of database handlers. If {@link
30514 *   full_info} is set to TRUE, the array will be associative with the
30515 *   handlers names as keys, and their version information as value.
30516 *   Otherwise, the result will be an indexed array of handlers names.
30517 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
30518 **/
30519function dba_handlers($full_info){}
30520
30521/**
30522 * Insert entry
30523 *
30524 * {@link dba_insert} inserts the entry described with {@link key} and
30525 * {@link value} into the database.
30526 *
30527 * @param string $key The key of the entry to be inserted. If this key
30528 *   already exist in the database, this function will fail. Use {@link
30529 *   dba_replace} if you need to replace an existent key.
30530 * @param string $value The value to be inserted.
30531 * @param resource $handle The database handler, returned by {@link
30532 *   dba_open} or {@link dba_popen}.
30533 * @return bool
30534 * @since PHP 4, PHP 5, PHP 7
30535 **/
30536function dba_insert($key, $value, $handle){}
30537
30538/**
30539 * Splits a key in string representation into array representation
30540 *
30541 * {@link dba_key_split} splits a key (string representation) into an
30542 * array representation.
30543 *
30544 * @param mixed $key The key in string representation.
30545 * @return mixed Returns an array of the form array(0 => group, 1 =>
30546 *   value_name). This function will return FALSE if {@link key} is NULL
30547 *   or FALSE.
30548 * @since PHP 5, PHP 7
30549 **/
30550function dba_key_split($key){}
30551
30552/**
30553 * List all open database files
30554 *
30555 * {@link dba_list} list all open database files.
30556 *
30557 * @return array An associative array, in the form resourceid =>
30558 *   filename.
30559 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
30560 **/
30561function dba_list(){}
30562
30563/**
30564 * Fetch next key
30565 *
30566 * {@link dba_nextkey} returns the next key of the database and advances
30567 * the internal key pointer.
30568 *
30569 * @param resource $handle The database handler, returned by {@link
30570 *   dba_open} or {@link dba_popen}.
30571 * @return string Returns the key on success.
30572 * @since PHP 4, PHP 5, PHP 7
30573 **/
30574function dba_nextkey($handle){}
30575
30576/**
30577 * Open database
30578 *
30579 * {@link dba_open} establishes a database instance for {@link path} with
30580 * {@link mode} using {@link handler}.
30581 *
30582 * @param string $path Commonly a regular path in your filesystem.
30583 * @param string $mode It is r for read access, w for read/write access
30584 *   to an already existing database, c for read/write access and
30585 *   database creation if it doesn't currently exist, and n for create,
30586 *   truncate and read/write access. The database is created in BTree
30587 *   mode, other modes (like Hash or Queue) are not supported.
30588 *   Additionally you can set the database lock method with the next
30589 *   char. Use l to lock the database with a .lck file or d to lock the
30590 *   databasefile itself. It is important that all of your applications
30591 *   do this consistently. If you want to test the access and do not want
30592 *   to wait for the lock you can add t as third character. When you are
30593 *   absolutely sure that you do not require database locking you can do
30594 *   so by using - instead of l or d. When none of d, l or - is used, dba
30595 *   will lock on the database file as it would with d.
30596 * @param string $handler The name of the handler which shall be used
30597 *   for accessing {@link path}. It is passed all optional parameters
30598 *   given to {@link dba_open} and can act on behalf of them.
30599 * @param string ...$vararg Optional parameters which are passed to the
30600 *   driver. The cdb, cdb_make, flatfile, inifile, qdbm and tcadb drivers
30601 *   do not support additional parameters. The db1, db2, db3, db4, dbm,
30602 *   gdbm, and ndbm drivers supports a single additional parameter
30603 *   $filemode, which has the same meaning as the $mode parameter of
30604 *   {@link chmod}, and defaults to 0644. The lmdb driver accepts two
30605 *   additional parameters. The first allows to specify the $filemode
30606 *   (see description above), and the second to specify the $mapsize,
30607 *   where the value should be a multiple of the page size of the OS, or
30608 *   zero, to use the default mapsize. The $mapsize parameter is
30609 *   supported as of PHP 7.3.14 and 7.4.2, respectively.
30610 * @return resource Returns a positive handle on success.
30611 * @since PHP 4, PHP 5, PHP 7
30612 **/
30613function dba_open($path, $mode, $handler, ...$vararg){}
30614
30615/**
30616 * Optimize database
30617 *
30618 * {@link dba_optimize} optimizes the underlying database.
30619 *
30620 * @param resource $handle The database handler, returned by {@link
30621 *   dba_open} or {@link dba_popen}.
30622 * @return bool
30623 * @since PHP 4, PHP 5, PHP 7
30624 **/
30625function dba_optimize($handle){}
30626
30627/**
30628 * Open database persistently
30629 *
30630 * {@link dba_popen} establishes a persistent database instance for
30631 * {@link path} with {@link mode} using {@link handler}.
30632 *
30633 * @param string $path Commonly a regular path in your filesystem.
30634 * @param string $mode It is r for read access, w for read/write access
30635 *   to an already existing database, c for read/write access and
30636 *   database creation if it doesn't currently exist, and n for create,
30637 *   truncate and read/write access.
30638 * @param string $handler The name of the handler which shall be used
30639 *   for accessing {@link path}. It is passed all optional parameters
30640 *   given to {@link dba_popen} and can act on behalf of them.
30641 * @param mixed ...$vararg
30642 * @return resource Returns a positive handle on success.
30643 * @since PHP 4, PHP 5, PHP 7
30644 **/
30645function dba_popen($path, $mode, $handler, ...$vararg){}
30646
30647/**
30648 * Replace or insert entry
30649 *
30650 * {@link dba_replace} replaces or inserts the entry described with
30651 * {@link key} and {@link value} into the database specified by {@link
30652 * handle}.
30653 *
30654 * @param string $key The key of the entry to be replaced.
30655 * @param string $value The value to be replaced.
30656 * @param resource $handle The database handler, returned by {@link
30657 *   dba_open} or {@link dba_popen}.
30658 * @return bool
30659 * @since PHP 4, PHP 5, PHP 7
30660 **/
30661function dba_replace($key, $value, $handle){}
30662
30663/**
30664 * Synchronize database
30665 *
30666 * {@link dba_sync} synchronizes the database. This will probably trigger
30667 * a physical write to the disk, if supported.
30668 *
30669 * @param resource $handle The database handler, returned by {@link
30670 *   dba_open} or {@link dba_popen}.
30671 * @return bool
30672 * @since PHP 4, PHP 5, PHP 7
30673 **/
30674function dba_sync($handle){}
30675
30676/**
30677 * Add a tuple to a relation
30678 *
30679 * Adds a tuple to a {@link relation}.
30680 *
30681 * @param resource $relation
30682 * @param array $tuple An array of attribute/value pairs to be inserted
30683 *   into the given {@link relation}. After successful execution this
30684 *   array will contain the complete data of the newly created tuple,
30685 *   including all implicitly set domain fields like sequences.
30686 * @return int The function will return DBPLUS_ERR_NOERR on success or
30687 *   a db++ error code on failure.
30688 * @since PHP 4 = 0.9
30689 **/
30690function dbplus_add($relation, $tuple){}
30691
30692/**
30693 * Perform AQL query
30694 *
30695 * Executes an AQL {@link query} on the given {@link server} and {@link
30696 * dbpath}.
30697 *
30698 * @param string $query The AQL query to be executed. Further
30699 *   information on the AQL (Algebraic Query Language) is provided in the
30700 *   original db++ manual.
30701 * @param string $server
30702 * @param string $dbpath
30703 * @return resource Returns a relation handle on success. The result
30704 *   data may be fetched from this relation by calling {@link
30705 *   dbplus_next} and {@link dbplus_curr}. Other relation access
30706 *   functions will not work on a result relation.
30707 * @since PHP 4 = 0.9
30708 **/
30709function dbplus_aql($query, $server, $dbpath){}
30710
30711/**
30712 * Get/Set database virtual current directory
30713 *
30714 * Changes the virtual current directory where relation files will be
30715 * looked for by {@link dbplus_open}.
30716 *
30717 * @param string $newdir The new directory for relation files. You can
30718 *   omit this parameter to query the current working directory.
30719 * @return string Returns the absolute path of the current directory.
30720 * @since PHP 4 = 0.9
30721 **/
30722function dbplus_chdir($newdir){}
30723
30724/**
30725 * Close a relation
30726 *
30727 * Closes a relation previously opened by {@link dbplus_open}.
30728 *
30729 * @param resource $relation A relation opened by {@link dbplus_open}.
30730 * @return mixed Returns TRUE on success or DBPLUS_ERR_UNKNOWN on
30731 *   failure.
30732 * @since PHP 4 = 0.9
30733 **/
30734function dbplus_close($relation){}
30735
30736/**
30737 * Get current tuple from relation
30738 *
30739 * Reads the data for the current tuple for the given {@link relation}.
30740 *
30741 * @param resource $relation A relation opened by {@link dbplus_open}.
30742 * @param array $tuple The data will be passed back in this parameter,
30743 *   as an associative array.
30744 * @return int The function will return zero (aka. DBPLUS_ERR_NOERR) on
30745 *   success or a db++ error code on failure.
30746 * @since PHP 4 = 0.9
30747 **/
30748function dbplus_curr($relation, &$tuple){}
30749
30750/**
30751 * Get error string for given errorcode or last error
30752 *
30753 * Returns a clear error string for the given error code.
30754 *
30755 * @param int $errno The error code. If not provided, the result code
30756 *   of the last db++ operation is assumed.
30757 * @return string Returns the error message.
30758 * @since PHP 4 = 0.9
30759 **/
30760function dbplus_errcode($errno){}
30761
30762/**
30763 * Get error code for last operation
30764 *
30765 * Returns the error code returned by the last db++ operation.
30766 *
30767 * @return int Returns the error code, as an integer.
30768 * @since PHP 4 = 0.9
30769 **/
30770function dbplus_errno(){}
30771
30772/**
30773 * Set a constraint on a relation
30774 *
30775 * Places a constraint on the given {@link relation}.
30776 *
30777 * Further calls to functions like {@link dbplus_curr} or {@link
30778 * dbplus_next} will only return tuples matching the given constraints.
30779 *
30780 * @param resource $relation A relation opened by {@link dbplus_open}.
30781 * @param array $constraints Constraints are triplets of strings
30782 *   containing of a domain name, a comparison operator and a comparison
30783 *   value. The {@link constraints} parameter array may consist of a
30784 *   collection of string arrays, each of which contains a domain, an
30785 *   operator and a value, or of a single string array containing a
30786 *   multiple of three elements. The comparison operator may be one of
30787 *   the following strings: '==', '>', '>=', '<', '<=', '!=', '~' for a
30788 *   regular expression match and 'BAND' or 'BOR' for bitwise operations.
30789 * @param mixed $tuple
30790 * @return int
30791 * @since PHP 4 = 0.9
30792 **/
30793function dbplus_find($relation, $constraints, $tuple){}
30794
30795/**
30796 * Get first tuple from relation
30797 *
30798 * Reads the data for the first tuple for the given {@link relation},
30799 * makes it the current tuple and pass it back as an associative array in
30800 * {@link tuple}.
30801 *
30802 * @param resource $relation A relation opened by {@link dbplus_open}.
30803 * @param array $tuple
30804 * @return int Returns DBPLUS_ERR_NOERR on success or a db++ error code
30805 *   on failure.
30806 * @since PHP 4 = 0.9
30807 **/
30808function dbplus_first($relation, &$tuple){}
30809
30810/**
30811 * Flush all changes made on a relation
30812 *
30813 * Writes all changes applied to {@link relation} since the last flush to
30814 * disk.
30815 *
30816 * @param resource $relation A relation opened by {@link dbplus_open}.
30817 * @return int Returns DBPLUS_ERR_NOERR on success or a db++ error code
30818 *   on failure.
30819 * @since PHP 4 = 0.9
30820 **/
30821function dbplus_flush($relation){}
30822
30823/**
30824 * Free all locks held by this client
30825 *
30826 * Frees all tuple locks held by this client.
30827 *
30828 * @return int
30829 * @since PHP 4 = 0.9
30830 **/
30831function dbplus_freealllocks(){}
30832
30833/**
30834 * Release write lock on tuple
30835 *
30836 * Releases a write lock on the given {@link tuple} previously obtained
30837 * by {@link dbplus_getlock}.
30838 *
30839 * @param resource $relation A relation opened by {@link dbplus_open}.
30840 * @param string $tuple
30841 * @return int
30842 * @since PHP 4 = 0.9
30843 **/
30844function dbplus_freelock($relation, $tuple){}
30845
30846/**
30847 * Free all tuple locks on given relation
30848 *
30849 * Frees all tuple locks held on the given {@link relation}.
30850 *
30851 * @param resource $relation A relation opened by {@link dbplus_open}.
30852 * @return int
30853 * @since PHP 4 = 0.9
30854 **/
30855function dbplus_freerlocks($relation){}
30856
30857/**
30858 * Get a write lock on a tuple
30859 *
30860 * Requests a write lock on the specified {@link tuple}.
30861 *
30862 * @param resource $relation A relation opened by {@link dbplus_open}.
30863 * @param string $tuple
30864 * @return int Returns zero on success or a non-zero error code,
30865 *   especially DBPLUS_ERR_WLOCKED on failure.
30866 * @since PHP 4 = 0.9
30867 **/
30868function dbplus_getlock($relation, $tuple){}
30869
30870/**
30871 * Get an id number unique to a relation
30872 *
30873 * Obtains a number guaranteed to be unique for the given {@link
30874 * relation} and will pass it back in the variable given as {@link
30875 * uniqueid}.
30876 *
30877 * @param resource $relation A relation opened by {@link dbplus_open}.
30878 * @param int $uniqueid
30879 * @return int Returns DBPLUS_ERR_NOERR on success or a db++ error code
30880 *   on failure.
30881 * @since PHP 4 = 0.9
30882 **/
30883function dbplus_getunique($relation, $uniqueid){}
30884
30885/**
30886 * Get information about a relation
30887 *
30888 * @param resource $relation A relation opened by {@link dbplus_open}.
30889 * @param string $key
30890 * @param array $result
30891 * @return int
30892 * @since PHP 4 = 0.9
30893 **/
30894function dbplus_info($relation, $key, &$result){}
30895
30896/**
30897 * Get last tuple from relation
30898 *
30899 * Reads the data for the last tuple for the given {@link relation},
30900 * makes it the current tuple and pass it back as an associative array in
30901 * {@link tuple}.
30902 *
30903 * @param resource $relation A relation opened by {@link dbplus_open}.
30904 * @param array $tuple
30905 * @return int Returns DBPLUS_ERR_NOERR on success or a db++ error code
30906 *   on failure.
30907 * @since PHP 4 = 0.9
30908 **/
30909function dbplus_last($relation, &$tuple){}
30910
30911/**
30912 * Request write lock on relation
30913 *
30914 * Requests a write lock on the given {@link relation}.
30915 *
30916 * Other clients may still query the relation, but can't alter it while
30917 * it is locked.
30918 *
30919 * @param resource $relation A relation opened by {@link dbplus_open}.
30920 * @return int
30921 * @since PHP 4 = 0.9
30922 **/
30923function dbplus_lockrel($relation){}
30924
30925/**
30926 * Get next tuple from relation
30927 *
30928 * Reads the data for the next tuple for the given {@link relation},
30929 * makes it the current tuple and will pass it back as an associative
30930 * array in {@link tuple}.
30931 *
30932 * @param resource $relation A relation opened by {@link dbplus_open}.
30933 * @param array $tuple
30934 * @return int Returns DBPLUS_ERR_NOERR on success or a db++ error code
30935 *   on failure.
30936 * @since PHP 4 = 0.9
30937 **/
30938function dbplus_next($relation, &$tuple){}
30939
30940/**
30941 * Open relation file
30942 *
30943 * Opens the given relation file.
30944 *
30945 * @param string $name Can be either a file name or a relative or
30946 *   absolute path name. This will be mapped in any case to an absolute
30947 *   relation file path on a specific host machine and server.
30948 * @return resource On success a relation file resource (cursor) is
30949 *   returned which must be used in any subsequent commands referencing
30950 *   the relation. Failure leads to a zero return value, the actual error
30951 *   code may be asked for by calling {@link dbplus_errno}.
30952 * @since PHP 4 = 0.9
30953 **/
30954function dbplus_open($name){}
30955
30956/**
30957 * Get previous tuple from relation
30958 *
30959 * Reads the data for the previous tuple for the given {@link relation},
30960 * makes it the current tuple and will pass it back as an associative
30961 * array in {@link tuple}.
30962 *
30963 * @param resource $relation A relation opened by {@link dbplus_open}.
30964 * @param array $tuple
30965 * @return int Returns DBPLUS_ERR_NOERR on success or a db++ error code
30966 *   on failure.
30967 * @since PHP 4 = 0.9
30968 **/
30969function dbplus_prev($relation, &$tuple){}
30970
30971/**
30972 * Change relation permissions
30973 *
30974 * Changes access permissions as specified by {@link mask}, {@link user}
30975 * and {@link group}. The values for these are operating system specific.
30976 *
30977 * @param resource $relation A relation opened by {@link dbplus_open}.
30978 * @param int $mask
30979 * @param string $user
30980 * @param string $group
30981 * @return int
30982 * @since PHP 4 = 0.9
30983 **/
30984function dbplus_rchperm($relation, $mask, $user, $group){}
30985
30986/**
30987 * Creates a new DB++ relation
30988 *
30989 * Creates a new relation. Any existing relation sharing the same {@link
30990 * name} will be overwritten if the relation is currently not in use and
30991 * {@link overwrite} is set to TRUE.
30992 *
30993 * @param string $name
30994 * @param mixed $domlist A combination of domains. May be passed as a
30995 *   single domain name string or as an array of domain names. This
30996 *   parameter should contain the domain specification for the new
30997 *   relation within an array of domain description strings. A domain
30998 *   description string consists of a domain name unique to this
30999 *   relation, a slash and a type specification character. See the db++
31000 *   documentation, especially the dbcreate(1) manpage, for a description
31001 *   of available type specifiers and their meanings.
31002 * @param bool $overwrite
31003 * @return resource
31004 * @since PHP 4 = 0.9
31005 **/
31006function dbplus_rcreate($name, $domlist, $overwrite){}
31007
31008/**
31009 * Creates an exact but empty copy of a relation including indices
31010 *
31011 * {@link dbplus_rcrtexact} will create an exact but empty copy of the
31012 * given {@link relation} under a new {@link name}.
31013 *
31014 * @param string $name
31015 * @param resource $relation The copied relation, opened by {@link
31016 *   dbplus_open}.
31017 * @param bool $overwrite An existing relation by the same {@link name}
31018 *   will only be overwritten if this parameter is set to TRUE and no
31019 *   other process is currently using the relation.
31020 * @return mixed Returns resource on success or DBPLUS_ERR_UNKNOWN on
31021 *   failure.
31022 * @since PHP 4 = 0.9
31023 **/
31024function dbplus_rcrtexact($name, $relation, $overwrite){}
31025
31026/**
31027 * Creates an empty copy of a relation with default indices
31028 *
31029 * {@link dbplus_rcrtexact} will create an empty copy of the given {@link
31030 * relation} under a new {@link name}, but with default indices.
31031 *
31032 * @param string $name
31033 * @param resource $relation The copied relation, opened by {@link
31034 *   dbplus_open}.
31035 * @param int $overwrite An existing relation by the same {@link name}
31036 *   will only be overwritten if this parameter is set to TRUE and no
31037 *   other process is currently using the relation.
31038 * @return mixed Returns resource on success or DBPLUS_ERR_UNKNOWN on
31039 *   failure.
31040 * @since PHP 4 = 0.9
31041 **/
31042function dbplus_rcrtlike($name, $relation, $overwrite){}
31043
31044/**
31045 * Resolve host information for relation
31046 *
31047 * {@link dbplus_resolve} will try to resolve the given {@link
31048 * relation_name} and find out internal server id, real hostname and the
31049 * database path on this host.
31050 *
31051 * @param string $relation_name The relation name.
31052 * @return array Returns an array containing these values under the
31053 *   keys sid, host and host_path or FALSE on error.
31054 * @since PHP 4 = 0.9
31055 **/
31056function dbplus_resolve($relation_name){}
31057
31058/**
31059 * Restore position
31060 *
31061 * @param resource $relation A relation opened by {@link dbplus_open}.
31062 * @param array $tuple
31063 * @return int
31064 * @since PHP 4 = 0.9
31065 **/
31066function dbplus_restorepos($relation, $tuple){}
31067
31068/**
31069 * Specify new primary key for a relation
31070 *
31071 * {@link dbplus_rkeys} will replace the current primary key for {@link
31072 * relation} with the combination of domains specified by {@link
31073 * domlist}.
31074 *
31075 * @param resource $relation A relation opened by {@link dbplus_open}.
31076 * @param mixed $domlist A combination of domains. May be passed as a
31077 *   single domain name string or as an array of domain names.
31078 * @return mixed Returns resource on success or DBPLUS_ERR_UNKNOWN on
31079 *   failure.
31080 * @since PHP 4 = 0.9
31081 **/
31082function dbplus_rkeys($relation, $domlist){}
31083
31084/**
31085 * Open relation file local
31086 *
31087 * {@link dbplus_ropen} will open the relation {@link file} locally for
31088 * quick access without any client/server overhead. Access is read only
31089 * and only {@link dbplus_curr} and {@link dbplus_next} may be applied to
31090 * the returned relation.
31091 *
31092 * @param string $name
31093 * @return resource
31094 * @since PHP 4 = 0.9
31095 **/
31096function dbplus_ropen($name){}
31097
31098/**
31099 * Perform local (raw) AQL query
31100 *
31101 * {@link dbplus_rquery} performs a local (raw) AQL query using an AQL
31102 * interpreter embedded into the db++ client library. {@link
31103 * dbplus_rquery} is faster than {@link dbplus_aql} but will work on
31104 * local data only.
31105 *
31106 * @param string $query
31107 * @param string $dbpath
31108 * @return resource
31109 * @since PHP 4 = 0.9
31110 **/
31111function dbplus_rquery($query, $dbpath){}
31112
31113/**
31114 * Rename a relation
31115 *
31116 * {@link dbplus_rrename} will change the name of {@link relation} to
31117 * {@link name}.
31118 *
31119 * @param resource $relation A relation opened by {@link dbplus_open}.
31120 * @param string $name
31121 * @return int
31122 * @since PHP 4 = 0.9
31123 **/
31124function dbplus_rrename($relation, $name){}
31125
31126/**
31127 * Create a new secondary index for a relation
31128 *
31129 * {@link dbplus_rsecindex} will create a new secondary index for {@link
31130 * relation} with consists of the domains specified by {@link domlist}
31131 * and is of type {@link type}
31132 *
31133 * @param resource $relation A relation opened by {@link dbplus_open}.
31134 * @param mixed $domlist A combination of domains. May be passed as a
31135 *   single domain name string or as an array of domain names.
31136 * @param int $type
31137 * @return mixed Returns resource on success or DBPLUS_ERR_UNKNOWN on
31138 *   failure.
31139 * @since PHP 4 = 0.9
31140 **/
31141function dbplus_rsecindex($relation, $domlist, $type){}
31142
31143/**
31144 * Remove relation from filesystem
31145 *
31146 * {@link dbplus_runlink} will close and remove the {@link relation}.
31147 *
31148 * @param resource $relation A relation opened by {@link dbplus_open}.
31149 * @return int
31150 * @since PHP 4 = 0.9
31151 **/
31152function dbplus_runlink($relation){}
31153
31154/**
31155 * Remove all tuples from relation
31156 *
31157 * {@link dbplus_rzap} will remove all tuples from {@link relation}.
31158 *
31159 * @param resource $relation A relation opened by {@link dbplus_open}.
31160 * @return int
31161 * @since PHP 4 = 0.9
31162 **/
31163function dbplus_rzap($relation){}
31164
31165/**
31166 * Save position
31167 *
31168 * @param resource $relation A relation opened by {@link dbplus_open}.
31169 * @return int
31170 * @since PHP 4 = 0.9
31171 **/
31172function dbplus_savepos($relation){}
31173
31174/**
31175 * Set index
31176 *
31177 * @param resource $relation A relation opened by {@link dbplus_open}.
31178 * @param string $idx_name
31179 * @return int
31180 * @since PHP 4 = 0.9
31181 **/
31182function dbplus_setindex($relation, $idx_name){}
31183
31184/**
31185 * Set index by number
31186 *
31187 * @param resource $relation A relation opened by {@link dbplus_open}.
31188 * @param int $idx_number
31189 * @return int
31190 * @since PHP 4 = 0.9
31191 **/
31192function dbplus_setindexbynumber($relation, $idx_number){}
31193
31194/**
31195 * Perform SQL query
31196 *
31197 * @param string $query
31198 * @param string $server
31199 * @param string $dbpath
31200 * @return resource
31201 * @since PHP 4 = 0.9
31202 **/
31203function dbplus_sql($query, $server, $dbpath){}
31204
31205/**
31206 * Execute TCL code on server side
31207 *
31208 * A db++ server will prepare a TCL interpreter for each client
31209 * connection. This interpreter will enable the server to execute TCL
31210 * code provided by the client as a sort of stored procedures to improve
31211 * the performance of database operations by avoiding client/server data
31212 * transfers and context switches.
31213 *
31214 * {@link dbplus_tcl} needs to pass the client connection id the TCL
31215 * {@link script} code should be executed by. {@link dbplus_resolve} will
31216 * provide this connection id. The function will return whatever the TCL
31217 * code returns or a TCL error message if the TCL code fails.
31218 *
31219 * @param int $sid
31220 * @param string $script
31221 * @return string
31222 * @since PHP 4 = 0.9
31223 **/
31224function dbplus_tcl($sid, $script){}
31225
31226/**
31227 * Remove tuple and return new current tuple
31228 *
31229 * {@link dbplus_tremove} removes {@link tuple} from {@link relation} if
31230 * it perfectly matches a tuple within the relation. {@link current}, if
31231 * given, will contain the data of the new current tuple after calling
31232 * {@link dbplus_tremove}.
31233 *
31234 * @param resource $relation A relation opened by {@link dbplus_open}.
31235 * @param array $tuple
31236 * @param array $current
31237 * @return int
31238 * @since PHP 4 = 0.9
31239 **/
31240function dbplus_tremove($relation, $tuple, &$current){}
31241
31242/**
31243 * Undo
31244 *
31245 * @param resource $relation A relation opened by {@link dbplus_open}.
31246 * @return int
31247 * @since PHP 4 = 0.9
31248 **/
31249function dbplus_undo($relation){}
31250
31251/**
31252 * Prepare undo
31253 *
31254 * @param resource $relation A relation opened by {@link dbplus_open}.
31255 * @return int
31256 * @since PHP 4 = 0.9
31257 **/
31258function dbplus_undoprepare($relation){}
31259
31260/**
31261 * Give up write lock on relation
31262 *
31263 * Release a write lock previously obtained by {@link dbplus_lockrel}.
31264 *
31265 * @param resource $relation A relation opened by {@link dbplus_open}.
31266 * @return int
31267 * @since PHP 4 = 0.9
31268 **/
31269function dbplus_unlockrel($relation){}
31270
31271/**
31272 * Remove a constraint from relation
31273 *
31274 * Calling {@link dbplus_unselect} will remove a constraint previously
31275 * set by {@link dbplus_find} on {@link relation}.
31276 *
31277 * @param resource $relation A relation opened by {@link dbplus_open}.
31278 * @return int
31279 * @since PHP 4 = 0.9
31280 **/
31281function dbplus_unselect($relation){}
31282
31283/**
31284 * Update specified tuple in relation
31285 *
31286 * {@link dbplus_update} replaces the {@link old} tuple with the data
31287 * from the {@link new} one, only if the {@link old} completely matches a
31288 * tuple within {@link relation}.
31289 *
31290 * @param resource $relation A relation opened by {@link dbplus_open}.
31291 * @param array $old The old tuple.
31292 * @param array $new The new tuple.
31293 * @return int
31294 * @since PHP 4 = 0.9
31295 **/
31296function dbplus_update($relation, $old, $new){}
31297
31298/**
31299 * Request exclusive lock on relation
31300 *
31301 * Request an exclusive lock on {@link relation} preventing even read
31302 * access from other clients.
31303 *
31304 * @param resource $relation A relation opened by {@link dbplus_open}.
31305 * @return int
31306 * @since PHP 4 = 0.9
31307 **/
31308function dbplus_xlockrel($relation){}
31309
31310/**
31311 * Free exclusive lock on relation
31312 *
31313 * Releases an exclusive lock previously obtained by {@link
31314 * dbplus_xlockrel}.
31315 *
31316 * @param resource $relation A relation opened by {@link dbplus_open}.
31317 * @return int
31318 * @since PHP 4 = 0.9
31319 **/
31320function dbplus_xunlockrel($relation){}
31321
31322/**
31323 * Close an open connection/database
31324 *
31325 * @param object $link_identifier The DBX link object to close.
31326 * @return int Returns 1 on success and 0 on errors.
31327 * @since PHP 4 >= 4.0.6, PHP 5 < 5.1.0, PECL dbx >= 1.1.0
31328 **/
31329function dbx_close($link_identifier){}
31330
31331/**
31332 * Compare two rows for sorting purposes
31333 *
31334 * {@link dbx_compare} is a helper function for {@link dbx_sort} to ease
31335 * the make and use of the custom sorting function.
31336 *
31337 * @param array $row_a First row
31338 * @param array $row_b Second row
31339 * @param string $column_key The compared column
31340 * @param int $flags The {@link flags} can be set to specify comparison
31341 *   direction: DBX_CMP_ASC - ascending order DBX_CMP_DESC - descending
31342 *   order and the preferred comparison type: DBX_CMP_NATIVE - no type
31343 *   conversion DBX_CMP_TEXT - compare items as strings DBX_CMP_NUMBER -
31344 *   compare items numerically One of the direction and one of the type
31345 *   constant can be combined with bitwise OR operator (|).
31346 * @return int Returns 0 if the row_a[$column_key] is equal to
31347 *   row_b[$column_key], and 1 or -1 if the former is greater or is
31348 *   smaller than the latter one, respectively, or vice versa if the
31349 *   {@link flag} is set to DBX_CMP_DESC.
31350 * @since PHP 4 >= 4.1.0, PHP 5 < 5.1.0, PECL dbx >= 1.1.0
31351 **/
31352function dbx_compare($row_a, $row_b, $column_key, $flags){}
31353
31354/**
31355 * Open a connection/database
31356 *
31357 * Opens a connection to a database.
31358 *
31359 * @param mixed $module The {@link module} parameter can be either a
31360 *   string or a constant, though the latter form is preferred. The
31361 *   possible values are given below, but keep in mind that they only
31362 *   work if the module is actually loaded.
31363 *
31364 *   DBX_MYSQL or "mysql" DBX_ODBC or "odbc" DBX_PGSQL or "pgsql"
31365 *   DBX_MSSQL or "mssql" DBX_FBSQL or "fbsql" DBX_SYBASECT or
31366 *   "sybase_ct" DBX_OCI8 or "oci8" DBX_SQLITE or "sqlite"
31367 * @param string $host The SQL server host
31368 * @param string $database The database name
31369 * @param string $username The username
31370 * @param string $password The password
31371 * @param int $persistent The {@link persistent} parameter can be set
31372 *   to DBX_PERSISTENT, if so, a persistent connection will be created.
31373 * @return object Returns an object on success, FALSE on error. If a
31374 *   connection has been made but the database could not be selected, the
31375 *   connection is closed and FALSE is returned.
31376 * @since PHP 4 >= 4.0.6, PHP 5 < 5.1.0, PECL dbx >= 1.1.0
31377 **/
31378function dbx_connect($module, $host, $database, $username, $password, $persistent){}
31379
31380/**
31381 * Report the error message of the latest function call in the module
31382 *
31383 * {@link dbx_error} returns the last error message.
31384 *
31385 * @param object $link_identifier The DBX link object returned by
31386 *   {@link dbx_connect}
31387 * @return string Returns a string containing the error message from
31388 *   the last function call of the abstracted module (e.g. mysql module).
31389 *   If there are multiple connections in the same module, just the last
31390 *   error is given. If there are connections on different modules, the
31391 *   latest error is returned for the module specified by the {@link
31392 *   link_identifier} parameter.
31393 * @since PHP 4 >= 4.0.6, PHP 5 < 5.1.0, PECL dbx >= 1.1.0
31394 **/
31395function dbx_error($link_identifier){}
31396
31397/**
31398 * Escape a string so it can safely be used in an sql-statement
31399 *
31400 * Escape the given string so that it can safely be used in an
31401 * sql-statement.
31402 *
31403 * @param object $link_identifier The DBX link object returned by
31404 *   {@link dbx_connect}
31405 * @param string $text The string to escape.
31406 * @return string Returns the text, escaped where necessary (such as
31407 *   quotes, backslashes etc). On error, NULL is returned.
31408 * @since PHP 4 >= 4.3.0, PHP 5 < 5.1.0, PECL dbx >= 1.1.0
31409 **/
31410function dbx_escape_string($link_identifier, $text){}
31411
31412/**
31413 * Fetches rows from a query-result that had the flag set
31414 *
31415 * {@link dbx_fetch_row} fetches rows from a result identifier that had
31416 * the DBX_RESULT_UNBUFFERED flag set.
31417 *
31418 * When the DBX_RESULT_UNBUFFERED is not set in the query, {@link
31419 * dbx_fetch_row} will fail as all rows have already been fetched into
31420 * the results data property.
31421 *
31422 * As a side effect, the rows property of the query-result object is
31423 * incremented for each successful call to {@link dbx_fetch_row}.
31424 *
31425 * @param object $result_identifier A result set returned by {@link
31426 *   dbx_query}.
31427 * @return mixed Returns an object on success that contains the same
31428 *   information as any row would have in the {@link dbx_query} result
31429 *   data property, including columns accessible by index or fieldname
31430 *   when the flags for {@link dbx_query} were set that way.
31431 * @since PHP 5 < 5.1.0, PECL dbx >= 1.1.0
31432 **/
31433function dbx_fetch_row($result_identifier){}
31434
31435/**
31436 * Send a query and fetch all results (if any)
31437 *
31438 * Sends a query and fetch all results.
31439 *
31440 * @param object $link_identifier The DBX link object returned by
31441 *   {@link dbx_connect}
31442 * @param string $sql_statement SQL statement. Data inside the query
31443 *   should be properly escaped.
31444 * @param int $flags The {@link flags} parameter is used to control the
31445 *   amount of information that is returned. It may be any combination of
31446 *   the following constants with the bitwise OR operator (|). The
31447 *   DBX_COLNAMES_* flags override the dbx.colnames_case setting from .
31448 *   DBX_RESULT_INDEX It is always set, that is, the returned object has
31449 *   a data property which is a 2 dimensional array indexed numerically.
31450 *   For example, in the expression data[2][3] 2 stands for the row (or
31451 *   record) number and 3 stands for the column (or field) number. The
31452 *   first row and column are indexed at 0. If DBX_RESULT_ASSOC is also
31453 *   specified, the returning object contains the information related to
31454 *   DBX_RESULT_INFO too, even if it was not specified. DBX_RESULT_INFO
31455 *   It provides info about columns, such as field names and field types.
31456 *   DBX_RESULT_ASSOC It effects that the field values can be accessed
31457 *   with the respective column names used as keys to the returned
31458 *   object's data property. Associated results are actually references
31459 *   to the numerically indexed data, so modifying data[0][0] causes that
31460 *   data[0]['field_name_for_first_column'] is modified as well.
31461 *   DBX_RESULT_UNBUFFERED This flag will not create the data property,
31462 *   and the rows property will initially be 0. Use this flag for large
31463 *   datasets, and use {@link dbx_fetch_row} to retrieve the results row
31464 *   by row. The {@link dbx_fetch_row} function will return rows that are
31465 *   conformant to the flags set with this query. Incidentally, it will
31466 *   also update the rows each time it is called. DBX_COLNAMES_UNCHANGED
31467 *   The case of the returned column names will not be changed.
31468 *   DBX_COLNAMES_UPPERCASE The case of the returned column names will be
31469 *   changed to uppercase. DBX_COLNAMES_LOWERCASE The case of the
31470 *   returned column names will be changed to lowercase. Note that
31471 *   DBX_RESULT_INDEX is always used, regardless of the actual value of
31472 *   {@link flags} parameter. This means that only the following
31473 *   combinations are effective: DBX_RESULT_INDEX DBX_RESULT_INDEX |
31474 *   DBX_RESULT_INFO DBX_RESULT_INDEX | DBX_RESULT_INFO |
31475 *   DBX_RESULT_ASSOC - this is the default, if {@link flags} is not
31476 *   specified.
31477 * @return mixed {@link dbx_query} returns an object or 1 on success,
31478 *   and 0 on failure. The result object is returned only if the query
31479 *   given in {@link sql_statement} produces a result set (i.e. a SELECT
31480 *   query, even if the result set is empty).
31481 * @since PHP 4 >= 4.0.6, PHP 5 < 5.1.0, PECL dbx >= 1.1.0
31482 **/
31483function dbx_query($link_identifier, $sql_statement, $flags){}
31484
31485/**
31486 * Sort a result from a dbx_query by a custom sort function
31487 *
31488 * Sort a result from a {@link dbx_query} call with a custom sort
31489 * function.
31490 *
31491 * @param object $result A result set returned by {@link dbx_query}.
31492 * @param string $user_compare_function The user-defined comparison
31493 *   function. It must accept two arguments and return an integer less
31494 *   than, equal to, or greater than zero if the first argument is
31495 *   considered to be respectively less than, equal to, or greater than
31496 *   the second.
31497 * @return bool
31498 * @since PHP 4 >= 4.0.6, PHP 5 < 5.1.0, PECL dbx >= 1.1.0
31499 **/
31500function dbx_sort($result, $user_compare_function){}
31501
31502/**
31503 * Overrides the domain for a single lookup
31504 *
31505 * This function allows you to override the current domain for a single
31506 * message lookup.
31507 *
31508 * @param string $domain The domain
31509 * @param string $message The message
31510 * @param int $category The category
31511 * @return string A string on success.
31512 * @since PHP 4, PHP 5, PHP 7
31513 **/
31514function dcgettext($domain, $message, $category){}
31515
31516/**
31517 * Plural version of dcgettext
31518 *
31519 * This function allows you to override the current domain for a single
31520 * plural message lookup.
31521 *
31522 * @param string $domain The domain
31523 * @param string $msgid1
31524 * @param string $msgid2
31525 * @param int $n
31526 * @param int $category
31527 * @return string A string on success.
31528 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
31529 **/
31530function dcngettext($domain, $msgid1, $msgid2, $n, $category){}
31531
31532/**
31533 * Generates a backtrace
31534 *
31535 * {@link debug_backtrace} generates a PHP backtrace.
31536 *
31537 * @param int $options As of 5.3.6, this parameter is a bitmask for the
31538 *   following options: {@link debug_backtrace} options
31539 *   DEBUG_BACKTRACE_PROVIDE_OBJECT Whether or not to populate the
31540 *   "object" index. DEBUG_BACKTRACE_IGNORE_ARGS Whether or not to omit
31541 *   the "args" index, and thus all the function/method arguments, to
31542 *   save memory. Before 5.3.6, the only values recognized are TRUE or
31543 *   FALSE, which are the same as setting or not setting the
31544 *   DEBUG_BACKTRACE_PROVIDE_OBJECT option respectively.
31545 * @param int $limit As of 5.4.0, this parameter can be used to limit
31546 *   the number of stack frames returned. By default ({@link limit}=0) it
31547 *   returns all stack frames.
31548 * @return array Returns an array of associative arrays. The possible
31549 *   returned elements are as follows:
31550 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
31551 **/
31552function debug_backtrace($options, $limit){}
31553
31554/**
31555 * Prints a backtrace
31556 *
31557 * {@link debug_print_backtrace} prints a PHP backtrace. It prints the
31558 * function calls, included/required files and {@link eval}ed stuff.
31559 *
31560 * @param int $options As of 5.3.6, this parameter is a bitmask for the
31561 *   following options: {@link debug_print_backtrace} options
31562 *   DEBUG_BACKTRACE_IGNORE_ARGS Whether or not to omit the "args" index,
31563 *   and thus all the function/method arguments, to save memory.
31564 * @param int $limit As of 5.4.0, this parameter can be used to limit
31565 *   the number of stack frames printed. By default ({@link limit}=0) it
31566 *   prints all stack frames.
31567 * @return void
31568 * @since PHP 5, PHP 7
31569 **/
31570function debug_print_backtrace($options, $limit){}
31571
31572/**
31573 * Dumps a string representation of an internal zend value to output
31574 *
31575 * @param mixed $variable The variable being evaluated.
31576 * @param mixed ...$vararg
31577 * @return void
31578 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
31579 **/
31580function debug_zval_dump($variable, ...$vararg){}
31581
31582/**
31583 * Decimal to binary
31584 *
31585 * Returns a string containing a binary representation of the given
31586 * {@link number} argument.
31587 *
31588 * @param int $number Decimal value to convert
31589 * @return string Binary string representation of {@link number}
31590 * @since PHP 4, PHP 5, PHP 7
31591 **/
31592function decbin($number){}
31593
31594/**
31595 * Decimal to hexadecimal
31596 *
31597 * Returns a string containing a hexadecimal representation of the given
31598 * unsigned {@link number} argument.
31599 *
31600 * The largest number that can be converted is PHP_INT_MAX * 2 + 1 (or
31601 * -1): on 32-bit platforms, this will be 4294967295 in decimal, which
31602 * results in {@link dechex} returning ffffffff.
31603 *
31604 * @param int $number The decimal value to convert. As PHP's integer
31605 *   type is signed, but {@link dechex} deals with unsigned integers,
31606 *   negative integers will be treated as though they were unsigned.
31607 * @return string Hexadecimal string representation of {@link number}.
31608 * @since PHP 4, PHP 5, PHP 7
31609 **/
31610function dechex($number){}
31611
31612/**
31613 * Decimal to octal
31614 *
31615 * Returns a string containing an octal representation of the given
31616 * {@link number} argument. The largest number that can be converted
31617 * depends on the platform in use. For 32-bit platforms this is usually
31618 * 4294967295 in decimal resulting in 37777777777. For 64-bit platforms
31619 * this is usually 9223372036854775807 in decimal resulting in
31620 * 777777777777777777777.
31621 *
31622 * @param int $number Decimal value to convert
31623 * @return string Octal string representation of {@link number}
31624 * @since PHP 4, PHP 5, PHP 7
31625 **/
31626function decoct($number){}
31627
31628/**
31629 * Defines a named constant
31630 *
31631 * Defines a named constant at runtime.
31632 *
31633 * @param string $name The name of the constant.
31634 * @param mixed $value The value of the constant. In PHP 5, {@link
31635 *   value} must be a scalar value (integer, float, string, boolean, or
31636 *   NULL). In PHP 7, array values are also accepted.
31637 * @param bool $case_insensitive If set to TRUE, the constant will be
31638 *   defined case-insensitive. The default behavior is case-sensitive;
31639 *   i.e. CONSTANT and Constant represent different values.
31640 * @return bool
31641 * @since PHP 4, PHP 5, PHP 7
31642 **/
31643function define($name, $value, $case_insensitive){}
31644
31645/**
31646 * Checks whether a given named constant exists
31647 *
31648 * Checks whether the given constant exists and is defined.
31649 *
31650 * @param string $name The constant name.
31651 * @return bool Returns TRUE if the named constant given by {@link
31652 *   name} has been defined, FALSE otherwise.
31653 * @since PHP 4, PHP 5, PHP 7
31654 **/
31655function defined($name){}
31656
31657/**
31658 * Initializes all syslog related variables
31659 *
31660 * Initializes all variables used in the syslog functions.
31661 *
31662 * @return void
31663 * @since PHP 4, PHP 5 < 5.4.0
31664 **/
31665function define_syslog_variables(){}
31666
31667/**
31668 * Incrementally deflate data
31669 *
31670 * Incrementally deflates data in the specified context.
31671 *
31672 * @param resource $context A context created with {@link
31673 *   deflate_init}.
31674 * @param string $data A chunk of data to compress.
31675 * @param int $flush_mode One of ZLIB_BLOCK, ZLIB_NO_FLUSH,
31676 *   ZLIB_PARTIAL_FLUSH, ZLIB_SYNC_FLUSH (default), ZLIB_FULL_FLUSH,
31677 *   ZLIB_FINISH. Normally you will want to set ZLIB_NO_FLUSH to maximize
31678 *   compression, and ZLIB_FINISH to terminate with the last chunk of
31679 *   data. See the zlib manual for a detailed description of these
31680 *   constants.
31681 * @return string Returns a chunk of compressed data, .
31682 * @since PHP 7
31683 **/
31684function deflate_add($context, $data, $flush_mode){}
31685
31686/**
31687 * Initialize an incremental deflate context
31688 *
31689 * Initializes an incremental deflate context using the specified {@link
31690 * encoding}.
31691 *
31692 * Note that the window option here only sets the window size of the
31693 * algorithm, differently from the zlib filters where the same parameter
31694 * also sets the encoding to use; the encoding must be set with the
31695 * {@link encoding} parameter.
31696 *
31697 * Limitation: there is currently no way to set the header information on
31698 * a GZIP compressed stream, which are set as follows: GZIP signature
31699 * (\x1f\x8B); compression method (\x08 == DEFLATE); 6 zero bytes; the
31700 * operating system set to the current system (\x00 = Windows, \x03 =
31701 * Unix, etc.)
31702 *
31703 * @param int $encoding One of the ZLIB_ENCODING_* constants.
31704 * @param array $options An associative array which may contain the
31705 *   following elements: level The compression level in range -1..9;
31706 *   defaults to -1. memory The compression memory level in range 1..9;
31707 *   defaults to 8. window The zlib window size (logarithmic) in range
31708 *   8..15; defaults to 15. strategy One of ZLIB_FILTERED,
31709 *   ZLIB_HUFFMAN_ONLY, ZLIB_RLE, ZLIB_FIXED or ZLIB_DEFAULT_STRATEGY
31710 *   (the default). dictionary A string or an array of strings of the
31711 *   preset dictionary (default: no preset dictionary).
31712 * @return resource Returns a deflate context resource (zlib.deflate)
31713 *   on success, .
31714 * @since PHP 7
31715 **/
31716function deflate_init($encoding, $options){}
31717
31718/**
31719 * Converts the number in degrees to the radian equivalent
31720 *
31721 * This function converts {@link number} from degrees to the radian
31722 * equivalent.
31723 *
31724 * @param float $number Angular value in degrees
31725 * @return float The radian equivalent of {@link number}
31726 * @since PHP 4, PHP 5, PHP 7
31727 **/
31728function deg2rad($number){}
31729
31730/**
31731 * Override the current domain
31732 *
31733 * The {@link dgettext} function allows you to override the current
31734 * {@link domain} for a single message lookup.
31735 *
31736 * @param string $domain The domain
31737 * @param string $message The message
31738 * @return string A string on success.
31739 * @since PHP 4, PHP 5, PHP 7
31740 **/
31741function dgettext($domain, $message){}
31742
31743/**
31744 * Closes the file descriptor given by fd
31745 *
31746 * The function {@link dio_close} closes the file descriptor {@link fd}.
31747 *
31748 * @param resource $fd The file descriptor returned by {@link
31749 *   dio_open}.
31750 * @return void
31751 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.0
31752 **/
31753function dio_close($fd){}
31754
31755/**
31756 * Performs a c library fcntl on fd
31757 *
31758 * The {@link dio_fcntl} function performs the operation specified by
31759 * {@link cmd} on the file descriptor {@link fd}. Some commands require
31760 * additional arguments {@link args} to be supplied.
31761 *
31762 * @param resource $fd The file descriptor returned by {@link
31763 *   dio_open}.
31764 * @param int $cmd Can be one of the following operations: F_SETLK -
31765 *   Lock is set or cleared. If the lock is held by someone else {@link
31766 *   dio_fcntl} returns -1. F_SETLKW - like F_SETLK, but in case the lock
31767 *   is held by someone else, {@link dio_fcntl} waits until the lock is
31768 *   released. F_GETLK - {@link dio_fcntl} returns an associative array
31769 *   (as described below) if someone else prevents lock. If there is no
31770 *   obstruction key "type" will set to F_UNLCK. F_DUPFD - finds the
31771 *   lowest numbered available file descriptor greater than or equal to
31772 *   {@link args} and returns them. F_SETFL - Sets the file descriptors
31773 *   flags to the value specified by {@link args}, which can be O_APPEND,
31774 *   O_NONBLOCK or O_ASYNC. To use O_ASYNC you will need to use the PCNTL
31775 *   extension.
31776 * @param mixed $args {@link args} is an associative array, when {@link
31777 *   cmd} is F_SETLK or F_SETLLW, with the following keys: start - offset
31778 *   where lock begins length - size of locked area. zero means to end of
31779 *   file whence - Where l_start is relative to: can be SEEK_SET,
31780 *   SEEK_END and SEEK_CUR type - type of lock: can be F_RDLCK (read
31781 *   lock), F_WRLCK (write lock) or F_UNLCK (unlock)
31782 * @return mixed Returns the result of the C call.
31783 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.0
31784 **/
31785function dio_fcntl($fd, $cmd, $args){}
31786
31787/**
31788 * Opens a file (creating it if necessary) at a lower level than the C
31789 * library input/ouput stream functions allow
31790 *
31791 * {@link dio_open} opens a file and returns a new file descriptor for
31792 * it.
31793 *
31794 * @param string $filename The pathname of the file to open.
31795 * @param int $flags The {@link flags} parameter is a bitwise-ORed
31796 *   value comprising flags from the following list. This value must
31797 *   include one of O_RDONLY, O_WRONLY, or O_RDWR. Additionally, it may
31798 *   include any combination of the other flags from this list. O_RDONLY
31799 *   - opens the file for read access. O_WRONLY - opens the file for
31800 *   write access. O_RDWR - opens the file for both reading and writing.
31801 *   O_CREAT - creates the file, if it doesn't already exist. O_EXCL - if
31802 *   both O_CREAT and O_EXCL are set and the file already exists, {@link
31803 *   dio_open} will fail. O_TRUNC - if the file exists and is opened for
31804 *   write access, the file will be truncated to zero length. O_APPEND -
31805 *   write operations write data at the end of the file. O_NONBLOCK -
31806 *   sets non blocking mode. O_NOCTTY - prevent the OS from assigning the
31807 *   opened file as the process's controlling terminal when opening a TTY
31808 *   device file.
31809 * @param int $mode If {@link flags} contains O_CREAT, {@link mode}
31810 *   will set the permissions of the file (creation permissions). {@link
31811 *   mode} is required for correct operation when O_CREAT is specified in
31812 *   {@link flags} and is ignored otherwise. The actual permissions
31813 *   assigned to the created file will be affected by the process's umask
31814 *   setting as per usual.
31815 * @return resource A file descriptor or FALSE on error.
31816 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.0
31817 **/
31818function dio_open($filename, $flags, $mode){}
31819
31820/**
31821 * Reads bytes from a file descriptor
31822 *
31823 * The function {@link dio_read} reads and returns {@link len} bytes from
31824 * file with descriptor {@link fd}.
31825 *
31826 * @param resource $fd The file descriptor returned by {@link
31827 *   dio_open}.
31828 * @param int $len The number of bytes to read. If not specified,
31829 *   {@link dio_read} reads 1K sized block.
31830 * @return string The bytes read from {@link fd}.
31831 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.0
31832 **/
31833function dio_read($fd, $len){}
31834
31835/**
31836 * Seeks to pos on fd from whence
31837 *
31838 * The function {@link dio_seek} is used to change the file position of
31839 * the given file descriptor.
31840 *
31841 * @param resource $fd The file descriptor returned by {@link
31842 *   dio_open}.
31843 * @param int $pos The new position.
31844 * @param int $whence Specifies how the position {@link pos} should be
31845 *   interpreted: SEEK_SET (default) - specifies that {@link pos} is
31846 *   specified from the beginning of the file. SEEK_CUR - Specifies that
31847 *   {@link pos} is a count of characters from the current file position.
31848 *   This count may be positive or negative. SEEK_END - Specifies that
31849 *   {@link pos} is a count of characters from the end of the file. A
31850 *   negative count specifies a position within the current extent of the
31851 *   file; a positive count specifies a position past the current end. If
31852 *   you set the position past the current end, and actually write data,
31853 *   you will extend the file with zeros up to that position.
31854 * @return int
31855 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.0
31856 **/
31857function dio_seek($fd, $pos, $whence){}
31858
31859/**
31860 * Gets stat information about the file descriptor fd
31861 *
31862 * {@link dio_stat} returns information about the given file descriptor.
31863 *
31864 * @param resource $fd The file descriptor returned by {@link
31865 *   dio_open}.
31866 * @return array Returns an associative array with the following keys:
31867 *   "device" - device "inode" - inode "mode" - mode "nlink" - number of
31868 *   hard links "uid" - user id "gid" - group id "device_type" - device
31869 *   type (if inode device) "size" - total size in bytes "blocksize" -
31870 *   blocksize "blocks" - number of blocks allocated "atime" - time of
31871 *   last access "mtime" - time of last modification "ctime" - time of
31872 *   last change On error {@link dio_stat} returns NULL.
31873 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.0
31874 **/
31875function dio_stat($fd){}
31876
31877/**
31878 * Sets terminal attributes and baud rate for a serial port
31879 *
31880 * {@link dio_tcsetattr} sets the terminal attributes and baud rate of
31881 * the open {@link fd}.
31882 *
31883 * @param resource $fd The file descriptor returned by {@link
31884 *   dio_open}.
31885 * @param array $options The currently available options are: 'baud' -
31886 *   baud rate of the port - can be 38400,19200,9600,4800,2400,1800,
31887 *   1200,600,300,200,150,134,110,75 or 50, default value is 9600. 'bits'
31888 *   - data bits - can be 8,7,6 or 5. Default value is 8. 'stop' - stop
31889 *   bits - can be 1 or 2. Default value is 1. 'parity' - can be 0,1 or
31890 *   2. Default value is 0.
31891 * @return bool
31892 * @since PHP 4 >= 4.3.0, PHP 5 < 5.1.0
31893 **/
31894function dio_tcsetattr($fd, $options){}
31895
31896/**
31897 * Truncates file descriptor fd to offset bytes
31898 *
31899 * {@link dio_truncate} truncates a file to at most {@link offset} bytes
31900 * in size.
31901 *
31902 * If the file previously was larger than this size, the extra data is
31903 * lost. If the file previously was shorter, it is unspecified whether
31904 * the file is left unchanged or is extended. In the latter case the
31905 * extended part reads as zero bytes.
31906 *
31907 * @param resource $fd The file descriptor returned by {@link
31908 *   dio_open}.
31909 * @param int $offset The offset in bytes.
31910 * @return bool
31911 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.0
31912 **/
31913function dio_truncate($fd, $offset){}
31914
31915/**
31916 * Writes data to fd with optional truncation at length
31917 *
31918 * {@link dio_write} writes up to {@link len} bytes from {@link data} to
31919 * file {@link fd}.
31920 *
31921 * @param resource $fd The file descriptor returned by {@link
31922 *   dio_open}.
31923 * @param string $data The written data.
31924 * @param int $len The length of data to write in bytes. If not
31925 *   specified, the function writes all the data to the specified file.
31926 * @return int Returns the number of bytes written to {@link fd}.
31927 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.0
31928 **/
31929function dio_write($fd, $data, $len){}
31930
31931/**
31932 * Return an instance of the Directory class
31933 *
31934 * A pseudo-object oriented mechanism for reading a directory. The given
31935 * {@link directory} is opened.
31936 *
31937 * @param string $directory Directory to open
31938 * @param resource $context
31939 * @return Directory Returns an instance of Directory, or NULL with
31940 *   wrong parameters, or FALSE in case of another error.
31941 * @since PHP 4, PHP 5, PHP 7
31942 **/
31943function dir($directory, $context){}
31944
31945/**
31946 * Returns a parent directory's path
31947 *
31948 * Given a string containing the path of a file or directory, this
31949 * function will return the parent directory's path that is {@link
31950 * levels} up from the current directory.
31951 *
31952 * @param string $path A path. On Windows, both slash (/) and backslash
31953 *   (\) are used as directory separator character. In other
31954 *   environments, it is the forward slash (/).
31955 * @param int $levels The number of parent directories to go up. This
31956 *   must be an integer greater than 0.
31957 * @return string Returns the path of a parent directory. If there are
31958 *   no slashes in {@link path}, a dot ('.') is returned, indicating the
31959 *   current directory. Otherwise, the returned string is {@link path}
31960 *   with any trailing /component removed.
31961 * @since PHP 4, PHP 5, PHP 7
31962 **/
31963function dirname($path, $levels){}
31964
31965/**
31966 * Returns available space on filesystem or disk partition
31967 *
31968 * Given a string containing a directory, this function will return the
31969 * number of bytes available on the corresponding filesystem or disk
31970 * partition.
31971 *
31972 * @param string $directory A directory of the filesystem or disk
31973 *   partition.
31974 * @return float Returns the number of available bytes as a float .
31975 * @since PHP 4, PHP 5, PHP 7
31976 **/
31977function diskfreespace($directory){}
31978
31979/**
31980 * Returns available space on filesystem or disk partition
31981 *
31982 * Given a string containing a directory, this function will return the
31983 * number of bytes available on the corresponding filesystem or disk
31984 * partition.
31985 *
31986 * @param string $directory A directory of the filesystem or disk
31987 *   partition.
31988 * @return float Returns the number of available bytes as a float .
31989 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
31990 **/
31991function disk_free_space($directory){}
31992
31993/**
31994 * Returns the total size of a filesystem or disk partition
31995 *
31996 * Given a string containing a directory, this function will return the
31997 * total number of bytes on the corresponding filesystem or disk
31998 * partition.
31999 *
32000 * @param string $directory A directory of the filesystem or disk
32001 *   partition.
32002 * @return float Returns the total number of bytes as a float .
32003 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
32004 **/
32005function disk_total_space($directory){}
32006
32007/**
32008 * Loads a PHP extension at runtime
32009 *
32010 * Loads the PHP extension given by the parameter {@link library}.
32011 *
32012 * Use {@link extension_loaded} to test whether a given extension is
32013 * already available or not. This works on both built-in extensions and
32014 * dynamically loaded ones (either through or {@link dl}).
32015 *
32016 * @param string $library This parameter is only the filename of the
32017 *   extension to load which also depends on your platform. For example,
32018 *   the sockets extension (if compiled as a shared module, not the
32019 *   default!) would be called sockets.so on Unix platforms whereas it is
32020 *   called php_sockets.dll on the Windows platform. The directory where
32021 *   the extension is loaded from depends on your platform: Windows - If
32022 *   not explicitly set in the , the extension is loaded from C:\php5\ by
32023 *   default. Unix - If not explicitly set in the , the default extension
32024 *   directory depends on whether PHP has been built with --enable-debug
32025 *   or not whether PHP has been built with (experimental) ZTS (Zend
32026 *   Thread Safety) support or not the current internal
32027 *   ZEND_MODULE_API_NO (Zend internal module API number, which is
32028 *   basically the date on which a major module API change happened, e.g.
32029 *   20010901) Taking into account the above, the directory then defaults
32030 *   to <install-dir>/lib/php/extensions/
32031 *   <debug-or-not>-<zts-or-not>-ZEND_MODULE_API_NO, e.g.
32032 *   /usr/local/php/lib/php/extensions/debug-non-zts-20010901 or
32033 *   /usr/local/php/lib/php/extensions/no-debug-zts-20010901.
32034 * @return bool If the functionality of loading modules is not
32035 *   available or has been disabled (either by setting enable_dl off or
32036 *   by enabling in ) an E_ERROR is emitted and execution is stopped. If
32037 *   {@link dl} fails because the specified library couldn't be loaded,
32038 *   in addition to FALSE an E_WARNING message is emitted.
32039 * @since PHP 4, PHP 5, PHP 7
32040 **/
32041function dl($library){}
32042
32043/**
32044 * Plural version of dgettext
32045 *
32046 * The {@link dngettext} function allows you to override the current
32047 * {@link domain} for a single plural message lookup.
32048 *
32049 * @param string $domain The domain
32050 * @param string $msgid1
32051 * @param string $msgid2
32052 * @param int $n
32053 * @return string A string on success.
32054 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
32055 **/
32056function dngettext($domain, $msgid1, $msgid2, $n){}
32057
32058/**
32059 * Check DNS records corresponding to a given Internet host name or IP
32060 * address
32061 *
32062 * Searches DNS for records of type {@link type} corresponding to {@link
32063 * host}.
32064 *
32065 * @param string $host {@link host} may either be the IP address in
32066 *   dotted-quad notation or the host name.
32067 * @param string $type {@link type} may be any one of: A, MX, NS, SOA,
32068 *   PTR, CNAME, AAAA, A6, SRV, NAPTR, TXT or ANY.
32069 * @return bool Returns TRUE if any records are found; returns FALSE if
32070 *   no records were found or if an error occurred.
32071 * @since PHP 5, PHP 7
32072 **/
32073function dns_check_record($host, $type){}
32074
32075/**
32076 * Get MX records corresponding to a given Internet host name
32077 *
32078 * Searches DNS for MX records corresponding to {@link hostname}.
32079 *
32080 * @param string $hostname The Internet host name.
32081 * @param array $mxhosts A list of the MX records found is placed into
32082 *   the array {@link mxhosts}.
32083 * @param array $weight If the {@link weight} array is given, it will
32084 *   be filled with the weight information gathered.
32085 * @return bool Returns TRUE if any records are found; returns FALSE if
32086 *   no records were found or if an error occurred.
32087 * @since PHP 5, PHP 7
32088 **/
32089function dns_get_mx($hostname, &$mxhosts, &$weight){}
32090
32091/**
32092 * Fetch DNS Resource Records associated with a hostname
32093 *
32094 * Fetch DNS Resource Records associated with the given {@link hostname}.
32095 *
32096 * @param string $hostname {@link hostname} should be a valid DNS
32097 *   hostname such as "www.example.com". Reverse lookups can be generated
32098 *   using in-addr.arpa notation, but {@link gethostbyaddr} is more
32099 *   suitable for the majority of reverse lookups.
32100 * @param int $type By default, {@link dns_get_record} will search for
32101 *   any resource records associated with {@link hostname}. To limit the
32102 *   query, specify the optional {@link type} parameter. May be any one
32103 *   of the following: DNS_A, DNS_CNAME, DNS_HINFO, DNS_CAA, DNS_MX,
32104 *   DNS_NS, DNS_PTR, DNS_SOA, DNS_TXT, DNS_AAAA, DNS_SRV, DNS_NAPTR,
32105 *   DNS_A6, DNS_ALL or DNS_ANY.
32106 * @param array $authns Passed by reference and, if given, will be
32107 *   populated with Resource Records for the Authoritative Name Servers.
32108 * @param array $addtl Passed by reference and, if given, will be
32109 *   populated with any Additional Records.
32110 * @param bool $raw The {@link type} will be interpreted as a raw DNS
32111 *   type ID (the DNS_* constants cannot be used). The return value will
32112 *   contain a data key, which needs to be manually parsed.
32113 * @return array This function returns an array of associative arrays,
32114 *   . Each associative array contains at minimum the following keys:
32115 *   Basic DNS attributes Attribute Meaning host The record in the DNS
32116 *   namespace to which the rest of the associated data refers. class
32117 *   {@link dns_get_record} only returns Internet class records and as
32118 *   such this parameter will always return IN. type String containing
32119 *   the record type. Additional attributes will also be contained in the
32120 *   resulting array dependant on the value of type. See table below. ttl
32121 *   "Time To Live" remaining for this record. This will not equal the
32122 *   record's original ttl, but will rather equal the original ttl minus
32123 *   whatever length of time has passed since the authoritative name
32124 *   server was queried.
32125 * @since PHP 5, PHP 7
32126 **/
32127function dns_get_record($hostname, $type, &$authns, &$addtl, $raw){}
32128
32129/**
32130 * Gets a object from a object
32131 *
32132 * This function takes the node {@link node} of class SimpleXML and makes
32133 * it into a DOMElement node. This new object can then be used as a
32134 * native DOMElement node.
32135 *
32136 * @param SimpleXMLElement $node The SimpleXMLElement node.
32137 * @return DOMElement The DOMElement node added or FALSE if any errors
32138 *   occur.
32139 * @since PHP 5, PHP 7
32140 **/
32141function dom_import_simplexml($node){}
32142
32143/**
32144 * Get float value of a variable
32145 *
32146 * Gets the float value of {@link var}.
32147 *
32148 * @param mixed $var May be any scalar type. {@link floatval} should
32149 *   not be used on objects, as doing so will emit an E_NOTICE level
32150 *   error and return 1.
32151 * @return float The float value of the given variable. Empty arrays
32152 *   return 0, non-empty arrays return 1.
32153 * @since PHP 4, PHP 5, PHP 7
32154 **/
32155function doubleval($var){}
32156
32157/**
32158 * Return the current key and value pair from an array and advance the
32159 * array cursor
32160 *
32161 * Return the current key and value pair from an array and advance the
32162 * array cursor.
32163 *
32164 * After {@link each} has executed, the array cursor will be left on the
32165 * next element of the array, or past the last element if it hits the end
32166 * of the array. You have to use {@link reset} if you want to traverse
32167 * the array again using each.
32168 *
32169 * @param array $array The input array.
32170 * @return array Returns the current key and value pair from the array
32171 *   {@link array}. This pair is returned in a four-element array, with
32172 *   the keys 0, 1, key, and value. Elements 0 and key contain the key
32173 *   name of the array element, and 1 and value contain the data.
32174 * @since PHP 4, PHP 5, PHP 7
32175 **/
32176function each(&$array){}
32177
32178/**
32179 * Get Unix timestamp for midnight on Easter of a given year
32180 *
32181 * Returns the Unix timestamp corresponding to midnight on Easter of the
32182 * given year.
32183 *
32184 * The date of Easter Day was defined by the Council of Nicaea in AD325
32185 * as the Sunday after the first full moon which falls on or after the
32186 * Spring Equinox. The Equinox is assumed to always fall on 21st March,
32187 * so the calculation reduces to determining the date of the full moon
32188 * and the date of the following Sunday. The algorithm used here was
32189 * introduced around the year 532 by Dionysius Exiguus. Under the Julian
32190 * Calendar (for years before 1753) a simple 19-year cycle is used to
32191 * track the phases of the Moon. Under the Gregorian Calendar (for years
32192 * after 1753 - devised by Clavius and Lilius, and introduced by Pope
32193 * Gregory XIII in October 1582, and into Britain and its then colonies
32194 * in September 1752) two correction factors are added to make the cycle
32195 * more accurate.
32196 *
32197 * @param int $year The year as a number between 1970 an 2037. If
32198 *   omitted, defaults to the current year according to the local time.
32199 * @param int $method Allows Easter dates to be calculated based on the
32200 *   Julian calendar when set to CAL_EASTER_ALWAYS_JULIAN. See also
32201 *   calendar constants.
32202 * @return int The easter date as a unix timestamp.
32203 * @since PHP 4, PHP 5, PHP 7
32204 **/
32205function easter_date($year, $method){}
32206
32207/**
32208 * Get number of days after March 21 on which Easter falls for a given
32209 * year
32210 *
32211 * Returns the number of days after March 21 on which Easter falls for a
32212 * given year. If no year is specified, the current year is assumed.
32213 *
32214 * This function can be used instead of {@link easter_date} to calculate
32215 * Easter for years which fall outside the range of Unix timestamps (i.e.
32216 * before 1970 or after 2037).
32217 *
32218 * The date of Easter Day was defined by the Council of Nicaea in AD325
32219 * as the Sunday after the first full moon which falls on or after the
32220 * Spring Equinox. The Equinox is assumed to always fall on 21st March,
32221 * so the calculation reduces to determining the date of the full moon
32222 * and the date of the following Sunday. The algorithm used here was
32223 * introduced around the year 532 by Dionysius Exiguus. Under the Julian
32224 * Calendar (for years before 1753) a simple 19-year cycle is used to
32225 * track the phases of the Moon. Under the Gregorian Calendar (for years
32226 * after 1753 - devised by Clavius and Lilius, and introduced by Pope
32227 * Gregory XIII in October 1582, and into Britain and its then colonies
32228 * in September 1752) two correction factors are added to make the cycle
32229 * more accurate.
32230 *
32231 * @param int $year The year as a positive number. If omitted, defaults
32232 *   to the current year according to the local time.
32233 * @param int $method Allows Easter dates to be calculated based on the
32234 *   Gregorian calendar during the years 1582 - 1752 when set to
32235 *   CAL_EASTER_ROMAN. See the calendar constants for more valid
32236 *   constants.
32237 * @return int The number of days after March 21st that the Easter
32238 *   Sunday is in the given {@link year}.
32239 * @since PHP 4, PHP 5, PHP 7
32240 **/
32241function easter_days($year, $method){}
32242
32243/**
32244 * Artificially increase load. Could be useful in tests, benchmarking
32245 *
32246 * {@link eio_busy} artificially increases load taking {@link delay}
32247 * seconds to execute. May be used for debugging, or benchmarking.
32248 *
32249 * @param int $delay Delay in seconds
32250 * @param int $pri
32251 * @param callable $callback This callback is called when all the group
32252 *   requests are done.
32253 * @param mixed $data Arbitrary variable passed to {@link callback}.
32254 * @return resource {@link eio_busy} returns request resource on
32255 *   success or FALSE on error.
32256 * @since PECL eio >= 0.0.1dev
32257 **/
32258function eio_busy($delay, $pri, $callback, $data){}
32259
32260/**
32261 * Cancels a request
32262 *
32263 * {@link eio_cancel} cancels a request specified by {@link req}
32264 *
32265 * @param resource $req The request resource
32266 * @return void
32267 * @since PECL eio >= 0.0.1dev
32268 **/
32269function eio_cancel($req){}
32270
32271/**
32272 * Change file/directory permissions
32273 *
32274 * {@link eio_chmod} changes file, or directory permissions. The new
32275 * permissions are specified by {@link mode}.
32276 *
32277 * @param string $path Path to the target file or directory
32278 * @param int $mode The new permissions. E.g. 0644.
32279 * @param int $pri
32280 * @param callable $callback
32281 * @param mixed $data Arbitrary variable passed to {@link callback}.
32282 * @return resource {@link eio_chmod} returns request resource on
32283 *   success or FALSE on error.
32284 * @since PECL eio >= 0.0.1dev
32285 **/
32286function eio_chmod($path, $mode, $pri, $callback, $data){}
32287
32288/**
32289 * Change file/directory permissions
32290 *
32291 * Changes file, or directory permissions.
32292 *
32293 * @param string $path Path to file or directory.
32294 * @param int $uid User ID. Is ignored when equal to -1.
32295 * @param int $gid Group ID. Is ignored when equal to -1.
32296 * @param int $pri
32297 * @param callable $callback
32298 * @param mixed $data Arbitrary variable passed to {@link callback}.
32299 * @return resource {@link eio_chown} returns request resource on
32300 *   success or FALSE on error.
32301 * @since PECL eio >= 0.0.1dev
32302 **/
32303function eio_chown($path, $uid, $gid, $pri, $callback, $data){}
32304
32305/**
32306 * Close file
32307 *
32308 * {@link eio_close} closes file specified by {@link fd}.
32309 *
32310 * @param mixed $fd Stream, Socket resource, or numeric file descriptor
32311 * @param int $pri
32312 * @param callable $callback
32313 * @param mixed $data Arbitrary variable passed to {@link callback}.
32314 * @return resource {@link eio_close} returns request resource on
32315 *   success or FALSE on error.
32316 * @since PECL eio >= 0.0.1dev
32317 **/
32318function eio_close($fd, $pri, $callback, $data){}
32319
32320/**
32321 * Execute custom request like any other call
32322 *
32323 * {@link eio_custom} executes custom function specified by {@link
32324 * execute} processing it just like any other eio_* call.
32325 *
32326 * @param callable $execute Specifies the request function that should
32327 *   match the following prototype:
32328 *
32329 *   mixed execute(mixed data); {@link callback} is event completion
32330 *   callback that should match the following prototype: void
32331 *   callback(mixed data, mixed result);
32332 *
32333 *   {@link data} is the data passed to {@link execute} via {@link data}
32334 *   argument without modifications {@link result} value returned by
32335 *   {@link execute}
32336 * @param int $pri
32337 * @param callable $callback
32338 * @param mixed $data Arbitrary variable passed to {@link callback}.
32339 * @return resource {@link eio_custom} returns request resource on
32340 *   success or FALSE on error.
32341 * @since PECL eio >= 0.0.1dev
32342 **/
32343function eio_custom($execute, $pri, $callback, $data){}
32344
32345/**
32346 * Duplicate a file descriptor
32347 *
32348 * {@link eio_dup2} duplicates file descriptor.
32349 *
32350 * @param mixed $fd Source stream, Socket resource, or numeric file
32351 *   descriptor
32352 * @param mixed $fd2 Target stream, Socket resource, or numeric file
32353 *   descriptor
32354 * @param int $pri
32355 * @param callable $callback
32356 * @param mixed $data Arbitrary variable passed to {@link callback}.
32357 * @return resource {@link eio_dup2} returns request resource on
32358 *   success or FALSE on error.
32359 * @since PECL eio >= 0.0.1dev
32360 **/
32361function eio_dup2($fd, $fd2, $pri, $callback, $data){}
32362
32363/**
32364 * Polls libeio until all requests proceeded
32365 *
32366 * {@link eio_event_loop} polls libeio until all requests proceeded.
32367 *
32368 * @return bool {@link eio_event_loop} returns TRUE on success or FALSE
32369 *   on error.
32370 * @since PECL eio >= 0.0.1dev
32371 **/
32372function eio_event_loop(){}
32373
32374/**
32375 * Allows the caller to directly manipulate the allocated disk space for
32376 * a file
32377 *
32378 * {@link eio_fallocate} allows the caller to directly manipulate the
32379 * allocated disk space for the file specified by {@link fd} file
32380 * descriptor for the byte range starting at {@link offset} and
32381 * continuing for {@link length} bytes.
32382 *
32383 * @param mixed $fd Stream, Socket resource, or numeric file
32384 *   descriptor, e.g. returned by {@link eio_open}.
32385 * @param int $mode Currently only one flag is supported for mode:
32386 *   EIO_FALLOC_FL_KEEP_SIZE (the same as POSIX constant
32387 *   FALLOC_FL_KEEP_SIZE).
32388 * @param int $offset Specifies start of the byte range.
32389 * @param int $length Specifies length the byte range.
32390 * @param int $pri
32391 * @param callable $callback
32392 * @param mixed $data Arbitrary variable passed to {@link callback}.
32393 * @return resource {@link eio_fallocate} returns request resource on
32394 *   success or FALSE on error.
32395 * @since PECL eio >= 0.0.1dev
32396 **/
32397function eio_fallocate($fd, $mode, $offset, $length, $pri, $callback, $data){}
32398
32399/**
32400 * Change file permissions
32401 *
32402 * {@link eio_fchmod} changes permissions for the file specified by
32403 * {@link fd} file descriptor.
32404 *
32405 * @param mixed $fd Stream, Socket resource, or numeric file
32406 *   descriptor, e.g. returned by {@link eio_open}.
32407 * @param int $mode The new permissions. E.g. 0644.
32408 * @param int $pri
32409 * @param callable $callback
32410 * @param mixed $data Arbitrary variable passed to {@link callback}.
32411 * @return resource {@link eio_fchmod} returns request resource on
32412 *   success or FALSE on error.
32413 * @since PECL eio >= 0.0.1dev
32414 **/
32415function eio_fchmod($fd, $mode, $pri, $callback, $data){}
32416
32417/**
32418 * Change file ownership
32419 *
32420 * {@link eio_fchown} changes ownership of the file specified by {@link
32421 * fd} file descriptor.
32422 *
32423 * @param mixed $fd Stream, Socket resource, or numeric file
32424 *   descriptor.
32425 * @param int $uid User ID. Is ignored when equal to -1.
32426 * @param int $gid Group ID. Is ignored when equal to -1.
32427 * @param int $pri
32428 * @param callable $callback
32429 * @param mixed $data Arbitrary variable passed to {@link callback}.
32430 * @return resource
32431 * @since PECL eio >= 0.0.1dev
32432 **/
32433function eio_fchown($fd, $uid, $gid, $pri, $callback, $data){}
32434
32435/**
32436 * Synchronize a file's in-core state with storage device
32437 *
32438 * {@link eio_fdatasync} synchronizes a file's in-core state with storage
32439 * device.
32440 *
32441 * @param mixed $fd Stream, Socket resource, or numeric file
32442 *   descriptor, e.g. returned by {@link eio_open}.
32443 * @param int $pri
32444 * @param callable $callback
32445 * @param mixed $data Arbitrary variable passed to {@link callback}.
32446 * @return resource {@link eio_fdatasync} returns request resource on
32447 *   success or FALSE on error.
32448 * @since PECL eio >= 0.0.1dev
32449 **/
32450function eio_fdatasync($fd, $pri, $callback, $data){}
32451
32452/**
32453 * Get file status
32454 *
32455 * {@link eio_fstat} returns file status information in {@link result}
32456 * argument of {@link callback}
32457 *
32458 * @param mixed $fd Stream, Socket resource, or numeric file
32459 *   descriptor.
32460 * @param int $pri
32461 * @param callable $callback
32462 * @param mixed $data Arbitrary variable passed to {@link callback}.
32463 * @return resource {@link eio_busy} returns request resource on
32464 *   success or FALSE on error.
32465 * @since PECL eio >= 0.0.1dev
32466 **/
32467function eio_fstat($fd, $pri, $callback, $data){}
32468
32469/**
32470 * Get file system statistics
32471 *
32472 * {@link eio_fstatvfs} returns file system statistics in {@link result}
32473 * of {@link callback}.
32474 *
32475 * @param mixed $fd A file descriptor of a file within the mounted file
32476 *   system.
32477 * @param int $pri
32478 * @param callable $callback
32479 * @param mixed $data Arbitrary variable passed to {@link callback}.
32480 * @return resource {@link eio_fstatvfs} returns request resource on
32481 *   success or FALSE on error.
32482 * @since PECL eio >= 0.0.1dev
32483 **/
32484function eio_fstatvfs($fd, $pri, $callback, $data){}
32485
32486/**
32487 * Synchronize a file's in-core state with storage device
32488 *
32489 * @param mixed $fd Stream, Socket resource, or numeric file
32490 *   descriptor.
32491 * @param int $pri
32492 * @param callable $callback
32493 * @param mixed $data Arbitrary variable passed to {@link callback}.
32494 * @return resource {@link eio_fsync} returns request resource on
32495 *   success or FALSE on error.
32496 * @since PECL eio >= 0.0.1dev
32497 **/
32498function eio_fsync($fd, $pri, $callback, $data){}
32499
32500/**
32501 * Truncate a file
32502 *
32503 * {@link eio_ftruncate} causes a regular file referenced by {@link fd}
32504 * file descriptor to be truncated to precisely {@link length} bytes.
32505 *
32506 * @param mixed $fd Stream, Socket resource, or numeric file
32507 *   descriptor.
32508 * @param int $offset Offset from beginning of the file
32509 * @param int $pri
32510 * @param callable $callback
32511 * @param mixed $data Arbitrary variable passed to {@link callback}.
32512 * @return resource {@link eio_ftruncate} returns request resource on
32513 *   success or FALSE on error.
32514 * @since PECL eio >= 0.0.1dev
32515 **/
32516function eio_ftruncate($fd, $offset, $pri, $callback, $data){}
32517
32518/**
32519 * Change file last access and modification times
32520 *
32521 * {@link eio_futime} changes file last access and modification times.
32522 *
32523 * @param mixed $fd Stream, Socket resource, or numeric file
32524 *   descriptor, e.g. returned by {@link eio_open}
32525 * @param float $atime Access time
32526 * @param float $mtime Modification time
32527 * @param int $pri
32528 * @param callable $callback
32529 * @param mixed $data Arbitrary variable passed to {@link callback}.
32530 * @return resource {@link eio_futime} returns request resource on
32531 *   success or FALSE on error.
32532 * @since PECL eio >= 0.0.1dev
32533 **/
32534function eio_futime($fd, $atime, $mtime, $pri, $callback, $data){}
32535
32536/**
32537 * Get stream representing a variable used in internal communications
32538 * with libeio
32539 *
32540 * {@link eio_get_event_stream} acquires stream representing a variable
32541 * used in internal communications with libeio. Could be used to bind
32542 * with some event loop provided by other PECL extension, for example
32543 * libevent.
32544 *
32545 * @return mixed {@link eio_get_event_stream} returns stream on
32546 *   success; otherwise, NULL
32547 * @since PECL eio >= 0.3.1b
32548 **/
32549function eio_get_event_stream(){}
32550
32551/**
32552 * Returns string describing the last error associated with a request
32553 * resource
32554 *
32555 * {@link eio_get_last_error} returns string describing the last error
32556 * associated with {@link req}.
32557 *
32558 * @param resource $req The request resource
32559 * @return string {@link eio_get_last_error} returns string describing
32560 *   the last error associated with the request resource specified by
32561 *   {@link req}.
32562 * @since PECL eio >= 1.0.0
32563 **/
32564function eio_get_last_error($req){}
32565
32566/**
32567 * Creates a request group
32568 *
32569 * {@link eio_grp} creates a request group.
32570 *
32571 * @param callable $callback
32572 * @param string $data Arbitrary variable passed to {@link callback}.
32573 * @return resource {@link eio_grp} returns request group resource on
32574 *   success or FALSE on error.
32575 * @since PECL eio >= 0.0.1dev
32576 **/
32577function eio_grp($callback, $data){}
32578
32579/**
32580 * Adds a request to the request group
32581 *
32582 * {@link eio_grp_add} adds a request to the request group.
32583 *
32584 * @param resource $grp The request group resource returned by {@link
32585 *   eio_grp}
32586 * @param resource $req The request resource
32587 * @return void {@link eio_grp_add} doesn't return a value.
32588 * @since PECL eio >= 0.0.1dev
32589 **/
32590function eio_grp_add($grp, $req){}
32591
32592/**
32593 * Cancels a request group
32594 *
32595 * {@link eio_grp_cancel} cancels a group request specified by {@link
32596 * grp} request group resource.
32597 *
32598 * @param resource $grp The request group resource returned by {@link
32599 *   eio_grp}.
32600 * @return void
32601 * @since PECL eio >= 0.0.1dev
32602 **/
32603function eio_grp_cancel($grp){}
32604
32605/**
32606 * Set group limit
32607 *
32608 * Limit number of requests in the request group.
32609 *
32610 * @param resource $grp The request group resource.
32611 * @param int $limit Number of requests in the group.
32612 * @return void
32613 * @since PECL eio >= 0.0.1dev
32614 **/
32615function eio_grp_limit($grp, $limit){}
32616
32617/**
32618 * (Re-)initialize Eio
32619 *
32620 * {@link eio_init} (re-)initializes Eio. It allocates memory for
32621 * internal structures of libeio and Eio itself. You may call {@link
32622 * eio_init} before using Eio functions. Otherwise it will be called
32623 * internally first time you invoke an Eio function in a process.
32624 *
32625 * Since Eio 1.1.0 {@link eio_init} is deprecated. In Eio 1.0.0 because
32626 * of libeio's restrictions you must call {@link eio_init} in child
32627 * process, if you fork one by any means. You have to avoid using Eio in
32628 * parent process, if you use it in childs.
32629 *
32630 * @return void
32631 * @since PECL eio = 1.0.0
32632 **/
32633function eio_init(){}
32634
32635/**
32636 * Create a hardlink for file
32637 *
32638 * {@link eio_link} creates a hardlink {@link new_path} for a file
32639 * specified by {@link path}.
32640 *
32641 * @param string $path Source file path.
32642 * @param string $new_path Target file path.
32643 * @param int $pri
32644 * @param callable $callback
32645 * @param mixed $data Arbitrary variable passed to {@link callback}.
32646 * @return resource
32647 * @since PECL eio >= 0.0.1dev
32648 **/
32649function eio_link($path, $new_path, $pri, $callback, $data){}
32650
32651/**
32652 * Get file status
32653 *
32654 * {@link eio_lstat} returns file status information in {@link result}
32655 * argument of {@link callback}
32656 *
32657 * @param string $path The file path
32658 * @param int $pri
32659 * @param callable $callback
32660 * @param mixed $data Arbitrary variable passed to {@link callback}.
32661 * @return resource {@link eio_lstat} returns request resource on
32662 *   success or FALSE on error.
32663 * @since PECL eio >= 0.0.1dev
32664 **/
32665function eio_lstat($path, $pri, $callback, $data){}
32666
32667/**
32668 * Create directory
32669 *
32670 * {@link eio_mkdir} creates directory with specified access {@link
32671 * mode}.
32672 *
32673 * @param string $path Path for the new directory.
32674 * @param int $mode Access mode, e.g. 0755
32675 * @param int $pri
32676 * @param callable $callback
32677 * @param mixed $data Arbitrary variable passed to {@link callback}.
32678 * @return resource {@link eio_mkdir} returns request resource on
32679 *   success or FALSE on error.
32680 * @since PECL eio >= 0.0.1dev
32681 **/
32682function eio_mkdir($path, $mode, $pri, $callback, $data){}
32683
32684/**
32685 * Create a special or ordinary file
32686 *
32687 * {@link eio_mknod} creates ordinary or special(often) file.
32688 *
32689 * @param string $path Path for the new node(file).
32690 * @param int $mode Specifies both the permissions to use and the type
32691 *   of node to be created. It should be a combination (using bitwise OR)
32692 *   of one of the file types listed below and the permissions for the
32693 *   new node(e.g. 0640).
32694 *
32695 *   Possible file types are: EIO_S_IFREG(regular file),
32696 *   EIO_S_IFCHR(character file), EIO_S_IFBLK(block special file),
32697 *   EIO_S_IFIFO(FIFO - named pipe) and EIO_S_IFSOCK(UNIX domain socket).
32698 *
32699 *   To specify permissions EIO_S_I* constants could be used.
32700 * @param int $dev If the file type is EIO_S_IFCHR or EIO_S_IFBLK then
32701 *   dev specifies the major and minor numbers of the newly created
32702 *   device special file. Otherwise {@link dev} ignored. See mknod(2) man
32703 *   page for details.
32704 * @param int $pri
32705 * @param callable $callback
32706 * @param mixed $data Arbitrary variable passed to {@link callback}.
32707 * @return resource {@link eio_mknod} returns request resource on
32708 *   success or FALSE on error.
32709 * @since PECL eio >= 0.0.1dev
32710 **/
32711function eio_mknod($path, $mode, $dev, $pri, $callback, $data){}
32712
32713/**
32714 * Does nothing, except go through the whole request cycle
32715 *
32716 * {@link eio_nop} does nothing, except go through the whole request
32717 * cycle. Could be useful in debugging.
32718 *
32719 * @param int $pri
32720 * @param callable $callback
32721 * @param mixed $data Arbitrary variable passed to {@link callback}.
32722 * @return resource {@link eio_nop} returns request resource on success
32723 *   or FALSE on error.
32724 * @since PECL eio >= 0.0.1dev
32725 **/
32726function eio_nop($pri, $callback, $data){}
32727
32728/**
32729 * Returns number of finished, but unhandled requests
32730 *
32731 * {@link eio_npending} returns number of finished, but unhandled
32732 * requests
32733 *
32734 * @return int {@link eio_npending} returns number of finished, but
32735 *   unhandled requests.
32736 * @since PECL eio >= 0.0.1dev
32737 **/
32738function eio_npending(){}
32739
32740/**
32741 * Returns number of not-yet handled requests
32742 *
32743 * @return int {@link eio_nready} returns number of not-yet handled
32744 *   requests
32745 * @since PECL eio >= 0.0.1dev
32746 **/
32747function eio_nready(){}
32748
32749/**
32750 * Returns number of requests to be processed
32751 *
32752 * {@link eio_nreqs} could be called in a custom loop calling {@link
32753 * eio_poll}.
32754 *
32755 * @return int {@link eio_nreqs} returns number of requests to be
32756 *   processed.
32757 * @since PECL eio >= 0.0.1dev
32758 **/
32759function eio_nreqs(){}
32760
32761/**
32762 * Returns number of threads currently in use
32763 *
32764 * @return int {@link eio_nthreads} returns number of threads currently
32765 *   in use.
32766 * @since PECL eio >= 0.0.1dev
32767 **/
32768function eio_nthreads(){}
32769
32770/**
32771 * Opens a file
32772 *
32773 * {@link eio_open} opens file specified by {@link path} in access mode
32774 * {@link mode} with
32775 *
32776 * @param string $path Path of the file to be opened. In some
32777 *   SAPIs(e.g. PHP-FPM) it could fail, if you don't specify full path.
32778 * @param int $flags One of EIO_O_* constants, or their combinations.
32779 *   EIO_O_* constants have the same meaning, as their corresponding O_*
32780 *   counterparts defined in fnctl.h C header file. Default is
32781 *   EIO_O_RDWR.
32782 * @param int $mode One of EIO_S_I* constants, or their combination
32783 *   (via bitwise OR operator). The constants have the same meaning as
32784 *   their S_I* counterparts defined in sys/stat.h C header file.
32785 *   Required, if a file is created. Otherwise ignored.
32786 * @param int $pri
32787 * @param callable $callback
32788 * @param mixed $data Arbitrary variable passed to {@link callback}.
32789 * @return resource {@link eio_open} returns file descriptor in {@link
32790 *   result} argument of {@link callback} on success; otherwise, {@link
32791 *   result} is equal to -1.
32792 * @since PECL eio >= 0.0.1dev
32793 **/
32794function eio_open($path, $flags, $mode, $pri, $callback, $data){}
32795
32796/**
32797 * Can be to be called whenever there are pending requests that need
32798 * finishing
32799 *
32800 * {@link eio_poll} can be used to implement special event loop. For this
32801 * {@link eio_nreqs} could be used to test if there are unprocessed
32802 * requests.
32803 *
32804 * @return int If any request invocation returns a non-zero value,
32805 *   returns that value. Otherwise, it returns 0.
32806 * @since PECL eio >= 0.0.1dev
32807 **/
32808function eio_poll(){}
32809
32810/**
32811 * Read from a file descriptor at given offset
32812 *
32813 * {@link eio_read} reads up to {@link length} bytes from {@link fd} file
32814 * descriptor at {@link offset}. The read bytes are stored in {@link
32815 * result} argument of {@link callback}.
32816 *
32817 * @param mixed $fd Stream, Socket resource, or numeric file descriptor
32818 * @param int $length Maximum number of bytes to read.
32819 * @param int $offset Offset within the file.
32820 * @param int $pri
32821 * @param callable $callback
32822 * @param mixed $data Arbitrary variable passed to {@link callback}.
32823 * @return resource {@link eio_read} stores read bytes in {@link
32824 *   result} argument of {@link callback} function.
32825 * @since PECL eio >= 0.0.1dev
32826 **/
32827function eio_read($fd, $length, $offset, $pri, $callback, $data){}
32828
32829/**
32830 * Perform file readahead into page cache
32831 *
32832 * {@link eio_readahead} populates the page cache with data from a file
32833 * so that subsequent reads from that file will not block on disk I/O.
32834 * See READAHEAD(2) man page for details.
32835 *
32836 * @param mixed $fd Stream, Socket resource, or numeric file descriptor
32837 * @param int $offset Starting point from which data is to be read.
32838 * @param int $length Number of bytes to be read.
32839 * @param int $pri
32840 * @param callable $callback
32841 * @param mixed $data Arbitrary variable passed to {@link callback}.
32842 * @return resource {@link eio_readahead} returns request resource on
32843 *   success or FALSE on error.
32844 * @since PECL eio >= 0.0.1dev
32845 **/
32846function eio_readahead($fd, $offset, $length, $pri, $callback, $data){}
32847
32848/**
32849 * Reads through a whole directory
32850 *
32851 * Reads through a whole directory(via the opendir, readdir and closedir
32852 * system calls) and returns either the names or an array in {@link
32853 * result} argument of {@link callback} function, depending on the {@link
32854 * flags} argument.
32855 *
32856 * @param string $path Directory path.
32857 * @param int $flags Combination of EIO_READDIR_* constants.
32858 * @param int $pri
32859 * @param callable $callback
32860 * @param string $data Arbitrary variable passed to {@link callback}.
32861 * @return resource {@link eio_readdir} returns request resource on
32862 *   success, or FALSE on error. Sets {@link result} argument of {@link
32863 *   callback} function according to {@link flags}:
32864 * @since PECL eio >= 0.0.1dev
32865 **/
32866function eio_readdir($path, $flags, $pri, $callback, $data){}
32867
32868/**
32869 * Read value of a symbolic link
32870 *
32871 * @param string $path Source symbolic link path
32872 * @param int $pri
32873 * @param callable $callback
32874 * @param string $data Arbitrary variable passed to {@link callback}.
32875 * @return resource {@link eio_readlink} returns request resource on
32876 *   success or FALSE on error.
32877 * @since PECL eio >= 0.0.1dev
32878 **/
32879function eio_readlink($path, $pri, $callback, $data){}
32880
32881/**
32882 * Get the canonicalized absolute pathname
32883 *
32884 * {@link eio_realpath} returns the canonicalized absolute pathname in
32885 * {@link result} argument of {@link callback} function.
32886 *
32887 * @param string $path Short pathname
32888 * @param int $pri
32889 * @param callable $callback
32890 * @param string $data
32891 * @return resource
32892 * @since PECL eio >= 0.0.1dev
32893 **/
32894function eio_realpath($path, $pri, $callback, $data){}
32895
32896/**
32897 * Change the name or location of a file
32898 *
32899 * {@link eio_rename} renames or moves a file to new location.
32900 *
32901 * @param string $path Source path
32902 * @param string $new_path Target path
32903 * @param int $pri
32904 * @param callable $callback
32905 * @param mixed $data Arbitrary variable passed to {@link callback}.
32906 * @return resource {@link eio_rename} returns request resource on
32907 *   success or FALSE on error.
32908 * @since PECL eio >= 0.0.1dev
32909 **/
32910function eio_rename($path, $new_path, $pri, $callback, $data){}
32911
32912/**
32913 * Remove a directory
32914 *
32915 * {@link eio_rmdir} removes a directory.
32916 *
32917 * @param string $path Directory path
32918 * @param int $pri
32919 * @param callable $callback
32920 * @param mixed $data Arbitrary variable passed to {@link callback}.
32921 * @return resource {@link eio_rmdir} returns request resource on
32922 *   success or FALSE on error.
32923 * @since PECL eio >= 0.0.1dev
32924 **/
32925function eio_rmdir($path, $pri, $callback, $data){}
32926
32927/**
32928 * Repositions the offset of the open file associated with the argument
32929 * to the argument according to the directive
32930 *
32931 * {@link eio_seek} repositions the offset of the open file associated
32932 * with stream, Socket resource, or file descriptor specified by {@link
32933 * fd} to the argument {@link offset} according to the directive {@link
32934 * whence} as follows: EIO_SEEK_SET - Set position equal to {@link
32935 * offset} bytes. EIO_SEEK_CUR - Set position to current location plus
32936 * {@link offset}. EIO_SEEK_END - Set position to end-of-file plus {@link
32937 * offset}.
32938 *
32939 * @param mixed $fd Stream, Socket resource, or numeric file descriptor
32940 * @param int $offset Starting point from which data is to be read.
32941 * @param int $whence Number of bytes to be read.
32942 * @param int $pri
32943 * @param callable $callback
32944 * @param mixed $data Arbitrary variable passed to {@link callback}.
32945 * @return resource {@link eio_seek} returns request resource on
32946 *   success or FALSE on error.
32947 * @since PECL eio >= 0.5.0b
32948 **/
32949function eio_seek($fd, $offset, $whence, $pri, $callback, $data){}
32950
32951/**
32952 * Transfer data between file descriptors
32953 *
32954 * {@link eio_sendfile} copies data between one file descriptor and
32955 * another. See SENDFILE(2) man page for details.
32956 *
32957 * @param mixed $out_fd Output stream, Socket resource, or file
32958 *   descriptor. Should be opened for writing.
32959 * @param mixed $in_fd Input stream, Socket resource, or file
32960 *   descriptor. Should be opened for reading.
32961 * @param int $offset Offset within the source file.
32962 * @param int $length Number of bytes to copy.
32963 * @param int $pri
32964 * @param callable $callback
32965 * @param string $data Arbitrary variable passed to {@link callback}.
32966 * @return resource {@link eio_sendfile} returns request resource on
32967 *   success or FALSE on error.
32968 * @since PECL eio >= 0.0.1dev
32969 **/
32970function eio_sendfile($out_fd, $in_fd, $offset, $length, $pri, $callback, $data){}
32971
32972/**
32973 * Set maximum number of idle threads
32974 *
32975 * @param int $nthreads Number of idle threads.
32976 * @return void
32977 * @since PECL eio >= 0.0.1dev
32978 **/
32979function eio_set_max_idle($nthreads){}
32980
32981/**
32982 * Set maximum parallel threads
32983 *
32984 * @param int $nthreads Number of parallel threads
32985 * @return void
32986 * @since PECL eio >= 0.0.1dev
32987 **/
32988function eio_set_max_parallel($nthreads){}
32989
32990/**
32991 * Set maximum number of requests processed in a poll
32992 *
32993 * @param int $nreqs Number of requests
32994 * @return void
32995 * @since PECL eio >= 0.0.1dev
32996 **/
32997function eio_set_max_poll_reqs($nreqs){}
32998
32999/**
33000 * Set maximum poll time
33001 *
33002 * Polling stops, if poll took longer than {@link nseconds} seconds.
33003 *
33004 * @param float $nseconds Number of seconds
33005 * @return void
33006 * @since PECL eio >= 0.0.1dev
33007 **/
33008function eio_set_max_poll_time($nseconds){}
33009
33010/**
33011 * Set minimum parallel thread number
33012 *
33013 * @param string $nthreads Number of parallel threads.
33014 * @return void
33015 * @since PECL eio >= 0.0.1dev
33016 **/
33017function eio_set_min_parallel($nthreads){}
33018
33019/**
33020 * Get file status
33021 *
33022 * {@link eio_stat} returns file status information in {@link result}
33023 * argument of {@link callback}
33024 *
33025 * @param string $path The file path
33026 * @param int $pri
33027 * @param callable $callback
33028 * @param mixed $data Arbitrary variable passed to {@link callback}.
33029 * @return resource {@link eio_stat} returns request resource on
33030 *   success or FALSE on error. On success assigns {@link result}
33031 *   argument of {@link callback} to an array.
33032 * @since PECL eio >= 0.0.1dev
33033 **/
33034function eio_stat($path, $pri, $callback, $data){}
33035
33036/**
33037 * Get file system statistics
33038 *
33039 * {@link eio_statvfs} returns file system statistics information in
33040 * {@link result} argument of {@link callback}
33041 *
33042 * @param string $path Pathname of any file within the mounted file
33043 *   system
33044 * @param int $pri
33045 * @param callable $callback
33046 * @param mixed $data Arbitrary variable passed to {@link callback}.
33047 * @return resource {@link eio_statvfs} returns request resource on
33048 *   success or FALSE on error. On success assigns {@link result}
33049 *   argument of {@link callback} to an array.
33050 * @since PECL eio >= 0.0.1dev
33051 **/
33052function eio_statvfs($path, $pri, $callback, $data){}
33053
33054/**
33055 * Create a symbolic link
33056 *
33057 * {@link eio_symlink} creates a symbolic link {@link new_path} to {@link
33058 * path}.
33059 *
33060 * @param string $path Source path
33061 * @param string $new_path Target path
33062 * @param int $pri
33063 * @param callable $callback
33064 * @param mixed $data Arbitrary variable passed to {@link callback}.
33065 * @return resource {@link eio_symlink} returns request resource on
33066 *   success or FALSE on error.
33067 * @since PECL eio >= 0.0.1dev
33068 **/
33069function eio_symlink($path, $new_path, $pri, $callback, $data){}
33070
33071/**
33072 * Commit buffer cache to disk
33073 *
33074 * @param int $pri
33075 * @param callable $callback
33076 * @param mixed $data
33077 * @return resource {@link eio_sync} returns request resource on
33078 *   success or FALSE on error.
33079 * @since PECL eio >= 0.0.1dev
33080 **/
33081function eio_sync($pri, $callback, $data){}
33082
33083/**
33084 * Calls Linux' syncfs syscall, if available
33085 *
33086 * @param mixed $fd File descriptor
33087 * @param int $pri
33088 * @param callable $callback
33089 * @param mixed $data Arbitrary variable passed to {@link callback}.
33090 * @return resource {@link eio_syncfs} returns request resource on
33091 *   success or FALSE on error.
33092 * @since PECL eio >= 0.0.1dev
33093 **/
33094function eio_syncfs($fd, $pri, $callback, $data){}
33095
33096/**
33097 * Sync a file segment with disk
33098 *
33099 * {@link eio_sync_file_range} permits fine control when synchronizing
33100 * the open file referred to by the file descriptor {@link fd} with disk.
33101 *
33102 * @param mixed $fd File descriptor
33103 * @param int $offset The starting byte of the file range to be
33104 *   synchronized
33105 * @param int $nbytes Specifies the length of the range to be
33106 *   synchronized, in bytes. If {@link nbytes} is zero, then all bytes
33107 *   from {@link offset} through to the end of file are synchronized.
33108 * @param int $flags A bit-mask. Can include any of the following
33109 *   values: EIO_SYNC_FILE_RANGE_WAIT_BEFORE, EIO_SYNC_FILE_RANGE_WRITE,
33110 *   EIO_SYNC_FILE_RANGE_WAIT_AFTER. These flags have the same meaning as
33111 *   their SYNC_FILE_RANGE_* counterparts(see SYNC_FILE_RANGE(2) man
33112 *   page).
33113 * @param int $pri
33114 * @param callable $callback
33115 * @param mixed $data Arbitrary variable passed to {@link callback}.
33116 * @return resource {@link eio_sync_file_range} returns request
33117 *   resource on success or FALSE on error.
33118 * @since PECL eio >= 0.0.1dev
33119 **/
33120function eio_sync_file_range($fd, $offset, $nbytes, $flags, $pri, $callback, $data){}
33121
33122/**
33123 * Truncate a file
33124 *
33125 * {@link eio_truncate} causes the regular file named by {@link path} to
33126 * be truncated to a size of precisely {@link length} bytes
33127 *
33128 * @param string $path File path
33129 * @param int $offset Offset from beginning of the file.
33130 * @param int $pri
33131 * @param callable $callback
33132 * @param mixed $data Arbitrary variable passed to {@link callback}.
33133 * @return resource {@link eio_busy} returns request resource on
33134 *   success or FALSE on error.
33135 * @since PECL eio >= 0.0.1dev
33136 **/
33137function eio_truncate($path, $offset, $pri, $callback, $data){}
33138
33139/**
33140 * Delete a name and possibly the file it refers to
33141 *
33142 * {@link eio_unlink} deletes a name from the file system.
33143 *
33144 * @param string $path Path to file
33145 * @param int $pri
33146 * @param callable $callback
33147 * @param mixed $data Arbitrary variable passed to {@link callback}.
33148 * @return resource {@link eio_unlink} returns request resource on
33149 *   success or FALSE on error.
33150 * @since PECL eio >= 0.0.1dev
33151 **/
33152function eio_unlink($path, $pri, $callback, $data){}
33153
33154/**
33155 * Change file last access and modification times
33156 *
33157 * @param string $path Path to the file.
33158 * @param float $atime Access time
33159 * @param float $mtime Modification time
33160 * @param int $pri
33161 * @param callable $callback
33162 * @param mixed $data Arbitrary variable passed to {@link callback}.
33163 * @return resource {@link eio_utime} returns request resource on
33164 *   success or FALSE on error.
33165 * @since PECL eio >= 0.0.1dev
33166 **/
33167function eio_utime($path, $atime, $mtime, $pri, $callback, $data){}
33168
33169/**
33170 * Write to file
33171 *
33172 * {@link eio_write} writes up to {@link length} bytes from {@link str}
33173 * at {@link offset} offset from the beginning of the file.
33174 *
33175 * @param mixed $fd Stream, Socket resource, or numeric file
33176 *   descriptor, e.g. returned by {@link eio_open}
33177 * @param string $str Source string
33178 * @param int $length Maximum number of bytes to write.
33179 * @param int $offset Offset from the beginning of file.
33180 * @param int $pri
33181 * @param callable $callback
33182 * @param mixed $data Arbitrary variable passed to {@link callback}.
33183 * @return resource {@link eio_write} returns request resource on
33184 *   success or FALSE on error.
33185 * @since PECL eio >= 0.0.1dev
33186 **/
33187function eio_write($fd, $str, $length, $offset, $pri, $callback, $data){}
33188
33189/**
33190 * Enumerates the Enchant providers
33191 *
33192 * Enumerates the Enchant providers and tells you some rudimentary
33193 * information about them. The same info is provided through phpinfo().
33194 *
33195 * @param resource $broker Broker resource
33196 * @return array Returns an of available Enchant providers with their
33197 *   details, .
33198 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 0.1.0
33199 **/
33200function enchant_broker_describe($broker){}
33201
33202/**
33203 * Whether a dictionary exists or not. Using non-empty tag
33204 *
33205 * Tells if a dictionary exists or not, using a non-empty tags
33206 *
33207 * @param resource $broker Broker resource
33208 * @param string $tag non-empty tag in the LOCALE format, ex: us_US,
33209 *   ch_DE, etc.
33210 * @return bool Returns TRUE when the tag exist or FALSE when not.
33211 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 0.1.0
33212 **/
33213function enchant_broker_dict_exists($broker, $tag){}
33214
33215/**
33216 * Free the broker resource and its dictionaries
33217 *
33218 * Free a broker resource with all its dictionaries.
33219 *
33220 * @param resource $broker Broker resource
33221 * @return bool
33222 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 0.1.0
33223 **/
33224function enchant_broker_free($broker){}
33225
33226/**
33227 * Free a dictionary resource
33228 *
33229 * @param resource $dict Dictionary resource.
33230 * @return bool
33231 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 0.1.0
33232 **/
33233function enchant_broker_free_dict($dict){}
33234
33235/**
33236 * Get the directory path for a given backend
33237 *
33238 * @param resource $broker Broker resource.
33239 * @param int $dict_type The type of the dictionaries, i.e.
33240 *   ENCHANT_MYSPELL or ENCHANT_ISPELL.
33241 * @return bool Returns the path of the dictionary directory on
33242 *   success.
33243 * @since PHP 5 >= 5.3.1, PHP 7, PECL enchant >= 1.0.1
33244 **/
33245function enchant_broker_get_dict_path($broker, $dict_type){}
33246
33247/**
33248 * Returns the last error of the broker
33249 *
33250 * Returns the last error which occurred in this broker.
33251 *
33252 * @param resource $broker Broker resource.
33253 * @return string Return the msg string if an error was found or FALSE
33254 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 0.1.0
33255 **/
33256function enchant_broker_get_error($broker){}
33257
33258/**
33259 * Create a new broker object capable of requesting
33260 *
33261 * @return resource Returns a broker resource on success or FALSE.
33262 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 0.1.0
33263 **/
33264function enchant_broker_init(){}
33265
33266/**
33267 * Returns a list of available dictionaries
33268 *
33269 * Returns a list of available dictionaries with their details.
33270 *
33271 * @param resource $broker Broker resource
33272 * @return mixed Returns an of available dictionaries with their
33273 *   details, .
33274 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 1.0.1
33275 **/
33276function enchant_broker_list_dicts($broker){}
33277
33278/**
33279 * Create a new dictionary using a tag
33280 *
33281 * create a new dictionary using tag, the non-empty language tag you wish
33282 * to request a dictionary for ("en_US", "de_DE", ...)
33283 *
33284 * @param resource $broker Broker resource
33285 * @param string $tag A tag describing the locale, for example en_US,
33286 *   de_DE
33287 * @return resource Returns a dictionary resource on success.
33288 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 0.1.0
33289 **/
33290function enchant_broker_request_dict($broker, $tag){}
33291
33292/**
33293 * Creates a dictionary using a PWL file
33294 *
33295 * Creates a dictionary using a PWL file. A PWL file is personal word
33296 * file one word per line.
33297 *
33298 * @param resource $broker Broker resource
33299 * @param string $filename Path to the PWL file. If there is no such
33300 *   file, a new one will be created if possible.
33301 * @return resource Returns a dictionary resource on success.
33302 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 0.1.0
33303 **/
33304function enchant_broker_request_pwl_dict($broker, $filename){}
33305
33306/**
33307 * Set the directory path for a given backend
33308 *
33309 * @param resource $broker Broker resource.
33310 * @param int $dict_type The type of the dictionaries, i.e.
33311 *   ENCHANT_MYSPELL or ENCHANT_ISPELL.
33312 * @param string $value The path of the dictionary directory.
33313 * @return bool
33314 * @since PHP 5 >= 5.3.1, PHP 7, PECL enchant >= 1.0.1
33315 **/
33316function enchant_broker_set_dict_path($broker, $dict_type, $value){}
33317
33318/**
33319 * Declares a preference of dictionaries to use for the language
33320 *
33321 * Declares a preference of dictionaries to use for the language
33322 * described/referred to by 'tag'. The ordering is a comma delimited list
33323 * of provider names. As a special exception, the "*" tag can be used as
33324 * a language tag to declare a default ordering for any language that
33325 * does not explicitly declare an ordering.
33326 *
33327 * @param resource $broker Broker resource
33328 * @param string $tag Language tag. The special "*" tag can be used as
33329 *   a language tag to declare a default ordering for any language that
33330 *   does not explicitly declare an ordering.
33331 * @param string $ordering Comma delimited list of provider names
33332 * @return bool
33333 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 0.1.0
33334 **/
33335function enchant_broker_set_ordering($broker, $tag, $ordering){}
33336
33337/**
33338 * Add a word to personal word list
33339 *
33340 * Add a word to personal word list of the given dictionary.
33341 *
33342 * @param resource $dict Dictionary resource
33343 * @param string $word The word to add
33344 * @return void
33345 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 0.1.0
33346 **/
33347function enchant_dict_add_to_personal($dict, $word){}
33348
33349/**
33350 * Add 'word' to this spell-checking session
33351 *
33352 * Add a word to the given dictionary. It will be added only for the
33353 * active spell-checking session.
33354 *
33355 * @param resource $dict Dictionary resource
33356 * @param string $word The word to add
33357 * @return void
33358 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 0.1.0
33359 **/
33360function enchant_dict_add_to_session($dict, $word){}
33361
33362/**
33363 * Check whether a word is correctly spelled or not
33364 *
33365 * If the word is correctly spelled return TRUE, otherwise return FALSE
33366 *
33367 * @param resource $dict Dictionary resource
33368 * @param string $word The word to check
33369 * @return bool Returns TRUE if the word is spelled correctly, FALSE if
33370 *   not.
33371 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 0.1.0
33372 **/
33373function enchant_dict_check($dict, $word){}
33374
33375/**
33376 * Describes an individual dictionary
33377 *
33378 * Returns the details of the dictionary.
33379 *
33380 * @param resource $dict Dictionary resource
33381 * @return mixed
33382 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 0.1.0
33383 **/
33384function enchant_dict_describe($dict){}
33385
33386/**
33387 * Returns the last error of the current spelling-session
33388 *
33389 * @param resource $dict Dictinaray resource
33390 * @return string Returns the error message as string or FALSE if no
33391 *   error occurred.
33392 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 0.1.0
33393 **/
33394function enchant_dict_get_error($dict){}
33395
33396/**
33397 * Whether or not 'word' exists in this spelling-session
33398 *
33399 * Tells whether or not a word already exists in the current session.
33400 *
33401 * @param resource $dict Dictionary resource
33402 * @param string $word The word to lookup
33403 * @return bool Returns TRUE if the word exists or FALSE
33404 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 0.1.0
33405 **/
33406function enchant_dict_is_in_session($dict, $word){}
33407
33408/**
33409 * Check the word is correctly spelled and provide suggestions
33410 *
33411 * If the word is correctly spelled return TRUE, otherwise return FALSE,
33412 * if suggestions variable is provided, fill it with spelling
33413 * alternatives.
33414 *
33415 * @param resource $dict Dictionary resource
33416 * @param string $word The word to check
33417 * @param array $suggestions If the word is not correctly spelled, this
33418 *   variable will contain an array of suggestions.
33419 * @return bool Returns TRUE if the word is correctly spelled or FALSE
33420 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant:0.2.0-1.0.1
33421 **/
33422function enchant_dict_quick_check($dict, $word, &$suggestions){}
33423
33424/**
33425 * Add a correction for a word
33426 *
33427 * Add a correction for 'mis' using 'cor'. Notes that you replaced @mis
33428 * with @cor, so it's possibly more likely that future occurrences of
33429 * @mis will be replaced with @cor. So it might bump @cor up in the
33430 * suggestion list.
33431 *
33432 * @param resource $dict Dictionary resource
33433 * @param string $mis The work to fix
33434 * @param string $cor The correct word
33435 * @return void
33436 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 0.1.0
33437 **/
33438function enchant_dict_store_replacement($dict, $mis, $cor){}
33439
33440/**
33441 * Will return a list of values if any of those pre-conditions are not
33442 * met
33443 *
33444 * @param resource $dict Dictionary resource
33445 * @param string $word Word to use for the suggestions.
33446 * @return array Will returns an array of suggestions if the word is
33447 *   bad spelled.
33448 * @since PHP 5 >= 5.3.0, PHP 7, PECL enchant >= 0.1.0
33449 **/
33450function enchant_dict_suggest($dict, $word){}
33451
33452/**
33453 * Set the internal pointer of an array to its last element
33454 *
33455 * {@link end} advances {@link array}'s internal pointer to the last
33456 * element, and returns its value.
33457 *
33458 * @param array $array The array. This array is passed by reference
33459 *   because it is modified by the function. This means you must pass it
33460 *   a real variable and not a function returning an array because only
33461 *   actual variables may be passed by reference.
33462 * @return mixed Returns the value of the last element or FALSE for
33463 *   empty array.
33464 * @since PHP 4, PHP 5, PHP 7
33465 **/
33466function end(&$array){}
33467
33468/**
33469 * Regular expression match
33470 *
33471 * @param string $pattern Case sensitive regular expression.
33472 * @param string $string The input string.
33473 * @param array $regs If matches are found for parenthesized substrings
33474 *   of {@link pattern} and the function is called with the third
33475 *   argument {@link regs}, the matches will be stored in the elements of
33476 *   the array {@link regs}. $regs[1] will contain the substring which
33477 *   starts at the first left parenthesis; $regs[2] will contain the
33478 *   substring starting at the second, and so on. $regs[0] will contain a
33479 *   copy of the complete string matched.
33480 * @return int Returns the length of the matched string if a match for
33481 *   {@link pattern} was found in {@link string}, or FALSE if no matches
33482 *   were found or an error occurred.
33483 * @since PHP 4, PHP 5
33484 **/
33485function ereg($pattern, $string, &$regs){}
33486
33487/**
33488 * Case insensitive regular expression match
33489 *
33490 * This function is identical to {@link ereg} except that it ignores case
33491 * distinction when matching alphabetic characters.
33492 *
33493 * @param string $pattern Case insensitive regular expression.
33494 * @param string $string The input string.
33495 * @param array $regs If matches are found for parenthesized substrings
33496 *   of {@link pattern} and the function is called with the third
33497 *   argument {@link regs}, the matches will be stored in the elements of
33498 *   the array {@link regs}. $regs[1] will contain the substring which
33499 *   starts at the first left parenthesis; $regs[2] will contain the
33500 *   substring starting at the second, and so on. $regs[0] will contain a
33501 *   copy of the complete string matched.
33502 * @return int Returns the length of the matched string if a match for
33503 *   {@link pattern} was found in {@link string}, or FALSE if no matches
33504 *   were found or an error occurred.
33505 * @since PHP 4, PHP 5
33506 **/
33507function eregi($pattern, $string, &$regs){}
33508
33509/**
33510 * Replace regular expression case insensitive
33511 *
33512 * This function is identical to {@link ereg_replace} except that this
33513 * ignores case distinction when matching alphabetic characters.
33514 *
33515 * @param string $pattern A POSIX extended regular expression.
33516 * @param string $replacement If {@link pattern} contains parenthesized
33517 *   substrings, {@link replacement} may contain substrings of the form
33518 *   \digit, which will be replaced by the text matching the digit'th
33519 *   parenthesized substring; \0 will produce the entire contents of
33520 *   string. Up to nine substrings may be used. Parentheses may be
33521 *   nested, in which case they are counted by the opening parenthesis.
33522 * @param string $string The input string.
33523 * @return string The modified string is returned. If no matches are
33524 *   found in {@link string}, then it will be returned unchanged.
33525 * @since PHP 4, PHP 5
33526 **/
33527function eregi_replace($pattern, $replacement, $string){}
33528
33529/**
33530 * Replace regular expression
33531 *
33532 * @param string $pattern A POSIX extended regular expression.
33533 * @param string $replacement If {@link pattern} contains parenthesized
33534 *   substrings, {@link replacement} may contain substrings of the form
33535 *   \digit, which will be replaced by the text matching the digit'th
33536 *   parenthesized substring; \0 will produce the entire contents of
33537 *   string. Up to nine substrings may be used. Parentheses may be
33538 *   nested, in which case they are counted by the opening parenthesis.
33539 * @param string $string The input string.
33540 * @return string The modified string is returned. If no matches are
33541 *   found in {@link string}, then it will be returned unchanged.
33542 * @since PHP 4, PHP 5
33543 **/
33544function ereg_replace($pattern, $replacement, $string){}
33545
33546/**
33547 * Clear the most recent error
33548 *
33549 * @return void Clears the most recent errors, making it unable to be
33550 *   retrieved with {@link error_get_last}.
33551 * @since PHP 7
33552 **/
33553function error_clear_last(){}
33554
33555/**
33556 * Get the last occurred error
33557 *
33558 * Gets information about the last error that occurred.
33559 *
33560 * @return array Returns an associative array describing the last error
33561 *   with keys "type", "message", "file" and "line". If the error has
33562 *   been caused by a PHP internal function then the "message" begins
33563 *   with its name. Returns NULL if there hasn't been an error yet.
33564 * @since PHP 5 >= 5.2.0, PHP 7
33565 **/
33566function error_get_last(){}
33567
33568/**
33569 * Send an error message to the defined error handling routines
33570 *
33571 * Sends an error message to the web server's error log or to a file.
33572 *
33573 * @param string $message The error message that should be logged.
33574 * @param int $message_type Says where the error should go. The
33575 *   possible message types are as follows:
33576 *
33577 *   {@link error_log} log types 0 {@link message} is sent to PHP's
33578 *   system logger, using the Operating System's system logging mechanism
33579 *   or a file, depending on what the error_log configuration directive
33580 *   is set to. This is the default option. 1 {@link message} is sent by
33581 *   email to the address in the {@link destination} parameter. This is
33582 *   the only message type where the fourth parameter, {@link
33583 *   extra_headers} is used. 2 No longer an option. 3 {@link message} is
33584 *   appended to the file {@link destination}. A newline is not
33585 *   automatically added to the end of the {@link message} string. 4
33586 *   {@link message} is sent directly to the SAPI logging handler.
33587 * @param string $destination The destination. Its meaning depends on
33588 *   the {@link message_type} parameter as described above.
33589 * @param string $extra_headers The extra headers. It's used when the
33590 *   {@link message_type} parameter is set to 1. This message type uses
33591 *   the same internal function as {@link mail} does.
33592 * @return bool
33593 * @since PHP 4, PHP 5, PHP 7
33594 **/
33595function error_log($message, $message_type, $destination, $extra_headers){}
33596
33597/**
33598 * Sets which PHP errors are reported
33599 *
33600 * The {@link error_reporting} function sets the error_reporting
33601 * directive at runtime. PHP has many levels of errors, using this
33602 * function sets that level for the duration (runtime) of your script. If
33603 * the optional {@link level} is not set, {@link error_reporting} will
33604 * just return the current error reporting level.
33605 *
33606 * @param int $level The new error_reporting level. It takes on either
33607 *   a bitmask, or named constants. Using named constants is strongly
33608 *   encouraged to ensure compatibility for future versions. As error
33609 *   levels are added, the range of integers increases, so older
33610 *   integer-based error levels will not always behave as expected. The
33611 *   available error level constants and the actual meanings of these
33612 *   error levels are described in the predefined constants.
33613 * @return int Returns the old error_reporting level or the current
33614 *   level if no {@link level} parameter is given.
33615 * @since PHP 4, PHP 5, PHP 7
33616 **/
33617function error_reporting($level){}
33618
33619/**
33620 * Escape a string to be used as a shell argument
33621 *
33622 * {@link escapeshellarg} adds single quotes around a string and
33623 * quotes/escapes any existing single quotes allowing you to pass a
33624 * string directly to a shell function and having it be treated as a
33625 * single safe argument. This function should be used to escape
33626 * individual arguments to shell functions coming from user input. The
33627 * shell functions include {@link exec}, {@link system} and the backtick
33628 * operator.
33629 *
33630 * On Windows, {@link escapeshellarg} instead replaces percent signs,
33631 * exclamation marks (delayed variable substitution) and double quotes
33632 * with spaces and adds double quotes around the string.
33633 *
33634 * @param string $arg The argument that will be escaped.
33635 * @return string The escaped string.
33636 * @since PHP 4 >= 4.0.3, PHP 5, PHP 7
33637 **/
33638function escapeshellarg($arg){}
33639
33640/**
33641 * Escape shell metacharacters
33642 *
33643 * {@link escapeshellcmd} escapes any characters in a string that might
33644 * be used to trick a shell command into executing arbitrary commands.
33645 * This function should be used to make sure that any data coming from
33646 * user input is escaped before this data is passed to the {@link exec}
33647 * or {@link system} functions, or to the backtick operator.
33648 *
33649 * Following characters are preceded by a backslash: &#;`|*?~<>^()[]{}$\,
33650 * \x0A and \xFF. ' and " are escaped only if they are not paired. On
33651 * Windows, all these characters plus % and ! are preceded by a caret
33652 * (^).
33653 *
33654 * @param string $command The command that will be escaped.
33655 * @return string The escaped string.
33656 * @since PHP 4, PHP 5, PHP 7
33657 **/
33658function escapeshellcmd($command){}
33659
33660/**
33661 * Add an event to the set of monitored events
33662 *
33663 * {@link event_add} schedules the execution of the {@link event} when
33664 * the event specified in {@link event_set} occurs or in at least the
33665 * time specified by the {@link timeout} argument. If {@link timeout} was
33666 * not specified, not timeout is set. The {@link event} must be already
33667 * initalized by {@link event_set} and {@link event_base_set} functions.
33668 * If the {@link event} already has a timeout set, it is replaced by the
33669 * new one.
33670 *
33671 * @param resource $event Valid event resource.
33672 * @param int $timeout Optional timeout (in microseconds).
33673 * @return bool {@link event_add} returns TRUE on success or FALSE on
33674 *   error.
33675 * @since PECL libevent >= 0.0.1
33676 **/
33677function event_add($event, $timeout){}
33678
33679/**
33680 * Destroy event base
33681 *
33682 * Destroys the specified {@link event_base} and frees all the resources
33683 * associated. Note that it's not possible to destroy an event base with
33684 * events attached to it.
33685 *
33686 * @param resource $event_base Valid event base resource.
33687 * @return void
33688 * @since PECL libevent >= 0.0.1
33689 **/
33690function event_base_free($event_base){}
33691
33692/**
33693 * Handle events
33694 *
33695 * Starts event loop for the specified event base.
33696 *
33697 * @param resource $event_base Valid event base resource.
33698 * @param int $flags Optional parameter, which can take any combination
33699 *   of EVLOOP_ONCE and EVLOOP_NONBLOCK.
33700 * @return int {@link event_base_loop} returns 0 on success, -1 on
33701 *   error and 1 if no events were registered.
33702 * @since PECL libevent >= 0.0.1
33703 **/
33704function event_base_loop($event_base, $flags){}
33705
33706/**
33707 * Abort event loop
33708 *
33709 * Abort the active event loop immediately. The behaviour is similar to
33710 * break statement.
33711 *
33712 * @param resource $event_base Valid event base resource.
33713 * @return bool {@link event_base_loopbreak} returns TRUE on success or
33714 *   FALSE on error.
33715 * @since PECL libevent >= 0.0.1
33716 **/
33717function event_base_loopbreak($event_base){}
33718
33719/**
33720 * Exit loop after a time
33721 *
33722 * The next event loop iteration after the given timer expires will
33723 * complete normally, then exit without blocking for events again.
33724 *
33725 * @param resource $event_base Valid event base resource.
33726 * @param int $timeout Optional timeout parameter (in microseconds).
33727 * @return bool {@link event_base_loopexit} returns TRUE on success or
33728 *   FALSE on error.
33729 * @since PECL libevent >= 0.0.1
33730 **/
33731function event_base_loopexit($event_base, $timeout){}
33732
33733/**
33734 * Create and initialize new event base
33735 *
33736 * Returns new event base, which can be used later in {@link
33737 * event_base_set}, {@link event_base_loop} and other functions.
33738 *
33739 * @return resource {@link event_base_new} returns valid event base
33740 *   resource on success or FALSE on error.
33741 * @since PECL libevent >= 0.0.1
33742 **/
33743function event_base_new(){}
33744
33745/**
33746 * Set the number of event priority levels
33747 *
33748 * Sets the number of different event priority levels.
33749 *
33750 * By default all events are scheduled with the same priority ({@link
33751 * npriorities}/2). Using {@link event_base_priority_init} you can change
33752 * the number of event priority levels and then set a desired priority
33753 * for each event.
33754 *
33755 * @param resource $event_base Valid event base resource.
33756 * @param int $npriorities The number of event priority levels.
33757 * @return bool {@link event_base_priority_init} returns TRUE on
33758 *   success or FALSE on error.
33759 * @since PECL libevent >= 0.0.2
33760 **/
33761function event_base_priority_init($event_base, $npriorities){}
33762
33763/**
33764 * Reinitialize the event base after a fork
33765 *
33766 * Some event mechanisms do not survive across fork. The {@link
33767 * event_base} needs to be reinitialized with this function.
33768 *
33769 * @param resource $event_base Valid event base resource that needs to
33770 *   be re-initialized.
33771 * @return bool
33772 * @since PECL libevent >= 0.1.0
33773 **/
33774function event_base_reinit($event_base){}
33775
33776/**
33777 * Associate event base with an event
33778 *
33779 * Associates the {@link event_base} with the {@link event}.
33780 *
33781 * @param resource $event Valid event resource.
33782 * @param resource $event_base Valid event base resource.
33783 * @return bool {@link event_base_set} returns TRUE on success or FALSE
33784 *   on error.
33785 * @since PECL libevent >= 0.0.1
33786 **/
33787function event_base_set($event, $event_base){}
33788
33789/**
33790 * Associate buffered event with an event base
33791 *
33792 * Assign the specified {@link bevent} to the {@link event_base}.
33793 *
33794 * @param resource $bevent Valid buffered event resource.
33795 * @param resource $event_base Valid event base resource.
33796 * @return bool {@link event_buffer_base_set} returns TRUE on success
33797 *   or FALSE on error.
33798 * @since PECL libevent >= 0.0.1
33799 **/
33800function event_buffer_base_set($bevent, $event_base){}
33801
33802/**
33803 * Disable a buffered event
33804 *
33805 * Disables the specified buffered event.
33806 *
33807 * @param resource $bevent Valid buffered event resource.
33808 * @param int $events Any combination of EV_READ and EV_WRITE.
33809 * @return bool {@link event_buffer_disable} returns TRUE on success or
33810 *   FALSE on error.
33811 * @since PECL libevent >= 0.0.1
33812 **/
33813function event_buffer_disable($bevent, $events){}
33814
33815/**
33816 * Enable a buffered event
33817 *
33818 * Enables the specified buffered event.
33819 *
33820 * @param resource $bevent Valid buffered event resource.
33821 * @param int $events Any combination of EV_READ and EV_WRITE.
33822 * @return bool {@link event_buffer_enable} returns TRUE on success or
33823 *   FALSE on error.
33824 * @since PECL libevent >= 0.0.1
33825 **/
33826function event_buffer_enable($bevent, $events){}
33827
33828/**
33829 * Change a buffered event file descriptor
33830 *
33831 * Changes the file descriptor on which the buffered event operates.
33832 *
33833 * @param resource $bevent Valid buffered event resource.
33834 * @param resource $fd Valid PHP stream, must be castable to file
33835 *   descriptor.
33836 * @return void
33837 * @since PECL libevent >= 0.0.1
33838 **/
33839function event_buffer_fd_set($bevent, $fd){}
33840
33841/**
33842 * Destroy buffered event
33843 *
33844 * Destroys the specified buffered event and frees all the resources
33845 * associated.
33846 *
33847 * @param resource $bevent Valid buffered event resource.
33848 * @return void
33849 * @since PECL libevent >= 0.0.1
33850 **/
33851function event_buffer_free($bevent){}
33852
33853/**
33854 * Create new buffered event
33855 *
33856 * Libevent provides an abstraction layer on top of the regular event
33857 * API. Using buffered event you don't need to deal with the I/O
33858 * manually, instead it provides input and output buffers that get filled
33859 * and drained automatically.
33860 *
33861 * @param resource $stream Valid PHP stream resource. Must be castable
33862 *   to file descriptor.
33863 * @param mixed $readcb Callback to invoke where there is data to read,
33864 *   or NULL if no callback is desired.
33865 * @param mixed $writecb Callback to invoke where the descriptor is
33866 *   ready for writing, or NULL if no callback is desired.
33867 * @param mixed $errorcb Callback to invoke where there is an error on
33868 *   the descriptor, cannot be NULL.
33869 * @param mixed $arg An argument that will be passed to each of the
33870 *   callbacks (optional).
33871 * @return resource {@link event_buffer_new} returns new buffered event
33872 *   resource on success or FALSE on error.
33873 * @since PECL libevent >= 0.0.1
33874 **/
33875function event_buffer_new($stream, $readcb, $writecb, $errorcb, $arg){}
33876
33877/**
33878 * Assign a priority to a buffered event
33879 *
33880 * Assign a priority to the {@link bevent}.
33881 *
33882 * @param resource $bevent Valid buffered event resource.
33883 * @param int $priority Priority level. Cannot be less than zero and
33884 *   cannot exceed maximum priority level of the event base (see {@link
33885 *   event_base_priority_init}).
33886 * @return bool {@link event_buffer_priority_set} returns TRUE on
33887 *   success or FALSE on error.
33888 * @since PECL libevent >= 0.0.1
33889 **/
33890function event_buffer_priority_set($bevent, $priority){}
33891
33892/**
33893 * Read data from a buffered event
33894 *
33895 * Reads data from the input buffer of the buffered event.
33896 *
33897 * @param resource $bevent Valid buffered event resource.
33898 * @param int $data_size Data size in bytes.
33899 * @return string
33900 * @since PECL libevent >= 0.0.1
33901 **/
33902function event_buffer_read($bevent, $data_size){}
33903
33904/**
33905 * Set or reset callbacks for a buffered event
33906 *
33907 * Sets or changes existing callbacks for the buffered {@link event}.
33908 *
33909 * @param resource $event Valid buffered event resource.
33910 * @param mixed $readcb Callback to invoke where there is data to read,
33911 *   or NULL if no callback is desired.
33912 * @param mixed $writecb Callback to invoke where the descriptor is
33913 *   ready for writing, or NULL if no callback is desired.
33914 * @param mixed $errorcb Callback to invoke where there is an error on
33915 *   the descriptor, cannot be NULL.
33916 * @param mixed $arg An argument that will be passed to each of the
33917 *   callbacks (optional).
33918 * @return bool
33919 * @since PECL libevent >= 0.0.4
33920 **/
33921function event_buffer_set_callback($event, $readcb, $writecb, $errorcb, $arg){}
33922
33923/**
33924 * Set read and write timeouts for a buffered event
33925 *
33926 * Sets the read and write timeouts for the specified buffered event.
33927 *
33928 * @param resource $bevent Valid buffered event resource.
33929 * @param int $read_timeout Read timeout (in seconds).
33930 * @param int $write_timeout Write timeout (in seconds).
33931 * @return void
33932 * @since PECL libevent >= 0.0.1
33933 **/
33934function event_buffer_timeout_set($bevent, $read_timeout, $write_timeout){}
33935
33936/**
33937 * Set the watermarks for read and write events
33938 *
33939 * Sets the watermarks for read and write events. Libevent does not
33940 * invoke read callback unless there is at least {@link lowmark} bytes in
33941 * the input buffer; if the read buffer is beyond the {@link highmark},
33942 * reading is stopped. On output, the write callback is invoked whenever
33943 * the buffered data falls below the {@link lowmark}.
33944 *
33945 * @param resource $bevent Valid buffered event resource.
33946 * @param int $events Any combination of EV_READ and EV_WRITE.
33947 * @param int $lowmark Low watermark.
33948 * @param int $highmark High watermark.
33949 * @return void
33950 * @since PECL libevent >= 0.0.1
33951 **/
33952function event_buffer_watermark_set($bevent, $events, $lowmark, $highmark){}
33953
33954/**
33955 * Write data to a buffered event
33956 *
33957 * Writes data to the specified buffered event. The data is appended to
33958 * the output buffer and written to the descriptor when it becomes
33959 * available for writing.
33960 *
33961 * @param resource $bevent Valid buffered event resource.
33962 * @param string $data The data to be written.
33963 * @param int $data_size Optional size parameter. {@link
33964 *   event_buffer_write} writes all the {@link data} by default.
33965 * @return bool {@link event_buffer_write} returns TRUE on success or
33966 *   FALSE on error.
33967 * @since PECL libevent >= 0.0.1
33968 **/
33969function event_buffer_write($bevent, $data, $data_size){}
33970
33971/**
33972 * Remove an event from the set of monitored events
33973 *
33974 * Cancels the {@link event}.
33975 *
33976 * @param resource $event Valid event resource.
33977 * @return bool {@link event_del} returns TRUE on success or FALSE on
33978 *   error.
33979 * @since PECL libevent >= 0.0.1
33980 **/
33981function event_del($event){}
33982
33983/**
33984 * Free event resource
33985 *
33986 * Frees previously created event resource.
33987 *
33988 * @param resource $event Valid event resource.
33989 * @return void
33990 * @since PECL libevent >= 0.0.1
33991 **/
33992function event_free($event){}
33993
33994/**
33995 * Create new event
33996 *
33997 * Creates and returns a new event resource.
33998 *
33999 * @return resource {@link event_new} returns a new event resource on
34000 *   success or FALSE on error.
34001 * @since PECL libevent >= 0.0.1
34002 **/
34003function event_new(){}
34004
34005/**
34006 * Assign a priority to an event
34007 *
34008 * Assign a priority to the {@link event}.
34009 *
34010 * @param resource $event Valid event resource.
34011 * @param int $priority Priority level. Cannot be less than zero and
34012 *   cannot exceed maximum priority level of the event base (see {@link
34013 *   event_base_priority_init}).
34014 * @return bool
34015 * @since PECL libevent >= 0.0.5
34016 **/
34017function event_priority_set($event, $priority){}
34018
34019/**
34020 * Prepare an event
34021 *
34022 * Prepares the event to be used in {@link event_add}. The event is
34023 * prepared to call the function specified by the {@link callback} on the
34024 * events specified in parameter {@link events}, which is a set of the
34025 * following flags: EV_TIMEOUT, EV_SIGNAL, EV_READ, EV_WRITE and
34026 * EV_PERSIST.
34027 *
34028 * If EV_SIGNAL bit is set in parameter {@link events}, the {@link fd} is
34029 * interpreted as signal number.
34030 *
34031 * After initializing the event, use {@link event_base_set} to associate
34032 * the event with its event base.
34033 *
34034 * In case of matching event, these three arguments are passed to the
34035 * {@link callback} function: {@link fd} Signal number or resource
34036 * indicating the stream. {@link events} A flag indicating the event.
34037 * Consists of the following flags: EV_TIMEOUT, EV_SIGNAL, EV_READ,
34038 * EV_WRITE and EV_PERSIST. {@link arg} Optional parameter, previously
34039 * passed to {@link event_set} as {@link arg}.
34040 *
34041 * @param resource $event Valid event resource.
34042 * @param mixed $fd Valid PHP stream resource. The stream must be
34043 *   castable to file descriptor, so you most likely won't be able to use
34044 *   any of filtered streams.
34045 * @param int $events A set of flags indicating the desired event, can
34046 *   be EV_READ and/or EV_WRITE. The additional flag EV_PERSIST makes the
34047 *   event to persist until {@link event_del} is called, otherwise the
34048 *   callback is invoked only once.
34049 * @param mixed $callback Callback function to be called when the
34050 *   matching event occurs.
34051 * @param mixed $arg Optional callback parameter.
34052 * @return bool {@link event_set} returns TRUE on success or FALSE on
34053 *   error.
34054 * @since PECL libevent >= 0.0.1
34055 **/
34056function event_set($event, $fd, $events, $callback, $arg){}
34057
34058/**
34059 * Add an event to the set of monitored events
34060 *
34061 * {@link event_timer_add} schedules the execution of the {@link event}
34062 * when the event specified in {@link event_set} occurs or in at least
34063 * the time specified by the {@link timeout} argument. If {@link timeout}
34064 * was not specified, not timeout is set. The {@link event} must be
34065 * already initalized by {@link event_set} and {@link event_base_set}
34066 * functions. If the {@link event} already has a timeout set, it is
34067 * replaced by the new one.
34068 *
34069 * @param resource $event Valid event resource.
34070 * @param int $timeout Optional timeout (in microseconds).
34071 * @return bool {@link event_add} returns TRUE on success or FALSE on
34072 *   error.
34073 * @since PECL libevent >= 0.0.2
34074 **/
34075function event_timer_add($event, $timeout){}
34076
34077/**
34078 * Remove an event from the set of monitored events
34079 *
34080 * Cancels the {@link event}.
34081 *
34082 * @param resource $event Valid event resource.
34083 * @return bool {@link event_del} returns TRUE on success or FALSE on
34084 *   error.
34085 * @since PECL libevent >= 0.0.2
34086 **/
34087function event_timer_del($event){}
34088
34089/**
34090 * Create new event
34091 *
34092 * Creates and returns a new event resource.
34093 *
34094 * @return resource {@link event_new} returns a new event resource on
34095 *   success or FALSE on error.
34096 * @since PECL libevent >= 0.0.2
34097 **/
34098function event_timer_new(){}
34099
34100/**
34101 * Prepare a timer event
34102 *
34103 * Prepares the timer event to be used in {@link event_add}. The event is
34104 * prepared to call the function specified by the {@link callback} when
34105 * the event timeout elapses.
34106 *
34107 * After initializing the event, use {@link event_base_set} to associate
34108 * the event with its event base.
34109 *
34110 * In case of matching event, these three arguments are passed to the
34111 * {@link callback} function: {@link fd} Signal number or resource
34112 * indicating the stream. {@link events} A flag indicating the event.
34113 * This will always be EV_TIMEOUT for timer events. {@link arg} Optional
34114 * parameter, previously passed to {@link event_timer_set} as {@link
34115 * arg}.
34116 *
34117 * @param resource $event Valid event resource.
34118 * @param callable $callback Callback function to be called when the
34119 *   matching event occurs.
34120 * @param mixed $arg Optional callback parameter.
34121 * @return bool
34122 * @since PECL libevent >= 0.0.2
34123 **/
34124function event_timer_set($event, $callback, $arg){}
34125
34126/**
34127 * Execute an external program
34128 *
34129 * {@link exec} executes the given {@link command}.
34130 *
34131 * @param string $command The command that will be executed.
34132 * @param array $output If the {@link output} argument is present, then
34133 *   the specified array will be filled with every line of output from
34134 *   the command. Trailing whitespace, such as \n, is not included in
34135 *   this array. Note that if the array already contains some elements,
34136 *   {@link exec} will append to the end of the array. If you do not want
34137 *   the function to append elements, call {@link unset} on the array
34138 *   before passing it to {@link exec}.
34139 * @param int $return_var If the {@link return_var} argument is present
34140 *   along with the {@link output} argument, then the return status of
34141 *   the executed command will be written to this variable.
34142 * @return string The last line from the result of the command. If you
34143 *   need to execute a command and have all the data from the command
34144 *   passed directly back without any interference, use the {@link
34145 *   passthru} function.
34146 * @since PHP 4, PHP 5, PHP 7
34147 **/
34148function exec($command, &$output, &$return_var){}
34149
34150/**
34151 * Determine the type of an image
34152 *
34153 * {@link exif_imagetype} reads the first bytes of an image and checks
34154 * its signature.
34155 *
34156 * {@link exif_imagetype} can be used to avoid calls to other exif
34157 * functions with unsupported file types or in conjunction with
34158 * $_SERVER['HTTP_ACCEPT'] to check whether or not the viewer is able to
34159 * see a specific image in the browser.
34160 *
34161 * @param string $filename
34162 * @return int When a correct signature is found, the appropriate
34163 *   constant value will be returned otherwise the return value is FALSE.
34164 *   The return value is the same value that {@link getimagesize} returns
34165 *   in index 2 but {@link exif_imagetype} is much faster.
34166 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
34167 **/
34168function exif_imagetype($filename){}
34169
34170/**
34171 * Reads the headers from an image file
34172 *
34173 * {@link exif_read_data} reads the EXIF headers from an image file. This
34174 * way you can read meta data generated by digital cameras.
34175 *
34176 * EXIF headers tend to be present in JPEG/TIFF images generated by
34177 * digital cameras, but unfortunately each digital camera maker has a
34178 * different idea of how to actually tag their images, so you can't
34179 * always rely on a specific Exif header being present.
34180 *
34181 * Height and Width are computed the same way {@link getimagesize} does
34182 * so their values must not be part of any header returned. Also, html is
34183 * a height/width text string to be used inside normal HTML.
34184 *
34185 * When an Exif header contains a Copyright note, this itself can contain
34186 * two values. As the solution is inconsistent in the Exif 2.10 standard,
34187 * the COMPUTED section will return both entries Copyright.Photographer
34188 * and Copyright.Editor while the IFD0 sections contains the byte array
34189 * with the NULL character that splits both entries. Or just the first
34190 * entry if the datatype was wrong (normal behaviour of Exif). The
34191 * COMPUTED will also contain the entry Copyright which is either the
34192 * original copyright string, or a comma separated list of the photo and
34193 * editor copyright.
34194 *
34195 * The tag UserComment has the same problem as the Copyright tag. It can
34196 * store two values. First the encoding used, and second the value
34197 * itself. If so the IFD section only contains the encoding or a byte
34198 * array. The COMPUTED section will store both in the entries
34199 * UserCommentEncoding and UserComment. The entry UserComment is
34200 * available in both cases so it should be used in preference to the
34201 * value in IFD0 section.
34202 *
34203 * {@link exif_read_data} also validates EXIF data tags according to the
34204 * EXIF specification (, page 20).
34205 *
34206 * @param mixed $stream The location of the image file. This can either
34207 *   be a path to the file (stream wrappers are also supported as usual)
34208 *   or a stream resource.
34209 * @param string $sections Is a comma separated list of sections that
34210 *   need to be present in file to produce a result array. If none of the
34211 *   requested sections could be found the return value is FALSE. FILE
34212 *   FileName, FileSize, FileDateTime, SectionsFound COMPUTED html,
34213 *   Width, Height, IsColor, and more if available. Height and Width are
34214 *   computed the same way {@link getimagesize} does so their values must
34215 *   not be part of any header returned. Also, html is a height/width
34216 *   text string to be used inside normal HTML. ANY_TAG Any information
34217 *   that has a Tag e.g. IFD0, EXIF, ... IFD0 All tagged data of IFD0. In
34218 *   normal imagefiles this contains image size and so forth. THUMBNAIL A
34219 *   file is supposed to contain a thumbnail if it has a second IFD. All
34220 *   tagged information about the embedded thumbnail is stored in this
34221 *   section. COMMENT Comment headers of JPEG images. EXIF The EXIF
34222 *   section is a sub section of IFD0. It contains more detailed
34223 *   information about an image. Most of these entries are digital camera
34224 *   related.
34225 * @param bool $arrays Specifies whether or not each section becomes an
34226 *   array. The {@link sections} COMPUTED, THUMBNAIL, and COMMENT always
34227 *   become arrays as they may contain values whose names conflict with
34228 *   other sections.
34229 * @param bool $thumbnail When set to TRUE the thumbnail itself is
34230 *   read. Otherwise, only the tagged data is read.
34231 * @return array It returns an associative array where the array
34232 *   indexes are the header names and the array values are the values
34233 *   associated with those headers. If no data can be returned, {@link
34234 *   exif_read_data} will return FALSE.
34235 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
34236 **/
34237function exif_read_data($stream, $sections, $arrays, $thumbnail){}
34238
34239/**
34240 * Get the header name for an index
34241 *
34242 * @param int $index The Tag ID for which a Tag Name will be looked up.
34243 * @return string Returns the header name, or FALSE if {@link index} is
34244 *   not a defined EXIF tag id.
34245 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
34246 **/
34247function exif_tagname($index){}
34248
34249/**
34250 * Retrieve the embedded thumbnail of an image
34251 *
34252 * {@link exif_thumbnail} reads the embedded thumbnail of an image.
34253 *
34254 * If you want to deliver thumbnails through this function, you should
34255 * send the mimetype information using the {@link header} function.
34256 *
34257 * It is possible that {@link exif_thumbnail} cannot create an image but
34258 * can determine its size. In this case, the return value is FALSE but
34259 * {@link width} and {@link height} are set.
34260 *
34261 * @param mixed $stream The location of the image file. This can either
34262 *   be a path to the file or a stream resource.
34263 * @param int $width The return width of the returned thumbnail.
34264 * @param int $height The returned height of the returned thumbnail.
34265 * @param int $imagetype The returned image type of the returned
34266 *   thumbnail. This is either TIFF or JPEG.
34267 * @return string Returns the embedded thumbnail, or FALSE if the image
34268 *   contains no thumbnail.
34269 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
34270 **/
34271function exif_thumbnail($stream, &$width, &$height, &$imagetype){}
34272
34273/**
34274 * Calculates the exponent of
34275 *
34276 * Returns e raised to the power of {@link arg}.
34277 *
34278 * @param float $arg The argument to process
34279 * @return float 'e' raised to the power of {@link arg}
34280 * @since PHP 4, PHP 5, PHP 7
34281 **/
34282function exp($arg){}
34283
34284/**
34285 * Waits until the output from a process matches one of the patterns, a
34286 * specified time period has passed, or an is seen
34287 *
34288 * Waits until the output from a process matches one of the patterns, a
34289 * specified time period has passed, or an EOF is seen.
34290 *
34291 * If {@link match} is provided, then it is filled with the result of
34292 * search. The matched string can be found in {@link match[0]}. The match
34293 * substrings (according to the parentheses) in the original pattern can
34294 * be found in {@link match[1]}, {@link match[2]}, and so on, up to
34295 * {@link match[9]} (the limitation of libexpect).
34296 *
34297 * @param resource $expect An Expect stream, previously opened with
34298 *   {@link expect_popen}.
34299 * @param array $cases An array of expect cases. Each expect case is an
34300 *   indexed array, as described in the following table: Expect Case
34301 *   Array Index Key Value Type Description Is Mandatory Default Value 0
34302 *   string pattern, that will be matched against the output from the
34303 *   stream yes 1 mixed value, that will be returned by this function, if
34304 *   the pattern matches yes 2 integer pattern type, one of: EXP_GLOB,
34305 *   EXP_EXACT or EXP_REGEXP no EXP_GLOB
34306 * @param array $match
34307 * @return int Returns value associated with the pattern that was
34308 *   matched.
34309 * @since PECL expect >= 0.1.0
34310 **/
34311function expect_expectl($expect, $cases, &$match){}
34312
34313/**
34314 * Execute command via Bourne shell, and open the PTY stream to the
34315 * process
34316 *
34317 * Execute command via Bourne shell, and open the PTY stream to the
34318 * process.
34319 *
34320 * @param string $command Command to execute.
34321 * @return resource Returns an open PTY stream to the processes stdio,
34322 *   stdout, and stderr.
34323 * @since PECL expect >= 0.1.0
34324 **/
34325function expect_popen($command){}
34326
34327/**
34328 * Split a string by a string
34329 *
34330 * Returns an array of strings, each of which is a substring of {@link
34331 * string} formed by splitting it on boundaries formed by the string
34332 * {@link delimiter}.
34333 *
34334 * @param string $delimiter The boundary string.
34335 * @param string $string The input string.
34336 * @param int $limit If {@link limit} is set and positive, the returned
34337 *   array will contain a maximum of {@link limit} elements with the last
34338 *   element containing the rest of {@link string}. If the {@link limit}
34339 *   parameter is negative, all components except the last -{@link limit}
34340 *   are returned. If the {@link limit} parameter is zero, then this is
34341 *   treated as 1.
34342 * @return array Returns an array of strings created by splitting the
34343 *   {@link string} parameter on boundaries formed by the {@link
34344 *   delimiter}.
34345 * @since PHP 4, PHP 5, PHP 7
34346 **/
34347function explode($delimiter, $string, $limit){}
34348
34349/**
34350 * Returns exp(number) - 1, computed in a way that is accurate even when
34351 * the value of number is close to zero
34352 *
34353 * {@link expm1} returns the equivalent to 'exp({@link arg}) - 1'
34354 * computed in a way that is accurate even if the value of {@link arg} is
34355 * near zero, a case where 'exp ({@link arg}) - 1' would be inaccurate
34356 * due to subtraction of two numbers that are nearly equal.
34357 *
34358 * @param float $arg The argument to process
34359 * @return float 'e' to the power of {@link arg} minus one
34360 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
34361 **/
34362function expm1($arg){}
34363
34364/**
34365 * Find out whether an extension is loaded
34366 *
34367 * Finds out whether the extension is loaded.
34368 *
34369 * @param string $name The extension name. This parameter is
34370 *   case-insensitive. You can see the names of various extensions by
34371 *   using {@link phpinfo} or if you're using the CGI or CLI version of
34372 *   PHP you can use the -m switch to list all available extensions:
34373 *
34374 *   $ php -m [PHP Modules] xml tokenizer standard sockets session posix
34375 *   pcre overload mysql mbstring ctype
34376 *
34377 *   [Zend Modules]
34378 * @return bool Returns TRUE if the extension identified by {@link
34379 *   name} is loaded, FALSE otherwise.
34380 * @since PHP 4, PHP 5, PHP 7
34381 **/
34382function extension_loaded($name){}
34383
34384/**
34385 * Import variables into the current symbol table from an array
34386 *
34387 * Import variables from an array into the current symbol table.
34388 *
34389 * Checks each key to see whether it has a valid variable name. It also
34390 * checks for collisions with existing variables in the symbol table.
34391 *
34392 * @param array $array An associative array. This function treats keys
34393 *   as variable names and values as variable values. For each key/value
34394 *   pair it will create a variable in the current symbol table, subject
34395 *   to {@link flags} and {@link prefix} parameters. You must use an
34396 *   associative array; a numerically indexed array will not produce
34397 *   results unless you use EXTR_PREFIX_ALL or EXTR_PREFIX_INVALID.
34398 * @param int $flags The way invalid/numeric keys and collisions are
34399 *   treated is determined by the extraction {@link flags}. It can be one
34400 *   of the following values: EXTR_OVERWRITE If there is a collision,
34401 *   overwrite the existing variable. EXTR_SKIP If there is a collision,
34402 *   don't overwrite the existing variable. EXTR_PREFIX_SAME If there is
34403 *   a collision, prefix the variable name with {@link prefix}.
34404 *   EXTR_PREFIX_ALL Prefix all variable names with {@link prefix}.
34405 *   EXTR_PREFIX_INVALID Only prefix invalid/numeric variable names with
34406 *   {@link prefix}. EXTR_IF_EXISTS Only overwrite the variable if it
34407 *   already exists in the current symbol table, otherwise do nothing.
34408 *   This is useful for defining a list of valid variables and then
34409 *   extracting only those variables you have defined out of $_REQUEST,
34410 *   for example. EXTR_PREFIX_IF_EXISTS Only create prefixed variable
34411 *   names if the non-prefixed version of the same variable exists in the
34412 *   current symbol table. EXTR_REFS Extracts variables as references.
34413 *   This effectively means that the values of the imported variables are
34414 *   still referencing the values of the {@link array} parameter. You can
34415 *   use this flag on its own or combine it with any other flag by OR'ing
34416 *   the {@link flags}. If {@link flags} is not specified, it is assumed
34417 *   to be EXTR_OVERWRITE.
34418 * @param string $prefix
34419 * @return int Returns the number of variables successfully imported
34420 *   into the symbol table.
34421 * @since PHP 4, PHP 5, PHP 7
34422 **/
34423function extract(&$array, $flags, $prefix){}
34424
34425/**
34426 * Calculate the hash value needed by EZMLM
34427 *
34428 * @param string $addr The email address that's being hashed.
34429 * @return int The hash value of {@link addr}.
34430 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
34431 **/
34432function ezmlm_hash($addr){}
34433
34434/**
34435 * Terminate monitoring
34436 *
34437 * Terminates monitoring on a resource.
34438 *
34439 * In addition an FAMAcknowledge event occurs.
34440 *
34441 * @param resource $fam A resource representing a connection to the FAM
34442 *   service returned by {@link fam_open}
34443 * @param resource $fam_monitor A resource returned by one of the
34444 *   fam_monitor_XXX functions
34445 * @return bool
34446 * @since PHP 5 < 5.1.0
34447 **/
34448function fam_cancel_monitor($fam, $fam_monitor){}
34449
34450/**
34451 * Close FAM connection
34452 *
34453 * Closes a connection to the FAM service.
34454 *
34455 * @param resource $fam A resource representing a connection to the FAM
34456 *   service returned by {@link fam_open}
34457 * @return void
34458 * @since PHP 5 < 5.1.0
34459 **/
34460function fam_close($fam){}
34461
34462/**
34463 * Monitor a collection of files in a directory for changes
34464 *
34465 * Requests monitoring for a collection of files within a directory.
34466 *
34467 * A FAM event will be generated whenever the status of the files change.
34468 * The possible event codes are described in detail in the constants part
34469 * of this section.
34470 *
34471 * @param resource $fam A resource representing a connection to the FAM
34472 *   service returned by {@link fam_open}
34473 * @param string $dirname Directory path to the monitored files
34474 * @param int $depth The maximum search {@link depth} starting from
34475 *   this directory
34476 * @param string $mask A shell pattern {@link mask} restricting the
34477 *   file names to look for
34478 * @return resource Returns a monitoring resource or FALSE on errors.
34479 * @since PHP 5 < 5.1.0
34480 **/
34481function fam_monitor_collection($fam, $dirname, $depth, $mask){}
34482
34483/**
34484 * Monitor a directory for changes
34485 *
34486 * Requests monitoring for a directory and all contained files.
34487 *
34488 * A FAM event will be generated whenever the status of the directory
34489 * (i.e. the result of function {@link stat} on that directory) or its
34490 * content (i.e. the results of {@link readdir}) changes.
34491 *
34492 * The possible event codes are described in detail in the constants part
34493 * of this section.
34494 *
34495 * @param resource $fam A resource representing a connection to the FAM
34496 *   service returned by {@link fam_open}
34497 * @param string $dirname Path to the monitored directory
34498 * @return resource Returns a monitoring resource or FALSE on errors.
34499 * @since PHP 5 < 5.1.0
34500 **/
34501function fam_monitor_directory($fam, $dirname){}
34502
34503/**
34504 * Monitor a regular file for changes
34505 *
34506 * Requests monitoring for a single file. A FAM event will be generated
34507 * whenever the file status changes (i.e. the result of function {@link
34508 * stat} on that file).
34509 *
34510 * The possible event codes are described in detail in the constants part
34511 * of this section.
34512 *
34513 * @param resource $fam A resource representing a connection to the FAM
34514 *   service returned by {@link fam_open}
34515 * @param string $filename Path to the monitored file
34516 * @return resource Returns a monitoring resource or FALSE on errors.
34517 * @since PHP 5 < 5.1.0
34518 **/
34519function fam_monitor_file($fam, $filename){}
34520
34521/**
34522 * Get next pending FAM event
34523 *
34524 * Returns the next pending FAM event.
34525 *
34526 * The function will block until an event is available which can be
34527 * checked for using {@link fam_pending}.
34528 *
34529 * @param resource $fam A resource representing a connection to the FAM
34530 *   service returned by {@link fam_open}
34531 * @return array Returns an array that contains a FAM event code in the
34532 *   'code' element, the path of the file this event applies to in the
34533 *   'filename' element and optionally a hostname in the 'hostname'
34534 *   element.
34535 * @since PHP 5 < 5.1.0
34536 **/
34537function fam_next_event($fam){}
34538
34539/**
34540 * Open connection to FAM daemon
34541 *
34542 * Opens a connection to the FAM service daemon.
34543 *
34544 * @param string $appname A string identifying the application for
34545 *   logging reasons
34546 * @return resource Returns a resource representing a connection to the
34547 *   FAM service on success or FALSE on errors.
34548 * @since PHP 5 < 5.1.0
34549 **/
34550function fam_open($appname){}
34551
34552/**
34553 * Check for pending FAM events
34554 *
34555 * Checks for pending FAM events.
34556 *
34557 * @param resource $fam A resource representing a connection to the FAM
34558 *   service returned by {@link fam_open}
34559 * @return int Returns non-zero if events are available to be fetched
34560 *   using {@link fam_next_event}, zero otherwise.
34561 * @since PHP 5 < 5.1.0
34562 **/
34563function fam_pending($fam){}
34564
34565/**
34566 * Resume suspended monitoring
34567 *
34568 * Resumes monitoring of a resource previously suspended using {@link
34569 * fam_suspend_monitor}.
34570 *
34571 * @param resource $fam A resource representing a connection to the FAM
34572 *   service returned by {@link fam_open}
34573 * @param resource $fam_monitor A resource returned by one of the
34574 *   fam_monitor_XXX functions
34575 * @return bool
34576 * @since PHP 5 < 5.1.0
34577 **/
34578function fam_resume_monitor($fam, $fam_monitor){}
34579
34580/**
34581 * Temporarily suspend monitoring
34582 *
34583 * {@link fam_suspend_monitor} temporarily suspend monitoring of a
34584 * resource.
34585 *
34586 * Monitoring can later be continued using {@link fam_resume_monitor}
34587 * without the need of requesting a complete new monitor.
34588 *
34589 * @param resource $fam A resource representing a connection to the FAM
34590 *   service returned by {@link fam_open}
34591 * @param resource $fam_monitor A resource returned by one of the
34592 *   fam_monitor_XXX functions
34593 * @return bool
34594 * @since PHP 5 < 5.1.0
34595 **/
34596function fam_suspend_monitor($fam, $fam_monitor){}
34597
34598/**
34599 * Trains on an entire dataset, for a period of time using the Cascade2
34600 * training algorithm
34601 *
34602 * The cascade output change fraction is a number between 0 and 1
34603 * determining how large a fraction the {@link fann_get_MSE} value should
34604 * change within {@link fann_get_cascade_output_stagnation_epochs} during
34605 * training of the output connections, in order for the training not to
34606 * stagnate. If the training stagnates, the training of the output
34607 * connections will be ended and new candidates will be prepared.
34608 *
34609 * This training uses the parameters set using the fann_set_cascade_...,
34610 * but it also uses another training algorithm as it’s internal
34611 * training algorithm. This algorithm can be set to either
34612 * FANN_TRAIN_RPROP or FANN_TRAIN_QUICKPROP by {@link
34613 * fann_set_training_algorithm}, and the parameters set for these
34614 * training algorithms will also affect the cascade training.
34615 *
34616 * @param resource $ann
34617 * @param resource $data
34618 * @param int $max_neurons The maximum number of neurons to be added to
34619 *   neural network.
34620 * @param int $neurons_between_reports The number of neurons between
34621 *   printing a status report. A value of zero means no reports should be
34622 *   printed.
34623 * @param float $desired_error The desired {@link fann_get_MSE} or
34624 *   {@link fann_get_bit_fail}, depending on which stop function is
34625 *   chosen by {@link fann_set_train_stop_function}
34626 * @return bool
34627 * @since PECL fann >= 1.0.0
34628 **/
34629function fann_cascadetrain_on_data($ann, $data, $max_neurons, $neurons_between_reports, $desired_error){}
34630
34631/**
34632 * Trains on an entire dataset read from file, for a period of time using
34633 * the Cascade2 training algorithm
34634 *
34635 * Does the same as {@link fann_cascadetrain_on_data}, but reads the
34636 * training data directly from a file.
34637 *
34638 * @param resource $ann
34639 * @param string $filename A file containing the data for training.
34640 * @param int $max_neurons The maximum number of neurons to be added to
34641 *   neural network
34642 * @param int $neurons_between_reports The number of neurons between
34643 *   printing a status report. A value of zero means no reports should be
34644 *   printed.
34645 * @param float $desired_error The desired {@link fann_get_MSE} or
34646 *   {@link fann_get_bit_fail}, depending on which stop function is
34647 *   chosen by {@link fann_set_train_stop_function}.
34648 * @return bool
34649 * @since PECL fann >= 1.0.0
34650 **/
34651function fann_cascadetrain_on_file($ann, $filename, $max_neurons, $neurons_between_reports, $desired_error){}
34652
34653/**
34654 * Clears scaling parameters
34655 *
34656 * @param resource $ann
34657 * @return bool
34658 * @since PECL fann >= 1.0.0
34659 **/
34660function fann_clear_scaling_params($ann){}
34661
34662/**
34663 * Creates a copy of a fann structure
34664 *
34665 * @param resource $ann
34666 * @return resource Returns a copy of neural network resource on
34667 *   success, or FALSE on error
34668 * @since PECL fann >= 1.0.0
34669 **/
34670function fann_copy($ann){}
34671
34672/**
34673 * Constructs a backpropagation neural network from a configuration file
34674 *
34675 * Constructs a backpropagation neural network from a configuration file,
34676 * which have been saved by {@link fann_save}.
34677 *
34678 * @param string $configuration_file The configuration file path.
34679 * @return resource
34680 * @since PECL fann >= 1.0.0
34681 **/
34682function fann_create_from_file($configuration_file){}
34683
34684/**
34685 * Creates a standard backpropagation neural network which is not fully
34686 * connectected and has shortcut connections
34687 *
34688 * Creates a standard backpropagation neural network, which is not fully
34689 * connected and which also has shortcut connections.
34690 *
34691 * Shortcut connections are connections that skip layers. A fully
34692 * connected network with shortcut connections, is a network where all
34693 * neurons are connected to all neurons in later layers. Including direct
34694 * connections from the input layer to the output layer.
34695 *
34696 * @param int $num_layers The total number of layers including the
34697 *   input and the output layer.
34698 * @param int $num_neurons1 Number of neurons in the first layer.
34699 * @param int $num_neurons2 Number of neurons in the second layer.
34700 * @param int ...$vararg Number of neurons in other layers.
34701 * @return resource Returns a neural network resource on success, or
34702 *   FALSE on error.
34703 * @since PECL fann >= 1.0.0
34704 **/
34705function fann_create_shortcut($num_layers, $num_neurons1, $num_neurons2, ...$vararg){}
34706
34707/**
34708 * Creates a standard backpropagation neural network which is not fully
34709 * connectected and has shortcut connections
34710 *
34711 * Creates a standard backpropagation neural network which is not fully
34712 * connectected and has shortcut connections using an array of layers
34713 * sizes.
34714 *
34715 * @param int $num_layers The total number of layers including the
34716 *   input and the output layer.
34717 * @param array $layers An array of layers sizes.
34718 * @return resource Returns a neural network resource on success, or
34719 *   FALSE on error.
34720 * @since PECL fann >= 1.0.0
34721 **/
34722function fann_create_shortcut_array($num_layers, $layers){}
34723
34724/**
34725 * Creates a standard backpropagation neural network, which is not fully
34726 * connected
34727 *
34728 * @param float $connection_rate The connection rate controls how many
34729 *   connections there will be in the network. If the connection rate is
34730 *   set to 1, the network will be fully connected, but if it is set to
34731 *   0.5 only half of the connections will be set. A connection rate of 1
34732 *   will yield the same result as {@link fann_create_standard}.
34733 * @param int $num_layers The total number of layers including the
34734 *   input and the output layer.
34735 * @param int $num_neurons1 Number of neurons in the first layer.
34736 * @param int $num_neurons2 Number of neurons in the second layer.
34737 * @param int ...$vararg Number of neurons in other layers.
34738 * @return resource Returns a neural network resource on success, or
34739 *   FALSE on error.
34740 * @since PECL fann >= 1.0.0
34741 **/
34742function fann_create_sparse($connection_rate, $num_layers, $num_neurons1, $num_neurons2, ...$vararg){}
34743
34744/**
34745 * Creates a standard backpropagation neural network, which is not fully
34746 * connected using an array of layer sizes
34747 *
34748 * @param float $connection_rate The connection rate controls how many
34749 *   connections there will be in the network. If the connection rate is
34750 *   set to 1, the network will be fully connected, but if it is set to
34751 *   0.5 only half of the connections will be set. A connection rate of 1
34752 *   will yield the same result as {@link fann_create_standard}.
34753 * @param int $num_layers The total number of layers including the
34754 *   input and the output layer.
34755 * @param array $layers An array of layer sizes.
34756 * @return resource Returns a neural network resource on success, or
34757 *   FALSE on error.
34758 * @since PECL fann >= 1.0.0
34759 **/
34760function fann_create_sparse_array($connection_rate, $num_layers, $layers){}
34761
34762/**
34763 * Creates a standard fully connected backpropagation neural network
34764 *
34765 * There will be a bias neuron in each layer (except the output layer),
34766 * and this bias neuron will be connected to all neurons in the next
34767 * layer. When running the network, the bias nodes always emits 1.
34768 *
34769 * To destroy a neural network use the {@link fann_destroy} function.
34770 *
34771 * @param int $num_layers The total number of layers including the
34772 *   input and the output layer.
34773 * @param int $num_neurons1 Number of neurons in the first layer.
34774 * @param int $num_neurons2 Number of neurons in the second layer.
34775 * @param int ...$vararg Number of neurons in other layers.
34776 * @return resource Returns a neural network resource on success, or
34777 *   FALSE on error.
34778 * @since PECL fann >= 1.0.0
34779 **/
34780function fann_create_standard($num_layers, $num_neurons1, $num_neurons2, ...$vararg){}
34781
34782/**
34783 * Creates a standard fully connected backpropagation neural network
34784 * using an array of layer sizes
34785 *
34786 * Creates a standard fully connected backpropagation neural network.
34787 *
34788 * There will be a bias neuron in each layer (except the output layer),
34789 * and this bias neuron will be connected to all neurons in the next
34790 * layer. When running the network, the bias nodes always emits 1.
34791 *
34792 * To destroy a neural network use the {@link fann_destroy} function.
34793 *
34794 * @param int $num_layers The total number of layers including the
34795 *   input and the output layer.
34796 * @param array $layers An array of layer sizes.
34797 * @return resource Returns a neural network resource on success, or
34798 *   FALSE on error.
34799 * @since PECL fann >= 1.0.0
34800 **/
34801function fann_create_standard_array($num_layers, $layers){}
34802
34803/**
34804 * Creates an empty training data struct
34805 *
34806 * @param int $num_data The number of training data
34807 * @param int $num_input The number of inputs per training data
34808 * @param int $num_output The number of ouputs per training data
34809 * @return resource
34810 * @since PECL fann >= 1.0.0
34811 **/
34812function fann_create_train($num_data, $num_input, $num_output){}
34813
34814/**
34815 * Creates the training data struct from a user supplied function
34816 *
34817 * Creates the training data struct from a user supplied function. As the
34818 * training data are numerable (data 1, data 2...), the user must write a
34819 * function that receives the number of the training data set (input,
34820 * output) and returns the set.
34821 *
34822 * @param int $num_data The number of training data
34823 * @param int $num_input The number of inputs per training data
34824 * @param int $num_output The number of ouputs per training data
34825 * @param callable $user_function The user supplied function with
34826 *   following parameters: num - The number of the training data set
34827 *   num_input - The number of inputs per training data num_output - The
34828 *   number of ouputs per training data The function should return an
34829 *   associative array with keys input and output and two array values of
34830 *   input and output.
34831 * @return resource
34832 * @since PECL fann >= 1.0.0
34833 **/
34834function fann_create_train_from_callback($num_data, $num_input, $num_output, $user_function){}
34835
34836/**
34837 * Scale data in input vector after get it from ann based on previously
34838 * calculated parameters
34839 *
34840 * @param resource $ann
34841 * @param array $input_vector Input vector that will be descaled
34842 * @return bool
34843 * @since PECL fann >= 1.0.0
34844 **/
34845function fann_descale_input($ann, $input_vector){}
34846
34847/**
34848 * Scale data in output vector after get it from ann based on previously
34849 * calculated parameters
34850 *
34851 * @param resource $ann
34852 * @param array $output_vector Output vector that will be descaled
34853 * @return bool
34854 * @since PECL fann >= 1.0.0
34855 **/
34856function fann_descale_output($ann, $output_vector){}
34857
34858/**
34859 * Descale input and output data based on previously calculated
34860 * parameters
34861 *
34862 * @param resource $ann
34863 * @param resource $train_data
34864 * @return bool
34865 * @since PECL fann >= 1.0.0
34866 **/
34867function fann_descale_train($ann, $train_data){}
34868
34869/**
34870 * Destroys the entire network and properly freeing all the associated
34871 * memory
34872 *
34873 * @param resource $ann
34874 * @return bool
34875 * @since PECL fann >= 1.0.0
34876 **/
34877function fann_destroy($ann){}
34878
34879/**
34880 * Destructs the training data
34881 *
34882 * @param resource $train_data
34883 * @return bool
34884 * @since PECL fann >= 1.0.0
34885 **/
34886function fann_destroy_train($train_data){}
34887
34888/**
34889 * Returns an exact copy of a fann train data
34890 *
34891 * Returns an exact copy of a fann train data resource.
34892 *
34893 * @param resource $data
34894 * @return resource
34895 * @since PECL fann >= 1.0.0
34896 **/
34897function fann_duplicate_train_data($data){}
34898
34899/**
34900 * Returns the activation function
34901 *
34902 * Get the activation function for neuron number neuron in layer number
34903 * layer, counting the input layer as layer 0.
34904 *
34905 * It is not possible to get activation functions for the neurons in the
34906 * input layer.
34907 *
34908 * The return value is one of the activation functions constants.
34909 *
34910 * @param resource $ann
34911 * @param int $layer Layer number.
34912 * @param int $neuron Neuron number.
34913 * @return int Learning functions constant or -1 if the neuron is not
34914 *   defined in the neural network, or FALSE on error.
34915 * @since PECL fann >= 1.0.0
34916 **/
34917function fann_get_activation_function($ann, $layer, $neuron){}
34918
34919/**
34920 * Returns the activation steepness for supplied neuron and layer number
34921 *
34922 * Get the activation steepness for neuron number neuron in layer number
34923 * layer, counting the input layer as layer 0.
34924 *
34925 * It is not possible to get activation steepness for the neurons in the
34926 * input layer.
34927 *
34928 * The steepness of an activation function says something about how fast
34929 * the activation function goes from the minimum to the maximum. A high
34930 * value for the activation function will also give a more agressive
34931 * training.
34932 *
34933 * When training neural networks where the output values should be at the
34934 * extremes (usually 0 and 1, depending on the activation function), a
34935 * steep activation function can be used (e.g. 1.0).
34936 *
34937 * The default activation steepness is 0.5.
34938 *
34939 * @param resource $ann
34940 * @param int $layer Layer number
34941 * @param int $neuron Neuron number
34942 * @return float The activation steepness for the neuron or -1 if the
34943 *   neuron is not defined in the neural network, or FALSE on error.
34944 * @since PECL fann >= 1.0.0
34945 **/
34946function fann_get_activation_steepness($ann, $layer, $neuron){}
34947
34948/**
34949 * Get the number of bias in each layer in the network
34950 *
34951 * @param resource $ann
34952 * @return array An array of numbers of bias in each layer
34953 * @since PECL fann >= 1.0.0
34954 **/
34955function fann_get_bias_array($ann){}
34956
34957/**
34958 * The number of fail bits
34959 *
34960 * The number of fail bits; means the number of output neurons which
34961 * differ more than the bit fail limit (see {@link
34962 * fann_get_bit_fail_limit}, {@link fann_set_bit_fail_limit}). The bits
34963 * are counted in all of the training data, so this number can be higher
34964 * than the number of training data.
34965 *
34966 * This value is reset by {@link fann_reset_MSE} and updated by all the
34967 * same functions which also updates the MSE value (e.g. {@link
34968 * fann_test_data}, {@link fann_train_epoch})
34969 *
34970 * @param resource $ann
34971 * @return int The number of bits fail, or FALSE on error.
34972 * @since PECL fann >= 1.0.0
34973 **/
34974function fann_get_bit_fail($ann){}
34975
34976/**
34977 * Returns the bit fail limit used during training
34978 *
34979 * The bit fail limit is used during training where the stop function is
34980 * set to FANN_STOPFUNC_BIT.
34981 *
34982 * The limit is the maximum accepted difference between the desired
34983 * output and the actual output during training. Each output that
34984 * diverges more than this limit is counted as an error bit. This
34985 * difference is divided by two when dealing with symmetric activation
34986 * functions, so that symmetric and not symmetric activation functions
34987 * can use the same limit.
34988 *
34989 * The default bit fail limit is 0.35.
34990 *
34991 * @param resource $ann
34992 * @return float The bit fail limit, or FALSE on error.
34993 * @since PECL fann >= 1.0.0
34994 **/
34995function fann_get_bit_fail_limit($ann){}
34996
34997/**
34998 * Returns the cascade activation functions
34999 *
35000 * The cascade activation functions array is an array of the different
35001 * activation functions used by the candidates
35002 *
35003 * See {@link fann_get_cascade_num_candidates} for a description of which
35004 * candidate neurons will be generated by this array.
35005 *
35006 * The default activation functions are FANN_SIGMOID,
35007 * FANN_SIGMOID_SYMMETRIC, FANN_GAUSSIAN, FANN_GAUSSIAN_SYMMETRIC,
35008 * FANN_ELLIOT, FANN_ELLIOT_SYMMETRIC.
35009 *
35010 * @param resource $ann
35011 * @return array The cascade activation functions, or FALSE on error.
35012 * @since PECL fann >= 1.0.0
35013 **/
35014function fann_get_cascade_activation_functions($ann){}
35015
35016/**
35017 * Returns the number of cascade activation functions
35018 *
35019 * The number of activation functions in the {@link
35020 * fann_get_cascade_activation_functions} array.
35021 *
35022 * The default number of activation functions is 6.
35023 *
35024 * @param resource $ann
35025 * @return int The number of cascade activation functions, or FALSE on
35026 *   error.
35027 * @since PECL fann >= 1.0.0
35028 **/
35029function fann_get_cascade_activation_functions_count($ann){}
35030
35031/**
35032 * Returns the cascade activation steepnesses
35033 *
35034 * The cascade activation steepnesses array is an array of the different
35035 * activation functions used by the candidates.
35036 *
35037 * See {@link fann_get_cascade_num_candidates} for a description of which
35038 * candidate neurons will be generated by this array.
35039 *
35040 * The default activation steepnesses are {0.25, 0.50, 0.75, 1.00}.
35041 *
35042 * @param resource $ann
35043 * @return array The cascade activation steepnesses, or FALSE on error.
35044 * @since PECL fann >= 1.0.0
35045 **/
35046function fann_get_cascade_activation_steepnesses($ann){}
35047
35048/**
35049 * The number of activation steepnesses
35050 *
35051 * The number of activation steepnesses in the {@link
35052 * fann_get_cascade_activation_functions} array.
35053 *
35054 * The default number of activation steepnesses is 4.
35055 *
35056 * @param resource $ann
35057 * @return int The number of activation steepnesses, or FALSE on error.
35058 * @since PECL fann >= 1.0.0
35059 **/
35060function fann_get_cascade_activation_steepnesses_count($ann){}
35061
35062/**
35063 * Returns the cascade candidate change fraction
35064 *
35065 * The cascade candidate change fraction is a number between 0 and 1
35066 * determining how large a fraction the {@link fann_get_MSE} value should
35067 * change within {@link fann_get_cascade_candidate_stagnation_epochs}
35068 * during training of the candidate neurons, in order for the training
35069 * not to stagnate. If the training stagnates, the training of the
35070 * candidate neurons will be ended and the best candidate will be
35071 * selected.
35072 *
35073 * It means that if the MSE does not change by a fraction of {@link
35074 * fann_get_cascade_candidate_change_fraction} during a period of {@link
35075 * fann_get_cascade_candidate_stagnation_epochs}, the training of the
35076 * candidate neurons is stopped because the training has stagnated.
35077 *
35078 * If the cascade candidate change fraction is low, the candidate neurons
35079 * will be trained more and if the fraction is high they will be trained
35080 * less.
35081 *
35082 * The default cascade candidate change fraction is 0.01, which is
35083 * equalent to a 1% change in MSE.
35084 *
35085 * @param resource $ann
35086 * @return float The cascade candidate change fraction, or FALSE on
35087 *   error.
35088 * @since PECL fann >= 1.0.0
35089 **/
35090function fann_get_cascade_candidate_change_fraction($ann){}
35091
35092/**
35093 * Return the candidate limit
35094 *
35095 * The candidate limit is a limit for how much the candidate neuron may
35096 * be trained. The limit is a limit on the proportion between the MSE and
35097 * candidate score.
35098 *
35099 * Set this to a lower value to avoid overfitting and to a higher if
35100 * overfitting is not a problem.
35101 *
35102 * The default candidate limit is 1000.0.
35103 *
35104 * @param resource $ann
35105 * @return float The candidate limit, or FALSE on error.
35106 * @since PECL fann >= 1.0.0
35107 **/
35108function fann_get_cascade_candidate_limit($ann){}
35109
35110/**
35111 * Returns the number of cascade candidate stagnation epochs
35112 *
35113 * The number of cascade candidate stagnation epochs determines the
35114 * number of epochs training is allowed to continue without changing the
35115 * MSE by a fraction of {@link
35116 * fann_get_cascade_candidate_change_fraction}.
35117 *
35118 * See more info about this parameter in {@link
35119 * fann_get_cascade_candidate_change_fraction}.
35120 *
35121 * The default number of cascade candidate stagnation epochs is 12.
35122 *
35123 * @param resource $ann
35124 * @return int The number of cascade candidate stagnation epochs, or
35125 *   FALSE on error.
35126 * @since PECL fann >= 1.0.0
35127 **/
35128function fann_get_cascade_candidate_stagnation_epochs($ann){}
35129
35130/**
35131 * Returns the maximum candidate epochs
35132 *
35133 * The maximum candidate epochs determines the maximum number of epochs
35134 * the input connections to the candidates may be trained before adding a
35135 * new candidate neuron.
35136 *
35137 * The default max candidate epochs is 150.
35138 *
35139 * @param resource $ann
35140 * @return int The maximum candidate epochs, or FALSE on error.
35141 * @since PECL fann >= 1.0.0
35142 **/
35143function fann_get_cascade_max_cand_epochs($ann){}
35144
35145/**
35146 * Returns the maximum out epochs
35147 *
35148 * The maximum out epochs determines the maximum number of epochs the
35149 * output connections may be trained after adding a new candidate neuron.
35150 *
35151 * The default max out epochs is 150.
35152 *
35153 * @param resource $ann
35154 * @return int The maximum out epochs, or FALSE on error.
35155 * @since PECL fann >= 1.0.0
35156 **/
35157function fann_get_cascade_max_out_epochs($ann){}
35158
35159/**
35160 * Returns the minimum candidate epochs
35161 *
35162 * The minimum candidate epochs determines the minimum number of epochs
35163 * the input connections to the candidates may be trained before adding a
35164 * new candidate neuron.
35165 *
35166 * The default min candidate epochs is 50.
35167 *
35168 * @param resource $ann
35169 * @return int The minimum candidate epochs, or FALSE on error.
35170 * @since PECL fann >= 1.0.0
35171 **/
35172function fann_get_cascade_min_cand_epochs($ann){}
35173
35174/**
35175 * Returns the minimum out epochs
35176 *
35177 * The minimum out epochs determines the minimum number of epochs the
35178 * output connections must be trained after adding a new candidate
35179 * neuron.
35180 *
35181 * The default min out epochs is 50.
35182 *
35183 * @param resource $ann
35184 * @return int The minimum out epochs, or FALSE on error.
35185 * @since PECL fann >= 1.0.0
35186 **/
35187function fann_get_cascade_min_out_epochs($ann){}
35188
35189/**
35190 * Returns the number of candidates used during training
35191 *
35192 * The number of candidates used during training (calculated by
35193 * multiplying {@link fann_get_cascade_activation_functions_count},
35194 * {@link fann_get_cascade_activation_steepnesses_count} and {@link
35195 * fann_get_cascade_num_candidate_groups}).
35196 *
35197 * The actual candidates is defined by the {@link
35198 * fann_get_cascade_activation_functions} and {@link
35199 * fann_get_cascade_activation_steepnesses} arrays. These arrays define
35200 * the activation functions and activation steepnesses used for the
35201 * candidate neurons. If there are 2 activation functions in the
35202 * activation function array and 3 steepnesses in the steepness array,
35203 * then there will be 2x3=6 different candidates which will be trained.
35204 * These 6 different candidates can be copied into several candidate
35205 * groups, where the only difference between these groups is the initial
35206 * weights. If the number of groups is set to 2, then the number of
35207 * candidate neurons will be 2x3x2=12. The number of candidate groups is
35208 * defined by {@link fann_set_cascade_num_candidate_groups}.
35209 *
35210 * The default number of candidates is 6x4x2 = 48
35211 *
35212 * @param resource $ann
35213 * @return int The number of candidates used during training, or FALSE
35214 *   on error.
35215 * @since PECL fann >= 1.0.0
35216 **/
35217function fann_get_cascade_num_candidates($ann){}
35218
35219/**
35220 * Returns the number of candidate groups
35221 *
35222 * The number of candidate groups is the number of groups of identical
35223 * candidates which will be used during training.
35224 *
35225 * This number can be used to have more candidates without having to
35226 * define new parameters for the candidates.
35227 *
35228 * See {@link fann_get_cascade_num_candidates} for a description of which
35229 * candidate neurons will be generated by this parameter.
35230 *
35231 * The default number of candidate groups is 2.
35232 *
35233 * @param resource $ann
35234 * @return int The number of candidate groups, or FALSE on error.
35235 * @since PECL fann >= 1.0.0
35236 **/
35237function fann_get_cascade_num_candidate_groups($ann){}
35238
35239/**
35240 * Returns the cascade output change fraction
35241 *
35242 * The cascade output change fraction is a number between 0 and 1
35243 * determining how large a fraction of the {@link fann_get_MSE} value
35244 * should change within {@link fann_get_cascade_output_stagnation_epochs}
35245 * during training of the output connections, in order for the training
35246 * not to stagnate. If the training stagnates, the training of the output
35247 * connections will be ended and new candidates will be prepared.
35248 *
35249 * It means that if the MSE does not change by a fraction of {@link
35250 * fann_get_cascade_output_change_fraction} during a period of {@link
35251 * fann_get_cascade_output_stagnation_epochs}, the training of the output
35252 * connections is stopped because the training has stagnated.
35253 *
35254 * If the cascade output change fraction is low, the output connections
35255 * will be trained more and if the fraction is high, they will be trained
35256 * less.
35257 *
35258 * The default cascade output change fraction is 0.01, which is equalent
35259 * to a 1% change in MSE.
35260 *
35261 * @param resource $ann
35262 * @return float The cascade output change fraction, or FALSE on error.
35263 * @since PECL fann >= 1.0.0
35264 **/
35265function fann_get_cascade_output_change_fraction($ann){}
35266
35267/**
35268 * Returns the number of cascade output stagnation epochs
35269 *
35270 * The number of cascade output stagnation epochs determines the number
35271 * of epochs training is allowed to continue without changing the MSE by
35272 * a fraction of {@link fann_get_cascade_output_change_fraction}.
35273 *
35274 * See more info about this parameter in {@link
35275 * fann_get_cascade_output_change_fraction}.
35276 *
35277 * The default number of cascade output stagnation epochs is 12.
35278 *
35279 * @param resource $ann
35280 * @return int The number of cascade output stagnation epochs, or FALSE
35281 *   on error.
35282 * @since PECL fann >= 1.0.0
35283 **/
35284function fann_get_cascade_output_stagnation_epochs($ann){}
35285
35286/**
35287 * Returns the weight multiplier
35288 *
35289 * The weight multiplier is a parameter which is used to multiply the
35290 * weights from the candidate neuron before adding the neuron to the
35291 * neural network. This parameter is usually between 0 and 1, and is used
35292 * to make the training a bit less aggressive.
35293 *
35294 * The default weight multiplier is 0.4.
35295 *
35296 * @param resource $ann
35297 * @return float The weight multiplier, or FALSE on error.
35298 * @since PECL fann >= 1.0.0
35299 **/
35300function fann_get_cascade_weight_multiplier($ann){}
35301
35302/**
35303 * Get connections in the network
35304 *
35305 * @param resource $ann
35306 * @return array An array of connections in the network
35307 * @since PECL fann >= 1.0.0
35308 **/
35309function fann_get_connection_array($ann){}
35310
35311/**
35312 * Get the connection rate used when the network was created
35313 *
35314 * @param resource $ann
35315 * @return float The connection rate used when the network was created,
35316 *   or FALSE on error.
35317 * @since PECL fann >= 1.0.0
35318 **/
35319function fann_get_connection_rate($ann){}
35320
35321/**
35322 * Returns the last error number
35323 *
35324 * @param resource $errdat
35325 * @return int The error number, or FALSE on error.
35326 * @since PECL fann >= 1.0.0
35327 **/
35328function fann_get_errno($errdat){}
35329
35330/**
35331 * Returns the last errstr
35332 *
35333 * @param resource $errdat
35334 * @return string The last error string, or FALSE on error.
35335 * @since PECL fann >= 1.0.0
35336 **/
35337function fann_get_errstr($errdat){}
35338
35339/**
35340 * Get the number of neurons in each layer in the network
35341 *
35342 * Get the number of neurons in each layer in the neural network.
35343 *
35344 * Bias is not included so the layers match the fann_create functions.
35345 *
35346 * @param resource $ann
35347 * @return array An array of numbers of neurons in each leayer
35348 * @since PECL fann >= 1.0.0
35349 **/
35350function fann_get_layer_array($ann){}
35351
35352/**
35353 * Returns the learning momentum
35354 *
35355 * The learning momentum can be used to speed up FANN_TRAIN_INCREMENTAL
35356 * training. A too high momentum will however not benefit training.
35357 * Setting momentum to 0 will be the same as not using the momentum
35358 * parameter. The recommended value of this parameter is between 0.0 and
35359 * 1.0.
35360 *
35361 * The default momentum is 0.
35362 *
35363 * @param resource $ann
35364 * @return float The learning momentum, or FALSE on error.
35365 * @since PECL fann >= 1.0.0
35366 **/
35367function fann_get_learning_momentum($ann){}
35368
35369/**
35370 * Returns the learning rate
35371 *
35372 * The learning rate is used to determine how aggressive training should
35373 * be for some of the training algorithms (FANN_TRAIN_INCREMENTAL,
35374 * FANN_TRAIN_BATCH, FANN_TRAIN_QUICKPROP). Do however note that it is
35375 * not used in FANN_TRAIN_RPROP.
35376 *
35377 * The default learning rate is 0.7.
35378 *
35379 * @param resource $ann
35380 * @return float The learning rate, or FALSE on error.
35381 * @since PECL fann >= 1.0.0
35382 **/
35383function fann_get_learning_rate($ann){}
35384
35385/**
35386 * Reads the mean square error from the network
35387 *
35388 * Reads the mean square error from the network. This value is calculated
35389 * during training or testing and can therefore sometimes be a bit off if
35390 * the weights have been changed since the last calculation of the value.
35391 *
35392 * @param resource $ann
35393 * @return float The mean square error, or FALSE on error.
35394 * @since PECL fann >= 1.0.0
35395 **/
35396function fann_get_MSE($ann){}
35397
35398/**
35399 * Get the type of neural network it was created as
35400 *
35401 * @param resource $ann
35402 * @return int Network type constant, or FALSE on error.
35403 * @since PECL fann >= 1.0.0
35404 **/
35405function fann_get_network_type($ann){}
35406
35407/**
35408 * Get the number of input neurons
35409 *
35410 * @param resource $ann
35411 * @return int Number of input neurons, or FALSE on error
35412 * @since PECL fann >= 1.0.0
35413 **/
35414function fann_get_num_input($ann){}
35415
35416/**
35417 * Get the number of layers in the neural network
35418 *
35419 * @param resource $ann
35420 * @return int The number of leayers in the neural network, or FALSE on
35421 *   error.
35422 * @since PECL fann >= 1.0.0
35423 **/
35424function fann_get_num_layers($ann){}
35425
35426/**
35427 * Get the number of output neurons
35428 *
35429 * @param resource $ann
35430 * @return int Number of output neurons, or FALSE on error
35431 * @since PECL fann >= 1.0.0
35432 **/
35433function fann_get_num_output($ann){}
35434
35435/**
35436 * Returns the decay which is a factor that weights should decrease in
35437 * each iteration during quickprop training
35438 *
35439 * The decay is a small negative valued number which is a factor that the
35440 * weights should decrease in each iteration during quickprop training.
35441 * This is used to make sure that the weights do not become too high
35442 * during training.
35443 *
35444 * The default decay is -0.0001.
35445 *
35446 * @param resource $ann
35447 * @return float The decay, or FALSE on error.
35448 * @since PECL fann >= 1.0.0
35449 **/
35450function fann_get_quickprop_decay($ann){}
35451
35452/**
35453 * Returns the mu factor
35454 *
35455 * The mu factor is used to increase and decrease the step-size during
35456 * quickprop training. The mu factor should always be above 1, since it
35457 * would otherwise decrease the step-size when it was suppose to increase
35458 * it.
35459 *
35460 * The default mu factor is 1.75.
35461 *
35462 * @param resource $ann
35463 * @return float The mu factor, or FALSE on error.
35464 * @since PECL fann >= 1.0.0
35465 **/
35466function fann_get_quickprop_mu($ann){}
35467
35468/**
35469 * Returns the increase factor used during RPROP training
35470 *
35471 * The decrease factor is a value smaller than 1, which is used to
35472 * decrease the step-size during RPROP training.
35473 *
35474 * The default decrease factor is 0.5.
35475 *
35476 * @param resource $ann
35477 * @return float The decrease factor, or FALSE on error.
35478 * @since PECL fann >= 1.0.0
35479 **/
35480function fann_get_rprop_decrease_factor($ann){}
35481
35482/**
35483 * Returns the maximum step-size
35484 *
35485 * The maximum step-size is a positive number determining how large the
35486 * maximum step-size may be.
35487 *
35488 * The default delta max is 50.0.
35489 *
35490 * @param resource $ann
35491 * @return float The maximum step-size, or FALSE on error.
35492 * @since PECL fann >= 1.0.0
35493 **/
35494function fann_get_rprop_delta_max($ann){}
35495
35496/**
35497 * Returns the minimum step-size
35498 *
35499 * The minimum step-size is a small positive number determining how small
35500 * the minimum step-size may be.
35501 *
35502 * The default value delta min is 0.0.
35503 *
35504 * @param resource $ann
35505 * @return float The minimum step-size, or FALSE on error.
35506 * @since PECL fann >= 1.0.0
35507 **/
35508function fann_get_rprop_delta_min($ann){}
35509
35510/**
35511 * Returns the initial step-size
35512 *
35513 * The initial step-size is a positive number determining the initial
35514 * step size.
35515 *
35516 * The default delta zero is 0.1.
35517 *
35518 * @param resource $ann
35519 * @return int The initial step-size, or FALSE on error.
35520 * @since PECL fann >= 1.0.0
35521 **/
35522function fann_get_rprop_delta_zero($ann){}
35523
35524/**
35525 * Returns the increase factor used during RPROP training
35526 *
35527 * The increase factor is a value larger than 1, which is used to
35528 * increase the step-size during RPROP training.
35529 *
35530 * The default increase factor is 1.2.
35531 *
35532 * @param resource $ann
35533 * @return float The increase factor, or FALSE on error.
35534 * @since PECL fann >= 1.0.0
35535 **/
35536function fann_get_rprop_increase_factor($ann){}
35537
35538/**
35539 * Returns the sarprop step error shift
35540 *
35541 * The default step error shift is 1.385.
35542 *
35543 * @param resource $ann
35544 * @return float The sarprop step error shift , or FALSE on error.
35545 * @since PECL fann >= 1.0.0
35546 **/
35547function fann_get_sarprop_step_error_shift($ann){}
35548
35549/**
35550 * Returns the sarprop step error threshold factor
35551 *
35552 * The sarprop step error threshold factor.
35553 *
35554 * The default factor is 0.1.
35555 *
35556 * @param resource $ann
35557 * @return float The sarprop step error threshold factor, or FALSE on
35558 *   error.
35559 * @since PECL fann >= 1.0.0
35560 **/
35561function fann_get_sarprop_step_error_threshold_factor($ann){}
35562
35563/**
35564 * Returns the sarprop temperature
35565 *
35566 * The default temperature is 0.015.
35567 *
35568 * @param resource $ann
35569 * @return float The sarprop temperature, or FALSE on error.
35570 * @since PECL fann >= 1.0.0
35571 **/
35572function fann_get_sarprop_temperature($ann){}
35573
35574/**
35575 * Returns the sarprop weight decay shift
35576 *
35577 * The sarprop weight decay shift.
35578 *
35579 * The default delta max is -6.644.
35580 *
35581 * @param resource $ann
35582 * @return float The sarprop weight decay shift, or FALSE on error.
35583 * @since PECL fann >= 1.0.0
35584 **/
35585function fann_get_sarprop_weight_decay_shift($ann){}
35586
35587/**
35588 * Get the total number of connections in the entire network
35589 *
35590 * @param resource $ann
35591 * @return int Total number of connections in the entire network, or
35592 *   FALSE on error
35593 * @since PECL fann >= 1.0.0
35594 **/
35595function fann_get_total_connections($ann){}
35596
35597/**
35598 * Get the total number of neurons in the entire network
35599 *
35600 * Get the total number of neurons in the entire network. This number
35601 * does also include the bias neurons, so a 2-4-2 network has 2+4+2
35602 * +2(bias) = 10 neurons.
35603 *
35604 * @param resource $ann
35605 * @return int Total number of neurons in the entire network, or FALSE
35606 *   on error.
35607 * @since PECL fann >= 1.0.0
35608 **/
35609function fann_get_total_neurons($ann){}
35610
35611/**
35612 * Returns the training algorithm
35613 *
35614 * Returns the training algorithm. This training algorithm is used by
35615 * {@link fann_train_on_data} and associated functions.
35616 *
35617 * Note that this algorithm is also used during {@link
35618 * fann_cascadetrain_on_data}, although only FANN_TRAIN_RPROP and
35619 * FANN_TRAIN_QUICKPROP is allowed during cascade training.
35620 *
35621 * @param resource $ann
35622 * @return int Training algorithm constant, or FALSE on error.
35623 * @since PECL fann >= 1.0.0
35624 **/
35625function fann_get_training_algorithm($ann){}
35626
35627/**
35628 * Returns the error function used during training
35629 *
35630 * The error functions are described further in error functions
35631 * constants.
35632 *
35633 * The default error function is FANN_ERRORFUNC_TANH.
35634 *
35635 * @param resource $ann
35636 * @return int The error function constant, or FALSE on error.
35637 * @since PECL fann >= 1.0.0
35638 **/
35639function fann_get_train_error_function($ann){}
35640
35641/**
35642 * Returns the stop function used during training
35643 *
35644 * The stop functions are described further in stop functions constants.
35645 *
35646 * The default stop function is FANN_STOPFUNC_MSE.
35647 *
35648 * @param resource $ann
35649 * @return int The stop function constant, or FALSE on error.
35650 * @since PECL fann >= 1.0.0
35651 **/
35652function fann_get_train_stop_function($ann){}
35653
35654/**
35655 * Initialize the weights using Widrow + Nguyen’s algorithm
35656 *
35657 * This function behaves similarly to {@link fann_randomize_weights}. It
35658 * will use the algorithm developed by Derrick Nguyen and Bernard Widrow
35659 * to set the weights in such a way as to speed up training. This
35660 * technique is not always successful, and in some cases can be less
35661 * efficient than a purely random initialization.
35662 *
35663 * The algorithm requires access to the range of the input data (for
35664 * example largest and smallest input), and therefore accepts a second
35665 * argument, data, which is the training data that will be used to train
35666 * the network.
35667 *
35668 * @param resource $ann
35669 * @param resource $train_data
35670 * @return bool
35671 * @since PECL fann >= 1.0.0
35672 **/
35673function fann_init_weights($ann, $train_data){}
35674
35675/**
35676 * Returns the number of training patterns in the train data
35677 *
35678 * Returns the number of training patterns in the train data resource.
35679 *
35680 * @param resource $data
35681 * @return int Number of elements in the train data resource, or FALSE
35682 *   on error.
35683 * @since PECL fann >= 1.0.0
35684 **/
35685function fann_length_train_data($data){}
35686
35687/**
35688 * Merges the train data
35689 *
35690 * Merges the data from data1 and data2 into a new train data resource.
35691 *
35692 * @param resource $data1
35693 * @param resource $data2
35694 * @return resource New merged train data resource, or FALSE on error.
35695 * @since PECL fann >= 1.0.0
35696 **/
35697function fann_merge_train_data($data1, $data2){}
35698
35699/**
35700 * Returns the number of inputs in each of the training patterns in the
35701 * train data
35702 *
35703 * Returns the number of inputs in each of the training patterns in the
35704 * train data resource.
35705 *
35706 * @param resource $data
35707 * @return int The number of inputs, or FALSE on error.
35708 * @since PECL fann >= 1.0.0
35709 **/
35710function fann_num_input_train_data($data){}
35711
35712/**
35713 * Returns the number of outputs in each of the training patterns in the
35714 * train data
35715 *
35716 * Returns the number of outputs in each of the training patterns in the
35717 * train data resource.
35718 *
35719 * @param resource $data
35720 * @return int The number of outputs, or FALSE on error.
35721 * @since PECL fann >= 1.0.0
35722 **/
35723function fann_num_output_train_data($data){}
35724
35725/**
35726 * Prints the error string
35727 *
35728 * @param resource $errdat
35729 * @return void
35730 * @since PECL fann >= 1.0.0
35731 **/
35732function fann_print_error($errdat){}
35733
35734/**
35735 * Give each connection a random weight between min_weight and max_weight
35736 *
35737 * Give each connection a random weight between {@link min_weight} and
35738 * {@link max_weight}
35739 *
35740 * From the beginning the weights are random between -0.1 and 0.1.
35741 *
35742 * @param resource $ann
35743 * @param float $min_weight Minimum weight value
35744 * @param float $max_weight Maximum weight value
35745 * @return bool
35746 * @since PECL fann >= 1.0.0
35747 **/
35748function fann_randomize_weights($ann, $min_weight, $max_weight){}
35749
35750/**
35751 * Reads a file that stores training data
35752 *
35753 * @param string $filename The input file in the following format:
35754 * @return resource
35755 * @since PECL fann >= 1.0.0
35756 **/
35757function fann_read_train_from_file($filename){}
35758
35759/**
35760 * Resets the last error number
35761 *
35762 * @param resource $errdat
35763 * @return void
35764 * @since PECL fann >= 1.0.0
35765 **/
35766function fann_reset_errno($errdat){}
35767
35768/**
35769 * Resets the last error string
35770 *
35771 * @param resource $errdat
35772 * @return void
35773 * @since PECL fann >= 1.0.0
35774 **/
35775function fann_reset_errstr($errdat){}
35776
35777/**
35778 * Resets the mean square error from the network
35779 *
35780 * This function also resets the number of bits that fail.
35781 *
35782 * @param string $ann
35783 * @return bool
35784 * @since PECL fann >= 1.0.0
35785 **/
35786function fann_reset_MSE($ann){}
35787
35788/**
35789 * Will run input through the neural network
35790 *
35791 * Will run input through the neural network, returning an array of
35792 * outputs, the number of which being equal to the number of neurons in
35793 * the output layer.
35794 *
35795 * @param resource $ann
35796 * @param array $input Array of input values
35797 * @return array Array of output values, or FALSE on error
35798 * @since PECL fann >= 1.0.0
35799 **/
35800function fann_run($ann, $input){}
35801
35802/**
35803 * Saves the entire network to a configuration file
35804 *
35805 * The configuration file contains all information about the neural
35806 * network and enables {@link fann_create_from_file} to create an exact
35807 * copy of the neural network and all of the parameters associated with
35808 * the neural network.
35809 *
35810 * These three parameters ({@link fann_set_callback}, {@link
35811 * fann_set_error_log}, {@link fann_set_user_data}) are NOT saved to the
35812 * file because they cannot safely be ported to a different location.
35813 * Also temporary parameters generated during training like {@link
35814 * fann_get_MSE} is not saved.
35815 *
35816 * @param resource $ann
35817 * @param string $configuration_file The configuration file path.
35818 * @return bool
35819 * @since PECL fann >= 1.0.0
35820 **/
35821function fann_save($ann, $configuration_file){}
35822
35823/**
35824 * Save the training structure to a file
35825 *
35826 * Save the training data to a file, with the format as specified in
35827 * {@link fann_read_train_from_file}.
35828 *
35829 * @param resource $data
35830 * @param string $file_name The file name of the file where training
35831 *   data is saved to.
35832 * @return bool
35833 * @since PECL fann >= 1.0.0
35834 **/
35835function fann_save_train($data, $file_name){}
35836
35837/**
35838 * Scale data in input vector before feed it to ann based on previously
35839 * calculated parameters
35840 *
35841 * @param resource $ann
35842 * @param array $input_vector Input vector that will be scaled
35843 * @return bool
35844 * @since PECL fann >= 1.0.0
35845 **/
35846function fann_scale_input($ann, $input_vector){}
35847
35848/**
35849 * Scales the inputs in the training data to the specified range
35850 *
35851 * @param resource $train_data
35852 * @param float $new_min New minimum after scaling inputs in training
35853 *   data.
35854 * @param float $new_max New maximum after scaling inputs in training
35855 *   data.
35856 * @return bool
35857 * @since PECL fann >= 1.0.0
35858 **/
35859function fann_scale_input_train_data($train_data, $new_min, $new_max){}
35860
35861/**
35862 * Scale data in output vector before feed it to ann based on previously
35863 * calculated parameters
35864 *
35865 * @param resource $ann
35866 * @param array $output_vector Output vector that will be scaled
35867 * @return bool
35868 * @since PECL fann >= 1.0.0
35869 **/
35870function fann_scale_output($ann, $output_vector){}
35871
35872/**
35873 * Scales the outputs in the training data to the specified range
35874 *
35875 * @param resource $train_data
35876 * @param float $new_min New minimum after scaling outputs in training
35877 *   data.
35878 * @param float $new_max New maximum after scaling outputs in training
35879 *   data.
35880 * @return bool
35881 * @since PECL fann >= 1.0.0
35882 **/
35883function fann_scale_output_train_data($train_data, $new_min, $new_max){}
35884
35885/**
35886 * Scale input and output data based on previously calculated parameters
35887 *
35888 * @param resource $ann
35889 * @param resource $train_data
35890 * @return bool
35891 * @since PECL fann >= 1.0.0
35892 **/
35893function fann_scale_train($ann, $train_data){}
35894
35895/**
35896 * Scales the inputs and outputs in the training data to the specified
35897 * range
35898 *
35899 * @param resource $train_data
35900 * @param float $new_min New minimum after scaling inputs and outputs
35901 *   in training data.
35902 * @param float $new_max New maximum after scaling inputs and outputs
35903 *   in training data.
35904 * @return bool
35905 * @since PECL fann >= 1.0.0
35906 **/
35907function fann_scale_train_data($train_data, $new_min, $new_max){}
35908
35909/**
35910 * Sets the activation function for supplied neuron and layer
35911 *
35912 * Set the activation function for neuron number neuron in layer number
35913 * layer, counting the input layer as layer 0.
35914 *
35915 * It is not possible to set activation functions for the neurons in the
35916 * input layer.
35917 *
35918 * When choosing an activation function it is important to note that the
35919 * activation functions have different range. FANN_SIGMOID is e.g. in the
35920 * 0 - 1 range while FANN_SIGMOID_SYMMETRIC is in the -1 - 1 range and
35921 * FANN_LINEAR is unbound.
35922 *
35923 * The supplied activation_function value must be one of the activation
35924 * functions constants.
35925 *
35926 * The return value is one of the activation functions constants.
35927 *
35928 * @param resource $ann
35929 * @param int $activation_function The activation functions constant.
35930 * @param int $layer Layer number.
35931 * @param int $neuron Neuron number.
35932 * @return bool
35933 * @since PECL fann >= 1.0.0
35934 **/
35935function fann_set_activation_function($ann, $activation_function, $layer, $neuron){}
35936
35937/**
35938 * Sets the activation function for all of the hidden layers
35939 *
35940 * @param resource $ann
35941 * @param int $activation_function The activation functions constant.
35942 * @return bool
35943 * @since PECL fann >= 1.0.0
35944 **/
35945function fann_set_activation_function_hidden($ann, $activation_function){}
35946
35947/**
35948 * Sets the activation function for all the neurons in the supplied layer
35949 *
35950 * Set the activation function for all the neurons in the layer number
35951 * layer, counting the input layer as layer 0.
35952 *
35953 * It is not possible to set activation functions for the neurons in the
35954 * input layer.
35955 *
35956 * @param resource $ann
35957 * @param int $activation_function The activation functions constant.
35958 * @param int $layer Layer number.
35959 * @return bool
35960 * @since PECL fann >= 1.0.0
35961 **/
35962function fann_set_activation_function_layer($ann, $activation_function, $layer){}
35963
35964/**
35965 * Sets the activation function for the output layer
35966 *
35967 * @param resource $ann
35968 * @param int $activation_function The activation functions constant.
35969 * @return bool
35970 * @since PECL fann >= 1.0.0
35971 **/
35972function fann_set_activation_function_output($ann, $activation_function){}
35973
35974/**
35975 * Sets the activation steepness for supplied neuron and layer number
35976 *
35977 * Set the activation steepness for neuron number neuron in layer number
35978 * layer, counting the input layer as layer 0.
35979 *
35980 * It is not possible to set activation steepness for the neurons in the
35981 * input layer.
35982 *
35983 * The steepness of an activation function says something about how fast
35984 * the activation function goes from the minimum to the maximum. A high
35985 * value for the activation function will also give a more agressive
35986 * training.
35987 *
35988 * When training neural networks where the output values should be at the
35989 * extremes (usually 0 and 1, depending on the activation function), a
35990 * steep activation function can be used (e.g. 1.0).
35991 *
35992 * The default activation steepness is 0.5.
35993 *
35994 * @param resource $ann
35995 * @param float $activation_steepness The activation steepness.
35996 * @param int $layer Layer number.
35997 * @param int $neuron Neuron number.
35998 * @return bool
35999 * @since PECL fann >= 1.0.0
36000 **/
36001function fann_set_activation_steepness($ann, $activation_steepness, $layer, $neuron){}
36002
36003/**
36004 * Sets the steepness of the activation steepness for all neurons in the
36005 * all hidden layers
36006 *
36007 * @param resource $ann
36008 * @param float $activation_steepness The activation steepness.
36009 * @return bool
36010 * @since PECL fann >= 1.0.0
36011 **/
36012function fann_set_activation_steepness_hidden($ann, $activation_steepness){}
36013
36014/**
36015 * Sets the activation steepness for all of the neurons in the supplied
36016 * layer number
36017 *
36018 * Set the activation steepness for all of the neurons in layer number
36019 * layer, counting the input layer as layer 0.
36020 *
36021 * It is not possible to set activation steepness for the neurons in the
36022 * input layer.
36023 *
36024 * @param resource $ann
36025 * @param float $activation_steepness The activation steepness.
36026 * @param int $layer Layer number.
36027 * @return bool
36028 * @since PECL fann >= 1.0.0
36029 **/
36030function fann_set_activation_steepness_layer($ann, $activation_steepness, $layer){}
36031
36032/**
36033 * Sets the steepness of the activation steepness in the output layer
36034 *
36035 * @param resource $ann
36036 * @param float $activation_steepness The activation steepness.
36037 * @return bool
36038 * @since PECL fann >= 1.0.0
36039 **/
36040function fann_set_activation_steepness_output($ann, $activation_steepness){}
36041
36042/**
36043 * Set the bit fail limit used during training
36044 *
36045 * @param resource $ann
36046 * @param float $bit_fail_limit The bit fail limit.
36047 * @return bool
36048 * @since PECL fann >= 1.0.0
36049 **/
36050function fann_set_bit_fail_limit($ann, $bit_fail_limit){}
36051
36052/**
36053 * Sets the callback function for use during training
36054 *
36055 * Sets the callback function for use during training. It means that it
36056 * is called from {@link fann_train_on_data} or {@link
36057 * fann_train_on_file}.
36058 *
36059 * @param resource $ann
36060 * @param callable $callback The supplied callback function takes
36061 *   following parameters: ann - The neural network resource train - The
36062 *   train data resource or NULL if called from {@link
36063 *   fann_train_on_file} max_epochs - The maximum number of epochs the
36064 *   training should continue epochs_between_reports - The number of
36065 *   epochs between calling this function desired_error - The desired
36066 *   {@link fann_get_MSE} or {@link fann_get_bit_fail}, depending on the
36067 *   stop function chosen by {@link fann_set_train_stop_function} epochs
36068 *   - The current epoch The callback should return TRUE. If it returns
36069 *   FALSE, the training will terminate.
36070 * @return bool
36071 * @since PECL fann >= 1.0.0
36072 **/
36073function fann_set_callback($ann, $callback){}
36074
36075/**
36076 * Sets the array of cascade candidate activation functions
36077 *
36078 * See {@link fann_get_cascade_num_candidates} for a description of which
36079 * candidate neurons will be generated by this array.
36080 *
36081 * @param resource $ann
36082 * @param array $cascade_activation_functions The array of cascade
36083 *   candidate activation functions.
36084 * @return bool
36085 * @since PECL fann >= 1.0.0
36086 **/
36087function fann_set_cascade_activation_functions($ann, $cascade_activation_functions){}
36088
36089/**
36090 * Sets the array of cascade candidate activation steepnesses
36091 *
36092 * See {@link fann_get_cascade_num_candidates} for a description of which
36093 * candidate neurons will be generated by this array.
36094 *
36095 * @param resource $ann
36096 * @param array $cascade_activation_steepnesses_count The array of
36097 *   cascade candidate activation steepnesses.
36098 * @return bool
36099 * @since PECL fann >= 1.0.0
36100 **/
36101function fann_set_cascade_activation_steepnesses($ann, $cascade_activation_steepnesses_count){}
36102
36103/**
36104 * Sets the cascade candidate change fraction
36105 *
36106 * @param resource $ann
36107 * @param float $cascade_candidate_change_fraction The cascade
36108 *   candidate change fraction.
36109 * @return bool
36110 * @since PECL fann >= 1.0.0
36111 **/
36112function fann_set_cascade_candidate_change_fraction($ann, $cascade_candidate_change_fraction){}
36113
36114/**
36115 * Sets the candidate limit
36116 *
36117 * @param resource $ann
36118 * @param float $cascade_candidate_limit The candidate limit.
36119 * @return bool
36120 * @since PECL fann >= 1.0.0
36121 **/
36122function fann_set_cascade_candidate_limit($ann, $cascade_candidate_limit){}
36123
36124/**
36125 * Sets the number of cascade candidate stagnation epochs
36126 *
36127 * @param resource $ann
36128 * @param int $cascade_candidate_stagnation_epochs The number of
36129 *   cascade candidate stagnation epochs.
36130 * @return bool
36131 * @since PECL fann >= 1.0.0
36132 **/
36133function fann_set_cascade_candidate_stagnation_epochs($ann, $cascade_candidate_stagnation_epochs){}
36134
36135/**
36136 * Sets the max candidate epochs
36137 *
36138 * @param resource $ann
36139 * @param int $cascade_max_cand_epochs The max candidate epochs.
36140 * @return bool
36141 * @since PECL fann >= 1.0.0
36142 **/
36143function fann_set_cascade_max_cand_epochs($ann, $cascade_max_cand_epochs){}
36144
36145/**
36146 * Sets the maximum out epochs
36147 *
36148 * @param resource $ann
36149 * @param int $cascade_max_out_epochs The maximum out epochs.
36150 * @return bool
36151 * @since PECL fann >= 1.0.0
36152 **/
36153function fann_set_cascade_max_out_epochs($ann, $cascade_max_out_epochs){}
36154
36155/**
36156 * Sets the min candidate epochs
36157 *
36158 * @param resource $ann
36159 * @param int $cascade_min_cand_epochs The minimum candidate epochs.
36160 * @return bool
36161 * @since PECL fann >= 1.0.0
36162 **/
36163function fann_set_cascade_min_cand_epochs($ann, $cascade_min_cand_epochs){}
36164
36165/**
36166 * Sets the minimum out epochs
36167 *
36168 * @param resource $ann
36169 * @param int $cascade_min_out_epochs The minimum out epochs.
36170 * @return bool
36171 * @since PECL fann >= 1.0.0
36172 **/
36173function fann_set_cascade_min_out_epochs($ann, $cascade_min_out_epochs){}
36174
36175/**
36176 * Sets the number of candidate groups
36177 *
36178 * @param resource $ann
36179 * @param int $cascade_num_candidate_groups The number of candidate
36180 *   groups.
36181 * @return bool
36182 * @since PECL fann >= 1.0.0
36183 **/
36184function fann_set_cascade_num_candidate_groups($ann, $cascade_num_candidate_groups){}
36185
36186/**
36187 * Sets the cascade output change fraction
36188 *
36189 * @param resource $ann
36190 * @param float $cascade_output_change_fraction The cascade output
36191 *   change fraction.
36192 * @return bool
36193 * @since PECL fann >= 1.0.0
36194 **/
36195function fann_set_cascade_output_change_fraction($ann, $cascade_output_change_fraction){}
36196
36197/**
36198 * Sets the number of cascade output stagnation epochs
36199 *
36200 * @param resource $ann
36201 * @param int $cascade_output_stagnation_epochs The number of cascade
36202 *   output stagnation epochs.
36203 * @return bool
36204 * @since PECL fann >= 1.0.0
36205 **/
36206function fann_set_cascade_output_stagnation_epochs($ann, $cascade_output_stagnation_epochs){}
36207
36208/**
36209 * Sets the weight multiplier
36210 *
36211 * @param resource $ann
36212 * @param float $cascade_weight_multiplier The weight multiplier.
36213 * @return bool
36214 * @since PECL fann >= 1.0.0
36215 **/
36216function fann_set_cascade_weight_multiplier($ann, $cascade_weight_multiplier){}
36217
36218/**
36219 * Sets where the errors are logged to
36220 *
36221 * @param resource $errdat
36222 * @param string $log_file The log file path.
36223 * @return void
36224 * @since PECL fann >= 1.0.0
36225 **/
36226function fann_set_error_log($errdat, $log_file){}
36227
36228/**
36229 * Calculate input scaling parameters for future use based on training
36230 * data
36231 *
36232 * @param resource $ann
36233 * @param resource $train_data
36234 * @param float $new_input_min The desired lower bound in input data
36235 *   after scaling (not strictly followed)
36236 * @param float $new_input_max The desired upper bound in input data
36237 *   after scaling (not strictly followed)
36238 * @return bool
36239 * @since PECL fann >= 1.0.0
36240 **/
36241function fann_set_input_scaling_params($ann, $train_data, $new_input_min, $new_input_max){}
36242
36243/**
36244 * Sets the learning momentum
36245 *
36246 * More info available in {@link fann_get_learning_momentum}.
36247 *
36248 * @param resource $ann
36249 * @param float $learning_momentum The learning momentum.
36250 * @return bool
36251 * @since PECL fann >= 1.0.0
36252 **/
36253function fann_set_learning_momentum($ann, $learning_momentum){}
36254
36255/**
36256 * Sets the learning rate
36257 *
36258 * More info available in {@link fann_get_learning_rate}.
36259 *
36260 * @param resource $ann
36261 * @param float $learning_rate The learning rate.
36262 * @return bool
36263 * @since PECL fann >= 1.0.0
36264 **/
36265function fann_set_learning_rate($ann, $learning_rate){}
36266
36267/**
36268 * Calculate output scaling parameters for future use based on training
36269 * data
36270 *
36271 * @param resource $ann
36272 * @param resource $train_data
36273 * @param float $new_output_min The desired lower bound in output data
36274 *   after scaling (not strictly followed)
36275 * @param float $new_output_max The desired upper bound in output data
36276 *   after scaling (not strictly followed)
36277 * @return bool
36278 * @since PECL fann >= 1.0.0
36279 **/
36280function fann_set_output_scaling_params($ann, $train_data, $new_output_min, $new_output_max){}
36281
36282/**
36283 * Sets the quickprop decay factor
36284 *
36285 * @param resource $ann
36286 * @param float $quickprop_decay The quickprop decay factor.
36287 * @return bool
36288 * @since PECL fann >= 1.0.0
36289 **/
36290function fann_set_quickprop_decay($ann, $quickprop_decay){}
36291
36292/**
36293 * Sets the quickprop mu factor
36294 *
36295 * @param resource $ann
36296 * @param float $quickprop_mu The mu factor.
36297 * @return bool
36298 * @since PECL fann >= 1.0.0
36299 **/
36300function fann_set_quickprop_mu($ann, $quickprop_mu){}
36301
36302/**
36303 * Sets the decrease factor used during RPROP training
36304 *
36305 * @param resource $ann
36306 * @param float $rprop_decrease_factor The decrease factor.
36307 * @return bool
36308 * @since PECL fann >= 1.0.0
36309 **/
36310function fann_set_rprop_decrease_factor($ann, $rprop_decrease_factor){}
36311
36312/**
36313 * Sets the maximum step-size
36314 *
36315 * The maximum step-size is a positive number determining how large the
36316 * maximum step-size may be.
36317 *
36318 * @param resource $ann
36319 * @param float $rprop_delta_max The maximum step-size.
36320 * @return bool
36321 * @since PECL fann >= 1.0.0
36322 **/
36323function fann_set_rprop_delta_max($ann, $rprop_delta_max){}
36324
36325/**
36326 * Sets the minimum step-size
36327 *
36328 * The minimum step-size is a small positive number determining how small
36329 * the minimum step-size may be.
36330 *
36331 * @param resource $ann
36332 * @param float $rprop_delta_min The minimum step-size.
36333 * @return bool
36334 * @since PECL fann >= 1.0.0
36335 **/
36336function fann_set_rprop_delta_min($ann, $rprop_delta_min){}
36337
36338/**
36339 * Sets the initial step-size
36340 *
36341 * The initial step-size is a positive number determining the initial
36342 * step size.
36343 *
36344 * @param resource $ann
36345 * @param float $rprop_delta_zero The initial step-size.
36346 * @return bool
36347 * @since PECL fann >= 1.0.0
36348 **/
36349function fann_set_rprop_delta_zero($ann, $rprop_delta_zero){}
36350
36351/**
36352 * Sets the increase factor used during RPROP training
36353 *
36354 * @param resource $ann
36355 * @param float $rprop_increase_factor The increase factor.
36356 * @return bool
36357 * @since PECL fann >= 1.0.0
36358 **/
36359function fann_set_rprop_increase_factor($ann, $rprop_increase_factor){}
36360
36361/**
36362 * Sets the sarprop step error shift
36363 *
36364 * @param resource $ann
36365 * @param float $sarprop_step_error_shift The sarprop step error shift.
36366 * @return bool
36367 * @since PECL fann >= 1.0.0
36368 **/
36369function fann_set_sarprop_step_error_shift($ann, $sarprop_step_error_shift){}
36370
36371/**
36372 * Sets the sarprop step error threshold factor
36373 *
36374 * @param resource $ann
36375 * @param float $sarprop_step_error_threshold_factor The sarprop step
36376 *   error threshold factor.
36377 * @return bool
36378 * @since PECL fann >= 1.0.0
36379 **/
36380function fann_set_sarprop_step_error_threshold_factor($ann, $sarprop_step_error_threshold_factor){}
36381
36382/**
36383 * Sets the sarprop temperature
36384 *
36385 * @param resource $ann
36386 * @param float $sarprop_temperature The sarprop temperature.
36387 * @return bool
36388 * @since PECL fann >= 1.0.0
36389 **/
36390function fann_set_sarprop_temperature($ann, $sarprop_temperature){}
36391
36392/**
36393 * Sets the sarprop weight decay shift
36394 *
36395 * @param resource $ann
36396 * @param float $sarprop_weight_decay_shift The sarprop weight decay
36397 *   shift.
36398 * @return bool
36399 * @since PECL fann >= 1.0.0
36400 **/
36401function fann_set_sarprop_weight_decay_shift($ann, $sarprop_weight_decay_shift){}
36402
36403/**
36404 * Calculate input and output scaling parameters for future use based on
36405 * training data
36406 *
36407 * @param resource $ann
36408 * @param resource $train_data
36409 * @param float $new_input_min The desired lower bound in input data
36410 *   after scaling (not strictly followed)
36411 * @param float $new_input_max The desired upper bound in input data
36412 *   after scaling (not strictly followed)
36413 * @param float $new_output_min The desired lower bound in output data
36414 *   after scaling (not strictly followed)
36415 * @param float $new_output_max The desired upper bound in output data
36416 *   after scaling (not strictly followed)
36417 * @return bool
36418 * @since PECL fann >= 1.0.0
36419 **/
36420function fann_set_scaling_params($ann, $train_data, $new_input_min, $new_input_max, $new_output_min, $new_output_max){}
36421
36422/**
36423 * Sets the training algorithm
36424 *
36425 * More info available in {@link fann_get_training_algorithm}.
36426 *
36427 * @param resource $ann
36428 * @param int $training_algorithm Training algorithm constant
36429 * @return bool
36430 * @since PECL fann >= 1.0.0
36431 **/
36432function fann_set_training_algorithm($ann, $training_algorithm){}
36433
36434/**
36435 * Sets the error function used during training
36436 *
36437 * The error functions are described further in error functions
36438 * constants.
36439 *
36440 * @param resource $ann
36441 * @param int $error_function The error function constant
36442 * @return bool
36443 * @since PECL fann >= 1.0.0
36444 **/
36445function fann_set_train_error_function($ann, $error_function){}
36446
36447/**
36448 * Sets the stop function used during training
36449 *
36450 * The stop functions are described further in stop functions constants.
36451 *
36452 * @param resource $ann
36453 * @param int $stop_function The stop function constant.
36454 * @return bool
36455 * @since PECL fann >= 1.0.0
36456 **/
36457function fann_set_train_stop_function($ann, $stop_function){}
36458
36459/**
36460 * Set a connection in the network
36461 *
36462 * Set a connections in the network.
36463 *
36464 * @param resource $ann
36465 * @param int $from_neuron The neuron where the connection starts
36466 * @param int $to_neuron The neuron where the connection ends
36467 * @param float $weight Connection weight
36468 * @return bool
36469 * @since PECL fann >= 1.0.0
36470 **/
36471function fann_set_weight($ann, $from_neuron, $to_neuron, $weight){}
36472
36473/**
36474 * Set connections in the network
36475 *
36476 * Only the weights can be changed, connections and weights are ignored
36477 * if they do not already exist in the network.
36478 *
36479 * @param resource $ann
36480 * @param array $connections An array of FANNConnection objects
36481 * @return bool
36482 * @since PECL fann >= 1.0.0
36483 **/
36484function fann_set_weight_array($ann, $connections){}
36485
36486/**
36487 * Shuffles training data, randomizing the order
36488 *
36489 * Shuffles training data, randomizing the order. This is recommended for
36490 * incremental training, while it have no influence during batch
36491 * training.
36492 *
36493 * @param resource $train_data
36494 * @return bool
36495 * @since PECL fann >= 1.0.0
36496 **/
36497function fann_shuffle_train_data($train_data){}
36498
36499/**
36500 * Returns an copy of a subset of the train data
36501 *
36502 * Returns an copy of a subset of the train data resource, starting at
36503 * position pos and length elements forward.
36504 *
36505 * The fann_subset_train_data(train_data, 0,
36506 * fann_length_train_data(train_data)) do the same as {@link
36507 * fann_duplicate_train_data}
36508 *
36509 * @param resource $data
36510 * @param int $pos Starting position.
36511 * @param int $length The number of copied elements.
36512 * @return resource
36513 * @since PECL fann >= 1.0.0
36514 **/
36515function fann_subset_train_data($data, $pos, $length){}
36516
36517/**
36518 * Test with a set of inputs, and a set of desired outputs
36519 *
36520 * Test with a set of inputs, and a set of desired outputs. This
36521 * operation updates the mean square error, but does not change the
36522 * network in any way.
36523 *
36524 * @param resource $ann
36525 * @param array $input An array of inputs. This array must be exactly
36526 *   {@link fann_get_num_input} long.
36527 * @param array $desired_output An array of desired outputs. This array
36528 *   must be exactly {@link fann_get_num_output} long.
36529 * @return array Returns test outputs on success, or FALSE on error.
36530 * @since PECL fann >= 1.0.0
36531 **/
36532function fann_test($ann, $input, $desired_output){}
36533
36534/**
36535 * Test a set of training data and calculates the MSE for the training
36536 * data
36537 *
36538 * This function updates the MSE and the bit fail values.
36539 *
36540 * @param resource $ann
36541 * @param resource $data
36542 * @return float The updated MSE, or FALSE on error.
36543 * @since PECL fann >= 1.0.0
36544 **/
36545function fann_test_data($ann, $data){}
36546
36547/**
36548 * Train one iteration with a set of inputs, and a set of desired outputs
36549 *
36550 * Train one iteration with a set of inputs, and a set of desired
36551 * outputs. This training is always incremental training, since only one
36552 * pattern is presented.
36553 *
36554 * @param resource $ann
36555 * @param array $input An array of inputs. This array must be exactly
36556 *   {@link fann_get_num_input} long.
36557 * @param array $desired_output An array of desired outputs. This array
36558 *   must be exactly {@link fann_get_num_output} long.
36559 * @return bool
36560 * @since PECL fann >= 1.0.0
36561 **/
36562function fann_train($ann, $input, $desired_output){}
36563
36564/**
36565 * Train one epoch with a set of training data
36566 *
36567 * Train one epoch with the training data stored in data. One epoch is
36568 * where all of the training data is considered exactly once.
36569 *
36570 * This function returns the MSE error as it is calculated either before
36571 * or during the actual training. This is not the actual MSE after the
36572 * training epoch, but since calculating this will require to go through
36573 * the entire training set once more. It is more than adequate to use
36574 * this value during training.
36575 *
36576 * The training algorithm used by this function is chosen by {@link
36577 * fann_set_training_algorithm} function.
36578 *
36579 * @param resource $ann
36580 * @param resource $data
36581 * @return float The MSE, or FALSE on error.
36582 * @since PECL fann >= 1.0.0
36583 **/
36584function fann_train_epoch($ann, $data){}
36585
36586/**
36587 * Trains on an entire dataset for a period of time
36588 *
36589 * This training uses the training algorithm chosen by {@link
36590 * fann_set_training_algorithm} and the parameters set for these training
36591 * algorithms.
36592 *
36593 * @param resource $ann
36594 * @param resource $data
36595 * @param int $max_epochs The maximum number of epochs the training
36596 *   should continue
36597 * @param int $epochs_between_reports The number of epochs between
36598 *   calling a callback function. A value of zero means that user
36599 *   function is not called.
36600 * @param float $desired_error The desired {@link fann_get_MSE} or
36601 *   {@link fann_get_bit_fail}, depending on the stop function chosen by
36602 *   {@link fann_set_train_stop_function}
36603 * @return bool
36604 * @since PECL fann >= 1.0.0
36605 **/
36606function fann_train_on_data($ann, $data, $max_epochs, $epochs_between_reports, $desired_error){}
36607
36608/**
36609 * Trains on an entire dataset, which is read from file, for a period of
36610 * time
36611 *
36612 * This training uses the training algorithm chosen by {@link
36613 * fann_set_training_algorithm} and the parameters set for these training
36614 * algorithms.
36615 *
36616 * @param resource $ann
36617 * @param string $filename The file containing train data
36618 * @param int $max_epochs The maximum number of epochs the training
36619 *   should continue
36620 * @param int $epochs_between_reports The number of epochs between
36621 *   calling a user function. A value of zero means that user function is
36622 *   not called.
36623 * @param float $desired_error The desired {@link fann_get_MSE} or
36624 *   {@link fann_get_bit_fail}, depending on the stop function chosen by
36625 *   {@link fann_set_train_stop_function}
36626 * @return bool
36627 * @since PECL fann >= 1.0.0
36628 **/
36629function fann_train_on_file($ann, $filename, $max_epochs, $epochs_between_reports, $desired_error){}
36630
36631/**
36632 * Flushes all response data to the client
36633 *
36634 * This function flushes all response data to the client and finishes the
36635 * request. This allows for time consuming tasks to be performed without
36636 * leaving the connection to the client open.
36637 *
36638 * @return bool
36639 * @since PHP 5 >= 5.3.3, PHP 7
36640 **/
36641function fastcgi_finish_request(){}
36642
36643/**
36644 * Add a user to a security database
36645 *
36646 * @param resource $service_handle The handle on the database server
36647 *   service.
36648 * @param string $user_name The login name of the new database user.
36649 * @param string $password The password of the new user.
36650 * @param string $first_name The first name of the new database user.
36651 * @param string $middle_name The middle name of the new database user.
36652 * @param string $last_name The last name of the new database user.
36653 * @return bool
36654 * @since PHP 5, PHP 7 < 7.4.0
36655 **/
36656function fbird_add_user($service_handle, $user_name, $password, $first_name, $middle_name, $last_name){}
36657
36658/**
36659 * Return the number of rows that were affected by the previous query
36660 *
36661 * This function returns the number of rows that were affected by the
36662 * previous query (INSERT, UPDATE or DELETE) that was executed from
36663 * within the specified transaction context.
36664 *
36665 * @param resource $link_identifier A transaction context. If {@link
36666 *   link_identifier} is a connection resource, its default transaction
36667 *   is used.
36668 * @return int Returns the number of rows as an integer.
36669 * @since PHP 5, PHP 7 < 7.4.0
36670 **/
36671function fbird_affected_rows($link_identifier){}
36672
36673/**
36674 * Initiates a backup task in the service manager and returns immediately
36675 *
36676 * This function passes the arguments to the (remote) database server.
36677 * There it starts a new backup process. Therefore you won't get any
36678 * responses.
36679 *
36680 * @param resource $service_handle A previously opened connection to
36681 *   the database server.
36682 * @param string $source_db The absolute file path to the database on
36683 *   the database server. You can also use a database alias.
36684 * @param string $dest_file The path to the backup file on the database
36685 *   server.
36686 * @param int $options Additional options to pass to the database
36687 *   server for backup. The {@link options} parameter can be a
36688 *   combination of the following constants: IBASE_BKP_IGNORE_CHECKSUMS,
36689 *   IBASE_BKP_IGNORE_LIMBO, IBASE_BKP_METADATA_ONLY,
36690 *   IBASE_BKP_NO_GARBAGE_COLLECT, IBASE_BKP_OLD_DESCRIPTIONS,
36691 *   IBASE_BKP_NON_TRANSPORTABLE or IBASE_BKP_CONVERT. Read the section
36692 *   about for further information.
36693 * @param bool $verbose Since the backup process is done on the
36694 *   database server, you don't have any chance to get its output. This
36695 *   argument is useless.
36696 * @return mixed
36697 * @since PHP 5, PHP 7 < 7.4.0
36698 **/
36699function fbird_backup($service_handle, $source_db, $dest_file, $options, $verbose){}
36700
36701/**
36702 * Add data into a newly created blob
36703 *
36704 * {@link fbird_blob_add} adds data into a blob created with {@link
36705 * ibase_blob_create}.
36706 *
36707 * @param resource $blob_handle A blob handle opened with {@link
36708 *   ibase_blob_create}.
36709 * @param string $data The data to be added.
36710 * @return void
36711 * @since PHP 5, PHP 7 < 7.4.0
36712 **/
36713function fbird_blob_add($blob_handle, $data){}
36714
36715/**
36716 * Cancel creating blob
36717 *
36718 * This function will discard a BLOB if it has not yet been closed by
36719 * {@link fbird_blob_close}.
36720 *
36721 * @param resource $blob_handle A BLOB handle opened with {@link
36722 *   fbird_blob_create}.
36723 * @return bool
36724 * @since PHP 5, PHP 7 < 7.4.0
36725 **/
36726function fbird_blob_cancel($blob_handle){}
36727
36728/**
36729 * Close blob
36730 *
36731 * This function closes a BLOB that has either been opened for reading by
36732 * {@link ibase_blob_open} or has been opened for writing by {@link
36733 * ibase_blob_create}.
36734 *
36735 * @param resource $blob_handle A BLOB handle opened with {@link
36736 *   ibase_blob_create} or {@link ibase_blob_open}.
36737 * @return mixed If the BLOB was being read, this function returns TRUE
36738 *   on success, if the BLOB was being written to, this function returns
36739 *   a string containing the BLOB id that has been assigned to it by the
36740 *   database. On failure, this function returns FALSE.
36741 * @since PHP 5, PHP 7 < 7.4.0
36742 **/
36743function fbird_blob_close($blob_handle){}
36744
36745/**
36746 * Create a new blob for adding data
36747 *
36748 * {@link fbird_blob_create} creates a new BLOB for filling with data.
36749 *
36750 * @param resource $link_identifier An InterBase link identifier. If
36751 *   omitted, the last opened link is assumed.
36752 * @return resource Returns a BLOB handle for later use with {@link
36753 *   ibase_blob_add}.
36754 * @since PHP 5, PHP 7 < 7.4.0
36755 **/
36756function fbird_blob_create($link_identifier){}
36757
36758/**
36759 * Output blob contents to browser
36760 *
36761 * This function opens a BLOB for reading and sends its contents directly
36762 * to standard output (the browser, in most cases).
36763 *
36764 * @param string $blob_id An InterBase link identifier. If omitted, the
36765 *   last opened link is assumed.
36766 * @return bool
36767 * @since PHP 5, PHP 7 < 7.4.0
36768 **/
36769function fbird_blob_echo($blob_id){}
36770
36771/**
36772 * Get len bytes data from open blob
36773 *
36774 * This function returns at most {@link len} bytes from a BLOB that has
36775 * been opened for reading by {@link ibase_blob_open}.
36776 *
36777 * @param resource $blob_handle A BLOB handle opened with {@link
36778 *   ibase_blob_open}.
36779 * @param int $len Size of returned data.
36780 * @return string Returns at most {@link len} bytes from the BLOB, or
36781 *   FALSE on failure.
36782 * @since PHP 5, PHP 7 < 7.4.0
36783 **/
36784function fbird_blob_get($blob_handle, $len){}
36785
36786/**
36787 * Create blob, copy file in it, and close it
36788 *
36789 * This function creates a BLOB, reads an entire file into it, closes it
36790 * and returns the assigned BLOB id.
36791 *
36792 * @param resource $link_identifier An InterBase link identifier. If
36793 *   omitted, the last opened link is assumed.
36794 * @param resource $file_handle The file handle is a handle returned by
36795 *   {@link fopen}.
36796 * @return string Returns the BLOB id on success, or FALSE on error.
36797 * @since PHP 5, PHP 7 < 7.4.0
36798 **/
36799function fbird_blob_import($link_identifier, $file_handle){}
36800
36801/**
36802 * Return blob length and other useful info
36803 *
36804 * Returns the BLOB length and other useful information.
36805 *
36806 * @param resource $link_identifier An InterBase link identifier. If
36807 *   omitted, the last opened link is assumed.
36808 * @param string $blob_id A BLOB id.
36809 * @return array Returns an array containing information about a BLOB.
36810 *   The information returned consists of the length of the BLOB, the
36811 *   number of segments it contains, the size of the largest segment, and
36812 *   whether it is a stream BLOB or a segmented BLOB.
36813 * @since PHP 5, PHP 7 < 7.4.0
36814 **/
36815function fbird_blob_info($link_identifier, $blob_id){}
36816
36817/**
36818 * Open blob for retrieving data parts
36819 *
36820 * Opens an existing BLOB for reading.
36821 *
36822 * @param resource $link_identifier An InterBase link identifier. If
36823 *   omitted, the last opened link is assumed.
36824 * @param string $blob_id A BLOB id.
36825 * @return resource Returns a BLOB handle for later use with {@link
36826 *   ibase_blob_get}.
36827 * @since PHP 5, PHP 7 < 7.4.0
36828 **/
36829function fbird_blob_open($link_identifier, $blob_id){}
36830
36831/**
36832 * Close a connection to an InterBase database
36833 *
36834 * Closes the link to an InterBase database that's associated with a
36835 * connection id returned from {@link ibase_connect}. Default transaction
36836 * on link is committed, other transactions are rolled back.
36837 *
36838 * @param resource $connection_id An InterBase link identifier returned
36839 *   from {@link ibase_connect}. If omitted, the last opened link is
36840 *   assumed.
36841 * @return bool
36842 * @since PHP 5, PHP 7 < 7.4.0
36843 **/
36844function fbird_close($connection_id){}
36845
36846/**
36847 * Commit a transaction
36848 *
36849 * Commits a transaction.
36850 *
36851 * @param resource $link_or_trans_identifier If called without an
36852 *   argument, this function commits the default transaction of the
36853 *   default link. If the argument is a connection identifier, the
36854 *   default transaction of the corresponding connection will be
36855 *   committed. If the argument is a transaction identifier, the
36856 *   corresponding transaction will be committed.
36857 * @return bool
36858 * @since PHP 5, PHP 7 < 7.4.0
36859 **/
36860function fbird_commit($link_or_trans_identifier){}
36861
36862/**
36863 * Commit a transaction without closing it
36864 *
36865 * Commits a transaction without closing it.
36866 *
36867 * @param resource $link_or_trans_identifier If called without an
36868 *   argument, this function commits the default transaction of the
36869 *   default link. If the argument is a connection identifier, the
36870 *   default transaction of the corresponding connection will be
36871 *   committed. If the argument is a transaction identifier, the
36872 *   corresponding transaction will be committed. The transaction context
36873 *   will be retained, so statements executed from within this
36874 *   transaction will not be invalidated.
36875 * @return bool
36876 * @since PHP 5, PHP 7 < 7.4.0
36877 **/
36878function fbird_commit_ret($link_or_trans_identifier){}
36879
36880/**
36881 * Open a connection to a database
36882 *
36883 * Establishes a connection to an Firebird/InterBase server.
36884 *
36885 * In case a second call is made to {@link fbird_connect} with the same
36886 * arguments, no new link will be established, but instead, the link
36887 * identifier of the already opened link will be returned. The link to
36888 * the server will be closed as soon as the execution of the script ends,
36889 * unless it's closed earlier by explicitly calling {@link ibase_close}.
36890 *
36891 * @param string $database The {@link database} argument has to be a
36892 *   valid path to database file on the server it resides on. If the
36893 *   server is not local, it must be prefixed with either 'hostname:'
36894 *   (TCP/IP), 'hostname/port:' (TCP/IP with interbase server on custom
36895 *   TCP port), '//hostname/' (NetBEUI), depending on the connection
36896 *   protocol used.
36897 * @param string $username The user name. Can be set with the
36898 *   ibase.default_user directive.
36899 * @param string $password The password for {@link username}. Can be
36900 *   set with the ibase.default_password directive.
36901 * @param string $charset {@link charset} is the default character set
36902 *   for a database.
36903 * @param int $buffers {@link buffers} is the number of database
36904 *   buffers to allocate for the server-side cache. If 0 or omitted,
36905 *   server chooses its own default.
36906 * @param int $dialect {@link dialect} selects the default SQL dialect
36907 *   for any statement executed within a connection, and it defaults to
36908 *   the highest one supported by client libraries.
36909 * @param string $role Functional only with InterBase 5 and up.
36910 * @param int $sync
36911 * @return resource Returns an Firebird/InterBase link identifier on
36912 *   success, or FALSE on error.
36913 * @since PHP 5, PHP 7 < 7.4.0
36914 **/
36915function fbird_connect($database, $username, $password, $charset, $buffers, $dialect, $role, $sync){}
36916
36917/**
36918 * Request statistics about a database
36919 *
36920 * @param resource $service_handle
36921 * @param string $db
36922 * @param int $action
36923 * @param int $argument
36924 * @return string
36925 * @since PHP 5, PHP 7 < 7.4.0
36926 **/
36927function fbird_db_info($service_handle, $db, $action, $argument){}
36928
36929/**
36930 * Delete a user from a security database
36931 *
36932 * @param resource $service_handle The handle on the database server
36933 *   service.
36934 * @param string $user_name The login name of the user you want to
36935 *   delete from the database.
36936 * @return bool
36937 * @since PHP 5, PHP 7 < 7.4.0
36938 **/
36939function fbird_delete_user($service_handle, $user_name){}
36940
36941/**
36942 * Drops a database
36943 *
36944 * This functions drops a database that was opened by either {@link
36945 * ibase_connect} or {@link ibase_pconnect}. The database is closed and
36946 * deleted from the server.
36947 *
36948 * @param resource $connection An InterBase link identifier. If
36949 *   omitted, the last opened link is assumed.
36950 * @return bool
36951 * @since PHP 5, PHP 7 < 7.4.0
36952 **/
36953function fbird_drop_db($connection){}
36954
36955/**
36956 * Return an error code
36957 *
36958 * Returns the error code that resulted from the most recent InterBase
36959 * function call.
36960 *
36961 * @return int Returns the error code as an integer, or FALSE if no
36962 *   error occurred.
36963 * @since PHP 5, PHP 7 < 7.4.0
36964 **/
36965function fbird_errcode(){}
36966
36967/**
36968 * Return error messages
36969 *
36970 * @return string Returns the error message as a string, or FALSE if no
36971 *   error occurred.
36972 * @since PHP 5, PHP 7 < 7.4.0
36973 **/
36974function fbird_errmsg(){}
36975
36976/**
36977 * Execute a previously prepared query
36978 *
36979 * Execute a query prepared by {@link ibase_prepare}.
36980 *
36981 * This is a lot more effective than using {@link ibase_query} if you are
36982 * repeating a same kind of query several times with only some parameters
36983 * changing.
36984 *
36985 * @param resource $query An InterBase query prepared by {@link
36986 *   ibase_prepare}.
36987 * @param mixed ...$vararg
36988 * @return resource If the query raises an error, returns FALSE. If it
36989 *   is successful and there is a (possibly empty) result set (such as
36990 *   with a SELECT query), returns a result identifier. If the query was
36991 *   successful and there were no results, returns TRUE.
36992 * @since PHP 5, PHP 7 < 7.4.0
36993 **/
36994function fbird_execute($query, ...$vararg){}
36995
36996/**
36997 * Fetch a result row from a query as an associative array
36998 *
36999 * {@link fbird_fetch_assoc} fetches one row of data from the {@link
37000 * result}. If two or more columns of the result have the same field
37001 * names, the last column will take precedence. To access the other
37002 * column(s) of the same name, you either need to access the result with
37003 * numeric indices by using {@link ibase_fetch_row} or use alias names in
37004 * your query.
37005 *
37006 * @param resource $result The result handle.
37007 * @param int $fetch_flag {@link fetch_flag} is a combination of the
37008 *   constants IBASE_TEXT and IBASE_UNIXTIME ORed together. Passing
37009 *   IBASE_TEXT will cause this function to return BLOB contents instead
37010 *   of BLOB ids. Passing IBASE_UNIXTIME will cause this function to
37011 *   return date/time values as Unix timestamps instead of as formatted
37012 *   strings.
37013 * @return array Returns an associative array that corresponds to the
37014 *   fetched row. Subsequent calls will return the next row in the result
37015 *   set, or FALSE if there are no more rows.
37016 * @since PHP 5, PHP 7 < 7.4.0
37017 **/
37018function fbird_fetch_assoc($result, $fetch_flag){}
37019
37020/**
37021 * Get an object from a InterBase database
37022 *
37023 * Fetches a row as a pseudo-object from a given result identifier.
37024 *
37025 * Subsequent calls to {@link fbird_fetch_object} return the next row in
37026 * the result set.
37027 *
37028 * @param resource $result_id An InterBase result identifier obtained
37029 *   either by {@link ibase_query} or {@link ibase_execute}.
37030 * @param int $fetch_flag {@link fetch_flag} is a combination of the
37031 *   constants IBASE_TEXT and IBASE_UNIXTIME ORed together. Passing
37032 *   IBASE_TEXT will cause this function to return BLOB contents instead
37033 *   of BLOB ids. Passing IBASE_UNIXTIME will cause this function to
37034 *   return date/time values as Unix timestamps instead of as formatted
37035 *   strings.
37036 * @return object Returns an object with the next row information, or
37037 *   FALSE if there are no more rows.
37038 * @since PHP 5, PHP 7 < 7.4.0
37039 **/
37040function fbird_fetch_object($result_id, $fetch_flag){}
37041
37042/**
37043 * Fetch a row from an InterBase database
37044 *
37045 * {@link fbird_fetch_row} fetches one row of data from the given result
37046 * set.
37047 *
37048 * Subsequent calls to {@link fbird_fetch_row} return the next row in the
37049 * result set, or FALSE if there are no more rows.
37050 *
37051 * @param resource $result_identifier An InterBase result identifier.
37052 * @param int $fetch_flag {@link fetch_flag} is a combination of the
37053 *   constants IBASE_TEXT and IBASE_UNIXTIME ORed together. Passing
37054 *   IBASE_TEXT will cause this function to return BLOB contents instead
37055 *   of BLOB ids. Passing IBASE_UNIXTIME will cause this function to
37056 *   return date/time values as Unix timestamps instead of as formatted
37057 *   strings.
37058 * @return array Returns an array that corresponds to the fetched row,
37059 *   or FALSE if there are no more rows. Each result column is stored in
37060 *   an array offset, starting at offset 0.
37061 * @since PHP 5, PHP 7 < 7.4.0
37062 **/
37063function fbird_fetch_row($result_identifier, $fetch_flag){}
37064
37065/**
37066 * Get information about a field
37067 *
37068 * Returns an array with information about a field after a select query
37069 * has been run.
37070 *
37071 * @param resource $result An InterBase result identifier.
37072 * @param int $field_number Field offset.
37073 * @return array Returns an array with the following keys: name, alias,
37074 *   relation, length and type.
37075 * @since PHP 5, PHP 7 < 7.4.0
37076 **/
37077function fbird_field_info($result, $field_number){}
37078
37079/**
37080 * Cancels a registered event handler
37081 *
37082 * This function causes the registered event handler specified by {@link
37083 * event} to be cancelled. The callback function will no longer be called
37084 * for the events it was registered to handle.
37085 *
37086 * @param resource $event An event resource, created by {@link
37087 *   ibase_set_event_handler}.
37088 * @return bool
37089 * @since PHP 5, PHP 7 < 7.4.0
37090 **/
37091function fbird_free_event_handler($event){}
37092
37093/**
37094 * Free memory allocated by a prepared query
37095 *
37096 * Frees a prepared query.
37097 *
37098 * @param resource $query A query prepared with {@link ibase_prepare}.
37099 * @return bool
37100 * @since PHP 5, PHP 7 < 7.4.0
37101 **/
37102function fbird_free_query($query){}
37103
37104/**
37105 * Free a result set
37106 *
37107 * Frees a result set.
37108 *
37109 * @param resource $result_identifier A result set created by {@link
37110 *   ibase_query} or {@link ibase_execute}.
37111 * @return bool
37112 * @since PHP 5, PHP 7 < 7.4.0
37113 **/
37114function fbird_free_result($result_identifier){}
37115
37116/**
37117 * Increments the named generator and returns its new value
37118 *
37119 * @param string $generator
37120 * @param int $increment
37121 * @param resource $link_identifier
37122 * @return mixed Returns new generator value as integer, or as string
37123 *   if the value is too big.
37124 * @since PHP 5, PHP 7 < 7.4.0
37125 **/
37126function fbird_gen_id($generator, $increment, $link_identifier){}
37127
37128/**
37129 * Execute a maintenance command on the database server
37130 *
37131 * @param resource $service_handle
37132 * @param string $db
37133 * @param int $action
37134 * @param int $argument
37135 * @return bool
37136 * @since PHP 5, PHP 7 < 7.4.0
37137 **/
37138function fbird_maintain_db($service_handle, $db, $action, $argument){}
37139
37140/**
37141 * Modify a user to a security database
37142 *
37143 * @param resource $service_handle The handle on the database server
37144 *   service.
37145 * @param string $user_name The login name of the database user to
37146 *   modify.
37147 * @param string $password The user's new password.
37148 * @param string $first_name The user's new first name.
37149 * @param string $middle_name The user's new middle name.
37150 * @param string $last_name The user's new last name.
37151 * @return bool
37152 * @since PHP 5, PHP 7 < 7.4.0
37153 **/
37154function fbird_modify_user($service_handle, $user_name, $password, $first_name, $middle_name, $last_name){}
37155
37156/**
37157 * Assigns a name to a result set
37158 *
37159 * This function assigns a name to a result set. This name can be used
37160 * later in UPDATE|DELETE ... WHERE CURRENT OF {@link name} statements.
37161 *
37162 * @param resource $result An InterBase result set.
37163 * @param string $name The name to be assigned.
37164 * @return bool
37165 * @since PHP 5, PHP 7 < 7.4.0
37166 **/
37167function fbird_name_result($result, $name){}
37168
37169/**
37170 * Get the number of fields in a result set
37171 *
37172 * @param resource $result_id An InterBase result identifier.
37173 * @return int Returns the number of fields as an integer.
37174 * @since PHP 5, PHP 7 < 7.4.0
37175 **/
37176function fbird_num_fields($result_id){}
37177
37178/**
37179 * Return the number of parameters in a prepared query
37180 *
37181 * This function returns the number of parameters in the prepared query
37182 * specified by {@link query}. This is the number of binding arguments
37183 * that must be present when calling {@link ibase_execute}.
37184 *
37185 * @param resource $query The prepared query handle.
37186 * @return int Returns the number of parameters as an integer.
37187 * @since PHP 5, PHP 7 < 7.4.0
37188 **/
37189function fbird_num_params($query){}
37190
37191/**
37192 * Return information about a parameter in a prepared query
37193 *
37194 * Returns an array with information about a parameter after a query has
37195 * been prepared.
37196 *
37197 * @param resource $query An InterBase prepared query handle.
37198 * @param int $param_number Parameter offset.
37199 * @return array Returns an array with the following keys: name, alias,
37200 *   relation, length and type.
37201 * @since PHP 5, PHP 7 < 7.4.0
37202 **/
37203function fbird_param_info($query, $param_number){}
37204
37205/**
37206 * Open a persistent connection to an InterBase database
37207 *
37208 * Opens a persistent connection to an InterBase database.
37209 *
37210 * {@link fbird_pconnect} acts very much like {@link ibase_connect} with
37211 * two major differences.
37212 *
37213 * First, when connecting, the function will first try to find a
37214 * (persistent) link that's already opened with the same parameters. If
37215 * one is found, an identifier for it will be returned instead of opening
37216 * a new connection.
37217 *
37218 * Second, the connection to the InterBase server will not be closed when
37219 * the execution of the script ends. Instead, the link will remain open
37220 * for future use ({@link ibase_close} will not close links established
37221 * by {@link fbird_pconnect}). This type of link is therefore called
37222 * 'persistent'.
37223 *
37224 * @param string $database The {@link database} argument has to be a
37225 *   valid path to database file on the server it resides on. If the
37226 *   server is not local, it must be prefixed with either 'hostname:'
37227 *   (TCP/IP), '//hostname/' (NetBEUI) or 'hostname@' (IPX/SPX),
37228 *   depending on the connection protocol used.
37229 * @param string $username The user name. Can be set with the
37230 *   ibase.default_user directive.
37231 * @param string $password The password for {@link username}. Can be
37232 *   set with the ibase.default_password directive.
37233 * @param string $charset {@link charset} is the default character set
37234 *   for a database.
37235 * @param int $buffers {@link buffers} is the number of database
37236 *   buffers to allocate for the server-side cache. If 0 or omitted,
37237 *   server chooses its own default.
37238 * @param int $dialect {@link dialect} selects the default SQL dialect
37239 *   for any statement executed within a connection, and it defaults to
37240 *   the highest one supported by client libraries. Functional only with
37241 *   InterBase 6 and up.
37242 * @param string $role Functional only with InterBase 5 and up.
37243 * @param int $sync
37244 * @return resource Returns an InterBase link identifier on success, or
37245 *   FALSE on error.
37246 * @since PHP 5, PHP 7 < 7.4.0
37247 **/
37248function fbird_pconnect($database, $username, $password, $charset, $buffers, $dialect, $role, $sync){}
37249
37250/**
37251 * Prepare a query for later binding of parameter placeholders and
37252 * execution
37253 *
37254 * @param string $query An InterBase query.
37255 * @return resource Returns a prepared query handle, or FALSE on error.
37256 * @since PHP 5, PHP 7 < 7.4.0
37257 **/
37258function fbird_prepare($query){}
37259
37260/**
37261 * Execute a query on an InterBase database
37262 *
37263 * @param resource $link_identifier An InterBase link identifier. If
37264 *   omitted, the last opened link is assumed.
37265 * @param string $query An InterBase query.
37266 * @param int $bind_args
37267 * @return resource If the query raises an error, returns FALSE. If it
37268 *   is successful and there is a (possibly empty) result set (such as
37269 *   with a SELECT query), returns a result identifier. If the query was
37270 *   successful and there were no results, returns TRUE.
37271 * @since PHP 5, PHP 7 < 7.4.0
37272 **/
37273function fbird_query($link_identifier, $query, $bind_args){}
37274
37275/**
37276 * Initiates a restore task in the service manager and returns
37277 * immediately
37278 *
37279 * This function passes the arguments to the (remote) database server.
37280 * There it starts a new restore process. Therefore you won't get any
37281 * responses.
37282 *
37283 * @param resource $service_handle A previously opened connection to
37284 *   the database server.
37285 * @param string $source_file The absolute path on the server where the
37286 *   backup file is located.
37287 * @param string $dest_db The path to create the new database on the
37288 *   server. You can also use database alias.
37289 * @param int $options Additional options to pass to the database
37290 *   server for restore. The {@link options} parameter can be a
37291 *   combination of the following constants: IBASE_RES_DEACTIVATE_IDX,
37292 *   IBASE_RES_NO_SHADOW, IBASE_RES_NO_VALIDITY, IBASE_RES_ONE_AT_A_TIME,
37293 *   IBASE_RES_REPLACE, IBASE_RES_CREATE, IBASE_RES_USE_ALL_SPACE,
37294 *   IBASE_PRP_PAGE_BUFFERS, IBASE_PRP_SWEEP_INTERVAL, IBASE_RES_CREATE.
37295 *   Read the section about for further information.
37296 * @param bool $verbose Since the restore process is done on the
37297 *   database server, you don't have any chance to get its output. This
37298 *   argument is useless.
37299 * @return mixed
37300 * @since PHP 5, PHP 7 < 7.4.0
37301 **/
37302function fbird_restore($service_handle, $source_file, $dest_db, $options, $verbose){}
37303
37304/**
37305 * Roll back a transaction
37306 *
37307 * Rolls back a transaction.
37308 *
37309 * @param resource $link_or_trans_identifier If called without an
37310 *   argument, this function rolls back the default transaction of the
37311 *   default link. If the argument is a connection identifier, the
37312 *   default transaction of the corresponding connection will be rolled
37313 *   back. If the argument is a transaction identifier, the corresponding
37314 *   transaction will be rolled back.
37315 * @return bool
37316 * @since PHP 5, PHP 7 < 7.4.0
37317 **/
37318function fbird_rollback($link_or_trans_identifier){}
37319
37320/**
37321 * Roll back a transaction without closing it
37322 *
37323 * Rolls back a transaction without closing it.
37324 *
37325 * @param resource $link_or_trans_identifier If called without an
37326 *   argument, this function rolls back the default transaction of the
37327 *   default link. If the argument is a connection identifier, the
37328 *   default transaction of the corresponding connection will be rolled
37329 *   back. If the argument is a transaction identifier, the corresponding
37330 *   transaction will be rolled back. The transaction context will be
37331 *   retained, so statements executed from within this transaction will
37332 *   not be invalidated.
37333 * @return bool
37334 * @since PHP 5, PHP 7 < 7.4.0
37335 **/
37336function fbird_rollback_ret($link_or_trans_identifier){}
37337
37338/**
37339 * Request information about a database server
37340 *
37341 * @param resource $service_handle A previously created connection to
37342 *   the database server.
37343 * @param int $action A valid constant.
37344 * @return string Returns mixed types depending on context.
37345 * @since PHP 5, PHP 7 < 7.4.0
37346 **/
37347function fbird_server_info($service_handle, $action){}
37348
37349/**
37350 * Connect to the service manager
37351 *
37352 * @param string $host The name or ip address of the database host. You
37353 *   can define the port by adding '/' and port number. If no port is
37354 *   specified, port 3050 will be used.
37355 * @param string $dba_username The name of any valid user.
37356 * @param string $dba_password The user's password.
37357 * @return resource Returns a Interbase / Firebird link identifier on
37358 *   success.
37359 * @since PHP 5, PHP 7 < 7.4.0
37360 **/
37361function fbird_service_attach($host, $dba_username, $dba_password){}
37362
37363/**
37364 * Disconnect from the service manager
37365 *
37366 * @param resource $service_handle A previously created connection to
37367 *   the database server.
37368 * @return bool
37369 * @since PHP 5, PHP 7 < 7.4.0
37370 **/
37371function fbird_service_detach($service_handle){}
37372
37373/**
37374 * Register a callback function to be called when events are posted
37375 *
37376 * This function registers a PHP user function as event handler for the
37377 * specified events.
37378 *
37379 * @param callable $event_handler The callback is called with the event
37380 *   name and the link resource as arguments whenever one of the
37381 *   specified events is posted by the database. The callback must return
37382 *   FALSE if the event handler should be canceled. Any other return
37383 *   value is ignored. This function accepts up to 15 event arguments.
37384 * @param string $event_name1 An event name.
37385 * @param string ...$vararg At most 15 events allowed.
37386 * @return resource The return value is an event resource. This
37387 *   resource can be used to free the event handler using {@link
37388 *   ibase_free_event_handler}.
37389 * @since PHP 5, PHP 7 < 7.4.0
37390 **/
37391function fbird_set_event_handler($event_handler, $event_name1, ...$vararg){}
37392
37393/**
37394 * Begin a transaction
37395 *
37396 * Begins a transaction.
37397 *
37398 * @param int $trans_args {@link trans_args} can be a combination of
37399 *   IBASE_READ, IBASE_WRITE, IBASE_COMMITTED, IBASE_CONSISTENCY,
37400 *   IBASE_CONCURRENCY, IBASE_REC_VERSION, IBASE_REC_NO_VERSION,
37401 *   IBASE_WAIT and IBASE_NOWAIT.
37402 * @param resource $link_identifier An InterBase link identifier. If
37403 *   omitted, the last opened link is assumed.
37404 * @return resource Returns a transaction handle, or FALSE on error.
37405 * @since PHP 5, PHP 7 < 7.4.0
37406 **/
37407function fbird_trans($trans_args, $link_identifier){}
37408
37409/**
37410 * Wait for an event to be posted by the database
37411 *
37412 * This function suspends execution of the script until one of the
37413 * specified events is posted by the database. The name of the event that
37414 * was posted is returned. This function accepts up to 15 event
37415 * arguments.
37416 *
37417 * @param string $event_name1 The event name.
37418 * @param string ...$vararg
37419 * @return string Returns the name of the event that was posted.
37420 * @since PHP 5, PHP 7 < 7.4.0
37421 **/
37422function fbird_wait_event($event_name1, ...$vararg){}
37423
37424/**
37425 * Get number of affected rows in previous FrontBase operation
37426 *
37427 * {@link fbsql_affected_rows} returns the number of rows affected by the
37428 * last INSERT, UPDATE or DELETE query associated with {@link
37429 * link_identifier}.
37430 *
37431 * If the last query was a DELETE query with no WHERE clause, all of the
37432 * records will have been deleted from the table but this function will
37433 * return zero.
37434 *
37435 * @param resource $link_identifier
37436 * @return int If the last query failed, this function will return -1.
37437 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37438 **/
37439function fbsql_affected_rows($link_identifier){}
37440
37441/**
37442 * Enable or disable autocommit
37443 *
37444 * Returns the current autocommit status.
37445 *
37446 * @param resource $link_identifier If this optional parameter is given
37447 *   the auto commit status will be changed. With {@link OnOff} set to
37448 *   TRUE each statement will be committed automatically, if no errors
37449 *   was found. With OnOff set to FALSE the user must commit or rollback
37450 *   the transaction using either {@link fbsql_commit} or {@link
37451 *   fbsql_rollback}.
37452 * @param bool $OnOff
37453 * @return bool Returns the current autocommit status, as a boolean.
37454 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37455 **/
37456function fbsql_autocommit($link_identifier, $OnOff){}
37457
37458/**
37459 * Get the size of a BLOB
37460 *
37461 * Returns the size of the given BLOB.
37462 *
37463 * @param string $blob_handle A BLOB handle, returned by {@link
37464 *   fbsql_create_blob}.
37465 * @param resource $link_identifier
37466 * @return int Returns the BLOB size as an integer, or FALSE on error.
37467 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0
37468 **/
37469function fbsql_blob_size($blob_handle, $link_identifier){}
37470
37471/**
37472 * Change logged in user of the active connection
37473 *
37474 * {@link fbsql_change_user} changes the logged in user of the specified
37475 * connection. If the new user and password authorization fails, the
37476 * current connected user stays active.
37477 *
37478 * @param string $user The new user name.
37479 * @param string $password The new user password.
37480 * @param string $database If specified, this will be the default or
37481 *   current database after the user has been changed.
37482 * @param resource $link_identifier
37483 * @return bool
37484 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37485 **/
37486function fbsql_change_user($user, $password, $database, $link_identifier){}
37487
37488/**
37489 * Get the size of a CLOB
37490 *
37491 * Returns the size of the given CLOB.
37492 *
37493 * @param string $clob_handle A CLOB handle, returned by {@link
37494 *   fbsql_create_clob}.
37495 * @param resource $link_identifier
37496 * @return int Returns the CLOB size as an integer, or FALSE on error.
37497 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0
37498 **/
37499function fbsql_clob_size($clob_handle, $link_identifier){}
37500
37501/**
37502 * Close FrontBase connection
37503 *
37504 * Closes the connection to the FrontBase server that's associated with
37505 * the specified link identifier.
37506 *
37507 * Using {@link fbsql_close} isn't usually necessary, as non-persistent
37508 * open links are automatically closed at the end of the script's
37509 * execution.
37510 *
37511 * @param resource $link_identifier
37512 * @return bool
37513 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37514 **/
37515function fbsql_close($link_identifier){}
37516
37517/**
37518 * Commits a transaction to the database
37519 *
37520 * Ends the current transaction by writing all inserts, updates and
37521 * deletes to the disk and unlocking all row and table locks held by the
37522 * transaction. This command is only needed if autocommit is set to
37523 * false.
37524 *
37525 * @param resource $link_identifier
37526 * @return bool
37527 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37528 **/
37529function fbsql_commit($link_identifier){}
37530
37531/**
37532 * Open a connection to a FrontBase Server
37533 *
37534 * {@link fbsql_connect} establishes a connection to a FrontBase server.
37535 *
37536 * If a second call is made to {@link fbsql_connect} with the same
37537 * arguments, no new link will be established, but instead, the link
37538 * identifier of the already opened link will be returned.
37539 *
37540 * The link to the server will be closed as soon as the execution of the
37541 * script ends, unless it's closed earlier by explicitly calling {@link
37542 * fbsql_close}.
37543 *
37544 * @param string $hostname The server host name.
37545 * @param string $username The user name for the connection.
37546 * @param string $password The password for the connection.
37547 * @return resource Returns a positive FrontBase link identifier on
37548 *   success, or FALSE on errors.
37549 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37550 **/
37551function fbsql_connect($hostname, $username, $password){}
37552
37553/**
37554 * Create a BLOB
37555 *
37556 * Creates a BLOB from the given data.
37557 *
37558 * @param string $blob_data The BLOB data.
37559 * @param resource $link_identifier
37560 * @return string Returns a resource handle to the newly created BLOB,
37561 *   which can be used with insert and update commands to store the BLOB
37562 *   in the database.
37563 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0
37564 **/
37565function fbsql_create_blob($blob_data, $link_identifier){}
37566
37567/**
37568 * Create a CLOB
37569 *
37570 * Creates a CLOB from the given data.
37571 *
37572 * @param string $clob_data The CLOB data.
37573 * @param resource $link_identifier
37574 * @return string Returns a resource handle to the newly created CLOB,
37575 *   which can be used with insert and update commands to store the CLOB
37576 *   in the database.
37577 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0
37578 **/
37579function fbsql_create_clob($clob_data, $link_identifier){}
37580
37581/**
37582 * Create a FrontBase database
37583 *
37584 * Attempts to create a new database on the specified server.
37585 *
37586 * @param string $database_name The database name, as a string.
37587 * @param resource $link_identifier
37588 * @param string $database_options
37589 * @return bool
37590 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37591 **/
37592function fbsql_create_db($database_name, $link_identifier, $database_options){}
37593
37594/**
37595 * Get or set the database name used with a connection
37596 *
37597 * Get or set the database name used with the connection.
37598 *
37599 * @param resource $link_identifier The database name. If given, the
37600 *   default database of the connexion will be changed to {@link
37601 *   database}.
37602 * @param string $database
37603 * @return string Returns the name of the database used with this
37604 *   connection.
37605 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37606 **/
37607function fbsql_database($link_identifier, $database){}
37608
37609/**
37610 * Sets or retrieves the password for a FrontBase database
37611 *
37612 * Sets and retrieves the database password used by the connection. If a
37613 * database is protected by a database password, the user must call this
37614 * function before calling {@link fbsql_select_db}.
37615 *
37616 * If no link is open, the function will try to establish a link as if
37617 * {@link fbsql_connect} was called, and use it.
37618 *
37619 * This function does not change the database password in the database
37620 * nor can it be used to retrieve the database password for a database.
37621 *
37622 * @param resource $link_identifier The database password, as a string.
37623 *   If given, the function sets the database password for the specified
37624 *   link identifier.
37625 * @param string $database_password
37626 * @return string Returns the database password associated with the
37627 *   link identifier.
37628 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37629 **/
37630function fbsql_database_password($link_identifier, $database_password){}
37631
37632/**
37633 * Move internal result pointer
37634 *
37635 * Moves the internal row pointer of the FrontBase result associated with
37636 * the specified result identifier to point to the specified row number.
37637 *
37638 * The next call to {@link fbsql_fetch_row} would return that row.
37639 *
37640 * @param resource $result The row number. Starts at 0.
37641 * @param int $row_number
37642 * @return bool
37643 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37644 **/
37645function fbsql_data_seek($result, $row_number){}
37646
37647/**
37648 * Send a FrontBase query
37649 *
37650 * Selects a database and executes a query on it.
37651 *
37652 * @param string $database The database to be selected.
37653 * @param string $query The SQL query to be executed.
37654 * @param resource $link_identifier
37655 * @return resource Returns a positive FrontBase result identifier to
37656 *   the query result, or FALSE on error.
37657 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37658 **/
37659function fbsql_db_query($database, $query, $link_identifier){}
37660
37661/**
37662 * Get the status for a given database
37663 *
37664 * Gets the current status of the specified database.
37665 *
37666 * @param string $database_name The database name.
37667 * @param resource $link_identifier
37668 * @return int Returns an integer value with the current status. This
37669 *   can be one of the following constants: FALSE - The exec handler for
37670 *   the host was invalid. This error will occur when the {@link
37671 *   link_identifier} connects directly to a database by using a port
37672 *   number. FBExec can be available on the server but no connection has
37673 *   been made for it. FBSQL_UNKNOWN - The Status is unknown.
37674 *   FBSQL_STOPPED - The database is not running. Use {@link
37675 *   fbsql_start_db} to start the database. FBSQL_STARTING - The database
37676 *   is starting. FBSQL_RUNNING - The database is running and can be used
37677 *   to perform SQL operations. FBSQL_STOPPING - The database is
37678 *   stopping. FBSQL_NOEXEC - FBExec is not running on the server and it
37679 *   is not possible to get the status of the database.
37680 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0
37681 **/
37682function fbsql_db_status($database_name, $link_identifier){}
37683
37684/**
37685 * Drop (delete) a FrontBase database
37686 *
37687 * {@link fbsql_drop_db} attempts to drop (remove) an entire database
37688 * from the server associated with the specified link identifier.
37689 *
37690 * @param string $database_name The database name, as a string.
37691 * @param resource $link_identifier
37692 * @return bool
37693 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37694 **/
37695function fbsql_drop_db($database_name, $link_identifier){}
37696
37697/**
37698 * Returns the error number from previous operation
37699 *
37700 * Returns the numerical value of the error message from previous
37701 * FrontBase operation.
37702 *
37703 * Errors coming back from the fbsql database backend don't issue
37704 * warnings. Instead, use {@link fbsql_errno} to retrieve the error code.
37705 * Note that this function only returns the error code from the most
37706 * recently executed fbsql function (not including {@link fbsql_error}
37707 * and {@link fbsql_errno}), so if you want to use it, make sure you
37708 * check the value before calling another fbsql function.
37709 *
37710 * @param resource $link_identifier
37711 * @return int Returns the error number from the last fbsql function,
37712 *   or 0 (zero) if no error occurred.
37713 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37714 **/
37715function fbsql_errno($link_identifier){}
37716
37717/**
37718 * Returns the error message from previous operation
37719 *
37720 * Returns the error message from previous FrontBase operation.
37721 *
37722 * Errors coming back from the fbsql database backend don't issue
37723 * warnings. Instead, use {@link fbsql_error} to retrieve the error text.
37724 * Note that this function only returns the error code from the most
37725 * recently executed fbsql function (not including {@link fbsql_error}
37726 * and {@link fbsql_errno}), so if you want to use it, make sure you
37727 * check the value before calling another fbsql function.
37728 *
37729 * @param resource $link_identifier
37730 * @return string Returns the error text from the last fbsql function,
37731 *   or '' (the empty string) if no error occurred.
37732 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37733 **/
37734function fbsql_error($link_identifier){}
37735
37736/**
37737 * Fetch a result row as an associative array, a numeric array, or both
37738 *
37739 * {@link fbsql_fetch_array} is a combination of {@link fbsql_fetch_row}
37740 * and {@link fbsql_fetch_assoc}.
37741 *
37742 * An important thing to note is that using {@link fbsql_fetch_array} is
37743 * NOT significantly slower than using {@link fbsql_fetch_row}, while it
37744 * provides a significant added value.
37745 *
37746 * @param resource $result A constant and can take the following
37747 *   values: FBSQL_ASSOC, FBSQL_NUM, or FBSQL_BOTH. When using
37748 *   FBSQL_BOTH, in addition to storing the data in the numeric indices
37749 *   of the result array, it also stores the data in associative indices,
37750 *   using the field names as keys.
37751 * @param int $result_type
37752 * @return array Returns an array that corresponds to the fetched row,
37753 *   or FALSE if there are no more rows.
37754 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37755 **/
37756function fbsql_fetch_array($result, $result_type){}
37757
37758/**
37759 * Fetch a result row as an associative array
37760 *
37761 * Calling {@link fbsql_fetch_assoc} is equivalent to calling {@link
37762 * fbsql_fetch_array} with FBSQL_ASSOC as second parameter. It only
37763 * returns an associative array.
37764 *
37765 * This is the way {@link fbsql_fetch_array} originally worked. If you
37766 * need the numeric indices as well as the associative, use {@link
37767 * fbsql_fetch_array}.
37768 *
37769 * An important thing to note is that using {@link fbsql_fetch_assoc} is
37770 * NOT significantly slower than using {@link fbsql_fetch_row}, while it
37771 * provides a significant added value.
37772 *
37773 * @param resource $result
37774 * @return array Returns an associative array that corresponds to the
37775 *   fetched row, or FALSE if there are no more rows.
37776 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37777 **/
37778function fbsql_fetch_assoc($result){}
37779
37780/**
37781 * Get column information from a result and return as an object
37782 *
37783 * Used in order to obtain information about fields in a certain query
37784 * result.
37785 *
37786 * @param resource $result The numerical offset of the field. The field
37787 *   index starts at 0. If not specified, the next field that wasn't yet
37788 *   retrieved by {@link fbsql_fetch_field} is retrieved.
37789 * @param int $field_offset
37790 * @return object Returns an object containing field information, or
37791 *   FALSE on errors.
37792 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37793 **/
37794function fbsql_fetch_field($result, $field_offset){}
37795
37796/**
37797 * Get the length of each output in a result
37798 *
37799 * Stores the lengths of each result column in the last row returned by
37800 * {@link fbsql_fetch_row}, {@link fbsql_fetch_array} and {@link
37801 * fbsql_fetch_object} in an array.
37802 *
37803 * @param resource $result
37804 * @return array Returns an array, starting at offset 0, that
37805 *   corresponds to the lengths of each field in the last row fetched by
37806 *   {@link fbsql_fetch_row}, or FALSE on error.
37807 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37808 **/
37809function fbsql_fetch_lengths($result){}
37810
37811/**
37812 * Fetch a result row as an object
37813 *
37814 * {@link fbsql_fetch_object} is similar to {@link fbsql_fetch_array},
37815 * with one difference - an object is returned, instead of an array.
37816 * Indirectly, that means that you can only access the data by the field
37817 * names, and not by their offsets (numbers are illegal property names).
37818 *
37819 * Speed-wise, the function is identical to {@link fbsql_fetch_array},
37820 * and almost as quick as {@link fbsql_fetch_row} (the difference is
37821 * insignificant).
37822 *
37823 * @param resource $result
37824 * @return object Returns an object with properties that correspond to
37825 *   the fetched row, or FALSE if there are no more rows.
37826 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37827 **/
37828function fbsql_fetch_object($result){}
37829
37830/**
37831 * Get a result row as an enumerated array
37832 *
37833 * {@link fbsql_fetch_row} fetches one row of data from the result
37834 * associated with the specified result identifier.
37835 *
37836 * Subsequent call to {@link fbsql_fetch_row} would return the next row
37837 * in the result set, or FALSE if there are no more rows.
37838 *
37839 * @param resource $result
37840 * @return array Returns an array that corresponds to the fetched row
37841 *   where each result column is stored in an offset, starting at offset
37842 *   0, or FALSE if there are no more rows.
37843 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37844 **/
37845function fbsql_fetch_row($result){}
37846
37847/**
37848 * Get the flags associated with the specified field in a result
37849 *
37850 * Gets the flags associated with the specified field in a result.
37851 *
37852 * @param resource $result A result pointer returned by {@link
37853 *   fbsql_list_fields}.
37854 * @param int $field_offset The numerical offset of the field. The
37855 *   field index starts at 0.
37856 * @return string Returns the field flags of the specified field as a
37857 *   single word per flag separated by a single space, so that you can
37858 *   split the returned value using {@link explode}.
37859 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37860 **/
37861function fbsql_field_flags($result, $field_offset){}
37862
37863/**
37864 * Returns the length of the specified field
37865 *
37866 * @param resource $result A result pointer returned by {@link
37867 *   fbsql_list_fields}.
37868 * @param int $field_offset The numerical offset of the field. The
37869 *   field index starts at 0.
37870 * @return int Returns the length of the specified field.
37871 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37872 **/
37873function fbsql_field_len($result, $field_offset){}
37874
37875/**
37876 * Get the name of the specified field in a result
37877 *
37878 * Returns the name of the specified field index.
37879 *
37880 * @param resource $result A result pointer returned by {@link
37881 *   fbsql_list_fields}.
37882 * @param int $field_index The numerical offset of the field. The field
37883 *   index starts at 0.
37884 * @return string Returns the name as a string, or FALSE if the field
37885 *   doesn't exist.
37886 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37887 **/
37888function fbsql_field_name($result, $field_index){}
37889
37890/**
37891 * Set result pointer to a specified field offset
37892 *
37893 * Seeks to the specified field offset. If the next call to {@link
37894 * fbsql_fetch_field} doesn't include a field offset, the field offset
37895 * specified in {@link fbsql_field_seek} will be returned.
37896 *
37897 * @param resource $result The numerical offset of the field. The field
37898 *   index starts at 0.
37899 * @param int $field_offset
37900 * @return bool
37901 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37902 **/
37903function fbsql_field_seek($result, $field_offset){}
37904
37905/**
37906 * Get name of the table the specified field is in
37907 *
37908 * Returns the name of the table that the specified field is in.
37909 *
37910 * @param resource $result The numerical offset of the field. The field
37911 *   index starts at 0.
37912 * @param int $field_offset
37913 * @return string Returns the name of the table, as a string.
37914 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37915 **/
37916function fbsql_field_table($result, $field_offset){}
37917
37918/**
37919 * Get the type of the specified field in a result
37920 *
37921 * {@link fbsql_field_type} is similar to the {@link fbsql_field_name}
37922 * function, but the field type is returned instead.
37923 *
37924 * @param resource $result The numerical offset of the field. The field
37925 *   index starts at 0.
37926 * @param int $field_offset
37927 * @return string Returns the field type, as a string.
37928 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37929 **/
37930function fbsql_field_type($result, $field_offset){}
37931
37932/**
37933 * Free result memory
37934 *
37935 * Frees all memory associated with the given {@link result} identifier.
37936 *
37937 * {@link fbsql_free_result} only needs to be called if you are concerned
37938 * about how much memory is being used for queries that return large
37939 * result sets. All associated result memory is automatically freed at
37940 * the end of the script's execution.
37941 *
37942 * @param resource $result
37943 * @return bool
37944 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37945 **/
37946function fbsql_free_result($result){}
37947
37948/**
37949 * @param resource $link_identifier
37950 * @return array
37951 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0
37952 **/
37953function fbsql_get_autostart_info($link_identifier){}
37954
37955/**
37956 * Get or set the host name used with a connection
37957 *
37958 * Gets or sets the host name used with a connection.
37959 *
37960 * @param resource $link_identifier If provided, this will be the new
37961 *   connection host name.
37962 * @param string $host_name
37963 * @return string Returns the current host name used for the
37964 *   connection.
37965 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37966 **/
37967function fbsql_hostname($link_identifier, $host_name){}
37968
37969/**
37970 * Get the id generated from the previous INSERT operation
37971 *
37972 * Gets the id generated from the previous INSERT operation which created
37973 * a DEFAULT UNIQUE value.
37974 *
37975 * @param resource $link_identifier
37976 * @return int Returns the ID generated from the previous INSERT query,
37977 *   or 0 if the previous query does not generate an DEFAULT UNIQUE
37978 *   value.
37979 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37980 **/
37981function fbsql_insert_id($link_identifier){}
37982
37983/**
37984 * List databases available on a FrontBase server
37985 *
37986 * Return a result pointer containing the databases available from the
37987 * current fbsql daemon. Use the {@link fbsql_tablename} to traverse this
37988 * result pointer.
37989 *
37990 * @param resource $link_identifier
37991 * @return resource Returns a result pointer or FALSE on error.
37992 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
37993 **/
37994function fbsql_list_dbs($link_identifier){}
37995
37996/**
37997 * List FrontBase result fields
37998 *
37999 * Retrieves information about the given table.
38000 *
38001 * @param string $database_name The database name.
38002 * @param string $table_name The table name.
38003 * @param resource $link_identifier
38004 * @return resource Returns a result pointer which can be used with the
38005 *   fbsql_field_xxx functions, or FALSE on error.
38006 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
38007 **/
38008function fbsql_list_fields($database_name, $table_name, $link_identifier){}
38009
38010/**
38011 * List tables in a FrontBase database
38012 *
38013 * Returns a result pointer describing the {@link database}.
38014 *
38015 * @param string $database The database name.
38016 * @param resource $link_identifier
38017 * @return resource Returns a result pointer which can be used with the
38018 *   {@link fbsql_tablename} function to read the actual table names, or
38019 *   FALSE on error.
38020 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
38021 **/
38022function fbsql_list_tables($database, $link_identifier){}
38023
38024/**
38025 * Move the internal result pointer to the next result
38026 *
38027 * When sending more than one SQL statement to the server or executing a
38028 * stored procedure with multiple results will cause the server to return
38029 * multiple result sets. This function will test for additional results
38030 * available form the server. If an additional result set exists it will
38031 * free the existing result set and prepare to fetch the words from the
38032 * new result set.
38033 *
38034 * @param resource $result
38035 * @return bool Returns TRUE if an additional result set was available
38036 *   or FALSE otherwise.
38037 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
38038 **/
38039function fbsql_next_result($result){}
38040
38041/**
38042 * Get number of fields in result
38043 *
38044 * Returns the number of fields in the given {@link result} set.
38045 *
38046 * @param resource $result
38047 * @return int Returns the number of fields, as an integer.
38048 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
38049 **/
38050function fbsql_num_fields($result){}
38051
38052/**
38053 * Get number of rows in result
38054 *
38055 * Gets the number of rows in the given {@link result} set.
38056 *
38057 * This function is only valid for SELECT statements. To retrieve the
38058 * number of rows returned from a INSERT, UPDATE or DELETE query, use
38059 * {@link fbsql_affected_rows}.
38060 *
38061 * @param resource $result
38062 * @return int Returns the number of rows returned by the last SELECT
38063 *   statement.
38064 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
38065 **/
38066function fbsql_num_rows($result){}
38067
38068/**
38069 * Get or set the user password used with a connection
38070 *
38071 * @param resource $link_identifier If provided, this will be the new
38072 *   connection password.
38073 * @param string $password
38074 * @return string Returns the current password used for the connection.
38075 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
38076 **/
38077function fbsql_password($link_identifier, $password){}
38078
38079/**
38080 * Open a persistent connection to a FrontBase Server
38081 *
38082 * Establishes a persistent connection to a FrontBase server.
38083 *
38084 * To set the server port number, use {@link fbsql_select_db}.
38085 *
38086 * {@link fbsql_pconnect} acts very much like {@link fbsql_connect} with
38087 * two major differences:
38088 *
38089 * First, when connecting, the function would first try to find a
38090 * (persistent) link that's already open with the same host, username and
38091 * password. If one is found, an identifier for it will be returned
38092 * instead of opening a new connection.
38093 *
38094 * Second, the connection to the SQL server will not be closed when the
38095 * execution of the script ends. Instead, the link will remain open for
38096 * future use.
38097 *
38098 * This type of links is therefore called 'persistent'.
38099 *
38100 * @param string $hostname The server host name.
38101 * @param string $username The user name for the connection.
38102 * @param string $password The password for the connection.
38103 * @return resource Returns a positive FrontBase persistent link
38104 *   identifier on success, or FALSE on error.
38105 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
38106 **/
38107function fbsql_pconnect($hostname, $username, $password){}
38108
38109/**
38110 * Send a FrontBase query
38111 *
38112 * Sends a {@link query} to the currently active database on the server.
38113 *
38114 * If the query succeeds, you can call {@link fbsql_num_rows} to find out
38115 * how many rows were returned for a SELECT statement or {@link
38116 * fbsql_affected_rows} to find out how many rows were affected by a
38117 * DELETE, INSERT, REPLACE, or UPDATE statement.
38118 *
38119 * @param string $query The SQL query to be executed.
38120 * @param resource $link_identifier
38121 * @param int $batch_size
38122 * @return resource {@link fbsql_query} returns TRUE (non-zero) or
38123 *   FALSE to indicate whether or not the query succeeded. A return value
38124 *   of TRUE means that the query was legal and could be executed by the
38125 *   server. It does not indicate anything about the number of rows
38126 *   affected or returned. It is perfectly possible for a query to
38127 *   succeed but affect no rows or return no rows.
38128 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
38129 **/
38130function fbsql_query($query, $link_identifier, $batch_size){}
38131
38132/**
38133 * Read a BLOB from the database
38134 *
38135 * Reads BLOB data from the database.
38136 *
38137 * If a select statement contains BLOB and/or CLOB columns FrontBase will
38138 * return the data directly when data is fetched. This default behavior
38139 * can be changed with {@link fbsql_set_lob_mode} so the fetch functions
38140 * will return handles to BLOB and CLOB data. If a handle is fetched a
38141 * user must call {@link fbsql_read_blob} to get the actual BLOB data
38142 * from the database.
38143 *
38144 * @param string $blob_handle A BLOB handle, returned by {@link
38145 *   fbsql_create_blob}.
38146 * @param resource $link_identifier
38147 * @return string Returns a string containing the specified BLOB data.
38148 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0
38149 **/
38150function fbsql_read_blob($blob_handle, $link_identifier){}
38151
38152/**
38153 * Read a CLOB from the database
38154 *
38155 * Reads CLOB data from the database.
38156 *
38157 * If a select statement contains BLOB and/or CLOB columns FrontBase will
38158 * return the data directly when data is fetched. This default behavior
38159 * can be changed with {@link fbsql_set_lob_mode} so the fetch functions
38160 * will return handles to BLOB and CLOB data. If a handle is fetched a
38161 * user must call {@link fbsql_read_clob} to get the actual CLOB data
38162 * from the database.
38163 *
38164 * @param string $clob_handle A CLOB handle, returned by {@link
38165 *   fbsql_create_clob}.
38166 * @param resource $link_identifier
38167 * @return string Returns a string containing the specified CLOB data.
38168 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0
38169 **/
38170function fbsql_read_clob($clob_handle, $link_identifier){}
38171
38172/**
38173 * Get result data
38174 *
38175 * Returns the contents of one cell from a FrontBase {@link result} set.
38176 *
38177 * When working on large result sets, you should consider using one of
38178 * the functions that fetch an entire row (specified below). As these
38179 * functions return the contents of multiple cells in one function call,
38180 * they're MUCH quicker than {@link fbsql_result}.
38181 *
38182 * Calls to {@link fbsql_result} should not be mixed with calls to other
38183 * functions that deal with the result set.
38184 *
38185 * @param resource $result
38186 * @param int $row Can be the field's offset, or the field's name, or
38187 *   the field's table dot field's name (tablename.fieldname). If the
38188 *   column name has been aliased ('select foo as bar from...'), use the
38189 *   alias instead of the column name.
38190 * @param mixed $field
38191 * @return mixed
38192 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
38193 **/
38194function fbsql_result($result, $row, $field){}
38195
38196/**
38197 * Rollback a transaction to the database
38198 *
38199 * Ends the current transaction by rolling back all statements issued
38200 * since last commit.
38201 *
38202 * This command is only needed if autocommit is set to false.
38203 *
38204 * @param resource $link_identifier
38205 * @return bool
38206 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
38207 **/
38208function fbsql_rollback($link_identifier){}
38209
38210/**
38211 * Get the number of rows affected by the last statement
38212 *
38213 * Gets the number of rows affected by the last statement.
38214 *
38215 * @param resource $result
38216 * @return int Returns the number of rows, as an integer.
38217 * @since PHP 5 >= 5.1.0 < 5.3.0
38218 **/
38219function fbsql_rows_fetched($result){}
38220
38221/**
38222 * Select a FrontBase database
38223 *
38224 * Sets the current active database on the given link identifier.
38225 *
38226 * The client contacts FBExec to obtain the port number to use for the
38227 * connection to the database. If the database name is a number the
38228 * system will use that as a port number and it will not ask FBExec for
38229 * the port number. The FrontBase server can be stared as FRontBase
38230 * -FBExec=No -port=<port number> <database name>.
38231 *
38232 * Every subsequent call to {@link fbsql_query} will be made on the
38233 * active database.
38234 *
38235 * @param string $database_name The name of the database to be
38236 *   selected. If the database is protected with a database password, the
38237 *   you must call {@link fbsql_database_password} before selecting the
38238 *   database.
38239 * @param resource $link_identifier
38240 * @return bool
38241 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
38242 **/
38243function fbsql_select_db($database_name, $link_identifier){}
38244
38245/**
38246 * Change input/output character set
38247 *
38248 * @param resource $link_identifier
38249 * @param int $characterset
38250 * @param int $in_out_both
38251 * @return void
38252 * @since PHP 5 >= 5.1.0 < 5.3.0
38253 **/
38254function fbsql_set_characterset($link_identifier, $characterset, $in_out_both){}
38255
38256/**
38257 * Set the LOB retrieve mode for a FrontBase result set
38258 *
38259 * Sets the mode for retrieving LOB data from the database.
38260 *
38261 * When BLOB and CLOB data is retrieved in FrontBase it can be retrieved
38262 * direct or indirect. Direct retrieved LOB data will always be fetched
38263 * no matter the setting of the lob mode. If the LOB data is less than
38264 * 512 bytes it will always be retrieved directly.
38265 *
38266 * @param resource $result Can be one of: FBSQL_LOB_DIRECT - LOB data
38267 *   is retrieved directly. When data is fetched from the database with
38268 *   {@link fbsql_fetch_row}, and other fetch functions, all CLOB and
38269 *   BLOB columns will be returned as ordinary columns. This is the
38270 *   default value on a new FrontBase result. FBSQL_LOB_HANDLE - LOB data
38271 *   is retrieved as handles to the data. When data is fetched from the
38272 *   database with {@link fbsql_fetch_row}, and other fetch functions,
38273 *   LOB data will be returned as a handle to the data if the data is
38274 *   stored indirect or the data if it is stored direct. If a handle is
38275 *   returned it will be a 27 byte string formatted as
38276 *   @'000000000000000000000000'.
38277 * @param int $lob_mode
38278 * @return bool
38279 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0
38280 **/
38281function fbsql_set_lob_mode($result, $lob_mode){}
38282
38283/**
38284 * Change the password for a given user
38285 *
38286 * Changes the password for the given {@link user}.
38287 *
38288 * @param resource $link_identifier The user name.
38289 * @param string $user The new password to be set.
38290 * @param string $password The old password to be replaced.
38291 * @param string $old_password
38292 * @return bool
38293 * @since PHP 5 < 5.3.0
38294 **/
38295function fbsql_set_password($link_identifier, $user, $password, $old_password){}
38296
38297/**
38298 * Set the transaction locking and isolation
38299 *
38300 * Sets the transaction {@link locking} and {@link isolation}.
38301 *
38302 * @param resource $link_identifier The type of locking to be set. It
38303 *   can be one of the following constants: FBSQL_LOCK_DEFERRED,
38304 *   FBSQL_LOCK_OPTIMISTIC, or FBSQL_LOCK_PESSIMISTIC.
38305 * @param int $locking The type of isolation to be set. It can be one
38306 *   of the following constants: FBSQL_ISO_READ_UNCOMMITTED,
38307 *   FBSQL_ISO_READ_COMMITTED, FBSQL_ISO_REPEATABLE_READ,
38308 *   FBSQL_ISO_SERIALIZABLE, or FBSQL_ISO_VERSIONED.
38309 * @param int $isolation
38310 * @return void
38311 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0
38312 **/
38313function fbsql_set_transaction($link_identifier, $locking, $isolation){}
38314
38315/**
38316 * Start a database on local or remote server
38317 *
38318 * @param string $database_name The database name.
38319 * @param resource $link_identifier
38320 * @param string $database_options
38321 * @return bool
38322 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
38323 **/
38324function fbsql_start_db($database_name, $link_identifier, $database_options){}
38325
38326/**
38327 * Stop a database on local or remote server
38328 *
38329 * Stops a database on local or remote server.
38330 *
38331 * @param string $database_name The database name.
38332 * @param resource $link_identifier
38333 * @return bool
38334 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
38335 **/
38336function fbsql_stop_db($database_name, $link_identifier){}
38337
38338/**
38339 * Get table name of field
38340 *
38341 * {@link fbsql_tablename} gets the name of the current table in the
38342 * given {@link result} set.
38343 *
38344 * The {@link fbsql_num_rows} function may be used to determine the
38345 * number of tables in the result pointer.
38346 *
38347 * @param resource $result A result pointer returned by {@link
38348 *   fbsql_list_tables}.
38349 * @param int $index Integer index for the current table.
38350 * @return string Returns the name of the table, as a string.
38351 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0
38352 **/
38353function fbsql_tablename($result, $index){}
38354
38355/**
38356 * Get table name of field
38357 *
38358 * {@link fbsql_table_name} gets the name of the current table in the
38359 * given {@link result} set.
38360 *
38361 * The {@link fbsql_num_rows} function may be used to determine the
38362 * number of tables in the result pointer.
38363 *
38364 * @param resource $result A result pointer returned by {@link
38365 *   fbsql_list_tables}.
38366 * @param int $index Integer index for the current table.
38367 * @return string Returns the name of the table, as a string.
38368 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0
38369 **/
38370function fbsql_table_name($result, $index){}
38371
38372/**
38373 * Get or set the username for the connection
38374 *
38375 * Get or set the username used for the connection.
38376 *
38377 * @param resource $link_identifier If provided, this is the new
38378 *   username to set.
38379 * @param string $username
38380 * @return string Returns the current username used with the
38381 *   connection, as a string.
38382 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
38383 **/
38384function fbsql_username($link_identifier, $username){}
38385
38386/**
38387 * Enable or disable FrontBase warnings
38388 *
38389 * Enables or disables FrontBase warnings.
38390 *
38391 * @param bool $OnOff Whether to enable warnings or no.
38392 * @return bool Returns TRUE if warnings is turned on, FALSE otherwise.
38393 * @since PHP 4 >= 4.0.6, PHP 5 < 5.3.0
38394 **/
38395function fbsql_warnings($OnOff){}
38396
38397/**
38398 * Closes an open file pointer
38399 *
38400 * The file pointed to by {@link handle} is closed.
38401 *
38402 * @param resource $handle The file pointer must be valid, and must
38403 *   point to a file successfully opened by {@link fopen} or {@link
38404 *   fsockopen}.
38405 * @return bool
38406 * @since PHP 4, PHP 5, PHP 7
38407 **/
38408function fclose($handle){}
38409
38410/**
38411 * Adds javascript code to the FDF document
38412 *
38413 * Adds a script to the FDF, which Acrobat then adds to the doc-level
38414 * scripts of a document, once the FDF is imported into it.
38415 *
38416 * @param resource $fdf_document The FDF document handle, returned by
38417 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38418 * @param string $script_name The script name.
38419 * @param string $script_code The script code. It is strongly suggested
38420 *   to use \r for linebreaks within the script code.
38421 * @return bool
38422 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
38423 **/
38424function fdf_add_doc_javascript($fdf_document, $script_name, $script_code){}
38425
38426/**
38427 * Adds a template into the FDF document
38428 *
38429 * @param resource $fdf_document
38430 * @param int $newpage
38431 * @param string $filename
38432 * @param string $template
38433 * @param int $rename
38434 * @return bool
38435 * @since PHP 4, PHP 5 < 5.3.0, PECL fdf SVN
38436 **/
38437function fdf_add_template($fdf_document, $newpage, $filename, $template, $rename){}
38438
38439/**
38440 * Close an FDF document
38441 *
38442 * Closes the FDF document.
38443 *
38444 * @param resource $fdf_document The FDF document handle, returned by
38445 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38446 * @return void
38447 * @since PHP 4, PHP 5 < 5.3.0, PECL fdf SVN
38448 **/
38449function fdf_close($fdf_document){}
38450
38451/**
38452 * Create a new FDF document
38453 *
38454 * Creates a new FDF document.
38455 *
38456 * This function is needed if one would like to populate input fields in
38457 * a PDF document with data.
38458 *
38459 * @return resource Returns a FDF document handle, or FALSE on error.
38460 * @since PHP 4, PHP 5 < 5.3.0, PECL fdf SVN
38461 **/
38462function fdf_create(){}
38463
38464/**
38465 * Call a user defined function for each document value
38466 *
38467 * @param resource $fdf_document
38468 * @param callable $function
38469 * @param mixed $userdata
38470 * @return bool
38471 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
38472 **/
38473function fdf_enum_values($fdf_document, $function, $userdata){}
38474
38475/**
38476 * Return error code for last fdf operation
38477 *
38478 * Gets the error code set by the last FDF function call.
38479 *
38480 * A textual description of the error may be obtained using with {@link
38481 * fdf_error}.
38482 *
38483 * @return int Returns the error code as an integer, or zero if there
38484 *   was no errors.
38485 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
38486 **/
38487function fdf_errno(){}
38488
38489/**
38490 * Return error description for FDF error code
38491 *
38492 * Gets a textual description for the FDF error code given in {@link
38493 * error_code}.
38494 *
38495 * @param int $error_code An error code obtained with {@link
38496 *   fdf_errno}. If not provided, this function uses the internal error
38497 *   code set by the last operation.
38498 * @return string Returns the error message as a string, or the string
38499 *   no error if nothing went wrong.
38500 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
38501 **/
38502function fdf_error($error_code){}
38503
38504/**
38505 * Get the appearance of a field
38506 *
38507 * Gets the appearance of a {@link field} (i.e. the value of the /AP key)
38508 * and stores it in a file.
38509 *
38510 * @param resource $fdf_document The FDF document handle, returned by
38511 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38512 * @param string $field
38513 * @param int $face The possible values are FDFNormalAP, FDFRolloverAP
38514 *   and FDFDownAP.
38515 * @param string $filename The appearance will be stored in this
38516 *   parameter.
38517 * @return bool
38518 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
38519 **/
38520function fdf_get_ap($fdf_document, $field, $face, $filename){}
38521
38522/**
38523 * Extracts uploaded file embedded in the FDF
38524 *
38525 * Extracts a file uploaded by means of the "file selection" field {@link
38526 * fieldname} and stores it under {@link savepath}.
38527 *
38528 * @param resource $fdf_document The FDF document handle, returned by
38529 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38530 * @param string $fieldname
38531 * @param string $savepath May be the name of a plain file or an
38532 *   existing directory in which the file is to be created under its
38533 *   original name. Any existing file under the same name will be
38534 *   overwritten.
38535 * @return array The returned array contains the following fields:
38536 *   {@link path} - path were the file got stored {@link size} - size of
38537 *   the stored file in bytes {@link type} - mimetype if given in the FDF
38538 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
38539 **/
38540function fdf_get_attachment($fdf_document, $fieldname, $savepath){}
38541
38542/**
38543 * Get the value of the /Encoding key
38544 *
38545 * Gets the value of the /Encoding key.
38546 *
38547 * @param resource $fdf_document The FDF document handle, returned by
38548 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38549 * @return string Returns the encoding as a string. An empty string is
38550 *   returned if the default PDFDocEncoding/Unicode scheme is used.
38551 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
38552 **/
38553function fdf_get_encoding($fdf_document){}
38554
38555/**
38556 * Get the value of the /F key
38557 *
38558 * Gets the value of the /F key.
38559 *
38560 * @param resource $fdf_document The FDF document handle, returned by
38561 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38562 * @return string Returns the key value, as a string.
38563 * @since PHP 4, PHP 5 < 5.3.0, PECL fdf SVN
38564 **/
38565function fdf_get_file($fdf_document){}
38566
38567/**
38568 * Gets the flags of a field
38569 *
38570 * @param resource $fdf_document
38571 * @param string $fieldname
38572 * @param int $whichflags
38573 * @return int
38574 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
38575 **/
38576function fdf_get_flags($fdf_document, $fieldname, $whichflags){}
38577
38578/**
38579 * Gets a value from the opt array of a field
38580 *
38581 * @param resource $fdf_document
38582 * @param string $fieldname
38583 * @param int $element
38584 * @return mixed
38585 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECLv
38586 **/
38587function fdf_get_opt($fdf_document, $fieldname, $element){}
38588
38589/**
38590 * Get the value of the /STATUS key
38591 *
38592 * Gets the value of the /STATUS key.
38593 *
38594 * @param resource $fdf_document The FDF document handle, returned by
38595 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38596 * @return string Returns the key value, as a string.
38597 * @since PHP 4, PHP 5 < 5.3.0, PECL fdf SVN
38598 **/
38599function fdf_get_status($fdf_document){}
38600
38601/**
38602 * Get the value of a field
38603 *
38604 * Gets the value for the requested field.
38605 *
38606 * @param resource $fdf_document The FDF document handle, returned by
38607 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38608 * @param string $fieldname Name of the FDF field, as a string.
38609 * @param int $which Elements of an array field can be retrieved by
38610 *   passing this optional parameter, starting at zero. For non-array
38611 *   fields, this parameter will be ignored.
38612 * @return mixed Returns the field value.
38613 * @since PHP 4, PHP 5 < 5.3.0, PECL fdf SVN
38614 **/
38615function fdf_get_value($fdf_document, $fieldname, $which){}
38616
38617/**
38618 * Gets version number for FDF API or file
38619 *
38620 * Return the FDF version for the given document, or the toolkit API
38621 * version number if no parameter is given.
38622 *
38623 * @param resource $fdf_document The FDF document handle, returned by
38624 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38625 * @return string Returns the version as a string. For the current FDF
38626 *   toolkit 5.0 the API version number is 5.0 and the document version
38627 *   number is either 1.2, 1.3 or 1.4.
38628 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
38629 **/
38630function fdf_get_version($fdf_document){}
38631
38632/**
38633 * Sets FDF-specific output headers
38634 *
38635 * This is a convenience function to set appropriate HTTP headers for FDF
38636 * output. It sets the Content-type: to application/vnd.fdf.
38637 *
38638 * @return void
38639 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVNf
38640 **/
38641function fdf_header(){}
38642
38643/**
38644 * Get the next field name
38645 *
38646 * Gets the name of the field after the given field. This name can be
38647 * used with several functions.
38648 *
38649 * @param resource $fdf_document The FDF document handle, returned by
38650 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38651 * @param string $fieldname Name of the FDF field, as a string. If not
38652 *   given, the first field will be assumed.
38653 * @return string Returns the field name as a string.
38654 * @since PHP 4, PHP 5 < 5.3.0, PECL fdf SVN
38655 **/
38656function fdf_next_field_name($fdf_document, $fieldname){}
38657
38658/**
38659 * Open a FDF document
38660 *
38661 * Opens a file with form data.
38662 *
38663 * You can also use {@link fdf_open_string} to process the results of a
38664 * PDF form POST request.
38665 *
38666 * @param string $filename Path to the FDF file. This file must contain
38667 *   the data as returned from a PDF form or created using {@link
38668 *   fdf_create} and {@link fdf_save}.
38669 * @return resource Returns a FDF document handle, or FALSE on error.
38670 * @since PHP 4, PHP 5 < 5.3.0, PECL fdf SVN
38671 **/
38672function fdf_open($filename){}
38673
38674/**
38675 * Read a FDF document from a string
38676 *
38677 * Reads form data from a string.
38678 *
38679 * You can use {@link fdf_open_string} together with $HTTP_FDF_DATA to
38680 * process FDF form input from a remote client.
38681 *
38682 * @param string $fdf_data The data as returned from a PDF form or
38683 *   created using {@link fdf_create} and {@link fdf_save_string}.
38684 * @return resource Returns a FDF document handle, or FALSE on error.
38685 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
38686 **/
38687function fdf_open_string($fdf_data){}
38688
38689/**
38690 * Sets target frame for form
38691 *
38692 * @param resource $fdf_document
38693 * @param string $fieldname
38694 * @param int $item
38695 * @return bool
38696 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
38697 **/
38698function fdf_remove_item($fdf_document, $fieldname, $item){}
38699
38700/**
38701 * Save a FDF document
38702 *
38703 * Saves a FDF document.
38704 *
38705 * @param resource $fdf_document The FDF document handle, returned by
38706 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38707 * @param string $filename If provided, the resulting FDF will be
38708 *   written in this parameter. Otherwise, this function will write the
38709 *   FDF to the default PHP output stream.
38710 * @return bool
38711 * @since PHP 4, PHP 5 < 5.3.0, PECL fdf SVN
38712 **/
38713function fdf_save($fdf_document, $filename){}
38714
38715/**
38716 * Returns the FDF document as a string
38717 *
38718 * @param resource $fdf_document The FDF document handle, returned by
38719 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38720 * @return string Returns the document as a string, or FALSE on error.
38721 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
38722 **/
38723function fdf_save_string($fdf_document){}
38724
38725/**
38726 * Set the appearance of a field
38727 *
38728 * Sets the appearance of a field (i.e. the value of the /AP key).
38729 *
38730 * @param resource $fdf_document The FDF document handle, returned by
38731 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38732 * @param string $field_name
38733 * @param int $face The possible values FDFNormalAP, FDFRolloverAP and
38734 *   FDFDownAP.
38735 * @param string $filename
38736 * @param int $page_number
38737 * @return bool
38738 * @since PHP 4, PHP 5 < 5.3.0, PECL fdf SVN
38739 **/
38740function fdf_set_ap($fdf_document, $field_name, $face, $filename, $page_number){}
38741
38742/**
38743 * Sets FDF character encoding
38744 *
38745 * Sets the character encoding for the FDF document.
38746 *
38747 * @param resource $fdf_document The FDF document handle, returned by
38748 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38749 * @param string $encoding The encoding name. The following values are
38750 *   supported: "Shift-JIS", "UHC", "GBK" and "BigFive". An empty string
38751 *   resets the encoding to the default PDFDocEncoding/Unicode scheme.
38752 * @return bool
38753 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL fdf SVN
38754 **/
38755function fdf_set_encoding($fdf_document, $encoding){}
38756
38757/**
38758 * Set PDF document to display FDF data in
38759 *
38760 * Selects a different PDF document to display the form results in then
38761 * the form it originated from.
38762 *
38763 * @param resource $fdf_document The FDF document handle, returned by
38764 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38765 * @param string $url Should be given as an absolute URL.
38766 * @param string $target_frame Use this parameter to specify the frame
38767 *   in which the document will be displayed. You can also set the
38768 *   default value for this parameter using {@link fdf_set_target_frame}.
38769 * @return bool
38770 * @since PHP 4, PHP 5 < 5.3.0, PECL fdf SVN
38771 **/
38772function fdf_set_file($fdf_document, $url, $target_frame){}
38773
38774/**
38775 * Sets a flag of a field
38776 *
38777 * Sets certain flags of the given field.
38778 *
38779 * @param resource $fdf_document The FDF document handle, returned by
38780 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38781 * @param string $fieldname Name of the FDF field, as a string.
38782 * @param int $whichFlags
38783 * @param int $newFlags
38784 * @return bool
38785 * @since PHP 4 >= 4.0.2, PHP 5 < 5.3.0, PECL fdf SVN
38786 **/
38787function fdf_set_flags($fdf_document, $fieldname, $whichFlags, $newFlags){}
38788
38789/**
38790 * Sets an javascript action of a field
38791 *
38792 * Sets a javascript action for the given field.
38793 *
38794 * @param resource $fdf_document The FDF document handle, returned by
38795 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38796 * @param string $fieldname Name of the FDF field, as a string.
38797 * @param int $trigger
38798 * @param string $script
38799 * @return bool
38800 * @since PHP 4 >= 4.0.2, PHP 5 < 5.3.0, PECL fdf SVN
38801 **/
38802function fdf_set_javascript_action($fdf_document, $fieldname, $trigger, $script){}
38803
38804/**
38805 * Adds javascript code to be executed when Acrobat opens the FDF
38806 *
38807 * @param resource $fdf_document
38808 * @param string $script
38809 * @param bool $before_data_import
38810 * @return bool
38811 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
38812 **/
38813function fdf_set_on_import_javascript($fdf_document, $script, $before_data_import){}
38814
38815/**
38816 * Sets an option of a field
38817 *
38818 * Sets options of the given field.
38819 *
38820 * @param resource $fdf_document The FDF document handle, returned by
38821 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38822 * @param string $fieldname Name of the FDF field, as a string.
38823 * @param int $element
38824 * @param string $str1
38825 * @param string $str2
38826 * @return bool
38827 * @since PHP 4 >= 4.0.2, PHP 5 < 5.3.0, PECL fdf SVN
38828 **/
38829function fdf_set_opt($fdf_document, $fieldname, $element, $str1, $str2){}
38830
38831/**
38832 * Set the value of the /STATUS key
38833 *
38834 * Sets the value of the /STATUS key. When a client receives a FDF with a
38835 * status set it will present the value in an alert box.
38836 *
38837 * @param resource $fdf_document The FDF document handle, returned by
38838 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38839 * @param string $status
38840 * @return bool
38841 * @since PHP 4, PHP 5 < 5.3.0, PECL fdf SVN
38842 **/
38843function fdf_set_status($fdf_document, $status){}
38844
38845/**
38846 * Sets a submit form action of a field
38847 *
38848 * Sets a submit form action for the given field.
38849 *
38850 * @param resource $fdf_document The FDF document handle, returned by
38851 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38852 * @param string $fieldname Name of the FDF field, as a string.
38853 * @param int $trigger
38854 * @param string $script
38855 * @param int $flags
38856 * @return bool
38857 * @since PHP 4 >= 4.0.2, PHP 5 < 5.3.0, PECL fdf SVN
38858 **/
38859function fdf_set_submit_form_action($fdf_document, $fieldname, $trigger, $script, $flags){}
38860
38861/**
38862 * Set target frame for form display
38863 *
38864 * Sets the target frame to display a result PDF defined with {@link
38865 * fdf_save_file} in.
38866 *
38867 * @param resource $fdf_document The FDF document handle, returned by
38868 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38869 * @param string $frame_name The frame name, as a string.
38870 * @return bool
38871 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
38872 **/
38873function fdf_set_target_frame($fdf_document, $frame_name){}
38874
38875/**
38876 * Set the value of a field
38877 *
38878 * Sets the {@link value} for the given field.
38879 *
38880 * @param resource $fdf_document The FDF document handle, returned by
38881 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38882 * @param string $fieldname Name of the FDF field, as a string.
38883 * @param mixed $value This parameter will be stored as a string unless
38884 *   it is an array. In this case all array elements will be stored as a
38885 *   value array.
38886 * @param int $isName
38887 * @return bool
38888 * @since PHP 4, PHP 5 < 5.3.0, PECL fdf SVN
38889 **/
38890function fdf_set_value($fdf_document, $fieldname, $value, $isName){}
38891
38892/**
38893 * Sets version number for a FDF file
38894 *
38895 * Sets the FDF {@link version} for the given document.
38896 *
38897 * Some features supported by this extension are only available in newer
38898 * FDF versions.
38899 *
38900 * @param resource $fdf_document The FDF document handle, returned by
38901 *   {@link fdf_create}, {@link fdf_open} or {@link fdf_open_string}.
38902 * @param string $version The version number. For the current FDF
38903 *   toolkit 5.0, this may be either 1.2, 1.3 or 1.4.
38904 * @return bool
38905 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
38906 **/
38907function fdf_set_version($fdf_document, $version){}
38908
38909/**
38910 * Tests for end-of-file on a file pointer
38911 *
38912 * @param resource $handle
38913 * @return bool Returns TRUE if the file pointer is at EOF or an error
38914 *   occurs (including socket timeout); otherwise returns FALSE.
38915 * @since PHP 4, PHP 5, PHP 7
38916 **/
38917function feof($handle){}
38918
38919/**
38920 * Flushes the output to a file
38921 *
38922 * This function forces a write of all buffered output to the resource
38923 * pointed to by the file {@link handle}.
38924 *
38925 * @param resource $handle
38926 * @return bool
38927 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
38928 **/
38929function fflush($handle){}
38930
38931/**
38932 * Gets character from file pointer
38933 *
38934 * Gets a character from the given file pointer.
38935 *
38936 * @param resource $handle
38937 * @return string Returns a string containing a single character read
38938 *   from the file pointed to by {@link handle}. Returns FALSE on EOF.
38939 * @since PHP 4, PHP 5, PHP 7
38940 **/
38941function fgetc($handle){}
38942
38943/**
38944 * Gets line from file pointer and parse for CSV fields
38945 *
38946 * Similar to {@link fgets} except that {@link fgetcsv} parses the line
38947 * it reads for fields in CSV format and returns an array containing the
38948 * fields read.
38949 *
38950 * @param resource $handle A valid file pointer to a file successfully
38951 *   opened by {@link fopen}, {@link popen}, or {@link fsockopen}.
38952 * @param int $length Must be greater than the longest line (in
38953 *   characters) to be found in the CSV file (allowing for trailing
38954 *   line-end characters). Otherwise the line is split in chunks of
38955 *   {@link length} characters, unless the split would occur inside an
38956 *   enclosure. Omitting this parameter (or setting it to 0 in PHP 5.1.0
38957 *   and later) the maximum line length is not limited, which is slightly
38958 *   slower.
38959 * @param string $delimiter The optional {@link delimiter} parameter
38960 *   sets the field delimiter (one character only).
38961 * @param string $enclosure The optional {@link enclosure} parameter
38962 *   sets the field enclosure character (one character only).
38963 * @param string $escape The optional {@link escape} parameter sets the
38964 *   escape character (at most one character). An empty string ("")
38965 *   disables the proprietary escape mechanism.
38966 * @return array Returns an indexed array containing the fields read.
38967 * @since PHP 4, PHP 5, PHP 7
38968 **/
38969function fgetcsv($handle, $length, $delimiter, $enclosure, $escape){}
38970
38971/**
38972 * Gets line from file pointer
38973 *
38974 * Gets a line from file pointer.
38975 *
38976 * @param resource $handle
38977 * @param int $length Reading ends when {@link length} - 1 bytes have
38978 *   been read, or a newline (which is included in the return value), or
38979 *   an EOF (whichever comes first). If no length is specified, it will
38980 *   keep reading from the stream until it reaches the end of the line.
38981 * @return string Returns a string of up to {@link length} - 1 bytes
38982 *   read from the file pointed to by {@link handle}. If there is no more
38983 *   data to read in the file pointer, then FALSE is returned.
38984 * @since PHP 4, PHP 5, PHP 7
38985 **/
38986function fgets($handle, $length){}
38987
38988/**
38989 * Gets line from file pointer and strip HTML tags
38990 *
38991 * Identical to {@link fgets}, except that {@link fgetss} attempts to
38992 * strip any NUL bytes, HTML and PHP tags from the text it reads. The
38993 * function retains the parsing state from call to call, and as such is
38994 * not equivalent to calling {@link strip_tags} on the return value of
38995 * {@link fgets}.
38996 *
38997 * @param resource $handle
38998 * @param int $length Length of the data to be retrieved.
38999 * @param string $allowable_tags You can use the optional third
39000 *   parameter to specify tags which should not be stripped. See {@link
39001 *   strip_tags} for details regarding {@link allowable_tags}.
39002 * @return string Returns a string of up to {@link length} - 1 bytes
39003 *   read from the file pointed to by {@link handle}, with all HTML and
39004 *   PHP code stripped.
39005 * @since PHP 4, PHP 5, PHP 7
39006 **/
39007function fgetss($handle, $length, $allowable_tags){}
39008
39009/**
39010 * Reads entire file into an array
39011 *
39012 * Reads an entire file into an array.
39013 *
39014 * @param string $filename Path to the file.
39015 * @param int $flags The optional parameter {@link flags} can be one,
39016 *   or more, of the following constants: FILE_USE_INCLUDE_PATH Search
39017 *   for the file in the include_path. FILE_IGNORE_NEW_LINES Omit newline
39018 *   at the end of each array element FILE_SKIP_EMPTY_LINES Skip empty
39019 *   lines
39020 * @param resource $context
39021 * @return array Returns the file in an array. Each element of the
39022 *   array corresponds to a line in the file, with the newline still
39023 *   attached. Upon failure, {@link file} returns FALSE.
39024 * @since PHP 4, PHP 5, PHP 7
39025 **/
39026function file($filename, $flags, $context){}
39027
39028/**
39029 * Gets last access time of file
39030 *
39031 * @param string $filename Path to the file.
39032 * @return int Returns the time the file was last accessed, . The time
39033 *   is returned as a Unix timestamp.
39034 * @since PHP 4, PHP 5, PHP 7
39035 **/
39036function fileatime($filename){}
39037
39038/**
39039 * Gets inode change time of file
39040 *
39041 * Gets the inode change time of a file.
39042 *
39043 * @param string $filename Path to the file.
39044 * @return int Returns the time the file was last changed, . The time
39045 *   is returned as a Unix timestamp.
39046 * @since PHP 4, PHP 5, PHP 7
39047 **/
39048function filectime($filename){}
39049
39050/**
39051 * Gets file group
39052 *
39053 * Gets the file group. The group ID is returned in numerical format, use
39054 * {@link posix_getgrgid} to resolve it to a group name.
39055 *
39056 * @param string $filename Path to the file.
39057 * @return int Returns the group ID of the file, or FALSE if an error
39058 *   occurs. The group ID is returned in numerical format, use {@link
39059 *   posix_getgrgid} to resolve it to a group name. Upon failure, FALSE
39060 *   is returned.
39061 * @since PHP 4, PHP 5, PHP 7
39062 **/
39063function filegroup($filename){}
39064
39065/**
39066 * Gets file inode
39067 *
39068 * Gets the file inode.
39069 *
39070 * @param string $filename Path to the file.
39071 * @return int Returns the inode number of the file, .
39072 * @since PHP 4, PHP 5, PHP 7
39073 **/
39074function fileinode($filename){}
39075
39076/**
39077 * Gets file modification time
39078 *
39079 * This function returns the time when the data blocks of a file were
39080 * being written to, that is, the time when the content of the file was
39081 * changed.
39082 *
39083 * @param string $filename Path to the file.
39084 * @return int Returns the time the file was last modified, . The time
39085 *   is returned as a Unix timestamp, which is suitable for the {@link
39086 *   date} function.
39087 * @since PHP 4, PHP 5, PHP 7
39088 **/
39089function filemtime($filename){}
39090
39091/**
39092 * Gets file owner
39093 *
39094 * Gets the file owner.
39095 *
39096 * @param string $filename Path to the file.
39097 * @return int Returns the user ID of the owner of the file, . The user
39098 *   ID is returned in numerical format, use {@link posix_getpwuid} to
39099 *   resolve it to a username.
39100 * @since PHP 4, PHP 5, PHP 7
39101 **/
39102function fileowner($filename){}
39103
39104/**
39105 * Gets file permissions
39106 *
39107 * Gets permissions for the given file.
39108 *
39109 * @param string $filename Path to the file.
39110 * @return int Returns the file's permissions as a numeric mode. Lower
39111 *   bits of this mode are the same as the permissions expected by {@link
39112 *   chmod}, however on most platforms the return value will also include
39113 *   information on the type of file given as {@link filename}. The
39114 *   examples below demonstrate how to test the return value for specific
39115 *   permissions and file types on POSIX systems, including Linux and
39116 *   macOS.
39117 * @since PHP 4, PHP 5, PHP 7
39118 **/
39119function fileperms($filename){}
39120
39121/**
39122 * Read and verify the map file
39123 *
39124 * This reads and verifies the map file, storing the field count and
39125 * info.
39126 *
39127 * No locking is done, so you should avoid modifying your filePro
39128 * database while it may be opened in PHP.
39129 *
39130 * @param string $directory The map directory.
39131 * @return bool
39132 * @since PHP 4, PHP 5 < 5.2.0, PECL filepro SVN
39133 **/
39134function filepro($directory){}
39135
39136/**
39137 * Find out how many fields are in a filePro database
39138 *
39139 * Returns the number of fields (columns) in the opened filePro database.
39140 *
39141 * @return int Returns the number of fields in the opened filePro
39142 *   database, or FALSE on errors.
39143 * @since PHP 4, PHP 5 < 5.2.0, PECL filepro SVN
39144 **/
39145function filepro_fieldcount(){}
39146
39147/**
39148 * Gets the name of a field
39149 *
39150 * Returns the name of the field corresponding to {@link field_number}.
39151 *
39152 * @param int $field_number The field number.
39153 * @return string Returns the name of the field as a string, or FALSE
39154 *   on errors.
39155 * @since PHP 4, PHP 5 < 5.2.0, PECL filepro SVN
39156 **/
39157function filepro_fieldname($field_number){}
39158
39159/**
39160 * Gets the type of a field
39161 *
39162 * Returns the edit type of the field corresponding to {@link
39163 * field_number}.
39164 *
39165 * @param int $field_number The field number.
39166 * @return string Returns the edit type of the field as a string, or
39167 *   FALSE on errors.
39168 * @since PHP 4, PHP 5 < 5.2.0, PECL filepro SVN
39169 **/
39170function filepro_fieldtype($field_number){}
39171
39172/**
39173 * Gets the width of a field
39174 *
39175 * Returns the width of the field corresponding to {@link field_number}.
39176 *
39177 * @param int $field_number The field number.
39178 * @return int Returns the width of the field as a integer, or FALSE on
39179 *   errors.
39180 * @since PHP 4, PHP 5 < 5.2.0, PECL filepro SVN
39181 **/
39182function filepro_fieldwidth($field_number){}
39183
39184/**
39185 * Retrieves data from a filePro database
39186 *
39187 * Returns the data from the specified location in the database.
39188 *
39189 * @param int $row_number The row number. Must be between zero and the
39190 *   total number of rows minus one (0..{@link filepro_rowcount} - 1)
39191 * @param int $field_number The field number. Accepts values between
39192 *   zero and the total number of fields minus one (0..{@link
39193 *   filepro_fieldcount} - 1)
39194 * @return string Returns the specified data, or FALSE on errors.
39195 * @since PHP 4, PHP 5 < 5.2.0, PECL filepro SVN
39196 **/
39197function filepro_retrieve($row_number, $field_number){}
39198
39199/**
39200 * Find out how many rows are in a filePro database
39201 *
39202 * Returns the number of rows in the opened filePro database.
39203 *
39204 * @return int Returns the number of rows in the opened filePro
39205 *   database, or FALSE on errors.
39206 * @since PHP 4, PHP 5 < 5.2.0, PECL filepro SVN
39207 **/
39208function filepro_rowcount(){}
39209
39210/**
39211 * Gets file size
39212 *
39213 * Gets the size for the given file.
39214 *
39215 * @param string $filename Path to the file.
39216 * @return int Returns the size of the file in bytes, or FALSE (and
39217 *   generates an error of level E_WARNING) in case of an error.
39218 * @since PHP 4, PHP 5, PHP 7
39219 **/
39220function filesize($filename){}
39221
39222/**
39223 * Gets file type
39224 *
39225 * Returns the type of the given file.
39226 *
39227 * @param string $filename Path to the file.
39228 * @return string Returns the type of the file. Possible values are
39229 *   fifo, char, dir, block, link, file, socket and unknown.
39230 * @since PHP 4, PHP 5, PHP 7
39231 **/
39232function filetype($filename){}
39233
39234/**
39235 * Checks whether a file or directory exists
39236 *
39237 * @param string $filename Path to the file or directory. On windows,
39238 *   use //computername/share/filename or \\computername\share\filename
39239 *   to check files on network shares.
39240 * @return bool Returns TRUE if the file or directory specified by
39241 *   {@link filename} exists; FALSE otherwise.
39242 * @since PHP 4, PHP 5, PHP 7
39243 **/
39244function file_exists($filename){}
39245
39246/**
39247 * Reads entire file into a string
39248 *
39249 * This function is similar to {@link file}, except that {@link
39250 * file_get_contents} returns the file in a string, starting at the
39251 * specified {@link offset} up to {@link maxlen} bytes. On failure,
39252 * {@link file_get_contents} will return FALSE.
39253 *
39254 * {@link file_get_contents} is the preferred way to read the contents of
39255 * a file into a string. It will use memory mapping techniques if
39256 * supported by your OS to enhance performance.
39257 *
39258 * @param string $filename Name of the file to read.
39259 * @param bool $use_include_path
39260 * @param resource $context A valid context resource created with
39261 *   {@link stream_context_create}. If you don't need to use a custom
39262 *   context, you can skip this parameter by NULL.
39263 * @param int $offset The offset where the reading starts on the
39264 *   original stream. Negative offsets count from the end of the stream.
39265 *   Seeking ({@link offset}) is not supported with remote files.
39266 *   Attempting to seek on non-local files may work with small offsets,
39267 *   but this is unpredictable because it works on the buffered stream.
39268 * @param int $maxlen Maximum length of data read. The default is to
39269 *   read until end of file is reached. Note that this parameter is
39270 *   applied to the stream processed by the filters.
39271 * @return string The function returns the read data .
39272 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
39273 **/
39274function file_get_contents($filename, $use_include_path, $context, $offset, $maxlen){}
39275
39276/**
39277 * Write data to a file
39278 *
39279 * This function is identical to calling {@link fopen}, {@link fwrite}
39280 * and {@link fclose} successively to write data to a file.
39281 *
39282 * If {@link filename} does not exist, the file is created. Otherwise,
39283 * the existing file is overwritten, unless the FILE_APPEND flag is set.
39284 *
39285 * @param string $filename Path to the file where to write the data.
39286 * @param mixed $data The data to write. Can be either a string, an
39287 *   array or a stream resource. If {@link data} is a stream resource,
39288 *   the remaining buffer of that stream will be copied to the specified
39289 *   file. This is similar with using {@link stream_copy_to_stream}. You
39290 *   can also specify the {@link data} parameter as a single dimension
39291 *   array. This is equivalent to file_put_contents($filename,
39292 *   implode('', $array)).
39293 * @param int $flags The value of {@link flags} can be any combination
39294 *   of the following flags, joined with the binary OR (|) operator.
39295 *
39296 *   Available flags Flag Description FILE_USE_INCLUDE_PATH Search for
39297 *   {@link filename} in the include directory. See include_path for more
39298 *   information. FILE_APPEND If file {@link filename} already exists,
39299 *   append the data to the file instead of overwriting it. LOCK_EX
39300 *   Acquire an exclusive lock on the file while proceeding to the
39301 *   writing. In other words, a {@link flock} call happens between the
39302 *   {@link fopen} call and the {@link fwrite} call. This is not
39303 *   identical to an {@link fopen} call with mode "x".
39304 * @param resource $context A valid context resource created with
39305 *   {@link stream_context_create}.
39306 * @return int This function returns the number of bytes that were
39307 *   written to the file, or FALSE on failure.
39308 * @since PHP 5, PHP 7
39309 **/
39310function file_put_contents($filename, $data, $flags, $context){}
39311
39312/**
39313 * Checks if variable of specified type exists
39314 *
39315 * @param int $type One of INPUT_GET, INPUT_POST, INPUT_COOKIE,
39316 *   INPUT_SERVER, or INPUT_ENV.
39317 * @param string $variable_name Name of a variable to check.
39318 * @return bool
39319 * @since PHP 5 >= 5.2.0, PHP 7
39320 **/
39321function filter_has_var($type, $variable_name){}
39322
39323/**
39324 * Returns the filter ID belonging to a named filter
39325 *
39326 * @param string $filtername Name of a filter to get.
39327 * @return int ID of a filter on success or FALSE if filter doesn't
39328 *   exist.
39329 * @since PHP 5 >= 5.2.0, PHP 7
39330 **/
39331function filter_id($filtername){}
39332
39333/**
39334 * Gets a specific external variable by name and optionally filters it
39335 *
39336 * @param int $type One of INPUT_GET, INPUT_POST, INPUT_COOKIE,
39337 *   INPUT_SERVER, or INPUT_ENV.
39338 * @param string $variable_name Name of a variable to get.
39339 * @param int $filter Associative array of options or bitwise
39340 *   disjunction of flags. If filter accepts options, flags can be
39341 *   provided in "flags" field of array.
39342 * @param mixed $options
39343 * @return mixed Value of the requested variable on success, FALSE if
39344 *   the filter fails, or NULL if the {@link variable_name} variable is
39345 *   not set. If the flag FILTER_NULL_ON_FAILURE is used, it returns
39346 *   FALSE if the variable is not set and NULL if the filter fails.
39347 * @since PHP 5 >= 5.2.0, PHP 7
39348 **/
39349function filter_input($type, $variable_name, $filter, $options){}
39350
39351/**
39352 * Gets external variables and optionally filters them
39353 *
39354 * This function is useful for retrieving many values without
39355 * repetitively calling {@link filter_input}.
39356 *
39357 * @param int $type One of INPUT_GET, INPUT_POST, INPUT_COOKIE,
39358 *   INPUT_SERVER, or INPUT_ENV.
39359 * @param mixed $definition An array defining the arguments. A valid
39360 *   key is a string containing a variable name and a valid value is
39361 *   either a filter type, or an array optionally specifying the filter,
39362 *   flags and options. If the value is an array, valid keys are filter
39363 *   which specifies the filter type, flags which specifies any flags
39364 *   that apply to the filter, and options which specifies any options
39365 *   that apply to the filter. See the example below for a better
39366 *   understanding. This parameter can be also an integer holding a
39367 *   filter constant. Then all values in the input array are filtered by
39368 *   this filter.
39369 * @param bool $add_empty Add missing keys as NULL to the return value.
39370 * @return mixed An array containing the values of the requested
39371 *   variables on success. If the input array designated by {@link type}
39372 *   is not populated, the function returns NULL if the
39373 *   FILTER_NULL_ON_FAILURE flag is not given, or FALSE otherwise. For
39374 *   other failures, FALSE is returned.
39375 * @since PHP 5 >= 5.2.0, PHP 7
39376 **/
39377function filter_input_array($type, $definition, $add_empty){}
39378
39379/**
39380 * Returns a list of all supported filters
39381 *
39382 * @return array Returns an array of names of all supported filters,
39383 *   empty array if there are no such filters. Indexes of this array are
39384 *   not filter IDs, they can be obtained with {@link filter_id} from a
39385 *   name instead.
39386 * @since PHP 5 >= 5.2.0, PHP 7
39387 **/
39388function filter_list(){}
39389
39390/**
39391 * Filters a variable with a specified filter
39392 *
39393 * @param mixed $variable Value to filter. Note that scalar values are
39394 *   converted to string internally before they are filtered.
39395 * @param int $filter Associative array of options or bitwise
39396 *   disjunction of flags. If filter accepts options, flags can be
39397 *   provided in "flags" field of array. For the "callback" filter,
39398 *   callable type should be passed. The callback must accept one
39399 *   argument, the value to be filtered, and return the value after
39400 *   filtering/sanitizing it.
39401 *
39402 *   <?php // for filters that accept options, use this format $options =
39403 *   array( 'options' => array( 'default' => 3, // value to return if the
39404 *   filter fails // other options here 'min_range' => 0 ), 'flags' =>
39405 *   FILTER_FLAG_ALLOW_OCTAL, ); $var = filter_var('0755',
39406 *   FILTER_VALIDATE_INT, $options);
39407 *
39408 *   // for filters that only accept flags, you can pass them directly
39409 *   $var = filter_var('oops', FILTER_VALIDATE_BOOLEAN,
39410 *   FILTER_NULL_ON_FAILURE);
39411 *
39412 *   // for filters that only accept flags, you can also pass as an array
39413 *   $var = filter_var('oops', FILTER_VALIDATE_BOOLEAN, array('flags' =>
39414 *   FILTER_NULL_ON_FAILURE));
39415 *
39416 *   // callback validate filter function foo($value) { // Expected
39417 *   format: Surname, GivenNames if (strpos($value, ", ") === false)
39418 *   return false; list($surname, $givennames) = explode(", ", $value,
39419 *   2); $empty = (empty($surname) || empty($givennames)); $notstrings =
39420 *   (!is_string($surname) || !is_string($givennames)); if ($empty ||
39421 *   $notstrings) { return false; } else { return $value; } } $var =
39422 *   filter_var('Doe, Jane Sue', FILTER_CALLBACK, array('options' =>
39423 *   'foo')); ?>
39424 * @param mixed $options
39425 * @return mixed Returns the filtered data, or FALSE if the filter
39426 *   fails.
39427 * @since PHP 5 >= 5.2.0, PHP 7
39428 **/
39429function filter_var($variable, $filter, $options){}
39430
39431/**
39432 * Gets multiple variables and optionally filters them
39433 *
39434 * This function is useful for retrieving many values without
39435 * repetitively calling {@link filter_var}.
39436 *
39437 * @param array $data An array with string keys containing the data to
39438 *   filter.
39439 * @param mixed $definition An array defining the arguments. A valid
39440 *   key is a string containing a variable name and a valid value is
39441 *   either a filter type, or an array optionally specifying the filter,
39442 *   flags and options. If the value is an array, valid keys are filter
39443 *   which specifies the filter type, flags which specifies any flags
39444 *   that apply to the filter, and options which specifies any options
39445 *   that apply to the filter. See the example below for a better
39446 *   understanding. This parameter can be also an integer holding a
39447 *   filter constant. Then all values in the input array are filtered by
39448 *   this filter.
39449 * @param bool $add_empty Add missing keys as NULL to the return value.
39450 * @return mixed An array containing the values of the requested
39451 *   variables on success, or FALSE on failure. An array value will be
39452 *   FALSE if the filter fails, or NULL if the variable is not set.
39453 * @since PHP 5 >= 5.2.0, PHP 7
39454 **/
39455function filter_var_array($data, $definition, $add_empty){}
39456
39457/**
39458 * Return information about a string buffer
39459 *
39460 * This function is used to get information about binary data in a
39461 * string.
39462 *
39463 * @param resource $finfo Fileinfo resource returned by {@link
39464 *   finfo_open}.
39465 * @param string $string Content of a file to be checked.
39466 * @param int $options One or disjunction of more Fileinfo constants.
39467 * @param resource $context
39468 * @return string Returns a textual description of the {@link string}
39469 *   argument, or FALSE if an error occurred.
39470 * @since PHP 5 >= 5.3.0, PHP 7, PECL fileinfo >= 0.1.0
39471 **/
39472function finfo_buffer($finfo, $string, $options, $context){}
39473
39474/**
39475 * Close fileinfo resource
39476 *
39477 * This function closes the resource opened by {@link finfo_open}.
39478 *
39479 * @param resource $finfo Fileinfo resource returned by {@link
39480 *   finfo_open}.
39481 * @return bool
39482 * @since PHP >= 5.3.0, PECL fileinfo >= 0.1.0
39483 **/
39484function finfo_close($finfo){}
39485
39486/**
39487 * Return information about a file
39488 *
39489 * This function is used to get information about a file.
39490 *
39491 * @param resource $finfo Fileinfo resource returned by {@link
39492 *   finfo_open}.
39493 * @param string $file_name Name of a file to be checked.
39494 * @param int $options One or disjunction of more Fileinfo constants.
39495 * @param resource $context For a description of contexts, refer to .
39496 * @return string Returns a textual description of the contents of the
39497 *   {@link file_name} argument, or FALSE if an error occurred.
39498 * @since PHP >= 5.3.0, PECL fileinfo >= 0.1.0
39499 **/
39500function finfo_file($finfo, $file_name, $options, $context){}
39501
39502/**
39503 * Create a new fileinfo resource
39504 *
39505 * (constructor):
39506 *
39507 * This function opens a magic database and returns its resource.
39508 *
39509 * @param int $options One or disjunction of more Fileinfo constants.
39510 * @param string $magic_file Name of a magic database file, usually
39511 *   something like /path/to/magic.mime. If not specified, the MAGIC
39512 *   environment variable is used. If the environment variable isn't set,
39513 *   then PHP's bundled magic database will be used. Passing NULL or an
39514 *   empty string will be equivalent to the default value.
39515 * @return resource (Procedural style only) Returns a magic database
39516 *   resource on success.
39517 * @since PHP >= 5.3.0, PECL fileinfo >= 0.1.0
39518 **/
39519function finfo_open($options, $magic_file){}
39520
39521/**
39522 * Set libmagic configuration options
39523 *
39524 * This function sets various Fileinfo options. Options can be set also
39525 * directly in {@link finfo_open} or other Fileinfo functions.
39526 *
39527 * @param resource $finfo Fileinfo resource returned by {@link
39528 *   finfo_open}.
39529 * @param int $options One or disjunction of more Fileinfo constants.
39530 * @return bool
39531 * @since PHP >= 5.3.0, PECL fileinfo >= 0.1.0
39532 **/
39533function finfo_set_flags($finfo, $options){}
39534
39535/**
39536 * Get float value of a variable
39537 *
39538 * Gets the float value of {@link var}.
39539 *
39540 * @param mixed $var May be any scalar type. {@link floatval} should
39541 *   not be used on objects, as doing so will emit an E_NOTICE level
39542 *   error and return 1.
39543 * @return float The float value of the given variable. Empty arrays
39544 *   return 0, non-empty arrays return 1.
39545 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
39546 **/
39547function floatval($var){}
39548
39549/**
39550 * Portable advisory file locking
39551 *
39552 * {@link flock} allows you to perform a simple reader/writer model which
39553 * can be used on virtually every platform (including most Unix
39554 * derivatives and even Windows).
39555 *
39556 * On versions of PHP before 5.3.2, the lock is released also by {@link
39557 * fclose} (which is also called automatically when script finished).
39558 *
39559 * PHP supports a portable way of locking complete files in an advisory
39560 * way (which means all accessing programs have to use the same way of
39561 * locking or it will not work). By default, this function will block
39562 * until the requested lock is acquired; this may be controlled with the
39563 * LOCK_NB option documented below.
39564 *
39565 * @param resource $handle
39566 * @param int $operation {@link operation} is one of the following:
39567 *   LOCK_SH to acquire a shared lock (reader). LOCK_EX to acquire an
39568 *   exclusive lock (writer). LOCK_UN to release a lock (shared or
39569 *   exclusive). It is also possible to add LOCK_NB as a bitmask to one
39570 *   of the above operations if you don't want {@link flock} to block
39571 *   while locking.
39572 * @param int $wouldblock The optional third argument is set to 1 if
39573 *   the lock would block (EWOULDBLOCK errno condition).
39574 * @return bool
39575 * @since PHP 4, PHP 5, PHP 7
39576 **/
39577function flock($handle, $operation, &$wouldblock){}
39578
39579/**
39580 * Round fractions down
39581 *
39582 * @param float $value The numeric value to round
39583 * @return float {@link value} rounded to the next lowest integer. The
39584 *   return value of {@link floor} is still of type float because the
39585 *   value range of float is usually bigger than that of integer. This
39586 *   function returns FALSE in case of an error (e.g. passing an array).
39587 * @since PHP 4, PHP 5, PHP 7
39588 **/
39589function floor($value){}
39590
39591/**
39592 * Flush system output buffer
39593 *
39594 * Flushes the system write buffers of PHP and whatever backend PHP is
39595 * using (CGI, a web server, etc). This attempts to push current output
39596 * all the way to the browser with a few caveats.
39597 *
39598 * {@link flush} may not be able to override the buffering scheme of your
39599 * web server and it has no effect on any client-side buffering in the
39600 * browser. It also doesn't affect PHP's userspace output buffering
39601 * mechanism. This means you will have to call both {@link ob_flush} and
39602 * {@link flush} to flush the ob output buffers if you are using those.
39603 *
39604 * Several servers, especially on Win32, will still buffer the output
39605 * from your script until it terminates before transmitting the results
39606 * to the browser.
39607 *
39608 * Server modules for Apache like mod_gzip may do buffering of their own
39609 * that will cause {@link flush} to not result in data being sent
39610 * immediately to the client.
39611 *
39612 * Even the browser may buffer its input before displaying it. Netscape,
39613 * for example, buffers text until it receives an end-of-line or the
39614 * beginning of a tag, and it won't render tables until the </table> tag
39615 * of the outermost table is seen.
39616 *
39617 * Some versions of Microsoft Internet Explorer will only start to
39618 * display the page after they have received 256 bytes of output, so you
39619 * may need to send extra whitespace before flushing to get those
39620 * browsers to display the page.
39621 *
39622 * @return void
39623 * @since PHP 4, PHP 5, PHP 7
39624 **/
39625function flush(){}
39626
39627/**
39628 * Returns the floating point remainder (modulo) of the division of the
39629 * arguments
39630 *
39631 * Returns the floating point remainder of dividing the dividend ({@link
39632 * x}) by the divisor ({@link y}). The remainder (r) is defined as: x = i
39633 * * y + r, for some integer i. If {@link y} is non-zero, r has the same
39634 * sign as {@link x} and a magnitude less than the magnitude of {@link
39635 * y}.
39636 *
39637 * @param float $x The dividend
39638 * @param float $y The divisor
39639 * @return float The floating point remainder of {@link x}/{@link y}
39640 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
39641 **/
39642function fmod($x, $y){}
39643
39644/**
39645 * Match filename against a pattern
39646 *
39647 * {@link fnmatch} checks if the passed {@link string} would match the
39648 * given shell wildcard {@link pattern}.
39649 *
39650 * @param string $pattern The shell wildcard pattern.
39651 * @param string $string The tested string. This function is especially
39652 *   useful for filenames, but may also be used on regular strings. The
39653 *   average user may be used to shell patterns or at least in their
39654 *   simplest form to '?' and '*' wildcards so using {@link fnmatch}
39655 *   instead of {@link preg_match} for frontend search expression input
39656 *   may be way more convenient for non-programming users.
39657 * @param int $flags The value of {@link flags} can be any combination
39658 *   of the following flags, joined with the binary OR (|) operator. A
39659 *   list of possible flags for {@link fnmatch} {@link Flag} Description
39660 *   FNM_NOESCAPE Disable backslash escaping. FNM_PATHNAME Slash in
39661 *   string only matches slash in the given pattern. FNM_PERIOD Leading
39662 *   period in string must be exactly matched by period in the given
39663 *   pattern. FNM_CASEFOLD Caseless match. Part of the GNU extension.
39664 * @return bool Returns TRUE if there is a match, FALSE otherwise.
39665 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
39666 **/
39667function fnmatch($pattern, $string, $flags){}
39668
39669/**
39670 * Opens file or URL
39671 *
39672 * {@link fopen} binds a named resource, specified by {@link filename},
39673 * to a stream.
39674 *
39675 * @param string $filename If {@link filename} is of the form
39676 *   "scheme://...", it is assumed to be a URL and PHP will search for a
39677 *   protocol handler (also known as a wrapper) for that scheme. If no
39678 *   wrappers for that protocol are registered, PHP will emit a notice to
39679 *   help you track potential problems in your script and then continue
39680 *   as though {@link filename} specifies a regular file. If PHP has
39681 *   decided that {@link filename} specifies a local file, then it will
39682 *   try to open a stream on that file. The file must be accessible to
39683 *   PHP, so you need to ensure that the file access permissions allow
39684 *   this access. If you have enabled or open_basedir further
39685 *   restrictions may apply. If PHP has decided that {@link filename}
39686 *   specifies a registered protocol, and that protocol is registered as
39687 *   a network URL, PHP will check to make sure that allow_url_fopen is
39688 *   enabled. If it is switched off, PHP will emit a warning and the
39689 *   fopen call will fail. On the Windows platform, be careful to escape
39690 *   any backslashes used in the path to the file, or use forward
39691 *   slashes.
39692 *
39693 *   <?php $handle = fopen("c:\\folder\\resource.txt", "r"); ?>
39694 * @param string $mode The {@link mode} parameter specifies the type of
39695 *   access you require to the stream. It may be any of the following: A
39696 *   list of possible modes for {@link fopen} using {@link mode} {@link
39697 *   mode} Description 'r' Open for reading only; place the file pointer
39698 *   at the beginning of the file. 'r+' Open for reading and writing;
39699 *   place the file pointer at the beginning of the file. 'w' Open for
39700 *   writing only; place the file pointer at the beginning of the file
39701 *   and truncate the file to zero length. If the file does not exist,
39702 *   attempt to create it. 'w+' Open for reading and writing; place the
39703 *   file pointer at the beginning of the file and truncate the file to
39704 *   zero length. If the file does not exist, attempt to create it. 'a'
39705 *   Open for writing only; place the file pointer at the end of the
39706 *   file. If the file does not exist, attempt to create it. In this
39707 *   mode, {@link fseek} has no effect, writes are always appended. 'a+'
39708 *   Open for reading and writing; place the file pointer at the end of
39709 *   the file. If the file does not exist, attempt to create it. In this
39710 *   mode, {@link fseek} only affects the reading position, writes are
39711 *   always appended. 'x' Create and open for writing only; place the
39712 *   file pointer at the beginning of the file. If the file already
39713 *   exists, the {@link fopen} call will fail by returning FALSE and
39714 *   generating an error of level E_WARNING. If the file does not exist,
39715 *   attempt to create it. This is equivalent to specifying
39716 *   O_EXCL|O_CREAT flags for the underlying open(2) system call. 'x+'
39717 *   Create and open for reading and writing; otherwise it has the same
39718 *   behavior as 'x'. 'c' Open the file for writing only. If the file
39719 *   does not exist, it is created. If it exists, it is neither truncated
39720 *   (as opposed to 'w'), nor the call to this function fails (as is the
39721 *   case with 'x'). The file pointer is positioned on the beginning of
39722 *   the file. This may be useful if it's desired to get an advisory lock
39723 *   (see {@link flock}) before attempting to modify the file, as using
39724 *   'w' could truncate the file before the lock was obtained (if
39725 *   truncation is desired, {@link ftruncate} can be used after the lock
39726 *   is requested). 'c+' Open the file for reading and writing; otherwise
39727 *   it has the same behavior as 'c'. 'e' Set close-on-exec flag on the
39728 *   opened file descriptor. Only available in PHP compiled on
39729 *   POSIX.1-2008 conform systems.
39730 * @param bool $use_include_path The optional third {@link
39731 *   use_include_path} parameter can be set to '1' or TRUE if you want to
39732 *   search for the file in the include_path, too.
39733 * @param resource $context
39734 * @return resource Returns a file pointer resource on success,
39735 * @since PHP 4, PHP 5, PHP 7
39736 **/
39737function fopen($filename, $mode, $use_include_path, $context){}
39738
39739/**
39740 * Call a static method
39741 *
39742 * Calls a user defined function or method given by the {@link function}
39743 * parameter, with the following arguments. This function must be called
39744 * within a method context, it can't be used outside a class. It uses the
39745 * late static binding.
39746 *
39747 * @param callable $function The function or method to be called. This
39748 *   parameter may be an array, with the name of the class, and the
39749 *   method, or a string, with a function name.
39750 * @param mixed ...$vararg Zero or more parameters to be passed to the
39751 *   function.
39752 * @return mixed Returns the function result, or FALSE on error.
39753 * @since PHP 5 >= 5.3.0, PHP 7
39754 **/
39755function forward_static_call($function, ...$vararg){}
39756
39757/**
39758 * Call a static method and pass the arguments as array
39759 *
39760 * Calls a user defined function or method given by the {@link function}
39761 * parameter. This function must be called within a method context, it
39762 * can't be used outside a class. It uses the late static binding. All
39763 * arguments of the forwarded method are passed as values, and as an
39764 * array, similarly to {@link call_user_func_array}.
39765 *
39766 * @param callable $function The function or method to be called. This
39767 *   parameter may be an , with the name of the class, and the method, or
39768 *   a , with a function name.
39769 * @param array $parameters One parameter, gathering all the method
39770 *   parameter in one array.
39771 * @return mixed Returns the function result, or FALSE on error.
39772 * @since PHP 5 >= 5.3.0, PHP 7
39773 **/
39774function forward_static_call_array($function, $parameters){}
39775
39776/**
39777 * Output all remaining data on a file pointer
39778 *
39779 * Reads to EOF on the given file pointer from the current position and
39780 * writes the results to the output buffer.
39781 *
39782 * You may need to call {@link rewind} to reset the file pointer to the
39783 * beginning of the file if you have already written data to the file.
39784 *
39785 * If you just want to dump the contents of a file to the output buffer,
39786 * without first modifying it or seeking to a particular offset, you may
39787 * want to use the {@link readfile}, which saves you the {@link fopen}
39788 * call.
39789 *
39790 * @param resource $handle
39791 * @return int If an error occurs, {@link fpassthru} returns FALSE.
39792 *   Otherwise, {@link fpassthru} returns the number of characters read
39793 *   from {@link handle} and passed through to the output.
39794 * @since PHP 4, PHP 5, PHP 7
39795 **/
39796function fpassthru($handle){}
39797
39798/**
39799 * Write a formatted string to a stream
39800 *
39801 * Write a string produced according to {@link format} to the stream
39802 * resource specified by {@link handle}.
39803 *
39804 * @param resource $handle
39805 * @param string $format
39806 * @param mixed ...$vararg
39807 * @return int Returns the length of the string written.
39808 * @since PHP 5, PHP 7
39809 **/
39810function fprintf($handle, $format, ...$vararg){}
39811
39812/**
39813 * Format line as CSV and write to file pointer
39814 *
39815 * {@link fputcsv} formats a line (passed as a {@link fields} array) as
39816 * CSV and writes it (terminated by a newline) to the specified file
39817 * {@link handle}.
39818 *
39819 * @param resource $handle
39820 * @param array $fields An array of strings.
39821 * @param string $delimiter The optional {@link delimiter} parameter
39822 *   sets the field delimiter (one character only).
39823 * @param string $enclosure The optional {@link enclosure} parameter
39824 *   sets the field enclosure (one character only).
39825 * @param string $escape_char The optional {@link escape_char}
39826 *   parameter sets the escape character (at most one character). An
39827 *   empty string ("") disables the proprietary escape mechanism.
39828 * @return int Returns the length of the written string .
39829 * @since PHP 5 >= 5.1.0, PHP 7
39830 **/
39831function fputcsv($handle, $fields, $delimiter, $enclosure, $escape_char){}
39832
39833/**
39834 * Binary-safe file write
39835 *
39836 * @param resource $handle
39837 * @param string $string The string that is to be written.
39838 * @param int $length If the {@link length} argument is given, writing
39839 *   will stop after {@link length} bytes have been written or the end of
39840 *   {@link string} is reached, whichever comes first. Note that if the
39841 *   {@link length} argument is given, then the magic_quotes_runtime
39842 *   configuration option will be ignored and no slashes will be stripped
39843 *   from {@link string}.
39844 * @return int
39845 * @since PHP 4, PHP 5, PHP 7
39846 **/
39847function fputs($handle, $string, $length){}
39848
39849/**
39850 * Binary-safe file read
39851 *
39852 * {@link fread} reads up to {@link length} bytes from the file pointer
39853 * referenced by {@link handle}. Reading stops as soon as one of the
39854 * following conditions is met: {@link length} bytes have been read EOF
39855 * (end of file) is reached a packet becomes available or the socket
39856 * timeout occurs (for network streams) if the stream is read buffered
39857 * and it does not represent a plain file, at most one read of up to a
39858 * number of bytes equal to the chunk size (usually 8192) is made;
39859 * depending on the previously buffered data, the size of the returned
39860 * data may be larger than the chunk size.
39861 *
39862 * @param resource $handle
39863 * @param int $length Up to {@link length} number of bytes read.
39864 * @return string Returns the read string .
39865 * @since PHP 4, PHP 5, PHP 7
39866 **/
39867function fread($handle, $length){}
39868
39869/**
39870 * Converts a date from the French Republican Calendar to a Julian Day
39871 * Count
39872 *
39873 * Converts a date from the French Republican Calendar to a Julian Day
39874 * Count.
39875 *
39876 * These routines only convert dates in years 1 through 14 (Gregorian
39877 * dates 22 September 1792 through 22 September 1806). This more than
39878 * covers the period when the calendar was in use.
39879 *
39880 * @param int $month The month as a number from 1 (for Vendémiaire) to
39881 *   13 (for the period of 5-6 days at the end of each year)
39882 * @param int $day The day as a number from 1 to 30
39883 * @param int $year The year as a number between 1 and 14
39884 * @return int The julian day for the given french revolution date as
39885 *   an integer.
39886 * @since PHP 4, PHP 5, PHP 7
39887 **/
39888function frenchtojd($month, $day, $year){}
39889
39890/**
39891 * Convert a logical string to a visual one
39892 *
39893 * Converts a logical string to a visual one.
39894 *
39895 * @param string $str The logical string.
39896 * @param string $direction One of FRIBIDI_RTL, FRIBIDI_LTR or
39897 *   FRIBIDI_AUTO.
39898 * @param int $charset One of the FRIBIDI_CHARSET_XXX constants.
39899 * @return string Returns the visual string on success.
39900 * @since PHP 4 >= 4.0.4 and PHP 4 = 1.0
39901 **/
39902function fribidi_log2vis($str, $direction, $charset){}
39903
39904/**
39905 * Parses input from a file according to a format
39906 *
39907 * The function {@link fscanf} is similar to {@link sscanf}, but it takes
39908 * its input from a file associated with {@link handle} and interprets
39909 * the input according to the specified {@link format}, which is
39910 * described in the documentation for {@link sprintf}.
39911 *
39912 * Any whitespace in the format string matches any whitespace in the
39913 * input stream. This means that even a tab \t in the format string can
39914 * match a single space character in the input stream.
39915 *
39916 * Each call to {@link fscanf} reads one line from the file.
39917 *
39918 * @param resource $handle
39919 * @param string $format The optional assigned values.
39920 * @param mixed ...$vararg
39921 * @return mixed If only two parameters were passed to this function,
39922 *   the values parsed will be returned as an array. Otherwise, if
39923 *   optional parameters are passed, the function will return the number
39924 *   of assigned values. The optional parameters must be passed by
39925 *   reference.
39926 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
39927 **/
39928function fscanf($handle, $format, &...$vararg){}
39929
39930/**
39931 * Seeks on a file pointer
39932 *
39933 * Sets the file position indicator for the file referenced by {@link
39934 * handle}. The new position, measured in bytes from the beginning of the
39935 * file, is obtained by adding {@link offset} to the position specified
39936 * by {@link whence}.
39937 *
39938 * In general, it is allowed to seek past the end-of-file; if data is
39939 * then written, reads in any unwritten region between the end-of-file
39940 * and the sought position will yield bytes with value 0. However,
39941 * certain streams may not support this behavior, especially when they
39942 * have an underlying fixed size storage.
39943 *
39944 * @param resource $handle
39945 * @param int $offset The offset. To move to a position before the
39946 *   end-of-file, you need to pass a negative value in {@link offset} and
39947 *   set {@link whence} to SEEK_END.
39948 * @param int $whence {@link whence} values are: SEEK_SET - Set
39949 *   position equal to {@link offset} bytes. SEEK_CUR - Set position to
39950 *   current location plus {@link offset}. SEEK_END - Set position to
39951 *   end-of-file plus {@link offset}.
39952 * @return int Upon success, returns 0; otherwise, returns -1.
39953 * @since PHP 4, PHP 5, PHP 7
39954 **/
39955function fseek($handle, $offset, $whence){}
39956
39957/**
39958 * Open Internet or Unix domain socket connection
39959 *
39960 * Initiates a socket connection to the resource specified by {@link
39961 * hostname}.
39962 *
39963 * PHP supports targets in the Internet and Unix domains as described in
39964 * . A list of supported transports can also be retrieved using {@link
39965 * stream_get_transports}.
39966 *
39967 * The socket will by default be opened in blocking mode. You can switch
39968 * it to non-blocking mode by using {@link stream_set_blocking}.
39969 *
39970 * The function {@link stream_socket_client} is similar but provides a
39971 * richer set of options, including non-blocking connection and the
39972 * ability to provide a stream context.
39973 *
39974 * @param string $hostname If OpenSSL support is installed, you may
39975 *   prefix the {@link hostname} with either ssl:// or tls:// to use an
39976 *   SSL or TLS client connection over TCP/IP to connect to the remote
39977 *   host.
39978 * @param int $port The port number. This can be omitted and skipped
39979 *   with -1 for transports that do not use ports, such as unix://.
39980 * @param int $errno If provided, holds the system level error number
39981 *   that occurred in the system-level connect() call. If the value
39982 *   returned in {@link errno} is 0 and the function returned FALSE, it
39983 *   is an indication that the error occurred before the connect() call.
39984 *   This is most likely due to a problem initializing the socket.
39985 * @param string $errstr The error message as a string.
39986 * @param float $timeout The connection timeout, in seconds.
39987 * @return resource {@link fsockopen} returns a file pointer which may
39988 *   be used together with the other file functions (such as {@link
39989 *   fgets}, {@link fgetss}, {@link fwrite}, {@link fclose}, and {@link
39990 *   feof}). If the call fails, it will return FALSE
39991 * @since PHP 4, PHP 5, PHP 7
39992 **/
39993function fsockopen($hostname, $port, &$errno, &$errstr, $timeout){}
39994
39995/**
39996 * Gets information about a file using an open file pointer
39997 *
39998 * Gathers the statistics of the file opened by the file pointer {@link
39999 * handle}. This function is similar to the {@link stat} function except
40000 * that it operates on an open file pointer instead of a filename.
40001 *
40002 * @param resource $handle
40003 * @return array Returns an array with the statistics of the file; the
40004 *   format of the array is described in detail on the {@link stat}
40005 *   manual page.
40006 * @since PHP 4, PHP 5, PHP 7
40007 **/
40008function fstat($handle){}
40009
40010/**
40011 * Returns the current position of the file read/write pointer
40012 *
40013 * Returns the position of the file pointer referenced by {@link handle}.
40014 *
40015 * @param resource $handle The file pointer must be valid, and must
40016 *   point to a file successfully opened by {@link fopen} or {@link
40017 *   popen}. {@link ftell} gives undefined results for append-only
40018 *   streams (opened with "a" flag).
40019 * @return int Returns the position of the file pointer referenced by
40020 *   {@link handle} as an integer; i.e., its offset into the file stream.
40021 * @since PHP 4, PHP 5, PHP 7
40022 **/
40023function ftell($handle){}
40024
40025/**
40026 * Convert a pathname and a project identifier to a System V IPC key
40027 *
40028 * The function converts the {@link pathname} of an existing accessible
40029 * file and a project identifier into an integer for use with for example
40030 * {@link shmop_open} and other System V IPC keys.
40031 *
40032 * @param string $pathname Path to an accessible file.
40033 * @param string $proj Project identifier. This must be a one character
40034 *   string.
40035 * @return int On success the return value will be the created key
40036 *   value, otherwise -1 is returned.
40037 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
40038 **/
40039function ftok($pathname, $proj){}
40040
40041/**
40042 * Allocates space for a file to be uploaded
40043 *
40044 * Sends an ALLO command to the remote FTP server to allocate space for a
40045 * file to be uploaded.
40046 *
40047 * @param resource $ftp_stream The link identifier of the FTP
40048 *   connection.
40049 * @param int $filesize The number of bytes to allocate.
40050 * @param string $result A textual representation of the servers
40051 *   response will be returned by reference in {@link result} if a
40052 *   variable is provided.
40053 * @return bool
40054 * @since PHP 5, PHP 7
40055 **/
40056function ftp_alloc($ftp_stream, $filesize, &$result){}
40057
40058/**
40059 * Append the contents of a file to another file on the FTP server
40060 *
40061 * @param resource $ftp
40062 * @param string $remote_file
40063 * @param string $local_file
40064 * @param int $mode
40065 * @return bool
40066 * @since PHP 7 >= 7.2.0
40067 **/
40068function ftp_append($ftp, $remote_file, $local_file, $mode){}
40069
40070/**
40071 * Changes to the parent directory
40072 *
40073 * @param resource $ftp_stream The link identifier of the FTP
40074 *   connection.
40075 * @return bool
40076 * @since PHP 4, PHP 5, PHP 7
40077 **/
40078function ftp_cdup($ftp_stream){}
40079
40080/**
40081 * Changes the current directory on a FTP server
40082 *
40083 * Changes the current directory to the specified one.
40084 *
40085 * @param resource $ftp_stream The link identifier of the FTP
40086 *   connection.
40087 * @param string $directory The target directory.
40088 * @return bool If changing directory fails, PHP will also throw a
40089 *   warning.
40090 * @since PHP 4, PHP 5, PHP 7
40091 **/
40092function ftp_chdir($ftp_stream, $directory){}
40093
40094/**
40095 * Set permissions on a file via FTP
40096 *
40097 * Sets the permissions on the specified remote file to {@link mode}.
40098 *
40099 * @param resource $ftp_stream The link identifier of the FTP
40100 *   connection.
40101 * @param int $mode The new permissions, given as an octal value.
40102 * @param string $filename The remote file.
40103 * @return int Returns the new file permissions on success or FALSE on
40104 *   error.
40105 * @since PHP 5, PHP 7
40106 **/
40107function ftp_chmod($ftp_stream, $mode, $filename){}
40108
40109/**
40110 * Closes an FTP connection
40111 *
40112 * {@link ftp_close} closes the given link identifier and releases the
40113 * resource.
40114 *
40115 * @param resource $ftp_stream The link identifier of the FTP
40116 *   connection.
40117 * @return bool
40118 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
40119 **/
40120function ftp_close($ftp_stream){}
40121
40122/**
40123 * Opens an FTP connection
40124 *
40125 * {@link ftp_connect} opens an FTP connection to the specified {@link
40126 * host}.
40127 *
40128 * @param string $host The FTP server address. This parameter shouldn't
40129 *   have any trailing slashes and shouldn't be prefixed with ftp://.
40130 * @param int $port This parameter specifies an alternate port to
40131 *   connect to. If it is omitted or set to zero, then the default FTP
40132 *   port, 21, will be used.
40133 * @param int $timeout This parameter specifies the timeout in seconds
40134 *   for all subsequent network operations. If omitted, the default value
40135 *   is 90 seconds. The timeout can be changed and queried at any time
40136 *   with {@link ftp_set_option} and {@link ftp_get_option}.
40137 * @return resource Returns a FTP stream on success or FALSE on error.
40138 * @since PHP 4, PHP 5, PHP 7
40139 **/
40140function ftp_connect($host, $port, $timeout){}
40141
40142/**
40143 * Deletes a file on the FTP server
40144 *
40145 * {@link ftp_delete} deletes the file specified by {@link path} from the
40146 * FTP server.
40147 *
40148 * @param resource $ftp_stream The link identifier of the FTP
40149 *   connection.
40150 * @param string $path The file to delete.
40151 * @return bool
40152 * @since PHP 4, PHP 5, PHP 7
40153 **/
40154function ftp_delete($ftp_stream, $path){}
40155
40156/**
40157 * Requests execution of a command on the FTP server
40158 *
40159 * Sends a SITE EXEC {@link command} request to the FTP server.
40160 *
40161 * @param resource $ftp_stream The link identifier of the FTP
40162 *   connection.
40163 * @param string $command The command to execute.
40164 * @return bool Returns TRUE if the command was successful (server sent
40165 *   response code: 200); otherwise returns FALSE.
40166 * @since PHP 4 >= 4.0.3, PHP 5, PHP 7
40167 **/
40168function ftp_exec($ftp_stream, $command){}
40169
40170/**
40171 * Downloads a file from the FTP server and saves to an open file
40172 *
40173 * {@link ftp_fget} retrieves {@link remote_file} from the FTP server,
40174 * and writes it to the given file pointer.
40175 *
40176 * @param resource $ftp_stream The link identifier of the FTP
40177 *   connection.
40178 * @param resource $handle An open file pointer in which we store the
40179 *   data.
40180 * @param string $remote_file The remote file path.
40181 * @param int $mode The transfer mode. Must be either FTP_ASCII or
40182 *   FTP_BINARY.
40183 * @param int $resumepos The position in the remote file to start
40184 *   downloading from.
40185 * @return bool
40186 * @since PHP 4, PHP 5, PHP 7
40187 **/
40188function ftp_fget($ftp_stream, $handle, $remote_file, $mode, $resumepos){}
40189
40190/**
40191 * Uploads from an open file to the FTP server
40192 *
40193 * {@link ftp_fput} uploads the data from a file pointer to a remote file
40194 * on the FTP server.
40195 *
40196 * @param resource $ftp_stream The link identifier of the FTP
40197 *   connection.
40198 * @param string $remote_file The remote file path.
40199 * @param resource $handle An open file pointer on the local file.
40200 *   Reading stops at end of file.
40201 * @param int $mode The transfer mode. Must be either FTP_ASCII or
40202 *   FTP_BINARY.
40203 * @param int $startpos The position in the remote file to start
40204 *   uploading to.
40205 * @return bool
40206 * @since PHP 4, PHP 5, PHP 7
40207 **/
40208function ftp_fput($ftp_stream, $remote_file, $handle, $mode, $startpos){}
40209
40210/**
40211 * Downloads a file from the FTP server
40212 *
40213 * {@link ftp_get} retrieves a remote file from the FTP server, and saves
40214 * it into a local file.
40215 *
40216 * @param resource $ftp_stream The link identifier of the FTP
40217 *   connection.
40218 * @param string $local_file The local file path (will be overwritten
40219 *   if the file already exists).
40220 * @param string $remote_file The remote file path.
40221 * @param int $mode The transfer mode. Must be either FTP_ASCII or
40222 *   FTP_BINARY.
40223 * @param int $resumepos The position in the remote file to start
40224 *   downloading from.
40225 * @return bool
40226 * @since PHP 4, PHP 5, PHP 7
40227 **/
40228function ftp_get($ftp_stream, $local_file, $remote_file, $mode, $resumepos){}
40229
40230/**
40231 * Retrieves various runtime behaviours of the current FTP stream
40232 *
40233 * This function returns the value for the requested {@link option} from
40234 * the specified FTP connection.
40235 *
40236 * @param resource $ftp_stream The link identifier of the FTP
40237 *   connection.
40238 * @param int $option Currently, the following options are supported:
40239 *   Supported runtime FTP options FTP_TIMEOUT_SEC Returns the current
40240 *   timeout used for network related operations. FTP_AUTOSEEK Returns
40241 *   TRUE if this option is on, FALSE otherwise.
40242 * @return mixed Returns the value on success or FALSE if the given
40243 *   {@link option} is not supported. In the latter case, a warning
40244 *   message is also thrown.
40245 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
40246 **/
40247function ftp_get_option($ftp_stream, $option){}
40248
40249/**
40250 * Logs in to an FTP connection
40251 *
40252 * Logs in to the given FTP stream.
40253 *
40254 * @param resource $ftp_stream The link identifier of the FTP
40255 *   connection.
40256 * @param string $username The username (USER).
40257 * @param string $password The password (PASS).
40258 * @return bool If login fails, PHP will also throw a warning.
40259 * @since PHP 4, PHP 5, PHP 7
40260 **/
40261function ftp_login($ftp_stream, $username, $password){}
40262
40263/**
40264 * Returns the last modified time of the given file
40265 *
40266 * {@link ftp_mdtm} gets the last modified time for a remote file.
40267 *
40268 * @param resource $ftp_stream The link identifier of the FTP
40269 *   connection.
40270 * @param string $remote_file The file from which to extract the last
40271 *   modification time.
40272 * @return int Returns the last modified time as a Unix timestamp on
40273 *   success, or -1 on error.
40274 * @since PHP 4, PHP 5, PHP 7
40275 **/
40276function ftp_mdtm($ftp_stream, $remote_file){}
40277
40278/**
40279 * Creates a directory
40280 *
40281 * Creates the specified {@link directory} on the FTP server.
40282 *
40283 * @param resource $ftp_stream The link identifier of the FTP
40284 *   connection.
40285 * @param string $directory The name of the directory that will be
40286 *   created.
40287 * @return string Returns the newly created directory name on success
40288 *   or FALSE on error.
40289 * @since PHP 4, PHP 5, PHP 7
40290 **/
40291function ftp_mkdir($ftp_stream, $directory){}
40292
40293/**
40294 * Returns a list of files in the given directory
40295 *
40296 * @param resource $ftp_stream The link identifier of the FTP
40297 *   connection.
40298 * @param string $directory The directory to be listed.
40299 * @return array Returns an array of arrays with file infos from the
40300 *   specified directory on success or FALSE on error.
40301 * @since PHP 7 >= 7.2.0
40302 **/
40303function ftp_mlsd($ftp_stream, $directory){}
40304
40305/**
40306 * Continues retrieving/sending a file (non-blocking)
40307 *
40308 * Continues retrieving/sending a file non-blocking.
40309 *
40310 * @param resource $ftp_stream The link identifier of the FTP
40311 *   connection.
40312 * @return int Returns FTP_FAILED or FTP_FINISHED or FTP_MOREDATA.
40313 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
40314 **/
40315function ftp_nb_continue($ftp_stream){}
40316
40317/**
40318 * Retrieves a file from the FTP server and writes it to an open file
40319 * (non-blocking)
40320 *
40321 * {@link ftp_nb_fget} retrieves a remote file from the FTP server.
40322 *
40323 * The difference between this function and {@link ftp_fget} is that this
40324 * function retrieves the file asynchronously, so your program can
40325 * perform other operations while the file is being downloaded.
40326 *
40327 * @param resource $ftp_stream The link identifier of the FTP
40328 *   connection.
40329 * @param resource $handle An open file pointer in which we store the
40330 *   data.
40331 * @param string $remote_file The remote file path.
40332 * @param int $mode The transfer mode. Must be either FTP_ASCII or
40333 *   FTP_BINARY.
40334 * @param int $resumepos The position in the remote file to start
40335 *   downloading from.
40336 * @return int Returns FTP_FAILED or FTP_FINISHED or FTP_MOREDATA.
40337 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
40338 **/
40339function ftp_nb_fget($ftp_stream, $handle, $remote_file, $mode, $resumepos){}
40340
40341/**
40342 * Stores a file from an open file to the FTP server (non-blocking)
40343 *
40344 * {@link ftp_nb_fput} uploads the data from a file pointer to a remote
40345 * file on the FTP server.
40346 *
40347 * The difference between this function and the {@link ftp_fput} is that
40348 * this function uploads the file asynchronously, so your program can
40349 * perform other operations while the file is being uploaded.
40350 *
40351 * @param resource $ftp_stream The link identifier of the FTP
40352 *   connection.
40353 * @param string $remote_file The remote file path.
40354 * @param resource $handle An open file pointer on the local file.
40355 *   Reading stops at end of file.
40356 * @param int $mode The transfer mode. Must be either FTP_ASCII or
40357 *   FTP_BINARY.
40358 * @param int $startpos The position in the remote file to start
40359 *   uploading to.
40360 * @return int Returns FTP_FAILED or FTP_FINISHED or FTP_MOREDATA.
40361 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
40362 **/
40363function ftp_nb_fput($ftp_stream, $remote_file, $handle, $mode, $startpos){}
40364
40365/**
40366 * Retrieves a file from the FTP server and writes it to a local file
40367 * (non-blocking)
40368 *
40369 * {@link ftp_nb_get} retrieves a remote file from the FTP server, and
40370 * saves it into a local file.
40371 *
40372 * The difference between this function and {@link ftp_get} is that this
40373 * function retrieves the file asynchronously, so your program can
40374 * perform other operations while the file is being downloaded.
40375 *
40376 * @param resource $ftp_stream The link identifier of the FTP
40377 *   connection.
40378 * @param string $local_file The local file path (will be overwritten
40379 *   if the file already exists).
40380 * @param string $remote_file The remote file path.
40381 * @param int $mode The transfer mode. Must be either FTP_ASCII or
40382 *   FTP_BINARY.
40383 * @param int $resumepos The position in the remote file to start
40384 *   downloading from.
40385 * @return int Returns FTP_FAILED or FTP_FINISHED or FTP_MOREDATA.
40386 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
40387 **/
40388function ftp_nb_get($ftp_stream, $local_file, $remote_file, $mode, $resumepos){}
40389
40390/**
40391 * Stores a file on the FTP server (non-blocking)
40392 *
40393 * {@link ftp_nb_put} stores a local file on the FTP server.
40394 *
40395 * The difference between this function and the {@link ftp_put} is that
40396 * this function uploads the file asynchronously, so your program can
40397 * perform other operations while the file is being uploaded.
40398 *
40399 * @param resource $ftp_stream The link identifier of the FTP
40400 *   connection.
40401 * @param string $remote_file The remote file path.
40402 * @param string $local_file The local file path.
40403 * @param int $mode The transfer mode. Must be either FTP_ASCII or
40404 *   FTP_BINARY.
40405 * @param int $startpos The position in the remote file to start
40406 *   uploading to.
40407 * @return int Returns FTP_FAILED or FTP_FINISHED or FTP_MOREDATA.
40408 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
40409 **/
40410function ftp_nb_put($ftp_stream, $remote_file, $local_file, $mode, $startpos){}
40411
40412/**
40413 * Returns a list of files in the given directory
40414 *
40415 * @param resource $ftp_stream The link identifier of the FTP
40416 *   connection.
40417 * @param string $directory The directory to be listed. This parameter
40418 *   can also include arguments, eg. ftp_nlist($conn_id, "-la
40419 *   /your/dir"); Note that this parameter isn't escaped so there may be
40420 *   some issues with filenames containing spaces and other characters.
40421 * @return array Returns an array of filenames from the specified
40422 *   directory on success or FALSE on error.
40423 * @since PHP 4, PHP 5, PHP 7
40424 **/
40425function ftp_nlist($ftp_stream, $directory){}
40426
40427/**
40428 * Turns passive mode on or off
40429 *
40430 * {@link ftp_pasv} turns on or off passive mode. In passive mode, data
40431 * connections are initiated by the client, rather than by the server. It
40432 * may be needed if the client is behind firewall.
40433 *
40434 * Please note that {@link ftp_pasv} can only be called after a
40435 * successful login or otherwise it will fail.
40436 *
40437 * @param resource $ftp_stream The link identifier of the FTP
40438 *   connection.
40439 * @param bool $pasv If TRUE, the passive mode is turned on, else it's
40440 *   turned off.
40441 * @return bool
40442 * @since PHP 4, PHP 5, PHP 7
40443 **/
40444function ftp_pasv($ftp_stream, $pasv){}
40445
40446/**
40447 * Uploads a file to the FTP server
40448 *
40449 * {@link ftp_put} stores a local file on the FTP server.
40450 *
40451 * @param resource $ftp_stream The link identifier of the FTP
40452 *   connection.
40453 * @param string $remote_file The remote file path.
40454 * @param string $local_file The local file path.
40455 * @param int $mode The transfer mode. Must be either FTP_ASCII or
40456 *   FTP_BINARY.
40457 * @param int $startpos The position in the remote file to start
40458 *   uploading to.
40459 * @return bool
40460 * @since PHP 4, PHP 5, PHP 7
40461 **/
40462function ftp_put($ftp_stream, $remote_file, $local_file, $mode, $startpos){}
40463
40464/**
40465 * Returns the current directory name
40466 *
40467 * @param resource $ftp_stream The link identifier of the FTP
40468 *   connection.
40469 * @return string Returns the current directory name or FALSE on error.
40470 * @since PHP 4, PHP 5, PHP 7
40471 **/
40472function ftp_pwd($ftp_stream){}
40473
40474/**
40475 * Closes an FTP connection
40476 *
40477 * {@link ftp_quit} closes the given link identifier and releases the
40478 * resource.
40479 *
40480 * @param resource $ftp_stream The link identifier of the FTP
40481 *   connection.
40482 * @return bool
40483 * @since PHP 4, PHP 5, PHP 7
40484 **/
40485function ftp_quit($ftp_stream){}
40486
40487/**
40488 * Sends an arbitrary command to an FTP server
40489 *
40490 * Sends an arbitrary {@link command} to the FTP server.
40491 *
40492 * @param resource $ftp_stream The link identifier of the FTP
40493 *   connection.
40494 * @param string $command The command to execute.
40495 * @return array Returns the server's response as an array of strings.
40496 *   No parsing is performed on the response string, nor does {@link
40497 *   ftp_raw} determine if the command succeeded.
40498 * @since PHP 5, PHP 7
40499 **/
40500function ftp_raw($ftp_stream, $command){}
40501
40502/**
40503 * Returns a detailed list of files in the given directory
40504 *
40505 * {@link ftp_rawlist} executes the FTP LIST command, and returns the
40506 * result as an array.
40507 *
40508 * @param resource $ftp_stream The link identifier of the FTP
40509 *   connection.
40510 * @param string $directory The directory path. May include arguments
40511 *   for the LIST command.
40512 * @param bool $recursive If set to TRUE, the issued command will be
40513 *   LIST -R.
40514 * @return array Returns an array where each element corresponds to one
40515 *   line of text. Returns FALSE when passed {@link directory} is
40516 *   invalid.
40517 * @since PHP 4, PHP 5, PHP 7
40518 **/
40519function ftp_rawlist($ftp_stream, $directory, $recursive){}
40520
40521/**
40522 * Renames a file or a directory on the FTP server
40523 *
40524 * {@link ftp_rename} renames a file or a directory on the FTP server.
40525 *
40526 * @param resource $ftp_stream The link identifier of the FTP
40527 *   connection.
40528 * @param string $oldname The old file/directory name.
40529 * @param string $newname The new name.
40530 * @return bool Upon failure (such as attempting to rename a
40531 *   non-existent file), an E_WARNING error will be emitted.
40532 * @since PHP 4, PHP 5, PHP 7
40533 **/
40534function ftp_rename($ftp_stream, $oldname, $newname){}
40535
40536/**
40537 * Removes a directory
40538 *
40539 * Removes the specified {@link directory} on the FTP server.
40540 *
40541 * @param resource $ftp_stream The link identifier of the FTP
40542 *   connection.
40543 * @param string $directory The directory to delete. This must be
40544 *   either an absolute or relative path to an empty directory.
40545 * @return bool
40546 * @since PHP 4, PHP 5, PHP 7
40547 **/
40548function ftp_rmdir($ftp_stream, $directory){}
40549
40550/**
40551 * Set miscellaneous runtime FTP options
40552 *
40553 * This function controls various runtime options for the specified FTP
40554 * stream.
40555 *
40556 * @param resource $ftp_stream The link identifier of the FTP
40557 *   connection.
40558 * @param int $option Currently, the following options are supported:
40559 *   Supported runtime FTP options FTP_TIMEOUT_SEC Changes the timeout in
40560 *   seconds used for all network related functions. {@link value} must
40561 *   be an integer that is greater than 0. The default timeout is 90
40562 *   seconds. FTP_AUTOSEEK When enabled, GET or PUT requests with a
40563 *   {@link resumepos} or {@link startpos} parameter will first seek to
40564 *   the requested position within the file. This is enabled by default.
40565 *   FTP_USEPASVADDRESS When disabled, PHP will ignore the IP address
40566 *   returned by the FTP server in response to the PASV command and
40567 *   instead use the IP address that was supplied in the ftp_connect().
40568 *   {@link value} must be a boolean.
40569 * @param mixed $value This parameter depends on which {@link option}
40570 *   is chosen to be altered.
40571 * @return bool Returns TRUE if the option could be set; FALSE if not.
40572 *   A warning message will be thrown if the {@link option} is not
40573 *   supported or the passed {@link value} doesn't match the expected
40574 *   value for the given {@link option}.
40575 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
40576 **/
40577function ftp_set_option($ftp_stream, $option, $value){}
40578
40579/**
40580 * Sends a SITE command to the server
40581 *
40582 * {@link ftp_site} sends the given SITE command to the FTP server.
40583 *
40584 * SITE commands are not standardized, and vary from server to server.
40585 * They are useful for handling such things as file permissions and group
40586 * membership.
40587 *
40588 * @param resource $ftp_stream The link identifier of the FTP
40589 *   connection.
40590 * @param string $command The SITE command. Note that this parameter
40591 *   isn't escaped so there may be some issues with filenames containing
40592 *   spaces and other characters.
40593 * @return bool
40594 * @since PHP 4, PHP 5, PHP 7
40595 **/
40596function ftp_site($ftp_stream, $command){}
40597
40598/**
40599 * Returns the size of the given file
40600 *
40601 * {@link ftp_size} returns the size of the given file in bytes.
40602 *
40603 * @param resource $ftp_stream The link identifier of the FTP
40604 *   connection.
40605 * @param string $remote_file The remote file.
40606 * @return int Returns the file size on success, or -1 on error.
40607 * @since PHP 4, PHP 5, PHP 7
40608 **/
40609function ftp_size($ftp_stream, $remote_file){}
40610
40611/**
40612 * Opens a Secure SSL-FTP connection
40613 *
40614 * {@link ftp_ssl_connect} opens an explicit SSL-FTP connection to the
40615 * specified {@link host}. That implies that {@link ftp_ssl_connect} will
40616 * succeed even if the server is not configured for SSL-FTP, or its
40617 * certificate is invalid. Only when {@link ftp_login} is called, the
40618 * client will send the appropriate AUTH FTP command, so {@link
40619 * ftp_login} will fail in the mentioned cases.
40620 *
40621 * @param string $host The FTP server address. This parameter shouldn't
40622 *   have any trailing slashes and shouldn't be prefixed with ftp://.
40623 * @param int $port This parameter specifies an alternate port to
40624 *   connect to. If it is omitted or set to zero, then the default FTP
40625 *   port, 21, will be used.
40626 * @param int $timeout This parameter specifies the timeout for all
40627 *   subsequent network operations. If omitted, the default value is 90
40628 *   seconds. The timeout can be changed and queried at any time with
40629 *   {@link ftp_set_option} and {@link ftp_get_option}.
40630 * @return resource Returns a SSL-FTP stream on success or FALSE on
40631 *   error.
40632 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
40633 **/
40634function ftp_ssl_connect($host, $port, $timeout){}
40635
40636/**
40637 * Returns the system type identifier of the remote FTP server
40638 *
40639 * @param resource $ftp_stream The link identifier of the FTP
40640 *   connection.
40641 * @return string Returns the remote system type, or FALSE on error.
40642 * @since PHP 4, PHP 5, PHP 7
40643 **/
40644function ftp_systype($ftp_stream){}
40645
40646/**
40647 * Truncates a file to a given length
40648 *
40649 * Takes the filepointer, {@link handle}, and truncates the file to
40650 * length, {@link size}.
40651 *
40652 * @param resource $handle The file pointer.
40653 * @param int $size The size to truncate to.
40654 * @return bool
40655 * @since PHP 4, PHP 5, PHP 7
40656 **/
40657function ftruncate($handle, $size){}
40658
40659/**
40660 * Return TRUE if the given function has been defined
40661 *
40662 * Checks the list of defined functions, both built-in (internal) and
40663 * user-defined, for {@link function_name}.
40664 *
40665 * @param string $function_name The function name, as a string.
40666 * @return bool Returns TRUE if {@link function_name} exists and is a
40667 *   function, FALSE otherwise.
40668 * @since PHP 4, PHP 5, PHP 7
40669 **/
40670function function_exists($function_name){}
40671
40672/**
40673 * Return an item from the argument list
40674 *
40675 * Gets the specified argument from a user-defined function's argument
40676 * list.
40677 *
40678 * This function may be used in conjunction with {@link func_get_args}
40679 * and {@link func_num_args} to allow user-defined functions to accept
40680 * variable-length argument lists.
40681 *
40682 * @param int $arg_num The argument offset. Function arguments are
40683 *   counted starting from zero.
40684 * @return mixed Returns the specified argument, or FALSE on error.
40685 * @since PHP 4, PHP 5, PHP 7
40686 **/
40687function func_get_arg($arg_num){}
40688
40689/**
40690 * Returns an array comprising a function's argument list
40691 *
40692 * Gets an array of the function's argument list.
40693 *
40694 * This function may be used in conjunction with {@link func_get_arg} and
40695 * {@link func_num_args} to allow user-defined functions to accept
40696 * variable-length argument lists.
40697 *
40698 * @return array Returns an array in which each element is a copy of
40699 *   the corresponding member of the current user-defined function's
40700 *   argument list.
40701 * @since PHP 4, PHP 5, PHP 7
40702 **/
40703function func_get_args(){}
40704
40705/**
40706 * Returns the number of arguments passed to the function
40707 *
40708 * Gets the number of arguments passed to the function.
40709 *
40710 * This function may be used in conjunction with {@link func_get_arg} and
40711 * {@link func_get_args} to allow user-defined functions to accept
40712 * variable-length argument lists.
40713 *
40714 * @return int Returns the number of arguments passed into the current
40715 *   user-defined function.
40716 * @since PHP 4, PHP 5, PHP 7
40717 **/
40718function func_num_args(){}
40719
40720/**
40721 * Binary-safe file write
40722 *
40723 * @param resource $handle
40724 * @param string $string The string that is to be written.
40725 * @param int $length If the {@link length} argument is given, writing
40726 *   will stop after {@link length} bytes have been written or the end of
40727 *   {@link string} is reached, whichever comes first. Note that if the
40728 *   {@link length} argument is given, then the magic_quotes_runtime
40729 *   configuration option will be ignored and no slashes will be stripped
40730 *   from {@link string}.
40731 * @return int
40732 * @since PHP 4, PHP 5, PHP 7
40733 **/
40734function fwrite($handle, $string, $length){}
40735
40736/**
40737 * Forces collection of any existing garbage cycles
40738 *
40739 * @return int Returns number of collected cycles.
40740 * @since PHP 5 >= 5.3.0, PHP 7
40741 **/
40742function gc_collect_cycles(){}
40743
40744/**
40745 * Deactivates the circular reference collector
40746 *
40747 * Deactivates the circular reference collector, setting zend.enable_gc
40748 * to 0.
40749 *
40750 * @return void
40751 * @since PHP 5 >= 5.3.0, PHP 7
40752 **/
40753function gc_disable(){}
40754
40755/**
40756 * Activates the circular reference collector
40757 *
40758 * Activates the circular reference collector, setting zend.enable_gc to
40759 * 1.
40760 *
40761 * @return void
40762 * @since PHP 5 >= 5.3.0, PHP 7
40763 **/
40764function gc_enable(){}
40765
40766/**
40767 * Returns status of the circular reference collector
40768 *
40769 * @return bool Returns TRUE if the garbage collector is enabled, FALSE
40770 *   otherwise.
40771 * @since PHP 5 >= 5.3.0, PHP 7
40772 **/
40773function gc_enabled(){}
40774
40775/**
40776 * Reclaims memory used by the Zend Engine memory manager
40777 *
40778 * Reclaims memory used by the Zend Engine memory manager.
40779 *
40780 * @return int Returns the number of bytes freed.
40781 * @since PHP 7
40782 **/
40783function gc_mem_caches(){}
40784
40785/**
40786 * Gets information about the garbage collector
40787 *
40788 * Gets information about the current state of the garbage collector.
40789 *
40790 * @return array Returns an associative array with the following
40791 *   elements: "runs" "collected" "threshold" "roots"
40792 * @since PHP 7 >= 7.3.0
40793 **/
40794function gc_status(){}
40795
40796/**
40797 * Retrieve information about the currently installed GD library
40798 *
40799 * Gets information about the version and capabilities of the installed
40800 * GD library.
40801 *
40802 * @return array Returns an associative array.
40803 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
40804 **/
40805function gd_info(){}
40806
40807/**
40808 * Get the Autonomous System Numbers (ASN)
40809 *
40810 * The {@link geoip_asnum_by_name} function will return the Autonomous
40811 * System Numbers (ASN) associated with an IP address.
40812 *
40813 * @param string $hostname The hostname or IP address.
40814 * @return string Returns the ASN on success, or FALSE if the address
40815 *   cannot be found in the database.
40816 * @since PECL geoip >= 1.1.0
40817 **/
40818function geoip_asnum_by_name($hostname){}
40819
40820/**
40821 * Get the two letter continent code
40822 *
40823 * The {@link geoip_continent_code_by_name} function will return the two
40824 * letter continent code corresponding to a hostname or an IP address.
40825 *
40826 * @param string $hostname The hostname or IP address whose location is
40827 *   to be looked-up.
40828 * @return string Returns the two letter continent code on success, or
40829 *   FALSE if the address cannot be found in the database.
40830 * @since PECL geoip >= 1.0.3
40831 **/
40832function geoip_continent_code_by_name($hostname){}
40833
40834/**
40835 * Get the three letter country code
40836 *
40837 * The {@link geoip_country_code3_by_name} function will return the three
40838 * letter country code corresponding to a hostname or an IP address.
40839 *
40840 * @param string $hostname The hostname or IP address whose location is
40841 *   to be looked-up.
40842 * @return string Returns the three letter country code on success, or
40843 *   FALSE if the address cannot be found in the database.
40844 * @since PECL geoip >= 0.2.0
40845 **/
40846function geoip_country_code3_by_name($hostname){}
40847
40848/**
40849 * Get the two letter country code
40850 *
40851 * The {@link geoip_country_code_by_name} function will return the two
40852 * letter country code corresponding to a hostname or an IP address.
40853 *
40854 * @param string $hostname The hostname or IP address whose location is
40855 *   to be looked-up.
40856 * @return string Returns the two letter ISO country code on success,
40857 *   or FALSE if the address cannot be found in the database.
40858 * @since PECL geoip >= 0.2.0
40859 **/
40860function geoip_country_code_by_name($hostname){}
40861
40862/**
40863 * Get the full country name
40864 *
40865 * The {@link geoip_country_name_by_name} function will return the full
40866 * country name corresponding to a hostname or an IP address.
40867 *
40868 * @param string $hostname The hostname or IP address whose location is
40869 *   to be looked-up.
40870 * @return string Returns the country name on success, or FALSE if the
40871 *   address cannot be found in the database.
40872 * @since PECL geoip >= 0.2.0
40873 **/
40874function geoip_country_name_by_name($hostname){}
40875
40876/**
40877 * Get GeoIP Database information
40878 *
40879 * The {@link geoip_database_info} function returns the corresponding
40880 * GeoIP Database version as it is defined inside the binary file.
40881 *
40882 * If this function is called without arguments, it returns the version
40883 * of the GeoIP Free Country Edition.
40884 *
40885 * @param int $database The database type as an integer. You can use
40886 *   the various constants defined with this extension (ie:
40887 *   GEOIP_*_EDITION).
40888 * @return string Returns the corresponding database version, or NULL
40889 *   on error.
40890 * @since PECL geoip >= 0.2.0
40891 **/
40892function geoip_database_info($database){}
40893
40894/**
40895 * Determine if GeoIP Database is available
40896 *
40897 * The {@link geoip_db_avail} function returns if the corresponding GeoIP
40898 * Database is available and can be opened on disk.
40899 *
40900 * It does not indicate if the file is a proper database, only if it is
40901 * readable.
40902 *
40903 * @param int $database The database type as an integer. You can use
40904 *   the various constants defined with this extension (ie:
40905 *   GEOIP_*_EDITION).
40906 * @return bool Returns TRUE is database exists, FALSE if not found, or
40907 *   NULL on error.
40908 * @since PECL geoip >= 1.0.1
40909 **/
40910function geoip_db_avail($database){}
40911
40912/**
40913 * Returns the filename of the corresponding GeoIP Database
40914 *
40915 * The {@link geoip_db_filename} function returns the filename of the
40916 * corresponding GeoIP Database.
40917 *
40918 * It does not indicate if the file exists or not on disk, only where the
40919 * library is looking for the database.
40920 *
40921 * @param int $database The database type as an integer. You can use
40922 *   the various constants defined with this extension (ie:
40923 *   GEOIP_*_EDITION).
40924 * @return string Returns the filename of the corresponding database,
40925 *   or NULL on error.
40926 * @since PECL geoip >= 1.0.1
40927 **/
40928function geoip_db_filename($database){}
40929
40930/**
40931 * Returns detailed information about all GeoIP database types
40932 *
40933 * The {@link geoip_db_get_all_info} function will return detailed
40934 * information as a multi-dimensional array about all the GeoIP database
40935 * types.
40936 *
40937 * This function is available even if no databases are installed. It will
40938 * simply list them as non-available.
40939 *
40940 * The names of the different keys of the returning associative array are
40941 * as follows:
40942 *
40943 * "available" -- Boolean, indicate if DB is available (see {@link
40944 * geoip_db_avail}) "description" -- The database description "filename"
40945 * -- The database filename on disk (see {@link geoip_db_filename})
40946 *
40947 * @return array Returns the associative array.
40948 * @since PECL geoip >= 1.0.1
40949 **/
40950function geoip_db_get_all_info(){}
40951
40952/**
40953 * Get the second level domain name
40954 *
40955 * The {@link geoip_domain_by_name} function will return the second level
40956 * domain names associated with a hostname or an IP address.
40957 *
40958 * This function is currently only available to users who have bought a
40959 * commercial GeoIP Domain Edition. A warning will be issued if the
40960 * proper database cannot be located.
40961 *
40962 * @param string $hostname The hostname or IP address.
40963 * @return string Returns the domain name on success, or FALSE if the
40964 *   address cannot be found in the database.
40965 * @since PECL geoip >= 1.1.0
40966 **/
40967function geoip_domain_by_name($hostname){}
40968
40969/**
40970 * Get the Internet connection type
40971 *
40972 * The {@link geoip_id_by_name} function will return the Internet
40973 * connection type corresponding to a hostname or an IP address.
40974 *
40975 * The return value is numeric and can be compared to the following
40976 * constants:
40977 *
40978 * GEOIP_UNKNOWN_SPEED GEOIP_DIALUP_SPEED GEOIP_CABLEDSL_SPEED
40979 * GEOIP_CORPORATE_SPEED
40980 *
40981 * @param string $hostname The hostname or IP address whose connection
40982 *   type is to be looked-up.
40983 * @return int Returns the connection type.
40984 * @since PECL geoip >= 0.2.0
40985 **/
40986function geoip_id_by_name($hostname){}
40987
40988/**
40989 * Get the Internet Service Provider (ISP) name
40990 *
40991 * The {@link geoip_isp_by_name} function will return the name of the
40992 * Internet Service Provider (ISP) that an IP is assigned to.
40993 *
40994 * This function is currently only available to users who have bought a
40995 * commercial GeoIP ISP Edition. A warning will be issued if the proper
40996 * database cannot be located.
40997 *
40998 * @param string $hostname The hostname or IP address.
40999 * @return string Returns the ISP name on success, or FALSE if the
41000 *   address cannot be found in the database.
41001 * @since PECL geoip >= 1.0.2
41002 **/
41003function geoip_isp_by_name($hostname){}
41004
41005/**
41006 * Get the Internet connection speed
41007 *
41008 * The {@link geoip_netspeedcell_by_name} function will return the
41009 * Internet connection type and speed corresponding to a hostname or an
41010 * IP address.
41011 *
41012 * This function is only available if using GeoIP Library version 1.4.8
41013 * or newer.
41014 *
41015 * This function is currently only available to users who have bought a
41016 * commercial GeoIP NetSpeedCell Edition. A warning will be issued if the
41017 * proper database cannot be located.
41018 *
41019 * The return value is a string, common values are:
41020 *
41021 * Cable/DSL Dialup Cellular Corporate
41022 *
41023 * @param string $hostname The hostname or IP address.
41024 * @return string Returns the connection speed on success, or FALSE if
41025 *   the address cannot be found in the database.
41026 * @since PECL geoip >= 1.1.0
41027 **/
41028function geoip_netspeedcell_by_name($hostname){}
41029
41030/**
41031 * Get the organization name
41032 *
41033 * The {@link geoip_org_by_name} function will return the name of the
41034 * organization that an IP is assigned to.
41035 *
41036 * This function is currently only available to users who have bought a
41037 * commercial GeoIP Organization, ISP or AS Edition. A warning will be
41038 * issued if the proper database cannot be located.
41039 *
41040 * @param string $hostname The hostname or IP address.
41041 * @return string Returns the organization name on success, or FALSE if
41042 *   the address cannot be found in the database.
41043 * @since PECL geoip >= 0.2.0
41044 **/
41045function geoip_org_by_name($hostname){}
41046
41047/**
41048 * Returns the detailed City information found in the GeoIP Database
41049 *
41050 * The {@link geoip_record_by_name} function will return the record
41051 * information corresponding to a hostname or an IP address.
41052 *
41053 * This function is available for both GeoLite City Edition and
41054 * commercial GeoIP City Edition. A warning will be issued if the proper
41055 * database cannot be located.
41056 *
41057 * The names of the different keys of the returning associative array are
41058 * as follows:
41059 *
41060 * "continent_code" -- Two letter continent code (as of version 1.0.4
41061 * with libgeoip 1.4.3 or newer) "country_code" -- Two letter country
41062 * code (see {@link geoip_country_code_by_name}) "country_code3" -- Three
41063 * letter country code (see {@link geoip_country_code3_by_name})
41064 * "country_name" -- The country name (see {@link
41065 * geoip_country_name_by_name}) "region" -- The region code (ex: CA for
41066 * California) "city" -- The city. "postal_code" -- The Postal Code, FSA
41067 * or Zip Code. "latitude" -- The Latitude as signed double. "longitude"
41068 * -- The Longitude as signed double. "dma_code" -- Designated Market
41069 * Area code (USA and Canada only) "area_code" -- The PSTN area code (ex:
41070 * 212)
41071 *
41072 * @param string $hostname The hostname or IP address whose record is
41073 *   to be looked-up.
41074 * @return array Returns the associative array on success, or FALSE if
41075 *   the address cannot be found in the database.
41076 * @since PECL geoip >= 0.2.0
41077 **/
41078function geoip_record_by_name($hostname){}
41079
41080/**
41081 * Get the country code and region
41082 *
41083 * The {@link geoip_region_by_name} function will return the country and
41084 * region corresponding to a hostname or an IP address.
41085 *
41086 * This function is currently only available to users who have bought a
41087 * commercial GeoIP Region Edition. A warning will be issued if the
41088 * proper database cannot be located.
41089 *
41090 * The names of the different keys of the returning associative array are
41091 * as follows:
41092 *
41093 * "country_code" -- Two letter country code (see {@link
41094 * geoip_country_code_by_name}) "region" -- The region code (ex: CA for
41095 * California)
41096 *
41097 * @param string $hostname The hostname or IP address whose region is
41098 *   to be looked-up.
41099 * @return array Returns the associative array on success, or FALSE if
41100 *   the address cannot be found in the database.
41101 * @since PECL geoip >= 0.2.0
41102 **/
41103function geoip_region_by_name($hostname){}
41104
41105/**
41106 * Returns the region name for some country and region code combo
41107 *
41108 * The {@link geoip_region_name_by_code} function will return the region
41109 * name corresponding to a country and region code combo.
41110 *
41111 * In the United States, the region code corresponds to the two-letter
41112 * abbreviation of each state. In Canada, the region code corresponds to
41113 * the two-letter province or territory code as attributed by Canada
41114 * Post.
41115 *
41116 * For the rest of the world, GeoIP uses FIPS 10-4 codes to represent
41117 * regions. You can check for a detailed list of FIPS 10-4 codes.
41118 *
41119 * This function is always available if using GeoIP Library version 1.4.1
41120 * or newer. The data is taken directly from the GeoIP Library and not
41121 * from any database.
41122 *
41123 * @param string $country_code The two-letter country code (see {@link
41124 *   geoip_country_code_by_name})
41125 * @param string $region_code The two-letter (or digit) region code
41126 *   (see {@link geoip_region_by_name})
41127 * @return string Returns the region name on success, or FALSE if the
41128 *   country and region code combo cannot be found.
41129 * @since PECL geoip >= 1.0.4
41130 **/
41131function geoip_region_name_by_code($country_code, $region_code){}
41132
41133/**
41134 * Set a custom directory for the GeoIP database
41135 *
41136 * The {@link geoip_setup_custom_directory} function will change the
41137 * default directory of the GeoIP database. This is equivalent to
41138 * changing geoip.custom_directory.
41139 *
41140 * @param string $path The full path of where the GeoIP database is on
41141 *   disk.
41142 * @return void
41143 * @since PECL geoip >= 1.1.0
41144 **/
41145function geoip_setup_custom_directory($path){}
41146
41147/**
41148 * Returns the time zone for some country and region code combo
41149 *
41150 * The {@link geoip_time_zone_by_country_and_region} function will return
41151 * the time zone corresponding to a country and region code combo.
41152 *
41153 * In the United States, the region code corresponds to the two-letter
41154 * abbreviation of each state. In Canada, the region code corresponds to
41155 * the two-letter province or territory code as attributed by Canada
41156 * Post.
41157 *
41158 * For the rest of the world, GeoIP uses FIPS 10-4 codes to represent
41159 * regions. You can check for a detailed list of FIPS 10-4 codes.
41160 *
41161 * This function is always available if using GeoIP Library version 1.4.1
41162 * or newer. The data is taken directly from the GeoIP Library and not
41163 * from any database.
41164 *
41165 * @param string $country_code The two-letter country code (see {@link
41166 *   geoip_country_code_by_name})
41167 * @param string $region_code The two-letter (or digit) region code
41168 *   (see {@link geoip_region_by_name})
41169 * @return string Returns the time zone on success, or FALSE if the
41170 *   country and region code combo cannot be found.
41171 * @since PECL geoip >= 1.0.4
41172 **/
41173function geoip_time_zone_by_country_and_region($country_code, $region_code){}
41174
41175/**
41176 * Fetch all HTTP request headers
41177 *
41178 * Fetches all HTTP headers from the current request.
41179 *
41180 * This function is an alias for {@link apache_request_headers}. Please
41181 * read the {@link apache_request_headers} documentation for more
41182 * information on how this function works.
41183 *
41184 * @return array An associative array of all the HTTP headers in the
41185 *   current request, or FALSE on failure.
41186 * @since PHP 4, PHP 5, PHP 7
41187 **/
41188function getallheaders(){}
41189
41190/**
41191 * Gets the current working directory
41192 *
41193 * @return string Returns the current working directory on success, or
41194 *   FALSE on failure.
41195 * @since PHP 4, PHP 5, PHP 7
41196 **/
41197function getcwd(){}
41198
41199/**
41200 * Get date/time information
41201 *
41202 * Returns an associative array containing the date information of the
41203 * {@link timestamp}, or the current local time if no {@link timestamp}
41204 * is given.
41205 *
41206 * @param int $timestamp
41207 * @return array Returns an associative array of information related to
41208 *   the {@link timestamp}. Elements from the returned associative array
41209 *   are as follows:
41210 * @since PHP 4, PHP 5, PHP 7
41211 **/
41212function getdate($timestamp){}
41213
41214/**
41215 * Gets the value of an environment variable
41216 *
41217 * You can see a list of all the environmental variables by using {@link
41218 * phpinfo}. Many of these variables are listed within RFC 3875,
41219 * specifically section 4.1, "Request Meta-Variables".
41220 *
41221 * @param string $varname The variable name.
41222 * @param bool $local_only Set to true to only return local environment
41223 *   variables (set by the operating system or putenv).
41224 * @return string Returns the value of the environment variable {@link
41225 *   varname}, or FALSE if the environment variable {@link varname} does
41226 *   not exist. If {@link varname} is omitted, all environment variables
41227 *   are returned as associative array.
41228 * @since PHP 4, PHP 5, PHP 7
41229 **/
41230function getenv($varname, $local_only){}
41231
41232/**
41233 * Get the Internet host name corresponding to a given IP address
41234 *
41235 * Returns the host name of the Internet host specified by {@link
41236 * ip_address}.
41237 *
41238 * @param string $ip_address The host IP address.
41239 * @return string Returns the host name on success, the unmodified
41240 *   {@link ip_address} on failure, or FALSE on malformed input.
41241 * @since PHP 4, PHP 5, PHP 7
41242 **/
41243function gethostbyaddr($ip_address){}
41244
41245/**
41246 * Get the IPv4 address corresponding to a given Internet host name
41247 *
41248 * Returns the IPv4 address of the Internet host specified by {@link
41249 * hostname}.
41250 *
41251 * @param string $hostname The host name.
41252 * @return string Returns the IPv4 address or a string containing the
41253 *   unmodified {@link hostname} on failure.
41254 * @since PHP 4, PHP 5, PHP 7
41255 **/
41256function gethostbyname($hostname){}
41257
41258/**
41259 * Get a list of IPv4 addresses corresponding to a given Internet host
41260 * name
41261 *
41262 * Returns a list of IPv4 addresses to which the Internet host specified
41263 * by {@link hostname} resolves.
41264 *
41265 * @param string $hostname The host name.
41266 * @return array Returns an array of IPv4 addresses or FALSE if {@link
41267 *   hostname} could not be resolved.
41268 * @since PHP 4, PHP 5, PHP 7
41269 **/
41270function gethostbynamel($hostname){}
41271
41272/**
41273 * Gets the host name
41274 *
41275 * {@link gethostname} gets the standard host name for the local machine.
41276 *
41277 * @return string Returns a string with the hostname on success,
41278 *   otherwise FALSE is returned.
41279 * @since PHP 5 >= 5.3.0, PHP 7
41280 **/
41281function gethostname(){}
41282
41283/**
41284 * Get the size of an image
41285 *
41286 * The {@link getimagesize} function will determine the size of any
41287 * supported given image file and return the dimensions along with the
41288 * file type and a height/width text string to be used inside a normal
41289 * HTML IMG tag and the correspondent HTTP content type.
41290 *
41291 * {@link getimagesize} can also return some more information in {@link
41292 * imageinfo} parameter.
41293 *
41294 * @param string $filename This parameter specifies the file you wish
41295 *   to retrieve information about. It can reference a local file or
41296 *   (configuration permitting) a remote file using one of the supported
41297 *   streams.
41298 * @param array $imageinfo This optional parameter allows you to
41299 *   extract some extended information from the image file. Currently,
41300 *   this will return the different JPG APP markers as an associative
41301 *   array. Some programs use these APP markers to embed text information
41302 *   in images. A very common one is to embed IPTC information in the
41303 *   APP13 marker. You can use the {@link iptcparse} function to parse
41304 *   the binary APP13 marker into something readable.
41305 * @return array Returns an array with up to 7 elements. Not all image
41306 *   types will include the channels and bits elements.
41307 * @since PHP 4, PHP 5, PHP 7
41308 **/
41309function getimagesize($filename, &$imageinfo){}
41310
41311/**
41312 * Get the size of an image from a string
41313 *
41314 * Identical to {@link getimagesize} except that {@link
41315 * getimagesizefromstring} accepts a string instead of a file name as the
41316 * first parameter.
41317 *
41318 * See the {@link getimagesize} documentation for details on how this
41319 * function works.
41320 *
41321 * @param string $imagedata The image data, as a string.
41322 * @param array $imageinfo See {@link getimagesize}.
41323 * @return array See {@link getimagesize}.
41324 * @since PHP 5 >= 5.4.0, PHP 7
41325 **/
41326function getimagesizefromstring($imagedata, &$imageinfo){}
41327
41328/**
41329 * Gets time of last page modification
41330 *
41331 * Gets the time of the last modification of the main script of
41332 * execution.
41333 *
41334 * If you're interested in getting the last modification time of a
41335 * different file, consider using {@link filemtime}.
41336 *
41337 * @return int Returns the time of the last modification of the current
41338 *   page. The value returned is a Unix timestamp, suitable for feeding
41339 *   to {@link date}. Returns FALSE on error.
41340 * @since PHP 4, PHP 5, PHP 7
41341 **/
41342function getlastmod(){}
41343
41344/**
41345 * Get MX records corresponding to a given Internet host name
41346 *
41347 * Searches DNS for MX records corresponding to {@link hostname}.
41348 *
41349 * @param string $hostname The Internet host name.
41350 * @param array $mxhosts A list of the MX records found is placed into
41351 *   the array {@link mxhosts}.
41352 * @param array $weight If the {@link weight} array is given, it will
41353 *   be filled with the weight information gathered.
41354 * @return bool Returns TRUE if any records are found; returns FALSE if
41355 *   no records were found or if an error occurred.
41356 * @since PHP 4, PHP 5, PHP 7
41357 **/
41358function getmxrr($hostname, &$mxhosts, &$weight){}
41359
41360/**
41361 * Get PHP script owner's GID
41362 *
41363 * @return int Returns the group ID of the current script, or FALSE on
41364 *   error.
41365 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
41366 **/
41367function getmygid(){}
41368
41369/**
41370 * Gets the inode of the current script
41371 *
41372 * @return int Returns the current script's inode as an integer, or
41373 *   FALSE on error.
41374 * @since PHP 4, PHP 5, PHP 7
41375 **/
41376function getmyinode(){}
41377
41378/**
41379 * Gets PHP's process ID
41380 *
41381 * Gets the current PHP process ID.
41382 *
41383 * @return int Returns the current PHP process ID, or FALSE on error.
41384 * @since PHP 4, PHP 5, PHP 7
41385 **/
41386function getmypid(){}
41387
41388/**
41389 * Gets PHP script owner's UID
41390 *
41391 * @return int Returns the user ID of the current script, or FALSE on
41392 *   error.
41393 * @since PHP 4, PHP 5, PHP 7
41394 **/
41395function getmyuid(){}
41396
41397/**
41398 * Gets options from the command line argument list
41399 *
41400 * Parses options passed to the script.
41401 *
41402 * @param string $options
41403 * @param array $longopts
41404 * @param int $optind
41405 * @return array This function will return an array of option /
41406 *   argument pairs, .
41407 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
41408 **/
41409function getopt($options, $longopts, &$optind){}
41410
41411/**
41412 * Get protocol number associated with protocol name
41413 *
41414 * {@link getprotobyname} returns the protocol number associated with the
41415 * protocol {@link name} as per /etc/protocols.
41416 *
41417 * @param string $name The protocol name.
41418 * @return int Returns the protocol number, .
41419 * @since PHP 4, PHP 5, PHP 7
41420 **/
41421function getprotobyname($name){}
41422
41423/**
41424 * Get protocol name associated with protocol number
41425 *
41426 * {@link getprotobynumber} returns the protocol name associated with
41427 * protocol {@link number} as per /etc/protocols.
41428 *
41429 * @param int $number The protocol number.
41430 * @return string Returns the protocol name as a string, .
41431 * @since PHP 4, PHP 5, PHP 7
41432 **/
41433function getprotobynumber($number){}
41434
41435/**
41436 * Show largest possible random value
41437 *
41438 * @return int The largest possible random value returned by {@link
41439 *   rand}
41440 * @since PHP 4, PHP 5, PHP 7
41441 **/
41442function getrandmax(){}
41443
41444/**
41445 * Gets the current resource usages
41446 *
41447 * This is an interface to getrusage(2). It gets data returned from the
41448 * system call.
41449 *
41450 * @param int $who If {@link who} is 1, getrusage will be called with
41451 *   RUSAGE_CHILDREN.
41452 * @return array Returns an associative array containing the data
41453 *   returned from the system call. All entries are accessible by using
41454 *   their documented field names.
41455 * @since PHP 4, PHP 5, PHP 7
41456 **/
41457function getrusage($who){}
41458
41459/**
41460 * Get port number associated with an Internet service and protocol
41461 *
41462 * {@link getservbyname} returns the Internet port which corresponds to
41463 * {@link service} for the specified {@link protocol} as per
41464 * /etc/services.
41465 *
41466 * @param string $service The Internet service name, as a string.
41467 * @param string $protocol {@link protocol} is either "tcp" or "udp"
41468 *   (in lowercase).
41469 * @return int Returns the port number, or FALSE if {@link service} or
41470 *   {@link protocol} is not found.
41471 * @since PHP 4, PHP 5, PHP 7
41472 **/
41473function getservbyname($service, $protocol){}
41474
41475/**
41476 * Get Internet service which corresponds to port and protocol
41477 *
41478 * {@link getservbyport} returns the Internet service associated with
41479 * {@link port} for the specified {@link protocol} as per /etc/services.
41480 *
41481 * @param int $port The port number.
41482 * @param string $protocol {@link protocol} is either "tcp" or "udp"
41483 *   (in lowercase).
41484 * @return string Returns the Internet service name as a string.
41485 * @since PHP 4, PHP 5, PHP 7
41486 **/
41487function getservbyport($port, $protocol){}
41488
41489/**
41490 * Lookup a message in the current domain
41491 *
41492 * Looks up a message in the current domain.
41493 *
41494 * @param string $message The message being translated.
41495 * @return string Returns a translated string if one is found in the
41496 *   translation table, or the submitted message if not found.
41497 * @since PHP 4, PHP 5, PHP 7
41498 **/
41499function gettext($message){}
41500
41501/**
41502 * Get current time
41503 *
41504 * This is an interface to gettimeofday(2). It returns an associative
41505 * array containing the data returned from the system call.
41506 *
41507 * @param bool $returnFloat When set to TRUE, a float instead of an
41508 *   array is returned.
41509 * @return mixed By default an array is returned. If {@link
41510 *   returnFloat} is set, then a float is returned.
41511 * @since PHP 4, PHP 5, PHP 7
41512 **/
41513function gettimeofday($returnFloat){}
41514
41515/**
41516 * Get the type of a variable
41517 *
41518 * Returns the type of the PHP variable {@link var}. For type checking,
41519 * use is_* functions.
41520 *
41521 * @param mixed $var The variable being type checked.
41522 * @return string Possible values for the returned string are:
41523 *   "boolean" "integer" "double" (for historical reasons "double" is
41524 *   returned in case of a float, and not simply "float") "string"
41525 *   "array" "object" "resource" "resource (closed)" as of PHP 7.2.0
41526 *   "NULL" "unknown type"
41527 * @since PHP 4, PHP 5, PHP 7
41528 **/
41529function gettype($var){}
41530
41531/**
41532 * Tells what the user's browser is capable of
41533 *
41534 * Attempts to determine the capabilities of the user's browser, by
41535 * looking up the browser's information in the browscap.ini file.
41536 *
41537 * @param string $user_agent The User Agent to be analyzed. By default,
41538 *   the value of HTTP User-Agent header is used; however, you can alter
41539 *   this (i.e., look up another browser's info) by passing this
41540 *   parameter. You can bypass this parameter with a NULL value.
41541 * @param bool $return_array If set to TRUE, this function will return
41542 *   an array instead of an object.
41543 * @return mixed The information is returned in an object or an array
41544 *   which will contain various data elements representing, for instance,
41545 *   the browser's major and minor version numbers and ID string;
41546 *   TRUE/FALSE values for features such as frames, JavaScript, and
41547 *   cookies; and so forth.
41548 * @since PHP 4, PHP 5, PHP 7
41549 **/
41550function get_browser($user_agent, $return_array){}
41551
41552/**
41553 * The "Late Static Binding" class name
41554 *
41555 * Gets the name of the class the static method is called in.
41556 *
41557 * @return string Returns the class name. Returns FALSE if called from
41558 *   outside a class.
41559 * @since PHP 5 >= 5.3.0, PHP 7
41560 **/
41561function get_called_class(){}
41562
41563/**
41564 * Gets the value of a PHP configuration option
41565 *
41566 * Gets the value of a PHP configuration {@link option}.
41567 *
41568 * This function will not return configuration information set when the
41569 * PHP was compiled, or read from an Apache configuration file.
41570 *
41571 * To check whether the system is using a configuration file, try
41572 * retrieving the value of the cfg_file_path configuration setting. If
41573 * this is available, a configuration file is being used.
41574 *
41575 * @param string $option The configuration option name.
41576 * @return mixed Returns the current value of the PHP configuration
41577 *   variable specified by {@link option}, or FALSE if an error occurs.
41578 * @since PHP 4, PHP 5, PHP 7
41579 **/
41580function get_cfg_var($option){}
41581
41582/**
41583 * Returns the name of the class of an object
41584 *
41585 * Gets the name of the class of the given {@link object}.
41586 *
41587 * @param object $object The tested object. This parameter may be
41588 *   omitted when inside a class.
41589 * @return string Returns the name of the class of which {@link object}
41590 *   is an instance. Returns FALSE if {@link object} is not an object.
41591 * @since PHP 4, PHP 5, PHP 7
41592 **/
41593function get_class($object){}
41594
41595/**
41596 * Gets the class methods' names
41597 *
41598 * Gets the class methods names.
41599 *
41600 * @param mixed $class_name The class name or an object instance
41601 * @return array Returns an array of method names defined for the class
41602 *   specified by {@link class_name}. In case of an error, it returns
41603 *   NULL.
41604 * @since PHP 4, PHP 5, PHP 7
41605 **/
41606function get_class_methods($class_name){}
41607
41608/**
41609 * Get the default properties of the class
41610 *
41611 * Get the default properties of the given class.
41612 *
41613 * @param string $class_name The class name
41614 * @return array Returns an associative array of declared properties
41615 *   visible from the current scope, with their default value. The
41616 *   resulting array elements are in the form of varname => value. In
41617 *   case of an error, it returns FALSE.
41618 * @since PHP 4, PHP 5, PHP 7
41619 **/
41620function get_class_vars($class_name){}
41621
41622/**
41623 * Gets the name of the owner of the current PHP script
41624 *
41625 * @return string Returns the username as a string.
41626 * @since PHP 4, PHP 5, PHP 7
41627 **/
41628function get_current_user(){}
41629
41630/**
41631 * Returns an array with the name of the defined classes
41632 *
41633 * Gets the declared classes.
41634 *
41635 * @return array Returns an array of the names of the declared classes
41636 *   in the current script.
41637 * @since PHP 4, PHP 5, PHP 7
41638 **/
41639function get_declared_classes(){}
41640
41641/**
41642 * Returns an array of all declared interfaces
41643 *
41644 * Gets the declared interfaces.
41645 *
41646 * @return array Returns an array of the names of the declared
41647 *   interfaces in the current script.
41648 * @since PHP 5, PHP 7
41649 **/
41650function get_declared_interfaces(){}
41651
41652/**
41653 * Returns an array of all declared traits
41654 *
41655 * @return array Returns an array with names of all declared traits in
41656 *   values. Returns NULL in case of a failure.
41657 * @since PHP 5 >= 5.4.0, PHP 7
41658 **/
41659function get_declared_traits(){}
41660
41661/**
41662 * Returns an associative array with the names of all the constants and
41663 * their values
41664 *
41665 * Returns the names and values of all the constants currently defined.
41666 * This includes those created by extensions as well as those created
41667 * with the {@link define} function.
41668 *
41669 * @param bool $categorize Causing this function to return a
41670 *   multi-dimensional array with categories in the keys of the first
41671 *   dimension and constants and their values in the second dimension.
41672 *
41673 *   <?php define("MY_CONSTANT", 1);
41674 *   print_r(get_defined_constants(true)); ?>
41675 *
41676 *   Array ( [Core] => Array ( [E_ERROR] => 1 [E_WARNING] => 2 [E_PARSE]
41677 *   => 4 [E_NOTICE] => 8 [E_CORE_ERROR] => 16 [E_CORE_WARNING] => 32
41678 *   [E_COMPILE_ERROR] => 64 [E_COMPILE_WARNING] => 128 [E_USER_ERROR] =>
41679 *   256 [E_USER_WARNING] => 512 [E_USER_NOTICE] => 1024 [E_ALL] => 2047
41680 *   [TRUE] => 1 )
41681 *
41682 *   [pcre] => Array ( [PREG_PATTERN_ORDER] => 1 [PREG_SET_ORDER] => 2
41683 *   [PREG_OFFSET_CAPTURE] => 256 [PREG_SPLIT_NO_EMPTY] => 1
41684 *   [PREG_SPLIT_DELIM_CAPTURE] => 2 [PREG_SPLIT_OFFSET_CAPTURE] => 4
41685 *   [PREG_GREP_INVERT] => 1 )
41686 *
41687 *   [user] => Array ( [MY_CONSTANT] => 1 )
41688 *
41689 *   )
41690 * @return array Returns an array of constant name => constant value
41691 *   array, optionally groupped by extension name registering the
41692 *   constant.
41693 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
41694 **/
41695function get_defined_constants($categorize){}
41696
41697/**
41698 * Returns an array of all defined functions
41699 *
41700 * Gets an array of all defined functions.
41701 *
41702 * @param bool $exclude_disabled Whether disabled functions should be
41703 *   excluded from the return value.
41704 * @return array Returns a multidimensional array containing a list of
41705 *   all defined functions, both built-in (internal) and user-defined.
41706 *   The internal functions will be accessible via $arr["internal"], and
41707 *   the user defined ones using $arr["user"] (see example below).
41708 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
41709 **/
41710function get_defined_functions($exclude_disabled){}
41711
41712/**
41713 * Returns an array of all defined variables
41714 *
41715 * This function returns a multidimensional array containing a list of
41716 * all defined variables, be them environment, server or user-defined
41717 * variables, within the scope that {@link get_defined_vars} is called.
41718 *
41719 * @return array A multidimensional array with all the variables.
41720 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
41721 **/
41722function get_defined_vars(){}
41723
41724/**
41725 * Returns an array with the names of the functions of a module
41726 *
41727 * This function returns the names of all the functions defined in the
41728 * module indicated by {@link module_name}.
41729 *
41730 * @param string $module_name The module name.
41731 * @return array Returns an array with all the functions, or FALSE if
41732 *   {@link module_name} is not a valid extension.
41733 * @since PHP 4, PHP 5, PHP 7
41734 **/
41735function get_extension_funcs($module_name){}
41736
41737/**
41738 * Fetches all the headers sent by the server in response to an HTTP
41739 * request
41740 *
41741 * {@link get_headers} returns an array with the headers sent by the
41742 * server in response to a HTTP request.
41743 *
41744 * @param string $url The target URL.
41745 * @param int $format If the optional {@link format} parameter is set
41746 *   to non-zero, {@link get_headers} parses the response and sets the
41747 *   array's keys.
41748 * @param resource $context A valid context resource created with
41749 *   {@link stream_context_create}.
41750 * @return array Returns an indexed or associative array with the
41751 *   headers, or FALSE on failure.
41752 * @since PHP 5, PHP 7
41753 **/
41754function get_headers($url, $format, $context){}
41755
41756/**
41757 * Returns the translation table used by and
41758 *
41759 * {@link get_html_translation_table} will return the translation table
41760 * that is used internally for {@link htmlspecialchars} and {@link
41761 * htmlentities}.
41762 *
41763 * @param int $table Which table to return. Either HTML_ENTITIES or
41764 *   HTML_SPECIALCHARS.
41765 * @param int $flags A bitmask of one or more of the following flags,
41766 *   which specify which quotes the table will contain as well as which
41767 *   document type the table is for. The default is ENT_COMPAT |
41768 *   ENT_HTML401. Available {@link flags} constants Constant Name
41769 *   Description ENT_COMPAT Table will contain entities for
41770 *   double-quotes, but not for single-quotes. ENT_QUOTES Table will
41771 *   contain entities for both double and single quotes. ENT_NOQUOTES
41772 *   Table will neither contain entities for single quotes nor for double
41773 *   quotes. ENT_HTML401 Table for HTML 4.01. ENT_XML1 Table for XML 1.
41774 *   ENT_XHTML Table for XHTML. ENT_HTML5 Table for HTML 5.
41775 * @param string $encoding Encoding to use. If omitted, the default
41776 *   value for this argument is ISO-8859-1 in versions of PHP prior to
41777 *   5.4.0, and UTF-8 from PHP 5.4.0 onwards.
41778 * @return array Returns the translation table as an array, with the
41779 *   original characters as keys and entities as values.
41780 * @since PHP 4, PHP 5, PHP 7
41781 **/
41782function get_html_translation_table($table, $flags, $encoding){}
41783
41784/**
41785 * Returns an array with the names of included or required files
41786 *
41787 * Gets the names of all files that have been included using {@link
41788 * include}, {@link include_once}, {@link require} or {@link
41789 * require_once}.
41790 *
41791 * @return array Returns an array of the names of all files.
41792 * @since PHP 4, PHP 5, PHP 7
41793 **/
41794function get_included_files(){}
41795
41796/**
41797 * Gets the current include_path configuration option
41798 *
41799 * @return string Returns the path, as a string.
41800 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
41801 **/
41802function get_include_path(){}
41803
41804/**
41805 * Returns an array with the names of all modules compiled and loaded
41806 *
41807 * This function returns the names of all the modules compiled and loaded
41808 * in the PHP interpreter.
41809 *
41810 * @param bool $zend_extensions Only return Zend extensions, if not
41811 *   then regular extensions, like mysqli are listed. Defaults to FALSE
41812 *   (return regular extensions).
41813 * @return array Returns an indexed array of all the modules names.
41814 * @since PHP 4, PHP 5, PHP 7
41815 **/
41816function get_loaded_extensions($zend_extensions){}
41817
41818/**
41819 * Gets the current configuration setting of magic_quotes_gpc
41820 *
41821 * Returns the current configuration setting of magic_quotes_gpc
41822 *
41823 * Keep in mind that attempting to set magic_quotes_gpc at runtime will
41824 * not work.
41825 *
41826 * For more information about magic_quotes, see this security section.
41827 *
41828 * @return bool Returns 0 if magic_quotes_gpc is off, 1 otherwise. Or
41829 *   always returns FALSE as of PHP 5.4.0.
41830 * @since PHP 4, PHP 5, PHP 7
41831 **/
41832function get_magic_quotes_gpc(){}
41833
41834/**
41835 * Gets the current active configuration setting of magic_quotes_runtime
41836 *
41837 * @return bool Returns 0 if magic_quotes_runtime is off, 1 otherwise.
41838 *   Or always returns FALSE as of PHP 5.4.0.
41839 * @since PHP 4, PHP 5, PHP 7
41840 **/
41841function get_magic_quotes_runtime(){}
41842
41843/**
41844 * Extracts all meta tag content attributes from a file and returns an
41845 * array
41846 *
41847 * Opens {@link filename} and parses it line by line for <meta> tags in
41848 * the file. The parsing stops at </head>.
41849 *
41850 * @param string $filename The path to the HTML file, as a string. This
41851 *   can be a local file or an URL.
41852 *
41853 *   What {@link get_meta_tags} parses
41854 *
41855 *   <meta name="author" content="name"> <meta name="keywords"
41856 *   content="php documentation"> <meta name="DESCRIPTION" content="a php
41857 *   manual"> <meta name="geo.position" content="49.33;-86.59"> </head>
41858 *   <!-- parsing stops here -->
41859 *
41860 *   (pay attention to line endings - PHP uses a native function to parse
41861 *   the input, so a Mac file won't work on Unix).
41862 * @param bool $use_include_path Setting {@link use_include_path} to
41863 *   TRUE will result in PHP trying to open the file along the standard
41864 *   include path as per the include_path directive. This is used for
41865 *   local files, not URLs.
41866 * @return array Returns an array with all the parsed meta tags.
41867 * @since PHP 4, PHP 5, PHP 7
41868 **/
41869function get_meta_tags($filename, $use_include_path){}
41870
41871/**
41872 * Gets the properties of the given object
41873 *
41874 * Gets the accessible non-static properties of the given {@link object}
41875 * according to scope.
41876 *
41877 * @param object $object An object instance.
41878 * @return array Returns an associative array of defined object
41879 *   accessible non-static properties for the specified {@link object} in
41880 *   scope.
41881 * @since PHP 4, PHP 5, PHP 7
41882 **/
41883function get_object_vars($object){}
41884
41885/**
41886 * Retrieves the parent class name for object or class
41887 *
41888 * @param mixed $object The tested object or class name. This parameter
41889 *   is optional if called from the object's method.
41890 * @return string Returns the name of the parent class of the class of
41891 *   which {@link object} is an instance or the name.
41892 * @since PHP 4, PHP 5, PHP 7
41893 **/
41894function get_parent_class($object){}
41895
41896/**
41897 * Returns an array with the names of included or required files
41898 *
41899 * Gets the names of all files that have been included using {@link
41900 * include}, {@link include_once}, {@link require} or {@link
41901 * require_once}.
41902 *
41903 * @return array Returns an array of the names of all files.
41904 * @since PHP 4, PHP 5, PHP 7
41905 **/
41906function get_required_files(){}
41907
41908/**
41909 * Returns active resources
41910 *
41911 * Returns an array of all currently active resources, optionally
41912 * filtered by resource type.
41913 *
41914 * @param string $type If defined, this will cause {@link
41915 *   get_resources} to only return resources of the given type. A list of
41916 *   resource types is available. If the string Unknown is provided as
41917 *   the type, then only resources that are of an unknown type will be
41918 *   returned. If omitted, all resources will be returned.
41919 * @return array Returns an array of currently active resources,
41920 *   indexed by resource number.
41921 * @since PHP 7
41922 **/
41923function get_resources($type){}
41924
41925/**
41926 * Returns the resource type
41927 *
41928 * This function gets the type of the given resource.
41929 *
41930 * @param resource $handle The evaluated resource handle.
41931 * @return string If the given {@link handle} is a resource, this
41932 *   function will return a string representing its type. If the type is
41933 *   not identified by this function, the return value will be the string
41934 *   Unknown.
41935 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
41936 **/
41937function get_resource_type($handle){}
41938
41939/**
41940 * Find pathnames matching a pattern
41941 *
41942 * The {@link glob} function searches for all the pathnames matching
41943 * {@link pattern} according to the rules used by the libc glob()
41944 * function, which is similar to the rules used by common shells.
41945 *
41946 * @param string $pattern The pattern. No tilde expansion or parameter
41947 *   substitution is done. Special characters: * - Matches zero or more
41948 *   characters. ? - Matches exactly one character (any character). [...]
41949 *   - Matches one character from a group of characters. If the first
41950 *   character is !, matches any character not in the group. \ - Escapes
41951 *   the following character, except when the GLOB_NOESCAPE flag is used.
41952 * @param int $flags Valid flags: GLOB_MARK - Adds a slash to each
41953 *   directory returned GLOB_NOSORT - Return files as they appear in the
41954 *   directory (no sorting). When this flag is not used, the pathnames
41955 *   are sorted alphabetically GLOB_NOCHECK - Return the search pattern
41956 *   if no files matching it were found GLOB_NOESCAPE - Backslashes do
41957 *   not quote metacharacters GLOB_BRACE - Expands {a,b,c} to match 'a',
41958 *   'b', or 'c' GLOB_ONLYDIR - Return only directory entries which match
41959 *   the pattern GLOB_ERR - Stop on read errors (like unreadable
41960 *   directories), by default errors are ignored.
41961 * @return array Returns an array containing the matched
41962 *   files/directories, an empty array if no file matched or FALSE on
41963 *   error.
41964 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
41965 **/
41966function glob($pattern, $flags){}
41967
41968/**
41969 * Format a GMT/UTC date/time
41970 *
41971 * Identical to the {@link date} function except that the time returned
41972 * is Greenwich Mean Time (GMT).
41973 *
41974 * @param string $format The format of the outputted date string. See
41975 *   the formatting options for the {@link date} function.
41976 * @param int $timestamp
41977 * @return string Returns a formatted date string. If a non-numeric
41978 *   value is used for {@link timestamp}, FALSE is returned and an
41979 *   E_WARNING level error is emitted.
41980 * @since PHP 4, PHP 5, PHP 7
41981 **/
41982function gmdate($format, $timestamp){}
41983
41984/**
41985 * Get Unix timestamp for a GMT date
41986 *
41987 * Identical to {@link mktime} except the passed parameters represents a
41988 * GMT date. {@link gmmktime} internally uses {@link mktime} so only
41989 * times valid in derived local time can be used.
41990 *
41991 * Like {@link mktime}, arguments may be left out in order from right to
41992 * left, with any omitted arguments being set to the current
41993 * corresponding GMT value.
41994 *
41995 * @param int $hour The number of the hour relative to the start of the
41996 *   day determined by {@link month}, {@link day} and {@link year}.
41997 *   Negative values reference the hour before midnight of the day in
41998 *   question. Values greater than 23 reference the appropriate hour in
41999 *   the following day(s).
42000 * @param int $minute The number of the minute relative to the start of
42001 *   the {@link hour}. Negative values reference the minute in the
42002 *   previous hour. Values greater than 59 reference the appropriate
42003 *   minute in the following hour(s).
42004 * @param int $second The number of seconds relative to the start of
42005 *   the {@link minute}. Negative values reference the second in the
42006 *   previous minute. Values greater than 59 reference the appropriate
42007 *   second in the following minute(s).
42008 * @param int $month The number of the month relative to the end of the
42009 *   previous year. Values 1 to 12 reference the normal calendar months
42010 *   of the year in question. Values less than 1 (including negative
42011 *   values) reference the months in the previous year in reverse order,
42012 *   so 0 is December, -1 is November, etc. Values greater than 12
42013 *   reference the appropriate month in the following year(s).
42014 * @param int $day The number of the day relative to the end of the
42015 *   previous month. Values 1 to 28, 29, 30 or 31 (depending upon the
42016 *   month) reference the normal days in the relevant month. Values less
42017 *   than 1 (including negative values) reference the days in the
42018 *   previous month, so 0 is the last day of the previous month, -1 is
42019 *   the day before that, etc. Values greater than the number of days in
42020 *   the relevant month reference the appropriate day in the following
42021 *   month(s).
42022 * @param int $year The year
42023 * @param int $isDST Parameters always represent a GMT date so {@link
42024 *   isDST} doesn't influence the result.
42025 * @return int Returns a integer Unix timestamp.
42026 * @since PHP 4, PHP 5, PHP 7
42027 **/
42028function gmmktime($hour, $minute, $second, $month, $day, $year, $isDST){}
42029
42030/**
42031 * Absolute value
42032 *
42033 * Get the absolute value of a number.
42034 *
42035 * @param GMP $a
42036 * @return GMP Returns the absolute value of {@link a}, as a GMP
42037 *   number.
42038 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42039 **/
42040function gmp_abs($a){}
42041
42042/**
42043 * Add numbers
42044 *
42045 * Add two numbers.
42046 *
42047 * @param GMP $a The first summand (augent).
42048 * @param GMP $b The second summand (addend).
42049 * @return GMP A GMP number representing the sum of the arguments.
42050 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42051 **/
42052function gmp_add($a, $b){}
42053
42054/**
42055 * Bitwise AND
42056 *
42057 * Calculates bitwise AND of two GMP numbers.
42058 *
42059 * @param GMP $a
42060 * @param GMP $b
42061 * @return GMP A GMP number representing the bitwise AND comparison.
42062 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42063 **/
42064function gmp_and($a, $b){}
42065
42066/**
42067 * Calculates binomial coefficient
42068 *
42069 * Calculates the binomial coefficient C(n, k).
42070 *
42071 * @param mixed $n
42072 * @param int $k
42073 * @return GMP Returns the binomial coefficient C(n, k), .
42074 * @since PHP 7 >= 7.3.0
42075 **/
42076function gmp_binomial($n, $k){}
42077
42078/**
42079 * Clear bit
42080 *
42081 * Clears (sets to 0) bit {@link index} in {@link a}. The index starts at
42082 * 0.
42083 *
42084 * @param GMP $a
42085 * @param int $index The index of the bit to clear. Index 0 represents
42086 *   the least significant bit.
42087 * @return void
42088 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42089 **/
42090function gmp_clrbit($a, $index){}
42091
42092/**
42093 * Compare numbers
42094 *
42095 * Compares two numbers.
42096 *
42097 * @param GMP $a
42098 * @param GMP $b
42099 * @return int Returns a positive value if a > b, zero if a = b and a
42100 *   negative value if a < b.
42101 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42102 **/
42103function gmp_cmp($a, $b){}
42104
42105/**
42106 * Calculates one's complement
42107 *
42108 * Returns the one's complement of {@link a}.
42109 *
42110 * @param GMP $a
42111 * @return GMP Returns the one's complement of {@link a}, as a GMP
42112 *   number.
42113 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42114 **/
42115function gmp_com($a){}
42116
42117/**
42118 * Divide numbers
42119 *
42120 * Divides {@link a} by {@link b} and returns the integer result.
42121 *
42122 * @param GMP $a The number being divided.
42123 * @param GMP $b The number that {@link a} is being divided by.
42124 * @param int $round The result rounding is defined by the {@link
42125 *   round}, which can have the following values: GMP_ROUND_ZERO: The
42126 *   result is truncated towards 0. GMP_ROUND_PLUSINF: The result is
42127 *   rounded towards +infinity. GMP_ROUND_MINUSINF: The result is rounded
42128 *   towards -infinity.
42129 * @return GMP
42130 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42131 **/
42132function gmp_div($a, $b, $round){}
42133
42134/**
42135 * Exact division of numbers
42136 *
42137 * Divides {@link n} by {@link d}, using fast "exact division" algorithm.
42138 * This function produces correct results only when it is known in
42139 * advance that {@link d} divides {@link n}.
42140 *
42141 * @param GMP $n The number being divided.
42142 * @param GMP $d The number that {@link a} is being divided by.
42143 * @return GMP
42144 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42145 **/
42146function gmp_divexact($n, $d){}
42147
42148/**
42149 * Divide numbers
42150 *
42151 * Divides {@link a} by {@link b} and returns the integer result.
42152 *
42153 * @param GMP $a The number being divided.
42154 * @param GMP $b The number that {@link a} is being divided by.
42155 * @param int $round The result rounding is defined by the {@link
42156 *   round}, which can have the following values: GMP_ROUND_ZERO: The
42157 *   result is truncated towards 0. GMP_ROUND_PLUSINF: The result is
42158 *   rounded towards +infinity. GMP_ROUND_MINUSINF: The result is rounded
42159 *   towards -infinity.
42160 * @return GMP
42161 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42162 **/
42163function gmp_div_q($a, $b, $round){}
42164
42165/**
42166 * Divide numbers and get quotient and remainder
42167 *
42168 * The function divides {@link n} by {@link d}.
42169 *
42170 * @param GMP $n The number being divided.
42171 * @param GMP $d The number that {@link n} is being divided by.
42172 * @param int $round See the {@link gmp_div_q} function for description
42173 *   of the {@link round} argument.
42174 * @return array Returns an array, with the first element being [n/d]
42175 *   (the integer result of the division) and the second being (n - [n/d]
42176 *   * d) (the remainder of the division).
42177 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42178 **/
42179function gmp_div_qr($n, $d, $round){}
42180
42181/**
42182 * Remainder of the division of numbers
42183 *
42184 * Calculates remainder of the integer division of {@link n} by {@link
42185 * d}. The remainder has the sign of the {@link n} argument, if not zero.
42186 *
42187 * @param GMP $n The number being divided.
42188 * @param GMP $d The number that {@link n} is being divided by.
42189 * @param int $round See the {@link gmp_div_q} function for description
42190 *   of the {@link round} argument.
42191 * @return GMP The remainder, as a GMP number.
42192 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42193 **/
42194function gmp_div_r($n, $d, $round){}
42195
42196/**
42197 * Export to a binary string
42198 *
42199 * Export a GMP number to a binary string
42200 *
42201 * @param GMP $gmpnumber The GMP number being exported
42202 * @param int $word_size Default value is 1. The number of bytes in
42203 *   each chunk of binary data. This is mainly used in conjunction with
42204 *   the options parameter.
42205 * @param int $options Default value is GMP_MSW_FIRST |
42206 *   GMP_NATIVE_ENDIAN.
42207 * @return string Returns a string.
42208 * @since PHP 5 >= 5.6.1, PHP 7
42209 **/
42210function gmp_export($gmpnumber, $word_size, $options){}
42211
42212/**
42213 * Factorial
42214 *
42215 * Calculates factorial (a!) of {@link a}.
42216 *
42217 * @param mixed $a The factorial number.
42218 * @return GMP
42219 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42220 **/
42221function gmp_fact($a){}
42222
42223/**
42224 * Calculate GCD
42225 *
42226 * Calculate greatest common divisor of {@link a} and {@link b}. The
42227 * result is always positive even if either of, or both, input operands
42228 * are negative.
42229 *
42230 * @param GMP $a
42231 * @param GMP $b
42232 * @return GMP A positive GMP number that divides into both {@link a}
42233 *   and {@link b}.
42234 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42235 **/
42236function gmp_gcd($a, $b){}
42237
42238/**
42239 * Calculate GCD and multipliers
42240 *
42241 * Calculates g, s, and t, such that a*s + b*t = g = gcd(a,b), where gcd
42242 * is the greatest common divisor. Returns an array with respective
42243 * elements g, s and t.
42244 *
42245 * This function can be used to solve linear Diophantine equations in two
42246 * variables. These are equations that allow only integer solutions and
42247 * have the form: a*x + b*y = c. For more information, go to the
42248 * "Diophantine Equation" page at MathWorld
42249 *
42250 * @param GMP $a
42251 * @param GMP $b
42252 * @return array An array of GMP numbers.
42253 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42254 **/
42255function gmp_gcdext($a, $b){}
42256
42257/**
42258 * Hamming distance
42259 *
42260 * Returns the hamming distance between {@link a} and {@link b}. Both
42261 * operands should be non-negative.
42262 *
42263 * @param GMP $a It should be positive.
42264 * @param GMP $b It should be positive.
42265 * @return int
42266 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42267 **/
42268function gmp_hamdist($a, $b){}
42269
42270/**
42271 * Import from a binary string
42272 *
42273 * Import a GMP number from a binary string
42274 *
42275 * @param string $data The binary string being imported
42276 * @param int $word_size Default value is 1. The number of bytes in
42277 *   each chunk of binary data. This is mainly used in conjunction with
42278 *   the options parameter.
42279 * @param int $options Default value is GMP_MSW_FIRST |
42280 *   GMP_NATIVE_ENDIAN.
42281 * @return GMP Returns a GMP number.
42282 * @since PHP 5 >= 5.6.1, PHP 7
42283 **/
42284function gmp_import($data, $word_size, $options){}
42285
42286/**
42287 * Create GMP number
42288 *
42289 * Creates a GMP number from an integer or string.
42290 *
42291 * @param mixed $number An integer or a string. The string
42292 *   representation can be decimal, hexadecimal or octal.
42293 * @param int $base The base. The base may vary from 2 to 36. If base
42294 *   is 0 (default value), the actual base is determined from the leading
42295 *   characters: if the first two characters are 0x or 0X, hexadecimal is
42296 *   assumed, otherwise if the first character is "0", octal is assumed,
42297 *   otherwise decimal is assumed.
42298 * @return GMP
42299 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42300 **/
42301function gmp_init($number, $base){}
42302
42303/**
42304 * Convert GMP number to integer
42305 *
42306 * This function converts GMP number into native PHP integers.
42307 *
42308 * @param GMP $gmpnumber
42309 * @return int The integer value of {@link gmpnumber}.
42310 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42311 **/
42312function gmp_intval($gmpnumber){}
42313
42314/**
42315 * Inverse by modulo
42316 *
42317 * Computes the inverse of {@link a} modulo {@link b}.
42318 *
42319 * @param GMP $a
42320 * @param GMP $b
42321 * @return GMP A GMP number on success or FALSE if an inverse does not
42322 *   exist.
42323 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42324 **/
42325function gmp_invert($a, $b){}
42326
42327/**
42328 * Jacobi symbol
42329 *
42330 * Computes Jacobi symbol of {@link a} and {@link p}. {@link p} should be
42331 * odd and must be positive.
42332 *
42333 * @param GMP $a
42334 * @param GMP $p Should be odd and must be positive.
42335 * @return int
42336 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42337 **/
42338function gmp_jacobi($a, $p){}
42339
42340/**
42341 * Kronecker symbol
42342 *
42343 * This function computes the Kronecker symbol of {@link a} and {@link
42344 * b}.
42345 *
42346 * @param mixed $a
42347 * @param mixed $b
42348 * @return int Returns the Kronecker symbol of {@link a} and {@link b}
42349 * @since PHP 7 >= 7.3.0
42350 **/
42351function gmp_kronecker($a, $b){}
42352
42353/**
42354 * Calculate LCM
42355 *
42356 * This function computes the least common multiple (lcm) of {@link a}
42357 * and {@link b}.
42358 *
42359 * @param mixed $a
42360 * @param mixed $b
42361 * @return GMP
42362 * @since PHP 7 >= 7.3.0
42363 **/
42364function gmp_lcm($a, $b){}
42365
42366/**
42367 * Legendre symbol
42368 *
42369 * Compute the Legendre symbol of {@link a} and {@link p}. {@link p}
42370 * should be odd and must be positive.
42371 *
42372 * @param GMP $a
42373 * @param GMP $p Should be odd and must be positive.
42374 * @return int
42375 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42376 **/
42377function gmp_legendre($a, $p){}
42378
42379/**
42380 * Modulo operation
42381 *
42382 * Calculates {@link n} modulo {@link d}. The result is always
42383 * non-negative, the sign of {@link d} is ignored.
42384 *
42385 * @param GMP $n
42386 * @param GMP $d The modulo that is being evaluated.
42387 * @return GMP
42388 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42389 **/
42390function gmp_mod($n, $d){}
42391
42392/**
42393 * Multiply numbers
42394 *
42395 * Multiplies {@link a} by {@link b} and returns the result.
42396 *
42397 * @param GMP $a A number that will be multiplied by {@link b}.
42398 * @param GMP $b A number that will be multiplied by {@link a}.
42399 * @return GMP
42400 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42401 **/
42402function gmp_mul($a, $b){}
42403
42404/**
42405 * Negate number
42406 *
42407 * Returns the negative value of a number.
42408 *
42409 * @param GMP $a
42410 * @return GMP Returns -{@link a}, as a GMP number.
42411 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42412 **/
42413function gmp_neg($a){}
42414
42415/**
42416 * Find next prime number
42417 *
42418 * @param int $a
42419 * @return GMP Return the next prime number greater than {@link a}, as
42420 *   a GMP number.
42421 * @since PHP 5 >= 5.2.0, PHP 7
42422 **/
42423function gmp_nextprime($a){}
42424
42425/**
42426 * Bitwise OR
42427 *
42428 * Calculates bitwise inclusive OR of two GMP numbers.
42429 *
42430 * @param GMP $a
42431 * @param GMP $b
42432 * @return GMP
42433 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42434 **/
42435function gmp_or($a, $b){}
42436
42437/**
42438 * Perfect power check
42439 *
42440 * Checks whether {@link a} is a perfect power.
42441 *
42442 * @param mixed $a
42443 * @return bool Returns TRUE if {@link a} is a perfect power, FALSE
42444 *   otherwise.
42445 * @since PHP 7 >= 7.3.0
42446 **/
42447function gmp_perfect_power($a){}
42448
42449/**
42450 * Perfect square check
42451 *
42452 * Check if a number is a perfect square.
42453 *
42454 * @param GMP $a The number being checked as a perfect square.
42455 * @return bool Returns TRUE if {@link a} is a perfect square, FALSE
42456 *   otherwise.
42457 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42458 **/
42459function gmp_perfect_square($a){}
42460
42461/**
42462 * Population count
42463 *
42464 * Get the population count.
42465 *
42466 * @param GMP $a
42467 * @return int The population count of {@link a}, as an integer.
42468 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42469 **/
42470function gmp_popcount($a){}
42471
42472/**
42473 * Raise number into power
42474 *
42475 * Raise {@link base} into power {@link exp}.
42476 *
42477 * @param GMP $base The base number.
42478 * @param int $exp The positive power to raise the {@link base}.
42479 * @return GMP The new (raised) number, as a GMP number. The case of
42480 *   0^0 yields 1.
42481 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42482 **/
42483function gmp_pow($base, $exp){}
42484
42485/**
42486 * Raise number into power with modulo
42487 *
42488 * Calculate ({@link base} raised into power {@link exp}) modulo {@link
42489 * mod}. If {@link exp} is negative, result is undefined.
42490 *
42491 * @param GMP $base The base number.
42492 * @param GMP $exp The positive power to raise the {@link base}.
42493 * @param GMP $mod The modulo.
42494 * @return GMP The new (raised) number, as a GMP number.
42495 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42496 **/
42497function gmp_powm($base, $exp, $mod){}
42498
42499/**
42500 * Check if number is "probably prime"
42501 *
42502 * The function uses Miller-Rabin's probabilistic test to check if a
42503 * number is a prime.
42504 *
42505 * @param GMP $a The number being checked as a prime.
42506 * @param int $reps Reasonable values of {@link reps} vary from 5 to 10
42507 *   (default being 10); a higher value lowers the probability for a
42508 *   non-prime to pass as a "probable" prime.
42509 * @return int If this function returns 0, {@link a} is definitely not
42510 *   prime. If it returns 1, then {@link a} is "probably" prime. If it
42511 *   returns 2, then {@link a} is surely prime.
42512 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42513 **/
42514function gmp_prob_prime($a, $reps){}
42515
42516/**
42517 * Random number
42518 *
42519 * Generate a random number. The number will be between 0 and (2 ** n) -
42520 * 1, where n is the number of bits per limb multiplied by {@link
42521 * limiter}. If {@link limiter} is negative, negative numbers are
42522 * generated.
42523 *
42524 * A limb is an internal GMP mechanism. The number of bits in a limb is
42525 * not static, and can vary from system to system. Generally, the number
42526 * of bits in a limb is either 32 or 64, but this is not guaranteed.
42527 *
42528 * @param int $limiter The limiter.
42529 * @return GMP A random GMP number.
42530 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42531 **/
42532function gmp_random($limiter){}
42533
42534/**
42535 * Random number
42536 *
42537 * Generate a random number. The number will be between 0 and (2 **
42538 * {@link bits}) - 1.
42539 *
42540 * {@link bits} must greater than 0, and the maximum value is restricted
42541 * by available memory.
42542 *
42543 * @param int $bits The number of bits.
42544 * @return GMP A random GMP number.
42545 * @since PHP 5 >= 5.6.3, PHP 7
42546 **/
42547function gmp_random_bits($bits){}
42548
42549/**
42550 * Random number
42551 *
42552 * Generate a random number. The number will be between {@link min} and
42553 * {@link max}.
42554 *
42555 * {@link min} and {@link max} can both be negative but {@link min} must
42556 * always be less than {@link max}.
42557 *
42558 * @param GMP $min A GMP number representing the lower bound for the
42559 *   random number
42560 * @param GMP $max A GMP number representing the upper bound for the
42561 *   random number
42562 * @return GMP A random GMP number.
42563 * @since PHP 5 >= 5.6.3, PHP 7
42564 **/
42565function gmp_random_range($min, $max){}
42566
42567/**
42568 * Sets the RNG seed
42569 *
42570 * @param mixed $seed The seed to be set for the {@link gmp_random},
42571 *   {@link gmp_random_bits}, and {@link gmp_random_range} functions.
42572 * @return void
42573 * @since PHP 7
42574 **/
42575function gmp_random_seed($seed){}
42576
42577/**
42578 * Take the integer part of nth root
42579 *
42580 * Takes the {@link nth} root of {@link a} and returns the integer
42581 * component of the result.
42582 *
42583 * @param GMP $a
42584 * @param int $nth The positive root to take of {@link a}.
42585 * @return GMP The integer component of the resultant root, as a GMP
42586 *   number.
42587 * @since PHP 5 >= 5.6.0, PHP 7
42588 **/
42589function gmp_root($a, $nth){}
42590
42591/**
42592 * Take the integer part and remainder of nth root
42593 *
42594 * Takes the {@link nth} root of {@link a} and returns the integer
42595 * component and remainder of the result.
42596 *
42597 * @param GMP $a
42598 * @param int $nth The positive root to take of {@link a}.
42599 * @return array A two element array, where the first element is the
42600 *   integer component of the root, and the second element is the
42601 *   remainder, both represented as GMP numbers.
42602 * @since PHP 5 >= 5.6.0, PHP 7
42603 **/
42604function gmp_rootrem($a, $nth){}
42605
42606/**
42607 * Scan for 0
42608 *
42609 * Scans {@link a}, starting with bit {@link start}, towards more
42610 * significant bits, until the first clear bit is found.
42611 *
42612 * @param GMP $a The number to scan.
42613 * @param int $start The starting bit.
42614 * @return int Returns the index of the found bit, as an integer. The
42615 *   index starts from 0.
42616 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42617 **/
42618function gmp_scan0($a, $start){}
42619
42620/**
42621 * Scan for 1
42622 *
42623 * Scans {@link a}, starting with bit {@link start}, towards more
42624 * significant bits, until the first set bit is found.
42625 *
42626 * @param GMP $a The number to scan.
42627 * @param int $start The starting bit.
42628 * @return int Returns the index of the found bit, as an integer. If no
42629 *   set bit is found, -1 is returned.
42630 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42631 **/
42632function gmp_scan1($a, $start){}
42633
42634/**
42635 * Set bit
42636 *
42637 * Sets bit {@link index} in {@link a}.
42638 *
42639 * @param GMP $a The value to modify.
42640 * @param int $index The index of the bit to set. Index 0 represents
42641 *   the least significant bit.
42642 * @param bool $bit_on True to set the bit (set it to 1/on); false to
42643 *   clear the bit (set it to 0/off).
42644 * @return void
42645 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42646 **/
42647function gmp_setbit($a, $index, $bit_on){}
42648
42649/**
42650 * Sign of number
42651 *
42652 * Checks the sign of a number.
42653 *
42654 * @param GMP $a Either a GMP number resource in PHP 5.5 and earlier, a
42655 *   GMP object in PHP 5.6 and later, or a numeric string provided that
42656 *   it is possible to convert the latter to an integer.
42657 * @return int Returns 1 if {@link a} is positive, -1 if {@link a} is
42658 *   negative, and 0 if {@link a} is zero.
42659 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42660 **/
42661function gmp_sign($a){}
42662
42663/**
42664 * Calculate square root
42665 *
42666 * Calculates square root of {@link a}.
42667 *
42668 * @param GMP $a
42669 * @return GMP The integer portion of the square root, as a GMP number.
42670 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42671 **/
42672function gmp_sqrt($a){}
42673
42674/**
42675 * Square root with remainder
42676 *
42677 * Calculate the square root of a number, with remainder.
42678 *
42679 * @param GMP $a The number being square rooted.
42680 * @return array Returns array where first element is the integer
42681 *   square root of {@link a} and the second is the remainder (i.e., the
42682 *   difference between {@link a} and the first element squared).
42683 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42684 **/
42685function gmp_sqrtrem($a){}
42686
42687/**
42688 * Convert GMP number to string
42689 *
42690 * Convert GMP number to string representation in base {@link base}. The
42691 * default base is 10.
42692 *
42693 * @param GMP $gmpnumber The GMP number that will be converted to a
42694 *   string.
42695 * @param int $base The base of the returned number. The default base
42696 *   is 10. Allowed values for the base are from 2 to 62 and -2 to -36.
42697 * @return string The number, as a string.
42698 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42699 **/
42700function gmp_strval($gmpnumber, $base){}
42701
42702/**
42703 * Subtract numbers
42704 *
42705 * Subtracts {@link b} from {@link a} and returns the result.
42706 *
42707 * @param GMP $a The number being subtracted from.
42708 * @param GMP $b The number subtracted from {@link a}.
42709 * @return GMP
42710 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42711 **/
42712function gmp_sub($a, $b){}
42713
42714/**
42715 * Tests if a bit is set
42716 *
42717 * Tests if the specified bit is set.
42718 *
42719 * @param GMP $a
42720 * @param int $index The bit to test
42721 * @return bool Returns TRUE if the bit is set in resource {@link $a},
42722 *   otherwise FALSE.
42723 * @since PHP 5 >= 5.3.0, PHP 7
42724 **/
42725function gmp_testbit($a, $index){}
42726
42727/**
42728 * Bitwise XOR
42729 *
42730 * Calculates bitwise exclusive OR (XOR) of two GMP numbers.
42731 *
42732 * @param GMP $a
42733 * @param GMP $b
42734 * @return GMP
42735 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
42736 **/
42737function gmp_xor($a, $b){}
42738
42739/**
42740 * Format a GMT/UTC time/date according to locale settings
42741 *
42742 * Behaves the same as {@link strftime} except that the time returned is
42743 * Greenwich Mean Time (GMT). For example, when run in Eastern Standard
42744 * Time (GMT -0500), the first line below prints "Dec 31 1998 20:00:00",
42745 * while the second prints "Jan 01 1999 01:00:00".
42746 *
42747 * @param string $format See description in {@link strftime}.
42748 * @param int $timestamp
42749 * @return string Returns a string formatted according to the given
42750 *   format string using the given {@link timestamp} or the current local
42751 *   time if no timestamp is given. Month and weekday names and other
42752 *   language dependent strings respect the current locale set with
42753 *   {@link setlocale}.
42754 * @since PHP 4, PHP 5, PHP 7
42755 **/
42756function gmstrftime($format, $timestamp){}
42757
42758/**
42759 * Add a key for decryption
42760 *
42761 * @param resource $identifier
42762 * @param string $fingerprint
42763 * @param string $passphrase The pass phrase.
42764 * @return bool
42765 * @since PECL gnupg >= 0.5
42766 **/
42767function gnupg_adddecryptkey($identifier, $fingerprint, $passphrase){}
42768
42769/**
42770 * Add a key for encryption
42771 *
42772 * @param resource $identifier
42773 * @param string $fingerprint
42774 * @return bool
42775 * @since PECL gnupg >= 0.5
42776 **/
42777function gnupg_addencryptkey($identifier, $fingerprint){}
42778
42779/**
42780 * Add a key for signing
42781 *
42782 * @param resource $identifier
42783 * @param string $fingerprint
42784 * @param string $passphrase The pass phrase.
42785 * @return bool
42786 * @since PECL gnupg >= 0.5
42787 **/
42788function gnupg_addsignkey($identifier, $fingerprint, $passphrase){}
42789
42790/**
42791 * Removes all keys which were set for decryption before
42792 *
42793 * @param resource $identifier
42794 * @return bool
42795 * @since PECL gnupg >= 0.5
42796 **/
42797function gnupg_cleardecryptkeys($identifier){}
42798
42799/**
42800 * Removes all keys which were set for encryption before
42801 *
42802 * @param resource $identifier
42803 * @return bool
42804 * @since PECL gnupg >= 0.5
42805 **/
42806function gnupg_clearencryptkeys($identifier){}
42807
42808/**
42809 * Removes all keys which were set for signing before
42810 *
42811 * @param resource $identifier
42812 * @return bool
42813 * @since PECL gnupg >= 0.5
42814 **/
42815function gnupg_clearsignkeys($identifier){}
42816
42817/**
42818 * Decrypts a given text
42819 *
42820 * Decrypts the given text with the keys, which were set with
42821 * gnupg_adddecryptkey before.
42822 *
42823 * @param resource $identifier
42824 * @param string $text The text being decrypted.
42825 * @return string On success, this function returns the decrypted text.
42826 *   On failure, this function returns FALSE.
42827 * @since PECL gnupg >= 0.1
42828 **/
42829function gnupg_decrypt($identifier, $text){}
42830
42831/**
42832 * Decrypts and verifies a given text
42833 *
42834 * Decrypts and verifies a given text and returns information about the
42835 * signature.
42836 *
42837 * @param resource $identifier
42838 * @param string $text The text being decrypted.
42839 * @param string $plaintext The parameter {@link plaintext} gets filled
42840 *   with the decrypted text.
42841 * @return array On success, this function returns information about
42842 *   the signature and fills the {@link plaintext} parameter with the
42843 *   decrypted text. On failure, this function returns FALSE.
42844 * @since PECL gnupg >= 0.2
42845 **/
42846function gnupg_decryptverify($identifier, $text, &$plaintext){}
42847
42848/**
42849 * Encrypts a given text
42850 *
42851 * Encrypts the given {@link plaintext} with the keys, which were set
42852 * with gnupg_addencryptkey before and returns the encrypted text.
42853 *
42854 * @param resource $identifier
42855 * @param string $plaintext The text being encrypted.
42856 * @return string On success, this function returns the encrypted text.
42857 *   On failure, this function returns FALSE.
42858 * @since PECL gnupg >= 0.1
42859 **/
42860function gnupg_encrypt($identifier, $plaintext){}
42861
42862/**
42863 * Encrypts and signs a given text
42864 *
42865 * Encrypts and signs the given {@link plaintext} with the keys, which
42866 * were set with gnupg_addsignkey and gnupg_addencryptkey before and
42867 * returns the encrypted and signed text.
42868 *
42869 * @param resource $identifier
42870 * @param string $plaintext The text being encrypted.
42871 * @return string On success, this function returns the encrypted and
42872 *   signed text. On failure, this function returns FALSE.
42873 * @since PECL gnupg >= 0.2
42874 **/
42875function gnupg_encryptsign($identifier, $plaintext){}
42876
42877/**
42878 * Exports a key
42879 *
42880 * Exports the key {@link fingerprint}.
42881 *
42882 * @param resource $identifier
42883 * @param string $fingerprint
42884 * @return string On success, this function returns the keydata. On
42885 *   failure, this function returns FALSE.
42886 * @since PECL gnupg >= 0.1
42887 **/
42888function gnupg_export($identifier, $fingerprint){}
42889
42890/**
42891 * Returns the errortext, if a function fails
42892 *
42893 * @param resource $identifier
42894 * @return string Returns an errortext, if an error has occurred,
42895 *   otherwise FALSE.
42896 * @since PECL gnupg >= 0.1
42897 **/
42898function gnupg_geterror($identifier){}
42899
42900/**
42901 * Returns the currently active protocol for all operations
42902 *
42903 * @param resource $identifier
42904 * @return int Returns the currently active protocol, which can be one
42905 *   of GNUPG_PROTOCOL_OpenPGP or GNUPG_PROTOCOL_CMS.
42906 * @since PECL gnupg >= 0.1
42907 **/
42908function gnupg_getprotocol($identifier){}
42909
42910/**
42911 * Imports a key
42912 *
42913 * Imports the key {@link keydata} and returns an array with information
42914 * about the importprocess.
42915 *
42916 * @param resource $identifier
42917 * @param string $keydata The data key that is being imported.
42918 * @return array On success, this function returns and info-array about
42919 *   the importprocess. On failure, this function returns FALSE.
42920 * @since PECL gnupg >= 0.3
42921 **/
42922function gnupg_import($identifier, $keydata){}
42923
42924/**
42925 * Initialize a connection
42926 *
42927 * @return resource A GnuPG resource connection used by other GnuPG
42928 *   functions.
42929 * @since PECL gnupg >= 0.4
42930 **/
42931function gnupg_init(){}
42932
42933/**
42934 * Returns an array with information about all keys that matches the
42935 * given pattern
42936 *
42937 * @param resource $identifier
42938 * @param string $pattern The pattern being checked against the keys.
42939 * @return array Returns an array with information about all keys that
42940 *   matches the given pattern or FALSE, if an error has occurred.
42941 * @since PECL gnupg >= 0.1
42942 **/
42943function gnupg_keyinfo($identifier, $pattern){}
42944
42945/**
42946 * Toggle armored output
42947 *
42948 * Toggle the armored output.
42949 *
42950 * @param resource $identifier
42951 * @param int $armor Pass a non-zero integer-value to this function to
42952 *   enable armored-output (default). Pass 0 to disable armored output.
42953 * @return bool
42954 * @since PECL gnupg >= 0.1
42955 **/
42956function gnupg_setarmor($identifier, $armor){}
42957
42958/**
42959 * Sets the mode for error_reporting
42960 *
42961 * Sets the mode for error_reporting.
42962 *
42963 * @param resource $identifier
42964 * @param int $errormode The error mode. {@link errormode} takes a
42965 *   constant indicating what type of error_reporting should be used. The
42966 *   possible values are GNUPG_ERROR_WARNING, GNUPG_ERROR_EXCEPTION and
42967 *   GNUPG_ERROR_SILENT. By default GNUPG_ERROR_SILENT is used.
42968 * @return void
42969 * @since PECL gnupg >= 0.6
42970 **/
42971function gnupg_seterrormode($identifier, $errormode){}
42972
42973/**
42974 * Sets the mode for signing
42975 *
42976 * @param resource $identifier
42977 * @param int $signmode The mode for signing. {@link signmode} takes a
42978 *   constant indicating what type of signature should be produced. The
42979 *   possible values are GNUPG_SIG_MODE_NORMAL, GNUPG_SIG_MODE_DETACH and
42980 *   GNUPG_SIG_MODE_CLEAR. By default GNUPG_SIG_MODE_CLEAR is used.
42981 * @return bool
42982 * @since PECL gnupg >= 0.1
42983 **/
42984function gnupg_setsignmode($identifier, $signmode){}
42985
42986/**
42987 * Signs a given text
42988 *
42989 * Signs the given {@link plaintext} with the keys, which were set with
42990 * gnupg_addsignkey before and returns the signed text or the signature,
42991 * depending on what was set with gnupg_setsignmode.
42992 *
42993 * @param resource $identifier
42994 * @param string $plaintext The plain text being signed.
42995 * @return string On success, this function returns the signed text or
42996 *   the signature. On failure, this function returns FALSE.
42997 * @since PECL gnupg >= 0.1
42998 **/
42999function gnupg_sign($identifier, $plaintext){}
43000
43001/**
43002 * Verifies a signed text
43003 *
43004 * Verifies the given {@link signed_text} and returns information about
43005 * the signature.
43006 *
43007 * @param resource $identifier
43008 * @param string $signed_text The signed text.
43009 * @param string $signature The signature. To verify a clearsigned
43010 *   text, set signature to FALSE.
43011 * @param string $plaintext The plain text. If this optional parameter
43012 *   is passed, it is filled with the plain text.
43013 * @return array On success, this function returns information about
43014 *   the signature. On failure, this function returns FALSE.
43015 * @since PECL gnupg >= 0.1
43016 **/
43017function gnupg_verify($identifier, $signed_text, $signature, &$plaintext){}
43018
43019/**
43020 * Translate a gopher formatted directory entry into an associative array
43021 *
43022 * {@link gopher_parsedir} parses a gopher formatted directory entry into
43023 * an associative array.
43024 *
43025 * While gopher returns text/plain documents for actual document
43026 * requests. A request to a directory (such as /) will return specially
43027 * encoded series of lines with each line being one directory entry or
43028 * information line.
43029 *
43030 * @param string $dirent The directory entry.
43031 * @return array Returns an associative array whose components are:
43032 *   type - One of the GOPHER_XXX constants. title - The name of the
43033 *   resource. path - The path of the resource. host - The domain name of
43034 *   the host that has this document (or directory). port - The port at
43035 *   which to connect on host.
43036 * @since PECL net_gopher >= 0.1
43037 **/
43038function gopher_parsedir($dirent){}
43039
43040/**
43041 * Function to extract a sequence of default grapheme clusters from a
43042 * text buffer, which must be encoded in UTF-8
43043 *
43044 * @param string $haystack String to search.
43045 * @param int $size Maximum number items - based on the $extract_type -
43046 *   to return.
43047 * @param int $extract_type Defines the type of units referred to by
43048 *   the $size parameter:
43049 *
43050 *   GRAPHEME_EXTR_COUNT (default) - $size is the number of default
43051 *   grapheme clusters to extract. GRAPHEME_EXTR_MAXBYTES - $size is the
43052 *   maximum number of bytes returned. GRAPHEME_EXTR_MAXCHARS - $size is
43053 *   the maximum number of UTF-8 characters returned.
43054 * @param int $start Starting position in $haystack in bytes - if
43055 *   given, it must be zero or a positive value that is less than or
43056 *   equal to the length of $haystack in bytes, or a negative value that
43057 *   counts from the end of $haystack. If $start does not point to the
43058 *   first byte of a UTF-8 character, the start position is moved to the
43059 *   next character boundary.
43060 * @param int $next Reference to a value that will be set to the next
43061 *   starting position. When the call returns, this may point to the
43062 *   first byte position past the end of the string.
43063 * @return string A string starting at offset $start and ending on a
43064 *   default grapheme cluster boundary that conforms to the $size and
43065 *   $extract_type specified.
43066 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
43067 **/
43068function grapheme_extract($haystack, $size, $extract_type, $start, &$next){}
43069
43070/**
43071 * Find position (in grapheme units) of first occurrence of a
43072 * case-insensitive string
43073 *
43074 * @param string $haystack The string to look in. Must be valid UTF-8.
43075 * @param string $needle The string to look for. Must be valid UTF-8.
43076 * @param int $offset The optional $offset parameter allows you to
43077 *   specify where in haystack to start searching as an offset in
43078 *   grapheme units (not bytes or characters). If the offset is negative,
43079 *   it is treated relative to the end of the string. The position
43080 *   returned is still relative to the beginning of haystack regardless
43081 *   of the value of $offset.
43082 * @return int Returns the position as an integer. If needle is not
43083 *   found, grapheme_stripos() will return boolean FALSE.
43084 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
43085 **/
43086function grapheme_stripos($haystack, $needle, $offset){}
43087
43088/**
43089 * Returns part of haystack string from the first occurrence of
43090 * case-insensitive needle to the end of haystack
43091 *
43092 * Returns part of haystack string starting from and including the first
43093 * occurrence of case-insensitive needle to the end of haystack.
43094 *
43095 * @param string $haystack The input string. Must be valid UTF-8.
43096 * @param string $needle The string to look for. Must be valid UTF-8.
43097 * @param bool $before_needle If TRUE, grapheme_strstr() returns the
43098 *   part of the haystack before the first occurrence of the needle
43099 *   (excluding needle).
43100 * @return string Returns the portion of $haystack, or FALSE if $needle
43101 *   is not found.
43102 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
43103 **/
43104function grapheme_stristr($haystack, $needle, $before_needle){}
43105
43106/**
43107 * Get string length in grapheme units
43108 *
43109 * Get string length in grapheme units (not bytes or characters)
43110 *
43111 * @param string $input The string being measured for length. It must
43112 *   be a valid UTF-8 string.
43113 * @return int The length of the string on success, and 0 if the string
43114 *   is empty.
43115 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
43116 **/
43117function grapheme_strlen($input){}
43118
43119/**
43120 * Find position (in grapheme units) of first occurrence of a string
43121 *
43122 * @param string $haystack The string to look in. Must be valid UTF-8.
43123 * @param string $needle The string to look for. Must be valid UTF-8.
43124 * @param int $offset The optional $offset parameter allows you to
43125 *   specify where in $haystack to start searching as an offset in
43126 *   grapheme units (not bytes or characters). If the offset is negative,
43127 *   it is treated relative to the end of the string. The position
43128 *   returned is still relative to the beginning of haystack regardless
43129 *   of the value of $offset.
43130 * @return int Returns the position as an integer. If needle is not
43131 *   found, grapheme_strpos() will return boolean FALSE.
43132 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
43133 **/
43134function grapheme_strpos($haystack, $needle, $offset){}
43135
43136/**
43137 * Find position (in grapheme units) of last occurrence of a
43138 * case-insensitive string
43139 *
43140 * @param string $haystack The string to look in. Must be valid UTF-8.
43141 * @param string $needle The string to look for. Must be valid UTF-8.
43142 * @param int $offset The optional $offset parameter allows you to
43143 *   specify where in $haystack to start searching as an offset in
43144 *   grapheme units (not bytes or characters). The position returned is
43145 *   still relative to the beginning of haystack regardless of the value
43146 *   of $offset.
43147 * @return int Returns the position as an integer. If needle is not
43148 *   found, grapheme_strripos() will return boolean FALSE.
43149 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
43150 **/
43151function grapheme_strripos($haystack, $needle, $offset){}
43152
43153/**
43154 * Find position (in grapheme units) of last occurrence of a string
43155 *
43156 * @param string $haystack The string to look in. Must be valid UTF-8.
43157 * @param string $needle The string to look for. Must be valid UTF-8.
43158 * @param int $offset The optional $offset parameter allows you to
43159 *   specify where in $haystack to start searching as an offset in
43160 *   grapheme units (not bytes or characters). The position returned is
43161 *   still relative to the beginning of haystack regardless of the value
43162 *   of $offset.
43163 * @return int Returns the position as an integer. If needle is not
43164 *   found, grapheme_strrpos() will return boolean FALSE.
43165 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
43166 **/
43167function grapheme_strrpos($haystack, $needle, $offset){}
43168
43169/**
43170 * Returns part of haystack string from the first occurrence of needle to
43171 * the end of haystack
43172 *
43173 * Returns part of haystack string from the first occurrence of needle to
43174 * the end of haystack (including the needle).
43175 *
43176 * @param string $haystack The input string. Must be valid UTF-8.
43177 * @param string $needle The string to look for. Must be valid UTF-8.
43178 * @param bool $before_needle If TRUE, grapheme_strstr() returns the
43179 *   part of the haystack before the first occurrence of the needle
43180 *   (excluding the needle).
43181 * @return string Returns the portion of string, or FALSE if needle is
43182 *   not found.
43183 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
43184 **/
43185function grapheme_strstr($haystack, $needle, $before_needle){}
43186
43187/**
43188 * Return part of a string
43189 *
43190 * @param string $string The input string. Must be valid UTF-8.
43191 * @param int $start Start position in default grapheme units. If
43192 *   $start is non-negative, the returned string will start at the
43193 *   $start'th position in $string, counting from zero. If $start is
43194 *   negative, the returned string will start at the $start'th grapheme
43195 *   unit from the end of string.
43196 * @param int $length Length in grapheme units. If $length is given and
43197 *   is positive, the string returned will contain at most $length
43198 *   grapheme units beginning from $start (depending on the length of
43199 *   string). If $length is given and is negative, then that many
43200 *   grapheme units will be omitted from the end of string (after the
43201 *   start position has been calculated when a start is negative). If
43202 *   $start denotes a position beyond this truncation, FALSE will be
43203 *   returned.
43204 * @return string Returns the extracted part of $string.
43205 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
43206 **/
43207function grapheme_substr($string, $start, $length){}
43208
43209/**
43210 * Converts a Gregorian date to Julian Day Count
43211 *
43212 * The valid range for the Gregorian calendar is from November 25, 4714
43213 * B.C. to at least December 31, 9999 A.D.
43214 *
43215 * Although this function can handle dates all the way back to 4714 B.C.,
43216 * such use may not be meaningful. The Gregorian calendar was not
43217 * instituted until October 15, 1582 (or October 5, 1582 in the Julian
43218 * calendar). Some countries did not accept it until much later. For
43219 * example, Britain converted in 1752, The USSR in 1918 and Greece in
43220 * 1923. Most European countries used the Julian calendar prior to the
43221 * Gregorian.
43222 *
43223 * @param int $month The month as a number from 1 (for January) to 12
43224 *   (for December)
43225 * @param int $day The day as a number from 1 to 31. If the month has
43226 *   less days then given, overflow occurs; see the example below.
43227 * @param int $year The year as a number between -4714 and 9999.
43228 *   Negative numbers mean years B.C., positive numbers mean years A.D.
43229 *   Note that there is no year 0; December 31, 1 B.C. is immediately
43230 *   followed by January 1, 1 A.D.
43231 * @return int The julian day for the given gregorian date as an
43232 *   integer. Dates outside the valid range return 0.
43233 * @since PHP 4, PHP 5, PHP 7
43234 **/
43235function gregoriantojd($month, $day, $year){}
43236
43237/**
43238 * Get the IP address
43239 *
43240 * Get the IP address we advertise ourselves as using.
43241 *
43242 * @param resource $context A context identifier, returned by {@link
43243 *   gupnp_context_new}.
43244 * @return string Returns the IP address for the current context and
43245 *   FALSE on error.
43246 * @since PECL gupnp >= 0.1.0
43247 **/
43248function gupnp_context_get_host_ip($context){}
43249
43250/**
43251 * Get the port
43252 *
43253 * Get the port that the SOAP server is running on.
43254 *
43255 * @param resource $context A context identifier, returned by {@link
43256 *   gupnp_context_new}.
43257 * @return int Returns the port number for the current context and
43258 *   FALSE on error.
43259 * @since PECL gupnp >= 0.1.0
43260 **/
43261function gupnp_context_get_port($context){}
43262
43263/**
43264 * Get the event subscription timeout
43265 *
43266 * Get the event subscription timeout (in seconds), or 0 meaning there is
43267 * no timeout.
43268 *
43269 * @param resource $context A context identifier, returned by {@link
43270 *   gupnp_context_new}.
43271 * @return int The event subscription timeout in seconds.
43272 * @since PECL gupnp >= 0.1.0
43273 **/
43274function gupnp_context_get_subscription_timeout($context){}
43275
43276/**
43277 * Start hosting
43278 *
43279 * Start hosting {@link local_path} at {@link server_path}. Files with
43280 * the path {@link local_path}.LOCALE (if they exist) will be served up
43281 * when LOCALE is specified in the request's Accept-Language header.
43282 *
43283 * @param resource $context A context identifier, returned by {@link
43284 *   gupnp_context_new}.
43285 * @param string $local_path Path to the local file or folder to be
43286 *   hosted.
43287 * @param string $server_path Web server path where {@link local_path}
43288 *   should be hosted.
43289 * @return bool
43290 * @since PECL gupnp >= 0.1.0
43291 **/
43292function gupnp_context_host_path($context, $local_path, $server_path){}
43293
43294/**
43295 * Create a new context
43296 *
43297 * Create a new context with the specified host_ip and port.
43298 *
43299 * @param string $host_ip The local host's IP address, or NULL to use
43300 *   the IP address of the first non-loopback network interface.
43301 * @param int $port Port to run on, or 0 if you don't care what port is
43302 *   used.
43303 * @return resource A context identifier.
43304 * @since PECL gupnp >= 0.1.0
43305 **/
43306function gupnp_context_new($host_ip, $port){}
43307
43308/**
43309 * Sets the event subscription timeout
43310 *
43311 * Sets the event subscription timeout (in seconds) to time out. Note
43312 * that any client side subscriptions will automatically be renewed.
43313 *
43314 * @param resource $context A context identifier, returned by {@link
43315 *   gupnp_context_new}.
43316 * @param int $timeout The event subscription timeout in seconds. Use 0
43317 *   if you don't want subscriptions to time out.
43318 * @return void
43319 * @since PECL gupnp >= 0.1.0
43320 **/
43321function gupnp_context_set_subscription_timeout($context, $timeout){}
43322
43323/**
43324 * Sets a function to be called at regular intervals
43325 *
43326 * @param resource $context A context identifier, returned by {@link
43327 *   gupnp_context_new}.
43328 * @param int $timeout A timeout in miliseconds.
43329 * @param mixed $callback The callback function calling every {@link
43330 *   timeout} period of time. Typically, callback function takes on
43331 *   {@link arg} parameter.
43332 * @param mixed $arg User data for {@link callback}.
43333 * @return bool
43334 * @since PECL gupnp >= 0.1.0
43335 **/
43336function gupnp_context_timeout_add($context, $timeout, $callback, $arg){}
43337
43338/**
43339 * Stop hosting
43340 *
43341 * Stop hosting the file or folder at {@link server_path}.
43342 *
43343 * @param resource $context A context identifier, returned by {@link
43344 *   gupnp_context_new}.
43345 * @param string $server_path Web server path where the file or folder
43346 *   is hosted.
43347 * @return bool
43348 * @since PECL gupnp >= 0.1.0
43349 **/
43350function gupnp_context_unhost_path($context, $server_path){}
43351
43352/**
43353 * Start browsing
43354 *
43355 * Start the search and calls user-defined callback.
43356 *
43357 * @param resource $cpoint A control point identifier, returned by
43358 *   {@link gupnp_control_point_new}.
43359 * @return bool
43360 * @since PECL gupnp >= 0.1.0
43361 **/
43362function gupnp_control_point_browse_start($cpoint){}
43363
43364/**
43365 * Stop browsing
43366 *
43367 * Stop the search and calls user-defined callback.
43368 *
43369 * @param resource $cpoint A control point identifier, returned by
43370 *   {@link gupnp_control_point_new}.
43371 * @return bool
43372 * @since PECL gupnp >= 0.1.0
43373 **/
43374function gupnp_control_point_browse_stop($cpoint){}
43375
43376/**
43377 * Set control point callback
43378 *
43379 * Set control point callback function for signal.
43380 *
43381 * @param resource $cpoint A control point identifier, returned by
43382 *   {@link gupnp_control_point_new}.
43383 * @param int $signal The value of signal. Signal can be one of the
43384 *   following values: GUPNP_SIGNAL_DEVICE_PROXY_AVAILABLE Emitted
43385 *   whenever a new device has become available.
43386 *   GUPNP_SIGNAL_DEVICE_PROXY_UNAVAILABLE Emitted whenever a device is
43387 *   not available any more. GUPNP_SIGNAL_SERVICE_PROXY_AVAILABLE Emitted
43388 *   whenever a new service has become available.
43389 *   GUPNP_SIGNAL_SERVICE_PROXY_UNAVAILABLE Emitted whenever a service is
43390 *   not available any more.
43391 * @param mixed $callback
43392 * @param mixed $arg
43393 * @return bool
43394 * @since PECL gupnp >= 0.1.0
43395 **/
43396function gupnp_control_point_callback_set($cpoint, $signal, $callback, $arg){}
43397
43398/**
43399 * Create a new control point
43400 *
43401 * Create a new control point with the specified target.
43402 *
43403 * @param resource $context A context identifier, returned by {@link
43404 *   gupnp_context_new}.
43405 * @param string $target The search target. {@link target} should be a
43406 *   service or device name, such as
43407 *   urn:schemas-upnp-org:service:WANIPConnection:1 or
43408 *   urn:schemas-upnp-org:device:MediaRenderer:1.
43409 * @return resource A control point identifier.
43410 * @since PECL gupnp >= 0.1.0
43411 **/
43412function gupnp_control_point_new($context, $target){}
43413
43414/**
43415 * Set device callback function
43416 *
43417 * Set device callback function for signal and action.
43418 *
43419 * @param resource $root_device A root device identifier, returned by
43420 *   {@link gupnp_root_device_new}.
43421 * @param int $signal The value of signal. Signal can be one of the
43422 *   following values: GUPNP_SIGNAL_ACTION_INVOKED Emitted whenever an
43423 *   action is invoked. Handler should process action and must call
43424 *   either {@link gupnp_service_action_return} or {@link
43425 *   gupnp_service_action_return_error}. GUPNP_SIGNAL_NOTIFY_FAILED
43426 *   Emitted whenever notification of a client fails.
43427 * @param string $action_name
43428 * @param mixed $callback
43429 * @param mixed $arg The name of action.
43430 * @return bool
43431 * @since PECL gupnp >= 0.1.0
43432 **/
43433function gupnp_device_action_callback_set($root_device, $signal, $action_name, $callback, $arg){}
43434
43435/**
43436 * Get info of root device
43437 *
43438 * @param resource $root_device A root device identifier, returned by
43439 *   {@link gupnp_root_device_new}.
43440 * @return array Return array wich contains the information of the root
43441 *   device (like location, url, udn and etc).
43442 * @since PECL gupnp >= 0.1.0
43443 **/
43444function gupnp_device_info_get($root_device){}
43445
43446/**
43447 * Get the service with type
43448 *
43449 * Get the service with type or false if no such device was found.
43450 *
43451 * @param resource $root_device A root device identifier, returned by
43452 *   {@link gupnp_root_device_new}.
43453 * @param string $type The type of the service to be retrieved.
43454 * @return resource A service identifier.
43455 * @since PECL gupnp >= 0.1.0
43456 **/
43457function gupnp_device_info_get_service($root_device, $type){}
43458
43459/**
43460 * Check whether root device is available
43461 *
43462 * Get whether or not {@link root_device} is available (announcing its
43463 * presence).
43464 *
43465 * @param resource $root_device A root device identifier, returned by
43466 *   {@link gupnp_root_device_new}.
43467 * @return bool
43468 * @since PECL gupnp >= 0.1.0
43469 **/
43470function gupnp_root_device_get_available($root_device){}
43471
43472/**
43473 * Get the relative location of root device
43474 *
43475 * @param resource $root_device A root device identifier, returned by
43476 *   {@link gupnp_root_device_new}.
43477 * @return string The relative location of root device
43478 * @since PECL gupnp >= 0.1.0
43479 **/
43480function gupnp_root_device_get_relative_location($root_device){}
43481
43482/**
43483 * Create a new root device
43484 *
43485 * Create a new root device, automatically downloading and parsing
43486 * location.
43487 *
43488 * @param resource $context A context identifier, returned by {@link
43489 *   gupnp_context_new}.
43490 * @param string $location Location of the description file for this
43491 *   device, relative to the HTTP root
43492 * @param string $description_dir
43493 * @return resource A root device identifier.
43494 * @since PECL gupnp >= 0.1.0
43495 **/
43496function gupnp_root_device_new($context, $location, $description_dir){}
43497
43498/**
43499 * Set whether or not root_device is available
43500 *
43501 * Controls whether or not root_device is available (announcing its
43502 * presence).
43503 *
43504 * @param resource $root_device A root device identifier, returned by
43505 *   {@link gupnp_root_device_new}.
43506 * @param bool $available Set TRUE if {@link root_device} should be
43507 *   available.
43508 * @return bool
43509 * @since PECL gupnp >= 0.1.0
43510 **/
43511function gupnp_root_device_set_available($root_device, $available){}
43512
43513/**
43514 * Start main loop
43515 *
43516 * Start root server's main loop.
43517 *
43518 * @param resource $root_device A root device identifier, returned by
43519 *   {@link gupnp_root_device_new}.
43520 * @return bool
43521 * @since PECL gupnp >= 0.1.0
43522 **/
43523function gupnp_root_device_start($root_device){}
43524
43525/**
43526 * Stop main loop
43527 *
43528 * Stop root server's main loop.
43529 *
43530 * @param resource $root_device A root device identifier, returned by
43531 *   {@link gupnp_root_device_new}.
43532 * @return bool
43533 * @since PECL gupnp >= 0.1.0
43534 **/
43535function gupnp_root_device_stop($root_device){}
43536
43537/**
43538 * Retrieves the specified action arguments
43539 *
43540 * @param resource $action A service action identifier.
43541 * @param string $name The name of the variable to retrieve.
43542 * @param int $type The type of the variable to retrieve. Type can be
43543 *   one of the following values: GUPNP_TYPE_BOOLEAN Type of the variable
43544 *   is boolean. GUPNP_TYPE_INT Type of the variable is integer.
43545 *   GUPNP_TYPE_LONG Type of the variable is long. GUPNP_TYPE_DOUBLE Type
43546 *   of the variable is double. GUPNP_TYPE_FLOAT Type of the variable is
43547 *   float. GUPNP_TYPE_STRING Type of the variable is string.
43548 * @return mixed The value of the variable.
43549 * @since PECL gupnp >= 0.1.0
43550 **/
43551function gupnp_service_action_get($action, $name, $type){}
43552
43553/**
43554 * Return successfully
43555 *
43556 * @param resource $action A service action identifier.
43557 * @return bool
43558 * @since PECL gupnp >= 0.1.0
43559 **/
43560function gupnp_service_action_return($action){}
43561
43562/**
43563 * Return error code
43564 *
43565 * @param resource $action A service action identifier.
43566 * @param int $error_code The error code. Signal can be one of the
43567 *   following values or user defined: GUPNP_CONTROL_ERROR_INVALID_ACTION
43568 *   The action name was invalid. GUPNP_CONTROL_ERROR_INVALID_ARGS The
43569 *   action arguments were invalid. GUPNP_CONTROL_ERROR_OUT_OF_SYNC Out
43570 *   of sync (deprecated). GUPNP_CONTROL_ERROR_ACTION_FAILED The action
43571 *   failed.
43572 * @param string $error_description
43573 * @return bool
43574 * @since PECL gupnp >= 0.1.0
43575 **/
43576function gupnp_service_action_return_error($action, $error_code, $error_description){}
43577
43578/**
43579 * Sets the specified action return values
43580 *
43581 * @param resource $action A service action identifier.
43582 * @param string $name The name of the variable to retrieve.
43583 * @param int $type The type of the variable to retrieve. Type can be
43584 *   one of the following values: GUPNP_TYPE_BOOLEAN Type of the variable
43585 *   is boolean. GUPNP_TYPE_INT Type of the variable is integer.
43586 *   GUPNP_TYPE_LONG Type of the variable is long. GUPNP_TYPE_DOUBLE Type
43587 *   of the variable is double. GUPNP_TYPE_FLOAT Type of the variable is
43588 *   float. GUPNP_TYPE_STRING Type of the variable is string.
43589 * @param mixed $value
43590 * @return bool
43591 * @since PECL gupnp >= 0.1.0
43592 **/
43593function gupnp_service_action_set($action, $name, $type, $value){}
43594
43595/**
43596 * Freeze new notifications
43597 *
43598 * Causes new notifications to be queued up until {@link
43599 * gupnp_service_thaw_notify} is called.
43600 *
43601 * @param resource $service A service identifier.
43602 * @return bool
43603 * @since PECL gupnp >= 0.1.0
43604 **/
43605function gupnp_service_freeze_notify($service){}
43606
43607/**
43608 * Get full info of service
43609 *
43610 * @param resource $proxy A service proxy identifier.
43611 * @return array Return array wich contains the information of the
43612 *   service (like location, url, udn and etc).
43613 * @since PECL gupnp >= 0.1.0
43614 **/
43615function gupnp_service_info_get($proxy){}
43616
43617/**
43618 * Get resource introspection of service
43619 *
43620 * Get resource introspection of service or register callback if
43621 * corresponding parameter was passed.
43622 *
43623 * @param resource $proxy A service proxy identifier.
43624 * @param mixed $callback The callback function to be called when
43625 *   introspection object is ready. Typically, callback function takes on
43626 *   three parameters. The {@link introspection} parameter's identifier
43627 *   being the first, {@link error} parameter's message being the second,
43628 *   and the {@link arg} is third.
43629 * @param mixed $arg User data for {@link callback}.
43630 * @return mixed Return true if callback function was defined. Return
43631 *   introspection identifier if callback function was omited.
43632 * @since PECL gupnp >= 0.1.0
43633 **/
43634function gupnp_service_info_get_introspection($proxy, $callback, $arg){}
43635
43636/**
43637 * Returns the state variable data
43638 *
43639 * Returns the state variable data by the name {@link variable_name} in
43640 * this service.
43641 *
43642 * @param resource $introspection A introspection identifier.
43643 * @param string $variable_name The name of the variable to retreive.
43644 * @return array Return the state variable data or FALSE.
43645 * @since PECL gupnp >= 0.1.0
43646 **/
43647function gupnp_service_introspection_get_state_variable($introspection, $variable_name){}
43648
43649/**
43650 * Notifies listening clients
43651 *
43652 * Notifies listening clients that the property have changed to the
43653 * specified values.
43654 *
43655 * @param resource $service A service identifier.
43656 * @param string $name The name of the variable.
43657 * @param int $type The type of the variable. Type can be one of the
43658 *   following values: GUPNP_TYPE_BOOLEAN Type of the variable is
43659 *   boolean. GUPNP_TYPE_INT Type of the variable is integer.
43660 *   GUPNP_TYPE_LONG Type of the variable is long. GUPNP_TYPE_DOUBLE Type
43661 *   of the variable is double. GUPNP_TYPE_FLOAT Type of the variable is
43662 *   float. GUPNP_TYPE_STRING Type of the variable is string.
43663 * @param mixed $value
43664 * @return bool
43665 * @since PECL gupnp >= 0.1.0
43666 **/
43667function gupnp_service_notify($service, $name, $type, $value){}
43668
43669/**
43670 * Send action to the service and get value
43671 *
43672 * Send action with parameters to the service exposed by proxy
43673 * synchronously and get value.
43674 *
43675 * @param resource $proxy A service proxy identifier.
43676 * @param string $action An action.
43677 * @param string $name The action name.
43678 * @param int $type The type of the variable to retrieve. Type can be
43679 *   one of the following values: GUPNP_TYPE_BOOLEAN Type of the variable
43680 *   is boolean. GUPNP_TYPE_INT Type of the variable is integer.
43681 *   GUPNP_TYPE_LONG Type of the variable is long. GUPNP_TYPE_DOUBLE Type
43682 *   of the variable is double. GUPNP_TYPE_FLOAT Type of the variable is
43683 *   float. GUPNP_TYPE_STRING Type of the variable is string.
43684 * @return mixed Return value of the action.
43685 * @since PECL gupnp >= 0.1.0
43686 **/
43687function gupnp_service_proxy_action_get($proxy, $action, $name, $type){}
43688
43689/**
43690 * Send action to the service and set value
43691 *
43692 * Send action with parameters to the service exposed by proxy
43693 * synchronously and set value.
43694 *
43695 * @param resource $proxy A service proxy identifier.
43696 * @param string $action An action.
43697 * @param string $name The action name.
43698 * @param mixed $value The action value.
43699 * @param int $type The type of the action. Type can be one of the
43700 *   following values: GUPNP_TYPE_BOOLEAN Type of the variable is
43701 *   boolean. GUPNP_TYPE_INT Type of the variable is integer.
43702 *   GUPNP_TYPE_LONG Type of the variable is long. GUPNP_TYPE_DOUBLE Type
43703 *   of the variable is double. GUPNP_TYPE_FLOAT Type of the variable is
43704 *   float. GUPNP_TYPE_STRING Type of the variable is string.
43705 * @return bool
43706 * @since PECL gupnp >= 0.1.0
43707 **/
43708function gupnp_service_proxy_action_set($proxy, $action, $name, $value, $type){}
43709
43710/**
43711 * Sets up callback for variable change notification
43712 *
43713 * Sets up callback to be called whenever a change notification for
43714 * variable is recieved.
43715 *
43716 * @param resource $proxy A service proxy identifier.
43717 * @param string $value The variable to add notification for.
43718 * @param int $type The type of the variable. Type can be one of the
43719 *   following values: GUPNP_TYPE_BOOLEAN Type of the variable is
43720 *   boolean. GUPNP_TYPE_INT Type of the variable is integer.
43721 *   GUPNP_TYPE_LONG Type of the variable is long. GUPNP_TYPE_DOUBLE Type
43722 *   of the variable is double. GUPNP_TYPE_FLOAT Type of the variable is
43723 *   float. GUPNP_TYPE_STRING Type of the variable is string.
43724 * @param mixed $callback
43725 * @param mixed $arg
43726 * @return bool
43727 * @since PECL gupnp >= 0.1.0
43728 **/
43729function gupnp_service_proxy_add_notify($proxy, $value, $type, $callback, $arg){}
43730
43731/**
43732 * Set service proxy callback for signal
43733 *
43734 * @param resource $proxy A service proxy identifier.
43735 * @param int $signal The value of signal.
43736 *   GUPNP_SIGNAL_SUBSCRIPTION_LOST Emitted whenever the subscription to
43737 *   this service has been lost due to an error condition.
43738 * @param mixed $callback
43739 * @param mixed $arg The callback function for the certain signal.
43740 *   Typically, callback function takes on two parameters. {@link error}
43741 *   parameter's message being the first, and the {@link arg} is second.
43742 * @return bool
43743 * @since PECL gupnp >= 0.1.0
43744 **/
43745function gupnp_service_proxy_callback_set($proxy, $signal, $callback, $arg){}
43746
43747/**
43748 * Check whether subscription is valid to the service
43749 *
43750 * @param resource $proxy A service proxy identifier.
43751 * @return bool
43752 * @since PECL gupnp >= 0.1.0
43753 **/
43754function gupnp_service_proxy_get_subscribed($proxy){}
43755
43756/**
43757 * Cancels the variable change notification
43758 *
43759 * @param resource $proxy A service proxy identifier.
43760 * @param string $value The variable to add notification for.
43761 * @return bool
43762 * @since PECL gupnp >= 0.1.0
43763 **/
43764function gupnp_service_proxy_remove_notify($proxy, $value){}
43765
43766/**
43767 * Send action with multiple parameters synchronously
43768 *
43769 * Send action with parameters {@link in_params} to the service exposed
43770 * by proxy synchronously and return {@link out_params} with values or
43771 * FALSE on error.
43772 *
43773 * @param resource $proxy A service proxy identifier.
43774 * @param string $action An action.
43775 * @param array $in_params An array of in parameters. Each entry in
43776 *   {@link in_params} is supposed to an array containing name, type and
43777 *   value of the parameters.
43778 * @param array $out_params An array of out parameters. Each entry in
43779 *   {@link out_params} is supposed to an array containing name and type
43780 *   of the parameters.
43781 * @return array Return {@link out_params} array with values or FALSE
43782 *   on error.
43783 * @since PECL gupnp >= 0.2.0
43784 **/
43785function gupnp_service_proxy_send_action($proxy, $action, $in_params, $out_params){}
43786
43787/**
43788 * (Un)subscribes to the service
43789 *
43790 * @param resource $proxy A service proxy identifier.
43791 * @param bool $subscribed Set TRUE to subscribe to this service.
43792 * @return bool
43793 * @since PECL gupnp >= 0.1.0
43794 **/
43795function gupnp_service_proxy_set_subscribed($proxy, $subscribed){}
43796
43797/**
43798 * Sends out any pending notifications and stops queuing of new ones
43799 *
43800 * @param resource $service A service identifier.
43801 * @return bool
43802 * @since PECL gupnp >= 0.1.0
43803 **/
43804function gupnp_service_thaw_notify($service){}
43805
43806/**
43807 * Close an open gz-file pointer
43808 *
43809 * Closes the given gz-file pointer.
43810 *
43811 * @param resource $zp The gz-file pointer. It must be valid, and must
43812 *   point to a file successfully opened by {@link gzopen}.
43813 * @return bool
43814 * @since PHP 4, PHP 5, PHP 7
43815 **/
43816function gzclose($zp){}
43817
43818/**
43819 * Compress a string
43820 *
43821 * This function compresses the given string using the ZLIB data format.
43822 *
43823 * For details on the ZLIB compression algorithm see the document "ZLIB
43824 * Compressed Data Format Specification version 3.3" (RFC 1950).
43825 *
43826 * @param string $data The data to compress.
43827 * @param int $level The level of compression. Can be given as 0 for no
43828 *   compression up to 9 for maximum compression. If -1 is used, the
43829 *   default compression of the zlib library is used which is 6.
43830 * @param int $encoding One of ZLIB_ENCODING_* constants.
43831 * @return string The compressed string or FALSE if an error occurred.
43832 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
43833 **/
43834function gzcompress($data, $level, $encoding){}
43835
43836/**
43837 * Decodes a gzip compressed string
43838 *
43839 * This function returns a decoded version of the input {@link data}.
43840 *
43841 * @param string $data The data to decode, encoded by {@link gzencode}.
43842 * @param int $length The maximum length of data to decode.
43843 * @return string The decoded string, or FALSE if an error occurred.
43844 * @since PHP 5 >= 5.4.0, PHP 7
43845 **/
43846function gzdecode($data, $length){}
43847
43848/**
43849 * Deflate a string
43850 *
43851 * This function compresses the given string using the DEFLATE data
43852 * format.
43853 *
43854 * For details on the DEFLATE compression algorithm see the document
43855 * "DEFLATE Compressed Data Format Specification version 1.3" (RFC 1951).
43856 *
43857 * @param string $data The data to deflate.
43858 * @param int $level The level of compression. Can be given as 0 for no
43859 *   compression up to 9 for maximum compression. If not given, the
43860 *   default compression level will be the default compression level of
43861 *   the zlib library.
43862 * @param int $encoding One of ZLIB_ENCODING_* constants.
43863 * @return string The deflated string or FALSE if an error occurred.
43864 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
43865 **/
43866function gzdeflate($data, $level, $encoding){}
43867
43868/**
43869 * Create a gzip compressed string
43870 *
43871 * This function returns a compressed version of the input {@link data}
43872 * compatible with the output of the gzip program.
43873 *
43874 * For more information on the GZIP file format, see the document: GZIP
43875 * file format specification version 4.3 (RFC 1952).
43876 *
43877 * @param string $data The data to encode.
43878 * @param int $level The level of compression. Can be given as 0 for no
43879 *   compression up to 9 for maximum compression. If not given, the
43880 *   default compression level will be the default compression level of
43881 *   the zlib library.
43882 * @param int $encoding_mode The encoding mode. Can be FORCE_GZIP (the
43883 *   default) or FORCE_DEFLATE. Prior to PHP 5.4.0, using FORCE_DEFLATE
43884 *   results in a standard zlib deflated string (inclusive zlib headers)
43885 *   after a gzip file header but without the trailing crc32 checksum. In
43886 *   PHP 5.4.0 and later, FORCE_DEFLATE generates RFC 1950 compliant
43887 *   output, consisting of a zlib header, the deflated data, and an Adler
43888 *   checksum.
43889 * @return string The encoded string, or FALSE if an error occurred.
43890 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
43891 **/
43892function gzencode($data, $level, $encoding_mode){}
43893
43894/**
43895 * Test for on a gz-file pointer
43896 *
43897 * Tests the given GZ file pointer for EOF.
43898 *
43899 * @param resource $zp The gz-file pointer. It must be valid, and must
43900 *   point to a file successfully opened by {@link gzopen}.
43901 * @return int Returns TRUE if the gz-file pointer is at EOF or an
43902 *   error occurs; otherwise returns FALSE.
43903 * @since PHP 4, PHP 5, PHP 7
43904 **/
43905function gzeof($zp){}
43906
43907/**
43908 * Read entire gz-file into an array
43909 *
43910 * This function is identical to {@link readgzfile}, except that it
43911 * returns the file in an array.
43912 *
43913 * @param string $filename The file name.
43914 * @param int $use_include_path You can set this optional parameter to
43915 *   1, if you want to search for the file in the include_path too.
43916 * @return array An array containing the file, one line per cell, empty
43917 *   lines included, and with newlines still attached.
43918 * @since PHP 4, PHP 5, PHP 7
43919 **/
43920function gzfile($filename, $use_include_path){}
43921
43922/**
43923 * Get character from gz-file pointer
43924 *
43925 * Returns a string containing a single (uncompressed) character read
43926 * from the given gz-file pointer.
43927 *
43928 * @param resource $zp The gz-file pointer. It must be valid, and must
43929 *   point to a file successfully opened by {@link gzopen}.
43930 * @return string The uncompressed character or FALSE on EOF (unlike
43931 *   {@link gzeof}).
43932 * @since PHP 4, PHP 5, PHP 7
43933 **/
43934function gzgetc($zp){}
43935
43936/**
43937 * Get line from file pointer
43938 *
43939 * Gets a (uncompressed) string of up to length - 1 bytes read from the
43940 * given file pointer. Reading ends when length - 1 bytes have been read,
43941 * on a newline, or on EOF (whichever comes first).
43942 *
43943 * @param resource $zp The gz-file pointer. It must be valid, and must
43944 *   point to a file successfully opened by {@link gzopen}.
43945 * @param int $length The length of data to get.
43946 * @return string The uncompressed string, or FALSE on error.
43947 * @since PHP 4, PHP 5, PHP 7
43948 **/
43949function gzgets($zp, $length){}
43950
43951/**
43952 * Get line from gz-file pointer and strip HTML tags
43953 *
43954 * Identical to {@link gzgets}, except that {@link gzgetss} attempts to
43955 * strip any HTML and PHP tags from the text it reads.
43956 *
43957 * @param resource $zp The gz-file pointer. It must be valid, and must
43958 *   point to a file successfully opened by {@link gzopen}.
43959 * @param int $length The length of data to get.
43960 * @param string $allowable_tags You can use this optional parameter to
43961 *   specify tags which should not be stripped.
43962 * @return string The uncompressed and stripped string, or FALSE on
43963 *   error.
43964 * @since PHP 4, PHP 5, PHP 7
43965 **/
43966function gzgetss($zp, $length, $allowable_tags){}
43967
43968/**
43969 * Inflate a deflated string
43970 *
43971 * This function inflates a deflated string.
43972 *
43973 * @param string $data The data compressed by {@link gzdeflate}.
43974 * @param int $length The maximum length of data to decode.
43975 * @return string The original uncompressed data or FALSE on error.
43976 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
43977 **/
43978function gzinflate($data, $length){}
43979
43980/**
43981 * Open gz-file
43982 *
43983 * Opens a gzip (.gz) file for reading or writing.
43984 *
43985 * {@link gzopen} can be used to read a file which is not in gzip format;
43986 * in this case {@link gzread} will directly read from the file without
43987 * decompression.
43988 *
43989 * @param string $filename The file name.
43990 * @param string $mode As in {@link fopen} (rb or wb) but can also
43991 *   include a compression level (wb9) or a strategy: f for filtered data
43992 *   as in wb6f, h for Huffman only compression as in wb1h. (See the
43993 *   description of deflateInit2 in zlib.h for more information about the
43994 *   strategy parameter.)
43995 * @param int $use_include_path You can set this optional parameter to
43996 *   1, if you want to search for the file in the include_path too.
43997 * @return resource Returns a file pointer to the file opened, after
43998 *   that, everything you read from this file descriptor will be
43999 *   transparently decompressed and what you write gets compressed.
44000 * @since PHP 4, PHP 5, PHP 7
44001 **/
44002function gzopen($filename, $mode, $use_include_path){}
44003
44004/**
44005 * Output all remaining data on a gz-file pointer
44006 *
44007 * Reads to EOF on the given gz-file pointer from the current position
44008 * and writes the (uncompressed) results to standard output.
44009 *
44010 * @param resource $zp The gz-file pointer. It must be valid, and must
44011 *   point to a file successfully opened by {@link gzopen}.
44012 * @return int The number of uncompressed characters read from {@link
44013 *   gz} and passed through to the input, or FALSE on error.
44014 * @since PHP 4, PHP 5, PHP 7
44015 **/
44016function gzpassthru($zp){}
44017
44018/**
44019 * Binary-safe gz-file write
44020 *
44021 * {@link gzputs} writes the contents of {@link string} to the given
44022 * gz-file.
44023 *
44024 * @param resource $zp The gz-file pointer. It must be valid, and must
44025 *   point to a file successfully opened by {@link gzopen}.
44026 * @param string $string The string to write.
44027 * @param int $length The number of uncompressed bytes to write. If
44028 *   supplied, writing will stop after {@link length} (uncompressed)
44029 *   bytes have been written or the end of {@link string} is reached,
44030 *   whichever comes first.
44031 * @return int Returns the number of (uncompressed) bytes written to
44032 *   the given gz-file stream.
44033 * @since PHP 4, PHP 5, PHP 7
44034 **/
44035function gzputs($zp, $string, $length){}
44036
44037/**
44038 * Binary-safe gz-file read
44039 *
44040 * {@link gzread} reads up to {@link length} bytes from the given gz-file
44041 * pointer. Reading stops when {@link length} (uncompressed) bytes have
44042 * been read or EOF is reached, whichever comes first.
44043 *
44044 * @param resource $zp The gz-file pointer. It must be valid, and must
44045 *   point to a file successfully opened by {@link gzopen}.
44046 * @param int $length The number of bytes to read.
44047 * @return string The data that have been read.
44048 * @since PHP 4, PHP 5, PHP 7
44049 **/
44050function gzread($zp, $length){}
44051
44052/**
44053 * Rewind the position of a gz-file pointer
44054 *
44055 * Sets the file position indicator of the given gz-file pointer to the
44056 * beginning of the file stream.
44057 *
44058 * @param resource $zp The gz-file pointer. It must be valid, and must
44059 *   point to a file successfully opened by {@link gzopen}.
44060 * @return bool
44061 * @since PHP 4, PHP 5, PHP 7
44062 **/
44063function gzrewind($zp){}
44064
44065/**
44066 * Seek on a gz-file pointer
44067 *
44068 * Sets the file position indicator for the given file pointer to the
44069 * given offset byte into the file stream. Equivalent to calling (in C)
44070 * gzseek(zp, offset, SEEK_SET).
44071 *
44072 * If the file is opened for reading, this function is emulated but can
44073 * be extremely slow. If the file is opened for writing, only forward
44074 * seeks are supported; {@link gzseek} then compresses a sequence of
44075 * zeroes up to the new starting position.
44076 *
44077 * @param resource $zp The gz-file pointer. It must be valid, and must
44078 *   point to a file successfully opened by {@link gzopen}.
44079 * @param int $offset The seeked offset.
44080 * @param int $whence {@link whence} values are: SEEK_SET - Set
44081 *   position equal to {@link offset} bytes. SEEK_CUR - Set position to
44082 *   current location plus {@link offset}. If {@link whence} is not
44083 *   specified, it is assumed to be SEEK_SET.
44084 * @return int Upon success, returns 0; otherwise, returns -1. Note
44085 *   that seeking past EOF is not considered an error.
44086 * @since PHP 4, PHP 5, PHP 7
44087 **/
44088function gzseek($zp, $offset, $whence){}
44089
44090/**
44091 * Tell gz-file pointer read/write position
44092 *
44093 * Gets the position of the given file pointer; i.e., its offset into the
44094 * uncompressed file stream.
44095 *
44096 * @param resource $zp The gz-file pointer. It must be valid, and must
44097 *   point to a file successfully opened by {@link gzopen}.
44098 * @return int The position of the file pointer or FALSE if an error
44099 *   occurs.
44100 * @since PHP 4, PHP 5, PHP 7
44101 **/
44102function gztell($zp){}
44103
44104/**
44105 * Uncompress a compressed string
44106 *
44107 * This function uncompress a compressed string.
44108 *
44109 * @param string $data The data compressed by {@link gzcompress}.
44110 * @param int $length The maximum length of data to decode.
44111 * @return string The original uncompressed data or FALSE on error.
44112 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
44113 **/
44114function gzuncompress($data, $length){}
44115
44116/**
44117 * Binary-safe gz-file write
44118 *
44119 * {@link gzwrite} writes the contents of {@link string} to the given
44120 * gz-file.
44121 *
44122 * @param resource $zp The gz-file pointer. It must be valid, and must
44123 *   point to a file successfully opened by {@link gzopen}.
44124 * @param string $string The string to write.
44125 * @param int $length The number of uncompressed bytes to write. If
44126 *   supplied, writing will stop after {@link length} (uncompressed)
44127 *   bytes have been written or the end of {@link string} is reached,
44128 *   whichever comes first.
44129 * @return int Returns the number of (uncompressed) bytes written to
44130 *   the given gz-file stream.
44131 * @since PHP 4, PHP 5, PHP 7
44132 **/
44133function gzwrite($zp, $string, $length){}
44134
44135/**
44136 * Generate a hash value (message digest)
44137 *
44138 * @param string $algo Name of selected hashing algorithm (i.e. "md5",
44139 *   "sha256", "haval160,4", etc..). For a list of supported algorithms
44140 *   see {@link hash_algos}.
44141 * @param string $data Message to be hashed.
44142 * @param bool $raw_output When set to TRUE, outputs raw binary data.
44143 *   FALSE outputs lowercase hexits.
44144 * @return string Returns a string containing the calculated message
44145 *   digest as lowercase hexits unless {@link raw_output} is set to true
44146 *   in which case the raw binary representation of the message digest is
44147 *   returned.
44148 * @since PHP 5 >= 5.1.2, PHP 7, PECL hash >= 1.1
44149 **/
44150function hash($algo, $data, $raw_output){}
44151
44152/**
44153 * Return a list of registered hashing algorithms
44154 *
44155 * @return array Returns a numerically indexed array containing the
44156 *   list of supported hashing algorithms.
44157 * @since PHP 5 >= 5.1.2, PHP 7, PECL hash >= 1.1
44158 **/
44159function hash_algos(){}
44160
44161/**
44162 * Copy hashing context
44163 *
44164 * @param HashContext $context Hashing context returned by {@link
44165 *   hash_init}.
44166 * @return HashContext Returns a copy of Hashing Context.
44167 * @since PHP 5 >= 5.3.0, PHP 7
44168 **/
44169function hash_copy($context){}
44170
44171/**
44172 * Timing attack safe string comparison
44173 *
44174 * Compares two strings using the same time whether they're equal or not.
44175 *
44176 * This function should be used to mitigate timing attacks; for instance,
44177 * when testing {@link crypt} password hashes.
44178 *
44179 * @param string $known_string The string of known length to compare
44180 *   against
44181 * @param string $user_string The user-supplied string
44182 * @return bool Returns TRUE when the two strings are equal, FALSE
44183 *   otherwise.
44184 * @since PHP 5 >= 5.6.0, PHP 7
44185 **/
44186function hash_equals($known_string, $user_string){}
44187
44188/**
44189 * Generate a hash value using the contents of a given file
44190 *
44191 * @param string $algo Name of selected hashing algorithm (i.e. "md5",
44192 *   "sha256", "haval160,4", etc..). For a list of supported algorithms
44193 *   see {@link hash_algos}.
44194 * @param string $filename URL describing location of file to be
44195 *   hashed; Supports fopen wrappers.
44196 * @param bool $raw_output When set to TRUE, outputs raw binary data.
44197 *   FALSE outputs lowercase hexits.
44198 * @return string Returns a string containing the calculated message
44199 *   digest as lowercase hexits unless {@link raw_output} is set to true
44200 *   in which case the raw binary representation of the message digest is
44201 *   returned.
44202 * @since PHP 5 >= 5.1.2, PHP 7, PECL hash >= 1.1
44203 **/
44204function hash_file($algo, $filename, $raw_output){}
44205
44206/**
44207 * Finalize an incremental hash and return resulting digest
44208 *
44209 * @param HashContext $context Hashing context returned by {@link
44210 *   hash_init}.
44211 * @param bool $raw_output When set to TRUE, outputs raw binary data.
44212 *   FALSE outputs lowercase hexits.
44213 * @return string Returns a string containing the calculated message
44214 *   digest as lowercase hexits unless {@link raw_output} is set to true
44215 *   in which case the raw binary representation of the message digest is
44216 *   returned.
44217 * @since PHP 5 >= 5.1.2, PHP 7, PECL hash >= 1.1
44218 **/
44219function hash_final($context, $raw_output){}
44220
44221/**
44222 * Generate a HKDF key derivation of a supplied key input
44223 *
44224 * @param string $algo Name of selected hashing algorithm (i.e.
44225 *   "sha256", "sha512", "haval160,4", etc..) See {@link hash_algos} for
44226 *   a list of supported algorithms. Non-cryptographic hash functions are
44227 *   not allowed.
44228 * @param string $ikm Input keying material (raw binary). Cannot be
44229 *   empty.
44230 * @param int $length Desired output length in bytes. Cannot be greater
44231 *   than 255 times the chosen hash function size. If {@link length} is
44232 *   0, the output length will default to the chosen hash function size.
44233 * @param string $info Application/context-specific info string.
44234 * @param string $salt Salt to use during derivation. While optional,
44235 *   adding random salt significantly improves the strength of HKDF.
44236 * @return string Returns a string containing a raw binary
44237 *   representation of the derived key (also known as output keying
44238 *   material - OKM); or FALSE on failure.
44239 * @since PHP 7 >= 7.1.2
44240 **/
44241function hash_hkdf($algo, $ikm, $length, $info, $salt){}
44242
44243/**
44244 * Generate a keyed hash value using the HMAC method
44245 *
44246 * @param string $algo Name of selected hashing algorithm (i.e. "md5",
44247 *   "sha256", "haval160,4", etc..) See {@link hash_hmac_algos} for a
44248 *   list of supported algorithms.
44249 * @param string $data Message to be hashed.
44250 * @param string $key Shared secret key used for generating the HMAC
44251 *   variant of the message digest.
44252 * @param bool $raw_output When set to TRUE, outputs raw binary data.
44253 *   FALSE outputs lowercase hexits.
44254 * @return string Returns a string containing the calculated message
44255 *   digest as lowercase hexits unless {@link raw_output} is set to true
44256 *   in which case the raw binary representation of the message digest is
44257 *   returned. Returns FALSE when {@link algo} is unknown or is a
44258 *   non-cryptographic hash function.
44259 * @since PHP 5 >= 5.1.2, PHP 7, PECL hash >= 1.1
44260 **/
44261function hash_hmac($algo, $data, $key, $raw_output){}
44262
44263/**
44264 * Return a list of registered hashing algorithms suitable for hash_hmac
44265 *
44266 * @return array Returns a numerically indexed array containing the
44267 *   list of supported hashing algorithms suitable for {@link hash_hmac}.
44268 * @since PHP 7 >= 7.2.0
44269 **/
44270function hash_hmac_algos(){}
44271
44272/**
44273 * Generate a keyed hash value using the HMAC method and the contents of
44274 * a given file
44275 *
44276 * @param string $algo Name of selected hashing algorithm (i.e. "md5",
44277 *   "sha256", "haval160,4", etc..) See {@link hash_hmac_algos} for a
44278 *   list of supported algorithms.
44279 * @param string $filename URL describing location of file to be
44280 *   hashed; Supports fopen wrappers.
44281 * @param string $key Shared secret key used for generating the HMAC
44282 *   variant of the message digest.
44283 * @param bool $raw_output When set to TRUE, outputs raw binary data.
44284 *   FALSE outputs lowercase hexits.
44285 * @return string Returns a string containing the calculated message
44286 *   digest as lowercase hexits unless {@link raw_output} is set to true
44287 *   in which case the raw binary representation of the message digest is
44288 *   returned. Returns FALSE when {@link algo} is unknown or is a
44289 *   non-cryptographic hash function, or if the file {@link filename}
44290 *   cannot be read.
44291 * @since PHP 5 >= 5.1.2, PHP 7, PECL hash >= 1.1
44292 **/
44293function hash_hmac_file($algo, $filename, $key, $raw_output){}
44294
44295/**
44296 * Initialize an incremental hashing context
44297 *
44298 * @param string $algo Name of selected hashing algorithm (i.e. "md5",
44299 *   "sha256", "haval160,4", etc..). For a list of supported algorithms
44300 *   see {@link hash_algos}.
44301 * @param int $options Optional settings for hash generation, currently
44302 *   supports only one option: HASH_HMAC. When specified, the {@link key}
44303 *   must be specified.
44304 * @param string $key When HASH_HMAC is specified for {@link options},
44305 *   a shared secret key to be used with the HMAC hashing method must be
44306 *   supplied in this parameter.
44307 * @return HashContext Returns a Hashing Context for use with {@link
44308 *   hash_update}, {@link hash_update_stream}, {@link hash_update_file},
44309 *   and {@link hash_final}.
44310 * @since PHP 5 >= 5.1.2, PHP 7, PECL hash >= 1.1
44311 **/
44312function hash_init($algo, $options, $key){}
44313
44314/**
44315 * Generate a PBKDF2 key derivation of a supplied password
44316 *
44317 * @param string $algo Name of selected hashing algorithm (i.e. md5,
44318 *   sha256, haval160,4, etc..) See {@link hash_algos} for a list of
44319 *   supported algorithms.
44320 * @param string $password The password to use for the derivation.
44321 * @param string $salt The salt to use for the derivation. This value
44322 *   should be generated randomly.
44323 * @param int $iterations The number of internal iterations to perform
44324 *   for the derivation.
44325 * @param int $length The length of the output string. If {@link
44326 *   raw_output} is TRUE this corresponds to the byte-length of the
44327 *   derived key, if {@link raw_output} is FALSE this corresponds to
44328 *   twice the byte-length of the derived key (as every byte of the key
44329 *   is returned as two hexits). If 0 is passed, the entire output of the
44330 *   supplied algorithm is used.
44331 * @param bool $raw_output When set to TRUE, outputs raw binary data.
44332 *   FALSE outputs lowercase hexits.
44333 * @return string Returns a string containing the derived key as
44334 *   lowercase hexits unless {@link raw_output} is set to TRUE in which
44335 *   case the raw binary representation of the derived key is returned.
44336 * @since PHP 5 >= 5.5.0, PHP 7
44337 **/
44338function hash_pbkdf2($algo, $password, $salt, $iterations, $length, $raw_output){}
44339
44340/**
44341 * Pump data into an active hashing context
44342 *
44343 * @param HashContext $context Hashing context returned by {@link
44344 *   hash_init}.
44345 * @param string $data Message to be included in the hash digest.
44346 * @return bool Returns TRUE.
44347 * @since PHP 5 >= 5.1.2, PHP 7, PECL hash >= 1.1
44348 **/
44349function hash_update($context, $data){}
44350
44351/**
44352 * Pump data into an active hashing context from a file
44353 *
44354 * @param HashContext $hcontext Hashing context returned by {@link
44355 *   hash_init}.
44356 * @param string $filename URL describing location of file to be
44357 *   hashed; Supports fopen wrappers.
44358 * @param resource $scontext Stream context as returned by {@link
44359 *   stream_context_create}.
44360 * @return bool
44361 * @since PHP 5 >= 5.1.2, PHP 7, PECL hash >= 1.1
44362 **/
44363function hash_update_file($hcontext, $filename, $scontext){}
44364
44365/**
44366 * Pump data into an active hashing context from an open stream
44367 *
44368 * @param HashContext $context Hashing context returned by {@link
44369 *   hash_init}.
44370 * @param resource $handle Open file handle as returned by any stream
44371 *   creation function.
44372 * @param int $length Maximum number of characters to copy from {@link
44373 *   handle} into the hashing context.
44374 * @return int Actual number of bytes added to the hashing context from
44375 *   {@link handle}.
44376 * @since PHP 5 >= 5.1.2, PHP 7, PECL hash >= 1.1
44377 **/
44378function hash_update_stream($context, $handle, $length){}
44379
44380/**
44381 * Send a raw HTTP header
44382 *
44383 * {@link header} is used to send a raw HTTP header. See the HTTP/1.1
44384 * specification for more information on HTTP headers.
44385 *
44386 * Remember that {@link header} must be called before any actual output
44387 * is sent, either by normal HTML tags, blank lines in a file, or from
44388 * PHP. It is a very common error to read code with {@link include}, or
44389 * {@link require}, functions, or another file access function, and have
44390 * spaces or empty lines that are output before {@link header} is called.
44391 * The same problem exists when using a single PHP/HTML file.
44392 *
44393 * <html> <?php /* This will give an error. Note the output * above,
44394 * which is before the header() call * / header('Location:
44395 * http://www.example.com/'); exit; ?>
44396 *
44397 * @param string $header The header string. There are two special-case
44398 *   header calls. The first is a header that starts with the string
44399 *   "HTTP/" (case is not significant), which will be used to figure out
44400 *   the HTTP status code to send. For example, if you have configured
44401 *   Apache to use a PHP script to handle requests for missing files
44402 *   (using the ErrorDocument directive), you may want to make sure that
44403 *   your script generates the proper status code.
44404 *
44405 *   <?php header("HTTP/1.0 404 Not Found"); ?>
44406 *
44407 *   The second special case is the "Location:" header. Not only does it
44408 *   send this header back to the browser, but it also returns a REDIRECT
44409 *   (302) status code to the browser unless the 201 or a 3xx status code
44410 *   has already been set.
44411 *
44412 *   <?php header("Location: http://www.example.com/"); /* Redirect
44413 *   browser * /
44414 *
44415 *   /* Make sure that code below does not get executed when we redirect.
44416 *   * / exit; ?>
44417 * @param bool $replace The optional {@link replace} parameter
44418 *   indicates whether the header should replace a previous similar
44419 *   header, or add a second header of the same type. By default it will
44420 *   replace, but if you pass in FALSE as the second argument you can
44421 *   force multiple headers of the same type. For example:
44422 *
44423 *   <?php header('WWW-Authenticate: Negotiate');
44424 *   header('WWW-Authenticate: NTLM', false); ?>
44425 * @param int $http_response_code Forces the HTTP response code to the
44426 *   specified value. Note that this parameter only has an effect if the
44427 *   {@link header} is not empty.
44428 * @return void
44429 * @since PHP 4, PHP 5, PHP 7
44430 **/
44431function header($header, $replace, $http_response_code){}
44432
44433/**
44434 * Returns a list of response headers sent (or ready to send)
44435 *
44436 * {@link headers_list} will return a list of headers to be sent to the
44437 * browser / client. To determine whether or not these headers have been
44438 * sent yet, use {@link headers_sent}.
44439 *
44440 * @return array Returns a numerically indexed array of headers.
44441 * @since PHP 5, PHP 7
44442 **/
44443function headers_list(){}
44444
44445/**
44446 * Checks if or where headers have been sent
44447 *
44448 * You can't add any more header lines using the {@link header} function
44449 * once the header block has already been sent. Using this function you
44450 * can at least prevent getting HTTP header related error messages.
44451 * Another option is to use Output Buffering.
44452 *
44453 * @param string $file If the optional {@link file} and {@link line}
44454 *   parameters are set, {@link headers_sent} will put the PHP source
44455 *   file name and line number where output started in the {@link file}
44456 *   and {@link line} variables.
44457 * @param int $line The line number where the output started.
44458 * @return bool {@link headers_sent} will return FALSE if no HTTP
44459 *   headers have already been sent or TRUE otherwise.
44460 * @since PHP 4, PHP 5, PHP 7
44461 **/
44462function headers_sent(&$file, &$line){}
44463
44464/**
44465 * Call a header function
44466 *
44467 * Registers a function that will be called when PHP starts sending
44468 * output.
44469 *
44470 * The {@link callback} is executed just after PHP prepares all headers
44471 * to be sent, and before any other output is sent, creating a window to
44472 * manipulate the outgoing headers before being sent.
44473 *
44474 * @param callable $callback Function called just before the headers
44475 *   are sent. It gets no parameters and the return value is ignored.
44476 * @return bool
44477 * @since PHP 5 >= 5.4.0, PHP 7
44478 **/
44479function header_register_callback($callback){}
44480
44481/**
44482 * Remove previously set headers
44483 *
44484 * Removes an HTTP header previously set using {@link header}.
44485 *
44486 * @param string $name The header name to be removed.
44487 * @return void
44488 * @since PHP 5 >= 5.3.0, PHP 7
44489 **/
44490function header_remove($name){}
44491
44492/**
44493 * Convert logical Hebrew text to visual text
44494 *
44495 * Converts logical Hebrew text to visual text.
44496 *
44497 * The function tries to avoid breaking words.
44498 *
44499 * @param string $hebrew_text A Hebrew input string.
44500 * @param int $max_chars_per_line This optional parameter indicates
44501 *   maximum number of characters per line that will be returned.
44502 * @return string Returns the visual string.
44503 * @since PHP 4, PHP 5, PHP 7
44504 **/
44505function hebrev($hebrew_text, $max_chars_per_line){}
44506
44507/**
44508 * Convert logical Hebrew text to visual text with newline conversion
44509 *
44510 * This function is similar to {@link hebrev} with the difference that it
44511 * converts newlines (\n) to "<br>\n".
44512 *
44513 * The function tries to avoid breaking words.
44514 *
44515 * @param string $hebrew_text A Hebrew input string.
44516 * @param int $max_chars_per_line This optional parameter indicates
44517 *   maximum number of characters per line that will be returned.
44518 * @return string Returns the visual string.
44519 * @since PHP 4, PHP 5, PHP 7
44520 **/
44521function hebrevc($hebrew_text, $max_chars_per_line){}
44522
44523/**
44524 * Decodes a hexadecimally encoded binary string
44525 *
44526 * @param string $data Hexadecimal representation of data.
44527 * @return string Returns the binary representation of the given data .
44528 * @since PHP 5 >= 5.4.0, PHP 7
44529 **/
44530function hex2bin($data){}
44531
44532/**
44533 * Hexadecimal to decimal
44534 *
44535 * Returns the decimal equivalent of the hexadecimal number represented
44536 * by the {@link hex_string} argument. {@link hexdec} converts a
44537 * hexadecimal string to a decimal number.
44538 *
44539 * {@link hexdec} will ignore any non-hexadecimal characters it
44540 * encounters. As of PHP 7.4.0 supplying any invalid characters is
44541 * deprecated.
44542 *
44543 * @param string $hex_string The hexadecimal string to convert
44544 * @return number The decimal representation of {@link hex_string}
44545 * @since PHP 4, PHP 5, PHP 7
44546 **/
44547function hexdec($hex_string){}
44548
44549/**
44550 * Syntax highlighting of a file
44551 *
44552 * Prints out or returns a syntax highlighted version of the code
44553 * contained in {@link filename} using the colors defined in the built-in
44554 * syntax highlighter for PHP.
44555 *
44556 * Many servers are configured to automatically highlight files with a
44557 * phps extension. For example, example.phps when viewed will show the
44558 * syntax highlighted source of the file. To enable this, add this line
44559 * to the :
44560 *
44561 * @param string $filename Path to the PHP file to be highlighted.
44562 * @param bool $return Set this parameter to TRUE to make this function
44563 *   return the highlighted code.
44564 * @return mixed If {@link return} is set to TRUE, returns the
44565 *   highlighted code as a string instead of printing it out. Otherwise,
44566 *   it will return TRUE on success, FALSE on failure.
44567 * @since PHP 4, PHP 5, PHP 7
44568 **/
44569function highlight_file($filename, $return){}
44570
44571/**
44572 * Syntax highlighting of a string
44573 *
44574 * @param string $str The PHP code to be highlighted. This should
44575 *   include the opening tag.
44576 * @param bool $return Set this parameter to TRUE to make this function
44577 *   return the highlighted code.
44578 * @return mixed If {@link return} is set to TRUE, returns the
44579 *   highlighted code as a string instead of printing it out. Otherwise,
44580 *   it will return TRUE on success, FALSE on failure.
44581 * @since PHP 4, PHP 5, PHP 7
44582 **/
44583function highlight_string($str, $return){}
44584
44585/**
44586 * Get the system's high resolution time
44587 *
44588 * @param bool $get_as_number Whether the high resolution time should
44589 *   be returned as array or number.
44590 * @return mixed Returns an array of integers in the form [seconds,
44591 *   nanoseconds], if the parameter {@link get_as_number} is false.
44592 *   Otherwise the nanoseconds are returned as integer (64bit platforms)
44593 *   or float (32bit platforms).
44594 * @since PHP 7 >= 7.3.0
44595 **/
44596function hrtime($get_as_number){}
44597
44598/**
44599 * Convert all applicable characters to HTML entities
44600 *
44601 * This function is identical to {@link htmlspecialchars} in all ways,
44602 * except with {@link htmlentities}, all characters which have HTML
44603 * character entity equivalents are translated into these entities.
44604 *
44605 * If you want to decode instead (the reverse) you can use {@link
44606 * html_entity_decode}.
44607 *
44608 * @param string $string The input string.
44609 * @param int $flags A bitmask of one or more of the following flags,
44610 *   which specify how to handle quotes, invalid code unit sequences and
44611 *   the used document type. The default is ENT_COMPAT | ENT_HTML401.
44612 *   Available {@link flags} constants Constant Name Description
44613 *   ENT_COMPAT Will convert double-quotes and leave single-quotes alone.
44614 *   ENT_QUOTES Will convert both double and single quotes. ENT_NOQUOTES
44615 *   Will leave both double and single quotes unconverted. ENT_IGNORE
44616 *   Silently discard invalid code unit sequences instead of returning an
44617 *   empty string. Using this flag is discouraged as it may have security
44618 *   implications. ENT_SUBSTITUTE Replace invalid code unit sequences
44619 *   with a Unicode Replacement Character U+FFFD (UTF-8) or &#FFFD;
44620 *   (otherwise) instead of returning an empty string. ENT_DISALLOWED
44621 *   Replace invalid code points for the given document type with a
44622 *   Unicode Replacement Character U+FFFD (UTF-8) or &#FFFD; (otherwise)
44623 *   instead of leaving them as is. This may be useful, for instance, to
44624 *   ensure the well-formedness of XML documents with embedded external
44625 *   content. ENT_HTML401 Handle code as HTML 4.01. ENT_XML1 Handle code
44626 *   as XML 1. ENT_XHTML Handle code as XHTML. ENT_HTML5 Handle code as
44627 *   HTML 5.
44628 * @param string $encoding
44629 * @param bool $double_encode When {@link double_encode} is turned off
44630 *   PHP will not encode existing html entities. The default is to
44631 *   convert everything.
44632 * @return string Returns the encoded string.
44633 * @since PHP 4, PHP 5, PHP 7
44634 **/
44635function htmlentities($string, $flags, $encoding, $double_encode){}
44636
44637/**
44638 * Convert special characters to HTML entities
44639 *
44640 * Certain characters have special significance in HTML, and should be
44641 * represented by HTML entities if they are to preserve their meanings.
44642 * This function returns a string with these conversions made. If you
44643 * require all input substrings that have associated named entities to be
44644 * translated, use {@link htmlentities} instead.
44645 *
44646 * If the input string passed to this function and the final document
44647 * share the same character set, this function is sufficient to prepare
44648 * input for inclusion in most contexts of an HTML document. If, however,
44649 * the input can represent characters that are not coded in the final
44650 * document character set and you wish to retain those characters (as
44651 * numeric or named entities), both this function and {@link
44652 * htmlentities} (which only encodes substrings that have named entity
44653 * equivalents) may be insufficient. You may have to use {@link
44654 * mb_encode_numericentity} instead.
44655 *
44656 * Performed translations Character Replacement & (ampersand) &amp;
44657 * (double quote) &quot;, unless ENT_NOQUOTES is set ' (single quote)
44658 * &#039; (for ENT_HTML401) or &apos; (for ENT_XML1, ENT_XHTML or
44659 * ENT_HTML5), but only when ENT_QUOTES is set < (less than) &lt; >
44660 * (greater than) &gt;
44661 *
44662 * @param string $string The string being converted.
44663 * @param int $flags A bitmask of one or more of the following flags,
44664 *   which specify how to handle quotes, invalid code unit sequences and
44665 *   the used document type. The default is ENT_COMPAT | ENT_HTML401.
44666 *   Available {@link flags} constants Constant Name Description
44667 *   ENT_COMPAT Will convert double-quotes and leave single-quotes alone.
44668 *   ENT_QUOTES Will convert both double and single quotes. ENT_NOQUOTES
44669 *   Will leave both double and single quotes unconverted. ENT_IGNORE
44670 *   Silently discard invalid code unit sequences instead of returning an
44671 *   empty string. Using this flag is discouraged as it may have security
44672 *   implications. ENT_SUBSTITUTE Replace invalid code unit sequences
44673 *   with a Unicode Replacement Character U+FFFD (UTF-8) or &#xFFFD;
44674 *   (otherwise) instead of returning an empty string. ENT_DISALLOWED
44675 *   Replace invalid code points for the given document type with a
44676 *   Unicode Replacement Character U+FFFD (UTF-8) or &#xFFFD; (otherwise)
44677 *   instead of leaving them as is. This may be useful, for instance, to
44678 *   ensure the well-formedness of XML documents with embedded external
44679 *   content. ENT_HTML401 Handle code as HTML 4.01. ENT_XML1 Handle code
44680 *   as XML 1. ENT_XHTML Handle code as XHTML. ENT_HTML5 Handle code as
44681 *   HTML 5.
44682 * @param string $encoding For the purposes of this function, the
44683 *   encodings ISO-8859-1, ISO-8859-15, UTF-8, cp866, cp1251, cp1252, and
44684 *   KOI8-R are effectively equivalent, provided the {@link string}
44685 *   itself is valid for the encoding, as the characters affected by
44686 *   {@link htmlspecialchars} occupy the same positions in all of these
44687 *   encodings.
44688 * @param bool $double_encode When {@link double_encode} is turned off
44689 *   PHP will not encode existing html entities, the default is to
44690 *   convert everything.
44691 * @return string The converted string.
44692 * @since PHP 4, PHP 5, PHP 7
44693 **/
44694function htmlspecialchars($string, $flags, $encoding, $double_encode){}
44695
44696/**
44697 * Convert special HTML entities back to characters
44698 *
44699 * This function is the opposite of {@link htmlspecialchars}. It converts
44700 * special HTML entities back to characters.
44701 *
44702 * The converted entities are: &amp;, &quot; (when ENT_NOQUOTES is not
44703 * set), &#039; (when ENT_QUOTES is set), &lt; and &gt;.
44704 *
44705 * @param string $string The string to decode.
44706 * @param int $flags A bitmask of one or more of the following flags,
44707 *   which specify how to handle quotes and which document type to use.
44708 *   The default is ENT_COMPAT | ENT_HTML401. Available {@link flags}
44709 *   constants Constant Name Description ENT_COMPAT Will convert
44710 *   double-quotes and leave single-quotes alone. ENT_QUOTES Will convert
44711 *   both double and single quotes. ENT_NOQUOTES Will leave both double
44712 *   and single quotes unconverted. ENT_HTML401 Handle code as HTML 4.01.
44713 *   ENT_XML1 Handle code as XML 1. ENT_XHTML Handle code as XHTML.
44714 *   ENT_HTML5 Handle code as HTML 5.
44715 * @return string Returns the decoded string.
44716 * @since PHP 5 >= 5.1.0, PHP 7
44717 **/
44718function htmlspecialchars_decode($string, $flags){}
44719
44720/**
44721 * Convert HTML entities to their corresponding characters
44722 *
44723 * {@link html_entity_decode} is the opposite of {@link htmlentities} in
44724 * that it converts HTML entities in the {@link string} to their
44725 * corresponding characters.
44726 *
44727 * More precisely, this function decodes all the entities (including all
44728 * numeric entities) that a) are necessarily valid for the chosen
44729 * document type — i.e., for XML, this function does not decode named
44730 * entities that might be defined in some DTD — and b) whose character
44731 * or characters are in the coded character set associated with the
44732 * chosen encoding and are permitted in the chosen document type. All
44733 * other entities are left as is.
44734 *
44735 * @param string $string The input string.
44736 * @param int $flags A bitmask of one or more of the following flags,
44737 *   which specify how to handle quotes and which document type to use.
44738 *   The default is ENT_COMPAT | ENT_HTML401. Available {@link flags}
44739 *   constants Constant Name Description ENT_COMPAT Will convert
44740 *   double-quotes and leave single-quotes alone. ENT_QUOTES Will convert
44741 *   both double and single quotes. ENT_NOQUOTES Will leave both double
44742 *   and single quotes unconverted. ENT_HTML401 Handle code as HTML 4.01.
44743 *   ENT_XML1 Handle code as XML 1. ENT_XHTML Handle code as XHTML.
44744 *   ENT_HTML5 Handle code as HTML 5.
44745 * @param string $encoding
44746 * @return string Returns the decoded string.
44747 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
44748 **/
44749function html_entity_decode($string, $flags, $encoding){}
44750
44751/**
44752 * Generate URL-encoded query string
44753 *
44754 * Generates a URL-encoded query string from the associative (or indexed)
44755 * array provided.
44756 *
44757 * @param mixed $query_data May be an array or object containing
44758 *   properties. If {@link query_data} is an array, it may be a simple
44759 *   one-dimensional structure, or an array of arrays (which in turn may
44760 *   contain other arrays). If {@link query_data} is an object, then only
44761 *   public properties will be incorporated into the result.
44762 * @param string $numeric_prefix If numeric indices are used in the
44763 *   base array and this parameter is provided, it will be prepended to
44764 *   the numeric index for elements in the base array only. This is meant
44765 *   to allow for legal variable names when the data is decoded by PHP or
44766 *   another CGI application later on.
44767 * @param string $arg_separator arg_separator.output is used to
44768 *   separate arguments but may be overridden by specifying this
44769 *   parameter.
44770 * @param int $enc_type By default, PHP_QUERY_RFC1738. If {@link
44771 *   enc_type} is PHP_QUERY_RFC1738, then encoding is performed per RFC
44772 *   1738 and the application/x-www-form-urlencoded media type, which
44773 *   implies that spaces are encoded as plus (+) signs. If {@link
44774 *   enc_type} is PHP_QUERY_RFC3986, then encoding is performed according
44775 *   to RFC 3986, and spaces will be percent encoded (%20).
44776 * @return string Returns a URL-encoded string.
44777 * @since PHP 5, PHP 7
44778 **/
44779function http_build_query($query_data, $numeric_prefix, $arg_separator, $enc_type){}
44780
44781/**
44782 * Get or Set the HTTP response code
44783 *
44784 * Gets or sets the HTTP response status code.
44785 *
44786 * @param int $response_code The optional {@link response_code} will
44787 *   set the response code.
44788 * @return mixed If {@link response_code} is provided, then the
44789 *   previous status code will be returned. If {@link response_code} is
44790 *   not provided, then the current status code will be returned. Both of
44791 *   these values will default to a 200 status code if used in a web
44792 *   server environment.
44793 * @since PHP 5 >= 5.4.0, PHP 7
44794 **/
44795function http_response_code($response_code){}
44796
44797/**
44798 * Creates instance of class hw_api_attribute
44799 *
44800 * Creates a new instance of hw_api_attribute with the given name and
44801 * value.
44802 *
44803 * @param string $name The attribute name.
44804 * @param string $value The attribute value.
44805 * @return HW_API_Attribute Returns an instance of hw_api_attribute.
44806 * @since PHP 5 < 5.2.0
44807 **/
44808function hwapi_attribute_new($name, $value){}
44809
44810/**
44811 * Create new instance of class hw_api_content
44812 *
44813 * Creates a new content object from the string {@link content}.
44814 *
44815 * @param string $content
44816 * @param string $mimetype The mimetype for the contents.
44817 * @return HW_API_Content
44818 * @since PHP 5 < 5.2.0
44819 **/
44820function hwapi_content_new($content, $mimetype){}
44821
44822/**
44823 * Returns object of class hw_api
44824 *
44825 * Opens a connection to the Hyperwave server on host {@link hostname}.
44826 * The protocol used is HGCSP.
44827 *
44828 * @param string $hostname The host name.
44829 * @param int $port If you do not pass a port number, 418 is used.
44830 * @return HW_API Returns an instance of HW_API.
44831 * @since PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN
44832 **/
44833function hwapi_hgcsp($hostname, $port){}
44834
44835/**
44836 * Creates a new instance of class hwapi_object_new
44837 *
44838 * Creates a new instance of the class hw_api_object.
44839 *
44840 * @param array $parameter
44841 * @return hw_api_object
44842 * @since PHP 5 < 5.2.0
44843 **/
44844function hwapi_object_new($parameter){}
44845
44846/**
44847 * Calculate the length of the hypotenuse of a right-angle triangle
44848 *
44849 * {@link hypot} returns the length of the hypotenuse of a right-angle
44850 * triangle with sides of length {@link x} and {@link y}, or the distance
44851 * of the point ({@link x}, {@link y}) from the origin. This is
44852 * equivalent to sqrt(x*x + y*y).
44853 *
44854 * @param float $x Length of first side
44855 * @param float $y Length of second side
44856 * @return float Calculated length of the hypotenuse
44857 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
44858 **/
44859function hypot($x, $y){}
44860
44861/**
44862 * Add a user to a security database
44863 *
44864 * @param resource $service_handle The handle on the database server
44865 *   service.
44866 * @param string $user_name The login name of the new database user.
44867 * @param string $password The password of the new user.
44868 * @param string $first_name The first name of the new database user.
44869 * @param string $middle_name The middle name of the new database user.
44870 * @param string $last_name The last name of the new database user.
44871 * @return bool
44872 * @since PHP 5, PHP 7 < 7.4.0
44873 **/
44874function ibase_add_user($service_handle, $user_name, $password, $first_name, $middle_name, $last_name){}
44875
44876/**
44877 * Return the number of rows that were affected by the previous query
44878 *
44879 * This function returns the number of rows that were affected by the
44880 * previous query (INSERT, UPDATE or DELETE) that was executed from
44881 * within the specified transaction context.
44882 *
44883 * @param resource $link_identifier A transaction context. If {@link
44884 *   link_identifier} is a connection resource, its default transaction
44885 *   is used.
44886 * @return int Returns the number of rows as an integer.
44887 * @since PHP 5, PHP 7 < 7.4.0
44888 **/
44889function ibase_affected_rows($link_identifier){}
44890
44891/**
44892 * Initiates a backup task in the service manager and returns immediately
44893 *
44894 * This function passes the arguments to the (remote) database server.
44895 * There it starts a new backup process. Therefore you won't get any
44896 * responses.
44897 *
44898 * @param resource $service_handle A previously opened connection to
44899 *   the database server.
44900 * @param string $source_db The absolute file path to the database on
44901 *   the database server. You can also use a database alias.
44902 * @param string $dest_file The path to the backup file on the database
44903 *   server.
44904 * @param int $options Additional options to pass to the database
44905 *   server for backup. The {@link options} parameter can be a
44906 *   combination of the following constants: IBASE_BKP_IGNORE_CHECKSUMS,
44907 *   IBASE_BKP_IGNORE_LIMBO, IBASE_BKP_METADATA_ONLY,
44908 *   IBASE_BKP_NO_GARBAGE_COLLECT, IBASE_BKP_OLD_DESCRIPTIONS,
44909 *   IBASE_BKP_NON_TRANSPORTABLE or IBASE_BKP_CONVERT. Read the section
44910 *   about for further information.
44911 * @param bool $verbose Since the backup process is done on the
44912 *   database server, you don't have any chance to get its output. This
44913 *   argument is useless.
44914 * @return mixed
44915 * @since PHP 5, PHP 7 < 7.4.0
44916 **/
44917function ibase_backup($service_handle, $source_db, $dest_file, $options, $verbose){}
44918
44919/**
44920 * Add data into a newly created blob
44921 *
44922 * {@link ibase_blob_add} adds data into a blob created with {@link
44923 * ibase_blob_create}.
44924 *
44925 * @param resource $blob_handle A blob handle opened with {@link
44926 *   ibase_blob_create}.
44927 * @param string $data The data to be added.
44928 * @return void
44929 * @since PHP 5, PHP 7 < 7.4.0
44930 **/
44931function ibase_blob_add($blob_handle, $data){}
44932
44933/**
44934 * Cancel creating blob
44935 *
44936 * This function will discard a BLOB if it has not yet been closed by
44937 * {@link ibase_blob_close}.
44938 *
44939 * @param resource $blob_handle A BLOB handle opened with {@link
44940 *   ibase_blob_create}.
44941 * @return bool
44942 * @since PHP 5, PHP 7 < 7.4.0
44943 **/
44944function ibase_blob_cancel($blob_handle){}
44945
44946/**
44947 * Close blob
44948 *
44949 * This function closes a BLOB that has either been opened for reading by
44950 * {@link ibase_blob_open} or has been opened for writing by {@link
44951 * ibase_blob_create}.
44952 *
44953 * @param resource $blob_handle A BLOB handle opened with {@link
44954 *   ibase_blob_create} or {@link ibase_blob_open}.
44955 * @return mixed If the BLOB was being read, this function returns TRUE
44956 *   on success, if the BLOB was being written to, this function returns
44957 *   a string containing the BLOB id that has been assigned to it by the
44958 *   database. On failure, this function returns FALSE.
44959 * @since PHP 5, PHP 7 < 7.4.0
44960 **/
44961function ibase_blob_close($blob_handle){}
44962
44963/**
44964 * Create a new blob for adding data
44965 *
44966 * {@link ibase_blob_create} creates a new BLOB for filling with data.
44967 *
44968 * @param resource $link_identifier An InterBase link identifier. If
44969 *   omitted, the last opened link is assumed.
44970 * @return resource Returns a BLOB handle for later use with {@link
44971 *   ibase_blob_add}.
44972 * @since PHP 5, PHP 7 < 7.4.0
44973 **/
44974function ibase_blob_create($link_identifier){}
44975
44976/**
44977 * Output blob contents to browser
44978 *
44979 * This function opens a BLOB for reading and sends its contents directly
44980 * to standard output (the browser, in most cases).
44981 *
44982 * @param string $blob_id An InterBase link identifier. If omitted, the
44983 *   last opened link is assumed.
44984 * @return bool
44985 * @since PHP 5, PHP 7 < 7.4.0
44986 **/
44987function ibase_blob_echo($blob_id){}
44988
44989/**
44990 * Get len bytes data from open blob
44991 *
44992 * This function returns at most {@link len} bytes from a BLOB that has
44993 * been opened for reading by {@link ibase_blob_open}.
44994 *
44995 * @param resource $blob_handle A BLOB handle opened with {@link
44996 *   ibase_blob_open}.
44997 * @param int $len Size of returned data.
44998 * @return string Returns at most {@link len} bytes from the BLOB, or
44999 *   FALSE on failure.
45000 * @since PHP 5, PHP 7 < 7.4.0
45001 **/
45002function ibase_blob_get($blob_handle, $len){}
45003
45004/**
45005 * Create blob, copy file in it, and close it
45006 *
45007 * This function creates a BLOB, reads an entire file into it, closes it
45008 * and returns the assigned BLOB id.
45009 *
45010 * @param resource $link_identifier An InterBase link identifier. If
45011 *   omitted, the last opened link is assumed.
45012 * @param resource $file_handle The file handle is a handle returned by
45013 *   {@link fopen}.
45014 * @return string Returns the BLOB id on success, or FALSE on error.
45015 * @since PHP 5, PHP 7 < 7.4.0
45016 **/
45017function ibase_blob_import($link_identifier, $file_handle){}
45018
45019/**
45020 * Return blob length and other useful info
45021 *
45022 * Returns the BLOB length and other useful information.
45023 *
45024 * @param resource $link_identifier An InterBase link identifier. If
45025 *   omitted, the last opened link is assumed.
45026 * @param string $blob_id A BLOB id.
45027 * @return array Returns an array containing information about a BLOB.
45028 *   The information returned consists of the length of the BLOB, the
45029 *   number of segments it contains, the size of the largest segment, and
45030 *   whether it is a stream BLOB or a segmented BLOB.
45031 * @since PHP 5, PHP 7 < 7.4.0
45032 **/
45033function ibase_blob_info($link_identifier, $blob_id){}
45034
45035/**
45036 * Open blob for retrieving data parts
45037 *
45038 * Opens an existing BLOB for reading.
45039 *
45040 * @param resource $link_identifier An InterBase link identifier. If
45041 *   omitted, the last opened link is assumed.
45042 * @param string $blob_id A BLOB id.
45043 * @return resource Returns a BLOB handle for later use with {@link
45044 *   ibase_blob_get}.
45045 * @since PHP 5, PHP 7 < 7.4.0
45046 **/
45047function ibase_blob_open($link_identifier, $blob_id){}
45048
45049/**
45050 * Close a connection to an InterBase database
45051 *
45052 * Closes the link to an InterBase database that's associated with a
45053 * connection id returned from {@link ibase_connect}. Default transaction
45054 * on link is committed, other transactions are rolled back.
45055 *
45056 * @param resource $connection_id An InterBase link identifier returned
45057 *   from {@link ibase_connect}. If omitted, the last opened link is
45058 *   assumed.
45059 * @return bool
45060 * @since PHP 5, PHP 7 < 7.4.0
45061 **/
45062function ibase_close($connection_id){}
45063
45064/**
45065 * Commit a transaction
45066 *
45067 * Commits a transaction.
45068 *
45069 * @param resource $link_or_trans_identifier If called without an
45070 *   argument, this function commits the default transaction of the
45071 *   default link. If the argument is a connection identifier, the
45072 *   default transaction of the corresponding connection will be
45073 *   committed. If the argument is a transaction identifier, the
45074 *   corresponding transaction will be committed.
45075 * @return bool
45076 * @since PHP 5, PHP 7 < 7.4.0
45077 **/
45078function ibase_commit($link_or_trans_identifier){}
45079
45080/**
45081 * Commit a transaction without closing it
45082 *
45083 * Commits a transaction without closing it.
45084 *
45085 * @param resource $link_or_trans_identifier If called without an
45086 *   argument, this function commits the default transaction of the
45087 *   default link. If the argument is a connection identifier, the
45088 *   default transaction of the corresponding connection will be
45089 *   committed. If the argument is a transaction identifier, the
45090 *   corresponding transaction will be committed. The transaction context
45091 *   will be retained, so statements executed from within this
45092 *   transaction will not be invalidated.
45093 * @return bool
45094 * @since PHP 5, PHP 7 < 7.4.0
45095 **/
45096function ibase_commit_ret($link_or_trans_identifier){}
45097
45098/**
45099 * Open a connection to a database
45100 *
45101 * Establishes a connection to an Firebird/InterBase server.
45102 *
45103 * In case a second call is made to {@link ibase_connect} with the same
45104 * arguments, no new link will be established, but instead, the link
45105 * identifier of the already opened link will be returned. The link to
45106 * the server will be closed as soon as the execution of the script ends,
45107 * unless it's closed earlier by explicitly calling {@link ibase_close}.
45108 *
45109 * @param string $database The {@link database} argument has to be a
45110 *   valid path to database file on the server it resides on. If the
45111 *   server is not local, it must be prefixed with either 'hostname:'
45112 *   (TCP/IP), 'hostname/port:' (TCP/IP with interbase server on custom
45113 *   TCP port), '//hostname/' (NetBEUI), depending on the connection
45114 *   protocol used.
45115 * @param string $username The user name. Can be set with the
45116 *   ibase.default_user directive.
45117 * @param string $password The password for {@link username}. Can be
45118 *   set with the ibase.default_password directive.
45119 * @param string $charset {@link charset} is the default character set
45120 *   for a database.
45121 * @param int $buffers {@link buffers} is the number of database
45122 *   buffers to allocate for the server-side cache. If 0 or omitted,
45123 *   server chooses its own default.
45124 * @param int $dialect {@link dialect} selects the default SQL dialect
45125 *   for any statement executed within a connection, and it defaults to
45126 *   the highest one supported by client libraries.
45127 * @param string $role Functional only with InterBase 5 and up.
45128 * @param int $sync
45129 * @return resource Returns an Firebird/InterBase link identifier on
45130 *   success, or FALSE on error.
45131 * @since PHP 5, PHP 7 < 7.4.0
45132 **/
45133function ibase_connect($database, $username, $password, $charset, $buffers, $dialect, $role, $sync){}
45134
45135/**
45136 * Request statistics about a database
45137 *
45138 * @param resource $service_handle
45139 * @param string $db
45140 * @param int $action
45141 * @param int $argument
45142 * @return string
45143 * @since PHP 5, PHP 7 < 7.4.0
45144 **/
45145function ibase_db_info($service_handle, $db, $action, $argument){}
45146
45147/**
45148 * Delete a user from a security database
45149 *
45150 * @param resource $service_handle The handle on the database server
45151 *   service.
45152 * @param string $user_name The login name of the user you want to
45153 *   delete from the database.
45154 * @return bool
45155 * @since PHP 5, PHP 7 < 7.4.0
45156 **/
45157function ibase_delete_user($service_handle, $user_name){}
45158
45159/**
45160 * Drops a database
45161 *
45162 * This functions drops a database that was opened by either {@link
45163 * ibase_connect} or {@link ibase_pconnect}. The database is closed and
45164 * deleted from the server.
45165 *
45166 * @param resource $connection An InterBase link identifier. If
45167 *   omitted, the last opened link is assumed.
45168 * @return bool
45169 * @since PHP 5, PHP 7 < 7.4.0
45170 **/
45171function ibase_drop_db($connection){}
45172
45173/**
45174 * Return an error code
45175 *
45176 * Returns the error code that resulted from the most recent InterBase
45177 * function call.
45178 *
45179 * @return int Returns the error code as an integer, or FALSE if no
45180 *   error occurred.
45181 * @since PHP 5, PHP 7 < 7.4.0
45182 **/
45183function ibase_errcode(){}
45184
45185/**
45186 * Return error messages
45187 *
45188 * @return string Returns the error message as a string, or FALSE if no
45189 *   error occurred.
45190 * @since PHP 5, PHP 7 < 7.4.0
45191 **/
45192function ibase_errmsg(){}
45193
45194/**
45195 * Execute a previously prepared query
45196 *
45197 * Execute a query prepared by {@link ibase_prepare}.
45198 *
45199 * This is a lot more effective than using {@link ibase_query} if you are
45200 * repeating a same kind of query several times with only some parameters
45201 * changing.
45202 *
45203 * @param resource $query An InterBase query prepared by {@link
45204 *   ibase_prepare}.
45205 * @param mixed ...$vararg
45206 * @return resource If the query raises an error, returns FALSE. If it
45207 *   is successful and there is a (possibly empty) result set (such as
45208 *   with a SELECT query), returns a result identifier. If the query was
45209 *   successful and there were no results, returns TRUE.
45210 * @since PHP 5, PHP 7 < 7.4.0
45211 **/
45212function ibase_execute($query, ...$vararg){}
45213
45214/**
45215 * Fetch a result row from a query as an associative array
45216 *
45217 * {@link ibase_fetch_assoc} fetches one row of data from the {@link
45218 * result}. If two or more columns of the result have the same field
45219 * names, the last column will take precedence. To access the other
45220 * column(s) of the same name, you either need to access the result with
45221 * numeric indices by using {@link ibase_fetch_row} or use alias names in
45222 * your query.
45223 *
45224 * @param resource $result The result handle.
45225 * @param int $fetch_flag {@link fetch_flag} is a combination of the
45226 *   constants IBASE_TEXT and IBASE_UNIXTIME ORed together. Passing
45227 *   IBASE_TEXT will cause this function to return BLOB contents instead
45228 *   of BLOB ids. Passing IBASE_UNIXTIME will cause this function to
45229 *   return date/time values as Unix timestamps instead of as formatted
45230 *   strings.
45231 * @return array Returns an associative array that corresponds to the
45232 *   fetched row. Subsequent calls will return the next row in the result
45233 *   set, or FALSE if there are no more rows.
45234 * @since PHP 5, PHP 7 < 7.4.0
45235 **/
45236function ibase_fetch_assoc($result, $fetch_flag){}
45237
45238/**
45239 * Get an object from a InterBase database
45240 *
45241 * Fetches a row as a pseudo-object from a given result identifier.
45242 *
45243 * Subsequent calls to {@link ibase_fetch_object} return the next row in
45244 * the result set.
45245 *
45246 * @param resource $result_id An InterBase result identifier obtained
45247 *   either by {@link ibase_query} or {@link ibase_execute}.
45248 * @param int $fetch_flag {@link fetch_flag} is a combination of the
45249 *   constants IBASE_TEXT and IBASE_UNIXTIME ORed together. Passing
45250 *   IBASE_TEXT will cause this function to return BLOB contents instead
45251 *   of BLOB ids. Passing IBASE_UNIXTIME will cause this function to
45252 *   return date/time values as Unix timestamps instead of as formatted
45253 *   strings.
45254 * @return object Returns an object with the next row information, or
45255 *   FALSE if there are no more rows.
45256 * @since PHP 5, PHP 7 < 7.4.0
45257 **/
45258function ibase_fetch_object($result_id, $fetch_flag){}
45259
45260/**
45261 * Fetch a row from an InterBase database
45262 *
45263 * {@link ibase_fetch_row} fetches one row of data from the given result
45264 * set.
45265 *
45266 * Subsequent calls to {@link ibase_fetch_row} return the next row in the
45267 * result set, or FALSE if there are no more rows.
45268 *
45269 * @param resource $result_identifier An InterBase result identifier.
45270 * @param int $fetch_flag {@link fetch_flag} is a combination of the
45271 *   constants IBASE_TEXT and IBASE_UNIXTIME ORed together. Passing
45272 *   IBASE_TEXT will cause this function to return BLOB contents instead
45273 *   of BLOB ids. Passing IBASE_UNIXTIME will cause this function to
45274 *   return date/time values as Unix timestamps instead of as formatted
45275 *   strings.
45276 * @return array Returns an array that corresponds to the fetched row,
45277 *   or FALSE if there are no more rows. Each result column is stored in
45278 *   an array offset, starting at offset 0.
45279 * @since PHP 5, PHP 7 < 7.4.0
45280 **/
45281function ibase_fetch_row($result_identifier, $fetch_flag){}
45282
45283/**
45284 * Get information about a field
45285 *
45286 * Returns an array with information about a field after a select query
45287 * has been run.
45288 *
45289 * @param resource $result An InterBase result identifier.
45290 * @param int $field_number Field offset.
45291 * @return array Returns an array with the following keys: name, alias,
45292 *   relation, length and type.
45293 * @since PHP 5, PHP 7 < 7.4.0
45294 **/
45295function ibase_field_info($result, $field_number){}
45296
45297/**
45298 * Cancels a registered event handler
45299 *
45300 * This function causes the registered event handler specified by {@link
45301 * event} to be cancelled. The callback function will no longer be called
45302 * for the events it was registered to handle.
45303 *
45304 * @param resource $event An event resource, created by {@link
45305 *   ibase_set_event_handler}.
45306 * @return bool
45307 * @since PHP 5, PHP 7 < 7.4.0
45308 **/
45309function ibase_free_event_handler($event){}
45310
45311/**
45312 * Free memory allocated by a prepared query
45313 *
45314 * Frees a prepared query.
45315 *
45316 * @param resource $query A query prepared with {@link ibase_prepare}.
45317 * @return bool
45318 * @since PHP 5, PHP 7 < 7.4.0
45319 **/
45320function ibase_free_query($query){}
45321
45322/**
45323 * Free a result set
45324 *
45325 * Frees a result set.
45326 *
45327 * @param resource $result_identifier A result set created by {@link
45328 *   ibase_query} or {@link ibase_execute}.
45329 * @return bool
45330 * @since PHP 5, PHP 7 < 7.4.0
45331 **/
45332function ibase_free_result($result_identifier){}
45333
45334/**
45335 * Increments the named generator and returns its new value
45336 *
45337 * @param string $generator
45338 * @param int $increment
45339 * @param resource $link_identifier
45340 * @return mixed Returns new generator value as integer, or as string
45341 *   if the value is too big.
45342 * @since PHP 5, PHP 7 < 7.4.0
45343 **/
45344function ibase_gen_id($generator, $increment, $link_identifier){}
45345
45346/**
45347 * Execute a maintenance command on the database server
45348 *
45349 * @param resource $service_handle
45350 * @param string $db
45351 * @param int $action
45352 * @param int $argument
45353 * @return bool
45354 * @since PHP 5, PHP 7 < 7.4.0
45355 **/
45356function ibase_maintain_db($service_handle, $db, $action, $argument){}
45357
45358/**
45359 * Modify a user to a security database
45360 *
45361 * @param resource $service_handle The handle on the database server
45362 *   service.
45363 * @param string $user_name The login name of the database user to
45364 *   modify.
45365 * @param string $password The user's new password.
45366 * @param string $first_name The user's new first name.
45367 * @param string $middle_name The user's new middle name.
45368 * @param string $last_name The user's new last name.
45369 * @return bool
45370 * @since PHP 5, PHP 7 < 7.4.0
45371 **/
45372function ibase_modify_user($service_handle, $user_name, $password, $first_name, $middle_name, $last_name){}
45373
45374/**
45375 * Assigns a name to a result set
45376 *
45377 * This function assigns a name to a result set. This name can be used
45378 * later in UPDATE|DELETE ... WHERE CURRENT OF {@link name} statements.
45379 *
45380 * @param resource $result An InterBase result set.
45381 * @param string $name The name to be assigned.
45382 * @return bool
45383 * @since PHP 5, PHP 7 < 7.4.0
45384 **/
45385function ibase_name_result($result, $name){}
45386
45387/**
45388 * Get the number of fields in a result set
45389 *
45390 * @param resource $result_id An InterBase result identifier.
45391 * @return int Returns the number of fields as an integer.
45392 * @since PHP 5, PHP 7 < 7.4.0
45393 **/
45394function ibase_num_fields($result_id){}
45395
45396/**
45397 * Return the number of parameters in a prepared query
45398 *
45399 * This function returns the number of parameters in the prepared query
45400 * specified by {@link query}. This is the number of binding arguments
45401 * that must be present when calling {@link ibase_execute}.
45402 *
45403 * @param resource $query The prepared query handle.
45404 * @return int Returns the number of parameters as an integer.
45405 * @since PHP 5, PHP 7 < 7.4.0
45406 **/
45407function ibase_num_params($query){}
45408
45409/**
45410 * Return information about a parameter in a prepared query
45411 *
45412 * Returns an array with information about a parameter after a query has
45413 * been prepared.
45414 *
45415 * @param resource $query An InterBase prepared query handle.
45416 * @param int $param_number Parameter offset.
45417 * @return array Returns an array with the following keys: name, alias,
45418 *   relation, length and type.
45419 * @since PHP 5, PHP 7 < 7.4.0
45420 **/
45421function ibase_param_info($query, $param_number){}
45422
45423/**
45424 * Open a persistent connection to an InterBase database
45425 *
45426 * Opens a persistent connection to an InterBase database.
45427 *
45428 * {@link ibase_pconnect} acts very much like {@link ibase_connect} with
45429 * two major differences.
45430 *
45431 * First, when connecting, the function will first try to find a
45432 * (persistent) link that's already opened with the same parameters. If
45433 * one is found, an identifier for it will be returned instead of opening
45434 * a new connection.
45435 *
45436 * Second, the connection to the InterBase server will not be closed when
45437 * the execution of the script ends. Instead, the link will remain open
45438 * for future use ({@link ibase_close} will not close links established
45439 * by {@link ibase_pconnect}). This type of link is therefore called
45440 * 'persistent'.
45441 *
45442 * @param string $database The {@link database} argument has to be a
45443 *   valid path to database file on the server it resides on. If the
45444 *   server is not local, it must be prefixed with either 'hostname:'
45445 *   (TCP/IP), '//hostname/' (NetBEUI) or 'hostname@' (IPX/SPX),
45446 *   depending on the connection protocol used.
45447 * @param string $username The user name. Can be set with the
45448 *   ibase.default_user directive.
45449 * @param string $password The password for {@link username}. Can be
45450 *   set with the ibase.default_password directive.
45451 * @param string $charset {@link charset} is the default character set
45452 *   for a database.
45453 * @param int $buffers {@link buffers} is the number of database
45454 *   buffers to allocate for the server-side cache. If 0 or omitted,
45455 *   server chooses its own default.
45456 * @param int $dialect {@link dialect} selects the default SQL dialect
45457 *   for any statement executed within a connection, and it defaults to
45458 *   the highest one supported by client libraries. Functional only with
45459 *   InterBase 6 and up.
45460 * @param string $role Functional only with InterBase 5 and up.
45461 * @param int $sync
45462 * @return resource Returns an InterBase link identifier on success, or
45463 *   FALSE on error.
45464 * @since PHP 5, PHP 7 < 7.4.0
45465 **/
45466function ibase_pconnect($database, $username, $password, $charset, $buffers, $dialect, $role, $sync){}
45467
45468/**
45469 * Prepare a query for later binding of parameter placeholders and
45470 * execution
45471 *
45472 * @param string $query An InterBase query.
45473 * @return resource Returns a prepared query handle, or FALSE on error.
45474 * @since PHP 5, PHP 7 < 7.4.0
45475 **/
45476function ibase_prepare($query){}
45477
45478/**
45479 * Execute a query on an InterBase database
45480 *
45481 * @param resource $link_identifier An InterBase link identifier. If
45482 *   omitted, the last opened link is assumed.
45483 * @param string $query An InterBase query.
45484 * @param int $bind_args
45485 * @return resource If the query raises an error, returns FALSE. If it
45486 *   is successful and there is a (possibly empty) result set (such as
45487 *   with a SELECT query), returns a result identifier. If the query was
45488 *   successful and there were no results, returns TRUE.
45489 * @since PHP 5, PHP 7 < 7.4.0
45490 **/
45491function ibase_query($link_identifier, $query, $bind_args){}
45492
45493/**
45494 * Initiates a restore task in the service manager and returns
45495 * immediately
45496 *
45497 * This function passes the arguments to the (remote) database server.
45498 * There it starts a new restore process. Therefore you won't get any
45499 * responses.
45500 *
45501 * @param resource $service_handle A previously opened connection to
45502 *   the database server.
45503 * @param string $source_file The absolute path on the server where the
45504 *   backup file is located.
45505 * @param string $dest_db The path to create the new database on the
45506 *   server. You can also use database alias.
45507 * @param int $options Additional options to pass to the database
45508 *   server for restore. The {@link options} parameter can be a
45509 *   combination of the following constants: IBASE_RES_DEACTIVATE_IDX,
45510 *   IBASE_RES_NO_SHADOW, IBASE_RES_NO_VALIDITY, IBASE_RES_ONE_AT_A_TIME,
45511 *   IBASE_RES_REPLACE, IBASE_RES_CREATE, IBASE_RES_USE_ALL_SPACE,
45512 *   IBASE_PRP_PAGE_BUFFERS, IBASE_PRP_SWEEP_INTERVAL, IBASE_RES_CREATE.
45513 *   Read the section about for further information.
45514 * @param bool $verbose Since the restore process is done on the
45515 *   database server, you don't have any chance to get its output. This
45516 *   argument is useless.
45517 * @return mixed
45518 * @since PHP 5, PHP 7 < 7.4.0
45519 **/
45520function ibase_restore($service_handle, $source_file, $dest_db, $options, $verbose){}
45521
45522/**
45523 * Roll back a transaction
45524 *
45525 * Rolls back a transaction.
45526 *
45527 * @param resource $link_or_trans_identifier If called without an
45528 *   argument, this function rolls back the default transaction of the
45529 *   default link. If the argument is a connection identifier, the
45530 *   default transaction of the corresponding connection will be rolled
45531 *   back. If the argument is a transaction identifier, the corresponding
45532 *   transaction will be rolled back.
45533 * @return bool
45534 * @since PHP 5, PHP 7 < 7.4.0
45535 **/
45536function ibase_rollback($link_or_trans_identifier){}
45537
45538/**
45539 * Roll back a transaction without closing it
45540 *
45541 * Rolls back a transaction without closing it.
45542 *
45543 * @param resource $link_or_trans_identifier If called without an
45544 *   argument, this function rolls back the default transaction of the
45545 *   default link. If the argument is a connection identifier, the
45546 *   default transaction of the corresponding connection will be rolled
45547 *   back. If the argument is a transaction identifier, the corresponding
45548 *   transaction will be rolled back. The transaction context will be
45549 *   retained, so statements executed from within this transaction will
45550 *   not be invalidated.
45551 * @return bool
45552 * @since PHP 5, PHP 7 < 7.4.0
45553 **/
45554function ibase_rollback_ret($link_or_trans_identifier){}
45555
45556/**
45557 * Request information about a database server
45558 *
45559 * @param resource $service_handle A previously created connection to
45560 *   the database server.
45561 * @param int $action A valid constant.
45562 * @return string Returns mixed types depending on context.
45563 * @since PHP 5, PHP 7 < 7.4.0
45564 **/
45565function ibase_server_info($service_handle, $action){}
45566
45567/**
45568 * Connect to the service manager
45569 *
45570 * @param string $host The name or ip address of the database host. You
45571 *   can define the port by adding '/' and port number. If no port is
45572 *   specified, port 3050 will be used.
45573 * @param string $dba_username The name of any valid user.
45574 * @param string $dba_password The user's password.
45575 * @return resource Returns a Interbase / Firebird link identifier on
45576 *   success.
45577 * @since PHP 5, PHP 7 < 7.4.0
45578 **/
45579function ibase_service_attach($host, $dba_username, $dba_password){}
45580
45581/**
45582 * Disconnect from the service manager
45583 *
45584 * @param resource $service_handle A previously created connection to
45585 *   the database server.
45586 * @return bool
45587 * @since PHP 5, PHP 7 < 7.4.0
45588 **/
45589function ibase_service_detach($service_handle){}
45590
45591/**
45592 * Register a callback function to be called when events are posted
45593 *
45594 * This function registers a PHP user function as event handler for the
45595 * specified events.
45596 *
45597 * @param callable $event_handler The callback is called with the event
45598 *   name and the link resource as arguments whenever one of the
45599 *   specified events is posted by the database. The callback must return
45600 *   FALSE if the event handler should be canceled. Any other return
45601 *   value is ignored. This function accepts up to 15 event arguments.
45602 * @param string $event_name1 An event name.
45603 * @param string ...$vararg At most 15 events allowed.
45604 * @return resource The return value is an event resource. This
45605 *   resource can be used to free the event handler using {@link
45606 *   ibase_free_event_handler}.
45607 * @since PHP 5, PHP 7 < 7.4.0
45608 **/
45609function ibase_set_event_handler($event_handler, $event_name1, ...$vararg){}
45610
45611/**
45612 * Begin a transaction
45613 *
45614 * Begins a transaction.
45615 *
45616 * @param int $trans_args {@link trans_args} can be a combination of
45617 *   IBASE_READ, IBASE_WRITE, IBASE_COMMITTED, IBASE_CONSISTENCY,
45618 *   IBASE_CONCURRENCY, IBASE_REC_VERSION, IBASE_REC_NO_VERSION,
45619 *   IBASE_WAIT and IBASE_NOWAIT.
45620 * @param resource $link_identifier An InterBase link identifier. If
45621 *   omitted, the last opened link is assumed.
45622 * @return resource Returns a transaction handle, or FALSE on error.
45623 * @since PHP 5, PHP 7 < 7.4.0
45624 **/
45625function ibase_trans($trans_args, $link_identifier){}
45626
45627/**
45628 * Wait for an event to be posted by the database
45629 *
45630 * This function suspends execution of the script until one of the
45631 * specified events is posted by the database. The name of the event that
45632 * was posted is returned. This function accepts up to 15 event
45633 * arguments.
45634 *
45635 * @param string $event_name1 The event name.
45636 * @param string ...$vararg
45637 * @return string Returns the name of the event that was posted.
45638 * @since PHP 5, PHP 7 < 7.4.0
45639 **/
45640function ibase_wait_event($event_name1, ...$vararg){}
45641
45642/**
45643 * Convert string to requested character encoding
45644 *
45645 * Performs a character set conversion on the string {@link str} from
45646 * {@link in_charset} to {@link out_charset}.
45647 *
45648 * @param string $in_charset The input charset.
45649 * @param string $out_charset The output charset. If you append the
45650 *   string //TRANSLIT to {@link out_charset} transliteration is
45651 *   activated. This means that when a character can't be represented in
45652 *   the target charset, it can be approximated through one or several
45653 *   similarly looking characters. If you append the string //IGNORE,
45654 *   characters that cannot be represented in the target charset are
45655 *   silently discarded. Otherwise, E_NOTICE is generated and the
45656 *   function will return FALSE.
45657 * @param string $str The string to be converted.
45658 * @return string Returns the converted string.
45659 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
45660 **/
45661function iconv($in_charset, $out_charset, $str){}
45662
45663/**
45664 * Retrieve internal configuration variables of iconv extension
45665 *
45666 * @param string $type The value of the optional {@link type} can be:
45667 *   all input_encoding output_encoding internal_encoding
45668 * @return mixed Returns the current value of the internal
45669 *   configuration variable if successful.
45670 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
45671 **/
45672function iconv_get_encoding($type){}
45673
45674/**
45675 * Decodes a header field
45676 *
45677 * Decodes a MIME header field.
45678 *
45679 * @param string $encoded_header The encoded header, as a string.
45680 * @param int $mode {@link mode} determines the behaviour in the event
45681 *   {@link iconv_mime_decode} encounters a malformed MIME header field.
45682 *   You can specify any combination of the following bitmasks. Bitmasks
45683 *   acceptable to {@link iconv_mime_decode} Value Constant Description 1
45684 *   ICONV_MIME_DECODE_STRICT If set, the given header is decoded in full
45685 *   conformance with the standards defined in RFC2047. This option is
45686 *   disabled by default because there are a lot of broken mail user
45687 *   agents that don't follow the specification and don't produce correct
45688 *   MIME headers. 2 ICONV_MIME_DECODE_CONTINUE_ON_ERROR If set, {@link
45689 *   iconv_mime_decode_headers} attempts to ignore any grammatical errors
45690 *   and continue to process a given header.
45691 * @param string $charset The optional {@link charset} parameter
45692 *   specifies the character set to represent the result by. If omitted,
45693 *   iconv.internal_encoding will be used.
45694 * @return string Returns a decoded MIME field on success, or FALSE if
45695 *   an error occurs during the decoding.
45696 * @since PHP 5, PHP 7
45697 **/
45698function iconv_mime_decode($encoded_header, $mode, $charset){}
45699
45700/**
45701 * Decodes multiple header fields at once
45702 *
45703 * Decodes multiple MIME header fields at once.
45704 *
45705 * @param string $encoded_headers The encoded headers, as a string.
45706 * @param int $mode {@link mode} determines the behaviour in the event
45707 *   {@link iconv_mime_decode_headers} encounters a malformed MIME header
45708 *   field. You can specify any combination of the following bitmasks.
45709 *   Bitmasks acceptable to {@link iconv_mime_decode_headers} Value
45710 *   Constant Description 1 ICONV_MIME_DECODE_STRICT If set, the given
45711 *   header is decoded in full conformance with the standards defined in
45712 *   RFC2047. This option is disabled by default because there are a lot
45713 *   of broken mail user agents that don't follow the specification and
45714 *   don't produce correct MIME headers. 2
45715 *   ICONV_MIME_DECODE_CONTINUE_ON_ERROR If set, {@link
45716 *   iconv_mime_decode_headers} attempts to ignore any grammatical errors
45717 *   and continue to process a given header.
45718 * @param string $charset The optional {@link charset} parameter
45719 *   specifies the character set to represent the result by. If omitted,
45720 *   iconv.internal_encoding will be used.
45721 * @return array Returns an associative array that holds a whole set of
45722 *   MIME header fields specified by {@link encoded_headers} on success,
45723 *   or FALSE if an error occurs during the decoding.
45724 * @since PHP 5, PHP 7
45725 **/
45726function iconv_mime_decode_headers($encoded_headers, $mode, $charset){}
45727
45728/**
45729 * Composes a header field
45730 *
45731 * Composes and returns a string that represents a valid MIME header
45732 * field, which looks like the following:
45733 *
45734 * Subject: =?ISO-8859-1?Q?Pr=FCfung_f=FCr?= Entwerfen von einer MIME
45735 * kopfzeile
45736 *
45737 * In the above example, "Subject" is the field name and the portion that
45738 * begins with "=?ISO-8859-1?..." is the field value.
45739 *
45740 * @param string $field_name The field name.
45741 * @param string $field_value The field value.
45742 * @param array $preferences You can control the behaviour of {@link
45743 *   iconv_mime_encode} by specifying an associative array that contains
45744 *   configuration items to the optional third parameter {@link
45745 *   preferences}. The items supported by {@link iconv_mime_encode} are
45746 *   listed below. Note that item names are treated case-sensitive.
45747 *   Configuration items supported by {@link iconv_mime_encode} Item Type
45748 *   Description Default value Example scheme string Specifies the method
45749 *   to encode a field value by. The value of this item may be either "B"
45750 *   or "Q", where "B" stands for base64 encoding scheme and "Q" stands
45751 *   for quoted-printable encoding scheme. B B input-charset string
45752 *   Specifies the character set in which the first parameter {@link
45753 *   field_name} and the second parameter {@link field_value} are
45754 *   presented. If not given, {@link iconv_mime_encode} assumes those
45755 *   parameters are presented to it in the iconv.internal_encoding ini
45756 *   setting. iconv.internal_encoding ISO-8859-1 output-charset string
45757 *   Specifies the character set to use to compose the MIME header.
45758 *   iconv.internal_encoding UTF-8 line-length integer Specifies the
45759 *   maximum length of the header lines. The resulting header is "folded"
45760 *   to a set of multiple lines in case the resulting header field would
45761 *   be longer than the value of this parameter, according to RFC2822 -
45762 *   Internet Message Format. If not given, the length will be limited to
45763 *   76 characters. 76 996 line-break-chars string Specifies the sequence
45764 *   of characters to append to each line as an end-of-line sign when
45765 *   "folding" is performed on a long header field. If not given, this
45766 *   defaults to "\r\n" (CR LF). Note that this parameter is always
45767 *   treated as an ASCII string regardless of the value of input-charset.
45768 *   \r\n \n
45769 * @return string Returns an encoded MIME field on success, or FALSE if
45770 *   an error occurs during the encoding.
45771 * @since PHP 5, PHP 7
45772 **/
45773function iconv_mime_encode($field_name, $field_value, $preferences){}
45774
45775/**
45776 * Set current setting for character encoding conversion
45777 *
45778 * Changes the value of the internal configuration variable specified by
45779 * {@link type} to {@link charset}.
45780 *
45781 * @param string $type The value of {@link type} can be any one of
45782 *   these: input_encoding output_encoding internal_encoding
45783 * @param string $charset The character set.
45784 * @return bool
45785 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
45786 **/
45787function iconv_set_encoding($type, $charset){}
45788
45789/**
45790 * Returns the character count of string
45791 *
45792 * In contrast to {@link strlen}, {@link iconv_strlen} counts the
45793 * occurrences of characters in the given byte sequence {@link str} on
45794 * the basis of the specified character set, the result of which is not
45795 * necessarily identical to the length of the string in byte.
45796 *
45797 * @param string $str The string.
45798 * @param string $charset If {@link charset} parameter is omitted,
45799 *   {@link str} is assumed to be encoded in iconv.internal_encoding.
45800 * @return int Returns the character count of {@link str}, as an
45801 *   integer.
45802 * @since PHP 5, PHP 7
45803 **/
45804function iconv_strlen($str, $charset){}
45805
45806/**
45807 * Finds position of first occurrence of a needle within a haystack
45808 *
45809 * Finds position of first occurrence of a {@link needle} within a {@link
45810 * haystack}.
45811 *
45812 * In contrast to {@link strpos}, the return value of {@link
45813 * iconv_strpos} is the number of characters that appear before the
45814 * needle, rather than the offset in bytes to the position where the
45815 * needle has been found. The characters are counted on the basis of the
45816 * specified character set {@link charset}.
45817 *
45818 * @param string $haystack The entire string.
45819 * @param string $needle The searched substring.
45820 * @param int $offset The optional {@link offset} parameter specifies
45821 *   the position from which the search should be performed. If the
45822 *   offset is negative, it is counted from the end of the string.
45823 * @param string $charset If {@link charset} parameter is omitted,
45824 *   {@link string} are assumed to be encoded in iconv.internal_encoding.
45825 * @return int Returns the numeric position of the first occurrence of
45826 *   {@link needle} in {@link haystack}.
45827 * @since PHP 5, PHP 7
45828 **/
45829function iconv_strpos($haystack, $needle, $offset, $charset){}
45830
45831/**
45832 * Finds the last occurrence of a needle within a haystack
45833 *
45834 * Finds the last occurrence of a {@link needle} within a {@link
45835 * haystack}.
45836 *
45837 * In contrast to {@link strrpos}, the return value of {@link
45838 * iconv_strrpos} is the number of characters that appear before the
45839 * needle, rather than the offset in bytes to the position where the
45840 * needle has been found. The characters are counted on the basis of the
45841 * specified character set {@link charset}.
45842 *
45843 * @param string $haystack The entire string.
45844 * @param string $needle The searched substring.
45845 * @param string $charset If {@link charset} parameter is omitted,
45846 *   {@link string} are assumed to be encoded in iconv.internal_encoding.
45847 * @return int Returns the numeric position of the last occurrence of
45848 *   {@link needle} in {@link haystack}.
45849 * @since PHP 5, PHP 7
45850 **/
45851function iconv_strrpos($haystack, $needle, $charset){}
45852
45853/**
45854 * Cut out part of a string
45855 *
45856 * Cuts a portion of {@link str} specified by the {@link offset} and
45857 * {@link length} parameters.
45858 *
45859 * @param string $str The original string.
45860 * @param int $offset If {@link offset} is non-negative, {@link
45861 *   iconv_substr} cuts the portion out of {@link str} beginning at
45862 *   {@link offset}'th character, counting from zero. If {@link offset}
45863 *   is negative, {@link iconv_substr} cuts out the portion beginning at
45864 *   the position, {@link offset} characters away from the end of {@link
45865 *   str}.
45866 * @param int $length If {@link length} is given and is positive, the
45867 *   return value will contain at most {@link length} characters of the
45868 *   portion that begins at {@link offset} (depending on the length of
45869 *   {@link string}). If negative {@link length} is passed, {@link
45870 *   iconv_substr} cuts the portion out of {@link str} from the {@link
45871 *   offset}'th character up to the character that is {@link length}
45872 *   characters away from the end of the string. In case {@link offset}
45873 *   is also negative, the start position is calculated beforehand
45874 *   according to the rule explained above.
45875 * @param string $charset If {@link charset} parameter is omitted,
45876 *   {@link string} are assumed to be encoded in iconv.internal_encoding.
45877 *   Note that {@link offset} and {@link length} parameters are always
45878 *   deemed to represent offsets that are calculated on the basis of the
45879 *   character set determined by {@link charset}, whilst the counterpart
45880 *   {@link substr} always takes these for byte offsets.
45881 * @return string Returns the portion of {@link str} specified by the
45882 *   {@link offset} and {@link length} parameters.
45883 * @since PHP 5, PHP 7
45884 **/
45885function iconv_substr($str, $offset, $length, $charset){}
45886
45887/**
45888 * Get the long name of an ID3v2 frame
45889 *
45890 * {@link id3_get_frame_long_name} returns the long name for an ID3v2
45891 * frame.
45892 *
45893 * @param string $frameId An ID3v2 frame
45894 * @return string Returns the frame long name or FALSE on errors.
45895 * @since PECL id3 >= 0.2
45896 **/
45897function id3_get_frame_long_name($frameId){}
45898
45899/**
45900 * Get the short name of an ID3v2 frame
45901 *
45902 * {@link id3_get_frame_short_name} returns the short name for an ID3v2
45903 * frame.
45904 *
45905 * @param string $frameId An ID3v2 frame
45906 * @return string Returns the frame short name or FALSE on errors.
45907 * @since PECL id3 >= 0.2
45908 **/
45909function id3_get_frame_short_name($frameId){}
45910
45911/**
45912 * Get the id for a genre
45913 *
45914 * {@link id3_get_genre_id} returns the id for a genre.
45915 *
45916 * @param string $genre Genre name as string.
45917 * @return int The genre id or FALSE on errors.
45918 * @since PECL id3 >= 0.1
45919 **/
45920function id3_get_genre_id($genre){}
45921
45922/**
45923 * Get all possible genre values
45924 *
45925 * {@link id3_get_genre_list} returns an array containing all possible
45926 * genres that may be stored in an ID3 tag. This list has been created by
45927 * Eric Kemp and later extended by WinAmp.
45928 *
45929 * This function is useful to provide you users a list of genres from
45930 * which they may choose one. When updating the ID3 tag you will always
45931 * have to specify the genre as an integer ranging from 0 to 147.
45932 *
45933 * @return array Returns an array containing all possible genres that
45934 *   may be stored in an ID3 tag.
45935 * @since PECL id3 >= 0.1
45936 **/
45937function id3_get_genre_list(){}
45938
45939/**
45940 * Get the name for a genre id
45941 *
45942 * {@link id3_get_genre_name} returns the name for a genre id.
45943 *
45944 * @param int $genre_id An integer ranging from 0 to 147
45945 * @return string Returns the name as a string.
45946 * @since PECL id3 >= 0.1
45947 **/
45948function id3_get_genre_name($genre_id){}
45949
45950/**
45951 * Get all information stored in an ID3 tag
45952 *
45953 * {@link id3_get_tag} is used to get all information stored in the id3
45954 * tag of the specified file.
45955 *
45956 * @param string $filename The path to the MP3 file Instead of a
45957 *   filename you may also pass a valid stream resource
45958 * @param int $version Allows you to specify the version of the tag as
45959 *   MP3 files may contain both, version 1.x and version 2.x tags Since
45960 *   version 0.2 {@link id3_get_tag} also supports ID3 tags of version
45961 *   2.2, 2.3 and 2.4. To extract information from these tags, pass one
45962 *   of the constants ID3_V2_2, ID3_V2_3 or ID3_V2_4 as the second
45963 *   parameter. ID3 v2.x tags can contain a lot more information about
45964 *   the MP3 file than ID3 v1.x tags.
45965 * @return array Returns an associative array with various keys like:
45966 *   title, artist, ..
45967 * @since PECL id3 >= 0.1
45968 **/
45969function id3_get_tag($filename, $version){}
45970
45971/**
45972 * Get version of an ID3 tag
45973 *
45974 * {@link id3_get_version} retrieves the version(s) of the ID3 tag(s) in
45975 * the MP3 file.
45976 *
45977 * If a file contains an ID3 v1.1 tag, it always contains a 1.0 tag, as
45978 * version 1.1 is just an extension of 1.0.
45979 *
45980 * @param string $filename The path to the MP3 file Instead of a
45981 *   filename you may also pass a valid stream resource
45982 * @return int Returns the version number of the ID3 tag of the file.
45983 *   As a tag can contain ID3 v1.x and v2.x tags, the return value of
45984 *   this function should be bitwise compared with the predefined
45985 *   constants ID3_V1_0, ID3_V1_1 and ID3_V2.
45986 * @since PECL id3 >= 0.1
45987 **/
45988function id3_get_version($filename){}
45989
45990/**
45991 * Remove an existing ID3 tag
45992 *
45993 * {@link id3_remove_tag} is used to remove the information stored of an
45994 * ID3 tag.
45995 *
45996 * @param string $filename The path to the MP3 file Instead of a
45997 *   filename you may also pass a valid stream resource
45998 * @param int $version Allows you to specify the version of the tag as
45999 *   MP3 files may contain both, version 1.x and version 2.x tags.
46000 * @return bool
46001 * @since PECL id3 >= 0.1
46002 **/
46003function id3_remove_tag($filename, $version){}
46004
46005/**
46006 * Update information stored in an ID3 tag
46007 *
46008 * {@link id3_set_tag} is used to change the information stored of an ID3
46009 * tag. If no tag has been present, it will be added to the file.
46010 *
46011 * @param string $filename The path to the MP3 file Instead of a
46012 *   filename you may also pass a valid stream resource
46013 * @param array $tag An associative array of tag keys and values The
46014 *   following keys may be used in the associative array:
46015 *
46016 *   Keys in the associative array key possible value available in
46017 *   version title string with maximum of 30 characters v1.0, v1.1 artist
46018 *   string with maximum of 30 characters v1.0, v1.1 album string with
46019 *   maximum of 30 characters v1.0, v1.1 year 4 digits v1.0, v1.1 genre
46020 *   integer value between 0 and 147 v1.0, v1.1 comment string with
46021 *   maximum of 30 characters (28 in v1.1) v1.0, v1.1 track integer
46022 *   between 0 and 255 v1.1
46023 * @param int $version Allows you to specify the version of the tag as
46024 *   MP3 files may contain both, version 1.x and version 2.x tags
46025 * @return bool
46026 * @since PECL id3 >= 0.1
46027 **/
46028function id3_set_tag($filename, $tag, $version){}
46029
46030/**
46031 * Format a local time/date as integer
46032 *
46033 * Returns a number formatted according to the given format string using
46034 * the given integer {@link timestamp} or the current local time if no
46035 * timestamp is given. In other words, {@link timestamp} is optional and
46036 * defaults to the value of {@link time}.
46037 *
46038 * Unlike the function {@link date}, {@link idate} accepts just one char
46039 * in the {@link format} parameter.
46040 *
46041 * @param string $format The following characters are recognized in the
46042 *   {@link format} parameter string {@link format} character Description
46043 *   B Swatch Beat/Internet Time d Day of the month h Hour (12 hour
46044 *   format) H Hour (24 hour format) i Minutes I (uppercase i) returns 1
46045 *   if DST is activated, 0 otherwise L (uppercase l) returns 1 for leap
46046 *   year, 0 otherwise m Month number s Seconds t Days in current month U
46047 *   Seconds since the Unix Epoch - January 1 1970 00:00:00 UTC - this is
46048 *   the same as {@link time} w Day of the week (0 on Sunday) W ISO-8601
46049 *   week number of year, weeks starting on Monday y Year (1 or 2 digits
46050 *   - check note below) Y Year (4 digits) z Day of the year Z Timezone
46051 *   offset in seconds
46052 * @param int $timestamp
46053 * @return int Returns an integer.
46054 * @since PHP 5, PHP 7
46055 **/
46056function idate($format, $timestamp){}
46057
46058/**
46059 * Convert domain name to IDNA ASCII form
46060 *
46061 * This function converts a Unicode domain name to an IDNA
46062 * ASCII-compatible format.
46063 *
46064 * @param string $domain The domain to convert, which must be UTF-8
46065 *   encoded.
46066 * @param int $options Conversion options - combination of IDNA_*
46067 *   constants (except IDNA_ERROR_* constants).
46068 * @param int $variant Either INTL_IDNA_VARIANT_2003 (deprecated as of
46069 *   PHP 7.2.0) for IDNA 2003 or INTL_IDNA_VARIANT_UTS46 (only available
46070 *   as of ICU 4.6) for UTS #46.
46071 * @param array $idna_info This parameter can be used only if
46072 *   INTL_IDNA_VARIANT_UTS46 was used for {@link variant}. In that case,
46073 *   it will be filled with an array with the keys 'result', the possibly
46074 *   illegal result of the transformation, 'isTransitionalDifferent', a
46075 *   boolean indicating whether the usage of the transitional mechanisms
46076 *   of UTS #46 either has or would have changed the result and 'errors',
46077 *   which is an int representing a bitset of the error constants
46078 *   IDNA_ERROR_*.
46079 * @return string The domain name encoded in ASCII-compatible form,
46080 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.2, PECL idn >= 0.1
46081 **/
46082function idn_to_ascii($domain, $options, $variant, &$idna_info){}
46083
46084/**
46085 * Convert domain name from IDNA ASCII to Unicode
46086 *
46087 * This function converts a Unicode domain name from an IDNA
46088 * ASCII-compatible format to plain Unicode, encoded in UTF-8.
46089 *
46090 * @param string $domain Domain to convert in an IDNA ASCII-compatible
46091 *   format.
46092 * @param int $options Conversion options - combination of IDNA_*
46093 *   constants (except IDNA_ERROR_* constants).
46094 * @param int $variant Either INTL_IDNA_VARIANT_2003 (deprecated as of
46095 *   PHP 7.2.0) for IDNA 2003 or INTL_IDNA_VARIANT_UTS46 (only available
46096 *   as of ICU 4.6) for UTS #46.
46097 * @param array $idna_info This parameter can be used only if
46098 *   INTL_IDNA_VARIANT_UTS46 was used for {@link variant}. In that case,
46099 *   it will be filled with an array with the keys 'result', the possibly
46100 *   illegal result of the transformation, 'isTransitionalDifferent', a
46101 *   boolean indicating whether the usage of the transitional mechanisms
46102 *   of UTS #46 either has or would have changed the result and 'errors',
46103 *   which is an int representing a bitset of the error constants
46104 *   IDNA_ERROR_*.
46105 * @return string The domain name in Unicode, encoded in UTF-8,
46106 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.2, PECL idn >= 0.1
46107 **/
46108function idn_to_utf8($domain, $options, $variant, &$idna_info){}
46109
46110/**
46111 * Deletes the slob object
46112 *
46113 * Deletes the slob object on the given slob object-id {@link bid}.
46114 *
46115 * @param int $bid An existing slob id.
46116 * @return bool
46117 * @since PHP 4, PHP 5 < 5.2.1
46118 **/
46119function ifxus_close_slob($bid){}
46120
46121/**
46122 * Creates an slob object and opens it
46123 *
46124 * @param int $mode A combination of IFX_LO_RDONLY, IFX_LO_WRONLY,
46125 *   IFX_LO_APPEND IFX_LO_RDWR, IFX_LO_BUFFER, IFX_LO_NOBUFFER.
46126 * @return int Return the new slob object-id, or FALSE on errors.
46127 * @since PHP 4, PHP 5 < 5.2.1
46128 **/
46129function ifxus_create_slob($mode){}
46130
46131/**
46132 * Deletes the slob object
46133 *
46134 * @param int $bid An existing slob id.
46135 * @return bool
46136 * @since PHP 4, PHP 5 < 5.2.1
46137 **/
46138function ifxus_free_slob($bid){}
46139
46140/**
46141 * Opens an slob object
46142 *
46143 * Opens an slob object. {@link bid} should be an existing slob id.
46144 *
46145 * @param int $bid An existing slob id.
46146 * @param int $mode A combination of IFX_LO_RDONLY, IFX_LO_WRONLY,
46147 *   IFX_LO_APPEND IFX_LO_RDWR, IFX_LO_BUFFER, IFX_LO_NOBUFFER.
46148 * @return int Returns the new slob object-id, or FALSE on errors.
46149 * @since PHP 4, PHP 5 < 5.2.1
46150 **/
46151function ifxus_open_slob($bid, $mode){}
46152
46153/**
46154 * Reads nbytes of the slob object
46155 *
46156 * Reads {@link nbytes} of the slob object.
46157 *
46158 * @param int $bid An existing slob id.
46159 * @param int $nbytes The number of bytes to read.
46160 * @return string Returns the slob contents as a string, or FALSE on
46161 *   errors.
46162 * @since PHP 4, PHP 5 < 5.2.1
46163 **/
46164function ifxus_read_slob($bid, $nbytes){}
46165
46166/**
46167 * Sets the current file or seek position
46168 *
46169 * Sets the current file or seek position of an open slob object.
46170 *
46171 * @param int $bid An existing slob id.
46172 * @param int $mode 0 = LO_SEEK_SET, 1 = LO_SEEK_CUR, 2 = LO_SEEK_END.
46173 * @param int $offset A byte offset.
46174 * @return int Returns the seek position as an integer, or FALSE on
46175 *   errors.
46176 * @since PHP 4, PHP 5 < 5.2.1
46177 **/
46178function ifxus_seek_slob($bid, $mode, $offset){}
46179
46180/**
46181 * Returns the current file or seek position
46182 *
46183 * Returns the current file or seek position of an open slob object
46184 *
46185 * @param int $bid An existing slob id.
46186 * @return int Returns the seek position as an integer, or FALSE on
46187 *   errors.
46188 * @since PHP 4, PHP 5 < 5.2.1
46189 **/
46190function ifxus_tell_slob($bid){}
46191
46192/**
46193 * Writes a string into the slob object
46194 *
46195 * @param int $bid An existing slob id.
46196 * @param string $content The content to write, as a string.
46197 * @return int Returns the bytes written as an integer, or FALSE on
46198 *   errors.
46199 * @since PHP 4, PHP 5 < 5.2.1
46200 **/
46201function ifxus_write_slob($bid, $content){}
46202
46203/**
46204 * Get number of rows affected by a query
46205 *
46206 * Returns the number of rows affected by a query associated with {@link
46207 * result_id}.
46208 *
46209 * For inserts, updates and deletes the number is the real number
46210 * (sqlerrd[2]) of affected rows. For selects it is an estimate
46211 * (sqlerrd[0]). Don't rely on it. The database server can never return
46212 * the actual number of rows that will be returned by a SELECT because it
46213 * has not even begun fetching them at this stage (just after the
46214 * "PREPARE" when the optimizer has determined the query plan).
46215 *
46216 * Useful after {@link ifx_prepare} to limit queries to reasonable result
46217 * sets.
46218 *
46219 * @param resource $result_id A valid result id returned by {@link
46220 *   ifx_query} or {@link ifx_prepare}.
46221 * @return int Returns the number of rows as an integer.
46222 * @since PHP 4, PHP 5 < 5.2.1
46223 **/
46224function ifx_affected_rows($result_id){}
46225
46226/**
46227 * Set the default blob mode for all select queries
46228 *
46229 * @param int $mode Mode "0" means save Byte-Blobs in memory, and mode
46230 *   "1" means save Byte-Blobs in a file.
46231 * @return bool
46232 * @since PHP 4, PHP 5 < 5.2.1
46233 **/
46234function ifx_blobinfile_mode($mode){}
46235
46236/**
46237 * Set the default byte mode
46238 *
46239 * Sets the default byte mode for all select-queries.
46240 *
46241 * @param int $mode Mode "0" will return a blob id, and mode "1" will
46242 *   return a varchar with text content.
46243 * @return bool
46244 * @since PHP 4, PHP 5 < 5.2.1
46245 **/
46246function ifx_byteasvarchar($mode){}
46247
46248/**
46249 * Close Informix connection
46250 *
46251 * {@link ifx_close} closes the link to an Informix database that's
46252 * associated with the specified link identifier.
46253 *
46254 * Note that this isn't usually necessary, as non-persistent open links
46255 * are automatically closed at the end of the script's execution.
46256 *
46257 * {@link ifx_close} will not close persistent links generated by {@link
46258 * ifx_pconnect}.
46259 *
46260 * @param resource $link_identifier The link identifier. If not
46261 *   specified, the last opened link is assumed.
46262 * @return bool
46263 * @since PHP 4, PHP 5 < 5.2.1
46264 **/
46265function ifx_close($link_identifier){}
46266
46267/**
46268 * Open Informix server connection
46269 *
46270 * {@link ifx_connect} establishes a connection to an Informix server.
46271 *
46272 * In case a second call is made to {@link ifx_connect} with the same
46273 * arguments, no new link will be established, but instead, the link
46274 * identifier of the already opened link will be returned.
46275 *
46276 * The link to the server will be closed as soon as the execution of the
46277 * script ends, unless it's closed earlier by explicitly calling {@link
46278 * ifx_close}.
46279 *
46280 * @param string $database The database name, as a string.
46281 * @param string $userid The username, as a string.
46282 * @param string $password The password, as a string.
46283 * @return resource Returns a connection identifier on success, or
46284 *   FALSE on error.
46285 * @since PHP 4, PHP 5 < 5.2.1
46286 **/
46287function ifx_connect($database, $userid, $password){}
46288
46289/**
46290 * Duplicates the given blob object
46291 *
46292 * @param int $bid A BLOB identifier.
46293 * @return int Returns the new blob object-id, or FALSE on errors.
46294 * @since PHP 4, PHP 5 < 5.2.1
46295 **/
46296function ifx_copy_blob($bid){}
46297
46298/**
46299 * Creates an blob object
46300 *
46301 * Creates a blob object.
46302 *
46303 * @param int $type 1 = TEXT, 0 = BYTE
46304 * @param int $mode 0 = blob-object holds the content in memory, 1 =
46305 *   blob-object holds the content in file.
46306 * @param string $param if mode = 0: pointer to the content, if mode =
46307 *   1: pointer to the filestring.
46308 * @return int Returns the new BLOB object-id, or FALSE on errors.
46309 * @since PHP 4, PHP 5 < 5.2.1
46310 **/
46311function ifx_create_blob($type, $mode, $param){}
46312
46313/**
46314 * Creates an char object
46315 *
46316 * @param string $param The char content.
46317 * @return int Returns the new char object id, or FALSE on errors.
46318 * @since PHP 4, PHP 5 < 5.2.1
46319 **/
46320function ifx_create_char($param){}
46321
46322/**
46323 * Execute a previously prepared SQL-statement
46324 *
46325 * Executes a previously prepared query or opens a cursor for it.
46326 *
46327 * Does NOT free {@link result_id} on error.
46328 *
46329 * Also sets the real number of {@link ifx_affected_rows} for non-select
46330 * statements for retrieval by {@link ifx_affected_rows}.
46331 *
46332 * @param resource $result_id {@link result_id} is a valid resultid
46333 *   returned by {@link ifx_query} or {@link ifx_prepare} (select type
46334 *   queries only!).
46335 * @return bool
46336 * @since PHP 4, PHP 5 < 5.2.1
46337 **/
46338function ifx_do($result_id){}
46339
46340/**
46341 * Returns error code of last Informix call
46342 *
46343 * Returns in a string one character describing the general results of a
46344 * statement and both SQLSTATE and SQLCODE associated with the most
46345 * recent SQL statement executed.
46346 *
46347 * @param resource $link_identifier The link identifier.
46348 * @return string The Informix error codes (SQLSTATE & SQLCODE)
46349 *   formatted as x [SQLSTATE = aa bbb SQLCODE=cccc].
46350 * @since PHP 4, PHP 5 < 5.2.1
46351 **/
46352function ifx_error($link_identifier){}
46353
46354/**
46355 * Returns error message of last Informix call
46356 *
46357 * Returns the Informix error message associated with the most recent
46358 * Informix error.
46359 *
46360 * @param int $errorcode If specified, the function will return the
46361 *   message corresponding to the specified code.
46362 * @return string Return the error message, as a string.
46363 * @since PHP 4, PHP 5 < 5.2.1
46364 **/
46365function ifx_errormsg($errorcode){}
46366
46367/**
46368 * Get row as an associative array
46369 *
46370 * Fetches one row of data from the result associated with the specified
46371 * result identifier.
46372 *
46373 * Subsequent calls to {@link ifx_fetch_row} would return the next row in
46374 * the result set, or FALSE if there are no more rows.
46375 *
46376 * @param resource $result_id {@link result_id} is a valid resultid
46377 *   returned by {@link ifx_query} or {@link ifx_prepare} (select type
46378 *   queries only!).
46379 * @param mixed $position An optional parameter for a "fetch" operation
46380 *   on "scroll" cursors: NEXT, PREVIOUS, CURRENT, FIRST, LAST or a
46381 *   number. If you specify a number, an "absolute" row fetch is
46382 *   executed. This parameter is optional, and only valid for SCROLL
46383 *   cursors.
46384 * @return array Returns an associative array that corresponds to the
46385 *   fetched row, or FALSE if there are no more rows.
46386 * @since PHP 4, PHP 5 < 5.2.1
46387 **/
46388function ifx_fetch_row($result_id, $position){}
46389
46390/**
46391 * List of SQL fieldproperties
46392 *
46393 * Returns the Informix SQL fieldproperties of every field in the query
46394 * as an associative array. Properties are encoded as:
46395 * "SQLTYPE;length;precision;scale;ISNULLABLE" where SQLTYPE = the
46396 * Informix type like "SQLVCHAR" etc. and ISNULLABLE = "Y" or "N".
46397 *
46398 * @param resource $result_id {@link result_id} is a valid resultid
46399 *   returned by {@link ifx_query} or {@link ifx_prepare} (select type
46400 *   queries only!).
46401 * @return array Returns an associative array with fieldnames as key
46402 *   and the SQL fieldproperties as data for a query with {@link
46403 *   result_id}. Returns FALSE on errors.
46404 * @since PHP 4, PHP 5 < 5.2.1
46405 **/
46406function ifx_fieldproperties($result_id){}
46407
46408/**
46409 * List of Informix SQL fields
46410 *
46411 * Returns an associative array with fieldnames as key and the SQL
46412 * fieldtypes as data for the query associated with {@link result_id}.
46413 *
46414 * @param resource $result_id {@link result_id} is a valid resultid
46415 *   returned by {@link ifx_query} or {@link ifx_prepare} (select type
46416 *   queries only!).
46417 * @return array Returns an associative array with fieldnames as key
46418 *   and the SQL fieldtypes as data for query with {@link result_id}.
46419 *   Returns FALSE on error.
46420 * @since PHP 4, PHP 5 < 5.2.1
46421 **/
46422function ifx_fieldtypes($result_id){}
46423
46424/**
46425 * Deletes the blob object
46426 *
46427 * Deletes the blobobject for the given blob object-id.
46428 *
46429 * @param int $bid The BLOB object id.
46430 * @return bool
46431 * @since PHP 4, PHP 5 < 5.2.1
46432 **/
46433function ifx_free_blob($bid){}
46434
46435/**
46436 * Deletes the char object
46437 *
46438 * Deletes the charobject for the given char object-id.
46439 *
46440 * @param int $bid The char object id.
46441 * @return bool
46442 * @since PHP 4, PHP 5 < 5.2.1
46443 **/
46444function ifx_free_char($bid){}
46445
46446/**
46447 * Releases resources for the query
46448 *
46449 * Releases resources for the query associated with {@link result_id}.
46450 *
46451 * @param resource $result_id {@link result_id} is a valid resultid
46452 *   returned by {@link ifx_query} or {@link ifx_prepare} (select type
46453 *   queries only!).
46454 * @return bool
46455 * @since PHP 4, PHP 5 < 5.2.1
46456 **/
46457function ifx_free_result($result_id){}
46458
46459/**
46460 * Get the contents of sqlca.sqlerrd[0..5] after a query
46461 *
46462 * Returns a pseudo-row with sqlca.sqlerrd[0] ... sqlca.sqlerrd[5] after
46463 * the query associated with {@link result_id}.
46464 *
46465 * For inserts, updates and deletes the values returned are those as set
46466 * by the server after executing the query. This gives access to the
46467 * number of affected rows and the serial insert value. For SELECTs the
46468 * values are those saved after the PREPARE statement. This gives access
46469 * to the *estimated* number of affected rows. The use of this function
46470 * saves the overhead of executing a SELECT dbinfo('sqlca.sqlerrdx')
46471 * query, as it retrieves the values that were saved by the ifx driver at
46472 * the appropriate moment.
46473 *
46474 * @param resource $result_id {@link result_id} is a valid result id
46475 *   returned by {@link ifx_query} or {@link ifx_prepare} (select type
46476 *   queries only!).
46477 * @return array Returns an associative array with the following
46478 *   entries: sqlerrd0, sqlerrd1, sqlerrd2, sqlerrd3, sqlerrd4 and
46479 *   sqlerrd5.
46480 * @since PHP 4, PHP 5 < 5.2.1
46481 **/
46482function ifx_getsqlca($result_id){}
46483
46484/**
46485 * Return the content of a blob object
46486 *
46487 * Returns the content of the blob object.
46488 *
46489 * @param int $bid The BLOB object id.
46490 * @return string The contents of the BLOB as a string, or FALSE on
46491 *   errors.
46492 * @since PHP 4, PHP 5 < 5.2.1
46493 **/
46494function ifx_get_blob($bid){}
46495
46496/**
46497 * Return the content of the char object
46498 *
46499 * Returns the content of the char object.
46500 *
46501 * @param int $bid The char object-id.
46502 * @return string Returns the contents as a string, or FALSE on errors.
46503 * @since PHP 4, PHP 5 < 5.2.1
46504 **/
46505function ifx_get_char($bid){}
46506
46507/**
46508 * Formats all rows of a query into a HTML table
46509 *
46510 * Formats and prints all rows of the {@link result_id} query into a HTML
46511 * table.
46512 *
46513 * @param resource $result_id {@link result_id} is a valid resultid
46514 *   returned by {@link ifx_query} or {@link ifx_prepare} (select type
46515 *   queries only!).
46516 * @param string $html_table_options This optional argument is a string
46517 *   of <table> tag options.
46518 * @return int Returns the number of fetched rows, or FALSE on errors.
46519 * @since PHP 4, PHP 5 < 5.2.1
46520 **/
46521function ifx_htmltbl_result($result_id, $html_table_options){}
46522
46523/**
46524 * Sets the default return value on a fetch row
46525 *
46526 * Sets the default return value of a NULL-value on a fetch row.
46527 *
46528 * @param int $mode Mode "0" returns "", and mode "1" returns "NULL".
46529 * @return bool
46530 * @since PHP 4, PHP 5 < 5.2.1
46531 **/
46532function ifx_nullformat($mode){}
46533
46534/**
46535 * Returns the number of columns in the query
46536 *
46537 * After preparing or executing a query, this call gives you the number
46538 * of columns in the query.
46539 *
46540 * @param resource $result_id {@link result_id} is a valid resultid
46541 *   returned by {@link ifx_query} or {@link ifx_prepare} (select type
46542 *   queries only!).
46543 * @return int Returns the number of columns in query for {@link
46544 *   result_id}, or FALSE on errors.
46545 * @since PHP 4, PHP 5 < 5.2.1
46546 **/
46547function ifx_num_fields($result_id){}
46548
46549/**
46550 * Count the rows already fetched from a query
46551 *
46552 * Gives the number of rows fetched so far for a query with {@link
46553 * result_id} after a {@link ifx_query} or {@link ifx_do} query.
46554 *
46555 * @param resource $result_id {@link result_id} is a valid resultid
46556 *   returned by {@link ifx_query} or {@link ifx_prepare} (select type
46557 *   queries only!).
46558 * @return int Returns the number of fetched rows or FALSE on errors.
46559 * @since PHP 4, PHP 5 < 5.2.1
46560 **/
46561function ifx_num_rows($result_id){}
46562
46563/**
46564 * Open persistent Informix connection
46565 *
46566 * {@link ifx_pconnect} acts very much like {@link ifx_connect} with two
46567 * major differences.
46568 *
46569 * First, when connecting, the function would first try to find a
46570 * (persistent) link that's already open with the same host, username and
46571 * password. If one is found, an identifier for it will be returned
46572 * instead of opening a new connection.
46573 *
46574 * Second, the connection to the SQL server will not be closed when the
46575 * execution of the script ends. Instead, the link will remain open for
46576 * future use ({@link ifx_close} will not close links established by
46577 * {@link ifx_pconnect}).
46578 *
46579 * This type of links is therefore called 'persistent'.
46580 *
46581 * @param string $database The database name, as a string.
46582 * @param string $userid The username, as a string.
46583 * @param string $password The password, as a string.
46584 * @return resource Returns: valid Informix persistent link identifier
46585 *   on success, or FALSE on errors.
46586 * @since PHP 4, PHP 5 < 5.2.1
46587 **/
46588function ifx_pconnect($database, $userid, $password){}
46589
46590/**
46591 * Prepare an SQL-statement for execution
46592 *
46593 * Prepares a {@link query} for later use with {@link ifx_do}.
46594 *
46595 * For "select-type" queries a cursor is declared and opened. Non-select
46596 * queries are "execute immediate".
46597 *
46598 * For either query type the number of (estimated or real) affected rows
46599 * is saved for retrieval by {@link ifx_affected_rows}.
46600 *
46601 * If the contents of the TEXT (or BYTE) column allow it, you can also
46602 * use ifx_textasvarchar(1) and ifx_byteasvarchar(1). This allows you to
46603 * treat TEXT (or BYTE) columns just as if they were ordinary (but long)
46604 * VARCHAR columns for select queries, and you don't need to bother with
46605 * blob id's.
46606 *
46607 * With ifx_textasvarchar(0) or ifx_byteasvarchar(0) (the default
46608 * situation), select queries will return BLOB columns as blob id's
46609 * (integer value). You can get the value of the blob as a string or file
46610 * with the blob functions (see below).
46611 *
46612 * @param string $query The query string.
46613 * @param resource $link_identifier The link identifier.
46614 * @param int $cursor_def This optional parameter allows you to make
46615 *   this a scroll and/or hold cursor. It's a bitmask and can be either
46616 *   IFX_SCROLL, IFX_HOLD, or both or'ed together.
46617 * @param mixed $blobidarray If you have BLOB (BYTE or TEXT) columns in
46618 *   the query, you can add a {@link blobidarray} parameter containing
46619 *   the corresponding "blob ids", and you should replace those columns
46620 *   with a "?" in the query text.
46621 * @return resource Returns a valid result identifier for use by {@link
46622 *   ifx_do}, or FALSE on errors.
46623 * @since PHP 4, PHP 5 < 5.2.1
46624 **/
46625function ifx_prepare($query, $link_identifier, $cursor_def, $blobidarray){}
46626
46627/**
46628 * Send Informix query
46629 *
46630 * Sends a {@link query} to the currently active database on the server
46631 * that's associated with the specified link identifier.
46632 *
46633 * For "select-type" queries a cursor is declared and opened. Non-select
46634 * queries are "execute immediate".
46635 *
46636 * For either query type the number of (estimated or real) affected rows
46637 * is saved for retrieval by {@link ifx_affected_rows}.
46638 *
46639 * If the contents of the TEXT (or BYTE) column allow it, you can also
46640 * use ifx_textasvarchar(1) and ifx_byteasvarchar(1). This allows you to
46641 * treat TEXT (or BYTE) columns just as if they were ordinary (but long)
46642 * VARCHAR columns for select queries, and you don't need to bother with
46643 * blob id's.
46644 *
46645 * With ifx_textasvarchar(0) or ifx_byteasvarchar(0) (the default
46646 * situation), select queries will return BLOB columns as blob id's
46647 * (integer value). You can get the value of the blob as a string or file
46648 * with the blob functions (see below).
46649 *
46650 * @param string $query The query string.
46651 * @param resource $link_identifier The link identifier.
46652 * @param int $cursor_type This optional parameter allows you to make
46653 *   this a scroll and/or hold cursor. It's a bitmask and can be either
46654 *   IFX_SCROLL, IFX_HOLD, or both or'ed together. I you omit this
46655 *   parameter the cursor is a normal sequential cursor.
46656 * @param mixed $blobidarray If you have BLOB (BYTE or TEXT) columns in
46657 *   the query, you can add a {@link blobidarray} parameter containing
46658 *   the corresponding "blob ids", and you should replace those columns
46659 *   with a "?" in the query text.
46660 * @return resource Returns valid Informix result identifier on
46661 *   success, or FALSE on errors.
46662 * @since PHP 4, PHP 5 < 5.2.1
46663 **/
46664function ifx_query($query, $link_identifier, $cursor_type, $blobidarray){}
46665
46666/**
46667 * Set the default text mode
46668 *
46669 * Sets the default text mode for all select-queries.
46670 *
46671 * @param int $mode Mode "0" will return a blob id, and mode "1" will
46672 *   return a varchar with text content.
46673 * @return bool
46674 * @since PHP 4, PHP 5 < 5.2.1
46675 **/
46676function ifx_textasvarchar($mode){}
46677
46678/**
46679 * Updates the content of the blob object
46680 *
46681 * Updates the content of the blob object for the given blob object
46682 * {@link bid}.
46683 *
46684 * @param int $bid A BLOB object identifier.
46685 * @param string $content The new data, as a string.
46686 * @return bool
46687 * @since PHP 4, PHP 5 < 5.2.1
46688 **/
46689function ifx_update_blob($bid, $content){}
46690
46691/**
46692 * Updates the content of the char object
46693 *
46694 * Updates the content of the char object for the given char object
46695 * {@link bid}.
46696 *
46697 * @param int $bid A char object identifier.
46698 * @param string $content The new data, as a string.
46699 * @return bool
46700 * @since PHP 4, PHP 5 < 5.2.1
46701 **/
46702function ifx_update_char($bid, $content){}
46703
46704/**
46705 * Set whether a client disconnect should abort script execution
46706 *
46707 * Sets whether a client disconnect should cause a script to be aborted.
46708 *
46709 * When running PHP as a command line script, and the script's tty goes
46710 * away without the script being terminated then the script will die the
46711 * next time it tries to write anything, unless {@link value} is set to
46712 * TRUE
46713 *
46714 * @param bool $value If set, this function will set the
46715 *   ignore_user_abort ini setting to the given {@link value}. If not,
46716 *   this function will only return the previous setting without changing
46717 *   it.
46718 * @return int Returns the previous setting, as an integer.
46719 * @since PHP 4, PHP 5, PHP 7
46720 **/
46721function ignore_user_abort($value){}
46722
46723/**
46724 * Creates a new virtual web server
46725 *
46726 * @param string $path
46727 * @param string $comment
46728 * @param string $server_ip
46729 * @param int $port
46730 * @param string $host_name
46731 * @param int $rights
46732 * @param int $start_server
46733 * @return int
46734 * @since PECL iisfunc SVN
46735 **/
46736function iis_add_server($path, $comment, $server_ip, $port, $host_name, $rights, $start_server){}
46737
46738/**
46739 * Gets Directory Security
46740 *
46741 * @param int $server_instance
46742 * @param string $virtual_path
46743 * @return int
46744 * @since PECL iisfunc SVN
46745 **/
46746function iis_get_dir_security($server_instance, $virtual_path){}
46747
46748/**
46749 * Gets script mapping on a virtual directory for a specific extension
46750 *
46751 * @param int $server_instance
46752 * @param string $virtual_path
46753 * @param string $script_extension
46754 * @return string
46755 * @since PECL iisfunc SVN
46756 **/
46757function iis_get_script_map($server_instance, $virtual_path, $script_extension){}
46758
46759/**
46760 * Return the instance number associated with the Comment
46761 *
46762 * @param string $comment
46763 * @return int
46764 * @since PECL iisfunc SVN
46765 **/
46766function iis_get_server_by_comment($comment){}
46767
46768/**
46769 * Return the instance number associated with the Path
46770 *
46771 * Each virtual server in IIS is associated with an instance number.
46772 * {@link iis_get_server_by_path} finds the instance number from the
46773 * actual path to the root directory.
46774 *
46775 * @param string $path The path to the root directory
46776 * @return int Returns the server instance number.
46777 * @since PECL iisfunc SVN
46778 **/
46779function iis_get_server_by_path($path){}
46780
46781/**
46782 * Gets server rights
46783 *
46784 * @param int $server_instance
46785 * @param string $virtual_path
46786 * @return int
46787 * @since PECL iisfunc SVN
46788 **/
46789function iis_get_server_rights($server_instance, $virtual_path){}
46790
46791/**
46792 * Returns the state for the service defined by ServiceId
46793 *
46794 * @param string $service_id
46795 * @return int
46796 * @since PECL iisfunc SVN
46797 **/
46798function iis_get_service_state($service_id){}
46799
46800/**
46801 * Removes the virtual web server indicated by ServerInstance
46802 *
46803 * @param int $server_instance
46804 * @return int
46805 * @since PECL iisfunc SVN
46806 **/
46807function iis_remove_server($server_instance){}
46808
46809/**
46810 * Creates application scope for a virtual directory
46811 *
46812 * @param int $server_instance
46813 * @param string $virtual_path
46814 * @param string $application_scope
46815 * @return int
46816 * @since PECL iisfunc SVN
46817 **/
46818function iis_set_app_settings($server_instance, $virtual_path, $application_scope){}
46819
46820/**
46821 * Sets Directory Security
46822 *
46823 * @param int $server_instance
46824 * @param string $virtual_path
46825 * @param int $directory_flags
46826 * @return int
46827 * @since PECL iisfunc SVN
46828 **/
46829function iis_set_dir_security($server_instance, $virtual_path, $directory_flags){}
46830
46831/**
46832 * Sets script mapping on a virtual directory
46833 *
46834 * @param int $server_instance
46835 * @param string $virtual_path
46836 * @param string $script_extension
46837 * @param string $engine_path
46838 * @param int $allow_scripting
46839 * @return int
46840 * @since PECL iisfunc SVN
46841 **/
46842function iis_set_script_map($server_instance, $virtual_path, $script_extension, $engine_path, $allow_scripting){}
46843
46844/**
46845 * Sets server rights
46846 *
46847 * @param int $server_instance
46848 * @param string $virtual_path
46849 * @param int $directory_flags
46850 * @return int
46851 * @since PECL iisfunc SVN
46852 **/
46853function iis_set_server_rights($server_instance, $virtual_path, $directory_flags){}
46854
46855/**
46856 * Starts the virtual web server
46857 *
46858 * @param int $server_instance
46859 * @return int
46860 * @since PECL iisfunc SVN
46861 **/
46862function iis_start_server($server_instance){}
46863
46864/**
46865 * Starts the service defined by ServiceId
46866 *
46867 * @param string $service_id
46868 * @return int
46869 * @since PECL iisfunc SVN
46870 **/
46871function iis_start_service($service_id){}
46872
46873/**
46874 * Stops the virtual web server
46875 *
46876 * @param int $server_instance
46877 * @return int
46878 * @since PECL iisfunc SVN
46879 **/
46880function iis_stop_server($server_instance){}
46881
46882/**
46883 * Stops the service defined by ServiceId
46884 *
46885 * @param string $service_id
46886 * @return int
46887 * @since PECL iisfunc SVN
46888 **/
46889function iis_stop_service($service_id){}
46890
46891/**
46892 * {@link image2wbmp} outputs or save a WBMP version of the given {@link
46893 * image}.
46894 *
46895 * @param resource $image Path to the saved file. If not given, the raw
46896 *   image stream will be output directly.
46897 * @param string $filename You can set the foreground color with this
46898 *   parameter by setting an identifier obtained from {@link
46899 *   imagecolorallocate}. The default foreground color is black.
46900 * @param int $foreground
46901 * @return bool
46902 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
46903 **/
46904function image2wbmp($image, $filename, $foreground){}
46905
46906/**
46907 * Return an image containing the affine transformed src image, using an
46908 * optional clipping area
46909 *
46910 * @param resource $image Array with keys 0 to 5.
46911 * @param array $affine Array with keys "x", "y", "width" and "height".
46912 * @param array $clip
46913 * @return resource Return affined image resource on success.
46914 * @since PHP 5 >= 5.5.0, PHP 7
46915 **/
46916function imageaffine($image, $affine, $clip){}
46917
46918/**
46919 * Concatenate two affine transformation matrices
46920 *
46921 * Returns the concatenation of two affine transformation matrices, what
46922 * is useful if multiple transformations should be applied to the same
46923 * image in one go.
46924 *
46925 * @param array $m1 An affine transformation matrix (an array with keys
46926 *   0 to 5 and float values).
46927 * @param array $m2 An affine transformation matrix (an array with keys
46928 *   0 to 5 and float values).
46929 * @return array An affine transformation matrix (an array with keys 0
46930 *   to 5 and float values) .
46931 * @since PHP 5 >= 5.5.0, PHP 7
46932 **/
46933function imageaffinematrixconcat($m1, $m2){}
46934
46935/**
46936 * Get an affine transformation matrix
46937 *
46938 * Returns an affine transformation matrix.
46939 *
46940 * @param int $type One of the IMG_AFFINE_* constants.
46941 * @param mixed $options If {@link type} is IMG_AFFINE_TRANSLATE or
46942 *   IMG_AFFINE_SCALE, {@link options} has to be an array with keys x and
46943 *   y, both having float values. If {@link type} is IMG_AFFINE_ROTATE,
46944 *   IMG_AFFINE_SHEAR_HORIZONTAL or IMG_AFFINE_SHEAR_VERTICAL, {@link
46945 *   options} has to be a float specifying the angle.
46946 * @return array An affine transformation matrix (an array with keys 0
46947 *   to 5 and float values) .
46948 * @since PHP 5 >= 5.5.0, PHP 7
46949 **/
46950function imageaffinematrixget($type, $options){}
46951
46952/**
46953 * Set the blending mode for an image
46954 *
46955 * {@link imagealphablending} allows for two different modes of drawing
46956 * on truecolor images. In blending mode, the alpha channel component of
46957 * the color supplied to all drawing function, such as {@link
46958 * imagesetpixel} determines how much of the underlying color should be
46959 * allowed to shine through. As a result, gd automatically blends the
46960 * existing color at that point with the drawing color, and stores the
46961 * result in the image. The resulting pixel is opaque. In non-blending
46962 * mode, the drawing color is copied literally with its alpha channel
46963 * information, replacing the destination pixel. Blending mode is not
46964 * available when drawing on palette images.
46965 *
46966 * @param resource $image Whether to enable the blending mode or not.
46967 *   On true color images the default value is TRUE otherwise the default
46968 *   value is FALSE
46969 * @param bool $blendmode
46970 * @return bool
46971 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
46972 **/
46973function imagealphablending($image, $blendmode){}
46974
46975/**
46976 * Should antialias functions be used or not
46977 *
46978 * Activate the fast drawing antialiased methods for lines and wired
46979 * polygons. It does not support alpha components. It works using a
46980 * direct blend operation. It works only with truecolor images.
46981 *
46982 * Thickness and styled are not supported.
46983 *
46984 * Using antialiased primitives with transparent background color can end
46985 * with some unexpected results. The blend method uses the background
46986 * color as any other colors. The lack of alpha component support does
46987 * not allow an alpha based antialiasing method.
46988 *
46989 * @param resource $image Whether to enable antialiasing or not.
46990 * @param bool $enabled
46991 * @return bool
46992 * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
46993 **/
46994function imageantialias($image, $enabled){}
46995
46996/**
46997 * Draws an arc
46998 *
46999 * {@link imagearc} draws an arc of circle centered at the given
47000 * coordinates.
47001 *
47002 * @param resource $image x-coordinate of the center.
47003 * @param int $cx y-coordinate of the center.
47004 * @param int $cy The arc width.
47005 * @param int $width The arc height.
47006 * @param int $height The arc start angle, in degrees.
47007 * @param int $start The arc end angle, in degrees. 0° is located at
47008 *   the three-o'clock position, and the arc is drawn clockwise.
47009 * @param int $end
47010 * @param int $color
47011 * @return bool
47012 * @since PHP 4, PHP 5, PHP 7
47013 **/
47014function imagearc($image, $cx, $cy, $width, $height, $start, $end, $color){}
47015
47016/**
47017 * Output a BMP image to browser or file
47018 *
47019 * Outputs or saves a BMP version of the given {@link image}.
47020 *
47021 * @param resource $image
47022 * @param mixed $to Whether the BMP should be compressed with
47023 *   run-length encoding (RLE), or not.
47024 * @param bool $compressed
47025 * @return bool
47026 * @since PHP 7 >= 7.2.0
47027 **/
47028function imagebmp($image, $to, $compressed){}
47029
47030/**
47031 * Draw a character horizontally
47032 *
47033 * {@link imagechar} draws the first character of {@link c} in the image
47034 * identified by {@link image} with its upper-left at {@link x},{@link y}
47035 * (top left is 0, 0) with the color {@link color}.
47036 *
47037 * @param resource $image x-coordinate of the start.
47038 * @param int $font y-coordinate of the start.
47039 * @param int $x The character to draw.
47040 * @param int $y
47041 * @param string $c
47042 * @param int $color
47043 * @return bool
47044 * @since PHP 4, PHP 5, PHP 7
47045 **/
47046function imagechar($image, $font, $x, $y, $c, $color){}
47047
47048/**
47049 * Draw a character vertically
47050 *
47051 * Draws the character {@link c} vertically at the specified coordinate
47052 * on the given {@link image}.
47053 *
47054 * @param resource $image x-coordinate of the start.
47055 * @param int $font y-coordinate of the start.
47056 * @param int $x The character to draw.
47057 * @param int $y
47058 * @param string $c
47059 * @param int $color
47060 * @return bool
47061 * @since PHP 4, PHP 5, PHP 7
47062 **/
47063function imagecharup($image, $font, $x, $y, $c, $color){}
47064
47065/**
47066 * Allocate a color for an image
47067 *
47068 * Returns a color identifier representing the color composed of the
47069 * given RGB components.
47070 *
47071 * {@link imagecolorallocate} must be called to create each color that is
47072 * to be used in the image represented by {@link image}.
47073 *
47074 * @param resource $image
47075 * @param int $red
47076 * @param int $green
47077 * @param int $blue
47078 * @return int A color identifier or FALSE if the allocation failed.
47079 * @since PHP 4, PHP 5, PHP 7
47080 **/
47081function imagecolorallocate($image, $red, $green, $blue){}
47082
47083/**
47084 * Allocate a color for an image
47085 *
47086 * {@link imagecolorallocatealpha} behaves identically to {@link
47087 * imagecolorallocate} with the addition of the transparency parameter
47088 * {@link alpha}.
47089 *
47090 * @param resource $image
47091 * @param int $red
47092 * @param int $green
47093 * @param int $blue A value between 0 and 127. 0 indicates completely
47094 *   opaque while 127 indicates completely transparent.
47095 * @param int $alpha
47096 * @return int A color identifier or FALSE if the allocation failed.
47097 * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
47098 **/
47099function imagecolorallocatealpha($image, $red, $green, $blue, $alpha){}
47100
47101/**
47102 * Get the index of the color of a pixel
47103 *
47104 * Returns the index of the color of the pixel at the specified location
47105 * in the image specified by {@link image}.
47106 *
47107 * If the image is a truecolor image, this function returns the RGB value
47108 * of that pixel as integer. Use bitshifting and masking to access the
47109 * distinct red, green and blue component values:
47110 *
47111 * @param resource $image x-coordinate of the point.
47112 * @param int $x y-coordinate of the point.
47113 * @param int $y
47114 * @return int Returns the index of the color .
47115 * @since PHP 4, PHP 5, PHP 7
47116 **/
47117function imagecolorat($image, $x, $y){}
47118
47119/**
47120 * Get the index of the closest color to the specified color
47121 *
47122 * Returns the index of the color in the palette of the image which is
47123 * "closest" to the specified RGB value.
47124 *
47125 * The "distance" between the desired color and each color in the palette
47126 * is calculated as if the RGB values represented points in
47127 * three-dimensional space.
47128 *
47129 * @param resource $image
47130 * @param int $red
47131 * @param int $green
47132 * @param int $blue
47133 * @return int Returns the index of the closest color, in the palette
47134 *   of the image, to the specified one
47135 * @since PHP 4, PHP 5, PHP 7
47136 **/
47137function imagecolorclosest($image, $red, $green, $blue){}
47138
47139/**
47140 * Get the index of the closest color to the specified color + alpha
47141 *
47142 * Returns the index of the color in the palette of the image which is
47143 * "closest" to the specified RGB value and {@link alpha} level.
47144 *
47145 * @param resource $image
47146 * @param int $red
47147 * @param int $green
47148 * @param int $blue A value between 0 and 127. 0 indicates completely
47149 *   opaque while 127 indicates completely transparent.
47150 * @param int $alpha
47151 * @return int Returns the index of the closest color in the palette.
47152 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
47153 **/
47154function imagecolorclosestalpha($image, $red, $green, $blue, $alpha){}
47155
47156/**
47157 * Get the index of the color which has the hue, white and blackness
47158 *
47159 * Get the index of the color which has the hue, white and blackness
47160 * nearest the given color.
47161 *
47162 * @param resource $image
47163 * @param int $red
47164 * @param int $green
47165 * @param int $blue
47166 * @return int Returns an integer with the index of the color which has
47167 *   the hue, white and blackness nearest the given color.
47168 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
47169 **/
47170function imagecolorclosesthwb($image, $red, $green, $blue){}
47171
47172/**
47173 * De-allocate a color for an image
47174 *
47175 * De-allocates a color previously allocated with {@link
47176 * imagecolorallocate} or {@link imagecolorallocatealpha}.
47177 *
47178 * @param resource $image The color identifier.
47179 * @param int $color
47180 * @return bool
47181 * @since PHP 4, PHP 5, PHP 7
47182 **/
47183function imagecolordeallocate($image, $color){}
47184
47185/**
47186 * Get the index of the specified color
47187 *
47188 * Returns the index of the specified color in the palette of the image.
47189 *
47190 * @param resource $image
47191 * @param int $red
47192 * @param int $green
47193 * @param int $blue
47194 * @return int Returns the index of the specified color in the palette,
47195 *   or -1 if the color does not exist.
47196 * @since PHP 4, PHP 5, PHP 7
47197 **/
47198function imagecolorexact($image, $red, $green, $blue){}
47199
47200/**
47201 * Get the index of the specified color + alpha
47202 *
47203 * Returns the index of the specified color+alpha in the palette of the
47204 * image.
47205 *
47206 * @param resource $image
47207 * @param int $red
47208 * @param int $green
47209 * @param int $blue A value between 0 and 127. 0 indicates completely
47210 *   opaque while 127 indicates completely transparent.
47211 * @param int $alpha
47212 * @return int Returns the index of the specified color+alpha in the
47213 *   palette of the image, or -1 if the color does not exist in the
47214 *   image's palette.
47215 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
47216 **/
47217function imagecolorexactalpha($image, $red, $green, $blue, $alpha){}
47218
47219/**
47220 * Makes the colors of the palette version of an image more closely match
47221 * the true color version
47222 *
47223 * @param resource $image1 A truecolor image link resource.
47224 * @param resource $image2 A palette image link resource pointing to an
47225 *   image that has the same size as {@link image1}.
47226 * @return bool
47227 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
47228 **/
47229function imagecolormatch($image1, $image2){}
47230
47231/**
47232 * Get the index of the specified color or its closest possible
47233 * alternative
47234 *
47235 * This function is guaranteed to return a color index for a requested
47236 * color, either the exact color or the closest possible alternative.
47237 *
47238 * @param resource $image
47239 * @param int $red
47240 * @param int $green
47241 * @param int $blue
47242 * @return int Returns a color index.
47243 * @since PHP 4, PHP 5, PHP 7
47244 **/
47245function imagecolorresolve($image, $red, $green, $blue){}
47246
47247/**
47248 * Get the index of the specified color + alpha or its closest possible
47249 * alternative
47250 *
47251 * This function is guaranteed to return a color index for a requested
47252 * color, either the exact color or the closest possible alternative.
47253 *
47254 * @param resource $image
47255 * @param int $red
47256 * @param int $green
47257 * @param int $blue A value between 0 and 127. 0 indicates completely
47258 *   opaque while 127 indicates completely transparent.
47259 * @param int $alpha
47260 * @return int Returns a color index.
47261 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
47262 **/
47263function imagecolorresolvealpha($image, $red, $green, $blue, $alpha){}
47264
47265/**
47266 * Set the color for the specified palette index
47267 *
47268 * This sets the specified index in the palette to the specified color.
47269 * This is useful for creating flood-fill-like effects in palleted images
47270 * without the overhead of performing the actual flood-fill.
47271 *
47272 * @param resource $image An index in the palette.
47273 * @param int $index
47274 * @param int $red
47275 * @param int $green
47276 * @param int $blue Value of alpha component.
47277 * @param int $alpha
47278 * @return void
47279 * @since PHP 4, PHP 5, PHP 7
47280 **/
47281function imagecolorset($image, $index, $red, $green, $blue, $alpha){}
47282
47283/**
47284 * Get the colors for an index
47285 *
47286 * Gets the color for a specified index.
47287 *
47288 * @param resource $image The color index.
47289 * @param int $index
47290 * @return array Returns an associative array with red, green, blue and
47291 *   alpha keys that contain the appropriate values for the specified
47292 *   color index.
47293 * @since PHP 4, PHP 5, PHP 7
47294 **/
47295function imagecolorsforindex($image, $index){}
47296
47297/**
47298 * Find out the number of colors in an image's palette
47299 *
47300 * Returns the number of colors in an image palette.
47301 *
47302 * @param resource $image
47303 * @return int Returns the number of colors in the specified image's
47304 *   palette or 0 for truecolor images.
47305 * @since PHP 4, PHP 5, PHP 7
47306 **/
47307function imagecolorstotal($image){}
47308
47309/**
47310 * Define a color as transparent
47311 *
47312 * Gets or sets the transparent color in the given {@link image}.
47313 *
47314 * @param resource $image
47315 * @return int The identifier of the new (or current, if none is
47316 *   specified) transparent color is returned. If {@link color} is not
47317 *   specified, and the image has no transparent color, the returned
47318 *   identifier will be -1.
47319 * @since PHP 4, PHP 5, PHP 7
47320 **/
47321function imagecolortransparent($image){}
47322
47323/**
47324 * Apply a 3x3 convolution matrix, using coefficient and offset
47325 *
47326 * Applies a convolution matrix on the image, using the given coefficient
47327 * and offset.
47328 *
47329 * @param resource $image A 3x3 matrix: an array of three arrays of
47330 *   three floats.
47331 * @param array $matrix The divisor of the result of the convolution,
47332 *   used for normalization.
47333 * @param float $div Color offset.
47334 * @param float $offset
47335 * @return bool
47336 * @since PHP 5 >= 5.1.0, PHP 7
47337 **/
47338function imageconvolution($image, $matrix, $div, $offset){}
47339
47340/**
47341 * Copy part of an image
47342 *
47343 * Copy a part of {@link src_im} onto {@link dst_im} starting at the x,y
47344 * coordinates {@link src_x}, {@link src_y } with a width of {@link
47345 * src_w} and a height of {@link src_h}. The portion defined will be
47346 * copied onto the x,y coordinates, {@link dst_x} and {@link dst_y}.
47347 *
47348 * @param resource $dst_im
47349 * @param resource $src_im
47350 * @param int $dst_x x-coordinate of destination point.
47351 * @param int $dst_y y-coordinate of destination point.
47352 * @param int $src_x x-coordinate of source point.
47353 * @param int $src_y y-coordinate of source point.
47354 * @param int $src_w
47355 * @param int $src_h
47356 * @return bool
47357 * @since PHP 4, PHP 5, PHP 7
47358 **/
47359function imagecopy($dst_im, $src_im, $dst_x, $dst_y, $src_x, $src_y, $src_w, $src_h){}
47360
47361/**
47362 * Copy and merge part of an image
47363 *
47364 * Copy a part of {@link src_im} onto {@link dst_im} starting at the x,y
47365 * coordinates {@link src_x}, {@link src_y } with a width of {@link
47366 * src_w} and a height of {@link src_h}. The portion defined will be
47367 * copied onto the x,y coordinates, {@link dst_x} and {@link dst_y}.
47368 *
47369 * @param resource $dst_im
47370 * @param resource $src_im
47371 * @param int $dst_x x-coordinate of destination point.
47372 * @param int $dst_y y-coordinate of destination point.
47373 * @param int $src_x x-coordinate of source point.
47374 * @param int $src_y y-coordinate of source point.
47375 * @param int $src_w
47376 * @param int $src_h
47377 * @param int $pct The two images will be merged according to {@link
47378 *   pct} which can range from 0 to 100. When {@link pct} = 0, no action
47379 *   is taken, when 100 this function behaves identically to {@link
47380 *   imagecopy} for pallete images, except for ignoring alpha components,
47381 *   while it implements alpha transparency for true colour images.
47382 * @return bool
47383 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
47384 **/
47385function imagecopymerge($dst_im, $src_im, $dst_x, $dst_y, $src_x, $src_y, $src_w, $src_h, $pct){}
47386
47387/**
47388 * Copy and merge part of an image with gray scale
47389 *
47390 * {@link imagecopymergegray} copy a part of {@link src_im} onto {@link
47391 * dst_im} starting at the x,y coordinates {@link src_x}, {@link src_y }
47392 * with a width of {@link src_w} and a height of {@link src_h}. The
47393 * portion defined will be copied onto the x,y coordinates, {@link dst_x}
47394 * and {@link dst_y}.
47395 *
47396 * This function is identical to {@link imagecopymerge} except that when
47397 * merging it preserves the hue of the source by converting the
47398 * destination pixels to gray scale before the copy operation.
47399 *
47400 * @param resource $dst_im
47401 * @param resource $src_im
47402 * @param int $dst_x x-coordinate of destination point.
47403 * @param int $dst_y y-coordinate of destination point.
47404 * @param int $src_x x-coordinate of source point.
47405 * @param int $src_y y-coordinate of source point.
47406 * @param int $src_w
47407 * @param int $src_h
47408 * @param int $pct The {@link src_im} will be changed to grayscale
47409 *   according to {@link pct} where 0 is fully grayscale and 100 is
47410 *   unchanged. When {@link pct} = 100 this function behaves identically
47411 *   to {@link imagecopy} for pallete images, except for ignoring alpha
47412 *   components, while it implements alpha transparency for true colour
47413 *   images.
47414 * @return bool
47415 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
47416 **/
47417function imagecopymergegray($dst_im, $src_im, $dst_x, $dst_y, $src_x, $src_y, $src_w, $src_h, $pct){}
47418
47419/**
47420 * Copy and resize part of an image with resampling
47421 *
47422 * {@link imagecopyresampled} copies a rectangular portion of one image
47423 * to another image, smoothly interpolating pixel values so that, in
47424 * particular, reducing the size of an image still retains a great deal
47425 * of clarity.
47426 *
47427 * In other words, {@link imagecopyresampled} will take a rectangular
47428 * area from {@link src_image} of width {@link src_w} and height {@link
47429 * src_h} at position ({@link src_x},{@link src_y}) and place it in a
47430 * rectangular area of {@link dst_image} of width {@link dst_w} and
47431 * height {@link dst_h} at position ({@link dst_x},{@link dst_y}).
47432 *
47433 * If the source and destination coordinates and width and heights
47434 * differ, appropriate stretching or shrinking of the image fragment will
47435 * be performed. The coordinates refer to the upper left corner. This
47436 * function can be used to copy regions within the same image (if {@link
47437 * dst_image} is the same as {@link src_image}) but if the regions
47438 * overlap the results will be unpredictable.
47439 *
47440 * @param resource $dst_image
47441 * @param resource $src_image
47442 * @param int $dst_x x-coordinate of destination point.
47443 * @param int $dst_y y-coordinate of destination point.
47444 * @param int $src_x x-coordinate of source point.
47445 * @param int $src_y y-coordinate of source point.
47446 * @param int $dst_w Destination width.
47447 * @param int $dst_h Destination height.
47448 * @param int $src_w
47449 * @param int $src_h
47450 * @return bool
47451 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
47452 **/
47453function imagecopyresampled($dst_image, $src_image, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h){}
47454
47455/**
47456 * Copy and resize part of an image
47457 *
47458 * {@link imagecopyresized} copies a rectangular portion of one image to
47459 * another image. {@link dst_image} is the destination image, {@link
47460 * src_image} is the source image identifier.
47461 *
47462 * In other words, {@link imagecopyresized} will take a rectangular area
47463 * from {@link src_image} of width {@link src_w} and height {@link src_h}
47464 * at position ({@link src_x},{@link src_y}) and place it in a
47465 * rectangular area of {@link dst_image} of width {@link dst_w} and
47466 * height {@link dst_h} at position ({@link dst_x},{@link dst_y}).
47467 *
47468 * If the source and destination coordinates and width and heights
47469 * differ, appropriate stretching or shrinking of the image fragment will
47470 * be performed. The coordinates refer to the upper left corner. This
47471 * function can be used to copy regions within the same image (if {@link
47472 * dst_image} is the same as {@link src_image}) but if the regions
47473 * overlap the results will be unpredictable.
47474 *
47475 * @param resource $dst_image
47476 * @param resource $src_image
47477 * @param int $dst_x x-coordinate of destination point.
47478 * @param int $dst_y y-coordinate of destination point.
47479 * @param int $src_x x-coordinate of source point.
47480 * @param int $src_y y-coordinate of source point.
47481 * @param int $dst_w Destination width.
47482 * @param int $dst_h Destination height.
47483 * @param int $src_w
47484 * @param int $src_h
47485 * @return bool
47486 * @since PHP 4, PHP 5, PHP 7
47487 **/
47488function imagecopyresized($dst_image, $src_image, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h){}
47489
47490/**
47491 * Create a new palette based image
47492 *
47493 * {@link imagecreate} returns an image identifier representing a blank
47494 * image of specified size.
47495 *
47496 * In general, we recommend the use of {@link imagecreatetruecolor}
47497 * instead of {@link imagecreate} so that image processing occurs on the
47498 * highest quality image possible. If you want to output a palette image,
47499 * then {@link imagetruecolortopalette} should be called immediately
47500 * before saving the image with {@link imagepng} or {@link imagegif}.
47501 *
47502 * @param int $width The image width.
47503 * @param int $height The image height.
47504 * @return resource
47505 * @since PHP 4, PHP 5, PHP 7
47506 **/
47507function imagecreate($width, $height){}
47508
47509/**
47510 * {@link imagecreatefrombmp} returns an image identifier representing
47511 * the image obtained from the given filename.
47512 *
47513 * @param string $filename Path to the BMP image.
47514 * @return resource
47515 * @since PHP 7 >= 7.2.0
47516 **/
47517function imagecreatefrombmp($filename){}
47518
47519/**
47520 * Create a new image from GD file or URL
47521 *
47522 * @param string $filename Path to the GD file.
47523 * @return resource
47524 * @since PHP 4 >= 4.0.7, PHP 5, PHP 7
47525 **/
47526function imagecreatefromgd($filename){}
47527
47528/**
47529 * Create a new image from GD2 file or URL
47530 *
47531 * @param string $filename Path to the GD2 image.
47532 * @return resource
47533 * @since PHP 4 >= 4.0.7, PHP 5, PHP 7
47534 **/
47535function imagecreatefromgd2($filename){}
47536
47537/**
47538 * Create a new image from a given part of GD2 file or URL
47539 *
47540 * @param string $filename Path to the GD2 image.
47541 * @param int $srcX x-coordinate of source point.
47542 * @param int $srcY y-coordinate of source point.
47543 * @param int $width
47544 * @param int $height
47545 * @return resource
47546 * @since PHP 4 >= 4.0.7, PHP 5, PHP 7
47547 **/
47548function imagecreatefromgd2part($filename, $srcX, $srcY, $width, $height){}
47549
47550/**
47551 * {@link imagecreatefromgif} returns an image identifier representing
47552 * the image obtained from the given filename.
47553 *
47554 * @param string $filename Path to the GIF image.
47555 * @return resource
47556 * @since PHP 4, PHP 5, PHP 7
47557 **/
47558function imagecreatefromgif($filename){}
47559
47560/**
47561 * {@link imagecreatefromjpeg} returns an image identifier representing
47562 * the image obtained from the given filename.
47563 *
47564 * @param string $filename Path to the JPEG image.
47565 * @return resource
47566 * @since PHP 4, PHP 5, PHP 7
47567 **/
47568function imagecreatefromjpeg($filename){}
47569
47570/**
47571 * {@link imagecreatefrompng} returns an image identifier representing
47572 * the image obtained from the given filename.
47573 *
47574 * @param string $filename Path to the PNG image.
47575 * @return resource
47576 * @since PHP 4, PHP 5, PHP 7
47577 **/
47578function imagecreatefrompng($filename){}
47579
47580/**
47581 * Create a new image from the image stream in the string
47582 *
47583 * {@link imagecreatefromstring} returns an image identifier representing
47584 * the image obtained from the given {@link image}. These types will be
47585 * automatically detected if your build of PHP supports them: JPEG, PNG,
47586 * GIF, BMP, WBMP, and GD2.
47587 *
47588 * @param string $image A string containing the image data.
47589 * @return resource An image resource will be returned on success.
47590 *   FALSE is returned if the image type is unsupported, the data is not
47591 *   in a recognised format, or the image is corrupt and cannot be
47592 *   loaded.
47593 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
47594 **/
47595function imagecreatefromstring($image){}
47596
47597/**
47598 * {@link imagecreatefromwbmp} returns an image identifier representing
47599 * the image obtained from the given filename.
47600 *
47601 * @param string $filename Path to the WBMP image.
47602 * @return resource
47603 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
47604 **/
47605function imagecreatefromwbmp($filename){}
47606
47607/**
47608 * {@link imagecreatefromwebp} returns an image identifier representing
47609 * the image obtained from the given filename.
47610 *
47611 * @param string $filename Path to the WebP image.
47612 * @return resource
47613 * @since PHP 5 >= 5.4.0, PHP 7
47614 **/
47615function imagecreatefromwebp($filename){}
47616
47617/**
47618 * {@link imagecreatefromxbm} returns an image identifier representing
47619 * the image obtained from the given filename.
47620 *
47621 * @param string $filename Path to the XBM image.
47622 * @return resource
47623 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
47624 **/
47625function imagecreatefromxbm($filename){}
47626
47627/**
47628 * {@link imagecreatefromxpm} returns an image identifier representing
47629 * the image obtained from the given filename.
47630 *
47631 * @param string $filename Path to the XPM image.
47632 * @return resource
47633 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
47634 **/
47635function imagecreatefromxpm($filename){}
47636
47637/**
47638 * Create a new true color image
47639 *
47640 * {@link imagecreatetruecolor} returns an image identifier representing
47641 * a black image of the specified size.
47642 *
47643 * @param int $width Image width.
47644 * @param int $height Image height.
47645 * @return resource
47646 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
47647 **/
47648function imagecreatetruecolor($width, $height){}
47649
47650/**
47651 * Crop an image to the given rectangle
47652 *
47653 * Crops an image to the given rectangular area and returns the resulting
47654 * image. The given {@link image} is not modified.
47655 *
47656 * @param resource $image The cropping rectangle as array with keys x,
47657 *   y, width and height.
47658 * @param array $rect
47659 * @return resource Return cropped image resource on success.
47660 * @since PHP 5 >= 5.5.0, PHP 7
47661 **/
47662function imagecrop($image, $rect){}
47663
47664/**
47665 * Crop an image automatically using one of the available modes
47666 *
47667 * Automatically crops an image according to the given {@link mode}.
47668 *
47669 * @param resource $image One of the following constants:
47670 * @param int $mode
47671 * @param float $threshold
47672 * @param int $color
47673 * @return resource Returns a cropped image resource on success. If the
47674 *   complete image was cropped, {@link imagecrop} returns FALSE.
47675 * @since PHP 5 >= 5.5.0, PHP 7
47676 **/
47677function imagecropauto($image, $mode, $threshold, $color){}
47678
47679/**
47680 * Draw a dashed line
47681 *
47682 * This function is deprecated. Use combination of {@link imagesetstyle}
47683 * and {@link imageline} instead.
47684 *
47685 * @param resource $image Upper left x coordinate.
47686 * @param int $x1 Upper left y coordinate 0, 0 is the top left corner
47687 *   of the image.
47688 * @param int $y1 Bottom right x coordinate.
47689 * @param int $x2 Bottom right y coordinate.
47690 * @param int $y2 The fill color.
47691 * @param int $color
47692 * @return bool
47693 * @since PHP 4, PHP 5, PHP 7
47694 **/
47695function imagedashedline($image, $x1, $y1, $x2, $y2, $color){}
47696
47697/**
47698 * Destroy an image
47699 *
47700 * {@link imagedestroy} frees any memory associated with image {@link
47701 * image}.
47702 *
47703 * @param resource $image
47704 * @return bool
47705 * @since PHP 4, PHP 5, PHP 7
47706 **/
47707function imagedestroy($image){}
47708
47709/**
47710 * Draw an ellipse
47711 *
47712 * Draws an ellipse centered at the specified coordinates.
47713 *
47714 * @param resource $image x-coordinate of the center.
47715 * @param int $cx y-coordinate of the center.
47716 * @param int $cy The ellipse width.
47717 * @param int $width The ellipse height.
47718 * @param int $height The color of the ellipse.
47719 * @param int $color
47720 * @return bool
47721 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
47722 **/
47723function imageellipse($image, $cx, $cy, $width, $height, $color){}
47724
47725/**
47726 * Flood fill
47727 *
47728 * Performs a flood fill starting at the given coordinate (top left is 0,
47729 * 0) with the given {@link color} in the {@link image}.
47730 *
47731 * @param resource $image x-coordinate of start point.
47732 * @param int $x y-coordinate of start point.
47733 * @param int $y The fill color.
47734 * @param int $color
47735 * @return bool
47736 * @since PHP 4, PHP 5, PHP 7
47737 **/
47738function imagefill($image, $x, $y, $color){}
47739
47740/**
47741 * Draw a partial arc and fill it
47742 *
47743 * Draws a partial arc centered at the specified coordinate in the given
47744 * {@link image}.
47745 *
47746 * @param resource $image x-coordinate of the center.
47747 * @param int $cx y-coordinate of the center.
47748 * @param int $cy The arc width.
47749 * @param int $width The arc height.
47750 * @param int $height The arc start angle, in degrees.
47751 * @param int $start The arc end angle, in degrees. 0° is located at
47752 *   the three-o'clock position, and the arc is drawn clockwise.
47753 * @param int $end
47754 * @param int $color A bitwise OR of the following possibilities:
47755 *   IMG_ARC_PIE IMG_ARC_CHORD IMG_ARC_NOFILL IMG_ARC_EDGED IMG_ARC_PIE
47756 *   and IMG_ARC_CHORD are mutually exclusive; IMG_ARC_CHORD just
47757 *   connects the starting and ending angles with a straight line, while
47758 *   IMG_ARC_PIE produces a rounded edge. IMG_ARC_NOFILL indicates that
47759 *   the arc or chord should be outlined, not filled. IMG_ARC_EDGED, used
47760 *   together with IMG_ARC_NOFILL, indicates that the beginning and
47761 *   ending angles should be connected to the center - this is a good way
47762 *   to outline (rather than fill) a 'pie slice'.
47763 * @param int $style
47764 * @return bool
47765 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
47766 **/
47767function imagefilledarc($image, $cx, $cy, $width, $height, $start, $end, $color, $style){}
47768
47769/**
47770 * Draw a filled ellipse
47771 *
47772 * Draws an ellipse centered at the specified coordinate on the given
47773 * {@link image}.
47774 *
47775 * @param resource $image x-coordinate of the center.
47776 * @param int $cx y-coordinate of the center.
47777 * @param int $cy The ellipse width.
47778 * @param int $width The ellipse height.
47779 * @param int $height The fill color.
47780 * @param int $color
47781 * @return bool
47782 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
47783 **/
47784function imagefilledellipse($image, $cx, $cy, $width, $height, $color){}
47785
47786/**
47787 * Draw a filled polygon
47788 *
47789 * {@link imagefilledpolygon} creates a filled polygon in the given
47790 * {@link image}.
47791 *
47792 * @param resource $image An array containing the x and y coordinates
47793 *   of the polygons vertices consecutively.
47794 * @param array $points Total number of points (vertices), which must
47795 *   be at least 3.
47796 * @param int $num_points
47797 * @param int $color
47798 * @return bool
47799 * @since PHP 4, PHP 5, PHP 7
47800 **/
47801function imagefilledpolygon($image, $points, $num_points, $color){}
47802
47803/**
47804 * Draw a filled rectangle
47805 *
47806 * Creates a rectangle filled with {@link color} in the given {@link
47807 * image} starting at point 1 and ending at point 2. 0, 0 is the top left
47808 * corner of the image.
47809 *
47810 * @param resource $image x-coordinate for point 1.
47811 * @param int $x1 y-coordinate for point 1.
47812 * @param int $y1 x-coordinate for point 2.
47813 * @param int $x2 y-coordinate for point 2.
47814 * @param int $y2 The fill color.
47815 * @param int $color
47816 * @return bool
47817 * @since PHP 4, PHP 5, PHP 7
47818 **/
47819function imagefilledrectangle($image, $x1, $y1, $x2, $y2, $color){}
47820
47821/**
47822 * Flood fill to specific color
47823 *
47824 * {@link imagefilltoborder} performs a flood fill whose border color is
47825 * defined by {@link border}. The starting point for the fill is {@link
47826 * x}, {@link y} (top left is 0, 0) and the region is filled with color
47827 * {@link color}.
47828 *
47829 * @param resource $image x-coordinate of start.
47830 * @param int $x y-coordinate of start.
47831 * @param int $y The border color.
47832 * @param int $border The fill color.
47833 * @param int $color
47834 * @return bool
47835 * @since PHP 4, PHP 5, PHP 7
47836 **/
47837function imagefilltoborder($image, $x, $y, $border, $color){}
47838
47839/**
47840 * Applies a filter to an image
47841 *
47842 * {@link imagefilter} applies the given filter {@link filtertype} on the
47843 * {@link image}.
47844 *
47845 * @param resource $image {@link filtertype} can be one of the
47846 *   following: IMG_FILTER_NEGATE: Reverses all colors of the image.
47847 *   IMG_FILTER_GRAYSCALE: Converts the image into grayscale by changing
47848 *   the red, green and blue components to their weighted sum using the
47849 *   same coefficients as the REC.601 luma (Y') calculation. The alpha
47850 *   components are retained. For palette images the result may differ
47851 *   due to palette limitations. IMG_FILTER_BRIGHTNESS: Changes the
47852 *   brightness of the image. Use {@link arg1} to set the level of
47853 *   brightness. The range for the brightness is -255 to 255.
47854 *   IMG_FILTER_CONTRAST: Changes the contrast of the image. Use {@link
47855 *   arg1} to set the level of contrast. IMG_FILTER_COLORIZE: Like
47856 *   IMG_FILTER_GRAYSCALE, except you can specify the color. Use {@link
47857 *   arg1}, {@link arg2} and {@link arg3} in the form of {@link red},
47858 *   {@link green}, {@link blue} and {@link arg4} for the {@link alpha}
47859 *   channel. The range for each color is 0 to 255.
47860 *   IMG_FILTER_EDGEDETECT: Uses edge detection to highlight the edges in
47861 *   the image. IMG_FILTER_EMBOSS: Embosses the image.
47862 *   IMG_FILTER_GAUSSIAN_BLUR: Blurs the image using the Gaussian method.
47863 *   IMG_FILTER_SELECTIVE_BLUR: Blurs the image. IMG_FILTER_MEAN_REMOVAL:
47864 *   Uses mean removal to achieve a "sketchy" effect. IMG_FILTER_SMOOTH:
47865 *   Makes the image smoother. Use {@link arg1} to set the level of
47866 *   smoothness. IMG_FILTER_PIXELATE: Applies pixelation effect to the
47867 *   image, use {@link arg1} to set the block size and {@link arg2} to
47868 *   set the pixelation effect mode. IMG_FILTER_SCATTER: Applies scatter
47869 *   effect to the image, use {@link arg1} and {@link arg2} to define the
47870 *   effect strength and additionally {@link arg3} to only apply the on
47871 *   select pixel colors.
47872 * @param int $filtertype IMG_FILTER_BRIGHTNESS: Brightness level.
47873 *   IMG_FILTER_CONTRAST: Contrast level. IMG_FILTER_COLORIZE:
47874 *   IMG_FILTER_SMOOTH: Smoothness level. IMG_FILTER_PIXELATE: Block size
47875 *   in pixels. IMG_FILTER_SCATTER: Effect substraction level. This must
47876 *   not be higher or equal to the addition level set with {@link arg2}.
47877 * @param int $arg1 IMG_FILTER_COLORIZE: IMG_FILTER_PIXELATE: Whether
47878 *   to use advanced pixelation effect or not (defaults to FALSE).
47879 *   IMG_FILTER_SCATTER: Effect addition level.
47880 * @param int $arg2 IMG_FILTER_COLORIZE: IMG_FILTER_SCATTER: Optional
47881 *   array indexed color values to apply effect at.
47882 * @param int $arg3 IMG_FILTER_COLORIZE: Alpha channel, A value between
47883 *   0 and 127. 0 indicates completely opaque while 127 indicates
47884 *   completely transparent.
47885 * @param int $arg4
47886 * @return bool
47887 * @since PHP 5, PHP 7
47888 **/
47889function imagefilter($image, $filtertype, $arg1, $arg2, $arg3, $arg4){}
47890
47891/**
47892 * Flips an image using a given mode
47893 *
47894 * Flips the {@link image} image using the given {@link mode}.
47895 *
47896 * @param resource $image Flip mode, this can be one of the IMG_FLIP_*
47897 *   constants:
47898 *
47899 *   Constant Meaning IMG_FLIP_HORIZONTAL Flips the image horizontally.
47900 *   IMG_FLIP_VERTICAL Flips the image vertically. IMG_FLIP_BOTH Flips
47901 *   the image both horizontally and vertically.
47902 * @param int $mode
47903 * @return bool
47904 * @since PHP 5 >= 5.5.0, PHP 7
47905 **/
47906function imageflip($image, $mode){}
47907
47908/**
47909 * Get font height
47910 *
47911 * Returns the pixel height of a character in the specified font.
47912 *
47913 * @param int $font
47914 * @return int Returns the pixel height of the font.
47915 * @since PHP 4, PHP 5, PHP 7
47916 **/
47917function imagefontheight($font){}
47918
47919/**
47920 * Get font width
47921 *
47922 * Returns the pixel width of a character in font.
47923 *
47924 * @param int $font
47925 * @return int Returns the pixel width of the font.
47926 * @since PHP 4, PHP 5, PHP 7
47927 **/
47928function imagefontwidth($font){}
47929
47930/**
47931 * Give the bounding box of a text using fonts via freetype2
47932 *
47933 * This function calculates and returns the bounding box in pixels for a
47934 * FreeType text.
47935 *
47936 * @param float $size
47937 * @param float $angle Angle in degrees in which {@link text} will be
47938 *   measured.
47939 * @param string $fontfile The name of the TrueType font file (can be a
47940 *   URL). Depending on which version of the GD library that PHP is
47941 *   using, it may attempt to search for files that do not begin with a
47942 *   leading '/' by appending '.ttf' to the filename and searching along
47943 *   a library-defined font path.
47944 * @param string $text The string to be measured.
47945 * @param array $extrainfo Possible array indexes for {@link extrainfo}
47946 *   Key Type Meaning linespacing float Defines drawing linespacing
47947 * @return array {@link imageftbbox} returns an array with 8 elements
47948 *   representing four points making the bounding box of the text: 0
47949 *   lower left corner, X position 1 lower left corner, Y position 2
47950 *   lower right corner, X position 3 lower right corner, Y position 4
47951 *   upper right corner, X position 5 upper right corner, Y position 6
47952 *   upper left corner, X position 7 upper left corner, Y position
47953 * @since PHP 4 >= 4.0.7, PHP 5, PHP 7
47954 **/
47955function imageftbbox($size, $angle, $fontfile, $text, $extrainfo){}
47956
47957/**
47958 * Write text to the image using fonts using FreeType 2
47959 *
47960 * @param resource $image The font size to use in points.
47961 * @param float $size The angle in degrees, with 0 degrees being
47962 *   left-to-right reading text. Higher values represent a
47963 *   counter-clockwise rotation. For example, a value of 90 would result
47964 *   in bottom-to-top reading text.
47965 * @param float $angle The coordinates given by {@link x} and {@link y}
47966 *   will define the basepoint of the first character (roughly the
47967 *   lower-left corner of the character). This is different from the
47968 *   {@link imagestring}, where {@link x} and {@link y} define the
47969 *   upper-left corner of the first character. For example, "top left" is
47970 *   0, 0.
47971 * @param int $x The y-ordinate. This sets the position of the fonts
47972 *   baseline, not the very bottom of the character.
47973 * @param int $y The index of the desired color for the text, see
47974 *   {@link imagecolorexact}.
47975 * @param int $color The path to the TrueType font you wish to use.
47976 *   Depending on which version of the GD library PHP is using, when
47977 *   {@link fontfile} does not begin with a leading / then .ttf will be
47978 *   appended to the filename and the library will attempt to search for
47979 *   that filename along a library-defined font path. When using versions
47980 *   of the GD library lower than 2.0.18, a space character, rather than
47981 *   a semicolon, was used as the 'path separator' for different font
47982 *   files. Unintentional use of this feature will result in the warning
47983 *   message: Warning: Could not find/open font. For these affected
47984 *   versions, the only solution is moving the font to a path which does
47985 *   not contain spaces. In many cases where a font resides in the same
47986 *   directory as the script using it the following trick will alleviate
47987 *   any include problems.
47988 *
47989 *   <?php // Set the enviroment variable for GD putenv('GDFONTPATH=' .
47990 *   realpath('.'));
47991 *
47992 *   // Name the font to be used (note the lack of the .ttf extension)
47993 *   $font = 'SomeFont'; ?>
47994 * @param string $fontfile Text to be inserted into image.
47995 * @param string $text Possible array indexes for {@link extrainfo} Key
47996 *   Type Meaning linespacing float Defines drawing linespacing
47997 * @param array $extrainfo
47998 * @return array This function returns an array defining the four
47999 *   points of the box, starting in the lower left and moving
48000 *   counter-clockwise: 0 lower left x-coordinate 1 lower left
48001 *   y-coordinate 2 lower right x-coordinate 3 lower right y-coordinate 4
48002 *   upper right x-coordinate 5 upper right y-coordinate 6 upper left
48003 *   x-coordinate 7 upper left y-coordinate
48004 * @since PHP 4 >= 4.0.7, PHP 5, PHP 7
48005 **/
48006function imagefttext($image, $size, $angle, $x, $y, $color, $fontfile, $text, $extrainfo){}
48007
48008/**
48009 * Apply a gamma correction to a GD image
48010 *
48011 * Applies gamma correction to the given gd {@link image} given an input
48012 * and an output gamma.
48013 *
48014 * @param resource $image The input gamma.
48015 * @param float $inputgamma The output gamma.
48016 * @param float $outputgamma
48017 * @return bool
48018 * @since PHP 4, PHP 5, PHP 7
48019 **/
48020function imagegammacorrect($image, $inputgamma, $outputgamma){}
48021
48022/**
48023 * Output GD image to browser or file
48024 *
48025 * Outputs a GD image to the given {@link to}.
48026 *
48027 * @param resource $image
48028 * @param mixed $to
48029 * @return bool
48030 * @since PHP 4 >= 4.0.7, PHP 5, PHP 7
48031 **/
48032function imagegd($image, $to){}
48033
48034/**
48035 * Output GD2 image to browser or file
48036 *
48037 * Outputs a GD2 image to the given {@link to}.
48038 *
48039 * @param resource $image
48040 * @param mixed $to Chunk size.
48041 * @param int $chunk_size Either IMG_GD2_RAW or IMG_GD2_COMPRESSED.
48042 *   Default is IMG_GD2_RAW.
48043 * @param int $type
48044 * @return bool
48045 * @since PHP 4 >= 4.0.7, PHP 5, PHP 7
48046 **/
48047function imagegd2($image, $to, $chunk_size, $type){}
48048
48049/**
48050 * Get the clipping rectangle
48051 *
48052 * {@link imagegetclip} retrieves the current clipping rectangle, i.e.
48053 * the area beyond which no pixels will be drawn.
48054 *
48055 * @param resource $im
48056 * @return array The function returns an indexed array with the
48057 *   coordinates of the clipping rectangle which has the following
48058 *   entries: x-coordinate of the upper left corner y-coordinate of the
48059 *   upper left corner x-coordinate of the lower right corner
48060 *   y-coordinate of the lower right corner
48061 * @since PHP 7 >= 7.2.0
48062 **/
48063function imagegetclip($im){}
48064
48065/**
48066 * {@link imagegif} creates the GIF file in {@link to} from the image
48067 * {@link image}. The {@link image} argument is the return from the
48068 * {@link imagecreate} or imagecreatefrom* function.
48069 *
48070 * The image format will be GIF87a unless the image has been made
48071 * transparent with {@link imagecolortransparent}, in which case the
48072 * image format will be GIF89a.
48073 *
48074 * @param resource $image
48075 * @param mixed $to
48076 * @return bool
48077 * @since PHP 4, PHP 5, PHP 7
48078 **/
48079function imagegif($image, $to){}
48080
48081/**
48082 * Captures the whole screen
48083 *
48084 * Grabs a screenshot of the whole screen.
48085 *
48086 * @return resource Returns an image resource identifier on success,
48087 *   FALSE on failure.
48088 * @since PHP 5 >= 5.2.2, PHP 7
48089 **/
48090function imagegrabscreen(){}
48091
48092/**
48093 * Captures a window
48094 *
48095 * Grabs a window or its client area using a windows handle (HWND
48096 * property in COM instance)
48097 *
48098 * @param int $window_handle The HWND window ID.
48099 * @param int $client_area Include the client area of the application
48100 *   window.
48101 * @return resource Returns an image resource identifier on success,
48102 *   FALSE on failure.
48103 * @since PHP 5 >= 5.2.2, PHP 7
48104 **/
48105function imagegrabwindow($window_handle, $client_area){}
48106
48107/**
48108 * Enable or disable interlace
48109 *
48110 * {@link imageinterlace} turns the interlace bit on or off.
48111 *
48112 * If the interlace bit is set and the image is used as a JPEG image, the
48113 * image is created as a progressive JPEG.
48114 *
48115 * @param resource $image If non-zero, the image will be interlaced,
48116 *   else the interlace bit is turned off.
48117 * @param int $interlace
48118 * @return int Returns 1 if the interlace bit is set for the image, 0
48119 *   otherwise.
48120 * @since PHP 4, PHP 5, PHP 7
48121 **/
48122function imageinterlace($image, $interlace){}
48123
48124/**
48125 * Finds whether an image is a truecolor image
48126 *
48127 * {@link imageistruecolor} finds whether the image {@link image} is a
48128 * truecolor image.
48129 *
48130 * @param resource $image
48131 * @return bool Returns TRUE if the {@link image} is truecolor, FALSE
48132 *   otherwise.
48133 * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
48134 **/
48135function imageistruecolor($image){}
48136
48137/**
48138 * {@link imagejpeg} creates a JPEG file from the given {@link image}.
48139 *
48140 * @param resource $image
48141 * @param mixed $to {@link quality} is optional, and ranges from 0
48142 *   (worst quality, smaller file) to 100 (best quality, biggest file).
48143 *   The default (-1) uses the default IJG quality value (about 75).
48144 * @param int $quality
48145 * @return bool
48146 * @since PHP 4, PHP 5, PHP 7
48147 **/
48148function imagejpeg($image, $to, $quality){}
48149
48150/**
48151 * Set the alpha blending flag to use layering effects
48152 *
48153 * @param resource $image One of the following constants:
48154 *   IMG_EFFECT_REPLACE Use pixel replacement (equivalent of passing TRUE
48155 *   to {@link imagealphablending}) IMG_EFFECT_ALPHABLEND Use normal
48156 *   pixel blending (equivalent of passing FALSE to {@link
48157 *   imagealphablending}) IMG_EFFECT_NORMAL Same as
48158 *   IMG_EFFECT_ALPHABLEND. IMG_EFFECT_OVERLAY Overlay has the effect
48159 *   that black background pixels will remain black, white background
48160 *   pixels will remain white, but grey background pixels will take the
48161 *   colour of the foreground pixel. IMG_EFFECT_MULTIPLY Overlays with a
48162 *   multiply effect.
48163 * @param int $effect
48164 * @return bool
48165 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
48166 **/
48167function imagelayereffect($image, $effect){}
48168
48169/**
48170 * Draw a line
48171 *
48172 * Draws a line between the two given points.
48173 *
48174 * @param resource $image x-coordinate for first point.
48175 * @param int $x1 y-coordinate for first point.
48176 * @param int $y1 x-coordinate for second point.
48177 * @param int $x2 y-coordinate for second point.
48178 * @param int $y2 The line color.
48179 * @param int $color
48180 * @return bool
48181 * @since PHP 4, PHP 5, PHP 7
48182 **/
48183function imageline($image, $x1, $y1, $x2, $y2, $color){}
48184
48185/**
48186 * Load a new font
48187 *
48188 * {@link imageloadfont} loads a user-defined bitmap and returns its
48189 * identifier.
48190 *
48191 * @param string $file The font file format is currently binary and
48192 *   architecture dependent. This means you should generate the font
48193 *   files on the same type of CPU as the machine you are running PHP on.
48194 *
48195 *   Font file format byte position C data type description byte 0-3 int
48196 *   number of characters in the font byte 4-7 int value of first
48197 *   character in the font (often 32 for space) byte 8-11 int pixel width
48198 *   of each character byte 12-15 int pixel height of each character byte
48199 *   16- char array with character data, one byte per pixel in each
48200 *   character, for a total of (nchars*width*height) bytes.
48201 * @return int The font identifier which is always bigger than 5 to
48202 *   avoid conflicts with built-in fonts or FALSE on errors.
48203 * @since PHP 4, PHP 5, PHP 7
48204 **/
48205function imageloadfont($file){}
48206
48207/**
48208 * Draws an open polygon
48209 *
48210 * {@link imageopenpolygon} draws an open polygon on the given {@link
48211 * image}. Contrary to {@link imagepolygon}, no line is drawn between the
48212 * last and the first point.
48213 *
48214 * @param resource $image An array containing the polygon's vertices,
48215 *   e.g.: points[0] = x0 points[1] = y0 points[2] = x1 points[3] = y1
48216 * @param array $points Total number of points (vertices), which must
48217 *   be at least 3.
48218 * @param int $num_points
48219 * @param int $color
48220 * @return bool
48221 * @since PHP 7 >= 7.2.0
48222 **/
48223function imageopenpolygon($image, $points, $num_points, $color){}
48224
48225/**
48226 * Copy the palette from one image to another
48227 *
48228 * {@link imagepalettecopy} copies the palette from the {@link source}
48229 * image to the {@link destination} image.
48230 *
48231 * @param resource $destination The destination image resource.
48232 * @param resource $source The source image resource.
48233 * @return void
48234 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
48235 **/
48236function imagepalettecopy($destination, $source){}
48237
48238/**
48239 * Converts a palette based image to true color
48240 *
48241 * Converts a palette based image, created by functions like {@link
48242 * imagecreate} to a true color image, like {@link imagecreatetruecolor}.
48243 *
48244 * @param resource $src
48245 * @return bool Returns TRUE if the convertion was complete, or if the
48246 *   source image already is a true color image, otherwise FALSE is
48247 *   returned.
48248 * @since PHP 5 >= 5.5.0, PHP 7
48249 **/
48250function imagepalettetotruecolor($src){}
48251
48252/**
48253 * Output a PNG image to either the browser or a file
48254 *
48255 * Outputs or saves a PNG image from the given {@link image}.
48256 *
48257 * @param resource $image
48258 * @param mixed $to Compression level: from 0 (no compression) to 9.
48259 *   The default (-1) uses the zlib compression default. For more
48260 *   information see the zlib manual.
48261 * @param int $quality Allows reducing the PNG file size. It is a
48262 *   bitmask field which may be set to any combination of the
48263 *   PNG_FILTER_XXX constants. PNG_NO_FILTER or PNG_ALL_FILTERS may also
48264 *   be used to respectively disable or activate all filters. The default
48265 *   value (-1) disables filtering.
48266 * @param int $filters
48267 * @return bool
48268 * @since PHP 4, PHP 5, PHP 7
48269 **/
48270function imagepng($image, $to, $quality, $filters){}
48271
48272/**
48273 * Draws a polygon
48274 *
48275 * {@link imagepolygon} creates a polygon in the given {@link image}.
48276 *
48277 * @param resource $image An array containing the polygon's vertices,
48278 *   e.g.: points[0] = x0 points[1] = y0 points[2] = x1 points[3] = y1
48279 * @param array $points Total number of points (vertices), which must
48280 *   be at least 3.
48281 * @param int $num_points
48282 * @param int $color
48283 * @return bool
48284 * @since PHP 4, PHP 5, PHP 7
48285 **/
48286function imagepolygon($image, $points, $num_points, $color){}
48287
48288/**
48289 * Give the bounding box of a text rectangle using PostScript Type1 fonts
48290 *
48291 * Gives the bounding box of a text rectangle using PostScript Type1
48292 * fonts.
48293 *
48294 * The bounding box is calculated using information available from
48295 * character metrics, and unfortunately tends to differ slightly from the
48296 * results achieved by actually rasterizing the text. If the angle is 0
48297 * degrees, you can expect the text to need 1 pixel more to every
48298 * direction.
48299 *
48300 * @param string $text The text to be written.
48301 * @param resource $font {@link size} is expressed in pixels.
48302 * @param int $size Allows you to change the default value of a space
48303 *   in a font. This amount is added to the normal value and can also be
48304 *   negative. Expressed in character space units, where 1 unit is
48305 *   1/1000th of an em-square.
48306 * @return array Returns an array containing the following elements: 0
48307 *   left x-coordinate 1 upper y-coordinate 2 right x-coordinate 3 lower
48308 *   y-coordinate
48309 * @since PHP 4, PHP 5
48310 **/
48311function imagepsbbox($text, $font, $size){}
48312
48313/**
48314 * Change the character encoding vector of a font
48315 *
48316 * Loads a character encoding vector from a file and changes the fonts
48317 * encoding vector to it. As a PostScript fonts default vector lacks most
48318 * of the character positions above 127, you'll definitely want to change
48319 * this if you use a language other than English.
48320 *
48321 * If you find yourself using this function all the time, a much better
48322 * way to define the encoding is to set ps.default_encoding in the
48323 * configuration file to point to the right encoding file and all fonts
48324 * you load will automatically have the right encoding.
48325 *
48326 * @param resource $font_index The exact format of this file is
48327 *   described in T1libs documentation. T1lib comes with two ready-to-use
48328 *   files, IsoLatin1.enc and IsoLatin2.enc.
48329 * @param string $encodingfile
48330 * @return bool
48331 * @since PHP 4, PHP 5
48332 **/
48333function imagepsencodefont($font_index, $encodingfile){}
48334
48335/**
48336 * Extend or condense a font
48337 *
48338 * Extend or condense a font ({@link font_index}), if the value of the
48339 * {@link extend} parameter is less than one you will be condensing the
48340 * font.
48341 *
48342 * @param resource $font_index Extension value, must be greater than 0.
48343 * @param float $extend
48344 * @return bool
48345 * @since PHP 4, PHP 5
48346 **/
48347function imagepsextendfont($font_index, $extend){}
48348
48349/**
48350 * Free memory used by a PostScript Type 1 font
48351 *
48352 * {@link imagepsfreefont} frees memory used by a PostScript Type 1 font.
48353 *
48354 * @param resource $font_index
48355 * @return bool
48356 * @since PHP 4, PHP 5
48357 **/
48358function imagepsfreefont($font_index){}
48359
48360/**
48361 * Load a PostScript Type 1 font from file
48362 *
48363 * Load a PostScript Type 1 font from the given {@link filename}.
48364 *
48365 * @param string $filename Path to the Postscript font file.
48366 * @return resource In the case everything went right, a valid font
48367 *   index will be returned and can be used for further purposes.
48368 *   Otherwise the function returns FALSE.
48369 * @since PHP 4, PHP 5
48370 **/
48371function imagepsloadfont($filename){}
48372
48373/**
48374 * Slant a font
48375 *
48376 * Slant a given font.
48377 *
48378 * @param resource $font_index Slant level.
48379 * @param float $slant
48380 * @return bool
48381 * @since PHP 4, PHP 5
48382 **/
48383function imagepsslantfont($font_index, $slant){}
48384
48385/**
48386 * Draws a text over an image using PostScript Type1 fonts
48387 *
48388 * Draws a text on an image using PostScript Type1 fonts.
48389 *
48390 * Refer to PostScript documentation about fonts and their measuring
48391 * system if you have trouble understanding how this works.
48392 *
48393 * @param resource $image The text to be written.
48394 * @param string $text {@link size} is expressed in pixels.
48395 * @param resource $font_index The color in which the text will be
48396 *   painted.
48397 * @param int $size The color to which the text will try to fade in
48398 *   with antialiasing. No pixels with the color {@link background} are
48399 *   actually painted, so the background image does not need to be of
48400 *   solid color.
48401 * @param int $foreground x-coordinate for the lower-left corner of the
48402 *   first character.
48403 * @param int $background y-coordinate for the lower-left corner of the
48404 *   first character.
48405 * @param int $x Allows you to change the default value of a space in a
48406 *   font. This amount is added to the normal value and can also be
48407 *   negative. Expressed in character space units, where 1 unit is
48408 *   1/1000th of an em-square.
48409 * @param int $y {@link tightness} allows you to control the amount of
48410 *   white space between characters. This amount is added to the normal
48411 *   character width and can also be negative. Expressed in character
48412 *   space units, where 1 unit is 1/1000th of an em-square.
48413 * @param int $space {@link angle} is in degrees.
48414 * @param int $tightness Allows you to control the number of colours
48415 *   used for antialiasing text. Allowed values are 4 and 16. The higher
48416 *   value is recommended for text sizes lower than 20, where the effect
48417 *   in text quality is quite visible. With bigger sizes, use 4. It's
48418 *   less computationally intensive.
48419 * @param float $angle
48420 * @param int $antialias_steps
48421 * @return array This function returns an array containing the
48422 *   following elements: 0 lower left x-coordinate 1 lower left
48423 *   y-coordinate 2 upper right x-coordinate 3 upper right y-coordinate
48424 * @since PHP 4, PHP 5
48425 **/
48426function imagepstext($image, $text, $font_index, $size, $foreground, $background, $x, $y, $space, $tightness, $angle, $antialias_steps){}
48427
48428/**
48429 * Draw a rectangle
48430 *
48431 * {@link imagerectangle} creates a rectangle starting at the specified
48432 * coordinates.
48433 *
48434 * @param resource $image Upper left x coordinate.
48435 * @param int $x1 Upper left y coordinate 0, 0 is the top left corner
48436 *   of the image.
48437 * @param int $y1 Bottom right x coordinate.
48438 * @param int $x2 Bottom right y coordinate.
48439 * @param int $y2
48440 * @param int $color
48441 * @return bool
48442 * @since PHP 4, PHP 5, PHP 7
48443 **/
48444function imagerectangle($image, $x1, $y1, $x2, $y2, $color){}
48445
48446/**
48447 * Get or set the resolution of the image
48448 *
48449 * {@link imageresolution} allows to set and get the resolution of an
48450 * image in DPI (dots per inch). If none of the optional parameters is
48451 * given, the current resolution is returned as indexed array. If only
48452 * {@link res_x} is given, the horizontal and vertical resolution are set
48453 * to this value. If both optional parameters are given, the horizontal
48454 * and vertical resolution are set to these values, respectively.
48455 *
48456 * The resolution is only used as meta information when images are read
48457 * from and written to formats supporting this kind of information
48458 * (curently PNG and JPEG). It does not affect any drawing operations.
48459 * The default resolution for new images is 96 DPI.
48460 *
48461 * @param resource $image The horizontal resolution in DPI.
48462 * @return mixed When used as getter (first signature), it returns an
48463 *   indexed array of the horizontal and vertical resolution on success,
48464 *   . When used as setter (second signature), it returns TRUE on
48465 *   success, .
48466 * @since PHP 7 >= 7.2.0
48467 **/
48468function imageresolution($image){}
48469
48470/**
48471 * Rotate an image with a given angle
48472 *
48473 * Rotates the {@link image} image using the given {@link angle} in
48474 * degrees.
48475 *
48476 * The center of rotation is the center of the image, and the rotated
48477 * image may have different dimensions than the original image.
48478 *
48479 * @param resource $image Rotation angle, in degrees. The rotation
48480 *   angle is interpreted as the number of degrees to rotate the image
48481 *   anticlockwise.
48482 * @param float $angle Specifies the color of the uncovered zone after
48483 *   the rotation
48484 * @param int $bgd_color If set and non-zero, transparent colors are
48485 *   ignored (otherwise kept).
48486 * @param int $ignore_transparent
48487 * @return resource Returns an image resource for the rotated image, .
48488 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
48489 **/
48490function imagerotate($image, $angle, $bgd_color, $ignore_transparent){}
48491
48492/**
48493 * Whether to retain full alpha channel information when saving PNG
48494 * images
48495 *
48496 * {@link imagesavealpha} sets the flag which determines whether to
48497 * retain full alpha channel information (as opposed to single-color
48498 * transparency) when saving PNG images.
48499 *
48500 * Alphablending has to be disabled (imagealphablending($im, false)) to
48501 * retain the alpha-channel in the first place.
48502 *
48503 * @param resource $image Whether to save the alpha channel or not.
48504 *   Defaults to FALSE.
48505 * @param bool $saveflag
48506 * @return bool
48507 * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
48508 **/
48509function imagesavealpha($image, $saveflag){}
48510
48511/**
48512 * Scale an image using the given new width and height
48513 *
48514 * {@link imagescale} scales an image using the given interpolation
48515 * algorithm.
48516 *
48517 * @param resource $image The width to scale the image to.
48518 * @param int $new_width The height to scale the image to. If omitted
48519 *   or negative, the aspect ratio will be preserved.
48520 * @param int $new_height One of IMG_NEAREST_NEIGHBOUR,
48521 *   IMG_BILINEAR_FIXED, IMG_BICUBIC, IMG_BICUBIC_FIXED or anything else
48522 *   (will use two pass). IMG_WEIGHTED4 is not yet supported.
48523 * @param int $mode
48524 * @return resource Return the scaled image resource on success.
48525 * @since PHP 5 >= 5.5.0, PHP 7
48526 **/
48527function imagescale($image, $new_width, $new_height, $mode){}
48528
48529/**
48530 * Set the brush image for line drawing
48531 *
48532 * {@link imagesetbrush} sets the brush image to be used by all line
48533 * drawing functions (such as {@link imageline} and {@link imagepolygon})
48534 * when drawing with the special colors IMG_COLOR_BRUSHED or
48535 * IMG_COLOR_STYLEDBRUSHED.
48536 *
48537 * @param resource $image An image resource.
48538 * @param resource $brush
48539 * @return bool
48540 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
48541 **/
48542function imagesetbrush($image, $brush){}
48543
48544/**
48545 * Set the clipping rectangle
48546 *
48547 * {@link imagesetclip} sets the current clipping rectangle, i.e. the
48548 * area beyond which no pixels will be drawn.
48549 *
48550 * @param resource $im The x-coordinate of the upper left corner.
48551 * @param int $x1 The y-coordinate of the upper left corner.
48552 * @param int $y1 The x-coordinate of the lower right corner.
48553 * @param int $x2 The y-coordinate of the lower right corner.
48554 * @param int $y2
48555 * @return bool
48556 * @since PHP 7 >= 7.2.0
48557 **/
48558function imagesetclip($im, $x1, $y1, $x2, $y2){}
48559
48560/**
48561 * Set the interpolation method
48562 *
48563 * Sets the interpolation method, setting an interpolation method affects
48564 * the rendering of various functions in GD, such as the {@link
48565 * imagerotate} function.
48566 *
48567 * @param resource $image The interpolation method, which can be one of
48568 *   the following: IMG_BELL: Bell filter. IMG_BESSEL: Bessel filter.
48569 *   IMG_BICUBIC: Bicubic interpolation. IMG_BICUBIC_FIXED: Fixed point
48570 *   implementation of the bicubic interpolation. IMG_BILINEAR_FIXED:
48571 *   Fixed point implementation of the bilinear interpolation (default
48572 *   (also on image creation)). IMG_BLACKMAN: Blackman window function.
48573 *   IMG_BOX: Box blur filter. IMG_BSPLINE: Spline interpolation.
48574 *   IMG_CATMULLROM: Cubic Hermite spline interpolation. IMG_GAUSSIAN:
48575 *   Gaussian function. IMG_GENERALIZED_CUBIC: Generalized cubic spline
48576 *   fractal interpolation. IMG_HERMITE: Hermite interpolation.
48577 *   IMG_HAMMING: Hamming filter. IMG_HANNING: Hanning filter.
48578 *   IMG_MITCHELL: Mitchell filter. IMG_POWER: Power interpolation.
48579 *   IMG_QUADRATIC: Inverse quadratic interpolation. IMG_SINC: Sinc
48580 *   function. IMG_NEAREST_NEIGHBOUR: Nearest neighbour interpolation.
48581 *   IMG_WEIGHTED4: Weighting filter. IMG_TRIANGLE: Triangle
48582 *   interpolation.
48583 * @param int $method
48584 * @return bool
48585 * @since PHP 5 >= 5.5.0, PHP 7
48586 **/
48587function imagesetinterpolation($image, $method){}
48588
48589/**
48590 * Set a single pixel
48591 *
48592 * {@link imagesetpixel} draws a pixel at the specified coordinate.
48593 *
48594 * @param resource $image x-coordinate.
48595 * @param int $x y-coordinate.
48596 * @param int $y
48597 * @param int $color
48598 * @return bool
48599 * @since PHP 4, PHP 5, PHP 7
48600 **/
48601function imagesetpixel($image, $x, $y, $color){}
48602
48603/**
48604 * Set the style for line drawing
48605 *
48606 * {@link imagesetstyle} sets the style to be used by all line drawing
48607 * functions (such as {@link imageline} and {@link imagepolygon}) when
48608 * drawing with the special color IMG_COLOR_STYLED or lines of images
48609 * with color IMG_COLOR_STYLEDBRUSHED.
48610 *
48611 * @param resource $image An array of pixel colors. You can use the
48612 *   IMG_COLOR_TRANSPARENT constant to add a transparent pixel. Note that
48613 *   {@link style} must not be an empty array.
48614 * @param array $style
48615 * @return bool
48616 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
48617 **/
48618function imagesetstyle($image, $style){}
48619
48620/**
48621 * Set the thickness for line drawing
48622 *
48623 * {@link imagesetthickness} sets the thickness of the lines drawn when
48624 * drawing rectangles, polygons, arcs etc. to {@link thickness} pixels.
48625 *
48626 * @param resource $image Thickness, in pixels.
48627 * @param int $thickness
48628 * @return bool
48629 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
48630 **/
48631function imagesetthickness($image, $thickness){}
48632
48633/**
48634 * Set the tile image for filling
48635 *
48636 * {@link imagesettile} sets the tile image to be used by all region
48637 * filling functions (such as {@link imagefill} and {@link
48638 * imagefilledpolygon}) when filling with the special color
48639 * IMG_COLOR_TILED.
48640 *
48641 * A tile is an image used to fill an area with a repeated pattern. Any
48642 * GD image can be used as a tile, and by setting the transparent color
48643 * index of the tile image with {@link imagecolortransparent}, a tile
48644 * allows certain parts of the underlying area to shine through can be
48645 * created.
48646 *
48647 * @param resource $image The image resource to be used as a tile.
48648 * @param resource $tile
48649 * @return bool
48650 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
48651 **/
48652function imagesettile($image, $tile){}
48653
48654/**
48655 * Draw a string horizontally
48656 *
48657 * Draws a {@link string} at the given coordinates.
48658 *
48659 * @param resource $image x-coordinate of the upper left corner.
48660 * @param int $font y-coordinate of the upper left corner.
48661 * @param int $x The string to be written.
48662 * @param int $y
48663 * @param string $string
48664 * @param int $color
48665 * @return bool
48666 * @since PHP 4, PHP 5, PHP 7
48667 **/
48668function imagestring($image, $font, $x, $y, $string, $color){}
48669
48670/**
48671 * Draw a string vertically
48672 *
48673 * Draws a {@link string} vertically at the given coordinates.
48674 *
48675 * @param resource $image x-coordinate of the bottom left corner.
48676 * @param int $font y-coordinate of the bottom left corner.
48677 * @param int $x The string to be written.
48678 * @param int $y
48679 * @param string $string
48680 * @param int $color
48681 * @return bool
48682 * @since PHP 4, PHP 5, PHP 7
48683 **/
48684function imagestringup($image, $font, $x, $y, $string, $color){}
48685
48686/**
48687 * Get image width
48688 *
48689 * Returns the width of the given {@link image} resource.
48690 *
48691 * @param resource $image
48692 * @return int Return the width of the {@link image} or FALSE on
48693 *   errors.
48694 * @since PHP 4, PHP 5, PHP 7
48695 **/
48696function imagesx($image){}
48697
48698/**
48699 * Get image height
48700 *
48701 * Returns the height of the given {@link image} resource.
48702 *
48703 * @param resource $image
48704 * @return int Return the height of the {@link image} or FALSE on
48705 *   errors.
48706 * @since PHP 4, PHP 5, PHP 7
48707 **/
48708function imagesy($image){}
48709
48710/**
48711 * Convert a true color image to a palette image
48712 *
48713 * {@link imagetruecolortopalette} converts a truecolor image to a
48714 * palette image. The code for this function was originally drawn from
48715 * the Independent JPEG Group library code, which is excellent. The code
48716 * has been modified to preserve as much alpha channel information as
48717 * possible in the resulting palette, in addition to preserving colors as
48718 * well as possible. This does not work as well as might be hoped. It is
48719 * usually best to simply produce a truecolor output image instead, which
48720 * guarantees the highest output quality.
48721 *
48722 * @param resource $image Indicates if the image should be dithered -
48723 *   if it is TRUE then dithering will be used which will result in a
48724 *   more speckled image but with better color approximation.
48725 * @param bool $dither Sets the maximum number of colors that should be
48726 *   retained in the palette.
48727 * @param int $ncolors
48728 * @return bool
48729 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
48730 **/
48731function imagetruecolortopalette($image, $dither, $ncolors){}
48732
48733/**
48734 * Give the bounding box of a text using TrueType fonts
48735 *
48736 * This function calculates and returns the bounding box in pixels for a
48737 * TrueType text.
48738 *
48739 * @param float $size
48740 * @param float $angle Angle in degrees in which {@link text} will be
48741 *   measured.
48742 * @param string $fontfile The string to be measured.
48743 * @param string $text
48744 * @return array {@link imagettfbbox} returns an array with 8 elements
48745 *   representing four points making the bounding box of the text on
48746 *   success and FALSE on error. key contents 0 lower left corner, X
48747 *   position 1 lower left corner, Y position 2 lower right corner, X
48748 *   position 3 lower right corner, Y position 4 upper right corner, X
48749 *   position 5 upper right corner, Y position 6 upper left corner, X
48750 *   position 7 upper left corner, Y position
48751 * @since PHP 4, PHP 5, PHP 7
48752 **/
48753function imagettfbbox($size, $angle, $fontfile, $text){}
48754
48755/**
48756 * Write text to the image using TrueType fonts
48757 *
48758 * Writes the given {@link text} into the image using TrueType fonts.
48759 *
48760 * @param resource $image
48761 * @param float $size The angle in degrees, with 0 degrees being
48762 *   left-to-right reading text. Higher values represent a
48763 *   counter-clockwise rotation. For example, a value of 90 would result
48764 *   in bottom-to-top reading text.
48765 * @param float $angle The coordinates given by {@link x} and {@link y}
48766 *   will define the basepoint of the first character (roughly the
48767 *   lower-left corner of the character). This is different from the
48768 *   {@link imagestring}, where {@link x} and {@link y} define the
48769 *   upper-left corner of the first character. For example, "top left" is
48770 *   0, 0.
48771 * @param int $x The y-ordinate. This sets the position of the fonts
48772 *   baseline, not the very bottom of the character.
48773 * @param int $y The color index. Using the negative of a color index
48774 *   has the effect of turning off antialiasing. See {@link
48775 *   imagecolorallocate}.
48776 * @param int $color The text string in UTF-8 encoding. May include
48777 *   decimal numeric character references (of the form: &#8364;) to
48778 *   access characters in a font beyond position 127. The hexadecimal
48779 *   format (like &#xA9;) is supported. Strings in UTF-8 encoding can be
48780 *   passed directly. Named entities, such as &copy;, are not supported.
48781 *   Consider using {@link html_entity_decode} to decode these named
48782 *   entities into UTF-8 strings. If a character is used in the string
48783 *   which is not supported by the font, a hollow rectangle will replace
48784 *   the character.
48785 * @param string $fontfile
48786 * @param string $text
48787 * @return array Returns an array with 8 elements representing four
48788 *   points making the bounding box of the text. The order of the points
48789 *   is lower left, lower right, upper right, upper left. The points are
48790 *   relative to the text regardless of the angle, so "upper left" means
48791 *   in the top left-hand corner when you see the text horizontally.
48792 *   Returns FALSE on error.
48793 * @since PHP 4, PHP 5, PHP 7
48794 **/
48795function imagettftext($image, $size, $angle, $x, $y, $color, $fontfile, $text){}
48796
48797/**
48798 * Return the image types supported by this PHP build
48799 *
48800 * Returns the image types supported by the current PHP installation.
48801 *
48802 * @return int Returns a bit-field corresponding to the image formats
48803 *   supported by the version of GD linked into PHP. The following bits
48804 *   are returned, IMG_BMP | IMG_GIF | IMG_JPG | IMG_PNG | IMG_WBMP |
48805 *   IMG_XPM | IMG_WEBP.
48806 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
48807 **/
48808function imagetypes(){}
48809
48810/**
48811 * {@link imagewbmp} outputs or save a WBMP version of the given {@link
48812 * image}.
48813 *
48814 * @param resource $image
48815 * @param mixed $to You can set the foreground color with this
48816 *   parameter by setting an identifier obtained from {@link
48817 *   imagecolorallocate}. The default foreground color is black.
48818 * @param int $foreground
48819 * @return bool
48820 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
48821 **/
48822function imagewbmp($image, $to, $foreground){}
48823
48824/**
48825 * Output a WebP image to browser or file
48826 *
48827 * Outputs or saves a WebP version of the given {@link image}.
48828 *
48829 * @param resource $image
48830 * @param mixed $to {@link quality} ranges from 0 (worst quality,
48831 *   smaller file) to 100 (best quality, biggest file).
48832 * @param int $quality
48833 * @return bool
48834 * @since PHP 5 >= 5.4.0, PHP 7
48835 **/
48836function imagewebp($image, $to, $quality){}
48837
48838/**
48839 * Output an XBM image to browser or file
48840 *
48841 * Outputs or save an XBM version of the given {@link image}.
48842 *
48843 * @param resource $image The path to save the file to. If not set or
48844 *   NULL, the raw image stream will be outputted directly. The {@link
48845 *   filename} (without the .xbm extension) is also used for the C
48846 *   identifiers of the XBM, whereby non alphanumeric characters of the
48847 *   current locale are substituted by underscores. If {@link filename}
48848 *   is set to NULL, image is used to build the C identifiers.
48849 * @param string $filename You can set the foreground color with this
48850 *   parameter by setting an identifier obtained from {@link
48851 *   imagecolorallocate}. The default foreground color is black. All
48852 *   other colors are treated as background.
48853 * @param int $foreground
48854 * @return bool
48855 * @since PHP 5, PHP 7
48856 **/
48857function imagexbm($image, $filename, $foreground){}
48858
48859/**
48860 * Get file extension for image type
48861 *
48862 * Returns the extension for the given IMAGETYPE_XXX constant.
48863 *
48864 * @param int $imagetype One of the IMAGETYPE_XXX constant.
48865 * @param bool $include_dot Whether to prepend a dot to the extension
48866 *   or not. Default to TRUE.
48867 * @return string A string with the extension corresponding to the
48868 *   given image type.
48869 * @since PHP 5 >= 5.2.0, PHP 7
48870 **/
48871function image_type_to_extension($imagetype, $include_dot){}
48872
48873/**
48874 * Get Mime-Type for image-type returned by getimagesize, exif_read_data,
48875 * exif_thumbnail, exif_imagetype
48876 *
48877 * The {@link image_type_to_mime_type} function will determine the
48878 * Mime-Type for an IMAGETYPE constant.
48879 *
48880 * @param int $imagetype One of the IMAGETYPE_XXX constants.
48881 * @return string The returned values are as follows Returned values
48882 *   Constants {@link imagetype} Returned value IMAGETYPE_GIF image/gif
48883 *   IMAGETYPE_JPEG image/jpeg IMAGETYPE_PNG image/png IMAGETYPE_SWF
48884 *   application/x-shockwave-flash IMAGETYPE_PSD image/psd IMAGETYPE_BMP
48885 *   image/bmp IMAGETYPE_TIFF_II (intel byte order) image/tiff
48886 *   IMAGETYPE_TIFF_MM (motorola byte order) image/tiff IMAGETYPE_JPC
48887 *   application/octet-stream IMAGETYPE_JP2 image/jp2 IMAGETYPE_JPX
48888 *   application/octet-stream IMAGETYPE_JB2 application/octet-stream
48889 *   IMAGETYPE_SWC application/x-shockwave-flash IMAGETYPE_IFF image/iff
48890 *   IMAGETYPE_WBMP image/vnd.wap.wbmp IMAGETYPE_XBM image/xbm
48891 *   IMAGETYPE_ICO image/vnd.microsoft.icon IMAGETYPE_WEBP image/webp
48892 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
48893 **/
48894function image_type_to_mime_type($imagetype){}
48895
48896/**
48897 * Convert an 8bit string to a quoted-printable string
48898 *
48899 * Convert an 8bit string to a quoted-printable string (according to
48900 * RFC2045, section 6.7).
48901 *
48902 * @param string $string The 8bit string to convert
48903 * @return string Returns a quoted-printable string.
48904 * @since PHP 4, PHP 5, PHP 7
48905 **/
48906function imap_8bit($string){}
48907
48908/**
48909 * Returns all IMAP alert messages that have occurred
48910 *
48911 * Returns all of the IMAP alert messages generated since the last {@link
48912 * imap_alerts} call, or the beginning of the page.
48913 *
48914 * When {@link imap_alerts} is called, the alert stack is subsequently
48915 * cleared. The IMAP specification requires that these messages be passed
48916 * to the user.
48917 *
48918 * @return array Returns an array of all of the IMAP alert messages
48919 *   generated or FALSE if no alert messages are available.
48920 * @since PHP 4, PHP 5, PHP 7
48921 **/
48922function imap_alerts(){}
48923
48924/**
48925 * Append a string message to a specified mailbox
48926 *
48927 * Appends a string {@link message} to the specified {@link mailbox}.
48928 *
48929 * @param resource $imap_stream The mailbox name, see {@link imap_open}
48930 *   for more information
48931 * @param string $mailbox The message to be append, as a string When
48932 *   talking to the Cyrus IMAP server, you must use "\r\n" as your
48933 *   end-of-line terminator instead of "\n" or the operation will fail
48934 * @param string $message If provided, the {@link options} will also be
48935 *   written to the {@link mailbox}
48936 * @param string $options If this parameter is set, it will set the
48937 *   INTERNALDATE on the appended message. The parameter should be a date
48938 *   string that conforms to the rfc2060 specifications for a date_time
48939 *   value.
48940 * @param string $internal_date
48941 * @return bool
48942 * @since PHP 4, PHP 5, PHP 7
48943 **/
48944function imap_append($imap_stream, $mailbox, $message, $options, $internal_date){}
48945
48946/**
48947 * Decode BASE64 encoded text
48948 *
48949 * Decodes the given BASE-64 encoded {@link text}.
48950 *
48951 * @param string $text The encoded text
48952 * @return string Returns the decoded message as a string.
48953 * @since PHP 4, PHP 5, PHP 7
48954 **/
48955function imap_base64($text){}
48956
48957/**
48958 * Convert an 8bit string to a base64 string
48959 *
48960 * Convert an 8bit string to a base64 string according to RFC2045,
48961 * Section 6.8.
48962 *
48963 * @param string $string The 8bit string
48964 * @return string Returns a base64 encoded string.
48965 * @since PHP 4, PHP 5, PHP 7
48966 **/
48967function imap_binary($string){}
48968
48969/**
48970 * Read the message body
48971 *
48972 * {@link imap_body} returns the body of the message, numbered {@link
48973 * msg_number} in the current mailbox.
48974 *
48975 * {@link imap_body} will only return a verbatim copy of the message
48976 * body. To extract single parts of a multipart MIME-encoded message you
48977 * have to use {@link imap_fetchstructure} to analyze its structure and
48978 * {@link imap_fetchbody} to extract a copy of a single body component.
48979 *
48980 * @param resource $imap_stream The message number
48981 * @param int $msg_number The optional {@link options} are a bit mask
48982 *   with one or more of the following: FT_UID - The {@link msg_number}
48983 *   is a UID FT_PEEK - Do not set the \Seen flag if not already set
48984 *   FT_INTERNAL - The return string is in internal format, will not
48985 *   canonicalize to CRLF.
48986 * @param int $options
48987 * @return string Returns the body of the specified message, as a
48988 *   string.
48989 * @since PHP 4, PHP 5, PHP 7
48990 **/
48991function imap_body($imap_stream, $msg_number, $options){}
48992
48993/**
48994 * Read the structure of a specified body section of a specific message
48995 *
48996 * @param resource $imap_stream The message number
48997 * @param int $msg_number The body section to read
48998 * @param string $section
48999 * @return object Returns the information in an object, for a detailed
49000 *   description of the object structure and properties see {@link
49001 *   imap_fetchstructure}.
49002 * @since PHP 4, PHP 5, PHP 7
49003 **/
49004function imap_bodystruct($imap_stream, $msg_number, $section){}
49005
49006/**
49007 * Check current mailbox
49008 *
49009 * Checks information about the current mailbox.
49010 *
49011 * @param resource $imap_stream
49012 * @return object Returns the information in an object with following
49013 *   properties: Date - current system time formatted according to
49014 *   RFC2822 Driver - protocol used to access this mailbox: POP3, IMAP,
49015 *   NNTP Mailbox - the mailbox name Nmsgs - number of messages in the
49016 *   mailbox Recent - number of recent messages in the mailbox
49017 * @since PHP 4, PHP 5, PHP 7
49018 **/
49019function imap_check($imap_stream){}
49020
49021/**
49022 * Clears flags on messages
49023 *
49024 * This function causes a store to delete the specified {@link flag} to
49025 * the flags set for the messages in the specified {@link sequence}.
49026 *
49027 * @param resource $imap_stream A sequence of message numbers. You can
49028 *   enumerate desired messages with the X,Y syntax, or retrieve all
49029 *   messages within an interval with the X:Y syntax
49030 * @param string $sequence The flags which you can unset are "\\Seen",
49031 *   "\\Answered", "\\Flagged", "\\Deleted", and "\\Draft" (as defined by
49032 *   RFC2060)
49033 * @param string $flag {@link options} are a bit mask and may contain
49034 *   the single option: ST_UID - The sequence argument contains UIDs
49035 *   instead of sequence numbers
49036 * @param int $options
49037 * @return bool
49038 * @since PHP 4, PHP 5, PHP 7
49039 **/
49040function imap_clearflag_full($imap_stream, $sequence, $flag, $options){}
49041
49042/**
49043 * Close an IMAP stream
49044 *
49045 * Closes the imap stream.
49046 *
49047 * @param resource $imap_stream If set to CL_EXPUNGE, the function will
49048 *   silently expunge the mailbox before closing, removing all messages
49049 *   marked for deletion. You can achieve the same thing by using {@link
49050 *   imap_expunge}
49051 * @param int $flag
49052 * @return bool
49053 * @since PHP 4, PHP 5, PHP 7
49054 **/
49055function imap_close($imap_stream, $flag){}
49056
49057/**
49058 * Create a new mailbox
49059 *
49060 * Creates a new mailbox specified by {@link mailbox}.
49061 *
49062 * @param resource $imap_stream The mailbox name, see {@link imap_open}
49063 *   for more information. Names containing international characters
49064 *   should be encoded by {@link imap_utf7_encode}
49065 * @param string $mailbox
49066 * @return bool
49067 * @since PHP 4, PHP 5, PHP 7
49068 **/
49069function imap_create($imap_stream, $mailbox){}
49070
49071/**
49072 * Create a new mailbox
49073 *
49074 * Creates a new mailbox specified by {@link mailbox}.
49075 *
49076 * @param resource $imap_stream The mailbox name, see {@link imap_open}
49077 *   for more information. Names containing international characters
49078 *   should be encoded by {@link imap_utf7_encode}
49079 * @param string $mailbox
49080 * @return bool
49081 * @since PHP 4, PHP 5, PHP 7
49082 **/
49083function imap_createmailbox($imap_stream, $mailbox){}
49084
49085/**
49086 * Mark a message for deletion from current mailbox
49087 *
49088 * Marks messages listed in {@link msg_number} for deletion. Messages
49089 * marked for deletion will stay in the mailbox until either {@link
49090 * imap_expunge} is called or {@link imap_close} is called with the
49091 * optional parameter CL_EXPUNGE.
49092 *
49093 * @param resource $imap_stream The message number
49094 * @param int $msg_number You can set the FT_UID which tells the
49095 *   function to treat the {@link msg_number} argument as a UID.
49096 * @param int $options
49097 * @return bool Returns TRUE.
49098 * @since PHP 4, PHP 5, PHP 7
49099 **/
49100function imap_delete($imap_stream, $msg_number, $options){}
49101
49102/**
49103 * Delete a mailbox
49104 *
49105 * Deletes the specified {@link mailbox}.
49106 *
49107 * @param resource $imap_stream The mailbox name, see {@link imap_open}
49108 *   for more information
49109 * @param string $mailbox
49110 * @return bool
49111 * @since PHP 4, PHP 5, PHP 7
49112 **/
49113function imap_deletemailbox($imap_stream, $mailbox){}
49114
49115/**
49116 * Returns all of the IMAP errors that have occurred
49117 *
49118 * Gets all of the IMAP errors (if any) that have occurred during this
49119 * page request or since the error stack was reset.
49120 *
49121 * When {@link imap_errors} is called, the error stack is subsequently
49122 * cleared.
49123 *
49124 * @return array This function returns an array of all of the IMAP
49125 *   error messages generated since the last {@link imap_errors} call, or
49126 *   the beginning of the page. Returns FALSE if no error messages are
49127 *   available.
49128 * @since PHP 4, PHP 5, PHP 7
49129 **/
49130function imap_errors(){}
49131
49132/**
49133 * Delete all messages marked for deletion
49134 *
49135 * Deletes all the messages marked for deletion by {@link imap_delete},
49136 * {@link imap_mail_move}, or {@link imap_setflag_full}.
49137 *
49138 * @param resource $imap_stream
49139 * @return bool Returns TRUE.
49140 * @since PHP 4, PHP 5, PHP 7
49141 **/
49142function imap_expunge($imap_stream){}
49143
49144/**
49145 * Fetch a particular section of the body of the message
49146 *
49147 * Fetch of a particular section of the body of the specified messages.
49148 * Body parts are not decoded by this function.
49149 *
49150 * @param resource $imap_stream The message number
49151 * @param int $msg_number The part number. It is a string of integers
49152 *   delimited by period which index into a body part list as per the
49153 *   IMAP4 specification
49154 * @param string $section A bitmask with one or more of the following:
49155 *   FT_UID - The {@link msg_number} is a UID FT_PEEK - Do not set the
49156 *   \Seen flag if not already set FT_INTERNAL - The return string is in
49157 *   internal format, will not canonicalize to CRLF.
49158 * @param int $options
49159 * @return string Returns a particular section of the body of the
49160 *   specified messages as a text string.
49161 * @since PHP 4, PHP 5, PHP 7
49162 **/
49163function imap_fetchbody($imap_stream, $msg_number, $section, $options){}
49164
49165/**
49166 * Returns header for a message
49167 *
49168 * This function causes a fetch of the complete, unfiltered RFC2822
49169 * format header of the specified message.
49170 *
49171 * @param resource $imap_stream The message number
49172 * @param int $msg_number The possible {@link options} are: FT_UID -
49173 *   The {@link msgno} argument is a UID FT_INTERNAL - The return string
49174 *   is in "internal" format, without any attempt to canonicalize to CRLF
49175 *   newlines FT_PREFETCHTEXT - The RFC822.TEXT should be pre-fetched at
49176 *   the same time. This avoids an extra RTT on an IMAP connection if a
49177 *   full message text is desired (e.g. in a "save to local file"
49178 *   operation)
49179 * @param int $options
49180 * @return string Returns the header of the specified message as a text
49181 *   string.
49182 * @since PHP 4, PHP 5, PHP 7
49183 **/
49184function imap_fetchheader($imap_stream, $msg_number, $options){}
49185
49186/**
49187 * Fetch MIME headers for a particular section of the message
49188 *
49189 * Fetch the MIME headers of a particular section of the body of the
49190 * specified messages.
49191 *
49192 * @param resource $imap_stream The message number
49193 * @param int $msg_number The part number. It is a string of integers
49194 *   delimited by period which index into a body part list as per the
49195 *   IMAP4 specification
49196 * @param string $section A bitmask with one or more of the following:
49197 *   FT_UID - The {@link msg_number} is a UID FT_PEEK - Do not set the
49198 *   \Seen flag if not already set FT_INTERNAL - The return string is in
49199 *   internal format, will not canonicalize to CRLF.
49200 * @param int $options
49201 * @return string Returns the MIME headers of a particular section of
49202 *   the body of the specified messages as a text string.
49203 * @since PHP 5 >= 5.3.6, PHP 7
49204 **/
49205function imap_fetchmime($imap_stream, $msg_number, $section, $options){}
49206
49207/**
49208 * Read the structure of a particular message
49209 *
49210 * Fetches all the structured information for a given message.
49211 *
49212 * @param resource $imap_stream The message number
49213 * @param int $msg_number This optional parameter only has a single
49214 *   option, FT_UID, which tells the function to treat the {@link
49215 *   msg_number} argument as a UID.
49216 * @param int $options
49217 * @return object Returns an object includes the envelope, internal
49218 *   date, size, flags and body structure along with a similar object for
49219 *   each mime attachment. The structure of the returned objects is as
49220 *   follows:
49221 * @since PHP 4, PHP 5, PHP 7
49222 **/
49223function imap_fetchstructure($imap_stream, $msg_number, $options){}
49224
49225/**
49226 * Read the message body
49227 *
49228 * {@link imap_fetchtext} returns the body of the message, numbered
49229 * {@link msg_number} in the current mailbox.
49230 *
49231 * {@link imap_fetchtext} will only return a verbatim copy of the message
49232 * body. To extract single parts of a multipart MIME-encoded message you
49233 * have to use {@link imap_fetchstructure} to analyze its structure and
49234 * {@link imap_fetchbody} to extract a copy of a single body component.
49235 *
49236 * @param resource $imap_stream The message number
49237 * @param int $msg_number The optional {@link options} are a bit mask
49238 *   with one or more of the following: FT_UID - The {@link msg_number}
49239 *   is a UID FT_PEEK - Do not set the \Seen flag if not already set
49240 *   FT_INTERNAL - The return string is in internal format, will not
49241 *   canonicalize to CRLF.
49242 * @param int $options
49243 * @return string Returns the body of the specified message, as a
49244 *   string.
49245 * @since PHP 4, PHP 5, PHP 7
49246 **/
49247function imap_fetchtext($imap_stream, $msg_number, $options){}
49248
49249/**
49250 * Read an overview of the information in the headers of the given
49251 * message
49252 *
49253 * This function fetches mail headers for the given {@link sequence} and
49254 * returns an overview of their contents.
49255 *
49256 * @param resource $imap_stream A message sequence description. You can
49257 *   enumerate desired messages with the X,Y syntax, or retrieve all
49258 *   messages within an interval with the X:Y syntax
49259 * @param string $sequence {@link sequence} will contain a sequence of
49260 *   message indices or UIDs, if this parameter is set to FT_UID.
49261 * @param int $options
49262 * @return array Returns an array of objects describing one message
49263 *   header each. The object will only define a property if it exists.
49264 *   The possible properties are: subject - the messages subject from -
49265 *   who sent it to - recipient date - when was it sent message_id -
49266 *   Message-ID references - is a reference to this message id
49267 *   in_reply_to - is a reply to this message id size - size in bytes uid
49268 *   - UID the message has in the mailbox msgno - message sequence number
49269 *   in the mailbox recent - this message is flagged as recent flagged -
49270 *   this message is flagged answered - this message is flagged as
49271 *   answered deleted - this message is flagged for deletion seen - this
49272 *   message is flagged as already read draft - this message is flagged
49273 *   as being a draft udate - the UNIX timestamp of the arrival date
49274 * @since PHP 4, PHP 5, PHP 7
49275 **/
49276function imap_fetch_overview($imap_stream, $sequence, $options){}
49277
49278/**
49279 * Clears IMAP cache
49280 *
49281 * Purges the cache of entries of a specific type.
49282 *
49283 * @param resource $imap_stream Specifies the cache to purge. It may
49284 *   one or a combination of the following constants: IMAP_GC_ELT
49285 *   (message cache elements), IMAP_GC_ENV (envelope and bodies),
49286 *   IMAP_GC_TEXTS (texts).
49287 * @param int $caches
49288 * @return bool
49289 * @since PHP 5 >= 5.3.0, PHP 7
49290 **/
49291function imap_gc($imap_stream, $caches){}
49292
49293/**
49294 * Gets the ACL for a given mailbox
49295 *
49296 * @param resource $imap_stream The mailbox name, see {@link imap_open}
49297 *   for more information
49298 * @param string $mailbox
49299 * @return array Returns an associative array of "folder" => "acl"
49300 *   pairs.
49301 * @since PHP 5, PHP 7
49302 **/
49303function imap_getacl($imap_stream, $mailbox){}
49304
49305/**
49306 * Read the list of mailboxes, returning detailed information on each one
49307 *
49308 * Gets information on the mailboxes.
49309 *
49310 * @param resource $imap_stream {@link ref} should normally be just the
49311 *   server specification as described in {@link imap_open}
49312 * @param string $ref
49313 * @param string $pattern
49314 * @return array Returns an array of objects containing mailbox
49315 *   information. Each object has the attributes {@link name}, specifying
49316 *   the full name of the mailbox; {@link delimiter}, which is the
49317 *   hierarchy delimiter for the part of the hierarchy this mailbox is
49318 *   in; and {@link attributes}. {@link Attributes} is a bitmask that can
49319 *   be tested against: LATT_NOINFERIORS - This mailbox not contains, and
49320 *   may not contain any "children" (there are no mailboxes below this
49321 *   one). Calling {@link imap_createmailbox} will not work on this
49322 *   mailbox. LATT_NOSELECT - This is only a container, not a mailbox -
49323 *   you cannot open it. LATT_MARKED - This mailbox is marked. This means
49324 *   that it may contain new messages since the last time it was checked.
49325 *   Not provided by all IMAP servers. LATT_UNMARKED - This mailbox is
49326 *   not marked, does not contain new messages. If either MARKED or
49327 *   UNMARKED is provided, you can assume the IMAP server supports this
49328 *   feature for this mailbox. LATT_REFERRAL - This container has a
49329 *   referral to a remote mailbox. LATT_HASCHILDREN - This mailbox has
49330 *   selectable inferiors. LATT_HASNOCHILDREN - This mailbox has no
49331 *   selectable inferiors.
49332 * @since PHP 4, PHP 5, PHP 7
49333 **/
49334function imap_getmailboxes($imap_stream, $ref, $pattern){}
49335
49336/**
49337 * List all the subscribed mailboxes
49338 *
49339 * Gets information about the subscribed mailboxes.
49340 *
49341 * Identical to {@link imap_getmailboxes}, except that it only returns
49342 * mailboxes that the user is subscribed to.
49343 *
49344 * @param resource $imap_stream {@link ref} should normally be just the
49345 *   server specification as described in {@link imap_open}
49346 * @param string $ref
49347 * @param string $pattern
49348 * @return array Returns an array of objects containing mailbox
49349 *   information. Each object has the attributes {@link name}, specifying
49350 *   the full name of the mailbox; {@link delimiter}, which is the
49351 *   hierarchy delimiter for the part of the hierarchy this mailbox is
49352 *   in; and {@link attributes}. {@link Attributes} is a bitmask that can
49353 *   be tested against: LATT_NOINFERIORS - This mailbox has no "children"
49354 *   (there are no mailboxes below this one). LATT_NOSELECT - This is
49355 *   only a container, not a mailbox - you cannot open it. LATT_MARKED -
49356 *   This mailbox is marked. Only used by UW-IMAPD. LATT_UNMARKED - This
49357 *   mailbox is not marked. Only used by UW-IMAPD. LATT_REFERRAL - This
49358 *   container has a referral to a remote mailbox. LATT_HASCHILDREN -
49359 *   This mailbox has selectable inferiors. LATT_HASNOCHILDREN - This
49360 *   mailbox has no selectable inferiors.
49361 * @since PHP 4, PHP 5, PHP 7
49362 **/
49363function imap_getsubscribed($imap_stream, $ref, $pattern){}
49364
49365/**
49366 * Retrieve the quota level settings, and usage statics per mailbox
49367 *
49368 * For a non-admin user version of this function, please see the {@link
49369 * imap_get_quotaroot} function of PHP.
49370 *
49371 * @param resource $imap_stream {@link quota_root} should normally be
49372 *   in the form of user.name where name is the mailbox you wish to
49373 *   retrieve information about.
49374 * @param string $quota_root
49375 * @return array Returns an array with integer values limit and usage
49376 *   for the given mailbox. The value of limit represents the total
49377 *   amount of space allowed for this mailbox. The usage value represents
49378 *   the mailboxes current level of capacity. Will return FALSE in the
49379 *   case of failure.
49380 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
49381 **/
49382function imap_get_quota($imap_stream, $quota_root){}
49383
49384/**
49385 * Retrieve the quota settings per user
49386 *
49387 * Retrieve the quota settings per user. The limit value represents the
49388 * total amount of space allowed for this user's total mailbox usage. The
49389 * usage value represents the user's current total mailbox capacity.
49390 *
49391 * @param resource $imap_stream {@link quota_root} should normally be
49392 *   in the form of which mailbox (i.e. INBOX).
49393 * @param string $quota_root
49394 * @return array Returns an array of integer values pertaining to the
49395 *   specified user mailbox. All values contain a key based upon the
49396 *   resource name, and a corresponding array with the usage and limit
49397 *   values within.
49398 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
49399 **/
49400function imap_get_quotaroot($imap_stream, $quota_root){}
49401
49402/**
49403 * Read the header of the message
49404 *
49405 * Gets information about the given message number by reading its
49406 * headers.
49407 *
49408 * @param resource $imap_stream The message number
49409 * @param int $msg_number Number of characters for the fetchfrom
49410 *   property. Must be greater than or equal to zero.
49411 * @param int $fromlength Number of characters for the fetchsubject
49412 *   property Must be greater than or equal to zero.
49413 * @param int $subjectlength
49414 * @param string $defaulthost
49415 * @return object Returns FALSE on error or, if successful, the
49416 *   information in an object with following properties: toaddress - full
49417 *   to: line, up to 1024 characters to - an array of objects from the
49418 *   To: line, with the following properties: personal, adl, mailbox, and
49419 *   host fromaddress - full from: line, up to 1024 characters from - an
49420 *   array of objects from the From: line, with the following properties:
49421 *   personal, adl, mailbox, and host ccaddress - full cc: line, up to
49422 *   1024 characters cc - an array of objects from the Cc: line, with the
49423 *   following properties: personal, adl, mailbox, and host bccaddress -
49424 *   full bcc: line, up to 1024 characters bcc - an array of objects from
49425 *   the Bcc: line, with the following properties: personal, adl,
49426 *   mailbox, and host reply_toaddress - full Reply-To: line, up to 1024
49427 *   characters reply_to - an array of objects from the Reply-To: line,
49428 *   with the following properties: personal, adl, mailbox, and host
49429 *   senderaddress - full sender: line, up to 1024 characters sender - an
49430 *   array of objects from the Sender: line, with the following
49431 *   properties: personal, adl, mailbox, and host return_pathaddress -
49432 *   full Return-Path: line, up to 1024 characters return_path - an array
49433 *   of objects from the Return-Path: line, with the following
49434 *   properties: personal, adl, mailbox, and host remail - date - The
49435 *   message date as found in its headers Date - Same as date subject -
49436 *   The message subject Subject - Same as subject in_reply_to -
49437 *   message_id - newsgroups - followup_to - references - Recent - R if
49438 *   recent and seen, N if recent and not seen, ' ' if not recent. Unseen
49439 *   - U if not seen AND not recent, ' ' if seen OR not seen and recent
49440 *   Flagged - F if flagged, ' ' if not flagged Answered - A if answered,
49441 *   ' ' if unanswered Deleted - D if deleted, ' ' if not deleted Draft -
49442 *   X if draft, ' ' if not draft Msgno - The message number MailDate -
49443 *   Size - The message size udate - mail message date in Unix time
49444 *   fetchfrom - from line formatted to fit {@link fromlength} characters
49445 *   fetchsubject - subject line formatted to fit {@link subjectlength}
49446 *   characters
49447 * @since PHP 4, PHP 5, PHP 7
49448 **/
49449function imap_header($imap_stream, $msg_number, $fromlength, $subjectlength, $defaulthost){}
49450
49451/**
49452 * Read the header of the message
49453 *
49454 * Gets information about the given message number by reading its
49455 * headers.
49456 *
49457 * @param resource $imap_stream The message number
49458 * @param int $msg_number Number of characters for the fetchfrom
49459 *   property. Must be greater than or equal to zero.
49460 * @param int $fromlength Number of characters for the fetchsubject
49461 *   property Must be greater than or equal to zero.
49462 * @param int $subjectlength
49463 * @param string $defaulthost
49464 * @return object Returns FALSE on error or, if successful, the
49465 *   information in an object with following properties: toaddress - full
49466 *   to: line, up to 1024 characters to - an array of objects from the
49467 *   To: line, with the following properties: personal, adl, mailbox, and
49468 *   host fromaddress - full from: line, up to 1024 characters from - an
49469 *   array of objects from the From: line, with the following properties:
49470 *   personal, adl, mailbox, and host ccaddress - full cc: line, up to
49471 *   1024 characters cc - an array of objects from the Cc: line, with the
49472 *   following properties: personal, adl, mailbox, and host bccaddress -
49473 *   full bcc: line, up to 1024 characters bcc - an array of objects from
49474 *   the Bcc: line, with the following properties: personal, adl,
49475 *   mailbox, and host reply_toaddress - full Reply-To: line, up to 1024
49476 *   characters reply_to - an array of objects from the Reply-To: line,
49477 *   with the following properties: personal, adl, mailbox, and host
49478 *   senderaddress - full sender: line, up to 1024 characters sender - an
49479 *   array of objects from the Sender: line, with the following
49480 *   properties: personal, adl, mailbox, and host return_pathaddress -
49481 *   full Return-Path: line, up to 1024 characters return_path - an array
49482 *   of objects from the Return-Path: line, with the following
49483 *   properties: personal, adl, mailbox, and host remail - date - The
49484 *   message date as found in its headers Date - Same as date subject -
49485 *   The message subject Subject - Same as subject in_reply_to -
49486 *   message_id - newsgroups - followup_to - references - Recent - R if
49487 *   recent and seen, N if recent and not seen, ' ' if not recent. Unseen
49488 *   - U if not seen AND not recent, ' ' if seen OR not seen and recent
49489 *   Flagged - F if flagged, ' ' if not flagged Answered - A if answered,
49490 *   ' ' if unanswered Deleted - D if deleted, ' ' if not deleted Draft -
49491 *   X if draft, ' ' if not draft Msgno - The message number MailDate -
49492 *   Size - The message size udate - mail message date in Unix time
49493 *   fetchfrom - from line formatted to fit {@link fromlength} characters
49494 *   fetchsubject - subject line formatted to fit {@link subjectlength}
49495 *   characters
49496 * @since PHP 4, PHP 5, PHP 7
49497 **/
49498function imap_headerinfo($imap_stream, $msg_number, $fromlength, $subjectlength, $defaulthost){}
49499
49500/**
49501 * Returns headers for all messages in a mailbox
49502 *
49503 * @param resource $imap_stream
49504 * @return array Returns an array of string formatted with header info.
49505 *   One element per mail message.
49506 * @since PHP 4, PHP 5, PHP 7
49507 **/
49508function imap_headers($imap_stream){}
49509
49510/**
49511 * Gets the last IMAP error that occurred during this page request
49512 *
49513 * Gets the full text of the last IMAP error message that occurred on the
49514 * current page. The error stack is untouched; calling {@link
49515 * imap_last_error} subsequently, with no intervening errors, will return
49516 * the same error.
49517 *
49518 * @return string Returns the full text of the last IMAP error message
49519 *   that occurred on the current page. Returns FALSE if no error
49520 *   messages are available.
49521 * @since PHP 4, PHP 5, PHP 7
49522 **/
49523function imap_last_error(){}
49524
49525/**
49526 * Read the list of mailboxes
49527 *
49528 * @param resource $imap_stream {@link ref} should normally be just the
49529 *   server specification as described in {@link imap_open}.
49530 * @param string $ref
49531 * @param string $pattern
49532 * @return array Returns an array containing the names of the mailboxes
49533 *   or false in case of failure.
49534 * @since PHP 4, PHP 5, PHP 7
49535 **/
49536function imap_list($imap_stream, $ref, $pattern){}
49537
49538/**
49539 * Read the list of mailboxes
49540 *
49541 * @param resource $imap_stream {@link ref} should normally be just the
49542 *   server specification as described in {@link imap_open}.
49543 * @param string $ref
49544 * @param string $pattern
49545 * @return array Returns an array containing the names of the mailboxes
49546 *   or false in case of failure.
49547 * @since PHP 4, PHP 5, PHP 7
49548 **/
49549function imap_listmailbox($imap_stream, $ref, $pattern){}
49550
49551/**
49552 * Returns the list of mailboxes that matches the given text
49553 *
49554 * Returns an array containing the names of the mailboxes that have
49555 * {@link content} in the text of the mailbox.
49556 *
49557 * This function is similar to {@link imap_listmailbox}, but it will
49558 * additionally check for the presence of the string {@link content}
49559 * inside the mailbox data.
49560 *
49561 * @param resource $imap_stream {@link ref} should normally be just the
49562 *   server specification as described in {@link imap_open}
49563 * @param string $ref
49564 * @param string $pattern The searched string
49565 * @param string $content
49566 * @return array Returns an array containing the names of the mailboxes
49567 *   that have {@link content} in the text of the mailbox.
49568 * @since PHP 4, PHP 5, PHP 7
49569 **/
49570function imap_listscan($imap_stream, $ref, $pattern, $content){}
49571
49572/**
49573 * List all the subscribed mailboxes
49574 *
49575 * Gets an array of all the mailboxes that you have subscribed.
49576 *
49577 * @param resource $imap_stream {@link ref} should normally be just the
49578 *   server specification as described in {@link imap_open}
49579 * @param string $ref
49580 * @param string $pattern
49581 * @return array Returns an array of all the subscribed mailboxes.
49582 * @since PHP 4, PHP 5, PHP 7
49583 **/
49584function imap_listsubscribed($imap_stream, $ref, $pattern){}
49585
49586/**
49587 * List all the subscribed mailboxes
49588 *
49589 * Gets an array of all the mailboxes that you have subscribed.
49590 *
49591 * @param resource $imap_stream {@link ref} should normally be just the
49592 *   server specification as described in {@link imap_open}
49593 * @param string $ref
49594 * @param string $pattern
49595 * @return array Returns an array of all the subscribed mailboxes.
49596 * @since PHP 4, PHP 5, PHP 7
49597 **/
49598function imap_lsub($imap_stream, $ref, $pattern){}
49599
49600/**
49601 * Send an email message
49602 *
49603 * This function allows sending of emails with correct handling of Cc and
49604 * Bcc receivers.
49605 *
49606 * The parameters {@link to}, {@link cc} and {@link bcc} are all strings
49607 * and are all parsed as RFC822 address lists.
49608 *
49609 * @param string $to The receiver
49610 * @param string $subject The mail subject
49611 * @param string $message The mail body, see {@link imap_mail_compose}
49612 * @param string $additional_headers As string with additional headers
49613 *   to be set on the mail
49614 * @param string $cc
49615 * @param string $bcc The receivers specified in {@link bcc} will get
49616 *   the mail, but are excluded from the headers.
49617 * @param string $rpath Use this parameter to specify return path upon
49618 *   mail delivery failure. This is useful when using PHP as a mail
49619 *   client for multiple users.
49620 * @return bool
49621 * @since PHP 4, PHP 5, PHP 7
49622 **/
49623function imap_mail($to, $subject, $message, $additional_headers, $cc, $bcc, $rpath){}
49624
49625/**
49626 * Get information about the current mailbox
49627 *
49628 * Checks the current mailbox status on the server. It is similar to
49629 * {@link imap_status}, but will additionally sum up the size of all
49630 * messages in the mailbox, which will take some additional time to
49631 * execute.
49632 *
49633 * @param resource $imap_stream
49634 * @return object Returns the information in an object with following
49635 *   properties: Mailbox properties Date date of last change (current
49636 *   datetime) Driver driver Mailbox name of the mailbox Nmsgs number of
49637 *   messages Recent number of recent messages Unread number of unread
49638 *   messages Deleted number of deleted messages Size mailbox size
49639 * @since PHP 4, PHP 5, PHP 7
49640 **/
49641function imap_mailboxmsginfo($imap_stream){}
49642
49643/**
49644 * Create a MIME message based on given envelope and body sections
49645 *
49646 * Create a MIME message based on the given {@link envelope} and {@link
49647 * body} sections.
49648 *
49649 * @param array $envelope An associative array of headers fields. Valid
49650 *   keys are: "remail", "return_path", "date", "from", "reply_to",
49651 *   "in_reply_to", "subject", "to", "cc", "bcc", "message_id" and
49652 *   "custom_headers" (which contains associative array of other
49653 *   headers).
49654 * @param array $body An indexed array of bodies A body is an
49655 *   associative array which can consist of the following keys: "type",
49656 *   "encoding", "charset", "type.parameters", "subtype", "id",
49657 *   "description", "disposition.type", "disposition", "contents.data",
49658 *   "lines", "bytes" and "md5".
49659 * @return string Returns the MIME message.
49660 * @since PHP 4, PHP 5, PHP 7
49661 **/
49662function imap_mail_compose($envelope, $body){}
49663
49664/**
49665 * Copy specified messages to a mailbox
49666 *
49667 * Copies mail messages specified by {@link msglist} to specified
49668 * mailbox.
49669 *
49670 * @param resource $imap_stream {@link msglist} is a range not just
49671 *   message numbers (as described in RFC2060).
49672 * @param string $msglist The mailbox name, see {@link imap_open} for
49673 *   more information
49674 * @param string $mailbox {@link options} is a bitmask of one or more
49675 *   of CP_UID - the sequence numbers contain UIDS CP_MOVE - Delete the
49676 *   messages from the current mailbox after copying
49677 * @param int $options
49678 * @return bool
49679 * @since PHP 4, PHP 5, PHP 7
49680 **/
49681function imap_mail_copy($imap_stream, $msglist, $mailbox, $options){}
49682
49683/**
49684 * Move specified messages to a mailbox
49685 *
49686 * Moves mail messages specified by {@link msglist} to the specified
49687 * {@link mailbox}.
49688 *
49689 * @param resource $imap_stream {@link msglist} is a range not just
49690 *   message numbers (as described in RFC2060).
49691 * @param string $msglist The mailbox name, see {@link imap_open} for
49692 *   more information
49693 * @param string $mailbox {@link options} is a bitmask and may contain
49694 *   the single option: CP_UID - the sequence numbers contain UIDS
49695 * @param int $options
49696 * @return bool
49697 * @since PHP 4, PHP 5, PHP 7
49698 **/
49699function imap_mail_move($imap_stream, $msglist, $mailbox, $options){}
49700
49701/**
49702 * Decode MIME header elements
49703 *
49704 * Decodes MIME message header extensions that are non ASCII text (see
49705 * RFC2047).
49706 *
49707 * @param string $text The MIME text
49708 * @return array The decoded elements are returned in an array of
49709 *   objects, where each object has two properties, charset and text.
49710 * @since PHP 4, PHP 5, PHP 7
49711 **/
49712function imap_mime_header_decode($text){}
49713
49714/**
49715 * Gets the message sequence number for the given UID
49716 *
49717 * Returns the message sequence number for the given {@link uid}.
49718 *
49719 * This function is the inverse of {@link imap_uid}.
49720 *
49721 * @param resource $imap_stream The message UID
49722 * @param int $uid
49723 * @return int Returns the message sequence number for the given {@link
49724 *   uid}.
49725 * @since PHP 4, PHP 5, PHP 7
49726 **/
49727function imap_msgno($imap_stream, $uid){}
49728
49729/**
49730 * Decode a modified UTF-7 string to UTF-8
49731 *
49732 * Decode a modified UTF-7 (as specified in RFC 2060, section 5.1.3)
49733 * string to UTF-8.
49734 *
49735 * @param string $in A string encoded in modified UTF-7.
49736 * @return string Returns {@link in} converted to UTF-8, .
49737 * @since PHP 5 >= 5.3.0, PHP 7
49738 **/
49739function imap_mutf7_to_utf8($in){}
49740
49741/**
49742 * Gets the number of messages in the current mailbox
49743 *
49744 * @param resource $imap_stream
49745 * @return int Return the number of messages in the current mailbox, as
49746 *   an integer, or FALSE on error.
49747 * @since PHP 4, PHP 5, PHP 7
49748 **/
49749function imap_num_msg($imap_stream){}
49750
49751/**
49752 * Gets the number of recent messages in current mailbox
49753 *
49754 * Gets the number of recent messages in the current mailbox.
49755 *
49756 * @param resource $imap_stream
49757 * @return int Returns the number of recent messages in the current
49758 *   mailbox, as an integer.
49759 * @since PHP 4, PHP 5, PHP 7
49760 **/
49761function imap_num_recent($imap_stream){}
49762
49763/**
49764 * Open an stream to a mailbox
49765 *
49766 * Opens an IMAP stream to a {@link mailbox}.
49767 *
49768 * This function can also be used to open streams to POP3 and NNTP
49769 * servers, but some functions and features are only available on IMAP
49770 * servers.
49771 *
49772 * @param string $mailbox A mailbox name consists of a server and a
49773 *   mailbox path on this server. The special name INBOX stands for the
49774 *   current users personal mailbox. Mailbox names that contain
49775 *   international characters besides those in the printable ASCII space
49776 *   have to be encoded with {@link imap_utf7_encode}. The server part,
49777 *   which is enclosed in '{' and '}', consists of the servers name or ip
49778 *   address, an optional port (prefixed by ':'), and an optional
49779 *   protocol specification (prefixed by '/'). The server part is
49780 *   mandatory in all mailbox parameters. All names which start with {
49781 *   are remote names, and are in the form "{" remote_system_name [":"
49782 *   port] [flags] "}" [mailbox_name] where: remote_system_name -
49783 *   Internet domain name or bracketed IP address of server. port -
49784 *   optional TCP port number, default is the default port for that
49785 *   service flags - optional flags, see following table. mailbox_name -
49786 *   remote mailbox name, default is INBOX
49787 *
49788 *   Optional flags for names Flag Description /service=service mailbox
49789 *   access service, default is "imap" /user=user remote user name for
49790 *   login on the server /authuser=user remote authentication user; if
49791 *   specified this is the user name whose password is used (e.g.
49792 *   administrator) /anonymous remote access as anonymous user /debug
49793 *   record protocol telemetry in application's debug log /secure do not
49794 *   transmit a plaintext password over the network /imap, /imap2,
49795 *   /imap2bis, /imap4, /imap4rev1 equivalent to /service=imap /pop3
49796 *   equivalent to /service=pop3 /nntp equivalent to /service=nntp /norsh
49797 *   do not use rsh or ssh to establish a preauthenticated IMAP session
49798 *   /ssl use the Secure Socket Layer to encrypt the session
49799 *   /validate-cert validate certificates from TLS/SSL server (this is
49800 *   the default behavior) /novalidate-cert do not validate certificates
49801 *   from TLS/SSL server, needed if server uses self-signed certificates
49802 *   /tls force use of start-TLS to encrypt the session, and reject
49803 *   connection to servers that do not support it /notls do not do
49804 *   start-TLS to encrypt the session, even with servers that support it
49805 *   /readonly request read-only mailbox open (IMAP only; ignored on
49806 *   NNTP, and an error with SMTP and POP3)
49807 * @param string $username The user name
49808 * @param string $password The password associated with the {@link
49809 *   username}
49810 * @param int $options The {@link options} are a bit mask with one or
49811 *   more of the following: OP_READONLY - Open mailbox read-only
49812 *   OP_ANONYMOUS - Don't use or update a .newsrc for news (NNTP only)
49813 *   OP_HALFOPEN - For IMAP and NNTP names, open a connection but don't
49814 *   open a mailbox. CL_EXPUNGE - Expunge mailbox automatically upon
49815 *   mailbox close (see also {@link imap_delete} and {@link
49816 *   imap_expunge}) OP_DEBUG - Debug protocol negotiations OP_SHORTCACHE
49817 *   - Short (elt-only) caching OP_SILENT - Don't pass up events
49818 *   (internal use) OP_PROTOTYPE - Return driver prototype OP_SECURE -
49819 *   Don't do non-secure authentication
49820 * @param int $n_retries Number of maximum connect attempts
49821 * @param array $params Connection parameters, the following (string)
49822 *   keys maybe used to set one or more connection parameters:
49823 *   DISABLE_AUTHENTICATOR - Disable authentication properties
49824 * @return resource Returns an IMAP stream on success or FALSE on
49825 *   error.
49826 * @since PHP 4, PHP 5, PHP 7
49827 **/
49828function imap_open($mailbox, $username, $password, $options, $n_retries, $params){}
49829
49830/**
49831 * Check if the IMAP stream is still active
49832 *
49833 * {@link imap_ping} pings the stream to see if it's still active. It may
49834 * discover new mail; this is the preferred method for a periodic "new
49835 * mail check" as well as a "keep alive" for servers which have
49836 * inactivity timeout.
49837 *
49838 * @param resource $imap_stream
49839 * @return bool Returns TRUE if the stream is still alive, FALSE
49840 *   otherwise.
49841 * @since PHP 4, PHP 5, PHP 7
49842 **/
49843function imap_ping($imap_stream){}
49844
49845/**
49846 * Convert a quoted-printable string to an 8 bit string
49847 *
49848 * Convert a quoted-printable string to an 8 bit string according to
49849 * RFC2045, section 6.7.
49850 *
49851 * @param string $string A quoted-printable string
49852 * @return string Returns an 8 bits string.
49853 * @since PHP 4, PHP 5, PHP 7
49854 **/
49855function imap_qprint($string){}
49856
49857/**
49858 * Rename an old mailbox to new mailbox
49859 *
49860 * This function renames on old mailbox to new mailbox (see {@link
49861 * imap_open} for the format of {@link mbox} names).
49862 *
49863 * @param resource $imap_stream The old mailbox name, see {@link
49864 *   imap_open} for more information
49865 * @param string $old_mbox The new mailbox name, see {@link imap_open}
49866 *   for more information
49867 * @param string $new_mbox
49868 * @return bool
49869 * @since PHP 4, PHP 5, PHP 7
49870 **/
49871function imap_rename($imap_stream, $old_mbox, $new_mbox){}
49872
49873/**
49874 * Rename an old mailbox to new mailbox
49875 *
49876 * This function renames on old mailbox to new mailbox (see {@link
49877 * imap_open} for the format of {@link mbox} names).
49878 *
49879 * @param resource $imap_stream The old mailbox name, see {@link
49880 *   imap_open} for more information
49881 * @param string $old_mbox The new mailbox name, see {@link imap_open}
49882 *   for more information
49883 * @param string $new_mbox
49884 * @return bool
49885 * @since PHP 4, PHP 5, PHP 7
49886 **/
49887function imap_renamemailbox($imap_stream, $old_mbox, $new_mbox){}
49888
49889/**
49890 * Reopen stream to new mailbox
49891 *
49892 * Reopens the specified stream to a new {@link mailbox} on an IMAP or
49893 * NNTP server.
49894 *
49895 * @param resource $imap_stream The mailbox name, see {@link imap_open}
49896 *   for more information
49897 * @param string $mailbox The {@link options} are a bit mask with one
49898 *   or more of the following: OP_READONLY - Open mailbox read-only
49899 *   OP_ANONYMOUS - Don't use or update a .newsrc for news (NNTP only)
49900 *   OP_HALFOPEN - For IMAP and NNTP names, open a connection but don't
49901 *   open a mailbox. OP_EXPUNGE - Silently expunge recycle stream
49902 *   CL_EXPUNGE - Expunge mailbox automatically upon mailbox close (see
49903 *   also {@link imap_delete} and {@link imap_expunge})
49904 * @param int $options Number of maximum connect attempts
49905 * @param int $n_retries
49906 * @return bool Returns TRUE if the stream is reopened, FALSE
49907 *   otherwise.
49908 * @since PHP 4, PHP 5, PHP 7
49909 **/
49910function imap_reopen($imap_stream, $mailbox, $options, $n_retries){}
49911
49912/**
49913 * Parses an address string
49914 *
49915 * Parses the address string as defined in RFC2822 and for each address.
49916 *
49917 * @param string $address A string containing addresses
49918 * @param string $default_host The default host name
49919 * @return array Returns an array of objects. The objects properties
49920 *   are:
49921 * @since PHP 4, PHP 5, PHP 7
49922 **/
49923function imap_rfc822_parse_adrlist($address, $default_host){}
49924
49925/**
49926 * Parse mail headers from a string
49927 *
49928 * Gets an object of various header elements, similar to {@link
49929 * imap_header}.
49930 *
49931 * @param string $headers The parsed headers data
49932 * @param string $defaulthost The default host name
49933 * @return object Returns an object similar to the one returned by
49934 *   {@link imap_header}, except for the flags and other properties that
49935 *   come from the IMAP server.
49936 * @since PHP 4, PHP 5, PHP 7
49937 **/
49938function imap_rfc822_parse_headers($headers, $defaulthost){}
49939
49940/**
49941 * Returns a properly formatted email address given the mailbox, host,
49942 * and personal info
49943 *
49944 * Returns a properly formatted email address as defined in RFC2822 given
49945 * the needed information.
49946 *
49947 * @param string $mailbox The mailbox name, see {@link imap_open} for
49948 *   more information
49949 * @param string $host The email host part
49950 * @param string $personal The name of the account owner
49951 * @return string Returns a string properly formatted email address as
49952 *   defined in RFC2822.
49953 * @since PHP 4, PHP 5, PHP 7
49954 **/
49955function imap_rfc822_write_address($mailbox, $host, $personal){}
49956
49957/**
49958 * Save a specific body section to a file
49959 *
49960 * Saves a part or the whole body of the specified message.
49961 *
49962 * @param resource $imap_stream The path to the saved file as a string,
49963 *   or a valid file descriptor returned by {@link fopen}.
49964 * @param mixed $file The message number
49965 * @param int $msg_number The part number. It is a string of integers
49966 *   delimited by period which index into a body part list as per the
49967 *   IMAP4 specification
49968 * @param string $part_number A bitmask with one or more of the
49969 *   following: FT_UID - The {@link msg_number} is a UID FT_PEEK - Do not
49970 *   set the \Seen flag if not already set FT_INTERNAL - The return
49971 *   string is in internal format, will not canonicalize to CRLF.
49972 * @param int $options
49973 * @return bool
49974 * @since PHP 5 >= 5.1.3, PHP 7
49975 **/
49976function imap_savebody($imap_stream, $file, $msg_number, $part_number, $options){}
49977
49978/**
49979 * Returns the list of mailboxes that matches the given text
49980 *
49981 * Returns an array containing the names of the mailboxes that have
49982 * {@link content} in the text of the mailbox.
49983 *
49984 * This function is similar to {@link imap_listmailbox}, but it will
49985 * additionally check for the presence of the string {@link content}
49986 * inside the mailbox data.
49987 *
49988 * @param resource $imap_stream {@link ref} should normally be just the
49989 *   server specification as described in {@link imap_open}
49990 * @param string $ref
49991 * @param string $pattern The searched string
49992 * @param string $content
49993 * @return array Returns an array containing the names of the mailboxes
49994 *   that have {@link content} in the text of the mailbox.
49995 * @since PHP 4, PHP 5, PHP 7
49996 **/
49997function imap_scan($imap_stream, $ref, $pattern, $content){}
49998
49999/**
50000 * Returns the list of mailboxes that matches the given text
50001 *
50002 * Returns an array containing the names of the mailboxes that have
50003 * {@link content} in the text of the mailbox.
50004 *
50005 * This function is similar to {@link imap_listmailbox}, but it will
50006 * additionally check for the presence of the string {@link content}
50007 * inside the mailbox data.
50008 *
50009 * @param resource $imap_stream {@link ref} should normally be just the
50010 *   server specification as described in {@link imap_open}
50011 * @param string $ref
50012 * @param string $pattern The searched string
50013 * @param string $content
50014 * @return array Returns an array containing the names of the mailboxes
50015 *   that have {@link content} in the text of the mailbox.
50016 * @since PHP 4, PHP 5, PHP 7
50017 **/
50018function imap_scanmailbox($imap_stream, $ref, $pattern, $content){}
50019
50020/**
50021 * This function returns an array of messages matching the given search
50022 * criteria
50023 *
50024 * This function performs a search on the mailbox currently opened in the
50025 * given IMAP stream.
50026 *
50027 * For example, to match all unanswered messages sent by Mom, you'd use:
50028 * "UNANSWERED FROM mom". Searches appear to be case insensitive. This
50029 * list of criteria is from a reading of the UW c-client source code and
50030 * may be incomplete or inaccurate (see also RFC2060, section 6.4.4).
50031 *
50032 * @param resource $imap_stream A string, delimited by spaces, in which
50033 *   the following keywords are allowed. Any multi-word arguments (e.g.
50034 *   FROM "joey smith") must be quoted. Results will match all {@link
50035 *   criteria} entries. ALL - return all messages matching the rest of
50036 *   the criteria ANSWERED - match messages with the \\ANSWERED flag set
50037 *   BCC "string" - match messages with "string" in the Bcc: field BEFORE
50038 *   "date" - match messages with Date: before "date" BODY "string" -
50039 *   match messages with "string" in the body of the message CC "string"
50040 *   - match messages with "string" in the Cc: field DELETED - match
50041 *   deleted messages FLAGGED - match messages with the \\FLAGGED
50042 *   (sometimes referred to as Important or Urgent) flag set FROM
50043 *   "string" - match messages with "string" in the From: field KEYWORD
50044 *   "string" - match messages with "string" as a keyword NEW - match new
50045 *   messages OLD - match old messages ON "date" - match messages with
50046 *   Date: matching "date" RECENT - match messages with the \\RECENT flag
50047 *   set SEEN - match messages that have been read (the \\SEEN flag is
50048 *   set) SINCE "date" - match messages with Date: after "date" SUBJECT
50049 *   "string" - match messages with "string" in the Subject: TEXT
50050 *   "string" - match messages with text "string" TO "string" - match
50051 *   messages with "string" in the To: UNANSWERED - match messages that
50052 *   have not been answered UNDELETED - match messages that are not
50053 *   deleted UNFLAGGED - match messages that are not flagged UNKEYWORD
50054 *   "string" - match messages that do not have the keyword "string"
50055 *   UNSEEN - match messages which have not been read yet
50056 * @param string $criteria Valid values for {@link options} are SE_UID,
50057 *   which causes the returned array to contain UIDs instead of messages
50058 *   sequence numbers.
50059 * @param int $options MIME character set to use when searching
50060 *   strings.
50061 * @param string $charset
50062 * @return array Returns an array of message numbers or UIDs.
50063 * @since PHP 4, PHP 5, PHP 7
50064 **/
50065function imap_search($imap_stream, $criteria, $options, $charset){}
50066
50067/**
50068 * Sets the ACL for a given mailbox
50069 *
50070 * Sets the ACL for a giving mailbox.
50071 *
50072 * @param resource $imap_stream The mailbox name, see {@link imap_open}
50073 *   for more information
50074 * @param string $mailbox The user to give the rights to.
50075 * @param string $id The rights to give to the user. Passing an empty
50076 *   string will delete acl.
50077 * @param string $rights
50078 * @return bool
50079 * @since PHP 4 >= 4.0.7, PHP 5, PHP 7
50080 **/
50081function imap_setacl($imap_stream, $mailbox, $id, $rights){}
50082
50083/**
50084 * Sets flags on messages
50085 *
50086 * Causes a store to add the specified {@link flag} to the flags set for
50087 * the messages in the specified {@link sequence}.
50088 *
50089 * @param resource $imap_stream A sequence of message numbers. You can
50090 *   enumerate desired messages with the X,Y syntax, or retrieve all
50091 *   messages within an interval with the X:Y syntax
50092 * @param string $sequence The flags which you can set are \Seen,
50093 *   \Answered, \Flagged, \Deleted, and \Draft as defined by RFC2060.
50094 * @param string $flag A bit mask that may contain the single option:
50095 *   ST_UID - The sequence argument contains UIDs instead of sequence
50096 *   numbers
50097 * @param int $options
50098 * @return bool
50099 * @since PHP 4, PHP 5, PHP 7
50100 **/
50101function imap_setflag_full($imap_stream, $sequence, $flag, $options){}
50102
50103/**
50104 * Sets a quota for a given mailbox
50105 *
50106 * Sets an upper limit quota on a per mailbox basis.
50107 *
50108 * @param resource $imap_stream The mailbox to have a quota set. This
50109 *   should follow the IMAP standard format for a mailbox: user.name.
50110 * @param string $quota_root The maximum size (in KB) for the {@link
50111 *   quota_root}
50112 * @param int $quota_limit
50113 * @return bool
50114 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
50115 **/
50116function imap_set_quota($imap_stream, $quota_root, $quota_limit){}
50117
50118/**
50119 * Gets and sort messages
50120 *
50121 * Gets and sorts message numbers by the given parameters.
50122 *
50123 * @param resource $imap_stream Criteria can be one (and only one) of
50124 *   the following: SORTDATE - message Date SORTARRIVAL - arrival date
50125 *   SORTFROM - mailbox in first From address SORTSUBJECT - message
50126 *   subject SORTTO - mailbox in first To address SORTCC - mailbox in
50127 *   first cc address SORTSIZE - size of message in octets
50128 * @param int $criteria Set this to 1 for reverse sorting
50129 * @param int $reverse The {@link options} are a bitmask of one or more
50130 *   of the following: SE_UID - Return UIDs instead of sequence numbers
50131 *   SE_NOPREFETCH - Don't prefetch searched messages
50132 * @param int $options IMAP2-format search criteria string. For details
50133 *   see {@link imap_search}.
50134 * @param string $search_criteria MIME character set to use when
50135 *   sorting strings.
50136 * @param string $charset
50137 * @return array Returns an array of message numbers sorted by the
50138 *   given parameters.
50139 * @since PHP 4, PHP 5, PHP 7
50140 **/
50141function imap_sort($imap_stream, $criteria, $reverse, $options, $search_criteria, $charset){}
50142
50143/**
50144 * Returns status information on a mailbox
50145 *
50146 * Gets status information about the given {@link mailbox}.
50147 *
50148 * @param resource $imap_stream The mailbox name, see {@link imap_open}
50149 *   for more information
50150 * @param string $mailbox Valid flags are: SA_MESSAGES - set
50151 *   $status->messages to the number of messages in the mailbox SA_RECENT
50152 *   - set $status->recent to the number of recent messages in the
50153 *   mailbox SA_UNSEEN - set $status->unseen to the number of unseen
50154 *   (new) messages in the mailbox SA_UIDNEXT - set $status->uidnext to
50155 *   the next uid to be used in the mailbox SA_UIDVALIDITY - set
50156 *   $status->uidvalidity to a constant that changes when uids for the
50157 *   mailbox may no longer be valid SA_ALL - set all of the above
50158 * @param int $options
50159 * @return object This function returns an object containing status
50160 *   information. The object has the following properties: messages,
50161 *   recent, unseen, uidnext, and uidvalidity.
50162 * @since PHP 4, PHP 5, PHP 7
50163 **/
50164function imap_status($imap_stream, $mailbox, $options){}
50165
50166/**
50167 * Subscribe to a mailbox
50168 *
50169 * Subscribe to a new mailbox.
50170 *
50171 * @param resource $imap_stream The mailbox name, see {@link imap_open}
50172 *   for more information
50173 * @param string $mailbox
50174 * @return bool
50175 * @since PHP 4, PHP 5, PHP 7
50176 **/
50177function imap_subscribe($imap_stream, $mailbox){}
50178
50179/**
50180 * Returns a tree of threaded message
50181 *
50182 * Gets a tree of a threaded message.
50183 *
50184 * @param resource $imap_stream
50185 * @param int $options
50186 * @return array {@link imap_thread} returns an associative array
50187 *   containing a tree of messages threaded by REFERENCES, or FALSE on
50188 *   error.
50189 * @since PHP 4 >= 4.0.7, PHP 5, PHP 7
50190 **/
50191function imap_thread($imap_stream, $options){}
50192
50193/**
50194 * Set or fetch imap timeout
50195 *
50196 * Sets or fetches the imap timeout.
50197 *
50198 * @param int $timeout_type One of the following: IMAP_OPENTIMEOUT,
50199 *   IMAP_READTIMEOUT, IMAP_WRITETIMEOUT, or IMAP_CLOSETIMEOUT.
50200 * @param int $timeout The timeout, in seconds.
50201 * @return mixed If the {@link timeout} parameter is set, this function
50202 *   returns TRUE on success and FALSE on failure.
50203 * @since PHP 4 >= 4.3.3, PHP 5, PHP 7
50204 **/
50205function imap_timeout($timeout_type, $timeout){}
50206
50207/**
50208 * This function returns the UID for the given message sequence number
50209 *
50210 * This function returns the UID for the given message sequence number.
50211 * An UID is a unique identifier that will not change over time while a
50212 * message sequence number may change whenever the content of the mailbox
50213 * changes.
50214 *
50215 * This function is the inverse of {@link imap_msgno}.
50216 *
50217 * @param resource $imap_stream The message number.
50218 * @param int $msg_number
50219 * @return int The UID of the given message.
50220 * @since PHP 4, PHP 5, PHP 7
50221 **/
50222function imap_uid($imap_stream, $msg_number){}
50223
50224/**
50225 * Unmark the message which is marked deleted
50226 *
50227 * Removes the deletion flag for a specified message, which is set by
50228 * {@link imap_delete} or {@link imap_mail_move}.
50229 *
50230 * @param resource $imap_stream The message number
50231 * @param int $msg_number
50232 * @param int $flags
50233 * @return bool
50234 * @since PHP 4, PHP 5, PHP 7
50235 **/
50236function imap_undelete($imap_stream, $msg_number, $flags){}
50237
50238/**
50239 * Unsubscribe from a mailbox
50240 *
50241 * Unsubscribe from the specified {@link mailbox}.
50242 *
50243 * @param resource $imap_stream The mailbox name, see {@link imap_open}
50244 *   for more information
50245 * @param string $mailbox
50246 * @return bool
50247 * @since PHP 4, PHP 5, PHP 7
50248 **/
50249function imap_unsubscribe($imap_stream, $mailbox){}
50250
50251/**
50252 * Decodes a modified UTF-7 encoded string
50253 *
50254 * Decodes modified UTF-7 {@link text} into ISO-8859-1 string.
50255 *
50256 * This function is needed to decode mailbox names that contain certain
50257 * characters which are not in range of printable ASCII characters.
50258 *
50259 * @param string $text A modified UTF-7 encoding string, as defined in
50260 *   RFC 2060, section 5.1.3 (original UTF-7 was defined in RFC1642).
50261 * @return string Returns a string that is encoded in ISO-8859-1 and
50262 *   consists of the same sequence of characters in {@link text}, or
50263 *   FALSE if {@link text} contains invalid modified UTF-7 sequence or
50264 *   {@link text} contains a character that is not part of ISO-8859-1
50265 *   character set.
50266 * @since PHP 4, PHP 5, PHP 7
50267 **/
50268function imap_utf7_decode($text){}
50269
50270/**
50271 * Converts ISO-8859-1 string to modified UTF-7 text
50272 *
50273 * Converts {@link data} to modified UTF-7 text.
50274 *
50275 * This is needed to encode mailbox names that contain certain characters
50276 * which are not in range of printable ASCII characters.
50277 *
50278 * @param string $data An ISO-8859-1 string.
50279 * @return string Returns {@link data} encoded with the modified UTF-7
50280 *   encoding as defined in RFC 2060, section 5.1.3 (original UTF-7 was
50281 *   defined in RFC1642).
50282 * @since PHP 4, PHP 5, PHP 7
50283 **/
50284function imap_utf7_encode($data){}
50285
50286/**
50287 * Converts MIME-encoded text to UTF-8
50288 *
50289 * Converts the given {@link mime_encoded_text} to UTF-8.
50290 *
50291 * @param string $mime_encoded_text A MIME encoded string. MIME
50292 *   encoding method and the UTF-8 specification are described in RFC2047
50293 *   and RFC2044 respectively.
50294 * @return string Returns an UTF-8 encoded string.
50295 * @since PHP 4, PHP 5, PHP 7
50296 **/
50297function imap_utf8($mime_encoded_text){}
50298
50299/**
50300 * Encode a UTF-8 string to modified UTF-7
50301 *
50302 * Encode a UTF-8 string to modified UTF-7 (as specified in RFC 2060,
50303 * section 5.1.3).
50304 *
50305 * @param string $in A UTF-8 encoded string.
50306 * @return string Returns {@link in} converted to modified UTF-7, .
50307 * @since PHP 5 >= 5.3.0, PHP 7
50308 **/
50309function imap_utf8_to_mutf7($in){}
50310
50311/**
50312 * Join array elements with a string
50313 *
50314 * Join array elements with a {@link glue} string.
50315 *
50316 * @param string $glue Defaults to an empty string.
50317 * @param array $pieces The array of strings to implode.
50318 * @return string Returns a string containing a string representation
50319 *   of all the array elements in the same order, with the glue string
50320 *   between each element.
50321 * @since PHP 4, PHP 5, PHP 7
50322 **/
50323function implode($glue, $pieces){}
50324
50325/**
50326 * Import GET/POST/Cookie variables into the global scope
50327 *
50328 * Imports GET/POST/Cookie variables into the global scope. It is useful
50329 * if you disabled register_globals, but would like to see some variables
50330 * in the global scope.
50331 *
50332 * If you're interested in importing other variables into the global
50333 * scope, such as $_SERVER, consider using {@link extract}.
50334 *
50335 * @param string $types Using the {@link types} parameter, you can
50336 *   specify which request variables to import. You can use 'G', 'P' and
50337 *   'C' characters respectively for GET, POST and Cookie. These
50338 *   characters are not case sensitive, so you can also use any
50339 *   combination of 'g', 'p' and 'c'. POST includes the POST uploaded
50340 *   file information.
50341 * @param string $prefix Variable name prefix, prepended before all
50342 *   variable's name imported into the global scope. So if you have a GET
50343 *   value named "userid", and provide a prefix "pref_", then you'll get
50344 *   a global variable named $pref_userid.
50345 * @return bool
50346 * @since PHP 4 >= 4.1.0, PHP 5 < 5.4.0
50347 **/
50348function import_request_variables($types, $prefix){}
50349
50350/**
50351 * Get the inclued data
50352 *
50353 * @return array The inclued data.
50354 **/
50355function inclued_get_data(){}
50356
50357/**
50358 * Converts a packed internet address to a human readable representation
50359 *
50360 * @param string $in_addr A 32bit IPv4, or 128bit IPv6 address.
50361 * @return string Returns a string representation of the address.
50362 * @since PHP 5 >= 5.1.0, PHP 7
50363 **/
50364function inet_ntop($in_addr){}
50365
50366/**
50367 * Converts a human readable IP address to its packed in_addr
50368 * representation
50369 *
50370 * This function converts a human readable IPv4 or IPv6 address (if PHP
50371 * was built with IPv6 support enabled) into an address family
50372 * appropriate 32bit or 128bit binary structure.
50373 *
50374 * @param string $address A human readable IPv4 or IPv6 address.
50375 * @return string Returns the in_addr representation of the given
50376 *   {@link address}, or FALSE if a syntactically invalid {@link address}
50377 *   is given (for example, an IPv4 address without dots or an IPv6
50378 *   address without colons).
50379 * @since PHP 5 >= 5.1.0, PHP 7
50380 **/
50381function inet_pton($address){}
50382
50383/**
50384 * Incrementally inflate encoded data
50385 *
50386 * Incrementally inflates encoded data in the specified {@link context}.
50387 *
50388 * Limitation: header information from GZIP compressed data are not made
50389 * available.
50390 *
50391 * @param resource $context A context created with {@link
50392 *   inflate_init}.
50393 * @param string $encoded_data A chunk of compressed data.
50394 * @param int $flush_mode One of ZLIB_BLOCK, ZLIB_NO_FLUSH,
50395 *   ZLIB_PARTIAL_FLUSH, ZLIB_SYNC_FLUSH (default), ZLIB_FULL_FLUSH,
50396 *   ZLIB_FINISH. Normally you will want to set ZLIB_NO_FLUSH to maximize
50397 *   compression, and ZLIB_FINISH to terminate with the last chunk of
50398 *   data. See the zlib manual for a detailed description of these
50399 *   constants.
50400 * @return string Returns a chunk of uncompressed data, .
50401 * @since PHP 7
50402 **/
50403function inflate_add($context, $encoded_data, $flush_mode){}
50404
50405/**
50406 * Get number of bytes read so far
50407 *
50408 * @param resource $resource
50409 * @return int Returns number of bytes read so far.
50410 * @since PHP 7 >= 7.2.0
50411 **/
50412function inflate_get_read_len($resource){}
50413
50414/**
50415 * Get decompression status
50416 *
50417 * Usually returns either ZLIB_OK or ZLIB_STREAM_END.
50418 *
50419 * @param resource $resource
50420 * @return int Returns decompression status.
50421 * @since PHP 7 >= 7.2.0
50422 **/
50423function inflate_get_status($resource){}
50424
50425/**
50426 * Initialize an incremental inflate context
50427 *
50428 * Initialize an incremental inflate context with the specified {@link
50429 * encoding}.
50430 *
50431 * @param int $encoding One of the ZLIB_ENCODING_* constants.
50432 * @param array $options An associative array which may contain the
50433 *   following elements: level The compression level in range -1..9;
50434 *   defaults to -1. memory The compression memory level in range 1..9;
50435 *   defaults to 8. window The zlib window size (logarithmic) in range
50436 *   8..15; defaults to 15. strategy One of ZLIB_FILTERED,
50437 *   ZLIB_HUFFMAN_ONLY, ZLIB_RLE, ZLIB_FIXED or ZLIB_DEFAULT_STRATEGY
50438 *   (the default). dictionary A string or an array of strings of the
50439 *   preset dictionary (default: no preset dictionary).
50440 * @return resource Returns an inflate context resource (zlib.inflate)
50441 *   on success, .
50442 * @since PHP 7
50443 **/
50444function inflate_init($encoding, $options){}
50445
50446/**
50447 * Switch autocommit on or off
50448 *
50449 * {@link ingres_autocommit} is called before opening a transaction
50450 * (before the first call to {@link ingres_query} or just after a call to
50451 * {@link ingres_rollback} or {@link ingres_commit}) to switch the
50452 * autocommit mode of the server on or off (when the script begins the
50453 * autocommit mode is off).
50454 *
50455 * When autocommit mode is on, every query is automatically committed by
50456 * the server, as if {@link ingres_commit} was called after every call to
50457 * {@link ingres_query}. To see if autocommit is enabled use, {@link
50458 * ingres_autocommit_state}.
50459 *
50460 * By default Ingres will rollback any uncommitted transactions at the
50461 * end of a request. Use this function or {@link ingres_commit} to ensure
50462 * your data is committed to the database.
50463 *
50464 * @param resource $link The connection link identifier
50465 * @return bool
50466 * @since PHP 4 >= 4.0.2, PHP 5 < 5.1.0, PECL ingres >= 1.0.0
50467 **/
50468function ingres_autocommit($link){}
50469
50470/**
50471 * Test if the connection is using autocommit
50472 *
50473 * {@link ingres_autocommit_state} is called to determine whether the
50474 * current link has autocommit enabled or not.
50475 *
50476 * @param resource $link The connection link identifier
50477 * @return bool Returns TRUE if autocommit is enabled or FALSE when
50478 *   autocommit is disabled
50479 * @since PECL ingres >= 2.0.0
50480 **/
50481function ingres_autocommit_state($link){}
50482
50483/**
50484 * Returns the installation character set
50485 *
50486 * {@link ingres_charset} is called to determine the character set being
50487 * used by the Ingres client, from II_CHARSETxx (where xx is the
50488 * installation code).
50489 *
50490 * @param resource $link The connection link identifier
50491 * @return string Returns a string with the value for II_CHARSETxx or
50492 *   returns NULL if the value could not be determined.
50493 * @since PECL ingres >= 2.1.0
50494 **/
50495function ingres_charset($link){}
50496
50497/**
50498 * Close an Ingres database connection
50499 *
50500 * {@link ingres_close} closes the connection to the Ingres server that
50501 * is associated with the specified link.
50502 *
50503 * {@link ingres_close} is usually unnecessary, as it will not close
50504 * persistent connections and all non-persistent connections are
50505 * automatically closed at the end of the script.
50506 *
50507 * @param resource $link The connection link identifier
50508 * @return bool
50509 * @since PHP 4 >= 4.0.2, PHP 5 < 5.1.0, PECL ingres >= 1.0.0
50510 **/
50511function ingres_close($link){}
50512
50513/**
50514 * Commit a transaction
50515 *
50516 * {@link ingres_commit} commits the currently open transaction, making
50517 * all changes made to the database permanent.
50518 *
50519 * This closes the transaction. A new transaction can be opened by
50520 * sending a query with {@link ingres_query}.
50521 *
50522 * You can also have the server commit automatically after every query by
50523 * calling {@link ingres_autocommit} before opening the transaction.
50524 *
50525 * By default Ingres will roll back any uncommitted transactions at the
50526 * end of a request. Use this function or {@link ingres_autocommit} to
50527 * ensure your that data is committed to the database.
50528 *
50529 * @param resource $link The connection link identifier
50530 * @return bool
50531 * @since PHP 4 >= 4.0.2, PHP 5 < 5.1.0, PECL ingres >= 1.0.0
50532 **/
50533function ingres_commit($link){}
50534
50535/**
50536 * Open a connection to an Ingres database
50537 *
50538 * {@link ingres_connect} opens a connection with the given Ingres {@link
50539 * database}.
50540 *
50541 * The connection is closed when the script ends or when {@link
50542 * ingres_close} is called on this link.
50543 *
50544 * @param string $database The database name. Must follow the syntax:
50545 *   [vnode::]dbname[/svr_class]
50546 * @param string $username The Ingres user name
50547 * @param string $password The password associated with {@link
50548 *   username}
50549 * @param array $options {@link ingres_connect} options Option name
50550 *   Option type Description Example date_century_boundary integer The
50551 *   threshold by which a 2-digit year is determined to be in the current
50552 *   century or in the next century. Equivalent to
50553 *   II_DATE_CENTURY_BOUNDARY. 50 group string Specifies the group ID of
50554 *   the user, equivalent to the "-G" flag payroll role string The role
50555 *   ID of the application. If a role password is required, the parameter
50556 *   value should be specified as "role/password" effective_user string
50557 *   The ingres user account being impersonated, equivalent to the "-u"
50558 *   flag another_user dbms_password string The internal database
50559 *   password for the user connecting to Ingres s3cr3t table_structure
50560 *   string The default structure for new tables. Valid values for
50561 *   table_structure are: INGRES_STRUCTURE_BTREE INGRES_STRUCTURE_HASH
50562 *   INGRES_STRUCTURE_HEAP INGRES_STRUCTURE_ISAM INGRES_STRUCTURE_CBTREE
50563 *   INGRES_STRUCTURE_CISAM INGRES_STRUCTURE_CHASH INGRES_STRUCTURE_CHEAP
50564 *   INGRES_STRUCTURE_BTREE index_structure string The default structure
50565 *   for new secondary indexes. Valid values for index_structure are:
50566 *   INGRES_STRUCTURE_CBTREE INGRES_STRUCTURE_CISAM
50567 *   INGRES_STRUCTURE_CHASH INGRES_STRUCTURE_BTREE INGRES_STRUCTURE_HASH
50568 *   INGRES_STRUCTURE_ISAM INGRES_STRUCTURE_HASH login_local boolean
50569 *   Determines how the connection user ID and password are used when a
50570 *   VNODE is included in the target database string. If set to TRUE, the
50571 *   user ID and password are used to locally access the VNODE, and the
50572 *   VNODE login information is used to establish the DBMS connection. If
50573 *   set to FALSE, the process user ID is used to access the VNODE, and
50574 *   the connection user ID and password are used in place of the VNODE
50575 *   login information to establish the DBMS connection. This parameter
50576 *   is ignored if no VNODE is included in the target database string.
50577 *   The default is FALSE. TRUE timezone string Controls the timezone of
50578 *   the session. If not set it will default to the value defined by
50579 *   II_TIMEZONE_NAME. If II_TIMEZONE_NAME is not defined, NA-PACIFIC
50580 *   (GMT-8 with Daylight Savings) is used. date_format integer Sets the
50581 *   allowable input and output format for Ingres dates. Defaults to the
50582 *   value defined by II_DATE_FORMAT. If II_DATE_FORMAT is not set the
50583 *   default date format is US, e.g. mm/dd/yy. Valid values for
50584 *   date_format are: INGRES_DATE_DMY INGRES_DATE_FINISH
50585 *   INGRES_DATE_GERMAN INGRES_DATE_ISO INGRES_DATE_ISO4 INGRES_DATE_MDY
50586 *   INGRES_DATE_MULTINATIONAL INGRES_DATE_MULTINATIONAL4 INGRES_DATE_YMD
50587 *   INGRES_DATE_US INGRES_DATE_MULTINATIONAL4 decimal_separator string
50588 *   The character identifier for decimal data "," money_lort integer
50589 *   Leading or trailing currency sign. Valid values for money_lort are:
50590 *   INGRES_MONEY_LEADING INGRES_MONEY_TRAILING INGRES_MONEY_TRAILING
50591 *   money_sign string The currency symbol to be used with the MONEY
50592 *   datatype € money_precision integer The precision of the MONEY
50593 *   datatype 3 float4_precision integer Precision of the FLOAT4 datatype
50594 *   10 float8_precision integer Precision of the FLOAT8 data 10
50595 *   blob_segment_length integer The amount of data in bytes to fetch at
50596 *   a time when retrieving BLOB or CLOB data, defaults to 4096 bytes
50597 *   when not explicitly set 8192
50598 * @return resource Returns a Ingres link resource on success
50599 * @since PHP 4 >= 4.0.2, PHP 5 < 5.1.0, PECL ingres >= 1.0.0
50600 **/
50601function ingres_connect($database, $username, $password, $options){}
50602
50603/**
50604 * Get a cursor name for a given result resource
50605 *
50606 * Returns a string with the active cursor name. If no cursor is active
50607 * then NULL is returned.
50608 *
50609 * @param resource $result The query result identifier
50610 * @return string Returns a string containing the active cursor name.
50611 *   If no cursor is active then NULL is returned.
50612 * @since PECL ingres >= 1.1.0
50613 **/
50614function ingres_cursor($result){}
50615
50616/**
50617 * Get the last Ingres error number generated
50618 *
50619 * Returns an integer containing the last error number. If no error was
50620 * reported 0 is returned.
50621 *
50622 * If a {@link link} resource is passed to {@link ingres_errno} it
50623 * returns the last error recorded for the link. If no link is passed,
50624 * then {@link ingres_errno} returns the last error reported using the
50625 * default link.
50626 *
50627 * The function, {@link ingres_errno}, should always be called after
50628 * executing a database query. Calling another function before {@link
50629 * ingres_errno} is called will reset or change any error code from the
50630 * last Ingres function call.
50631 *
50632 * @param resource $link The connection link identifier
50633 * @return int Returns an integer containing the last error number. If
50634 *   no error was reported, 0 is returned.
50635 * @since PECL ingres >= 1.1.0
50636 **/
50637function ingres_errno($link){}
50638
50639/**
50640 * Get a meaningful error message for the last error generated
50641 *
50642 * Returns a string containing the last error, or NULL if no error has
50643 * occurred.
50644 *
50645 * If a {@link link} resource is passed to {@link ingres_error}, it
50646 * returns the last error recorded for the link. If no link is passed
50647 * then {@link ingres_error} returns the last error reported using the
50648 * default link.
50649 *
50650 * The function, {@link ingres_error}, should always be called after
50651 * executing any database query. Calling another function before {@link
50652 * ingres_error} is called will reset or change any error message from
50653 * the last Ingres function call.
50654 *
50655 * @param resource $link The connection link identifier
50656 * @return string Returns a string containing the last error, or NULL
50657 *   if no error has occurred.
50658 * @since PECL ingres >= 1.1.0
50659 **/
50660function ingres_error($link){}
50661
50662/**
50663 * Get the last SQLSTATE error code generated
50664 *
50665 * Returns a string containing the last SQLSTATE, or NULL if no error has
50666 * occurred.
50667 *
50668 * If a {@link link} resource is passed to {@link ingres_errsqlstate}, it
50669 * returns the last error recorded for the link. If no link is passed,
50670 * then {@link ingres_errsqlstate} returns the last error reported using
50671 * the default link.
50672 *
50673 * The function, {@link ingres_errsqlstate}, should always be called
50674 * after executing any database query. Calling another function before
50675 * {@link ingres_errsqlstate} is called will reset or change any error
50676 * message from the last Ingres function call.
50677 *
50678 * @param resource $link The connection link identifier
50679 * @return string Returns a string containing the last SQLSTATE, or
50680 *   NULL if no error has occurred.
50681 * @since PECL ingres >= 1.1.0
50682 **/
50683function ingres_errsqlstate($link){}
50684
50685/**
50686 * Escape special characters for use in a query
50687 *
50688 * {@link ingres_escape_string} is used to escape certain characters
50689 * within a string before it is sent to the database server.
50690 *
50691 * @param resource $link The connection link identifier
50692 * @param string $source_string The source string to be parsed
50693 * @return string Returns a string containing the escaped data.
50694 * @since PECL ingres >= 2.1.0
50695 **/
50696function ingres_escape_string($link, $source_string){}
50697
50698/**
50699 * Execute a prepared query
50700 *
50701 * Execute a query prepared using {@link ingres_prepare}.
50702 *
50703 * @param resource $result The result query identifier
50704 * @param array $params An array of parameter values to be used with
50705 *   the query
50706 * @param string $types A string containing a sequence of types for the
50707 *   parameter values passed. See the types parameter in {@link
50708 *   ingres_query} for the list of type codes.
50709 * @return bool
50710 * @since PECL ingres >= 1.1.0
50711 **/
50712function ingres_execute($result, $params, $types){}
50713
50714/**
50715 * Fetch a row of result into an array
50716 *
50717 * This function is an extended version of {@link ingres_fetch_row}. In
50718 * addition to storing the data in the numeric indices of the result
50719 * array, it also stores the data in associative indices, using the field
50720 * names as keys.
50721 *
50722 * If two or more columns of the result have the same field names, the
50723 * last column will take precedence. To access the another column or
50724 * columns of the same name, you must use the numeric index of the column
50725 * or make an alias for the column. For example:
50726 *
50727 * <?php
50728 *
50729 * $result = ingres_query($link, "select ap_place as city, ap_ccode as
50730 * country from airport where ap_iatacode = 'VLL'"); $result =
50731 * ingres_fetch_array($result); $foo = $result["city"]; $bar =
50732 * $result["country"];
50733 *
50734 * ?>
50735 *
50736 * With regard to speed, the function is identical to {@link
50737 * ingres_fetch_object}, and almost as quick as {@link ingres_fetch_row}
50738 * (the difference is insignificant).
50739 *
50740 * By default, arrays created by {@link ingres_fetch_array} start from
50741 * position 1 and not 0 as with other DBMS extensions. The starting
50742 * position can be adjusted to 0 using the configuration parameter
50743 * ingres.array_index_start.
50744 *
50745 * @param resource $result The query result identifier
50746 * @param int $result_type The result type. This {@link result_type}
50747 *   can be INGRES_NUM for enumerated array, INGRES_ASSOC for associative
50748 *   array, or INGRES_BOTH (default).
50749 * @return array Returns an array that corresponds to the fetched row,
50750 *   or FALSE if there are no more rows
50751 * @since PHP 5 < 5.1.0, PECL ingres >= 1.0.0
50752 **/
50753function ingres_fetch_array($result, $result_type){}
50754
50755/**
50756 * Fetch a row of result into an associative array
50757 *
50758 * This function is stores the data fetched from a query executed using
50759 * {@link ingres_query} in an associative array, using the field names as
50760 * keys.
50761 *
50762 * With regard to speed, the function is identical to {@link
50763 * ingres_fetch_object}, and almost as quick as {@link ingres_fetch_row}
50764 * (the difference is insignificant).
50765 *
50766 * By default, arrays created by {@link ingres_fetch_assoc} start from
50767 * position 1 and not 0 as with other DBMS extensions. The starting
50768 * position can be adjusted to 0 using the configuration parameter
50769 * ingres.array_index_start.
50770 *
50771 * @param resource $result The query result identifier
50772 * @return array Returns an associative array that corresponds to the
50773 *   fetched row, or FALSE if there are no more rows
50774 * @since PECL ingres >= 2.2.2
50775 **/
50776function ingres_fetch_assoc($result){}
50777
50778/**
50779 * Fetch a row of result into an object
50780 *
50781 * This function is similar to {@link ingres_fetch_array}, with one
50782 * difference - an object is returned instead of an array. Indirectly,
50783 * this means that you can access the data only by the field names and
50784 * not by their offsets (numbers are illegal property names).
50785 *
50786 * With regard to speed, the function is identical to {@link
50787 * ingres_fetch_array}, and almost as quick as {@link ingres_fetch_row}
50788 * (the difference is insignificant).
50789 *
50790 * @param resource $result The query result identifier
50791 * @param int $result_type (Optional argument.) {@link result_type} is
50792 *   a constant and can take the following values: INGRES_ASSOC,
50793 *   INGRES_NUM, and INGRES_BOTH.
50794 * @return object Returns an object that corresponds to the fetched
50795 *   row, or FALSE if there are no more rows
50796 * @since PHP 4 >= 4.0.2, PHP 5 < 5.1.0, PECL ingres >= 1.0.0
50797 **/
50798function ingres_fetch_object($result, $result_type){}
50799
50800/**
50801 * Get the return value from a procedure call
50802 *
50803 * This function is used to retrieve the return value following the
50804 * execution of an Ingres database procedure (stored procedure).
50805 *
50806 * @param resource $result The result identifier for a query
50807 * @return int Returns an integer if there is a return value otherwise
50808 *   it will return NULL.
50809 * @since PECL ingres >= 1.4.0
50810 **/
50811function ingres_fetch_proc_return($result){}
50812
50813/**
50814 * Fetch a row of result into an enumerated array
50815 *
50816 * {@link ingres_fetch_row} returns an array that corresponds to the
50817 * fetched row, or FALSE if there are no more rows. Each result column is
50818 * stored in an array offset, starting at offset 1.
50819 *
50820 * Subsequent calls to {@link ingres_fetch_row} return the next row in
50821 * the result set, or FALSE if there are no more rows.
50822 *
50823 * By default, arrays created by {@link ingres_fetch_row} start from
50824 * position 1 and not 0 as with other DBMS extensions. The starting
50825 * position can be adjusted to 0 using the configuration parameter
50826 * ingres.array_index_start.
50827 *
50828 * @param resource $result The query result identifier
50829 * @return array Returns an array that corresponds to the fetched row,
50830 *   or FALSE if there are no more rows
50831 * @since PHP 4 >= 4.0.2, PHP 5 < 5.1.0, PECL ingres >= 1.0.0
50832 **/
50833function ingres_fetch_row($result){}
50834
50835/**
50836 * Get the length of a field
50837 *
50838 * {@link ingres_field_length} returns the length of a field. This is the
50839 * number of bytes the server uses to store the field. For detailed
50840 * information, see the Ingres OpenAPI User Guide, Appendix "Data Types"
50841 * in the Ingres documentation.
50842 *
50843 * @param resource $result The query result identifier
50844 * @param int $index {@link index} is the column number whose length
50845 *   will be retrieved. The possible values of {@link index} depend upon
50846 *   the value of ingres.array_index_start. If ingres.array_index_start
50847 *   is 1 (the default) then {@link index} must be between 1 and the
50848 *   value returned by {@link ingres_num_fields}. If
50849 *   ingres.array_index_start is 0 then {@link index} must be between 0
50850 *   and {@link ingres_num_fields} - 1.
50851 * @return int Returns the length of a field.
50852 * @since PHP 4 >= 4.0.2, PHP 5 < 5.1.0, PECL ingres >= 1.0.0
50853 **/
50854function ingres_field_length($result, $index){}
50855
50856/**
50857 * Get the name of a field in a query result
50858 *
50859 * {@link ingres_field_name} returns the name of a field in a query
50860 * result.
50861 *
50862 * @param resource $result The query result identifier
50863 * @param int $index {@link index} is the field whose name will be
50864 *   retrieved. The possible values of {@link index} depend upon the
50865 *   value of ingres.array_index_start. If ingres.array_index_start is 1
50866 *   (the default) then {@link index} must be between 1 and the value
50867 *   returned by {@link ingres_num_fields}. If ingres.array_index_start
50868 *   is 0 then {@link index} must be between 0 and {@link
50869 *   ingres_num_fields} - 1.
50870 * @return string Returns the name of a field in a query result
50871 * @since PHP 4 >= 4.0.2, PHP 5 < 5.1.0, PECL ingres >= 1.0.0
50872 **/
50873function ingres_field_name($result, $index){}
50874
50875/**
50876 * Test if a field is nullable
50877 *
50878 * @param resource $result The query result identifier
50879 * @param int $index {@link index} is the field whose nullability will
50880 *   be retrieved. The possible values of {@link index} depend upon the
50881 *   value of ingres.array_index_start. If ingres.array_index_start is 1
50882 *   (the default) then {@link index} must be between 1 and the value
50883 *   returned by {@link ingres_num_fields}. If ingres.array_index_start
50884 *   is 0 then {@link index} must be between 0 and {@link
50885 *   ingres_num_fields} - 1.
50886 * @return bool {@link ingres_field_nullable} returns TRUE if the field
50887 *   can be set to the NULL value and FALSE if it cannot
50888 * @since PHP 4 >= 4.0.2, PHP 5 < 5.1.0, PECL ingres >= 1.0.0
50889 **/
50890function ingres_field_nullable($result, $index){}
50891
50892/**
50893 * Get the precision of a field
50894 *
50895 * {@link ingres_field_precision} returns the precision of a field. This
50896 * value is used only for decimal, float, and money SQL data types. For
50897 * detailed information, see the Ingres OpenAPI User Guide, Appendix
50898 * "Data Types" in the Ingres documentation.
50899 *
50900 * @param resource $result The query result identifier
50901 * @param int $index {@link index} is the field whose precision will be
50902 *   retrieved. The possible values of {@link index} depend upon the
50903 *   value of ingres.array_index_start. If ingres.array_index_start is 1
50904 *   (the default) then {@link index} must be between 1 and the value
50905 *   returned by {@link ingres_num_fields}. If ingres.array_index_start
50906 *   is 0 then {@link index} must be between 0 and {@link
50907 *   ingres_num_fields} - 1.
50908 * @return int Returns the field precision as an integer
50909 * @since PHP 4 >= 4.0.2, PHP 5 < 5.1.0, PECL ingres >= 1.0.0
50910 **/
50911function ingres_field_precision($result, $index){}
50912
50913/**
50914 * Get the scale of a field
50915 *
50916 * {@link ingres_field_scale} returns the scale of a field. This value is
50917 * used only for the decimal SQL data type. For detailed information, see
50918 * the Ingres OpenAPI User Guide, Appendix "Data Types" in the Ingres
50919 * documentation.
50920 *
50921 * @param resource $result The query result identifier
50922 * @param int $index {@link index} is the field whose scale will be
50923 *   retrieved. The possible values of {@link index} depend upon the
50924 *   value of ingres.array_index_start. If ingres.array_index_start is 1
50925 *   (the default) then {@link index} must be between 1 and the value
50926 *   returned by {@link ingres_num_fields}. If ingres.array_index_start
50927 *   is 0 then {@link index} must be between 0 and {@link
50928 *   ingres_num_fields} - 1.
50929 * @return int Returns the scale of the field, as an integer
50930 * @since PHP 4 >= 4.0.2, PHP 5 < 5.1.0, PECL ingres >= 1.0.0
50931 **/
50932function ingres_field_scale($result, $index){}
50933
50934/**
50935 * Get the type of a field in a query result
50936 *
50937 * @param resource $result The query result identifier
50938 * @param int $index {@link index} is the field whose type will be
50939 *   retrieved. The possible values of {@link index} depend upon the
50940 *   value of ingres.array_index_start. If ingres.array_index_start is 1
50941 *   (the default) then {@link index} must be between 1 and the value
50942 *   returned by {@link ingres_num_fields}. If ingres.array_index_start
50943 *   is 0 then {@link index} must be between 0 and {@link
50944 *   ingres_num_fields} - 1.
50945 * @return string {@link ingres_field_type} returns the type of a field
50946 *   in a query result. Examples of types returned are IIAPI_BYTE_TYPE,
50947 *   IIAPI_CHA_TYPE, IIAPI_DTE_TYPE, IIAPI_FLT_TYPE, IIAPI_INT_TYPE,
50948 *   IIAPI_VCH_TYPE. Some of these types can map to more than one SQL
50949 *   type depending on the length of the field (see {@link
50950 *   ingres_field_length}). For example IIAPI_FLT_TYPE can be a float4 or
50951 *   a float8. For detailed information, see the Ingres OpenAPI User
50952 *   Guide, Appendix "Data Types" in the Ingres documentation.
50953 * @since PHP 4 >= 4.0.2, PHP 5 < 5.1.0, PECL ingres >= 1.0.0
50954 **/
50955function ingres_field_type($result, $index){}
50956
50957/**
50958 * Free the resources associated with a result identifier
50959 *
50960 * @param resource $result The query result identifier
50961 * @return bool
50962 * @since PECL ingres >= 2.0.0
50963 **/
50964function ingres_free_result($result){}
50965
50966/**
50967 * Get the next Ingres error
50968 *
50969 * Get the next Ingres error for the last executed query. Each call to
50970 * {@link ingres_next_error} can be followed by a call to {@link
50971 * ingres_errno}, {@link ingres_error} or {@link ingres_errsqlstate} to
50972 * get the respective error number, error text, or SQL STATE. While
50973 * {@link ingres_next_error} returns TRUE, there are more errors to
50974 * fetch.
50975 *
50976 * @param resource $link The connection link identifier
50977 * @return bool {@link ingres_next_error} returns TRUE if there is
50978 *   another error to retrieve or FALSE when there are no more errors
50979 * @since PECL ingres >= 2.0.0
50980 **/
50981function ingres_next_error($link){}
50982
50983/**
50984 * Get the number of fields returned by the last query
50985 *
50986 * {@link ingres_num_fields} returns the number of fields in the results
50987 * returned by the Ingres server after a call to {@link ingres_query}.
50988 *
50989 * @param resource $result The query result identifier
50990 * @return int Returns the number of fields
50991 * @since PHP 4 >= 4.0.2, PHP 5 < 5.1.0, PECL ingres >= 1.0.0
50992 **/
50993function ingres_num_fields($result){}
50994
50995/**
50996 * Get the number of rows affected or returned by a query
50997 *
50998 * This function primarily is meant to get the number of rows modified in
50999 * the database. However, it can be used to retrieve the number of rows
51000 * to fetch for a SELECT statement.
51001 *
51002 * @param resource $result The result identifier for a query
51003 * @return int For delete, insert, or update queries, {@link
51004 *   ingres_num_rows} returns the number of rows affected by the query.
51005 *   For other queries, {@link ingres_num_rows} returns the number of
51006 *   rows in the query's result.
51007 * @since PHP 4 >= 4.0.2, PHP 5 < 5.1.0, PECL ingres >= 1.0.0
51008 **/
51009function ingres_num_rows($result){}
51010
51011/**
51012 * Open a persistent connection to an Ingres database
51013 *
51014 * There are only two differences between this function and {@link
51015 * ingres_connect}: First, when connecting, the function will initially
51016 * try to find a (persistent) link that is already opened with the same
51017 * parameters. If one is found, an identifier for it will be returned
51018 * instead of opening a new connection. Second, the connection to the
51019 * Ingres server will not be closed when the execution of the script
51020 * ends. Instead, the link will remain open for future use ({@link
51021 * ingres_close} will not close links established by {@link
51022 * ingres_pconnect}). This type of link is therefore called "persistent".
51023 *
51024 * @param string $database The database name. Must follow the syntax:
51025 *   [vnode::]dbname[/svr_class]
51026 * @param string $username The Ingres user name
51027 * @param string $password The password associated with {@link
51028 *   username}
51029 * @param array $options See {@link ingres_connect} for the list of
51030 *   options that can be passed
51031 * @return resource Returns an Ingres link resource on success
51032 * @since PHP 4 >= 4.0.2, PHP 5 < 5.1.0, PECL ingres >= 1.0.0
51033 **/
51034function ingres_pconnect($database, $username, $password, $options){}
51035
51036/**
51037 * Prepare a query for later execution
51038 *
51039 * Prepares a query for execution by {@link ingres_execute}.
51040 *
51041 * The query becomes part of the currently open transaction. If there is
51042 * no open transaction, {@link ingres_query} opens a new transaction. To
51043 * close the transaction, you can call either {@link ingres_commit} to
51044 * commit the changes made to the database or {@link ingres_rollback} to
51045 * cancel these changes. When the script ends, any open transaction is
51046 * rolled back (by calling {@link ingres_rollback}). You can also use
51047 * {@link ingres_autocommit} before opening a new transaction to have
51048 * every SQL query immediately committed.
51049 *
51050 * @param resource $link The connection link identifier
51051 * @param string $query A valid SQL query (see the Ingres SQL reference
51052 *   guide) in the Ingres documentation. See the query parameter in
51053 *   {@link ingres_query} for a list of SQL statements which cannot be
51054 *   executed using {@link ingres_prepare}
51055 * @return mixed {@link ingres_prepare} returns a query result
51056 *   identifier that is used with {@link ingres_execute} to execute the
51057 *   query. To see if an error occurred, use {@link ingres_errno}, {@link
51058 *   ingres_error}, or {@link ingres_errsqlstate}.
51059 * @since PECL ingres >= 1.1.0
51060 **/
51061function ingres_prepare($link, $query){}
51062
51063/**
51064 * Send an SQL query to Ingres
51065 *
51066 * {@link ingres_query} sends the given {@link query} to the Ingres
51067 * server.
51068 *
51069 * The query becomes part of the currently open transaction. If there is
51070 * no open transaction, {@link ingres_query} opens a new transaction. To
51071 * close the transaction, you can call either {@link ingres_commit} to
51072 * commit the changes made to the database or {@link ingres_rollback} to
51073 * cancel these changes. When the script ends, any open transaction is
51074 * rolled back (by calling {@link ingres_rollback}). You can also use
51075 * {@link ingres_autocommit} before opening a new transaction to have
51076 * every SQL query immediately committed.
51077 *
51078 * @param resource $link The connection link identifier.
51079 * @param string $query A valid SQL query (see the Ingres SQL reference
51080 *   guide) in the Ingres documentation. Data inside the query should be
51081 *   properly escaped. The following types of SQL queries cannot be sent
51082 *   with this function: close (see {@link ingres_close}) commit (see
51083 *   {@link ingres_commit}) connect (see {@link ingres_connect})
51084 *   disconnect (see {@link ingres_close}) get dbevent prepare to commit
51085 *   rollback (see {@link ingres_rollback}) savepoint set autocommit (see
51086 *   {@link ingres_autocommit}) all cursor-related queries are
51087 *   unsupported
51088 * @param array $params An array of parameter values to be used with
51089 *   the query
51090 * @param string $types A string containing a sequence of types for the
51091 *   parameter values passed. When ingres.describe is enabled, this
51092 *   parameter can be ignored as the driver automatically fetches the
51093 *   expected parameter types from the server.
51094 * @return mixed {@link ingres_query} returns a query result identifier
51095 *   on success else it returns FALSE. To see if an error occurred use
51096 *   {@link ingres_errno}, {@link ingres_error} or {@link
51097 *   ingres_errsqlstate}.
51098 * @since PHP 4 >= 4.0.2, PHP 5 < 5.1.0, PECL ingres >= 1.0.0
51099 **/
51100function ingres_query($link, $query, $params, $types){}
51101
51102/**
51103 * Set the row position before fetching data
51104 *
51105 * This function is used to position the cursor associated with the
51106 * result resource before issuing a fetch. If ingres.array_index_start is
51107 * set to 0 then the first row is 0 else it is 1. {@link
51108 * ingres_result_seek} can be used only with queries that make use of
51109 * scrollable cursors. It cannot be used with {@link
51110 * ingres_unbuffered_query}.
51111 *
51112 * @param resource $result The result identifier for a query
51113 * @param int $position The row to position the cursor on. If
51114 *   ingres.array_index_start is set to 0, then the first row is 0, else
51115 *   it is 1
51116 * @return bool
51117 * @since PECL ingres >= 2.1.0
51118 **/
51119function ingres_result_seek($result, $position){}
51120
51121/**
51122 * Roll back a transaction
51123 *
51124 * {@link ingres_rollback} rolls back the currently open transaction,
51125 * actually cancelling all changes made to the database during the
51126 * transaction.
51127 *
51128 * This closes the transaction. A new transaction can be opened by
51129 * sending a query with {@link ingres_query}.
51130 *
51131 * @param resource $link The connection link identifier
51132 * @return bool
51133 * @since PHP 4 >= 4.0.2, PHP 5 < 5.1.0, PECL ingres >= 1.0.0
51134 **/
51135function ingres_rollback($link){}
51136
51137/**
51138 * Set environment features controlling output options
51139 *
51140 * {@link ingres_set_environment} is called to set environmental options
51141 * that affect the output of certain values from Ingres, such as the
51142 * timezone, date format, decimal character separator, and float
51143 * precision.
51144 *
51145 * @param resource $link The connection link identifier
51146 * @param array $options An enumerated array of option name/value
51147 *   pairs. The following table lists the option name and the expected
51148 *   type
51149 *
51150 *   Option name Option type Description Example date_century_boundary
51151 *   integer The threshold by which a 2-digit year is determined to be in
51152 *   the current century or in the next century. Equivalent to
51153 *   II_DATE_CENTURY_BOUNDARY 50 timezone string Controls the timezone of
51154 *   the session. If not set, it will default the value defined by
51155 *   II_TIMEZONE_NAME. If II_TIMEZONE_NAME is not defined, NA-PACIFIC
51156 *   (GMT-8 with Daylight Savings) is used. UNITED-KINGDOM date_format
51157 *   integer Sets the allowable input and output format for Ingres dates.
51158 *   Defaults to the value defined by II_DATE_FORMAT. If II_DATE_FORMAT
51159 *   is not set, the default date format is US, for example mm/dd/yy.
51160 *   Valid values for date_format are: INGRES_DATE_DMY INGRES_DATE_FINISH
51161 *   INGRES_DATE_GERMAN INGRES_DATE_ISO INGRES_DATE_ISO4 INGRES_DATE_MDY
51162 *   INGRES_DATE_MULTINATIONAL INGRES_DATE_MULTINATIONAL4 INGRES_DATE_YMD
51163 *   INGRES_DATE_US INGRES_DATE_ISO4 decimal_separator string The
51164 *   character identifier for decimal data "," money_lort integer Leading
51165 *   or trailing currency sign. Valid values for money_lort are:
51166 *   INGRES_MONEY_LEADING INGRES_MONEY_TRAILING INGRES_MONEY_LEADING
51167 *   money_sign string The currency symbol to be used with the MONEY
51168 *   datatype € money_precision integer The precision of the MONEY
51169 *   datatype 2 float4_precision integer Precision of the FLOAT4 datatype
51170 *   10 float8_precision integer Precision of the FLOAT8 data 10
51171 *   blob_segment_length integer The amount of data in bytes to fetch at
51172 *   a time when retrieving BLOB or CLOB data. Defaults to 4096 bytes
51173 *   when not set explicitly 8192
51174 * @return bool
51175 * @since PECL ingres >= 1.2.0
51176 **/
51177function ingres_set_environment($link, $options){}
51178
51179/**
51180 * Send an unbuffered SQL query to Ingres
51181 *
51182 * {@link ingres_unbuffered_query} sends the given {@link query} to the
51183 * Ingres server.
51184 *
51185 * The query becomes part of the currently open transaction. If there is
51186 * no open transaction, {@link ingres_unbuffered_query} opens a new
51187 * transaction. To close the transaction, you can call either {@link
51188 * ingres_commit} to commit the changes made to the database or {@link
51189 * ingres_rollback} to cancel these changes. When the script ends, any
51190 * open transaction is rolled back (by calling {@link ingres_rollback}).
51191 * You can also use {@link ingres_autocommit} before opening a new
51192 * transaction to have every SQL query immediately committed. Ingres
51193 * allows only a single unbuffered statement to be active at any one
51194 * time. The extension will close any active unbuffered statements before
51195 * executing any SQL. In addition you cannot use {@link
51196 * ingres_result_seek} to position the row before fetching.
51197 *
51198 * @param resource $link The connection link identifier
51199 * @param string $query A valid SQL query (see the Ingres SQL reference
51200 *   guide) in the Ingres documentation. See the query parameter in
51201 *   {@link ingres_query} for a list of SQL statements that cannot be
51202 *   executed via {@link ingres_unbuffered_query}. Data inside the query
51203 *   should be properly escaped.
51204 * @param array $params An array of parameter values to be used with
51205 *   the query
51206 * @param string $types A string containing a sequence of types for the
51207 *   parameter values passed. See the types parameter in {@link
51208 *   ingres_query} for the list of type codes.
51209 * @return mixed {@link ingres_unbuffered_query} returns a query result
51210 *   identifier when there are rows to fetch; else it returns FALSE when
51211 *   there are no rows, as is the case of an INSERT, UPDATE, or DELETE
51212 *   statement. To see if an error occurred, use {@link ingres_errno},
51213 *   {@link ingres_error}, or {@link ingres_errsqlstate}.
51214 **/
51215function ingres_unbuffered_query($link, $query, $params, $types){}
51216
51217/**
51218 * Sets the value of a configuration option
51219 *
51220 * Sets the value of the given configuration option. The configuration
51221 * option will keep this new value during the script's execution, and
51222 * will be restored at the script's ending.
51223 *
51224 * @param string $varname Not all the available options can be changed
51225 *   using {@link ini_set}. There is a list of all available options in
51226 *   the appendix.
51227 * @param string $newvalue The new value for the option.
51228 * @return string Returns the old value on success, FALSE on failure.
51229 * @since PHP 4, PHP 5, PHP 7
51230 **/
51231function ini_alter($varname, $newvalue){}
51232
51233/**
51234 * Gets the value of a configuration option
51235 *
51236 * Returns the value of the configuration option on success.
51237 *
51238 * @param string $varname The configuration option name.
51239 * @return string Returns the value of the configuration option as a
51240 *   string on success, or an empty string for null values. Returns FALSE
51241 *   if the configuration option doesn't exist.
51242 * @since PHP 4, PHP 5, PHP 7
51243 **/
51244function ini_get($varname){}
51245
51246/**
51247 * Gets all configuration options
51248 *
51249 * Returns all the registered configuration options.
51250 *
51251 * @param string $extension An optional extension name. If set, the
51252 *   function return only options specific for that extension.
51253 * @param bool $details Retrieve details settings or only the current
51254 *   value for each setting. Default is TRUE (retrieve details).
51255 * @return array Returns an associative array with directive name as
51256 *   the array key. Returns FALSE and raises an E_WARNING level error if
51257 *   the {@link extension} doesn't exist.
51258 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
51259 **/
51260function ini_get_all($extension, $details){}
51261
51262/**
51263 * Restores the value of a configuration option
51264 *
51265 * Restores a given configuration option to its original value.
51266 *
51267 * @param string $varname The configuration option name.
51268 * @return void
51269 * @since PHP 4, PHP 5, PHP 7
51270 **/
51271function ini_restore($varname){}
51272
51273/**
51274 * Sets the value of a configuration option
51275 *
51276 * Sets the value of the given configuration option. The configuration
51277 * option will keep this new value during the script's execution, and
51278 * will be restored at the script's ending.
51279 *
51280 * @param string $varname Not all the available options can be changed
51281 *   using {@link ini_set}. There is a list of all available options in
51282 *   the appendix.
51283 * @param string $newvalue The new value for the option.
51284 * @return string Returns the old value on success, FALSE on failure.
51285 * @since PHP 4, PHP 5, PHP 7
51286 **/
51287function ini_set($varname, $newvalue){}
51288
51289/**
51290 * Add a watch to an initialized inotify instance
51291 *
51292 * {@link inotify_add_watch} adds a new watch or modify an existing watch
51293 * for the file or directory specified in {@link pathname}.
51294 *
51295 * Using {@link inotify_add_watch} on a watched object replaces the
51296 * existing watch. Using the IN_MASK_ADD constant adds (OR) events to the
51297 * existing watch.
51298 *
51299 * @param resource $inotify_instance
51300 * @param string $pathname File or directory to watch
51301 * @param int $mask Events to watch for. See .
51302 * @return int The return value is a unique (inotify instance wide)
51303 *   watch descriptor.
51304 * @since PECL inotify >= 0.1.2
51305 **/
51306function inotify_add_watch($inotify_instance, $pathname, $mask){}
51307
51308/**
51309 * Initialize an inotify instance
51310 *
51311 * Initialize an inotify instance for use with {@link inotify_add_watch}
51312 *
51313 * @return resource A stream resource or FALSE on error.
51314 * @since PECL inotify >= 0.1.2
51315 **/
51316function inotify_init(){}
51317
51318/**
51319 * Return a number upper than zero if there are pending events
51320 *
51321 * This function allows to know if {@link inotify_read} will block or
51322 * not. If a number upper than zero is returned, there are pending events
51323 * and {@link inotify_read} will not block.
51324 *
51325 * @param resource $inotify_instance
51326 * @return int Returns a number upper than zero if there are pending
51327 *   events.
51328 * @since PECL inotify >= 0.1.2
51329 **/
51330function inotify_queue_len($inotify_instance){}
51331
51332/**
51333 * Read events from an inotify instance
51334 *
51335 * Read inotify events from an inotify instance.
51336 *
51337 * @param resource $inotify_instance
51338 * @return array An array of inotify events or FALSE if no events was
51339 *   pending and {@link inotify_instance} is non-blocking. Each event is
51340 *   an array with the following keys: wd is a watch descriptor returned
51341 *   by {@link inotify_add_watch} mask is a bit mask of events cookie is
51342 *   a unique id to connect related events (e.g. IN_MOVE_FROM and
51343 *   IN_MOVE_TO) name is the name of a file (e.g. if a file was modified
51344 *   in a watched directory)
51345 * @since PECL inotify >= 0.1.2
51346 **/
51347function inotify_read($inotify_instance){}
51348
51349/**
51350 * Remove an existing watch from an inotify instance
51351 *
51352 * {@link inotify_rm_watch} removes the watch {@link watch_descriptor}
51353 * from the inotify instance {@link inotify_instance}.
51354 *
51355 * @param resource $inotify_instance
51356 * @param int $watch_descriptor Watch to remove from the instance
51357 * @return bool
51358 * @since PECL inotify >= 0.1.2
51359 **/
51360function inotify_rm_watch($inotify_instance, $watch_descriptor){}
51361
51362/**
51363 * Integer division
51364 *
51365 * Returns the integer quotient of the division of {@link dividend} by
51366 * {@link divisor}.
51367 *
51368 * @param int $dividend Number to be divided.
51369 * @param int $divisor Number which divides the {@link dividend}.
51370 * @return int The integer quotient of the division of {@link dividend}
51371 *   by {@link divisor}.
51372 * @since PHP 7
51373 **/
51374function intdiv($dividend, $divisor){}
51375
51376/**
51377 * Checks if the interface has been defined
51378 *
51379 * Checks if the given interface has been defined.
51380 *
51381 * @param string $interface_name The interface name
51382 * @param bool $autoload Whether to call or not by default.
51383 * @return bool Returns TRUE if the interface given by {@link
51384 *   interface_name} has been defined, FALSE otherwise.
51385 * @since PHP 5 >= 5.0.2, PHP 7
51386 **/
51387function interface_exists($interface_name, $autoload){}
51388
51389/**
51390 * Add a (signed) amount of time to a field
51391 *
51392 * Add a signed amount to a field. Adding a positive amount allows
51393 * advances in time, even if the numeric value of the field decreases
51394 * (e.g. when working with years in BC dates).
51395 *
51396 * Other fields may need to adjusted – for instance, adding a month to
51397 * the 31st of January will result in the 28th (or 29th) of February.
51398 * Contrary to {@link IntlCalendar::roll}, when a value wraps around,
51399 * more significant fields may change. For instance, adding a day to the
51400 * 31st of January will result in the 1st of February, not the 1st of
51401 * January.
51402 *
51403 * @param IntlCalendar $cal The IntlCalendar resource.
51404 * @param int $field
51405 * @param int $amount The signed amount to add to the current field. If
51406 *   the amount is positive, the instant will be moved forward; if it is
51407 *   negative, the instant will be moved into the past. The unit is
51408 *   implicit to the field type. For instance, hours for
51409 *   IntlCalendar::FIELD_HOUR_OF_DAY.
51410 * @return bool Returns TRUE on success.
51411 **/
51412function intlcal_add($cal, $field, $amount){}
51413
51414/**
51415 * Whether this objectʼs time is after that of the passed object
51416 *
51417 * Returns whether this objectʼs time succeeds the argumentʼs time.
51418 *
51419 * @param IntlCalendar $cal The IntlCalendar resource.
51420 * @param IntlCalendar $other The calendar whose time will be checked
51421 *   against the primary objectʼs time.
51422 * @return bool Returns TRUE if this objectʼs current time is after
51423 *   that of the {@link calendar} argumentʼs time. Returns FALSE
51424 *   otherwise. Also returns FALSE on failure. You can use exceptions or
51425 *   {@link intl_get_error_code} to detect error conditions.
51426 **/
51427function intlcal_after($cal, $other){}
51428
51429/**
51430 * Whether this objectʼs time is before that of the passed object
51431 *
51432 * Returns whether this objectʼs time precedes the argumentʼs time.
51433 *
51434 * @param IntlCalendar $cal The IntlCalendar resource.
51435 * @param IntlCalendar $other The calendar whose time will be checked
51436 *   against the primary objectʼs time.
51437 * @return bool Returns TRUE if this objectʼs current time is before
51438 *   that of the {@link calendar} argumentʼs time. Returns FALSE
51439 *   otherwise. Also returns FALSE on failure. You can use exceptions or
51440 *   {@link intl_get_error_code} to detect error conditions.
51441 **/
51442function intlcal_before($cal, $other){}
51443
51444/**
51445 * Clear a field or all fields
51446 *
51447 * Clears either all of the fields or a specific field. A cleared field
51448 * is marked as unset, giving it the lowest priority against overlapping
51449 * fields or even default values when calculating the time. Additionally,
51450 * its value is set to 0, though given the fieldʼs low priority, its
51451 * value may have been internally set to another value by the time the
51452 * field has finished been queried.
51453 *
51454 * @param IntlCalendar $cal The IntlCalendar resource.
51455 * @param int $field
51456 * @return bool Returns TRUE on success. Failure can only occur is
51457 *   invalid arguments are provided.
51458 **/
51459function intlcal_clear($cal, $field){}
51460
51461/**
51462 * Create a new IntlCalendar
51463 *
51464 * Given a timezone and locale, this method creates an IntlCalendar
51465 * object. This factory method may return a subclass of IntlCalendar.
51466 *
51467 * The calendar created will represent the time instance at which it was
51468 * created, based on the system time. The fields can all be cleared by
51469 * calling {@link IntCalendar::clear} with no arguments. See also {@link
51470 * IntlGregorianCalendar::__construct}.
51471 *
51472 * @param mixed $timeZone The timezone to use.
51473 * @param string $locale A locale to use or NULL to use the default
51474 *   locale.
51475 * @return IntlCalendar The created IntlCalendar instance or NULL on
51476 *   failure.
51477 **/
51478function intlcal_create_instance($timeZone, $locale){}
51479
51480/**
51481 * Compare time of two IntlCalendar objects for equality
51482 *
51483 * Returns true if this calendar and the given calendar have the same
51484 * time. The settings, calendar types and field states do not have to be
51485 * the same.
51486 *
51487 * @param IntlCalendar $cal The IntlCalendar resource.
51488 * @param IntlCalendar $other The calendar to compare with the primary
51489 *   object.
51490 * @return bool Returns TRUE if the current time of both this and the
51491 *   passed in IntlCalendar object are the same, or FALSE otherwise. The
51492 *   value FALSE can also be returned on failure. This can only happen if
51493 *   bad arguments are passed in. In any case, the two cases can be
51494 *   distinguished by calling {@link intl_get_error_code}.
51495 **/
51496function intlcal_equals($cal, $other){}
51497
51498/**
51499 * Calculate difference between given time and this objectʼs time
51500 *
51501 * Return the difference between the given time and the time this object
51502 * is set to, with respect to the quantity specified the {@link field}
51503 * parameter.
51504 *
51505 * This method is meant to be called successively, first with the most
51506 * significant field of interest down to the least significant field. To
51507 * this end, as a side effect, this calendarʼs value for the field
51508 * specified is advanced by the amount returned.
51509 *
51510 * @param IntlCalendar $cal The IntlCalendar resource.
51511 * @param float $when The time against which to compare the quantity
51512 *   represented by the {@link field}. For the result to be positive, the
51513 *   time given for this parameter must be ahead of the time of the
51514 *   object the method is being invoked on.
51515 * @param int $field The field that represents the quantity being
51516 *   compared.
51517 * @return int Returns a (signed) difference of time in the unit
51518 *   associated with the specified field.
51519 **/
51520function intlcal_field_difference($cal, $when, $field){}
51521
51522/**
51523 * Create an IntlCalendar from a DateTime object or string
51524 *
51525 * Creates an IntlCalendar object either from a DateTime object or from a
51526 * string from which a DateTime object can be built.
51527 *
51528 * The new calendar will represent not only the same instant as the given
51529 * DateTime (subject to precision loss for dates very far into the past
51530 * or future), but also the same timezone (subject to the caveat that
51531 * different timezone databases will be used, and therefore the results
51532 * may differ).
51533 *
51534 * @param mixed $dateTime A DateTime object or a string that can be
51535 *   passed to {@link DateTime::__construct}.
51536 * @return IntlCalendar The created IntlCalendar object or NULL in case
51537 *   of failure. If a string is passed, any exception that occurs inside
51538 *   the DateTime constructor is propagated.
51539 **/
51540function intlcal_from_date_time($dateTime){}
51541
51542/**
51543 * Get the value for a field
51544 *
51545 * Gets the value for a specific field.
51546 *
51547 * @param IntlCalendar $cal The IntlCalendar resource.
51548 * @param int $field
51549 * @return int An integer with the value of the time field.
51550 **/
51551function intlcal_get($cal, $field){}
51552
51553/**
51554 * The maximum value for a field, considering the objectʼs current time
51555 *
51556 * Returns a fieldʼs relative maximum value around the current time. The
51557 * exact semantics vary by field, but in the general case this is the
51558 * value that would be obtained if one would set the field value into the
51559 * smallest relative maximum for the field and would increment it until
51560 * reaching the global maximum or the field value wraps around, in which
51561 * the value returned would be the global maximum or the value before the
51562 * wrapping, respectively.
51563 *
51564 * For instance, in the gregorian calendar, the actual maximum value for
51565 * the day of month would vary between 28 and 31, depending on the month
51566 * and year of the current time.
51567 *
51568 * @param IntlCalendar $cal The IntlCalendar resource.
51569 * @param int $field
51570 * @return int An int representing the maximum value in the units
51571 *   associated with the given {@link field}.
51572 **/
51573function intlcal_get_actual_maximum($cal, $field){}
51574
51575/**
51576 * The minimum value for a field, considering the objectʼs current time
51577 *
51578 * Returns a fieldʼs relative minimum value around the current time. The
51579 * exact semantics vary by field, but in the general case this is the
51580 * value that would be obtained if one would set the field value into the
51581 * greatest relative minimum for the field and would decrement it until
51582 * reaching the global minimum or the field value wraps around, in which
51583 * the value returned would be the global minimum or the value before the
51584 * wrapping, respectively.
51585 *
51586 * For the Gregorian calendar, this is always the same as {@link
51587 * IntlCalendar::getMinimum}.
51588 *
51589 * @param IntlCalendar $cal The IntlCalendar resource.
51590 * @param int $field
51591 * @return int An int representing the minimum value in the fieldʼs
51592 *   unit.
51593 **/
51594function intlcal_get_actual_minimum($cal, $field){}
51595
51596/**
51597 * Get array of locales for which there is data
51598 *
51599 * Gives the list of locales for which calendars are installed. As of ICU
51600 * 51, this is the list of all installed ICU locales.
51601 *
51602 * @return array An array of strings, one for which locale.
51603 **/
51604function intlcal_get_available_locales(){}
51605
51606/**
51607 * Tell whether a day is a weekday, weekend or a day that has a
51608 * transition between the two
51609 *
51610 * Returns whether the passed day is a weekday
51611 * (IntlCalendar::DOW_TYPE_WEEKDAY), a weekend day
51612 * (IntlCalendar::DOW_TYPE_WEEKEND), a day during which a transition
51613 * occurs into the weekend (IntlCalendar::DOW_TYPE_WEEKEND_OFFSET) or a
51614 * day during which the weekend ceases
51615 * (IntlCalendar::DOW_TYPE_WEEKEND_CEASE).
51616 *
51617 * If the return is either IntlCalendar::DOW_TYPE_WEEKEND_OFFSET or
51618 * IntlCalendar::DOW_TYPE_WEEKEND_CEASE, then {@link
51619 * IntlCalendar::getWeekendTransition} can be called to obtain the time
51620 * of the transition.
51621 *
51622 * This function requires ICU 4.4 or later.
51623 *
51624 * @param IntlCalendar $cal The IntlCalendar resource.
51625 * @param int $dayOfWeek One of the constants IntlCalendar::DOW_SUNDAY,
51626 *   IntlCalendar::DOW_MONDAY, …, IntlCalendar::DOW_SATURDAY.
51627 * @return int Returns one of the constants
51628 *   IntlCalendar::DOW_TYPE_WEEKDAY, IntlCalendar::DOW_TYPE_WEEKEND,
51629 *   IntlCalendar::DOW_TYPE_WEEKEND_OFFSET or
51630 *   IntlCalendar::DOW_TYPE_WEEKEND_CEASE.
51631 **/
51632function intlcal_get_day_of_week_type($cal, $dayOfWeek){}
51633
51634/**
51635 * Get last error code on the object
51636 *
51637 * Returns the numeric ICU error code for the last call on this object
51638 * (including cloning) or the IntlCalendar given for the {@link calendar}
51639 * parameter (in the procedural‒style version). This may indicate only
51640 * a warning (negative error code) or no error at all (U_ZERO_ERROR). The
51641 * actual presence of an error can be tested with {@link
51642 * intl_is_failure}.
51643 *
51644 * Invalid arguments detected on the PHP side (before invoking functions
51645 * of the ICU library) are not recorded for the purposes of this
51646 * function.
51647 *
51648 * The last error that occurred in any call to a function of the intl
51649 * extension, including early argument errors, can be obtained with
51650 * {@link intl_get_error_code}. This function resets the global error
51651 * code, but not the objectʼs error code.
51652 *
51653 * @param IntlCalendar $calendar The calendar object, on the procedural
51654 *   style interface.
51655 * @return int An ICU error code indicating either success, failure or
51656 *   a warning.
51657 **/
51658function intlcal_get_error_code($calendar){}
51659
51660/**
51661 * Get last error message on the object
51662 *
51663 * Returns the error message (if any) associated with the error reported
51664 * by {@link IntlCalendar::getErrorCode} or {@link
51665 * intlcal_get_error_code}. If there is no associated error message, only
51666 * the string representation of the name of the error constant will be
51667 * returned. Otherwise, the message also includes a message set on the
51668 * side of the PHP binding.
51669 *
51670 * @param IntlCalendar $calendar The calendar object, on the procedural
51671 *   style interface.
51672 * @return string The error message associated with last error that
51673 *   occurred in a function call on this object, or a string indicating
51674 *   the non-existance of an error.
51675 **/
51676function intlcal_get_error_message($calendar){}
51677
51678/**
51679 * Get the first day of the week for the calendarʼs locale
51680 *
51681 * The week day deemed to start a week, either the default value for this
51682 * locale or the value set with {@link IntlCalendar::setFirstDayOfWeek}.
51683 *
51684 * @param IntlCalendar $cal The IntlCalendar resource.
51685 * @return int One of the constants IntlCalendar::DOW_SUNDAY,
51686 *   IntlCalendar::DOW_MONDAY, …, IntlCalendar::DOW_SATURDAY.
51687 **/
51688function intlcal_get_first_day_of_week($cal){}
51689
51690/**
51691 * Get the largest local minimum value for a field
51692 *
51693 * Returns the largest local minimum for a field. This should be a value
51694 * larger or equal to that returned by {@link
51695 * IntlCalendar::getActualMinimum}, which is in its turn larger or equal
51696 * to that returned by {@link IntlCalendar::getMinimum}. All these three
51697 * functions return the same value for the Gregorian calendar.
51698 *
51699 * @param IntlCalendar $cal The IntlCalendar resource.
51700 * @param int $field
51701 * @return int An int representing a field value, in the fieldʼs
51702 *   unit,.
51703 **/
51704function intlcal_get_greatest_minimum($cal, $field){}
51705
51706/**
51707 * Get set of locale keyword values
51708 *
51709 * For a given locale key, get the set of values for that key that would
51710 * result in a different behavior. For now, only the 'calendar' keyword
51711 * is supported.
51712 *
51713 * This function requires ICU 4.2 or later.
51714 *
51715 * @param string $key The locale keyword for which relevant values are
51716 *   to be queried. Only 'calendar' is supported.
51717 * @param string $locale The locale onto which the keyword/value pair
51718 *   are to be appended.
51719 * @param bool $commonlyUsed Whether to show only the values commonly
51720 *   used for the specified locale.
51721 * @return Iterator An iterator that yields strings with the locale
51722 *   keyword values.
51723 **/
51724function intlcal_get_keyword_values_for_locale($key, $locale, $commonlyUsed){}
51725
51726/**
51727 * Get the smallest local maximum for a field
51728 *
51729 * Returns the smallest local maximumw for a field. This should be a
51730 * value smaller or equal to that returned by {@link
51731 * IntlCalendar::getActualMaxmimum}, which is in its turn smaller or
51732 * equal to that returned by {@link IntlCalendar::getMaximum}.
51733 *
51734 * @param IntlCalendar $cal The IntlCalendar resource.
51735 * @param int $field
51736 * @return int An int representing a field value in the fieldʼs unit.
51737 **/
51738function intlcal_get_least_maximum($cal, $field){}
51739
51740/**
51741 * Get the locale associated with the object
51742 *
51743 * Returns the locale used by this calendar object.
51744 *
51745 * @param IntlCalendar $cal The IntlCalendar resource.
51746 * @param int $localeType Whether to fetch the actual locale (the
51747 *   locale from which the calendar data originates, with
51748 *   Locale::ACTUAL_LOCALE) or the valid locale, i.e., the most specific
51749 *   locale supported by ICU relatively to the requested locale – see
51750 *   Locale::VALID_LOCALE. From the most general to the most specific,
51751 *   the locales are ordered in this fashion – actual locale, valid
51752 *   locale, requested locale.
51753 * @return string A locale string.
51754 **/
51755function intlcal_get_locale($cal, $localeType){}
51756
51757/**
51758 * Get the global maximum value for a field
51759 *
51760 * Gets the global maximum for a field, in this specific calendar. This
51761 * value is larger or equal to that returned by {@link
51762 * IntlCalendar::getActualMaximum}, which is in its turn larger or equal
51763 * to that returned by {@link IntlCalendar::getLeastMaximum}.
51764 *
51765 * @param IntlCalendar $cal The IntlCalendar resource.
51766 * @param int $field
51767 * @return int An int representing a field value in the fieldʼs unit.
51768 **/
51769function intlcal_get_maximum($cal, $field){}
51770
51771/**
51772 * Get minimal number of days the first week in a year or month can have
51773 *
51774 * Returns the smallest number of days the first week of a year or month
51775 * must have in the new year or month. For instance, in the Gregorian
51776 * calendar, if this value is 1, then the first week of the year will
51777 * necessarily include January 1st, while if this value is 7, then the
51778 * week with January 1st will be the first week of the year only if the
51779 * day of the week for January 1st matches the day of the week returned
51780 * by {@link IntlCalendar::getFirstDayOfWeek}; otherwise it will be the
51781 * previous yearʼs last week.
51782 *
51783 * @param IntlCalendar $cal The IntlCalendar resource.
51784 * @return int An int representing a number of days.
51785 **/
51786function intlcal_get_minimal_days_in_first_week($cal){}
51787
51788/**
51789 * Get the global minimum value for a field
51790 *
51791 * Gets the global minimum for a field, in this specific calendar. This
51792 * value is smaller or equal to that returned by {@link
51793 * IntlCalendar::getActualMinimum}, which is in its turn smaller or equal
51794 * to that returned by {@link IntlCalendar::getGreatestMinimum}. For the
51795 * Gregorian calendar, these three functions always return the same value
51796 * (for each field).
51797 *
51798 * @param IntlCalendar $cal The IntlCalendar resource.
51799 * @param int $field
51800 * @return int An int representing a value for the given field in the
51801 *   fieldʼs unit.
51802 **/
51803function intlcal_get_minimum($cal, $field){}
51804
51805/**
51806 * Get number representing the current time
51807 *
51808 * The number of milliseconds that have passed since the reference date.
51809 * This number is derived from the system time.
51810 *
51811 * @return float A float representing a number of milliseconds since
51812 *   the epoch, not counting leap seconds.
51813 **/
51814function intlcal_get_now(){}
51815
51816/**
51817 * Get behavior for handling repeating wall time
51818 *
51819 * Gets the current strategy for dealing with wall times that are
51820 * repeated whenever the clock is set back during dailight saving time
51821 * end transitions. The default value is IntlCalendar::WALLTIME_LAST.
51822 *
51823 * This function requires ICU 4.9 or later.
51824 *
51825 * @param IntlCalendar $cal The IntlCalendar resource.
51826 * @return int One of the constants IntlCalendar::WALLTIME_FIRST or
51827 *   IntlCalendar::WALLTIME_LAST.
51828 **/
51829function intlcal_get_repeated_wall_time_option($cal){}
51830
51831/**
51832 * Get behavior for handling skipped wall time
51833 *
51834 * Gets the current strategy for dealing with wall times that are skipped
51835 * whenever the clock is forwarded during dailight saving time start
51836 * transitions. The default value is IntlCalendar::WALLTIME_LAST.
51837 *
51838 * The calendar must be lenient for this option to have any effect,
51839 * otherwise attempting to set a non-existing time will cause an error.
51840 *
51841 * This function requires ICU 4.9 or later.
51842 *
51843 * @param IntlCalendar $cal The IntlCalendar resource.
51844 * @return int One of the constants IntlCalendar::WALLTIME_FIRST,
51845 *   IntlCalendar::WALLTIME_LAST or IntlCalendar::WALLTIME_NEXT_VALID.
51846 **/
51847function intlcal_get_skipped_wall_time_option($cal){}
51848
51849/**
51850 * Get time currently represented by the object
51851 *
51852 * Returns the time associated with this object, expressed as the number
51853 * of milliseconds since the epoch.
51854 *
51855 * @param IntlCalendar $cal The IntlCalendar resource.
51856 * @return float A float representing the number of milliseconds
51857 *   elapsed since the reference time (1 Jan 1970 00:00:00 UTC).
51858 **/
51859function intlcal_get_time($cal){}
51860
51861/**
51862 * Get the objectʼs timezone
51863 *
51864 * Returns the IntlTimeZone object associated with this calendar.
51865 *
51866 * @param IntlCalendar $cal The IntlCalendar resource.
51867 * @return IntlTimeZone An IntlTimeZone object corresponding to the one
51868 *   used internally in this object.
51869 **/
51870function intlcal_get_time_zone($cal){}
51871
51872/**
51873 * Get the calendar type
51874 *
51875 * A string describing the type of this calendar. This is one of the
51876 * valid values for the calendar keyword value 'calendar'.
51877 *
51878 * @param IntlCalendar $cal The IntlCalendar resource.
51879 * @return string A string representing the calendar type, such as
51880 *   'gregorian', 'islamic', etc.
51881 **/
51882function intlcal_get_type($cal){}
51883
51884/**
51885 * Get time of the day at which weekend begins or ends
51886 *
51887 * Returns the number of milliseconds after midnight at which the weekend
51888 * begins or ends.
51889 *
51890 * This is only applicable for days of the week for which {@link
51891 * IntlCalendar::getDayOfWeekType} returns either
51892 * IntlCalendar::DOW_TYPE_WEEKEND_OFFSET or
51893 * IntlCalendar::DOW_TYPE_WEEKEND_CEASE. Calling this function for other
51894 * days of the week is an error condition.
51895 *
51896 * This function requires ICU 4.4 or later.
51897 *
51898 * @param IntlCalendar $cal The IntlCalendar resource.
51899 * @param string $dayOfWeek One of the constants
51900 *   IntlCalendar::DOW_SUNDAY, IntlCalendar::DOW_MONDAY, …,
51901 *   IntlCalendar::DOW_SATURDAY.
51902 * @return int The number of milliseconds into the day at which the
51903 *   weekend begins or ends.
51904 **/
51905function intlcal_get_weekend_transition($cal, $dayOfWeek){}
51906
51907/**
51908 * Whether the objectʼs time is in Daylight Savings Time
51909 *
51910 * Whether, for the instant represented by this object and for this
51911 * objectʼs timezone, daylight saving time is in place.
51912 *
51913 * @param IntlCalendar $cal The IntlCalendar resource.
51914 * @return bool Returns TRUE if the date is in Daylight Savings Time,
51915 *   FALSE otherwise. The value FALSE may also be returned on failure,
51916 *   for instance after specifying invalid field values on non-lenient
51917 *   mode; use exceptions or query {@link intl_get_error_code} to
51918 *   disambiguate.
51919 **/
51920function intlcal_in_daylight_time($cal){}
51921
51922/**
51923 * Whether another calendar is equal but for a different time
51924 *
51925 * Returns whether this and the given object are equivalent for all
51926 * purposes except as to the time they have set. The locales do not have
51927 * to match, as long as no change in behavior results from such mismatch.
51928 * This includes the timezone, whether the lenient mode is set, the
51929 * repeated and skipped wall time settings, the days of the week when the
51930 * weekend starts and ceases and the times where such transitions occur.
51931 * It may also include other calendar specific settings, such as the
51932 * Gregorian/Julian transition instant.
51933 *
51934 * @param IntlCalendar $cal The IntlCalendar resource.
51935 * @param IntlCalendar $other The other calendar against which the
51936 *   comparison is to be made.
51937 * @return bool Assuming there are no argument errors, returns TRUE if
51938 *   the calendars are equivalent except possibly for their set time.
51939 **/
51940function intlcal_is_equivalent_to($cal, $other){}
51941
51942/**
51943 * Whether date/time interpretation is in lenient mode
51944 *
51945 * Returns whether the current date/time interpretations is lenient (the
51946 * default). If that is case, some out of range values for fields will be
51947 * accepted instead of raising an error.
51948 *
51949 * @param IntlCalendar $cal The IntlCalendar resource.
51950 * @return bool A bool representing whether the calendar is set to
51951 *   lenient mode.
51952 **/
51953function intlcal_is_lenient($cal){}
51954
51955/**
51956 * Whether a field is set
51957 *
51958 * Returns whether a field is set (as opposed to clear). Set fields take
51959 * priority over unset fields and their default values when the date/time
51960 * is being calculated. Fields set later take priority over fields set
51961 * earlier.
51962 *
51963 * @param IntlCalendar $cal The IntlCalendar resource.
51964 * @param int $field
51965 * @return bool Assuming there are no argument errors, returns TRUE if
51966 *   the field is set.
51967 **/
51968function intlcal_is_set($cal, $field){}
51969
51970/**
51971 * Whether a certain date/time is in the weekend
51972 *
51973 * Returns whether either the obejctʼs current time or the provided
51974 * timestamp occur during a weekend in this objectʼs calendar system.
51975 *
51976 * This function requires ICU 4.4 or later.
51977 *
51978 * @param IntlCalendar $cal The IntlCalendar resource.
51979 * @param float $date An optional timestamp representing the number of
51980 *   milliseconds since the epoch, excluding leap seconds. If NULL, this
51981 *   objectʼs current time is used instead.
51982 * @return bool A bool indicating whether the given or this objectʼs
51983 *   time occurs in a weekend.
51984 **/
51985function intlcal_is_weekend($cal, $date){}
51986
51987/**
51988 * Add value to field without carrying into more significant fields
51989 *
51990 * Adds a (signed) amount to a field. The difference with respect to
51991 * {@link IntlCalendar::add} is that when the field value overflows, it
51992 * does not carry into more significant fields.
51993 *
51994 * @param IntlCalendar $cal The IntlCalendar resource.
51995 * @param int $field
51996 * @param mixed $amountOrUpOrDown The (signed) amount to add to the
51997 *   field, TRUE for rolling up (adding 1), or FALSE for rolling down
51998 *   (subtracting 1).
51999 * @return bool Returns TRUE on success or FALSE on failure.
52000 **/
52001function intlcal_roll($cal, $field, $amountOrUpOrDown){}
52002
52003/**
52004 * Set a time field or several common fields at once
52005 *
52006 * Sets either a specific field to the given value, or sets at once
52007 * several common fields. The range of values that are accepted depend on
52008 * whether the calendar is using the lenient mode.
52009 *
52010 * For fields that conflict, the fields that are set later have priority.
52011 *
52012 * This method cannot be called with exactly four arguments.
52013 *
52014 * @param IntlCalendar $cal The IntlCalendar resource.
52015 * @param int $field
52016 * @param int $value The new value of the given field.
52017 * @return bool Returns TRUE on success and FALSE on failure.
52018 **/
52019function intlcal_set($cal, $field, $value){}
52020
52021/**
52022 * Set the day on which the week is deemed to start
52023 *
52024 * Defines the day of week deemed to start the week. This affects the
52025 * behavior of fields that depend on the concept of week start and end
52026 * such as IntlCalendar::FIELD_WEEK_OF_YEAR and
52027 * IntlCalendar::FIELD_YEAR_WOY.
52028 *
52029 * @param IntlCalendar $cal The IntlCalendar resource.
52030 * @param int $dayOfWeek One of the constants IntlCalendar::DOW_SUNDAY,
52031 *   IntlCalendar::DOW_MONDAY, …, IntlCalendar::DOW_SATURDAY.
52032 * @return bool Returns TRUE on success. Failure can only happen due to
52033 *   invalid parameters.
52034 **/
52035function intlcal_set_first_day_of_week($cal, $dayOfWeek){}
52036
52037/**
52038 * Set whether date/time interpretation is to be lenient
52039 *
52040 * Defines whether the calendar is ‘lenient mode’. In such a mode,
52041 * some of out-of-bounds values for some fields are accepted, the
52042 * behavior being similar to that of {@link IntlCalendar::add} (i.e., the
52043 * value wraps around, carrying into more significant fields each time).
52044 * If the lenient mode is off, then such values will generate an error.
52045 *
52046 * @param IntlCalendar $cal The IntlCalendar resource.
52047 * @param bool $isLenient Use TRUE to activate the lenient mode; FALSE
52048 *   otherwise.
52049 * @return bool Returns TRUE on success. Failure can only happen due to
52050 *   invalid parameters.
52051 **/
52052function intlcal_set_lenient($cal, $isLenient){}
52053
52054/**
52055 * Set minimal number of days the first week in a year or month can have
52056 *
52057 * Sets the smallest number of days the first week of a year or month
52058 * must have in the new year or month. For instance, in the Gregorian
52059 * calendar, if this value is 1, then the first week of the year will
52060 * necessarily include January 1st, while if this value is 7, then the
52061 * week with January 1st will be the first week of the year only if the
52062 * day of the week for January 1st matches the day of the week returned
52063 * by {@link IntlCalendar::getFirstDayOfWeek}; otherwise it will be the
52064 * previous yearʼs last week.
52065 *
52066 * @param IntlCalendar $cal The IntlCalendar resource.
52067 * @param int $minimalDays The number of minimal days to set.
52068 * @return bool TRUE on success, FALSE on failure.
52069 **/
52070function intlcal_set_minimal_days_in_first_week($cal, $minimalDays){}
52071
52072/**
52073 * Set behavior for handling repeating wall times at negative timezone
52074 * offset transitions
52075 *
52076 * Sets the current strategy for dealing with wall times that are
52077 * repeated whenever the clock is set back during dailight saving time
52078 * end transitions. The default value is IntlCalendar::WALLTIME_LAST
52079 * (take the post-DST instant). The other possible value is
52080 * IntlCalendar::WALLTIME_FIRST (take the instant that occurs during
52081 * DST).
52082 *
52083 * This function requires ICU 4.9 or later.
52084 *
52085 * @param IntlCalendar $cal The IntlCalendar resource.
52086 * @param int $wallTimeOption One of the constants
52087 *   IntlCalendar::WALLTIME_FIRST or IntlCalendar::WALLTIME_LAST.
52088 * @return bool Returns TRUE on success. Failure can only happen due to
52089 *   invalid parameters.
52090 **/
52091function intlcal_set_repeated_wall_time_option($cal, $wallTimeOption){}
52092
52093/**
52094 * Set behavior for handling skipped wall times at positive timezone
52095 * offset transitions
52096 *
52097 * Sets the current strategy for dealing with wall times that are skipped
52098 * whenever the clock is forwarded during dailight saving time start
52099 * transitions. The default value is IntlCalendar::WALLTIME_LAST (take it
52100 * as being the same instant as the one when the wall time is one hour
52101 * more). Alternative values are IntlCalendar::WALLTIME_FIRST (same
52102 * instant as the one with a wall time of one hour less) and
52103 * IntlCalendar::WALLTIME_NEXT_VALID (same instant as when DST begins).
52104 *
52105 * This affects only the instant represented by the calendar (as reported
52106 * by {@link IntlCalendar::getTime}), the field values will not be
52107 * rewritten accordingly.
52108 *
52109 * The calendar must be lenient for this option to have any effect,
52110 * otherwise attempting to set a non-existing time will cause an error.
52111 *
52112 * This function requires ICU 4.9 or later.
52113 *
52114 * @param IntlCalendar $cal The IntlCalendar resource.
52115 * @param int $wallTimeOption One of the constants
52116 *   IntlCalendar::WALLTIME_FIRST, IntlCalendar::WALLTIME_LAST or
52117 *   IntlCalendar::WALLTIME_NEXT_VALID.
52118 * @return bool Returns TRUE on success. Failure can only happen due to
52119 *   invalid parameters.
52120 **/
52121function intlcal_set_skipped_wall_time_option($cal, $wallTimeOption){}
52122
52123/**
52124 * Set the calendar time in milliseconds since the epoch
52125 *
52126 * Sets the instant represented by this object. The instant is
52127 * represented by a float whose value should be an integer number of
52128 * milliseconds since the epoch (1 Jan 1970 00:00:00.000 UTC), ignoring
52129 * leap seconds. All the field values will be recalculated accordingly.
52130 *
52131 * @param IntlCalendar $cal The IntlCalendar resource.
52132 * @param float $date An instant represented by the number of number of
52133 *   milliseconds between such instant and the epoch, ignoring leap
52134 *   seconds.
52135 * @return bool Returns TRUE on success and FALSE on failure.
52136 **/
52137function intlcal_set_time($cal, $date){}
52138
52139/**
52140 * Set the timezone used by this calendar
52141 *
52142 * Defines a new timezone for this calendar. The time represented by the
52143 * object is preserved to the detriment of the field values.
52144 *
52145 * @param IntlCalendar $cal The IntlCalendar resource.
52146 * @param mixed $timeZone The new timezone to be used by this calendar.
52147 *   It can be specified in the following ways:
52148 * @return bool Returns TRUE on success and FALSE on failure.
52149 **/
52150function intlcal_set_time_zone($cal, $timeZone){}
52151
52152/**
52153 * Convert an IntlCalendar into a DateTime object
52154 *
52155 * Create a DateTime object that represents the same instant (up to
52156 * second precision, with a rounding error of less than 1 second) and has
52157 * an analog timezone to this object (the difference being DateTimeʼs
52158 * timezone will be backed by PHPʼs timezone while IntlCalendarʼs
52159 * timezone is backed by ICUʼs).
52160 *
52161 * @param IntlCalendar $cal The IntlCalendar resource.
52162 * @return DateTime A DateTime object with the same timezone as this
52163 *   object (though using PHPʼs database instead of ICUʼs) and the same
52164 *   time, except for the smaller precision (second precision instead of
52165 *   millisecond). Returns FALSE on failure.
52166 **/
52167function intlcal_to_date_time($cal){}
52168
52169/**
52170 * Get last error code on the object
52171 *
52172 * @return int
52173 **/
52174function intltz_get_error_code(){}
52175
52176/**
52177 * Get last error message on the object
52178 *
52179 * @return string
52180 **/
52181function intltz_get_error_message(){}
52182
52183/**
52184 * Get symbolic name for a given error code
52185 *
52186 * Return ICU error code name.
52187 *
52188 * @param int $error_code
52189 * @return string
52190 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
52191 **/
52192function intl_error_name($error_code){}
52193
52194/**
52195 * Get last error code on the object
52196 *
52197 * @return int
52198 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
52199 **/
52200function intl_get_error_code(){}
52201
52202/**
52203 * Get last error message on the object
52204 *
52205 * @return string
52206 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
52207 **/
52208function intl_get_error_message(){}
52209
52210/**
52211 * Check whether the given error code indicates failure
52212 *
52213 * @param int $error_code
52214 * @return bool
52215 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
52216 **/
52217function intl_is_failure($error_code){}
52218
52219/**
52220 * Get the integer value of a variable
52221 *
52222 * Returns the integer value of {@link var}, using the specified {@link
52223 * base} for the conversion (the default is base 10). {@link intval}
52224 * should not be used on objects, as doing so will emit an E_NOTICE level
52225 * error and return 1.
52226 *
52227 * @param mixed $var The scalar value being converted to an integer
52228 * @param int $base The base for the conversion
52229 * @return int The integer value of {@link var} on success, or 0 on
52230 *   failure. Empty arrays return 0, non-empty arrays return 1.
52231 * @since PHP 4, PHP 5, PHP 7
52232 **/
52233function intval($var, $base){}
52234
52235/**
52236 * Checks if a value exists in an array
52237 *
52238 * Searches for {@link needle} in {@link haystack} using loose comparison
52239 * unless {@link strict} is set.
52240 *
52241 * @param mixed $needle The searched value.
52242 * @param array $haystack The array.
52243 * @param bool $strict If the third parameter {@link strict} is set to
52244 *   TRUE then the {@link in_array} function will also check the types of
52245 *   the {@link needle} in the {@link haystack}.
52246 * @return bool Returns TRUE if {@link needle} is found in the array,
52247 *   FALSE otherwise.
52248 * @since PHP 4, PHP 5, PHP 7
52249 **/
52250function in_array($needle, $haystack, $strict){}
52251
52252/**
52253 * Converts a string containing an (IPv4) Internet Protocol dotted
52254 * address into a long integer
52255 *
52256 * The function {@link ip2long} generates a long integer representation
52257 * of IPv4 Internet network address from its Internet standard format
52258 * (dotted string) representation.
52259 *
52260 * {@link ip2long} will also work with non-complete IP addresses. Read
52261 * for more info.
52262 *
52263 * @param string $ip_address A standard format address.
52264 * @return int Returns the long integer or FALSE if {@link ip_address}
52265 *   is invalid.
52266 * @since PHP 4, PHP 5, PHP 7
52267 **/
52268function ip2long($ip_address){}
52269
52270/**
52271 * Embeds binary IPTC data into a JPEG image
52272 *
52273 * @param string $iptcdata The data to be written.
52274 * @param string $jpeg_file_name Path to the JPEG image.
52275 * @param int $spool Spool flag. If the spool flag is less than 2 then
52276 *   the JPEG will be returned as a string. Otherwise the JPEG will be
52277 *   printed to STDOUT.
52278 * @return mixed If {@link spool} is less than 2, the JPEG will be
52279 *   returned, . Otherwise returns TRUE on success .
52280 * @since PHP 4, PHP 5, PHP 7
52281 **/
52282function iptcembed($iptcdata, $jpeg_file_name, $spool){}
52283
52284/**
52285 * Parse a binary IPTC block into single tags
52286 *
52287 * Parses an IPTC block into its single tags.
52288 *
52289 * @param string $iptcblock A binary IPTC block.
52290 * @return array Returns an array using the tagmarker as an index and
52291 *   the value as the value. It returns FALSE on error or if no IPTC data
52292 *   was found.
52293 * @since PHP 4, PHP 5, PHP 7
52294 **/
52295function iptcparse($iptcblock){}
52296
52297/**
52298 * Checks if the object is of this class or has this class as one of its
52299 * parents
52300 *
52301 * Checks if the given {@link object} is of this class or has this class
52302 * as one of its parents.
52303 *
52304 * @param mixed $object A class name or an object instance.
52305 * @param string $class_name The class name
52306 * @param bool $allow_string If this parameter set to FALSE, string
52307 *   class name as {@link object} is not allowed. This also prevents from
52308 *   calling autoloader if the class doesn't exist.
52309 * @return bool Returns TRUE if the object is of this class or has this
52310 *   class as one of its parents, FALSE otherwise.
52311 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
52312 **/
52313function is_a($object, $class_name, $allow_string){}
52314
52315/**
52316 * Finds whether a variable is an array
52317 *
52318 * Finds whether the given variable is an array.
52319 *
52320 * @param mixed $var The variable being evaluated.
52321 * @return bool Returns TRUE if {@link var} is an array, FALSE
52322 *   otherwise.
52323 * @since PHP 4, PHP 5, PHP 7
52324 **/
52325function is_array($var){}
52326
52327/**
52328 * Finds out whether a variable is a boolean
52329 *
52330 * Finds whether the given variable is a boolean.
52331 *
52332 * @param mixed $var The variable being evaluated.
52333 * @return bool Returns TRUE if {@link var} is a boolean, FALSE
52334 *   otherwise.
52335 * @since PHP 4, PHP 5, PHP 7
52336 **/
52337function is_bool($var){}
52338
52339/**
52340 * Verify that the contents of a variable can be called as a function
52341 *
52342 * Verify that the contents of a variable can be called as a function.
52343 * This can check that a simple variable contains the name of a valid
52344 * function, or that an array contains a properly encoded object and
52345 * function name.
52346 *
52347 * @param mixed $var The value to check
52348 * @param bool $syntax_only If set to TRUE the function only verifies
52349 *   that {@link var} might be a function or method. It will only reject
52350 *   simple variables that are not strings, or an array that does not
52351 *   have a valid structure to be used as a callback. The valid ones are
52352 *   supposed to have only 2 entries, the first of which is an object or
52353 *   a string, and the second a string.
52354 * @param string $callable_name Receives the "callable name". In the
52355 *   example below it is "someClass::someMethod". Note, however, that
52356 *   despite the implication that someClass::SomeMethod() is a callable
52357 *   static method, this is not the case.
52358 * @return bool Returns TRUE if {@link var} is callable, FALSE
52359 *   otherwise.
52360 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
52361 **/
52362function is_callable($var, $syntax_only, &$callable_name){}
52363
52364/**
52365 * Verify that the contents of a variable is a countable value
52366 *
52367 * Verify that the contents of a variable is an array or an object
52368 * implementing Countable
52369 *
52370 * @param mixed $var The value to check
52371 * @return bool Returns TRUE if {@link var} is countable, FALSE
52372 *   otherwise.
52373 * @since PHP 7 >= 7.3.0
52374 **/
52375function is_countable($var){}
52376
52377/**
52378 * Tells whether the filename is a directory
52379 *
52380 * Tells whether the given filename is a directory.
52381 *
52382 * @param string $filename Path to the file. If {@link filename} is a
52383 *   relative filename, it will be checked relative to the current
52384 *   working directory. If {@link filename} is a symbolic or hard link
52385 *   then the link will be resolved and checked. If you have enabled , or
52386 *   open_basedir further restrictions may apply.
52387 * @return bool Returns TRUE if the filename exists and is a directory,
52388 *   FALSE otherwise.
52389 * @since PHP 4, PHP 5, PHP 7
52390 **/
52391function is_dir($filename){}
52392
52393/**
52394 * Finds whether the type of a variable is float
52395 *
52396 * Finds whether the type of the given variable is float.
52397 *
52398 * @param mixed $var The variable being evaluated.
52399 * @return bool Returns TRUE if {@link var} is a float, FALSE
52400 *   otherwise.
52401 * @since PHP 4, PHP 5, PHP 7
52402 **/
52403function is_double($var){}
52404
52405/**
52406 * Tells whether the filename is executable
52407 *
52408 * @param string $filename Path to the file.
52409 * @return bool Returns TRUE if the filename exists and is executable,
52410 *   or FALSE on error.
52411 * @since PHP 4, PHP 5, PHP 7
52412 **/
52413function is_executable($filename){}
52414
52415/**
52416 * Tells whether the filename is a regular file
52417 *
52418 * Tells whether the given file is a regular file.
52419 *
52420 * @param string $filename Path to the file.
52421 * @return bool Returns TRUE if the filename exists and is a regular
52422 *   file, FALSE otherwise.
52423 * @since PHP 4, PHP 5, PHP 7
52424 **/
52425function is_file($filename){}
52426
52427/**
52428 * Finds whether a value is a legal finite number
52429 *
52430 * Checks whether {@link val} is a legal finite on this platform.
52431 *
52432 * @param float $val The value to check
52433 * @return bool TRUE if {@link val} is a legal finite number within the
52434 *   allowed range for a PHP float on this platform, else FALSE.
52435 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
52436 **/
52437function is_finite($val){}
52438
52439/**
52440 * Finds whether the type of a variable is float
52441 *
52442 * Finds whether the type of the given variable is float.
52443 *
52444 * @param mixed $var The variable being evaluated.
52445 * @return bool Returns TRUE if {@link var} is a float, FALSE
52446 *   otherwise.
52447 * @since PHP 4, PHP 5, PHP 7
52448 **/
52449function is_float($var){}
52450
52451/**
52452 * Finds whether a value is infinite
52453 *
52454 * Returns TRUE if {@link val} is infinite (positive or negative), like
52455 * the result of log(0) or any value too big to fit into a float on this
52456 * platform.
52457 *
52458 * @param float $val The value to check
52459 * @return bool TRUE if {@link val} is infinite, else FALSE.
52460 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
52461 **/
52462function is_infinite($val){}
52463
52464/**
52465 * Find whether the type of a variable is integer
52466 *
52467 * Finds whether the type of the given variable is integer.
52468 *
52469 * @param mixed $var The variable being evaluated.
52470 * @return bool Returns TRUE if {@link var} is an integer, FALSE
52471 *   otherwise.
52472 * @since PHP 4, PHP 5, PHP 7
52473 **/
52474function is_int($var){}
52475
52476/**
52477 * Find whether the type of a variable is integer
52478 *
52479 * Finds whether the type of the given variable is integer.
52480 *
52481 * @param mixed $var The variable being evaluated.
52482 * @return bool Returns TRUE if {@link var} is an integer, FALSE
52483 *   otherwise.
52484 * @since PHP 4, PHP 5, PHP 7
52485 **/
52486function is_integer($var){}
52487
52488/**
52489 * Verify that the contents of a variable is an iterable value
52490 *
52491 * Verify that the contents of a variable is accepted by the iterable
52492 * pseudo-type, i.e. that it is either an array or an object implementing
52493 * Traversable
52494 *
52495 * @param mixed $var The value to check
52496 * @return bool Returns TRUE if {@link var} is iterable, FALSE
52497 *   otherwise.
52498 * @since PHP 7 >= 7.1.0
52499 **/
52500function is_iterable($var){}
52501
52502/**
52503 * Tells whether the filename is a symbolic link
52504 *
52505 * Tells whether the given file is a symbolic link.
52506 *
52507 * @param string $filename Path to the file.
52508 * @return bool Returns TRUE if the filename exists and is a symbolic
52509 *   link, FALSE otherwise.
52510 * @since PHP 4, PHP 5, PHP 7
52511 **/
52512function is_link($filename){}
52513
52514/**
52515 * Find whether the type of a variable is integer
52516 *
52517 * Finds whether the type of the given variable is integer.
52518 *
52519 * @param mixed $var The variable being evaluated.
52520 * @return bool Returns TRUE if {@link var} is an integer, FALSE
52521 *   otherwise.
52522 * @since PHP 4, PHP 5, PHP 7
52523 **/
52524function is_long($var){}
52525
52526/**
52527 * Finds whether a value is not a number
52528 *
52529 * Checks whether {@link val} is 'not a number', like the result of
52530 * acos(1.01).
52531 *
52532 * @param float $val The value to check
52533 * @return bool Returns TRUE if {@link val} is 'not a number', else
52534 *   FALSE.
52535 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
52536 **/
52537function is_nan($val){}
52538
52539/**
52540 * Finds whether a variable is NULL
52541 *
52542 * Finds whether the given variable is NULL.
52543 *
52544 * @param mixed $var The variable being evaluated.
52545 * @return bool Returns TRUE if {@link var} is null, FALSE otherwise.
52546 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
52547 **/
52548function is_null($var){}
52549
52550/**
52551 * Finds whether a variable is a number or a numeric string
52552 *
52553 * Finds whether the given variable is numeric. Numeric strings consist
52554 * of optional whitespace, optional sign, any number of digits, optional
52555 * decimal part and optional exponential part. Thus +0123.45e6 is a valid
52556 * numeric value. Hexadecimal (e.g. 0xf4c3b00c) and binary (e.g.
52557 * 0b10100111001) notation is not allowed.
52558 *
52559 * @param mixed $var The variable being evaluated.
52560 * @return bool Returns TRUE if {@link var} is a number or a numeric
52561 *   string, FALSE otherwise.
52562 * @since PHP 4, PHP 5, PHP 7
52563 **/
52564function is_numeric($var){}
52565
52566/**
52567 * Finds whether a variable is an object
52568 *
52569 * Finds whether the given variable is an object.
52570 *
52571 * @param mixed $var The variable being evaluated.
52572 * @return bool Returns TRUE if {@link var} is an object, FALSE
52573 *   otherwise.
52574 * @since PHP 4, PHP 5, PHP 7
52575 **/
52576function is_object($var){}
52577
52578/**
52579 * Tells whether a file exists and is readable
52580 *
52581 * @param string $filename Path to the file.
52582 * @return bool Returns TRUE if the file or directory specified by
52583 *   {@link filename} exists and is readable, FALSE otherwise.
52584 * @since PHP 4, PHP 5, PHP 7
52585 **/
52586function is_readable($filename){}
52587
52588/**
52589 * Finds whether the type of a variable is float
52590 *
52591 * Finds whether the type of the given variable is float.
52592 *
52593 * @param mixed $var The variable being evaluated.
52594 * @return bool Returns TRUE if {@link var} is a float, FALSE
52595 *   otherwise.
52596 * @since PHP 4, PHP 5, PHP 7
52597 **/
52598function is_real($var){}
52599
52600/**
52601 * Finds whether a variable is a resource
52602 *
52603 * Finds whether the given variable is a resource.
52604 *
52605 * @param mixed $var The variable being evaluated.
52606 * @return bool Returns TRUE if {@link var} is a resource, FALSE
52607 *   otherwise.
52608 * @since PHP 4, PHP 5, PHP 7
52609 **/
52610function is_resource($var){}
52611
52612/**
52613 * Finds whether a variable is a scalar
52614 *
52615 * Finds whether the given variable is a scalar.
52616 *
52617 * Scalar variables are those containing an integer, float, string or
52618 * boolean. Types array, object and resource are not scalar.
52619 *
52620 * @param mixed $var The variable being evaluated.
52621 * @return bool Returns TRUE if {@link var} is a scalar, FALSE
52622 *   otherwise.
52623 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
52624 **/
52625function is_scalar($var){}
52626
52627/**
52628 * Checks if a SOAP call has failed
52629 *
52630 * This function is useful to check if the SOAP call failed, but without
52631 * using exceptions. To use it, create a SoapClient object with the
52632 * exceptions option set to zero or FALSE. In this case, the SOAP method
52633 * will return a special SoapFault object which encapsulates the fault
52634 * details (faultcode, faultstring, faultactor and faultdetails).
52635 *
52636 * If exceptions is not set then SOAP call will throw an exception on
52637 * error. {@link is_soap_fault} checks if the given parameter is a
52638 * SoapFault object.
52639 *
52640 * @param mixed $object The object to test.
52641 * @return bool This will return TRUE on error, and FALSE otherwise.
52642 * @since PHP 5, PHP 7
52643 **/
52644function is_soap_fault($object){}
52645
52646/**
52647 * Find whether the type of a variable is string
52648 *
52649 * Finds whether the type of the given variable is string.
52650 *
52651 * @param mixed $var The variable being evaluated.
52652 * @return bool Returns TRUE if {@link var} is of type string, FALSE
52653 *   otherwise.
52654 * @since PHP 4, PHP 5, PHP 7
52655 **/
52656function is_string($var){}
52657
52658/**
52659 * Checks if the object has this class as one of its parents or
52660 * implements it
52661 *
52662 * Checks if the given {@link object} has the class {@link class_name} as
52663 * one of its parents or implements it.
52664 *
52665 * @param mixed $object A class name or an object instance. No error is
52666 *   generated if the class does not exist.
52667 * @param string $class_name The class name
52668 * @param bool $allow_string If this parameter set to false, string
52669 *   class name as {@link object} is not allowed. This also prevents from
52670 *   calling autoloader if the class doesn't exist.
52671 * @return bool This function returns TRUE if the object {@link
52672 *   object}, belongs to a class which is a subclass of {@link
52673 *   class_name}, FALSE otherwise.
52674 * @since PHP 4, PHP 5, PHP 7
52675 **/
52676function is_subclass_of($object, $class_name, $allow_string){}
52677
52678/**
52679 * Checks whether a string is tainted
52680 *
52681 * @param string $string
52682 * @return bool Return TRUE if the string is tainted, FALSE otherwise.
52683 * @since PECL taint >=0.1.0
52684 **/
52685function is_tainted($string){}
52686
52687/**
52688 * Tells whether the file was uploaded via HTTP POST
52689 *
52690 * Returns TRUE if the file named by {@link filename} was uploaded via
52691 * HTTP POST. This is useful to help ensure that a malicious user hasn't
52692 * tried to trick the script into working on files upon which it should
52693 * not be working--for instance, /etc/passwd.
52694 *
52695 * This sort of check is especially important if there is any chance that
52696 * anything done with uploaded files could reveal their contents to the
52697 * user, or even to other users on the same system.
52698 *
52699 * For proper working, the function {@link is_uploaded_file} needs an
52700 * argument like $_FILES['userfile']['tmp_name'], - the name of the
52701 * uploaded file on the client's machine $_FILES['userfile']['name'] does
52702 * not work.
52703 *
52704 * @param string $filename The filename being checked.
52705 * @return bool
52706 * @since PHP 4 >= 4.0.3, PHP 5, PHP 7
52707 **/
52708function is_uploaded_file($filename){}
52709
52710/**
52711 * Tells whether the filename is writable
52712 *
52713 * Returns TRUE if the {@link filename} exists and is writable. The
52714 * filename argument may be a directory name allowing you to check if a
52715 * directory is writable.
52716 *
52717 * Keep in mind that PHP may be accessing the file as the user id that
52718 * the web server runs as (often 'nobody'). Safe mode limitations are not
52719 * taken into account.
52720 *
52721 * @param string $filename The filename being checked.
52722 * @return bool Returns TRUE if the {@link filename} exists and is
52723 *   writable.
52724 * @since PHP 4, PHP 5, PHP 7
52725 **/
52726function is_writable($filename){}
52727
52728/**
52729 * Tells whether the filename is writable
52730 *
52731 * Returns TRUE if the {@link filename} exists and is writable. The
52732 * filename argument may be a directory name allowing you to check if a
52733 * directory is writable.
52734 *
52735 * Keep in mind that PHP may be accessing the file as the user id that
52736 * the web server runs as (often 'nobody'). Safe mode limitations are not
52737 * taken into account.
52738 *
52739 * @param string $filename The filename being checked.
52740 * @return bool Returns TRUE if the {@link filename} exists and is
52741 *   writable.
52742 * @since PHP 4, PHP 5, PHP 7
52743 **/
52744function is_writeable($filename){}
52745
52746/**
52747 * Call a function for every element in an iterator
52748 *
52749 * Calls a function for every element in an iterator.
52750 *
52751 * @param Traversable $iterator The iterator object to iterate over.
52752 * @param callable $function The callback function to call on every
52753 *   element. This function only receives the given {@link args}, so it
52754 *   is nullary by default. If count($args) === 3, for instance, the
52755 *   callback function is ternary. The function must return TRUE in order
52756 *   to continue iterating over the {@link iterator}.
52757 * @param array $args An array of arguments; each element of {@link
52758 *   args} is passed to the callback {@link function} as separate
52759 *   argument.
52760 * @return int Returns the iteration count.
52761 * @since PHP 5 >= 5.1.0, PHP 7
52762 **/
52763function iterator_apply($iterator, $function, $args){}
52764
52765/**
52766 * Count the elements in an iterator
52767 *
52768 * Count the elements in an iterator. {@link iterator_count} is not
52769 * guaranteed to retain the current position of the {@link iterator}.
52770 *
52771 * @param Traversable $iterator The iterator being counted.
52772 * @return int The number of elements in {@link iterator}.
52773 * @since PHP 5 >= 5.1.0, PHP 7
52774 **/
52775function iterator_count($iterator){}
52776
52777/**
52778 * Copy the iterator into an array
52779 *
52780 * Copy the elements of an iterator into an array.
52781 *
52782 * @param Traversable $iterator The iterator being copied.
52783 * @param bool $use_keys Whether to use the iterator element keys as
52784 *   index. In PHP 5.5 and later, if a key is an array or object, a
52785 *   warning will be generated. NULL keys will be converted to an empty
52786 *   string, float keys will be truncated to their integer counterpart,
52787 *   resource keys will generate a warning and be converted to their
52788 *   resource ID, and boolean keys will be converted to integers.
52789 * @return array An array containing the elements of the {@link
52790 *   iterator}.
52791 * @since PHP 5 >= 5.1.0, PHP 7
52792 **/
52793function iterator_to_array($iterator, $use_keys){}
52794
52795/**
52796 * Returns the day of the week
52797 *
52798 * Returns the day of the week. Can return a string or an integer
52799 * depending on the mode.
52800 *
52801 * @param int $julianday A julian day number as integer
52802 * @param int $mode
52803 * @return mixed The gregorian weekday as either an integer or string.
52804 * @since PHP 4, PHP 5, PHP 7
52805 **/
52806function jddayofweek($julianday, $mode){}
52807
52808/**
52809 * Returns a month name
52810 *
52811 * Returns a string containing a month name. {@link mode} tells this
52812 * function which calendar to convert the Julian Day Count to, and what
52813 * type of month names are to be returned. Calendar modes Mode Meaning
52814 * Values CAL_MONTH_GREGORIAN_SHORT Gregorian - abbreviated Jan, Feb,
52815 * Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec
52816 * CAL_MONTH_GREGORIAN_LONG Gregorian January, February, March, April,
52817 * May, June, July, August, September, October, November, December
52818 * CAL_MONTH_JULIAN_SHORT Julian - abbreviated Jan, Feb, Mar, Apr, May,
52819 * Jun, Jul, Aug, Sep, Oct, Nov, Dec CAL_MONTH_JULIAN_LONG Julian
52820 * January, February, March, April, May, June, July, August, September,
52821 * October, November, December CAL_MONTH_JEWISH Jewish Tishri, Heshvan,
52822 * Kislev, Tevet, Shevat, AdarI, AdarII, Nisan, Iyyar, Sivan, Tammuz, Av,
52823 * Elul CAL_MONTH_FRENCH French Republican Vendemiaire, Brumaire,
52824 * Frimaire, Nivose, Pluviose, Ventose, Germinal, Floreal, Prairial,
52825 * Messidor, Thermidor, Fructidor, Extra
52826 *
52827 * @param int $julianday The Julian Day to operate on
52828 * @param int $mode The calendar mode (see table above).
52829 * @return string The month name for the given Julian Day and {@link
52830 *   mode}.
52831 * @since PHP 4, PHP 5, PHP 7
52832 **/
52833function jdmonthname($julianday, $mode){}
52834
52835/**
52836 * Converts a Julian Day Count to the French Republican Calendar
52837 *
52838 * @param int $juliandaycount A julian day number as integer
52839 * @return string The french revolution date as a string in the form
52840 *   "month/day/year"
52841 * @since PHP 4, PHP 5, PHP 7
52842 **/
52843function jdtofrench($juliandaycount){}
52844
52845/**
52846 * Converts Julian Day Count to Gregorian date
52847 *
52848 * Converts Julian Day Count to a string containing the Gregorian date in
52849 * the format of "month/day/year".
52850 *
52851 * @param int $julianday A julian day number as integer
52852 * @return string The gregorian date as a string in the form
52853 *   "month/day/year"
52854 * @since PHP 4, PHP 5, PHP 7
52855 **/
52856function jdtogregorian($julianday){}
52857
52858/**
52859 * Converts a Julian day count to a Jewish calendar date
52860 *
52861 * Converts a Julian Day Count to the Jewish Calendar.
52862 *
52863 * @param int $juliandaycount A julian day number as integer
52864 * @param bool $hebrew If the {@link hebrew} parameter is set to TRUE,
52865 *   the {@link fl} parameter is used for Hebrew, ISO-8859-8 encoded
52866 *   string based, output format.
52867 * @param int $fl A bitmask which may consist of
52868 *   CAL_JEWISH_ADD_ALAFIM_GERESH, CAL_JEWISH_ADD_ALAFIM and
52869 *   CAL_JEWISH_ADD_GERESHAYIM.
52870 * @return string The Jewish date as a string in the form
52871 *   "month/day/year", or an ISO-8859-8 encoded Hebrew date string,
52872 *   according to the {@link hebrew} parameter.
52873 * @since PHP 4, PHP 5, PHP 7
52874 **/
52875function jdtojewish($juliandaycount, $hebrew, $fl){}
52876
52877/**
52878 * Converts a Julian Day Count to a Julian Calendar Date
52879 *
52880 * Converts Julian Day Count to a string containing the Julian Calendar
52881 * Date in the format of "month/day/year".
52882 *
52883 * @param int $julianday A julian day number as integer
52884 * @return string The julian date as a string in the form
52885 *   "month/day/year"
52886 * @since PHP 4, PHP 5, PHP 7
52887 **/
52888function jdtojulian($julianday){}
52889
52890/**
52891 * Convert Julian Day to Unix timestamp
52892 *
52893 * This function will return a Unix timestamp corresponding to the Julian
52894 * Day given in {@link jday} or FALSE if {@link jday} is not inside the
52895 * Unix epoch (Gregorian years between 1970 and 2037 or 2440588 <= {@link
52896 * jday} <= 2465342 ). The time returned is UTC.
52897 *
52898 * @param int $jday A julian day number between 2440588 and 2465342.
52899 * @return int The unix timestamp for the start (midnight, not noon) of
52900 *   the given Julian day.
52901 * @since PHP 4, PHP 5, PHP 7
52902 **/
52903function jdtounix($jday){}
52904
52905/**
52906 * Converts a date in the Jewish Calendar to Julian Day Count
52907 *
52908 * Although this function can handle dates all the way back to the year 1
52909 * (3761 B.C.), such use may not be meaningful. The Jewish calendar has
52910 * been in use for several thousand years, but in the early days there
52911 * was no formula to determine the start of a month. A new month was
52912 * started when the new moon was first observed.
52913 *
52914 * @param int $month The month as a number from 1 to 13, where 1 means
52915 *   Tishri, 13 means Elul, and 6 and 7 mean Adar in regular years, but
52916 *   Adar I and Adar II, respectively, in leap years.
52917 * @param int $day The day as a number from 1 to 30. If the month has
52918 *   only 29 days, the first day of the following month is assumed.
52919 * @param int $year The year as a number between 1 and 9999
52920 * @return int The julian day for the given jewish date as an integer.
52921 * @since PHP 4, PHP 5, PHP 7
52922 **/
52923function jewishtojd($month, $day, $year){}
52924
52925/**
52926 * Join array elements with a string
52927 *
52928 * Join array elements with a {@link glue} string.
52929 *
52930 * @param string $glue Defaults to an empty string.
52931 * @param array $pieces The array of strings to implode.
52932 * @return string Returns a string containing a string representation
52933 *   of all the array elements in the same order, with the glue string
52934 *   between each element.
52935 * @since PHP 4, PHP 5, PHP 7
52936 **/
52937function join($glue, $pieces){}
52938
52939/**
52940 * Convert JPEG image file to WBMP image file
52941 *
52942 * Converts a JPEG file into a WBMP file.
52943 *
52944 * @param string $jpegname Path to JPEG file.
52945 * @param string $wbmpname Path to destination WBMP file.
52946 * @param int $dest_height Destination image height.
52947 * @param int $dest_width Destination image width.
52948 * @param int $threshold Threshold value, between 0 and 8 (inclusive).
52949 * @return bool
52950 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
52951 **/
52952function jpeg2wbmp($jpegname, $wbmpname, $dest_height, $dest_width, $threshold){}
52953
52954/**
52955 * Decodes a JSON string
52956 *
52957 * Takes a JSON encoded string and converts it into a PHP variable.
52958 *
52959 * @param string $json The {@link json} string being decoded. This
52960 *   function only works with UTF-8 encoded strings.
52961 * @param bool $assoc When TRUE, returned s will be converted into
52962 *   associative s.
52963 * @param int $depth User specified recursion depth.
52964 * @param int $options Bitmask of JSON_BIGINT_AS_STRING,
52965 *   JSON_INVALID_UTF8_IGNORE, JSON_INVALID_UTF8_SUBSTITUTE,
52966 *   JSON_OBJECT_AS_ARRAY, JSON_THROW_ON_ERROR. The behaviour of these
52967 *   constants is described on the JSON constants page.
52968 * @return mixed Returns the value encoded in {@link json} in
52969 *   appropriate PHP type. Values true, false and null are returned as
52970 *   TRUE, FALSE and NULL respectively. NULL is returned if the {@link
52971 *   json} cannot be decoded or if the encoded data is deeper than the
52972 *   recursion limit.
52973 * @since PHP 5 >= 5.2.0, PHP 7, PECL json >= 1.2.0
52974 **/
52975function json_decode($json, $assoc, $depth, $options){}
52976
52977/**
52978 * Returns the JSON representation of a value
52979 *
52980 * Returns a string containing the JSON representation of the supplied
52981 * {@link value}.
52982 *
52983 * The encoding is affected by the supplied {@link options} and
52984 * additionally the encoding of float values depends on the value of
52985 * serialize_precision.
52986 *
52987 * @param mixed $value The {@link value} being encoded. Can be any type
52988 *   except a . All string data must be UTF-8 encoded.
52989 * @param int $options Bitmask consisting of JSON_FORCE_OBJECT,
52990 *   JSON_HEX_QUOT, JSON_HEX_TAG, JSON_HEX_AMP, JSON_HEX_APOS,
52991 *   JSON_INVALID_UTF8_IGNORE, JSON_INVALID_UTF8_SUBSTITUTE,
52992 *   JSON_NUMERIC_CHECK, JSON_PARTIAL_OUTPUT_ON_ERROR,
52993 *   JSON_PRESERVE_ZERO_FRACTION, JSON_PRETTY_PRINT,
52994 *   JSON_UNESCAPED_LINE_TERMINATORS, JSON_UNESCAPED_SLASHES,
52995 *   JSON_UNESCAPED_UNICODE, JSON_THROW_ON_ERROR. The behaviour of these
52996 *   constants is described on the JSON constants page.
52997 * @param int $depth Set the maximum depth. Must be greater than zero.
52998 * @return string Returns a JSON encoded on success .
52999 * @since PHP 5 >= 5.2.0, PHP 7, PECL json >= 1.2.0
53000 **/
53001function json_encode($value, $options, $depth){}
53002
53003/**
53004 * Returns the last error occurred
53005 *
53006 * Returns the last error (if any) occurred during the last JSON
53007 * encoding/decoding, which did not specify JSON_THROW_ON_ERROR.
53008 *
53009 * @return int Returns an integer, the value can be one of the
53010 *   following constants:
53011 * @since PHP 5 >= 5.3.0, PHP 7
53012 **/
53013function json_last_error(){}
53014
53015/**
53016 * Returns the error string of the last json_encode() or json_decode()
53017 * call
53018 *
53019 * Returns the error string of the last {@link json_encode} or {@link
53020 * json_decode} call, which did not specify JSON_THROW_ON_ERROR.
53021 *
53022 * @return string Returns the error message on success, "No error" if
53023 *   no error has occurred, .
53024 * @since PHP 5 >= 5.5.0, PHP 7
53025 **/
53026function json_last_error_msg(){}
53027
53028/**
53029 * Return the type of a array
53030 *
53031 * {@link judy_type} return an integer corresponding to the Judy type of
53032 * the specified Judy {@link array}.
53033 *
53034 * @param Judy $array The Judy Array to test.
53035 * @return int Return an integer corresponding to a Judy type.
53036 * @since PECL judy >= 0.1.1
53037 **/
53038function judy_type($array){}
53039
53040/**
53041 * Return or print the current PHP Judy version
53042 *
53043 * Return a string of the PHP Judy version. If the return value is not
53044 * used, the string will be printed.
53045 *
53046 * @return string Return a string of the PHP Judy version.
53047 * @since PECL judy >= 0.1.1
53048 **/
53049function judy_version(){}
53050
53051/**
53052 * Converts a Julian Calendar date to Julian Day Count
53053 *
53054 * Valid Range for Julian Calendar 4713 B.C. to 9999 A.D.
53055 *
53056 * Although this function can handle dates all the way back to 4713 B.C.,
53057 * such use may not be meaningful. The calendar was created in 46 B.C.,
53058 * but the details did not stabilize until at least 8 A.D., and perhaps
53059 * as late at the 4th century. Also, the beginning of a year varied from
53060 * one culture to another - not all accepted January as the first month.
53061 *
53062 * @param int $month The month as a number from 1 (for January) to 12
53063 *   (for December)
53064 * @param int $day The day as a number from 1 to 31
53065 * @param int $year The year as a number between -4713 and 9999
53066 * @return int The julian day for the given julian date as an integer.
53067 * @since PHP 4, PHP 5, PHP 7
53068 **/
53069function juliantojd($month, $day, $year){}
53070
53071/**
53072 * Changes the principal's password
53073 *
53074 * {@link kadm5_chpass_principal} sets the new password {@link password}
53075 * for the {@link principal}.
53076 *
53077 * @param resource $handle A KADM5 handle.
53078 * @param string $principal The principal.
53079 * @param string $password The new password.
53080 * @return bool
53081 * @since PECL kadm5 >= 0.2.3
53082 **/
53083function kadm5_chpass_principal($handle, $principal, $password){}
53084
53085/**
53086 * Creates a kerberos principal with the given parameters
53087 *
53088 * Creates a {@link principal} with the given {@link password}.
53089 *
53090 * @param resource $handle A KADM5 handle.
53091 * @param string $principal The principal.
53092 * @param string $password If {@link password} is omitted or is NULL, a
53093 *   random key will be generated.
53094 * @param array $options It is possible to specify several optional
53095 *   parameters within the array {@link options}. Allowed are the
53096 *   following options: KADM5_PRINC_EXPIRE_TIME, KADM5_PW_EXPIRATION,
53097 *   KADM5_ATTRIBUTES, KADM5_MAX_LIFE, KADM5_KVNO, KADM5_POLICY,
53098 *   KADM5_CLEARPOLICY, KADM5_MAX_RLIFE.
53099 * @return bool
53100 * @since PECL kadm5 >= 0.2.3
53101 **/
53102function kadm5_create_principal($handle, $principal, $password, $options){}
53103
53104/**
53105 * Deletes a kerberos principal
53106 *
53107 * Removes the {@link principal} from the Kerberos database.
53108 *
53109 * @param resource $handle A KADM5 handle.
53110 * @param string $principal The removed principal.
53111 * @return bool
53112 * @since PECL kadm5 >= 0.2.3
53113 **/
53114function kadm5_delete_principal($handle, $principal){}
53115
53116/**
53117 * Closes the connection to the admin server and releases all related
53118 * resources
53119 *
53120 * Closes the connection to the admin server and releases all related
53121 * resources.
53122 *
53123 * @param resource $handle A KADM5 handle.
53124 * @return bool
53125 * @since PECL kadm5 >= 0.2.3
53126 **/
53127function kadm5_destroy($handle){}
53128
53129/**
53130 * Flush all changes to the Kerberos database
53131 *
53132 * Flush all changes to the Kerberos database, leaving the connection to
53133 * the Kerberos admin server open.
53134 *
53135 * @param resource $handle A KADM5 handle.
53136 * @return bool
53137 * @since PECL kadm5 >= 0.2.3
53138 **/
53139function kadm5_flush($handle){}
53140
53141/**
53142 * Gets all policies from the Kerberos database
53143 *
53144 * Gets an array containing the policies's names.
53145 *
53146 * @param resource $handle A KADM5 handle.
53147 * @return array Returns array of policies on success.
53148 * @since PECL kadm5 >= 0.2.3
53149 **/
53150function kadm5_get_policies($handle){}
53151
53152/**
53153 * Gets the principal's entries from the Kerberos database
53154 *
53155 * @param resource $handle A KADM5 handle.
53156 * @param string $principal The principal.
53157 * @return array Returns array of options containing the following
53158 *   keys: KADM5_PRINCIPAL, KADM5_PRINC_EXPIRE_TIME, KADM5_PW_EXPIRATION,
53159 *   KADM5_ATTRIBUTES, KADM5_MAX_LIFE, KADM5_MOD_NAME, KADM5_MOD_TIME,
53160 *   KADM5_KVNO, KADM5_POLICY, KADM5_MAX_RLIFE, KADM5_LAST_SUCCESS,
53161 *   KADM5_LAST_FAILED, KADM5_FAIL_AUTH_COUNT on success.
53162 * @since PECL kadm5 >= 0.2.3
53163 **/
53164function kadm5_get_principal($handle, $principal){}
53165
53166/**
53167 * Gets all principals from the Kerberos database
53168 *
53169 * {@link kadm5_get_principals} returns an array containing the
53170 * principals's names.
53171 *
53172 * @param resource $handle A KADM5 handle.
53173 * @return array Returns array of principals on success.
53174 * @since PECL kadm5 >= 0.2.3
53175 **/
53176function kadm5_get_principals($handle){}
53177
53178/**
53179 * Opens a connection to the KADM5 library
53180 *
53181 * Opens a connection with the KADM5 library using the {@link principal}
53182 * and the given {@link password} to obtain initial credentials from the
53183 * {@link admin_server}.
53184 *
53185 * @param string $admin_server The server.
53186 * @param string $realm Defines the authentication domain for the
53187 *   connection.
53188 * @param string $principal The principal.
53189 * @param string $password If {@link password} is omitted or is NULL, a
53190 *   random key will be generated.
53191 * @return resource Returns a KADM5 handle on success.
53192 * @since PECL kadm5 >= 0.2.3
53193 **/
53194function kadm5_init_with_password($admin_server, $realm, $principal, $password){}
53195
53196/**
53197 * Modifies a kerberos principal with the given parameters
53198 *
53199 * Modifies a {@link principal} according to the given {@link options}.
53200 *
53201 * @param resource $handle A KADM5 handle.
53202 * @param string $principal The principal.
53203 * @param array $options It is possible to specify several optional
53204 *   parameters within the array {@link options}. Allowed are the
53205 *   following options: KADM5_PRINC_EXPIRE_TIME, KADM5_PW_EXPIRATION,
53206 *   KADM5_ATTRIBUTES, KADM5_MAX_LIFE, KADM5_KVNO, KADM5_POLICY,
53207 *   KADM5_CLEARPOLICY, KADM5_MAX_RLIFE. KADM5_FAIL_AUTH_COUNT.
53208 * @return bool
53209 * @since PECL kadm5 >= 0.2.3
53210 **/
53211function kadm5_modify_principal($handle, $principal, $options){}
53212
53213/**
53214 * Fetch a key from an array
53215 *
53216 * {@link key} returns the index element of the current array position.
53217 *
53218 * @param array $array The array.
53219 * @return mixed The {@link key} function simply returns the key of the
53220 *   array element that's currently being pointed to by the internal
53221 *   pointer. It does not move the pointer in any way. If the internal
53222 *   pointer points beyond the end of the elements list or the array is
53223 *   empty, {@link key} returns NULL.
53224 * @since PHP 4, PHP 5, PHP 7
53225 **/
53226function key($array){}
53227
53228/**
53229 * Checks if the given key or index exists in the array
53230 *
53231 * {@link key_exists} returns TRUE if the given {@link key} is set in the
53232 * array. {@link key} can be any value possible for an array index.
53233 *
53234 * @param mixed $key Value to check.
53235 * @param array $array An array with keys to check.
53236 * @return bool
53237 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
53238 **/
53239function key_exists($key, $array){}
53240
53241/**
53242 * Sort an array by key in reverse order
53243 *
53244 * Sorts an array by key in reverse order, maintaining key to data
53245 * correlations. This is useful mainly for associative arrays.
53246 *
53247 * @param array $array The input array.
53248 * @param int $sort_flags You may modify the behavior of the sort using
53249 *   the optional parameter {@link sort_flags}, for details see {@link
53250 *   sort}.
53251 * @return bool
53252 * @since PHP 4, PHP 5, PHP 7
53253 **/
53254function krsort(&$array, $sort_flags){}
53255
53256/**
53257 * Sort an array by key
53258 *
53259 * Sorts an array by key, maintaining key to data correlations. This is
53260 * useful mainly for associative arrays.
53261 *
53262 * @param array $array The input array.
53263 * @param int $sort_flags You may modify the behavior of the sort using
53264 *   the optional parameter {@link sort_flags}, for details see {@link
53265 *   sort}.
53266 * @return bool
53267 * @since PHP 4, PHP 5, PHP 7
53268 **/
53269function ksort(&$array, $sort_flags){}
53270
53271/**
53272 * Make a string's first character lowercase
53273 *
53274 * Returns a string with the first character of {@link str} lowercased if
53275 * that character is alphabetic.
53276 *
53277 * Note that 'alphabetic' is determined by the current locale. For
53278 * instance, in the default "C" locale characters such as umlaut-a (ä)
53279 * will not be converted.
53280 *
53281 * @param string $str The input string.
53282 * @return string Returns the resulting string.
53283 * @since PHP 5 >= 5.3.0, PHP 7
53284 **/
53285function lcfirst($str){}
53286
53287/**
53288 * Combined linear congruential generator
53289 *
53290 * {@link lcg_value} returns a pseudo random number in the range of (0,
53291 * 1). The function combines two CGs with periods of 2^31 - 85 and 2^31 -
53292 * 249. The period of this function is equal to the product of both
53293 * primes.
53294 *
53295 * @return float A pseudo random float value between 0.0 and 1.0,
53296 *   inclusive.
53297 * @since PHP 4, PHP 5, PHP 7
53298 **/
53299function lcg_value(){}
53300
53301/**
53302 * Changes group ownership of symlink
53303 *
53304 * Attempts to change the group of the symlink {@link filename} to {@link
53305 * group}.
53306 *
53307 * Only the superuser may change the group of a symlink arbitrarily;
53308 * other users may change the group of a symlink to any group of which
53309 * that user is a member.
53310 *
53311 * @param string $filename Path to the symlink.
53312 * @param mixed $group The group specified by name or number.
53313 * @return bool
53314 * @since PHP 5 >= 5.1.3, PHP 7
53315 **/
53316function lchgrp($filename, $group){}
53317
53318/**
53319 * Changes user ownership of symlink
53320 *
53321 * Attempts to change the owner of the symlink {@link filename} to user
53322 * {@link user}.
53323 *
53324 * Only the superuser may change the owner of a symlink.
53325 *
53326 * @param string $filename Path to the file.
53327 * @param mixed $user User name or number.
53328 * @return bool
53329 * @since PHP 5 >= 5.1.3, PHP 7
53330 **/
53331function lchown($filename, $user){}
53332
53333/**
53334 * Translate 8859 characters to t61 characters
53335 *
53336 * Translate ISO-8859 characters to t61 characters.
53337 *
53338 * This function is useful if you have to talk to a legacy LDAPv2 server.
53339 *
53340 * @param string $value The text to be translated.
53341 * @return string Return the t61 translation of {@link value}.
53342 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
53343 **/
53344function ldap_8859_to_t61($value){}
53345
53346/**
53347 * Add entries to LDAP directory
53348 *
53349 * Add entries in the LDAP directory.
53350 *
53351 * @param resource $link_identifier An LDAP link identifier, returned
53352 *   by {@link ldap_connect}.
53353 * @param string $dn The distinguished name of an LDAP entity.
53354 * @param array $entry An array that specifies the information about
53355 *   the entry. The values in the entries are indexed by individual
53356 *   attributes. In case of multiple values for an attribute, they are
53357 *   indexed using integers starting with 0. <?php $entry["attribute1"] =
53358 *   "value"; $entry["attribute2"][0] = "value1"; $entry["attribute2"][1]
53359 *   = "value2"; ?>
53360 * @param array $serverctrls Array of LDAP Controls to send with the
53361 *   request.
53362 * @return bool
53363 * @since PHP 4, PHP 5, PHP 7
53364 **/
53365function ldap_add($link_identifier, $dn, $entry, $serverctrls){}
53366
53367/**
53368 * Add entries to LDAP directory
53369 *
53370 * Does the same thing as {@link ldap_add} but returns the LDAP result
53371 * resource to be parsed with {@link ldap_parse_result}.
53372 *
53373 * @param resource $link_identifier
53374 * @param string $dn
53375 * @param array $entry
53376 * @param array $serverctrls
53377 * @return resource Returns an LDAP result identifier or FALSE on
53378 *   error.
53379 * @since PHP 7 >= 7.3.0
53380 **/
53381function ldap_add_ext($link_identifier, $dn, $entry, $serverctrls){}
53382
53383/**
53384 * Bind to LDAP directory
53385 *
53386 * Binds to the LDAP directory with specified RDN and password.
53387 *
53388 * @param resource $link_identifier An LDAP link identifier, returned
53389 *   by {@link ldap_connect}.
53390 * @param string $bind_rdn
53391 * @param string $bind_password
53392 * @return bool
53393 * @since PHP 4, PHP 5, PHP 7
53394 **/
53395function ldap_bind($link_identifier, $bind_rdn, $bind_password){}
53396
53397/**
53398 * Bind to LDAP directory
53399 *
53400 * Does the same thing as {@link ldap_bind} but returns the LDAP result
53401 * resource to be parsed with {@link ldap_parse_result}.
53402 *
53403 * @param resource $link_identifier
53404 * @param string $bind_rdn
53405 * @param string $bind_password
53406 * @param array $serverctrls
53407 * @return resource Returns an LDAP result identifier or FALSE on
53408 *   error.
53409 * @since PHP 7 >= 7.3.0
53410 **/
53411function ldap_bind_ext($link_identifier, $bind_rdn, $bind_password, $serverctrls){}
53412
53413/**
53414 * Unbind from LDAP directory
53415 *
53416 * Unbinds from the LDAP directory.
53417 *
53418 * @param resource $link_identifier An LDAP link identifier, returned
53419 *   by {@link ldap_connect}.
53420 * @return bool
53421 * @since PHP 4, PHP 5, PHP 7
53422 **/
53423function ldap_close($link_identifier){}
53424
53425/**
53426 * Compare value of attribute found in entry specified with DN
53427 *
53428 * Compare {@link value} of {@link attribute} with value of same
53429 * attribute in an LDAP directory entry.
53430 *
53431 * @param resource $link_identifier An LDAP link identifier, returned
53432 *   by {@link ldap_connect}.
53433 * @param string $dn The distinguished name of an LDAP entity.
53434 * @param string $attribute The attribute name.
53435 * @param string $value The compared value.
53436 * @param array $serverctrls Array of LDAP Controls to send with the
53437 *   request.
53438 * @return mixed Returns TRUE if {@link value} matches otherwise
53439 *   returns FALSE. Returns -1 on error.
53440 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
53441 **/
53442function ldap_compare($link_identifier, $dn, $attribute, $value, $serverctrls){}
53443
53444/**
53445 * Connect to an LDAP server
53446 *
53447 * Creates an LDAP link identifier and checks whether the given {@link
53448 * host} and {@link port} are plausible.
53449 *
53450 * @param string $ldap_uri A full LDAP URI of the form
53451 *   ldap://hostname:port or ldaps://hostname:port for SSL encryption.
53452 *   You can also provide multiple LDAP-URIs separated by a space as one
53453 *   string Note that hostname:port is not a supported LDAP URI as the
53454 *   schema is missing.
53455 * @return resource Returns a positive LDAP link identifier when the
53456 *   provided LDAP URI seems plausible. It's a syntactic check of the
53457 *   provided parameter but the server(s) will not be contacted! If the
53458 *   syntactic check fails it returns FALSE. {@link ldap_connect} will
53459 *   otherwise return a resource as it does not actually connect but just
53460 *   initializes the connecting parameters. The actual connect happens
53461 *   with the next calls to ldap_* funcs, usually with {@link ldap_bind}.
53462 * @since PHP 4, PHP 5, PHP 7
53463 **/
53464function ldap_connect($ldap_uri){}
53465
53466/**
53467 * Send LDAP pagination control
53468 *
53469 * Enable LDAP pagination by sending the pagination control (page size,
53470 * cookie...).
53471 *
53472 * @param resource $link An LDAP link identifier, returned by {@link
53473 *   ldap_connect}.
53474 * @param int $pagesize The number of entries by page.
53475 * @param bool $iscritical Indicates whether the pagination is critical
53476 *   or not. If true and if the server doesn't support pagination, the
53477 *   search will return no result.
53478 * @param string $cookie An opaque structure sent by the server ({@link
53479 *   ldap_control_paged_result_response}).
53480 * @return bool
53481 * @since PHP 5 >= 5.4.0, PHP 7
53482 **/
53483function ldap_control_paged_result($link, $pagesize, $iscritical, $cookie){}
53484
53485/**
53486 * Retrieve the LDAP pagination cookie
53487 *
53488 * Retrieve the pagination information send by the server.
53489 *
53490 * @param resource $link An LDAP link identifier, returned by {@link
53491 *   ldap_connect}.
53492 * @param resource $result
53493 * @param string $cookie An opaque structure sent by the server.
53494 * @param int $estimated The estimated number of entries to retrieve.
53495 * @return bool
53496 * @since PHP 5 >= 5.4.0, PHP 7
53497 **/
53498function ldap_control_paged_result_response($link, $result, &$cookie, &$estimated){}
53499
53500/**
53501 * Count the number of entries in a search
53502 *
53503 * Returns the number of entries stored in the result of previous search
53504 * operations.
53505 *
53506 * @param resource $link_identifier An LDAP link identifier, returned
53507 *   by {@link ldap_connect}.
53508 * @param resource $result_identifier The internal LDAP result.
53509 * @return int Returns number of entries in the result or FALSE on
53510 *   error.
53511 * @since PHP 4, PHP 5, PHP 7
53512 **/
53513function ldap_count_entries($link_identifier, $result_identifier){}
53514
53515/**
53516 * Delete an entry from a directory
53517 *
53518 * Deletes a particular entry in LDAP directory.
53519 *
53520 * @param resource $link_identifier An LDAP link identifier, returned
53521 *   by {@link ldap_connect}.
53522 * @param string $dn The distinguished name of an LDAP entity.
53523 * @param array $serverctrls Array of LDAP Controls to send with the
53524 *   request.
53525 * @return bool
53526 * @since PHP 4, PHP 5, PHP 7
53527 **/
53528function ldap_delete($link_identifier, $dn, $serverctrls){}
53529
53530/**
53531 * Delete an entry from a directory
53532 *
53533 * Does the same thing as {@link ldap_delete} but returns the LDAP result
53534 * resource to be parsed with {@link ldap_parse_result}.
53535 *
53536 * @param resource $link_identifier
53537 * @param string $dn
53538 * @param array $serverctrls
53539 * @return resource Returns an LDAP result identifier or FALSE on
53540 *   error.
53541 * @since PHP 7 >= 7.3.0
53542 **/
53543function ldap_delete_ext($link_identifier, $dn, $serverctrls){}
53544
53545/**
53546 * Convert DN to User Friendly Naming format
53547 *
53548 * Turns the specified {@link dn}, into a more user-friendly form,
53549 * stripping off type names.
53550 *
53551 * @param string $dn The distinguished name of an LDAP entity.
53552 * @return string Returns the user friendly name.
53553 * @since PHP 4, PHP 5, PHP 7
53554 **/
53555function ldap_dn2ufn($dn){}
53556
53557/**
53558 * Convert LDAP error number into string error message
53559 *
53560 * Returns the string error message explaining the error number {@link
53561 * errno}. While LDAP errno numbers are standardized, different libraries
53562 * return different or even localized textual error messages. Never check
53563 * for a specific error message text, but always use an error number to
53564 * check.
53565 *
53566 * @param int $errno The error number.
53567 * @return string Returns the error message, as a string.
53568 * @since PHP 4, PHP 5, PHP 7
53569 **/
53570function ldap_err2str($errno){}
53571
53572/**
53573 * Return the LDAP error number of the last LDAP command
53574 *
53575 * Returns the standardized error number returned by the last LDAP
53576 * command. This number can be converted into a textual error message
53577 * using {@link ldap_err2str}.
53578 *
53579 * @param resource $link_identifier An LDAP link identifier, returned
53580 *   by {@link ldap_connect}.
53581 * @return int Return the LDAP error number of the last LDAP command
53582 *   for this link.
53583 * @since PHP 4, PHP 5, PHP 7
53584 **/
53585function ldap_errno($link_identifier){}
53586
53587/**
53588 * Return the LDAP error message of the last LDAP command
53589 *
53590 * Returns the string error message explaining the error generated by the
53591 * last LDAP command for the given {@link link_identifier}. While LDAP
53592 * errno numbers are standardized, different libraries return different
53593 * or even localized textual error messages. Never check for a specific
53594 * error message text, but always use an error number to check.
53595 *
53596 * Unless you lower your warning level in your sufficiently or prefix
53597 * your LDAP commands with @ (at) characters to suppress warning output,
53598 * the errors generated will also show up in your HTML output.
53599 *
53600 * @param resource $link_identifier An LDAP link identifier, returned
53601 *   by {@link ldap_connect}.
53602 * @return string Returns string error message.
53603 * @since PHP 4, PHP 5, PHP 7
53604 **/
53605function ldap_error($link_identifier){}
53606
53607/**
53608 * Escape a string for use in an LDAP filter or DN
53609 *
53610 * Escapes {@link value} for use in the context implied by {@link flags}.
53611 *
53612 * @param string $value The value to escape.
53613 * @param string $ignore Characters to ignore when escaping.
53614 * @param int $flags The context the escaped string will be used in:
53615 *   LDAP_ESCAPE_FILTER for filters to be used with {@link ldap_search},
53616 *   or LDAP_ESCAPE_DN for DNs. If neither flag is passed, all chars are
53617 *   escaped.
53618 * @return string Returns the escaped string.
53619 * @since PHP 5 >= 5.6.0, PHP 7
53620 **/
53621function ldap_escape($value, $ignore, $flags){}
53622
53623/**
53624 * Performs an extended operation
53625 *
53626 * Performs an extended operation on the specified {@link link} with
53627 * {@link reqoid} the OID of the operation and {@link reqdata} the data.
53628 *
53629 * @param resource $link An LDAP link identifier, returned by {@link
53630 *   ldap_connect}.
53631 * @param string $reqoid The extended operation request OID. You may
53632 *   use one of LDAP_EXOP_START_TLS, LDAP_EXOP_MODIFY_PASSWD,
53633 *   LDAP_EXOP_REFRESH, LDAP_EXOP_WHO_AM_I, LDAP_EXOP_TURN, or a string
53634 *   with the OID of the operation you want to send.
53635 * @param string $reqdata The extended operation request data. May be
53636 *   NULL for some operations like LDAP_EXOP_WHO_AM_I, may also need to
53637 *   be BER encoded.
53638 * @param array $serverctrls Array of LDAP Controls to send with the
53639 *   request.
53640 * @param string $retdata Will be filled with the extended operation
53641 *   response data if provided. If not provided you may use
53642 *   ldap_parse_exop on the result object later to get this data.
53643 * @param string $retoid Will be filled with the response OID if
53644 *   provided, usually equal to the request OID.
53645 * @return mixed When used with {@link retdata}, returns TRUE on
53646 *   success or FALSE on error. When used without {@link retdata},
53647 *   returns a result identifier or FALSE on error.
53648 * @since PHP 7 >= 7.2.0
53649 **/
53650function ldap_exop($link, $reqoid, $reqdata, $serverctrls, &$retdata, &$retoid){}
53651
53652/**
53653 * PASSWD extended operation helper
53654 *
53655 * Performs a PASSWD extended operation.
53656 *
53657 * @param resource $link An LDAP link identifier, returned by {@link
53658 *   ldap_connect}.
53659 * @param string $user dn of the user to change the password of.
53660 * @param string $oldpw The old password of this user. May be ommited
53661 *   depending of server configuration.
53662 * @param string $newpw The new password for this user. May be omitted
53663 *   or empty to have a generated password.
53664 * @param array $serverctrls If provided, a password policy request
53665 *   control is send with the request and this is filled with an array of
53666 *   LDAP Controls returned with the request.
53667 * @return mixed Returns the generated password if {@link newpw} is
53668 *   empty or omitted. Otherwise returns TRUE on success and FALSE on
53669 *   failure.
53670 * @since PHP 7 >= 7.2.0
53671 **/
53672function ldap_exop_passwd($link, $user, $oldpw, $newpw, &$serverctrls){}
53673
53674/**
53675 * Refresh extended operation helper
53676 *
53677 * Performs a Refresh extended operation and returns the data.
53678 *
53679 * @param resource $link An LDAP link identifier, returned by {@link
53680 *   ldap_connect}.
53681 * @param string $dn dn of the entry to refresh.
53682 * @param int $ttl Time in seconds (between 1 and 31557600) that the
53683 *   client requests that the entry exists in the directory before being
53684 *   automatically removed.
53685 * @return int From RFC: The responseTtl field is the time in seconds
53686 *   which the server chooses to have as the time-to-live field for that
53687 *   entry. It must not be any smaller than that which the client
53688 *   requested, and it may be larger. However, to allow servers to
53689 *   maintain a relatively accurate directory, and to prevent clients
53690 *   from abusing the dynamic extensions, servers are permitted to
53691 *   shorten a client-requested time-to-live value, down to a minimum of
53692 *   86400 seconds (one day).
53693 *
53694 *   FALSE will be returned on error.
53695 * @since PHP 7 >= 7.3.0
53696 **/
53697function ldap_exop_refresh($link, $dn, $ttl){}
53698
53699/**
53700 * WHOAMI extended operation helper
53701 *
53702 * Performs a WHOAMI extended operation and returns the data.
53703 *
53704 * @param resource $link An LDAP link identifier, returned by {@link
53705 *   ldap_connect}.
53706 * @return string The data returned by the server, or FALSE on error.
53707 * @since PHP 7 >= 7.2.0
53708 **/
53709function ldap_exop_whoami($link){}
53710
53711/**
53712 * Splits DN into its component parts
53713 *
53714 * Splits the DN returned by {@link ldap_get_dn} and breaks it up into
53715 * its component parts. Each part is known as Relative Distinguished
53716 * Name, or RDN.
53717 *
53718 * @param string $dn The distinguished name of an LDAP entity.
53719 * @param int $with_attrib Used to request if the RDNs are returned
53720 *   with only values or their attributes as well. To get RDNs with the
53721 *   attributes (i.e. in attribute=value format) set {@link with_attrib}
53722 *   to 0 and to get only values set it to 1.
53723 * @return array Returns an array of all DN components, . The first
53724 *   element in the array has count key and represents the number of
53725 *   returned values, next elements are numerically indexed DN
53726 *   components.
53727 * @since PHP 4, PHP 5, PHP 7
53728 **/
53729function ldap_explode_dn($dn, $with_attrib){}
53730
53731/**
53732 * Return first attribute
53733 *
53734 * Gets the first attribute in the given entry. Remaining attributes are
53735 * retrieved by calling {@link ldap_next_attribute} successively.
53736 *
53737 * Similar to reading entries, attributes are also read one by one from a
53738 * particular entry.
53739 *
53740 * @param resource $link_identifier An LDAP link identifier, returned
53741 *   by {@link ldap_connect}.
53742 * @param resource $result_entry_identifier
53743 * @return string Returns the first attribute in the entry on success
53744 *   and FALSE on error.
53745 * @since PHP 4, PHP 5, PHP 7
53746 **/
53747function ldap_first_attribute($link_identifier, $result_entry_identifier){}
53748
53749/**
53750 * Return first result id
53751 *
53752 * Returns the entry identifier for first entry in the result. This entry
53753 * identifier is then supplied to {@link ldap_next_entry} routine to get
53754 * successive entries from the result.
53755 *
53756 * Entries in the LDAP result are read sequentially using the {@link
53757 * ldap_first_entry} and {@link ldap_next_entry} functions.
53758 *
53759 * @param resource $link_identifier An LDAP link identifier, returned
53760 *   by {@link ldap_connect}.
53761 * @param resource $result_identifier
53762 * @return resource Returns the result entry identifier for the first
53763 *   entry on success and FALSE on error.
53764 * @since PHP 4, PHP 5, PHP 7
53765 **/
53766function ldap_first_entry($link_identifier, $result_identifier){}
53767
53768/**
53769 * Return first reference
53770 *
53771 * @param resource $link
53772 * @param resource $result
53773 * @return resource
53774 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
53775 **/
53776function ldap_first_reference($link, $result){}
53777
53778/**
53779 * Free result memory
53780 *
53781 * Frees up the memory allocated internally to store the result. All
53782 * result memory will be automatically freed when the script terminates.
53783 *
53784 * Typically all the memory allocated for the LDAP result gets freed at
53785 * the end of the script. In case the script is making successive
53786 * searches which return large result sets, {@link ldap_free_result}
53787 * could be called to keep the runtime memory usage by the script low.
53788 *
53789 * @param resource $result_identifier
53790 * @return bool
53791 * @since PHP 4, PHP 5, PHP 7
53792 **/
53793function ldap_free_result($result_identifier){}
53794
53795/**
53796 * Get attributes from a search result entry
53797 *
53798 * Reads attributes and values from an entry in the search result.
53799 *
53800 * Having located a specific entry in the directory, you can find out
53801 * what information is held for that entry by using this call. You would
53802 * use this call for an application which "browses" directory entries
53803 * and/or where you do not know the structure of the directory entries.
53804 * In many applications you will be searching for a specific attribute
53805 * such as an email address or a surname, and won't care what other data
53806 * is held.
53807 *
53808 * return_value["count"] = number of attributes in the entry
53809 * return_value[0] = first attribute return_value[n] = nth attribute
53810 *
53811 * return_value["attribute"]["count"] = number of values for attribute
53812 * return_value["attribute"][0] = first value of the attribute
53813 * return_value["attribute"][i] = (i+1)th value of the attribute
53814 *
53815 * @param resource $link_identifier An LDAP link identifier, returned
53816 *   by {@link ldap_connect}.
53817 * @param resource $result_entry_identifier
53818 * @return array Returns a complete entry information in a
53819 *   multi-dimensional array on success and FALSE on error.
53820 * @since PHP 4, PHP 5, PHP 7
53821 **/
53822function ldap_get_attributes($link_identifier, $result_entry_identifier){}
53823
53824/**
53825 * Get the DN of a result entry
53826 *
53827 * Finds out the DN of an entry in the result.
53828 *
53829 * @param resource $link_identifier An LDAP link identifier, returned
53830 *   by {@link ldap_connect}.
53831 * @param resource $result_entry_identifier
53832 * @return string Returns the DN of the result entry and FALSE on
53833 *   error.
53834 * @since PHP 4, PHP 5, PHP 7
53835 **/
53836function ldap_get_dn($link_identifier, $result_entry_identifier){}
53837
53838/**
53839 * Get all result entries
53840 *
53841 * Reads multiple entries from the given result, and then reading the
53842 * attributes and multiple values.
53843 *
53844 * @param resource $link_identifier An LDAP link identifier, returned
53845 *   by {@link ldap_connect}.
53846 * @param resource $result_identifier
53847 * @return array Returns a complete result information in a
53848 *   multi-dimensional array on success and FALSE on error.
53849 * @since PHP 4, PHP 5, PHP 7
53850 **/
53851function ldap_get_entries($link_identifier, $result_identifier){}
53852
53853/**
53854 * Get the current value for given option
53855 *
53856 * Sets {@link retval} to the value of the specified option.
53857 *
53858 * @param resource $link_identifier An LDAP link identifier, returned
53859 *   by {@link ldap_connect}.
53860 * @param int $option The parameter {@link option} can be one of:
53861 *   Option Type since LDAP_OPT_DEREF integer LDAP_OPT_SIZELIMIT integer
53862 *   LDAP_OPT_TIMELIMIT integer LDAP_OPT_NETWORK_TIMEOUT integer
53863 *   LDAP_OPT_PROTOCOL_VERSION integer LDAP_OPT_ERROR_NUMBER integer
53864 *   LDAP_OPT_DIAGNOSTIC_MESSAGE integer LDAP_OPT_REFERRALS bool
53865 *   LDAP_OPT_RESTART bool LDAP_OPT_HOST_NAME string
53866 *   LDAP_OPT_ERROR_STRING string LDAP_OPT_MATCHED_DN string
53867 *   LDAP_OPT_SERVER_CONTROLS array LDAP_OPT_CLIENT_CONTROLS array
53868 *   LDAP_OPT_X_KEEPALIVE_IDLE int 7.1 LDAP_OPT_X_KEEPALIVE_PROBES int
53869 *   7.1 LDAP_OPT_X_KEEPALIVE_INTERVAL int 7.1 LDAP_OPT_X_TLS_CACERTDIR
53870 *   string 7.1 LDAP_OPT_X_TLS_CACERTFILE string 7.1
53871 *   LDAP_OPT_X_TLS_CERTFILE string 7.1 LDAP_OPT_X_TLS_CIPHER_SUITE
53872 *   string 7.1 LDAP_OPT_X_TLS_CRLCHECK integer 7.1
53873 *   LDAP_OPT_X_TLS_CRL_NONE integer 7.1 LDAP_OPT_X_TLS_CRL_PEER integer
53874 *   7.1 LDAP_OPT_X_TLS_CRL_ALL integer 7.1 LDAP_OPT_X_TLS_CRLFILE string
53875 *   7.1 LDAP_OPT_X_TLS_DHFILE string 7.1 LDAP_OPT_X_TLS_KEYILE string
53876 *   7.1 LDAP_OPT_X_TLS_PACKAGE string 7.1 LDAP_OPT_X_TLS_PROTOCOL_MIN
53877 *   integer 7.1 LDAP_OPT_X_TLS_RANDOM_FILE string 7.1
53878 *   LDAP_OPT_X_TLS_REQUIRE_CERT integer
53879 * @param mixed $retval This will be set to the option value.
53880 * @return bool
53881 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
53882 **/
53883function ldap_get_option($link_identifier, $option, &$retval){}
53884
53885/**
53886 * Get all values from a result entry
53887 *
53888 * Reads all the values of the attribute in the entry in the result.
53889 *
53890 * This call needs a {@link result_entry_identifier}, so needs to be
53891 * preceded by one of the ldap search calls and one of the calls to get
53892 * an individual entry.
53893 *
53894 * You application will either be hard coded to look for certain
53895 * attributes (such as "surname" or "mail") or you will have to use the
53896 * {@link ldap_get_attributes} call to work out what attributes exist for
53897 * a given entry.
53898 *
53899 * @param resource $link_identifier An LDAP link identifier, returned
53900 *   by {@link ldap_connect}.
53901 * @param resource $result_entry_identifier
53902 * @param string $attribute
53903 * @return array Returns an array of values for the attribute on
53904 *   success and FALSE on error. The number of values can be found by
53905 *   indexing "count" in the resultant array. Individual values are
53906 *   accessed by integer index in the array. The first index is 0.
53907 * @since PHP 4, PHP 5, PHP 7
53908 **/
53909function ldap_get_values($link_identifier, $result_entry_identifier, $attribute){}
53910
53911/**
53912 * Get all binary values from a result entry
53913 *
53914 * Reads all the values of the attribute in the entry in the result.
53915 *
53916 * This function is used exactly like {@link ldap_get_values} except that
53917 * it handles binary data and not string data.
53918 *
53919 * @param resource $link_identifier An LDAP link identifier, returned
53920 *   by {@link ldap_connect}.
53921 * @param resource $result_entry_identifier
53922 * @param string $attribute
53923 * @return array Returns an array of values for the attribute on
53924 *   success and FALSE on error. Individual values are accessed by
53925 *   integer index in the array. The first index is 0. The number of
53926 *   values can be found by indexing "count" in the resultant array.
53927 * @since PHP 4, PHP 5, PHP 7
53928 **/
53929function ldap_get_values_len($link_identifier, $result_entry_identifier, $attribute){}
53930
53931/**
53932 * Single-level search
53933 *
53934 * Performs the search for a specified {@link filter} on the directory
53935 * with the scope LDAP_SCOPE_ONELEVEL.
53936 *
53937 * LDAP_SCOPE_ONELEVEL means that the search should only return
53938 * information that is at the level immediately below the {@link base_dn}
53939 * given in the call. (Equivalent to typing "ls" and getting a list of
53940 * files and folders in the current working directory.)
53941 *
53942 * @param resource $link_identifier An LDAP link identifier, returned
53943 *   by {@link ldap_connect}.
53944 * @param string $base_dn The base DN for the directory.
53945 * @param string $filter
53946 * @param array $attributes An array of the required attributes, e.g.
53947 *   array("mail", "sn", "cn"). Note that the "dn" is always returned
53948 *   irrespective of which attributes types are requested. Using this
53949 *   parameter is much more efficient than the default action (which is
53950 *   to return all attributes and their associated values). The use of
53951 *   this parameter should therefore be considered good practice.
53952 * @param int $attrsonly Should be set to 1 if only attribute types are
53953 *   wanted. If set to 0 both attributes types and attribute values are
53954 *   fetched which is the default behaviour.
53955 * @param int $sizelimit Enables you to limit the count of entries
53956 *   fetched. Setting this to 0 means no limit.
53957 * @param int $timelimit Sets the number of seconds how long is spend
53958 *   on the search. Setting this to 0 means no limit.
53959 * @param int $deref Specifies how aliases should be handled during the
53960 *   search. It can be one of the following: LDAP_DEREF_NEVER - (default)
53961 *   aliases are never dereferenced. LDAP_DEREF_SEARCHING - aliases
53962 *   should be dereferenced during the search but not when locating the
53963 *   base object of the search. LDAP_DEREF_FINDING - aliases should be
53964 *   dereferenced when locating the base object but not during the
53965 *   search. LDAP_DEREF_ALWAYS - aliases should be dereferenced always.
53966 * @param array $serverctrls Array of LDAP Controls to send with the
53967 *   request.
53968 * @return resource Returns a search result identifier or FALSE on
53969 *   error.
53970 * @since PHP 4, PHP 5, PHP 7
53971 **/
53972function ldap_list($link_identifier, $base_dn, $filter, $attributes, $attrsonly, $sizelimit, $timelimit, $deref, $serverctrls){}
53973
53974/**
53975 * Replace attribute values with new ones
53976 *
53977 * Replaces one or more attributes from the specified {@link dn}. It may
53978 * also add or remove attributes.
53979 *
53980 * @param resource $link_identifier An LDAP link identifier, returned
53981 *   by {@link ldap_connect}.
53982 * @param string $dn The distinguished name of an LDAP entity.
53983 * @param array $entry An associative array listing the attributes to
53984 *   replace. Sending an empty array as value will remove the attribute,
53985 *   while sending an attribute not existing yet on this entry will add
53986 *   it.
53987 * @param array $serverctrls Array of LDAP Controls to send with the
53988 *   request.
53989 * @return bool
53990 * @since PHP 4, PHP 5, PHP 7
53991 **/
53992function ldap_modify($link_identifier, $dn, $entry, $serverctrls){}
53993
53994/**
53995 * Batch and execute modifications on an LDAP entry
53996 *
53997 * Modifies an existing entry in the LDAP directory. Allows detailed
53998 * specification of the modifications to perform.
53999 *
54000 * @param resource $link_identifier An LDAP link identifier, returned
54001 *   by {@link ldap_connect}.
54002 * @param string $dn The distinguished name of an LDAP entity.
54003 * @param array $entry An array that specifies the modifications to
54004 *   make. Each entry in this array is an associative array with two or
54005 *   three keys: attrib maps to the name of the attribute to modify,
54006 *   modtype maps to the type of modification to perform, and (depending
54007 *   on the type of modification) values maps to an array of attribute
54008 *   values relevant to the modification. Possible values for modtype
54009 *   include: LDAP_MODIFY_BATCH_ADD Each value specified through values
54010 *   is added (as an additional value) to the attribute named by attrib.
54011 *   LDAP_MODIFY_BATCH_REMOVE Each value specified through values is
54012 *   removed from the attribute named by attrib. Any value of the
54013 *   attribute not contained in the values array will remain untouched.
54014 *   LDAP_MODIFY_BATCH_REMOVE_ALL All values are removed from the
54015 *   attribute named by attrib. A values entry must not be provided.
54016 *   LDAP_MODIFY_BATCH_REPLACE All current values of the attribute named
54017 *   by attrib are replaced with the values specified through values.
54018 *   Note that any value for attrib must be a string, any value for
54019 *   values must be an array of strings, and any value for modtype must
54020 *   be one of the LDAP_MODIFY_BATCH_* constants listed above.
54021 * @param array $serverctrls Each value specified through values is
54022 *   added (as an additional value) to the attribute named by attrib.
54023 * @return bool
54024 * @since PHP 5.4 >= 5.4.26, PHP 5.5 >= 5.5.10, PHP 5.6 >= 5.6.0, PHP 7
54025 **/
54026function ldap_modify_batch($link_identifier, $dn, $entry, $serverctrls){}
54027
54028/**
54029 * Add attribute values to current attributes
54030 *
54031 * Adds one or more attribute values to the specified {@link dn}. To add
54032 * a whole new object see {@link ldap_add} function.
54033 *
54034 * @param resource $link_identifier An LDAP link identifier, returned
54035 *   by {@link ldap_connect}.
54036 * @param string $dn The distinguished name of an LDAP entity.
54037 * @param array $entry An associative array listing the attirbute
54038 *   values to add. If an attribute was not existing yet it will be
54039 *   added. If an attribute is existing you can only add values to it if
54040 *   it supports multiple values.
54041 * @param array $serverctrls Array of LDAP Controls to send with the
54042 *   request.
54043 * @return bool
54044 * @since PHP 4, PHP 5, PHP 7
54045 **/
54046function ldap_mod_add($link_identifier, $dn, $entry, $serverctrls){}
54047
54048/**
54049 * Add attribute values to current attributes
54050 *
54051 * Does the same thing as {@link ldap_mod_add} but returns the LDAP
54052 * result resource to be parsed with {@link ldap_parse_result}.
54053 *
54054 * @param resource $link_identifier
54055 * @param string $dn
54056 * @param array $entry
54057 * @param array $serverctrls
54058 * @return resource Returns an LDAP result identifier or FALSE on
54059 *   error.
54060 * @since PHP 7 >= 7.3.0
54061 **/
54062function ldap_mod_add_ext($link_identifier, $dn, $entry, $serverctrls){}
54063
54064/**
54065 * Delete attribute values from current attributes
54066 *
54067 * Removes one or more attribute values from the specified {@link dn}.
54068 * Object deletions are done by the {@link ldap_delete} function.
54069 *
54070 * @param resource $link_identifier An LDAP link identifier, returned
54071 *   by {@link ldap_connect}.
54072 * @param string $dn The distinguished name of an LDAP entity.
54073 * @param array $entry
54074 * @param array $serverctrls Array of LDAP Controls to send with the
54075 *   request.
54076 * @return bool
54077 * @since PHP 4, PHP 5, PHP 7
54078 **/
54079function ldap_mod_del($link_identifier, $dn, $entry, $serverctrls){}
54080
54081/**
54082 * Delete attribute values from current attributes
54083 *
54084 * Does the same thing as {@link ldap_mod_del} but returns the LDAP
54085 * result resource to be parsed with {@link ldap_parse_result}.
54086 *
54087 * @param resource $link_identifier
54088 * @param string $dn
54089 * @param array $entry
54090 * @param array $serverctrls
54091 * @return resource Returns an LDAP result identifier or FALSE on
54092 *   error.
54093 * @since PHP 7 >= 7.3.0
54094 **/
54095function ldap_mod_del_ext($link_identifier, $dn, $entry, $serverctrls){}
54096
54097/**
54098 * Replace attribute values with new ones
54099 *
54100 * Replaces one or more attributes from the specified {@link dn}. It may
54101 * also add or remove attributes.
54102 *
54103 * @param resource $link_identifier An LDAP link identifier, returned
54104 *   by {@link ldap_connect}.
54105 * @param string $dn The distinguished name of an LDAP entity.
54106 * @param array $entry An associative array listing the attributes to
54107 *   replace. Sending an empty array as value will remove the attribute,
54108 *   while sending an attribute not existing yet on this entry will add
54109 *   it.
54110 * @param array $serverctrls Array of LDAP Controls to send with the
54111 *   request.
54112 * @return bool
54113 * @since PHP 4, PHP 5, PHP 7
54114 **/
54115function ldap_mod_replace($link_identifier, $dn, $entry, $serverctrls){}
54116
54117/**
54118 * Replace attribute values with new ones
54119 *
54120 * Does the same thing as {@link ldap_mod_replace} but returns the LDAP
54121 * result resource to be parsed with {@link ldap_parse_result}.
54122 *
54123 * @param resource $link_identifier
54124 * @param string $dn
54125 * @param array $entry
54126 * @param array $serverctrls
54127 * @return resource Returns an LDAP result identifier or FALSE on
54128 *   error.
54129 * @since PHP 7 >= 7.3.0
54130 **/
54131function ldap_mod_replace_ext($link_identifier, $dn, $entry, $serverctrls){}
54132
54133/**
54134 * Get the next attribute in result
54135 *
54136 * Retrieves the attributes in an entry. The first call to {@link
54137 * ldap_next_attribute} is made with the {@link result_entry_identifier}
54138 * returned from {@link ldap_first_attribute}.
54139 *
54140 * @param resource $link_identifier An LDAP link identifier, returned
54141 *   by {@link ldap_connect}.
54142 * @param resource $result_entry_identifier
54143 * @return string Returns the next attribute in an entry on success and
54144 *   FALSE on error.
54145 * @since PHP 4, PHP 5, PHP 7
54146 **/
54147function ldap_next_attribute($link_identifier, $result_entry_identifier){}
54148
54149/**
54150 * Get next result entry
54151 *
54152 * Retrieve the entries stored in the result. Successive calls to the
54153 * {@link ldap_next_entry} return entries one by one till there are no
54154 * more entries. The first call to {@link ldap_next_entry} is made after
54155 * the call to {@link ldap_first_entry} with the {@link
54156 * result_entry_identifier} as returned from the {@link
54157 * ldap_first_entry}.
54158 *
54159 * @param resource $link_identifier An LDAP link identifier, returned
54160 *   by {@link ldap_connect}.
54161 * @param resource $result_entry_identifier
54162 * @return resource Returns entry identifier for the next entry in the
54163 *   result whose entries are being read starting with {@link
54164 *   ldap_first_entry}. If there are no more entries in the result then
54165 *   it returns FALSE.
54166 * @since PHP 4, PHP 5, PHP 7
54167 **/
54168function ldap_next_entry($link_identifier, $result_entry_identifier){}
54169
54170/**
54171 * Get next reference
54172 *
54173 * @param resource $link
54174 * @param resource $entry
54175 * @return resource
54176 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
54177 **/
54178function ldap_next_reference($link, $entry){}
54179
54180/**
54181 * Parse result object from an LDAP extended operation
54182 *
54183 * Parse LDAP extended operation data from result object {@link result}
54184 *
54185 * @param resource $link An LDAP link identifier, returned by {@link
54186 *   ldap_connect}.
54187 * @param resource $result An LDAP result resource, returned by {@link
54188 *   ldap_exop}.
54189 * @param string $retdata Will be filled by the response data.
54190 * @param string $retoid Will be filled by the response OID.
54191 * @return bool
54192 * @since PHP 7 >= 7.2.0
54193 **/
54194function ldap_parse_exop($link, $result, &$retdata, &$retoid){}
54195
54196/**
54197 * Extract information from reference entry
54198 *
54199 * @param resource $link
54200 * @param resource $entry
54201 * @param array $referrals
54202 * @return bool
54203 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
54204 **/
54205function ldap_parse_reference($link, $entry, &$referrals){}
54206
54207/**
54208 * Extract information from result
54209 *
54210 * Parses an LDAP search result.
54211 *
54212 * @param resource $link An LDAP link identifier, returned by {@link
54213 *   ldap_connect}.
54214 * @param resource $result An LDAP result resource, returned by {@link
54215 *   ldap_list} or {@link ldap_search}.
54216 * @param int $errcode A reference to a variable that will be set to
54217 *   the LDAP error code in the result, or 0 if no error occurred.
54218 * @param string $matcheddn A reference to a variable that will be set
54219 *   to a matched DN if one was recognised within the request, otherwise
54220 *   it will be set to NULL.
54221 * @param string $errmsg A reference to a variable that will be set to
54222 *   the LDAP error message in the result, or an empty string if no error
54223 *   occurred.
54224 * @param array $referrals A reference to a variable that will be set
54225 *   to an array set to all of the referral strings in the result, or an
54226 *   empty array if no referrals were returned.
54227 * @param array $serverctrls An array of LDAP Controls which have been
54228 *   sent with the response.
54229 * @return bool
54230 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
54231 **/
54232function ldap_parse_result($link, $result, &$errcode, &$matcheddn, &$errmsg, &$referrals, &$serverctrls){}
54233
54234/**
54235 * Read an entry
54236 *
54237 * Performs the search for a specified {@link filter} on the directory
54238 * with the scope LDAP_SCOPE_BASE. So it is equivalent to reading an
54239 * entry from the directory.
54240 *
54241 * @param resource $link_identifier An LDAP link identifier, returned
54242 *   by {@link ldap_connect}.
54243 * @param string $base_dn The base DN for the directory.
54244 * @param string $filter An empty filter is not allowed. If you want to
54245 *   retrieve absolutely all information for this entry, use a filter of
54246 *   objectClass=*. If you know which entry types are used on the
54247 *   directory server, you might use an appropriate filter such as
54248 *   objectClass=inetOrgPerson.
54249 * @param array $attributes An array of the required attributes, e.g.
54250 *   array("mail", "sn", "cn"). Note that the "dn" is always returned
54251 *   irrespective of which attributes types are requested. Using this
54252 *   parameter is much more efficient than the default action (which is
54253 *   to return all attributes and their associated values). The use of
54254 *   this parameter should therefore be considered good practice.
54255 * @param int $attrsonly Should be set to 1 if only attribute types are
54256 *   wanted. If set to 0 both attributes types and attribute values are
54257 *   fetched which is the default behaviour.
54258 * @param int $sizelimit Enables you to limit the count of entries
54259 *   fetched. Setting this to 0 means no limit.
54260 * @param int $timelimit Sets the number of seconds how long is spend
54261 *   on the search. Setting this to 0 means no limit.
54262 * @param int $deref Specifies how aliases should be handled during the
54263 *   search. It can be one of the following: LDAP_DEREF_NEVER - (default)
54264 *   aliases are never dereferenced. LDAP_DEREF_SEARCHING - aliases
54265 *   should be dereferenced during the search but not when locating the
54266 *   base object of the search. LDAP_DEREF_FINDING - aliases should be
54267 *   dereferenced when locating the base object but not during the
54268 *   search. LDAP_DEREF_ALWAYS - aliases should be dereferenced always.
54269 * @param array $serverctrls Array of LDAP Controls to send with the
54270 *   request.
54271 * @return resource Returns a search result identifier or FALSE on
54272 *   error.
54273 * @since PHP 4, PHP 5, PHP 7
54274 **/
54275function ldap_read($link_identifier, $base_dn, $filter, $attributes, $attrsonly, $sizelimit, $timelimit, $deref, $serverctrls){}
54276
54277/**
54278 * Modify the name of an entry
54279 *
54280 * The entry specified by {@link dn} is renamed/moved.
54281 *
54282 * @param resource $link_identifier An LDAP link identifier, returned
54283 *   by {@link ldap_connect}.
54284 * @param string $dn The distinguished name of an LDAP entity.
54285 * @param string $newrdn The new RDN.
54286 * @param string $newparent The new parent/superior entry.
54287 * @param bool $deleteoldrdn If TRUE the old RDN value(s) is removed,
54288 *   else the old RDN value(s) is retained as non-distinguished values of
54289 *   the entry.
54290 * @param array $serverctrls Array of LDAP Controls to send with the
54291 *   request.
54292 * @return bool
54293 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
54294 **/
54295function ldap_rename($link_identifier, $dn, $newrdn, $newparent, $deleteoldrdn, $serverctrls){}
54296
54297/**
54298 * Modify the name of an entry
54299 *
54300 * Does the same thing as {@link ldap_rename} but returns the LDAP result
54301 * resource to be parsed with {@link ldap_parse_result}.
54302 *
54303 * @param resource $link_identifier
54304 * @param string $dn
54305 * @param string $newrdn
54306 * @param string $newparent
54307 * @param bool $deleteoldrdn
54308 * @param array $serverctrls
54309 * @return resource Returns an LDAP result identifier or FALSE on
54310 *   error.
54311 * @since PHP 7 >= 7.3.0
54312 **/
54313function ldap_rename_ext($link_identifier, $dn, $newrdn, $newparent, $deleteoldrdn, $serverctrls){}
54314
54315/**
54316 * Bind to LDAP directory using SASL
54317 *
54318 * @param resource $link
54319 * @param string $binddn
54320 * @param string $password
54321 * @param string $sasl_mech
54322 * @param string $sasl_realm
54323 * @param string $sasl_authc_id
54324 * @param string $sasl_authz_id
54325 * @param string $props
54326 * @return bool
54327 * @since PHP 5, PHP 7
54328 **/
54329function ldap_sasl_bind($link, $binddn, $password, $sasl_mech, $sasl_realm, $sasl_authc_id, $sasl_authz_id, $props){}
54330
54331/**
54332 * Search LDAP tree
54333 *
54334 * Performs the search for a specified filter on the directory with the
54335 * scope of LDAP_SCOPE_SUBTREE. This is equivalent to searching the
54336 * entire directory.
54337 *
54338 * From 4.0.5 on it's also possible to do parallel searches. To do this
54339 * you use an array of link identifiers, rather than a single identifier,
54340 * as the first argument. If you don't want the same base DN and the same
54341 * filter for all the searches, you can also use an array of base DNs
54342 * and/or an array of filters. Those arrays must be of the same size as
54343 * the link identifier array since the first entries of the arrays are
54344 * used for one search, the second entries are used for another, and so
54345 * on. When doing parallel searches an array of search result identifiers
54346 * is returned, except in case of error, then the entry corresponding to
54347 * the search will be FALSE. This is very much like the value normally
54348 * returned, except that a result identifier is always returned when a
54349 * search was made. There are some rare cases where the normal search
54350 * returns FALSE while the parallel search returns an identifier.
54351 *
54352 * @param resource $link_identifier An LDAP link identifier, returned
54353 *   by {@link ldap_connect}.
54354 * @param string $base_dn The base DN for the directory.
54355 * @param string $filter The search filter can be simple or advanced,
54356 *   using boolean operators in the format described in the LDAP
54357 *   documentation (see the Netscape Directory SDK or RFC4515 for full
54358 *   information on filters).
54359 * @param array $attributes An array of the required attributes, e.g.
54360 *   array("mail", "sn", "cn"). Note that the "dn" is always returned
54361 *   irrespective of which attributes types are requested. Using this
54362 *   parameter is much more efficient than the default action (which is
54363 *   to return all attributes and their associated values). The use of
54364 *   this parameter should therefore be considered good practice.
54365 * @param int $attrsonly Should be set to 1 if only attribute types are
54366 *   wanted. If set to 0 both attributes types and attribute values are
54367 *   fetched which is the default behaviour.
54368 * @param int $sizelimit Enables you to limit the count of entries
54369 *   fetched. Setting this to 0 means no limit.
54370 * @param int $timelimit Sets the number of seconds how long is spend
54371 *   on the search. Setting this to 0 means no limit.
54372 * @param int $deref Specifies how aliases should be handled during the
54373 *   search. It can be one of the following: LDAP_DEREF_NEVER - (default)
54374 *   aliases are never dereferenced. LDAP_DEREF_SEARCHING - aliases
54375 *   should be dereferenced during the search but not when locating the
54376 *   base object of the search. LDAP_DEREF_FINDING - aliases should be
54377 *   dereferenced when locating the base object but not during the
54378 *   search. LDAP_DEREF_ALWAYS - aliases should be dereferenced always.
54379 * @param array $serverctrls Array of LDAP Controls to send with the
54380 *   request.
54381 * @return resource Returns a search result identifier or FALSE on
54382 *   error.
54383 * @since PHP 4, PHP 5, PHP 7
54384 **/
54385function ldap_search($link_identifier, $base_dn, $filter, $attributes, $attrsonly, $sizelimit, $timelimit, $deref, $serverctrls){}
54386
54387/**
54388 * Set the value of the given option
54389 *
54390 * Sets the value of the specified option to be {@link newval}.
54391 *
54392 * @param resource $link_identifier An LDAP link identifier, returned
54393 *   by {@link ldap_connect}.
54394 * @param int $option The parameter {@link option} can be one of:
54395 *   Option Type Available since LDAP_OPT_DEREF integer
54396 *   LDAP_OPT_SIZELIMIT integer LDAP_OPT_TIMELIMIT integer
54397 *   LDAP_OPT_NETWORK_TIMEOUT integer PHP 5.3.0 LDAP_OPT_PROTOCOL_VERSION
54398 *   integer LDAP_OPT_ERROR_NUMBER integer LDAP_OPT_REFERRALS bool
54399 *   LDAP_OPT_RESTART bool LDAP_OPT_HOST_NAME string
54400 *   LDAP_OPT_ERROR_STRING string LDAP_OPT_DIAGNOSTIC_MESSAGE string
54401 *   LDAP_OPT_MATCHED_DN string LDAP_OPT_SERVER_CONTROLS array
54402 *   LDAP_OPT_CLIENT_CONTROLS array LDAP_OPT_X_KEEPALIVE_IDLE int PHP
54403 *   7.1.0 LDAP_OPT_X_KEEPALIVE_PROBES int PHP 7.1.0
54404 *   LDAP_OPT_X_KEEPALIVE_INTERVAL int PHP 7.1.0 LDAP_OPT_X_TLS_CACERTDIR
54405 *   string PHP 7.1.0 LDAP_OPT_X_TLS_CACERTFILE string PHP 7.1.0
54406 *   LDAP_OPT_X_TLS_CERTFILE string PHP 7.1.0 LDAP_OPT_X_TLS_CIPHER_SUITE
54407 *   string PHP 7.1.0 LDAP_OPT_X_TLS_CRLCHECK integer PHP 7.1.0
54408 *   LDAP_OPT_X_TLS_CRLFILE string PHP 7.1.0 LDAP_OPT_X_TLS_DHFILE string
54409 *   PHP 7.1.0 LDAP_OPT_X_TLS_KEYFILE string PHP 7.1.0
54410 *   LDAP_OPT_X_TLS_PROTOCOL_MIN integer PHP 7.1.0
54411 *   LDAP_OPT_X_TLS_RANDOM_FILE string PHP 7.1.0
54412 *   LDAP_OPT_X_TLS_REQUIRE_CERT integer PHP 7.0.5
54413 *   LDAP_OPT_SERVER_CONTROLS and LDAP_OPT_CLIENT_CONTROLS require a list
54414 *   of controls, this means that the value must be an array of controls.
54415 *   A control consists of an oid identifying the control, an optional
54416 *   value, and an optional flag for criticality. In PHP a control is
54417 *   given by an array containing an element with the key oid and string
54418 *   value, and two optional elements. The optional elements are key
54419 *   value with string value and key iscritical with boolean value.
54420 *   iscritical defaults to FALSE if not supplied. See
54421 *   draft-ietf-ldapext-ldap-c-api-xx.txt for details. See also the
54422 *   second example below.
54423 * @param mixed $newval The new value for the specified {@link option}.
54424 * @return bool
54425 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
54426 **/
54427function ldap_set_option($link_identifier, $option, $newval){}
54428
54429/**
54430 * Set a callback function to do re-binds on referral chasing
54431 *
54432 * @param resource $link
54433 * @param callable $callback
54434 * @return bool
54435 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
54436 **/
54437function ldap_set_rebind_proc($link, $callback){}
54438
54439/**
54440 * Sort LDAP result entries on the client side
54441 *
54442 * Sort the result of a LDAP search, returned by {@link ldap_search}.
54443 *
54444 * As this function sorts the returned values on the client side it is
54445 * possible that you might not get the expected results in case you reach
54446 * the {@link sizelimit} either of the server or defined within {@link
54447 * ldap_search}.
54448 *
54449 * @param resource $link An LDAP link identifier, returned by {@link
54450 *   ldap_connect}.
54451 * @param resource $result An search result identifier, returned by
54452 *   {@link ldap_search}.
54453 * @param string $sortfilter The attribute to use as a key in the sort.
54454 * @return bool
54455 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
54456 **/
54457function ldap_sort($link, $result, $sortfilter){}
54458
54459/**
54460 * Start TLS
54461 *
54462 * @param resource $link
54463 * @return bool
54464 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
54465 **/
54466function ldap_start_tls($link){}
54467
54468/**
54469 * Translate t61 characters to 8859 characters
54470 *
54471 * @param string $value
54472 * @return string
54473 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
54474 **/
54475function ldap_t61_to_8859($value){}
54476
54477/**
54478 * Unbind from LDAP directory
54479 *
54480 * Unbinds from the LDAP directory.
54481 *
54482 * @param resource $link_identifier An LDAP link identifier, returned
54483 *   by {@link ldap_connect}.
54484 * @return bool
54485 * @since PHP 4, PHP 5, PHP 7
54486 **/
54487function ldap_unbind($link_identifier){}
54488
54489/**
54490 * Calculate Levenshtein distance between two strings
54491 *
54492 * The Levenshtein distance is defined as the minimal number of
54493 * characters you have to replace, insert or delete to transform {@link
54494 * str1} into {@link str2}. The complexity of the algorithm is O(m*n),
54495 * where n and m are the length of {@link str1} and {@link str2} (rather
54496 * good when compared to {@link similar_text}, which is O(max(n,m)**3),
54497 * but still expensive).
54498 *
54499 * In its simplest form the function will take only the two strings as
54500 * parameter and will calculate just the number of insert, replace and
54501 * delete operations needed to transform {@link str1} into {@link str2}.
54502 *
54503 * A second variant will take three additional parameters that define the
54504 * cost of insert, replace and delete operations. This is more general
54505 * and adaptive than variant one, but not as efficient.
54506 *
54507 * @param string $str1 One of the strings being evaluated for
54508 *   Levenshtein distance.
54509 * @param string $str2 One of the strings being evaluated for
54510 *   Levenshtein distance.
54511 * @return int This function returns the Levenshtein-Distance between
54512 *   the two argument strings or -1, if one of the argument strings is
54513 *   longer than the limit of 255 characters.
54514 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
54515 **/
54516function levenshtein($str1, $str2){}
54517
54518/**
54519 * Clear libxml error buffer
54520 *
54521 * {@link libxml_clear_errors} clears the libxml error buffer.
54522 *
54523 * @return void
54524 * @since PHP 5 >= 5.1.0, PHP 7
54525 **/
54526function libxml_clear_errors(){}
54527
54528/**
54529 * Disable the ability to load external entities
54530 *
54531 * Disable/enable the ability to load external entities.
54532 *
54533 * @param bool $disable Disable (TRUE) or enable (FALSE) libxml
54534 *   extensions (such as , and ) to load external entities.
54535 * @return bool Returns the previous value.
54536 * @since PHP 5 >= 5.2.11, PHP 7
54537 **/
54538function libxml_disable_entity_loader($disable){}
54539
54540/**
54541 * Retrieve array of errors
54542 *
54543 * Retrieve array of errors.
54544 *
54545 * @return array Returns an array with LibXMLError objects if there are
54546 *   any errors in the buffer, or an empty array otherwise.
54547 * @since PHP 5 >= 5.1.0, PHP 7
54548 **/
54549function libxml_get_errors(){}
54550
54551/**
54552 * Retrieve last error from libxml
54553 *
54554 * Retrieve last error from libxml.
54555 *
54556 * @return LibXMLError Returns a LibXMLError object if there is any
54557 *   error in the buffer, FALSE otherwise.
54558 * @since PHP 5 >= 5.1.0, PHP 7
54559 **/
54560function libxml_get_last_error(){}
54561
54562/**
54563 * Changes the default external entity loader
54564 *
54565 * @param callable $resolver_function A callable that takes three
54566 *   arguments. Two strings, a public id and system id, and a context (an
54567 *   array with four keys) as the third argument. This callback should
54568 *   return a resource, a string from which a resource can be opened, or
54569 *   NULL.
54570 * @return bool
54571 * @since PHP 5 >= 5.4.0, PHP 7
54572 **/
54573function libxml_set_external_entity_loader($resolver_function){}
54574
54575/**
54576 * Set the streams context for the next libxml document load or write
54577 *
54578 * Sets the streams context for the next libxml document load or write.
54579 *
54580 * @param resource $streams_context The stream context resource
54581 *   (created with {@link stream_context_create})
54582 * @return void
54583 * @since PHP 5, PHP 7
54584 **/
54585function libxml_set_streams_context($streams_context){}
54586
54587/**
54588 * Disable libxml errors and allow user to fetch error information as
54589 * needed
54590 *
54591 * {@link libxml_use_internal_errors} allows you to disable standard
54592 * libxml errors and enable user error handling.
54593 *
54594 * @param bool $use_errors Enable (TRUE) user error handling or disable
54595 *   (FALSE) user error handling. Disabling will also clear any existing
54596 *   libxml errors.
54597 * @return bool This function returns the previous value of {@link
54598 *   use_errors}.
54599 * @since PHP 5 >= 5.1.0, PHP 7
54600 **/
54601function libxml_use_internal_errors($use_errors){}
54602
54603/**
54604 * Create a hard link
54605 *
54606 * {@link link} creates a hard link.
54607 *
54608 * @param string $target Target of the link.
54609 * @param string $link The link name.
54610 * @return bool
54611 * @since PHP 4, PHP 5, PHP 7
54612 **/
54613function link($target, $link){}
54614
54615/**
54616 * Gets information about a link
54617 *
54618 * This function is used to verify if a link (pointed to by {@link path})
54619 * really exists (using the same method as the S_ISLNK macro defined in
54620 * stat.h).
54621 *
54622 * @param string $path Path to the link.
54623 * @return int {@link linkinfo} returns the st_dev field of the Unix C
54624 *   stat structure returned by the lstat system call. Returns a
54625 *   non-negative integer on success, -1 in case the link was not found,
54626 *   or FALSE if an open.base_dir violation occurs.
54627 * @since PHP 4, PHP 5, PHP 7
54628 **/
54629function linkinfo($path){}
54630
54631/**
54632 * Get numeric formatting information
54633 *
54634 * Returns an associative array containing localized numeric and monetary
54635 * formatting information.
54636 *
54637 * @return array {@link localeconv} returns data based upon the current
54638 *   locale as set by {@link setlocale}. The associative array that is
54639 *   returned contains the following fields: Array element Description
54640 *   decimal_point Decimal point character thousands_sep Thousands
54641 *   separator grouping Array containing numeric groupings
54642 *   int_curr_symbol International currency symbol (i.e. USD)
54643 *   currency_symbol Local currency symbol (i.e. $) mon_decimal_point
54644 *   Monetary decimal point character mon_thousands_sep Monetary
54645 *   thousands separator mon_grouping Array containing monetary groupings
54646 *   positive_sign Sign for positive values negative_sign Sign for
54647 *   negative values int_frac_digits International fractional digits
54648 *   frac_digits Local fractional digits p_cs_precedes TRUE if
54649 *   currency_symbol precedes a positive value, FALSE if it succeeds one
54650 *   p_sep_by_space TRUE if a space separates currency_symbol from a
54651 *   positive value, FALSE otherwise n_cs_precedes TRUE if
54652 *   currency_symbol precedes a negative value, FALSE if it succeeds one
54653 *   n_sep_by_space TRUE if a space separates currency_symbol from a
54654 *   negative value, FALSE otherwise p_sign_posn 0 - Parentheses surround
54655 *   the quantity and currency_symbol 1 - The sign string precedes the
54656 *   quantity and currency_symbol 2 - The sign string succeeds the
54657 *   quantity and currency_symbol 3 - The sign string immediately
54658 *   precedes the currency_symbol 4 - The sign string immediately
54659 *   succeeds the currency_symbol n_sign_posn 0 - Parentheses surround
54660 *   the quantity and currency_symbol 1 - The sign string precedes the
54661 *   quantity and currency_symbol 2 - The sign string succeeds the
54662 *   quantity and currency_symbol 3 - The sign string immediately
54663 *   precedes the currency_symbol 4 - The sign string immediately
54664 *   succeeds the currency_symbol
54665 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
54666 **/
54667function localeconv(){}
54668
54669/**
54670 * Tries to find out best available locale based on HTTP
54671 * "Accept-Language" header
54672 *
54673 * Tries to find locale that can satisfy the language list that is
54674 * requested by the HTTP "Accept-Language" header.
54675 *
54676 * @param string $header The string containing the "Accept-Language"
54677 *   header according to format in RFC 2616.
54678 * @return string The corresponding locale identifier.
54679 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
54680 **/
54681function locale_accept_from_http($header){}
54682
54683/**
54684 * Returns a correctly ordered and delimited locale ID
54685 *
54686 * Returns a correctly ordered and delimited locale ID the keys identify
54687 * the particular locale ID subtags, and the values are the associated
54688 * subtag values.
54689 *
54690 * @param array $subtags an array containing a list of key-value pairs,
54691 *   where the keys identify the particular locale ID subtags, and the
54692 *   values are the associated subtag values. The 'variant' and 'private'
54693 *   subtags can take maximum 15 values whereas 'extlang' can take
54694 *   maximum 3 values.e.g. Variants are allowed with the suffix ranging
54695 *   from 0-14. Hence the keys for the input array can be variant0,
54696 *   variant1, ...,variant14. In the returned locale id, the subtag is
54697 *   ordered by suffix resulting in variant0 followed by variant1
54698 *   followed by variant2 and so on. The 'variant', 'private' and
54699 *   'extlang' multiple values can be specified both as array under
54700 *   specific key (e.g. 'variant') and as multiple numbered keys (e.g.
54701 *   'variant0', 'variant1', etc.).
54702 * @return string The corresponding locale identifier.
54703 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
54704 **/
54705function locale_compose($subtags){}
54706
54707/**
54708 * Checks if a language tag filter matches with locale
54709 *
54710 * Checks if a $langtag filter matches with $locale according to RFC
54711 * 4647's basic filtering algorithm
54712 *
54713 * @param string $langtag The language tag to check
54714 * @param string $locale The language range to check against
54715 * @param bool $canonicalize If true, the arguments will be converted
54716 *   to canonical form before matching.
54717 * @return bool TRUE if $locale matches $langtag FALSE otherwise.
54718 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
54719 **/
54720function locale_filter_matches($langtag, $locale, $canonicalize){}
54721
54722/**
54723 * Gets the variants for the input locale
54724 *
54725 * @param string $locale The locale to extract the variants from
54726 * @return array The array containing the list of all variants subtag
54727 *   for the locale or NULL if not present
54728 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
54729 **/
54730function locale_get_all_variants($locale){}
54731
54732/**
54733 * Gets the default locale value from the INTL global 'default_locale'
54734 *
54735 * Gets the default locale value. At the PHP initialization this value is
54736 * set to 'intl.default_locale' value from if that value exists or from
54737 * ICU's function uloc_getDefault().
54738 *
54739 * @return string The current runtime locale
54740 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
54741 **/
54742function locale_get_default(){}
54743
54744/**
54745 * Returns an appropriately localized display name for language of the
54746 * inputlocale
54747 *
54748 * Returns an appropriately localized display name for language of the
54749 * input locale. If is NULL then the default locale is used.
54750 *
54751 * @param string $locale The locale to return a display language for
54752 * @param string $in_locale Optional format locale to use to display
54753 *   the language name
54754 * @return string display name of the language for the $locale in the
54755 *   format appropriate for $in_locale.
54756 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
54757 **/
54758function locale_get_display_language($locale, $in_locale){}
54759
54760/**
54761 * Returns an appropriately localized display name for the input locale
54762 *
54763 * Returns an appropriately localized display name for the input locale.
54764 * If $locale is NULL then the default locale is used.
54765 *
54766 * @param string $locale The locale to return a display name for.
54767 * @param string $in_locale optional format locale
54768 * @return string Display name of the locale in the format appropriate
54769 *   for $in_locale.
54770 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
54771 **/
54772function locale_get_display_name($locale, $in_locale){}
54773
54774/**
54775 * Returns an appropriately localized display name for region of the
54776 * input locale
54777 *
54778 * Returns an appropriately localized display name for region of the
54779 * input locale. If is NULL then the default locale is used.
54780 *
54781 * @param string $locale The locale to return a display region for.
54782 * @param string $in_locale Optional format locale to use to display
54783 *   the region name
54784 * @return string display name of the region for the $locale in the
54785 *   format appropriate for $in_locale.
54786 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
54787 **/
54788function locale_get_display_region($locale, $in_locale){}
54789
54790/**
54791 * Returns an appropriately localized display name for script of the
54792 * input locale
54793 *
54794 * Returns an appropriately localized display name for script of the
54795 * input locale. If is NULL then the default locale is used.
54796 *
54797 * @param string $locale The locale to return a display script for
54798 * @param string $in_locale Optional format locale to use to display
54799 *   the script name
54800 * @return string Display name of the script for the $locale in the
54801 *   format appropriate for $in_locale.
54802 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
54803 **/
54804function locale_get_display_script($locale, $in_locale){}
54805
54806/**
54807 * Returns an appropriately localized display name for variants of the
54808 * input locale
54809 *
54810 * Returns an appropriately localized display name for variants of the
54811 * input locale. If is NULL then the default locale is used.
54812 *
54813 * @param string $locale The locale to return a display variant for
54814 * @param string $in_locale Optional format locale to use to display
54815 *   the variant name
54816 * @return string Display name of the variant for the $locale in the
54817 *   format appropriate for $in_locale.
54818 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
54819 **/
54820function locale_get_display_variant($locale, $in_locale){}
54821
54822/**
54823 * Gets the keywords for the input locale
54824 *
54825 * @param string $locale The locale to extract the keywords from
54826 * @return array Associative array containing the keyword-value pairs
54827 *   for this locale
54828 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
54829 **/
54830function locale_get_keywords($locale){}
54831
54832/**
54833 * Gets the primary language for the input locale
54834 *
54835 * @param string $locale The locale to extract the primary language
54836 *   code from
54837 * @return string The language code associated with the language or
54838 *   NULL in case of error.
54839 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
54840 **/
54841function locale_get_primary_language($locale){}
54842
54843/**
54844 * Gets the region for the input locale
54845 *
54846 * @param string $locale The locale to extract the region code from
54847 * @return string The region subtag for the locale or NULL if not
54848 *   present
54849 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
54850 **/
54851function locale_get_region($locale){}
54852
54853/**
54854 * Gets the script for the input locale
54855 *
54856 * @param string $locale The locale to extract the script code from
54857 * @return string The script subtag for the locale or NULL if not
54858 *   present
54859 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
54860 **/
54861function locale_get_script($locale){}
54862
54863/**
54864 * Searches the language tag list for the best match to the language
54865 *
54866 * Searches the items in {@link langtag} for the best match to the
54867 * language range specified in {@link locale} according to RFC 4647's
54868 * lookup algorithm.
54869 *
54870 * @param array $langtag An array containing a list of language tags to
54871 *   compare to {@link locale}. Maximum 100 items allowed.
54872 * @param string $locale The locale to use as the language range when
54873 *   matching.
54874 * @param bool $canonicalize If true, the arguments will be converted
54875 *   to canonical form before matching.
54876 * @param string $default The locale to use if no match is found.
54877 * @return string The closest matching language tag or default value.
54878 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
54879 **/
54880function locale_lookup($langtag, $locale, $canonicalize, $default){}
54881
54882/**
54883 * Returns a key-value array of locale ID subtag elements
54884 *
54885 * @param string $locale The locale to extract the subtag array from.
54886 *   Note: The 'variant' and 'private' subtags can take maximum 15 values
54887 *   whereas 'extlang' can take maximum 3 values.
54888 * @return array Returns an array containing a list of key-value pairs,
54889 *   where the keys identify the particular locale ID subtags, and the
54890 *   values are the associated subtag values. The array will be ordered
54891 *   as the locale id subtags e.g. in the locale id if variants are
54892 *   '-varX-varY-varZ' then the returned array will have variant0=>varX ,
54893 *   variant1=>varY , variant2=>varZ
54894 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
54895 **/
54896function locale_parse($locale){}
54897
54898/**
54899 * Sets the default runtime locale
54900 *
54901 * Sets the default runtime locale to $locale. This changes the value of
54902 * INTL global 'default_locale' locale identifier. UAX #35 extensions are
54903 * accepted.
54904 *
54905 * @param string $locale Is a BCP 47 compliant language tag.
54906 * @return bool
54907 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
54908 **/
54909function locale_set_default($locale){}
54910
54911/**
54912 * Get the local time
54913 *
54914 * The {@link localtime} function returns an array identical to that of
54915 * the structure returned by the C function call.
54916 *
54917 * @param int $timestamp If set to FALSE or not supplied then the array
54918 *   is returned as a regular, numerically indexed array. If the argument
54919 *   is set to TRUE then {@link localtime} returns an associative array
54920 *   containing all the different elements of the structure returned by
54921 *   the C function call to localtime. The names of the different keys of
54922 *   the associative array are as follows:
54923 *
54924 *   "tm_sec" - seconds, 0 to 59 "tm_min" - minutes, 0 to 59 "tm_hour" -
54925 *   hours, 0 to 23 "tm_mday" - day of the month, 1 to 31 "tm_mon" -
54926 *   month of the year, 0 (Jan) to 11 (Dec) "tm_year" - years since 1900
54927 *   "tm_wday" - day of the week, 0 (Sun) to 6 (Sat) "tm_yday" - day of
54928 *   the year, 0 to 365 "tm_isdst" - is daylight savings time in effect?
54929 *   Positive if yes, 0 if not, negative if unknown.
54930 * @param bool $associative
54931 * @return array
54932 * @since PHP 4, PHP 5, PHP 7
54933 **/
54934function localtime($timestamp, $associative){}
54935
54936/**
54937 * Natural logarithm
54938 *
54939 * If the optional {@link base} parameter is specified, {@link log}
54940 * returns logbase {@link arg}, otherwise {@link log} returns the natural
54941 * logarithm of {@link arg}.
54942 *
54943 * @param float $arg The value to calculate the logarithm for
54944 * @param float $base The optional logarithmic base to use (defaults to
54945 *   'e' and so to the natural logarithm).
54946 * @return float The logarithm of {@link arg} to {@link base}, if
54947 *   given, or the natural logarithm.
54948 * @since PHP 4, PHP 5, PHP 7
54949 **/
54950function log($arg, $base){}
54951
54952/**
54953 * Returns log(1 + number), computed in a way that is accurate even when
54954 * the value of number is close to zero
54955 *
54956 * {@link log1p} returns log(1 + {@link number}) computed in a way that
54957 * is accurate even when the value of {@link number} is close to zero.
54958 * {@link log} might only return log(1) in this case due to lack of
54959 * precision.
54960 *
54961 * @param float $number The argument to process
54962 * @return float log(1 + {@link number})
54963 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
54964 **/
54965function log1p($number){}
54966
54967/**
54968 * Base-10 logarithm
54969 *
54970 * Returns the base-10 logarithm of {@link arg}.
54971 *
54972 * @param float $arg The argument to process
54973 * @return float The base-10 logarithm of {@link arg}
54974 * @since PHP 4, PHP 5, PHP 7
54975 **/
54976function log10($arg){}
54977
54978/**
54979 * Callback When Deleting Documents
54980 *
54981 * A callable function, used by the log_cmd_delete context option, when
54982 * deleteing a document
54983 *
54984 * @param array $server key value limit integer, 1 or 0. If 0, delete
54985 *   all matching documents. q Array, the search criteria
54986 * @param array $writeOptions
54987 * @param array $deleteOptions
54988 * @param array $protocolOptions
54989 * @since PECL mongo >= 1.5.0
54990 **/
54991function log_cmd_delete($server, $writeOptions, $deleteOptions, $protocolOptions){}
54992
54993/**
54994 * Callback When Inserting Documents
54995 *
54996 * A callable function, used by the log_cmd_insert context option, when
54997 * inserting a document
54998 *
54999 * @param array $server The document that has been prepared to be
55000 *   inserted
55001 * @param array $document
55002 * @param array $writeOptions
55003 * @param array $protocolOptions
55004 * @since PECL mongo >= 1.5.0
55005 **/
55006function log_cmd_insert($server, $document, $writeOptions, $protocolOptions){}
55007
55008/**
55009 * Callback When Updating Documents
55010 *
55011 * A callable function, used by the log_cmd_update context option, when
55012 * updateing a document
55013 *
55014 * @param array $server key value multi Boolean, true if this update is
55015 *   allowed to update all matched criteria upsert Boolean, true if the
55016 *   document should be created if criteria does not match q Array, the
55017 *   search criteria u Array, the new object/modifications
55018 * @param array $writeOptions
55019 * @param array $updateOptions
55020 * @param array $protocolOptions
55021 * @since PECL mongo >= 1.5.0
55022 **/
55023function log_cmd_update($server, $writeOptions, $updateOptions, $protocolOptions){}
55024
55025/**
55026 * Callback When Retrieving Next Cursor Batch
55027 *
55028 * A callable function, used by the log_getmore context option, when
55029 * executing a GET_MORE operation.
55030 *
55031 * @param array $server key value request_id integer, the driver
55032 *   request identifier cursor_id integer, the cursor identifier being
55033 *   used to fetch more data batch_size integer, maximum number of
55034 *   documents being requested
55035 * @param array $info
55036 * @since PECL mongo >= 1.5.0
55037 **/
55038function log_getmore($server, $info){}
55039
55040/**
55041 * Callback When Executing KILLCURSOR operations
55042 *
55043 * A callable function, used by the log_killcursor context option, when
55044 * reading a killcursor from MongoDB.
55045 *
55046 * @param array $server key value cursor_id integer, the cursor
55047 *   identifier to kill
55048 * @param array $info
55049 * @since PECL mongo >= 1.5.0
55050 **/
55051function log_killcursor($server, $info){}
55052
55053/**
55054 * Callback When Reading the MongoDB reply
55055 *
55056 * A callable function, used by the log_reply context option, when
55057 * reading a reply from MongoDB.
55058 *
55059 * @param array $server key value length integer, bytes, message reply
55060 *   length request_id integer, the server request identifier response_id
55061 *   integer, the driver request identifier this message is a response of
55062 *   opcode integer, the opcode id
55063 * @param array $messageHeaders key value flags integer, bitmask of
55064 *   protocol flags cursor_id integer, ID of the cursor created on the
55065 *   server (0 if none created, or its been exhausted) start The starting
55066 *   offset of this cursor returned integer, how many documents are
55067 *   returned in this trip
55068 * @param array $operationHeaders
55069 * @since PECL mongo >= 1.5.0
55070 **/
55071function log_reply($server, $messageHeaders, $operationHeaders){}
55072
55073/**
55074 * Callback When Writing Batches
55075 *
55076 * A callable function, used by the log_write_batch context option, when
55077 * executing a batch operation.
55078 *
55079 * @param array $server Array, the actual batch operation.
55080 * @param array $writeOptions
55081 * @param array $batch
55082 * @param array $protocolOptions
55083 * @since PECL mongo >= 1.5.0
55084 **/
55085function log_write_batch($server, $writeOptions, $batch, $protocolOptions){}
55086
55087/**
55088 * Converts an long integer address into a string in (IPv4) Internet
55089 * standard dotted format
55090 *
55091 * The function {@link long2ip} generates an Internet address in dotted
55092 * format (i.e.: aaa.bbb.ccc.ddd) from the long integer representation.
55093 *
55094 * @param int $proper_address A proper address representation in long
55095 *   integer.
55096 * @return string Returns the Internet IP address as a string.
55097 * @since PHP 4, PHP 5, PHP 7
55098 **/
55099function long2ip($proper_address){}
55100
55101/**
55102 * Gives information about a file or symbolic link
55103 *
55104 * Gathers the statistics of the file or symbolic link named by {@link
55105 * filename}.
55106 *
55107 * @param string $filename Path to a file or a symbolic link.
55108 * @return array See the manual page for {@link stat} for information
55109 *   on the structure of the array that {@link lstat} returns. This
55110 *   function is identical to the {@link stat} function except that if
55111 *   the {@link filename} parameter is a symbolic link, the status of the
55112 *   symbolic link is returned, not the status of the file pointed to by
55113 *   the symbolic link.
55114 * @since PHP 4, PHP 5, PHP 7
55115 **/
55116function lstat($filename){}
55117
55118/**
55119 * Strip whitespace (or other characters) from the beginning of a string
55120 *
55121 * @param string $str The input string.
55122 * @param string $character_mask You can also specify the characters
55123 *   you want to strip, by means of the {@link character_mask} parameter.
55124 *   Simply list all characters that you want to be stripped. With .. you
55125 *   can specify a range of characters.
55126 * @return string This function returns a string with whitespace
55127 *   stripped from the beginning of {@link str}. Without the second
55128 *   parameter, {@link ltrim} will strip these characters: " " (ASCII 32
55129 *   (0x20)), an ordinary space. "\t" (ASCII 9 (0x09)), a tab. "\n"
55130 *   (ASCII 10 (0x0A)), a new line (line feed). "\r" (ASCII 13 (0x0D)), a
55131 *   carriage return. "\0" (ASCII 0 (0x00)), the NUL-byte. "\x0B" (ASCII
55132 *   11 (0x0B)), a vertical tab.
55133 * @since PHP 4, PHP 5, PHP 7
55134 **/
55135function ltrim($str, $character_mask){}
55136
55137/**
55138 * LZF compression
55139 *
55140 * {@link lzf_compress} compresses the given {@link data} string using
55141 * LZF encoding.
55142 *
55143 * @param string $data The string to compress.
55144 * @return string Returns the compressed data or FALSE if an error
55145 *   occurred.
55146 * @since PECL lzf >= 0.1.0
55147 **/
55148function lzf_compress($data){}
55149
55150/**
55151 * LZF decompression
55152 *
55153 * {@link lzf_compress} decompresses the given {@link data} string
55154 * containing lzf encoded data.
55155 *
55156 * @param string $data The compressed string.
55157 * @return string Returns the decompressed data or FALSE if an error
55158 *   occurred.
55159 * @since PECL lzf >= 0.1.0
55160 **/
55161function lzf_decompress($data){}
55162
55163/**
55164 * Determines what LZF extension was optimized for
55165 *
55166 * Determines what was LZF extension optimized for during compilation.
55167 *
55168 * @return int Returns 1 if LZF was optimized for speed, 0 for
55169 *   compression.
55170 * @since PECL lzf >= 1.0.0
55171 **/
55172function lzf_optimized_for(){}
55173
55174/**
55175 * Sets the current active configuration setting of magic_quotes_runtime
55176 *
55177 * Set the current active configuration setting of magic_quotes_runtime.
55178 *
55179 * @param bool $new_setting FALSE for off, TRUE for on.
55180 * @return bool
55181 * @since PHP 4, PHP 5
55182 **/
55183function magic_quotes_runtime($new_setting){}
55184
55185/**
55186 * Send mail
55187 *
55188 * Sends an email.
55189 *
55190 * @param string $to Receiver, or receivers of the mail. The formatting
55191 *   of this string must comply with RFC 2822. Some examples are:
55192 *   user@example.com user@example.com, anotheruser@example.com User
55193 *   <user@example.com> User <user@example.com>, Another User
55194 *   <anotheruser@example.com>
55195 * @param string $subject Subject of the email to be sent.
55196 * @param string $message Message to be sent. Each line should be
55197 *   separated with a CRLF (\r\n). Lines should not be larger than 70
55198 *   characters.
55199 * @param mixed $additional_headers String or array to be inserted at
55200 *   the end of the email header. This is typically used to add extra
55201 *   headers (From, Cc, and Bcc). Multiple extra headers should be
55202 *   separated with a CRLF (\r\n). If outside data are used to compose
55203 *   this header, the data should be sanitized so that no unwanted
55204 *   headers could be injected. If an array is passed, its keys are the
55205 *   header names and its values are the respective header values.
55206 * @param string $additional_parameters The {@link
55207 *   additional_parameters} parameter can be used to pass additional
55208 *   flags as command line options to the program configured to be used
55209 *   when sending mail, as defined by the sendmail_path configuration
55210 *   setting. For example, this can be used to set the envelope sender
55211 *   address when using sendmail with the -f sendmail option. This
55212 *   parameter is escaped by {@link escapeshellcmd} internally to prevent
55213 *   command execution. {@link escapeshellcmd} prevents command
55214 *   execution, but allows to add additional parameters. For security
55215 *   reasons, it is recommended for the user to sanitize this parameter
55216 *   to avoid adding unwanted parameters to the shell command. Since
55217 *   {@link escapeshellcmd} is applied automatically, some characters
55218 *   that are allowed as email addresses by internet RFCs cannot be used.
55219 *   {@link mail} can not allow such characters, so in programs where the
55220 *   use of such characters is required, alternative means of sending
55221 *   emails (such as using a framework or a library) is recommended. The
55222 *   user that the webserver runs as should be added as a trusted user to
55223 *   the sendmail configuration to prevent a 'X-Warning' header from
55224 *   being added to the message when the envelope sender (-f) is set
55225 *   using this method. For sendmail users, this file is
55226 *   /etc/mail/trusted-users.
55227 * @return bool Returns TRUE if the mail was successfully accepted for
55228 *   delivery, FALSE otherwise.
55229 * @since PHP 4, PHP 5, PHP 7
55230 **/
55231function mail($to, $subject, $message, $additional_headers, $additional_parameters){}
55232
55233/**
55234 * Gets the best way of encoding
55235 *
55236 * Figures out the best way of encoding the content read from the given
55237 * file pointer.
55238 *
55239 * @param resource $fp A valid file pointer, which must be seek-able.
55240 * @return string Returns one of the character encodings supported by
55241 *   the mbstring module.
55242 * @since PECL mailparse >= 0.9.0
55243 **/
55244function mailparse_determine_best_xfer_encoding($fp){}
55245
55246/**
55247 * Create a mime mail resource
55248 *
55249 * Create a MIME mail resource.
55250 *
55251 * @return resource Returns a handle that can be used to parse a
55252 *   message.
55253 * @since PECL mailparse >= 0.9.0
55254 **/
55255function mailparse_msg_create(){}
55256
55257/**
55258 * Extracts/decodes a message section
55259 *
55260 * @param resource $mimemail A valid MIME resource.
55261 * @param string $msgbody
55262 * @param callable $callbackfunc
55263 * @return void
55264 * @since PECL mailparse >= 0.9.0
55265 **/
55266function mailparse_msg_extract_part($mimemail, $msgbody, $callbackfunc){}
55267
55268/**
55269 * Extracts/decodes a message section
55270 *
55271 * Extracts/decodes a message section from the supplied filename.
55272 *
55273 * The contents of the section will be decoded according to their
55274 * transfer encoding - base64, quoted-printable and uuencoded text are
55275 * supported.
55276 *
55277 * @param resource $mimemail A valid MIME resource, created with {@link
55278 *   mailparse_msg_create}.
55279 * @param mixed $filename Can be a file name or a valid stream
55280 *   resource.
55281 * @param callable $callbackfunc If set, this must be either a valid
55282 *   callback that will be passed the extracted section, or NULL to make
55283 *   this function return the extracted section. If not specified, the
55284 *   contents will be sent to "stdout".
55285 * @return string If {@link callbackfunc} is not NULL returns TRUE on
55286 *   success.
55287 * @since PECL mailparse >= 0.9.0
55288 **/
55289function mailparse_msg_extract_part_file($mimemail, $filename, $callbackfunc){}
55290
55291/**
55292 * Extracts a message section including headers without decoding the
55293 * transfer encoding
55294 *
55295 * @param resource $mimemail A valid MIME resource.
55296 * @param string $filename
55297 * @param callable $callbackfunc
55298 * @return string
55299 * @since PECL mailparse >= 0.9.0
55300 **/
55301function mailparse_msg_extract_whole_part_file($mimemail, $filename, $callbackfunc){}
55302
55303/**
55304 * Frees a MIME resource
55305 *
55306 * Frees a MIME resource.
55307 *
55308 * @param resource $mimemail A valid MIME resource allocated by {@link
55309 *   mailparse_msg_create} or {@link mailparse_msg_parse_file}.
55310 * @return bool
55311 * @since PECL mailparse >= 0.9.0
55312 **/
55313function mailparse_msg_free($mimemail){}
55314
55315/**
55316 * Returns a handle on a given section in a mimemessage
55317 *
55318 * @param resource $mimemail A valid MIME resource.
55319 * @param string $mimesection
55320 * @return resource
55321 * @since PECL mailparse >= 0.9.0
55322 **/
55323function mailparse_msg_get_part($mimemail, $mimesection){}
55324
55325/**
55326 * Returns an associative array of info about the message
55327 *
55328 * @param resource $mimemail A valid MIME resource.
55329 * @return array
55330 * @since PECL mailparse >= 0.9.0
55331 **/
55332function mailparse_msg_get_part_data($mimemail){}
55333
55334/**
55335 * Returns an array of mime section names in the supplied message
55336 *
55337 * @param resource $mimemail A valid MIME resource.
55338 * @return array
55339 * @since PECL mailparse >= 0.9.0
55340 **/
55341function mailparse_msg_get_structure($mimemail){}
55342
55343/**
55344 * Incrementally parse data into buffer
55345 *
55346 * Incrementally parse data into the supplied mime mail resource.
55347 *
55348 * This function allow you to stream portions of a file at a time, rather
55349 * than read and parse the whole thing.
55350 *
55351 * @param resource $mimemail A valid MIME resource.
55352 * @param string $data
55353 * @return bool
55354 * @since PECL mailparse >= 0.9.0
55355 **/
55356function mailparse_msg_parse($mimemail, $data){}
55357
55358/**
55359 * Parses a file
55360 *
55361 * Parses a file. This is the optimal way of parsing a mail file that you
55362 * have on disk.
55363 *
55364 * @param string $filename Path to the file holding the message. The
55365 *   file is opened and streamed through the parser.
55366 * @return resource Returns a MIME resource representing the structure,
55367 *   or FALSE on error.
55368 * @since PECL mailparse >= 0.9.0
55369 **/
55370function mailparse_msg_parse_file($filename){}
55371
55372/**
55373 * Parse RFC 822 compliant addresses
55374 *
55375 * Parses a RFC 822 compliant recipient list, such as that found in the
55376 * To: header.
55377 *
55378 * @param string $addresses A string containing addresses, like in: Wez
55379 *   Furlong <wez@example.com>, doe@example.com
55380 * @return array Returns an array of associative arrays with the
55381 *   following keys for each recipient: display The recipient name, for
55382 *   display purpose. If this part is not set for a recipient, this key
55383 *   will hold the same value as address. address The email address
55384 *   is_group TRUE if the recipient is a newsgroup, FALSE otherwise.
55385 * @since PECL mailparse >= 0.9.0
55386 **/
55387function mailparse_rfc822_parse_addresses($addresses){}
55388
55389/**
55390 * Streams data from source file pointer, apply encoding and write to
55391 * destfp
55392 *
55393 * Streams data from the source file pointer, apply {@link encoding} and
55394 * write to the destination file pointer.
55395 *
55396 * @param resource $sourcefp A valid file handle. The file is streamed
55397 *   through the parser.
55398 * @param resource $destfp The destination file handle in which the
55399 *   encoded data will be written.
55400 * @param string $encoding One of the character encodings supported by
55401 *   the mbstring module.
55402 * @return bool
55403 * @since PECL mailparse >= 0.9.0
55404 **/
55405function mailparse_stream_encode($sourcefp, $destfp, $encoding){}
55406
55407/**
55408 * Scans the data from fp and extract each embedded uuencoded file
55409 *
55410 * Scans the data from the given file pointer and extract each embedded
55411 * uuencoded file into a temporary file.
55412 *
55413 * @param resource $fp A valid file pointer.
55414 * @return array Returns an array of associative arrays listing
55415 *   filename information. filename Path to the temporary file name
55416 *   created origfilename The original filename, for uuencoded parts only
55417 *   The first filename entry is the message body. The next entries are
55418 *   the decoded uuencoded files.
55419 * @since PECL mailparse >= 0.9.0
55420 **/
55421function mailparse_uudecode_all($fp){}
55422
55423/**
55424 * Find highest value
55425 *
55426 * If the first and only parameter is an array, {@link max} returns the
55427 * highest value in that array. If at least two parameters are provided,
55428 * {@link max} returns the biggest of these values.
55429 *
55430 * @param array $values An array containing the values.
55431 * @return mixed {@link max} returns the parameter value considered
55432 *   "highest" according to standard comparisons. If multiple values of
55433 *   different types evaluate as equal (e.g. 0 and 'abc') the first
55434 *   provided to the function will be returned.
55435 * @since PHP 4, PHP 5, PHP 7
55436 **/
55437function max($values){}
55438
55439/**
55440 * Gets the number of affected rows in a previous MaxDB operation
55441 *
55442 * {@link maxdb_affected_rows} returns the number of rows affected by the
55443 * last INSERT, UPDATE, or DELETE query associated with the provided
55444 * {@link link} parameter. If this number cannot be determined, this
55445 * function will return -1.
55446 *
55447 * The {@link maxdb_affected_rows} function only works with queries which
55448 * modify a table. In order to return the number of rows from a SELECT
55449 * query, use the {@link maxdb_num_rows} function instead.
55450 *
55451 * @param resource $link
55452 * @return int An integer greater than zero indicates the number of
55453 *   rows affected or retrieved. Zero indicates that no records where
55454 *   updated for an UPDATE statement, no rows matched the WHERE clause in
55455 *   the query or that no query has yet been executed. -1 indicates that
55456 *   the number of rows affected can not be determined.
55457 * @since PECL maxdb >= 1.0
55458 **/
55459function maxdb_affected_rows($link){}
55460
55461/**
55462 * Turns on or off auto-commiting database modifications
55463 *
55464 * {@link maxdb_autocommit} is used to turn on or off auto-commit mode on
55465 * queries for the database connection represented by the {@link link}
55466 * resource.
55467 *
55468 * @param resource $link
55469 * @param bool $mode
55470 * @return bool
55471 * @since PECL maxdb >= 1.0
55472 **/
55473function maxdb_autocommit($link, $mode){}
55474
55475/**
55476 * Binds variables to a prepared statement as parameters
55477 *
55478 * (extended syntax):
55479 *
55480 * (extended syntax):
55481 *
55482 * {@link maxdb_bind_param} is used to bind variables for the parameter
55483 * markers in the SQL statement that was passed to {@link maxdb_prepare}.
55484 * The string {@link types} contains one or more characters which specify
55485 * the types for the corresponding bind variables.
55486 *
55487 * The extended syntax of {@link maxdb_bind_param} allows to give the
55488 * parameters as an array instead of a variable list of PHP variables to
55489 * the function. If the array variable has not been used before calling
55490 * {@link maxdb_bind_param}, it has to be initialized as an emtpy array.
55491 * See the examples how to use {@link maxdb_bind_param} with extended
55492 * syntax.
55493 *
55494 * Variables for SELECT INTO SQL statements can also be bound using
55495 * {@link maxdb_bind_param}. Parameters for database procedures can be
55496 * bound using {@link maxdb_bind_param}. See the examples how to use
55497 * {@link maxdb_bind_param} in this cases.
55498 *
55499 * If a variable bound as INTO variable to an SQL statement was used
55500 * before, the content of this variable is overwritten by the data of the
55501 * SELECT INTO statement. A reference to this variable will be invalid
55502 * after a call to {@link maxdb_bind_param}.
55503 *
55504 * For INOUT parameters of database procedures the content of the bound
55505 * INOUT variable is overwritten by the output value of the database
55506 * procedure. A reference to this variable will be invalid after a call
55507 * to {@link maxdb_bind_param}.
55508 *
55509 * Type specification chars Character Description i corresponding
55510 * variable has type integer d corresponding variable has type double s
55511 * corresponding variable has type string b corresponding variable is a
55512 * blob and will be sent in packages
55513 *
55514 * @param resource $stmt
55515 * @param string $types
55516 * @param mixed $var1
55517 * @param mixed ...$vararg
55518 * @return bool
55519 * @since PECL maxdb 1.0
55520 **/
55521function maxdb_bind_param($stmt, $types, &$var1, &...$vararg){}
55522
55523/**
55524 * Binds variables to a prepared statement for result storage
55525 *
55526 * {@link maxdb_bind_result} is used to associate (bind) columns in the
55527 * result set to variables. When {@link maxdb_stmt_fetch} is called to
55528 * fetch data, the MaxDB client/server protocol places the data for the
55529 * bound columns into the specified variables {@link var1, ...}.
55530 *
55531 * @param resource $stmt
55532 * @param mixed $var1
55533 * @param mixed ...$vararg
55534 * @return bool
55535 * @since PECL maxdb 1.0
55536 **/
55537function maxdb_bind_result($stmt, &$var1, &...$vararg){}
55538
55539/**
55540 * Changes the user of the specified database connection
55541 *
55542 * {@link maxdb_change_user} is used to change the user of the specified
55543 * database connection as given by the {@link link} parameter and to set
55544 * the current database to that specified by the {@link database}
55545 * parameter.
55546 *
55547 * In order to successfully change users a valid {@link username} and
55548 * {@link password} parameters must be provided and that user must have
55549 * sufficient permissions to access the desired database. If for any
55550 * reason authorization fails, the current user authentication will
55551 * remain.
55552 *
55553 * @param resource $link
55554 * @param string $user
55555 * @param string $password
55556 * @param string $database
55557 * @return bool
55558 * @since PECL maxdb >= 1.0
55559 **/
55560function maxdb_change_user($link, $user, $password, $database){}
55561
55562/**
55563 * Returns the default character set for the database connection
55564 *
55565 * Returns the current character set for the database connection
55566 * specified by the {@link link} parameter.
55567 *
55568 * @param resource $link
55569 * @return string The default character set for the current connection,
55570 *   either ascii or unicode.
55571 * @since PECL maxdb >= 1.0
55572 **/
55573function maxdb_character_set_name($link){}
55574
55575/**
55576 * Returns the default character set for the database connection
55577 *
55578 * Returns the current character set for the database connection
55579 * specified by the {@link link} parameter.
55580 *
55581 * @param resource $link
55582 * @return string The default character set for the current connection,
55583 *   either ascii or unicode.
55584 * @since PECL maxdb 1.0
55585 **/
55586function maxdb_client_encoding($link){}
55587
55588/**
55589 * Closes a previously opened database connection
55590 *
55591 * The {@link maxdb_close} function closes a previously opened database
55592 * connection specified by the {@link link} parameter.
55593 *
55594 * @param resource $link
55595 * @return bool
55596 * @since PECL maxdb >= 1.0
55597 **/
55598function maxdb_close($link){}
55599
55600/**
55601 * Ends a sequence of
55602 *
55603 * This function has to be called after a sequence of {@link
55604 * maxdb_stmt_send_long_data}, that was started after {@link
55605 * maxdb_execute}.
55606 *
55607 * {@link param_nr} indicates which parameter to associate the end of
55608 * data with. Parameters are numbered beginning with 0.
55609 *
55610 * @param resource $stmt
55611 * @param int $param_nr
55612 * @return bool
55613 * @since PECL maxdb >= 1.0
55614 **/
55615function maxdb_close_long_data($stmt, $param_nr){}
55616
55617/**
55618 * Commits the current transaction
55619 *
55620 * Commits the current transaction for the database connection specified
55621 * by the {@link link} parameter.
55622 *
55623 * @param resource $link
55624 * @return bool
55625 * @since PECL maxdb >= 1.0
55626 **/
55627function maxdb_commit($link){}
55628
55629/**
55630 * Open a new connection to the MaxDB server
55631 *
55632 * The {@link maxdb_connect} function attempts to open a connection to
55633 * the MaxDB Server running on {@link host} which can be either a host
55634 * name or an IP address. Passing the string "localhost" to this
55635 * parameter, the local host is assumed. If successful, the {@link
55636 * maxdb_connect} will return an resource representing the connection to
55637 * the database.
55638 *
55639 * The {@link username} and {@link password} parameters specify the
55640 * username and password under which to connect to the MaxDB server. If
55641 * the password is not provided (the NULL value is passed), the MaxDB
55642 * server will attempt to authenticate the user against the {@link
55643 * maxdb.default_pw} in .
55644 *
55645 * The {@link dbname} parameter if provided will specify the default
55646 * database to be used when performing queries. If not provied, the entry
55647 * {@link maxdb.default_db} in is used.
55648 *
55649 * The {@link port} and {@link socket} parameters are ignored for the
55650 * MaxDB server.
55651 *
55652 * @param string $host
55653 * @param string $username
55654 * @param string $passwd
55655 * @param string $dbname
55656 * @param int $port
55657 * @param string $socket
55658 * @return resource Returns a resource which represents the connection
55659 *   to a MaxDB Server or FALSE if the connection failed.
55660 * @since PECL maxdb >= 1.0
55661 **/
55662function maxdb_connect($host, $username, $passwd, $dbname, $port, $socket){}
55663
55664/**
55665 * Returns the error code from last connect call
55666 *
55667 * The {@link maxdb_connect_errno} function will return the last error
55668 * code number for last call to {@link maxdb_connect}. If no errors have
55669 * occurred, this function will return zero.
55670 *
55671 * @return int An error code value for the last call to {@link
55672 *   maxdb_connect}, if it failed. zero means no error occurred.
55673 * @since PECL maxdb >= 1.0
55674 **/
55675function maxdb_connect_errno(){}
55676
55677/**
55678 * Returns a string description of the last connect error
55679 *
55680 * The {@link maxdb_connect_error} function is identical to the
55681 * corresponding {@link maxdb_connect_errno} function in every way,
55682 * except instead of returning an integer error code the {@link
55683 * maxdb_connect_error} function will return a string representation of
55684 * the last error to occur for the last {@link maxdb_connect} call. If no
55685 * error has occurred, this function will return an empty string.
55686 *
55687 * @return string A string that describes the error. An empty string if
55688 *   no error occurred.
55689 * @since PECL maxdb >= 1.0
55690 **/
55691function maxdb_connect_error(){}
55692
55693/**
55694 * Adjusts the result pointer to an arbitary row in the result
55695 *
55696 * The {@link maxdb_data_seek} function seeks to an arbitrary result
55697 * pointer specified by the {@link offset} in the result set represented
55698 * by {@link result}. The {@link offset} parameter must be between zero
55699 * and the total number of rows minus one (0..{@link maxdb_num_rows} -
55700 * 1).
55701 *
55702 * @param resource $result
55703 * @param int $offset
55704 * @return bool
55705 * @since PECL maxdb >= 1.0
55706 **/
55707function maxdb_data_seek($result, $offset){}
55708
55709/**
55710 * Performs debugging operations
55711 *
55712 * The {@link maxdb_debug} can be used to trace the SQLDBC communication.
55713 * The following strings can be used as a parameter to {@link
55714 * maxdb_debug}:
55715 *
55716 * @param string $debug
55717 * @return void {@link maxdb_debug} doesn't return any value.
55718 * @since PECL maxdb >= 1.0
55719 **/
55720function maxdb_debug($debug){}
55721
55722/**
55723 * Disable reads from master
55724 *
55725 * @param resource $link
55726 * @return bool
55727 * @since PECL maxdb >= 1.0
55728 **/
55729function maxdb_disable_reads_from_master($link){}
55730
55731/**
55732 * Disable RPL parse
55733 *
55734 * @param resource $link
55735 * @return bool
55736 * @since PECL maxdb >= 1.0
55737 **/
55738function maxdb_disable_rpl_parse($link){}
55739
55740/**
55741 * Dump debugging information into the log
55742 *
55743 * @param resource $link
55744 * @return bool
55745 * @since PECL maxdb >= 1.0
55746 **/
55747function maxdb_dump_debug_info($link){}
55748
55749/**
55750 * Open a connection to an embedded MaxDB server
55751 *
55752 * @param string $dbname
55753 * @return resource
55754 * @since PECL maxdb >= 1.0
55755 **/
55756function maxdb_embedded_connect($dbname){}
55757
55758/**
55759 * Enable reads from master
55760 *
55761 * @param resource $link
55762 * @return bool
55763 * @since PECL maxdb >= 1.0
55764 **/
55765function maxdb_enable_reads_from_master($link){}
55766
55767/**
55768 * Enable RPL parse
55769 *
55770 * @param resource $link
55771 * @return bool
55772 * @since PECL maxdb >= 1.0
55773 **/
55774function maxdb_enable_rpl_parse($link){}
55775
55776/**
55777 * Returns the error code for the most recent function call
55778 *
55779 * The {@link maxdb_errno} function will return the last error code for
55780 * the most recent MaxDB function call that can succeed or fail with
55781 * respect to the database link defined by the {@link link} parameter. If
55782 * no errors have occurred, this function will return zero.
55783 *
55784 * @param resource $link
55785 * @return int An error code value for the last call, if it failed.
55786 *   zero means no error occurred.
55787 * @since PECL maxdb >= 1.0
55788 **/
55789function maxdb_errno($link){}
55790
55791/**
55792 * Returns a string description of the last error
55793 *
55794 * The {@link maxdb_error} function is identical to the corresponding
55795 * {@link maxdb_errno} function in every way, except instead of returning
55796 * an integer error code the {@link maxdb_error} function will return a
55797 * string representation of the last error to occur for the database
55798 * connection represented by the {@link link} parameter. If no error has
55799 * occurred, this function will return an empty string.
55800 *
55801 * @param resource $link
55802 * @return string A string that describes the error. An empty string if
55803 *   no error occurred.
55804 * @since PECL maxdb >= 1.0
55805 **/
55806function maxdb_error($link){}
55807
55808/**
55809 * Escapes special characters in a string for use in an SQL statement,
55810 * taking into account the current charset of the connection
55811 *
55812 * This function is used to create a legal SQL string that you can use in
55813 * an SQL statement. The string escapestr is encoded to an escaped SQL
55814 * string, taking into account the current character set of the
55815 * connection.
55816 *
55817 * Characters encoded are ', ".
55818 *
55819 * @param resource $link
55820 * @param string $escapestr
55821 * @return string Returns an escaped string.
55822 * @since PECL maxdb 1.0
55823 **/
55824function maxdb_escape_string($link, $escapestr){}
55825
55826/**
55827 * Executes a prepared Query
55828 *
55829 * The {@link maxdb_execute} function executes a query that has been
55830 * previously prepared using the {@link maxdb_prepare} function
55831 * represented by the {@link stmt} resource. When executed any parameter
55832 * markers which exist will automatically be replaced with the
55833 * appropriate data.
55834 *
55835 * If the statement is UPDATE, DELETE, or INSERT, the total number of
55836 * affected rows can be determined by using the {@link
55837 * maxdb_stmt_affected_rows} function. Likewise, if the query yields a
55838 * result set the {@link maxdb_fetch} function is used.
55839 *
55840 * @param resource $stmt
55841 * @return bool
55842 * @since PECL maxdb 1.0
55843 **/
55844function maxdb_execute($stmt){}
55845
55846/**
55847 * Fetch results from a prepared statement into the bound variables
55848 *
55849 * {@link maxdb_fetch} returns row data using the variables bound by
55850 * {@link maxdb_stmt_bind_result}.
55851 *
55852 * @param resource $stmt
55853 * @return bool
55854 * @since PECL maxdb 1.0
55855 **/
55856function maxdb_fetch($stmt){}
55857
55858/**
55859 * Fetch a result row as an associative, a numeric array, or both
55860 *
55861 * Returns an array that corresponds to the fetched row or NULL if there
55862 * are no more rows for the resultset represented by the {@link result}
55863 * parameter.
55864 *
55865 * {@link maxdb_fetch_array} is an extended version of the {@link
55866 * maxdb_fetch_row} function. In addition to storing the data in the
55867 * numeric indices of the result array, the {@link maxdb_fetch_array}
55868 * function can also store the data in associative indices, using the
55869 * field names of the result set as keys.
55870 *
55871 * If two or more columns of the result have the same field names, the
55872 * last column will take precedence and overwrite the earlier data. In
55873 * order to access multiple columns with the same name, the numerically
55874 * indexed version of the row must be used.
55875 *
55876 * The optional second argument {@link resulttype} is a constant
55877 * indicating what type of array should be produced from the current row
55878 * data. The possible values for this parameter are the constants
55879 * MAXDB_ASSOC, MAXDB_ASSOC_UPPER, MAXDB_ASSOC_LOWER, MAXDB_NUM, or
55880 * MAXDB_BOTH. By default the {@link maxdb_fetch_array} function will
55881 * assume MAXDB_BOTH, which is a combination of MAXDB_NUM and MAXDB_ASSOC
55882 * for this parameter.
55883 *
55884 * By using the MAXDB_ASSOC constant this function will behave
55885 * identically to the {@link maxdb_fetch_assoc}, while MAXDB_NUM will
55886 * behave identically to the {@link maxdb_fetch_row} function. The final
55887 * option MAXDB_BOTH will create a single array with the attributes of
55888 * both.
55889 *
55890 * By using the MAXDB_ASSOC_UPPER constant, the behaviour of this
55891 * function is identical to the use of MAXDB_ASSOC except the array index
55892 * of a column is the fieldname in upper case.
55893 *
55894 * By using the MAXDB_ASSOC_LOWER constant, the behaviour of this
55895 * function is identical to the use of MAXDB_ASSOC except the array index
55896 * of a column is the fieldname in lower case.
55897 *
55898 * @param resource $result
55899 * @param int $resulttype
55900 * @return mixed Returns an array that corresponds to the fetched row
55901 *   or NULL if there are no more rows in resultset.
55902 * @since PECL maxdb >= 1.0
55903 **/
55904function maxdb_fetch_array($result, $resulttype){}
55905
55906/**
55907 * Fetch a result row as an associative array
55908 *
55909 * Returns an associative array that corresponds to the fetched row or
55910 * NULL if there are no more rows.
55911 *
55912 * The {@link maxdb_fetch_assoc} function is used to return an
55913 * associative array representing the next row in the result set for the
55914 * result represented by the {@link result} parameter, where each key in
55915 * the array represents the name of one of the result set's columns.
55916 *
55917 * If two or more columns of the result have the same field names, the
55918 * last column will take precedence. To access the other column(s) of the
55919 * same name, you either need to access the result with numeric indices
55920 * by using {@link maxdb_fetch_row} or add alias names.
55921 *
55922 * @param resource $result
55923 * @return array Returns an array that corresponds to the fetched row
55924 *   or NULL if there are no more rows in resultset.
55925 * @since PECL maxdb >= 1.0
55926 **/
55927function maxdb_fetch_assoc($result){}
55928
55929/**
55930 * Returns the next field in the result set
55931 *
55932 * The {@link maxdb_fetch_field} returns the definition of one column of
55933 * a result set as an resource. Call this function repeatedly to retrieve
55934 * information about all columns in the result set. {@link
55935 * maxdb_fetch_field} returns FALSE when no more fields are left.
55936 *
55937 * @param resource $result
55938 * @return mixed Returns an resource which contains field definition
55939 *   information or FALSE if no field information is available.
55940 * @since PECL maxdb >= 1.0
55941 **/
55942function maxdb_fetch_field($result){}
55943
55944/**
55945 * Returns an array of resources representing the fields in a result set
55946 *
55947 * This function serves an identical purpose to the {@link
55948 * maxdb_fetch_field} function with the single difference that, instead
55949 * of returning one resource at a time for each field, the columns are
55950 * returned as an array of resources.
55951 *
55952 * @param resource $result
55953 * @return mixed Returns an array of resources which contains field
55954 *   definition information or FALSE if no field information is
55955 *   available.
55956 * @since PECL maxdb >= 1.0
55957 **/
55958function maxdb_fetch_fields($result){}
55959
55960/**
55961 * Fetch meta-data for a single field
55962 *
55963 * {@link maxdb_fetch_field_direct} returns an resource which contains
55964 * field definition information from specified resultset. The value of
55965 * fieldnr must be in the range from 0 to number of fields - 1.
55966 *
55967 * @param resource $result
55968 * @param int $fieldnr
55969 * @return mixed Returns an resource which contains field definition
55970 *   information or FALSE if no field information for specified fieldnr
55971 *   is available.
55972 * @since PECL maxdb >= 1.0
55973 **/
55974function maxdb_fetch_field_direct($result, $fieldnr){}
55975
55976/**
55977 * Returns the lengths of the columns of the current row in the result
55978 * set
55979 *
55980 * The {@link maxdb_fetch_lengths} function returns an array containing
55981 * the lengths of every column of the current row within the result set
55982 * represented by the {@link result} parameter. If successful, a
55983 * numerically indexed array representing the lengths of each column is
55984 * returned.
55985 *
55986 * @param resource $result
55987 * @return array An array of integers representing the size of each
55988 *   column (not including any terminating null characters). FALSE if an
55989 *   error occurred.
55990 * @since PECL maxdb >= 1.0
55991 **/
55992function maxdb_fetch_lengths($result){}
55993
55994/**
55995 * Returns the current row of a result set as an object
55996 *
55997 * The {@link maxdb_fetch_object} will return the current row result set
55998 * as an object where the attributes of the object represent the names of
55999 * the fields found within the result set. If no more rows exist in the
56000 * current result set, NULL is returned.
56001 *
56002 * @param object $result
56003 * @return object Returns an object that corresponds to the fetched row
56004 *   or NULL if there are no more rows in resultset.
56005 * @since PECL maxdb >= 1.0
56006 **/
56007function maxdb_fetch_object($result){}
56008
56009/**
56010 * Get a result row as an enumerated array
56011 *
56012 * Returns an array that corresponds to the fetched row, or NULL if there
56013 * are no more rows.
56014 *
56015 * {@link maxdb_fetch_row} fetches one row of data from the result set
56016 * represented by {@link result} and returns it as an enumerated array,
56017 * where each column is stored in an array offset starting from 0 (zero).
56018 * Each subsequent call to the {@link maxdb_fetch_row} function will
56019 * return the next row within the result set, or FALSE if there are no
56020 * more rows.
56021 *
56022 * @param resource $result
56023 * @return mixed {@link maxdb_fetch_row} returns an array that
56024 *   corresponds to the fetched row or NULL if there are no more rows in
56025 *   result set.
56026 * @since PECL maxdb >= 1.0
56027 **/
56028function maxdb_fetch_row($result){}
56029
56030/**
56031 * Returns the number of columns for the most recent query
56032 *
56033 * Returns the number of columns for the most recent query on the
56034 * connection represented by the {@link link} parameter. This function
56035 * can be useful when using the {@link maxdb_store_result} function to
56036 * determine if the query should have produced a non-empty result set or
56037 * not without knowing the nature of the query.
56038 *
56039 * @param resource $link
56040 * @return int An integer representing the number of fields in a result
56041 *   set.
56042 * @since PECL maxdb >= 1.0
56043 **/
56044function maxdb_field_count($link){}
56045
56046/**
56047 * Set result pointer to a specified field offset
56048 *
56049 * Sets the field cursor to the given offset. The next call to {@link
56050 * maxdb_fetch_field} will retrieve the field definition of the column
56051 * associated with that offset.
56052 *
56053 * @param resource $result
56054 * @param int $fieldnr
56055 * @return bool {@link maxdb_field_seek} returns previuos value of
56056 *   field cursor.
56057 * @since PECL maxdb >= 1.0
56058 **/
56059function maxdb_field_seek($result, $fieldnr){}
56060
56061/**
56062 * Get current field offset of a result pointer
56063 *
56064 * Returns the position of the field cursor used for the last {@link
56065 * maxdb_fetch_field} call. This value can be used as an argument to
56066 * {@link maxdb_field_seek}.
56067 *
56068 * @param resource $result
56069 * @return int Returns current offset of field cursor.
56070 * @since PECL maxdb >= 1.0
56071 **/
56072function maxdb_field_tell($result){}
56073
56074/**
56075 * Frees the memory associated with a result
56076 *
56077 * The {@link maxdb_free_result} function frees the memory associated
56078 * with the result represented by the {@link result} parameter, which was
56079 * allocated by {@link maxdb_query}, {@link maxdb_store_result} or {@link
56080 * maxdb_use_result}.
56081 *
56082 * @param resource $result
56083 * @return void This function doesn't return any value.
56084 * @since PECL maxdb >= 1.0
56085 **/
56086function maxdb_free_result($result){}
56087
56088/**
56089 * Returns the MaxDB client version as a string
56090 *
56091 * The {@link maxdb_get_client_info} function is used to return a string
56092 * representing the client version being used in the MaxDB extension.
56093 *
56094 * @return string A string that represents the MaxDB client library
56095 *   version
56096 * @since PECL maxdb >= 1.0
56097 **/
56098function maxdb_get_client_info(){}
56099
56100/**
56101 * Get MaxDB client info
56102 *
56103 * Returns client version number as an integer.
56104 *
56105 * @return int A number that represents the MaxDB client library
56106 *   version in format: main_version*10000 + minor_version *100 +
56107 *   sub_version. For example, 7.5.0 is returned as 70500.
56108 * @since PECL maxdb >= 1.0
56109 **/
56110function maxdb_get_client_version(){}
56111
56112/**
56113 * Returns a string representing the type of connection used
56114 *
56115 * The {@link maxdb_get_host_info} function returns a string describing
56116 * the connection represented by the {@link link} parameter is using.
56117 *
56118 * @param resource $link
56119 * @return string A character string representing the server hostname
56120 *   and the connection type.
56121 * @since PECL maxdb >= 1.0
56122 **/
56123function maxdb_get_host_info($link){}
56124
56125/**
56126 * Returns result set metadata from a prepared statement
56127 *
56128 * If a statement passed to {@link maxdb_prepare} is one that produces a
56129 * result set, {@link maxdb_get_metadata} returns the result resource
56130 * that can be used to process the meta information such as total number
56131 * of fields and individual field information.
56132 *
56133 * The result set structure should be freed when you are done with it,
56134 * which you can do by passing it to {@link maxdb_free_result}
56135 *
56136 * @param resource $stmt
56137 * @return resource {@link maxdb_stmt_result_metadata} returns a result
56138 *   resource or FALSE if an error occurred.
56139 * @since PECL maxdb 1.0
56140 **/
56141function maxdb_get_metadata($stmt){}
56142
56143/**
56144 * Returns the version of the MaxDB protocol used
56145 *
56146 * Returns an integer representing the MaxDB protocol version used by the
56147 * connection represented by the {@link link} parameter.
56148 *
56149 * @param resource $link
56150 * @return int Returns an integer representing the protocol version
56151 *   (constant 10).
56152 * @since PECL maxdb >= 1.0
56153 **/
56154function maxdb_get_proto_info($link){}
56155
56156/**
56157 * Returns the version of the MaxDB server
56158 *
56159 * Returns a string representing the version of the MaxDB server that the
56160 * MaxDB extension is connected to (represented by the {@link link}
56161 * parameter).
56162 *
56163 * @param resource $link
56164 * @return string A character string representing the server version.
56165 * @since PECL maxdb >= 1.0
56166 **/
56167function maxdb_get_server_info($link){}
56168
56169/**
56170 * Returns the version of the MaxDB server as an integer
56171 *
56172 * The {@link maxdb_get_server_version} function returns the version of
56173 * the server connected to (represented by the {@link link} parameter) as
56174 * an integer.
56175 *
56176 * The form of this version number is main_version * 10000 +
56177 * minor_version * 100 + sub_version (i.e. version 7.5.0 is 70500).
56178 *
56179 * @param resource $link
56180 * @return int An integer representing the server version.
56181 * @since PECL maxdb >= 1.0
56182 **/
56183function maxdb_get_server_version($link){}
56184
56185/**
56186 * Retrieves information about the most recently executed query
56187 *
56188 * The {@link maxdb_info} function returns a string providing information
56189 * about the last query executed. The nature of this string is provided
56190 * below:
56191 *
56192 * Possible maxdb_info return values Query type Example result string
56193 * INSERT INTO...SELECT... Records: 100 Duplicates: 0 Warnings: 0 INSERT
56194 * INTO...VALUES (...),(...),(...) Records: 3 Duplicates: 0 Warnings: 0
56195 * LOAD DATA INFILE ... Records: 1 Deleted: 0 Skipped: 0 Warnings: 0
56196 * ALTER TABLE ... Records: 3 Duplicates: 0 Warnings: 0 UPDATE ... Rows
56197 * matched: 40 Changed: 40 Warnings: 0
56198 *
56199 * @param resource $link
56200 * @return string A character string representing additional
56201 *   information about the most recently executed query.
56202 * @since PECL maxdb >= 1.0
56203 **/
56204function maxdb_info($link){}
56205
56206/**
56207 * Initializes MaxDB and returns an resource for use with
56208 * maxdb_real_connect
56209 *
56210 * Allocates or initializes a MaxDB resource suitable for {@link
56211 * maxdb_options} and {@link maxdb_real_connect}.
56212 *
56213 * @return resource Returns an resource.
56214 * @since PECL maxdb >= 1.0
56215 **/
56216function maxdb_init(){}
56217
56218/**
56219 * Returns the auto generated id used in the last query
56220 *
56221 * The {@link maxdb_insert_id} function returns the ID generated by a
56222 * query on a table with a column having the DEFAULT SERIAL attribute. If
56223 * the last query wasn't an INSERT or UPDATE statement or if the modified
56224 * table does not have a column with the DEFAULT SERIAL attribute, this
56225 * function will return zero.
56226 *
56227 * @param resource $link
56228 * @return mixed The value of the DEFAULT SERIAL field that was updated
56229 *   by the previous query. Returns zero if there was no previous query
56230 *   on the connection or if the query did not update an DEFAULT_SERIAL
56231 *   value.
56232 * @since PECL maxdb >= 1.0
56233 **/
56234function maxdb_insert_id($link){}
56235
56236/**
56237 * Disconnects from a MaxDB server
56238 *
56239 * This function is used to disconnect from a MaxDB server specified by
56240 * the {@link processid} parameter.
56241 *
56242 * @param resource $link
56243 * @param int $processid
56244 * @return bool
56245 * @since PECL maxdb >= 1.0
56246 **/
56247function maxdb_kill($link, $processid){}
56248
56249/**
56250 * Enforce execution of a query on the master in a master/slave setup
56251 *
56252 * @param resource $link
56253 * @param string $query
56254 * @return bool
56255 * @since PECL maxdb >= 1.0
56256 **/
56257function maxdb_master_query($link, $query){}
56258
56259/**
56260 * Check if there any more query results from a multi query
56261 *
56262 * {@link maxdb_more_results} indicates if one or more result sets are
56263 * available from a previous call to {@link maxdb_multi_query}.
56264 *
56265 * @param resource $link
56266 * @return bool Always FALSE.
56267 * @since PECL maxdb >= 1.0
56268 **/
56269function maxdb_more_results($link){}
56270
56271/**
56272 * Performs a query on the database
56273 *
56274 * The {@link maxdb_multi_query} works like the function {@link
56275 * maxdb_query}. Multiple queries are not yet supported.
56276 *
56277 * @param resource $link
56278 * @param string $query
56279 * @return bool
56280 * @since PECL maxdb >= 1.0
56281 **/
56282function maxdb_multi_query($link, $query){}
56283
56284/**
56285 * Prepare next result from multi_query
56286 *
56287 * Since multiple queries are not yet supported, {@link
56288 * maxdb_next_result} returns always FALSE.
56289 *
56290 * @param resource $link
56291 * @return bool Returns FALSE.
56292 * @since PECL maxdb >= 1.0
56293 **/
56294function maxdb_next_result($link){}
56295
56296/**
56297 * Get the number of fields in a result
56298 *
56299 * {@link maxdb_num_fields} returns the number of fields from specified
56300 * result set.
56301 *
56302 * @param resource $result
56303 * @return int The number of fields from a result set
56304 * @since PECL maxdb >= 1.0
56305 **/
56306function maxdb_num_fields($result){}
56307
56308/**
56309 * Gets the number of rows in a result
56310 *
56311 * Returns the number of rows in the result set.
56312 *
56313 * The use of {@link maxdb_num_rows} depends on whether you use buffered
56314 * or unbuffered result sets. In case you use unbuffered resultsets
56315 * {@link maxdb_num_rows} will not correct the correct number of rows
56316 * until all the rows in the result have been retrieved.
56317 *
56318 * @param resource $result
56319 * @return int Returns number of rows in the result set.
56320 * @since PECL maxdb >= 1.0
56321 **/
56322function maxdb_num_rows($result){}
56323
56324/**
56325 * Set options
56326 *
56327 * {@link maxdb_options} can be used to set extra connect options and
56328 * affect behavior for a connection.
56329 *
56330 * This function may be called multiple times to set several options.
56331 *
56332 * {@link maxdb_options} should be called after {@link maxdb_init} and
56333 * before {@link maxdb_real_connect}.
56334 *
56335 * The parameter {@link option} is the option that you want to set, the
56336 * {@link value} is the value for the option. For detailed description of
56337 * the options see The parameter {@link option} can be one of the
56338 * following values: Valid options Name Description MAXDB_COMPNAME The
56339 * component name used to initialise the SQLDBC runtime environment.
56340 * MAXDB_APPLICATION The application to be connected to the database.
56341 * MAXDB_APPVERSION The version of the application. MAXDB_SQLMODE The SQL
56342 * mode. MAXDB_UNICODE TRUE, if the connection is an unicode (UCS2)
56343 * client or FALSE, if not. MAXDB_TIMEOUT The maximum allowed time of
56344 * inactivity after which the connection to the database is closed by the
56345 * system. MAXDB_ISOLATIONLEVEL Specifies whether and how shared locks
56346 * and exclusive locks are implicitly requested or released.
56347 * MAXDB_PACKETCOUNT The number of different request packets used for the
56348 * connection. MAXDB_STATEMENTCACHESIZE The number of prepared statements
56349 * to be cached for the connection for re-use. MAXDB_CURSORPREFIX The
56350 * prefix to use for result tables that are automatically named.
56351 *
56352 * @param resource $link
56353 * @param int $option
56354 * @param mixed $value
56355 * @return bool
56356 * @since PECL maxdb >= 1.0
56357 **/
56358function maxdb_options($link, $option, $value){}
56359
56360/**
56361 * Returns the number of parameter for the given statement
56362 *
56363 * {@link maxdb_param_count} returns the number of parameter markers
56364 * present in the prepared statement.
56365 *
56366 * @param resource $stmt
56367 * @return int returns an integer representing the number of
56368 *   parameters.
56369 * @since PECL maxdb 1.0
56370 **/
56371function maxdb_param_count($stmt){}
56372
56373/**
56374 * Pings a server connection, or tries to reconnect if the connection has
56375 * gone down
56376 *
56377 * Checks whether the connection to the server is working. If it has gone
56378 * down, and global option maxdb.reconnect is enabled an automatic
56379 * reconnection is attempted.
56380 *
56381 * This function can be used by clients that remain idle for a long
56382 * while, to check whether the server has closed the connection and
56383 * reconnect if necessary.
56384 *
56385 * @param resource $link
56386 * @return bool
56387 * @since PECL maxdb >= 1.0
56388 **/
56389function maxdb_ping($link){}
56390
56391/**
56392 * Prepare an SQL statement for execution
56393 *
56394 * {@link maxdb_prepare} prepares the SQL query pointed to by the
56395 * null-terminated string query, and returns a statement handle to be
56396 * used for further operations on the statement. The query must consist
56397 * of a single SQL statement.
56398 *
56399 * The parameter {@link query} can include one or more parameter markers
56400 * in the SQL statement by embedding question mark (?) characters at the
56401 * appropriate positions.
56402 *
56403 * The parameter markers must be bound to application variables using
56404 * {@link maxdb_stmt_bind_param} and/or {@link maxdb_stmt_bind_result}
56405 * before executing the statement or fetching rows.
56406 *
56407 * @param resource $link
56408 * @param string $query
56409 * @return resource {@link maxdb_prepare} returns a statement resource
56410 *   or FALSE if an error occurred.
56411 * @since PECL maxdb >= 1.0
56412 **/
56413function maxdb_prepare($link, $query){}
56414
56415/**
56416 * Performs a query on the database
56417 *
56418 * The {@link maxdb_query} function is used to simplify the act of
56419 * performing a query against the database represented by the {@link
56420 * link} parameter.
56421 *
56422 * @param resource $link
56423 * @param string $query
56424 * @param int $resultmode
56425 * @return mixed For SELECT, SHOW, DESCRIBE or EXPLAIN {@link
56426 *   maxdb_query} will return a result resource.
56427 * @since PECL maxdb >= 1.0
56428 **/
56429function maxdb_query($link, $query, $resultmode){}
56430
56431/**
56432 * Opens a connection to a MaxDB server
56433 *
56434 * {@link maxdb_real_connect} attempts to establish a connection to a
56435 * MaxDB database engine running on {@link hostname}.
56436 *
56437 * This function differs from {@link maxdb_connect}:
56438 *
56439 * @param resource $link
56440 * @param string $hostname
56441 * @param string $username
56442 * @param string $passwd
56443 * @param string $dbname
56444 * @param int $port
56445 * @param string $socket
56446 * @return bool
56447 * @since PECL maxdb >= 1.0
56448 **/
56449function maxdb_real_connect($link, $hostname, $username, $passwd, $dbname, $port, $socket){}
56450
56451/**
56452 * Escapes special characters in a string for use in an SQL statement,
56453 * taking into account the current charset of the connection
56454 *
56455 * This function is used to create a legal SQL string that you can use in
56456 * an SQL statement. The string escapestr is encoded to an escaped SQL
56457 * string, taking into account the current character set of the
56458 * connection.
56459 *
56460 * Characters encoded are ', ".
56461 *
56462 * @param resource $link
56463 * @param string $escapestr
56464 * @return string Returns an escaped string.
56465 * @since PECL maxdb >= 1.0
56466 **/
56467function maxdb_real_escape_string($link, $escapestr){}
56468
56469/**
56470 * Execute an SQL query
56471 *
56472 * The {@link maxdb_real_query} is functionally identical with the {@link
56473 * maxdb_query}.
56474 *
56475 * @param resource $link
56476 * @param string $query
56477 * @return bool
56478 * @since PECL maxdb >= 1.0
56479 **/
56480function maxdb_real_query($link, $query){}
56481
56482/**
56483 * Enables or disables internal report functions
56484 *
56485 * @param int $flags One of the MAXDB_REPORT_XXX constants.
56486 * @return bool
56487 * @since PECL maxdb 1.0
56488 **/
56489function maxdb_report($flags){}
56490
56491/**
56492 * Rolls back current transaction
56493 *
56494 * Rollbacks the current transaction for the database specified by the
56495 * {@link link} parameter.
56496 *
56497 * @param resource $link
56498 * @return bool
56499 * @since PECL maxdb >= 1.0
56500 **/
56501function maxdb_rollback($link){}
56502
56503/**
56504 * Check if RPL parse is enabled
56505 *
56506 * @param resource $link
56507 * @return int
56508 * @since PECL maxdb >= 1.0
56509 **/
56510function maxdb_rpl_parse_enabled($link){}
56511
56512/**
56513 * RPL probe
56514 *
56515 * @param resource $link
56516 * @return bool
56517 * @since PECL maxdb >= 1.0
56518 **/
56519function maxdb_rpl_probe($link){}
56520
56521/**
56522 * Returns RPL query type
56523 *
56524 * @param resource $link
56525 * @return int
56526 * @since PECL maxdb >= 1.0
56527 **/
56528function maxdb_rpl_query_type($link){}
56529
56530/**
56531 * Selects the default database for database queries
56532 *
56533 * The {@link maxdb_select_db} function selects the default database
56534 * (specified by the {@link dbname} parameter) to be used when performing
56535 * queries against the database connection represented by the {@link
56536 * link} parameter.
56537 *
56538 * @param resource $link
56539 * @param string $dbname
56540 * @return bool
56541 * @since PECL maxdb >= 1.0
56542 **/
56543function maxdb_select_db($link, $dbname){}
56544
56545/**
56546 * Send data in blocks
56547 *
56548 * Allows to send parameter data to the server in pieces (or chunks).
56549 * This function can be called multiple times to send the parts of a
56550 * character or binary data value for a column, which must be one of the
56551 * TEXT or BLOB datatypes.
56552 *
56553 * {@link param_nr} indicates which parameter to associate the data with.
56554 * Parameters are numbered beginning with 0. {@link data} is a string
56555 * containing data to be sent.
56556 *
56557 * @param resource $stmt
56558 * @param int $param_nr
56559 * @param string $data
56560 * @return bool
56561 * @since PECL maxdb >= 1.0
56562 **/
56563function maxdb_send_long_data($stmt, $param_nr, $data){}
56564
56565/**
56566 * Send the query and return
56567 *
56568 * @param resource $link
56569 * @param string $query
56570 * @return bool
56571 * @since PECL maxdb >= 1.0
56572 **/
56573function maxdb_send_query($link, $query){}
56574
56575/**
56576 * Shut down the embedded server
56577 *
56578 * @return void
56579 * @since PECL maxdb >= 1.0
56580 **/
56581function maxdb_server_end(){}
56582
56583/**
56584 * Initialize embedded server
56585 *
56586 * @param array $server
56587 * @param array $groups
56588 * @return bool
56589 * @since PECL maxdb >= 1.0
56590 **/
56591function maxdb_server_init($server, $groups){}
56592
56593/**
56594 * Set options
56595 *
56596 * {@link maxdb_set_opt} can be used to set extra connect options and
56597 * affect behavior for a connection.
56598 *
56599 * This function may be called multiple times to set several options.
56600 *
56601 * {@link maxdb_set_opt} should be called after {@link maxdb_init} and
56602 * before {@link maxdb_real_connect}.
56603 *
56604 * The parameter {@link option} is the option that you want to set, the
56605 * {@link value} is the value for the option. For detailed description of
56606 * the options see The parameter {@link option} can be one of the
56607 * following values: Valid options Name Description MAXDB_COMPNAME The
56608 * component name used to initialise the SQLDBC runtime environment.
56609 * MAXDB_APPLICATION The application to be connected to the database.
56610 * MAXDB_APPVERSION The version of the application. MAXDB_SQLMODE The SQL
56611 * mode. MAXDB_UNICODE TRUE, if the connection is an unicode (UCS2)
56612 * client or FALSE, if not. MAXDB_TIMEOUT The maximum allowed time of
56613 * inactivity after which the connection to the database is closed by the
56614 * system. MAXDB_ISOLATIONLEVEL Specifies whether and how shared locks
56615 * and exclusive locks are implicitly requested or released.
56616 * MAXDB_PACKETCOUNT The number of different request packets used for the
56617 * connection. MAXDB_STATEMENTCACHESIZE The number of prepared statements
56618 * to be cached for the connection for re-use. MAXDB_CURSORPREFIX The
56619 * prefix to use for result tables that are automatically named.
56620 *
56621 * @param resource $link
56622 * @param int $option
56623 * @param mixed $value
56624 * @return bool
56625 * @since PECL maxdb 1.0
56626 **/
56627function maxdb_set_opt($link, $option, $value){}
56628
56629/**
56630 * Returns the SQLSTATE error from previous MaxDB operation
56631 *
56632 * Returns a string containing the SQLSTATE error code for the last
56633 * error. The error code consists of five characters. '00000' means no
56634 * error. The values are specified by ANSI SQL and ODBC.
56635 *
56636 * @param resource $link
56637 * @return string Returns a string containing the SQLSTATE error code
56638 *   for the last error. The error code consists of five characters.
56639 *   '00000' means no error.
56640 * @since PECL maxdb >= 1.0
56641 **/
56642function maxdb_sqlstate($link){}
56643
56644/**
56645 * Used for establishing secure connections using SSL
56646 *
56647 * @param resource $link
56648 * @param string $key
56649 * @param string $cert
56650 * @param string $ca
56651 * @param string $capath
56652 * @param string $cipher
56653 * @return bool
56654 * @since PECL maxdb >= 1.0
56655 **/
56656function maxdb_ssl_set($link, $key, $cert, $ca, $capath, $cipher){}
56657
56658/**
56659 * Gets the current system status
56660 *
56661 * {@link maxdb_stat} returns a string containing several information
56662 * about the MaxDB server running.
56663 *
56664 * @param resource $link
56665 * @return string A string describing the server status. FALSE if an
56666 *   error occurred.
56667 * @since PECL maxdb >= 1.0
56668 **/
56669function maxdb_stat($link){}
56670
56671/**
56672 * Returns the total number of rows changed, deleted, or inserted by the
56673 * last executed statement
56674 *
56675 * {@link maxdb_stmt_affected_rows} returns the number of rows affected
56676 * by INSERT, UPDATE, or DELETE query. If the last query was invalid or
56677 * the number of rows can not determined, this function will return -1.
56678 *
56679 * @param resource $stmt
56680 * @return int An integer greater than zero indicates the number of
56681 *   rows affected or retrieved. Zero indicates that no records where
56682 *   updated for an UPDATE/DELETE statement, no rows matched the WHERE
56683 *   clause in the query or that no query has yet been executed. -1
56684 *   indicates that the query has returned an error or the number of rows
56685 *   can not determined.
56686 * @since PECL maxdb >= 1.0
56687 **/
56688function maxdb_stmt_affected_rows($stmt){}
56689
56690/**
56691 * Binds variables to a prepared statement as parameters
56692 *
56693 * (extended syntax):
56694 *
56695 * (extended syntax):
56696 *
56697 * {@link maxdb_stmt_bind_param} is used to bind variables for the
56698 * parameter markers in the SQL statement that was passed to {@link
56699 * maxdb_prepare}. The string {@link types} contains one or more
56700 * characters which specify the types for the corresponding bind
56701 * variables.
56702 *
56703 * The extended syntax of {@link maxdb_stmt_bind_param} allows to give
56704 * the parameters as an array instead of a variable list of PHP variables
56705 * to the function. If the array variable has not been used before
56706 * calling {@link maxdb_stmt_bind_param}, it has to be initialized as an
56707 * emtpy array. See the examples how to use {@link maxdb_stmt_bind_param}
56708 * with extended syntax.
56709 *
56710 * Variables for SELECT INTO SQL statements can also be bound using
56711 * {@link maxdb_stmt_bind_param}. Parameters for database procedures can
56712 * be bound using {@link maxdb_stmt_bind_param}. See the examples how to
56713 * use {@link maxdb_stmt_bind_param} in this cases.
56714 *
56715 * If a variable bound as INTO variable to an SQL statement was used
56716 * before, the content of this variable is overwritten by the data of the
56717 * SELECT INTO statement. A reference to this variable will be invalid
56718 * after a call to {@link maxdb_stmt_bind_param}.
56719 *
56720 * For INOUT parameters of database procedures the content of the bound
56721 * INOUT variable is overwritten by the output value of the database
56722 * procedure. A reference to this variable will be invalid after a call
56723 * to {@link maxdb_stmt_bind_param}.
56724 *
56725 * Type specification chars Character Description i corresponding
56726 * variable has type integer d corresponding variable has type double s
56727 * corresponding variable has type string b corresponding variable is a
56728 * blob and will be sent in packages
56729 *
56730 * @param resource $stmt
56731 * @param string $types
56732 * @param mixed $var1
56733 * @param mixed ...$vararg
56734 * @return bool
56735 * @since PECL maxdb >= 1.0
56736 **/
56737function maxdb_stmt_bind_param($stmt, $types, &$var1, &...$vararg){}
56738
56739/**
56740 * Binds variables to a prepared statement for result storage
56741 *
56742 * {@link maxdb_stmt_bind_result} is used to associate (bind) columns in
56743 * the result set to variables. When {@link maxdb_stmt_fetch} is called
56744 * to fetch data, the MaxDB client/server protocol places the data for
56745 * the bound columns into the specified variables {@link var1, ...}.
56746 *
56747 * @param resource $stmt
56748 * @param mixed $var1
56749 * @param mixed ...$vararg
56750 * @return bool
56751 * @since PECL maxdb >= 1.0
56752 **/
56753function maxdb_stmt_bind_result($stmt, &$var1, &...$vararg){}
56754
56755/**
56756 * Closes a prepared statement
56757 *
56758 * Closes a prepared statement. {@link maxdb_stmt_close} also deallocates
56759 * the statement handle pointed to by {@link stmt}. If the current
56760 * statement has pending or unread results, this function cancels them so
56761 * that the next query can be executed.
56762 *
56763 * @param resource $stmt
56764 * @return bool
56765 * @since PECL maxdb >= 1.0
56766 **/
56767function maxdb_stmt_close($stmt){}
56768
56769/**
56770 * Ends a sequence of
56771 *
56772 * This function has to be called after a sequence of {@link
56773 * maxdb_stmt_send_long_data}, that was started after {@link
56774 * maxdb_execute}.
56775 *
56776 * {@link param_nr} indicates which parameter to associate the end of
56777 * data with. Parameters are numbered beginning with 0.
56778 *
56779 * @param resource $stmt
56780 * @param int $param_nr
56781 * @return bool
56782 * @since PECL maxdb 1.0
56783 **/
56784function maxdb_stmt_close_long_data($stmt, $param_nr){}
56785
56786/**
56787 * Seeks to an arbitray row in statement result set
56788 *
56789 * The {@link maxdb_stmt_data_seek} function seeks to an arbitrary result
56790 * pointer specified by the {@link offset} in the statement result set
56791 * represented by {@link statement}. The {@link offset} parameter must be
56792 * between zero and the total number of rows minus one (0..{@link
56793 * maxdb_stmt_num_rows} - 1).
56794 *
56795 * @param resource $statement
56796 * @param int $offset
56797 * @return bool
56798 * @since PECL maxdb >= 1.0
56799 **/
56800function maxdb_stmt_data_seek($statement, $offset){}
56801
56802/**
56803 * Returns the error code for the most recent statement call
56804 *
56805 * For the statement specified by stmt, {@link maxdb_stmt_errno} returns
56806 * the error code for the most recently invoked statement function that
56807 * can succeed or fail.
56808 *
56809 * @param resource $stmt
56810 * @return int An error code value. Zero means no error occurred.
56811 * @since PECL maxdb >= 1.0
56812 **/
56813function maxdb_stmt_errno($stmt){}
56814
56815/**
56816 * Returns a string description for last statement error
56817 *
56818 * For the statement specified by stmt, {@link maxdb_stmt_error} returns
56819 * a containing the error message for the most recently invoked statement
56820 * function that can succeed or fail.
56821 *
56822 * @param resource $stmt
56823 * @return string A string that describes the error. An empty string if
56824 *   no error occurred.
56825 * @since PECL maxdb >= 1.0
56826 **/
56827function maxdb_stmt_error($stmt){}
56828
56829/**
56830 * Executes a prepared Query
56831 *
56832 * The {@link maxdb_stmt_execute} function executes a query that has been
56833 * previously prepared using the {@link maxdb_prepare} function
56834 * represented by the {@link stmt} resource. When executed any parameter
56835 * markers which exist will automatically be replaced with the
56836 * appropriate data.
56837 *
56838 * If the statement is UPDATE, DELETE, or INSERT, the total number of
56839 * affected rows can be determined by using the {@link
56840 * maxdb_stmt_affected_rows} function. Likewise, if the query yields a
56841 * result set the {@link maxdb_fetch} function is used.
56842 *
56843 * @param resource $stmt
56844 * @return bool
56845 * @since PECL maxdb >= 1.0
56846 **/
56847function maxdb_stmt_execute($stmt){}
56848
56849/**
56850 * Fetch results from a prepared statement into the bound variables
56851 *
56852 * {@link maxdb_stmt_fetch} returns row data using the variables bound by
56853 * {@link maxdb_stmt_bind_result}.
56854 *
56855 * @param resource $stmt
56856 * @return bool
56857 * @since PECL maxdb >= 1.0
56858 **/
56859function maxdb_stmt_fetch($stmt){}
56860
56861/**
56862 * Frees stored result memory for the given statement handle
56863 *
56864 * The {@link maxdb_stmt_free_result} function frees the result memory
56865 * associated with the statement represented by the {@link stmt}
56866 * parameter, which was allocated by {@link maxdb_stmt_store_result}.
56867 *
56868 * @param resource $stmt
56869 * @return void This function doesn't return any value.
56870 * @since PECL maxdb >= 1.0
56871 **/
56872function maxdb_stmt_free_result($stmt){}
56873
56874/**
56875 * Initializes a statement and returns an resource for use with
56876 * maxdb_stmt_prepare
56877 *
56878 * Allocates and initializes a statement resource suitable for {@link
56879 * maxdb_stmt_prepare}.
56880 *
56881 * @param resource $link
56882 * @return resource Returns an resource.
56883 * @since PECL maxdb >= 1.0
56884 **/
56885function maxdb_stmt_init($link){}
56886
56887/**
56888 * Return the number of rows in statements result set
56889 *
56890 * Returns the number of rows in the result set.
56891 *
56892 * @param resource $stmt
56893 * @return int An integer representing the number of rows in result
56894 *   set.
56895 * @since PECL maxdb >= 1.0
56896 **/
56897function maxdb_stmt_num_rows($stmt){}
56898
56899/**
56900 * Returns the number of parameter for the given statement
56901 *
56902 * {@link maxdb_stmt_param_count} returns the number of parameter markers
56903 * present in the prepared statement.
56904 *
56905 * @param resource $stmt
56906 * @return int returns an integer representing the number of
56907 *   parameters.
56908 * @since PECL maxdb >= 1.0
56909 **/
56910function maxdb_stmt_param_count($stmt){}
56911
56912/**
56913 * Prepare an SQL statement for execution
56914 *
56915 * {@link maxdb_stmt_prepare} prepares the SQL query pointed to by the
56916 * null-terminated string query. The statement resource has to be
56917 * allocated by {@link maxdb_stmt_init}. The query must consist of a
56918 * single SQL statement.
56919 *
56920 * The parameter {@link query} can include one or more parameter markers
56921 * in the SQL statement by embedding question mark (?) characters at the
56922 * appropriate positions.
56923 *
56924 * The parameter markers must be bound to application variables using
56925 * {@link maxdb_stmt_bind_param} and/or {@link maxdb_stmt_bind_result}
56926 * before executing the statement or fetching rows.
56927 *
56928 * @param resource $stmt
56929 * @param string $query
56930 * @return bool
56931 * @since PECL maxdb >= 1.0
56932 **/
56933function maxdb_stmt_prepare($stmt, $query){}
56934
56935/**
56936 * Resets a prepared statement
56937 *
56938 * @param resource $stmt
56939 * @return bool
56940 * @since PECL maxdb >= 1.0
56941 **/
56942function maxdb_stmt_reset($stmt){}
56943
56944/**
56945 * Returns result set metadata from a prepared statement
56946 *
56947 * If a statement passed to {@link maxdb_prepare} is one that produces a
56948 * result set, {@link maxdb_stmt_result_metadata} returns the result
56949 * resource that can be used to process the meta information such as
56950 * total number of fields and individual field information.
56951 *
56952 * The result set structure should be freed when you are done with it,
56953 * which you can do by passing it to {@link maxdb_free_result}
56954 *
56955 * @param resource $stmt
56956 * @return resource {@link maxdb_stmt_result_metadata} returns a result
56957 *   resource or FALSE if an error occurred.
56958 * @since PECL maxdb >= 1.0
56959 **/
56960function maxdb_stmt_result_metadata($stmt){}
56961
56962/**
56963 * Send data in blocks
56964 *
56965 * Allows to send parameter data to the server in pieces (or chunks).
56966 * This function can be called multiple times to send the parts of a
56967 * character or binary data value for a column, which must be one of the
56968 * TEXT or BLOB datatypes.
56969 *
56970 * {@link param_nr} indicates which parameter to associate the data with.
56971 * Parameters are numbered beginning with 0. {@link data} is a string
56972 * containing data to be sent.
56973 *
56974 * @param resource $stmt
56975 * @param int $param_nr
56976 * @param string $data
56977 * @return bool
56978 * @since PECL maxdb 1.0
56979 **/
56980function maxdb_stmt_send_long_data($stmt, $param_nr, $data){}
56981
56982/**
56983 * Returns SQLSTATE error from previous statement operation
56984 *
56985 * Returns a string containing the SQLSTATE error code for the most
56986 * recently invoked prepared statement function that can succeed or fail.
56987 * The error code consists of five characters. '00000' means no error.
56988 * The values are specified by ANSI SQL and ODBC.
56989 *
56990 * @param resource $stmt
56991 * @return string Returns a string containing the SQLSTATE error code
56992 *   for the last error. The error code consists of five characters.
56993 *   '00000' means no error.
56994 * @since PECL maxdb >= 1.0
56995 **/
56996function maxdb_stmt_sqlstate($stmt){}
56997
56998/**
56999 * Transfers a result set from a prepared statement
57000 *
57001 * {@link maxdb_stmt_store_result} has no functionally effect and should
57002 * not be used for retrieving data from MaxDB server.
57003 *
57004 * @param resource $stmt
57005 * @return bool
57006 * @since PECL maxdb >= 1.0
57007 **/
57008function maxdb_stmt_store_result($stmt){}
57009
57010/**
57011 * Transfers a result set from the last query
57012 *
57013 * This function has no functionally effect.
57014 *
57015 * @param resource $link
57016 * @return resource Returns a result resource or FALSE if an error
57017 *   occurred.
57018 * @since PECL maxdb >= 1.0
57019 **/
57020function maxdb_store_result($link){}
57021
57022/**
57023 * Returns the thread ID for the current connection
57024 *
57025 * The {@link maxdb_thread_id} function returns the thread ID for the
57026 * current connection which can then be killed using the {@link
57027 * maxdb_kill} function. If the connection is lost and you reconnect with
57028 * {@link maxdb_ping}, the thread ID will be other. Therefore you should
57029 * get the thread ID only when you need it.
57030 *
57031 * @param resource $link
57032 * @return int {@link maxdb_thread_id} returns the Thread ID for the
57033 *   current connection.
57034 * @since PECL maxdb >= 1.0
57035 **/
57036function maxdb_thread_id($link){}
57037
57038/**
57039 * Returns whether thread safety is given or not
57040 *
57041 * {@link maxdb_thread_safe} indicates whether the client library is
57042 * compiled as thread-safe.
57043 *
57044 * @return bool TRUE if the client library is thread-safe, otherwise
57045 *   FALSE.
57046 * @since PECL maxdb >= 7.6.06.04
57047 **/
57048function maxdb_thread_safe(){}
57049
57050/**
57051 * Initiate a result set retrieval
57052 *
57053 * {@link maxdb_use_result} has no effect.
57054 *
57055 * @param resource $link
57056 * @return resource Returns result .
57057 * @since PECL maxdb >= 1.0
57058 **/
57059function maxdb_use_result($link){}
57060
57061/**
57062 * Returns the number of warnings from the last query for the given link
57063 *
57064 * {@link maxdb_warning_count} returns the number of warnings from the
57065 * last query in the connection represented by the {@link link}
57066 * parameter.
57067 *
57068 * @param resource $link
57069 * @return int Number of warnings or zero if there are no warnings.
57070 * @since PECL maxdb >= 1.0
57071 **/
57072function maxdb_warning_count($link){}
57073
57074/**
57075 * Check if strings are valid for the specified encoding
57076 *
57077 * Checks if the specified byte stream is valid for the specified
57078 * encoding. If {@link var} is of type , all keys and values are
57079 * validated recursively. It is useful to prevent so-called "Invalid
57080 * Encoding Attack".
57081 *
57082 * @param mixed $var The byte stream or to check. If it is omitted,
57083 *   this function checks all the input from the beginning of the
57084 *   request.
57085 * @param string $encoding The expected encoding.
57086 * @return bool
57087 * @since PHP 4 >= 4.4.3, PHP 5 >= 5.1.3, PHP 7
57088 **/
57089function mb_check_encoding($var, $encoding){}
57090
57091/**
57092 * Get a specific character
57093 *
57094 * @param int $cp
57095 * @param string $encoding
57096 * @return string Returns a specific character.
57097 * @since PHP 7 >= 7.2.0
57098 **/
57099function mb_chr($cp, $encoding){}
57100
57101/**
57102 * Perform case folding on a string
57103 *
57104 * Performs case folding on a string, converted in the way specified by
57105 * {@link mode}.
57106 *
57107 * @param string $str The string being converted.
57108 * @param int $mode The mode of the conversion. It can be one of
57109 *   MB_CASE_UPPER, MB_CASE_LOWER, MB_CASE_TITLE, MB_CASE_FOLD,
57110 *   MB_CASE_UPPER_SIMPLE, MB_CASE_LOWER_SIMPLE, MB_CASE_TITLE_SIMPLE,
57111 *   MB_CASE_FOLD_SIMPLE.
57112 * @param string $encoding
57113 * @return string A case folded version of {@link string} converted in
57114 *   the way specified by {@link mode}.
57115 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
57116 **/
57117function mb_convert_case($str, $mode, $encoding){}
57118
57119/**
57120 * Convert character encoding
57121 *
57122 * Converts the character encoding of {@link val} to {@link to_encoding}
57123 * from optionally {@link from_encoding}. If {@link val} is an , all its
57124 * values will be converted recursively.
57125 *
57126 * @param mixed $val The or being encoded.
57127 * @param string $to_encoding The type of encoding that {@link val} is
57128 *   being converted to.
57129 * @param mixed $from_encoding Is specified by character code names
57130 *   before conversion. It is either an array, or a comma separated
57131 *   enumerated list. If {@link from_encoding} is not specified, the
57132 *   internal encoding will be used. See supported encodings.
57133 * @return mixed The encoded or .
57134 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57135 **/
57136function mb_convert_encoding($val, $to_encoding, $from_encoding){}
57137
57138/**
57139 * Convert "kana" one from another ("zen-kaku", "han-kaku" and more)
57140 *
57141 * Performs a "han-kaku" - "zen-kaku" conversion for string {@link str}.
57142 * This function is only useful for Japanese.
57143 *
57144 * @param string $str The string being converted.
57145 * @param string $option The conversion option. Specify with a
57146 *   combination of following options. Applicable Conversion Options
57147 *   Option Meaning r Convert "zen-kaku" alphabets to "han-kaku" R
57148 *   Convert "han-kaku" alphabets to "zen-kaku" n Convert "zen-kaku"
57149 *   numbers to "han-kaku" N Convert "han-kaku" numbers to "zen-kaku" a
57150 *   Convert "zen-kaku" alphabets and numbers to "han-kaku" A Convert
57151 *   "han-kaku" alphabets and numbers to "zen-kaku" (Characters included
57152 *   in "a", "A" options are U+0021 - U+007E excluding U+0022, U+0027,
57153 *   U+005C, U+007E) s Convert "zen-kaku" space to "han-kaku" (U+3000 ->
57154 *   U+0020) S Convert "han-kaku" space to "zen-kaku" (U+0020 -> U+3000)
57155 *   k Convert "zen-kaku kata-kana" to "han-kaku kata-kana" K Convert
57156 *   "han-kaku kata-kana" to "zen-kaku kata-kana" h Convert "zen-kaku
57157 *   hira-gana" to "han-kaku kata-kana" H Convert "han-kaku kata-kana" to
57158 *   "zen-kaku hira-gana" c Convert "zen-kaku kata-kana" to "zen-kaku
57159 *   hira-gana" C Convert "zen-kaku hira-gana" to "zen-kaku kata-kana" V
57160 *   Collapse voiced sound notation and convert them into a character.
57161 *   Use with "K","H"
57162 * @param string $encoding
57163 * @return string The converted string.
57164 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57165 **/
57166function mb_convert_kana($str, $option, $encoding){}
57167
57168/**
57169 * Convert character code in variable(s)
57170 *
57171 * Converts character encoding of variables {@link vars} in encoding
57172 * {@link from_encoding} to encoding {@link to_encoding}.
57173 *
57174 * {@link mb_convert_variables} join strings in Array or Object to detect
57175 * encoding, since encoding detection tends to fail for short strings.
57176 * Therefore, it is impossible to mix encoding in single array or object.
57177 *
57178 * @param string $to_encoding The encoding that the string is being
57179 *   converted to.
57180 * @param mixed $from_encoding {@link from_encoding} is specified as an
57181 *   array or comma separated string, it tries to detect encoding from
57182 *   {@link from-coding}. When {@link from_encoding} is omitted,
57183 *   detect_order is used.
57184 * @param mixed $vars {@link vars} is the reference to the variable
57185 *   being converted. String, Array and Object are accepted. {@link
57186 *   mb_convert_variables} assumes all parameters have the same encoding.
57187 * @param mixed ...$vararg Additional {@link vars}.
57188 * @return string The character encoding before conversion for success,
57189 *   or FALSE for failure.
57190 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57191 **/
57192function mb_convert_variables($to_encoding, $from_encoding, &$vars, &...$vararg){}
57193
57194/**
57195 * Decode string in MIME header field
57196 *
57197 * Decodes encoded-word string {@link str} in MIME header.
57198 *
57199 * @param string $str The string being decoded.
57200 * @return string The decoded string in internal character encoding.
57201 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57202 **/
57203function mb_decode_mimeheader($str){}
57204
57205/**
57206 * Decode HTML numeric string reference to character
57207 *
57208 * Convert numeric string reference of string {@link str} in a specified
57209 * block to character.
57210 *
57211 * @param string $str The string being decoded.
57212 * @param array $convmap {@link convmap} is an array that specifies the
57213 *   code area to convert.
57214 * @param string $encoding
57215 * @param bool $is_hex This parameter is not used.
57216 * @return string The converted string.
57217 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57218 **/
57219function mb_decode_numericentity($str, $convmap, $encoding, $is_hex){}
57220
57221/**
57222 * Detect character encoding
57223 *
57224 * Detects character encoding in string {@link str}.
57225 *
57226 * @param string $str The string being detected.
57227 * @param mixed $encoding_list {@link encoding_list} is list of
57228 *   character encoding. Encoding order may be specified by array or
57229 *   comma separated list string. If {@link encoding_list} is omitted,
57230 *   detect_order is used.
57231 * @param bool $strict {@link strict} specifies whether to use the
57232 *   strict encoding detection or not. Default is FALSE.
57233 * @return string The detected character encoding or FALSE if the
57234 *   encoding cannot be detected from the given string.
57235 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57236 **/
57237function mb_detect_encoding($str, $encoding_list, $strict){}
57238
57239/**
57240 * Set/Get character encoding detection order
57241 *
57242 * Sets the automatic character encoding detection order to {@link
57243 * encoding_list}.
57244 *
57245 * @param mixed $encoding_list {@link encoding_list} is an array or
57246 *   comma separated list of character encoding. See supported encodings.
57247 *   If {@link encoding_list} is omitted, it returns the current
57248 *   character encoding detection order as array. This setting affects
57249 *   {@link mb_detect_encoding} and {@link mb_send_mail}. mbstring
57250 *   currently implements the following encoding detection filters. If
57251 *   there is an invalid byte sequence for the following encodings,
57252 *   encoding detection will fail. For ISO-8859-*, mbstring always
57253 *   detects as ISO-8859-*. For UTF-16, UTF-32, UCS2 and UCS4, encoding
57254 *   detection will fail always.
57255 * @return mixed When setting the encoding detection order, TRUE is
57256 *   returned on success or FALSE on failure.
57257 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57258 **/
57259function mb_detect_order($encoding_list){}
57260
57261/**
57262 * Encode string for MIME header
57263 *
57264 * Encodes a given string {@link str} by the MIME header encoding scheme.
57265 *
57266 * @param string $str The string being encoded. Its encoding should be
57267 *   same as {@link mb_internal_encoding}.
57268 * @param string $charset {@link charset} specifies the name of the
57269 *   character set in which {@link str} is represented in. The default
57270 *   value is determined by the current NLS setting (mbstring.language).
57271 * @param string $transfer_encoding {@link transfer_encoding} specifies
57272 *   the scheme of MIME encoding. It should be either "B" (Base64) or "Q"
57273 *   (Quoted-Printable). Falls back to "B" if not given.
57274 * @param string $linefeed {@link linefeed} specifies the EOL
57275 *   (end-of-line) marker with which {@link mb_encode_mimeheader}
57276 *   performs line-folding (a RFC term, the act of breaking a line longer
57277 *   than a certain length into multiple lines. The length is currently
57278 *   hard-coded to 74 characters). Falls back to "\r\n" (CRLF) if not
57279 *   given.
57280 * @param int $indent Indentation of the first line (number of
57281 *   characters in the header before {@link str}).
57282 * @return string A converted version of the string represented in
57283 *   ASCII.
57284 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57285 **/
57286function mb_encode_mimeheader($str, $charset, $transfer_encoding, $linefeed, $indent){}
57287
57288/**
57289 * Encode character to HTML numeric string reference
57290 *
57291 * Converts specified character codes in string {@link str} from
57292 * character code to HTML numeric character reference.
57293 *
57294 * @param string $str The string being encoded.
57295 * @param array $convmap {@link convmap} is array specifies code area
57296 *   to convert.
57297 * @param string $encoding
57298 * @param bool $is_hex Whether the returned entity reference should be
57299 *   in hexadecimal notation (otherwise it is in decimal notation).
57300 * @return string The converted string.
57301 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57302 **/
57303function mb_encode_numericentity($str, $convmap, $encoding, $is_hex){}
57304
57305/**
57306 * Get aliases of a known encoding type
57307 *
57308 * Returns an array of aliases for a known {@link encoding} type.
57309 *
57310 * @param string $encoding The encoding type being checked, for
57311 *   aliases.
57312 * @return array Returns a numerically indexed array of encoding
57313 *   aliases on success,
57314 * @since PHP 5 >= 5.3.0, PHP 7
57315 **/
57316function mb_encoding_aliases($encoding){}
57317
57318/**
57319 * Regular expression match with multibyte support
57320 *
57321 * @param string $pattern The search pattern.
57322 * @param string $string The search string.
57323 * @param array $regs If matches are found for parenthesized substrings
57324 *   of {@link pattern} and the function is called with the third
57325 *   argument {@link regs}, the matches will be stored in the elements of
57326 *   the array {@link regs}. If no matches are found, {@link regs} is set
57327 *   to an empty array. $regs[1] will contain the substring which starts
57328 *   at the first left parenthesis; $regs[2] will contain the substring
57329 *   starting at the second, and so on. $regs[0] will contain a copy of
57330 *   the complete string matched.
57331 * @return int Returns the byte length of the matched string if a match
57332 *   for {@link pattern} was found in {@link string}, or FALSE if no
57333 *   matches were found or an error occurred.
57334 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
57335 **/
57336function mb_ereg($pattern, $string, &$regs){}
57337
57338/**
57339 * Regular expression match ignoring case with multibyte support
57340 *
57341 * @param string $pattern The regular expression pattern.
57342 * @param string $string The string being searched.
57343 * @param array $regs If matches are found for parenthesized substrings
57344 *   of {@link pattern} and the function is called with the third
57345 *   argument {@link regs}, the matches will be stored in the elements of
57346 *   the array {@link regs}. If no matches are found, {@link regs} is set
57347 *   to an empty array. $regs[1] will contain the substring which starts
57348 *   at the first left parenthesis; $regs[2] will contain the substring
57349 *   starting at the second, and so on. $regs[0] will contain a copy of
57350 *   the complete string matched.
57351 * @return int Returns the byte length of the matched string if a match
57352 *   for {@link pattern} was found in {@link string}, or FALSE if no
57353 *   matches were found or an error occurred.
57354 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
57355 **/
57356function mb_eregi($pattern, $string, &$regs){}
57357
57358/**
57359 * Replace regular expression with multibyte support ignoring case
57360 *
57361 * @param string $pattern The regular expression pattern. Multibyte
57362 *   characters may be used. The case will be ignored.
57363 * @param string $replace The replacement text.
57364 * @param string $string The searched string.
57365 * @param string $option
57366 * @return string The resultant string or FALSE on error.
57367 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
57368 **/
57369function mb_eregi_replace($pattern, $replace, $string, $option){}
57370
57371/**
57372 * Regular expression match for multibyte string
57373 *
57374 * A regular expression match for a multibyte string
57375 *
57376 * @param string $pattern The regular expression pattern.
57377 * @param string $string The string being evaluated.
57378 * @param string $option The search option. See {@link
57379 *   mb_regex_set_options} for explanation.
57380 * @return bool
57381 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
57382 **/
57383function mb_ereg_match($pattern, $string, $option){}
57384
57385/**
57386 * Replace regular expression with multibyte support
57387 *
57388 * @param string $pattern The regular expression pattern. Multibyte
57389 *   characters may be used in {@link pattern}.
57390 * @param string $replacement The replacement text.
57391 * @param string $string The string being checked.
57392 * @param string $option
57393 * @return string The resultant string on success, or FALSE on error.
57394 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
57395 **/
57396function mb_ereg_replace($pattern, $replacement, $string, $option){}
57397
57398/**
57399 * Perform a regular expression search and replace with multibyte support
57400 * using a callback
57401 *
57402 * Scans {@link string} for matches to {@link pattern}, then replaces the
57403 * matched text with the output of {@link callback} function.
57404 *
57405 * The behavior of this function is almost identical to {@link
57406 * mb_ereg_replace}, except for the fact that instead of {@link
57407 * replacement} parameter, one should specify a {@link callback}.
57408 *
57409 * @param string $pattern The regular expression pattern. Multibyte
57410 *   characters may be used in {@link pattern}.
57411 * @param callable $callback A callback that will be called and passed
57412 *   an array of matched elements in the {@link subject} string. The
57413 *   callback should return the replacement string. You'll often need the
57414 *   {@link callback} function for a {@link mb_ereg_replace_callback} in
57415 *   just one place. In this case you can use an anonymous function to
57416 *   declare the callback within the call to {@link
57417 *   mb_ereg_replace_callback}. By doing it this way you have all
57418 *   information for the call in one place and do not clutter the
57419 *   function namespace with a callback function's name not used anywhere
57420 *   else.
57421 * @param string $string The string being checked.
57422 * @param string $option The search option. See {@link
57423 *   mb_regex_set_options} for explanation.
57424 * @return string The resultant string on success, or FALSE on error.
57425 * @since PHP 5 >= 5.4.1, PHP 7
57426 **/
57427function mb_ereg_replace_callback($pattern, $callback, $string, $option){}
57428
57429/**
57430 * Multibyte regular expression match for predefined multibyte string
57431 *
57432 * Performs a multibyte regular expression match for a predefined
57433 * multibyte string.
57434 *
57435 * @param string $pattern The search pattern.
57436 * @param string $option The search option. See {@link
57437 *   mb_regex_set_options} for explanation.
57438 * @return bool
57439 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
57440 **/
57441function mb_ereg_search($pattern, $option){}
57442
57443/**
57444 * Returns start point for next regular expression match
57445 *
57446 * @return int
57447 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
57448 **/
57449function mb_ereg_search_getpos(){}
57450
57451/**
57452 * Retrieve the result from the last multibyte regular expression match
57453 *
57454 * @return array
57455 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
57456 **/
57457function mb_ereg_search_getregs(){}
57458
57459/**
57460 * Setup string and regular expression for a multibyte regular expression
57461 * match
57462 *
57463 * {@link mb_ereg_search_init} sets {@link string} and {@link pattern}
57464 * for a multibyte regular expression. These values are used for {@link
57465 * mb_ereg_search}, {@link mb_ereg_search_pos}, and {@link
57466 * mb_ereg_search_regs}.
57467 *
57468 * @param string $string The search string.
57469 * @param string $pattern The search pattern.
57470 * @param string $option The search option. See {@link
57471 *   mb_regex_set_options} for explanation.
57472 * @return bool
57473 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
57474 **/
57475function mb_ereg_search_init($string, $pattern, $option){}
57476
57477/**
57478 * Returns position and length of a matched part of the multibyte regular
57479 * expression for a predefined multibyte string
57480 *
57481 * Returns position and length of a matched part of the multibyte regular
57482 * expression for a predefined multibyte string
57483 *
57484 * The string for match is specified by {@link mb_ereg_search_init}. If
57485 * it is not specified, the previous one will be used.
57486 *
57487 * @param string $pattern The search pattern.
57488 * @param string $option The search option. See {@link
57489 *   mb_regex_set_options} for explanation.
57490 * @return array
57491 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
57492 **/
57493function mb_ereg_search_pos($pattern, $option){}
57494
57495/**
57496 * Returns the matched part of a multibyte regular expression
57497 *
57498 * @param string $pattern The search pattern.
57499 * @param string $option The search option. See {@link
57500 *   mb_regex_set_options} for explanation.
57501 * @return array
57502 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
57503 **/
57504function mb_ereg_search_regs($pattern, $option){}
57505
57506/**
57507 * Set start point of next regular expression match
57508 *
57509 * @param int $position The position to set. If it is negative, it
57510 *   counts from the end of the string.
57511 * @return bool
57512 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
57513 **/
57514function mb_ereg_search_setpos($position){}
57515
57516/**
57517 * Get internal settings of mbstring
57518 *
57519 * @param string $type If {@link type} isn't specified or is specified
57520 *   to "all", an array having the elements "internal_encoding",
57521 *   "http_output", "http_input", "func_overload", "mail_charset",
57522 *   "mail_header_encoding", "mail_body_encoding" will be returned. If
57523 *   {@link type} is specified as "http_output", "http_input",
57524 *   "internal_encoding", "func_overload", the specified setting
57525 *   parameter will be returned.
57526 * @return mixed An array of type information if {@link type} is not
57527 *   specified, otherwise a specific {@link type}.
57528 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
57529 **/
57530function mb_get_info($type){}
57531
57532/**
57533 * Detect HTTP input character encoding
57534 *
57535 * @param string $type Input string specifies the input type. "G" for
57536 *   GET, "P" for POST, "C" for COOKIE, "S" for string, "L" for list, and
57537 *   "I" for the whole list (will return array). If type is omitted, it
57538 *   returns the last input type processed.
57539 * @return mixed The character encoding name, as per the {@link type}.
57540 *   If {@link mb_http_input} does not process specified HTTP input, it
57541 *   returns FALSE.
57542 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57543 **/
57544function mb_http_input($type){}
57545
57546/**
57547 * Set/Get HTTP output character encoding
57548 *
57549 * Set/Get the HTTP output character encoding. Output after this function
57550 * is called will be converted from the set internal encoding to {@link
57551 * encoding}.
57552 *
57553 * @param string $encoding If {@link encoding} is set, {@link
57554 *   mb_http_output} sets the HTTP output character encoding to {@link
57555 *   encoding}. If {@link encoding} is omitted, {@link mb_http_output}
57556 *   returns the current HTTP output character encoding.
57557 * @return mixed If {@link encoding} is omitted, {@link mb_http_output}
57558 *   returns the current HTTP output character encoding. Otherwise,
57559 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57560 **/
57561function mb_http_output($encoding){}
57562
57563/**
57564 * Set/Get internal character encoding
57565 *
57566 * Set/Get the internal character encoding
57567 *
57568 * @param string $encoding {@link encoding} is the character encoding
57569 *   name used for the HTTP input character encoding conversion, HTTP
57570 *   output character encoding conversion, and the default character
57571 *   encoding for string functions defined by the mbstring module. You
57572 *   should notice that the internal encoding is totally different from
57573 *   the one for multibyte regex.
57574 * @return mixed If {@link encoding} is set, then In this case, the
57575 *   character encoding for multibyte regex is NOT changed. If {@link
57576 *   encoding} is omitted, then the current character encoding name is
57577 *   returned.
57578 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57579 **/
57580function mb_internal_encoding($encoding){}
57581
57582/**
57583 * Set/Get current language
57584 *
57585 * Set/Get the current language.
57586 *
57587 * @param string $language Used for encoding e-mail messages. The valid
57588 *   languages are listed in the following table. {@link mb_send_mail}
57589 *   uses this setting to encode e-mail.
57590 * @return bool If {@link language} is set and {@link language} is
57591 *   valid, it returns TRUE. Otherwise, it returns FALSE. When {@link
57592 *   language} is omitted, it returns the language name as a string.
57593 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57594 **/
57595function mb_language($language){}
57596
57597/**
57598 * Returns an array of all supported encodings
57599 *
57600 * Returns an array containing all supported encodings.
57601 *
57602 * @return array Returns a numerically indexed array.
57603 * @since PHP 5, PHP 7
57604 **/
57605function mb_list_encodings(){}
57606
57607/**
57608 * Get code point of character
57609 *
57610 * @param string $str
57611 * @param string $encoding
57612 * @return int Returns a code point of character.
57613 * @since PHP 7 >= 7.2.0
57614 **/
57615function mb_ord($str, $encoding){}
57616
57617/**
57618 * Callback function converts character encoding in output buffer
57619 *
57620 * {@link mb_output_handler} is {@link ob_start} callback function.
57621 * {@link mb_output_handler} converts characters in the output buffer
57622 * from internal character encoding to HTTP output character encoding.
57623 *
57624 * @param string $contents The contents of the output buffer.
57625 * @param int $status The status of the output buffer.
57626 * @return string The converted string.
57627 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57628 **/
57629function mb_output_handler($contents, $status){}
57630
57631/**
57632 * Parse GET/POST/COOKIE data and set global variable
57633 *
57634 * Parses GET/POST/COOKIE data and sets global variables. Since PHP does
57635 * not provide raw POST/COOKIE data, it can only be used for GET data for
57636 * now. It parses URL encoded data, detects encoding, converts coding to
57637 * internal encoding and set values to the {@link result} array or global
57638 * variables.
57639 *
57640 * @param string $encoded_string The URL encoded data.
57641 * @param array $result An array containing decoded and character
57642 *   encoded converted values.
57643 * @return bool
57644 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57645 **/
57646function mb_parse_str($encoded_string, &$result){}
57647
57648/**
57649 * Get MIME charset string
57650 *
57651 * Get a MIME charset string for a specific encoding.
57652 *
57653 * @param string $encoding The encoding being checked.
57654 * @return string The MIME charset string for character encoding {@link
57655 *   encoding}.
57656 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57657 **/
57658function mb_preferred_mime_name($encoding){}
57659
57660/**
57661 * Set/Get character encoding for multibyte regex
57662 *
57663 * Set/Get character encoding for a multibyte regex.
57664 *
57665 * @param string $encoding
57666 * @return mixed
57667 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
57668 **/
57669function mb_regex_encoding($encoding){}
57670
57671/**
57672 * Set/Get the default options for mbregex functions
57673 *
57674 * @param string $options The options to set. This is a string where
57675 *   each character is an option. To set a mode, the mode character must
57676 *   be the last one set, however there can only be set one mode but
57677 *   multiple options.
57678 * @return string The string that describes the current options is
57679 *   returned.
57680 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
57681 **/
57682function mb_regex_set_options($options){}
57683
57684/**
57685 * @param string $str
57686 * @param string $encoding
57687 * @return string
57688 * @since PHP 7 >= 7.2.0
57689 **/
57690function mb_scrub($str, $encoding){}
57691
57692/**
57693 * Send encoded mail
57694 *
57695 * Sends email. Headers and messages are converted and encoded according
57696 * to the {@link mb_language} setting. It's a wrapper function for {@link
57697 * mail}, so see also {@link mail} for details.
57698 *
57699 * @param string $to The mail addresses being sent to. Multiple
57700 *   recipients may be specified by putting a comma between each address
57701 *   in {@link to}. This parameter is not automatically encoded.
57702 * @param string $subject The subject of the mail.
57703 * @param string $message The message of the mail.
57704 * @param mixed $additional_headers String or array to be inserted at
57705 *   the end of the email header. This is typically used to add extra
57706 *   headers (From, Cc, and Bcc). Multiple extra headers should be
57707 *   separated with a CRLF (\r\n). Validate parameter not to be injected
57708 *   unwanted headers by attackers. If an array is passed, its keys are
57709 *   the header names and its values are the respective header values.
57710 * @param string $additional_parameter {@link additional_parameter} is
57711 *   a MTA command line parameter. It is useful when setting the correct
57712 *   Return-Path header when using sendmail. This parameter is escaped by
57713 *   {@link escapeshellcmd} internally to prevent command execution.
57714 *   {@link escapeshellcmd} prevents command execution, but allows to add
57715 *   additional parameters. For security reason, this parameter should be
57716 *   validated. Since {@link escapeshellcmd} is applied automatically,
57717 *   some characters that are allowed as email addresses by internet RFCs
57718 *   cannot be used. Programs that are required to use these characters
57719 *   {@link mail} cannot be used. The user that the webserver runs as
57720 *   should be added as a trusted user to the sendmail configuration to
57721 *   prevent a 'X-Warning' header from being added to the message when
57722 *   the envelope sender (-f) is set using this method. For sendmail
57723 *   users, this file is /etc/mail/trusted-users.
57724 * @return bool
57725 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57726 **/
57727function mb_send_mail($to, $subject, $message, $additional_headers, $additional_parameter){}
57728
57729/**
57730 * Split multibyte string using regular expression
57731 *
57732 * @param string $pattern The regular expression pattern.
57733 * @param string $string The string being split.
57734 * @param int $limit
57735 * @return array The result as an array, .
57736 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
57737 **/
57738function mb_split($pattern, $string, $limit){}
57739
57740/**
57741 * Get part of string
57742 *
57743 * {@link mb_strcut} extracts a substring from a string similarly to
57744 * {@link mb_substr}, but operates on bytes instead of characters. If the
57745 * cut position happens to be between two bytes of a multi-byte
57746 * character, the cut is performed starting from the first byte of that
57747 * character. This is also the difference to the {@link substr} function,
57748 * which would simply cut the string between the bytes and thus result in
57749 * a malformed byte sequence.
57750 *
57751 * @param string $str The string being cut.
57752 * @param int $start If {@link start} is non-negative, the returned
57753 *   string will start at the {@link start}'th byte position in {@link
57754 *   str}, counting from zero. For instance, in the string 'abcdef', the
57755 *   byte at position 0 is 'a', the byte at position 2 is 'c', and so
57756 *   forth. If {@link start} is negative, the returned string will start
57757 *   at the {@link start}'th byte counting back from the end of {@link
57758 *   str}. However, if the magnitude of a negative {@link start} is
57759 *   greater than the length of the string, the returned portion will
57760 *   start from the beginning of {@link str}.
57761 * @param int $length Length in bytes. If omitted or NULL is passed,
57762 *   extract all bytes to the end of the string. If {@link length} is
57763 *   negative, the returned string will end at the {@link length}'th byte
57764 *   counting back from the end of {@link str}. However, if the magnitude
57765 *   of a negative {@link length} is greater than the number of
57766 *   characters after the {@link start} position, an empty string will be
57767 *   returned.
57768 * @param string $encoding
57769 * @return string {@link mb_strcut} returns the portion of {@link str}
57770 *   specified by the {@link start} and {@link length} parameters.
57771 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57772 **/
57773function mb_strcut($str, $start, $length, $encoding){}
57774
57775/**
57776 * Get truncated string with specified width
57777 *
57778 * Truncates string {@link str} to specified {@link width}.
57779 *
57780 * @param string $str The string being decoded.
57781 * @param int $start The start position offset. Number of characters
57782 *   from the beginning of string (first character is 0), or if start is
57783 *   negative, number of characters from the end of the string.
57784 * @param int $width The width of the desired trim. Negative widths
57785 *   count from the end of the string.
57786 * @param string $trimmarker A string that is added to the end of
57787 *   string when string is truncated.
57788 * @param string $encoding
57789 * @return string The truncated string. If {@link trimmarker} is set,
57790 *   {@link trimmarker} replaces the last chars to match the {@link
57791 *   width}.
57792 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57793 **/
57794function mb_strimwidth($str, $start, $width, $trimmarker, $encoding){}
57795
57796/**
57797 * Finds position of first occurrence of a string within another, case
57798 * insensitive
57799 *
57800 * {@link mb_stripos} returns the numeric position of the first
57801 * occurrence of {@link needle} in the {@link haystack} string. Unlike
57802 * {@link mb_strpos}, {@link mb_stripos} is case-insensitive. If {@link
57803 * needle} is not found, it returns FALSE.
57804 *
57805 * @param string $haystack The string from which to get the position of
57806 *   the first occurrence of {@link needle}
57807 * @param string $needle The string to find in {@link haystack}
57808 * @param int $offset The position in {@link haystack} to start
57809 *   searching. A negative offset counts from the end of the string.
57810 * @param string $encoding Character encoding name to use. If it is
57811 *   omitted, internal character encoding is used.
57812 * @return int Return the numeric position of the first occurrence of
57813 *   {@link needle} in the {@link haystack} string, or FALSE if {@link
57814 *   needle} is not found.
57815 * @since PHP 5 >= 5.2.0, PHP 7
57816 **/
57817function mb_stripos($haystack, $needle, $offset, $encoding){}
57818
57819/**
57820 * Finds first occurrence of a string within another, case insensitive
57821 *
57822 * {@link mb_stristr} finds the first occurrence of {@link needle} in
57823 * {@link haystack} and returns the portion of {@link haystack}. Unlike
57824 * {@link mb_strstr}, {@link mb_stristr} is case-insensitive. If {@link
57825 * needle} is not found, it returns FALSE.
57826 *
57827 * @param string $haystack The string from which to get the first
57828 *   occurrence of {@link needle}
57829 * @param string $needle The string to find in {@link haystack}
57830 * @param bool $before_needle Determines which portion of {@link
57831 *   haystack} this function returns. If set to TRUE, it returns all of
57832 *   {@link haystack} from the beginning to the first occurrence of
57833 *   {@link needle} (excluding needle). If set to FALSE, it returns all
57834 *   of {@link haystack} from the first occurrence of {@link needle} to
57835 *   the end (including needle).
57836 * @param string $encoding Character encoding name to use. If it is
57837 *   omitted, internal character encoding is used.
57838 * @return string Returns the portion of {@link haystack}, or FALSE if
57839 *   {@link needle} is not found.
57840 * @since PHP 5 >= 5.2.0, PHP 7
57841 **/
57842function mb_stristr($haystack, $needle, $before_needle, $encoding){}
57843
57844/**
57845 * Get string length
57846 *
57847 * Gets the length of a string.
57848 *
57849 * @param string $str The string being checked for length.
57850 * @param string $encoding
57851 * @return int Returns the number of characters in string {@link str}
57852 *   having character encoding {@link encoding}. A multi-byte character
57853 *   is counted as 1.
57854 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57855 **/
57856function mb_strlen($str, $encoding){}
57857
57858/**
57859 * Find position of first occurrence of string in a string
57860 *
57861 * Finds position of the first occurrence of a string in a string.
57862 *
57863 * Performs a multi-byte safe {@link strpos} operation based on number of
57864 * characters. The first character's position is 0, the second character
57865 * position is 1, and so on.
57866 *
57867 * @param string $haystack The string being checked.
57868 * @param string $needle The string to find in {@link haystack}. In
57869 *   contrast with {@link strpos}, numeric values are not applied as the
57870 *   ordinal value of a character.
57871 * @param int $offset The search offset. If it is not specified, 0 is
57872 *   used. A negative offset counts from the end of the string.
57873 * @param string $encoding
57874 * @return int Returns the numeric position of the first occurrence of
57875 *   {@link needle} in the {@link haystack} string. If {@link needle} is
57876 *   not found, it returns FALSE.
57877 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57878 **/
57879function mb_strpos($haystack, $needle, $offset, $encoding){}
57880
57881/**
57882 * Finds the last occurrence of a character in a string within another
57883 *
57884 * {@link mb_strrchr} finds the last occurrence of {@link needle} in
57885 * {@link haystack} and returns the portion of {@link haystack}. If
57886 * {@link needle} is not found, it returns FALSE.
57887 *
57888 * @param string $haystack The string from which to get the last
57889 *   occurrence of {@link needle}
57890 * @param string $needle The string to find in {@link haystack}
57891 * @param bool $part Determines which portion of {@link haystack} this
57892 *   function returns. If set to TRUE, it returns all of {@link haystack}
57893 *   from the beginning to the last occurrence of {@link needle}. If set
57894 *   to FALSE, it returns all of {@link haystack} from the last
57895 *   occurrence of {@link needle} to the end,
57896 * @param string $encoding Character encoding name to use. If it is
57897 *   omitted, internal character encoding is used.
57898 * @return string Returns the portion of {@link haystack}. or FALSE if
57899 *   {@link needle} is not found.
57900 * @since PHP 5 >= 5.2.0, PHP 7
57901 **/
57902function mb_strrchr($haystack, $needle, $part, $encoding){}
57903
57904/**
57905 * Finds the last occurrence of a character in a string within another,
57906 * case insensitive
57907 *
57908 * {@link mb_strrichr} finds the last occurrence of {@link needle} in
57909 * {@link haystack} and returns the portion of {@link haystack}. Unlike
57910 * {@link mb_strrchr}, {@link mb_strrichr} is case-insensitive. If {@link
57911 * needle} is not found, it returns FALSE.
57912 *
57913 * @param string $haystack The string from which to get the last
57914 *   occurrence of {@link needle}
57915 * @param string $needle The string to find in {@link haystack}
57916 * @param bool $part Determines which portion of {@link haystack} this
57917 *   function returns. If set to TRUE, it returns all of {@link haystack}
57918 *   from the beginning to the last occurrence of {@link needle}. If set
57919 *   to FALSE, it returns all of {@link haystack} from the last
57920 *   occurrence of {@link needle} to the end,
57921 * @param string $encoding Character encoding name to use. If it is
57922 *   omitted, internal character encoding is used.
57923 * @return string Returns the portion of {@link haystack}. or FALSE if
57924 *   {@link needle} is not found.
57925 * @since PHP 5 >= 5.2.0, PHP 7
57926 **/
57927function mb_strrichr($haystack, $needle, $part, $encoding){}
57928
57929/**
57930 * Finds position of last occurrence of a string within another, case
57931 * insensitive
57932 *
57933 * {@link mb_strripos} performs multi-byte safe {@link strripos}
57934 * operation based on number of characters. {@link needle} position is
57935 * counted from the beginning of {@link haystack}. First character's
57936 * position is 0. Second character position is 1. Unlike {@link
57937 * mb_strrpos}, {@link mb_strripos} is case-insensitive.
57938 *
57939 * @param string $haystack The string from which to get the position of
57940 *   the last occurrence of {@link needle}
57941 * @param string $needle The string to find in {@link haystack}
57942 * @param int $offset The position in {@link haystack} to start
57943 *   searching
57944 * @param string $encoding Character encoding name to use. If it is
57945 *   omitted, internal character encoding is used.
57946 * @return int Return the numeric position of the last occurrence of
57947 *   {@link needle} in the {@link haystack} string, or FALSE if {@link
57948 *   needle} is not found.
57949 * @since PHP 5 >= 5.2.0, PHP 7
57950 **/
57951function mb_strripos($haystack, $needle, $offset, $encoding){}
57952
57953/**
57954 * Find position of last occurrence of a string in a string
57955 *
57956 * Performs a multibyte safe {@link strrpos} operation based on the
57957 * number of characters. {@link needle} position is counted from the
57958 * beginning of {@link haystack}. First character's position is 0. Second
57959 * character position is 1.
57960 *
57961 * @param string $haystack The string being checked, for the last
57962 *   occurrence of {@link needle}
57963 * @param string $needle The string to find in {@link haystack}.
57964 * @param int $offset
57965 * @param string $encoding
57966 * @return int Returns the numeric position of the last occurrence of
57967 *   {@link needle} in the {@link haystack} string. If {@link needle} is
57968 *   not found, it returns FALSE.
57969 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
57970 **/
57971function mb_strrpos($haystack, $needle, $offset, $encoding){}
57972
57973/**
57974 * Finds first occurrence of a string within another
57975 *
57976 * {@link mb_strstr} finds the first occurrence of {@link needle} in
57977 * {@link haystack} and returns the portion of {@link haystack}. If
57978 * {@link needle} is not found, it returns FALSE.
57979 *
57980 * @param string $haystack The string from which to get the first
57981 *   occurrence of {@link needle}
57982 * @param string $needle The string to find in {@link haystack}
57983 * @param bool $before_needle Determines which portion of {@link
57984 *   haystack} this function returns. If set to TRUE, it returns all of
57985 *   {@link haystack} from the beginning to the first occurrence of
57986 *   {@link needle} (excluding needle). If set to FALSE, it returns all
57987 *   of {@link haystack} from the first occurrence of {@link needle} to
57988 *   the end (including needle).
57989 * @param string $encoding Character encoding name to use. If it is
57990 *   omitted, internal character encoding is used.
57991 * @return string Returns the portion of {@link haystack}, or FALSE if
57992 *   {@link needle} is not found.
57993 * @since PHP 5 >= 5.2.0, PHP 7
57994 **/
57995function mb_strstr($haystack, $needle, $before_needle, $encoding){}
57996
57997/**
57998 * Make a string lowercase
57999 *
58000 * Returns {@link str} with all alphabetic characters converted to
58001 * lowercase.
58002 *
58003 * @param string $str The string being lowercased.
58004 * @param string $encoding
58005 * @return string {@link str} with all alphabetic characters converted
58006 *   to lowercase.
58007 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
58008 **/
58009function mb_strtolower($str, $encoding){}
58010
58011/**
58012 * Make a string uppercase
58013 *
58014 * Returns {@link str} with all alphabetic characters converted to
58015 * uppercase.
58016 *
58017 * @param string $str The string being uppercased.
58018 * @param string $encoding
58019 * @return string {@link str} with all alphabetic characters converted
58020 *   to uppercase.
58021 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
58022 **/
58023function mb_strtoupper($str, $encoding){}
58024
58025/**
58026 * Return width of string
58027 *
58028 * Returns the width of string {@link str}, where halfwidth characters
58029 * count as 1, and fullwidth characters count as 2.
58030 *
58031 * The fullwidth characters are: U+1100-U+115F, U+11A3-U+11A7,
58032 * U+11FA-U+11FF, U+2329-U+232A, U+2E80-U+2E99, U+2E9B-U+2EF3,
58033 * U+2F00-U+2FD5, U+2FF0-U+2FFB, U+3000-U+303E, U+3041-U+3096,
58034 * U+3099-U+30FF, U+3105-U+312D, U+3131-U+318E, U+3190-U+31BA,
58035 * U+31C0-U+31E3, U+31F0-U+321E, U+3220-U+3247, U+3250-U+32FE,
58036 * U+3300-U+4DBF, U+4E00-U+A48C, U+A490-U+A4C6, U+A960-U+A97C,
58037 * U+AC00-U+D7A3, U+D7B0-U+D7C6, U+D7CB-U+D7FB, U+F900-U+FAFF,
58038 * U+FE10-U+FE19, U+FE30-U+FE52, U+FE54-U+FE66, U+FE68-U+FE6B,
58039 * U+FF01-U+FF60, U+FFE0-U+FFE6, U+1B000-U+1B001, U+1F200-U+1F202,
58040 * U+1F210-U+1F23A, U+1F240-U+1F248, U+1F250-U+1F251, U+20000-U+2FFFD,
58041 * U+30000-U+3FFFD. All other characters are halfwidth characters.
58042 *
58043 * @param string $str The string being decoded.
58044 * @param string $encoding
58045 * @return int The width of string {@link str}.
58046 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
58047 **/
58048function mb_strwidth($str, $encoding){}
58049
58050/**
58051 * Given a multibyte string, return an array of its characters
58052 *
58053 * This function will return an array of strings, it is a version of
58054 * {@link str_split} with support for encodings of variable character
58055 * size as well as fixed-size encodings of 1,2 or 4 byte characters. If
58056 * the {@link split_length} parameter is specified, the string is broken
58057 * down into chunks of the specified length in characters (not bytes).
58058 * The {@link encoding} parameter can be optionally specified and it is
58059 * good practice to do so.
58060 *
58061 * @param string $string The to split into characters or chunks.
58062 * @param int $split_length If specified, each element of the returned
58063 *   array will be composed of multiple characters instead of a single
58064 *   character.
58065 * @param string $encoding A string specifying one of the supported
58066 *   encodings.
58067 * @return array {@link mb_str_split} returns an array of strings, .
58068 * @since PHP 7 >= 7.4.0
58069 **/
58070function mb_str_split($string, $split_length, $encoding){}
58071
58072/**
58073 * Set/Get substitution character
58074 *
58075 * Specifies a substitution character when input character encoding is
58076 * invalid or character code does not exist in output character encoding.
58077 * Invalid characters may be substituted NULL (no output), string or
58078 * integer value (Unicode character code value).
58079 *
58080 * This setting affects {@link mb_convert_encoding}, {@link
58081 * mb_convert_variables}, {@link mb_output_handler}, and {@link
58082 * mb_send_mail}.
58083 *
58084 * @param mixed $substchar Specify the Unicode value as an integer, or
58085 *   as one of the following strings: "none": no output "long": Output
58086 *   character code value (Example: U+3000, JIS+7E7E) "entity": Output
58087 *   character entity (Example: &#x200;)
58088 * @return mixed If {@link substchar} is set, it returns TRUE for
58089 *   success, otherwise returns FALSE. If {@link substchar} is not set,
58090 *   it returns the current setting.
58091 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
58092 **/
58093function mb_substitute_character($substchar){}
58094
58095/**
58096 * Get part of string
58097 *
58098 * Performs a multi-byte safe {@link substr} operation based on number of
58099 * characters. Position is counted from the beginning of {@link str}.
58100 * First character's position is 0. Second character position is 1, and
58101 * so on.
58102 *
58103 * @param string $str The string to extract the substring from.
58104 * @param int $start If {@link start} is non-negative, the returned
58105 *   string will start at the {@link start}'th position in {@link str},
58106 *   counting from zero. For instance, in the string 'abcdef', the
58107 *   character at position 0 is 'a', the character at position 2 is 'c',
58108 *   and so forth. If {@link start} is negative, the returned string will
58109 *   start at the {@link start}'th character from the end of {@link str}.
58110 * @param int $length Maximum number of characters to use from {@link
58111 *   str}. If omitted or NULL is passed, extract all characters to the
58112 *   end of the string.
58113 * @param string $encoding
58114 * @return string {@link mb_substr} returns the portion of {@link str}
58115 *   specified by the {@link start} and {@link length} parameters.
58116 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
58117 **/
58118function mb_substr($str, $start, $length, $encoding){}
58119
58120/**
58121 * Count the number of substring occurrences
58122 *
58123 * Counts the number of times the {@link needle} substring occurs in the
58124 * {@link haystack} string.
58125 *
58126 * @param string $haystack The string being checked.
58127 * @param string $needle The string being found.
58128 * @param string $encoding
58129 * @return int The number of times the {@link needle} substring occurs
58130 *   in the {@link haystack} string.
58131 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
58132 **/
58133function mb_substr_count($haystack, $needle, $encoding){}
58134
58135/**
58136 * Encrypts/decrypts data in CBC mode
58137 *
58138 * The first prototype is when linked against libmcrypt 2.2.x, the second
58139 * when linked against libmcrypt 2.4.x or higher. The {@link mode} should
58140 * be either MCRYPT_ENCRYPT or MCRYPT_DECRYPT.
58141 *
58142 * @param int $cipher
58143 * @param string $key
58144 * @param string $data
58145 * @param int $mode
58146 * @param string $iv
58147 * @return string
58148 * @since PHP 4, PHP 5
58149 **/
58150function mcrypt_cbc($cipher, $key, $data, $mode, $iv){}
58151
58152/**
58153 * Encrypts/decrypts data in CFB mode
58154 *
58155 * The first prototype is when linked against libmcrypt 2.2.x, the second
58156 * when linked against libmcrypt 2.4.x or higher. The {@link mode} should
58157 * be either MCRYPT_ENCRYPT or MCRYPT_DECRYPT.
58158 *
58159 * @param int $cipher
58160 * @param string $key
58161 * @param string $data
58162 * @param int $mode
58163 * @param string $iv
58164 * @return string
58165 * @since PHP 4, PHP 5
58166 **/
58167function mcrypt_cfb($cipher, $key, $data, $mode, $iv){}
58168
58169/**
58170 * Creates an initialization vector (IV) from a random source
58171 *
58172 * The IV is only meant to give an alternative seed to the encryption
58173 * routines. This IV does not need to be secret at all, though it can be
58174 * desirable. You even can send it along with your ciphertext without
58175 * losing security.
58176 *
58177 * @param int $size The size of the IV.
58178 * @param int $source The source of the IV. The source can be
58179 *   MCRYPT_RAND (system random number generator), MCRYPT_DEV_RANDOM
58180 *   (read data from /dev/random) and MCRYPT_DEV_URANDOM (read data from
58181 *   /dev/urandom). Prior to 5.3.0, MCRYPT_RAND was the only one
58182 *   supported on Windows. Note that the default value of this parameter
58183 *   was MCRYPT_DEV_RANDOM prior to PHP 5.6.0.
58184 * @return string Returns the initialization vector, or FALSE on error.
58185 * @since PHP 4, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58186 **/
58187function mcrypt_create_iv($size, $source){}
58188
58189/**
58190 * Decrypts crypttext with given parameters
58191 *
58192 * Decrypts the {@link data} and returns the unencrypted data.
58193 *
58194 * @param string $cipher
58195 * @param string $key The key with which the data was encrypted. If the
58196 *   provided key size is not supported by the cipher, the function will
58197 *   emit a warning and return FALSE
58198 * @param string $data The data that will be decrypted with the given
58199 *   {@link cipher} and {@link mode}. If the size of the data is not n *
58200 *   blocksize, the data will be padded with '\0'.
58201 * @param string $mode
58202 * @param string $iv
58203 * @return string Returns the decrypted data as a string .
58204 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58205 **/
58206function mcrypt_decrypt($cipher, $key, $data, $mode, $iv){}
58207
58208/**
58209 * Deprecated: Encrypts/decrypts data in ECB mode
58210 *
58211 * The first prototype is when linked against libmcrypt 2.2.x, the second
58212 * when linked against libmcrypt 2.4.x or higher. The {@link mode} should
58213 * be either MCRYPT_ENCRYPT or MCRYPT_DECRYPT.
58214 *
58215 * @param int $cipher
58216 * @param string $key
58217 * @param string $data
58218 * @param int $mode
58219 * @return string
58220 * @since PHP 4, PHP 5
58221 **/
58222function mcrypt_ecb($cipher, $key, $data, $mode){}
58223
58224/**
58225 * Encrypts plaintext with given parameters
58226 *
58227 * Encrypts the data and returns it.
58228 *
58229 * @param string $cipher
58230 * @param string $key The key with which the data will be encrypted. If
58231 *   the provided key size is not supported by the cipher, the function
58232 *   will emit a warning and return FALSE
58233 * @param string $data The data that will be encrypted with the given
58234 *   {@link cipher} and {@link mode}. If the size of the data is not n *
58235 *   blocksize, the data will be padded with '\0'. The returned crypttext
58236 *   can be larger than the size of the data that was given by {@link
58237 *   data}.
58238 * @param string $mode
58239 * @param string $iv
58240 * @return string Returns the encrypted data as a string .
58241 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58242 **/
58243function mcrypt_encrypt($cipher, $key, $data, $mode, $iv){}
58244
58245/**
58246 * Returns the name of the opened algorithm
58247 *
58248 * This function returns the name of the algorithm.
58249 *
58250 * @param resource $td The encryption descriptor.
58251 * @return string Returns the name of the opened algorithm as a string.
58252 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58253 **/
58254function mcrypt_enc_get_algorithms_name($td){}
58255
58256/**
58257 * Returns the blocksize of the opened algorithm
58258 *
58259 * Gets the blocksize of the opened algorithm.
58260 *
58261 * @param resource $td The encryption descriptor.
58262 * @return int Returns the block size of the specified algorithm in
58263 *   bytes.
58264 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58265 **/
58266function mcrypt_enc_get_block_size($td){}
58267
58268/**
58269 * Returns the size of the IV of the opened algorithm
58270 *
58271 * This function returns the size of the IV of the algorithm specified by
58272 * the encryption descriptor in bytes. An IV is used in cbc, cfb and ofb
58273 * modes, and in some algorithms in stream mode.
58274 *
58275 * @param resource $td The encryption descriptor.
58276 * @return int Returns the size of the IV, or 0 if the IV is ignored by
58277 *   the algorithm.
58278 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58279 **/
58280function mcrypt_enc_get_iv_size($td){}
58281
58282/**
58283 * Returns the maximum supported keysize of the opened mode
58284 *
58285 * Gets the maximum supported key size of the algorithm in bytes.
58286 *
58287 * @param resource $td The encryption descriptor.
58288 * @return int Returns the maximum supported key size of the algorithm
58289 *   in bytes.
58290 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58291 **/
58292function mcrypt_enc_get_key_size($td){}
58293
58294/**
58295 * Returns the name of the opened mode
58296 *
58297 * This function returns the name of the mode.
58298 *
58299 * @param resource $td The encryption descriptor.
58300 * @return string Returns the name as a string.
58301 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58302 **/
58303function mcrypt_enc_get_modes_name($td){}
58304
58305/**
58306 * Returns an array with the supported keysizes of the opened algorithm
58307 *
58308 * Gets the supported key sizes of the opened algorithm.
58309 *
58310 * @param resource $td The encryption descriptor.
58311 * @return array Returns an array with the key sizes supported by the
58312 *   algorithm specified by the encryption descriptor. If it returns an
58313 *   empty array then all key sizes between 1 and {@link
58314 *   mcrypt_enc_get_key_size} are supported by the algorithm.
58315 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58316 **/
58317function mcrypt_enc_get_supported_key_sizes($td){}
58318
58319/**
58320 * Checks whether the algorithm of the opened mode is a block algorithm
58321 *
58322 * Tells whether the algorithm of the opened mode is a block algorithm.
58323 *
58324 * @param resource $td The encryption descriptor.
58325 * @return bool Returns TRUE if the algorithm is a block algorithm or
58326 *   FALSE if it is a stream one.
58327 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58328 **/
58329function mcrypt_enc_is_block_algorithm($td){}
58330
58331/**
58332 * Checks whether the encryption of the opened mode works on blocks
58333 *
58334 * Tells whether the algorithm of the opened mode works on blocks (e.g.
58335 * FALSE for stream, and TRUE for cbc, cfb, ofb)..
58336 *
58337 * @param resource $td The encryption descriptor.
58338 * @return bool Returns TRUE if the mode is for use with block
58339 *   algorithms, otherwise it returns FALSE.
58340 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58341 **/
58342function mcrypt_enc_is_block_algorithm_mode($td){}
58343
58344/**
58345 * Checks whether the opened mode outputs blocks
58346 *
58347 * Tells whether the opened mode outputs blocks (e.g. TRUE for cbc and
58348 * ecb, and FALSE for cfb and stream).
58349 *
58350 * @param resource $td The encryption descriptor.
58351 * @return bool Returns TRUE if the mode outputs blocks of bytes, or
58352 *   FALSE if it outputs just bytes.
58353 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58354 **/
58355function mcrypt_enc_is_block_mode($td){}
58356
58357/**
58358 * Runs a self test on the opened module
58359 *
58360 * This function runs the self test on the algorithm specified by the
58361 * descriptor {@link td}.
58362 *
58363 * @param resource $td The encryption descriptor.
58364 * @return int Returns 0 on success and a negative on failure.
58365 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58366 **/
58367function mcrypt_enc_self_test($td){}
58368
58369/**
58370 * This function encrypts data
58371 *
58372 * This function encrypts data. The data is padded with "\0" to make sure
58373 * the length of the data is n * blocksize. This function returns the
58374 * encrypted data. Note that the length of the returned string can in
58375 * fact be longer than the input, due to the padding of the data.
58376 *
58377 * If you want to store the encrypted data in a database make sure to
58378 * store the entire string as returned by mcrypt_generic, or the string
58379 * will not entirely decrypt properly. If your original string is 10
58380 * characters long and the block size is 8 (use {@link
58381 * mcrypt_enc_get_block_size} to determine the blocksize), you would need
58382 * at least 16 characters in your database field. Note the string
58383 * returned by {@link mdecrypt_generic} will be 16 characters as
58384 * well...use rtrim($str, "\0") to remove the padding.
58385 *
58386 * If you are for example storing the data in a MySQL database remember
58387 * that varchar fields automatically have trailing spaces removed during
58388 * insertion. As encrypted data can end in a space (ASCII 32), the data
58389 * will be damaged by this removal. Store data in a tinyblob/tinytext (or
58390 * larger) field instead.
58391 *
58392 * @param resource $td The encryption descriptor. The encryption handle
58393 *   should always be initialized with {@link mcrypt_generic_init} with a
58394 *   key and an IV before calling this function. Where the encryption is
58395 *   done, you should free the encryption buffers by calling {@link
58396 *   mcrypt_generic_deinit}. See {@link mcrypt_module_open} for an
58397 *   example.
58398 * @param string $data The data to encrypt.
58399 * @return string Returns the encrypted data.
58400 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58401 **/
58402function mcrypt_generic($td, $data){}
58403
58404/**
58405 * This function deinitializes an encryption module
58406 *
58407 * This function terminates encryption specified by the encryption
58408 * descriptor ({@link td}). It clears all buffers, but does not close the
58409 * module. You need to call {@link mcrypt_module_close} yourself. (But
58410 * PHP does this for you at the end of the script.)
58411 *
58412 * @param resource $td The encryption descriptor.
58413 * @return bool
58414 * @since PHP 4 >= 4.0.7, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58415 **/
58416function mcrypt_generic_deinit($td){}
58417
58418/**
58419 * This function terminates encryption
58420 *
58421 * {@link mcrypt_generic_deinit} should be used instead of this function,
58422 * as it can cause crashes when used with {@link mcrypt_module_close} due
58423 * to multiple buffer frees.
58424 *
58425 * This function terminates encryption specified by the encryption
58426 * descriptor ({@link td}). Actually it clears all buffers, and closes
58427 * all the modules used. Returns FALSE on error, or TRUE on success.
58428 *
58429 * @param resource $td
58430 * @return bool
58431 * @since PHP 4 >= 4.0.2, PHP 5
58432 **/
58433function mcrypt_generic_end($td){}
58434
58435/**
58436 * This function initializes all buffers needed for encryption
58437 *
58438 * You need to call this function before every call to {@link
58439 * mcrypt_generic} or {@link mdecrypt_generic}.
58440 *
58441 * @param resource $td The encryption descriptor.
58442 * @param string $key The maximum length of the key should be the one
58443 *   obtained by calling {@link mcrypt_enc_get_key_size} and every value
58444 *   smaller than this is legal.
58445 * @param string $iv The IV should normally have the size of the
58446 *   algorithms block size, but you must obtain the size by calling
58447 *   {@link mcrypt_enc_get_iv_size}. IV is ignored in ECB. IV MUST exist
58448 *   in CFB, CBC, STREAM, nOFB and OFB modes. It needs to be random and
58449 *   unique (but not secret). The same IV must be used for
58450 *   encryption/decryption. If you do not want to use it you should set
58451 *   it to zeros, but this is not recommended.
58452 * @return int The function returns a negative value on error: -3 when
58453 *   the key length was incorrect, -4 when there was a memory allocation
58454 *   problem and any other return value is an unknown error. If an error
58455 *   occurs a warning will be displayed accordingly. FALSE is returned if
58456 *   incorrect parameters were passed.
58457 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58458 **/
58459function mcrypt_generic_init($td, $key, $iv){}
58460
58461/**
58462 * Gets the block size of the specified cipher
58463 *
58464 * The first prototype is when linked against libmcrypt 2.2.x, the second
58465 * when linked against libmcrypt 2.4.x or 2.5.x.
58466 *
58467 * {@link mcrypt_get_block_size} is used to get the size of a block of
58468 * the specified {@link cipher} (in combination with an encryption mode).
58469 *
58470 * It is more useful to use the {@link mcrypt_enc_get_block_size}
58471 * function as this uses the resource returned by {@link
58472 * mcrypt_module_open}.
58473 *
58474 * @param int $cipher
58475 * @return int Returns the algorithm block size in bytes .
58476 * @since PHP 4, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58477 **/
58478function mcrypt_get_block_size($cipher){}
58479
58480/**
58481 * Gets the name of the specified cipher
58482 *
58483 * {@link mcrypt_get_cipher_name} is used to get the name of the
58484 * specified cipher.
58485 *
58486 * {@link mcrypt_get_cipher_name} takes the cipher number as an argument
58487 * (libmcrypt 2.2.x) or takes the cipher name as an argument (libmcrypt
58488 * 2.4.x or higher) and returns the name of the cipher or FALSE, if the
58489 * cipher does not exist.
58490 *
58491 * @param int $cipher
58492 * @return string This function returns the name of the cipher or FALSE
58493 *   if the cipher does not exist.
58494 * @since PHP 4, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58495 **/
58496function mcrypt_get_cipher_name($cipher){}
58497
58498/**
58499 * Returns the size of the IV belonging to a specific cipher/mode
58500 * combination
58501 *
58502 * Gets the size of the IV belonging to a specific {@link cipher}/{@link
58503 * mode} combination.
58504 *
58505 * It is more useful to use the {@link mcrypt_enc_get_iv_size} function
58506 * as this uses the resource returned by {@link mcrypt_module_open}.
58507 *
58508 * @param string $cipher
58509 * @param string $mode The IV is ignored in ECB mode as this mode does
58510 *   not require it. You will need to have the same IV (think: starting
58511 *   point) both at encryption and decryption stages, otherwise your
58512 *   encryption will fail.
58513 * @return int Returns the size of the Initialization Vector (IV) in
58514 *   bytes. On error the function returns FALSE. If the IV is ignored in
58515 *   the specified cipher/mode combination zero is returned.
58516 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58517 **/
58518function mcrypt_get_iv_size($cipher, $mode){}
58519
58520/**
58521 * Gets the key size of the specified cipher
58522 *
58523 * The first prototype is when linked against libmcrypt 2.2.x, the second
58524 * when linked against libmcrypt 2.4.x or 2.5.x.
58525 *
58526 * {@link mcrypt_get_key_size} is used to get the size of a key of the
58527 * specified {@link cipher} (in combination with an encryption mode).
58528 *
58529 * It is more useful to use the {@link mcrypt_enc_get_key_size} function
58530 * as this uses the resource returned by {@link mcrypt_module_open}.
58531 *
58532 * @param int $cipher
58533 * @return int Returns the maximum supported key size of the algorithm
58534 *   in bytes .
58535 * @since PHP 4, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58536 **/
58537function mcrypt_get_key_size($cipher){}
58538
58539/**
58540 * Gets an array of all supported ciphers
58541 *
58542 * Gets the list of all supported algorithms in the {@link lib_dir}
58543 * parameter.
58544 *
58545 * @param string $lib_dir Specifies the directory where all algorithms
58546 *   are located. If not specified, the value of the
58547 *   mcrypt.algorithms_dir directive is used.
58548 * @return array Returns an array with all the supported algorithms.
58549 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58550 **/
58551function mcrypt_list_algorithms($lib_dir){}
58552
58553/**
58554 * Gets an array of all supported modes
58555 *
58556 * Gets the list of all supported modes in the {@link lib_dir} parameter.
58557 *
58558 * @param string $lib_dir Specifies the directory where all modes are
58559 *   located. If not specified, the value of the mcrypt.modes_dir
58560 *   directive is used.
58561 * @return array Returns an array with all the supported modes.
58562 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58563 **/
58564function mcrypt_list_modes($lib_dir){}
58565
58566/**
58567 * Closes the mcrypt module
58568 *
58569 * Closes the specified encryption handle.
58570 *
58571 * @param resource $td The encryption descriptor.
58572 * @return bool
58573 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58574 **/
58575function mcrypt_module_close($td){}
58576
58577/**
58578 * Returns the blocksize of the specified algorithm
58579 *
58580 * Gets the blocksize of the specified algorithm.
58581 *
58582 * @param string $algorithm The algorithm name.
58583 * @param string $lib_dir This optional parameter can contain the
58584 *   location where the mode module is on the system.
58585 * @return int Returns the block size of the algorithm specified in
58586 *   bytes.
58587 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58588 **/
58589function mcrypt_module_get_algo_block_size($algorithm, $lib_dir){}
58590
58591/**
58592 * Returns the maximum supported keysize of the opened mode
58593 *
58594 * Gets the maximum supported keysize of the opened mode.
58595 *
58596 * @param string $algorithm The algorithm name.
58597 * @param string $lib_dir This optional parameter can contain the
58598 *   location where the mode module is on the system.
58599 * @return int This function returns the maximum supported key size of
58600 *   the algorithm specified in bytes.
58601 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58602 **/
58603function mcrypt_module_get_algo_key_size($algorithm, $lib_dir){}
58604
58605/**
58606 * Returns an array with the supported keysizes of the opened algorithm
58607 *
58608 * Returns an array with the key sizes supported by the specified
58609 * algorithm. If it returns an empty array then all key sizes between 1
58610 * and {@link mcrypt_module_get_algo_key_size} are supported by the
58611 * algorithm.
58612 *
58613 * @param string $algorithm The algorithm to be used.
58614 * @param string $lib_dir The optional {@link lib_dir} parameter can
58615 *   contain the location where the algorithm module is on the system.
58616 * @return array Returns an array with the key sizes supported by the
58617 *   specified algorithm. If it returns an empty array then all key sizes
58618 *   between 1 and {@link mcrypt_module_get_algo_key_size} are supported
58619 *   by the algorithm.
58620 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58621 **/
58622function mcrypt_module_get_supported_key_sizes($algorithm, $lib_dir){}
58623
58624/**
58625 * This function checks whether the specified algorithm is a block
58626 * algorithm
58627 *
58628 * This function returns TRUE if the specified algorithm is a block
58629 * algorithm, or FALSE if it is a stream one.
58630 *
58631 * @param string $algorithm The algorithm to check.
58632 * @param string $lib_dir The optional {@link lib_dir} parameter can
58633 *   contain the location where the algorithm module is on the system.
58634 * @return bool This function returns TRUE if the specified algorithm
58635 *   is a block algorithm, or FALSE if it is a stream one.
58636 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58637 **/
58638function mcrypt_module_is_block_algorithm($algorithm, $lib_dir){}
58639
58640/**
58641 * Returns if the specified module is a block algorithm or not
58642 *
58643 * This function returns TRUE if the mode is for use with block
58644 * algorithms, otherwise it returns FALSE. (e.g. FALSE for stream, and
58645 * TRUE for cbc, cfb, ofb).
58646 *
58647 * @param string $mode The mode to check.
58648 * @param string $lib_dir The optional {@link lib_dir} parameter can
58649 *   contain the location where the algorithm module is on the system.
58650 * @return bool This function returns TRUE if the mode is for use with
58651 *   block algorithms, otherwise it returns FALSE. (e.g. FALSE for
58652 *   stream, and TRUE for cbc, cfb, ofb).
58653 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58654 **/
58655function mcrypt_module_is_block_algorithm_mode($mode, $lib_dir){}
58656
58657/**
58658 * Returns if the specified mode outputs blocks or not
58659 *
58660 * This function returns TRUE if the mode outputs blocks of bytes or
58661 * FALSE if it outputs just bytes. (e.g. TRUE for cbc and ecb, and FALSE
58662 * for cfb and stream).
58663 *
58664 * @param string $mode
58665 * @param string $lib_dir The optional {@link lib_dir} parameter can
58666 *   contain the location where the algorithm module is on the system.
58667 * @return bool This function returns TRUE if the mode outputs blocks
58668 *   of bytes or FALSE if it outputs just bytes. (e.g. TRUE for cbc and
58669 *   ecb, and FALSE for cfb and stream).
58670 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58671 **/
58672function mcrypt_module_is_block_mode($mode, $lib_dir){}
58673
58674/**
58675 * Opens the module of the algorithm and the mode to be used
58676 *
58677 * This function opens the module of the algorithm and the mode to be
58678 * used. The name of the algorithm is specified in algorithm, e.g.
58679 * "twofish" or is one of the MCRYPT_ciphername constants. The module is
58680 * closed by calling {@link mcrypt_module_close}.
58681 *
58682 * @param string $algorithm
58683 * @param string $algorithm_directory The {@link algorithm_directory}
58684 *   parameter is used to locate the encryption module. When you supply a
58685 *   directory name, it is used. When you set it to an empty string (""),
58686 *   the value set by the mcrypt.algorithms_dir directive is used. When
58687 *   it is not set, the default directory that is used is the one that
58688 *   was compiled into libmcrypt (usually /usr/local/lib/libmcrypt).
58689 * @param string $mode
58690 * @param string $mode_directory The {@link mode_directory} parameter
58691 *   is used to locate the encryption module. When you supply a directory
58692 *   name, it is used. When you set it to an empty string (""), the value
58693 *   set by the mcrypt.modes_dir directive is used. When it is not set,
58694 *   the default directory that is used is the one that was compiled-in
58695 *   into libmcrypt (usually /usr/local/lib/libmcrypt).
58696 * @return resource Normally it returns an encryption descriptor, or
58697 *   FALSE on error.
58698 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58699 **/
58700function mcrypt_module_open($algorithm, $algorithm_directory, $mode, $mode_directory){}
58701
58702/**
58703 * This function runs a self test on the specified module
58704 *
58705 * This function runs the self test on the algorithm specified.
58706 *
58707 * @param string $algorithm
58708 * @param string $lib_dir The optional {@link lib_dir} parameter can
58709 *   contain the location where the algorithm module is on the system.
58710 * @return bool The function returns TRUE if the self test succeeds, or
58711 *   FALSE when it fails.
58712 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58713 **/
58714function mcrypt_module_self_test($algorithm, $lib_dir){}
58715
58716/**
58717 * Encrypts/decrypts data in OFB mode
58718 *
58719 * The first prototype is when linked against libmcrypt 2.2.x, the second
58720 * when linked against libmcrypt 2.4.x or higher. The {@link mode} should
58721 * be either MCRYPT_ENCRYPT or MCRYPT_DECRYPT.
58722 *
58723 * @param int $cipher
58724 * @param string $key
58725 * @param string $data
58726 * @param int $mode
58727 * @param string $iv
58728 * @return string
58729 * @since PHP 4, PHP 5
58730 **/
58731function mcrypt_ofb($cipher, $key, $data, $mode, $iv){}
58732
58733/**
58734 * Calculate the md5 hash of a string
58735 *
58736 * Calculates the MD5 hash of {@link str} using the RSA Data Security,
58737 * Inc. MD5 Message-Digest Algorithm, and returns that hash.
58738 *
58739 * @param string $str The string.
58740 * @param bool $raw_output If the optional {@link raw_output} is set to
58741 *   TRUE, then the md5 digest is instead returned in raw binary format
58742 *   with a length of 16.
58743 * @return string Returns the hash as a 32-character hexadecimal
58744 *   number.
58745 * @since PHP 4, PHP 5, PHP 7
58746 **/
58747function md5($str, $raw_output){}
58748
58749/**
58750 * Calculates the md5 hash of a given file
58751 *
58752 * Calculates the MD5 hash of the file specified by the {@link filename}
58753 * parameter using the RSA Data Security, Inc. MD5 Message-Digest
58754 * Algorithm, and returns that hash. The hash is a 32-character
58755 * hexadecimal number.
58756 *
58757 * @param string $filename The filename
58758 * @param bool $raw_output When TRUE, returns the digest in raw binary
58759 *   format with a length of 16.
58760 * @return string Returns a string on success, FALSE otherwise.
58761 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
58762 **/
58763function md5_file($filename, $raw_output){}
58764
58765/**
58766 * Decrypts data
58767 *
58768 * This function decrypts data. Note that the length of the returned
58769 * string can in fact be longer than the unencrypted string, due to the
58770 * padding of the data.
58771 *
58772 * @param resource $td An encryption descriptor returned by {@link
58773 *   mcrypt_module_open}
58774 * @param string $data Encrypted data.
58775 * @return string
58776 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0
58777 **/
58778function mdecrypt_generic($td, $data){}
58779
58780/**
58781 * Turn debug output on/off
58782 *
58783 * {@link memcache_debug} turns on debug output if parameter {@link
58784 * on_off} is equal to TRUE and turns off if it's FALSE. {@link
58785 * memcache_debug} is accessible only if PHP was built with
58786 * --enable-debug option and always returns TRUE in this case. Otherwise,
58787 * this function has no effect and always returns FALSE.
58788 *
58789 * @param bool $on_off Turns debug output on if equals to TRUE. Turns
58790 *   debug output off if equals to FALSE.
58791 * @return bool Returns TRUE if PHP was built with --enable-debug
58792 *   option, otherwise returns FALSE.
58793 **/
58794function memcache_debug($on_off){}
58795
58796/**
58797 * Returns the peak of memory allocated by PHP
58798 *
58799 * Returns the peak of memory, in bytes, that's been allocated to your
58800 * PHP script.
58801 *
58802 * @param bool $real_usage Set this to TRUE to get the real size of
58803 *   memory allocated from system. If not set or FALSE only the memory
58804 *   used by emalloc() is reported.
58805 * @return int Returns the memory peak in bytes.
58806 * @since PHP 5 >= 5.2.0, PHP 7
58807 **/
58808function memory_get_peak_usage($real_usage){}
58809
58810/**
58811 * Returns the amount of memory allocated to PHP
58812 *
58813 * Returns the amount of memory, in bytes, that's currently being
58814 * allocated to your PHP script.
58815 *
58816 * @param bool $real_usage Set this to TRUE to get total memory
58817 *   allocated from system, including unused pages. If not set or FALSE
58818 *   only the used memory is reported.
58819 * @return int Returns the memory amount in bytes.
58820 * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
58821 **/
58822function memory_get_usage($real_usage){}
58823
58824/**
58825 * Calculate the metaphone key of a string
58826 *
58827 * Calculates the metaphone key of {@link str}.
58828 *
58829 * Similar to {@link soundex} metaphone creates the same key for similar
58830 * sounding words. It's more accurate than {@link soundex} as it knows
58831 * the basic rules of English pronunciation. The metaphone generated keys
58832 * are of variable length.
58833 *
58834 * Metaphone was developed by Lawrence Philips <lphilips at verity dot
58835 * com>. It is described in ["Practical Algorithms for Programmers",
58836 * Binstock & Rex, Addison Wesley, 1995].
58837 *
58838 * @param string $str The input string.
58839 * @param int $phonemes This parameter restricts the returned metaphone
58840 *   key to {@link phonemes} characters in length. The default value of 0
58841 *   means no restriction.
58842 * @return string Returns the metaphone key as a string, .
58843 * @since PHP 4, PHP 5, PHP 7
58844 **/
58845function metaphone($str, $phonemes){}
58846
58847/**
58848 * Checks if the class method exists
58849 *
58850 * Checks if the class method exists in the given {@link object}.
58851 *
58852 * @param mixed $object An object instance or a class name
58853 * @param string $method_name The method name
58854 * @return bool Returns TRUE if the method given by {@link method_name}
58855 *   has been defined for the given {@link object}, FALSE otherwise.
58856 * @since PHP 4, PHP 5, PHP 7
58857 **/
58858function method_exists($object, $method_name){}
58859
58860/**
58861 * Computes hash
58862 *
58863 * {@link mhash} applies a hash function specified by {@link hash} to the
58864 * {@link data}.
58865 *
58866 * @param int $hash The hash ID. One of the MHASH_hashname constants.
58867 * @param string $data The user input, as a string.
58868 * @param string $key If specified, the function will return the
58869 *   resulting HMAC instead. HMAC is keyed hashing for message
58870 *   authentication, or simply a message digest that depends on the
58871 *   specified key. Not all algorithms supported in mhash can be used in
58872 *   HMAC mode.
58873 * @return string Returns the resulting hash (also called digest) or
58874 *   HMAC as a string, or FALSE on error.
58875 * @since PHP 4, PHP 5, PHP 7
58876 **/
58877function mhash($hash, $data, $key){}
58878
58879/**
58880 * Gets the highest available hash ID
58881 *
58882 * @return int Returns the highest available hash ID. Hashes are
58883 *   numbered from 0 to this hash ID.
58884 * @since PHP 4, PHP 5, PHP 7
58885 **/
58886function mhash_count(){}
58887
58888/**
58889 * Gets the block size of the specified hash
58890 *
58891 * Gets the size of a block of the specified {@link hash}.
58892 *
58893 * @param int $hash The hash ID. One of the MHASH_hashname constants.
58894 * @return int Returns the size in bytes or FALSE, if the {@link hash}
58895 *   does not exist.
58896 * @since PHP 4, PHP 5, PHP 7
58897 **/
58898function mhash_get_block_size($hash){}
58899
58900/**
58901 * Gets the name of the specified hash
58902 *
58903 * Gets the name of the specified {@link hash}.
58904 *
58905 * @param int $hash The hash ID. One of the MHASH_hashname constants.
58906 * @return string Returns the name of the hash or FALSE, if the hash
58907 *   does not exist.
58908 * @since PHP 4, PHP 5, PHP 7
58909 **/
58910function mhash_get_hash_name($hash){}
58911
58912/**
58913 * Generates a key
58914 *
58915 * Generates a key according to the given {@link hash}, using an user
58916 * provided {@link password}.
58917 *
58918 * This is the Salted S2K algorithm as specified in the OpenPGP document
58919 * (RFC 2440).
58920 *
58921 * Keep in mind that user supplied passwords are not really suitable to
58922 * be used as keys in cryptographic algorithms, since users normally
58923 * choose keys they can write on keyboard. These passwords use only 6 to
58924 * 7 bits per character (or less). It is highly recommended to use some
58925 * kind of transformation (like this function) to the user supplied key.
58926 *
58927 * @param int $hash The hash ID used to create the key. One of the
58928 *   MHASH_hashname constants.
58929 * @param string $password An user supplied password.
58930 * @param string $salt Must be different and random enough for every
58931 *   key you generate in order to create different keys. Because {@link
58932 *   salt} must be known when you check the keys, it is a good idea to
58933 *   append the key to it. Salt has a fixed length of 8 bytes and will be
58934 *   padded with zeros if you supply less bytes.
58935 * @param int $bytes The key length, in bytes.
58936 * @return string Returns the generated key as a string, or FALSE on
58937 *   error.
58938 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
58939 **/
58940function mhash_keygen_s2k($hash, $password, $salt, $bytes){}
58941
58942/**
58943 * Return current Unix timestamp with microseconds
58944 *
58945 * {@link microtime} returns the current Unix timestamp with
58946 * microseconds. This function is only available on operating systems
58947 * that support the gettimeofday() system call.
58948 *
58949 * For performance measurements, using {@link hrtime} is recommended.
58950 *
58951 * @param bool $getAsFloat If used and set to TRUE, {@link microtime}
58952 *   will return a float instead of a string, as described in the return
58953 *   values section below.
58954 * @return mixed By default, {@link microtime} returns a string in the
58955 *   form "msec sec", where sec is the number of seconds since the Unix
58956 *   epoch (0:00:00 January 1,1970 GMT), and msec measures microseconds
58957 *   that have elapsed since sec and is also expressed in seconds.
58958 * @since PHP 4, PHP 5, PHP 7
58959 **/
58960function microtime($getAsFloat){}
58961
58962/**
58963 * Detect MIME Content-type for a file
58964 *
58965 * Returns the MIME content type for a file as determined by using
58966 * information from the magic.mime file.
58967 *
58968 * @param string $filename Path to the tested file.
58969 * @return string Returns the content type in MIME format, like
58970 *   text/plain or application/octet-stream, .
58971 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
58972 **/
58973function mime_content_type($filename){}
58974
58975/**
58976 * Find lowest value
58977 *
58978 * If the first and only parameter is an array, {@link min} returns the
58979 * lowest value in that array. If at least two parameters are provided,
58980 * {@link min} returns the smallest of these values.
58981 *
58982 * @param array $values An array containing the values.
58983 * @return mixed {@link min} returns the parameter value considered
58984 *   "lowest" according to standard comparisons. If multiple values of
58985 *   different types evaluate as equal (e.g. 0 and 'abc') the first
58986 *   provided to the function will be returned.
58987 * @since PHP 4, PHP 5, PHP 7
58988 **/
58989function min($values){}
58990
58991/**
58992 * Returns the action flag for keyPress(char)
58993 *
58994 * @param string $char
58995 * @return int
58996 * @since PHP 5 < 5.3.0, PECL ming SVN
58997 **/
58998function ming_keypress($char){}
58999
59000/**
59001 * Set cubic threshold
59002 *
59003 * Sets the threshold error for drawing cubic beziers.
59004 *
59005 * @param int $threshold The Threshold. Lower is more accurate, hence
59006 *   larger file size.
59007 * @return void
59008 * @since PHP 4 >= 4.0.5, PHP 5 < 5.3.0, PECL ming SVN
59009 **/
59010function ming_setcubicthreshold($threshold){}
59011
59012/**
59013 * Set the global scaling factor
59014 *
59015 * Sets the scale of the output SWF. Inside the SWF file, coordinates are
59016 * measured in TWIPS, rather than PIXELS. There are 20 TWIPS in 1 pixel.
59017 *
59018 * @param float $scale The scale to be set.
59019 * @return void
59020 * @since PHP 4 >= 4.0.5, PHP 5 < 5.3.0, PECL ming SVN
59021 **/
59022function ming_setscale($scale){}
59023
59024/**
59025 * Sets the SWF output compression
59026 *
59027 * Sets the SWF output compression level.
59028 *
59029 * @param int $level The new compression level. Should be a value
59030 *   between 1 and 9 inclusive.
59031 * @return void
59032 * @since PHP 5.2.1-5.3.0, PECL ming SVN
59033 **/
59034function ming_setswfcompression($level){}
59035
59036/**
59037 * Use constant pool
59038 *
59039 * @param int $use
59040 * @return void
59041 * @since PHP 5 < 5.3.0, PECL ming SVN
59042 **/
59043function ming_useconstants($use){}
59044
59045/**
59046 * Sets the SWF version
59047 *
59048 * Sets the SWF version to be used in the movie. This affect the
59049 * bahaviour of Action Script.
59050 *
59051 * @param int $version SWF version to use.
59052 * @return void
59053 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ming SVN
59054 **/
59055function ming_useswfversion($version){}
59056
59057/**
59058 * Makes directory
59059 *
59060 * Attempts to create the directory specified by pathname.
59061 *
59062 * @param string $pathname The directory path.
59063 * @param int $mode The mode is 0777 by default, which means the widest
59064 *   possible access. For more information on modes, read the details on
59065 *   the {@link chmod} page. Note that you probably want to specify the
59066 *   mode as an octal number, which means it should have a leading zero.
59067 *   The mode is also modified by the current umask, which you can change
59068 *   using {@link umask}.
59069 * @param bool $recursive Allows the creation of nested directories
59070 *   specified in the {@link pathname}.
59071 * @param resource $context
59072 * @return bool
59073 * @since PHP 4, PHP 5, PHP 7
59074 **/
59075function mkdir($pathname, $mode, $recursive, $context){}
59076
59077/**
59078 * Get Unix timestamp for a date
59079 *
59080 * Returns the Unix timestamp corresponding to the arguments given. This
59081 * timestamp is a long integer containing the number of seconds between
59082 * the Unix Epoch (January 1 1970 00:00:00 GMT) and the time specified.
59083 *
59084 * Arguments may be left out in order from right to left; any arguments
59085 * thus omitted will be set to the current value according to the local
59086 * date and time.
59087 *
59088 * @param int $hour The number of the hour relative to the start of the
59089 *   day determined by {@link month}, {@link day} and {@link year}.
59090 *   Negative values reference the hour before midnight of the day in
59091 *   question. Values greater than 23 reference the appropriate hour in
59092 *   the following day(s).
59093 * @param int $minute The number of the minute relative to the start of
59094 *   the {@link hour}. Negative values reference the minute in the
59095 *   previous hour. Values greater than 59 reference the appropriate
59096 *   minute in the following hour(s).
59097 * @param int $second The number of seconds relative to the start of
59098 *   the {@link minute}. Negative values reference the second in the
59099 *   previous minute. Values greater than 59 reference the appropriate
59100 *   second in the following minute(s).
59101 * @param int $month The number of the month relative to the end of the
59102 *   previous year. Values 1 to 12 reference the normal calendar months
59103 *   of the year in question. Values less than 1 (including negative
59104 *   values) reference the months in the previous year in reverse order,
59105 *   so 0 is December, -1 is November, etc. Values greater than 12
59106 *   reference the appropriate month in the following year(s).
59107 * @param int $day The number of the day relative to the end of the
59108 *   previous month. Values 1 to 28, 29, 30 or 31 (depending upon the
59109 *   month) reference the normal days in the relevant month. Values less
59110 *   than 1 (including negative values) reference the days in the
59111 *   previous month, so 0 is the last day of the previous month, -1 is
59112 *   the day before that, etc. Values greater than the number of days in
59113 *   the relevant month reference the appropriate day in the following
59114 *   month(s).
59115 * @param int $year The number of the year, may be a two or four digit
59116 *   value, with values between 0-69 mapping to 2000-2069 and 70-100 to
59117 *   1970-2000. On systems where time_t is a 32bit signed integer, as
59118 *   most common today, the valid range for {@link year} is somewhere
59119 *   between 1901 and 2038. However, before PHP 5.1.0 this range was
59120 *   limited from 1970 to 2038 on some systems (e.g. Windows).
59121 * @param int $isDST This parameter can be set to 1 if the time is
59122 *   during daylight savings time (DST), 0 if it is not, or -1 (the
59123 *   default) if it is unknown whether the time is within daylight
59124 *   savings time or not. If it's unknown, PHP tries to figure it out
59125 *   itself. This can cause unexpected (but not incorrect) results. Some
59126 *   times are invalid if DST is enabled on the system PHP is running on
59127 *   or {@link isDST} is set to 1. If DST is enabled in e.g. 2:00, all
59128 *   times between 2:00 and 3:00 are invalid and {@link mktime} returns
59129 *   an undefined (usually negative) value. Some systems (e.g. Solaris 8)
59130 *   enable DST at midnight so time 0:30 of the day when DST is enabled
59131 *   is evaluated as 23:30 of the previous day.
59132 * @return int {@link mktime} returns the Unix timestamp of the
59133 *   arguments given. If the arguments are invalid, the function returns
59134 *   FALSE (before PHP 5.1 it returned -1).
59135 * @since PHP 4, PHP 5, PHP 7
59136 **/
59137function mktime($hour, $minute, $second, $month, $day, $year, $isDST){}
59138
59139/**
59140 * Formats a number as a currency string
59141 *
59142 * {@link money_format} returns a formatted version of {@link number}.
59143 * This function wraps the C library function {@link strfmon}, with the
59144 * difference that this implementation converts only one number at a
59145 * time.
59146 *
59147 * @param string $format The format specification consists of the
59148 *   following sequence: a % character optional flags optional field
59149 *   width optional left precision optional right precision a required
59150 *   conversion character
59151 * @param float $number The character = followed by a (single byte)
59152 *   character f to be used as the numeric fill character. The default
59153 *   fill character is space.
59154 * @return string Returns the formatted string. Characters before and
59155 *   after the formatting string will be returned unchanged. Non-numeric
59156 *   {@link number} causes returning NULL and emitting E_WARNING.
59157 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
59158 **/
59159function money_format($format, $number){}
59160
59161namespace MongoDB\BSON {
59162
59163/**
59164 * Returns the BSON representation of a JSON value
59165 *
59166 * Converts an extended JSON string to its BSON representation.
59167 *
59168 * @param string $json JSON value to be converted.
59169 * @return string The serialized BSON document as a binary string.
59170 **/
59171function fromJSON($json){}
59172
59173}
59174
59175namespace MongoDB\BSON {
59176
59177/**
59178 * Returns the BSON representation of a PHP value
59179 *
59180 * Serializes a PHP array or object (e.g. document) to its BSON
59181 * representation. The returned binary string will describe a BSON
59182 * document.
59183 *
59184 * @param array|object $value PHP value to be serialized.
59185 * @return string The serialized BSON document as a binary string.
59186 **/
59187function fromPHP($value){}
59188
59189}
59190
59191namespace MongoDB\BSON {
59192
59193/**
59194 * Returns the Canonical Extended JSON representation of a BSON value
59195 *
59196 * Converts a BSON string to its Canonical Extended JSON representation.
59197 * The canonical format prefers type fidelity at the expense of concise
59198 * output and is most suited for producing output that can be converted
59199 * back to BSON without any loss of type information (e.g. numeric types
59200 * will remain differentiated).
59201 *
59202 * @param string $bson BSON value to be converted.
59203 * @return string The converted JSON value.
59204 **/
59205function toCanonicalExtendedJSON($bson){}
59206
59207}
59208
59209namespace MongoDB\BSON {
59210
59211/**
59212 * Returns the Legacy Extended JSON representation of a BSON value
59213 *
59214 * Converts a BSON string to its Legacy Extended JSON representation.
59215 *
59216 * @param string $bson BSON value to be converted.
59217 * @return string The converted JSON value.
59218 **/
59219function toJSON($bson){}
59220
59221}
59222
59223namespace MongoDB\BSON {
59224
59225/**
59226 * Returns the PHP representation of a BSON value
59227 *
59228 * Unserializes a BSON document (i.e. binary string) to its PHP
59229 * representation. The {@link typeMap} paramater may be used to control
59230 * the PHP types used for converting BSON arrays and documents (both root
59231 * and embedded).
59232 *
59233 * @param string $bson BSON value to be unserialized.
59234 * @param array $typeMap
59235 * @return array|object The unserialized PHP value.
59236 **/
59237function toPHP($bson, $typeMap){}
59238
59239}
59240
59241namespace MongoDB\BSON {
59242
59243/**
59244 * Returns the Relaxed Extended JSON representation of a BSON value
59245 *
59246 * Converts a BSON string to its Relaxed Extended JSON representation.
59247 * The relaxed format prefers use of JSON type primitives at the expense
59248 * of type fidelity and is most suited for producing output that can be
59249 * easily consumed by web APIs and humans.
59250 *
59251 * @param string $bson BSON value to be converted.
59252 * @return string The converted JSON value.
59253 **/
59254function toRelaxedExtendedJSON($bson){}
59255
59256}
59257
59258namespace MongoDB\Driver\Monitoring {
59259
59260/**
59261 * Registers a new monitoring event subscriber
59262 *
59263 * Registers a new monitoring event subscriber with the driver.
59264 * Registered subscribers will be notified of monitoring events through
59265 * specific methods.
59266 *
59267 * @param MongoDB\Driver\Monitoring\Subscriber $subscriber A monitoring
59268 *   event subscriber object to register.
59269 * @return void
59270 **/
59271function addSubscriber($subscriber){}
59272
59273}
59274
59275namespace MongoDB\Driver\Monitoring {
59276
59277/**
59278 * Unregisters an existing monitoring event subscriber
59279 *
59280 * Unregisters an existing monitoring event subscriber from the driver.
59281 * Unregistered subscribers will no longer be notified of monitoring
59282 * events.
59283 *
59284 * @param MongoDB\Driver\Monitoring\Subscriber $subscriber A monitoring
59285 *   event subscriber object to unregister.
59286 * @return void
59287 **/
59288function removeSubscriber($subscriber){}
59289
59290}
59291
59292/**
59293 * Moves an uploaded file to a new location
59294 *
59295 * This function checks to ensure that the file designated by {@link
59296 * filename} is a valid upload file (meaning that it was uploaded via
59297 * PHP's HTTP POST upload mechanism). If the file is valid, it will be
59298 * moved to the filename given by {@link destination}.
59299 *
59300 * This sort of check is especially important if there is any chance that
59301 * anything done with uploaded files could reveal their contents to the
59302 * user, or even to other users on the same system.
59303 *
59304 * @param string $filename The filename of the uploaded file.
59305 * @param string $destination The destination of the moved file.
59306 * @return bool Returns TRUE on success.
59307 * @since PHP 4 >= 4.0.3, PHP 5, PHP 7
59308 **/
59309function move_uploaded_file($filename, $destination){}
59310
59311/**
59312 * MQSeries MQBACK
59313 *
59314 * The {@link mqseries_back} (MQBACK) call indicates to the queue manager
59315 * that all the message gets and puts that have occurred since the last
59316 * syncpoint are to be backed out. Messages put as part of a unit of work
59317 * are deleted; messages retrieved as part of a unit of work are
59318 * reinstated on the queue.
59319 *
59320 * Using {@link mqseries_back} only works in conjunction with {@link
59321 * mqseries_begin} and only function when connecting directly to a Queueu
59322 * manager. Not via the mqclient interface.
59323 *
59324 * @param resource $hconn Connection handle. This handle represents the
59325 *   connection to the queue manager.
59326 * @param resource $compCode Completion code.
59327 * @param resource $reason Reason code qualifying the compCode.
59328 * @return void
59329 * @since PECL mqseries >= 0.10.0
59330 **/
59331function mqseries_back($hconn, &$compCode, &$reason){}
59332
59333/**
59334 * MQseries MQBEGIN
59335 *
59336 * The {@link mqseries_begin} (MQBEGIN) call begins a unit of work that
59337 * is coordinated by the queue manager, and that may involve external
59338 * resource managers.
59339 *
59340 * Using {@link mqseries_begin} starts the unit of work. Either {@link
59341 * mqseries_back} or {@link mqseries_cmit} ends the unit of work.
59342 *
59343 * @param resource $hconn Connection handle. This handle represents the
59344 *   connection to the queue manager.
59345 * @param array $beginOptions Completion code.
59346 * @param resource $compCode Reason code qualifying the compCode.
59347 * @param resource $reason
59348 * @return void
59349 * @since PECL mqseries >= 0.10.0
59350 **/
59351function mqseries_begin($hconn, $beginOptions, &$compCode, &$reason){}
59352
59353/**
59354 * MQSeries MQCLOSE
59355 *
59356 * The {@link mqseries_close} (MQCLOSE) call relinquishes access to an
59357 * object, and is the inverse of the {@link mqseries_open} (MQOPEN) call.
59358 *
59359 * @param resource $hconn Connection handle. This handle represents the
59360 *   connection to the queue manager.
59361 * @param resource $hobj Object handle. This handle represents the
59362 *   object to be used.
59363 * @param int $options
59364 * @param resource $compCode Completion code.
59365 * @param resource $reason Reason code qualifying the compCode.
59366 * @return void
59367 * @since PECL mqseries >= 0.10.0
59368 **/
59369function mqseries_close($hconn, $hobj, $options, &$compCode, &$reason){}
59370
59371/**
59372 * MQSeries MQCMIT
59373 *
59374 * The {@link mqseries_cmit} (MQCMIT) call indicates to the queue manager
59375 * that the application has reached a syncpoint, and that all of the
59376 * message gets and puts that have occurred since the last syncpoint are
59377 * to be made permanent. Messages put as part of a unit of work are made
59378 * available to other applications; messages retrieved as part of a unit
59379 * of work are deleted.
59380 *
59381 * @param resource $hconn Connection handle. This handle represents the
59382 *   connection to the queue manager.
59383 * @param resource $compCode Completion code.
59384 * @param resource $reason Reason code qualifying the compCode.
59385 * @return void
59386 * @since PECL mqseries >= 0.10.0
59387 **/
59388function mqseries_cmit($hconn, &$compCode, &$reason){}
59389
59390/**
59391 * MQSeries MQCONN
59392 *
59393 * The {@link mqseries_conn} (MQCONN) call connects an application
59394 * program to a queue manager. It provides a queue manager connection
59395 * handle, which is used by the application on subsequent message queuing
59396 * calls.
59397 *
59398 * @param string $qManagerName Name of queue manager. Name of the queue
59399 *   manager the application wishes to connect.
59400 * @param resource $hconn Connection handle. This handle represents the
59401 *   connection to the queue manager.
59402 * @param resource $compCode Completion code.
59403 * @param resource $reason Reason code qualifying the compCode.
59404 * @return void
59405 * @since PECL mqseries >= 0.10.0
59406 **/
59407function mqseries_conn($qManagerName, &$hconn, &$compCode, &$reason){}
59408
59409/**
59410 * MQSeries MQCONNX
59411 *
59412 * The {@link mqseries_connx} (MQCONNX) call connects an application
59413 * program to a queue manager. It provides a queue manager connection
59414 * handle, which is used by the application on subsequent MQ calls.
59415 *
59416 * The {@link mqseries_connx} call is like the {@link mqseries_conn}
59417 * (MQCONN) call, except that MQCONNX allows options to be specified to
59418 * control the way that the call works.
59419 *
59420 * @param string $qManagerName Name of queue manager. Name of the queue
59421 *   manager the application wishes to connect.
59422 * @param array $connOptions Options that control the action of
59423 *   function See also the MQCNO structure.
59424 * @param resource $hconn Connection handle. This handle represents the
59425 *   connection to the queue manager.
59426 * @param resource $compCode Completion code.
59427 * @param resource $reason Reason code qualifying the compCode.
59428 * @return void
59429 * @since PECL mqseries >= 0.10.0
59430 **/
59431function mqseries_connx($qManagerName, &$connOptions, &$hconn, &$compCode, &$reason){}
59432
59433/**
59434 * MQSeries MQDISC
59435 *
59436 * The {@link mqseries_disc} (MQDISC) call breaks the connection between
59437 * the queue manager and the application program, and is the inverse of
59438 * the {@link mqseries_conn} (MQCONN) or {@link mqseries_connx} (MQCONNX)
59439 * call.
59440 *
59441 * @param resource $hconn Connection handle. This handle represents the
59442 *   connection to the queue manager.
59443 * @param resource $compCode Completion code.
59444 * @param resource $reason Reason code qualifying the compCode.
59445 * @return void
59446 * @since PECL mqseries >= 0.10.0
59447 **/
59448function mqseries_disc($hconn, &$compCode, &$reason){}
59449
59450/**
59451 * MQSeries MQGET
59452 *
59453 * The {@link mqseries_get} (MQGET) call retrieves a message from a local
59454 * queue that has been opened using the {@link mqseries_open} (MQOPEN)
59455 * call
59456 *
59457 * @param resource $hConn Connection handle. This handle represents the
59458 *   connection to the queue manager.
59459 * @param resource $hObj Object handle. This handle represents the
59460 *   object to be used.
59461 * @param array $md Message descriptor (MQMD).
59462 * @param array $gmo Get message options (MQGMO).
59463 * @param int $bufferLength Expected length of the result buffer
59464 * @param string $msg Buffer holding the message that was retrieved
59465 *   from the object.
59466 * @param int $data_length Actual buffer length
59467 * @param resource $compCode Completion code.
59468 * @param resource $reason Reason code qualifying the compCode.
59469 * @return void
59470 * @since PECL mqseries >= 0.10.0
59471 **/
59472function mqseries_get($hConn, $hObj, &$md, &$gmo, &$bufferLength, &$msg, &$data_length, &$compCode, &$reason){}
59473
59474/**
59475 * MQSeries MQINQ
59476 *
59477 * The {@link mqseries_inq} (MQINQ) call returns an array of integers and
59478 * a set of character strings containing the attributes of an object.
59479 *
59480 * @param resource $hconn Connection handle. This handle represents the
59481 *   connection to the queue manager.
59482 * @param resource $hobj Object handle. This handle represents the
59483 *   object to be used.
59484 * @param int $selectorCount Count of selectors.
59485 * @param array $selectors Array of attribute selectors.
59486 * @param int $intAttrCount Count of integer attributes.
59487 * @param resource $intAttr Array of integer attributes.
59488 * @param int $charAttrLength Length of character attributes buffer.
59489 * @param resource $charAttr Character attributes.
59490 * @param resource $compCode Completion code.
59491 * @param resource $reason Reason code qualifying the compCode.
59492 * @return void
59493 * @since PECL mqseries >= 0.10.0
59494 **/
59495function mqseries_inq($hconn, $hobj, $selectorCount, $selectors, $intAttrCount, &$intAttr, $charAttrLength, &$charAttr, &$compCode, &$reason){}
59496
59497/**
59498 * MQSeries MQOPEN
59499 *
59500 * The {@link mqseries_open} (MQOPEN) call establishes access to an
59501 * object.
59502 *
59503 * @param resource $hconn Connection handle. This handle represents the
59504 *   connection to the queue manager.
59505 * @param array $objDesc Object descriptor. (MQOD)
59506 * @param int $option Options that control the action of the function.
59507 * @param resource $hobj Object handle. This handle represents the
59508 *   object to be used.
59509 * @param resource $compCode Completion code.
59510 * @param resource $reason Reason code qualifying the compCode.
59511 * @return void
59512 * @since PECL mqseries >= 0.10.0
59513 **/
59514function mqseries_open($hconn, &$objDesc, $option, &$hobj, &$compCode, &$reason){}
59515
59516/**
59517 * MQSeries MQPUT
59518 *
59519 * The {@link mqseries_put} (MQPUT) call puts a message on a queue or
59520 * distribution list. The queue or distribution list must already be
59521 * open.
59522 *
59523 * @param resource $hConn Connection handle. This handle represents the
59524 *   connection to the queue manager.
59525 * @param resource $hObj Object handle. This handle represents the
59526 *   object to be used.
59527 * @param array $md Message descriptor (MQMD).
59528 * @param array $pmo Put message options (MQPMO).
59529 * @param string $message The actual message to put onto the queue.
59530 * @param resource $compCode Completion code.
59531 * @param resource $reason Reason code qualifying the compCode.
59532 * @return void
59533 * @since PECL mqseries >= 0.10.0
59534 **/
59535function mqseries_put($hConn, $hObj, &$md, &$pmo, $message, &$compCode, &$reason){}
59536
59537/**
59538 * MQSeries MQPUT1
59539 *
59540 * The {@link mqseries_put1} (MQPUT1) call puts one message on a queue.
59541 * The queue need not be open.
59542 *
59543 * You can use both the {@link mqseries_put} and {@link mqseries_put1}
59544 * calls to put messages on a queue; which call to use depends on the
59545 * circumstances. Use the {@link mqseries_put} (MQPUT) call to place
59546 * multiple messages on the same queue. Use the {@link mqseries_put1}
59547 * (MQPUT1) call to put only one message on a queue. This call
59548 * encapsulates the MQOPEN, MQPUT, and MQCLOSE calls into a single call,
59549 * minimizing the number of calls that must be issued.
59550 *
59551 * @param resource $hconn Connection handle. This handle represents the
59552 *   connection to the queue manager.
59553 * @param resource $objDesc Object descriptor. (MQOD) This is a
59554 *   structure which identifies the queue to which the message is added.
59555 * @param resource $msgDesc Message descriptor (MQMD).
59556 * @param resource $pmo Put message options (MQPMO).
59557 * @param string $buffer Completion code.
59558 * @param resource $compCode Reason code qualifying the compCode.
59559 * @param resource $reason
59560 * @return void
59561 * @since PECL mqseries >= 0.10.0
59562 **/
59563function mqseries_put1($hconn, &$objDesc, &$msgDesc, &$pmo, $buffer, &$compCode, &$reason){}
59564
59565/**
59566 * MQSeries MQSET
59567 *
59568 * The {@link mqseries_set} (MQSET) call is used to change the attributes
59569 * of an object represented by a handle. The object must be a queue.
59570 *
59571 * @param resource $hConn Connection handle. This handle represents the
59572 *   connection to the queue manager.
59573 * @param resource $hObj Object handle. This handle represents the
59574 *   object to be used.
59575 * @param int $selectorCount Count of selectors.
59576 * @param array $selectors Array of attribute selectors.
59577 * @param int $intAttrCount Count of integer attributes.
59578 * @param array $intAttrs Array of integer attributes.
59579 * @param int $charAttrLength Length of character attributes buffer.
59580 * @param array $charAttrs Character attributes.
59581 * @param resource $compCode Completion code.
59582 * @param resource $reason Reason code qualifying the compCode.
59583 * @return void
59584 * @since PECL mqseries >= 0.10.0
59585 **/
59586function mqseries_set($hConn, $hObj, $selectorCount, $selectors, $intAttrCount, $intAttrs, $charAttrLength, $charAttrs, &$compCode, &$reason){}
59587
59588/**
59589 * Returns the error message corresponding to a result code (MQRC)
59590 *
59591 * {@link mqseries_strerror} returns the message that correspond to the
59592 * reason result code.
59593 *
59594 * @param int $reason Reason code qualifying the compCode.
59595 * @return string string representation of the reason code message.
59596 * @since PECL mqseries >= 0.10.0
59597 **/
59598function mqseries_strerror($reason){}
59599
59600/**
59601 * Connect to msession server
59602 *
59603 * @param string $host
59604 * @param string $port
59605 * @return bool
59606 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59607 **/
59608function msession_connect($host, $port){}
59609
59610/**
59611 * Get session count
59612 *
59613 * @return int
59614 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59615 **/
59616function msession_count(){}
59617
59618/**
59619 * Create a session
59620 *
59621 * @param string $session
59622 * @param string $classname
59623 * @param string $data
59624 * @return bool
59625 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59626 **/
59627function msession_create($session, $classname, $data){}
59628
59629/**
59630 * Destroy a session
59631 *
59632 * @param string $name
59633 * @return bool
59634 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59635 **/
59636function msession_destroy($name){}
59637
59638/**
59639 * Close connection to msession server
59640 *
59641 * @return void
59642 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59643 **/
59644function msession_disconnect(){}
59645
59646/**
59647 * Find all sessions with name and value
59648 *
59649 * @param string $name
59650 * @param string $value
59651 * @return array
59652 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59653 **/
59654function msession_find($name, $value){}
59655
59656/**
59657 * Get value from session
59658 *
59659 * @param string $session
59660 * @param string $name
59661 * @param string $value
59662 * @return string
59663 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59664 **/
59665function msession_get($session, $name, $value){}
59666
59667/**
59668 * Get array of msession variables
59669 *
59670 * @param string $session
59671 * @return array
59672 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59673 **/
59674function msession_get_array($session){}
59675
59676/**
59677 * Get data session unstructured data
59678 *
59679 * @param string $session
59680 * @return string
59681 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59682 **/
59683function msession_get_data($session){}
59684
59685/**
59686 * Increment value in session
59687 *
59688 * @param string $session
59689 * @param string $name
59690 * @return string
59691 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59692 **/
59693function msession_inc($session, $name){}
59694
59695/**
59696 * List all sessions
59697 *
59698 * @return array
59699 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59700 **/
59701function msession_list(){}
59702
59703/**
59704 * List sessions with variable
59705 *
59706 * Used for searching sessions with common attributes.
59707 *
59708 * @param string $name The name being searched.
59709 * @return array Returns an associative array of value/session for all
59710 *   sessions with a variable named {@link name}.
59711 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59712 **/
59713function msession_listvar($name){}
59714
59715/**
59716 * Lock a session
59717 *
59718 * @param string $name
59719 * @return int
59720 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59721 **/
59722function msession_lock($name){}
59723
59724/**
59725 * Call an escape function within the msession personality plugin
59726 *
59727 * @param string $session
59728 * @param string $val
59729 * @param string $param
59730 * @return string
59731 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59732 **/
59733function msession_plugin($session, $val, $param){}
59734
59735/**
59736 * Get random string
59737 *
59738 * @param int $param
59739 * @return string
59740 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59741 **/
59742function msession_randstr($param){}
59743
59744/**
59745 * Set value in session
59746 *
59747 * @param string $session
59748 * @param string $name
59749 * @param string $value
59750 * @return bool
59751 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59752 **/
59753function msession_set($session, $name, $value){}
59754
59755/**
59756 * Set msession variables from an array
59757 *
59758 * @param string $session
59759 * @param array $tuples
59760 * @return void
59761 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59762 **/
59763function msession_set_array($session, $tuples){}
59764
59765/**
59766 * Set data session unstructured data
59767 *
59768 * @param string $session
59769 * @param string $value
59770 * @return bool
59771 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59772 **/
59773function msession_set_data($session, $value){}
59774
59775/**
59776 * Set/get session timeout
59777 *
59778 * @param string $session
59779 * @param int $param
59780 * @return int
59781 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59782 **/
59783function msession_timeout($session, $param){}
59784
59785/**
59786 * Get unique id
59787 *
59788 * @param int $param
59789 * @param string $classname
59790 * @param string $data
59791 * @return string
59792 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59793 **/
59794function msession_uniq($param, $classname, $data){}
59795
59796/**
59797 * Unlock a session
59798 *
59799 * @param string $session
59800 * @param int $key
59801 * @return int
59802 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.3
59803 **/
59804function msession_unlock($session, $key){}
59805
59806/**
59807 * Constructs a new Message Formatter
59808 *
59809 * (method)
59810 *
59811 * (constructor):
59812 *
59813 * @param string $locale The locale to use when formatting arguments
59814 * @param string $pattern The pattern string to stick arguments into.
59815 *   The pattern uses an 'apostrophe-friendly' syntax; it is run through
59816 *   umsg_autoQuoteApostrophe before being interpreted.
59817 * @return MessageFormatter The formatter object
59818 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
59819 **/
59820function msgfmt_create($locale, $pattern){}
59821
59822/**
59823 * Format the message
59824 *
59825 * Format the message by substituting the data into the format string
59826 * according to the locale rules
59827 *
59828 * @param MessageFormatter $fmt The message formatter
59829 * @param array $args Arguments to insert into the format string
59830 * @return string The formatted string, or FALSE if an error occurred
59831 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
59832 **/
59833function msgfmt_format($fmt, $args){}
59834
59835/**
59836 * Quick format message
59837 *
59838 * Quick formatting function that formats the string without having to
59839 * explicitly create the formatter object. Use this function when the
59840 * format operation is done only once and does not need and parameters or
59841 * state to be kept.
59842 *
59843 * @param string $locale The locale to use for formatting
59844 *   locale-dependent parts
59845 * @param string $pattern The pattern string to insert things into. The
59846 *   pattern uses an 'apostrophe-friendly' syntax; it is run through
59847 *   umsg_autoQuoteApostrophe before being interpreted.
59848 * @param array $args The array of values to insert into the format
59849 *   string
59850 * @return string The formatted pattern string or FALSE if an error
59851 *   occurred
59852 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
59853 **/
59854function msgfmt_format_message($locale, $pattern, $args){}
59855
59856/**
59857 * Get the error code from last operation
59858 *
59859 * @param MessageFormatter $fmt The message formatter
59860 * @return int The error code, one of UErrorCode values. Initial value
59861 *   is U_ZERO_ERROR.
59862 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
59863 **/
59864function msgfmt_get_error_code($fmt){}
59865
59866/**
59867 * Get the error text from the last operation
59868 *
59869 * @param MessageFormatter $fmt The message formatter
59870 * @return string Description of the last error.
59871 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
59872 **/
59873function msgfmt_get_error_message($fmt){}
59874
59875/**
59876 * Get the locale for which the formatter was created
59877 *
59878 * @param NumberFormatter $formatter The formatter resource
59879 * @return string The locale name
59880 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
59881 **/
59882function msgfmt_get_locale($formatter){}
59883
59884/**
59885 * Get the pattern used by the formatter
59886 *
59887 * @param MessageFormatter $fmt The message formatter
59888 * @return string The pattern string for this message formatter
59889 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
59890 **/
59891function msgfmt_get_pattern($fmt){}
59892
59893/**
59894 * Parse input string according to pattern
59895 *
59896 * Parses input string and return any extracted items as an array.
59897 *
59898 * @param MessageFormatter $fmt The message formatter
59899 * @param string $value The string to parse
59900 * @return array An array containing the items extracted, or FALSE on
59901 *   error
59902 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
59903 **/
59904function msgfmt_parse($fmt, $value){}
59905
59906/**
59907 * Quick parse input string
59908 *
59909 * Parses input string without explicitly creating the formatter object.
59910 * Use this function when the format operation is done only once and does
59911 * not need and parameters or state to be kept.
59912 *
59913 * @param string $locale The locale to use for parsing locale-dependent
59914 *   parts
59915 * @param string $pattern The pattern with which to parse the {@link
59916 *   value}.
59917 * @param string $value The string to parse, conforming to the {@link
59918 *   pattern}.
59919 * @return array An array containing items extracted, or FALSE on error
59920 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
59921 **/
59922function msgfmt_parse_message($locale, $pattern, $value){}
59923
59924/**
59925 * Set the pattern used by the formatter
59926 *
59927 * @param MessageFormatter $fmt The message formatter
59928 * @param string $pattern The pattern string to use in this message
59929 *   formatter. The pattern uses an 'apostrophe-friendly' syntax; it is
59930 *   run through umsg_autoQuoteApostrophe before being interpreted.
59931 * @return bool
59932 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
59933 **/
59934function msgfmt_set_pattern($fmt, $pattern){}
59935
59936/**
59937 * Create or attach to a message queue
59938 *
59939 * {@link msg_get_queue} returns an id that can be used to access the
59940 * System V message queue with the given {@link key}. The first call
59941 * creates the message queue with the optional {@link perms}. A second
59942 * call to {@link msg_get_queue} for the same {@link key} will return a
59943 * different message queue identifier, but both identifiers access the
59944 * same underlying message queue.
59945 *
59946 * @param int $key Message queue numeric ID
59947 * @param int $perms Queue permissions. Default to 0666. If the message
59948 *   queue already exists, the {@link perms} will be ignored.
59949 * @return resource Returns a resource handle that can be used to
59950 *   access the System V message queue.
59951 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
59952 **/
59953function msg_get_queue($key, $perms){}
59954
59955/**
59956 * Check whether a message queue exists
59957 *
59958 * Checks whether the message queue {@link key} exists.
59959 *
59960 * @param int $key Queue key.
59961 * @return bool
59962 * @since PHP 5 >= 5.3.0, PHP 7
59963 **/
59964function msg_queue_exists($key){}
59965
59966/**
59967 * Receive a message from a message queue
59968 *
59969 * {@link msg_receive} will receive the first message from the specified
59970 * {@link queue} of the type specified by {@link desiredmsgtype}.
59971 *
59972 * @param resource $queue Message queue resource handle
59973 * @param int $desiredmsgtype If {@link desiredmsgtype} is 0, the
59974 *   message from the front of the queue is returned. If {@link
59975 *   desiredmsgtype} is greater than 0, then the first message of that
59976 *   type is returned. If {@link desiredmsgtype} is less than 0, the
59977 *   first message on the queue with a type less than or equal to the
59978 *   absolute value of {@link desiredmsgtype} will be read. If no
59979 *   messages match the criteria, your script will wait until a suitable
59980 *   message arrives on the queue. You can prevent the script from
59981 *   blocking by specifying MSG_IPC_NOWAIT in the {@link flags}
59982 *   parameter.
59983 * @param int $msgtype The type of the message that was received will
59984 *   be stored in this parameter.
59985 * @param int $maxsize The maximum size of message to be accepted is
59986 *   specified by the {@link maxsize}; if the message in the queue is
59987 *   larger than this size the function will fail (unless you set {@link
59988 *   flags} as described below).
59989 * @param mixed $message The received message will be stored in {@link
59990 *   message}, unless there were errors receiving the message.
59991 * @param bool $unserialize If set to TRUE, the message is treated as
59992 *   though it was serialized using the same mechanism as the session
59993 *   module. The message will be unserialized and then returned to your
59994 *   script. This allows you to easily receive arrays or complex object
59995 *   structures from other PHP scripts, or if you are using the WDDX
59996 *   serializer, from any WDDX compatible source. If {@link unserialize}
59997 *   is FALSE, the message will be returned as a binary-safe string.
59998 * @param int $flags The optional {@link flags} allows you to pass
59999 *   flags to the low-level msgrcv system call. It defaults to 0, but you
60000 *   may specify one or more of the following values (by adding or ORing
60001 *   them together). Flag values for msg_receive MSG_IPC_NOWAIT If there
60002 *   are no messages of the {@link desiredmsgtype}, return immediately
60003 *   and do not wait. The function will fail and return an integer value
60004 *   corresponding to MSG_ENOMSG. MSG_EXCEPT Using this flag in
60005 *   combination with a {@link desiredmsgtype} greater than 0 will cause
60006 *   the function to receive the first message that is not equal to
60007 *   {@link desiredmsgtype}. MSG_NOERROR If the message is longer than
60008 *   {@link maxsize}, setting this flag will truncate the message to
60009 *   {@link maxsize} and will not signal an error.
60010 * @param int $errorcode If the function fails, the optional {@link
60011 *   errorcode} will be set to the value of the system errno variable.
60012 * @return bool
60013 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
60014 **/
60015function msg_receive($queue, $desiredmsgtype, &$msgtype, $maxsize, &$message, $unserialize, $flags, &$errorcode){}
60016
60017/**
60018 * Destroy a message queue
60019 *
60020 * {@link msg_remove_queue} destroys the message queue specified by the
60021 * {@link queue}. Only use this function when all processes have finished
60022 * working with the message queue and you need to release the system
60023 * resources held by it.
60024 *
60025 * @param resource $queue Message queue resource handle
60026 * @return bool
60027 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
60028 **/
60029function msg_remove_queue($queue){}
60030
60031/**
60032 * Send a message to a message queue
60033 *
60034 * {@link msg_send} sends a {@link message} of type {@link msgtype}
60035 * (which MUST be greater than 0) to the message queue specified by
60036 * {@link queue}.
60037 *
60038 * @param resource $queue Message queue resource handle
60039 * @param int $msgtype The type of the message (MUST be greater than 0)
60040 * @param mixed $message The body of the message.
60041 * @param bool $serialize The optional {@link serialize} controls how
60042 *   the {@link message} is sent. {@link serialize} defaults to TRUE
60043 *   which means that the {@link message} is serialized using the same
60044 *   mechanism as the session module before being sent to the queue. This
60045 *   allows complex arrays and objects to be sent to other PHP scripts,
60046 *   or if you are using the WDDX serializer, to any WDDX compatible
60047 *   client.
60048 * @param bool $blocking If the message is too large to fit in the
60049 *   queue, your script will wait until another process reads messages
60050 *   from the queue and frees enough space for your message to be sent.
60051 *   This is called blocking; you can prevent blocking by setting the
60052 *   optional {@link blocking} parameter to FALSE, in which case {@link
60053 *   msg_send} will immediately return FALSE if the message is too big
60054 *   for the queue, and set the optional {@link errorcode} to MSG_EAGAIN,
60055 *   indicating that you should try to send your message again a little
60056 *   later on.
60057 * @param int $errorcode If the function fails, the optional errorcode
60058 *   will be set to the value of the system errno variable.
60059 * @return bool
60060 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
60061 **/
60062function msg_send($queue, $msgtype, $message, $serialize, $blocking, &$errorcode){}
60063
60064/**
60065 * Set information in the message queue data structure
60066 *
60067 * {@link msg_set_queue} allows you to change the values of the
60068 * msg_perm.uid, msg_perm.gid, msg_perm.mode and msg_qbytes fields of the
60069 * underlying message queue data structure.
60070 *
60071 * Changing the data structure will require that PHP be running as the
60072 * same user that created the queue, owns the queue (as determined by the
60073 * existing msg_perm.xxx fields), or be running with root privileges.
60074 * root privileges are required to raise the msg_qbytes values above the
60075 * system defined limit.
60076 *
60077 * @param resource $queue Message queue resource handle
60078 * @param array $data You specify the values you require by setting the
60079 *   value of the keys that you require in the {@link data} array.
60080 * @return bool
60081 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
60082 **/
60083function msg_set_queue($queue, $data){}
60084
60085/**
60086 * Returns information from the message queue data structure
60087 *
60088 * {@link msg_stat_queue} returns the message queue meta data for the
60089 * message queue specified by the {@link queue}. This is useful, for
60090 * example, to determine which process sent the message that was just
60091 * received.
60092 *
60093 * @param resource $queue Message queue resource handle
60094 * @return array The return value is an array whose keys and values
60095 *   have the following meanings: Array structure for msg_stat_queue
60096 *   msg_perm.uid The uid of the owner of the queue. msg_perm.gid The gid
60097 *   of the owner of the queue. msg_perm.mode The file access mode of the
60098 *   queue. msg_stime The time that the last message was sent to the
60099 *   queue. msg_rtime The time that the last message was received from
60100 *   the queue. msg_ctime The time that the queue was last changed.
60101 *   msg_qnum The number of messages waiting to be read from the queue.
60102 *   msg_qbytes The maximum number of bytes allowed in one message queue.
60103 *   On Linux, this value may be read and modified via
60104 *   /proc/sys/kernel/msgmnb. msg_lspid The pid of the process that sent
60105 *   the last message to the queue. msg_lrpid The pid of the process that
60106 *   received the last message from the queue.
60107 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
60108 **/
60109function msg_stat_queue($queue){}
60110
60111/**
60112 * Send mSQL query
60113 *
60114 * {@link msql} selects a database and executes a query on it.
60115 *
60116 * @param string $database The name of the mSQL database.
60117 * @param string $query The SQL query.
60118 * @param resource $link_identifier
60119 * @return resource Returns a positive mSQL query identifier to the
60120 *   query result, or FALSE on error.
60121 * @since PHP 4, PHP 5 < 5.3.0
60122 **/
60123function msql($database, $query, $link_identifier){}
60124
60125/**
60126 * Returns number of affected rows
60127 *
60128 * Returns number of affected rows by the last SELECT, UPDATE or DELETE
60129 * query associated with {@link result}.
60130 *
60131 * @param resource $result
60132 * @return int Returns the number of affected rows on success, or FALSE
60133 *   on error.
60134 * @since PHP 4, PHP 5 < 5.3.0
60135 **/
60136function msql_affected_rows($result){}
60137
60138/**
60139 * Close mSQL connection
60140 *
60141 * {@link msql_close} closes the non-persistent connection to the mSQL
60142 * server that's associated with the specified link identifier.
60143 *
60144 * Using {@link msql_close} isn't usually necessary, as non-persistent
60145 * open links are automatically closed at the end of the script's
60146 * execution. See also freeing resources.
60147 *
60148 * @param resource $link_identifier
60149 * @return bool
60150 * @since PHP 4, PHP 5 < 5.3.0
60151 **/
60152function msql_close($link_identifier){}
60153
60154/**
60155 * Open mSQL connection
60156 *
60157 * {@link msql_connect} establishes a connection to a mSQL server.
60158 *
60159 * If a second call is made to {@link msql_connect} with the same
60160 * arguments, no new link will be established, but instead, the link
60161 * identifier of the already opened link will be returned.
60162 *
60163 * The link to the server will be closed as soon as the execution of the
60164 * script ends, unless it's closed earlier by explicitly calling {@link
60165 * msql_close}.
60166 *
60167 * @param string $hostname The hostname can also include a port number.
60168 *   e.g. hostname,port. If not specified, the connection is established
60169 *   by the means of a Unix domain socket, being then more efficient then
60170 *   a localhost TCP socket connection.
60171 * @return resource Returns a positive mSQL link identifier on success,
60172 *   or FALSE on error.
60173 * @since PHP 4, PHP 5 < 5.3.0
60174 **/
60175function msql_connect($hostname){}
60176
60177/**
60178 * Create mSQL database
60179 *
60180 * {@link msql_createdb} attempts to create a new database on the mSQL
60181 * server.
60182 *
60183 * @param string $database_name The name of the mSQL database.
60184 * @param resource $link_identifier
60185 * @return bool
60186 * @since PHP 4, PHP 5 < 5.3.0
60187 **/
60188function msql_createdb($database_name, $link_identifier){}
60189
60190/**
60191 * Create mSQL database
60192 *
60193 * {@link msql_create_db} attempts to create a new database on the mSQL
60194 * server.
60195 *
60196 * @param string $database_name The name of the mSQL database.
60197 * @param resource $link_identifier
60198 * @return bool
60199 * @since PHP 4, PHP 5 < 5.3.0
60200 **/
60201function msql_create_db($database_name, $link_identifier){}
60202
60203/**
60204 * Move internal row pointer
60205 *
60206 * {@link msql_data_seek} moves the internal row pointer of the mSQL
60207 * result associated with the specified query identifier to point to the
60208 * specified row number. The next call to {@link msql_fetch_row} would
60209 * return that row.
60210 *
60211 * @param resource $result The seeked row number.
60212 * @param int $row_number
60213 * @return bool
60214 * @since PHP 4, PHP 5 < 5.3.0
60215 **/
60216function msql_data_seek($result, $row_number){}
60217
60218/**
60219 * Get result data
60220 *
60221 * {@link msql_dbname} returns the contents of one cell from a mSQL
60222 * result set.
60223 *
60224 * When working on large result sets, you should consider using one of
60225 * the functions that fetch an entire row (specified below). As these
60226 * functions return the contents of multiple cells in one function call,
60227 * they are often much quicker than {@link msql_dbname}.
60228 *
60229 * Recommended high-performance alternatives: {@link msql_fetch_row},
60230 * {@link msql_fetch_array}, and {@link msql_fetch_object}.
60231 *
60232 * @param resource $result The row offset.
60233 * @param int $row Can be the field's offset, or the field's name, or
60234 *   the field's table dot field's name (tablename.fieldname.). If the
60235 *   column name has been aliased ('select foo as bar from ...'), use the
60236 *   alias instead of the column name.
60237 * @param mixed $field
60238 * @return string Returns the contents of the cell at the row and
60239 *   offset in the specified mSQL result set.
60240 * @since PHP 4, PHP 5 < 5.3.0
60241 **/
60242function msql_dbname($result, $row, $field){}
60243
60244/**
60245 * Send mSQL query
60246 *
60247 * {@link msql_db_query} selects a database and executes a query on it.
60248 *
60249 * @param string $database The name of the mSQL database.
60250 * @param string $query The SQL query.
60251 * @param resource $link_identifier
60252 * @return resource Returns a positive mSQL query identifier to the
60253 *   query result, or FALSE on error.
60254 * @since PHP 4, PHP 5 < 5.3.0
60255 **/
60256function msql_db_query($database, $query, $link_identifier){}
60257
60258/**
60259 * Drop (delete) mSQL database
60260 *
60261 * {@link msql_drop_db} attempts to drop (remove) a database from the
60262 * mSQL server.
60263 *
60264 * @param string $database_name The name of the database.
60265 * @param resource $link_identifier
60266 * @return bool
60267 * @since PHP 4, PHP 5 < 5.3.0
60268 **/
60269function msql_drop_db($database_name, $link_identifier){}
60270
60271/**
60272 * Returns error message of last msql call
60273 *
60274 * {@link msql_error} returns the last issued error by the mSQL server.
60275 * Note that only the last error message is accessible with {@link
60276 * msql_error}.
60277 *
60278 * @return string The last error message or an empty string if no error
60279 *   was issued.
60280 * @since PHP 4, PHP 5 < 5.3.0
60281 **/
60282function msql_error(){}
60283
60284/**
60285 * Fetch row as array
60286 *
60287 * {@link msql_fetch_array} is an extended version of {@link
60288 * msql_fetch_row}. In addition to storing the data in the numeric
60289 * indices of the result array, it also stores the data in associative
60290 * indices, using the field names as keys.
60291 *
60292 * An important thing to note is that using {@link msql_fetch_array} is
60293 * NOT significantly slower than using {@link msql_fetch_row}, while it
60294 * provides a significant added value.
60295 *
60296 * @param resource $result A constant that can take the following
60297 *   values: MSQL_ASSOC, MSQL_NUM, and MSQL_BOTH with MSQL_BOTH being the
60298 *   default.
60299 * @param int $result_type
60300 * @return array Returns an array that corresponds to the fetched row,
60301 *   or FALSE if there are no more rows.
60302 * @since PHP 4, PHP 5 < 5.3.0
60303 **/
60304function msql_fetch_array($result, $result_type){}
60305
60306/**
60307 * Get field information
60308 *
60309 * {@link msql_fetch_field} can be used in order to obtain information
60310 * about fields in a certain query result.
60311 *
60312 * @param resource $result The field offset. If not specified, the next
60313 *   field that wasn't yet retrieved by {@link msql_fetch_field} is
60314 *   retrieved.
60315 * @param int $field_offset
60316 * @return object Returns an object containing field information. The
60317 *   properties of the object are: name - column name table - name of the
60318 *   table the column belongs to not_null - 1 if the column cannot be
60319 *   NULL unique - 1 if the column is a unique key type - the type of the
60320 *   column
60321 * @since PHP 4, PHP 5 < 5.3.0
60322 **/
60323function msql_fetch_field($result, $field_offset){}
60324
60325/**
60326 * Fetch row as object
60327 *
60328 * {@link msql_fetch_object} is similar to {@link msql_fetch_array}, with
60329 * one difference - an object is returned, instead of an array.
60330 * Indirectly, that means that you can only access the data by the field
60331 * names, and not by their offsets (numbers are illegal property names).
60332 *
60333 * Speed-wise, the function is identical to {@link msql_fetch_array}, and
60334 * almost as quick as {@link msql_fetch_row} (the difference is
60335 * insignificant).
60336 *
60337 * @param resource $result
60338 * @return object Returns an object with properties that correspond to
60339 *   the fetched row, or FALSE if there are no more rows.
60340 * @since PHP 4, PHP 5 < 5.3.0
60341 **/
60342function msql_fetch_object($result){}
60343
60344/**
60345 * Get row as enumerated array
60346 *
60347 * {@link msql_fetch_row} fetches one row of data from the result
60348 * associated with the specified query identifier. The row is returned as
60349 * an array. Each result column is stored in an array offset, starting at
60350 * offset 0.
60351 *
60352 * Subsequent call to {@link msql_fetch_row} would return the next row in
60353 * the result set, or FALSE if there are no more rows.
60354 *
60355 * @param resource $result
60356 * @return array Returns an array that corresponds to the fetched row,
60357 *   or FALSE if there are no more rows.
60358 * @since PHP 4, PHP 5 < 5.3.0
60359 **/
60360function msql_fetch_row($result){}
60361
60362/**
60363 * Get field flags
60364 *
60365 * {@link msql_fieldflags} returns the field flags of the specified
60366 * field.
60367 *
60368 * @param resource $result
60369 * @param int $field_offset
60370 * @return string Returns a string containing the field flags of the
60371 *   specified key. This can be: primary key not null, not null, primary
60372 *   key, unique not null or unique.
60373 * @since PHP 4, PHP 5 < 5.3.0
60374 **/
60375function msql_fieldflags($result, $field_offset){}
60376
60377/**
60378 * Get field length
60379 *
60380 * {@link msql_fieldlen} returns the length of the specified field.
60381 *
60382 * @param resource $result
60383 * @param int $field_offset
60384 * @return int Returns the length of the specified field or FALSE on
60385 *   error.
60386 * @since PHP 4, PHP 5 < 5.3.0
60387 **/
60388function msql_fieldlen($result, $field_offset){}
60389
60390/**
60391 * Get the name of the specified field in a result
60392 *
60393 * {@link msql_fieldname} gets the name of the specified field index.
60394 *
60395 * @param resource $result
60396 * @param int $field_offset
60397 * @return string The name of the field.
60398 * @since PHP 4, PHP 5 < 5.3.0
60399 **/
60400function msql_fieldname($result, $field_offset){}
60401
60402/**
60403 * Get table name for field
60404 *
60405 * Returns the name of the table that the specified field is in.
60406 *
60407 * @param resource $result
60408 * @param int $field_offset
60409 * @return int The name of the table on success.
60410 * @since PHP 4, PHP 5 < 5.3.0
60411 **/
60412function msql_fieldtable($result, $field_offset){}
60413
60414/**
60415 * Get field type
60416 *
60417 * {@link msql_fieldtype} gets the type of the specified field index.
60418 *
60419 * @param resource $result
60420 * @param int $field_offset
60421 * @return string The type of the field. One of int, char, real, ident,
60422 *   null or unknown. This functions will return FALSE on failure.
60423 * @since PHP 4, PHP 5 < 5.3.0
60424 **/
60425function msql_fieldtype($result, $field_offset){}
60426
60427/**
60428 * Get field flags
60429 *
60430 * {@link msql_field_flags} returns the field flags of the specified
60431 * field.
60432 *
60433 * @param resource $result
60434 * @param int $field_offset
60435 * @return string Returns a string containing the field flags of the
60436 *   specified key. This can be: primary key not null, not null, primary
60437 *   key, unique not null or unique.
60438 * @since PHP 4, PHP 5 < 5.3.0
60439 **/
60440function msql_field_flags($result, $field_offset){}
60441
60442/**
60443 * Get field length
60444 *
60445 * {@link msql_field_len} returns the length of the specified field.
60446 *
60447 * @param resource $result
60448 * @param int $field_offset
60449 * @return int Returns the length of the specified field or FALSE on
60450 *   error.
60451 * @since PHP 4, PHP 5 < 5.3.0
60452 **/
60453function msql_field_len($result, $field_offset){}
60454
60455/**
60456 * Get the name of the specified field in a result
60457 *
60458 * {@link msql_field_name} gets the name of the specified field index.
60459 *
60460 * @param resource $result
60461 * @param int $field_offset
60462 * @return string The name of the field.
60463 * @since PHP 4, PHP 5 < 5.3.0
60464 **/
60465function msql_field_name($result, $field_offset){}
60466
60467/**
60468 * Set field offset
60469 *
60470 * Seeks to the specified field offset. If the next call to {@link
60471 * msql_fetch_field} won't include a field offset, this field would be
60472 * returned.
60473 *
60474 * @param resource $result
60475 * @param int $field_offset
60476 * @return bool
60477 * @since PHP 4, PHP 5 < 5.3.0
60478 **/
60479function msql_field_seek($result, $field_offset){}
60480
60481/**
60482 * Get table name for field
60483 *
60484 * Returns the name of the table that the specified field is in.
60485 *
60486 * @param resource $result
60487 * @param int $field_offset
60488 * @return int The name of the table on success.
60489 * @since PHP 4, PHP 5 < 5.3.0
60490 **/
60491function msql_field_table($result, $field_offset){}
60492
60493/**
60494 * Get field type
60495 *
60496 * {@link msql_field_type} gets the type of the specified field index.
60497 *
60498 * @param resource $result
60499 * @param int $field_offset
60500 * @return string The type of the field. One of int, char, real, ident,
60501 *   null or unknown. This functions will return FALSE on failure.
60502 * @since PHP 4, PHP 5 < 5.3.0
60503 **/
60504function msql_field_type($result, $field_offset){}
60505
60506/**
60507 * Free result memory
60508 *
60509 * {@link msql_free_result} frees the memory associated with {@link
60510 * query_identifier}. When PHP completes a request, this memory is freed
60511 * automatically, so you only need to call this function when you want to
60512 * make sure you don't use too much memory while the script is running.
60513 *
60514 * @param resource $result
60515 * @return bool
60516 * @since PHP 4, PHP 5 < 5.3.0
60517 **/
60518function msql_free_result($result){}
60519
60520/**
60521 * List mSQL databases on server
60522 *
60523 * {@link msql_list_tables} lists the databases available on the
60524 * specified {@link link_identifier}.
60525 *
60526 * @param resource $link_identifier
60527 * @return resource Returns a result set which may be traversed with
60528 *   any function that fetches result sets, such as {@link
60529 *   msql_fetch_array}. On failure, this function will return FALSE.
60530 * @since PHP 4, PHP 5 < 5.3.0
60531 **/
60532function msql_list_dbs($link_identifier){}
60533
60534/**
60535 * List result fields
60536 *
60537 * {@link msql_list_fields} returns information about the given table.
60538 *
60539 * @param string $database The name of the database.
60540 * @param string $tablename The name of the table.
60541 * @param resource $link_identifier
60542 * @return resource Returns a result set which may be traversed with
60543 *   any function that fetches result sets, such as {@link
60544 *   msql_fetch_array}. On failure, this function will return FALSE.
60545 * @since PHP 4, PHP 5 < 5.3.0
60546 **/
60547function msql_list_fields($database, $tablename, $link_identifier){}
60548
60549/**
60550 * List tables in an mSQL database
60551 *
60552 * {@link msql_list_tables} lists the tables on the specified {@link
60553 * database}.
60554 *
60555 * @param string $database The name of the database.
60556 * @param resource $link_identifier
60557 * @return resource Returns a result set which may be traversed with
60558 *   any function that fetches result sets, such as {@link
60559 *   msql_fetch_array}. On failure, this function will return FALSE.
60560 * @since PHP 4, PHP 5 < 5.3.0
60561 **/
60562function msql_list_tables($database, $link_identifier){}
60563
60564/**
60565 * Get number of fields in result
60566 *
60567 * {@link msql_numfields} returns the number of fields in a result set.
60568 *
60569 * @param resource $result
60570 * @return int Returns the number of fields in the result set.
60571 * @since PHP 4, PHP 5 < 5.3.0
60572 **/
60573function msql_numfields($result){}
60574
60575/**
60576 * Get number of rows in result
60577 *
60578 * {@link msql_numrows} returns the number of rows in a result set.
60579 *
60580 * @param resource $query_identifier
60581 * @return int Returns the number of rows in the result set.
60582 * @since PHP 4, PHP 5 < 5.3.0
60583 **/
60584function msql_numrows($query_identifier){}
60585
60586/**
60587 * Get number of fields in result
60588 *
60589 * {@link msql_num_fields} returns the number of fields in a result set.
60590 *
60591 * @param resource $result
60592 * @return int Returns the number of fields in the result set.
60593 * @since PHP 4, PHP 5 < 5.3.0
60594 **/
60595function msql_num_fields($result){}
60596
60597/**
60598 * Get number of rows in result
60599 *
60600 * {@link msql_num_rows} returns the number of rows in a result set.
60601 *
60602 * @param resource $query_identifier
60603 * @return int Returns the number of rows in the result set.
60604 * @since PHP 4, PHP 5 < 5.3.0
60605 **/
60606function msql_num_rows($query_identifier){}
60607
60608/**
60609 * Open persistent mSQL connection
60610 *
60611 * {@link msql_pconnect} acts very much like {@link msql_connect} with
60612 * two major differences.
60613 *
60614 * First, when connecting, the function would first try to find a
60615 * (persistent) link that's already open with the same host. If one is
60616 * found, an identifier for it will be returned instead of opening a new
60617 * connection.
60618 *
60619 * Second, the connection to the SQL server will not be closed when the
60620 * execution of the script ends. Instead, the link will remain open for
60621 * future use ({@link msql_close} will not close links established by
60622 * this function).
60623 *
60624 * @param string $hostname The hostname can also include a port number.
60625 *   e.g. hostname,port. If not specified, the connection is established
60626 *   by the means of a Unix domain socket, being more efficient than a
60627 *   localhost TCP socket connection.
60628 * @return resource Returns a positive mSQL link identifier on success,
60629 *   or FALSE on error.
60630 * @since PHP 4, PHP 5 < 5.3.0
60631 **/
60632function msql_pconnect($hostname){}
60633
60634/**
60635 * Send mSQL query
60636 *
60637 * {@link msql_query} sends a query to the currently active database on
60638 * the server that's associated with the specified link identifier.
60639 *
60640 * @param string $query The SQL query.
60641 * @param resource $link_identifier
60642 * @return resource Returns a positive mSQL query identifier on
60643 *   success, or FALSE on error.
60644 * @since PHP 4, PHP 5 < 5.3.0
60645 **/
60646function msql_query($query, $link_identifier){}
60647
60648/**
60649 * Make regular expression for case insensitive match
60650 *
60651 * Creates a regular expression for a case insensitive match.
60652 *
60653 * @param string $string The input string.
60654 * @return string Returns a valid regular expression which will match
60655 *   {@link string}, ignoring case. This expression is {@link string}
60656 *   with each alphabetic character converted to a bracket expression;
60657 *   this bracket expression contains that character's uppercase and
60658 *   lowercase form. Other characters remain unchanged.
60659 * @since PHP 4, PHP 5 < 5.3.0
60660 **/
60661function msql_regcase($string){}
60662
60663/**
60664 * Get result data
60665 *
60666 * {@link msql_result} returns the contents of one cell from a mSQL
60667 * result set.
60668 *
60669 * When working on large result sets, you should consider using one of
60670 * the functions that fetch an entire row (specified below). As these
60671 * functions return the contents of multiple cells in one function call,
60672 * they are often much quicker than {@link msql_result}.
60673 *
60674 * Recommended high-performance alternatives: {@link msql_fetch_row},
60675 * {@link msql_fetch_array}, and {@link msql_fetch_object}.
60676 *
60677 * @param resource $result The row offset.
60678 * @param int $row Can be the field's offset, or the field's name, or
60679 *   the field's table dot field's name (tablename.fieldname.). If the
60680 *   column name has been aliased ('select foo as bar from ...'), use the
60681 *   alias instead of the column name.
60682 * @param mixed $field
60683 * @return string Returns the contents of the cell at the row and
60684 *   offset in the specified mSQL result set.
60685 * @since PHP 4, PHP 5 < 5.3.0
60686 **/
60687function msql_result($result, $row, $field){}
60688
60689/**
60690 * Select mSQL database
60691 *
60692 * {@link msql_select_db} sets the current active database on the server
60693 * that's associated with the specified {@link link_identifier}.
60694 *
60695 * Subsequent calls to {@link msql_query} will be made on the active
60696 * database.
60697 *
60698 * @param string $database_name The database name.
60699 * @param resource $link_identifier
60700 * @return bool
60701 * @since PHP 4, PHP 5 < 5.3.0
60702 **/
60703function msql_select_db($database_name, $link_identifier){}
60704
60705/**
60706 * Get result data
60707 *
60708 * {@link msql_tablename} returns the contents of one cell from a mSQL
60709 * result set.
60710 *
60711 * When working on large result sets, you should consider using one of
60712 * the functions that fetch an entire row (specified below). As these
60713 * functions return the contents of multiple cells in one function call,
60714 * they are often much quicker than {@link msql_tablename}.
60715 *
60716 * Recommended high-performance alternatives: {@link msql_fetch_row},
60717 * {@link msql_fetch_array}, and {@link msql_fetch_object}.
60718 *
60719 * @param resource $result The row offset.
60720 * @param int $row Can be the field's offset, or the field's name, or
60721 *   the field's table dot field's name (tablename.fieldname.). If the
60722 *   column name has been aliased ('select foo as bar from ...'), use the
60723 *   alias instead of the column name.
60724 * @param mixed $field
60725 * @return string Returns the contents of the cell at the row and
60726 *   offset in the specified mSQL result set.
60727 * @since PHP 4, PHP 5 < 5.3.0
60728 **/
60729function msql_tablename($result, $row, $field){}
60730
60731/**
60732 * Adds a parameter to a stored procedure or a remote stored procedure
60733 *
60734 * Binds a parameter to a stored procedure or a remote stored procedure.
60735 *
60736 * @param resource $stmt Statement resource, obtained with {@link
60737 *   mssql_init}.
60738 * @param string $param_name The parameter name, as a string.
60739 * @param mixed $var The PHP variable you'll bind the MSSQL parameter
60740 *   to. It is passed by reference, to retrieve OUTPUT and RETVAL values
60741 *   after the procedure execution.
60742 * @param int $type One of: SQLTEXT, SQLVARCHAR, SQLCHAR, SQLINT1,
60743 *   SQLINT2, SQLINT4, SQLBIT, SQLFLT4, SQLFLT8, SQLFLTN.
60744 * @param bool $is_output Whether the value is an OUTPUT parameter or
60745 *   not. If it's an OUTPUT parameter and you don't mention it, it will
60746 *   be treated as a normal input parameter and no error will be thrown.
60747 * @param bool $is_null Whether the parameter is NULL or not. Passing
60748 *   the NULL value as {@link var} will not do the job.
60749 * @param int $maxlen Used with char/varchar values. You have to
60750 *   indicate the length of the data so if the parameter is a
60751 *   varchar(50), the type must be SQLVARCHAR and this value 50.
60752 * @return bool
60753 * @since PHP 4 >= 4.0.7, PHP 5, PECL odbtp >= 1.1.1
60754 **/
60755function mssql_bind($stmt, $param_name, &$var, $type, $is_output, $is_null, $maxlen){}
60756
60757/**
60758 * Close MS SQL Server connection
60759 *
60760 * Closes the link to a MS SQL Server database that's associated with the
60761 * specified link identifier. If the link identifier isn't specified, the
60762 * last opened link is assumed.
60763 *
60764 * Note that this isn't usually necessary, as non-persistent open links
60765 * are automatically closed at the end of the script's execution.
60766 *
60767 * @param resource $link_identifier A MS SQL link identifier, returned
60768 *   by {@link mssql_connect}. This function will not close persistent
60769 *   links generated by {@link mssql_pconnect}.
60770 * @return bool
60771 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
60772 **/
60773function mssql_close($link_identifier){}
60774
60775/**
60776 * Open MS SQL server connection
60777 *
60778 * {@link mssql_connect} establishes a connection to a MS SQL server.
60779 *
60780 * The link to the server will be closed as soon as the execution of the
60781 * script ends, unless it's closed earlier by explicitly calling {@link
60782 * mssql_close}.
60783 *
60784 * @param string $servername The MS SQL server. It can also include a
60785 *   port number, e.g. hostname:port (Linux), or hostname,port (Windows).
60786 * @param string $username The username.
60787 * @param string $password The password.
60788 * @param bool $new_link If a second call is made to {@link
60789 *   mssql_connect} with the same arguments, no new link will be
60790 *   established, but instead, the link identifier of the already opened
60791 *   link will be returned. This parameter modifies this behavior and
60792 *   makes {@link mssql_connect} always open a new link, even if {@link
60793 *   mssql_connect} was called before with the same parameters.
60794 * @return resource Returns a MS SQL link identifier on success, or
60795 *   FALSE on error.
60796 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
60797 **/
60798function mssql_connect($servername, $username, $password, $new_link){}
60799
60800/**
60801 * Moves internal row pointer
60802 *
60803 * {@link mssql_data_seek} moves the internal row pointer of the MS SQL
60804 * result associated with the specified result identifier to point to the
60805 * specified row number, first row being number 0. The next call to
60806 * {@link mssql_fetch_row} would return that row.
60807 *
60808 * @param resource $result_identifier The result resource that is being
60809 *   evaluated.
60810 * @param int $row_number The desired row number of the new result
60811 *   pointer.
60812 * @return bool
60813 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
60814 **/
60815function mssql_data_seek($result_identifier, $row_number){}
60816
60817/**
60818 * Executes a stored procedure on a MS SQL server database
60819 *
60820 * @param resource $stmt Statement handle obtained with {@link
60821 *   mssql_init}.
60822 * @param bool $skip_results Whenever to skip the results or not.
60823 * @return mixed
60824 * @since PHP 4 >= 4.0.7, PHP 5, PECL odbtp >= 1.1.1
60825 **/
60826function mssql_execute($stmt, $skip_results){}
60827
60828/**
60829 * Fetch a result row as an associative array, a numeric array, or both
60830 *
60831 * {@link mssql_fetch_array} is an extended version of {@link
60832 * mssql_fetch_row}. In addition to storing the data in the numeric
60833 * indices of the result array, it also stores the data in associative
60834 * indices, using the field names as keys.
60835 *
60836 * An important thing to note is that using {@link mssql_fetch_array} is
60837 * NOT significantly slower than using {@link mssql_fetch_row}, while it
60838 * provides a significant added value.
60839 *
60840 * @param resource $result The result resource that is being evaluated.
60841 *   This result comes from a call to {@link mssql_query}.
60842 * @param int $result_type The type of array that is to be fetched.
60843 *   It's a constant and can take the following values: MSSQL_ASSOC,
60844 *   MSSQL_NUM, and MSSQL_BOTH.
60845 * @return array Returns an array that corresponds to the fetched row,
60846 *   or FALSE if there are no more rows.
60847 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
60848 **/
60849function mssql_fetch_array($result, $result_type){}
60850
60851/**
60852 * Returns an associative array of the current row in the result
60853 *
60854 * Returns an associative array that corresponds to the fetched row and
60855 * moves the internal data pointer ahead. {@link mssql_fetch_assoc} is
60856 * equivalent to calling {@link mssql_fetch_array} with MSSQL_ASSOC for
60857 * the optional second parameter.
60858 *
60859 * @param resource $result_id The result resource that is being
60860 *   evaluated. This result comes from a call to {@link mssql_query}.
60861 * @return array Returns an associative array that corresponds to the
60862 *   fetched row, or FALSE if there are no more rows.
60863 * @since PHP 4 >= 4.2.0, PHP 5, PECL odbtp >= 1.1.1
60864 **/
60865function mssql_fetch_assoc($result_id){}
60866
60867/**
60868 * Returns the next batch of records
60869 *
60870 * @param resource $result The result resource that is being evaluated.
60871 *   This result comes from a call to {@link mssql_query}.
60872 * @return int Returns the number of rows in the returned batch.
60873 * @since PHP 4 >= 4.0.4, PHP 5, PECL odbtp >= 1.1.1
60874 **/
60875function mssql_fetch_batch($result){}
60876
60877/**
60878 * Get field information
60879 *
60880 * {@link mssql_fetch_field} can be used in order to obtain information
60881 * about fields in a certain query result.
60882 *
60883 * @param resource $result The result resource that is being evaluated.
60884 *   This result comes from a call to {@link mssql_query}.
60885 * @param int $field_offset The numerical field offset. If the field
60886 *   offset is not specified, the next field that was not yet retrieved
60887 *   by this function is retrieved. The {@link field_offset} starts at 0.
60888 * @return object Returns an object containing field information.
60889 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
60890 **/
60891function mssql_fetch_field($result, $field_offset){}
60892
60893/**
60894 * Fetch row as object
60895 *
60896 * {@link mssql_fetch_object} is similar to {@link mssql_fetch_array},
60897 * with one difference - an object is returned, instead of an array.
60898 * Indirectly, that means that you can only access the data by the field
60899 * names, and not by their offsets (numbers are illegal property names).
60900 *
60901 * Speed-wise, the function is identical to {@link mssql_fetch_array},
60902 * and almost as quick as {@link mssql_fetch_row} (the difference is
60903 * insignificant).
60904 *
60905 * @param resource $result The result resource that is being evaluated.
60906 *   This result comes from a call to {@link mssql_query}.
60907 * @return object Returns an object with properties that correspond to
60908 *   the fetched row, or FALSE if there are no more rows.
60909 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
60910 **/
60911function mssql_fetch_object($result){}
60912
60913/**
60914 * Get row as enumerated array
60915 *
60916 * {@link mssql_fetch_row} fetches one row of data from the result
60917 * associated with the specified result identifier. The row is returned
60918 * as an array. Each result column is stored in an array offset, starting
60919 * at offset 0.
60920 *
60921 * Subsequent call to {@link mssql_fetch_row} would return the next row
60922 * in the result set, or FALSE if there are no more rows.
60923 *
60924 * @param resource $result The result resource that is being evaluated.
60925 *   This result comes from a call to {@link mssql_query}.
60926 * @return array Returns an array that corresponds to the fetched row,
60927 *   or FALSE if there are no more rows.
60928 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
60929 **/
60930function mssql_fetch_row($result){}
60931
60932/**
60933 * Get the length of a field
60934 *
60935 * Returns the length of field no. {@link offset} in {@link result}.
60936 *
60937 * @param resource $result The result resource that is being evaluated.
60938 *   This result comes from a call to {@link mssql_query}.
60939 * @param int $offset The field offset, starts at 0. If omitted, the
60940 *   current field is used.
60941 * @return int The length of the specified field index on success.
60942 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
60943 **/
60944function mssql_field_length($result, $offset){}
60945
60946/**
60947 * Get the name of a field
60948 *
60949 * Returns the name of field no. {@link offset} in {@link result}.
60950 *
60951 * @param resource $result The result resource that is being evaluated.
60952 *   This result comes from a call to {@link mssql_query}.
60953 * @param int $offset The field offset, starts at 0. If omitted, the
60954 *   current field is used.
60955 * @return string The name of the specified field index on success.
60956 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
60957 **/
60958function mssql_field_name($result, $offset){}
60959
60960/**
60961 * Seeks to the specified field offset
60962 *
60963 * Seeks to the specified field offset. If the next call to {@link
60964 * mssql_fetch_field} won't include a field offset, this field would be
60965 * returned.
60966 *
60967 * @param resource $result The result resource that is being evaluated.
60968 *   This result comes from a call to {@link mssql_query}.
60969 * @param int $field_offset The field offset, starts at 0.
60970 * @return bool
60971 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
60972 **/
60973function mssql_field_seek($result, $field_offset){}
60974
60975/**
60976 * Gets the type of a field
60977 *
60978 * Returns the type of field no. {@link offset} in {@link result}.
60979 *
60980 * @param resource $result The result resource that is being evaluated.
60981 *   This result comes from a call to {@link mssql_query}.
60982 * @param int $offset The field offset, starts at 0. If omitted, the
60983 *   current field is used.
60984 * @return string The type of the specified field index on success.
60985 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
60986 **/
60987function mssql_field_type($result, $offset){}
60988
60989/**
60990 * Free result memory
60991 *
60992 * {@link mssql_free_result} only needs to be called if you are worried
60993 * about using too much memory while your script is running. All result
60994 * memory will automatically be freed when the script ends. You may call
60995 * {@link mssql_free_result} with the result identifier as an argument
60996 * and the associated result memory will be freed.
60997 *
60998 * @param resource $result The result resource that is being freed.
60999 *   This result comes from a call to {@link mssql_query}.
61000 * @return bool
61001 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
61002 **/
61003function mssql_free_result($result){}
61004
61005/**
61006 * Free statement memory
61007 *
61008 * {@link mssql_free_statement} only needs to be called if you are
61009 * worried about using too much memory while your script is running. All
61010 * statement memory will automatically be freed when the script ends. You
61011 * may call {@link mssql_free_statement} with the statement identifier as
61012 * an argument and the associated statement memory will be freed.
61013 *
61014 * @param resource $stmt Statement resource, obtained with {@link
61015 *   mssql_init}.
61016 * @return bool
61017 * @since PHP 4 >= 4.3.2, PHP 5, PECL odbtp >= 1.1.1
61018 **/
61019function mssql_free_statement($stmt){}
61020
61021/**
61022 * Returns the last message from the server
61023 *
61024 * Gets the last message from the MS-SQL server
61025 *
61026 * @return string Returns last error message from server, or an empty
61027 *   string if no error messages are returned from MSSQL.
61028 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
61029 **/
61030function mssql_get_last_message(){}
61031
61032/**
61033 * Converts a 16 byte binary GUID to a string
61034 *
61035 * @param string $binary A 16 byte binary GUID.
61036 * @param bool $short_format Whenever to use short format.
61037 * @return string Returns the converted string on success.
61038 * @since PHP 4 >= 4.0.7, PHP 5, PECL odbtp >= 1.1.1
61039 **/
61040function mssql_guid_string($binary, $short_format){}
61041
61042/**
61043 * Initializes a stored procedure or a remote stored procedure
61044 *
61045 * @param string $sp_name Stored procedure name, like ownew.sp_name or
61046 *   otherdb.owner.sp_name.
61047 * @param resource $link_identifier A MS SQL link identifier, returned
61048 *   by {@link mssql_connect}.
61049 * @return resource Returns a resource identifier "statement", used in
61050 *   subsequent calls to {@link mssql_bind} and {@link mssql_execute}, or
61051 *   FALSE on errors.
61052 * @since PHP 4 >= 4.0.7, PHP 5, PECL odbtp >= 1.1.1
61053 **/
61054function mssql_init($sp_name, $link_identifier){}
61055
61056/**
61057 * Sets the minimum error severity
61058 *
61059 * @param int $severity The new error severity.
61060 * @return void
61061 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
61062 **/
61063function mssql_min_error_severity($severity){}
61064
61065/**
61066 * Sets the minimum message severity
61067 *
61068 * @param int $severity The new message severity.
61069 * @return void
61070 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
61071 **/
61072function mssql_min_message_severity($severity){}
61073
61074/**
61075 * Move the internal result pointer to the next result
61076 *
61077 * When sending more than one SQL statement to the server or executing a
61078 * stored procedure with multiple results, it will cause the server to
61079 * return multiple result sets. This function will test for additional
61080 * results available form the server. If an additional result set exists
61081 * it will free the existing result set and prepare to fetch the rows
61082 * from the new result set.
61083 *
61084 * @param resource $result_id The result resource that is being
61085 *   evaluated. This result comes from a call to {@link mssql_query}.
61086 * @return bool Returns TRUE if an additional result set was available
61087 *   or FALSE otherwise.
61088 * @since PHP 4 >= 4.0.5, PHP 5, PECL odbtp >= 1.1.1
61089 **/
61090function mssql_next_result($result_id){}
61091
61092/**
61093 * Gets the number of fields in result
61094 *
61095 * {@link mssql_num_fields} returns the number of fields in a result set.
61096 *
61097 * @param resource $result The result resource that is being evaluated.
61098 *   This result comes from a call to {@link mssql_query}.
61099 * @return int Returns the number of fields, as an integer.
61100 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
61101 **/
61102function mssql_num_fields($result){}
61103
61104/**
61105 * Gets the number of rows in result
61106 *
61107 * {@link mssql_num_rows} returns the number of rows in a result set.
61108 *
61109 * @param resource $result The result resource that is being evaluated.
61110 *   This result comes from a call to {@link mssql_query}.
61111 * @return int Returns the number of rows, as an integer.
61112 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
61113 **/
61114function mssql_num_rows($result){}
61115
61116/**
61117 * Open persistent MS SQL connection
61118 *
61119 * {@link mssql_pconnect} acts very much like {@link mssql_connect} with
61120 * two major differences.
61121 *
61122 * First, when connecting, the function would first try to find a
61123 * (persistent) link that's already open with the same host, username and
61124 * password. If one is found, an identifier for it will be returned
61125 * instead of opening a new connection.
61126 *
61127 * Second, the connection to the SQL server will not be closed when the
61128 * execution of the script ends. Instead, the link will remain open for
61129 * future use ({@link mssql_close} will not close links established by
61130 * {@link mssql_pconnect}).
61131 *
61132 * This type of links is therefore called 'persistent'.
61133 *
61134 * @param string $servername The MS SQL server. It can also include a
61135 *   port number. e.g. hostname:port.
61136 * @param string $username The username.
61137 * @param string $password The password.
61138 * @param bool $new_link If a second call is made to {@link
61139 *   mssql_pconnect} with the same arguments, no new link will be
61140 *   established, but instead, the link identifier of the already opened
61141 *   link will be returned. This parameter modifies this behavior and
61142 *   makes {@link mssql_pconnect} always open a new link, even if {@link
61143 *   mssql_pconnect} was called before with the same parameters.
61144 * @return resource Returns a positive MS SQL persistent link
61145 *   identifier on success, or FALSE on error.
61146 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
61147 **/
61148function mssql_pconnect($servername, $username, $password, $new_link){}
61149
61150/**
61151 * Send MS SQL query
61152 *
61153 * {@link mssql_query} sends a query to the currently active database on
61154 * the server that's associated with the specified link identifier.
61155 *
61156 * @param string $query An SQL query.
61157 * @param resource $link_identifier A MS SQL link identifier, returned
61158 *   by {@link mssql_connect} or {@link mssql_pconnect}. If the link
61159 *   identifier isn't specified, the last opened link is assumed. If no
61160 *   link is open, the function tries to establish a link as if {@link
61161 *   mssql_connect} was called, and use it.
61162 * @param int $batch_size The number of records to batch in the buffer.
61163 * @return mixed Returns a MS SQL result resource on success, TRUE if
61164 *   no rows were returned, or FALSE on error.
61165 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
61166 **/
61167function mssql_query($query, $link_identifier, $batch_size){}
61168
61169/**
61170 * Get result data
61171 *
61172 * {@link mssql_result} returns the contents of one cell from a MS SQL
61173 * result set.
61174 *
61175 * @param resource $result The result resource that is being evaluated.
61176 *   This result comes from a call to {@link mssql_query}.
61177 * @param int $row The row number.
61178 * @param mixed $field Can be the field's offset, the field's name or
61179 *   the field's table dot field's name (tablename.fieldname). If the
61180 *   column name has been aliased ('select foo as bar from...'), it uses
61181 *   the alias instead of the column name.
61182 * @return string Returns the contents of the specified cell.
61183 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
61184 **/
61185function mssql_result($result, $row, $field){}
61186
61187/**
61188 * Returns the number of records affected by the query
61189 *
61190 * Returns the number of records affected by the last write query.
61191 *
61192 * @param resource $link_identifier A MS SQL link identifier, returned
61193 *   by {@link mssql_connect} or {@link mssql_pconnect}.
61194 * @return int Returns the number of records affected by last
61195 *   operation.
61196 * @since PHP 4 >= 4.0.4, PHP 5, PECL odbtp >= 1.1.1
61197 **/
61198function mssql_rows_affected($link_identifier){}
61199
61200/**
61201 * Select MS SQL database
61202 *
61203 * {@link mssql_select_db} sets the current active database on the server
61204 * that's associated with the specified link identifier.
61205 *
61206 * Every subsequent call to {@link mssql_query} will be made on the
61207 * active database.
61208 *
61209 * @param string $database_name The database name. To escape the name
61210 *   of a database that contains spaces, hyphens ("-"), or any other
61211 *   exceptional characters, the database name must be enclosed in
61212 *   brackets, as is shown in the example, below. This technique must
61213 *   also be applied when selecting a database name that is also a
61214 *   reserved word (such as primary).
61215 * @param resource $link_identifier A MS SQL link identifier, returned
61216 *   by {@link mssql_connect} or {@link mssql_pconnect}. If no link
61217 *   identifier is specified, the last opened link is assumed. If no link
61218 *   is open, the function will try to establish a link as if {@link
61219 *   mssql_connect} was called, and use it.
61220 * @return bool
61221 * @since PHP 4, PHP 5, PECL odbtp >= 1.1.1
61222 **/
61223function mssql_select_db($database_name, $link_identifier){}
61224
61225/**
61226 * Show largest possible random value
61227 *
61228 * @return int Returns the maximum random value returned by a call to
61229 *   {@link mt_rand} without arguments, which is the maximum value that
61230 *   can be used for its {@link max} parameter without the result being
61231 *   scaled up (and therefore less random).
61232 * @since PHP 4, PHP 5, PHP 7
61233 **/
61234function mt_getrandmax(){}
61235
61236/**
61237 * Generate a random value via the Mersenne Twister Random Number
61238 * Generator
61239 *
61240 * @return int A random integer value between {@link min} (or 0) and
61241 *   {@link max} (or {@link mt_getrandmax}, inclusive), or FALSE if
61242 *   {@link max} is less than {@link min}.
61243 * @since PHP 4, PHP 5, PHP 7
61244 **/
61245function mt_rand(){}
61246
61247/**
61248 * Seeds the Mersenne Twister Random Number Generator
61249 *
61250 * Seeds the random number generator with {@link seed} or with a random
61251 * value if no {@link seed} is given.
61252 *
61253 * @param int $seed An arbitrary integer seed value.
61254 * @param int $mode Use one of the following constants to specify the
61255 *   implementation of the algorithm to use. Constant MT_RAND_MT19937
61256 *   Uses the fixed, correct, Mersenne Twister implementation, available
61257 *   as of PHP 7.1.0. MT_RAND_PHP Uses an incorrect Mersenne Twister
61258 *   implementation which was used as the default up till PHP 7.1.0. This
61259 *   mode is available for backward compatibility.
61260 * @return void
61261 * @since PHP 4, PHP 5, PHP 7
61262 **/
61263function mt_srand($seed, $mode){}
61264
61265/**
61266 * Gets the number of affected rows in a previous MySQL operation
61267 *
61268 * Returns the number of rows affected by the last INSERT, UPDATE,
61269 * REPLACE or DELETE query.
61270 *
61271 * For SELECT statements {@link mysqli_affected_rows} works like {@link
61272 * mysqli_num_rows}.
61273 *
61274 * @param mysqli $link
61275 * @return int An integer greater than zero indicates the number of
61276 *   rows affected or retrieved. Zero indicates that no records were
61277 *   updated for an UPDATE statement, no rows matched the WHERE clause in
61278 *   the query or that no query has yet been executed. -1 indicates that
61279 *   the query returned an error.
61280 * @since PHP 5, PHP 7
61281 **/
61282function mysqli_affected_rows($link){}
61283
61284/**
61285 * Turns on or off auto-committing database modifications
61286 *
61287 * Turns on or off auto-commit mode on queries for the database
61288 * connection.
61289 *
61290 * To determine the current state of autocommit use the SQL command
61291 * SELECT @@autocommit.
61292 *
61293 * @param mysqli $link Whether to turn on auto-commit or not.
61294 * @param bool $mode
61295 * @return bool
61296 * @since PHP 5, PHP 7
61297 **/
61298function mysqli_autocommit($link, $mode){}
61299
61300/**
61301 * Starts a transaction
61302 *
61303 * Begins a transaction. Requires the InnoDB engine (it is enabled by
61304 * default). For additional details about how MySQL transactions work,
61305 * see .
61306 *
61307 * @param mysqli $link Valid flags are:
61308 * @param int $flags Savepoint name for the transaction.
61309 * @param string $name
61310 * @return bool
61311 * @since PHP 5 >= 5.5.0, PHP 7
61312 **/
61313function mysqli_begin_transaction($link, $flags, $name){}
61314
61315/**
61316 * Changes the user of the specified database connection
61317 *
61318 * Changes the user of the specified database connection and sets the
61319 * current database.
61320 *
61321 * In order to successfully change users a valid {@link username} and
61322 * {@link password} parameters must be provided and that user must have
61323 * sufficient permissions to access the desired database. If for any
61324 * reason authorization fails, the current user authentication will
61325 * remain.
61326 *
61327 * @param mysqli $link The MySQL user name.
61328 * @param string $user The MySQL password.
61329 * @param string $password The database to change to. If desired, the
61330 *   NULL value may be passed resulting in only changing the user and not
61331 *   selecting a database. To select a database in this case use the
61332 *   {@link mysqli_select_db} function.
61333 * @param string $database
61334 * @return bool
61335 * @since PHP 5, PHP 7
61336 **/
61337function mysqli_change_user($link, $user, $password, $database){}
61338
61339/**
61340 * Returns the default character set for the database connection
61341 *
61342 * Returns the current character set for the database connection.
61343 *
61344 * @param mysqli $link
61345 * @return string The default character set for the current connection
61346 * @since PHP 5, PHP 7
61347 **/
61348function mysqli_character_set_name($link){}
61349
61350/**
61351 * Closes a previously opened database connection
61352 *
61353 * @param mysqli $link
61354 * @return bool
61355 * @since PHP 5, PHP 7
61356 **/
61357function mysqli_close($link){}
61358
61359/**
61360 * Commits the current transaction
61361 *
61362 * Commits the current transaction for the database connection.
61363 *
61364 * @param mysqli $link A bitmask of MYSQLI_TRANS_COR_* constants.
61365 * @param int $flags If provided then COMMIT/*name* / is executed.
61366 * @param string $name
61367 * @return bool
61368 * @since PHP 5, PHP 7
61369 **/
61370function mysqli_commit($link, $flags, $name){}
61371
61372/**
61373 * Open a new connection to the MySQL server
61374 *
61375 * Opens a connection to the MySQL Server.
61376 *
61377 * @param string $host Can be either a host name or an IP address.
61378 *   Passing the NULL value or the string "localhost" to this parameter,
61379 *   the local host is assumed. When possible, pipes will be used instead
61380 *   of the TCP/IP protocol. Prepending host by p: opens a persistent
61381 *   connection. {@link mysqli_change_user} is automatically called on
61382 *   connections opened from the connection pool.
61383 * @param string $username The MySQL user name.
61384 * @param string $passwd If not provided or NULL, the MySQL server will
61385 *   attempt to authenticate the user against those user records which
61386 *   have no password only. This allows one username to be used with
61387 *   different permissions (depending on if a password is provided or
61388 *   not).
61389 * @param string $dbname If provided will specify the default database
61390 *   to be used when performing queries.
61391 * @param int $port Specifies the port number to attempt to connect to
61392 *   the MySQL server.
61393 * @param string $socket Specifies the socket or named pipe that should
61394 *   be used.
61395 * @return mysqli Returns an object which represents the connection to
61396 *   a MySQL Server, .
61397 * @since PHP 5, PHP 7
61398 **/
61399function mysqli_connect($host, $username, $passwd, $dbname, $port, $socket){}
61400
61401/**
61402 * Returns the error code from last connect call
61403 *
61404 * Returns the last error code number from the last call to {@link
61405 * mysqli_connect}.
61406 *
61407 * @return int An error code value for the last call to {@link
61408 *   mysqli_connect}, if it failed. zero means no error occurred.
61409 * @since PHP 5, PHP 7
61410 **/
61411function mysqli_connect_errno(){}
61412
61413/**
61414 * Returns a string description of the last connect error
61415 *
61416 * Returns the last error message string from the last call to {@link
61417 * mysqli_connect}.
61418 *
61419 * @return string A string that describes the error. NULL is returned
61420 *   if no error occurred.
61421 * @since PHP 5, PHP 7
61422 **/
61423function mysqli_connect_error(){}
61424
61425/**
61426 * Adjusts the result pointer to an arbitrary row in the result
61427 *
61428 * The {@link mysqli_data_seek} function seeks to an arbitrary result
61429 * pointer specified by the {@link offset} in the result set.
61430 *
61431 * @param mysqli_result $result The field offset. Must be between zero
61432 *   and the total number of rows minus one (0..{@link mysqli_num_rows} -
61433 *   1).
61434 * @param int $offset
61435 * @return bool
61436 * @since PHP 5, PHP 7
61437 **/
61438function mysqli_data_seek($result, $offset){}
61439
61440/**
61441 * Performs debugging operations
61442 *
61443 * Performs debugging operations using the Fred Fish debugging library.
61444 *
61445 * @param string $message A string representing the debugging operation
61446 *   to perform
61447 * @return bool Returns TRUE.
61448 * @since PHP 5, PHP 7
61449 **/
61450function mysqli_debug($message){}
61451
61452/**
61453 * Disable reads from master
61454 *
61455 * @param mysqli $link
61456 * @return bool
61457 * @since PHP 5 < 5.3.0
61458 **/
61459function mysqli_disable_reads_from_master($link){}
61460
61461/**
61462 * Disable RPL parse
61463 *
61464 * @param mysqli $link
61465 * @return bool
61466 * @since PHP 5 < 5.3.0
61467 **/
61468function mysqli_disable_rpl_parse($link){}
61469
61470/**
61471 * Dump debugging information into the log
61472 *
61473 * This function is designed to be executed by an user with the SUPER
61474 * privilege and is used to dump debugging information into the log for
61475 * the MySQL Server relating to the connection.
61476 *
61477 * @param mysqli $link
61478 * @return bool
61479 * @since PHP 5, PHP 7
61480 **/
61481function mysqli_dump_debug_info($link){}
61482
61483/**
61484 * Stop embedded server
61485 *
61486 * @return void
61487 * @since PHP 5 >= 5.1.0, PHP 7 < 7.4.0
61488 **/
61489function mysqli_embedded_server_end(){}
61490
61491/**
61492 * Initialize and start embedded server
61493 *
61494 * @param int $start
61495 * @param array $arguments
61496 * @param array $groups
61497 * @return bool
61498 * @since PHP 5 >= 5.1.0, PHP 7 < 7.4.0
61499 **/
61500function mysqli_embedded_server_start($start, $arguments, $groups){}
61501
61502/**
61503 * Enable reads from master
61504 *
61505 * @param mysqli $link
61506 * @return bool
61507 * @since PHP 5 < 5.3.0
61508 **/
61509function mysqli_enable_reads_from_master($link){}
61510
61511/**
61512 * Enable RPL parse
61513 *
61514 * @param mysqli $link
61515 * @return bool
61516 * @since PHP 5 < 5.3.0
61517 **/
61518function mysqli_enable_rpl_parse($link){}
61519
61520/**
61521 * Returns the error code for the most recent function call
61522 *
61523 * Returns the last error code for the most recent MySQLi function call
61524 * that can succeed or fail.
61525 *
61526 * Client error message numbers are listed in the MySQL errmsg.h header
61527 * file, server error message numbers are listed in mysqld_error.h. In
61528 * the MySQL source distribution you can find a complete list of error
61529 * messages and error numbers in the file Docs/mysqld_error.txt.
61530 *
61531 * @param mysqli $link
61532 * @return int An error code value for the last call, if it failed.
61533 *   zero means no error occurred.
61534 * @since PHP 5, PHP 7
61535 **/
61536function mysqli_errno($link){}
61537
61538/**
61539 * Returns a string description of the last error
61540 *
61541 * Returns the last error message for the most recent MySQLi function
61542 * call that can succeed or fail.
61543 *
61544 * @param mysqli $link
61545 * @return string A string that describes the error. An empty string if
61546 *   no error occurred.
61547 * @since PHP 5, PHP 7
61548 **/
61549function mysqli_error($link){}
61550
61551/**
61552 * Returns a list of errors from the last command executed
61553 *
61554 * Returns a array of errors for the most recent MySQLi function call
61555 * that can succeed or fail.
61556 *
61557 * @param mysqli $link
61558 * @return array A list of errors, each as an associative array
61559 *   containing the errno, error, and sqlstate.
61560 * @since PHP 5 >= 5.4.0, PHP 7
61561 **/
61562function mysqli_error_list($link){}
61563
61564/**
61565 * Escapes special characters in a string for use in an SQL statement,
61566 * taking into account the current charset of the connection
61567 *
61568 * This function is used to create a legal SQL string that you can use in
61569 * an SQL statement. The given string is encoded to an escaped SQL
61570 * string, taking into account the current character set of the
61571 * connection.
61572 *
61573 * @param string $escapestr The string to be escaped. Characters
61574 *   encoded are NUL (ASCII 0), \n, \r, \, ', ", and Control-Z.
61575 * @return string Returns an escaped string.
61576 * @since PHP 5, PHP 7
61577 **/
61578function mysqli_escape_string($escapestr){}
61579
61580/**
61581 * Executes a prepared Query
61582 *
61583 * Executes a query that has been previously prepared using the {@link
61584 * mysqli_prepare} function. When mysqli_executed any parameter markers
61585 * which exist will automatically be replaced with the appropriate data.
61586 *
61587 * If the statement is UPDATE, DELETE, or INSERT, the total number of
61588 * affected rows can be determined by using the {@link
61589 * mysqli_stmt_affected_rows} function. Likewise, if the query yields a
61590 * result set the {@link mysqli_stmt_fetch} function is used.
61591 *
61592 * @return bool
61593 * @since PHP 5, PHP 7
61594 **/
61595function mysqli_execute(){}
61596
61597/**
61598 * Fetches all result rows as an associative array, a numeric array, or
61599 * both
61600 *
61601 * {@link mysqli_fetch_all} fetches all result rows and returns the
61602 * result set as an associative array, a numeric array, or both.
61603 *
61604 * @param mysqli_result $result This optional parameter is a constant
61605 *   indicating what type of array should be produced from the current
61606 *   row data. The possible values for this parameter are the constants
61607 *   MYSQLI_ASSOC, MYSQLI_NUM, or MYSQLI_BOTH.
61608 * @param int $resulttype
61609 * @return mixed Returns an array of associative or numeric arrays
61610 *   holding result rows.
61611 * @since PHP 5 >= 5.3.0, PHP 7
61612 **/
61613function mysqli_fetch_all($result, $resulttype){}
61614
61615/**
61616 * Fetch a result row as an associative, a numeric array, or both
61617 *
61618 * Returns an array that corresponds to the fetched row or NULL if there
61619 * are no more rows for the resultset represented by the {@link result}
61620 * parameter.
61621 *
61622 * {@link mysqli_fetch_array} is an extended version of the {@link
61623 * mysqli_fetch_row} function. In addition to storing the data in the
61624 * numeric indices of the result array, the {@link mysqli_fetch_array}
61625 * function can also store the data in associative indices, using the
61626 * field names of the result set as keys.
61627 *
61628 * If two or more columns of the result have the same field names, the
61629 * last column will take precedence and overwrite the earlier data. In
61630 * order to access multiple columns with the same name, the numerically
61631 * indexed version of the row must be used.
61632 *
61633 * @param mysqli_result $result This optional parameter is a constant
61634 *   indicating what type of array should be produced from the current
61635 *   row data. The possible values for this parameter are the constants
61636 *   MYSQLI_ASSOC, MYSQLI_NUM, or MYSQLI_BOTH. By using the MYSQLI_ASSOC
61637 *   constant this function will behave identically to the {@link
61638 *   mysqli_fetch_assoc}, while MYSQLI_NUM will behave identically to the
61639 *   {@link mysqli_fetch_row} function. The final option MYSQLI_BOTH will
61640 *   create a single array with the attributes of both.
61641 * @param int $resulttype
61642 * @return mixed Returns an array of strings that corresponds to the
61643 *   fetched row or NULL if there are no more rows in resultset.
61644 * @since PHP 5, PHP 7
61645 **/
61646function mysqli_fetch_array($result, $resulttype){}
61647
61648/**
61649 * Fetch a result row as an associative array
61650 *
61651 * Returns an associative array that corresponds to the fetched row or
61652 * NULL if there are no more rows.
61653 *
61654 * @param mysqli_result $result
61655 * @return array Returns an associative array of strings representing
61656 *   the fetched row in the result set, where each key in the array
61657 *   represents the name of one of the result set's columns or NULL if
61658 *   there are no more rows in resultset.
61659 * @since PHP 5, PHP 7
61660 **/
61661function mysqli_fetch_assoc($result){}
61662
61663/**
61664 * Returns the next field in the result set
61665 *
61666 * Returns the definition of one column of a result set as an object.
61667 * Call this function repeatedly to retrieve information about all
61668 * columns in the result set.
61669 *
61670 * @param mysqli_result $result
61671 * @return object Returns an object which contains field definition
61672 *   information or FALSE if no field information is available.
61673 * @since PHP 5, PHP 7
61674 **/
61675function mysqli_fetch_field($result){}
61676
61677/**
61678 * Returns an array of objects representing the fields in a result set
61679 *
61680 * This function serves an identical purpose to the {@link
61681 * mysqli_fetch_field} function with the single difference that, instead
61682 * of returning one object at a time for each field, the columns are
61683 * returned as an array of objects.
61684 *
61685 * @param mysqli_result $result
61686 * @return array Returns an array of objects which contains field
61687 *   definition information or FALSE if no field information is
61688 *   available.
61689 * @since PHP 5, PHP 7
61690 **/
61691function mysqli_fetch_fields($result){}
61692
61693/**
61694 * Fetch meta-data for a single field
61695 *
61696 * Returns an object which contains field definition information from the
61697 * specified result set.
61698 *
61699 * @param mysqli_result $result The field number. This value must be in
61700 *   the range from 0 to number of fields - 1.
61701 * @param int $fieldnr
61702 * @return object Returns an object which contains field definition
61703 *   information or FALSE if no field information for specified fieldnr
61704 *   is available.
61705 * @since PHP 5, PHP 7
61706 **/
61707function mysqli_fetch_field_direct($result, $fieldnr){}
61708
61709/**
61710 * Returns the lengths of the columns of the current row in the result
61711 * set
61712 *
61713 * The {@link mysqli_fetch_lengths} function returns an array containing
61714 * the lengths of every column of the current row within the result set.
61715 *
61716 * @param mysqli_result $result
61717 * @return array An array of integers representing the size of each
61718 *   column (not including any terminating null characters). FALSE if an
61719 *   error occurred.
61720 * @since PHP 5, PHP 7
61721 **/
61722function mysqli_fetch_lengths($result){}
61723
61724/**
61725 * Returns the current row of a result set as an object
61726 *
61727 * The {@link mysqli_fetch_object} will return the current row result set
61728 * as an object where the attributes of the object represent the names of
61729 * the fields found within the result set.
61730 *
61731 * Note that {@link mysqli_fetch_object} sets the properties of the
61732 * object before calling the object constructor.
61733 *
61734 * @param mysqli_result $result The name of the class to instantiate,
61735 *   set the properties of and return. If not specified, a stdClass
61736 *   object is returned.
61737 * @param string $class_name An optional array of parameters to pass to
61738 *   the constructor for {@link class_name} objects.
61739 * @param array $params
61740 * @return object Returns an object with string properties that
61741 *   corresponds to the fetched row or NULL if there are no more rows in
61742 *   resultset.
61743 * @since PHP 5, PHP 7
61744 **/
61745function mysqli_fetch_object($result, $class_name, $params){}
61746
61747/**
61748 * Get a result row as an enumerated array
61749 *
61750 * Fetches one row of data from the result set and returns it as an
61751 * enumerated array, where each column is stored in an array offset
61752 * starting from 0 (zero). Each subsequent call to this function will
61753 * return the next row within the result set, or NULL if there are no
61754 * more rows.
61755 *
61756 * @param mysqli_result $result
61757 * @return mixed {@link mysqli_fetch_row} returns an array of strings
61758 *   that corresponds to the fetched row or NULL if there are no more
61759 *   rows in result set.
61760 * @since PHP 5, PHP 7
61761 **/
61762function mysqli_fetch_row($result){}
61763
61764/**
61765 * Returns the number of columns for the most recent query
61766 *
61767 * Returns the number of columns for the most recent query on the
61768 * connection represented by the {@link link} parameter. This function
61769 * can be useful when using the {@link mysqli_store_result} function to
61770 * determine if the query should have produced a non-empty result set or
61771 * not without knowing the nature of the query.
61772 *
61773 * @param mysqli $link
61774 * @return int An integer representing the number of fields in a result
61775 *   set.
61776 * @since PHP 5, PHP 7
61777 **/
61778function mysqli_field_count($link){}
61779
61780/**
61781 * Set result pointer to a specified field offset
61782 *
61783 * Sets the field cursor to the given offset. The next call to {@link
61784 * mysqli_fetch_field} will retrieve the field definition of the column
61785 * associated with that offset.
61786 *
61787 * @param mysqli_result $result The field number. This value must be in
61788 *   the range from 0 to number of fields - 1.
61789 * @param int $fieldnr
61790 * @return bool
61791 * @since PHP 5, PHP 7
61792 **/
61793function mysqli_field_seek($result, $fieldnr){}
61794
61795/**
61796 * Get current field offset of a result pointer
61797 *
61798 * Returns the position of the field cursor used for the last {@link
61799 * mysqli_fetch_field} call. This value can be used as an argument to
61800 * {@link mysqli_field_seek}.
61801 *
61802 * @param mysqli_result $result
61803 * @return int Returns current offset of field cursor.
61804 * @since PHP 5, PHP 7
61805 **/
61806function mysqli_field_tell($result){}
61807
61808/**
61809 * Frees the memory associated with a result
61810 *
61811 * Frees the memory associated with the result.
61812 *
61813 * @param mysqli_result $result
61814 * @return void
61815 * @since PHP 5, PHP 7
61816 **/
61817function mysqli_free_result($result){}
61818
61819/**
61820 * Returns client Zval cache statistics
61821 *
61822 * Returns an empty array.
61823 *
61824 * @return array Returns an empty array on success, FALSE otherwise.
61825 * @since PHP 5 >= 5.3.0 and < 5.4.0
61826 **/
61827function mysqli_get_cache_stats(){}
61828
61829/**
61830 * Returns a character set object
61831 *
61832 * Returns a character set object providing several properties of the
61833 * current active character set.
61834 *
61835 * @param mysqli $link
61836 * @return object The function returns a character set object with the
61837 *   following properties: {@link charset} Character set name {@link
61838 *   collation} Collation name {@link dir} Directory the charset
61839 *   description was fetched from (?) or "" for built-in character sets
61840 *   {@link min_length} Minimum character length in bytes {@link
61841 *   max_length} Maximum character length in bytes {@link number}
61842 *   Internal character set number {@link state} Character set status (?)
61843 * @since PHP 5 >= 5.1.0, PHP 7
61844 **/
61845function mysqli_get_charset($link){}
61846
61847/**
61848 * Get MySQL client info
61849 *
61850 * Returns a string that represents the MySQL client library version.
61851 *
61852 * @param mysqli $link
61853 * @return string A string that represents the MySQL client library
61854 *   version
61855 * @since PHP 5, PHP 7
61856 **/
61857function mysqli_get_client_info($link){}
61858
61859/**
61860 * Returns client per-process statistics
61861 *
61862 * @return array Returns an array with client stats if success, FALSE
61863 *   otherwise.
61864 * @since PHP 5 >= 5.3.0, PHP 7
61865 **/
61866function mysqli_get_client_stats(){}
61867
61868/**
61869 * Returns the MySQL client version as an integer
61870 *
61871 * Returns client version number as an integer.
61872 *
61873 * @param mysqli $link
61874 * @return int A number that represents the MySQL client library
61875 *   version in format: main_version*10000 + minor_version *100 +
61876 *   sub_version. For example, 4.1.0 is returned as 40100.
61877 * @since PHP 5, PHP 7
61878 **/
61879function mysqli_get_client_version($link){}
61880
61881/**
61882 * Returns statistics about the client connection
61883 *
61884 * @param mysqli $link
61885 * @return array Returns an array with connection stats if success,
61886 *   FALSE otherwise.
61887 * @since PHP 5 >= 5.3.0, PHP 7
61888 **/
61889function mysqli_get_connection_stats($link){}
61890
61891/**
61892 * Returns a string representing the type of connection used
61893 *
61894 * Returns a string describing the connection represented by the {@link
61895 * link} parameter (including the server host name).
61896 *
61897 * @param mysqli $link
61898 * @return string A character string representing the server hostname
61899 *   and the connection type.
61900 * @since PHP 5, PHP 7
61901 **/
61902function mysqli_get_host_info($link){}
61903
61904/**
61905 * Return information about open and cached links
61906 *
61907 * {@link mysqli_get_links_stats} returns information about open and
61908 * cached MySQL links.
61909 *
61910 * @return array {@link mysqli_get_links_stats} returns an associative
61911 *   array with three elements, keyed as follows: {@link total} An
61912 *   integer indicating the total number of open links in any state.
61913 *   {@link active_plinks} An integer representing the number of active
61914 *   persistent connections. {@link cached_plinks} An integer
61915 *   representing the number of inactive persistent connections.
61916 * @since PHP 5 >= 5.6.0, PHP 7
61917 **/
61918function mysqli_get_links_stats(){}
61919
61920/**
61921 * Returns the version of the MySQL protocol used
61922 *
61923 * Returns an integer representing the MySQL protocol version used by the
61924 * connection represented by the {@link link} parameter.
61925 *
61926 * @param mysqli $link
61927 * @return int Returns an integer representing the protocol version.
61928 * @since PHP 5, PHP 7
61929 **/
61930function mysqli_get_proto_info($link){}
61931
61932/**
61933 * Returns the version of the MySQL server
61934 *
61935 * Returns a string representing the version of the MySQL server that the
61936 * MySQLi extension is connected to.
61937 *
61938 * @param mysqli $link
61939 * @return string A character string representing the server version.
61940 * @since PHP 5, PHP 7
61941 **/
61942function mysqli_get_server_info($link){}
61943
61944/**
61945 * Returns the version of the MySQL server as an integer
61946 *
61947 * The {@link mysqli_get_server_version} function returns the version of
61948 * the server connected to (represented by the {@link link} parameter) as
61949 * an integer.
61950 *
61951 * @param mysqli $link
61952 * @return int An integer representing the server version.
61953 * @since PHP 5, PHP 7
61954 **/
61955function mysqli_get_server_version($link){}
61956
61957/**
61958 * Get result of SHOW WARNINGS
61959 *
61960 * @param mysqli $link
61961 * @return mysqli_warning
61962 * @since PHP 5 >= 5.1.0, PHP 7
61963 **/
61964function mysqli_get_warnings($link){}
61965
61966/**
61967 * Retrieves information about the most recently executed query
61968 *
61969 * The {@link mysqli_info} function returns a string providing
61970 * information about the last query executed. The nature of this string
61971 * is provided below:
61972 *
61973 * Possible mysqli_info return values Query type Example result string
61974 * INSERT INTO...SELECT... Records: 100 Duplicates: 0 Warnings: 0 INSERT
61975 * INTO...VALUES (...),(...),(...) Records: 3 Duplicates: 0 Warnings: 0
61976 * LOAD DATA INFILE ... Records: 1 Deleted: 0 Skipped: 0 Warnings: 0
61977 * ALTER TABLE ... Records: 3 Duplicates: 0 Warnings: 0 UPDATE ... Rows
61978 * matched: 40 Changed: 40 Warnings: 0
61979 *
61980 * @param mysqli $link
61981 * @return string A character string representing additional
61982 *   information about the most recently executed query.
61983 * @since PHP 5, PHP 7
61984 **/
61985function mysqli_info($link){}
61986
61987/**
61988 * Initializes MySQLi and returns a resource for use with
61989 * mysqli_real_connect()
61990 *
61991 * Allocates or initializes a MYSQL object suitable for {@link
61992 * mysqli_options} and {@link mysqli_real_connect}.
61993 *
61994 * @return mysqli Returns an object.
61995 * @since PHP 5, PHP 7
61996 **/
61997function mysqli_init(){}
61998
61999/**
62000 * Returns the auto generated id used in the latest query
62001 *
62002 * The {@link mysqli_insert_id} function returns the ID generated by a
62003 * query (usually INSERT) on a table with a column having the
62004 * AUTO_INCREMENT attribute. If no INSERT or UPDATE statements were sent
62005 * via this connection, or if the modified table does not have a column
62006 * with the AUTO_INCREMENT attribute, this function will return zero.
62007 *
62008 * @param mysqli $link
62009 * @return mixed The value of the AUTO_INCREMENT field that was updated
62010 *   by the previous query. Returns zero if there was no previous query
62011 *   on the connection or if the query did not update an AUTO_INCREMENT
62012 *   value.
62013 * @since PHP 5, PHP 7
62014 **/
62015function mysqli_insert_id($link){}
62016
62017/**
62018 * Asks the server to kill a MySQL thread
62019 *
62020 * This function is used to ask the server to kill a MySQL thread
62021 * specified by the {@link processid} parameter. This value must be
62022 * retrieved by calling the {@link mysqli_thread_id} function.
62023 *
62024 * To stop a running query you should use the SQL command KILL QUERY
62025 * processid.
62026 *
62027 * @param mysqli $link
62028 * @param int $processid
62029 * @return bool
62030 * @since PHP 5, PHP 7
62031 **/
62032function mysqli_kill($link, $processid){}
62033
62034/**
62035 * Enforce execution of a query on the master in a master/slave setup
62036 *
62037 * @param mysqli $link
62038 * @param string $query
62039 * @return bool
62040 * @since PHP 5 < 5.3.0
62041 **/
62042function mysqli_master_query($link, $query){}
62043
62044/**
62045 * Check if there are any more query results from a multi query
62046 *
62047 * Indicates if one or more result sets are available from a previous
62048 * call to {@link mysqli_multi_query}.
62049 *
62050 * @param mysqli $link
62051 * @return bool Returns TRUE if one or more result sets (including
62052 *   errors) are available from a previous call to {@link
62053 *   mysqli_multi_query}, otherwise FALSE.
62054 * @since PHP 5, PHP 7
62055 **/
62056function mysqli_more_results($link){}
62057
62058/**
62059 * Performs a query on the database
62060 *
62061 * Executes one or multiple queries which are concatenated by a
62062 * semicolon.
62063 *
62064 * To retrieve the resultset from the first query you can use {@link
62065 * mysqli_use_result} or {@link mysqli_store_result}. All subsequent
62066 * query results can be processed using {@link mysqli_more_results} and
62067 * {@link mysqli_next_result}.
62068 *
62069 * @param mysqli $link The query, as a string. Data inside the query
62070 *   should be properly escaped.
62071 * @param string $query
62072 * @return bool Returns FALSE if the first statement failed. To
62073 *   retrieve subsequent errors from other statements you have to call
62074 *   {@link mysqli_next_result} first.
62075 * @since PHP 5, PHP 7
62076 **/
62077function mysqli_multi_query($link, $query){}
62078
62079/**
62080 * Prepare next result from multi_query
62081 *
62082 * Prepares next result set from a previous call to {@link
62083 * mysqli_multi_query} which can be retrieved by {@link
62084 * mysqli_store_result} or {@link mysqli_use_result}.
62085 *
62086 * @param mysqli $link
62087 * @return bool Also returns FALSE if the next statement resulted in an
62088 *   error, unlike mysqli_more_results.
62089 * @since PHP 5, PHP 7
62090 **/
62091function mysqli_next_result($link){}
62092
62093/**
62094 * Get the number of fields in a result
62095 *
62096 * Returns the number of fields from specified result set.
62097 *
62098 * @param mysqli_result $result
62099 * @return int The number of fields from a result set.
62100 * @since PHP 5, PHP 7
62101 **/
62102function mysqli_num_fields($result){}
62103
62104/**
62105 * Gets the number of rows in a result
62106 *
62107 * Returns the number of rows in the result set.
62108 *
62109 * The behaviour of {@link mysqli_num_rows} depends on whether buffered
62110 * or unbuffered result sets are being used. For unbuffered result sets,
62111 * {@link mysqli_num_rows} will not return the correct number of rows
62112 * until all the rows in the result have been retrieved.
62113 *
62114 * @param mysqli_result $result
62115 * @return int Returns number of rows in the result set.
62116 * @since PHP 5, PHP 7
62117 **/
62118function mysqli_num_rows($result){}
62119
62120/**
62121 * Set options
62122 *
62123 * Used to set extra connect options and affect behavior for a
62124 * connection.
62125 *
62126 * This function may be called multiple times to set several options.
62127 *
62128 * {@link mysqli_options} should be called after {@link mysqli_init} and
62129 * before {@link mysqli_real_connect}.
62130 *
62131 * @param mysqli $link The option that you want to set. It can be one
62132 *   of the following values: Valid options Name Description
62133 *   MYSQLI_OPT_CONNECT_TIMEOUT connection timeout in seconds (supported
62134 *   on Windows with TCP/IP since PHP 5.3.1) MYSQLI_OPT_LOCAL_INFILE
62135 *   enable/disable use of LOAD LOCAL INFILE MYSQLI_INIT_COMMAND command
62136 *   to execute after when connecting to MySQL server
62137 *   MYSQLI_READ_DEFAULT_FILE Read options from named option file instead
62138 *   of my.cnf MYSQLI_READ_DEFAULT_GROUP Read options from the named
62139 *   group from my.cnf or the file specified with
62140 *   MYSQL_READ_DEFAULT_FILE. MYSQLI_SERVER_PUBLIC_KEY RSA public key
62141 *   file used with the SHA-256 based authentication. Available since PHP
62142 *   5.5.0. MYSQLI_OPT_NET_CMD_BUFFER_SIZE The size of the internal
62143 *   command/network buffer. Only valid for mysqlnd. Available since PHP
62144 *   5.3.0. MYSQLI_OPT_NET_READ_BUFFER_SIZE Maximum read chunk size in
62145 *   bytes when reading the body of a MySQL command packet. Only valid
62146 *   for mysqlnd. Available since PHP 5.3.0.
62147 *   MYSQLI_OPT_INT_AND_FLOAT_NATIVE Convert integer and float columns
62148 *   back to PHP numbers. Only valid for mysqlnd. Available since PHP
62149 *   5.3.0. MYSQLI_OPT_SSL_VERIFY_SERVER_CERT Available since PHP 5.3.0.
62150 * @param int $option The value for the option.
62151 * @param mixed $value
62152 * @return bool
62153 * @since PHP 5, PHP 7
62154 **/
62155function mysqli_options($link, $option, $value){}
62156
62157/**
62158 * Pings a server connection, or tries to reconnect if the connection has
62159 * gone down
62160 *
62161 * Checks whether the connection to the server is working. If it has gone
62162 * down and global option mysqli.reconnect is enabled, an automatic
62163 * reconnection is attempted.
62164 *
62165 * This function can be used by clients that remain idle for a long
62166 * while, to check whether the server has closed the connection and
62167 * reconnect if necessary.
62168 *
62169 * @param mysqli $link
62170 * @return bool
62171 * @since PHP 5, PHP 7
62172 **/
62173function mysqli_ping($link){}
62174
62175/**
62176 * Poll connections
62177 *
62178 * Poll connections. The method can be used as static.
62179 *
62180 * @param array $read List of connections to check for outstanding
62181 *   results that can be read.
62182 * @param array $error List of connections on which an error occurred,
62183 *   for example, query failure or lost connection.
62184 * @param array $reject List of connections rejected because no
62185 *   asynchronous query has been run on for which the function could poll
62186 *   results.
62187 * @param int $sec Maximum number of seconds to wait, must be
62188 *   non-negative.
62189 * @param int $usec Maximum number of microseconds to wait, must be
62190 *   non-negative.
62191 * @return int Returns number of ready connections upon success, FALSE
62192 *   otherwise.
62193 * @since PHP 5 >= 5.3.0, PHP 7
62194 **/
62195function mysqli_poll(&$read, &$error, &$reject, $sec, $usec){}
62196
62197/**
62198 * Prepare an SQL statement for execution
62199 *
62200 * Prepares the SQL query, and returns a statement handle to be used for
62201 * further operations on the statement. The query must consist of a
62202 * single SQL statement.
62203 *
62204 * The parameter markers must be bound to application variables using
62205 * {@link mysqli_stmt_bind_param} and/or {@link mysqli_stmt_bind_result}
62206 * before executing the statement or fetching rows.
62207 *
62208 * @param mysqli $link The query, as a string. This parameter can
62209 *   include one or more parameter markers in the SQL statement by
62210 *   embedding question mark (?) characters at the appropriate positions.
62211 * @param string $query
62212 * @return mysqli_stmt {@link mysqli_prepare} returns a statement
62213 *   object or FALSE if an error occurred.
62214 * @since PHP 5, PHP 7
62215 **/
62216function mysqli_prepare($link, $query){}
62217
62218/**
62219 * Performs a query on the database
62220 *
62221 * Performs a {@link query} against the database.
62222 *
62223 * For non-DML queries (not INSERT, UPDATE or DELETE), this function is
62224 * similar to calling {@link mysqli_real_query} followed by either {@link
62225 * mysqli_use_result} or {@link mysqli_store_result}.
62226 *
62227 * @param mysqli $link The query string. Data inside the query should
62228 *   be properly escaped.
62229 * @param string $query Either the constant MYSQLI_USE_RESULT or
62230 *   MYSQLI_STORE_RESULT depending on the desired behavior. By default,
62231 *   MYSQLI_STORE_RESULT is used. If you use MYSQLI_USE_RESULT all
62232 *   subsequent calls will return error Commands out of sync unless you
62233 *   call {@link mysqli_free_result} With MYSQLI_ASYNC (available with
62234 *   mysqlnd), it is possible to perform query asynchronously. {@link
62235 *   mysqli_poll} is then used to get results from such queries.
62236 * @param int $resultmode
62237 * @return mixed Returns FALSE on failure. For successful SELECT, SHOW,
62238 *   DESCRIBE or EXPLAIN queries {@link mysqli_query} will return a
62239 *   mysqli_result object. For other successful queries {@link
62240 *   mysqli_query} will return TRUE.
62241 * @since PHP 5, PHP 7
62242 **/
62243function mysqli_query($link, $query, $resultmode){}
62244
62245/**
62246 * Opens a connection to a mysql server
62247 *
62248 * Establish a connection to a MySQL database engine.
62249 *
62250 * This function differs from {@link mysqli_connect}:
62251 *
62252 * @param mysqli $link Can be either a host name or an IP address.
62253 *   Passing the NULL value or the string "localhost" to this parameter,
62254 *   the local host is assumed. When possible, pipes will be used instead
62255 *   of the TCP/IP protocol.
62256 * @param string $host The MySQL user name.
62257 * @param string $username If provided or NULL, the MySQL server will
62258 *   attempt to authenticate the user against those user records which
62259 *   have no password only. This allows one username to be used with
62260 *   different permissions (depending on if a password as provided or
62261 *   not).
62262 * @param string $passwd If provided will specify the default database
62263 *   to be used when performing queries.
62264 * @param string $dbname Specifies the port number to attempt to
62265 *   connect to the MySQL server.
62266 * @param int $port Specifies the socket or named pipe that should be
62267 *   used.
62268 * @param string $socket With the parameter {@link flags} you can set
62269 *   different connection options:
62270 * @param int $flags
62271 * @return bool
62272 * @since PHP 5, PHP 7
62273 **/
62274function mysqli_real_connect($link, $host, $username, $passwd, $dbname, $port, $socket, $flags){}
62275
62276/**
62277 * Escapes special characters in a string for use in an SQL statement,
62278 * taking into account the current charset of the connection
62279 *
62280 * This function is used to create a legal SQL string that you can use in
62281 * an SQL statement. The given string is encoded to an escaped SQL
62282 * string, taking into account the current character set of the
62283 * connection.
62284 *
62285 * @param mysqli $link The string to be escaped. Characters encoded are
62286 *   NUL (ASCII 0), \n, \r, \, ', ", and Control-Z.
62287 * @param string $escapestr
62288 * @return string Returns an escaped string.
62289 * @since PHP 5, PHP 7
62290 **/
62291function mysqli_real_escape_string($link, $escapestr){}
62292
62293/**
62294 * Execute an SQL query
62295 *
62296 * Executes a single query against the database whose result can then be
62297 * retrieved or stored using the {@link mysqli_store_result} or {@link
62298 * mysqli_use_result} functions.
62299 *
62300 * In order to determine if a given query should return a result set or
62301 * not, see {@link mysqli_field_count}.
62302 *
62303 * @param mysqli $link The query, as a string. Data inside the query
62304 *   should be properly escaped.
62305 * @param string $query
62306 * @return bool
62307 * @since PHP 5, PHP 7
62308 **/
62309function mysqli_real_query($link, $query){}
62310
62311/**
62312 * Get result from async query
62313 *
62314 * @param mysqli $link
62315 * @return mysqli_result Returns mysqli_result in success, FALSE
62316 *   otherwise.
62317 * @since PHP 5 >= 5.3.0, PHP 7
62318 **/
62319function mysqli_reap_async_query($link){}
62320
62321/**
62322 * Refreshes
62323 *
62324 * Flushes tables or caches, or resets the replication server
62325 * information.
62326 *
62327 * @param resource $link The options to refresh, using the
62328 *   MYSQLI_REFRESH_* constants as documented within the MySQLi constants
62329 *   documentation. See also the official MySQL Refresh documentation.
62330 * @param int $options
62331 * @return bool TRUE if the refresh was a success, otherwise FALSE
62332 * @since PHP 5 >= 5.3.0, PHP 7
62333 **/
62334function mysqli_refresh($link, $options){}
62335
62336/**
62337 * Removes the named savepoint from the set of savepoints of the current
62338 * transaction
62339 *
62340 * @param mysqli $link
62341 * @param string $name
62342 * @return bool
62343 * @since PHP 5 >= 5.5.0, PHP 7
62344 **/
62345function mysqli_release_savepoint($link, $name){}
62346
62347/**
62348 * Enables or disables internal report functions
62349 *
62350 * A function helpful in improving queries during code development and
62351 * testing. Depending on the flags, it reports errors from mysqli
62352 * function calls or queries that don't use an index (or use a bad
62353 * index).
62354 *
62355 * @param int $flags Supported flags Name Description MYSQLI_REPORT_OFF
62356 *   Turns reporting off MYSQLI_REPORT_ERROR Report errors from mysqli
62357 *   function calls MYSQLI_REPORT_STRICT Throw mysqli_sql_exception for
62358 *   errors instead of warnings MYSQLI_REPORT_INDEX Report if no index or
62359 *   bad index was used in a query MYSQLI_REPORT_ALL Set all options
62360 *   (report all)
62361 * @return bool
62362 * @since PHP 5, PHP 7
62363 **/
62364function mysqli_report($flags){}
62365
62366/**
62367 * Rolls back current transaction
62368 *
62369 * Rollbacks the current transaction for the database.
62370 *
62371 * @param mysqli $link A bitmask of MYSQLI_TRANS_COR_* constants.
62372 * @param int $flags If provided then ROLLBACK/*name* / is executed.
62373 * @param string $name
62374 * @return bool
62375 * @since PHP 5, PHP 7
62376 **/
62377function mysqli_rollback($link, $flags, $name){}
62378
62379/**
62380 * Check if RPL parse is enabled
62381 *
62382 * @param mysqli $link
62383 * @return int
62384 * @since PHP 5 < 5.3.0
62385 **/
62386function mysqli_rpl_parse_enabled($link){}
62387
62388/**
62389 * RPL probe
62390 *
62391 * @param mysqli $link
62392 * @return bool
62393 * @since PHP 5 < 5.3.0
62394 **/
62395function mysqli_rpl_probe($link){}
62396
62397/**
62398 * Returns RPL query type
62399 *
62400 * Returns MYSQLI_RPL_MASTER, MYSQLI_RPL_SLAVE or MYSQLI_RPL_ADMIN
62401 * depending on a query type. INSERT, UPDATE and similar are master
62402 * queries, SELECT is slave, and FLUSH, REPAIR and similar are admin.
62403 *
62404 * @param mysqli $link
62405 * @param string $query
62406 * @return int
62407 * @since PHP 5, PHP 7
62408 **/
62409function mysqli_rpl_query_type($link, $query){}
62410
62411/**
62412 * Set a named transaction savepoint
62413 *
62414 * @param mysqli $link
62415 * @param string $name
62416 * @return bool
62417 * @since PHP 5 >= 5.5.0, PHP 7
62418 **/
62419function mysqli_savepoint($link, $name){}
62420
62421/**
62422 * Selects the default database for database queries
62423 *
62424 * Selects the default database to be used when performing queries
62425 * against the database connection.
62426 *
62427 * @param mysqli $link The database name.
62428 * @param string $dbname
62429 * @return bool
62430 * @since PHP 5, PHP 7
62431 **/
62432function mysqli_select_db($link, $dbname){}
62433
62434/**
62435 * Send the query and return
62436 *
62437 * @param mysqli $link
62438 * @param string $query
62439 * @return bool
62440 * @since PHP 5, PHP 7
62441 **/
62442function mysqli_send_query($link, $query){}
62443
62444/**
62445 * Sets the default client character set
62446 *
62447 * Sets the default character set to be used when sending data from and
62448 * to the database server.
62449 *
62450 * @param mysqli $link The charset to be set as default.
62451 * @param string $charset
62452 * @return bool
62453 * @since PHP 5 >= 5.0.5, PHP 7
62454 **/
62455function mysqli_set_charset($link, $charset){}
62456
62457/**
62458 * Unsets user defined handler for load local infile command
62459 *
62460 * Deactivates a LOAD DATA INFILE LOCAL handler previously set with
62461 * {@link mysqli_set_local_infile_handler}.
62462 *
62463 * @param mysqli $link
62464 * @return void
62465 * @since PHP 5 < 5.4.0
62466 **/
62467function mysqli_set_local_infile_default($link){}
62468
62469/**
62470 * Set callback function for LOAD DATA LOCAL INFILE command
62471 *
62472 * The callbacks task is to read input from the file specified in the
62473 * LOAD DATA LOCAL INFILE and to reformat it into the format understood
62474 * by LOAD DATA INFILE.
62475 *
62476 * The returned data needs to match the format specified in the LOAD DATA
62477 *
62478 * @param mysqli $link A callback function or object method taking the
62479 *   following parameters:
62480 * @param callable $read_func A PHP stream associated with the SQL
62481 *   commands INFILE
62482 * @return bool
62483 * @since PHP 5, PHP 7
62484 **/
62485function mysqli_set_local_infile_handler($link, $read_func){}
62486
62487/**
62488 * Set mysqli_set_opt
62489 *
62490 * Used to set extra connect mysqli_set_opt and affect behavior for a
62491 * connection.
62492 *
62493 * This function may be called multiple times to set several
62494 * mysqli_set_opt.
62495 *
62496 * {@link mysqli_mysqli_set_opt} should be called after {@link
62497 * mysqli_init} and before {@link mysqli_real_connect}.
62498 *
62499 * @param int $option The option that you want to set. It can be one of
62500 *   the following values: Valid options Name Description
62501 *   MYSQLI_OPT_CONNECT_TIMEOUT connection timeout in seconds (supported
62502 *   on Windows with TCP/IP since PHP 5.3.1) MYSQLI_OPT_LOCAL_INFILE
62503 *   enable/disable use of LOAD LOCAL INFILE MYSQLI_INIT_COMMAND command
62504 *   to execute after when connecting to MySQL server
62505 *   MYSQLI_READ_DEFAULT_FILE Read options from named option file instead
62506 *   of my.cnf MYSQLI_READ_DEFAULT_GROUP Read options from the named
62507 *   group from my.cnf or the file specified with
62508 *   MYSQL_READ_DEFAULT_FILE. MYSQLI_SERVER_PUBLIC_KEY RSA public key
62509 *   file used with the SHA-256 based authentication. Available since PHP
62510 *   5.5.0. MYSQLI_OPT_NET_CMD_BUFFER_SIZE The size of the internal
62511 *   command/network buffer. Only valid for mysqlnd. Available since PHP
62512 *   5.3.0. MYSQLI_OPT_NET_READ_BUFFER_SIZE Maximum read chunk size in
62513 *   bytes when reading the body of a MySQL command packet. Only valid
62514 *   for mysqlnd. Available since PHP 5.3.0.
62515 *   MYSQLI_OPT_INT_AND_FLOAT_NATIVE Convert integer and float columns
62516 *   back to PHP numbers. Only valid for mysqlnd. Available since PHP
62517 *   5.3.0. MYSQLI_OPT_SSL_VERIFY_SERVER_CERT Available since PHP 5.3.0.
62518 * @param mixed $value The value for the option.
62519 * @return bool
62520 * @since PHP 5, PHP 7
62521 **/
62522function mysqli_set_opt($option, $value){}
62523
62524/**
62525 * Force execution of a query on a slave in a master/slave setup
62526 *
62527 * @param mysqli $link
62528 * @param string $query
62529 * @return bool
62530 * @since PHP 5 < 5.3.0
62531 **/
62532function mysqli_slave_query($link, $query){}
62533
62534/**
62535 * Returns the SQLSTATE error from previous MySQL operation
62536 *
62537 * Returns a string containing the SQLSTATE error code for the last
62538 * error. The error code consists of five characters. '00000' means no
62539 * error. The values are specified by ANSI SQL and ODBC. For a list of
62540 * possible values, see .
62541 *
62542 * @param mysqli $link
62543 * @return string Returns a string containing the SQLSTATE error code
62544 *   for the last error. The error code consists of five characters.
62545 *   '00000' means no error.
62546 * @since PHP 5, PHP 7
62547 **/
62548function mysqli_sqlstate($link){}
62549
62550/**
62551 * Used for establishing secure connections using SSL
62552 *
62553 * Used for establishing secure connections using SSL. It must be called
62554 * before {@link mysqli_real_connect}. This function does nothing unless
62555 * OpenSSL support is enabled.
62556 *
62557 * Note that MySQL Native Driver does not support SSL before PHP 5.3.3,
62558 * so calling this function when using MySQL Native Driver will result in
62559 * an error. MySQL Native Driver is enabled by default on Microsoft
62560 * Windows from PHP version 5.3 onwards.
62561 *
62562 * @param mysqli $link The path name to the key file.
62563 * @param string $key The path name to the certificate file.
62564 * @param string $cert The path name to the certificate authority file.
62565 * @param string $ca The pathname to a directory that contains trusted
62566 *   SSL CA certificates in PEM format.
62567 * @param string $capath A list of allowable ciphers to use for SSL
62568 *   encryption.
62569 * @param string $cipher
62570 * @return bool This function always returns TRUE value. If SSL setup
62571 *   is incorrect {@link mysqli_real_connect} will return an error when
62572 *   you attempt to connect.
62573 * @since PHP 5, PHP 7
62574 **/
62575function mysqli_ssl_set($link, $key, $cert, $ca, $capath, $cipher){}
62576
62577/**
62578 * Gets the current system status
62579 *
62580 * {@link mysqli_stat} returns a string containing information similar to
62581 * that provided by the 'mysqladmin status' command. This includes uptime
62582 * in seconds and the number of running threads, questions, reloads, and
62583 * open tables.
62584 *
62585 * @param mysqli $link
62586 * @return string A string describing the server status. FALSE if an
62587 *   error occurred.
62588 * @since PHP 5, PHP 7
62589 **/
62590function mysqli_stat($link){}
62591
62592/**
62593 * Returns the total number of rows changed, deleted, or inserted by the
62594 * last executed statement
62595 *
62596 * Returns the number of rows affected by INSERT, UPDATE, or DELETE
62597 * query.
62598 *
62599 * This function only works with queries which update a table. In order
62600 * to get the number of rows from a SELECT query, use {@link
62601 * mysqli_stmt_num_rows} instead.
62602 *
62603 * @param mysqli_stmt $stmt
62604 * @return int An integer greater than zero indicates the number of
62605 *   rows affected or retrieved. Zero indicates that no records where
62606 *   updated for an UPDATE/DELETE statement, no rows matched the WHERE
62607 *   clause in the query or that no query has yet been executed. -1
62608 *   indicates that the query has returned an error. NULL indicates an
62609 *   invalid argument was supplied to the function.
62610 * @since PHP 5, PHP 7
62611 **/
62612function mysqli_stmt_affected_rows($stmt){}
62613
62614/**
62615 * Used to get the current value of a statement attribute
62616 *
62617 * Gets the current value of a statement attribute.
62618 *
62619 * @param mysqli_stmt $stmt The attribute that you want to get.
62620 * @param int $attr
62621 * @return int Returns FALSE if the attribute is not found, otherwise
62622 *   returns the value of the attribute.
62623 * @since PHP 5, PHP 7
62624 **/
62625function mysqli_stmt_attr_get($stmt, $attr){}
62626
62627/**
62628 * Used to modify the behavior of a prepared statement
62629 *
62630 * Used to modify the behavior of a prepared statement. This function may
62631 * be called multiple times to set several attributes.
62632 *
62633 * @param mysqli_stmt $stmt The attribute that you want to set. It can
62634 *   have one of the following values: Attribute values Character
62635 *   Description MYSQLI_STMT_ATTR_UPDATE_MAX_LENGTH Setting to TRUE
62636 *   causes {@link mysqli_stmt_store_result} to update the metadata
62637 *   MYSQL_FIELD->max_length value. MYSQLI_STMT_ATTR_CURSOR_TYPE Type of
62638 *   cursor to open for statement when {@link mysqli_stmt_execute} is
62639 *   invoked. {@link mode} can be MYSQLI_CURSOR_TYPE_NO_CURSOR (the
62640 *   default) or MYSQLI_CURSOR_TYPE_READ_ONLY.
62641 *   MYSQLI_STMT_ATTR_PREFETCH_ROWS Number of rows to fetch from server
62642 *   at a time when using a cursor. {@link mode} can be in the range from
62643 *   1 to the maximum value of unsigned long. The default is 1. If you
62644 *   use the MYSQLI_STMT_ATTR_CURSOR_TYPE option with
62645 *   MYSQLI_CURSOR_TYPE_READ_ONLY, a cursor is opened for the statement
62646 *   when you invoke {@link mysqli_stmt_execute}. If there is already an
62647 *   open cursor from a previous {@link mysqli_stmt_execute} call, it
62648 *   closes the cursor before opening a new one. {@link
62649 *   mysqli_stmt_reset} also closes any open cursor before preparing the
62650 *   statement for re-execution. {@link mysqli_stmt_free_result} closes
62651 *   any open cursor. If you open a cursor for a prepared statement,
62652 *   {@link mysqli_stmt_store_result} is unnecessary.
62653 * @param int $attr The value to assign to the attribute.
62654 * @param int $mode
62655 * @return bool
62656 * @since PHP 5, PHP 7
62657 **/
62658function mysqli_stmt_attr_set($stmt, $attr, $mode){}
62659
62660/**
62661 * Binds variables to a prepared statement as parameters
62662 *
62663 * Bind variables for the parameter markers in the SQL statement that was
62664 * passed to {@link mysqli_prepare}.
62665 *
62666 * @param mysqli_stmt $stmt A string that contains one or more
62667 *   characters which specify the types for the corresponding bind
62668 *   variables: Type specification chars Character Description i
62669 *   corresponding variable has type integer d corresponding variable has
62670 *   type double s corresponding variable has type string b corresponding
62671 *   variable is a blob and will be sent in packets
62672 * @param string $types The number of variables and length of string
62673 *   {@link types} must match the parameters in the statement.
62674 * @param mixed $var1
62675 * @param mixed ...$vararg
62676 * @return bool
62677 * @since PHP 5, PHP 7
62678 **/
62679function mysqli_stmt_bind_param($stmt, $types, &$var1, &...$vararg){}
62680
62681/**
62682 * Binds variables to a prepared statement for result storage
62683 *
62684 * Binds columns in the result set to variables.
62685 *
62686 * When {@link mysqli_stmt_fetch} is called to fetch data, the MySQL
62687 * client/server protocol places the data for the bound columns into the
62688 * specified variables {@link var1, ...}.
62689 *
62690 * @param mysqli_stmt $stmt The variable to be bound.
62691 * @param mixed $var1
62692 * @param mixed ...$vararg
62693 * @return bool
62694 * @since PHP 5, PHP 7
62695 **/
62696function mysqli_stmt_bind_result($stmt, &$var1, &...$vararg){}
62697
62698/**
62699 * Closes a prepared statement
62700 *
62701 * Closes a prepared statement. {@link mysqli_stmt_close} also
62702 * deallocates the statement handle. If the current statement has pending
62703 * or unread results, this function cancels them so that the next query
62704 * can be executed.
62705 *
62706 * @param mysqli_stmt $stmt
62707 * @return bool
62708 * @since PHP 5, PHP 7
62709 **/
62710function mysqli_stmt_close($stmt){}
62711
62712/**
62713 * Seeks to an arbitrary row in statement result set
62714 *
62715 * Seeks to an arbitrary result pointer in the statement result set.
62716 *
62717 * {@link mysqli_stmt_store_result} must be called prior to {@link
62718 * mysqli_stmt_data_seek}.
62719 *
62720 * @param mysqli_stmt $stmt Must be between zero and the total number
62721 *   of rows minus one (0.. {@link mysqli_stmt_num_rows} - 1).
62722 * @param int $offset
62723 * @return void
62724 * @since PHP 5, PHP 7
62725 **/
62726function mysqli_stmt_data_seek($stmt, $offset){}
62727
62728/**
62729 * Returns the error code for the most recent statement call
62730 *
62731 * Returns the error code for the most recently invoked statement
62732 * function that can succeed or fail.
62733 *
62734 * Client error message numbers are listed in the MySQL errmsg.h header
62735 * file, server error message numbers are listed in mysqld_error.h. In
62736 * the MySQL source distribution you can find a complete list of error
62737 * messages and error numbers in the file Docs/mysqld_error.txt.
62738 *
62739 * @param mysqli_stmt $stmt
62740 * @return int An error code value. Zero means no error occurred.
62741 * @since PHP 5, PHP 7
62742 **/
62743function mysqli_stmt_errno($stmt){}
62744
62745/**
62746 * Returns a string description for last statement error
62747 *
62748 * Returns a string containing the error message for the most recently
62749 * invoked statement function that can succeed or fail.
62750 *
62751 * @param mysqli_stmt $stmt
62752 * @return string A string that describes the error. An empty string if
62753 *   no error occurred.
62754 * @since PHP 5, PHP 7
62755 **/
62756function mysqli_stmt_error($stmt){}
62757
62758/**
62759 * Returns a list of errors from the last statement executed
62760 *
62761 * Returns an array of errors for the most recently invoked statement
62762 * function that can succeed or fail.
62763 *
62764 * @param mysqli_stmt $stmt
62765 * @return array A list of errors, each as an associative array
62766 *   containing the errno, error, and sqlstate.
62767 * @since PHP 5 >= 5.4.0, PHP 7
62768 **/
62769function mysqli_stmt_error_list($stmt){}
62770
62771/**
62772 * Executes a prepared Query
62773 *
62774 * Executes a query that has been previously prepared using the {@link
62775 * mysqli_prepare} function. When executed any parameter markers which
62776 * exist will automatically be replaced with the appropriate data.
62777 *
62778 * If the statement is UPDATE, DELETE, or INSERT, the total number of
62779 * affected rows can be determined by using the {@link
62780 * mysqli_stmt_affected_rows} function. Likewise, if the query yields a
62781 * result set the {@link mysqli_stmt_fetch} function is used.
62782 *
62783 * @param mysqli_stmt $stmt
62784 * @return bool
62785 * @since PHP 5, PHP 7
62786 **/
62787function mysqli_stmt_execute($stmt){}
62788
62789/**
62790 * Fetch results from a prepared statement into the bound variables
62791 *
62792 * Fetch the result from a prepared statement into the variables bound by
62793 * {@link mysqli_stmt_bind_result}.
62794 *
62795 * @param mysqli_stmt $stmt
62796 * @return bool
62797 * @since PHP 5, PHP 7
62798 **/
62799function mysqli_stmt_fetch($stmt){}
62800
62801/**
62802 * Returns the number of field in the given statement
62803 *
62804 * @param mysqli_stmt $stmt
62805 * @return int
62806 * @since PHP 5, PHP 7
62807 **/
62808function mysqli_stmt_field_count($stmt){}
62809
62810/**
62811 * Frees stored result memory for the given statement handle
62812 *
62813 * Frees the result memory associated with the statement, which was
62814 * allocated by {@link mysqli_stmt_store_result}.
62815 *
62816 * @param mysqli_stmt $stmt
62817 * @return void
62818 * @since PHP 5, PHP 7
62819 **/
62820function mysqli_stmt_free_result($stmt){}
62821
62822/**
62823 * Gets a result set from a prepared statement
62824 *
62825 * Call to return a result set from a prepared statement query.
62826 *
62827 * @param mysqli_stmt $stmt
62828 * @return mysqli_result Returns a resultset for successful SELECT
62829 *   queries, or FALSE for other DML queries or on failure. The {@link
62830 *   mysqli_errno} function can be used to distinguish between the two
62831 *   types of failure.
62832 * @since PHP 5 >= 5.3.0, PHP 7
62833 **/
62834function mysqli_stmt_get_result($stmt){}
62835
62836/**
62837 * Get result of SHOW WARNINGS
62838 *
62839 * @param mysqli_stmt $stmt
62840 * @return object
62841 * @since PHP 5 >= 5.1.0, PHP 7
62842 **/
62843function mysqli_stmt_get_warnings($stmt){}
62844
62845/**
62846 * Initializes a statement and returns an object for use with
62847 * mysqli_stmt_prepare
62848 *
62849 * Allocates and initializes a statement object suitable for {@link
62850 * mysqli_stmt_prepare}.
62851 *
62852 * @param mysqli $link
62853 * @return mysqli_stmt Returns an object.
62854 * @since PHP 5, PHP 7
62855 **/
62856function mysqli_stmt_init($link){}
62857
62858/**
62859 * Get the ID generated from the previous INSERT operation
62860 *
62861 * @param mysqli_stmt $stmt
62862 * @return mixed
62863 * @since PHP 5, PHP 7
62864 **/
62865function mysqli_stmt_insert_id($stmt){}
62866
62867/**
62868 * Check if there are more query results from a multiple query
62869 *
62870 * Checks if there are more query results from a multiple query.
62871 *
62872 * @param mysql_stmt $stmt
62873 * @return bool Returns TRUE if more results exist, otherwise FALSE.
62874 * @since PHP 5 >= 5.3.0, PHP 7
62875 **/
62876function mysqli_stmt_more_results($stmt){}
62877
62878/**
62879 * Reads the next result from a multiple query
62880 *
62881 * @param mysql_stmt $stmt
62882 * @return bool
62883 * @since PHP 5 >= 5.3.0, PHP 7
62884 **/
62885function mysqli_stmt_next_result($stmt){}
62886
62887/**
62888 * Return the number of rows in statements result set
62889 *
62890 * Returns the number of rows in the result set. The use of {@link
62891 * mysqli_stmt_num_rows} depends on whether or not you used {@link
62892 * mysqli_stmt_store_result} to buffer the entire result set in the
62893 * statement handle.
62894 *
62895 * If you use {@link mysqli_stmt_store_result}, {@link
62896 * mysqli_stmt_num_rows} may be called immediately.
62897 *
62898 * @param mysqli_stmt $stmt
62899 * @return int An integer representing the number of rows in result
62900 *   set.
62901 * @since PHP 5, PHP 7
62902 **/
62903function mysqli_stmt_num_rows($stmt){}
62904
62905/**
62906 * Returns the number of parameter for the given statement
62907 *
62908 * Returns the number of parameter markers present in the prepared
62909 * statement.
62910 *
62911 * @param mysqli_stmt $stmt
62912 * @return int Returns an integer representing the number of
62913 *   parameters.
62914 * @since PHP 5, PHP 7
62915 **/
62916function mysqli_stmt_param_count($stmt){}
62917
62918/**
62919 * Prepare an SQL statement for execution
62920 *
62921 * Prepares the SQL query pointed to by the null-terminated string query.
62922 *
62923 * The parameter markers must be bound to application variables using
62924 * {@link mysqli_stmt_bind_param} and/or {@link mysqli_stmt_bind_result}
62925 * before executing the statement or fetching rows.
62926 *
62927 * @param mysqli_stmt $stmt The query, as a string. It must consist of
62928 *   a single SQL statement. You can include one or more parameter
62929 *   markers in the SQL statement by embedding question mark (?)
62930 *   characters at the appropriate positions.
62931 * @param string $query
62932 * @return bool
62933 * @since PHP 5, PHP 7
62934 **/
62935function mysqli_stmt_prepare($stmt, $query){}
62936
62937/**
62938 * Resets a prepared statement
62939 *
62940 * Resets a prepared statement on client and server to state after
62941 * prepare.
62942 *
62943 * It resets the statement on the server, data sent using {@link
62944 * mysqli_stmt_send_long_data}, unbuffered result sets and current
62945 * errors. It does not clear bindings or stored result sets. Stored
62946 * result sets will be cleared when executing the prepared statement (or
62947 * closing it).
62948 *
62949 * To prepare a statement with another query use function {@link
62950 * mysqli_stmt_prepare}.
62951 *
62952 * @param mysqli_stmt $stmt
62953 * @return bool
62954 * @since PHP 5, PHP 7
62955 **/
62956function mysqli_stmt_reset($stmt){}
62957
62958/**
62959 * Returns result set metadata from a prepared statement
62960 *
62961 * If a statement passed to {@link mysqli_prepare} is one that produces a
62962 * result set, {@link mysqli_stmt_result_metadata} returns the result
62963 * object that can be used to process the meta information such as total
62964 * number of fields and individual field information.
62965 *
62966 * The result set structure should be freed when you are done with it,
62967 * which you can do by passing it to {@link mysqli_free_result}
62968 *
62969 * @param mysqli_stmt $stmt
62970 * @return mysqli_result Returns a result object or FALSE if an error
62971 *   occurred.
62972 * @since PHP 5, PHP 7
62973 **/
62974function mysqli_stmt_result_metadata($stmt){}
62975
62976/**
62977 * Send data in blocks
62978 *
62979 * Allows to send parameter data to the server in pieces (or chunks),
62980 * e.g. if the size of a blob exceeds the size of max_allowed_packet.
62981 * This function can be called multiple times to send the parts of a
62982 * character or binary data value for a column, which must be one of the
62983 * TEXT or BLOB datatypes.
62984 *
62985 * @param mysqli_stmt $stmt Indicates which parameter to associate the
62986 *   data with. Parameters are numbered beginning with 0.
62987 * @param int $param_nr A string containing data to be sent.
62988 * @param string $data
62989 * @return bool
62990 * @since PHP 5, PHP 7
62991 **/
62992function mysqli_stmt_send_long_data($stmt, $param_nr, $data){}
62993
62994/**
62995 * Returns SQLSTATE error from previous statement operation
62996 *
62997 * Returns a string containing the SQLSTATE error code for the most
62998 * recently invoked prepared statement function that can succeed or fail.
62999 * The error code consists of five characters. '00000' means no error.
63000 * The values are specified by ANSI SQL and ODBC. For a list of possible
63001 * values, see .
63002 *
63003 * @param mysqli_stmt $stmt
63004 * @return string Returns a string containing the SQLSTATE error code
63005 *   for the last error. The error code consists of five characters.
63006 *   '00000' means no error.
63007 * @since PHP 5, PHP 7
63008 **/
63009function mysqli_stmt_sqlstate($stmt){}
63010
63011/**
63012 * Transfers a result set from a prepared statement
63013 *
63014 * You must call {@link mysqli_stmt_store_result} for every query that
63015 * successfully produces a result set (SELECT, SHOW, DESCRIBE, EXPLAIN),
63016 * if and only if you want to buffer the complete result set by the
63017 * client, so that the subsequent {@link mysqli_stmt_fetch} call returns
63018 * buffered data.
63019 *
63020 * @param mysqli_stmt $stmt
63021 * @return bool
63022 * @since PHP 5, PHP 7
63023 **/
63024function mysqli_stmt_store_result($stmt){}
63025
63026/**
63027 * Transfers a result set from the last query
63028 *
63029 * Transfers the result set from the last query on the database
63030 * connection represented by the {@link link} parameter to be used with
63031 * the {@link mysqli_data_seek} function.
63032 *
63033 * @param mysqli $link The option that you want to set. It can be one
63034 *   of the following values: Valid options Name Description
63035 *   MYSQLI_STORE_RESULT_COPY_DATA Copy results from the internal mysqlnd
63036 *   buffer into the PHP variables fetched. By default, mysqlnd will use
63037 *   a reference logic to avoid copying and duplicating results held in
63038 *   memory. For certain result sets, for example, result sets with many
63039 *   small rows, the copy approach can reduce the overall memory usage
63040 *   because PHP variables holding results may be released earlier
63041 *   (available with mysqlnd only, since PHP 5.6.0)
63042 * @param int $option
63043 * @return mysqli_result Returns a buffered result object or FALSE if
63044 *   an error occurred.
63045 * @since PHP 5, PHP 7
63046 **/
63047function mysqli_store_result($link, $option){}
63048
63049/**
63050 * Returns the thread ID for the current connection
63051 *
63052 * The {@link mysqli_thread_id} function returns the thread ID for the
63053 * current connection which can then be killed using the {@link
63054 * mysqli_kill} function. If the connection is lost and you reconnect
63055 * with {@link mysqli_ping}, the thread ID will be other. Therefore you
63056 * should get the thread ID only when you need it.
63057 *
63058 * @param mysqli $link
63059 * @return int Returns the Thread ID for the current connection.
63060 * @since PHP 5, PHP 7
63061 **/
63062function mysqli_thread_id($link){}
63063
63064/**
63065 * Returns whether thread safety is given or not
63066 *
63067 * Tells whether the client library is compiled as thread-safe.
63068 *
63069 * @return bool TRUE if the client library is thread-safe, otherwise
63070 *   FALSE.
63071 * @since PHP 5, PHP 7
63072 **/
63073function mysqli_thread_safe(){}
63074
63075/**
63076 * Initiate a result set retrieval
63077 *
63078 * Used to initiate the retrieval of a result set from the last query
63079 * executed using the {@link mysqli_real_query} function on the database
63080 * connection.
63081 *
63082 * Either this or the {@link mysqli_store_result} function must be called
63083 * before the results of a query can be retrieved, and one or the other
63084 * must be called to prevent the next query on that database connection
63085 * from failing.
63086 *
63087 * @param mysqli $link
63088 * @return mysqli_result Returns an unbuffered result object or FALSE
63089 *   if an error occurred.
63090 * @since PHP 5, PHP 7
63091 **/
63092function mysqli_use_result($link){}
63093
63094/**
63095 * Returns the number of warnings from the last query for the given link
63096 *
63097 * Returns the number of warnings from the last query in the connection.
63098 *
63099 * @param mysqli $link
63100 * @return int Number of warnings or zero if there are no warnings.
63101 * @since PHP 5, PHP 7
63102 **/
63103function mysqli_warning_count($link){}
63104
63105/**
63106 * Returns information about the plugin configuration
63107 *
63108 * This function returns an array of all mysqlnd_memcache related
63109 * configuration information that is attached to the MySQL connection.
63110 * This includes MySQL, the Memcache object provided via {@link
63111 * mysqlnd_memcache_set}, and the table mapping configuration that was
63112 * automatically collected from the MySQL Server.
63113 *
63114 * @param mixed $connection A handle to a MySQL Server using one of the
63115 *   MySQL API extensions for PHP, which are PDO_MYSQL, mysqli or
63116 *   ext/mysql.
63117 * @return array An array of mysqlnd_memcache configuration information
63118 *   on success, otherwise FALSE.
63119 * @since PECL mysqlnd_memcache >= 1.0.0
63120 **/
63121function mysqlnd_memcache_get_config($connection){}
63122
63123/**
63124 * Associate a MySQL connection with a Memcache connection
63125 *
63126 * Associate {@link mysql_connection} with {@link memcache_connection}
63127 * using {@link pattern} as a PCRE regular expression, and {@link
63128 * callback} as a notification callback or to unset the association of
63129 * {@link mysql_connection}.
63130 *
63131 * While associating a MySQL connection with a Memcache connection, this
63132 * function will query the MySQL Server for its configuration. It will
63133 * automatically detect whether the server is configured to use the
63134 * InnoDB Memcache Daemon Plugin or MySQL Cluster NDB Memcache support.
63135 * It will also query the server to automatically identify exported
63136 * tables and other configuration options. The results of this automatic
63137 * configuration can be retrieved using {@link
63138 * mysqlnd_memcache_get_config}.
63139 *
63140 * @param mixed $mysql_connection A handle to a MySQL Server using one
63141 *   of the MySQL API extensions for PHP, which are PDO_MYSQL, mysqli or
63142 *   ext/mysql.
63143 * @param Memcached $memcache_connection A Memcached instance with a
63144 *   connection to the MySQL Memcache Daemon plugin. If this parameter is
63145 *   omitted, then {@link mysql_connection} will be unassociated from any
63146 *   memcache connection. And if a previous association exists, then it
63147 *   will be replaced.
63148 * @param string $pattern A regular expression in Perl Compatible
63149 *   Regular Expression syntax used to identify potential
63150 *   Memcache-queries. The query should have three sub patterns. The
63151 *   first subpattern contains the requested field list, the second the
63152 *   name of the ID column from the query and the third the requested
63153 *   value. If this parameter is omitted or os set to NULL, then a
63154 *   default pattern will be used.
63155 * @param callback $callback A callback which will be used whenever a
63156 *   query is being sent to MySQL. The callback will receive a single
63157 *   parameter telling if a query was sent via Memcache.
63158 * @return bool TRUE if the association or disassociation is
63159 *   successful, otherwise FALSE if there is an error.
63160 * @since PECL mysqlnd_memcache >= 1.0.0
63161 **/
63162function mysqlnd_memcache_set($mysql_connection, $memcache_connection, $pattern, $callback){}
63163
63164/**
63165 * Returns a list of currently configured servers
63166 *
63167 * @param mixed $connection A MySQL connection handle obtained from any
63168 *   of the connect functions of the mysqli, mysql or PDO_MYSQL
63169 *   extensions.
63170 * @return array FALSE on error. Otherwise, returns an array with two
63171 *   entries masters and slaves each of which contains an array listing
63172 *   all corresponding servers.
63173 **/
63174function mysqlnd_ms_dump_servers($connection){}
63175
63176/**
63177 * Switch to global sharding server for a given table
63178 *
63179 * MySQL Fabric related.
63180 *
63181 * Switch the connection to the nodes handling global sharding queries
63182 * for the given table name.
63183 *
63184 * @param mixed $connection A MySQL connection handle obtained from any
63185 *   of the connect functions of the mysqli, mysql or PDO_MYSQL
63186 *   extensions.
63187 * @param mixed $table_name The table name to ask Fabric about.
63188 * @return array FALSE on error. Otherwise, TRUE
63189 **/
63190function mysqlnd_ms_fabric_select_global($connection, $table_name){}
63191
63192/**
63193 * Switch to shard
63194 *
63195 * MySQL Fabric related.
63196 *
63197 * Switch the connection to the shards responsible for the given table
63198 * name and shard key.
63199 *
63200 * @param mixed $connection A MySQL connection handle obtained from any
63201 *   of the connect functions of the mysqli, mysql or PDO_MYSQL
63202 *   extensions.
63203 * @param mixed $table_name The table name to ask Fabric about.
63204 * @param mixed $shard_key The shard key to ask Fabric about.
63205 * @return array FALSE on error. Otherwise, TRUE
63206 **/
63207function mysqlnd_ms_fabric_select_shard($connection, $table_name, $shard_key){}
63208
63209/**
63210 * Returns the latest global transaction ID
63211 *
63212 * Returns a global transaction identifier which belongs to a write
63213 * operation no older than the last write performed by the client. It is
63214 * not guaranteed that the global transaction identifier is identical to
63215 * that one created for the last write transaction performed by the
63216 * client.
63217 *
63218 * @param mixed $connection A PECL/mysqlnd_ms connection handle to a
63219 *   MySQL server of the type PDO_MYSQL, mysqli> or ext/mysql. The
63220 *   connection handle is obtained when opening a connection with a host
63221 *   name that matches a mysqlnd_ms configuration file entry using any of
63222 *   the above three MySQL driver extensions.
63223 * @return string Returns a global transaction ID (GTID) on success.
63224 *   Otherwise, returns FALSE.
63225 * @since PECL mysqlnd_ms >= 1.2.0
63226 **/
63227function mysqlnd_ms_get_last_gtid($connection){}
63228
63229/**
63230 * Returns an array which describes the last used connection
63231 *
63232 * Returns an array which describes the last used connection from the
63233 * plugins connection pool currently pointed to by the user connection
63234 * handle. If using the plugin, a user connection handle represents a
63235 * pool of database connections. It is not possible to tell from the user
63236 * connection handles properties to which database server from the pool
63237 * the user connection handle points.
63238 *
63239 * The function can be used to debug or monitor PECL mysqlnd_ms.
63240 *
63241 * @param mixed $connection A MySQL connection handle obtained from any
63242 *   of the connect functions of the mysqli, mysql or PDO_MYSQL
63243 *   extensions.
63244 * @return array FALSE on error. Otherwise, an array which describes
63245 *   the connection used to execute the last statement on.
63246 * @since PECL mysqlnd_ms >= 1.1.0
63247 **/
63248function mysqlnd_ms_get_last_used_connection($connection){}
63249
63250/**
63251 * Returns query distribution and connection statistics
63252 *
63253 * Returns an array of statistics collected by the replication and load
63254 * balancing plugin.
63255 *
63256 * The PHP configuration setting mysqlnd_ms.collect_statistics controls
63257 * the collection of statistics. The collection of statistics is disabled
63258 * by default for performance reasons.
63259 *
63260 * The scope of the statistics is the PHP process. Depending on your
63261 * deployment model a PHP process may handle one or multiple requests.
63262 *
63263 * Statistics are aggregated for all connections and all storage handler.
63264 * It is not possible to tell how much queries originating from mysqli,
63265 * PDO_MySQL or mysql API calls have contributed to the aggregated data
63266 * values.
63267 *
63268 * @return array Returns NULL if the PHP configuration directive
63269 *   mysqlnd_ms.enable has disabled the plugin. Otherwise, returns array
63270 *   of statistics.
63271 * @since PECL mysqlnd_ms >= 1.0.0
63272 **/
63273function mysqlnd_ms_get_stats(){}
63274
63275/**
63276 * Finds whether a table name matches a wildcard pattern or not
63277 *
63278 * This function is not of much practical relevance with PECL mysqlnd_ms
63279 * 1.1.0 because the plugin does not support MySQL replication table
63280 * filtering yet.
63281 *
63282 * @param string $table_name The table name to check if it is matched
63283 *   by the wildcard.
63284 * @param string $wildcard The wildcard pattern to check against the
63285 *   table name. The wildcard pattern supports the same placeholders as
63286 *   MySQL replication filters do. MySQL replication filters can be
63287 *   configured by using the MySQL Server configuration options
63288 *   --replicate-wild-do-table and --replicate-wild-do-db. Please,
63289 *   consult the MySQL Reference Manual to learn more about this MySQL
63290 *   Server feature. The supported placeholders are: % - zero or more
63291 *   literals _ - one literal Placeholders can be escaped using \.
63292 * @return bool Returns TRUE table_name is matched by wildcard.
63293 *   Otherwise, returns FALSE
63294 * @since PECL mysqlnd_ms >= 1.1.0
63295 **/
63296function mysqlnd_ms_match_wild($table_name, $wildcard){}
63297
63298/**
63299 * Find whether to send the query to the master, the slave or the last
63300 * used MySQL server
63301 *
63302 * Finds whether to send the query to the master, the slave or the last
63303 * used MySQL server.
63304 *
63305 * The plugins built-in read/write split mechanism will be used to
63306 * analyze the query string to make a recommendation where to send the
63307 * query. The built-in read/write split mechanism is very basic and
63308 * simple. The plugin will recommend sending all queries to the MySQL
63309 * replication master server but those which begin with SELECT, or begin
63310 * with a SQL hint which enforces sending the query to a slave server.
63311 * Due to the basic but fast algorithm the plugin may propose to run some
63312 * read-only statements such as SHOW TABLES on the replication master.
63313 *
63314 * @param string $query Query string to test.
63315 * @return int A return value of MYSQLND_MS_QUERY_USE_MASTER indicates
63316 *   that the query should be send to the MySQL replication master
63317 *   server. The function returns a value of MYSQLND_MS_QUERY_USE_SLAVE
63318 *   if the query can be run on a slave because it is considered
63319 *   read-only. A value of MYSQLND_MS_QUERY_USE_LAST_USED is returned to
63320 *   recommend running the query on the last used server. This can either
63321 *   be a MySQL replication master server or a MySQL replication slave
63322 *   server.
63323 * @since PECL mysqlnd_ms >= 1.0.0
63324 **/
63325function mysqlnd_ms_query_is_select($query){}
63326
63327/**
63328 * Sets the quality of service needed from the cluster
63329 *
63330 * Sets the quality of service needed from the cluster. A database
63331 * cluster delivers a certain quality of service to the user depending on
63332 * its architecture. A major aspect of the quality of service is the
63333 * consistency level the cluster can offer. An asynchronous MySQL
63334 * replication cluster defaults to eventual consistency for slave reads:
63335 * a slave may serve stale data, current data, or it may have not the
63336 * requested data at all, because it is not synchronous to the master. In
63337 * a MySQL replication cluster, only master accesses can give strong
63338 * consistency, which promises that all clients see each others changes.
63339 *
63340 * PECL/mysqlnd_ms hides the complexity of choosing appropriate nodes to
63341 * achieve a certain level of service from the cluster. The "Quality of
63342 * Service" filter implements the necessary logic. The filter can either
63343 * be configured in the plugins configuration file, or at runtime using
63344 * {@link mysqlnd_ms_set_qos}.
63345 *
63346 * Similar results can be achieved with PECL mysqlnd_ms < 1.2.0, if using
63347 * SQL hints to force the use of a certain type of node or using the
63348 * master_on_write plugin configuration option. The first requires more
63349 * code and causes more work on the application side. The latter is less
63350 * refined than using the quality of service filter. Settings made
63351 * through the function call can be reversed, as shown in the example
63352 * below. The example temporarily switches to a higher service level
63353 * (session consistency, read your writes) and returns back to the
63354 * clusters default after it has performed all operations that require
63355 * the better service. This way, read load on the master can be minimized
63356 * compared to using master_on_write, which would continue using the
63357 * master after the first write.
63358 *
63359 * Since 1.5.0 calls will fail when done in the middle of a transaction
63360 * if transaction stickiness is enabled and transaction boundaries have
63361 * been detected. properly.
63362 *
63363 * @param mixed $connection A PECL/mysqlnd_ms connection handle to a
63364 *   MySQL server of the type PDO_MYSQL, mysqli or ext/mysql for which a
63365 *   service level is to be set. The connection handle is obtained when
63366 *   opening a connection with a host name that matches a mysqlnd_ms
63367 *   configuration file entry using any of the above three MySQL driver
63368 *   extensions.
63369 * @param int $service_level The requested service level:
63370 *   MYSQLND_MS_QOS_CONSISTENCY_EVENTUAL,
63371 *   MYSQLND_MS_QOS_CONSISTENCY_SESSION or
63372 *   MYSQLND_MS_QOS_CONSISTENCY_STRONG.
63373 * @param int $service_level_option An option to parameterize the
63374 *   requested service level. The option can either be
63375 *   MYSQLND_MS_QOS_OPTION_GTID or MYSQLND_MS_QOS_OPTION_AGE. The option
63376 *   MYSQLND_MS_QOS_OPTION_GTID can be used to refine the service level
63377 *   MYSQLND_MS_QOS_CONSISTENCY_SESSION. It must be combined with a
63378 *   fourth function parameter, the {@link option_value}. The {@link
63379 *   option_value} shall be a global transaction ID obtained from {@link
63380 *   mysqlnd_ms_get_last_gtid}. If set, the plugin considers both master
63381 *   servers and asynchronous slaves for session consistency (read your
63382 *   writes). Otherwise, only masters are used to achieve session
63383 *   consistency. A slave is considered up-to-date and checked if it has
63384 *   already replicated the global transaction ID from {@link
63385 *   option_value}. Please note, searching appropriate slaves is an
63386 *   expensive and slow operation. Use the feature sparsely, if the
63387 *   master cannot handle the read load alone. The
63388 *   MYSQLND_MS_QOS_OPTION_AGE option can be combined with the
63389 *   MYSQLND_MS_QOS_CONSISTENCY_EVENTUAL service level, to filter out
63390 *   asynchronous slaves that lag more seconds behind the master than
63391 *   {@link option_value}. If set, the plugin will only consider slaves
63392 *   for reading if SHOW SLAVE STATUS reports Slave_IO_Running=Yes,
63393 *   Slave_SQL_Running=Yes and Seconds_Behind_Master <= option_value.
63394 *   Please note, searching appropriate slaves is an expensive and slow
63395 *   operation. Use the feature sparsely in version 1.2.0. Future
63396 *   versions may improve the algorithm used to identify candidates.
63397 *   Please, see the MySQL reference manual about the precision, accuracy
63398 *   and limitations of the MySQL administrative command SHOW SLAVE
63399 *   STATUS.
63400 * @param mixed $option_value Parameter value for the service level
63401 *   option. See also the {@link service_level_option} parameter.
63402 * @return bool Returns TRUE if the connections service level has been
63403 *   switched to the requested. Otherwise, returns FALSE
63404 * @since PECL mysqlnd_ms < 1.2.0
63405 **/
63406function mysqlnd_ms_set_qos($connection, $service_level, $service_level_option, $option_value){}
63407
63408/**
63409 * Sets a callback for user-defined read/write splitting
63410 *
63411 * Sets a callback for user-defined read/write splitting. The plugin will
63412 * call the callback only if pick[]=user is the default rule for server
63413 * picking in the relevant section of the plugins configuration file.
63414 *
63415 * The plugins built-in read/write query split mechanism decisions can be
63416 * overwritten in two ways. The easiest way is to prepend the query
63417 * string with the SQL hints MYSQLND_MS_MASTER_SWITCH,
63418 * MYSQLND_MS_SLAVE_SWITCH or MYSQLND_MS_LAST_USED_SWITCH. Using SQL
63419 * hints one can control, for example, whether a query shall be send to
63420 * the MySQL replication master server or one of the slave servers. By
63421 * help of SQL hints it is not possible to pick a certain slave server
63422 * for query execution.
63423 *
63424 * Full control on server selection can be gained using a callback
63425 * function. Use of a callback is recommended to expert users only
63426 * because the callback has to cover all cases otherwise handled by the
63427 * plugin.
63428 *
63429 * The plugin will invoke the callback function for selecting a server
63430 * from the lists of configured master and slave servers. The callback
63431 * function inspects the query to run and picks a server for query
63432 * execution by returning the hosts URI, as found in the master and slave
63433 * list.
63434 *
63435 * If the lazy connections are enabled and the callback chooses a slave
63436 * server for which no connection has been established so far and
63437 * establishing the connection to the slave fails, the plugin will return
63438 * an error upon the next action on the failed connection, for example,
63439 * when running a query. It is the responsibility of the application
63440 * developer to handle the error. For example, the application can re-run
63441 * the query to trigger a new server selection and callback invocation.
63442 * If so, the callback must make sure to select a different slave, or
63443 * check slave availability, before returning to the plugin to prevent an
63444 * endless loop.
63445 *
63446 * @param string $function The function to be called. Class methods may
63447 *   also be invoked statically using this function by passing
63448 *   array($classname, $methodname) to this parameter. Additionally class
63449 *   methods of an object instance may be called by passing
63450 *   array($objectinstance, $methodname) to this parameter.
63451 * @return bool Host to run the query on. The host URI is to be taken
63452 *   from the master and slave connection lists passed to the callback
63453 *   function. If callback returns a value neither found in the master
63454 *   nor in the slave connection lists the plugin will fallback to the
63455 *   second pick method configured via the pick[] setting in the plugin
63456 *   configuration file. If not second pick method is given, the plugin
63457 *   falls back to the build-in default pick method for server selection.
63458 * @since PECL mysqlnd_ms < 1.1.0
63459 **/
63460function mysqlnd_ms_set_user_pick_server($function){}
63461
63462/**
63463 * Starts a distributed/XA transaction among MySQL servers
63464 *
63465 * Starts a XA transaction among MySQL servers. PECL/mysqlnd_ms acts as a
63466 * transaction coordinator the distributed transaction.
63467 *
63468 * Once a global transaction has been started, the plugin injects
63469 * appropriate XA BEGIN SQL statements on all MySQL servers used in the
63470 * following. The global transaction is either ended by calling {@link
63471 * mysqlnd_ms_xa_commit}, {@link mysqlnd_ms_xa_rollback} or by an
63472 * implicit rollback in case of an error.
63473 *
63474 * During a global transaction, the plugin tracks all server switches,
63475 * for example, when switching from one MySQL shard to another MySQL
63476 * shard. Immediately before a query is run on a server that has not been
63477 * participating in the global transaction yet, XA BEGIN is executed on
63478 * the server. From a users perspective the injection happens during a
63479 * call to a query execution function such as {@link mysqli_query}.
63480 * Should the injection fail an error is reported to the caller of the
63481 * query execution function. The failing server does not become a
63482 * participant in the global transaction. The user may retry executing a
63483 * query on the server and hereby retry injecting XA BEGIN, abort the
63484 * global transaction because not all required servers can participate,
63485 * or ignore and continue the global without the failed server.
63486 *
63487 * Reasons to fail executing XA BEGIN include but are not limited to a
63488 * server being unreachable or the server having an open, concurrent XA
63489 * transaction using the same xid.
63490 *
63491 * Please note, global and local transactions are mutually exclusive. You
63492 * cannot start a XA transaction when you have a local transaction open.
63493 * The local transaction must be ended first. The plugin tries to detect
63494 * this conflict as early as possible. It monitors API calls for
63495 * controlling local transactions to learn about the current state.
63496 * However, if using SQL statements for local transactions such as BEGIN,
63497 * the plugin may not know the current state and the conflict is not
63498 * detected before XA BEGIN is injected and executed.
63499 *
63500 * The use of other XA resources but MySQL servers is not supported by
63501 * the function. To carry out a global transaction among, for example, a
63502 * MySQL server and another vendors database system, you should issue the
63503 * systems SQL commands yourself.
63504 *
63505 * @param mixed $connection A MySQL connection handle obtained from any
63506 *   of the connect functions of the mysqli, mysql or PDO_MYSQL
63507 *   extensions.
63508 * @param string $gtrid Global transaction identifier (gtrid). The
63509 *   gtrid is a binary string up to 64 bytes long. Please note, depending
63510 *   on your character set settings, 64 characters may require more than
63511 *   64 bytes to store. In accordance with the MySQL SQL syntax, XA
63512 *   transactions use identifiers made of three parts. An xid consists of
63513 *   a global transaction identifier (gtrid), a branch qualifier (bqual)
63514 *   and a format identifier (formatID). Only the global transaction
63515 *   identifier can and needs to be set. The branch qualifier and format
63516 *   identifier are set automatically. The details should be considered
63517 *   implementation dependent, which may change without prior notice. In
63518 *   version 1.6 the branch qualifier is consecutive number which is
63519 *   incremented whenever a participant joins the global transaction.
63520 * @param int $timeout Timeout in seconds. The default value is 60
63521 *   seconds. The timeout is a hint to the garbage collection. If a
63522 *   transaction is recorded to take longer than expected, the garbage
63523 *   collection begins checking the transactions status. Setting a low
63524 *   value may make the garbage collection check the progress too often.
63525 *   Please note, checking the status of a global transaction may involve
63526 *   connecting to all recorded participants and possibly issuing queries
63527 *   on the servers.
63528 * @return int Returns TRUE if there is no open local or global
63529 *   transaction and a new global transaction can be started. Otherwise,
63530 *   returns FALSE
63531 * @since PECL mysqlnd_ms < 1.6.0
63532 **/
63533function mysqlnd_ms_xa_begin($connection, $gtrid, $timeout){}
63534
63535/**
63536 * Commits a distributed/XA transaction among MySQL servers
63537 *
63538 * Commits a global transaction among MySQL servers started by {@link
63539 * mysqlnd_ms_xa_begin}.
63540 *
63541 * If any of the global transaction participants fails to commit an
63542 * implicit rollback is performed. It may happen that not all cases can
63543 * be handled during the rollback. For example, no attempts will be made
63544 * to reconnect to a participant after the connection to the participant
63545 * has been lost. Solving cases that cannot easily be rolled back is left
63546 * to the garbage collection.
63547 *
63548 * @param mixed $connection A MySQL connection handle obtained from any
63549 *   of the connect functions of the mysqli, mysql or PDO_MYSQL
63550 *   extensions.
63551 * @param string $gtrid Global transaction identifier (gtrid).
63552 * @return int Returns TRUE if the global transaction has been
63553 *   committed. Otherwise, returns FALSE
63554 * @since PECL mysqlnd_ms < 1.6.0
63555 **/
63556function mysqlnd_ms_xa_commit($connection, $gtrid){}
63557
63558/**
63559 * Garbage collects unfinished XA transactions after severe errors
63560 *
63561 * Garbage collects unfinished XA transactions.
63562 *
63563 * The XA protocol is a blocking protocol. There exist cases when servers
63564 * participating in a global transaction cannot make progress when the
63565 * transaction coordinator crashes or disconnects. In such a case, the
63566 * MySQL servers keep waiting for instructions to finish the XA
63567 * transaction in question. Because transactions occupy resources,
63568 * transactions should always be terminated properly.
63569 *
63570 * Garbage collection requires configuring a state store to track global
63571 * transactions. Should a PHP client crash in the middle of a transaction
63572 * and a new PHP client be started, then the built-in garbage collection
63573 * can learn about the aborted global transaction and terminate it. If
63574 * you do not configure a state store, the garbage collection cannot
63575 * perform any cleanup tasks.
63576 *
63577 * The state store should be crash-safe and be highly available to
63578 * survive its own crash. Currently, only MySQL is supported as a state
63579 * store.
63580 *
63581 * Garbage collection can also be performed automatically in the
63582 * background. See the plugin configuration directive garbage_collection
63583 * for details.
63584 *
63585 * @param mixed $connection A MySQL connection handle obtained from any
63586 *   of the connect functions of the mysqli, mysql or PDO_MYSQL
63587 *   extensions.
63588 * @param string $gtrid Global transaction identifier (gtrid). If
63589 *   given, the garbage collection considers the transaction only.
63590 *   Otherwise, the state store is scanned for any unfinished
63591 *   transaction.
63592 * @param bool $ignore_max_retries Whether to ignore the plugin
63593 *   configuration max_retries setting. If garbage collection
63594 *   continuously fails and the max_retries limit is reached prior to
63595 *   finishing the failed global transaction, you can attempt further
63596 *   runs prior to investigating the cause and solving the issue manually
63597 *   by issuing appropriate SQL statements on the participants. Setting
63598 *   the parameter has the same effect as temporarily setting max_retries
63599 *   = 0.
63600 * @return int Returns TRUE if garbage collection was successful.
63601 *   Otherwise, returns FALSE
63602 * @since PECL mysqlnd_ms < 1.6.0
63603 **/
63604function mysqlnd_ms_xa_gc($connection, $gtrid, $ignore_max_retries){}
63605
63606/**
63607 * Rolls back a distributed/XA transaction among MySQL servers
63608 *
63609 * Rolls back a global transaction among MySQL servers started by {@link
63610 * mysqlnd_ms_xa_begin}.
63611 *
63612 * If any of the global transaction participants fails to rollback the
63613 * situation is left to be solved by the garbage collection.
63614 *
63615 * @param mixed $connection A MySQL connection handle obtained from any
63616 *   of the connect functions of the mysqli, mysql or PDO_MYSQL
63617 *   extensions.
63618 * @param string $gtrid Global transaction identifier (gtrid).
63619 * @return int Returns TRUE if the global transaction has been rolled
63620 *   back. Otherwise, returns FALSE
63621 * @since PECL mysqlnd_ms < 1.6.0
63622 **/
63623function mysqlnd_ms_xa_rollback($connection, $gtrid){}
63624
63625/**
63626 * Flush all cache contents
63627 *
63628 * Flushing the cache is a storage handler responsibility. All built-in
63629 * storage handler but the memcache storage handler support flushing the
63630 * cache. The memcache storage handler cannot flush its cache contents.
63631 *
63632 * User-defined storage handler may or may not support the operation.
63633 *
63634 * @return bool
63635 * @since PECL mysqlnd_qc >= 1.0.0
63636 **/
63637function mysqlnd_qc_clear_cache(){}
63638
63639/**
63640 * Returns a list of available storage handler
63641 *
63642 * Which storage are available depends on the compile time configuration
63643 * of the query cache plugin. The default storage handler is always
63644 * available. All other storage handler must be enabled explicitly when
63645 * building the extension.
63646 *
63647 * @return array Returns an array of available built-in storage
63648 *   handler. For each storage handler the version number and version
63649 *   string is given.
63650 * @since PECL mysqlnd_qc >= 1.0.0
63651 **/
63652function mysqlnd_qc_get_available_handlers(){}
63653
63654/**
63655 * Returns information on the current handler, the number of cache
63656 * entries and cache entries, if available
63657 *
63658 * @return array Returns information on the current handler, the number
63659 *   of cache entries and cache entries, if available. If and what data
63660 *   will be returned for the cache entries is subject to the active
63661 *   storage handler. Storage handler are free to return any data.
63662 *   Storage handler are recommended to return at least the data provided
63663 *   by the default handler, if technically possible.
63664 * @since PECL mysqlnd_qc >= 1.0.0
63665 **/
63666function mysqlnd_qc_get_cache_info(){}
63667
63668/**
63669 * Statistics collected by the core of the query cache
63670 *
63671 * Returns an array of statistics collected by the core of the cache
63672 * plugin. The same data fields will be reported for any storage handler
63673 * because the data is collected by the core.
63674 *
63675 * The PHP configuration setting mysqlnd_qc.collect_statistics controls
63676 * the collection of statistics. The collection of statistics is disabled
63677 * by default for performance reasons. Disabling the collection of
63678 * statistics will also disable the collection of time related
63679 * statistics.
63680 *
63681 * The PHP configuration setting mysqlnd_qc.collect_time_statistics
63682 * controls the collection of time related statistics.
63683 *
63684 * The scope of the core statistics is the PHP process. Depending on your
63685 * deployment model a PHP process may handle one or multiple requests.
63686 *
63687 * Statistics are aggregated for all cache entries and all storage
63688 * handler. It is not possible to tell how much queries originating from
63689 * mysqli, PDO_MySQL or mysql API calls have contributed to the
63690 * aggregated data values.
63691 *
63692 * @return array Array of core statistics
63693 * @since PECL mysqlnd_qc >= 1.0.0
63694 **/
63695function mysqlnd_qc_get_core_stats(){}
63696
63697/**
63698 * Returns a normalized query trace log for each query inspected by the
63699 * query cache
63700 *
63701 * Returns a normalized query trace log for each query inspected by the
63702 * query cache. The collection of the trace log is disabled by default.
63703 * To collect the trace log you have to set the PHP configuration
63704 * directive mysqlnd_qc.collect_normalized_query_trace to 1
63705 *
63706 * Entries in the trace log are grouped by the normalized query
63707 * statement. The normalized query statement is the query statement with
63708 * all statement parameter values being replaced with a question mark.
63709 * For example, the two statements SELECT id FROM test WHERE id = 1 and
63710 * SELECT id FROM test WHERE id = 2 are normalized as SELECT id FROM test
63711 * WHERE id = ?. Whenever a statement is inspected by the query cache
63712 * which matches the normalized statement pattern, its statistics are
63713 * grouped by the normalized statement string.
63714 *
63715 * @return array An array of query log. Every list entry contains the
63716 *   normalized query stringand further detail information.
63717 * @since PECL mysqlnd_qc >= 1.0.0
63718 **/
63719function mysqlnd_qc_get_normalized_query_trace_log(){}
63720
63721/**
63722 * Returns a backtrace for each query inspected by the query cache
63723 *
63724 * Returns a backtrace for each query inspected by the query cache. The
63725 * collection of the backtrace is disabled by default. To collect the
63726 * backtrace you have to set the PHP configuration directive
63727 * mysqlnd_qc.collect_query_trace to 1
63728 *
63729 * The maximum depth of the backtrace is limited to the depth set with
63730 * the PHP configuration directive mysqlnd_qc.query_trace_bt_depth.
63731 *
63732 * @return array An array of query backtrace. Every list entry contains
63733 *   the query string, a backtrace and further detail information.
63734 * @since PECL mysqlnd_qc >= 1.0.0
63735 **/
63736function mysqlnd_qc_get_query_trace_log(){}
63737
63738/**
63739 * Set conditions for automatic caching
63740 *
63741 * Sets a condition for automatic caching of statements which do not
63742 * contain the necessary SQL hints to enable caching of them.
63743 *
63744 * @param int $condition_type Type of the condition. The only allowed
63745 *   value is MYSQLND_QC_CONDITION_META_SCHEMA_PATTERN.
63746 * @param mixed $condition Parameter for the condition set with
63747 *   condition_type. Parameter type and structure depend on
63748 *   condition_type If condition_type equals
63749 *   MYSQLND_QC_CONDITION_META_SCHEMA_PATTERN condition must be a string.
63750 *   The string sets a pattern. Statements are cached if table and
63751 *   database meta data entry of their result sets match the pattern. The
63752 *   pattern is checked for a match with the db and org_table meta data
63753 *   entries provided by the underlying MySQL client server library.
63754 *   Please, check the MySQL Reference manual for details about the two
63755 *   entries. The db and org_table values are concatenated with a dot (.)
63756 *   before matched against condition. Pattern matching supports the
63757 *   wildcards % and _. The wildcard % will match one or many arbitrary
63758 *   characters. _ will match one arbitrary character. The escape symbol
63759 *   is backslash.
63760 * @param mixed $condition_option Option for condition. Type and
63761 *   structure depend on condition_type. If condition_type equals
63762 *   MYSQLND_QC_CONDITION_META_SCHEMA_PATTERN condition_options is the
63763 *   TTL to be used.
63764 * @return bool Returns TRUE on success or FALSE on FAILURE.
63765 * @since PECL mysqlnd_qc >= 1.1.0
63766 **/
63767function mysqlnd_qc_set_cache_condition($condition_type, $condition, $condition_option){}
63768
63769/**
63770 * Installs a callback which decides whether a statement is cached
63771 *
63772 * There are several ways of hinting PELC/mysqlnd_qc to cache a query. By
63773 * default, PECL/mysqlnd_qc attempts to cache a if caching of all
63774 * statements is enabled or the query string begins with a certain SQL
63775 * hint. The plugin internally calls a function named is_select() to find
63776 * out. This internal function can be replaced with a user-defined
63777 * callback. Then, the user-defined callback is responsible to decide
63778 * whether the plugin attempts to cache a statement. Because the internal
63779 * function is replaced with the callback, the callback gains full
63780 * control. The callback is free to ignore the configuration setting
63781 * mysqlnd_qc.cache_by_default and SQL hints.
63782 *
63783 * The callback is invoked for every statement inspected by the plugin.
63784 * It is given the statements string as a parameter. The callback returns
63785 * FALSE if the statement shall not be cached. It returns TRUE to make
63786 * the plugin attempt to cache the statements result set, if any. A
63787 * so-created cache entry is given the default TTL set with the PHP
63788 * configuration directive mysqlnd_qc.ttl. If a different TTL shall be
63789 * used, the callback returns a numeric value to be used as the TTL.
63790 *
63791 * The internal is_select function is part of the internal cache storage
63792 * handler interface. Thus, a user-defined storage handler offers the
63793 * same capabilities.
63794 *
63795 * @param string $callback
63796 * @return mixed
63797 * @since PECL mysqlnd_qc >= 1.0.0
63798 **/
63799function mysqlnd_qc_set_is_select($callback){}
63800
63801/**
63802 * Change current storage handler
63803 *
63804 * Sets the storage handler used by the query cache. A list of available
63805 * storage handler can be obtained from {@link
63806 * mysqlnd_qc_get_available_handlers}. Which storage are available
63807 * depends on the compile time configuration of the query cache plugin.
63808 * The default storage handler is always available. All other storage
63809 * handler must be enabled explicitly when building the extension.
63810 *
63811 * @param string $handler Handler can be of type string representing
63812 *   the name of a built-in storage handler or an object of type
63813 *   mysqlnd_qc_handler_default. The names of the built-in storage
63814 *   handler are default, APC, MEMCACHE, sqlite.
63815 * @return bool
63816 * @since PECL mysqlnd_qc >= 1.0.0
63817 **/
63818function mysqlnd_qc_set_storage_handler($handler){}
63819
63820/**
63821 * Sets the callback functions for a user-defined procedural storage
63822 * handler
63823 *
63824 * @param string $get_hash Name of the user function implementing the
63825 *   storage handler get_hash functionality.
63826 * @param string $find_query_in_cache Name of the user function
63827 *   implementing the storage handler find_in_cache functionality.
63828 * @param string $return_to_cache Name of the user function
63829 *   implementing the storage handler return_to_cache functionality.
63830 * @param string $add_query_to_cache_if_not_exists Name of the user
63831 *   function implementing the storage handler
63832 *   add_query_to_cache_if_not_exists functionality.
63833 * @param string $query_is_select Name of the user function
63834 *   implementing the storage handler query_is_select functionality.
63835 * @param string $update_query_run_time_stats Name of the user function
63836 *   implementing the storage handler update_query_run_time_stats
63837 *   functionality.
63838 * @param string $get_stats Name of the user function implementing the
63839 *   storage handler get_stats functionality.
63840 * @param string $clear_cache Name of the user function implementing
63841 *   the storage handler clear_cache functionality.
63842 * @return bool Returns TRUE on success or FALSE on FAILURE.
63843 * @since PECL mysqlnd_qc >= 1.0.0
63844 **/
63845function mysqlnd_qc_set_user_handlers($get_hash, $find_query_in_cache, $return_to_cache, $add_query_to_cache_if_not_exists, $query_is_select, $update_query_run_time_stats, $get_stats, $clear_cache){}
63846
63847/**
63848 * Converts a MySQL connection handle into a mysqlnd connection handle
63849 *
63850 * Converts a MySQL connection handle into a mysqlnd connection handle.
63851 * After conversion you can execute mysqlnd library calls on the
63852 * connection handle. This can be used to access mysqlnd functionality
63853 * not made available through user space API calls.
63854 *
63855 * The function can be disabled with mysqlnd_uh.enable. If
63856 * mysqlnd_uh.enable is set to FALSE the function will not install the
63857 * proxy and always return TRUE. Additionally, an error of the type
63858 * E_WARNING may be emitted. The error message may read like PHP Warning:
63859 * mysqlnd_uh_convert_to_mysqlnd(): (Mysqlnd User Handler) The plugin has
63860 * been disabled by setting the configuration parameter mysqlnd_uh.enable
63861 * = false. You are not allowed to call this function [...].
63862 *
63863 * @param mysqli $mysql_connection A MySQL connection handle of type
63864 *   mysql, mysqli or PDO_MySQL.
63865 * @return resource A mysqlnd connection handle.
63866 * @since PECL mysqlnd-uh >= 1.0.0-alpha
63867 **/
63868function mysqlnd_uh_convert_to_mysqlnd(&$mysql_connection){}
63869
63870/**
63871 * Installs a proxy for mysqlnd connections
63872 *
63873 * Installs a proxy object to hook mysqlnd's connection objects methods.
63874 * Once installed, the proxy will be used for all MySQL connections
63875 * opened with mysqli, mysql or PDO_MYSQL, assuming that the listed
63876 * extensions are compiled to use the mysqlnd library.
63877 *
63878 * The function can be disabled with mysqlnd_uh.enable. If
63879 * mysqlnd_uh.enable is set to FALSE the function will not install the
63880 * proxy and always return TRUE. Additionally, an error of the type
63881 * E_WARNING may be emitted. The error message may read like PHP Warning:
63882 * mysqlnd_uh_set_connection_proxy(): (Mysqlnd User Handler) The plugin
63883 * has been disabled by setting the configuration parameter
63884 * mysqlnd_uh.enable = false. The proxy has not been installed [...].
63885 *
63886 * @param MysqlndUhConnection $connection_proxy A proxy object of type
63887 *   MysqlndUhConnection.
63888 * @param mysqli $mysqli_connection Object of type mysqli. If given,
63889 *   the proxy will be set for this particular connection only.
63890 * @return bool Returns TRUE on success. Otherwise, returns FALSE
63891 * @since PECL mysqlnd-uh >= 1.0.0-alpha
63892 **/
63893function mysqlnd_uh_set_connection_proxy(&$connection_proxy, &$mysqli_connection){}
63894
63895/**
63896 * Installs a proxy for mysqlnd statements
63897 *
63898 * Installs a proxy for mysqlnd statements. The proxy object will be used
63899 * for all mysqlnd prepared statement objects, regardless which PHP MySQL
63900 * extension (mysqli, mysql, PDO_MYSQL) has created them as long as the
63901 * extension is compiled to use the mysqlnd library.
63902 *
63903 * The function can be disabled with mysqlnd_uh.enable. If
63904 * mysqlnd_uh.enable is set to FALSE the function will not install the
63905 * proxy and always return TRUE. Additionally, an error of the type
63906 * E_WARNING may be emitted. The error message may read like PHP Warning:
63907 * mysqlnd_uh_set_statement_proxy(): (Mysqlnd User Handler) The plugin
63908 * has been disabled by setting the configuration parameter
63909 * mysqlnd_uh.enable = false. The proxy has not been installed [...].
63910 *
63911 * @param MysqlndUhStatement $statement_proxy The mysqlnd statement
63912 *   proxy object of type MysqlndUhStatement
63913 * @return bool Returns TRUE on success. Otherwise, returns FALSE
63914 * @since PECL mysqlnd-uh >= 1.0.0-alpha
63915 **/
63916function mysqlnd_uh_set_statement_proxy(&$statement_proxy){}
63917
63918/**
63919 * Get number of affected rows in previous MySQL operation
63920 *
63921 * Get the number of affected rows by the last INSERT, UPDATE, REPLACE or
63922 * DELETE query associated with {@link link_identifier}.
63923 *
63924 * @param resource $link_identifier
63925 * @return int Returns the number of affected rows on success, and -1
63926 *   if the last query failed.
63927 * @since PHP 4, PHP 5
63928 **/
63929function mysql_affected_rows($link_identifier){}
63930
63931/**
63932 * Returns the name of the character set
63933 *
63934 * Retrieves the character_set variable from MySQL.
63935 *
63936 * @param resource $link_identifier
63937 * @return string Returns the default character set name for the
63938 *   current connection.
63939 * @since PHP 4 >= 4.3.0, PHP 5
63940 **/
63941function mysql_client_encoding($link_identifier){}
63942
63943/**
63944 * Close MySQL connection
63945 *
63946 * {@link mysql_close} closes the non-persistent connection to the MySQL
63947 * server that's associated with the specified link identifier. If {@link
63948 * link_identifier} isn't specified, the last opened link is used.
63949 *
63950 * @param resource $link_identifier
63951 * @return bool
63952 * @since PHP 4, PHP 5
63953 **/
63954function mysql_close($link_identifier){}
63955
63956/**
63957 * Open a connection to a MySQL Server
63958 *
63959 * Opens or reuses a connection to a MySQL server.
63960 *
63961 * @param string $server The MySQL server. It can also include a port
63962 *   number. e.g. "hostname:port" or a path to a local socket e.g.
63963 *   ":/path/to/socket" for the localhost. If the PHP directive
63964 *   mysql.default_host is undefined (default), then the default value is
63965 *   'localhost:3306'. In , this parameter is ignored and value
63966 *   'localhost:3306' is always used.
63967 * @param string $username The username. Default value is defined by
63968 *   mysql.default_user. In , this parameter is ignored and the name of
63969 *   the user that owns the server process is used.
63970 * @param string $password The password. Default value is defined by
63971 *   mysql.default_password. In , this parameter is ignored and empty
63972 *   password is used.
63973 * @param bool $new_link If a second call is made to {@link
63974 *   mysql_connect} with the same arguments, no new link will be
63975 *   established, but instead, the link identifier of the already opened
63976 *   link will be returned. The {@link new_link} parameter modifies this
63977 *   behavior and makes {@link mysql_connect} always open a new link,
63978 *   even if {@link mysql_connect} was called before with the same
63979 *   parameters. In , this parameter is ignored.
63980 * @param int $client_flags The {@link client_flags} parameter can be a
63981 *   combination of the following constants: 128 (enable LOAD DATA LOCAL
63982 *   handling), MYSQL_CLIENT_SSL, MYSQL_CLIENT_COMPRESS,
63983 *   MYSQL_CLIENT_IGNORE_SPACE or MYSQL_CLIENT_INTERACTIVE. Read the
63984 *   section about for further information. In , this parameter is
63985 *   ignored.
63986 * @return resource Returns a MySQL link identifier on success.
63987 * @since PHP 4, PHP 5
63988 **/
63989function mysql_connect($server, $username, $password, $new_link, $client_flags){}
63990
63991/**
63992 * Create a MySQL database
63993 *
63994 * {@link mysql_create_db} attempts to create a new database on the
63995 * server associated with the specified link identifier.
63996 *
63997 * @param string $database_name The name of the database being created.
63998 * @param resource $link_identifier
63999 * @return bool
64000 * @since PHP 4, PHP 5
64001 **/
64002function mysql_create_db($database_name, $link_identifier){}
64003
64004/**
64005 * Move internal result pointer
64006 *
64007 * {@link mysql_data_seek} moves the internal row pointer of the MySQL
64008 * result associated with the specified result identifier to point to the
64009 * specified row number. The next call to a MySQL fetch function, such as
64010 * {@link mysql_fetch_assoc}, would return that row.
64011 *
64012 * {@link row_number} starts at 0. The {@link row_number} should be a
64013 * value in the range from 0 to {@link mysql_num_rows} - 1. However if
64014 * the result set is empty ({@link mysql_num_rows} == 0), a seek to 0
64015 * will fail with an E_WARNING and {@link mysql_data_seek} will return
64016 * FALSE.
64017 *
64018 * @param resource $result The desired row number of the new result
64019 *   pointer.
64020 * @param int $row_number
64021 * @return bool
64022 * @since PHP 4, PHP 5
64023 **/
64024function mysql_data_seek($result, $row_number){}
64025
64026/**
64027 * Retrieves database name from the call to
64028 *
64029 * Retrieve the database name from a call to {@link mysql_list_dbs}.
64030 *
64031 * @param resource $result The result pointer from a call to {@link
64032 *   mysql_list_dbs}.
64033 * @param int $row The index into the result set.
64034 * @param mixed $field The field name.
64035 * @return string Returns the database name on success, and FALSE on
64036 *   failure. If FALSE is returned, use {@link mysql_error} to determine
64037 *   the nature of the error.
64038 * @since PHP 4, PHP 5
64039 **/
64040function mysql_db_name($result, $row, $field){}
64041
64042/**
64043 * Selects a database and executes a query on it
64044 *
64045 * {@link mysql_db_query} selects a database, and executes a query on it.
64046 *
64047 * @param string $database The name of the database that will be
64048 *   selected.
64049 * @param string $query The MySQL query. Data inside the query should
64050 *   be properly escaped.
64051 * @param resource $link_identifier
64052 * @return resource Returns a positive MySQL result resource to the
64053 *   query result, or FALSE on error. The function also returns
64054 *   TRUE/FALSE for INSERT/UPDATE/DELETE queries to indicate
64055 *   success/failure.
64056 * @since PHP 4, PHP 5
64057 **/
64058function mysql_db_query($database, $query, $link_identifier){}
64059
64060/**
64061 * Drop (delete) a MySQL database
64062 *
64063 * {@link mysql_drop_db} attempts to drop (remove) an entire database
64064 * from the server associated with the specified link identifier. This
64065 * function is deprecated, it is preferable to use {@link mysql_query} to
64066 * issue an sql DROP DATABASE statement instead.
64067 *
64068 * @param string $database_name The name of the database that will be
64069 *   deleted.
64070 * @param resource $link_identifier
64071 * @return bool
64072 * @since PHP 4, PHP 5
64073 **/
64074function mysql_drop_db($database_name, $link_identifier){}
64075
64076/**
64077 * Returns the numerical value of the error message from previous MySQL
64078 * operation
64079 *
64080 * Returns the error number from the last MySQL function.
64081 *
64082 * Errors coming back from the MySQL database backend no longer issue
64083 * warnings. Instead, use {@link mysql_errno} to retrieve the error code.
64084 * Note that this function only returns the error code from the most
64085 * recently executed MySQL function (not including {@link mysql_error}
64086 * and {@link mysql_errno}), so if you want to use it, make sure you
64087 * check the value before calling another MySQL function.
64088 *
64089 * @param resource $link_identifier
64090 * @return int Returns the error number from the last MySQL function,
64091 *   or 0 (zero) if no error occurred.
64092 * @since PHP 4, PHP 5
64093 **/
64094function mysql_errno($link_identifier){}
64095
64096/**
64097 * Returns the text of the error message from previous MySQL operation
64098 *
64099 * Returns the error text from the last MySQL function. Errors coming
64100 * back from the MySQL database backend no longer issue warnings.
64101 * Instead, use {@link mysql_error} to retrieve the error text. Note that
64102 * this function only returns the error text from the most recently
64103 * executed MySQL function (not including {@link mysql_error} and {@link
64104 * mysql_errno}), so if you want to use it, make sure you check the value
64105 * before calling another MySQL function.
64106 *
64107 * @param resource $link_identifier
64108 * @return string Returns the error text from the last MySQL function,
64109 *   or '' (empty string) if no error occurred.
64110 * @since PHP 4, PHP 5
64111 **/
64112function mysql_error($link_identifier){}
64113
64114/**
64115 * Escapes a string for use in a mysql_query
64116 *
64117 * This function will escape the {@link unescaped_string}, so that it is
64118 * safe to place it in a {@link mysql_query}. This function is
64119 * deprecated.
64120 *
64121 * This function is identical to {@link mysql_real_escape_string} except
64122 * that {@link mysql_real_escape_string} takes a connection handler and
64123 * escapes the string according to the current character set. {@link
64124 * mysql_escape_string} does not take a connection argument and does not
64125 * respect the current charset setting.
64126 *
64127 * @param string $unescaped_string The string that is to be escaped.
64128 * @return string Returns the escaped string.
64129 * @since PHP 4 >= 4.0.3, PHP 5
64130 **/
64131function mysql_escape_string($unescaped_string){}
64132
64133/**
64134 * Fetch a result row as an associative array, a numeric array, or both
64135 *
64136 * Returns an array that corresponds to the fetched row and moves the
64137 * internal data pointer ahead.
64138 *
64139 * @param resource $result The type of array that is to be fetched.
64140 *   It's a constant and can take the following values: MYSQL_ASSOC,
64141 *   MYSQL_NUM, and MYSQL_BOTH.
64142 * @param int $result_type
64143 * @return array Returns an array of strings that corresponds to the
64144 *   fetched row, or FALSE if there are no more rows. The type of
64145 *   returned array depends on how {@link result_type} is defined. By
64146 *   using MYSQL_BOTH (default), you'll get an array with both
64147 *   associative and number indices. Using MYSQL_ASSOC, you only get
64148 *   associative indices (as {@link mysql_fetch_assoc} works), using
64149 *   MYSQL_NUM, you only get number indices (as {@link mysql_fetch_row}
64150 *   works).
64151 * @since PHP 4, PHP 5
64152 **/
64153function mysql_fetch_array($result, $result_type){}
64154
64155/**
64156 * Fetch a result row as an associative array
64157 *
64158 * Returns an associative array that corresponds to the fetched row and
64159 * moves the internal data pointer ahead. {@link mysql_fetch_assoc} is
64160 * equivalent to calling {@link mysql_fetch_array} with MYSQL_ASSOC for
64161 * the optional second parameter. It only returns an associative array.
64162 *
64163 * @param resource $result
64164 * @return array Returns an associative array of strings that
64165 *   corresponds to the fetched row, or FALSE if there are no more rows.
64166 * @since PHP 4 >= 4.0.3, PHP 5
64167 **/
64168function mysql_fetch_assoc($result){}
64169
64170/**
64171 * Get column information from a result and return as an object
64172 *
64173 * Returns an object containing field information. This function can be
64174 * used to obtain information about fields in the provided query result.
64175 *
64176 * @param resource $result The numerical field offset. If the field
64177 *   offset is not specified, the next field that was not yet retrieved
64178 *   by this function is retrieved. The {@link field_offset} starts at 0.
64179 * @param int $field_offset
64180 * @return object Returns an object containing field information. The
64181 *   properties of the object are:
64182 * @since PHP 4, PHP 5
64183 **/
64184function mysql_fetch_field($result, $field_offset){}
64185
64186/**
64187 * Get the length of each output in a result
64188 *
64189 * Returns an array that corresponds to the lengths of each field in the
64190 * last row fetched by MySQL.
64191 *
64192 * {@link mysql_fetch_lengths} stores the lengths of each result column
64193 * in the last row returned by {@link mysql_fetch_row}, {@link
64194 * mysql_fetch_assoc}, {@link mysql_fetch_array}, and {@link
64195 * mysql_fetch_object} in an array, starting at offset 0.
64196 *
64197 * @param resource $result
64198 * @return array An array of lengths on success.
64199 * @since PHP 4, PHP 5
64200 **/
64201function mysql_fetch_lengths($result){}
64202
64203/**
64204 * Fetch a result row as an object
64205 *
64206 * Returns an object with properties that correspond to the fetched row
64207 * and moves the internal data pointer ahead.
64208 *
64209 * @param resource $result The name of the class to instantiate, set
64210 *   the properties of and return. If not specified, a stdClass object is
64211 *   returned.
64212 * @param string $class_name An optional array of parameters to pass to
64213 *   the constructor for {@link class_name} objects.
64214 * @param array $params
64215 * @return object Returns an object with string properties that
64216 *   correspond to the fetched row, or FALSE if there are no more rows.
64217 * @since PHP 4, PHP 5
64218 **/
64219function mysql_fetch_object($result, $class_name, $params){}
64220
64221/**
64222 * Get a result row as an enumerated array
64223 *
64224 * Returns a numerical array that corresponds to the fetched row and
64225 * moves the internal data pointer ahead.
64226 *
64227 * @param resource $result
64228 * @return array Returns an numerical array of strings that corresponds
64229 *   to the fetched row, or FALSE if there are no more rows.
64230 * @since PHP 4, PHP 5
64231 **/
64232function mysql_fetch_row($result){}
64233
64234/**
64235 * Get the flags associated with the specified field in a result
64236 *
64237 * {@link mysql_field_flags} returns the field flags of the specified
64238 * field. The flags are reported as a single word per flag separated by a
64239 * single space, so that you can split the returned value using {@link
64240 * explode}.
64241 *
64242 * @param resource $result
64243 * @param int $field_offset
64244 * @return string Returns a string of flags associated with the result.
64245 * @since PHP 4, PHP 5
64246 **/
64247function mysql_field_flags($result, $field_offset){}
64248
64249/**
64250 * Returns the length of the specified field
64251 *
64252 * {@link mysql_field_len} returns the length of the specified field.
64253 *
64254 * @param resource $result
64255 * @param int $field_offset
64256 * @return int The length of the specified field index on success.
64257 * @since PHP 4, PHP 5
64258 **/
64259function mysql_field_len($result, $field_offset){}
64260
64261/**
64262 * Get the name of the specified field in a result
64263 *
64264 * {@link mysql_field_name} returns the name of the specified field
64265 * index.
64266 *
64267 * @param resource $result
64268 * @param int $field_offset
64269 * @return string The name of the specified field index on success.
64270 * @since PHP 4, PHP 5
64271 **/
64272function mysql_field_name($result, $field_offset){}
64273
64274/**
64275 * Set result pointer to a specified field offset
64276 *
64277 * Seeks to the specified field offset. If the next call to {@link
64278 * mysql_fetch_field} doesn't include a field offset, the field offset
64279 * specified in {@link mysql_field_seek} will be returned.
64280 *
64281 * @param resource $result
64282 * @param int $field_offset
64283 * @return bool
64284 * @since PHP 4, PHP 5
64285 **/
64286function mysql_field_seek($result, $field_offset){}
64287
64288/**
64289 * Get name of the table the specified field is in
64290 *
64291 * Returns the name of the table that the specified field is in.
64292 *
64293 * @param resource $result
64294 * @param int $field_offset
64295 * @return string The name of the table on success.
64296 * @since PHP 4, PHP 5
64297 **/
64298function mysql_field_table($result, $field_offset){}
64299
64300/**
64301 * Get the type of the specified field in a result
64302 *
64303 * {@link mysql_field_type} is similar to the {@link mysql_field_name}
64304 * function. The arguments are identical, but the field type is returned
64305 * instead.
64306 *
64307 * @param resource $result
64308 * @param int $field_offset
64309 * @return string The returned field type will be one of "int", "real",
64310 *   "string", "blob", and others as detailed in the MySQL documentation.
64311 * @since PHP 4, PHP 5
64312 **/
64313function mysql_field_type($result, $field_offset){}
64314
64315/**
64316 * Free result memory
64317 *
64318 * {@link mysql_free_result} will free all memory associated with the
64319 * result identifier {@link result}.
64320 *
64321 * {@link mysql_free_result} only needs to be called if you are concerned
64322 * about how much memory is being used for queries that return large
64323 * result sets. All associated result memory is automatically freed at
64324 * the end of the script's execution.
64325 *
64326 * @param resource $result
64327 * @return bool
64328 * @since PHP 4, PHP 5
64329 **/
64330function mysql_free_result($result){}
64331
64332/**
64333 * Get MySQL client info
64334 *
64335 * {@link mysql_get_client_info} returns a string that represents the
64336 * client library version.
64337 *
64338 * @return string The MySQL client version.
64339 * @since PHP 4 >= 4.0.5, PHP 5
64340 **/
64341function mysql_get_client_info(){}
64342
64343/**
64344 * Get MySQL host info
64345 *
64346 * Describes the type of connection in use for the connection, including
64347 * the server host name.
64348 *
64349 * @param resource $link_identifier
64350 * @return string Returns a string describing the type of MySQL
64351 *   connection in use for the connection.
64352 * @since PHP 4 >= 4.0.5, PHP 5
64353 **/
64354function mysql_get_host_info($link_identifier){}
64355
64356/**
64357 * Get MySQL protocol info
64358 *
64359 * Retrieves the MySQL protocol.
64360 *
64361 * @param resource $link_identifier
64362 * @return int Returns the MySQL protocol on success.
64363 * @since PHP 4 >= 4.0.5, PHP 5
64364 **/
64365function mysql_get_proto_info($link_identifier){}
64366
64367/**
64368 * Get MySQL server info
64369 *
64370 * Retrieves the MySQL server version.
64371 *
64372 * @param resource $link_identifier
64373 * @return string Returns the MySQL server version on success.
64374 * @since PHP 4 >= 4.0.5, PHP 5
64375 **/
64376function mysql_get_server_info($link_identifier){}
64377
64378/**
64379 * Get information about the most recent query
64380 *
64381 * Returns detailed information about the last query.
64382 *
64383 * @param resource $link_identifier
64384 * @return string Returns information about the statement on success,
64385 *   or FALSE on failure. See the example below for which statements
64386 *   provide information, and what the returned value may look like.
64387 *   Statements that are not listed will return FALSE.
64388 * @since PHP 4 >= 4.3.0, PHP 5
64389 **/
64390function mysql_info($link_identifier){}
64391
64392/**
64393 * Get the ID generated in the last query
64394 *
64395 * Retrieves the ID generated for an AUTO_INCREMENT column by the
64396 * previous query (usually INSERT).
64397 *
64398 * @param resource $link_identifier
64399 * @return int The ID generated for an AUTO_INCREMENT column by the
64400 *   previous query on success, 0 if the previous query does not generate
64401 *   an AUTO_INCREMENT value, or FALSE if no MySQL connection was
64402 *   established.
64403 * @since PHP 4, PHP 5
64404 **/
64405function mysql_insert_id($link_identifier){}
64406
64407/**
64408 * List databases available on a MySQL server
64409 *
64410 * Returns a result pointer containing the databases available from the
64411 * current mysql daemon.
64412 *
64413 * @param resource $link_identifier
64414 * @return resource Returns a result pointer resource on success, or
64415 *   FALSE on failure. Use the {@link mysql_tablename} function to
64416 *   traverse this result pointer, or any function for result tables,
64417 *   such as {@link mysql_fetch_array}.
64418 * @since PHP 4, PHP 5
64419 **/
64420function mysql_list_dbs($link_identifier){}
64421
64422/**
64423 * List MySQL table fields
64424 *
64425 * Retrieves information about the given table name.
64426 *
64427 * This function is deprecated. It is preferable to use {@link
64428 * mysql_query} to issue an SQL SHOW COLUMNS FROM table [LIKE 'name']
64429 * statement instead.
64430 *
64431 * @param string $database_name The name of the database that's being
64432 *   queried.
64433 * @param string $table_name The name of the table that's being
64434 *   queried.
64435 * @param resource $link_identifier
64436 * @return resource A result pointer resource on success, or FALSE on
64437 *   failure.
64438 * @since PHP 4, PHP 5
64439 **/
64440function mysql_list_fields($database_name, $table_name, $link_identifier){}
64441
64442/**
64443 * List MySQL processes
64444 *
64445 * Retrieves the current MySQL server threads.
64446 *
64447 * @param resource $link_identifier
64448 * @return resource A result pointer resource on success.
64449 * @since PHP 4 >= 4.3.0, PHP 5
64450 **/
64451function mysql_list_processes($link_identifier){}
64452
64453/**
64454 * List tables in a MySQL database
64455 *
64456 * Retrieves a list of table names from a MySQL database.
64457 *
64458 * This function is deprecated. It is preferable to use {@link
64459 * mysql_query} to issue an SQL SHOW TABLES [FROM db_name] [LIKE
64460 * 'pattern'] statement instead.
64461 *
64462 * @param string $database The name of the database
64463 * @param resource $link_identifier
64464 * @return resource A result pointer resource on success.
64465 * @since PHP 4, PHP 5
64466 **/
64467function mysql_list_tables($database, $link_identifier){}
64468
64469/**
64470 * Get number of fields in result
64471 *
64472 * Retrieves the number of fields from a query.
64473 *
64474 * @param resource $result
64475 * @return int Returns the number of fields in the result set resource
64476 *   on success.
64477 * @since PHP 4, PHP 5
64478 **/
64479function mysql_num_fields($result){}
64480
64481/**
64482 * Get number of rows in result
64483 *
64484 * Retrieves the number of rows from a result set. This command is only
64485 * valid for statements like SELECT or SHOW that return an actual result
64486 * set. To retrieve the number of rows affected by a INSERT, UPDATE,
64487 * REPLACE or DELETE query, use {@link mysql_affected_rows}.
64488 *
64489 * @param resource $result
64490 * @return int The number of rows in a result set on success.
64491 * @since PHP 4, PHP 5
64492 **/
64493function mysql_num_rows($result){}
64494
64495/**
64496 * Open a persistent connection to a MySQL server
64497 *
64498 * Establishes a persistent connection to a MySQL server.
64499 *
64500 * {@link mysql_pconnect} acts very much like {@link mysql_connect} with
64501 * two major differences.
64502 *
64503 * First, when connecting, the function would first try to find a
64504 * (persistent) link that's already open with the same host, username and
64505 * password. If one is found, an identifier for it will be returned
64506 * instead of opening a new connection.
64507 *
64508 * Second, the connection to the SQL server will not be closed when the
64509 * execution of the script ends. Instead, the link will remain open for
64510 * future use ({@link mysql_close} will not close links established by
64511 * {@link mysql_pconnect}).
64512 *
64513 * This type of link is therefore called 'persistent'.
64514 *
64515 * @param string $server The MySQL server. It can also include a port
64516 *   number. e.g. "hostname:port" or a path to a local socket e.g.
64517 *   ":/path/to/socket" for the localhost. If the PHP directive
64518 *   mysql.default_host is undefined (default), then the default value is
64519 *   'localhost:3306'
64520 * @param string $username The username. Default value is the name of
64521 *   the user that owns the server process.
64522 * @param string $password The password. Default value is an empty
64523 *   password.
64524 * @param int $client_flags The {@link client_flags} parameter can be a
64525 *   combination of the following constants: 128 (enable LOAD DATA LOCAL
64526 *   handling), MYSQL_CLIENT_SSL, MYSQL_CLIENT_COMPRESS,
64527 *   MYSQL_CLIENT_IGNORE_SPACE or MYSQL_CLIENT_INTERACTIVE.
64528 * @return resource Returns a MySQL persistent link identifier on
64529 *   success, or FALSE on failure.
64530 * @since PHP 4, PHP 5
64531 **/
64532function mysql_pconnect($server, $username, $password, $client_flags){}
64533
64534/**
64535 * Ping a server connection or reconnect if there is no connection
64536 *
64537 * Checks whether or not the connection to the server is working. If it
64538 * has gone down, an automatic reconnection is attempted. This function
64539 * can be used by scripts that remain idle for a long while, to check
64540 * whether or not the server has closed the connection and reconnect if
64541 * necessary.
64542 *
64543 * @param resource $link_identifier
64544 * @return bool Returns TRUE if the connection to the server MySQL
64545 *   server is working, otherwise FALSE.
64546 * @since PHP 4 >= 4.3.0, PHP 5
64547 **/
64548function mysql_ping($link_identifier){}
64549
64550/**
64551 * Send a MySQL query
64552 *
64553 * {@link mysql_query} sends a unique query (multiple queries are not
64554 * supported) to the currently active database on the server that's
64555 * associated with the specified {@link link_identifier}.
64556 *
64557 * @param string $query An SQL query The query string should not end
64558 *   with a semicolon. Data inside the query should be properly escaped.
64559 * @param resource $link_identifier
64560 * @return mixed For SELECT, SHOW, DESCRIBE, EXPLAIN and other
64561 *   statements returning resultset, {@link mysql_query} returns a
64562 *   resource on success, or FALSE on error.
64563 * @since PHP 4, PHP 5
64564 **/
64565function mysql_query($query, $link_identifier){}
64566
64567/**
64568 * Escapes special characters in a string for use in an SQL statement
64569 *
64570 * Escapes special characters in the {@link unescaped_string}, taking
64571 * into account the current character set of the connection so that it is
64572 * safe to place it in a {@link mysql_query}. If binary data is to be
64573 * inserted, this function must be used.
64574 *
64575 * {@link mysql_real_escape_string} calls MySQL's library function
64576 * mysql_real_escape_string, which prepends backslashes to the following
64577 * characters: \x00, \n, \r, \, ', " and \x1a.
64578 *
64579 * This function must always (with few exceptions) be used to make data
64580 * safe before sending a query to MySQL.
64581 *
64582 * @param string $unescaped_string The string that is to be escaped.
64583 * @param resource $link_identifier
64584 * @return string Returns the escaped string, or FALSE on error.
64585 * @since PHP 4 >= 4.3.0, PHP 5
64586 **/
64587function mysql_real_escape_string($unescaped_string, $link_identifier){}
64588
64589/**
64590 * Get result data
64591 *
64592 * Retrieves the contents of one cell from a MySQL result set.
64593 *
64594 * When working on large result sets, you should consider using one of
64595 * the functions that fetch an entire row (specified below). As these
64596 * functions return the contents of multiple cells in one function call,
64597 * they're MUCH quicker than {@link mysql_result}. Also, note that
64598 * specifying a numeric offset for the field argument is much quicker
64599 * than specifying a fieldname or tablename.fieldname argument.
64600 *
64601 * @param resource $result The row number from the result that's being
64602 *   retrieved. Row numbers start at 0.
64603 * @param int $row The name or offset of the field being retrieved. It
64604 *   can be the field's offset, the field's name, or the field's table
64605 *   dot field name (tablename.fieldname). If the column name has been
64606 *   aliased ('select foo as bar from...'), use the alias instead of the
64607 *   column name. If undefined, the first field is retrieved.
64608 * @param mixed $field
64609 * @return string The contents of one cell from a MySQL result set on
64610 *   success, or FALSE on failure.
64611 * @since PHP 4, PHP 5
64612 **/
64613function mysql_result($result, $row, $field){}
64614
64615/**
64616 * Select a MySQL database
64617 *
64618 * Sets the current active database on the server that's associated with
64619 * the specified link identifier. Every subsequent call to {@link
64620 * mysql_query} will be made on the active database.
64621 *
64622 * @param string $database_name The name of the database that is to be
64623 *   selected.
64624 * @param resource $link_identifier
64625 * @return bool
64626 * @since PHP 4, PHP 5
64627 **/
64628function mysql_select_db($database_name, $link_identifier){}
64629
64630/**
64631 * Sets the client character set
64632 *
64633 * Sets the default character set for the current connection.
64634 *
64635 * @param string $charset A valid character set name.
64636 * @param resource $link_identifier
64637 * @return bool
64638 * @since PHP 5 >= 5.2.3
64639 **/
64640function mysql_set_charset($charset, $link_identifier){}
64641
64642/**
64643 * Get current system status
64644 *
64645 * {@link mysql_stat} returns the current server status.
64646 *
64647 * @param resource $link_identifier
64648 * @return string Returns a string with the status for uptime, threads,
64649 *   queries, open tables, flush tables and queries per second. For a
64650 *   complete list of other status variables, you have to use the SHOW
64651 *   STATUS SQL command. If {@link link_identifier} is invalid, NULL is
64652 *   returned.
64653 * @since PHP 4 >= 4.3.0, PHP 5
64654 **/
64655function mysql_stat($link_identifier){}
64656
64657/**
64658 * Get table name of field
64659 *
64660 * Retrieves the table name from a {@link result}.
64661 *
64662 * This function is deprecated. It is preferable to use {@link
64663 * mysql_query} to issue an SQL SHOW TABLES [FROM db_name] [LIKE
64664 * 'pattern'] statement instead.
64665 *
64666 * @param resource $result A result pointer resource that's returned
64667 *   from {@link mysql_list_tables}.
64668 * @param int $i The integer index (row/table number)
64669 * @return string The name of the table on success.
64670 * @since PHP 4, PHP 5
64671 **/
64672function mysql_tablename($result, $i){}
64673
64674/**
64675 * Return the current thread ID
64676 *
64677 * Retrieves the current thread ID. If the connection is lost, and a
64678 * reconnect with {@link mysql_ping} is executed, the thread ID will
64679 * change. This means only retrieve the thread ID when needed.
64680 *
64681 * @param resource $link_identifier
64682 * @return int The thread ID on success.
64683 * @since PHP 4 >= 4.3.0, PHP 5
64684 **/
64685function mysql_thread_id($link_identifier){}
64686
64687/**
64688 * Send an SQL query to MySQL without fetching and buffering the result
64689 * rows
64690 *
64691 * {@link mysql_unbuffered_query} sends the SQL query {@link query} to
64692 * MySQL without automatically fetching and buffering the result rows as
64693 * {@link mysql_query} does. This saves a considerable amount of memory
64694 * with SQL queries that produce large result sets, and you can start
64695 * working on the result set immediately after the first row has been
64696 * retrieved as you don't have to wait until the complete SQL query has
64697 * been performed. To use {@link mysql_unbuffered_query} while multiple
64698 * database connections are open, you must specify the optional parameter
64699 * {@link link_identifier} to identify which connection you want to use.
64700 *
64701 * @param string $query The SQL query to execute. Data inside the query
64702 *   should be properly escaped.
64703 * @param resource $link_identifier
64704 * @return resource For SELECT, SHOW, DESCRIBE or EXPLAIN statements,
64705 *   {@link mysql_unbuffered_query} returns a resource on success, or
64706 *   FALSE on error.
64707 * @since PHP 4 >= 4.0.6, PHP 5
64708 **/
64709function mysql_unbuffered_query($query, $link_identifier){}
64710
64711namespace mysql_xdevapi {
64712
64713/**
64714 * Bind prepared statement variables as parameters
64715 *
64716 * @param string $expression
64717 * @return object
64718 **/
64719function expression($expression){}
64720
64721}
64722
64723namespace mysql_xdevapi {
64724
64725/**
64726 * Connect to a MySQL server
64727 *
64728 * Connects to the MySQL server.
64729 *
64730 * @param string $uri The URI to the MySQL server, such as
64731 *   mysqlx://user:password@host. URI format:
64732 *   scheme://[user[:[password]]@]target[:port][?attribute1=value1&attribute2=value2...
64733 *   For related information, see MySQL Shell's Connecting using a URI
64734 *   String.
64735 * @return mysql_xdevapi\Session A Session object.
64736 **/
64737function getSession($uri){}
64738
64739}
64740
64741/**
64742 * Check to see if a transaction has completed
64743 *
64744 * @param resource $conn
64745 * @param int $identifier
64746 * @return int
64747 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64748 **/
64749function m_checkstatus($conn, $identifier){}
64750
64751/**
64752 * Number of complete authorizations in queue, returning an array of
64753 * their identifiers
64754 *
64755 * @param resource $conn Its description
64756 * @param int $array
64757 * @return int What the function returns, first on success, then on
64758 *   failure. See also the &return.success; entity
64759 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64760 **/
64761function m_completeauthorizations($conn, &$array){}
64762
64763/**
64764 * Establish the connection to MCVE
64765 *
64766 * @param resource $conn
64767 * @return int
64768 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64769 **/
64770function m_connect($conn){}
64771
64772/**
64773 * Get a textual representation of why a connection failed
64774 *
64775 * @param resource $conn
64776 * @return string
64777 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64778 **/
64779function m_connectionerror($conn){}
64780
64781/**
64782 * Delete specified transaction from MCVE_CONN structure
64783 *
64784 * @param resource $conn
64785 * @param int $identifier
64786 * @return bool
64787 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64788 **/
64789function m_deletetrans($conn, $identifier){}
64790
64791/**
64792 * Destroy the connection and MCVE_CONN structure
64793 *
64794 * @param resource $conn
64795 * @return bool Returns TRUE.
64796 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64797 **/
64798function m_destroyconn($conn){}
64799
64800/**
64801 * Free memory associated with IP/SSL connectivity
64802 *
64803 * @return void
64804 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64805 **/
64806function m_destroyengine(){}
64807
64808/**
64809 * Get a specific cell from a comma delimited response by column name
64810 *
64811 * @param resource $conn
64812 * @param int $identifier
64813 * @param string $column
64814 * @param int $row
64815 * @return string
64816 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64817 **/
64818function m_getcell($conn, $identifier, $column, $row){}
64819
64820/**
64821 * Get a specific cell from a comma delimited response by column number
64822 *
64823 * @param resource $conn
64824 * @param int $identifier
64825 * @param int $column
64826 * @param int $row
64827 * @return string
64828 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64829 **/
64830function m_getcellbynum($conn, $identifier, $column, $row){}
64831
64832/**
64833 * Get the RAW comma delimited data returned from MCVE
64834 *
64835 * @param resource $conn
64836 * @param int $identifier
64837 * @return string
64838 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64839 **/
64840function m_getcommadelimited($conn, $identifier){}
64841
64842/**
64843 * Get the name of the column in a comma-delimited response
64844 *
64845 * @param resource $conn
64846 * @param int $identifier
64847 * @param int $column_num
64848 * @return string
64849 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64850 **/
64851function m_getheader($conn, $identifier, $column_num){}
64852
64853/**
64854 * Create and initialize an MCVE_CONN structure
64855 *
64856 * @return resource Returns an MCVE_CONN resource.
64857 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64858 **/
64859function m_initconn(){}
64860
64861/**
64862 * Ready the client for IP/SSL Communication
64863 *
64864 * @param string $location
64865 * @return int
64866 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64867 **/
64868function m_initengine($location){}
64869
64870/**
64871 * Checks to see if response is comma delimited
64872 *
64873 * @param resource $conn
64874 * @param int $identifier
64875 * @return int
64876 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64877 **/
64878function m_iscommadelimited($conn, $identifier){}
64879
64880/**
64881 * The maximum amount of time the API will attempt a connection to MCVE
64882 *
64883 * @param resource $conn
64884 * @param int $secs
64885 * @return bool
64886 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64887 **/
64888function m_maxconntimeout($conn, $secs){}
64889
64890/**
64891 * Perform communication with MCVE (send/receive data) Non-blocking
64892 *
64893 * @param resource $conn
64894 * @return int
64895 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64896 **/
64897function m_monitor($conn){}
64898
64899/**
64900 * Number of columns returned in a comma delimited response
64901 *
64902 * @param resource $conn
64903 * @param int $identifier
64904 * @return int
64905 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64906 **/
64907function m_numcolumns($conn, $identifier){}
64908
64909/**
64910 * Number of rows returned in a comma delimited response
64911 *
64912 * @param resource $conn
64913 * @param int $identifier
64914 * @return int
64915 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64916 **/
64917function m_numrows($conn, $identifier){}
64918
64919/**
64920 * Parse the comma delimited response so m_getcell, etc will work
64921 *
64922 * @param resource $conn
64923 * @param int $identifier
64924 * @return int
64925 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64926 **/
64927function m_parsecommadelimited($conn, $identifier){}
64928
64929/**
64930 * Returns array of strings which represents the keys that can be used
64931 * for response parameters on this transaction
64932 *
64933 * @param resource $conn
64934 * @param int $identifier
64935 * @return array
64936 * @since PHP 5 >= 5.0.5 < 5.1.0, PECL mcve >= 1.0.0
64937 **/
64938function m_responsekeys($conn, $identifier){}
64939
64940/**
64941 * Get a custom response parameter
64942 *
64943 * @param resource $conn
64944 * @param int $identifier
64945 * @param string $key
64946 * @return string
64947 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64948 **/
64949function m_responseparam($conn, $identifier, $key){}
64950
64951/**
64952 * Check to see if the transaction was successful
64953 *
64954 * @param resource $conn
64955 * @param int $identifier
64956 * @return int
64957 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64958 **/
64959function m_returnstatus($conn, $identifier){}
64960
64961/**
64962 * Set blocking/non-blocking mode for connection
64963 *
64964 * @param resource $conn
64965 * @param int $tf
64966 * @return int
64967 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64968 **/
64969function m_setblocking($conn, $tf){}
64970
64971/**
64972 * Set the connection method to Drop-File
64973 *
64974 * @param resource $conn
64975 * @param string $directory
64976 * @return int
64977 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64978 **/
64979function m_setdropfile($conn, $directory){}
64980
64981/**
64982 * Set the connection method to IP
64983 *
64984 * @param resource $conn
64985 * @param string $host
64986 * @param int $port
64987 * @return int
64988 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
64989 **/
64990function m_setip($conn, $host, $port){}
64991
64992/**
64993 * Set the connection method to SSL
64994 *
64995 * @param resource $conn
64996 * @param string $host
64997 * @param int $port
64998 * @return int
64999 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
65000 **/
65001function m_setssl($conn, $host, $port){}
65002
65003/**
65004 * Set SSL CA (Certificate Authority) file for verification of server
65005 * certificate
65006 *
65007 * @param resource $conn
65008 * @param string $cafile
65009 * @return int
65010 * @since PHP 5 >= 5.0.5 < 5.1.0, PECL mcve >= 1.0.0
65011 **/
65012function m_setssl_cafile($conn, $cafile){}
65013
65014/**
65015 * Set certificate key files and certificates if server requires client
65016 * certificate verification
65017 *
65018 * @param resource $conn
65019 * @param string $sslkeyfile
65020 * @param string $sslcertfile
65021 * @return int
65022 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
65023 **/
65024function m_setssl_files($conn, $sslkeyfile, $sslcertfile){}
65025
65026/**
65027 * Set maximum transaction time (per trans)
65028 *
65029 * @param resource $conn
65030 * @param int $seconds
65031 * @return int
65032 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
65033 **/
65034function m_settimeout($conn, $seconds){}
65035
65036/**
65037 * Generate hash for SSL client certificate verification
65038 *
65039 * @param string $filename
65040 * @return string
65041 * @since PECL mcve >= 5.2.0
65042 **/
65043function m_sslcert_gen_hash($filename){}
65044
65045/**
65046 * Check to see if outgoing buffer is clear
65047 *
65048 * @param resource $conn
65049 * @return int
65050 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
65051 **/
65052function m_transactionssent($conn){}
65053
65054/**
65055 * Number of transactions in client-queue
65056 *
65057 * @param resource $conn
65058 * @return int
65059 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
65060 **/
65061function m_transinqueue($conn){}
65062
65063/**
65064 * Add key/value pair to a transaction. Replaces deprecated transparam()
65065 *
65066 * @param resource $conn
65067 * @param int $identifier
65068 * @param string $key
65069 * @param string $value
65070 * @return int
65071 * @since PHP 5 >= 5.0.5 < 5.1.0, PECL mcve >= 1.0.0
65072 **/
65073function m_transkeyval($conn, $identifier, $key, $value){}
65074
65075/**
65076 * Start a new transaction
65077 *
65078 * @param resource $conn
65079 * @return int
65080 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
65081 **/
65082function m_transnew($conn){}
65083
65084/**
65085 * Finalize and send the transaction
65086 *
65087 * @param resource $conn
65088 * @param int $identifier
65089 * @return int
65090 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
65091 **/
65092function m_transsend($conn, $identifier){}
65093
65094/**
65095 * Wait x microsecs
65096 *
65097 * @param int $microsecs
65098 * @return int
65099 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
65100 **/
65101function m_uwait($microsecs){}
65102
65103/**
65104 * Whether or not to validate the passed identifier on any transaction it
65105 * is passed to
65106 *
65107 * @param resource $conn
65108 * @param int $tf
65109 * @return int
65110 * @since PHP 5 >= 5.0.5 < 5.1.0, PECL mcve >= 1.0.0
65111 **/
65112function m_validateidentifier($conn, $tf){}
65113
65114/**
65115 * Set whether or not to PING upon connect to verify connection
65116 *
65117 * @param resource $conn
65118 * @param int $tf
65119 * @return bool
65120 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
65121 **/
65122function m_verifyconnection($conn, $tf){}
65123
65124/**
65125 * Set whether or not to verify the server ssl certificate
65126 *
65127 * @param resource $conn
65128 * @param int $tf
65129 * @return bool
65130 * @since PHP 4 >= 4.3.9, PHP 5 < 5.1.0, PECL mcve >= 1.0.0
65131 **/
65132function m_verifysslcert($conn, $tf){}
65133
65134/**
65135 * Sort an array using a case insensitive "natural order" algorithm
65136 *
65137 * {@link natcasesort} is a case insensitive version of {@link natsort}.
65138 *
65139 * This function implements a sort algorithm that orders alphanumeric
65140 * strings in the way a human being would while maintaining key/value
65141 * associations. This is described as a "natural ordering".
65142 *
65143 * @param array $array The input array.
65144 * @return bool
65145 * @since PHP 4, PHP 5, PHP 7
65146 **/
65147function natcasesort(&$array){}
65148
65149/**
65150 * Sort an array using a "natural order" algorithm
65151 *
65152 * This function implements a sort algorithm that orders alphanumeric
65153 * strings in the way a human being would while maintaining key/value
65154 * associations. This is described as a "natural ordering". An example of
65155 * the difference between this algorithm and the regular computer string
65156 * sorting algorithms (used in {@link sort}) can be seen in the example
65157 * below.
65158 *
65159 * @param array $array The input array.
65160 * @return bool
65161 * @since PHP 4, PHP 5, PHP 7
65162 **/
65163function natsort(&$array){}
65164
65165/**
65166 * Add character at current position and advance cursor
65167 *
65168 * @param int $ch
65169 * @return int
65170 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65171 **/
65172function ncurses_addch($ch){}
65173
65174/**
65175 * Add attributed string with specified length at current position
65176 *
65177 * @param string $s
65178 * @param int $n
65179 * @return int
65180 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65181 **/
65182function ncurses_addchnstr($s, $n){}
65183
65184/**
65185 * Add attributed string at current position
65186 *
65187 * @param string $s
65188 * @return int
65189 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65190 **/
65191function ncurses_addchstr($s){}
65192
65193/**
65194 * Add string with specified length at current position
65195 *
65196 * @param string $s
65197 * @param int $n
65198 * @return int
65199 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65200 **/
65201function ncurses_addnstr($s, $n){}
65202
65203/**
65204 * Output text at current position
65205 *
65206 * @param string $text
65207 * @return int
65208 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65209 **/
65210function ncurses_addstr($text){}
65211
65212/**
65213 * Define default colors for color 0
65214 *
65215 * @param int $fg
65216 * @param int $bg
65217 * @return int
65218 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65219 **/
65220function ncurses_assume_default_colors($fg, $bg){}
65221
65222/**
65223 * Turn off the given attributes
65224 *
65225 * @param int $attributes
65226 * @return int
65227 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65228 **/
65229function ncurses_attroff($attributes){}
65230
65231/**
65232 * Turn on the given attributes
65233 *
65234 * @param int $attributes
65235 * @return int
65236 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65237 **/
65238function ncurses_attron($attributes){}
65239
65240/**
65241 * Set given attributes
65242 *
65243 * @param int $attributes
65244 * @return int
65245 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65246 **/
65247function ncurses_attrset($attributes){}
65248
65249/**
65250 * Returns baudrate of terminal
65251 *
65252 * @return int
65253 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65254 **/
65255function ncurses_baudrate(){}
65256
65257/**
65258 * Let the terminal beep
65259 *
65260 * {@link ncurses_beep} sends an audible alert (bell) and if its not
65261 * possible flashes the screen.
65262 *
65263 * @return int
65264 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65265 **/
65266function ncurses_beep(){}
65267
65268/**
65269 * Set background property for terminal screen
65270 *
65271 * @param int $attrchar
65272 * @return int
65273 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65274 **/
65275function ncurses_bkgd($attrchar){}
65276
65277/**
65278 * Control screen background
65279 *
65280 * @param int $attrchar
65281 * @return void
65282 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65283 **/
65284function ncurses_bkgdset($attrchar){}
65285
65286/**
65287 * Draw a border around the screen using attributed characters
65288 *
65289 * Draws the specified lines and corners around the main window.
65290 *
65291 * Use {@link ncurses_wborder} for borders around subwindows!
65292 *
65293 * @param int $left
65294 * @param int $right
65295 * @param int $top
65296 * @param int $bottom
65297 * @param int $tl_corner Top left corner
65298 * @param int $tr_corner Top right corner
65299 * @param int $bl_corner Bottom left corner
65300 * @param int $br_corner Bottom right corner
65301 * @return int
65302 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65303 **/
65304function ncurses_border($left, $right, $top, $bottom, $tl_corner, $tr_corner, $bl_corner, $br_corner){}
65305
65306/**
65307 * Moves a visible panel to the bottom of the stack
65308 *
65309 * @param resource $panel
65310 * @return int
65311 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65312 **/
65313function ncurses_bottom_panel($panel){}
65314
65315/**
65316 * Checks if terminal color definitions can be changed
65317 *
65318 * Checks whether the terminal has color capabilities and whether the
65319 * programmer can change color definitions using {@link
65320 * ncurses_init_color}. ncurses must be initialized using {@link
65321 * ncurses_init} before calling this function.
65322 *
65323 * @return bool Return TRUE if the programmer can change color
65324 *   definitions, FALSE otherwise.
65325 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65326 **/
65327function ncurses_can_change_color(){}
65328
65329/**
65330 * Switch off input buffering
65331 *
65332 * Disables line buffering and character processing (interrupt and flow
65333 * control characters are unaffected), making characters typed by the
65334 * user immediately available to the program.
65335 *
65336 * @return bool Returns TRUE or NCURSES_ERR if any error occurred.
65337 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65338 **/
65339function ncurses_cbreak(){}
65340
65341/**
65342 * Clear screen
65343 *
65344 * Clears the screen completely without setting blanks.
65345 *
65346 * Note: {@link ncurses_clear} clears the screen without setting blanks,
65347 * which have the current background rendition. To clear screen with
65348 * blanks, use {@link ncurses_erase}.
65349 *
65350 * @return bool
65351 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65352 **/
65353function ncurses_clear(){}
65354
65355/**
65356 * Clear screen from current position to bottom
65357 *
65358 * Erases all lines from cursor to end of screen and creates blanks.
65359 * Blanks created by {@link ncurses_clrtobot} have the current background
65360 * rendition.
65361 *
65362 * @return bool
65363 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65364 **/
65365function ncurses_clrtobot(){}
65366
65367/**
65368 * Clear screen from current position to end of line
65369 *
65370 * Erases the current line from cursor position to the end. Blanks
65371 * created by {@link ncurses_clrtoeol} have the current background
65372 * rendition.
65373 *
65374 * @return bool
65375 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65376 **/
65377function ncurses_clrtoeol(){}
65378
65379/**
65380 * Retrieves RGB components of a color
65381 *
65382 * Retrieves the red, green, and blue components for the given color
65383 * definition. Terminal color capabilities must be initialized with
65384 * {@link ncurses_start_color} prior to calling this function.
65385 *
65386 * @param int $color The number of the color to retrieve information
65387 *   for. May be one of the pre-defined color constants.
65388 * @param int $r A reference to which to return the red component of
65389 *   the color. The value returned to the reference will be between 0 and
65390 *   1000.
65391 * @param int $g A reference to which to return the green component of
65392 *   the color. The value returned to the reference will be between 0 and
65393 *   1000.
65394 * @param int $b A reference to which to return the blue component of
65395 *   the color. The value returned to the reference will be between 0 and
65396 *   1000.
65397 * @return int Returns -1 if the function was successful, and 0 if
65398 *   ncurses or terminal color capabilities have not been initialized.
65399 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65400 **/
65401function ncurses_color_content($color, &$r, &$g, &$b){}
65402
65403/**
65404 * Set active foreground and background colors
65405 *
65406 * Sets the active foreground and background colors. Any characters
65407 * written after this function is invoked will have these colors. This
65408 * function requires terminal colors to be supported and initialized
65409 * using {@link ncurses_start_color} beforehand.
65410 *
65411 * ncurses uses color pairs to specify both foreground and background
65412 * colors. Use {@link ncurses_init_pair} to define a color pair.
65413 *
65414 * @param int $pair The color pair from which to get the foreground and
65415 *   background colors to set as the active colors.
65416 * @return int Returns -1 on success, and 0 on failure.
65417 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65418 **/
65419function ncurses_color_set($pair){}
65420
65421/**
65422 * Set cursor state
65423 *
65424 * @param int $visibility
65425 * @return int
65426 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65427 **/
65428function ncurses_curs_set($visibility){}
65429
65430/**
65431 * Define a keycode
65432 *
65433 * @param string $definition
65434 * @param int $keycode
65435 * @return int
65436 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65437 **/
65438function ncurses_define_key($definition, $keycode){}
65439
65440/**
65441 * Saves terminals (program) mode
65442 *
65443 * Saves the current terminal modes for program (in curses) for use by
65444 * {@link ncurses_reset_prog_mode}.
65445 *
65446 * @return bool Returns FALSE on success, otherwise TRUE.
65447 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65448 **/
65449function ncurses_def_prog_mode(){}
65450
65451/**
65452 * Saves terminals (shell) mode
65453 *
65454 * Saves the current terminal modes for shell (not in curses) for use by
65455 * {@link ncurses_reset_shell_mode}.
65456 *
65457 * @return bool Returns FALSE on success, TRUE otherwise.
65458 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65459 **/
65460function ncurses_def_shell_mode(){}
65461
65462/**
65463 * Delay output on terminal using padding characters
65464 *
65465 * @param int $milliseconds
65466 * @return int
65467 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65468 **/
65469function ncurses_delay_output($milliseconds){}
65470
65471/**
65472 * Delete character at current position, move rest of line left
65473 *
65474 * Deletes the character under the cursor. All characters to the right of
65475 * the cursor on the same line are moved to the left one position and the
65476 * last character on the line is filled with a blank. The cursor position
65477 * does not change.
65478 *
65479 * @return bool Returns FALSE on success, TRUE otherwise.
65480 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65481 **/
65482function ncurses_delch(){}
65483
65484/**
65485 * Delete line at current position, move rest of screen up
65486 *
65487 * Deletes the current line under cursor position. All lines below the
65488 * current line are moved up one line. The bottom line of window is
65489 * cleared. Cursor position does not change.
65490 *
65491 * @return bool Returns FALSE on success, otherwise TRUE.
65492 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65493 **/
65494function ncurses_deleteln(){}
65495
65496/**
65497 * Delete a ncurses window
65498 *
65499 * @param resource $window
65500 * @return bool
65501 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65502 **/
65503function ncurses_delwin($window){}
65504
65505/**
65506 * Remove panel from the stack and delete it (but not the associated
65507 * window)
65508 *
65509 * @param resource $panel
65510 * @return bool
65511 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65512 **/
65513function ncurses_del_panel($panel){}
65514
65515/**
65516 * Write all prepared refreshes to terminal
65517 *
65518 * Compares the virtual screen to the physical screen and updates the
65519 * physical screen. This way is more effective than using multiple
65520 * refresh calls.
65521 *
65522 * @return bool
65523 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65524 **/
65525function ncurses_doupdate(){}
65526
65527/**
65528 * Activate keyboard input echo
65529 *
65530 * Enables echo mode. All characters typed by user are echoed by {@link
65531 * ncurses_getch}.
65532 *
65533 * @return bool Returns FALSE on success, TRUE if any error occurred.
65534 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65535 **/
65536function ncurses_echo(){}
65537
65538/**
65539 * Single character output including refresh
65540 *
65541 * @param int $character
65542 * @return int
65543 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65544 **/
65545function ncurses_echochar($character){}
65546
65547/**
65548 * Stop using ncurses, clean up the screen
65549 *
65550 * @return int
65551 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65552 **/
65553function ncurses_end(){}
65554
65555/**
65556 * Erase terminal screen
65557 *
65558 * Fills the terminal screen with blanks.
65559 *
65560 * Created blanks have the current background rendition, set by {@link
65561 * ncurses_bkgd}.
65562 *
65563 * @return bool
65564 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65565 **/
65566function ncurses_erase(){}
65567
65568/**
65569 * Returns current erase character
65570 *
65571 * Returns the current erase character.
65572 *
65573 * @return string The current erase char, as a string.
65574 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65575 **/
65576function ncurses_erasechar(){}
65577
65578/**
65579 * Set LINES for iniscr() and newterm() to 1
65580 *
65581 * @return void
65582 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65583 **/
65584function ncurses_filter(){}
65585
65586/**
65587 * Flash terminal screen (visual bell)
65588 *
65589 * Flashes the screen, and if its not possible, sends an audible alert
65590 * (bell).
65591 *
65592 * @return bool Returns FALSE on success, otherwise TRUE.
65593 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65594 **/
65595function ncurses_flash(){}
65596
65597/**
65598 * Flush keyboard input buffer
65599 *
65600 * Throws away any typeahead that has been typed and has not yet been
65601 * read by your program.
65602 *
65603 * @return bool Returns FALSE on success, otherwise TRUE.
65604 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65605 **/
65606function ncurses_flushinp(){}
65607
65608/**
65609 * Read a character from keyboard
65610 *
65611 * @return int
65612 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65613 **/
65614function ncurses_getch(){}
65615
65616/**
65617 * Returns the size of a window
65618 *
65619 * Gets the horizontal and vertical size of the given {@link window} into
65620 * the given variables.
65621 *
65622 * Variables must be passed as reference, so they are updated when the
65623 * user changes the terminal size.
65624 *
65625 * @param resource $window The measured window
65626 * @param int $y This will be set to the window height
65627 * @param int $x This will be set to the window width
65628 * @return void
65629 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65630 **/
65631function ncurses_getmaxyx($window, &$y, &$x){}
65632
65633/**
65634 * Reads mouse event
65635 *
65636 * {@link ncurses_getmouse} reads mouse event out of queue.
65637 *
65638 * @param array $mevent Event options will be delivered in this
65639 *   parameter which has to be an array, passed by reference (see example
65640 *   below). On success an associative array with following keys will be
65641 *   delivered: "id" : Id to distinguish multiple devices "x" : screen
65642 *   relative x-position in character cells "y" : screen relative
65643 *   y-position in character cells "z" : currently not supported "mmask"
65644 *   : Mouse action
65645 * @return bool Returns FALSE if a mouse event is actually visible in
65646 *   the given window, otherwise returns TRUE.
65647 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65648 **/
65649function ncurses_getmouse(&$mevent){}
65650
65651/**
65652 * Returns the current cursor position for a window
65653 *
65654 * @param resource $window
65655 * @param int $y
65656 * @param int $x
65657 * @return void
65658 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65659 **/
65660function ncurses_getyx($window, &$y, &$x){}
65661
65662/**
65663 * Put terminal into halfdelay mode
65664 *
65665 * @param int $tenth
65666 * @return int
65667 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65668 **/
65669function ncurses_halfdelay($tenth){}
65670
65671/**
65672 * Checks if terminal has color capabilities
65673 *
65674 * Checks whether the terminal has color capabilities. This function can
65675 * be used to write terminal-independent programs. ncurses must be
65676 * initialized using {@link ncurses_init} before calling this function.
65677 *
65678 * @return bool Return TRUE if the terminal has color capabilities,
65679 *   FALSE otherwise.
65680 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65681 **/
65682function ncurses_has_colors(){}
65683
65684/**
65685 * Check for insert- and delete-capabilities
65686 *
65687 * Checks whether the terminal has insert and delete capabilities.
65688 *
65689 * @return bool Returns TRUE if the terminal has
65690 *   insert/delete-capabilities, FALSE otherwise.
65691 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65692 **/
65693function ncurses_has_ic(){}
65694
65695/**
65696 * Check for line insert- and delete-capabilities
65697 *
65698 * Checks whether the terminal has insert- and delete-line-capabilities.
65699 *
65700 * @return bool Returns TRUE if the terminal has insert/delete-line
65701 *   capabilities, FALSE otherwise.
65702 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65703 **/
65704function ncurses_has_il(){}
65705
65706/**
65707 * Check for presence of a function key on terminal keyboard
65708 *
65709 * @param int $keycode
65710 * @return int
65711 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65712 **/
65713function ncurses_has_key($keycode){}
65714
65715/**
65716 * Remove panel from the stack, making it invisible
65717 *
65718 * @param resource $panel
65719 * @return int
65720 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65721 **/
65722function ncurses_hide_panel($panel){}
65723
65724/**
65725 * Draw a horizontal line at current position using an attributed
65726 * character and max. n characters long
65727 *
65728 * @param int $charattr
65729 * @param int $n
65730 * @return int
65731 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65732 **/
65733function ncurses_hline($charattr, $n){}
65734
65735/**
65736 * Get character and attribute at current position
65737 *
65738 * Returns the character from the current position.
65739 *
65740 * @return string Returns the character, as a string.
65741 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65742 **/
65743function ncurses_inch(){}
65744
65745/**
65746 * Initialize ncurses
65747 *
65748 * Initializes the ncurses interface. This function must be used before
65749 * any other ncurses function call.
65750 *
65751 * Note that {@link ncurses_end} must be called before exiting from the
65752 * program, or the terminal will not be restored to its proper non-visual
65753 * mode.
65754 *
65755 * @return void
65756 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65757 **/
65758function ncurses_init(){}
65759
65760/**
65761 * Define a terminal color
65762 *
65763 * Defines or redefines the given color. When this function is called,
65764 * all occurrences of the given color on the screen, if any, immediately
65765 * change to the new definition.
65766 *
65767 * Color capabilities must be supported by the terminal and initialized
65768 * using {@link ncurses_start_color} prior to calling this function. In
65769 * addition, the terminal must have color changing capabilities; use
65770 * {@link ncurses_can_change_color} to check for this.
65771 *
65772 * @param int $color The identification number of the color to
65773 *   redefine. It may be one of the default color constants.
65774 * @param int $r A color value, between 0 and 1000, for the red
65775 *   component.
65776 * @param int $g A color value, between 0 and 1000, for the green
65777 *   component.
65778 * @param int $b A color value, between 0 and 1000, for the blue
65779 *   component.
65780 * @return int Returns -1 if the function was successful, and 0 if
65781 *   ncurses or terminal color capabilities have not been initialized or
65782 *   the terminal does not have color changing capabilities.
65783 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65784 **/
65785function ncurses_init_color($color, $r, $g, $b){}
65786
65787/**
65788 * Define a color pair
65789 *
65790 * Defines or redefines the given color pair to have the given foreground
65791 * and background colors. If the color pair was previously initialized,
65792 * the screen is refreshed and all occurrences of it are changed to
65793 * reflect the new definition.
65794 *
65795 * Color capabilities must be initialized using {@link
65796 * ncurses_start_color} before calling this function. The first color
65797 * pair (color pair 0) is assumed to be white on black by default, but
65798 * can be changed using {@link ncurses_assume_default_colors}.
65799 *
65800 * @param int $pair The number of the color pair to define.
65801 * @param int $fg The foreground color for the color pair. May be one
65802 *   of the pre-defined colors or one defined by {@link
65803 *   ncurses_init_color} if the terminal has color changing capabilities.
65804 * @param int $bg The background color for the color pair. May be one
65805 *   of the pre-defined colors or one defined by {@link
65806 *   ncurses_init_color} if the terminal has color changing capabilities.
65807 * @return int Returns -1 if the function was successful, and 0 if
65808 *   ncurses or color support were not initialized.
65809 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65810 **/
65811function ncurses_init_pair($pair, $fg, $bg){}
65812
65813/**
65814 * Insert character moving rest of line including character at current
65815 * position
65816 *
65817 * @param int $character
65818 * @return int
65819 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65820 **/
65821function ncurses_insch($character){}
65822
65823/**
65824 * Insert lines before current line scrolling down (negative numbers
65825 * delete and scroll up)
65826 *
65827 * @param int $count
65828 * @return int
65829 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65830 **/
65831function ncurses_insdelln($count){}
65832
65833/**
65834 * Insert a line, move rest of screen down
65835 *
65836 * Inserts a new line above the current line. The bottom line will be
65837 * lost.
65838 *
65839 * @return int
65840 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65841 **/
65842function ncurses_insertln(){}
65843
65844/**
65845 * Insert string at current position, moving rest of line right
65846 *
65847 * @param string $text
65848 * @return int
65849 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65850 **/
65851function ncurses_insstr($text){}
65852
65853/**
65854 * Reads string from terminal screen
65855 *
65856 * Reads a string from the terminal screen and returns the number of
65857 * characters read from the current character position until end of line.
65858 *
65859 * @param string $buffer The characters. Attributes will be stripped.
65860 * @return int Returns the number of characters.
65861 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65862 **/
65863function ncurses_instr(&$buffer){}
65864
65865/**
65866 * Ncurses is in endwin mode, normal screen output may be performed
65867 *
65868 * Checks if ncurses is in endwin mode.
65869 *
65870 * @return bool Returns TRUE, if {@link ncurses_end} has been called
65871 *   without any subsequent calls to {@link ncurses_wrefresh}, FALSE
65872 *   otherwise.
65873 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65874 **/
65875function ncurses_isendwin(){}
65876
65877/**
65878 * Enable or disable a keycode
65879 *
65880 * @param int $keycode
65881 * @param bool $enable
65882 * @return int
65883 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65884 **/
65885function ncurses_keyok($keycode, $enable){}
65886
65887/**
65888 * Turns keypad on or off
65889 *
65890 * @param resource $window
65891 * @param bool $bf
65892 * @return int
65893 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65894 **/
65895function ncurses_keypad($window, $bf){}
65896
65897/**
65898 * Returns current line kill character
65899 *
65900 * Returns the current line kill character.
65901 *
65902 * @return string Returns the kill character, as a string.
65903 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65904 **/
65905function ncurses_killchar(){}
65906
65907/**
65908 * Returns terminals description
65909 *
65910 * Returns a verbose description of the terminal.
65911 *
65912 * @return string Returns the description, as a string truncated to 128
65913 *   characters. On errors, returns NULL.
65914 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65915 **/
65916function ncurses_longname(){}
65917
65918/**
65919 * Enables/Disable 8-bit meta key information
65920 *
65921 * @param resource $window
65922 * @param bool $_8bit
65923 * @return int
65924 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65925 **/
65926function ncurses_meta($window, $_8bit){}
65927
65928/**
65929 * Set timeout for mouse button clicks
65930 *
65931 * @param int $milliseconds
65932 * @return int
65933 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65934 **/
65935function ncurses_mouseinterval($milliseconds){}
65936
65937/**
65938 * Sets mouse options
65939 *
65940 * Sets mouse events to be reported. By default no mouse events will be
65941 * reported.
65942 *
65943 * Mouse events are represented by NCURSES_KEY_MOUSE in the {@link
65944 * ncurses_wgetch} input stream. To read the event data and pop the event
65945 * of queue, call {@link ncurses_getmouse}.
65946 *
65947 * @param int $newmask Mouse mask options can be set with the following
65948 *   predefined constants: NCURSES_BUTTON1_PRESSED
65949 *   NCURSES_BUTTON1_RELEASED NCURSES_BUTTON1_CLICKED
65950 *   NCURSES_BUTTON1_DOUBLE_CLICKED NCURSES_BUTTON1_TRIPLE_CLICKED
65951 *   NCURSES_BUTTON2_PRESSED NCURSES_BUTTON2_RELEASED
65952 *   NCURSES_BUTTON2_CLICKED NCURSES_BUTTON2_DOUBLE_CLICKED
65953 *   NCURSES_BUTTON2_TRIPLE_CLICKED NCURSES_BUTTON3_PRESSED
65954 *   NCURSES_BUTTON3_RELEASED NCURSES_BUTTON3_CLICKED
65955 *   NCURSES_BUTTON3_DOUBLE_CLICKED NCURSES_BUTTON3_TRIPLE_CLICKED
65956 *   NCURSES_BUTTON4_PRESSED NCURSES_BUTTON4_RELEASED
65957 *   NCURSES_BUTTON4_CLICKED NCURSES_BUTTON4_DOUBLE_CLICKED
65958 *   NCURSES_BUTTON4_TRIPLE_CLICKED NCURSES_BUTTON_SHIFT>
65959 *   NCURSES_BUTTON_CTRL NCURSES_BUTTON_ALT NCURSES_ALL_MOUSE_EVENTS
65960 *   NCURSES_REPORT_MOUSE_POSITION As a side effect, setting a zero
65961 *   mousemask in {@link newmask} turns off the mouse pointer. Setting a
65962 *   non zero value turns mouse pointer on.
65963 * @param int $oldmask This will be set to the previous value of the
65964 *   mouse event mask.
65965 * @return int Returns the mask of reportable events. On complete
65966 *   failure, it returns 0.
65967 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65968 **/
65969function ncurses_mousemask($newmask, &$oldmask){}
65970
65971/**
65972 * Transforms coordinates
65973 *
65974 * @param int $y
65975 * @param int $x
65976 * @param bool $toscreen
65977 * @return bool
65978 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65979 **/
65980function ncurses_mouse_trafo(&$y, &$x, $toscreen){}
65981
65982/**
65983 * Move output position
65984 *
65985 * @param int $y
65986 * @param int $x
65987 * @return int
65988 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
65989 **/
65990function ncurses_move($y, $x){}
65991
65992/**
65993 * Moves a panel so that its upper-left corner is at [startx, starty]
65994 *
65995 * @param resource $panel
65996 * @param int $startx
65997 * @param int $starty
65998 * @return int
65999 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66000 **/
66001function ncurses_move_panel($panel, $startx, $starty){}
66002
66003/**
66004 * Move current position and add character
66005 *
66006 * @param int $y
66007 * @param int $x
66008 * @param int $c
66009 * @return int
66010 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66011 **/
66012function ncurses_mvaddch($y, $x, $c){}
66013
66014/**
66015 * Move position and add attributed string with specified length
66016 *
66017 * @param int $y
66018 * @param int $x
66019 * @param string $s
66020 * @param int $n
66021 * @return int
66022 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66023 **/
66024function ncurses_mvaddchnstr($y, $x, $s, $n){}
66025
66026/**
66027 * Move position and add attributed string
66028 *
66029 * @param int $y
66030 * @param int $x
66031 * @param string $s
66032 * @return int
66033 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66034 **/
66035function ncurses_mvaddchstr($y, $x, $s){}
66036
66037/**
66038 * Move position and add string with specified length
66039 *
66040 * @param int $y
66041 * @param int $x
66042 * @param string $s
66043 * @param int $n
66044 * @return int
66045 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66046 **/
66047function ncurses_mvaddnstr($y, $x, $s, $n){}
66048
66049/**
66050 * Move position and add string
66051 *
66052 * @param int $y
66053 * @param int $x
66054 * @param string $s
66055 * @return int
66056 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66057 **/
66058function ncurses_mvaddstr($y, $x, $s){}
66059
66060/**
66061 * Move cursor immediately
66062 *
66063 * @param int $old_y
66064 * @param int $old_x
66065 * @param int $new_y
66066 * @param int $new_x
66067 * @return int
66068 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66069 **/
66070function ncurses_mvcur($old_y, $old_x, $new_y, $new_x){}
66071
66072/**
66073 * Move position and delete character, shift rest of line left
66074 *
66075 * @param int $y
66076 * @param int $x
66077 * @return int
66078 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66079 **/
66080function ncurses_mvdelch($y, $x){}
66081
66082/**
66083 * Move position and get character at new position
66084 *
66085 * @param int $y
66086 * @param int $x
66087 * @return int
66088 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66089 **/
66090function ncurses_mvgetch($y, $x){}
66091
66092/**
66093 * Set new position and draw a horizontal line using an attributed
66094 * character and max. n characters long
66095 *
66096 * @param int $y
66097 * @param int $x
66098 * @param int $attrchar
66099 * @param int $n
66100 * @return int
66101 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66102 **/
66103function ncurses_mvhline($y, $x, $attrchar, $n){}
66104
66105/**
66106 * Move position and get attributed character at new position
66107 *
66108 * @param int $y
66109 * @param int $x
66110 * @return int
66111 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66112 **/
66113function ncurses_mvinch($y, $x){}
66114
66115/**
66116 * Set new position and draw a vertical line using an attributed
66117 * character and max. n characters long
66118 *
66119 * @param int $y
66120 * @param int $x
66121 * @param int $attrchar
66122 * @param int $n
66123 * @return int
66124 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66125 **/
66126function ncurses_mvvline($y, $x, $attrchar, $n){}
66127
66128/**
66129 * Add string at new position in window
66130 *
66131 * @param resource $window
66132 * @param int $y
66133 * @param int $x
66134 * @param string $text
66135 * @return int
66136 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66137 **/
66138function ncurses_mvwaddstr($window, $y, $x, $text){}
66139
66140/**
66141 * Sleep
66142 *
66143 * @param int $milliseconds
66144 * @return int
66145 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66146 **/
66147function ncurses_napms($milliseconds){}
66148
66149/**
66150 * Creates a new pad (window)
66151 *
66152 * @param int $rows
66153 * @param int $cols
66154 * @return resource
66155 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66156 **/
66157function ncurses_newpad($rows, $cols){}
66158
66159/**
66160 * Create a new window
66161 *
66162 * Creates a new window to draw elements in.
66163 *
66164 * When creating additional windows, remember to use {@link
66165 * ncurses_getmaxyx} to check for available space, as terminal size is
66166 * individual and may vary.
66167 *
66168 * @param int $rows Number of rows
66169 * @param int $cols Number of columns
66170 * @param int $y y-coordinate of the origin
66171 * @param int $x x-coordinate of the origin
66172 * @return resource Returns a resource ID for the new window.
66173 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66174 **/
66175function ncurses_newwin($rows, $cols, $y, $x){}
66176
66177/**
66178 * Create a new panel and associate it with window
66179 *
66180 * @param resource $window
66181 * @return resource
66182 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66183 **/
66184function ncurses_new_panel($window){}
66185
66186/**
66187 * Translate newline and carriage return / line feed
66188 *
66189 * @return bool
66190 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66191 **/
66192function ncurses_nl(){}
66193
66194/**
66195 * Switch terminal to cooked mode
66196 *
66197 * Returns terminal to normal (cooked) mode. Initially the terminal may
66198 * or may not be in cbreak mode as the mode is inherited. Therefore a
66199 * program should call {@link ncurses_cbreak} and {@link
66200 * ncurses_nocbreak} explicitly.
66201 *
66202 * @return bool Returns TRUE if any error occurred, otherwise FALSE.
66203 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66204 **/
66205function ncurses_nocbreak(){}
66206
66207/**
66208 * Switch off keyboard input echo
66209 *
66210 * Prevents echoing of user typed characters.
66211 *
66212 * @return bool Returns TRUE if any error occurred, FALSE otherwise.
66213 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66214 **/
66215function ncurses_noecho(){}
66216
66217/**
66218 * Do not translate newline and carriage return / line feed
66219 *
66220 * @return bool
66221 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66222 **/
66223function ncurses_nonl(){}
66224
66225/**
66226 * Do not flush on signal characters
66227 *
66228 * @return void
66229 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66230 **/
66231function ncurses_noqiflush(){}
66232
66233/**
66234 * Switch terminal out of raw mode
66235 *
66236 * Switches the terminal out of raw mode. Raw mode is similar to cbreak
66237 * mode, in that characters typed are immediately passed through to the
66238 * user program. The difference is that in raw mode, the interrupt, quit,
66239 * suspend and flow control characters are all passed through
66240 * uninterpreted, instead of generating a signal.
66241 *
66242 * @return bool Returns TRUE if any error occurred, otherwise FALSE.
66243 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66244 **/
66245function ncurses_noraw(){}
66246
66247/**
66248 * Retrieves foreground and background colors of a color pair
66249 *
66250 * Retrieves the foreground and background colors that constitute the
66251 * given color pair. Terminal color capabilities must be initialized with
66252 * {@link ncurses_start_color} prior to calling this function.
66253 *
66254 * @param int $pair The number of the color pair to retrieve
66255 *   information for.
66256 * @param int $f A reference to which to return the foreground color of
66257 *   the color pair. The information returned will be a color number
66258 *   referring to one of the pre-defined colors or a color defined
66259 *   previously by {@link ncurses_init_color} if the terminal supports
66260 *   color changing.
66261 * @param int $b A reference to which to return the background color of
66262 *   the color pair. The information returned will be a color number
66263 *   referring to one of the pre-defined colors or a color defined
66264 *   previously by {@link ncurses_init_color} if the terminal supports
66265 *   color changing.
66266 * @return int Returns -1 if the function was successful, and 0 if
66267 *   ncurses or terminal color capabilities have not been initialized.
66268 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66269 **/
66270function ncurses_pair_content($pair, &$f, &$b){}
66271
66272/**
66273 * Returns the panel above panel
66274 *
66275 * @param resource $panel
66276 * @return resource If panel is null, returns the bottom panel in the
66277 *   stack.
66278 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66279 **/
66280function ncurses_panel_above($panel){}
66281
66282/**
66283 * Returns the panel below panel
66284 *
66285 * @param resource $panel
66286 * @return resource
66287 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66288 **/
66289function ncurses_panel_below($panel){}
66290
66291/**
66292 * Returns the window associated with panel
66293 *
66294 * @param resource $panel
66295 * @return resource
66296 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66297 **/
66298function ncurses_panel_window($panel){}
66299
66300/**
66301 * Copies a region from a pad into the virtual screen
66302 *
66303 * @param resource $pad
66304 * @param int $pminrow
66305 * @param int $pmincol
66306 * @param int $sminrow
66307 * @param int $smincol
66308 * @param int $smaxrow
66309 * @param int $smaxcol
66310 * @return int
66311 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66312 **/
66313function ncurses_pnoutrefresh($pad, $pminrow, $pmincol, $sminrow, $smincol, $smaxrow, $smaxcol){}
66314
66315/**
66316 * Copies a region from a pad into the virtual screen
66317 *
66318 * @param resource $pad
66319 * @param int $pminrow
66320 * @param int $pmincol
66321 * @param int $sminrow
66322 * @param int $smincol
66323 * @param int $smaxrow
66324 * @param int $smaxcol
66325 * @return int
66326 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66327 **/
66328function ncurses_prefresh($pad, $pminrow, $pmincol, $sminrow, $smincol, $smaxrow, $smaxcol){}
66329
66330/**
66331 * Apply padding information to the string and output it
66332 *
66333 * @param string $text
66334 * @return int
66335 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66336 **/
66337function ncurses_putp($text){}
66338
66339/**
66340 * Flush on signal characters
66341 *
66342 * @return void
66343 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66344 **/
66345function ncurses_qiflush(){}
66346
66347/**
66348 * Switch terminal into raw mode
66349 *
66350 * Places the terminal in raw mode. Raw mode is similar to cbreak mode,
66351 * in that characters typed are immediately passed through to the user
66352 * program. The difference is that in raw mode, the interrupt, quit,
66353 * suspend and flow control characters are all passed through
66354 * uninterpreted, instead of generating a signal.
66355 *
66356 * @return bool Returns TRUE if any error occurred, otherwise FALSE.
66357 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66358 **/
66359function ncurses_raw(){}
66360
66361/**
66362 * Refresh screen
66363 *
66364 * @param int $ch
66365 * @return int
66366 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66367 **/
66368function ncurses_refresh($ch){}
66369
66370/**
66371 * Replaces the window associated with panel
66372 *
66373 * @param resource $panel
66374 * @param resource $window
66375 * @return int
66376 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66377 **/
66378function ncurses_replace_panel($panel, $window){}
66379
66380/**
66381 * Restores saved terminal state
66382 *
66383 * Restores the terminal state, which was previously saved by calling
66384 * {@link ncurses_savetty}.
66385 *
66386 * @return bool Always returns FALSE.
66387 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66388 **/
66389function ncurses_resetty(){}
66390
66391/**
66392 * Resets the prog mode saved by def_prog_mode
66393 *
66394 * @return int
66395 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66396 **/
66397function ncurses_reset_prog_mode(){}
66398
66399/**
66400 * Resets the shell mode saved by def_shell_mode
66401 *
66402 * @return int
66403 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66404 **/
66405function ncurses_reset_shell_mode(){}
66406
66407/**
66408 * Saves terminal state
66409 *
66410 * Saves the current terminal state. The saved terminal state can be
66411 * restored with {@link ncurses_resetty}.
66412 *
66413 * @return bool Always returns FALSE.
66414 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66415 **/
66416function ncurses_savetty(){}
66417
66418/**
66419 * Scroll window content up or down without changing current position
66420 *
66421 * @param int $count
66422 * @return int
66423 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66424 **/
66425function ncurses_scrl($count){}
66426
66427/**
66428 * Dump screen content to file
66429 *
66430 * @param string $filename
66431 * @return int
66432 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66433 **/
66434function ncurses_scr_dump($filename){}
66435
66436/**
66437 * Initialize screen from file dump
66438 *
66439 * @param string $filename
66440 * @return int
66441 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66442 **/
66443function ncurses_scr_init($filename){}
66444
66445/**
66446 * Restore screen from file dump
66447 *
66448 * @param string $filename
66449 * @return int
66450 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66451 **/
66452function ncurses_scr_restore($filename){}
66453
66454/**
66455 * Inherit screen from file dump
66456 *
66457 * @param string $filename
66458 * @return int
66459 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66460 **/
66461function ncurses_scr_set($filename){}
66462
66463/**
66464 * Places an invisible panel on top of the stack, making it visible
66465 *
66466 * @param resource $panel
66467 * @return int
66468 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66469 **/
66470function ncurses_show_panel($panel){}
66471
66472/**
66473 * Returns current soft label key attribute
66474 *
66475 * Returns the current soft label key attribute.
66476 *
66477 * @return int The attribute, as an integer.
66478 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66479 **/
66480function ncurses_slk_attr(){}
66481
66482/**
66483 * Turn off the given attributes for soft function-key labels
66484 *
66485 * @param int $intarg
66486 * @return int
66487 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66488 **/
66489function ncurses_slk_attroff($intarg){}
66490
66491/**
66492 * Turn on the given attributes for soft function-key labels
66493 *
66494 * @param int $intarg
66495 * @return int
66496 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66497 **/
66498function ncurses_slk_attron($intarg){}
66499
66500/**
66501 * Set given attributes for soft function-key labels
66502 *
66503 * @param int $intarg
66504 * @return int
66505 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66506 **/
66507function ncurses_slk_attrset($intarg){}
66508
66509/**
66510 * Clears soft labels from screen
66511 *
66512 * The function {@link ncurses_slk_clear} clears soft label keys from
66513 * screen.
66514 *
66515 * @return bool Returns TRUE on errors, FALSE otherwise.
66516 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66517 **/
66518function ncurses_slk_clear(){}
66519
66520/**
66521 * Sets color for soft label keys
66522 *
66523 * @param int $intarg
66524 * @return int
66525 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66526 **/
66527function ncurses_slk_color($intarg){}
66528
66529/**
66530 * Initializes soft label key functions
66531 *
66532 * This function must be called before {@link ncurses_init} or {@link
66533 * ncurses_newwin} is called.
66534 *
66535 * @param int $format If {@link ncurses_init} eventually uses a line
66536 *   from stdscr to emulate the soft labels, then this parameter
66537 *   determines how the labels are arranged of the screen. 0 indicates a
66538 *   3-2-3 arrangement of the labels, 1 indicates a 4-4 arrangement and 2
66539 *   indicates the PC like 4-4-4 mode, but in addition an index line will
66540 *   be created.
66541 * @return bool
66542 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66543 **/
66544function ncurses_slk_init($format){}
66545
66546/**
66547 * Copies soft label keys to virtual screen
66548 *
66549 * @return bool
66550 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66551 **/
66552function ncurses_slk_noutrefresh(){}
66553
66554/**
66555 * Copies soft label keys to screen
66556 *
66557 * Copies soft label keys from virtual screen to physical screen.
66558 *
66559 * @return int
66560 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66561 **/
66562function ncurses_slk_refresh(){}
66563
66564/**
66565 * Restores soft label keys
66566 *
66567 * Restores the soft label keys after {@link ncurses_slk_clear} has been
66568 * performed.
66569 *
66570 * @return int
66571 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66572 **/
66573function ncurses_slk_restore(){}
66574
66575/**
66576 * Sets function key labels
66577 *
66578 * @param int $labelnr
66579 * @param string $label
66580 * @param int $format
66581 * @return bool
66582 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66583 **/
66584function ncurses_slk_set($labelnr, $label, $format){}
66585
66586/**
66587 * Forces output when ncurses_slk_noutrefresh is performed
66588 *
66589 * Forces all the soft labels to be output the next time a {@link
66590 * ncurses_slk_noutrefresh} is performed.
66591 *
66592 * @return int
66593 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66594 **/
66595function ncurses_slk_touch(){}
66596
66597/**
66598 * Stop using 'standout' attribute
66599 *
66600 * @return int
66601 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66602 **/
66603function ncurses_standend(){}
66604
66605/**
66606 * Start using 'standout' attribute
66607 *
66608 * @return int
66609 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66610 **/
66611function ncurses_standout(){}
66612
66613/**
66614 * Initializes color functionality
66615 *
66616 * Initializes color functionality in ncurses. This function must be
66617 * called before any color manipulation functions are called and after
66618 * {@link ncurses_init} is called. It is good practice to call this
66619 * function right after {@link ncurses_init}.
66620 *
66621 * @return int Returns 0 on success, or -1 if the color table could not
66622 *   be allocated or ncurses was not initialized.
66623 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66624 **/
66625function ncurses_start_color(){}
66626
66627/**
66628 * Returns a logical OR of all attribute flags supported by terminal
66629 *
66630 * @return bool
66631 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66632 **/
66633function ncurses_termattrs(){}
66634
66635/**
66636 * Returns terminals (short)-name
66637 *
66638 * Returns terminals shortname.
66639 *
66640 * @return string Returns the shortname of the terminal, truncated to
66641 *   14 characters. On errors, returns NULL.
66642 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66643 **/
66644function ncurses_termname(){}
66645
66646/**
66647 * Set timeout for special key sequences
66648 *
66649 * @param int $millisec
66650 * @return void
66651 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66652 **/
66653function ncurses_timeout($millisec){}
66654
66655/**
66656 * Moves a visible panel to the top of the stack
66657 *
66658 * @param resource $panel
66659 * @return int
66660 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66661 **/
66662function ncurses_top_panel($panel){}
66663
66664/**
66665 * Specify different filedescriptor for typeahead checking
66666 *
66667 * @param int $fd
66668 * @return int
66669 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66670 **/
66671function ncurses_typeahead($fd){}
66672
66673/**
66674 * Put a character back into the input stream
66675 *
66676 * @param int $keycode
66677 * @return int
66678 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66679 **/
66680function ncurses_ungetch($keycode){}
66681
66682/**
66683 * Pushes mouse event to queue
66684 *
66685 * Pushes a KEY_MOUSE event onto the input queue and associates with this
66686 * event the given state data and screen-relative character cell
66687 * coordinates, specified in {@link mevent}.
66688 *
66689 * @param array $mevent An associative array specifying the event
66690 *   options: "id" : Id to distinguish multiple devices "x" : screen
66691 *   relative x-position in character cells "y" : screen relative
66692 *   y-position in character cells "z" : currently not supported "mmask"
66693 *   : Mouse action
66694 * @return bool Returns FALSE on success, TRUE otherwise.
66695 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66696 **/
66697function ncurses_ungetmouse($mevent){}
66698
66699/**
66700 * Refreshes the virtual screen to reflect the relations between panels
66701 * in the stack
66702 *
66703 * @return void
66704 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66705 **/
66706function ncurses_update_panels(){}
66707
66708/**
66709 * Assign terminal default colors to color id -1
66710 *
66711 * @return bool
66712 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66713 **/
66714function ncurses_use_default_colors(){}
66715
66716/**
66717 * Control use of environment information about terminal size
66718 *
66719 * @param bool $flag
66720 * @return void
66721 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66722 **/
66723function ncurses_use_env($flag){}
66724
66725/**
66726 * Control use of extended names in terminfo descriptions
66727 *
66728 * @param bool $flag
66729 * @return int
66730 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66731 **/
66732function ncurses_use_extended_names($flag){}
66733
66734/**
66735 * Display the string on the terminal in the video attribute mode
66736 *
66737 * @param int $intarg
66738 * @return int
66739 * @since PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66740 **/
66741function ncurses_vidattr($intarg){}
66742
66743/**
66744 * Draw a vertical line at current position using an attributed character
66745 * and max. n characters long
66746 *
66747 * @param int $charattr
66748 * @param int $n
66749 * @return int
66750 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66751 **/
66752function ncurses_vline($charattr, $n){}
66753
66754/**
66755 * Adds character at current position in a window and advance cursor
66756 *
66757 * @param resource $window
66758 * @param int $ch
66759 * @return int
66760 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66761 **/
66762function ncurses_waddch($window, $ch){}
66763
66764/**
66765 * Outputs text at current postion in window
66766 *
66767 * @param resource $window
66768 * @param string $str
66769 * @param int $n
66770 * @return int
66771 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66772 **/
66773function ncurses_waddstr($window, $str, $n){}
66774
66775/**
66776 * Turns off attributes for a window
66777 *
66778 * @param resource $window
66779 * @param int $attrs
66780 * @return int
66781 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66782 **/
66783function ncurses_wattroff($window, $attrs){}
66784
66785/**
66786 * Turns on attributes for a window
66787 *
66788 * @param resource $window
66789 * @param int $attrs
66790 * @return int
66791 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66792 **/
66793function ncurses_wattron($window, $attrs){}
66794
66795/**
66796 * Set the attributes for a window
66797 *
66798 * @param resource $window
66799 * @param int $attrs
66800 * @return int
66801 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66802 **/
66803function ncurses_wattrset($window, $attrs){}
66804
66805/**
66806 * Draws a border around the window using attributed characters
66807 *
66808 * Draws the specified lines and corners around the passed {@link
66809 * window}.
66810 *
66811 * Use {@link ncurses_border} for borders around the main window.
66812 *
66813 * @param resource $window The window on which we operate
66814 * @param int $left
66815 * @param int $right
66816 * @param int $top
66817 * @param int $bottom
66818 * @param int $tl_corner Top left corner
66819 * @param int $tr_corner Top right corner
66820 * @param int $bl_corner Bottom left corner
66821 * @param int $br_corner Bottom right corner
66822 * @return int
66823 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66824 **/
66825function ncurses_wborder($window, $left, $right, $top, $bottom, $tl_corner, $tr_corner, $bl_corner, $br_corner){}
66826
66827/**
66828 * Clears window
66829 *
66830 * @param resource $window
66831 * @return int
66832 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66833 **/
66834function ncurses_wclear($window){}
66835
66836/**
66837 * Sets windows color pairings
66838 *
66839 * @param resource $window
66840 * @param int $color_pair
66841 * @return int
66842 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66843 **/
66844function ncurses_wcolor_set($window, $color_pair){}
66845
66846/**
66847 * Erase window contents
66848 *
66849 * @param resource $window
66850 * @return int
66851 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66852 **/
66853function ncurses_werase($window){}
66854
66855/**
66856 * Reads a character from keyboard (window)
66857 *
66858 * @param resource $window
66859 * @return int
66860 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66861 **/
66862function ncurses_wgetch($window){}
66863
66864/**
66865 * Draws a horizontal line in a window at current position using an
66866 * attributed character and max. n characters long
66867 *
66868 * @param resource $window
66869 * @param int $charattr
66870 * @param int $n
66871 * @return int
66872 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66873 **/
66874function ncurses_whline($window, $charattr, $n){}
66875
66876/**
66877 * Transforms window/stdscr coordinates
66878 *
66879 * @param resource $window
66880 * @param int $y
66881 * @param int $x
66882 * @param bool $toscreen
66883 * @return bool
66884 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66885 **/
66886function ncurses_wmouse_trafo($window, &$y, &$x, $toscreen){}
66887
66888/**
66889 * Moves windows output position
66890 *
66891 * @param resource $window
66892 * @param int $y
66893 * @param int $x
66894 * @return int
66895 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66896 **/
66897function ncurses_wmove($window, $y, $x){}
66898
66899/**
66900 * Copies window to virtual screen
66901 *
66902 * @param resource $window
66903 * @return int
66904 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66905 **/
66906function ncurses_wnoutrefresh($window){}
66907
66908/**
66909 * Refresh window on terminal screen
66910 *
66911 * @param resource $window
66912 * @return int
66913 * @since PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66914 **/
66915function ncurses_wrefresh($window){}
66916
66917/**
66918 * End standout mode for a window
66919 *
66920 * @param resource $window
66921 * @return int
66922 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66923 **/
66924function ncurses_wstandend($window){}
66925
66926/**
66927 * Enter standout mode for a window
66928 *
66929 * @param resource $window
66930 * @return int
66931 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66932 **/
66933function ncurses_wstandout($window){}
66934
66935/**
66936 * Draws a vertical line in a window at current position using an
66937 * attributed character and max. n characters long
66938 *
66939 * @param resource $window
66940 * @param int $charattr
66941 * @param int $n
66942 * @return int
66943 * @since PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0
66944 **/
66945function ncurses_wvline($window, $charattr, $n){}
66946
66947/**
66948 * Send a beep to the terminal
66949 *
66950 * This function sends a beep to the terminal.
66951 *
66952 * @return void
66953 * @since PECL newt >= 0.1
66954 **/
66955function newt_bell(){}
66956
66957/**
66958 * Create a new button
66959 *
66960 * Creates a new button.
66961 *
66962 * @param int $left X-coordinate of the button.
66963 * @param int $top Y-coordinate of the button.
66964 * @param string $text The text which should be displayed in the
66965 *   button.
66966 * @return resource Returns a resource link to the created button
66967 *   component, or FALSE on error.
66968 * @since PECL newt >= 0.1
66969 **/
66970function newt_button($left, $top, $text){}
66971
66972/**
66973 * This function returns a grid containing the buttons created
66974 *
66975 * @param array $buttons
66976 * @return resource Returns grid containing the buttons created.
66977 * @since PECL newt >= 0.1
66978 **/
66979function newt_button_bar(&$buttons){}
66980
66981/**
66982 * Open a centered window of the specified size
66983 *
66984 * @param int $width Window width
66985 * @param int $height Window height
66986 * @param string $title Window title
66987 * @return int Undefined value.
66988 * @since PECL newt >= 0.1
66989 **/
66990function newt_centered_window($width, $height, $title){}
66991
66992/**
66993 * @param int $left
66994 * @param int $top
66995 * @param string $text
66996 * @param string $def_value
66997 * @param string $seq
66998 * @return resource
66999 * @since PECL newt >= 0.1
67000 **/
67001function newt_checkbox($left, $top, $text, $def_value, $seq){}
67002
67003/**
67004 * Retreives value of checkox resource
67005 *
67006 * This function returns the character in the sequence which indicates
67007 * the current value of the checkbox.
67008 *
67009 * @param resource $checkbox
67010 * @return string Returns character indicating the value of the
67011 *   checkbox.
67012 * @since PECL newt >= 0.1
67013 **/
67014function newt_checkbox_get_value($checkbox){}
67015
67016/**
67017 * Configures checkbox resource
67018 *
67019 * This function allows to set various flags on checkbox resource.
67020 *
67021 * @param resource $checkbox
67022 * @param int $flags
67023 * @param int $sense
67024 * @return void
67025 * @since PECL newt >= 0.1
67026 **/
67027function newt_checkbox_set_flags($checkbox, $flags, $sense){}
67028
67029/**
67030 * Sets the value of the checkbox
67031 *
67032 * This function allows to set the current value of the checkbox
67033 * resource.
67034 *
67035 * @param resource $checkbox
67036 * @param string $value
67037 * @return void
67038 * @since PECL newt >= 0.1
67039 **/
67040function newt_checkbox_set_value($checkbox, $value){}
67041
67042/**
67043 * @param int $left
67044 * @param int $top
67045 * @param int $height
67046 * @param int $flags
67047 * @return resource
67048 * @since PECL newt >= 0.1
67049 **/
67050function newt_checkbox_tree($left, $top, $height, $flags){}
67051
67052/**
67053 * Adds new item to the checkbox tree
67054 *
67055 * This function allows to add new item to the checkbox tree.
67056 *
67057 * @param resource $checkboxtree
67058 * @param string $text
67059 * @param mixed $data
67060 * @param int $flags
67061 * @param int $index
67062 * @param int ...$vararg
67063 * @return void
67064 * @since PECL newt >= 0.1
67065 **/
67066function newt_checkbox_tree_add_item($checkboxtree, $text, $data, $flags, $index, ...$vararg){}
67067
67068/**
67069 * Finds an item in the checkbox tree
67070 *
67071 * Finds an item in the checkbox tree by item's data.
67072 *
67073 * @param resource $checkboxtree
67074 * @param mixed $data
67075 * @return array Returns checkbox tree item resource, or NULL if it
67076 *   wasn't found.
67077 * @since PECL newt >= 0.1
67078 **/
67079function newt_checkbox_tree_find_item($checkboxtree, $data){}
67080
67081/**
67082 * Returns checkbox tree selected item
67083 *
67084 * This method returns checkbox tree selected tem.
67085 *
67086 * @param resource $checkboxtree
67087 * @return mixed Returns current (selected) checkbox tree item.
67088 * @since PECL newt >= 0.1
67089 **/
67090function newt_checkbox_tree_get_current($checkboxtree){}
67091
67092/**
67093 * @param resource $checkboxtree
67094 * @param mixed $data
67095 * @return string
67096 * @since PECL newt >= 0.1
67097 **/
67098function newt_checkbox_tree_get_entry_value($checkboxtree, $data){}
67099
67100/**
67101 * @param resource $checkboxtree
67102 * @param string $seqnum
67103 * @return array
67104 * @since PECL newt >= 0.1
67105 **/
67106function newt_checkbox_tree_get_multi_selection($checkboxtree, $seqnum){}
67107
67108/**
67109 * @param resource $checkboxtree
67110 * @return array
67111 * @since PECL newt >= 0.1
67112 **/
67113function newt_checkbox_tree_get_selection($checkboxtree){}
67114
67115/**
67116 * @param int $left
67117 * @param int $top
67118 * @param int $height
67119 * @param string $seq
67120 * @param int $flags
67121 * @return resource
67122 * @since PECL newt >= 0.1
67123 **/
67124function newt_checkbox_tree_multi($left, $top, $height, $seq, $flags){}
67125
67126/**
67127 * @param resource $checkboxtree
67128 * @param mixed $data
67129 * @return void
67130 * @since PECL newt >= 0.1
67131 **/
67132function newt_checkbox_tree_set_current($checkboxtree, $data){}
67133
67134/**
67135 * @param resource $checkboxtree
67136 * @param mixed $data
67137 * @param string $text
67138 * @return void
67139 * @since PECL newt >= 0.1
67140 **/
67141function newt_checkbox_tree_set_entry($checkboxtree, $data, $text){}
67142
67143/**
67144 * @param resource $checkboxtree
67145 * @param mixed $data
67146 * @param string $value
67147 * @return void
67148 * @since PECL newt >= 0.1
67149 **/
67150function newt_checkbox_tree_set_entry_value($checkboxtree, $data, $value){}
67151
67152/**
67153 * @param resource $checkbox_tree
67154 * @param int $width
67155 * @return void
67156 * @since PECL newt >= 0.1
67157 **/
67158function newt_checkbox_tree_set_width($checkbox_tree, $width){}
67159
67160/**
67161 * Discards the contents of the terminal's input buffer without waiting
67162 * for additional input
67163 *
67164 * Discards the contents of the terminal's input buffer without waiting
67165 * for additional input.
67166 *
67167 * @return void
67168 * @since PECL newt >= 0.1
67169 **/
67170function newt_clear_key_buffer(){}
67171
67172/**
67173 * @return void
67174 * @since PECL newt >= 0.1
67175 **/
67176function newt_cls(){}
67177
67178/**
67179 * @param int $left
67180 * @param int $top
67181 * @param string $text
67182 * @return resource
67183 * @since PECL newt >= 0.1
67184 **/
67185function newt_compact_button($left, $top, $text){}
67186
67187/**
67188 * @param resource $component
67189 * @param mixed $func_name
67190 * @param mixed $data
67191 * @return void
67192 * @since PECL newt >= 0.1
67193 **/
67194function newt_component_add_callback($component, $func_name, $data){}
67195
67196/**
67197 * @param resource $component
67198 * @param bool $takes_focus
67199 * @return void
67200 * @since PECL newt >= 0.1
67201 **/
67202function newt_component_takes_focus($component, $takes_focus){}
67203
67204/**
67205 * @param int $cols
67206 * @param int $rows
67207 * @return resource
67208 * @since PECL newt >= 0.1
67209 **/
67210function newt_create_grid($cols, $rows){}
67211
67212/**
67213 * @return void
67214 * @since PECL newt >= 0.1
67215 **/
67216function newt_cursor_off(){}
67217
67218/**
67219 * @return void
67220 * @since PECL newt >= 0.1
67221 **/
67222function newt_cursor_on(){}
67223
67224/**
67225 * @param int $microseconds
67226 * @return void
67227 * @since PECL newt >= 0.1
67228 **/
67229function newt_delay($microseconds){}
67230
67231/**
67232 * @param resource $form
67233 * @return void
67234 * @since PECL newt >= 0.1
67235 **/
67236function newt_draw_form($form){}
67237
67238/**
67239 * Displays the string text at the position indicated
67240 *
67241 * @param int $left Column number
67242 * @param int $top Line number
67243 * @param string $text Text to display.
67244 * @return void
67245 * @since PECL newt >= 0.1
67246 **/
67247function newt_draw_root_text($left, $top, $text){}
67248
67249/**
67250 * @param int $left
67251 * @param int $top
67252 * @param int $width
67253 * @param string $init_value
67254 * @param int $flags
67255 * @return resource
67256 * @since PECL newt >= 0.1
67257 **/
67258function newt_entry($left, $top, $width, $init_value, $flags){}
67259
67260/**
67261 * @param resource $entry
67262 * @return string
67263 * @since PECL newt >= 0.1
67264 **/
67265function newt_entry_get_value($entry){}
67266
67267/**
67268 * @param resource $entry
67269 * @param string $value
67270 * @param bool $cursor_at_end
67271 * @return void
67272 * @since PECL newt >= 0.1
67273 **/
67274function newt_entry_set($entry, $value, $cursor_at_end){}
67275
67276/**
67277 * @param resource $entry
67278 * @param callable $filter
67279 * @param mixed $data
67280 * @return void
67281 * @since PECL newt >= 0.1
67282 **/
67283function newt_entry_set_filter($entry, $filter, $data){}
67284
67285/**
67286 * @param resource $entry
67287 * @param int $flags
67288 * @param int $sense
67289 * @return void
67290 * @since PECL newt >= 0.1
67291 **/
67292function newt_entry_set_flags($entry, $flags, $sense){}
67293
67294/**
67295 * Uninitializes newt interface
67296 *
67297 * Uninitializes newt interface. This function be called, when program is
67298 * ready to exit.
67299 *
67300 * @return int Returns 1 on success, 0 on failure.
67301 * @since PECL newt >= 0.1
67302 **/
67303function newt_finished(){}
67304
67305/**
67306 * Create a form
67307 *
67308 * Create a new form.
67309 *
67310 * @param resource $vert_bar Vertical scrollbar which should be
67311 *   associated with the form
67312 * @param string $help Help text string
67313 * @param int $flags Various flags
67314 * @return resource Returns a resource link to the created form
67315 *   component, or FALSE on error.
67316 * @since PECL newt >= 0.1
67317 **/
67318function newt_form($vert_bar, $help, $flags){}
67319
67320/**
67321 * Adds a single component to the form
67322 *
67323 * Adds a single component to the {@link form}.
67324 *
67325 * @param resource $form Form to which component will be added
67326 * @param resource $component Component to add to the form
67327 * @return void
67328 * @since PECL newt >= 0.1
67329 **/
67330function newt_form_add_component($form, $component){}
67331
67332/**
67333 * Add several components to the form
67334 *
67335 * Adds several components to the {@link form}.
67336 *
67337 * @param resource $form Form to which components will be added
67338 * @param array $components Array of components to add to the form
67339 * @return void
67340 * @since PECL newt >= 0.1
67341 **/
67342function newt_form_add_components($form, $components){}
67343
67344/**
67345 * @param resource $form
67346 * @param int $key
67347 * @return void
67348 * @since PECL newt >= 0.1
67349 **/
67350function newt_form_add_hot_key($form, $key){}
67351
67352/**
67353 * Destroys a form
67354 *
67355 * This function frees the memory resources used by the form and all of
67356 * the components which have been added to the form (including those
67357 * components which are on subforms). Once a form has been destroyed,
67358 * none of the form's components can be used.
67359 *
67360 * @param resource $form Form component, which is going to be destroyed
67361 * @return void
67362 * @since PECL newt >= 0.1
67363 **/
67364function newt_form_destroy($form){}
67365
67366/**
67367 * @param resource $form
67368 * @return resource
67369 * @since PECL newt >= 0.1
67370 **/
67371function newt_form_get_current($form){}
67372
67373/**
67374 * Runs a form
67375 *
67376 * This function runs the form passed to it.
67377 *
67378 * @param resource $form Form component
67379 * @param array $exit_struct Array, used for returning information
67380 *   after running the form component. Keys and values are described in
67381 *   the following table: Form Exit Structure Index Key Value Type
67382 *   Description reason integer The reason, why the form has been exited.
67383 *   Possible values are defined here. watch resource Resource link,
67384 *   specified in {@link newt_form_watch_fd} key integer Hotkey component
67385 *   resource Component, which caused the form to exit
67386 * @return void
67387 * @since PECL newt >= 0.1
67388 **/
67389function newt_form_run($form, &$exit_struct){}
67390
67391/**
67392 * @param resource $from
67393 * @param int $background
67394 * @return void
67395 * @since PECL newt >= 0.1
67396 **/
67397function newt_form_set_background($from, $background){}
67398
67399/**
67400 * @param resource $form
67401 * @param int $height
67402 * @return void
67403 * @since PECL newt >= 0.1
67404 **/
67405function newt_form_set_height($form, $height){}
67406
67407/**
67408 * @param resource $form
67409 * @return void
67410 * @since PECL newt >= 0.1
67411 **/
67412function newt_form_set_size($form){}
67413
67414/**
67415 * @param resource $form
67416 * @param int $milliseconds
67417 * @return void
67418 * @since PECL newt >= 0.1
67419 **/
67420function newt_form_set_timer($form, $milliseconds){}
67421
67422/**
67423 * @param resource $form
67424 * @param int $width
67425 * @return void
67426 * @since PECL newt >= 0.1
67427 **/
67428function newt_form_set_width($form, $width){}
67429
67430/**
67431 * @param resource $form
67432 * @param resource $stream
67433 * @param int $flags
67434 * @return void
67435 * @since PECL newt >= 0.1
67436 **/
67437function newt_form_watch_fd($form, $stream, $flags){}
67438
67439/**
67440 * Fills in the passed references with the current size of the terminal
67441 *
67442 * Fills in the passed references with the current size of the terminal.
67443 *
67444 * @param int $cols Number of columns in the terminal
67445 * @param int $rows Number of rows in the terminal
67446 * @return void
67447 * @since PECL newt >= 0.1
67448 **/
67449function newt_get_screen_size(&$cols, &$rows){}
67450
67451/**
67452 * @param resource $grid
67453 * @param resource $form
67454 * @param bool $recurse
67455 * @return void
67456 * @since PECL newt >= 0.1
67457 **/
67458function newt_grid_add_components_to_form($grid, $form, $recurse){}
67459
67460/**
67461 * @param resource $text
67462 * @param resource $middle
67463 * @param resource $buttons
67464 * @return resource
67465 * @since PECL newt >= 0.1
67466 **/
67467function newt_grid_basic_window($text, $middle, $buttons){}
67468
67469/**
67470 * @param resource $grid
67471 * @param bool $recurse
67472 * @return void
67473 * @since PECL newt >= 0.1
67474 **/
67475function newt_grid_free($grid, $recurse){}
67476
67477/**
67478 * @param resouce $grid
67479 * @param int $width
67480 * @param int $height
67481 * @return void
67482 * @since PECL newt >= 0.1
67483 **/
67484function newt_grid_get_size($grid, &$width, &$height){}
67485
67486/**
67487 * @param int $element1_type
67488 * @param resource $element1
67489 * @param int ...$vararg
67490 * @param resource ...$vararg
67491 * @return resource
67492 * @since PECL newt >= 0.1
67493 **/
67494function newt_grid_h_close_stacked($element1_type, $element1, ...$vararg){}
67495
67496/**
67497 * @param int $element1_type
67498 * @param resource $element1
67499 * @param int ...$vararg
67500 * @param resource ...$vararg
67501 * @return resource
67502 * @since PECL newt >= 0.1
67503 **/
67504function newt_grid_h_stacked($element1_type, $element1, ...$vararg){}
67505
67506/**
67507 * @param resource $grid
67508 * @param int $left
67509 * @param int $top
67510 * @return void
67511 * @since PECL newt >= 0.1
67512 **/
67513function newt_grid_place($grid, $left, $top){}
67514
67515/**
67516 * @param resource $grid
67517 * @param int $col
67518 * @param int $row
67519 * @param int $type
67520 * @param resource $val
67521 * @param int $pad_left
67522 * @param int $pad_top
67523 * @param int $pad_right
67524 * @param int $pad_bottom
67525 * @param int $anchor
67526 * @param int $flags
67527 * @return void
67528 * @since PECL newt >= 0.1
67529 **/
67530function newt_grid_set_field($grid, $col, $row, $type, $val, $pad_left, $pad_top, $pad_right, $pad_bottom, $anchor, $flags){}
67531
67532/**
67533 * @param resource $text
67534 * @param resource $middle
67535 * @param resource $buttons
67536 * @return resource
67537 * @since PECL newt >= 0.1
67538 **/
67539function newt_grid_simple_window($text, $middle, $buttons){}
67540
67541/**
67542 * @param int $element1_type
67543 * @param resource $element1
67544 * @param int ...$vararg
67545 * @param resource ...$vararg
67546 * @return resource
67547 * @since PECL newt >= 0.1
67548 **/
67549function newt_grid_v_close_stacked($element1_type, $element1, ...$vararg){}
67550
67551/**
67552 * @param int $element1_type
67553 * @param resource $element1
67554 * @param int ...$vararg
67555 * @param resource ...$vararg
67556 * @return resource
67557 * @since PECL newt >= 0.1
67558 **/
67559function newt_grid_v_stacked($element1_type, $element1, ...$vararg){}
67560
67561/**
67562 * @param resource $grid
67563 * @param string $title
67564 * @return void
67565 * @since PECL newt >= 0.1
67566 **/
67567function newt_grid_wrapped_window($grid, $title){}
67568
67569/**
67570 * @param resource $grid
67571 * @param string $title
67572 * @param int $left
67573 * @param int $top
67574 * @return void
67575 * @since PECL newt >= 0.1
67576 **/
67577function newt_grid_wrapped_window_at($grid, $title, $left, $top){}
67578
67579/**
67580 * Initialize newt
67581 *
67582 * Initializes the newt interface. This function must be called before
67583 * any other newt function.
67584 *
67585 * @return int Returns 1 on success, 0 on failure.
67586 * @since PECL newt >= 0.1
67587 **/
67588function newt_init(){}
67589
67590/**
67591 * @param int $left
67592 * @param int $top
67593 * @param string $text
67594 * @return resource
67595 * @since PECL newt >= 0.1
67596 **/
67597function newt_label($left, $top, $text){}
67598
67599/**
67600 * @param resource $label
67601 * @param string $text
67602 * @return void
67603 * @since PECL newt >= 0.1
67604 **/
67605function newt_label_set_text($label, $text){}
67606
67607/**
67608 * @param int $left
67609 * @param int $top
67610 * @param int $height
67611 * @param int $flags
67612 * @return resource
67613 * @since PECL newt >= 0.1
67614 **/
67615function newt_listbox($left, $top, $height, $flags){}
67616
67617/**
67618 * @param resource $listbox
67619 * @param string $text
67620 * @param mixed $data
67621 * @return void
67622 * @since PECL newt >= 0.1
67623 **/
67624function newt_listbox_append_entry($listbox, $text, $data){}
67625
67626/**
67627 * @param resource $listobx
67628 * @return void
67629 * @since PECL newt >= 0.1
67630 **/
67631function newt_listbox_clear($listobx){}
67632
67633/**
67634 * @param resource $listbox
67635 * @return void
67636 * @since PECL newt >= 0.1
67637 **/
67638function newt_listbox_clear_selection($listbox){}
67639
67640/**
67641 * @param resource $listbox
67642 * @param mixed $key
67643 * @return void
67644 * @since PECL newt >= 0.1
67645 **/
67646function newt_listbox_delete_entry($listbox, $key){}
67647
67648/**
67649 * @param resource $listbox
67650 * @return string
67651 * @since PECL newt >= 0.1
67652 **/
67653function newt_listbox_get_current($listbox){}
67654
67655/**
67656 * @param resource $listbox
67657 * @return array
67658 * @since PECL newt >= 0.1
67659 **/
67660function newt_listbox_get_selection($listbox){}
67661
67662/**
67663 * @param resource $listbox
67664 * @param string $text
67665 * @param mixed $data
67666 * @param mixed $key
67667 * @return void
67668 * @since PECL newt >= 0.1
67669 **/
67670function newt_listbox_insert_entry($listbox, $text, $data, $key){}
67671
67672/**
67673 * @param resource $listbox
67674 * @return int
67675 * @since PECL newt >= 0.1
67676 **/
67677function newt_listbox_item_count($listbox){}
67678
67679/**
67680 * @param resource $listbox
67681 * @param mixed $key
67682 * @param int $sense
67683 * @return void
67684 * @since PECL newt >= 0.1
67685 **/
67686function newt_listbox_select_item($listbox, $key, $sense){}
67687
67688/**
67689 * @param resource $listbox
67690 * @param int $num
67691 * @return void
67692 * @since PECL newt >= 0.1
67693 **/
67694function newt_listbox_set_current($listbox, $num){}
67695
67696/**
67697 * @param resource $listbox
67698 * @param mixed $key
67699 * @return void
67700 * @since PECL newt >= 0.1
67701 **/
67702function newt_listbox_set_current_by_key($listbox, $key){}
67703
67704/**
67705 * @param resource $listbox
67706 * @param int $num
67707 * @param mixed $data
67708 * @return void
67709 * @since PECL newt >= 0.1
67710 **/
67711function newt_listbox_set_data($listbox, $num, $data){}
67712
67713/**
67714 * @param resource $listbox
67715 * @param int $num
67716 * @param string $text
67717 * @return void
67718 * @since PECL newt >= 0.1
67719 **/
67720function newt_listbox_set_entry($listbox, $num, $text){}
67721
67722/**
67723 * @param resource $listbox
67724 * @param int $width
67725 * @return void
67726 * @since PECL newt >= 0.1
67727 **/
67728function newt_listbox_set_width($listbox, $width){}
67729
67730/**
67731 * @param int $left
67732 * @param int $top
67733 * @param string $text
67734 * @param bool $is_default
67735 * @param resouce $prev_item
67736 * @param mixed $data
67737 * @param int $flags
67738 * @return resource
67739 * @since PECL newt >= 0.1
67740 **/
67741function newt_listitem($left, $top, $text, $is_default, $prev_item, $data, $flags){}
67742
67743/**
67744 * @param resource $item
67745 * @return mixed
67746 * @since PECL newt >= 0.1
67747 **/
67748function newt_listitem_get_data($item){}
67749
67750/**
67751 * @param resource $item
67752 * @param string $text
67753 * @return void
67754 * @since PECL newt >= 0.1
67755 **/
67756function newt_listitem_set($item, $text){}
67757
67758/**
67759 * Open a window of the specified size and position
67760 *
67761 * @param int $left Location of the upper left-hand corner of the
67762 *   window (column number)
67763 * @param int $top Location of the upper left-hand corner of the window
67764 *   (row number)
67765 * @param int $width Window width
67766 * @param int $height Window height
67767 * @param string $title Window title
67768 * @return int Returns 1 on success, 0 on failure.
67769 * @since PECL newt >= 0.1
67770 **/
67771function newt_open_window($left, $top, $width, $height, $title){}
67772
67773/**
67774 * Replaces the current help line with the one from the stack
67775 *
67776 * @return void
67777 * @since PECL newt >= 0.1
67778 **/
67779function newt_pop_help_line(){}
67780
67781/**
67782 * Removes the top window from the display
67783 *
67784 * Removes the top window from the display, and redraws the display areas
67785 * which the window overwrote.
67786 *
67787 * @return void
67788 * @since PECL newt >= 0.1
67789 **/
67790function newt_pop_window(){}
67791
67792/**
67793 * Saves the current help line on a stack, and displays the new line
67794 *
67795 * @param string $text New help text message
67796 * @return void
67797 * @since PECL newt >= 0.1
67798 **/
67799function newt_push_help_line($text){}
67800
67801/**
67802 * @param int $left
67803 * @param int $top
67804 * @param string $text
67805 * @param bool $is_default
67806 * @param resource $prev_button
67807 * @return resource
67808 * @since PECL newt >= 0.1
67809 **/
67810function newt_radiobutton($left, $top, $text, $is_default, $prev_button){}
67811
67812/**
67813 * @param resource $set_member
67814 * @return resource
67815 * @since PECL newt >= 0.1
67816 **/
67817function newt_radio_get_current($set_member){}
67818
67819/**
67820 * @return void
67821 * @since PECL newt >= 0.1
67822 **/
67823function newt_redraw_help_line(){}
67824
67825/**
67826 * @param string $text
67827 * @param int $width
67828 * @param int $flex_down
67829 * @param int $flex_up
67830 * @param int $actual_width
67831 * @param int $actual_height
67832 * @return string
67833 * @since PECL newt >= 0.1
67834 **/
67835function newt_reflow_text($text, $width, $flex_down, $flex_up, &$actual_width, &$actual_height){}
67836
67837/**
67838 * Updates modified portions of the screen
67839 *
67840 * To increase performance, newt only updates the display when it needs
67841 * to, not when the program tells it to write to the terminal.
67842 * Applications can force newt to immediately update modified portions of
67843 * the screen by calling this function.
67844 *
67845 * @return void
67846 * @since PECL newt >= 0.1
67847 **/
67848function newt_refresh(){}
67849
67850/**
67851 * @param bool $redraw
67852 * @return void
67853 * @since PECL newt >= 0.1
67854 **/
67855function newt_resize_screen($redraw){}
67856
67857/**
67858 * Resume using the newt interface after calling
67859 *
67860 * Resume using the newt interface after calling {@link newt_suspend}.
67861 *
67862 * @return void
67863 * @since PECL newt >= 0.1
67864 **/
67865function newt_resume(){}
67866
67867/**
67868 * Runs a form
67869 *
67870 * This function runs the form passed to it.
67871 *
67872 * @param resource $form Form component
67873 * @return resource The component which caused the form to stop
67874 *   running.
67875 * @since PECL newt >= 0.1
67876 **/
67877function newt_run_form($form){}
67878
67879/**
67880 * @param int $left
67881 * @param int $top
67882 * @param int $width
67883 * @param int $full_value
67884 * @return resource
67885 * @since PECL newt >= 0.1
67886 **/
67887function newt_scale($left, $top, $width, $full_value){}
67888
67889/**
67890 * @param resource $scale
67891 * @param int $amount
67892 * @return void
67893 * @since PECL newt >= 0.1
67894 **/
67895function newt_scale_set($scale, $amount){}
67896
67897/**
67898 * @param resource $scrollbar
67899 * @param int $where
67900 * @param int $total
67901 * @return void
67902 * @since PECL newt >= 0.1
67903 **/
67904function newt_scrollbar_set($scrollbar, $where, $total){}
67905
67906/**
67907 * @param mixed $function
67908 * @return void
67909 * @since PECL newt >= 0.1
67910 **/
67911function newt_set_help_callback($function){}
67912
67913/**
67914 * Set a callback function which gets invoked when user presses the
67915 * suspend key
67916 *
67917 * Set a callback function which gets invoked when user presses the
67918 * suspend key (normally ^Z). If no suspend callback is registered, the
67919 * suspend keystroke is ignored.
67920 *
67921 * @param callable $function A callback function, which accepts one
67922 *   argument: data
67923 * @param mixed $data This data is been passed to the callback function
67924 * @return void
67925 * @since PECL newt >= 0.1
67926 **/
67927function newt_set_suspend_callback($function, $data){}
67928
67929/**
67930 * Tells newt to return the terminal to its initial state
67931 *
67932 * Tells newt to return the terminal to its initial state. Once this is
67933 * done, the application can suspend itself (by sending itself a SIGTSTP,
67934 * fork a child program, or do whatever else it likes).
67935 *
67936 * @return void
67937 * @since PECL newt >= 0.1
67938 **/
67939function newt_suspend(){}
67940
67941/**
67942 * @param int $left
67943 * @param int $top
67944 * @param int $width
67945 * @param int $height
67946 * @param int $flags
67947 * @return resource
67948 * @since PECL newt >= 0.1
67949 **/
67950function newt_textbox($left, $top, $width, $height, $flags){}
67951
67952/**
67953 * @param resource $textbox
67954 * @return int
67955 * @since PECL newt >= 0.1
67956 **/
67957function newt_textbox_get_num_lines($textbox){}
67958
67959/**
67960 * @param int $left
67961 * @param int $top
67962 * @param char $text
67963 * @param int $width
67964 * @param int $flex_down
67965 * @param int $flex_up
67966 * @param int $flags
67967 * @return resource
67968 * @since PECL newt >= 0.1
67969 **/
67970function newt_textbox_reflowed($left, $top, $text, $width, $flex_down, $flex_up, $flags){}
67971
67972/**
67973 * @param resource $textbox
67974 * @param int $height
67975 * @return void
67976 * @since PECL newt >= 0.1
67977 **/
67978function newt_textbox_set_height($textbox, $height){}
67979
67980/**
67981 * @param resource $textbox
67982 * @param string $text
67983 * @return void
67984 * @since PECL newt >= 0.1
67985 **/
67986function newt_textbox_set_text($textbox, $text){}
67987
67988/**
67989 * @param int $left
67990 * @param int $top
67991 * @param int $height
67992 * @param int $normal_colorset
67993 * @param int $thumb_colorset
67994 * @return resource
67995 * @since PECL newt >= 0.1
67996 **/
67997function newt_vertical_scrollbar($left, $top, $height, $normal_colorset, $thumb_colorset){}
67998
67999/**
68000 * Doesn't return until a key has been pressed
68001 *
68002 * This function doesn't return until a key has been pressed. The
68003 * keystroke is then ignored. If a key is already in the terminal's
68004 * buffer, this function discards a keystroke and returns immediately.
68005 *
68006 * @return void
68007 * @since PECL newt >= 0.1
68008 **/
68009function newt_wait_for_key(){}
68010
68011/**
68012 * @param string $title
68013 * @param string $button1_text
68014 * @param string $button2_text
68015 * @param string $format
68016 * @param mixed $args
68017 * @param mixed ...$vararg
68018 * @return int
68019 * @since PECL newt >= 0.1
68020 **/
68021function newt_win_choice($title, $button1_text, $button2_text, $format, $args, ...$vararg){}
68022
68023/**
68024 * @param string $title
68025 * @param string $text
68026 * @param int $suggested_width
68027 * @param int $flex_down
68028 * @param int $flex_up
68029 * @param int $data_width
68030 * @param array $items
68031 * @param string $button1
68032 * @param string ...$vararg
68033 * @return int
68034 * @since PECL newt >= 0.1
68035 **/
68036function newt_win_entries($title, $text, $suggested_width, $flex_down, $flex_up, $data_width, &$items, $button1, ...$vararg){}
68037
68038/**
68039 * @param string $title
68040 * @param string $text
68041 * @param int $suggestedWidth
68042 * @param int $flexDown
68043 * @param int $flexUp
68044 * @param int $maxListHeight
68045 * @param array $items
68046 * @param int $listItem
68047 * @param string $button1
68048 * @param string ...$vararg
68049 * @return int
68050 * @since PECL newt >= 0.1
68051 **/
68052function newt_win_menu($title, $text, $suggestedWidth, $flexDown, $flexUp, $maxListHeight, $items, &$listItem, $button1, ...$vararg){}
68053
68054/**
68055 * @param string $title
68056 * @param string $button_text
68057 * @param string $format
68058 * @param mixed $args
68059 * @param mixed ...$vararg
68060 * @return void
68061 * @since PECL newt >= 0.1
68062 **/
68063function newt_win_message($title, $button_text, $format, $args, ...$vararg){}
68064
68065/**
68066 * @param string $title
68067 * @param string $button_text
68068 * @param string $format
68069 * @param array $args
68070 * @return void
68071 * @since PECL newt >= 0.1
68072 **/
68073function newt_win_messagev($title, $button_text, $format, $args){}
68074
68075/**
68076 * @param string $title Its description
68077 * @param string $button1_text Its description
68078 * @param string $button2_text Its description
68079 * @param string $button3_text Its description
68080 * @param string $format Its description
68081 * @param mixed $args Its description
68082 * @param mixed ...$vararg
68083 * @return int What the function returns, first on success, then on
68084 *   failure. See also the &return.success; entity
68085 * @since PECL newt >= 0.1
68086 **/
68087function newt_win_ternary($title, $button1_text, $button2_text, $button3_text, $format, $args, ...$vararg){}
68088
68089/**
68090 * Advance the internal pointer of an array
68091 *
68092 * {@link next} behaves like {@link current}, with one difference. It
68093 * advances the internal array pointer one place forward before returning
68094 * the element value. That means it returns the next array value and
68095 * advances the internal array pointer by one.
68096 *
68097 * @param array $array The array being affected.
68098 * @return mixed Returns the array value in the next place that's
68099 *   pointed to by the internal array pointer, or FALSE if there are no
68100 *   more elements.
68101 * @since PHP 4, PHP 5, PHP 7
68102 **/
68103function next(&$array){}
68104
68105/**
68106 * Plural version of gettext
68107 *
68108 * The plural version of {@link gettext}. Some languages have more than
68109 * one form for plural messages dependent on the count.
68110 *
68111 * @param string $msgid1 The singular message ID.
68112 * @param string $msgid2 The plural message ID.
68113 * @param int $n The number (e.g. item count) to determine the
68114 *   translation for the respective grammatical number.
68115 * @return string Returns correct plural form of message identified by
68116 *   {@link msgid1} and {@link msgid2} for count {@link n}.
68117 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
68118 **/
68119function ngettext($msgid1, $msgid2, $n){}
68120
68121/**
68122 * Inserts HTML line breaks before all newlines in a string
68123 *
68124 * Returns {@link string} with <br /> or <br> inserted before all
68125 * newlines (\r\n, \n\r, \n and \r).
68126 *
68127 * @param string $string The input string.
68128 * @param bool $is_xhtml Whether to use XHTML compatible line breaks or
68129 *   not.
68130 * @return string Returns the altered string.
68131 * @since PHP 4, PHP 5, PHP 7
68132 **/
68133function nl2br($string, $is_xhtml){}
68134
68135/**
68136 * Query language and locale information
68137 *
68138 * {@link nl_langinfo} is used to access individual elements of the
68139 * locale categories. Unlike {@link localeconv}, which returns all of the
68140 * elements, {@link nl_langinfo} allows you to select any specific
68141 * element.
68142 *
68143 * @param int $item {@link item} may be an integer value of the element
68144 *   or the constant name of the element. The following is a list of
68145 *   constant names for {@link item} that may be used and their
68146 *   description. Some of these constants may not be defined or hold no
68147 *   value for certain locales. nl_langinfo Constants Constant
68148 *   Description LC_TIME Category Constants ABDAY_(1-7) Abbreviated name
68149 *   of n-th day of the week. DAY_(1-7) Name of the n-th day of the week
68150 *   (DAY_1 = Sunday). ABMON_(1-12) Abbreviated name of the n-th month of
68151 *   the year. MON_(1-12) Name of the n-th month of the year. AM_STR
68152 *   String for Ante meridian. PM_STR String for Post meridian. D_T_FMT
68153 *   String that can be used as the format string for {@link strftime} to
68154 *   represent time and date. D_FMT String that can be used as the format
68155 *   string for {@link strftime} to represent date. T_FMT String that can
68156 *   be used as the format string for {@link strftime} to represent time.
68157 *   T_FMT_AMPM String that can be used as the format string for {@link
68158 *   strftime} to represent time in 12-hour format with ante/post
68159 *   meridian. ERA Alternate era. ERA_YEAR Year in alternate era format.
68160 *   ERA_D_T_FMT Date and time in alternate era format (string can be
68161 *   used in {@link strftime}). ERA_D_FMT Date in alternate era format
68162 *   (string can be used in {@link strftime}). ERA_T_FMT Time in
68163 *   alternate era format (string can be used in {@link strftime}).
68164 *   LC_MONETARY Category Constants INT_CURR_SYMBOL International
68165 *   currency symbol. CURRENCY_SYMBOL Local currency symbol. CRNCYSTR
68166 *   Same value as CURRENCY_SYMBOL. MON_DECIMAL_POINT Decimal point
68167 *   character. MON_THOUSANDS_SEP Thousands separator (groups of three
68168 *   digits). MON_GROUPING Like "grouping" element. POSITIVE_SIGN Sign
68169 *   for positive values. NEGATIVE_SIGN Sign for negative values.
68170 *   INT_FRAC_DIGITS International fractional digits. FRAC_DIGITS Local
68171 *   fractional digits. P_CS_PRECEDES Returns 1 if CURRENCY_SYMBOL
68172 *   precedes a positive value. P_SEP_BY_SPACE Returns 1 if a space
68173 *   separates CURRENCY_SYMBOL from a positive value. N_CS_PRECEDES
68174 *   Returns 1 if CURRENCY_SYMBOL precedes a negative value.
68175 *   N_SEP_BY_SPACE Returns 1 if a space separates CURRENCY_SYMBOL from a
68176 *   negative value. P_SIGN_POSN Returns 0 if parentheses surround the
68177 *   quantity and CURRENCY_SYMBOL. Returns 1 if the sign string precedes
68178 *   the quantity and CURRENCY_SYMBOL. Returns 2 if the sign string
68179 *   follows the quantity and CURRENCY_SYMBOL. Returns 3 if the sign
68180 *   string immediately precedes the CURRENCY_SYMBOL. Returns 4 if the
68181 *   sign string immediately follows the CURRENCY_SYMBOL. N_SIGN_POSN
68182 *   LC_NUMERIC Category Constants DECIMAL_POINT Decimal point character.
68183 *   RADIXCHAR Same value as DECIMAL_POINT. THOUSANDS_SEP Separator
68184 *   character for thousands (groups of three digits). THOUSEP Same value
68185 *   as THOUSANDS_SEP. GROUPING LC_MESSAGES Category Constants YESEXPR
68186 *   Regex string for matching "yes" input. NOEXPR Regex string for
68187 *   matching "no" input. YESSTR Output string for "yes". NOSTR Output
68188 *   string for "no". LC_CTYPE Category Constants CODESET Return a string
68189 *   with the name of the character encoding.
68190 * @return string Returns the element as a string, or FALSE if {@link
68191 *   item} is not valid.
68192 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
68193 **/
68194function nl_langinfo($item){}
68195
68196/**
68197 * Gets the Decomposition_Mapping property for the given UTF-8 encoded
68198 * code point
68199 *
68200 * Gets the Decomposition_Mapping property, as specified in the Unicode
68201 * Character Database (UCD), for the given UTF-8 encoded code point.
68202 *
68203 * @param string $input The input string, which should be a single,
68204 *   UTF-8 encoded, code point.
68205 * @return string Returns a string containing the Decomposition_Mapping
68206 *   property, if present in the UCD.
68207 **/
68208function normalizer_get_raw_decomposition($input){}
68209
68210/**
68211 * Checks if the provided string is already in the specified
68212 * normalization form
68213 *
68214 * Checks if the provided string is already in the specified
68215 * normalization form.
68216 *
68217 * @param string $input The input string to normalize
68218 * @param int $form One of the normalization forms.
68219 * @return bool TRUE if normalized, FALSE otherwise or if there an
68220 *   error
68221 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
68222 **/
68223function normalizer_is_normalized($input, $form){}
68224
68225/**
68226 * Normalizes the input provided and returns the normalized string
68227 *
68228 * Normalizes the input provided and returns the normalized string
68229 *
68230 * @param string $input The input string to normalize
68231 * @param int $form One of the normalization forms.
68232 * @return string The normalized string or FALSE if an error occurred.
68233 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
68234 **/
68235function normalizer_normalize($input, $form){}
68236
68237/**
68238 * Fetch all HTTP request headers
68239 *
68240 * {@link nsapi_request_headers} gets all the HTTP headers in the current
68241 * request. This is only supported when PHP runs as a NSAPI module.
68242 *
68243 * @return array Returns an associative array with all the HTTP
68244 *   headers.
68245 * @since PHP 4 >= 4.3.3, PHP 5, PHP 7
68246 **/
68247function nsapi_request_headers(){}
68248
68249/**
68250 * Fetch all HTTP response headers
68251 *
68252 * Gets all the NSAPI response headers.
68253 *
68254 * @return array Returns an associative array with all the NSAPI
68255 *   response headers.
68256 * @since PHP 4 >= 4.3.3, PHP 5, PHP 7
68257 **/
68258function nsapi_response_headers(){}
68259
68260/**
68261 * Perform an NSAPI sub-request
68262 *
68263 * {@link nsapi_virtual} is an NSAPI-specific function which is
68264 * equivalent to <!--#include virtual...--> in SSI (.shtml files). It
68265 * does an NSAPI sub-request. It is useful for including CGI scripts or
68266 * .shtml files, or anything else that you'd parse through webserver.
68267 *
68268 * To run the sub-request, all buffers are terminated and flushed to the
68269 * browser, pending headers are sent too.
68270 *
68271 * You cannot make recursive requests with this function to other PHP
68272 * scripts. If you want to include PHP scripts, use {@link include} or
68273 * {@link require}.
68274 *
68275 * @param string $uri The URI of the script.
68276 * @return bool
68277 * @since PHP 4 >= 4.3.3, PHP 5, PHP 7
68278 **/
68279function nsapi_virtual($uri){}
68280
68281/**
68282 * Format a number with grouped thousands
68283 *
68284 * This function accepts either one, two, or four parameters (not three):
68285 *
68286 * If only one parameter is given, {@link number} will be formatted
68287 * without decimals, but with a comma (",") between every group of
68288 * thousands.
68289 *
68290 * If two parameters are given, {@link number} will be formatted with
68291 * {@link decimals} decimals with a dot (".") in front, and a comma (",")
68292 * between every group of thousands.
68293 *
68294 * If all four parameters are given, {@link number} will be formatted
68295 * with {@link decimals} decimals, {@link dec_point} instead of a dot
68296 * (".") before the decimals and {@link thousands_sep} instead of a comma
68297 * (",") between every group of thousands.
68298 *
68299 * @param float $number The number being formatted.
68300 * @param int $decimals Sets the number of decimal points.
68301 * @return string A formatted version of {@link number}.
68302 * @since PHP 4, PHP 5, PHP 7
68303 **/
68304function number_format($number, $decimals){}
68305
68306/**
68307 * Create a number formatter
68308 *
68309 * (method)
68310 *
68311 * (constructor):
68312 *
68313 * Creates a number formatter.
68314 *
68315 * @param string $locale Locale in which the number would be formatted
68316 *   (locale name, e.g. en_CA).
68317 * @param int $style Style of the formatting, one of the format style
68318 *   constants. If NumberFormatter::PATTERN_DECIMAL or
68319 *   NumberFormatter::PATTERN_RULEBASED is passed then the number format
68320 *   is opened using the given pattern, which must conform to the syntax
68321 *   described in ICU DecimalFormat documentation or ICU
68322 *   RuleBasedNumberFormat documentation, respectively.
68323 * @param string $pattern Pattern string if the chosen style requires a
68324 *   pattern.
68325 * @return NumberFormatter Returns NumberFormatter object or FALSE on
68326 *   error.
68327 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
68328 **/
68329function numfmt_create($locale, $style, $pattern){}
68330
68331/**
68332 * Format a number
68333 *
68334 * Format a numeric value according to the formatter rules.
68335 *
68336 * @param NumberFormatter $fmt NumberFormatter object.
68337 * @param number $value The value to format. Can be integer or float,
68338 *   other values will be converted to a numeric value.
68339 * @param int $type The formatting type to use.
68340 * @return string Returns the string containing formatted value, or
68341 *   FALSE on error.
68342 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
68343 **/
68344function numfmt_format($fmt, $value, $type){}
68345
68346/**
68347 * Format a currency value
68348 *
68349 * Format the currency value according to the formatter rules.
68350 *
68351 * @param NumberFormatter $fmt NumberFormatter object.
68352 * @param float $value The numeric currency value.
68353 * @param string $currency The 3-letter ISO 4217 currency code
68354 *   indicating the currency to use.
68355 * @return string String representing the formatted currency value, .
68356 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
68357 **/
68358function numfmt_format_currency($fmt, $value, $currency){}
68359
68360/**
68361 * Get an attribute
68362 *
68363 * Get a numeric attribute associated with the formatter. An example of a
68364 * numeric attribute is the number of integer digits the formatter will
68365 * produce.
68366 *
68367 * @param NumberFormatter $fmt NumberFormatter object.
68368 * @param int $attr Attribute specifier - one of the numeric attribute
68369 *   constants.
68370 * @return int Return attribute value on success, or FALSE on error.
68371 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
68372 **/
68373function numfmt_get_attribute($fmt, $attr){}
68374
68375/**
68376 * Get formatter's last error code
68377 *
68378 * Get error code from the last function performed by the formatter.
68379 *
68380 * @param NumberFormatter $fmt NumberFormatter object.
68381 * @return int Returns error code from last formatter call.
68382 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
68383 **/
68384function numfmt_get_error_code($fmt){}
68385
68386/**
68387 * Get formatter's last error message
68388 *
68389 * Get error message from the last function performed by the formatter.
68390 *
68391 * @param NumberFormatter $fmt NumberFormatter object.
68392 * @return string Returns error message from last formatter call.
68393 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
68394 **/
68395function numfmt_get_error_message($fmt){}
68396
68397/**
68398 * Get formatter locale
68399 *
68400 * Get formatter locale name.
68401 *
68402 * @param NumberFormatter $fmt NumberFormatter object.
68403 * @param int $type You can choose between valid and actual locale (
68404 *   Locale::VALID_LOCALE, Locale::ACTUAL_LOCALE, respectively). The
68405 *   default is the actual locale.
68406 * @return string The locale name used to create the formatter.
68407 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
68408 **/
68409function numfmt_get_locale($fmt, $type){}
68410
68411/**
68412 * Get formatter pattern
68413 *
68414 * Extract pattern used by the formatter.
68415 *
68416 * @param NumberFormatter $fmt NumberFormatter object.
68417 * @return string Pattern string that is used by the formatter, or
68418 *   FALSE if an error happens.
68419 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
68420 **/
68421function numfmt_get_pattern($fmt){}
68422
68423/**
68424 * Get a symbol value
68425 *
68426 * Get a symbol associated with the formatter. The formatter uses symbols
68427 * to represent the special locale-dependent characters in a number, for
68428 * example the percent sign. This API is not supported for rule-based
68429 * formatters.
68430 *
68431 * @param NumberFormatter $fmt NumberFormatter object.
68432 * @param int $attr Symbol specifier, one of the format symbol
68433 *   constants.
68434 * @return string The symbol string or FALSE on error.
68435 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
68436 **/
68437function numfmt_get_symbol($fmt, $attr){}
68438
68439/**
68440 * Get a text attribute
68441 *
68442 * Get a text attribute associated with the formatter. An example of a
68443 * text attribute is the suffix for positive numbers. If the formatter
68444 * does not understand the attribute, U_UNSUPPORTED_ERROR error is
68445 * produced. Rule-based formatters only understand
68446 * NumberFormatter::DEFAULT_RULESET and NumberFormatter::PUBLIC_RULESETS.
68447 *
68448 * @param NumberFormatter $fmt NumberFormatter object.
68449 * @param int $attr Attribute specifier - one of the text attribute
68450 *   constants.
68451 * @return string Return attribute value on success, or FALSE on error.
68452 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
68453 **/
68454function numfmt_get_text_attribute($fmt, $attr){}
68455
68456/**
68457 * Parse a number
68458 *
68459 * Parse a string into a number using the current formatter rules.
68460 *
68461 * @param NumberFormatter $fmt NumberFormatter object.
68462 * @param string $value The formatting type to use. By default,
68463 *   NumberFormatter::TYPE_DOUBLE is used.
68464 * @param int $type Offset in the string at which to begin parsing. On
68465 *   return, this value will hold the offset at which parsing ended.
68466 * @param int $position
68467 * @return mixed The value of the parsed number or FALSE on error.
68468 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
68469 **/
68470function numfmt_parse($fmt, $value, $type, &$position){}
68471
68472/**
68473 * Parse a currency number
68474 *
68475 * Parse a string into a double and a currency using the current
68476 * formatter.
68477 *
68478 * @param NumberFormatter $fmt NumberFormatter object.
68479 * @param string $value Parameter to receive the currency name
68480 *   (3-letter ISO 4217 currency code).
68481 * @param string $currency Offset in the string at which to begin
68482 *   parsing. On return, this value will hold the offset at which parsing
68483 *   ended.
68484 * @param int $position
68485 * @return float The parsed numeric value or FALSE on error.
68486 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
68487 **/
68488function numfmt_parse_currency($fmt, $value, &$currency, &$position){}
68489
68490/**
68491 * Set an attribute
68492 *
68493 * Set a numeric attribute associated with the formatter. An example of a
68494 * numeric attribute is the number of integer digits the formatter will
68495 * produce.
68496 *
68497 * @param NumberFormatter $fmt NumberFormatter object.
68498 * @param int $attr Attribute specifier - one of the numeric attribute
68499 *   constants.
68500 * @param int $value The attribute value.
68501 * @return bool
68502 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
68503 **/
68504function numfmt_set_attribute($fmt, $attr, $value){}
68505
68506/**
68507 * Set formatter pattern
68508 *
68509 * Set the pattern used by the formatter. Can not be used on a rule-based
68510 * formatter.
68511 *
68512 * @param NumberFormatter $fmt NumberFormatter object.
68513 * @param string $pattern Pattern in syntax described in ICU
68514 *   DecimalFormat documentation.
68515 * @return bool
68516 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
68517 **/
68518function numfmt_set_pattern($fmt, $pattern){}
68519
68520/**
68521 * Set a symbol value
68522 *
68523 * Set a symbol associated with the formatter. The formatter uses symbols
68524 * to represent the special locale-dependent characters in a number, for
68525 * example the percent sign. This API is not supported for rule-based
68526 * formatters.
68527 *
68528 * @param NumberFormatter $fmt NumberFormatter object.
68529 * @param int $attr Symbol specifier, one of the format symbol
68530 *   constants.
68531 * @param string $value Text for the symbol.
68532 * @return bool
68533 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
68534 **/
68535function numfmt_set_symbol($fmt, $attr, $value){}
68536
68537/**
68538 * Set a text attribute
68539 *
68540 * Set a text attribute associated with the formatter. An example of a
68541 * text attribute is the suffix for positive numbers. If the formatter
68542 * does not understand the attribute, U_UNSUPPORTED_ERROR error is
68543 * produced. Rule-based formatters only understand
68544 * NumberFormatter::DEFAULT_RULESET and NumberFormatter::PUBLIC_RULESETS.
68545 *
68546 * @param NumberFormatter $fmt NumberFormatter object.
68547 * @param int $attr Attribute specifier - one of the text attribute
68548 *   constants.
68549 * @param string $value Text for the attribute value.
68550 * @return bool
68551 * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
68552 **/
68553function numfmt_set_text_attribute($fmt, $attr, $value){}
68554
68555/**
68556 * Generate a Signature Base String
68557 *
68558 * Generates a Signature Base String according to pecl/oauth.
68559 *
68560 * @param string $http_method The HTTP method.
68561 * @param string $uri URI to encode.
68562 * @param array $request_parameters Array of request parameters.
68563 * @return string Returns a Signature Base String.
68564 * @since PECL OAuth >=0.99.7
68565 **/
68566function oauth_get_sbs($http_method, $uri, $request_parameters){}
68567
68568/**
68569 * Encode a URI to RFC 3986
68570 *
68571 * Encodes a URI to RFC 3986.
68572 *
68573 * @param string $uri URI to encode.
68574 * @return string Returns an RFC 3986 encoded string.
68575 * @since PECL OAuth >=0.99.2
68576 **/
68577function oauth_urlencode($uri){}
68578
68579/**
68580 * Clean (erase) the output buffer
68581 *
68582 * This function discards the contents of the output buffer.
68583 *
68584 * This function does not destroy the output buffer like {@link
68585 * ob_end_clean} does.
68586 *
68587 * The output buffer must be started by {@link ob_start} with
68588 * PHP_OUTPUT_HANDLER_CLEANABLE flag. Otherwise {@link ob_clean} will not
68589 * work.
68590 *
68591 * @return void
68592 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
68593 **/
68594function ob_clean(){}
68595
68596/**
68597 * Clean (erase) the output buffer and turn off output buffering
68598 *
68599 * This function discards the contents of the topmost output buffer and
68600 * turns off this output buffering. If you want to further process the
68601 * buffer's contents you have to call {@link ob_get_contents} before
68602 * {@link ob_end_clean} as the buffer contents are discarded when {@link
68603 * ob_end_clean} is called.
68604 *
68605 * The output buffer must be started by {@link ob_start} with
68606 * PHP_OUTPUT_HANDLER_CLEANABLE and PHP_OUTPUT_HANDLER_REMOVABLE flags.
68607 * Otherwise {@link ob_end_clean} will not work.
68608 *
68609 * @return bool Reasons for failure are first that you called the
68610 *   function without an active buffer or that for some reason a buffer
68611 *   could not be deleted (possible for special buffer).
68612 * @since PHP 4, PHP 5, PHP 7
68613 **/
68614function ob_end_clean(){}
68615
68616/**
68617 * Flush (send) the output buffer and turn off output buffering
68618 *
68619 * This function will send the contents of the topmost output buffer (if
68620 * any) and turn this output buffer off. If you want to further process
68621 * the buffer's contents you have to call {@link ob_get_contents} before
68622 * {@link ob_end_flush} as the buffer contents are discarded after {@link
68623 * ob_end_flush} is called.
68624 *
68625 * The output buffer must be started by {@link ob_start} with
68626 * PHP_OUTPUT_HANDLER_FLUSHABLE and PHP_OUTPUT_HANDLER_REMOVABLE flags.
68627 * Otherwise {@link ob_end_flush} will not work.
68628 *
68629 * @return bool Reasons for failure are first that you called the
68630 *   function without an active buffer or that for some reason a buffer
68631 *   could not be deleted (possible for special buffer).
68632 * @since PHP 4, PHP 5, PHP 7
68633 **/
68634function ob_end_flush(){}
68635
68636/**
68637 * Flush (send) the output buffer
68638 *
68639 * This function will send the contents of the output buffer (if any). If
68640 * you want to further process the buffer's contents you have to call
68641 * {@link ob_get_contents} before {@link ob_flush} as the buffer contents
68642 * are discarded after {@link ob_flush} is called.
68643 *
68644 * This function does not destroy the output buffer like {@link
68645 * ob_end_flush} does.
68646 *
68647 * @return void
68648 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
68649 **/
68650function ob_flush(){}
68651
68652/**
68653 * Get current buffer contents and delete current output buffer
68654 *
68655 * Gets the current buffer contents and delete current output buffer.
68656 *
68657 * {@link ob_get_clean} essentially executes both {@link ob_get_contents}
68658 * and {@link ob_end_clean}.
68659 *
68660 * The output buffer must be started by {@link ob_start} with
68661 * PHP_OUTPUT_HANDLER_CLEANABLE and PHP_OUTPUT_HANDLER_REMOVABLE flags.
68662 * Otherwise {@link ob_get_clean} will not work.
68663 *
68664 * @return string Returns the contents of the output buffer and end
68665 *   output buffering. If output buffering isn't active then FALSE is
68666 *   returned.
68667 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
68668 **/
68669function ob_get_clean(){}
68670
68671/**
68672 * Return the contents of the output buffer
68673 *
68674 * Gets the contents of the output buffer without clearing it.
68675 *
68676 * @return string This will return the contents of the output buffer or
68677 *   FALSE, if output buffering isn't active.
68678 * @since PHP 4, PHP 5, PHP 7
68679 **/
68680function ob_get_contents(){}
68681
68682/**
68683 * Flush the output buffer, return it as a string and turn off output
68684 * buffering
68685 *
68686 * {@link ob_get_flush} flushes the output buffer, return it as a string
68687 * and turns off output buffering.
68688 *
68689 * The output buffer must be started by {@link ob_start} with
68690 * PHP_OUTPUT_HANDLER_FLUSHABLE flag. Otherwise {@link ob_get_flush} will
68691 * not work.
68692 *
68693 * @return string Returns the output buffer or FALSE if no buffering is
68694 *   active.
68695 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
68696 **/
68697function ob_get_flush(){}
68698
68699/**
68700 * Return the length of the output buffer
68701 *
68702 * This will return the length of the contents in the output buffer, in
68703 * bytes.
68704 *
68705 * @return int Returns the length of the output buffer contents, in
68706 *   bytes, or FALSE if no buffering is active.
68707 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
68708 **/
68709function ob_get_length(){}
68710
68711/**
68712 * Return the nesting level of the output buffering mechanism
68713 *
68714 * Returns the nesting level of the output buffering mechanism.
68715 *
68716 * @return int Returns the level of nested output buffering handlers or
68717 *   zero if output buffering is not active.
68718 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
68719 **/
68720function ob_get_level(){}
68721
68722/**
68723 * Get status of output buffers
68724 *
68725 * {@link ob_get_status} returns status information on either the top
68726 * level output buffer or all active output buffer levels if {@link
68727 * full_status} is set to TRUE.
68728 *
68729 * @param bool $full_status TRUE to return all active output buffer
68730 *   levels. If FALSE or not set, only the top level output buffer is
68731 *   returned.
68732 * @return array If called without the {@link full_status} parameter or
68733 *   with {@link full_status} = FALSE a simple array with the following
68734 *   elements is returned:
68735 *
68736 *   Array ( [level] => 2 [type] => 0 [status] => 0 [name] =>
68737 *   URL-Rewriter [del] => 1 )
68738 *
68739 *   Simple {@link ob_get_status} results KeyValue levelOutput nesting
68740 *   level typePHP_OUTPUT_HANDLER_INTERNAL (0) or PHP_OUTPUT_HANDLER_USER
68741 *   (1) statusOne of PHP_OUTPUT_HANDLER_START (0),
68742 *   PHP_OUTPUT_HANDLER_CONT (1) or PHP_OUTPUT_HANDLER_END (2) nameName
68743 *   of active output handler or ' default output handler' if none is set
68744 *   delErase-flag as set by {@link ob_start}
68745 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
68746 **/
68747function ob_get_status($full_status){}
68748
68749/**
68750 * ob_start callback function to gzip output buffer
68751 *
68752 * {@link ob_gzhandler} is intended to be used as a callback function for
68753 * {@link ob_start} to help facilitate sending gz-encoded data to web
68754 * browsers that support compressed web pages. Before {@link
68755 * ob_gzhandler} actually sends compressed data, it determines what type
68756 * of content encoding the browser will accept ("gzip", "deflate" or none
68757 * at all) and will return its output accordingly. All browsers are
68758 * supported since it's up to the browser to send the correct header
68759 * saying that it accepts compressed web pages. If a browser doesn't
68760 * support compressed pages this function returns FALSE.
68761 *
68762 * @param string $buffer
68763 * @param int $mode
68764 * @return string
68765 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
68766 **/
68767function ob_gzhandler($buffer, $mode){}
68768
68769/**
68770 * Convert character encoding as output buffer handler
68771 *
68772 * Converts the string encoded in {@link internal_encoding} to {@link
68773 * output_encoding}.
68774 *
68775 * {@link internal_encoding} and {@link output_encoding} should be
68776 * defined in the file or in {@link iconv_set_encoding}.
68777 *
68778 * @param string $contents
68779 * @param int $status
68780 * @return string See {@link ob_start} for information about this
68781 *   handler return values.
68782 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
68783 **/
68784function ob_iconv_handler($contents, $status){}
68785
68786/**
68787 * Turn implicit flush on/off
68788 *
68789 * {@link ob_implicit_flush} will turn implicit flushing on or off.
68790 * Implicit flushing will result in a flush operation after every output
68791 * call, so that explicit calls to {@link flush} will no longer be
68792 * needed.
68793 *
68794 * @param int $flag 1 to turn implicit flushing on, 0 otherwise.
68795 * @return void
68796 * @since PHP 4, PHP 5, PHP 7
68797 **/
68798function ob_implicit_flush($flag){}
68799
68800/**
68801 * List all output handlers in use
68802 *
68803 * Lists all output handlers in use.
68804 *
68805 * @return array This will return an array with the output handlers in
68806 *   use (if any). If output_buffering is enabled or an anonymous
68807 *   function was used with {@link ob_start}, {@link ob_list_handlers}
68808 *   will return "default output handler".
68809 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
68810 **/
68811function ob_list_handlers(){}
68812
68813/**
68814 * Turn on output buffering
68815 *
68816 * This function will turn output buffering on. While output buffering is
68817 * active no output is sent from the script (other than headers), instead
68818 * the output is stored in an internal buffer.
68819 *
68820 * The contents of this internal buffer may be copied into a string
68821 * variable using {@link ob_get_contents}. To output what is stored in
68822 * the internal buffer, use {@link ob_end_flush}. Alternatively, {@link
68823 * ob_end_clean} will silently discard the buffer contents.
68824 *
68825 * Output buffers are stackable, that is, you may call {@link ob_start}
68826 * while another {@link ob_start} is active. Just make sure that you call
68827 * {@link ob_end_flush} the appropriate number of times. If multiple
68828 * output callback functions are active, output is being filtered
68829 * sequentially through each of them in nesting order.
68830 *
68831 * @param callable $output_callback An optional {@link output_callback}
68832 *   function may be specified. This function takes a string as a
68833 *   parameter and should return a string. The function will be called
68834 *   when the output buffer is flushed (sent) or cleaned (with {@link
68835 *   ob_flush}, {@link ob_clean} or similar function) or when the output
68836 *   buffer is flushed to the browser at the end of the request. When
68837 *   {@link output_callback} is called, it will receive the contents of
68838 *   the output buffer as its parameter and is expected to return a new
68839 *   output buffer as a result, which will be sent to the browser. If the
68840 *   {@link output_callback} is not a callable function, this function
68841 *   will return FALSE. This is the callback signature:
68842 *
68843 *   stringhandler string{@link buffer} int{@link phase} {@link buffer}
68844 *   Contents of the output buffer. {@link phase} Bitmask of
68845 *   PHP_OUTPUT_HANDLER_* constants. If {@link output_callback} returns
68846 *   FALSE original input is sent to the browser. The {@link
68847 *   output_callback} parameter may be bypassed by passing a NULL value.
68848 *   {@link ob_end_clean}, {@link ob_end_flush}, {@link ob_clean}, {@link
68849 *   ob_flush} and {@link ob_start} may not be called from a callback
68850 *   function. If you call them from callback function, the behavior is
68851 *   undefined. If you would like to delete the contents of a buffer,
68852 *   return "" (a null string) from callback function. You can't even
68853 *   call functions using the output buffering functions like
68854 *   print_r($expression, true) or highlight_file($filename, true) from a
68855 *   callback function.
68856 * @param int $chunk_size
68857 * @param int $flags
68858 * @return bool
68859 * @since PHP 4, PHP 5, PHP 7
68860 **/
68861function ob_start($output_callback, $chunk_size, $flags){}
68862
68863/**
68864 * ob_start callback function to repair the buffer
68865 *
68866 * Callback function for {@link ob_start} to repair the buffer.
68867 *
68868 * @param string $input The buffer.
68869 * @param int $mode The buffer mode.
68870 * @return string Returns the modified buffer.
68871 * @since PHP 5, PHP 7
68872 **/
68873function ob_tidyhandler($input, $mode){}
68874
68875/**
68876 * Binds a PHP array to an Oracle PL/SQL array parameter
68877 *
68878 * Binds the PHP array {@link var_array} to the Oracle placeholder {@link
68879 * name}, which points to an Oracle PL/SQL array. Whether it will be used
68880 * for input or output will be determined at run-time.
68881 *
68882 * @param resource $statement A valid OCI statement identifier.
68883 * @param string $name The Oracle placeholder.
68884 * @param array $var_array An array.
68885 * @param int $max_table_length Sets the maximum length both for
68886 *   incoming and result arrays.
68887 * @param int $max_item_length Sets maximum length for array items. If
68888 *   not specified or equals to -1, {@link oci_bind_array_by_name} will
68889 *   find the longest element in the incoming array and will use it as
68890 *   the maximum length.
68891 * @param int $type Should be used to set the type of PL/SQL array
68892 *   items. See list of available types below:
68893 *
68894 *   SQLT_NUM - for arrays of NUMBER. SQLT_INT - for arrays of INTEGER
68895 *   (Note: INTEGER it is actually a synonym for NUMBER(38), but SQLT_NUM
68896 *   type won't work in this case even though they are synonyms).
68897 *   SQLT_FLT - for arrays of FLOAT. SQLT_AFC - for arrays of CHAR.
68898 *   SQLT_CHR - for arrays of VARCHAR2. SQLT_VCS - for arrays of VARCHAR.
68899 *   SQLT_AVC - for arrays of CHARZ. SQLT_STR - for arrays of STRING.
68900 *   SQLT_LVC - for arrays of LONG VARCHAR. SQLT_ODT - for arrays of
68901 *   DATE.
68902 * @return bool
68903 * @since PHP 5 >= 5.1.2, PHP 7, PECL OCI8 >= 1.2.0
68904 **/
68905function oci_bind_array_by_name($statement, $name, &$var_array, $max_table_length, $max_item_length, $type){}
68906
68907/**
68908 * Binds a PHP variable to an Oracle placeholder
68909 *
68910 * Binds a PHP variable {@link variable} to the Oracle bind variable
68911 * placeholder {@link bv_name}. Binding is important for Oracle database
68912 * performance and also as a way to avoid SQL Injection security issues.
68913 *
68914 * Binding allows the database to reuse the statement context and caches
68915 * from previous executions of the statement, even if another user or
68916 * process originally executed it. Binding reduces SQL Injection concerns
68917 * because the data associated with a bind variable is never treated as
68918 * part of the SQL statement. It does not need quoting or escaping.
68919 *
68920 * PHP variables that have been bound can be changed and the statement
68921 * re-executed without needing to re-parse the statement or re-bind.
68922 *
68923 * In Oracle, bind variables are commonly divided into IN binds for
68924 * values that are passed into the database, and OUT binds for values
68925 * that are returned to PHP. A bind variable may be both IN and OUT.
68926 * Whether a bind variable will be used for input or output is determined
68927 * at run-time.
68928 *
68929 * You must specify {@link maxlength} when using an OUT bind so that PHP
68930 * allocates enough memory to hold the returned value.
68931 *
68932 * For IN binds it is recommended to set the {@link maxlength} length if
68933 * the statement is re-executed multiple times with different values for
68934 * the PHP variable. Otherwise Oracle may truncate data to the length of
68935 * the initial PHP variable value. If you don't know what the maximum
68936 * length will be, then re-call {@link oci_bind_by_name} with the current
68937 * data size prior to each {@link oci_execute} call. Binding an
68938 * unnecessarily large length will have an impact on process memory in
68939 * the database.
68940 *
68941 * A bind call tells Oracle which memory address to read data from. For
68942 * IN binds that address needs to contain valid data when {@link
68943 * oci_execute} is called. This means that the variable bound must remain
68944 * in scope until execution. If it doesn't, unexpected results or errors
68945 * such as "ORA-01460: unimplemented or unreasonable conversion
68946 * requested" may occur. For OUT binds one symptom is no value being set
68947 * in the PHP variable.
68948 *
68949 * For a statement that is repeatedly executed, binding values that never
68950 * change may reduce the ability of the Oracle optimizer to choose the
68951 * best statement execution plan. Long running statements that are rarely
68952 * re-executed may not benefit from binding. However in both cases,
68953 * binding might be safer than joining strings into a SQL statement, as
68954 * this can be a security risk if unfiltered user text is concatenated.
68955 *
68956 * @param resource $statement A valid OCI8 statement identifer.
68957 * @param string $bv_name The colon-prefixed bind variable placeholder
68958 *   used in the statement. The colon is optional in {@link bv_name}.
68959 *   Oracle does not use question marks for placeholders.
68960 * @param mixed $variable The PHP variable to be associated with {@link
68961 *   bv_name}
68962 * @param int $maxlength Sets the maximum length for the data. If you
68963 *   set it to -1, this function will use the current length of {@link
68964 *   variable} to set the maximum length. In this case the {@link
68965 *   variable} must exist and contain data when {@link oci_bind_by_name}
68966 *   is called.
68967 * @param int $type The datatype that Oracle will treat the data as.
68968 *   The default {@link type} used is SQLT_CHR. Oracle will convert the
68969 *   data between this type and the database column (or PL/SQL variable
68970 *   type), when possible. If you need to bind an abstract datatype
68971 *   (LOB/ROWID/BFILE) you need to allocate it first using the {@link
68972 *   oci_new_descriptor} function. The {@link length} is not used for
68973 *   abstract datatypes and should be set to -1. Possible values for
68974 *   {@link type} are: SQLT_BFILEE or OCI_B_BFILE - for BFILEs;
68975 *   SQLT_CFILEE or OCI_B_CFILEE - for CFILEs; SQLT_CLOB or OCI_B_CLOB -
68976 *   for CLOBs; SQLT_BLOB or OCI_B_BLOB - for BLOBs; SQLT_RDD or
68977 *   OCI_B_ROWID - for ROWIDs; SQLT_NTY or OCI_B_NTY - for named
68978 *   datatypes; SQLT_INT or OCI_B_INT - for integers; SQLT_CHR - for
68979 *   VARCHARs; SQLT_BIN or OCI_B_BIN - for RAW columns; SQLT_LNG - for
68980 *   LONG columns; SQLT_LBI - for LONG RAW columns; SQLT_RSET - for
68981 *   cursors created with {@link oci_new_cursor}; SQLT_BOL or OCI_B_BOL -
68982 *   for PL/SQL BOOLEANs (Requires OCI8 2.0.7 and Oracle Database 12c)
68983 * @return bool
68984 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
68985 **/
68986function oci_bind_by_name($statement, $bv_name, &$variable, $maxlength, $type){}
68987
68988/**
68989 * Cancels reading from cursor
68990 *
68991 * Invalidates a cursor, freeing all associated resources and cancels the
68992 * ability to read from it.
68993 *
68994 * @param resource $statement An OCI statement.
68995 * @return bool
68996 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
68997 **/
68998function oci_cancel($statement){}
68999
69000/**
69001 * Returns the Oracle client library version
69002 *
69003 * Returns a string containing the version number of the Oracle C client
69004 * library that PHP is linked with.
69005 *
69006 * @return string Returns the version number as a string.
69007 * @since PHP 5 >= 5.3.7, PHP 7, PECL OCI8 >= 1.4.6
69008 **/
69009function oci_client_version(){}
69010
69011/**
69012 * Closes an Oracle connection
69013 *
69014 * Unsets {@link connection}. The underlying database connection is
69015 * closed if no other resources are using it and if it was created with
69016 * {@link oci_connect} or {@link oci_new_connect}.
69017 *
69018 * It is recommended to close connections that are no longer needed
69019 * because this makes database resources available for other users.
69020 *
69021 * @param resource $connection An Oracle connection identifier returned
69022 *   by {@link oci_connect}, {@link oci_pconnect}, or {@link
69023 *   oci_new_connect}.
69024 * @return bool
69025 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69026 **/
69027function oci_close($connection){}
69028
69029/**
69030 * Commits the outstanding database transaction
69031 *
69032 * Commits the outstanding transaction for the Oracle {@link connection}.
69033 * A commit ends the current transaction and makes permanent all changes.
69034 * It releases all locks held.
69035 *
69036 * A transaction begins when the first SQL statement that changes data is
69037 * executed with {@link oci_execute} using the OCI_NO_AUTO_COMMIT flag.
69038 * Further data changes made by other statements become part of the same
69039 * transaction. Data changes made in a transaction are temporary until
69040 * the transaction is committed or rolled back. Other users of the
69041 * database will not see the changes until they are committed.
69042 *
69043 * When inserting or updating data, using transactions is recommended for
69044 * relational data consistency and for performance reasons.
69045 *
69046 * @param resource $connection An Oracle connection identifier,
69047 *   returned by {@link oci_connect}, {@link oci_pconnect}, or {@link
69048 *   oci_new_connect}.
69049 * @return bool
69050 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69051 **/
69052function oci_commit($connection){}
69053
69054/**
69055 * Connect to an Oracle database
69056 *
69057 * Returns a connection identifier needed for most other OCI8 operations.
69058 *
69059 * See Connection Handling for general information on connection
69060 * management and connection pooling.
69061 *
69062 * From PHP 5.1.2 (PECL OCI8 1.1) {@link oci_close} can be used to close
69063 * the connection.
69064 *
69065 * The second and subsequent calls to {@link oci_connect} with the same
69066 * parameters will return the connection handle returned from the first
69067 * call. This means that transactions in one handle are also in the other
69068 * handles, because they use the same underlying database connection. If
69069 * two handles need to be transactionally isolated from each other, use
69070 * {@link oci_new_connect} instead.
69071 *
69072 * @param string $username The Oracle user name.
69073 * @param string $password The password for {@link username}.
69074 * @param string $connection_string
69075 * @param string $character_set
69076 * @param int $session_mode
69077 * @return resource Returns a connection identifier or FALSE on error.
69078 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69079 **/
69080function oci_connect($username, $password, $connection_string, $character_set, $session_mode){}
69081
69082/**
69083 * Associates a PHP variable with a column for query fetches
69084 *
69085 * Associates a PHP variable with a column for query fetches using {@link
69086 * oci_fetch}.
69087 *
69088 * The {@link oci_define_by_name} call must occur before executing {@link
69089 * oci_execute}.
69090 *
69091 * @param resource $statement
69092 * @param string $column_name The column name used in the query. Use
69093 *   uppercase for Oracle's default, non-case sensitive column names. Use
69094 *   the exact column name case for case-sensitive column names.
69095 * @param mixed $variable The PHP variable that will contain the
69096 *   returned column value.
69097 * @param int $type The data type to be returned. Generally not needed.
69098 *   Note that Oracle-style data conversions are not performed. For
69099 *   example, SQLT_INT will be ignored and the returned data type will
69100 *   still be SQLT_CHR. You can optionally use {@link oci_new_descriptor}
69101 *   to allocate LOB/ROWID/BFILE descriptors.
69102 * @return bool
69103 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69104 **/
69105function oci_define_by_name($statement, $column_name, &$variable, $type){}
69106
69107/**
69108 * Returns the last error found
69109 *
69110 * The function should be called immediately after an error occurs.
69111 * Errors are cleared by a successful statement.
69112 *
69113 * @param resource $resource For most errors, {@link resource} is the
69114 *   resource handle that was passed to the failing function call. For
69115 *   connection errors with {@link oci_connect}, {@link oci_new_connect}
69116 *   or {@link oci_pconnect} do not pass {@link resource}.
69117 * @return array If no error is found, {@link oci_error} returns FALSE.
69118 *   Otherwise, {@link oci_error} returns the error information as an
69119 *   associative array.
69120 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69121 **/
69122function oci_error($resource){}
69123
69124/**
69125 * Executes a statement
69126 *
69127 * Executes a {@link statement} previously returned from {@link
69128 * oci_parse}.
69129 *
69130 * After execution, statements like INSERT will have data committed to
69131 * the database by default. For statements like SELECT, execution
69132 * performs the logic of the query. Query results can subsequently be
69133 * fetched in PHP with functions like {@link oci_fetch_array}.
69134 *
69135 * Each parsed statement may be executed multiple times, saving the cost
69136 * of re-parsing. This is commonly used for INSERT statements when data
69137 * is bound with {@link oci_bind_by_name}.
69138 *
69139 * @param resource $statement A valid OCI statement identifier.
69140 * @param int $mode An optional second parameter can be one of the
69141 *   following constants: Execution Modes Constant Description
69142 *   OCI_COMMIT_ON_SUCCESS Automatically commit all outstanding changes
69143 *   for this connection when the statement has succeeded. This is the
69144 *   default. OCI_DESCRIBE_ONLY Make query meta data available to
69145 *   functions like {@link oci_field_name} but do not create a result
69146 *   set. Any subsequent fetch call such as {@link oci_fetch_array} will
69147 *   fail. OCI_NO_AUTO_COMMIT Do not automatically commit changes. Prior
69148 *   to PHP 5.3.2 (PECL OCI8 1.4) use OCI_DEFAULT which is equivalent to
69149 *   OCI_NO_AUTO_COMMIT. Using OCI_NO_AUTO_COMMIT mode starts or
69150 *   continues a transaction. Transactions are automatically rolled back
69151 *   when the connection is closed, or when the script ends. Explicitly
69152 *   call {@link oci_commit} to commit a transaction, or {@link
69153 *   oci_rollback} to abort it. When inserting or updating data, using
69154 *   transactions is recommended for relational data consistency and for
69155 *   performance reasons. If OCI_NO_AUTO_COMMIT mode is used for any
69156 *   statement including queries, and {@link oci_commit} or {@link
69157 *   oci_rollback} is not subsequently called, then OCI8 will perform a
69158 *   rollback at the end of the script even if no data was changed. To
69159 *   avoid an unnecessary rollback, many scripts do not use
69160 *   OCI_NO_AUTO_COMMIT mode for queries or PL/SQL. Be careful to ensure
69161 *   the appropriate transactional consistency for the application when
69162 *   using {@link oci_execute} with different modes in the same script.
69163 * @return bool
69164 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69165 **/
69166function oci_execute($statement, $mode){}
69167
69168/**
69169 * Fetches the next row from a query into internal buffers
69170 *
69171 * Fetches the next row from a query into internal buffers accessible
69172 * either with {@link oci_result}, or by using variables previously
69173 * defined with {@link oci_define_by_name}.
69174 *
69175 * See {@link oci_fetch_array} for general information about fetching
69176 * data.
69177 *
69178 * @param resource $statement
69179 * @return bool Returns TRUE on success or FALSE if there are no more
69180 *   rows in the {@link statement}.
69181 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69182 **/
69183function oci_fetch($statement){}
69184
69185/**
69186 * Fetches multiple rows from a query into a two-dimensional array
69187 *
69188 * Fetches multiple rows from a query into a two-dimensional array. By
69189 * default, all rows are returned.
69190 *
69191 * This function can be called only once for each query executed with
69192 * {@link oci_execute}.
69193 *
69194 * @param resource $statement
69195 * @param array $output The variable to contain the returned rows. LOB
69196 *   columns are returned as strings, where Oracle supports conversion.
69197 *   See {@link oci_fetch_array} for more information on how data and
69198 *   types are fetched.
69199 * @param int $skip The number of initial rows to discard when fetching
69200 *   the result. The default value is 0, so the first row onwards is
69201 *   returned.
69202 * @param int $maxrows The number of rows to return. The default is -1
69203 *   meaning return all the rows from {@link skip} + 1 onwards.
69204 * @param int $flags Parameter {@link flags} indicates the array
69205 *   structure and whether associative arrays should be used. {@link
69206 *   oci_fetch_all} Array Structure Modes Constant Description
69207 *   OCI_FETCHSTATEMENT_BY_ROW The outer array will contain one sub-array
69208 *   per query row. OCI_FETCHSTATEMENT_BY_COLUMN The outer array will
69209 *   contain one sub-array per query column. This is the default. Arrays
69210 *   can be indexed either by column heading or numerically. Only one
69211 *   index mode will be returned. {@link oci_fetch_all} Array Index Modes
69212 *   Constant Description OCI_NUM Numeric indexes are used for each
69213 *   column's array. OCI_ASSOC Associative indexes are used for each
69214 *   column's array. This is the default. Use the addition operator + to
69215 *   choose a combination of array structure and index modes. Oracle's
69216 *   default, non-case sensitive column names will have uppercase array
69217 *   keys. Case-sensitive column names will have array keys using the
69218 *   exact column case. Use {@link var_dump} on {@link output} to verify
69219 *   the appropriate case to use for each query. Queries that have more
69220 *   than one column with the same name should use column aliases.
69221 *   Otherwise only one of the columns will appear in an associative
69222 *   array.
69223 * @return int Returns the number of rows in {@link output}, which may
69224 *   be 0 or more, .
69225 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69226 **/
69227function oci_fetch_all($statement, &$output, $skip, $maxrows, $flags){}
69228
69229/**
69230 * Returns the next row from a query as an associative or numeric array
69231 *
69232 * Returns an array containing the next result-set row of a query. Each
69233 * array entry corresponds to a column of the row. This function is
69234 * typically called in a loop until it returns FALSE, indicating no more
69235 * rows exist.
69236 *
69237 * If {@link statement} corresponds to a PL/SQL block returning Oracle
69238 * Database 12c Implicit Result Sets, then rows from all sets are
69239 * consecutively fetched. If {@link statement} is returned by {@link
69240 * oci_get_implicit_resultset}, then only the subset of rows for one
69241 * child query are returned.
69242 *
69243 * @param resource $statement Can also be a statement identifier
69244 *   returned by {@link oci_get_implicit_resultset}.
69245 * @param int $mode An optional second parameter can be any combination
69246 *   of the following constants: {@link oci_fetch_array} Modes Constant
69247 *   Description OCI_BOTH Returns an array with both associative and
69248 *   numeric indices. This is the same as OCI_ASSOC + OCI_NUM and is the
69249 *   default behavior. OCI_ASSOC Returns an associative array. OCI_NUM
69250 *   Returns a numeric array. OCI_RETURN_NULLS Creates elements for NULL
69251 *   fields. The element values will be a PHP NULL. OCI_RETURN_LOBS
69252 *   Returns the contents of LOBs instead of the LOB descriptors. The
69253 *   default {@link mode} is OCI_BOTH. Use the addition operator + to
69254 *   specify more than one mode at a time.
69255 * @return array Returns an array with associative and/or numeric
69256 *   indices. If there are no more rows in the {@link statement} then
69257 *   FALSE is returned.
69258 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69259 **/
69260function oci_fetch_array($statement, $mode){}
69261
69262/**
69263 * Returns the next row from a query as an associative array
69264 *
69265 * Returns an associative array containing the next result-set row of a
69266 * query. Each array entry corresponds to a column of the row. This
69267 * function is typically called in a loop until it returns FALSE,
69268 * indicating no more rows exist.
69269 *
69270 * Calling {@link oci_fetch_assoc} is identical to calling {@link
69271 * oci_fetch_array} with OCI_ASSOC + OCI_RETURN_NULLS.
69272 *
69273 * @param resource $statement
69274 * @return array Returns an associative array. If there are no more
69275 *   rows in the {@link statement} then FALSE is returned.
69276 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69277 **/
69278function oci_fetch_assoc($statement){}
69279
69280/**
69281 * Returns the next row from a query as an object
69282 *
69283 * Returns an object containing the next result-set row of a query. Each
69284 * attribute of the object corresponds to a column of the row. This
69285 * function is typically called in a loop until it returns FALSE,
69286 * indicating no more rows exist.
69287 *
69288 * @param resource $statement
69289 * @return object Returns an object. Each attribute of the object
69290 *   corresponds to a column of the row. If there are no more rows in the
69291 *   {@link statement} then FALSE is returned.
69292 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69293 **/
69294function oci_fetch_object($statement){}
69295
69296/**
69297 * Returns the next row from a query as a numeric array
69298 *
69299 * Returns a numerically indexed array containing the next result-set row
69300 * of a query. Each array entry corresponds to a column of the row. This
69301 * function is typically called in a loop until it returns FALSE,
69302 * indicating no more rows exist.
69303 *
69304 * Calling {@link oci_fetch_row} is identical to calling {@link
69305 * oci_fetch_array} with OCI_NUM + OCI_RETURN_NULLS.
69306 *
69307 * @param resource $statement
69308 * @return array Returns a numerically indexed array. If there are no
69309 *   more rows in the {@link statement} then FALSE is returned.
69310 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69311 **/
69312function oci_fetch_row($statement){}
69313
69314/**
69315 * Checks if a field in the currently fetched row is NULL
69316 *
69317 * Checks if the given {@link field} from the current row of {@link
69318 * statement} is NULL.
69319 *
69320 * @param resource $statement A valid OCI statement identifier.
69321 * @param mixed $field Can be the field's index (1-based) or name.
69322 * @return bool Returns TRUE if {@link field} is NULL, FALSE otherwise.
69323 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69324 **/
69325function oci_field_is_null($statement, $field){}
69326
69327/**
69328 * Returns the name of a field from the statement
69329 *
69330 * Returns the name of the {@link field}.
69331 *
69332 * @param resource $statement A valid OCI statement identifier.
69333 * @param mixed $field Can be the field's index (1-based) or name.
69334 * @return string Returns the name as a string, or FALSE on errors.
69335 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69336 **/
69337function oci_field_name($statement, $field){}
69338
69339/**
69340 * Tell the precision of a field
69341 *
69342 * Returns precision of the {@link field}.
69343 *
69344 * For FLOAT columns, precision is nonzero and scale is -127. If
69345 * precision is 0, then column is NUMBER. Else it's NUMBER(precision,
69346 * scale).
69347 *
69348 * @param resource $statement A valid OCI statement identifier.
69349 * @param mixed $field Can be the field's index (1-based) or name.
69350 * @return int Returns the precision as an integer, or FALSE on errors.
69351 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69352 **/
69353function oci_field_precision($statement, $field){}
69354
69355/**
69356 * Tell the scale of the field
69357 *
69358 * Returns the scale of the column with {@link field} index.
69359 *
69360 * For FLOAT columns, precision is nonzero and scale is -127. If
69361 * precision is 0, then column is NUMBER. Else it's NUMBER(precision,
69362 * scale).
69363 *
69364 * @param resource $statement A valid OCI statement identifier.
69365 * @param mixed $field Can be the field's index (1-based) or name.
69366 * @return int Returns the scale as an integer, or FALSE on errors.
69367 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69368 **/
69369function oci_field_scale($statement, $field){}
69370
69371/**
69372 * Returns field's size
69373 *
69374 * Returns the size of a {@link field}.
69375 *
69376 * @param resource $statement A valid OCI statement identifier.
69377 * @param mixed $field Can be the field's index (1-based) or name.
69378 * @return int Returns the size of a {@link field} in bytes, or FALSE
69379 *   on errors.
69380 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69381 **/
69382function oci_field_size($statement, $field){}
69383
69384/**
69385 * Returns a field's data type name
69386 *
69387 * @param resource $statement A valid OCI statement identifier.
69388 * @param mixed $field Can be the field's index (1-based) or name.
69389 * @return mixed Returns the field data type as a string, or FALSE on
69390 *   errors.
69391 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69392 **/
69393function oci_field_type($statement, $field){}
69394
69395/**
69396 * Tell the raw Oracle data type of the field
69397 *
69398 * Returns Oracle's raw "SQLT" data type of the {@link field}.
69399 *
69400 * If you want a field's type name, then use {@link oci_field_type}
69401 * instead.
69402 *
69403 * @param resource $statement A valid OCI statement identifier.
69404 * @param mixed $field Can be the field's index (1-based) or name.
69405 * @return int Returns Oracle's raw data type as a number, or FALSE on
69406 *   errors.
69407 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69408 **/
69409function oci_field_type_raw($statement, $field){}
69410
69411/**
69412 * Frees a descriptor
69413 *
69414 * Frees a descriptor allocated by {@link oci_new_descriptor}.
69415 *
69416 * @param resource $descriptor
69417 * @return bool
69418 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69419 **/
69420function oci_free_descriptor($descriptor){}
69421
69422/**
69423 * Frees all resources associated with statement or cursor
69424 *
69425 * Frees resources associated with Oracle's cursor or statement, which
69426 * was received from as a result of {@link oci_parse} or obtained from
69427 * Oracle.
69428 *
69429 * @param resource $statement A valid OCI statement identifier.
69430 * @return bool
69431 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69432 **/
69433function oci_free_statement($statement){}
69434
69435/**
69436 * Returns the next child statement resource from a parent statement
69437 * resource that has Oracle Database 12c Implicit Result Sets
69438 *
69439 * Used to fetch consectutive sets of query results after the execution
69440 * of a stored or anonymous Oracle PL/SQL block where that block returns
69441 * query results with Oracle's DBMS_SQL.RETURN_RESULT PL/SQL function.
69442 * This allows PL/SQL blocks to easily return query results.
69443 *
69444 * The child statement can be used with any of the OCI8 fetching
69445 * functions: {@link oci_fetch}, {@link oci_fetch_all}, {@link
69446 * oci_fetch_array}, {@link oci_fetch_object}, {@link oci_fetch_assoc} or
69447 * {@link oci_fetch_row}
69448 *
69449 * Child statements inherit their parent statement's prefetch value, or
69450 * it can be explicitly set with {@link oci_set_prefetch}.
69451 *
69452 * @param resource $statement A valid OCI8 statement identifier created
69453 *   by {@link oci_parse} and executed by {@link oci_execute}. The
69454 *   statement identifier may or may not be associated with a SQL
69455 *   statement that returns Implicit Result Sets.
69456 * @return resource Returns a statement handle for the next child
69457 *   statement available on {@link statement}. Returns FALSE when child
69458 *   statements do not exist, or all child statements have been returned
69459 *   by previous calls to {@link oci_get_implicit_resultset}.
69460 * @since PHP 5 >= 5.6.0, PHP 7, PECL OCI8 >= 2.0.0
69461 **/
69462function oci_get_implicit_resultset($statement){}
69463
69464/**
69465 * Enables or disables internal debug output
69466 *
69467 * @param bool $onoff Set this to FALSE to turn debug output off or
69468 *   TRUE to turn it on.
69469 * @return void
69470 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69471 **/
69472function oci_internal_debug($onoff){}
69473
69474/**
69475 * Copies large object
69476 *
69477 * Copies a large object or a part of a large object to another large
69478 * object. Old LOB-recipient data will be overwritten.
69479 *
69480 * If you need to copy a particular part of a LOB to a particular
69481 * position of a LOB, use {@link OCI-Lob::seek} to move LOB internal
69482 * pointers.
69483 *
69484 * @param OCI-Lob $lob_to The destination LOB.
69485 * @param OCI-Lob $lob_from The copied LOB.
69486 * @param int $length Indicates the length of data to be copied.
69487 * @return bool
69488 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69489 **/
69490function oci_lob_copy($lob_to, $lob_from, $length){}
69491
69492/**
69493 * Compares two LOB/FILE locators for equality
69494 *
69495 * Compares two LOB/FILE locators.
69496 *
69497 * @param OCI-Lob $lob1 A LOB identifier.
69498 * @param OCI-Lob $lob2 A LOB identifier.
69499 * @return bool Returns TRUE if these objects are equal, FALSE
69500 *   otherwise.
69501 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69502 **/
69503function oci_lob_is_equal($lob1, $lob2){}
69504
69505/**
69506 * Allocates new collection object
69507 *
69508 * Allocates a new collection object.
69509 *
69510 * @param resource $connection An Oracle connection identifier,
69511 *   returned by {@link oci_connect} or {@link oci_pconnect}.
69512 * @param string $tdo Should be a valid named type (uppercase).
69513 * @param string $schema Should point to the scheme, where the named
69514 *   type was created. The name of the current user is the default value.
69515 * @return OCI-Collection Returns a new OCICollection object or FALSE
69516 *   on error.
69517 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69518 **/
69519function oci_new_collection($connection, $tdo, $schema){}
69520
69521/**
69522 * Connect to the Oracle server using a unique connection
69523 *
69524 * Establishes a new connection to an Oracle server and logs on.
69525 *
69526 * Unlike {@link oci_connect} and {@link oci_pconnect}, {@link
69527 * oci_new_connect} does not cache connections and will always return a
69528 * brand-new freshly opened connection handle. This is useful if your
69529 * application needs transactional isolation between two sets of queries.
69530 *
69531 * @param string $username The Oracle user name.
69532 * @param string $password The password for {@link username}.
69533 * @param string $connection_string
69534 * @param string $character_set
69535 * @param int $session_mode
69536 * @return resource Returns a connection identifier or FALSE on error.
69537 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69538 **/
69539function oci_new_connect($username, $password, $connection_string, $character_set, $session_mode){}
69540
69541/**
69542 * Allocates and returns a new cursor (statement handle)
69543 *
69544 * Allocates a new statement handle on the specified connection.
69545 *
69546 * @param resource $connection An Oracle connection identifier,
69547 *   returned by {@link oci_connect} or {@link oci_pconnect}.
69548 * @return resource Returns a new statement handle, or FALSE on error.
69549 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69550 **/
69551function oci_new_cursor($connection){}
69552
69553/**
69554 * Initializes a new empty LOB or FILE descriptor
69555 *
69556 * Allocates resources to hold descriptor or LOB locator.
69557 *
69558 * @param resource $connection An Oracle connection identifier,
69559 *   returned by {@link oci_connect} or {@link oci_pconnect}.
69560 * @param int $type Valid values for {@link type} are: OCI_DTYPE_FILE,
69561 *   OCI_DTYPE_LOB and OCI_DTYPE_ROWID.
69562 * @return OCI-Lob Returns a new LOB or FILE descriptor on success,
69563 *   FALSE on error.
69564 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69565 **/
69566function oci_new_descriptor($connection, $type){}
69567
69568/**
69569 * Returns the number of result columns in a statement
69570 *
69571 * Gets the number of columns in the given {@link statement}.
69572 *
69573 * @param resource $statement A valid OCI statement identifier.
69574 * @return int Returns the number of columns as an integer, or FALSE on
69575 *   errors.
69576 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69577 **/
69578function oci_num_fields($statement){}
69579
69580/**
69581 * Returns number of rows affected during statement execution
69582 *
69583 * Gets the number of rows affected during statement execution.
69584 *
69585 * @param resource $statement A valid OCI statement identifier.
69586 * @return int Returns the number of rows affected as an integer, or
69587 *   FALSE on errors.
69588 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69589 **/
69590function oci_num_rows($statement){}
69591
69592/**
69593 * Prepares an Oracle statement for execution
69594 *
69595 * Prepares {@link sql_text} using {@link connection} and returns the
69596 * statement identifier, which can be used with {@link oci_bind_by_name},
69597 * {@link oci_execute} and other functions.
69598 *
69599 * Statement identifiers can be freed with {@link oci_free_statement} or
69600 * by setting the variable to NULL.
69601 *
69602 * @param resource $connection An Oracle connection identifier,
69603 *   returned by {@link oci_connect}, {@link oci_pconnect}, or {@link
69604 *   oci_new_connect}.
69605 * @param string $sql_text The SQL or PL/SQL statement. SQL statements
69606 *   should not end with a semi-colon (;). PL/SQL statements should end
69607 *   with a semi-colon (;).
69608 * @return resource Returns a statement handle on success, or FALSE on
69609 *   error.
69610 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69611 **/
69612function oci_parse($connection, $sql_text){}
69613
69614/**
69615 * Changes password of Oracle's user
69616 *
69617 * Changes password for user with {@link username}.
69618 *
69619 * The {@link oci_password_change} function is most useful for PHP
69620 * command-line scripts, or when non-persistent connections are used
69621 * throughout the PHP application.
69622 *
69623 * @param resource $connection An Oracle connection identifier,
69624 *   returned by {@link oci_connect} or {@link oci_pconnect}.
69625 * @param string $username The Oracle user name.
69626 * @param string $old_password The old password.
69627 * @param string $new_password The new password to be set.
69628 * @return bool
69629 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69630 **/
69631function oci_password_change($connection, $username, $old_password, $new_password){}
69632
69633/**
69634 * Connect to an Oracle database using a persistent connection
69635 *
69636 * Creates a persistent connection to an Oracle server and logs on.
69637 *
69638 * Persistent connections are cached and re-used between requests,
69639 * resulting in reduced overhead on each page load; a typical PHP
69640 * application will have a single persistent connection open against an
69641 * Oracle server per Apache child process (or PHP FastCGI/CGI process).
69642 * See the Persistent Database Connections section for more information.
69643 *
69644 * @param string $username The Oracle user name.
69645 * @param string $password The password for {@link username}.
69646 * @param string $connection_string
69647 * @param string $character_set
69648 * @param int $session_mode
69649 * @return resource Returns a connection identifier or FALSE on error.
69650 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69651 **/
69652function oci_pconnect($username, $password, $connection_string, $character_set, $session_mode){}
69653
69654/**
69655 * Register a user-defined callback function for Oracle Database TAF
69656 *
69657 * Registers a user-defined callback function to {@link connection}. If
69658 * {@link connection} fails due to instance or network failure, the
69659 * registered callback function will be invoked for several times during
69660 * failover. See OCI8 Transparent Application Failover (TAF) Support for
69661 * information.
69662 *
69663 * When {@link oci_register_taf_callback} is called multiple times, each
69664 * registration overwrites the previous one.
69665 *
69666 * Use {@link oci_unregister_taf_callback} to explicitly unregister a
69667 * user-defined callback.
69668 *
69669 * TAF callback registration will NOT be saved across persistent
69670 * connections, therefore the callback needs to be re-registered for a
69671 * new persistent connection.
69672 *
69673 * @param resource $connection An Oracle connection identifier.
69674 * @param mixed $callbackFn A user-defined callback to register for
69675 *   Oracle TAF. It can be a string of the function name or a Closure
69676 *   (anonymous function). The interface of a TAF user-defined callback
69677 *   function is as follows: See the parameter description and an example
69678 *   on OCI8 Transparent Application Failover (TAF) Support page.
69679 * @return bool
69680 * @since PHP 7.0 >= 7.0.21, PHP 7 >= 7.1.7, PECL OCI8 >= 2.1.7
69681 **/
69682function oci_register_taf_callback($connection, $callbackFn){}
69683
69684/**
69685 * Returns field's value from the fetched row
69686 *
69687 * Returns the data from {@link field} in the current row, fetched by
69688 * {@link oci_fetch}.
69689 *
69690 * @param resource $statement
69691 * @param mixed $field Can be either use the column number (1-based) or
69692 *   the column name. The case of the column name must be the case that
69693 *   Oracle meta data describes the column as, which is uppercase for
69694 *   columns created case insensitively.
69695 * @return mixed Returns everything as strings except for abstract
69696 *   types (ROWIDs, LOBs and FILEs). Returns FALSE on error.
69697 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69698 **/
69699function oci_result($statement, $field){}
69700
69701/**
69702 * Rolls back the outstanding database transaction
69703 *
69704 * Reverts all uncommitted changes for the Oracle {@link connection} and
69705 * ends the transaction. It releases all locks held. All Oracle
69706 * SAVEPOINTS are erased.
69707 *
69708 * A transaction begins when the first SQL statement that changes data is
69709 * executed with {@link oci_execute} using the OCI_NO_AUTO_COMMIT flag.
69710 * Further data changes made by other statements become part of the same
69711 * transaction. Data changes made in a transaction are temporary until
69712 * the transaction is committed or rolled back. Other users of the
69713 * database will not see the changes until they are committed.
69714 *
69715 * When inserting or updating data, using transactions is recommended for
69716 * relational data consistency and for performance reasons.
69717 *
69718 * @param resource $connection An Oracle connection identifier,
69719 *   returned by {@link oci_connect}, {@link oci_pconnect} or {@link
69720 *   oci_new_connect}.
69721 * @return bool
69722 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69723 **/
69724function oci_rollback($connection){}
69725
69726/**
69727 * Returns the Oracle Database version
69728 *
69729 * Returns a string with the Oracle Database version and available
69730 * options
69731 *
69732 * @param resource $connection
69733 * @return string Returns the version information as a string or FALSE
69734 *   on error.
69735 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69736 **/
69737function oci_server_version($connection){}
69738
69739/**
69740 * Sets the action name
69741 *
69742 * Sets the action name for Oracle tracing.
69743 *
69744 * The action name is registered with the database when the next
69745 * 'round-trip' from PHP to the database occurs, typically when an SQL
69746 * statement is executed.
69747 *
69748 * The action name can subsequently be queried from database
69749 * administration views such as V$SESSION. It can be used for tracing and
69750 * monitoring such as with V$SQLAREA and
69751 * DBMS_MONITOR.SERV_MOD_ACT_STAT_ENABLE.
69752 *
69753 * The value may be retained across persistent connections.
69754 *
69755 * @param resource $connection
69756 * @param string $action_name User chosen string up to 32 bytes long.
69757 * @return bool
69758 * @since PHP 5 >= 5.3.2, PHP 7, PECL OCI8 >= 1.4.0
69759 **/
69760function oci_set_action($connection, $action_name){}
69761
69762/**
69763 * Sets a millisecond timeout for database calls
69764 *
69765 * Sets a timeout limiting the maxium time a database round-trip using
69766 * this connection may take.
69767 *
69768 * Each OCI8 operation may make zero or more calls to Oracle's client
69769 * library. These internal calls may then may make zero or more
69770 * round-trips to Oracle Database. If any one of those round-trips takes
69771 * more than time_out milliseconds, then the operation is cancelled and
69772 * an error is returned to the application.
69773 *
69774 * The time_out value applies to each round-trip individually, not to the
69775 * sum of all round-trips. Time spent processing in PHP OCI8 before or
69776 * after the completion of each round-trip is not counted.
69777 *
69778 * When a call is interrupted, Oracle will attempt to clean up the
69779 * connection for reuse. This operation is allowed to run for another
69780 * time_out period. Depending on the outcome of the cleanup, the
69781 * connection may or may not be reusable.
69782 *
69783 * When persistent connections are used, the timeout value will be
69784 * retained across PHP requests.
69785 *
69786 * The {@link oci_set_call_timeout} function is available when OCI8 uses
69787 * Oracle 18 (or later) Client libraries.
69788 *
69789 * @param resource $connection
69790 * @param int $time_out The maximum time in milliseconds that any
69791 *   single round-trip between PHP and Oracle Database may take.
69792 * @return bool
69793 * @since PHP 7.2 >= 7.2.14, PHP 7 >= 7.3.1, PECL OCI8 >= 2.2.0
69794 **/
69795function oci_set_call_timeout($connection, $time_out){}
69796
69797/**
69798 * Sets the client identifier
69799 *
69800 * Sets the client identifier used by various database components to
69801 * identify lightweight application users who authenticate as the same
69802 * database user.
69803 *
69804 * The client identifier is registered with the database when the next
69805 * 'round-trip' from PHP to the database occurs, typically when an SQL
69806 * statement is executed.
69807 *
69808 * The identifier can subsequently be queried, for example with SELECT
69809 * SYS_CONTEXT('USERENV','CLIENT_IDENTIFIER') FROM DUAL. Database
69810 * administration views such as V$SESSION will also contain the value. It
69811 * can be used with DBMS_MONITOR.CLIENT_ID_TRACE_ENABLE for tracing and
69812 * can also be used for auditing.
69813 *
69814 * The value may be retained across page requests that use the same
69815 * persistent connection.
69816 *
69817 * @param resource $connection
69818 * @param string $client_identifier User chosen string up to 64 bytes
69819 *   long.
69820 * @return bool
69821 * @since PHP 5 >= 5.3.2, PHP 7, PECL OCI8 >= 1.4.0
69822 **/
69823function oci_set_client_identifier($connection, $client_identifier){}
69824
69825/**
69826 * Sets the client information
69827 *
69828 * Sets the client information for Oracle tracing.
69829 *
69830 * The client information is registered with the database when the next
69831 * 'round-trip' from PHP to the database occurs, typically when an SQL
69832 * statement is executed.
69833 *
69834 * The client information can subsequently be queried from database
69835 * administration views such as V$SESSION.
69836 *
69837 * The value may be retained across persistent connections.
69838 *
69839 * @param resource $connection
69840 * @param string $client_info User chosen string up to 64 bytes long.
69841 * @return bool
69842 * @since PHP 5 >= 5.3.2, PHP 7, PECL OCI8 >= 1.4.0
69843 **/
69844function oci_set_client_info($connection, $client_info){}
69845
69846/**
69847 * Sets the database operation
69848 *
69849 * Sets the DBOP for Oracle tracing.
69850 *
69851 * The database operation name is registered with the database when the
69852 * next 'round-trip' from PHP to the database occurs, typically when a
69853 * SQL statement is executed.
69854 *
69855 * The database operation can subsequently be queried from database
69856 * administration views such as V$SQL_MONITOR.
69857 *
69858 * The {@link oci_set_db_operation} function is available when OCI8 uses
69859 * Oracle 12 (or later) Client libraries and Oracle Database 12 (or
69860 * later).
69861 *
69862 * @param resource $connection
69863 * @param string $dbop User chosen string.
69864 * @return bool
69865 * @since PHP 7 >= 7.2.14, PHP 7 >= 7.3.1, PECL OCI8 >= 2.2.0
69866 **/
69867function oci_set_db_operation($connection, $dbop){}
69868
69869/**
69870 * Sets the database edition
69871 *
69872 * Sets the database "edition" of objects to be used by a subsequent
69873 * connections.
69874 *
69875 * Oracle Editions allow concurrent versions of applications to run using
69876 * the same schema and object names. This is useful for upgrading live
69877 * systems.
69878 *
69879 * Call {@link oci_set_edition} before calling {@link oci_connect},
69880 * {@link oci_pconnect} or {@link oci_new_connect}.
69881 *
69882 * If an edition is set that is not valid in the database, connection
69883 * will fail even if {@link oci_set_edition} returns success.
69884 *
69885 * When using persistent connections, if a connection with the requested
69886 * edition setting already exists, it is reused. Otherwise, a different
69887 * persistent connection is created
69888 *
69889 * @param string $edition Oracle Database edition name previously
69890 *   created with the SQL "CREATE EDITION" command.
69891 * @return bool
69892 * @since PHP 5 >= 5.3.2, PHP 7, PECL OCI8 >= 1.4.0
69893 **/
69894function oci_set_edition($edition){}
69895
69896/**
69897 * Sets the module name
69898 *
69899 * Sets the module name for Oracle tracing.
69900 *
69901 * The module name is registered with the database when the next
69902 * 'round-trip' from PHP to the database occurs, typically when an SQL
69903 * statement is executed.
69904 *
69905 * The name can subsequently be queried from database administration
69906 * views such as V$SESSION. It can be used for tracing and monitoring
69907 * such as with V$SQLAREA and DBMS_MONITOR.SERV_MOD_ACT_STAT_ENABLE.
69908 *
69909 * The value may be retained across persistent connections.
69910 *
69911 * @param resource $connection
69912 * @param string $module_name User chosen string up to 48 bytes long.
69913 * @return bool
69914 * @since PHP 5 >= 5.3.2, PHP 7, PECL OCI8 >= 1.4.0
69915 **/
69916function oci_set_module_name($connection, $module_name){}
69917
69918/**
69919 * Sets number of rows to be prefetched by queries
69920 *
69921 * Sets the number of rows to be buffered by the Oracle Client libraries
69922 * after a successful query call to {@link oci_execute} and for each
69923 * subsequent internal fetch request to the database. For queries
69924 * returning a large number of rows, performance can be significantly
69925 * improved by increasing the prefetch count above the default
69926 * oci8.default_prefetch value.
69927 *
69928 * Prefetching is Oracle's efficient way of returning more than one data
69929 * row from the database in each network request. This can result in
69930 * better network and CPU utilization. The buffering of rows is internal
69931 * to OCI8 and the behavior of OCI8 fetching functions is unchanged
69932 * regardless of the prefetch count. For example, {@link oci_fetch_row}
69933 * will always return one row. The prefetch buffer is per-statement and
69934 * is not used by re-executed statements or by other connections.
69935 *
69936 * Call {@link oci_set_prefetch} before calling {@link oci_execute}.
69937 *
69938 * A tuning goal is to set the prefetch value to a reasonable size for
69939 * the network and database to handle. For queries returning a very large
69940 * number of rows, overall system efficiency might be better if rows are
69941 * retrieved from the database in several chunks (i.e set the prefetch
69942 * value smaller than the number of rows). This allows the database to
69943 * handle other users' statements while the PHP script is processing the
69944 * current set of rows.
69945 *
69946 * Query prefetching was introduced in Oracle 8i. REF CURSOR prefetching
69947 * was introduced in Oracle 11gR2 and occurs when PHP is linked with
69948 * Oracle 11gR2 (or later) Client libraries. Nested cursor prefetching
69949 * was introduced in Oracle 11gR2 and requires both the Oracle Client
69950 * libraries and the database to be version 11gR2 or greater.
69951 *
69952 * Prefetching is not supported when queries contain LONG or LOB columns.
69953 * The prefetch value is ignored and single-row fetches will be used in
69954 * all the situations when prefetching is not supported.
69955 *
69956 * When using Oracle Database 12c, the prefetch value set by PHP can be
69957 * overridden by Oracle's client oraaccess.xml configuration file. Refer
69958 * to Oracle documentation for more detail.
69959 *
69960 * @param resource $statement
69961 * @param int $rows The number of rows to be prefetched, >= 0
69962 * @return bool
69963 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69964 **/
69965function oci_set_prefetch($statement, $rows){}
69966
69967/**
69968 * Returns the type of a statement
69969 *
69970 * Returns a keyword identifying the type of the OCI8 {@link statement}.
69971 *
69972 * @param resource $statement A valid OCI8 statement identifier from
69973 *   {@link oci_parse}.
69974 * @return string Returns the type of {@link statement} as one of the
69975 *   following strings. Statement type Return String Notes ALTER BEGIN
69976 *   CALL Introduced in PHP 5.2.1 (PECL OCI8 1.2.3) CREATE DECLARE DELETE
69977 *   DROP INSERT SELECT UPDATE UNKNOWN
69978 * @since PHP 5, PHP 7, PECL OCI8 >= 1.1.0
69979 **/
69980function oci_statement_type($statement){}
69981
69982/**
69983 * Unregister a user-defined callback function for Oracle Database TAF
69984 *
69985 * Unregister the user-defined callback function registered to connection
69986 * by {@link oci_register_taf_callback}. See OCI8 Transparent Application
69987 * Failover (TAF) Support for information.
69988 *
69989 * @param resource $connection An Oracle connection identifier.
69990 * @return bool
69991 * @since PHP 7.0 >= 7.0.23, PHP 7 >= 7.1.9, PECL OCI8 >= 2.1.7
69992 **/
69993function oci_unregister_taf_callback($connection){}
69994
69995/**
69996 * Octal to decimal
69997 *
69998 * Returns the decimal equivalent of the octal number represented by the
69999 * {@link octal_string} argument.
70000 *
70001 * @param string $octal_string The octal string to convert. Any invalid
70002 *   characters in {@link octal_string} are silently ignored. As of PHP
70003 *   7.4.0 supplying any invalid characters is deprecated.
70004 * @return number The decimal representation of {@link octal_string}
70005 * @since PHP 4, PHP 5, PHP 7
70006 **/
70007function octdec($octal_string){}
70008
70009/**
70010 * Toggle autocommit behaviour
70011 *
70012 * Toggles autocommit behaviour.
70013 *
70014 * By default, auto-commit is on for a connection. Disabling auto-commit
70015 * is equivalent with starting a transaction.
70016 *
70017 * @param resource $connection_id
70018 * @param bool $OnOff If {@link OnOff} is TRUE, auto-commit is enabled,
70019 *   if it is FALSE auto-commit is disabled.
70020 * @return mixed Without the {@link OnOff} parameter, this function
70021 *   returns auto-commit status for {@link connection_id}. Non-zero is
70022 *   returned if auto-commit is on, 0 if it is off, or FALSE if an error
70023 *   occurs.
70024 * @since PHP 4, PHP 5, PHP 7
70025 **/
70026function odbc_autocommit($connection_id, $OnOff){}
70027
70028/**
70029 * Handling of binary column data
70030 *
70031 * Enables handling of binary column data. ODBC SQL types affected are
70032 * BINARY, VARBINARY, and LONGVARBINARY.
70033 *
70034 * When binary SQL data is converted to character C data, each byte (8
70035 * bits) of source data is represented as two ASCII characters. These
70036 * characters are the ASCII character representation of the number in its
70037 * hexadecimal form. For example, a binary 00000001 is converted to "01"
70038 * and a binary 11111111 is converted to "FF". LONGVARBINARY handling
70039 * binmode longreadlen result ODBC_BINMODE_PASSTHRU 0 passthru
70040 * ODBC_BINMODE_RETURN 0 passthru ODBC_BINMODE_CONVERT 0 passthru
70041 * ODBC_BINMODE_PASSTHRU 0 passthru ODBC_BINMODE_PASSTHRU >0 passthru
70042 * ODBC_BINMODE_RETURN >0 return as is ODBC_BINMODE_CONVERT >0 return as
70043 * char
70044 *
70045 * If {@link odbc_fetch_into} is used, passthru means that an empty
70046 * string is returned for these columns.
70047 *
70048 * @param resource $result_id The result identifier. If {@link
70049 *   result_id} is 0, the settings apply as default for new results.
70050 *   Default for longreadlen is 4096 and {@link mode} defaults to
70051 *   ODBC_BINMODE_RETURN. Handling of binary long columns is also
70052 *   affected by {@link odbc_longreadlen}.
70053 * @param int $mode Possible values for {@link mode} are:
70054 *   ODBC_BINMODE_PASSTHRU: Passthru BINARY data ODBC_BINMODE_RETURN:
70055 *   Return as is ODBC_BINMODE_CONVERT: Convert to char and return
70056 * @return bool
70057 * @since PHP 4, PHP 5, PHP 7
70058 **/
70059function odbc_binmode($result_id, $mode){}
70060
70061/**
70062 * Close an ODBC connection
70063 *
70064 * Closes down the connection to the database server.
70065 *
70066 * @param resource $connection_id
70067 * @return void
70068 * @since PHP 4, PHP 5, PHP 7
70069 **/
70070function odbc_close($connection_id){}
70071
70072/**
70073 * Close all ODBC connections
70074 *
70075 * {@link odbc_close_all} will close down all connections to database
70076 * server(s).
70077 *
70078 * @return void
70079 * @since PHP 4, PHP 5, PHP 7
70080 **/
70081function odbc_close_all(){}
70082
70083/**
70084 * Lists columns and associated privileges for the given table
70085 *
70086 * @param resource $connection_id
70087 * @param string $qualifier The qualifier.
70088 * @param string $owner The owner.
70089 * @param string $table_name The table name.
70090 * @param string $column_name The column name.
70091 * @return resource Returns an ODBC result identifier. This result
70092 *   identifier can be used to fetch a list of columns and associated
70093 *   privileges.
70094 * @since PHP 4, PHP 5, PHP 7
70095 **/
70096function odbc_columnprivileges($connection_id, $qualifier, $owner, $table_name, $column_name){}
70097
70098/**
70099 * Lists the column names in specified tables
70100 *
70101 * Lists all columns in the requested range.
70102 *
70103 * @param resource $connection_id
70104 * @param string $qualifier The qualifier.
70105 * @param string $schema The owner.
70106 * @param string $table_name The table name.
70107 * @param string $column_name The column name.
70108 * @return resource Returns an ODBC result identifier.
70109 * @since PHP 4, PHP 5, PHP 7
70110 **/
70111function odbc_columns($connection_id, $qualifier, $schema, $table_name, $column_name){}
70112
70113/**
70114 * Commit an ODBC transaction
70115 *
70116 * Commits all pending transactions on the connection.
70117 *
70118 * @param resource $connection_id
70119 * @return bool
70120 * @since PHP 4, PHP 5, PHP 7
70121 **/
70122function odbc_commit($connection_id){}
70123
70124/**
70125 * Connect to a datasource
70126 *
70127 * @param string $dsn The database source name for the connection.
70128 *   Alternatively, a DSN-less connection string can be used.
70129 * @param string $user The username.
70130 * @param string $password The password.
70131 * @param int $cursor_type This sets the type of cursor to be used for
70132 *   this connection. This parameter is not normally needed, but can be
70133 *   useful for working around problems with some ODBC drivers.
70134 *
70135 *   SQL_CUR_USE_IF_NEEDED SQL_CUR_USE_ODBC SQL_CUR_USE_DRIVER
70136 * @return resource Returns an ODBC connection or (FALSE) on error.
70137 * @since PHP 4, PHP 5, PHP 7
70138 **/
70139function odbc_connect($dsn, $user, $password, $cursor_type){}
70140
70141/**
70142 * Get cursorname
70143 *
70144 * Gets the cursorname for the given result_id.
70145 *
70146 * @param resource $result_id The result identifier.
70147 * @return string Returns the cursor name, as a string.
70148 * @since PHP 4, PHP 5, PHP 7
70149 **/
70150function odbc_cursor($result_id){}
70151
70152/**
70153 * Returns information about a current connection
70154 *
70155 * This function will return the list of available DSN (after calling it
70156 * several times).
70157 *
70158 * @param resource $connection_id
70159 * @param int $fetch_type The {@link fetch_type} can be one of two
70160 *   constant types: SQL_FETCH_FIRST, SQL_FETCH_NEXT. Use SQL_FETCH_FIRST
70161 *   the first time this function is called, thereafter use the
70162 *   SQL_FETCH_NEXT.
70163 * @return array Returns FALSE on error, and an array upon success.
70164 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
70165 **/
70166function odbc_data_source($connection_id, $fetch_type){}
70167
70168/**
70169 * Directly execute an SQL statement
70170 *
70171 * Sends an SQL statement to the database server.
70172 *
70173 * @param resource $connection_id
70174 * @param string $query_string The SQL statement.
70175 * @param int $flags This parameter is currently not used.
70176 * @return resource Returns an ODBC result identifier if the SQL
70177 *   command was executed successfully, or FALSE on error.
70178 * @since PHP 4, PHP 5, PHP 7
70179 **/
70180function odbc_do($connection_id, $query_string, $flags){}
70181
70182/**
70183 * Get the last error code
70184 *
70185 * @param resource $connection_id
70186 * @return string If {@link connection_id} is specified, the last state
70187 *   of that connection is returned, else the last state of any
70188 *   connection is returned.
70189 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
70190 **/
70191function odbc_error($connection_id){}
70192
70193/**
70194 * Get the last error message
70195 *
70196 * @param resource $connection_id
70197 * @return string If {@link connection_id} is specified, the last state
70198 *   of that connection is returned, else the last state of any
70199 *   connection is returned.
70200 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
70201 **/
70202function odbc_errormsg($connection_id){}
70203
70204/**
70205 * Directly execute an SQL statement
70206 *
70207 * Sends an SQL statement to the database server.
70208 *
70209 * @param resource $connection_id
70210 * @param string $query_string The SQL statement.
70211 * @param int $flags This parameter is currently not used.
70212 * @return resource Returns an ODBC result identifier if the SQL
70213 *   command was executed successfully, or FALSE on error.
70214 * @since PHP 4, PHP 5, PHP 7
70215 **/
70216function odbc_exec($connection_id, $query_string, $flags){}
70217
70218/**
70219 * Execute a prepared statement
70220 *
70221 * Executes a statement prepared with {@link odbc_prepare}.
70222 *
70223 * @param resource $result_id The result id resource, from {@link
70224 *   odbc_prepare}.
70225 * @param array $parameters_array Parameters in {@link parameter_array}
70226 *   will be substituted for placeholders in the prepared statement in
70227 *   order. Elements of this array will be converted to strings by
70228 *   calling this function. Any parameters in {@link parameter_array}
70229 *   which start and end with single quotes will be taken as the name of
70230 *   a file to read and send to the database server as the data for the
70231 *   appropriate placeholder.
70232 * @return bool
70233 * @since PHP 4, PHP 5, PHP 7
70234 **/
70235function odbc_execute($result_id, $parameters_array){}
70236
70237/**
70238 * Fetch a result row as an associative array
70239 *
70240 * Fetch an associative array from an ODBC query.
70241 *
70242 * @param resource $result The result resource from {@link odbc_exec}.
70243 * @param int $rownumber Optionally choose which row number to
70244 *   retrieve.
70245 * @return array Returns an array that corresponds to the fetched row,
70246 *   or FALSE if there are no more rows.
70247 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
70248 **/
70249function odbc_fetch_array($result, $rownumber){}
70250
70251/**
70252 * Fetch one result row into array
70253 *
70254 * Fetch one result row into array.
70255 *
70256 * @param resource $result_id The result resource.
70257 * @param array $result_array The result array that can be of any type
70258 *   since it will be converted to type array. The array will contain the
70259 *   column values starting at array index 0.
70260 * @param int $rownumber The row number.
70261 * @return int Returns the number of columns in the result; FALSE on
70262 *   error.
70263 * @since PHP 4, PHP 5, PHP 7
70264 **/
70265function odbc_fetch_into($result_id, &$result_array, $rownumber){}
70266
70267/**
70268 * Fetch a result row as an object
70269 *
70270 * Fetch an object from an ODBC query.
70271 *
70272 * @param resource $result The result resource from {@link odbc_exec}.
70273 * @param int $rownumber Optionally choose which row number to
70274 *   retrieve.
70275 * @return object Returns an object that corresponds to the fetched
70276 *   row, or FALSE if there are no more rows.
70277 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
70278 **/
70279function odbc_fetch_object($result, $rownumber){}
70280
70281/**
70282 * Fetch a row
70283 *
70284 * Fetches a row of the data that was returned by {@link odbc_do} or
70285 * {@link odbc_exec}. After {@link odbc_fetch_row} is called, the fields
70286 * of that row can be accessed with {@link odbc_result}.
70287 *
70288 * @param resource $result_id The result identifier.
70289 * @param int $row_number If {@link row_number} is not specified,
70290 *   {@link odbc_fetch_row} will try to fetch the next row in the result
70291 *   set. Calls to {@link odbc_fetch_row} with and without {@link
70292 *   row_number} can be mixed. To step through the result more than once,
70293 *   you can call {@link odbc_fetch_row} with {@link row_number} 1, and
70294 *   then continue doing {@link odbc_fetch_row} without {@link
70295 *   row_number} to review the result. If a driver doesn't support
70296 *   fetching rows by number, the {@link row_number} parameter is
70297 *   ignored.
70298 * @return bool Returns TRUE if there was a row, FALSE otherwise.
70299 * @since PHP 4, PHP 5, PHP 7
70300 **/
70301function odbc_fetch_row($result_id, $row_number){}
70302
70303/**
70304 * Get the length (precision) of a field
70305 *
70306 * Gets the length of the field referenced by number in the given result
70307 * identifier.
70308 *
70309 * @param resource $result_id The result identifier.
70310 * @param int $field_number The field number. Field numbering starts at
70311 *   1.
70312 * @return int Returns the field length, or FALSE on error.
70313 * @since PHP 4, PHP 5, PHP 7
70314 **/
70315function odbc_field_len($result_id, $field_number){}
70316
70317/**
70318 * Get the columnname
70319 *
70320 * Gets the name of the field occupying the given column number in the
70321 * given result identifier.
70322 *
70323 * @param resource $result_id The result identifier.
70324 * @param int $field_number The field number. Field numbering starts at
70325 *   1.
70326 * @return string Returns the field name as a string, or FALSE on
70327 *   error.
70328 * @since PHP 4, PHP 5, PHP 7
70329 **/
70330function odbc_field_name($result_id, $field_number){}
70331
70332/**
70333 * Return column number
70334 *
70335 * Gets the number of the column slot that corresponds to the named field
70336 * in the given result identifier.
70337 *
70338 * @param resource $result_id The result identifier.
70339 * @param string $field_name The field name.
70340 * @return int Returns the field number as a integer, or FALSE on
70341 *   error. Field numbering starts at 1.
70342 * @since PHP 4, PHP 5, PHP 7
70343 **/
70344function odbc_field_num($result_id, $field_name){}
70345
70346/**
70347 * Get the length (precision) of a field
70348 *
70349 * Gets the length of the field referenced by number in the given result
70350 * identifier.
70351 *
70352 * @param resource $result_id The result identifier.
70353 * @param int $field_number The field number. Field numbering starts at
70354 *   1.
70355 * @return int Returns the field length, or FALSE on error.
70356 * @since PHP 4, PHP 5, PHP 7
70357 **/
70358function odbc_field_precision($result_id, $field_number){}
70359
70360/**
70361 * Get the scale of a field
70362 *
70363 * Gets the scale of the field referenced by number in the given result
70364 * identifier.
70365 *
70366 * @param resource $result_id The result identifier.
70367 * @param int $field_number The field number. Field numbering starts at
70368 *   1.
70369 * @return int Returns the field scale as a integer, or FALSE on error.
70370 * @since PHP 4, PHP 5, PHP 7
70371 **/
70372function odbc_field_scale($result_id, $field_number){}
70373
70374/**
70375 * Datatype of a field
70376 *
70377 * Gets the SQL type of the field referenced by number in the given
70378 * result identifier.
70379 *
70380 * @param resource $result_id The result identifier.
70381 * @param int $field_number The field number. Field numbering starts at
70382 *   1.
70383 * @return string Returns the field type as a string, or FALSE on
70384 *   error.
70385 * @since PHP 4, PHP 5, PHP 7
70386 **/
70387function odbc_field_type($result_id, $field_number){}
70388
70389/**
70390 * Retrieves a list of foreign keys
70391 *
70392 * Retrieves a list of foreign keys in the specified table or a list of
70393 * foreign keys in other tables that refer to the primary key in the
70394 * specified table
70395 *
70396 * @param resource $connection_id
70397 * @param string $pk_qualifier The primary key qualifier.
70398 * @param string $pk_owner The primary key owner.
70399 * @param string $pk_table The primary key table.
70400 * @param string $fk_qualifier The foreign key qualifier.
70401 * @param string $fk_owner The foreign key owner.
70402 * @param string $fk_table The foreign key table.
70403 * @return resource Returns an ODBC result identifier.
70404 * @since PHP 4, PHP 5, PHP 7
70405 **/
70406function odbc_foreignkeys($connection_id, $pk_qualifier, $pk_owner, $pk_table, $fk_qualifier, $fk_owner, $fk_table){}
70407
70408/**
70409 * Free resources associated with a result
70410 *
70411 * {@link odbc_free_result} only needs to be called if you are worried
70412 * about using too much memory while your script is running. All result
70413 * memory will automatically be freed when the script is finished.
70414 *
70415 * @param resource $result_id The result identifier.
70416 * @return bool Always returns TRUE.
70417 * @since PHP 4, PHP 5, PHP 7
70418 **/
70419function odbc_free_result($result_id){}
70420
70421/**
70422 * Retrieves information about data types supported by the data source
70423 *
70424 * @param resource $connection_id
70425 * @param int $data_type The data type, which can be used to restrict
70426 *   the information to a single data type.
70427 * @return resource Returns an ODBC result identifier or FALSE on
70428 *   failure.
70429 * @since PHP 4, PHP 5, PHP 7
70430 **/
70431function odbc_gettypeinfo($connection_id, $data_type){}
70432
70433/**
70434 * Handling of LONG columns
70435 *
70436 * Enables handling of LONG and LONGVARBINARY columns.
70437 *
70438 * @param resource $result_id The result identifier.
70439 * @param int $length The number of bytes returned to PHP is controlled
70440 *   by the parameter length. If it is set to 0, Long column data is
70441 *   passed through to the client.
70442 * @return bool
70443 * @since PHP 4, PHP 5, PHP 7
70444 **/
70445function odbc_longreadlen($result_id, $length){}
70446
70447/**
70448 * Checks if multiple results are available
70449 *
70450 * Checks if there are more result sets available as well as allowing
70451 * access to the next result set via {@link odbc_fetch_array}, {@link
70452 * odbc_fetch_row}, {@link odbc_result}, etc.
70453 *
70454 * @param resource $result_id The result identifier.
70455 * @return bool Returns TRUE if there are more result sets, FALSE
70456 *   otherwise.
70457 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
70458 **/
70459function odbc_next_result($result_id){}
70460
70461/**
70462 * Number of columns in a result
70463 *
70464 * Gets the number of fields (columns) in an ODBC result.
70465 *
70466 * @param resource $result_id The result identifier returned by {@link
70467 *   odbc_exec}.
70468 * @return int Returns the number of fields, or -1 on error.
70469 * @since PHP 4, PHP 5, PHP 7
70470 **/
70471function odbc_num_fields($result_id){}
70472
70473/**
70474 * Number of rows in a result
70475 *
70476 * Gets the number of rows in a result. For INSERT, UPDATE and DELETE
70477 * statements {@link odbc_num_rows} returns the number of rows affected.
70478 * For a SELECT clause this can be the number of rows available.
70479 *
70480 * @param resource $result_id The result identifier returned by {@link
70481 *   odbc_exec}.
70482 * @return int Returns the number of rows in an ODBC result. This
70483 *   function will return -1 on error.
70484 * @since PHP 4, PHP 5, PHP 7
70485 **/
70486function odbc_num_rows($result_id){}
70487
70488/**
70489 * Open a persistent database connection
70490 *
70491 * Opens a persistent database connection.
70492 *
70493 * This function is much like {@link odbc_connect}, except that the
70494 * connection is not really closed when the script has finished. Future
70495 * requests for a connection with the same {@link dsn}, {@link user},
70496 * {@link password} combination (via {@link odbc_connect} and {@link
70497 * odbc_pconnect}) can reuse the persistent connection.
70498 *
70499 * @param string $dsn
70500 * @param string $user
70501 * @param string $password
70502 * @param int $cursor_type
70503 * @return resource Returns an ODBC connection id or 0 (FALSE) on
70504 *   error.
70505 * @since PHP 4, PHP 5, PHP 7
70506 **/
70507function odbc_pconnect($dsn, $user, $password, $cursor_type){}
70508
70509/**
70510 * Prepares a statement for execution
70511 *
70512 * Prepares a statement for execution. The result identifier can be used
70513 * later to execute the statement with {@link odbc_execute}.
70514 *
70515 * Some databases (such as IBM DB2, MS SQL Server, and Oracle) support
70516 * stored procedures that accept parameters of type IN, INOUT, and OUT as
70517 * defined by the ODBC specification. However, the Unified ODBC driver
70518 * currently only supports parameters of type IN to stored procedures.
70519 *
70520 * @param resource $connection_id
70521 * @param string $query_string The query string statement being
70522 *   prepared.
70523 * @return resource Returns an ODBC result identifier if the SQL
70524 *   command was prepared successfully. Returns FALSE on error.
70525 * @since PHP 4, PHP 5, PHP 7
70526 **/
70527function odbc_prepare($connection_id, $query_string){}
70528
70529/**
70530 * Gets the primary keys for a table
70531 *
70532 * Returns a result identifier that can be used to fetch the column names
70533 * that comprise the primary key for a table.
70534 *
70535 * @param resource $connection_id
70536 * @param string $qualifier
70537 * @param string $owner
70538 * @param string $table
70539 * @return resource Returns an ODBC result identifier.
70540 * @since PHP 4, PHP 5, PHP 7
70541 **/
70542function odbc_primarykeys($connection_id, $qualifier, $owner, $table){}
70543
70544/**
70545 * Retrieve information about parameters to procedures
70546 *
70547 * @param resource $connection_id
70548 * @return resource Returns the list of input and output parameters, as
70549 *   well as the columns that make up the result set for the specified
70550 *   procedures. Returns an ODBC result identifier.
70551 * @since PHP 4, PHP 5, PHP 7
70552 **/
70553function odbc_procedurecolumns($connection_id){}
70554
70555/**
70556 * Get the list of procedures stored in a specific data source
70557 *
70558 * Lists all procedures in the requested range.
70559 *
70560 * @param resource $connection_id
70561 * @return resource Returns an ODBC result identifier containing the
70562 *   information.
70563 * @since PHP 4, PHP 5, PHP 7
70564 **/
70565function odbc_procedures($connection_id){}
70566
70567/**
70568 * Get result data
70569 *
70570 * @param resource $result_id The ODBC resource.
70571 * @param mixed $field The field name being retrieved. It can either be
70572 *   an integer containing the column number of the field you want; or it
70573 *   can be a string containing the name of the field.
70574 * @return mixed Returns the string contents of the field, FALSE on
70575 *   error, NULL for NULL data, or TRUE for binary data.
70576 * @since PHP 4, PHP 5, PHP 7
70577 **/
70578function odbc_result($result_id, $field){}
70579
70580/**
70581 * Print result as HTML table
70582 *
70583 * Prints all rows from a result identifier produced by {@link
70584 * odbc_exec}. The result is printed in HTML table format.
70585 *
70586 * @param resource $result_id The result identifier.
70587 * @param string $format Additional overall table formatting.
70588 * @return int Returns the number of rows in the result or FALSE on
70589 *   error.
70590 * @since PHP 4, PHP 5, PHP 7
70591 **/
70592function odbc_result_all($result_id, $format){}
70593
70594/**
70595 * Rollback a transaction
70596 *
70597 * Rolls back all pending statements on the connection.
70598 *
70599 * @param resource $connection_id
70600 * @return bool
70601 * @since PHP 4, PHP 5, PHP 7
70602 **/
70603function odbc_rollback($connection_id){}
70604
70605/**
70606 * Adjust ODBC settings
70607 *
70608 * This function allows fiddling with the ODBC options for a particular
70609 * connection or query result. It was written to help find work around to
70610 * problems in quirky ODBC drivers. You should probably only use this
70611 * function if you are an ODBC programmer and understand the effects the
70612 * various options will have. You will certainly need a good ODBC
70613 * reference to explain all the different options and values that can be
70614 * used. Different driver versions support different options.
70615 *
70616 * Because the effects may vary depending on the ODBC driver, use of this
70617 * function in scripts to be made publicly available is strongly
70618 * discouraged. Also, some ODBC options are not available to this
70619 * function because they must be set before the connection is established
70620 * or the query is prepared. However, if on a particular job it can make
70621 * PHP work so your boss doesn't tell you to use a commercial product,
70622 * that's all that really matters.
70623 *
70624 * @param resource $id Is a connection id or result id on which to
70625 *   change the settings. For SQLSetConnectOption(), this is a connection
70626 *   id. For SQLSetStmtOption(), this is a result id.
70627 * @param int $function Is the ODBC function to use. The value should
70628 *   be 1 for SQLSetConnectOption() and 2 for SQLSetStmtOption().
70629 * @param int $option The option to set.
70630 * @param int $param The value for the given {@link option}.
70631 * @return bool
70632 * @since PHP 4, PHP 5, PHP 7
70633 **/
70634function odbc_setoption($id, $function, $option, $param){}
70635
70636/**
70637 * Retrieves special columns
70638 *
70639 * Retrieves either the optimal set of columns that uniquely identifies a
70640 * row in the table, or columns that are automatically updated when any
70641 * value in the row is updated by a transaction.
70642 *
70643 * @param resource $connection_id
70644 * @param int $type
70645 * @param string $qualifier The qualifier.
70646 * @param string $table The table.
70647 * @param int $scope The scope, which orders the result set.
70648 * @param int $nullable The nullable option.
70649 * @return resource Returns an ODBC result identifier or FALSE on
70650 *   failure.
70651 * @since PHP 4, PHP 5, PHP 7
70652 **/
70653function odbc_specialcolumns($connection_id, $type, $qualifier, $table, $scope, $nullable){}
70654
70655/**
70656 * Retrieve statistics about a table
70657 *
70658 * Get statistics about a table and its indexes.
70659 *
70660 * @param resource $connection_id
70661 * @param string $qualifier The qualifier.
70662 * @param string $owner The owner.
70663 * @param string $table_name The table name.
70664 * @param int $unique The unique attribute.
70665 * @param int $accuracy The accuracy.
70666 * @return resource Returns an ODBC result identifier.
70667 * @since PHP 4, PHP 5, PHP 7
70668 **/
70669function odbc_statistics($connection_id, $qualifier, $owner, $table_name, $unique, $accuracy){}
70670
70671/**
70672 * Lists tables and the privileges associated with each table
70673 *
70674 * Lists tables in the requested range and the privileges associated with
70675 * each table.
70676 *
70677 * @param resource $connection_id
70678 * @param string $qualifier The qualifier.
70679 * @param string $owner The owner. Accepts the following search
70680 *   patterns: ('%' to match zero or more characters and '_' to match a
70681 *   single character)
70682 * @param string $name The name. Accepts the following search patterns:
70683 *   ('%' to match zero or more characters and '_' to match a single
70684 *   character)
70685 * @return resource An ODBC result identifier.
70686 * @since PHP 4, PHP 5, PHP 7
70687 **/
70688function odbc_tableprivileges($connection_id, $qualifier, $owner, $name){}
70689
70690/**
70691 * Get the list of table names stored in a specific data source
70692 *
70693 * Lists all tables in the requested range.
70694 *
70695 * To support enumeration of qualifiers, owners, and table types, the
70696 * following special semantics for the {@link qualifier}, {@link owner},
70697 * {@link name}, and {@link table_type} are available: If {@link
70698 * qualifier} is a single percent character (%) and {@link owner} and
70699 * {@link name} are empty strings, then the result set contains a list of
70700 * valid qualifiers for the data source. (All columns except the
70701 * TABLE_QUALIFIER column contain NULLs.) If {@link owner} is a single
70702 * percent character (%) and {@link qualifier} and {@link name} are empty
70703 * strings, then the result set contains a list of valid owners for the
70704 * data source. (All columns except the TABLE_OWNER column contain
70705 * NULLs.) If {@link table_type} is a single percent character (%) and
70706 * {@link qualifier}, {@link owner} and {@link name} are empty strings,
70707 * then the result set contains a list of valid table types for the data
70708 * source. (All columns except the TABLE_TYPE column contain NULLs.)
70709 *
70710 * @param resource $connection_id
70711 * @param string $qualifier The qualifier.
70712 * @param string $owner The owner. Accepts search patterns ('%' to
70713 *   match zero or more characters and '_' to match a single character).
70714 * @param string $name The name. Accepts search patterns ('%' to match
70715 *   zero or more characters and '_' to match a single character).
70716 * @param string $types If {@link table_type} is not an empty string,
70717 *   it must contain a list of comma-separated values for the types of
70718 *   interest; each value may be enclosed in single quotes (') or
70719 *   unquoted. For example, "'TABLE','VIEW'" or "TABLE, VIEW". If the
70720 *   data source does not support a specified table type, {@link
70721 *   odbc_tables} does not return any results for that type.
70722 * @return resource Returns an ODBC result identifier containing the
70723 *   information .
70724 * @since PHP 4, PHP 5, PHP 7
70725 **/
70726function odbc_tables($connection_id, $qualifier, $owner, $name, $types){}
70727
70728/**
70729 * Compiles and caches a PHP script without executing it
70730 *
70731 * This function compiles a PHP script and adds it to the opcode cache
70732 * without executing it. This can be used to prime the cache after a Web
70733 * server restart by pre-caching files that will be included in later
70734 * requests.
70735 *
70736 * @param string $file The path to the PHP script to be compiled.
70737 * @return bool Returns TRUE if {@link file} was compiled successfully
70738 *   .
70739 * @since PHP 5 >= 5.5.5, PHP 7, PECL ZendOpcache > 7.0.2
70740 **/
70741function opcache_compile_file($file){}
70742
70743/**
70744 * Get configuration information about the cache
70745 *
70746 * This function returns configuration information about the cache
70747 * instance
70748 *
70749 * @return array Returns an array of information, including ini,
70750 *   blacklist and version
70751 * @since PHP 5 >= 5.5.0, PHP 7, PECL ZendOpcache > 7.0.2
70752 **/
70753function opcache_get_configuration(){}
70754
70755/**
70756 * Get status information about the cache
70757 *
70758 * This function returns state information about the cache instance
70759 *
70760 * @param bool $get_scripts Include script specific state information
70761 * @return array Returns an array of information, optionally containing
70762 *   script specific state information, .
70763 * @since PHP 5 >= 5.5.0, PHP 7, PECL ZendOpcache > 7.0.2
70764 **/
70765function opcache_get_status($get_scripts){}
70766
70767/**
70768 * Invalidates a cached script
70769 *
70770 * This function invalidates a particular script from the opcode cache.
70771 * If {@link force} is unset or FALSE, the script will only be
70772 * invalidated if the modification time of the script is newer than the
70773 * cached opcodes.
70774 *
70775 * @param string $script The path to the script being invalidated.
70776 * @param bool $force If set to TRUE, the script will be invalidated
70777 *   regardless of whether invalidation is necessary.
70778 * @return bool Returns TRUE if the opcode cache for {@link script} was
70779 *   invalidated or if there was nothing to invalidate, or FALSE if the
70780 *   opcode cache is disabled.
70781 * @since PHP 5 >= 5.5.0, PHP 7, PECL ZendOpcache >= 7.0.0
70782 **/
70783function opcache_invalidate($script, $force){}
70784
70785/**
70786 * Tells whether a script is cached in OPCache
70787 *
70788 * This function checks if a PHP script has been cached in OPCache. This
70789 * can be used to more easily detect the "warming" of the cache for a
70790 * particular script.
70791 *
70792 * @param string $file The path to the PHP script to be checked.
70793 * @return bool Returns TRUE if {@link file} is cached in OPCache,
70794 *   FALSE otherwise.
70795 * @since PHP 5 >= 5.5.11, PHP 7, PECL ZendOpcache >= 7.0.4
70796 **/
70797function opcache_is_script_cached($file){}
70798
70799/**
70800 * Resets the contents of the opcode cache
70801 *
70802 * This function resets the entire opcode cache. After calling {@link
70803 * opcache_reset}, all scripts will be reloaded and reparsed the next
70804 * time they are hit.
70805 *
70806 * @return bool Returns TRUE if the opcode cache was reset, or FALSE if
70807 *   the opcode cache is disabled.
70808 * @since PHP 5 >= 5.5.0, PHP 7, PECL ZendOpcache >= 7.0.0
70809 **/
70810function opcache_reset(){}
70811
70812/**
70813 * Generate OpenAL buffer
70814 *
70815 * @return resource Returns an Open AL(Buffer) resource on success or
70816 *   FALSE on failure.
70817 * @since PECL openal >= 0.1.0
70818 **/
70819function openal_buffer_create(){}
70820
70821/**
70822 * Load a buffer with data
70823 *
70824 * @param resource $buffer An Open AL(Buffer) resource (previously
70825 *   created by {@link openal_buffer_create}).
70826 * @param int $format Format of {@link data}, one of: AL_FORMAT_MONO8,
70827 *   AL_FORMAT_MONO16, AL_FORMAT_STEREO8 AL_FORMAT_STEREO16
70828 * @param string $data Block of binary audio data in the {@link format}
70829 *   and {@link freq} specified.
70830 * @param int $freq Frequency of {@link data} given in Hz.
70831 * @return bool
70832 * @since PECL openal >= 0.1.0
70833 **/
70834function openal_buffer_data($buffer, $format, $data, $freq){}
70835
70836/**
70837 * Destroys an OpenAL buffer
70838 *
70839 * @param resource $buffer An Open AL(Buffer) resource (previously
70840 *   created by {@link openal_buffer_create}).
70841 * @return bool
70842 * @since PECL openal >= 0.1.0
70843 **/
70844function openal_buffer_destroy($buffer){}
70845
70846/**
70847 * Retrieve an OpenAL buffer property
70848 *
70849 * @param resource $buffer An Open AL(Buffer) resource (previously
70850 *   created by {@link openal_buffer_create}).
70851 * @param int $property Specific property, one of: AL_FREQUENCY,
70852 *   AL_BITS, AL_CHANNELS AL_SIZE.
70853 * @return int Returns an integer value appropriate to the {@link
70854 *   property} requested.
70855 * @since PECL openal >= 0.1.0
70856 **/
70857function openal_buffer_get($buffer, $property){}
70858
70859/**
70860 * Load a .wav file into a buffer
70861 *
70862 * @param resource $buffer An Open AL(Buffer) resource (previously
70863 *   created by {@link openal_buffer_create}).
70864 * @param string $wavfile Path to .wav file on local file system.
70865 * @return bool
70866 * @since PECL openal >= 0.1.0
70867 **/
70868function openal_buffer_loadwav($buffer, $wavfile){}
70869
70870/**
70871 * Create an audio processing context
70872 *
70873 * @param resource $device An Open AL(Device) resource (previously
70874 *   created by {@link openal_device_open}).
70875 * @return resource Returns an Open AL(Context) resource on success or
70876 *   FALSE on failure.
70877 * @since PECL openal >= 0.1.0
70878 **/
70879function openal_context_create($device){}
70880
70881/**
70882 * Make the specified context current
70883 *
70884 * @param resource $context An Open AL(Context) resource (previously
70885 *   created by {@link openal_context_create}).
70886 * @return bool
70887 * @since PECL openal >= 0.1.0
70888 **/
70889function openal_context_current($context){}
70890
70891/**
70892 * Destroys a context
70893 *
70894 * @param resource $context An Open AL(Context) resource (previously
70895 *   created by {@link openal_context_create}).
70896 * @return bool
70897 * @since PECL openal >= 0.1.0
70898 **/
70899function openal_context_destroy($context){}
70900
70901/**
70902 * Process the specified context
70903 *
70904 * @param resource $context An Open AL(Context) resource (previously
70905 *   created by {@link openal_context_create}).
70906 * @return bool
70907 * @since PECL openal >= 0.1.0
70908 **/
70909function openal_context_process($context){}
70910
70911/**
70912 * Suspend the specified context
70913 *
70914 * @param resource $context An Open AL(Context) resource (previously
70915 *   created by {@link openal_context_create}).
70916 * @return bool
70917 * @since PECL openal >= 0.1.0
70918 **/
70919function openal_context_suspend($context){}
70920
70921/**
70922 * Close an OpenAL device
70923 *
70924 * @param resource $device An Open AL(Device) resource (previously
70925 *   created by {@link openal_device_open}) to be closed.
70926 * @return bool
70927 * @since PECL openal >= 0.1.0
70928 **/
70929function openal_device_close($device){}
70930
70931/**
70932 * Initialize the OpenAL audio layer
70933 *
70934 * @param string $device_desc Open an audio device optionally specified
70935 *   by {@link device_desc}. If {@link device_desc} is not specified the
70936 *   first available audio device will be used.
70937 * @return resource Returns an Open AL(Device) resource on success or
70938 *   FALSE on failure.
70939 * @since PECL openal >= 0.1.0
70940 **/
70941function openal_device_open($device_desc){}
70942
70943/**
70944 * Retrieve a listener property
70945 *
70946 * @param int $property Property to retrieve, one of: AL_GAIN (float),
70947 *   AL_POSITION (array(float,float,float)), AL_VELOCITY
70948 *   (array(float,float,float)) AL_ORIENTATION
70949 *   (array(float,float,float)).
70950 * @return mixed Returns a float or array of floats (as appropriate).
70951 * @since PECL openal >= 0.1.0
70952 **/
70953function openal_listener_get($property){}
70954
70955/**
70956 * Set a listener property
70957 *
70958 * @param int $property Property to set, one of: AL_GAIN (float),
70959 *   AL_POSITION (array(float,float,float)), AL_VELOCITY
70960 *   (array(float,float,float)) AL_ORIENTATION
70961 *   (array(float,float,float)).
70962 * @param mixed $setting Value to set, either float, or an array of
70963 *   floats as appropriate.
70964 * @return bool
70965 * @since PECL openal >= 0.1.0
70966 **/
70967function openal_listener_set($property, $setting){}
70968
70969/**
70970 * Generate a source resource
70971 *
70972 * @return resource Returns an Open AL(Source) resource on success or
70973 *   FALSE on failure.
70974 * @since PECL openal >= 0.1.0
70975 **/
70976function openal_source_create(){}
70977
70978/**
70979 * Destroy a source resource
70980 *
70981 * @param resource $source An Open AL(Source) resource (previously
70982 *   created by {@link openal_source_create}).
70983 * @return bool
70984 * @since PECL openal >= 0.1.0
70985 **/
70986function openal_source_destroy($source){}
70987
70988/**
70989 * Retrieve an OpenAL source property
70990 *
70991 * @param resource $source An Open AL(Source) resource (previously
70992 *   created by {@link openal_source_create}).
70993 * @param int $property Property to get, one of: AL_SOURCE_RELATIVE
70994 *   (int), AL_SOURCE_STATE (int), AL_PITCH (float), AL_GAIN (float),
70995 *   AL_MIN_GAIN (float), AL_MAX_GAIN (float), AL_MAX_DISTANCE (float),
70996 *   AL_ROLLOFF_FACTOR (float), AL_CONE_OUTER_GAIN (float),
70997 *   AL_CONE_INNER_ANGLE (float), AL_CONE_OUTER_ANGLE (float),
70998 *   AL_REFERENCE_DISTANCE (float), AL_POSITION
70999 *   (array(float,float,float)), AL_VELOCITY (array(float,float,float)),
71000 *   AL_DIRECTION (array(float,float,float)).
71001 * @return mixed Returns the type associated with the property being
71002 *   retrieved .
71003 * @since PECL openal >= 0.1.0
71004 **/
71005function openal_source_get($source, $property){}
71006
71007/**
71008 * Pause the source
71009 *
71010 * @param resource $source An Open AL(Source) resource (previously
71011 *   created by {@link openal_source_create}).
71012 * @return bool
71013 * @since PECL openal >= 0.1.0
71014 **/
71015function openal_source_pause($source){}
71016
71017/**
71018 * Start playing the source
71019 *
71020 * @param resource $source An Open AL(Source) resource (previously
71021 *   created by {@link openal_source_create}).
71022 * @return bool
71023 * @since PECL openal >= 0.1.0
71024 **/
71025function openal_source_play($source){}
71026
71027/**
71028 * Rewind the source
71029 *
71030 * @param resource $source An Open AL(Source) resource (previously
71031 *   created by {@link openal_source_create}).
71032 * @return bool
71033 * @since PECL openal >= 0.1.0
71034 **/
71035function openal_source_rewind($source){}
71036
71037/**
71038 * Set source property
71039 *
71040 * @param resource $source An Open AL(Source) resource (previously
71041 *   created by {@link openal_source_create}).
71042 * @param int $property Property to set, one of: AL_BUFFER
71043 *   (OpenAL(Source)), AL_LOOPING (bool), AL_SOURCE_RELATIVE (int),
71044 *   AL_SOURCE_STATE (int), AL_PITCH (float), AL_GAIN (float),
71045 *   AL_MIN_GAIN (float), AL_MAX_GAIN (float), AL_MAX_DISTANCE (float),
71046 *   AL_ROLLOFF_FACTOR (float), AL_CONE_OUTER_GAIN (float),
71047 *   AL_CONE_INNER_ANGLE (float), AL_CONE_OUTER_ANGLE (float),
71048 *   AL_REFERENCE_DISTANCE (float), AL_POSITION
71049 *   (array(float,float,float)), AL_VELOCITY (array(float,float,float)),
71050 *   AL_DIRECTION (array(float,float,float)).
71051 * @param mixed $setting Value to assign to specified {@link property}.
71052 *   Refer to the description of {@link property} for a description of
71053 *   the value(s) expected.
71054 * @return bool
71055 * @since PECL openal >= 0.1.0
71056 **/
71057function openal_source_set($source, $property, $setting){}
71058
71059/**
71060 * Stop playing the source
71061 *
71062 * @param resource $source An Open AL(Source) resource (previously
71063 *   created by {@link openal_source_create}).
71064 * @return bool
71065 * @since PECL openal >= 0.1.0
71066 **/
71067function openal_source_stop($source){}
71068
71069/**
71070 * Begin streaming on a source
71071 *
71072 * @param resource $source An Open AL(Source) resource (previously
71073 *   created by {@link openal_source_create}).
71074 * @param int $format Format of {@link data}, one of: AL_FORMAT_MONO8,
71075 *   AL_FORMAT_MONO16, AL_FORMAT_STEREO8 AL_FORMAT_STEREO16
71076 * @param int $rate Frequency of data to stream given in Hz.
71077 * @return resource Returns a stream resource on success.
71078 * @since PECL openal >= 0.1.0
71079 **/
71080function openal_stream($source, $format, $rate){}
71081
71082/**
71083 * Open directory handle
71084 *
71085 * Opens up a directory handle to be used in subsequent {@link closedir},
71086 * {@link readdir}, and {@link rewinddir} calls.
71087 *
71088 * @param string $path The directory path that is to be opened
71089 * @param resource $context For a description of the {@link context}
71090 *   parameter, refer to the streams section of the manual.
71091 * @return resource Returns a directory handle resource on success,
71092 * @since PHP 4, PHP 5, PHP 7
71093 **/
71094function opendir($path, $context){}
71095
71096/**
71097 * Open connection to system logger
71098 *
71099 * {@link openlog} opens a connection to the system logger for a program.
71100 *
71101 * The use of {@link openlog} is optional. It will automatically be
71102 * called by {@link syslog} if necessary, in which case {@link ident}
71103 * will default to FALSE.
71104 *
71105 * @param string $ident The string {@link ident} is added to each
71106 *   message.
71107 * @param int $option The {@link option} argument is used to indicate
71108 *   what logging options will be used when generating a log message.
71109 *   {@link openlog} Options Constant Description LOG_CONS if there is an
71110 *   error while sending data to the system logger, write directly to the
71111 *   system console LOG_NDELAY open the connection to the logger
71112 *   immediately LOG_ODELAY (default) delay opening the connection until
71113 *   the first message is logged LOG_PERROR print log message also to
71114 *   standard error LOG_PID include PID with each message You can use one
71115 *   or more of these options. When using multiple options you need to OR
71116 *   them, i.e. to open the connection immediately, write to the console
71117 *   and include the PID in each message, you will use: LOG_CONS |
71118 *   LOG_NDELAY | LOG_PID
71119 * @param int $facility The {@link facility} argument is used to
71120 *   specify what type of program is logging the message. This allows you
71121 *   to specify (in your machine's syslog configuration) how messages
71122 *   coming from different facilities will be handled. {@link openlog}
71123 *   Facilities Constant Description LOG_AUTH security/authorization
71124 *   messages (use LOG_AUTHPRIV instead in systems where that constant is
71125 *   defined) LOG_AUTHPRIV security/authorization messages (private)
71126 *   LOG_CRON clock daemon (cron and at) LOG_DAEMON other system daemons
71127 *   LOG_KERN kernel messages LOG_LOCAL0 ... LOG_LOCAL7 reserved for
71128 *   local use, these are not available in Windows LOG_LPR line printer
71129 *   subsystem LOG_MAIL mail subsystem LOG_NEWS USENET news subsystem
71130 *   LOG_SYSLOG messages generated internally by syslogd LOG_USER generic
71131 *   user-level messages LOG_UUCP UUCP subsystem
71132 * @return bool
71133 * @since PHP 4, PHP 5, PHP 7
71134 **/
71135function openlog($ident, $option, $facility){}
71136
71137/**
71138 * Gets the cipher iv length
71139 *
71140 * Gets the cipher initialization vector (iv) length.
71141 *
71142 * @param string $method The cipher method, see {@link
71143 *   openssl_get_cipher_methods} for a list of potential values.
71144 * @return int Returns the cipher length on success, or FALSE on
71145 *   failure.
71146 * @since PHP 5 >= 5.3.3, PHP 7
71147 **/
71148function openssl_cipher_iv_length($method){}
71149
71150/**
71151 * Exports a CSR as a string
71152 *
71153 * {@link openssl_csr_export} takes the Certificate Signing Request
71154 * represented by {@link csr} and stores it in PEM format in {@link out},
71155 * which is passed by reference.
71156 *
71157 * @param mixed $csr on success, this string will contain the PEM
71158 *   encoded CSR
71159 * @param string $out
71160 * @param bool $notext
71161 * @return bool
71162 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
71163 **/
71164function openssl_csr_export($csr, &$out, $notext){}
71165
71166/**
71167 * Exports a CSR to a file
71168 *
71169 * {@link openssl_csr_export_to_file} takes the Certificate Signing
71170 * Request represented by {@link csr} and saves it in PEM format into the
71171 * file named by {@link outfilename}.
71172 *
71173 * @param mixed $csr Path to the output file.
71174 * @param string $outfilename
71175 * @param bool $notext
71176 * @return bool
71177 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
71178 **/
71179function openssl_csr_export_to_file($csr, $outfilename, $notext){}
71180
71181/**
71182 * Returns the public key of a CSR
71183 *
71184 * {@link openssl_csr_get_public_key} extracts the public key from {@link
71185 * csr} and prepares it for use by other functions.
71186 *
71187 * @param mixed $csr
71188 * @param bool $use_shortnames
71189 * @return resource Returns a positive key resource identifier on
71190 *   success, or FALSE on error.
71191 * @since PHP 5 >= 5.2.0, PHP 7
71192 **/
71193function openssl_csr_get_public_key($csr, $use_shortnames){}
71194
71195/**
71196 * Returns the subject of a CSR
71197 *
71198 * {@link openssl_csr_get_subject} returns subject distinguished name
71199 * information encoded in the {@link csr} including fields commonName
71200 * (CN), organizationName (O), countryName (C) etc.
71201 *
71202 * @param mixed $csr {@link shortnames} controls how the data is
71203 *   indexed in the array - if {@link shortnames} is TRUE (the default)
71204 *   then fields will be indexed with the short name form, otherwise, the
71205 *   long name form will be used - e.g.: CN is the shortname form of
71206 *   commonName.
71207 * @param bool $use_shortnames
71208 * @return array Returns an associative array with subject description,
71209 *   .
71210 * @since PHP 5 >= 5.2.0, PHP 7
71211 **/
71212function openssl_csr_get_subject($csr, $use_shortnames){}
71213
71214/**
71215 * Generates a CSR
71216 *
71217 * {@link openssl_csr_new} generates a new CSR (Certificate Signing
71218 * Request) based on the information provided by {@link dn}.
71219 *
71220 * @param array $dn The Distinguished Name or subject fields to be used
71221 *   in the certificate.
71222 * @param resource $privkey {@link privkey} should be set to a private
71223 *   key that was previously generated by {@link openssl_pkey_new} (or
71224 *   otherwise obtained from the other openssl_pkey family of functions).
71225 *   The corresponding public portion of the key will be used to sign the
71226 *   CSR.
71227 * @param array $configargs By default, the information in your system
71228 *   openssl.conf is used to initialize the request; you can specify a
71229 *   configuration file section by setting the config_section_section key
71230 *   of {@link configargs}. You can also specify an alternative openssl
71231 *   configuration file by setting the value of the config key to the
71232 *   path of the file you want to use. The following keys, if present in
71233 *   {@link configargs} behave as their equivalents in the openssl.conf,
71234 *   as listed in the table below. Configuration overrides {@link
71235 *   configargs} key type openssl.conf equivalent description digest_alg
71236 *   string default_md Digest method or signature hash, usually one of
71237 *   {@link openssl_get_md_methods} x509_extensions string
71238 *   x509_extensions Selects which extensions should be used when
71239 *   creating an x509 certificate req_extensions string req_extensions
71240 *   Selects which extensions should be used when creating a CSR
71241 *   private_key_bits integer default_bits Specifies how many bits should
71242 *   be used to generate a private key private_key_type integer none
71243 *   Specifies the type of private key to create. This can be one of
71244 *   OPENSSL_KEYTYPE_DSA, OPENSSL_KEYTYPE_DH, OPENSSL_KEYTYPE_RSA or
71245 *   OPENSSL_KEYTYPE_EC. The default value is OPENSSL_KEYTYPE_RSA.
71246 *   encrypt_key boolean encrypt_key Should an exported key (with
71247 *   passphrase) be encrypted? encrypt_key_cipher integer none One of
71248 *   cipher constants. curve_name string none One of {@link
71249 *   openssl_get_curve_names}. config string N/A Path to your own
71250 *   alternative openssl.conf file.
71251 * @param array $extraattribs {@link extraattribs} is used to specify
71252 *   additional configuration options for the CSR. Both {@link dn} and
71253 *   {@link extraattribs} are associative arrays whose keys are converted
71254 *   to OIDs and applied to the relevant part of the request.
71255 * @return mixed Returns the CSR.
71256 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
71257 **/
71258function openssl_csr_new($dn, &$privkey, $configargs, $extraattribs){}
71259
71260/**
71261 * Sign a CSR with another certificate (or itself) and generate a
71262 * certificate
71263 *
71264 * {@link openssl_csr_sign} generates an x509 certificate resource from
71265 * the given CSR.
71266 *
71267 * @param mixed $csr A CSR previously generated by {@link
71268 *   openssl_csr_new}. It can also be the path to a PEM encoded CSR when
71269 *   specified as file://path/to/csr or an exported string generated by
71270 *   {@link openssl_csr_export}.
71271 * @param mixed $cacert The generated certificate will be signed by
71272 *   {@link cacert}. If {@link cacert} is NULL, the generated certificate
71273 *   will be a self-signed certificate.
71274 * @param mixed $priv_key {@link priv_key} is the private key that
71275 *   corresponds to {@link cacert}.
71276 * @param int $days {@link days} specifies the length of time for which
71277 *   the generated certificate will be valid, in days.
71278 * @param array $configargs You can finetune the CSR signing by {@link
71279 *   configargs}. See {@link openssl_csr_new} for more information about
71280 *   {@link configargs}.
71281 * @param int $serial An optional the serial number of issued
71282 *   certificate. If not specified it will default to 0.
71283 * @return resource Returns an x509 certificate resource on success,
71284 *   FALSE on failure.
71285 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
71286 **/
71287function openssl_csr_sign($csr, $cacert, $priv_key, $days, $configargs, $serial){}
71288
71289/**
71290 * Decrypts data
71291 *
71292 * Takes a raw or base64 encoded string and decrypts it using a given
71293 * method and key.
71294 *
71295 * @param string $data The encrypted message to be decrypted.
71296 * @param string $method The cipher method. For a list of available
71297 *   cipher methods, use {@link openssl_get_cipher_methods}.
71298 * @param string $key The key.
71299 * @param int $options {@link options} can be one of OPENSSL_RAW_DATA,
71300 *   OPENSSL_ZERO_PADDING.
71301 * @param string $iv A non-NULL Initialization Vector.
71302 * @param string $tag The authentication tag in AEAD cipher mode. If it
71303 *   is incorrect, the authentication fails and the function returns
71304 *   FALSE.
71305 * @param string $aad Additional authentication data.
71306 * @return string The decrypted string on success.
71307 * @since PHP 5 >= 5.3.0, PHP 7
71308 **/
71309function openssl_decrypt($data, $method, $key, $options, $iv, $tag, $aad){}
71310
71311/**
71312 * Computes shared secret for public value of remote DH public key and
71313 * local DH key
71314 *
71315 * The shared secret returned by {@link openssl_dh_compute_key} is often
71316 * used as an encryption key to secretly communicate with a remote party.
71317 * This is known as the Diffie-Hellman key exchange.
71318 *
71319 * @param string $pub_key DH Public key of the remote party.
71320 * @param resource $dh_key A local DH private key, corresponding to the
71321 *   public key to be shared with the remote party.
71322 * @return string Returns shared secret on success.
71323 * @since PHP 5 >= 5.3.0, PHP 7
71324 **/
71325function openssl_dh_compute_key($pub_key, $dh_key){}
71326
71327/**
71328 * Computes a digest
71329 *
71330 * Computes a digest hash value for the given data using a given method,
71331 * and returns a raw or binhex encoded string.
71332 *
71333 * @param string $data The data.
71334 * @param string $method The digest method to use, e.g. "sha256", see
71335 *   {@link openssl_get_md_methods} for a list of available digest
71336 *   methods.
71337 * @param bool $raw_output Setting to TRUE will return as raw output
71338 *   data, otherwise the return value is binhex encoded.
71339 * @return string Returns the digested hash value on success.
71340 * @since PHP 5 >= 5.3.0, PHP 7
71341 **/
71342function openssl_digest($data, $method, $raw_output){}
71343
71344/**
71345 * Encrypts data
71346 *
71347 * Encrypts given data with given method and key, returns a raw or base64
71348 * encoded string
71349 *
71350 * @param string $data The plaintext message data to be encrypted.
71351 * @param string $method The cipher method. For a list of available
71352 *   cipher methods, use {@link openssl_get_cipher_methods}.
71353 * @param string $key The key.
71354 * @param int $options {@link options} is a bitwise disjunction of the
71355 *   flags OPENSSL_RAW_DATA and OPENSSL_ZERO_PADDING.
71356 * @param string $iv A non-NULL Initialization Vector.
71357 * @param string $tag The authentication tag passed by reference when
71358 *   using AEAD cipher mode (GCM or CCM).
71359 * @param string $aad Additional authentication data.
71360 * @param int $tag_length The length of the authentication {@link tag}.
71361 *   Its value can be between 4 and 16 for GCM mode.
71362 * @return string Returns the encrypted string on success.
71363 * @since PHP 5 >= 5.3.0, PHP 7
71364 **/
71365function openssl_encrypt($data, $method, $key, $options, $iv, &$tag, $aad, $tag_length){}
71366
71367/**
71368 * Return openSSL error message
71369 *
71370 * {@link openssl_error_string} returns the last error from the openSSL
71371 * library. Error messages are queued, so this function should be called
71372 * multiple times to collect all of the information. The last error will
71373 * be the most recent one.
71374 *
71375 * @return string Returns an error message string, or FALSE if there
71376 *   are no more error messages to return.
71377 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
71378 **/
71379function openssl_error_string(){}
71380
71381/**
71382 * Free key resource
71383 *
71384 * {@link openssl_free_key} frees the key associated with the specified
71385 * {@link key_identifier} from memory.
71386 *
71387 * @param resource $key_identifier
71388 * @return void
71389 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
71390 **/
71391function openssl_free_key($key_identifier){}
71392
71393/**
71394 * Retrieve the available certificate locations
71395 *
71396 * {@link openssl_get_cert_locations} returns an array with information
71397 * about the available certificate locations that will be searched for
71398 * SSL certificates.
71399 *
71400 * @return array Returns an array with the available certificate
71401 *   locations.
71402 * @since PHP 5 >= 5.6.0, PHP 7
71403 **/
71404function openssl_get_cert_locations(){}
71405
71406/**
71407 * Gets available cipher methods
71408 *
71409 * Gets a list of available cipher methods.
71410 *
71411 * @param bool $aliases Set to TRUE if cipher aliases should be
71412 *   included within the returned array.
71413 * @return array An array of available cipher methods.
71414 * @since PHP 5 >= 5.3.0, PHP 7
71415 **/
71416function openssl_get_cipher_methods($aliases){}
71417
71418/**
71419 * Gets list of available curve names for ECC
71420 *
71421 * Gets the list of available curve names for use in Elliptic curve
71422 * cryptography (ECC) for public/private key operations. The two most
71423 * widely standardized/supported curves are prime256v1 (NIST P-256) and
71424 * secp384r1 (NIST P-384). Approximate Equivalancies of AES, RSA, DSA and
71425 * ECC Keysizes AES Symmetric Keysize (Bits) RSA and DSA Keysize (Bits)
71426 * ECC Keysize (Bits) 80 1024 160 112 2048 224 128 3072 256 192 7680 384
71427 * 256 15360 512 NIST recommends using ECC curves with at least 256 bits.
71428 *
71429 * @return array An array of available curve names.
71430 * @since PHP 7 >= 7.1.0
71431 **/
71432function openssl_get_curve_names(){}
71433
71434/**
71435 * Gets available digest methods
71436 *
71437 * Gets a list of available digest methods.
71438 *
71439 * @param bool $aliases Set to TRUE if digest aliases should be
71440 *   included within the returned array.
71441 * @return array An array of available digest methods.
71442 * @since PHP 5 >= 5.3.0, PHP 7
71443 **/
71444function openssl_get_md_methods($aliases){}
71445
71446/**
71447 * Get a private key
71448 *
71449 * {@link openssl_get_privatekey} parses {@link key} and prepares it for
71450 * use by other functions.
71451 *
71452 * @param mixed $key {@link key} can be one of the following: a string
71453 *   having the format file://path/to/file.pem. The named file must
71454 *   contain a PEM encoded certificate/private key (it may contain both).
71455 *   A PEM formatted private key.
71456 * @param string $passphrase The optional parameter {@link passphrase}
71457 *   must be used if the specified key is encrypted (protected by a
71458 *   passphrase).
71459 * @return resource Returns a positive key resource identifier on
71460 *   success, or FALSE on error.
71461 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
71462 **/
71463function openssl_get_privatekey($key, $passphrase){}
71464
71465/**
71466 * Extract public key from certificate and prepare it for use
71467 *
71468 * {@link openssl_get_publickey} extracts the public key from {@link
71469 * certificate} and prepares it for use by other functions.
71470 *
71471 * @param mixed $certificate {@link certificate} can be one of the
71472 *   following: an X.509 certificate resource a string having the format
71473 *   file://path/to/file.pem. The named file must contain a PEM encoded
71474 *   certificate/public key (it may contain both). A PEM formatted public
71475 *   key.
71476 * @return resource Returns a positive key resource identifier on
71477 *   success, or FALSE on error.
71478 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
71479 **/
71480function openssl_get_publickey($certificate){}
71481
71482/**
71483 * Open sealed data
71484 *
71485 * {@link openssl_open} opens (decrypts) {@link sealed_data} using the
71486 * private key associated with the key identifier {@link priv_key_id} and
71487 * the envelope key {@link env_key}, and fills {@link open_data} with the
71488 * decrypted data. The envelope key is generated when the data are sealed
71489 * and can only be used by one specific private key. See {@link
71490 * openssl_seal} for more information.
71491 *
71492 * @param string $sealed_data
71493 * @param string $open_data If the call is successful the opened data
71494 *   is returned in this parameter.
71495 * @param string $env_key
71496 * @param mixed $priv_key_id
71497 * @param string $method The cipher method.
71498 * @param string $iv The initialization vector.
71499 * @return bool
71500 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
71501 **/
71502function openssl_open($sealed_data, &$open_data, $env_key, $priv_key_id, $method, $iv){}
71503
71504/**
71505 * Generates a PKCS5 v2 PBKDF2 string
71506 *
71507 * {@link openssl_pbkdf2} computes PBKDF2 (Password-Based Key Derivation
71508 * Function 2), a key derivation function defined in PKCS5 v2.
71509 *
71510 * @param string $password Password from which the derived key is
71511 *   generated.
71512 * @param string $salt PBKDF2 recommends a crytographic salt of at
71513 *   least 64 bits (8 bytes).
71514 * @param int $key_length Length of desired output key.
71515 * @param int $iterations The number of iterations desired. NIST
71516 *   recommends at least 10,000.
71517 * @param string $digest_algorithm Optional hash or digest algorithm
71518 *   from {@link openssl_get_md_methods}. Defaults to SHA-1.
71519 * @return string Returns raw binary string.
71520 * @since PHP 5 >= 5.5.0, PHP 7
71521 **/
71522function openssl_pbkdf2($password, $salt, $key_length, $iterations, $digest_algorithm){}
71523
71524/**
71525 * Decrypts an S/MIME encrypted message
71526 *
71527 * Decrypts the S/MIME encrypted message contained in the file specified
71528 * by {@link infilename} using the certificate and its associated private
71529 * key specified by {@link recipcert} and {@link recipkey}.
71530 *
71531 * @param string $infilename
71532 * @param string $outfilename The decrypted message is written to the
71533 *   file specified by {@link outfilename}.
71534 * @param mixed $recipcert
71535 * @param mixed $recipkey
71536 * @return bool
71537 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
71538 **/
71539function openssl_pkcs7_decrypt($infilename, $outfilename, $recipcert, $recipkey){}
71540
71541/**
71542 * Encrypt an S/MIME message
71543 *
71544 * {@link openssl_pkcs7_encrypt} takes the contents of the file named
71545 * {@link infile} and encrypts them using an RC2 40-bit cipher so that
71546 * they can only be read by the intended recipients specified by {@link
71547 * recipcerts}.
71548 *
71549 * @param string $infile
71550 * @param string $outfile
71551 * @param mixed $recipcerts Either a lone X.509 certificate, or an
71552 *   array of X.509 certificates.
71553 * @param array $headers {@link headers} is an array of headers that
71554 *   will be prepended to the data after it has been encrypted. {@link
71555 *   headers} can be either an associative array keyed by header name, or
71556 *   an indexed array, where each element contains a single header line.
71557 * @param int $flags {@link flags} can be used to specify options that
71558 *   affect the encoding process - see PKCS7 constants.
71559 * @param int $cipherid One of cipher constants.
71560 * @return bool
71561 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
71562 **/
71563function openssl_pkcs7_encrypt($infile, $outfile, $recipcerts, $headers, $flags, $cipherid){}
71564
71565/**
71566 * Export the PKCS7 file to an array of PEM certificates
71567 *
71568 * @param string $infilename
71569 * @param array $certs
71570 * @return bool
71571 * @since PHP 7 >= 7.2.0
71572 **/
71573function openssl_pkcs7_read($infilename, &$certs){}
71574
71575/**
71576 * Sign an S/MIME message
71577 *
71578 * {@link openssl_pkcs7_sign} takes the contents of the file named {@link
71579 * infilename} and signs them using the certificate and its matching
71580 * private key specified by {@link signcert} and {@link privkey}
71581 * parameters.
71582 *
71583 * @param string $infilename The input file you are intending to
71584 *   digitally sign.
71585 * @param string $outfilename The file which the digital signature will
71586 *   be written to.
71587 * @param mixed $signcert The X.509 certificate used to digitally sign
71588 *   infilename. See Key/Certificate parameters for a list of valid
71589 *   values.
71590 * @param mixed $privkey {@link privkey} is the private key
71591 *   corresponding to signcert. See Public/Private Key parameters for a
71592 *   list of valid values.
71593 * @param array $headers {@link headers} is an array of headers that
71594 *   will be prepended to the data after it has been signed (see {@link
71595 *   openssl_pkcs7_encrypt} for more information about the format of this
71596 *   parameter).
71597 * @param int $flags {@link flags} can be used to alter the output -
71598 *   see PKCS7 constants.
71599 * @param string $extracerts {@link extracerts} specifies the name of a
71600 *   file containing a bunch of extra certificates to include in the
71601 *   signature which can for example be used to help the recipient to
71602 *   verify the certificate that you used.
71603 * @return bool
71604 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
71605 **/
71606function openssl_pkcs7_sign($infilename, $outfilename, $signcert, $privkey, $headers, $flags, $extracerts){}
71607
71608/**
71609 * Verifies the signature of an S/MIME signed message
71610 *
71611 * {@link openssl_pkcs7_verify} reads the S/MIME message contained in the
71612 * given file and examines the digital signature.
71613 *
71614 * @param string $filename Path to the message.
71615 * @param int $flags {@link flags} can be used to affect how the
71616 *   signature is verified - see PKCS7 constants for more information.
71617 * @param string $outfilename If the {@link outfilename} is specified,
71618 *   it should be a string holding the name of a file into which the
71619 *   certificates of the persons that signed the messages will be stored
71620 *   in PEM format.
71621 * @param array $cainfo If the {@link cainfo} is specified, it should
71622 *   hold information about the trusted CA certificates to use in the
71623 *   verification process - see certificate verification for more
71624 *   information about this parameter.
71625 * @param string $extracerts If the {@link extracerts} is specified, it
71626 *   is the filename of a file containing a bunch of certificates to use
71627 *   as untrusted CAs.
71628 * @param string $content You can specify a filename with {@link
71629 *   content} that will be filled with the verified data, but with the
71630 *   signature information stripped.
71631 * @param string $p7bfilename
71632 * @return mixed Returns TRUE if the signature is verified, FALSE if it
71633 *   is not correct (the message has been tampered with, or the signing
71634 *   certificate is invalid), or -1 on error.
71635 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
71636 **/
71637function openssl_pkcs7_verify($filename, $flags, $outfilename, $cainfo, $extracerts, $content, $p7bfilename){}
71638
71639/**
71640 * Exports a PKCS#12 Compatible Certificate Store File to variable
71641 *
71642 * {@link openssl_pkcs12_export} stores {@link x509} into a string named
71643 * by {@link out} in a PKCS#12 file format.
71644 *
71645 * @param mixed $x509 On success, this will hold the PKCS#12.
71646 * @param string $out Private key component of PKCS#12 file. See
71647 *   Public/Private Key parameters for a list of valid values.
71648 * @param mixed $priv_key Encryption password for unlocking the PKCS#12
71649 *   file.
71650 * @param string $pass Optional array, other keys will be ignored. Key
71651 *   "extracerts" array of extra certificates or a single certificate to
71652 *   be included in the PKCS#12 file. "friendlyname" string to be used
71653 *   for the supplied certificate and key
71654 * @param array $args
71655 * @return bool
71656 * @since PHP 5 >= 5.2.2, PHP 7
71657 **/
71658function openssl_pkcs12_export($x509, &$out, $priv_key, $pass, $args){}
71659
71660/**
71661 * Exports a PKCS#12 Compatible Certificate Store File
71662 *
71663 * {@link openssl_pkcs12_export_to_file} stores {@link x509} into a file
71664 * named by {@link filename} in a PKCS#12 file format.
71665 *
71666 * @param mixed $x509 Path to the output file.
71667 * @param string $filename Private key component of PKCS#12 file. See
71668 *   Public/Private Key parameters for a list of valid values.
71669 * @param mixed $priv_key Encryption password for unlocking the PKCS#12
71670 *   file.
71671 * @param string $pass Optional array, other keys will be ignored. Key
71672 *   "extracerts" array of extra certificates or a single certificate to
71673 *   be included in the PKCS#12 file. "friendlyname" string to be used
71674 *   for the supplied certificate and key
71675 * @param array $args
71676 * @return bool
71677 * @since PHP 5 >= 5.2.2, PHP 7
71678 **/
71679function openssl_pkcs12_export_to_file($x509, $filename, $priv_key, $pass, $args){}
71680
71681/**
71682 * Parse a PKCS#12 Certificate Store into an array
71683 *
71684 * {@link openssl_pkcs12_read} parses the PKCS#12 certificate store
71685 * supplied by {@link pkcs12} into a array named {@link certs}.
71686 *
71687 * @param string $pkcs12 The certificate store contents, not its file
71688 *   name.
71689 * @param array $certs On success, this will hold the Certificate Store
71690 *   Data.
71691 * @param string $pass Encryption password for unlocking the PKCS#12
71692 *   file.
71693 * @return bool
71694 * @since PHP 5 >= 5.2.2, PHP 7
71695 **/
71696function openssl_pkcs12_read($pkcs12, &$certs, $pass){}
71697
71698/**
71699 * Gets an exportable representation of a key into a string
71700 *
71701 * {@link openssl_pkey_export} exports {@link key} as a PEM encoded
71702 * string and stores it into {@link out} (which is passed by reference).
71703 *
71704 * @param mixed $key
71705 * @param string $out
71706 * @param string $passphrase The key is optionally protected by {@link
71707 *   passphrase}.
71708 * @param array $configargs {@link configargs} can be used to fine-tune
71709 *   the export process by specifying and/or overriding options for the
71710 *   openssl configuration file. See {@link openssl_csr_new} for more
71711 *   information about {@link configargs}.
71712 * @return bool
71713 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
71714 **/
71715function openssl_pkey_export($key, &$out, $passphrase, $configargs){}
71716
71717/**
71718 * Gets an exportable representation of a key into a file
71719 *
71720 * {@link openssl_pkey_export_to_file} saves an ascii-armoured (PEM
71721 * encoded) rendition of {@link key} into the file named by {@link
71722 * outfilename}.
71723 *
71724 * @param mixed $key
71725 * @param string $outfilename Path to the output file.
71726 * @param string $passphrase The key can be optionally protected by a
71727 *   {@link passphrase}.
71728 * @param array $configargs {@link configargs} can be used to fine-tune
71729 *   the export process by specifying and/or overriding options for the
71730 *   openssl configuration file. See {@link openssl_csr_new} for more
71731 *   information about {@link configargs}.
71732 * @return bool
71733 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
71734 **/
71735function openssl_pkey_export_to_file($key, $outfilename, $passphrase, $configargs){}
71736
71737/**
71738 * Frees a private key
71739 *
71740 * This function frees a private key created by {@link openssl_pkey_new}.
71741 *
71742 * @param resource $key Resource holding the key.
71743 * @return void
71744 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
71745 **/
71746function openssl_pkey_free($key){}
71747
71748/**
71749 * Returns an array with the key details
71750 *
71751 * This function returns the key details (bits, key, type).
71752 *
71753 * @param resource $key Resource holding the key.
71754 * @return array Returns an array with the key details in success or
71755 *   FALSE in failure. Returned array has indexes bits (number of bits),
71756 *   key (string representation of the public key) and type (type of the
71757 *   key which is one of OPENSSL_KEYTYPE_RSA, OPENSSL_KEYTYPE_DSA,
71758 *   OPENSSL_KEYTYPE_DH, OPENSSL_KEYTYPE_EC or -1 meaning unknown).
71759 * @since PHP 5 >= 5.2.0, PHP 7
71760 **/
71761function openssl_pkey_get_details($key){}
71762
71763/**
71764 * Get a private key
71765 *
71766 * {@link openssl_pkey_get_private} parses {@link key} and prepares it
71767 * for use by other functions.
71768 *
71769 * @param mixed $key {@link key} can be one of the following: a string
71770 *   having the format file://path/to/file.pem. The named file must
71771 *   contain a PEM encoded certificate/private key (it may contain both).
71772 *   A PEM formatted private key.
71773 * @param string $passphrase The optional parameter {@link passphrase}
71774 *   must be used if the specified key is encrypted (protected by a
71775 *   passphrase).
71776 * @return resource Returns a positive key resource identifier on
71777 *   success, or FALSE on error.
71778 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
71779 **/
71780function openssl_pkey_get_private($key, $passphrase){}
71781
71782/**
71783 * Extract public key from certificate and prepare it for use
71784 *
71785 * {@link openssl_pkey_get_public} extracts the public key from {@link
71786 * certificate} and prepares it for use by other functions.
71787 *
71788 * @param mixed $certificate {@link certificate} can be one of the
71789 *   following: an X.509 certificate resource a string having the format
71790 *   file://path/to/file.pem. The named file must contain a PEM encoded
71791 *   certificate/public key (it may contain both). A PEM formatted public
71792 *   key.
71793 * @return resource Returns a positive key resource identifier on
71794 *   success, or FALSE on error.
71795 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
71796 **/
71797function openssl_pkey_get_public($certificate){}
71798
71799/**
71800 * Generates a new private key
71801 *
71802 * {@link openssl_pkey_new} generates a new private and public key pair.
71803 * The public component of the key can be obtained using {@link
71804 * openssl_pkey_get_public}.
71805 *
71806 * @param array $configargs You can finetune the key generation (such
71807 *   as specifying the number of bits) using {@link configargs}. See
71808 *   {@link openssl_csr_new} for more information about {@link
71809 *   configargs}.
71810 * @return resource Returns a resource identifier for the pkey on
71811 *   success, or FALSE on error.
71812 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
71813 **/
71814function openssl_pkey_new($configargs){}
71815
71816/**
71817 * Decrypts data with private key
71818 *
71819 * {@link openssl_private_decrypt} decrypts {@link data} that was
71820 * previously encrypted via {@link openssl_public_encrypt} and stores the
71821 * result into {@link decrypted}.
71822 *
71823 * You can use this function e.g. to decrypt data which is supposed to
71824 * only be available to you.
71825 *
71826 * @param string $data
71827 * @param string $decrypted
71828 * @param mixed $key {@link key} must be the private key corresponding
71829 *   that was used to encrypt the data.
71830 * @param int $padding {@link padding} can be one of
71831 *   OPENSSL_PKCS1_PADDING, OPENSSL_SSLV23_PADDING,
71832 *   OPENSSL_PKCS1_OAEP_PADDING, OPENSSL_NO_PADDING.
71833 * @return bool
71834 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
71835 **/
71836function openssl_private_decrypt($data, &$decrypted, $key, $padding){}
71837
71838/**
71839 * Encrypts data with private key
71840 *
71841 * {@link openssl_private_encrypt} encrypts {@link data} with private
71842 * {@link key} and stores the result into {@link crypted}. Encrypted data
71843 * can be decrypted via {@link openssl_public_decrypt}.
71844 *
71845 * This function can be used e.g. to sign data (or its hash) to prove
71846 * that it is not written by someone else.
71847 *
71848 * @param string $data
71849 * @param string $crypted
71850 * @param mixed $key
71851 * @param int $padding {@link padding} can be one of
71852 *   OPENSSL_PKCS1_PADDING, OPENSSL_NO_PADDING.
71853 * @return bool
71854 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
71855 **/
71856function openssl_private_encrypt($data, &$crypted, $key, $padding){}
71857
71858/**
71859 * Decrypts data with public key
71860 *
71861 * {@link openssl_public_decrypt} decrypts {@link data} that was previous
71862 * encrypted via {@link openssl_private_encrypt} and stores the result
71863 * into {@link decrypted}.
71864 *
71865 * You can use this function e.g. to check if the message was written by
71866 * the owner of the private key.
71867 *
71868 * @param string $data
71869 * @param string $decrypted
71870 * @param mixed $key {@link key} must be the public key corresponding
71871 *   that was used to encrypt the data.
71872 * @param int $padding {@link padding} can be one of
71873 *   OPENSSL_PKCS1_PADDING, OPENSSL_NO_PADDING.
71874 * @return bool
71875 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
71876 **/
71877function openssl_public_decrypt($data, &$decrypted, $key, $padding){}
71878
71879/**
71880 * Encrypts data with public key
71881 *
71882 * {@link openssl_public_encrypt} encrypts {@link data} with public
71883 * {@link key} and stores the result into {@link crypted}. Encrypted data
71884 * can be decrypted via {@link openssl_private_decrypt}.
71885 *
71886 * This function can be used e.g. to encrypt message which can be then
71887 * read only by owner of the private key. It can be also used to store
71888 * secure data in database.
71889 *
71890 * @param string $data
71891 * @param string $crypted This will hold the result of the encryption.
71892 * @param mixed $key The public key.
71893 * @param int $padding {@link padding} can be one of
71894 *   OPENSSL_PKCS1_PADDING, OPENSSL_SSLV23_PADDING,
71895 *   OPENSSL_PKCS1_OAEP_PADDING, OPENSSL_NO_PADDING.
71896 * @return bool
71897 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
71898 **/
71899function openssl_public_encrypt($data, &$crypted, $key, $padding){}
71900
71901/**
71902 * Generate a pseudo-random string of bytes
71903 *
71904 * Generates a string of pseudo-random bytes, with the number of bytes
71905 * determined by the {@link length} parameter.
71906 *
71907 * It also indicates if a cryptographically strong algorithm was used to
71908 * produce the pseudo-random bytes, and does this via the optional {@link
71909 * crypto_strong} parameter. It's rare for this to be FALSE, but some
71910 * systems may be broken or old.
71911 *
71912 * @param int $length The length of the desired string of bytes. Must
71913 *   be a positive integer. PHP will try to cast this parameter to a
71914 *   non-null integer to use it.
71915 * @param bool $crypto_strong If passed into the function, this will
71916 *   hold a boolean value that determines if the algorithm used was
71917 *   "cryptographically strong", e.g., safe for usage with GPG,
71918 *   passwords, etc. TRUE if it did, otherwise FALSE
71919 * @return string Returns the generated of bytes on success, .
71920 * @since PHP 5 >= 5.3.0, PHP 7
71921 **/
71922function openssl_random_pseudo_bytes($length, &$crypto_strong){}
71923
71924/**
71925 * Seal (encrypt) data
71926 *
71927 * {@link openssl_seal} seals (encrypts) {@link data} by using the given
71928 * {@link method} with a randomly generated secret key. The key is
71929 * encrypted with each of the public keys associated with the identifiers
71930 * in {@link pub_key_ids} and each encrypted key is returned in {@link
71931 * env_keys}. This means that one can send sealed data to multiple
71932 * recipients (provided one has obtained their public keys). Each
71933 * recipient must receive both the sealed data and the envelope key that
71934 * was encrypted with the recipient's public key.
71935 *
71936 * @param string $data The data to seal.
71937 * @param string $sealed_data The sealed data.
71938 * @param array $env_keys Array of encrypted keys.
71939 * @param array $pub_key_ids Array of public key resource identifiers.
71940 * @param string $method The cipher method.
71941 * @param string $iv The initialization vector.
71942 * @return int Returns the length of the sealed data on success, or
71943 *   FALSE on error. If successful the sealed data is returned in {@link
71944 *   sealed_data}, and the envelope keys in {@link env_keys}.
71945 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
71946 **/
71947function openssl_seal($data, &$sealed_data, &$env_keys, $pub_key_ids, $method, &$iv){}
71948
71949/**
71950 * Generate signature
71951 *
71952 * {@link openssl_sign} computes a signature for the specified {@link
71953 * data} by generating a cryptographic digital signature using the
71954 * private key associated with {@link priv_key_id}. Note that the data
71955 * itself is not encrypted.
71956 *
71957 * @param string $data The string of data you wish to sign
71958 * @param string $signature If the call was successful the signature is
71959 *   returned in {@link signature}.
71960 * @param mixed $priv_key_id resource - a key, returned by {@link
71961 *   openssl_get_privatekey} string - a PEM formatted key
71962 * @param mixed $signature_alg int - one of these Signature Algorithms.
71963 *   string - a valid string returned by {@link openssl_get_md_methods}
71964 *   example, "sha256WithRSAEncryption" or "sha384".
71965 * @return bool
71966 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
71967 **/
71968function openssl_sign($data, &$signature, $priv_key_id, $signature_alg){}
71969
71970/**
71971 * Exports a valid PEM formatted public key signed public key and
71972 * challenge
71973 *
71974 * Exports PEM formatted public key from encoded signed public key and
71975 * challenge
71976 *
71977 * @param string $spkac Expects a valid signed public key and challenge
71978 * @return string Returns the associated PEM formatted public key or
71979 *   NULL on failure.
71980 * @since PHP 5 >= 5.6.0, PHP 7
71981 **/
71982function openssl_spki_export(&$spkac){}
71983
71984/**
71985 * Exports the challenge associated with a signed public key and
71986 * challenge
71987 *
71988 * Exports challenge from encoded signed public key and challenge
71989 *
71990 * @param string $spkac Expects a valid signed public key and challenge
71991 * @return string Returns the associated challenge string or NULL on
71992 *   failure.
71993 * @since PHP 5 >= 5.6.0, PHP 7
71994 **/
71995function openssl_spki_export_challenge(&$spkac){}
71996
71997/**
71998 * Generate a new signed public key and challenge
71999 *
72000 * Generates a signed public key and challenge using specified hashing
72001 * algorithm
72002 *
72003 * @param resource $privkey {@link privkey} should be set to a private
72004 *   key that was previously generated by {@link openssl_pkey_new} (or
72005 *   otherwise obtained from the other openssl_pkey family of functions).
72006 *   The corresponding public portion of the key will be used to sign the
72007 *   CSR.
72008 * @param string $challenge The challenge associated to associate with
72009 *   the SPKAC
72010 * @param int $algorithm The digest algorithm. See
72011 *   openssl_get_md_method().
72012 * @return string Returns a signed public key and challenge string or
72013 *   NULL on failure.
72014 * @since PHP 5 >= 5.6.0, PHP 7
72015 **/
72016function openssl_spki_new(&$privkey, &$challenge, $algorithm){}
72017
72018/**
72019 * Verifies a signed public key and challenge
72020 *
72021 * Validates the supplied signed public key and challenge
72022 *
72023 * @param string $spkac Expects a valid signed public key and challenge
72024 * @return string Returns a boolean on success or failure.
72025 * @since PHP 5 >= 5.6.0, PHP 7
72026 **/
72027function openssl_spki_verify(&$spkac){}
72028
72029/**
72030 * Verify signature
72031 *
72032 * {@link openssl_verify} verifies that the {@link signature} is correct
72033 * for the specified {@link data} using the public key associated with
72034 * {@link pub_key_id}. This must be the public key corresponding to the
72035 * private key used for signing.
72036 *
72037 * @param string $data The string of data used to generate the
72038 *   signature previously
72039 * @param string $signature A raw binary string, generated by {@link
72040 *   openssl_sign} or similar means
72041 * @param mixed $pub_key_id resource - a key, returned by {@link
72042 *   openssl_get_publickey} string - a PEM formatted key, example,
72043 *   "-----BEGIN PUBLIC KEY----- MIIBCgK..."
72044 * @param mixed $signature_alg int - one of these Signature Algorithms.
72045 *   string - a valid string returned by {@link openssl_get_md_methods}
72046 *   example, "sha1WithRSAEncryption" or "sha512".
72047 * @return int Returns 1 if the signature is correct, 0 if it is
72048 *   incorrect, and -1 on error.
72049 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
72050 **/
72051function openssl_verify($data, $signature, $pub_key_id, $signature_alg){}
72052
72053/**
72054 * Verifies if a certificate can be used for a particular purpose
72055 *
72056 * {@link openssl_x509_checkpurpose} examines a certificate to see if it
72057 * can be used for the specified {@link purpose}.
72058 *
72059 * @param mixed $x509cert The examined certificate.
72060 * @param int $purpose {@link openssl_x509_checkpurpose} purposes
72061 *   Constant Description X509_PURPOSE_SSL_CLIENT Can the certificate be
72062 *   used for the client side of an SSL connection?
72063 *   X509_PURPOSE_SSL_SERVER Can the certificate be used for the server
72064 *   side of an SSL connection? X509_PURPOSE_NS_SSL_SERVER Can the cert
72065 *   be used for Netscape SSL server? X509_PURPOSE_SMIME_SIGN Can the
72066 *   cert be used to sign S/MIME email? X509_PURPOSE_SMIME_ENCRYPT Can
72067 *   the cert be used to encrypt S/MIME email? X509_PURPOSE_CRL_SIGN Can
72068 *   the cert be used to sign a certificate revocation list (CRL)?
72069 *   X509_PURPOSE_ANY Can the cert be used for Any/All purposes? These
72070 *   options are not bitfields - you may specify one only!
72071 * @param array $cainfo {@link cainfo} should be an array of trusted CA
72072 *   files/dirs as described in Certificate Verification.
72073 * @param string $untrustedfile If specified, this should be the name
72074 *   of a PEM encoded file holding certificates that can be used to help
72075 *   verify the certificate, although no trust is placed in the
72076 *   certificates that come from that file.
72077 * @return int Returns TRUE if the certificate can be used for the
72078 *   intended purpose, FALSE if it cannot, or -1 on error.
72079 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
72080 **/
72081function openssl_x509_checkpurpose($x509cert, $purpose, $cainfo, $untrustedfile){}
72082
72083/**
72084 * Checks if a private key corresponds to a certificate
72085 *
72086 * Checks whether the given {@link key} is the private key that
72087 * corresponds to {@link cert}.
72088 *
72089 * @param mixed $cert The certificate.
72090 * @param mixed $key The private key.
72091 * @return bool Returns TRUE if {@link key} is the private key that
72092 *   corresponds to {@link cert}, or FALSE otherwise.
72093 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
72094 **/
72095function openssl_x509_check_private_key($cert, $key){}
72096
72097/**
72098 * Exports a certificate as a string
72099 *
72100 * {@link openssl_x509_export} stores {@link x509} into a string named by
72101 * {@link output} in a PEM encoded format.
72102 *
72103 * @param mixed $x509 On success, this will hold the PEM.
72104 * @param string $output
72105 * @param bool $notext
72106 * @return bool
72107 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
72108 **/
72109function openssl_x509_export($x509, &$output, $notext){}
72110
72111/**
72112 * Exports a certificate to file
72113 *
72114 * {@link openssl_x509_export_to_file} stores {@link x509} into a file
72115 * named by {@link outfilename} in a PEM encoded format.
72116 *
72117 * @param mixed $x509 Path to the output file.
72118 * @param string $outfilename
72119 * @param bool $notext
72120 * @return bool
72121 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
72122 **/
72123function openssl_x509_export_to_file($x509, $outfilename, $notext){}
72124
72125/**
72126 * Calculates the fingerprint, or digest, of a given X.509 certificate
72127 *
72128 * {@link openssl_x509_fingerprint} returns the digest of {@link x509} as
72129 * a string.
72130 *
72131 * @param mixed $x509 The digest method or hash algorithm to use, e.g.
72132 *   "sha256", one of {@link openssl_get_md_methods}.
72133 * @param string $hash_algorithm When set to TRUE, outputs raw binary
72134 *   data. FALSE outputs lowercase hexits.
72135 * @param bool $raw_output
72136 * @return string Returns a string containing the calculated
72137 *   certificate fingerprint as lowercase hexits unless {@link
72138 *   raw_output} is set to TRUE in which case the raw binary
72139 *   representation of the message digest is returned.
72140 * @since PHP 5 >= 5.6.0, PHP 7
72141 **/
72142function openssl_x509_fingerprint($x509, $hash_algorithm, $raw_output){}
72143
72144/**
72145 * Free certificate resource
72146 *
72147 * {@link openssl_x509_free} frees the certificate associated with the
72148 * specified {@link x509cert} resource from memory.
72149 *
72150 * @param resource $x509cert
72151 * @return void
72152 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
72153 **/
72154function openssl_x509_free($x509cert){}
72155
72156/**
72157 * Parse an X509 certificate and return the information as an array
72158 *
72159 * {@link openssl_x509_parse} returns information about the supplied
72160 * {@link x509cert}, including fields such as subject name, issuer name,
72161 * purposes, valid from and valid to dates etc.
72162 *
72163 * @param mixed $x509cert X509 certificate. See Key/Certificate
72164 *   parameters for a list of valid values.
72165 * @param bool $shortnames {@link shortnames} controls how the data is
72166 *   indexed in the array - if {@link shortnames} is TRUE (the default)
72167 *   then fields will be indexed with the short name form, otherwise, the
72168 *   long name form will be used - e.g.: CN is the shortname form of
72169 *   commonName.
72170 * @return array The structure of the returned data is (deliberately)
72171 *   not yet documented, as it is still subject to change.
72172 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
72173 **/
72174function openssl_x509_parse($x509cert, $shortnames){}
72175
72176/**
72177 * Parse an X.509 certificate and return a resource identifier for it
72178 *
72179 * {@link openssl_x509_read} parses the certificate supplied by {@link
72180 * x509certdata} and returns a resource identifier for it.
72181 *
72182 * @param mixed $x509certdata X509 certificate. See Key/Certificate
72183 *   parameters for a list of valid values.
72184 * @return resource Returns a resource identifier on success.
72185 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
72186 **/
72187function openssl_x509_read($x509certdata){}
72188
72189/**
72190 * Verifies digital signature of x509 certificate against a public key
72191 *
72192 * {@link openssl_x509_verify} verifies that the {@link x509} certificate
72193 * was signed by the private key corresponding to public key {@link
72194 * pub_key_id}.
72195 *
72196 * @param mixed $x509 resource - a key, returned by {@link
72197 *   openssl_get_publickey} string - a PEM formatted key, example,
72198 *   "-----BEGIN PUBLIC KEY----- MIIBCgK..."
72199 * @param mixed $pub_key_id
72200 * @return int Returns 1 if the signature is correct, 0 if it is
72201 *   incorrect, and -1 on error.
72202 * @since PHP 7 >= 7.4.0
72203 **/
72204function openssl_x509_verify($x509, $pub_key_id){}
72205
72206/**
72207 * Convert the first byte of a string to a value between 0 and 255
72208 *
72209 * Interprets the binary value of the first byte of {@link string} as an
72210 * unsigned integer between 0 and 255.
72211 *
72212 * If the string is in a single-byte encoding, such as ASCII, ISO-8859,
72213 * or Windows 1252, this is equivalent to returning the position of a
72214 * character in the character set's mapping table. However, note that
72215 * this function is not aware of any string encoding, and in particular
72216 * will never identify a Unicode code point in a multi-byte encoding such
72217 * as UTF-8 or UTF-16.
72218 *
72219 * This function complements {@link chr}.
72220 *
72221 * @param string $string A character.
72222 * @return int An integer between 0 and 255.
72223 * @since PHP 4, PHP 5, PHP 7
72224 **/
72225function ord($string){}
72226
72227/**
72228 * Add URL rewriter values
72229 *
72230 * This function adds another name/value pair to the URL rewrite
72231 * mechanism. The name and value will be added to URLs (as GET parameter)
72232 * and forms (as hidden input fields) the same way as the session ID when
72233 * transparent URL rewriting is enabled with session.use_trans_sid.
72234 *
72235 * This function's behaviour is controlled by the url_rewriter.tags and
72236 * url_rewriter.hosts parameters.
72237 *
72238 * @param string $name The variable name.
72239 * @param string $value The variable value.
72240 * @return bool
72241 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
72242 **/
72243function output_add_rewrite_var($name, $value){}
72244
72245/**
72246 * Reset URL rewriter values
72247 *
72248 * This function resets the URL rewriter and removes all rewrite
72249 * variables previously set by the {@link output_add_rewrite_var}
72250 * function.
72251 *
72252 * @return bool
72253 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
72254 **/
72255function output_reset_rewrite_vars(){}
72256
72257/**
72258 * Overrides built-in functions
72259 *
72260 * Overrides built-in functions by replacing them in the symbol table.
72261 *
72262 * @param string $function_name The function to override.
72263 * @param string $function_args The function arguments, as a comma
72264 *   separated string. Usually you will want to pass this parameter, as
72265 *   well as the {@link function_code} parameter, as a single quote
72266 *   delimited string. The reason for using single quoted strings, is to
72267 *   protect the variable names from parsing, otherwise, if you use
72268 *   double quotes there will be a need to escape the variable names,
72269 *   e.g. \$your_var.
72270 * @param string $function_code The new code for the function.
72271 * @return bool
72272 * @since PECL apd >= 0.2
72273 **/
72274function override_function($function_name, $function_args, $function_code){}
72275
72276/**
72277 * Pack data into binary string
72278 *
72279 * Pack given arguments into a binary string according to {@link format}.
72280 *
72281 * The idea for this function was taken from Perl and all formatting
72282 * codes work the same as in Perl. However, there are some formatting
72283 * codes that are missing such as Perl's "u" format code.
72284 *
72285 * Note that the distinction between signed and unsigned values only
72286 * affects the function {@link unpack}, where as function {@link pack}
72287 * gives the same result for signed and unsigned format codes.
72288 *
72289 * @param string $format The {@link format} string consists of format
72290 *   codes followed by an optional repeater argument. The repeater
72291 *   argument can be either an integer value or * for repeating to the
72292 *   end of the input data. For a, A, h, H the repeat count specifies how
72293 *   many characters of one data argument are taken, for @ it is the
72294 *   absolute position where to put the next data, for everything else
72295 *   the repeat count specifies how many data arguments are consumed and
72296 *   packed into the resulting binary string. Currently implemented
72297 *   formats are: {@link pack} format characters Code Description a
72298 *   NUL-padded string A SPACE-padded string h Hex string, low nibble
72299 *   first H Hex string, high nibble first csigned char C unsigned char s
72300 *   signed short (always 16 bit, machine byte order) S unsigned short
72301 *   (always 16 bit, machine byte order) n unsigned short (always 16 bit,
72302 *   big endian byte order) v unsigned short (always 16 bit, little
72303 *   endian byte order) i signed integer (machine dependent size and byte
72304 *   order) I unsigned integer (machine dependent size and byte order) l
72305 *   signed long (always 32 bit, machine byte order) L unsigned long
72306 *   (always 32 bit, machine byte order) N unsigned long (always 32 bit,
72307 *   big endian byte order) V unsigned long (always 32 bit, little endian
72308 *   byte order) q signed long long (always 64 bit, machine byte order) Q
72309 *   unsigned long long (always 64 bit, machine byte order) J unsigned
72310 *   long long (always 64 bit, big endian byte order) P unsigned long
72311 *   long (always 64 bit, little endian byte order) f float (machine
72312 *   dependent size and representation) g float (machine dependent size,
72313 *   little endian byte order) G float (machine dependent size, big
72314 *   endian byte order) d double (machine dependent size and
72315 *   representation) e double (machine dependent size, little endian byte
72316 *   order) E double (machine dependent size, big endian byte order) x
72317 *   NUL byte X Back up one byte Z NUL-padded string (new in PHP 5.5) @
72318 *   NUL-fill to absolute position
72319 * @param mixed ...$vararg
72320 * @return string Returns a binary string containing data.
72321 * @since PHP 4, PHP 5, PHP 7
72322 **/
72323function pack($format, ...$vararg){}
72324
72325namespace parallel {
72326
72327/**
72328 * Bootstrapping
72329 *
72330 * Shall use the provided {@link file} to bootstrap all runtimes created
72331 * for automatic scheduling via {@link parallel\run}.
72332 *
72333 * @param string $file
72334 * @return void
72335 **/
72336function bootstrap($file){}
72337
72338}
72339
72340namespace parallel {
72341
72342/**
72343 * Execution
72344 *
72345 * Shall schedule {@link task} for execution in parallel.
72346 *
72347 * Shall schedule {@link task} for execution in parallel, passing {@link
72348 * argv} at execution time.
72349 *
72350 * @param Closure $task
72351 * @return ?Future
72352 **/
72353function run($task){}
72354
72355}
72356
72357/**
72358 * Compile a PHP file and return the resulting op array
72359 *
72360 * @param string $filename A string containing the name of the file to
72361 *   compile. Similar to the argument to {@link include}.
72362 * @param array $errors A 2D hash of errors (including fatal errors)
72363 *   encountered during compilation. Returned by reference.
72364 * @param int $options One of either PARSEKIT_QUIET or PARSEKIT_SIMPLE.
72365 *   To produce varying degrees of verbosity in the returned output.
72366 * @return array Returns a complex multi-layer array structure as
72367 *   detailed below.
72368 * @since PECL parsekit >= 0.2.0
72369 **/
72370function parsekit_compile_file($filename, &$errors, $options){}
72371
72372/**
72373 * Compile a string of PHP code and return the resulting op array
72374 *
72375 * @param string $phpcode A string containing phpcode. Similar to the
72376 *   argument to {@link eval}.
72377 * @param array $errors A 2D hash of errors (including fatal errors)
72378 *   encountered during compilation. Returned by reference.
72379 * @param int $options One of either PARSEKIT_QUIET or PARSEKIT_SIMPLE.
72380 *   To produce varying degrees of verbosity in the returned output.
72381 * @return array Returns a complex multi-layer array structure as
72382 *   detailed below.
72383 * @since PECL parsekit >= 0.2.0
72384 **/
72385function parsekit_compile_string($phpcode, &$errors, $options){}
72386
72387/**
72388 * Return information regarding function argument(s)
72389 *
72390 * @param mixed $function A string describing a function, or an array
72391 *   describing a class/method.
72392 * @return array Returns an array containing argument information.
72393 * @since PECL parsekit >= 0.3.0
72394 **/
72395function parsekit_func_arginfo($function){}
72396
72397/**
72398 * Parse a configuration file
72399 *
72400 * {@link parse_ini_file} loads in the ini file specified in {@link
72401 * filename}, and returns the settings in it in an associative array.
72402 *
72403 * The structure of the ini file is the same as the 's.
72404 *
72405 * @param string $filename The filename of the ini file being parsed.
72406 * @param bool $process_sections By setting the {@link
72407 *   process_sections} parameter to TRUE, you get a multidimensional
72408 *   array, with the section names and settings included. The default for
72409 *   {@link process_sections} is FALSE
72410 * @param int $scanner_mode Can either be INI_SCANNER_NORMAL (default)
72411 *   or INI_SCANNER_RAW. If INI_SCANNER_RAW is supplied, then option
72412 *   values will not be parsed.
72413 * @return array The settings are returned as an associative array on
72414 *   success, and FALSE on failure.
72415 * @since PHP 4, PHP 5, PHP 7
72416 **/
72417function parse_ini_file($filename, $process_sections, $scanner_mode){}
72418
72419/**
72420 * Parse a configuration string
72421 *
72422 * {@link parse_ini_string} returns the settings in string {@link ini} in
72423 * an associative array.
72424 *
72425 * The structure of the ini string is the same as the 's.
72426 *
72427 * @param string $ini The contents of the ini file being parsed.
72428 * @param bool $process_sections By setting the {@link
72429 *   process_sections} parameter to TRUE, you get a multidimensional
72430 *   array, with the section names and settings included. The default for
72431 *   {@link process_sections} is FALSE
72432 * @param int $scanner_mode Can either be INI_SCANNER_NORMAL (default)
72433 *   or INI_SCANNER_RAW. If INI_SCANNER_RAW is supplied, then option
72434 *   values will not be parsed.
72435 * @return array The settings are returned as an associative array on
72436 *   success, and FALSE on failure.
72437 * @since PHP 5 >= 5.3.0, PHP 7
72438 **/
72439function parse_ini_string($ini, $process_sections, $scanner_mode){}
72440
72441/**
72442 * Parses the string into variables
72443 *
72444 * Parses {@link encoded_string} as if it were the query string passed
72445 * via a URL and sets variables in the current scope (or in the array if
72446 * {@link result} is provided).
72447 *
72448 * @param string $encoded_string The input string.
72449 * @param array $result If the second parameter {@link result} is
72450 *   present, variables are stored in this variable as array elements
72451 *   instead.
72452 * @return void
72453 * @since PHP 4, PHP 5, PHP 7
72454 **/
72455function parse_str($encoded_string, &$result){}
72456
72457/**
72458 * Parse a URL and return its components
72459 *
72460 * This function parses a URL and returns an associative array containing
72461 * any of the various components of the URL that are present. The values
72462 * of the array elements are not URL decoded.
72463 *
72464 * This function is not meant to validate the given URL, it only breaks
72465 * it up into the above listed parts. Partial URLs are also accepted,
72466 * {@link parse_url} tries its best to parse them correctly.
72467 *
72468 * @param string $url The URL to parse. Invalid characters are replaced
72469 *   by _.
72470 * @param int $component Specify one of PHP_URL_SCHEME, PHP_URL_HOST,
72471 *   PHP_URL_PORT, PHP_URL_USER, PHP_URL_PASS, PHP_URL_PATH,
72472 *   PHP_URL_QUERY or PHP_URL_FRAGMENT to retrieve just a specific URL
72473 *   component as a string (except when PHP_URL_PORT is given, in which
72474 *   case the return value will be an integer).
72475 * @return mixed On seriously malformed URLs, {@link parse_url} may
72476 *   return FALSE.
72477 * @since PHP 4, PHP 5, PHP 7
72478 **/
72479function parse_url($url, $component){}
72480
72481/**
72482 * Execute an external program and display raw output
72483 *
72484 * The {@link passthru} function is similar to the {@link exec} function
72485 * in that it executes a {@link command}. This function should be used in
72486 * place of {@link exec} or {@link system} when the output from the Unix
72487 * command is binary data which needs to be passed directly back to the
72488 * browser. A common use for this is to execute something like the
72489 * pbmplus utilities that can output an image stream directly. By setting
72490 * the Content-type to image/gif and then calling a pbmplus program to
72491 * output a gif, you can create PHP scripts that output images directly.
72492 *
72493 * @param string $command The command that will be executed.
72494 * @param int $return_var If the {@link return_var} argument is
72495 *   present, the return status of the Unix command will be placed here.
72496 * @return void
72497 * @since PHP 4, PHP 5, PHP 7
72498 **/
72499function passthru($command, &$return_var){}
72500
72501/**
72502 * Get available password hashing algorithm IDs
72503 *
72504 * Returns a complete list of all registered password hashing algorithm
72505 * IDs as an of s.
72506 *
72507 * @return array Returns the available password hashing algorithm IDs.
72508 * @since PHP 7 >= 7.4.0
72509 **/
72510function password_algos(){}
72511
72512/**
72513 * Returns information about the given hash
72514 *
72515 * When passed in a valid hash created by an algorithm supported by
72516 * {@link password_hash}, this function will return an array of
72517 * information about that hash.
72518 *
72519 * @param string $hash
72520 * @return array Returns an associative array with three elements:
72521 *   algo, which will match a password algorithm constant algoName, which
72522 *   has the human readable name of the algorithm options, which includes
72523 *   the options provided when calling {@link password_hash}
72524 * @since PHP 5 >= 5.5.0, PHP 7
72525 **/
72526function password_get_info($hash){}
72527
72528/**
72529 * Creates a password hash
72530 *
72531 * {@link password_hash} creates a new password hash using a strong
72532 * one-way hashing algorithm. {@link password_hash} is compatible with
72533 * {@link crypt}. Therefore, password hashes created by {@link crypt} can
72534 * be used with {@link password_hash}.
72535 *
72536 * PASSWORD_DEFAULT - Use the bcrypt algorithm (default as of PHP 5.5.0).
72537 * Note that this constant is designed to change over time as new and
72538 * stronger algorithms are added to PHP. For that reason, the length of
72539 * the result from using this identifier can change over time. Therefore,
72540 * it is recommended to store the result in a database column that can
72541 * expand beyond 60 characters (255 characters would be a good choice).
72542 * PASSWORD_BCRYPT - Use the CRYPT_BLOWFISH algorithm to create the hash.
72543 * This will produce a standard {@link crypt} compatible hash using the
72544 * "$2y$" identifier. The result will always be a 60 character string, .
72545 * PASSWORD_ARGON2I - Use the Argon2i hashing algorithm to create the
72546 * hash. This algorithm is only available if PHP has been compiled with
72547 * Argon2 support. PASSWORD_ARGON2ID - Use the Argon2id hashing algorithm
72548 * to create the hash. This algorithm is only available if PHP has been
72549 * compiled with Argon2 support.
72550 *
72551 * salt (string) - to manually provide a salt to use when hashing the
72552 * password. Note that this will override and prevent a salt from being
72553 * automatically generated. If omitted, a random salt will be generated
72554 * by {@link password_hash} for each password hashed. This is the
72555 * intended mode of operation. The salt option has been deprecated as of
72556 * PHP 7.0.0. It is now preferred to simply use the salt that is
72557 * generated by default. cost (integer) - which denotes the algorithmic
72558 * cost that should be used. Examples of these values can be found on the
72559 * {@link crypt} page. If omitted, a default value of 10 will be used.
72560 * This is a good baseline cost, but you may want to consider increasing
72561 * it depending on your hardware.
72562 *
72563 * memory_cost (integer) - Maximum memory (in kibibytes) that may be used
72564 * to compute the Argon2 hash. Defaults to
72565 * PASSWORD_ARGON2_DEFAULT_MEMORY_COST. time_cost (integer) - Maximum
72566 * amount of time it may take to compute the Argon2 hash. Defaults to
72567 * PASSWORD_ARGON2_DEFAULT_TIME_COST. threads (integer) - Number of
72568 * threads to use for computing the Argon2 hash. Defaults to
72569 * PASSWORD_ARGON2_DEFAULT_THREADS.
72570 *
72571 * @param string $password
72572 * @param mixed $algo
72573 * @param array $options If omitted, a random salt will be created and
72574 *   the default cost will be used.
72575 * @return string Returns the hashed password, .
72576 * @since PHP 5 >= 5.5.0, PHP 7
72577 **/
72578function password_hash($password, $algo, $options){}
72579
72580/**
72581 * Checks if the given hash matches the given options
72582 *
72583 * This function checks to see if the supplied hash implements the
72584 * algorithm and options provided. If not, it is assumed that the hash
72585 * needs to be rehashed.
72586 *
72587 * @param string $hash
72588 * @param mixed $algo
72589 * @param array $options
72590 * @return bool Returns TRUE if the hash should be rehashed to match
72591 *   the given {@link algo} and {@link options}, or FALSE otherwise.
72592 * @since PHP 5 >= 5.5.0, PHP 7
72593 **/
72594function password_needs_rehash($hash, $algo, $options){}
72595
72596/**
72597 * Verifies that a password matches a hash
72598 *
72599 * Verifies that the given hash matches the given password.
72600 *
72601 * Note that {@link password_hash} returns the algorithm, cost and salt
72602 * as part of the returned hash. Therefore, all information that's needed
72603 * to verify the hash is included in it. This allows the verify function
72604 * to verify the hash without needing separate storage for the salt or
72605 * algorithm information.
72606 *
72607 * This function is safe against timing attacks.
72608 *
72609 * @param string $password
72610 * @param string $hash
72611 * @return bool Returns TRUE if the password and hash match, or FALSE
72612 *   otherwise.
72613 * @since PHP 5 >= 5.5.0, PHP 7
72614 **/
72615function password_verify($password, $hash){}
72616
72617/**
72618 * Returns information about a file path
72619 *
72620 * {@link pathinfo} returns information about {@link path}: either an
72621 * associative array or a string, depending on {@link options}.
72622 *
72623 * @param string $path The path to be parsed.
72624 * @param int $options If present, specifies a specific element to be
72625 *   returned; one of PATHINFO_DIRNAME, PATHINFO_BASENAME,
72626 *   PATHINFO_EXTENSION or PATHINFO_FILENAME. If {@link options} is not
72627 *   specified, returns all available elements.
72628 * @return mixed If the {@link options} parameter is not passed, an
72629 *   associative array containing the following elements is returned:
72630 *   dirname, basename, extension (if any), and filename.
72631 * @since PHP 4 >= 4.0.3, PHP 5, PHP 7
72632 **/
72633function pathinfo($path, $options){}
72634
72635/**
72636 * Closes process file pointer
72637 *
72638 * Closes a file pointer to a pipe opened by {@link popen}.
72639 *
72640 * @param resource $handle The file pointer must be valid, and must
72641 *   have been returned by a successful call to {@link popen}.
72642 * @return int Returns the termination status of the process that was
72643 *   run. In case of an error then -1 is returned.
72644 * @since PHP 4, PHP 5, PHP 7
72645 **/
72646function pclose($handle){}
72647
72648/**
72649 * Set an alarm clock for delivery of a signal
72650 *
72651 * Creates a timer that will send a SIGALRM signal to the process after
72652 * the given number of seconds. Any call to {@link pcntl_alarm} will
72653 * cancel any previously set alarm.
72654 *
72655 * @param int $seconds The number of seconds to wait. If {@link
72656 *   seconds} is zero, no new alarm is created.
72657 * @return int Returns the time in seconds that any previously
72658 *   scheduled alarm had remaining before it was to be delivered, or 0 if
72659 *   there was no previously scheduled alarm.
72660 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
72661 **/
72662function pcntl_alarm($seconds){}
72663
72664/**
72665 * Enable/disable asynchronous signal handling or return the old setting
72666 *
72667 * If the {@link on} parameter is omitted, {@link pcntl_async_signals}
72668 * returns whether asynchronous signal handling is enabled. Otherwise,
72669 * asynchronous signal handling is enabled or disabled.
72670 *
72671 * @param bool $on Whether asynchronous signal handling should be
72672 *   enabled.
72673 * @return bool When used as getter (that is without the optional
72674 *   parameter) it returns whether asynchronous signal handling is
72675 *   enabled. When used as setter (that is with the optional parameter
72676 *   given), it returns whether asynchronous signal handling was enabled
72677 *   before the function call.
72678 * @since PHP 7 >= 7.1.0
72679 **/
72680function pcntl_async_signals($on){}
72681
72682/**
72683 * Retrieve the error number set by the last pcntl function which failed
72684 *
72685 * @return int Returns error code.
72686 * @since PHP 5 >= 5.3.4, PHP 7
72687 **/
72688function pcntl_errno(){}
72689
72690/**
72691 * Executes specified program in current process space
72692 *
72693 * Executes the program with the given arguments.
72694 *
72695 * @param string $path {@link path} must be the path to a binary
72696 *   executable or a script with a valid path pointing to an executable
72697 *   in the shebang ( #!/usr/local/bin/perl for example) as the first
72698 *   line. See your system's man execve(2) page for additional
72699 *   information.
72700 * @param array $args {@link args} is an array of argument strings
72701 *   passed to the program.
72702 * @param array $envs {@link envs} is an array of strings which are
72703 *   passed as environment to the program. The array is in the format of
72704 *   name => value, the key being the name of the environmental variable
72705 *   and the value being the value of that variable.
72706 * @return void
72707 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
72708 **/
72709function pcntl_exec($path, $args, $envs){}
72710
72711/**
72712 * Forks the currently running process
72713 *
72714 * The {@link pcntl_fork} function creates a child process that differs
72715 * from the parent process only in its PID and PPID. Please see your
72716 * system's fork(2) man page for specific details as to how fork works on
72717 * your system.
72718 *
72719 * @return int On success, the PID of the child process is returned in
72720 *   the parent's thread of execution, and a 0 is returned in the child's
72721 *   thread of execution. On failure, a -1 will be returned in the
72722 *   parent's context, no child process will be created, and a PHP error
72723 *   is raised.
72724 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
72725 **/
72726function pcntl_fork(){}
72727
72728/**
72729 * Get the priority of any process
72730 *
72731 * {@link pcntl_getpriority} gets the priority of {@link pid}. Because
72732 * priority levels can differ between system types and kernel versions,
72733 * please see your system's getpriority(2) man page for specific details.
72734 *
72735 * @param int $pid If not specified, the pid of the current process is
72736 *   used.
72737 * @param int $process_identifier One of PRIO_PGRP, PRIO_USER or
72738 *   PRIO_PROCESS.
72739 * @return int {@link pcntl_getpriority} returns the priority of the
72740 *   process or FALSE on error. A lower numerical value causes more
72741 *   favorable scheduling.
72742 * @since PHP 5, PHP 7
72743 **/
72744function pcntl_getpriority($pid, $process_identifier){}
72745
72746/**
72747 * Retrieve the error number set by the last pcntl function which failed
72748 *
72749 * @return int Returns error code.
72750 * @since PHP 5 >= 5.3.4, PHP 7
72751 **/
72752function pcntl_get_last_error(){}
72753
72754/**
72755 * Change the priority of any process
72756 *
72757 * {@link pcntl_setpriority} sets the priority of {@link pid}.
72758 *
72759 * @param int $priority {@link priority} is generally a value in the
72760 *   range -20 to 20. The default priority is 0 while a lower numerical
72761 *   value causes more favorable scheduling. Because priority levels can
72762 *   differ between system types and kernel versions, please see your
72763 *   system's setpriority(2) man page for specific details.
72764 * @param int $pid If not specified, the pid of the current process is
72765 *   used.
72766 * @param int $process_identifier One of PRIO_PGRP, PRIO_USER or
72767 *   PRIO_PROCESS.
72768 * @return bool
72769 * @since PHP 5, PHP 7
72770 **/
72771function pcntl_setpriority($priority, $pid, $process_identifier){}
72772
72773/**
72774 * Installs a signal handler
72775 *
72776 * The {@link pcntl_signal} function installs a new signal handler or
72777 * replaces the current signal handler for the signal indicated by {@link
72778 * signo}.
72779 *
72780 * @param int $signo The signal number.
72781 * @param callable|int $handler The signal handler. This may be either
72782 *   a callable, which will be invoked to handle the signal, or either of
72783 *   the two global constants SIG_IGN or SIG_DFL, which will ignore the
72784 *   signal or restore the default signal handler respectively. If a
72785 *   callable is given, it must implement the following signature:
72786 *
72787 *   voidhandler int{@link signo} mixed{@link signinfo} {@link signo} The
72788 *   signal being handled. {@link siginfo} If operating systems supports
72789 *   siginfo_t structures, this will be an array of signal information
72790 *   dependent on the signal.
72791 * @param bool $restart_syscalls
72792 * @return bool
72793 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
72794 **/
72795function pcntl_signal($signo, $handler, $restart_syscalls){}
72796
72797/**
72798 * Calls signal handlers for pending signals
72799 *
72800 * The {@link pcntl_signal_dispatch} function calls the signal handlers
72801 * installed by {@link pcntl_signal} for each pending signal.
72802 *
72803 * @return bool
72804 * @since PHP 5 >= 5.3.0, PHP 7
72805 **/
72806function pcntl_signal_dispatch(){}
72807
72808/**
72809 * Get the current handler for specified signal
72810 *
72811 * The {@link pcntl_signal_get_handler} function will get the current
72812 * handler for the specified {@link signo}.
72813 *
72814 * @param int $signo The signal number.
72815 * @return mixed This function may return an integer value that refers
72816 *   to SIG_DFL or SIG_IGN. If you set a custom handler a string value
72817 *   containing the function name is returned.
72818 * @since PHP 7 >= 7.1.0
72819 **/
72820function pcntl_signal_get_handler($signo){}
72821
72822/**
72823 * Sets and retrieves blocked signals
72824 *
72825 * The {@link pcntl_sigprocmask} function adds, removes or sets blocked
72826 * signals, depending on the {@link how} parameter.
72827 *
72828 * @param int $how Sets the behavior of {@link pcntl_sigprocmask}.
72829 *   Possible values: SIG_BLOCK: Add the signals to the currently blocked
72830 *   signals. SIG_UNBLOCK: Remove the signals from the currently blocked
72831 *   signals. SIG_SETMASK: Replace the currently blocked signals by the
72832 *   given list of signals.
72833 * @param array $set List of signals.
72834 * @param array $oldset The {@link oldset} parameter is set to an array
72835 *   containing the list of the previously blocked signals.
72836 * @return bool
72837 * @since PHP 5 >= 5.3.0, PHP 7
72838 **/
72839function pcntl_sigprocmask($how, $set, &$oldset){}
72840
72841/**
72842 * Waits for signals, with a timeout
72843 *
72844 * The {@link pcntl_sigtimedwait} function operates in exactly the same
72845 * way as {@link pcntl_sigwaitinfo} except that it takes two additional
72846 * parameters, {@link seconds} and {@link nanoseconds}, which enable an
72847 * upper bound to be placed on the time for which the script is
72848 * suspended.
72849 *
72850 * @param array $set Array of signals to wait for.
72851 * @param array $siginfo The {@link siginfo} is set to an array
72852 *   containing information about the signal. See {@link
72853 *   pcntl_sigwaitinfo}.
72854 * @param int $seconds Timeout in seconds.
72855 * @param int $nanoseconds Timeout in nanoseconds.
72856 * @return int On success, {@link pcntl_sigtimedwait} returns a signal
72857 *   number.
72858 * @since PHP 5 >= 5.3.0, PHP 7
72859 **/
72860function pcntl_sigtimedwait($set, &$siginfo, $seconds, $nanoseconds){}
72861
72862/**
72863 * Waits for signals
72864 *
72865 * The {@link pcntl_sigwaitinfo} function suspends execution of the
72866 * calling script until one of the signals given in {@link set} are
72867 * delivered. If one of the signal is already pending (e.g. blocked by
72868 * {@link pcntl_sigprocmask}), {@link pcntl_sigwaitinfo} will return
72869 * immediately.
72870 *
72871 * @param array $set Array of signals to wait for.
72872 * @param array $siginfo The {@link siginfo} parameter is set to an
72873 *   array containing information about the signal. The following
72874 *   elements are set for all signals: signo: Signal number errno: An
72875 *   error number code: Signal code The following elements may be set for
72876 *   the SIGCHLD signal: status: Exit value or signal utime: User time
72877 *   consumed stime: System time consumed pid: Sending process ID uid:
72878 *   Real user ID of sending process The following elements may be set
72879 *   for the SIGILL, SIGFPE, SIGSEGV and SIGBUS signals: addr: Memory
72880 *   location which caused fault The following element may be set for the
72881 *   SIGPOLL signal: band: Band event fd: File descriptor number
72882 * @return int On success, {@link pcntl_sigwaitinfo} returns a signal
72883 *   number.
72884 * @since PHP 5 >= 5.3.0, PHP 7
72885 **/
72886function pcntl_sigwaitinfo($set, &$siginfo){}
72887
72888/**
72889 * Retrieve the system error message associated with the given errno
72890 *
72891 * @param int $errno
72892 * @return string Returns error description on success.
72893 * @since PHP 5 >= 5.3.4, PHP 7
72894 **/
72895function pcntl_strerror($errno){}
72896
72897/**
72898 * Waits on or returns the status of a forked child
72899 *
72900 * The wait function suspends execution of the current process until a
72901 * child has exited, or until a signal is delivered whose action is to
72902 * terminate the current process or to call a signal handling function.
72903 * If a child has already exited by the time of the call (a so-called
72904 * "zombie" process), the function returns immediately. Any system
72905 * resources used by the child are freed. Please see your system's
72906 * wait(2) man page for specific details as to how wait works on your
72907 * system.
72908 *
72909 * @param int $status {@link pcntl_wait} will store status information
72910 *   in the {@link status} parameter which can be evaluated using the
72911 *   following functions: {@link pcntl_wifexited}, {@link
72912 *   pcntl_wifstopped}, {@link pcntl_wifsignaled}, {@link
72913 *   pcntl_wexitstatus}, {@link pcntl_wtermsig} and {@link
72914 *   pcntl_wstopsig}.
72915 * @param int $options If wait3 is available on your system (mostly
72916 *   BSD-style systems), you can provide the optional {@link options}
72917 *   parameter. If this parameter is not provided, wait will be used for
72918 *   the system call. If wait3 is not available, providing a value for
72919 *   options will have no effect. The value of options is the value of
72920 *   zero or more of the following two constants OR'ed together: Possible
72921 *   values for {@link options} WNOHANG Return immediately if no child
72922 *   has exited. WUNTRACED Return for children which are stopped, and
72923 *   whose status has not been reported.
72924 * @param array $rusage
72925 * @return int {@link pcntl_wait} returns the process ID of the child
72926 *   which exited, -1 on error or zero if WNOHANG was provided as an
72927 *   option (on wait3-available systems) and no child was available.
72928 * @since PHP 5, PHP 7
72929 **/
72930function pcntl_wait(&$status, $options, &$rusage){}
72931
72932/**
72933 * Waits on or returns the status of a forked child
72934 *
72935 * Suspends execution of the current process until a child as specified
72936 * by the {@link pid} argument has exited, or until a signal is delivered
72937 * whose action is to terminate the current process or to call a signal
72938 * handling function.
72939 *
72940 * If a child as requested by {@link pid} has already exited by the time
72941 * of the call (a so-called "zombie" process), the function returns
72942 * immediately. Any system resources used by the child are freed. Please
72943 * see your system's waitpid(2) man page for specific details as to how
72944 * waitpid works on your system.
72945 *
72946 * @param int $pid The value of {@link pid} can be one of the
72947 *   following: possible values for {@link pid} < -1 wait for any child
72948 *   process whose process group ID is equal to the absolute value of
72949 *   {@link pid}. -1 wait for any child process; this is the same
72950 *   behaviour that the wait function exhibits. 0 wait for any child
72951 *   process whose process group ID is equal to that of the calling
72952 *   process. > 0 wait for the child whose process ID is equal to the
72953 *   value of {@link pid}.
72954 * @param int $status {@link pcntl_waitpid} will store status
72955 *   information in the {@link status} parameter which can be evaluated
72956 *   using the following functions: {@link pcntl_wifexited}, {@link
72957 *   pcntl_wifstopped}, {@link pcntl_wifsignaled}, {@link
72958 *   pcntl_wexitstatus}, {@link pcntl_wtermsig} and {@link
72959 *   pcntl_wstopsig}.
72960 * @param int $options The value of {@link options} is the value of
72961 *   zero or more of the following two global constants OR'ed together:
72962 *   possible values for {@link options} WNOHANG return immediately if no
72963 *   child has exited. WUNTRACED return for children which are stopped,
72964 *   and whose status has not been reported.
72965 * @param array $rusage
72966 * @return int {@link pcntl_waitpid} returns the process ID of the
72967 *   child which exited, -1 on error or zero if WNOHANG was used and no
72968 *   child was available
72969 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
72970 **/
72971function pcntl_waitpid($pid, &$status, $options, &$rusage){}
72972
72973/**
72974 * Returns the return code of a terminated child
72975 *
72976 * Returns the return code of a terminated child. This function is only
72977 * useful if {@link pcntl_wifexited} returned TRUE.
72978 *
72979 * @param int $status
72980 * @return int Returns the return code, as an integer.
72981 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
72982 **/
72983function pcntl_wexitstatus($status){}
72984
72985/**
72986 * Checks if status code represents a normal exit
72987 *
72988 * Checks whether the child status code represents a normal exit.
72989 *
72990 * @param int $status
72991 * @return bool Returns TRUE if the child status code represents a
72992 *   normal exit, FALSE otherwise.
72993 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
72994 **/
72995function pcntl_wifexited($status){}
72996
72997/**
72998 * Checks whether the status code represents a termination due to a
72999 * signal
73000 *
73001 * Checks whether the child process exited because of a signal which was
73002 * not caught.
73003 *
73004 * @param int $status
73005 * @return bool Returns TRUE if the child process exited because of a
73006 *   signal which was not caught, FALSE otherwise.
73007 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
73008 **/
73009function pcntl_wifsignaled($status){}
73010
73011/**
73012 * Checks whether the child process is currently stopped
73013 *
73014 * Checks whether the child process which caused the return is currently
73015 * stopped; this is only possible if the call to {@link pcntl_waitpid}
73016 * was done using the option WUNTRACED.
73017 *
73018 * @param int $status
73019 * @return bool Returns TRUE if the child process which caused the
73020 *   return is currently stopped, FALSE otherwise.
73021 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
73022 **/
73023function pcntl_wifstopped($status){}
73024
73025/**
73026 * Returns the signal which caused the child to stop
73027 *
73028 * Returns the number of the signal which caused the child to stop. This
73029 * function is only useful if {@link pcntl_wifstopped} returned TRUE.
73030 *
73031 * @param int $status
73032 * @return int Returns the signal number.
73033 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
73034 **/
73035function pcntl_wstopsig($status){}
73036
73037/**
73038 * Returns the signal which caused the child to terminate
73039 *
73040 * Returns the number of the signal that caused the child process to
73041 * terminate. This function is only useful if {@link pcntl_wifsignaled}
73042 * returned TRUE.
73043 *
73044 * @param int $status
73045 * @return int Returns the signal number, as an integer.
73046 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
73047 **/
73048function pcntl_wtermsig($status){}
73049
73050/**
73051 * Activate structure element or other content item
73052 *
73053 * Activates a previously created structure element or other content
73054 * item.
73055 *
73056 * @param resource $pdfdoc
73057 * @param int $id
73058 * @return bool
73059 * @since PECL pdflib >= 2.0.0
73060 **/
73061function PDF_activate_item($pdfdoc, $id){}
73062
73063/**
73064 * Add launch annotation for current page [deprecated]
73065 *
73066 * Adds a link to a web resource.
73067 *
73068 * This function is deprecated since PDFlib version 6, use {@link
73069 * PDF_create_action} with {@link type=Launch} and {@link
73070 * PDF_create_annotation} with {@link type=Link} instead.
73071 *
73072 * @param resource $pdfdoc
73073 * @param float $llx
73074 * @param float $lly
73075 * @param float $urx
73076 * @param float $ury
73077 * @param string $filename
73078 * @return bool
73079 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
73080 **/
73081function PDF_add_launchlink($pdfdoc, $llx, $lly, $urx, $ury, $filename){}
73082
73083/**
73084 * Add link annotation for current page [deprecated]
73085 *
73086 * Add a link annotation to a target within the current PDF file.
73087 *
73088 * This function is deprecated since PDFlib version 6, use {@link
73089 * PDF_create_action} with {@link type=GoTo} and {@link
73090 * PDF_create_annotation} with {@link type=Link} instead.
73091 *
73092 * @param resource $pdfdoc
73093 * @param float $lowerleftx
73094 * @param float $lowerlefty
73095 * @param float $upperrightx
73096 * @param float $upperrighty
73097 * @param int $page
73098 * @param string $dest
73099 * @return bool
73100 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
73101 **/
73102function PDF_add_locallink($pdfdoc, $lowerleftx, $lowerlefty, $upperrightx, $upperrighty, $page, $dest){}
73103
73104/**
73105 * Create named destination
73106 *
73107 * Creates a named destination on an arbitrary page in the current
73108 * document.
73109 *
73110 * @param resource $pdfdoc
73111 * @param string $name
73112 * @param string $optlist
73113 * @return bool
73114 * @since PECL pdflib >= 2.0.0
73115 **/
73116function PDF_add_nameddest($pdfdoc, $name, $optlist){}
73117
73118/**
73119 * Set annotation for current page [deprecated]
73120 *
73121 * Sets an annotation for the current page.
73122 *
73123 * This function is deprecated since PDFlib version 6, use {@link
73124 * PDF_create_annotation} with {@link type=Text} instead.
73125 *
73126 * @param resource $pdfdoc
73127 * @param float $llx
73128 * @param float $lly
73129 * @param float $urx
73130 * @param float $ury
73131 * @param string $contents
73132 * @param string $title
73133 * @param string $icon
73134 * @param int $open
73135 * @return bool
73136 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
73137 **/
73138function PDF_add_note($pdfdoc, $llx, $lly, $urx, $ury, $contents, $title, $icon, $open){}
73139
73140/**
73141 * Add file link annotation for current page [deprecated]
73142 *
73143 * Add a file link annotation to a PDF target.
73144 *
73145 * This function is deprecated since PDFlib version 6, use {@link
73146 * PDF_create_action} with {@link type=GoToR} and {@link
73147 * PDF_create_annotation} with {@link type=Link} instead.
73148 *
73149 * @param resource $pdfdoc
73150 * @param float $bottom_left_x
73151 * @param float $bottom_left_y
73152 * @param float $up_right_x
73153 * @param float $up_right_y
73154 * @param string $filename
73155 * @param int $page
73156 * @param string $dest
73157 * @return bool
73158 * @since PHP 4, PECL pdflib >= 1.0.0
73159 **/
73160function PDF_add_pdflink($pdfdoc, $bottom_left_x, $bottom_left_y, $up_right_x, $up_right_y, $filename, $page, $dest){}
73161
73162/**
73163 * Add a cell to a new or existing table
73164 *
73165 * Adds a cell to a new or existing table.
73166 *
73167 * @param resource $pdfdoc
73168 * @param int $table
73169 * @param int $column
73170 * @param int $row
73171 * @param string $text
73172 * @param string $optlist
73173 * @return int
73174 * @since PECL pdflib >= 2.1.0
73175 **/
73176function PDF_add_table_cell($pdfdoc, $table, $column, $row, $text, $optlist){}
73177
73178/**
73179 * Create Textflow or add text to existing Textflow
73180 *
73181 * Creates a Textflow object, or adds text and explicit options to an
73182 * existing Textflow.
73183 *
73184 * @param resource $pdfdoc
73185 * @param int $textflow
73186 * @param string $text
73187 * @param string $optlist
73188 * @return int
73189 * @since PECL pdflib >= 2.1.0
73190 **/
73191function PDF_add_textflow($pdfdoc, $textflow, $text, $optlist){}
73192
73193/**
73194 * Add thumbnail for current page
73195 *
73196 * Adds an existing image as thumbnail for the current page.
73197 *
73198 * @param resource $pdfdoc
73199 * @param int $image
73200 * @return bool
73201 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
73202 **/
73203function PDF_add_thumbnail($pdfdoc, $image){}
73204
73205/**
73206 * Add weblink for current page [deprecated]
73207 *
73208 * Adds a weblink annotation to a target {@link url} on the Web.
73209 *
73210 * This function is deprecated since PDFlib version 6, use {@link
73211 * PDF_create_action} with {@link type=URI} and {@link
73212 * PDF_create_annotation} with {@link type=Link} instead.
73213 *
73214 * @param resource $pdfdoc
73215 * @param float $lowerleftx
73216 * @param float $lowerlefty
73217 * @param float $upperrightx
73218 * @param float $upperrighty
73219 * @param string $url
73220 * @return bool
73221 * @since PHP 4, PECL pdflib >= 1.0.0
73222 **/
73223function PDF_add_weblink($pdfdoc, $lowerleftx, $lowerlefty, $upperrightx, $upperrighty, $url){}
73224
73225/**
73226 * Draw a counterclockwise circular arc segment
73227 *
73228 * Adds a counterclockwise circular arc.
73229 *
73230 * @param resource $p
73231 * @param float $x
73232 * @param float $y
73233 * @param float $r
73234 * @param float $alpha
73235 * @param float $beta
73236 * @return bool
73237 * @since PHP 4, PECL pdflib >= 1.0.0
73238 **/
73239function PDF_arc($p, $x, $y, $r, $alpha, $beta){}
73240
73241/**
73242 * Draw a clockwise circular arc segment
73243 *
73244 * Except for the drawing direction, this function behaves exactly like
73245 * {@link PDF_arc}.
73246 *
73247 * @param resource $p
73248 * @param float $x
73249 * @param float $y
73250 * @param float $r
73251 * @param float $alpha
73252 * @param float $beta
73253 * @return bool
73254 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
73255 **/
73256function PDF_arcn($p, $x, $y, $r, $alpha, $beta){}
73257
73258/**
73259 * Add file attachment for current page [deprecated]
73260 *
73261 * Adds a file attachment annotation.
73262 *
73263 * This function is deprecated since PDFlib version 6, use {@link
73264 * PDF_create_annotation} with {@link type=FileAttachment} instead.
73265 *
73266 * @param resource $pdfdoc
73267 * @param float $llx
73268 * @param float $lly
73269 * @param float $urx
73270 * @param float $ury
73271 * @param string $filename
73272 * @param string $description
73273 * @param string $author
73274 * @param string $mimetype
73275 * @param string $icon
73276 * @return bool
73277 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
73278 **/
73279function PDF_attach_file($pdfdoc, $llx, $lly, $urx, $ury, $filename, $description, $author, $mimetype, $icon){}
73280
73281/**
73282 * Create new PDF file
73283 *
73284 * Creates a new PDF file subject to various options.
73285 *
73286 * @param resource $pdfdoc
73287 * @param string $filename
73288 * @param string $optlist
73289 * @return int
73290 * @since PECL pdflib >= 2.0.0
73291 **/
73292function PDF_begin_document($pdfdoc, $filename, $optlist){}
73293
73294/**
73295 * Start a Type 3 font definition
73296 *
73297 * Starts a Type 3 font definition.
73298 *
73299 * @param resource $pdfdoc
73300 * @param string $filename
73301 * @param float $a
73302 * @param float $b
73303 * @param float $c
73304 * @param float $d
73305 * @param float $e
73306 * @param float $f
73307 * @param string $optlist
73308 * @return bool
73309 * @since PECL pdflib >= 2.0.0
73310 **/
73311function PDF_begin_font($pdfdoc, $filename, $a, $b, $c, $d, $e, $f, $optlist){}
73312
73313/**
73314 * Start glyph definition for Type 3 font
73315 *
73316 * Starts a glyph definition for a Type 3 font.
73317 *
73318 * @param resource $pdfdoc
73319 * @param string $glyphname
73320 * @param float $wx
73321 * @param float $llx
73322 * @param float $lly
73323 * @param float $urx
73324 * @param float $ury
73325 * @return bool
73326 * @since PECL pdflib >= 2.0.0
73327 **/
73328function PDF_begin_glyph($pdfdoc, $glyphname, $wx, $llx, $lly, $urx, $ury){}
73329
73330/**
73331 * Open structure element or other content item
73332 *
73333 * Opens a structure element or other content item with attributes
73334 * supplied as options.
73335 *
73336 * @param resource $pdfdoc
73337 * @param string $tag
73338 * @param string $optlist
73339 * @return int
73340 * @since PECL pdflib >= 2.0.0
73341 **/
73342function PDF_begin_item($pdfdoc, $tag, $optlist){}
73343
73344/**
73345 * Start layer
73346 *
73347 * Starts a layer for subsequent output on the page.
73348 *
73349 * This function requires PDF 1.5.
73350 *
73351 * @param resource $pdfdoc
73352 * @param int $layer
73353 * @return bool
73354 * @since PECL pdflib >= 2.0.0
73355 **/
73356function PDF_begin_layer($pdfdoc, $layer){}
73357
73358/**
73359 * Start new page [deprecated]
73360 *
73361 * Adds a new page to the document.
73362 *
73363 * This function is deprecated since PDFlib version 6, use {@link
73364 * PDF_begin_page_ext} instead.
73365 *
73366 * @param resource $pdfdoc
73367 * @param float $width
73368 * @param float $height
73369 * @return bool
73370 * @since PHP 4, PECL pdflib >= 1.0.0
73371 **/
73372function PDF_begin_page($pdfdoc, $width, $height){}
73373
73374/**
73375 * Start new page
73376 *
73377 * Adds a new page to the document, and specifies various options. The
73378 * parameters {@link width} and {@link height} are the dimensions of the
73379 * new page in points.
73380 *
73381 * Common Page Sizes in Points name size A0 2380 x 3368 A1 1684 x 2380 A2
73382 * 1190 x 1684 A3 842 x 1190 A4 595 x 842 A5 421 x 595 A6 297 x 421 B5
73383 * 501 x 709 letter (8.5" x 11") 612 x 792 legal (8.5" x 14") 612 x 1008
73384 * ledger (17" x 11") 1224 x 792 11" x 17" 792 x 1224
73385 *
73386 * @param resource $pdfdoc
73387 * @param float $width
73388 * @param float $height
73389 * @param string $optlist
73390 * @return bool
73391 * @since PECL pdflib >= 2.0.0
73392 **/
73393function PDF_begin_page_ext($pdfdoc, $width, $height, $optlist){}
73394
73395/**
73396 * Start pattern definition
73397 *
73398 * Starts a new pattern definition.
73399 *
73400 * @param resource $pdfdoc
73401 * @param float $width
73402 * @param float $height
73403 * @param float $xstep
73404 * @param float $ystep
73405 * @param int $painttype
73406 * @return int
73407 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
73408 **/
73409function PDF_begin_pattern($pdfdoc, $width, $height, $xstep, $ystep, $painttype){}
73410
73411/**
73412 * Start template definition [deprecated]
73413 *
73414 * Starts a new template definition.
73415 *
73416 * This function is deprecated since PDFlib version 7, use {@link
73417 * PDF_begin_template_ext} instead.
73418 *
73419 * @param resource $pdfdoc
73420 * @param float $width
73421 * @param float $height
73422 * @return int
73423 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
73424 **/
73425function PDF_begin_template($pdfdoc, $width, $height){}
73426
73427/**
73428 * Start template definition
73429 *
73430 * Starts a new template definition.
73431 *
73432 * @param resource $pdfdoc
73433 * @param float $width
73434 * @param float $height
73435 * @param string $optlist
73436 * @return int
73437 * @since PECL pdflib >= 2.1.0
73438 **/
73439function PDF_begin_template_ext($pdfdoc, $width, $height, $optlist){}
73440
73441/**
73442 * Draw a circle
73443 *
73444 * Adds a circle.
73445 *
73446 * @param resource $pdfdoc
73447 * @param float $x
73448 * @param float $y
73449 * @param float $r
73450 * @return bool
73451 * @since PHP 4, PECL pdflib >= 1.0.0
73452 **/
73453function PDF_circle($pdfdoc, $x, $y, $r){}
73454
73455/**
73456 * Clip to current path
73457 *
73458 * Uses the current path as clipping path, and terminate the path.
73459 *
73460 * @param resource $p
73461 * @return bool
73462 * @since PHP 4, PECL pdflib >= 1.0.0
73463 **/
73464function PDF_clip($p){}
73465
73466/**
73467 * Close pdf resource [deprecated]
73468 *
73469 * Closes the generated PDF file, and frees all document-related
73470 * resources.
73471 *
73472 * This function is deprecated since PDFlib version 6, use {@link
73473 * PDF_end_document} instead.
73474 *
73475 * @param resource $p
73476 * @return bool
73477 * @since PHP 4, PECL pdflib >= 1.0.0
73478 **/
73479function PDF_close($p){}
73480
73481/**
73482 * Close current path
73483 *
73484 * Closes the current path.
73485 *
73486 * @param resource $p
73487 * @return bool
73488 * @since PHP 4, PECL pdflib >= 1.0.0
73489 **/
73490function PDF_closepath($p){}
73491
73492/**
73493 * Close, fill and stroke current path
73494 *
73495 * Closes the path, fills, and strokes it.
73496 *
73497 * @param resource $p
73498 * @return bool
73499 * @since PHP 4, PECL pdflib >= 1.0.0
73500 **/
73501function PDF_closepath_fill_stroke($p){}
73502
73503/**
73504 * Close and stroke path
73505 *
73506 * Closes the path, and strokes it.
73507 *
73508 * @param resource $p
73509 * @return bool
73510 * @since PHP 4, PECL pdflib >= 1.0.0
73511 **/
73512function PDF_closepath_stroke($p){}
73513
73514/**
73515 * Close image
73516 *
73517 * Closes an {@link image} retrieved with the {@link PDF_open_image}
73518 * function.
73519 *
73520 * @param resource $p
73521 * @param int $image
73522 * @return bool
73523 * @since PHP 4, PECL pdflib >= 1.0.0
73524 **/
73525function PDF_close_image($p, $image){}
73526
73527/**
73528 * Close the input PDF document [deprecated]
73529 *
73530 * Closes all open page handles, and closes the input PDF document.
73531 *
73532 * This function is deprecated since PDFlib version 7, use {@link
73533 * PDF_close_pdi_document} instead.
73534 *
73535 * @param resource $p
73536 * @param int $doc
73537 * @return bool
73538 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
73539 **/
73540function PDF_close_pdi($p, $doc){}
73541
73542/**
73543 * Close the page handle
73544 *
73545 * Closes the page handle, and frees all page-related resources.
73546 *
73547 * @param resource $p
73548 * @param int $page
73549 * @return bool
73550 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
73551 **/
73552function PDF_close_pdi_page($p, $page){}
73553
73554/**
73555 * Concatenate a matrix to the CTM
73556 *
73557 * Concatenates a matrix to the current transformation matrix (CTM).
73558 *
73559 * @param resource $p
73560 * @param float $a
73561 * @param float $b
73562 * @param float $c
73563 * @param float $d
73564 * @param float $e
73565 * @param float $f
73566 * @return bool
73567 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
73568 **/
73569function PDF_concat($p, $a, $b, $c, $d, $e, $f){}
73570
73571/**
73572 * Output text in next line
73573 *
73574 * Prints {@link text} at the next line.
73575 *
73576 * @param resource $p
73577 * @param string $text
73578 * @return bool
73579 * @since PHP 4, PECL pdflib >= 1.0.0
73580 **/
73581function PDF_continue_text($p, $text){}
73582
73583/**
73584 * Create 3D view
73585 *
73586 * Creates a 3D view.
73587 *
73588 * This function requires PDF 1.6.
73589 *
73590 * @param resource $pdfdoc
73591 * @param string $username
73592 * @param string $optlist
73593 * @return int
73594 * @since PECL pdflib >= 2.1.0
73595 **/
73596function PDF_create_3dview($pdfdoc, $username, $optlist){}
73597
73598/**
73599 * Create action for objects or events
73600 *
73601 * Creates an action which can be applied to various objects and events.
73602 *
73603 * @param resource $pdfdoc
73604 * @param string $type
73605 * @param string $optlist
73606 * @return int
73607 * @since PECL pdflib >= 2.0.0
73608 **/
73609function PDF_create_action($pdfdoc, $type, $optlist){}
73610
73611/**
73612 * Create rectangular annotation
73613 *
73614 * Creates a rectangular annotation on the current page.
73615 *
73616 * @param resource $pdfdoc
73617 * @param float $llx
73618 * @param float $lly
73619 * @param float $urx
73620 * @param float $ury
73621 * @param string $type
73622 * @param string $optlist
73623 * @return bool
73624 * @since PECL pdflib >= 2.0.0
73625 **/
73626function PDF_create_annotation($pdfdoc, $llx, $lly, $urx, $ury, $type, $optlist){}
73627
73628/**
73629 * Create bookmark
73630 *
73631 * Creates a bookmark subject to various options.
73632 *
73633 * @param resource $pdfdoc
73634 * @param string $text
73635 * @param string $optlist
73636 * @return int
73637 * @since PECL pdflib >= 2.0.0
73638 **/
73639function PDF_create_bookmark($pdfdoc, $text, $optlist){}
73640
73641/**
73642 * Create form field
73643 *
73644 * Creates a form field on the current page subject to various options.
73645 *
73646 * @param resource $pdfdoc
73647 * @param float $llx
73648 * @param float $lly
73649 * @param float $urx
73650 * @param float $ury
73651 * @param string $name
73652 * @param string $type
73653 * @param string $optlist
73654 * @return bool
73655 * @since PECL pdflib >= 2.0.0
73656 **/
73657function PDF_create_field($pdfdoc, $llx, $lly, $urx, $ury, $name, $type, $optlist){}
73658
73659/**
73660 * Create form field group
73661 *
73662 * Creates a form field group subject to various options.
73663 *
73664 * @param resource $pdfdoc
73665 * @param string $name
73666 * @param string $optlist
73667 * @return bool
73668 * @since PECL pdflib >= 2.0.0
73669 **/
73670function PDF_create_fieldgroup($pdfdoc, $name, $optlist){}
73671
73672/**
73673 * Create graphics state object
73674 *
73675 * Creates a graphics state object subject to various options.
73676 *
73677 * @param resource $pdfdoc
73678 * @param string $optlist
73679 * @return int
73680 * @since PECL pdflib >= 2.0.0
73681 **/
73682function PDF_create_gstate($pdfdoc, $optlist){}
73683
73684/**
73685 * Create PDFlib virtual file
73686 *
73687 * Creates a named virtual read-only file from data provided in memory.
73688 *
73689 * @param resource $pdfdoc
73690 * @param string $filename
73691 * @param string $data
73692 * @param string $optlist
73693 * @return bool
73694 * @since PECL pdflib >= 2.0.0
73695 **/
73696function PDF_create_pvf($pdfdoc, $filename, $data, $optlist){}
73697
73698/**
73699 * Create textflow object
73700 *
73701 * Preprocesses text for later formatting and creates a textflow object.
73702 *
73703 * @param resource $pdfdoc
73704 * @param string $text
73705 * @param string $optlist
73706 * @return int
73707 * @since PECL pdflib >= 2.0.0
73708 **/
73709function PDF_create_textflow($pdfdoc, $text, $optlist){}
73710
73711/**
73712 * Draw Bezier curve
73713 *
73714 * Draws a Bezier curve from the current point, using 3 more control
73715 * points.
73716 *
73717 * @param resource $p
73718 * @param float $x1
73719 * @param float $y1
73720 * @param float $x2
73721 * @param float $y2
73722 * @param float $x3
73723 * @param float $y3
73724 * @return bool
73725 * @since PHP 4, PECL pdflib >= 1.0.0
73726 **/
73727function PDF_curveto($p, $x1, $y1, $x2, $y2, $x3, $y3){}
73728
73729/**
73730 * Create layer definition
73731 *
73732 * Creates a new layer definition.
73733 *
73734 * This function requires PDF 1.5.
73735 *
73736 * @param resource $pdfdoc
73737 * @param string $name
73738 * @param string $optlist
73739 * @return int
73740 * @since PECL pdflib >= 2.0.0
73741 **/
73742function PDF_define_layer($pdfdoc, $name, $optlist){}
73743
73744/**
73745 * Delete PDFlib object
73746 *
73747 * Deletes a PDFlib object, and frees all internal resources.
73748 *
73749 * @param resource $pdfdoc
73750 * @return bool
73751 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
73752 **/
73753function PDF_delete($pdfdoc){}
73754
73755/**
73756 * Delete PDFlib virtual file
73757 *
73758 * Deletes a named virtual file and frees its data structures (but not
73759 * the contents).
73760 *
73761 * @param resource $pdfdoc
73762 * @param string $filename
73763 * @return int
73764 * @since PECL pdflib >= 2.0.0
73765 **/
73766function PDF_delete_pvf($pdfdoc, $filename){}
73767
73768/**
73769 * Delete table object
73770 *
73771 * Deletes a table and all associated data structures.
73772 *
73773 * @param resource $pdfdoc
73774 * @param int $table
73775 * @param string $optlist
73776 * @return bool
73777 * @since PECL pdflib >= 2.1.0
73778 **/
73779function PDF_delete_table($pdfdoc, $table, $optlist){}
73780
73781/**
73782 * Delete textflow object
73783 *
73784 * Deletes a textflow and the associated data structures.
73785 *
73786 * @param resource $pdfdoc
73787 * @param int $textflow
73788 * @return bool
73789 * @since PECL pdflib >= 2.0.0
73790 **/
73791function PDF_delete_textflow($pdfdoc, $textflow){}
73792
73793/**
73794 * Add glyph name and/or Unicode value
73795 *
73796 * Adds a glyph name and/or Unicode value to a custom encoding.
73797 *
73798 * @param resource $pdfdoc
73799 * @param string $encoding
73800 * @param int $slot
73801 * @param string $glyphname
73802 * @param int $uv
73803 * @return bool
73804 * @since PECL pdflib >= 2.0.0
73805 **/
73806function PDF_encoding_set_char($pdfdoc, $encoding, $slot, $glyphname, $uv){}
73807
73808/**
73809 * End current path
73810 *
73811 * Ends the current path without filling or stroking it.
73812 *
73813 * @param resource $p
73814 * @return bool
73815 * @since PHP 4, PECL pdflib >= 1.0.0
73816 **/
73817function PDF_endpath($p){}
73818
73819/**
73820 * Close PDF file
73821 *
73822 * Closes the generated PDF file and applies various options.
73823 *
73824 * @param resource $pdfdoc
73825 * @param string $optlist
73826 * @return bool
73827 * @since PECL pdflib >= 2.0.0
73828 **/
73829function PDF_end_document($pdfdoc, $optlist){}
73830
73831/**
73832 * Terminate Type 3 font definition
73833 *
73834 * Terminates a Type 3 font definition.
73835 *
73836 * @param resource $pdfdoc
73837 * @return bool
73838 * @since PECL pdflib >= 2.0.0
73839 **/
73840function PDF_end_font($pdfdoc){}
73841
73842/**
73843 * Terminate glyph definition for Type 3 font
73844 *
73845 * Terminates a glyph definition for a Type 3 font.
73846 *
73847 * @param resource $pdfdoc
73848 * @return bool
73849 * @since PECL pdflib >= 2.0.0
73850 **/
73851function PDF_end_glyph($pdfdoc){}
73852
73853/**
73854 * Close structure element or other content item
73855 *
73856 * Closes a structure element or other content item.
73857 *
73858 * @param resource $pdfdoc
73859 * @param int $id
73860 * @return bool
73861 * @since PECL pdflib >= 2.0.0
73862 **/
73863function PDF_end_item($pdfdoc, $id){}
73864
73865/**
73866 * Deactivate all active layers
73867 *
73868 * Deactivates all active layers.
73869 *
73870 * This function requires PDF 1.5.
73871 *
73872 * @param resource $pdfdoc
73873 * @return bool
73874 * @since PECL pdflib >= 2.0.0
73875 **/
73876function PDF_end_layer($pdfdoc){}
73877
73878/**
73879 * Finish page
73880 *
73881 * Finishes the page.
73882 *
73883 * @param resource $p
73884 * @return bool
73885 * @since PHP 4, PECL pdflib >= 1.0.0
73886 **/
73887function PDF_end_page($p){}
73888
73889/**
73890 * Finish page
73891 *
73892 * Finishes a page, and applies various options.
73893 *
73894 * @param resource $pdfdoc
73895 * @param string $optlist
73896 * @return bool
73897 * @since PECL pdflib >= 2.0.0
73898 **/
73899function PDF_end_page_ext($pdfdoc, $optlist){}
73900
73901/**
73902 * Finish pattern
73903 *
73904 * Finishes the pattern definition.
73905 *
73906 * @param resource $p
73907 * @return bool
73908 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
73909 **/
73910function PDF_end_pattern($p){}
73911
73912/**
73913 * Finish template
73914 *
73915 * Finishes a template definition.
73916 *
73917 * @param resource $p
73918 * @return bool
73919 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
73920 **/
73921function PDF_end_template($p){}
73922
73923/**
73924 * Fill current path
73925 *
73926 * Fills the interior of the current path with the current fill color.
73927 *
73928 * @param resource $p
73929 * @return bool
73930 * @since PHP 4, PECL pdflib >= 1.0.0
73931 **/
73932function PDF_fill($p){}
73933
73934/**
73935 * Fill image block with variable data
73936 *
73937 * Fills an image block with variable data according to its properties.
73938 *
73939 * This function is only available in the PDFlib Personalization Server
73940 * (PPS).
73941 *
73942 * @param resource $pdfdoc
73943 * @param int $page
73944 * @param string $blockname
73945 * @param int $image
73946 * @param string $optlist
73947 * @return int
73948 * @since PECL pdflib >= 2.0.0
73949 **/
73950function PDF_fill_imageblock($pdfdoc, $page, $blockname, $image, $optlist){}
73951
73952/**
73953 * Fill PDF block with variable data
73954 *
73955 * Fills a PDF block with variable data according to its properties.
73956 *
73957 * This function is only available in the PDFlib Personalization Server
73958 * (PPS).
73959 *
73960 * @param resource $pdfdoc
73961 * @param int $page
73962 * @param string $blockname
73963 * @param int $contents
73964 * @param string $optlist
73965 * @return int
73966 * @since PECL pdflib >= 2.0.0
73967 **/
73968function PDF_fill_pdfblock($pdfdoc, $page, $blockname, $contents, $optlist){}
73969
73970/**
73971 * Fill and stroke path
73972 *
73973 * Fills and strokes the current path with the current fill and stroke
73974 * color.
73975 *
73976 * @param resource $p
73977 * @return bool
73978 * @since PHP 4, PECL pdflib >= 1.0.0
73979 **/
73980function PDF_fill_stroke($p){}
73981
73982/**
73983 * Fill text block with variable data
73984 *
73985 * Fills a text block with variable data according to its properties.
73986 *
73987 * This function is only available in the PDFlib Personalization Server
73988 * (PPS).
73989 *
73990 * @param resource $pdfdoc
73991 * @param int $page
73992 * @param string $blockname
73993 * @param string $text
73994 * @param string $optlist
73995 * @return int
73996 * @since PECL pdflib >= 2.0.0
73997 **/
73998function PDF_fill_textblock($pdfdoc, $page, $blockname, $text, $optlist){}
73999
74000/**
74001 * Prepare font for later use [deprecated]
74002 *
74003 * Search for a font and prepare it for later use with {@link
74004 * PDF_setfont}. The metrics will be loaded, and if {@link embed} is
74005 * nonzero, the font file will be checked, but not yet used. {@link
74006 * encoding} is one of builtin, macroman, winansi, host, a user-defined
74007 * encoding name or the name of a CMap. Parameter {@link embed} is
74008 * optional before PHP 4.3.5 or with PDFlib less than 5.
74009 *
74010 * This function is deprecated since PDFlib version 5, use {@link
74011 * PDF_load_font} instead.
74012 *
74013 * @param resource $p
74014 * @param string $fontname
74015 * @param string $encoding
74016 * @param int $embed
74017 * @return int
74018 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
74019 **/
74020function PDF_findfont($p, $fontname, $encoding, $embed){}
74021
74022/**
74023 * Place image or template
74024 *
74025 * Places an image or template on the page, subject to various options.
74026 *
74027 * @param resource $pdfdoc
74028 * @param int $image
74029 * @param float $x
74030 * @param float $y
74031 * @param string $optlist
74032 * @return bool
74033 * @since PECL pdflib >= 2.0.0
74034 **/
74035function PDF_fit_image($pdfdoc, $image, $x, $y, $optlist){}
74036
74037/**
74038 * Place imported PDF page
74039 *
74040 * Places an imported PDF page on the page, subject to various options.
74041 *
74042 * @param resource $pdfdoc
74043 * @param int $page
74044 * @param float $x
74045 * @param float $y
74046 * @param string $optlist
74047 * @return bool
74048 * @since PECL pdflib >= 2.0.0
74049 **/
74050function PDF_fit_pdi_page($pdfdoc, $page, $x, $y, $optlist){}
74051
74052/**
74053 * Place table on page
74054 *
74055 * Places a table on the page fully or partially.
74056 *
74057 * @param resource $pdfdoc
74058 * @param int $table
74059 * @param float $llx
74060 * @param float $lly
74061 * @param float $urx
74062 * @param float $ury
74063 * @param string $optlist
74064 * @return string
74065 * @since PECL pdflib >= 2.1.0
74066 **/
74067function PDF_fit_table($pdfdoc, $table, $llx, $lly, $urx, $ury, $optlist){}
74068
74069/**
74070 * Format textflow in rectangular area
74071 *
74072 * Formats the next portion of a textflow into a rectangular area.
74073 *
74074 * @param resource $pdfdoc
74075 * @param int $textflow
74076 * @param float $llx
74077 * @param float $lly
74078 * @param float $urx
74079 * @param float $ury
74080 * @param string $optlist
74081 * @return string
74082 * @since PECL pdflib >= 2.0.0
74083 **/
74084function PDF_fit_textflow($pdfdoc, $textflow, $llx, $lly, $urx, $ury, $optlist){}
74085
74086/**
74087 * Place single line of text
74088 *
74089 * Places a single line of text on the page, subject to various options.
74090 *
74091 * @param resource $pdfdoc
74092 * @param string $text
74093 * @param float $x
74094 * @param float $y
74095 * @param string $optlist
74096 * @return bool
74097 * @since PECL pdflib >= 2.0.0
74098 **/
74099function PDF_fit_textline($pdfdoc, $text, $x, $y, $optlist){}
74100
74101/**
74102 * Get name of unsuccessfull API function
74103 *
74104 * Gets the name of the API function which threw the last exception or
74105 * failed.
74106 *
74107 * @param resource $pdfdoc
74108 * @return string
74109 * @since PECL pdflib >= 2.0.0
74110 **/
74111function PDF_get_apiname($pdfdoc){}
74112
74113/**
74114 * Get PDF output buffer
74115 *
74116 * Fetches the buffer containing the generated PDF data.
74117 *
74118 * @param resource $p
74119 * @return string
74120 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
74121 **/
74122function PDF_get_buffer($p){}
74123
74124/**
74125 * Get error text
74126 *
74127 * Gets the text of the last thrown exception or the reason for a failed
74128 * function call.
74129 *
74130 * @param resource $pdfdoc
74131 * @return string
74132 * @since PECL pdflib >= 2.0.0
74133 **/
74134function PDF_get_errmsg($pdfdoc){}
74135
74136/**
74137 * Get error number
74138 *
74139 * Gets the number of the last thrown exception or the reason for a
74140 * failed function call.
74141 *
74142 * @param resource $pdfdoc
74143 * @return int
74144 * @since PECL pdflib >= 2.0.0
74145 **/
74146function PDF_get_errnum($pdfdoc){}
74147
74148/**
74149 * Get major version number [deprecated]
74150 *
74151 * This function is deprecated since PDFlib version 5, use {@link
74152 * PDF_get_value} with the parameter {@link major} instead.
74153 *
74154 * @return int
74155 * @since PHP 4 >= 4.2.0, PECL pdflib >= 1.0.0
74156 **/
74157function PDF_get_majorversion(){}
74158
74159/**
74160 * Get minor version number [deprecated]
74161 *
74162 * Returns the minor version number of the PDFlib version.
74163 *
74164 * This function is deprecated since PDFlib version 5, use {@link
74165 * PDF_get_value} with the parameter {@link minor} instead.
74166 *
74167 * @return int
74168 * @since PHP 4 >= 4.2.0, PECL pdflib >= 1.0.0
74169 **/
74170function PDF_get_minorversion(){}
74171
74172/**
74173 * Get string parameter
74174 *
74175 * Gets the contents of some PDFlib parameter with string type.
74176 *
74177 * @param resource $p
74178 * @param string $key
74179 * @param float $modifier
74180 * @return string
74181 * @since PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0
74182 **/
74183function PDF_get_parameter($p, $key, $modifier){}
74184
74185/**
74186 * Get PDI string parameter [deprecated]
74187 *
74188 * Gets the contents of a PDI document parameter with string type.
74189 *
74190 * This function is deprecated since PDFlib version 7, use {@link
74191 * PDF_pcos_get_string} instead.
74192 *
74193 * @param resource $p
74194 * @param string $key
74195 * @param int $doc
74196 * @param int $page
74197 * @param int $reserved
74198 * @return string
74199 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
74200 **/
74201function PDF_get_pdi_parameter($p, $key, $doc, $page, $reserved){}
74202
74203/**
74204 * Get PDI numerical parameter [deprecated]
74205 *
74206 * Gets the contents of a PDI document parameter with numerical type.
74207 *
74208 * This function is deprecated since PDFlib version 7, use {@link
74209 * PDF_pcos_get_number} instead.
74210 *
74211 * @param resource $p
74212 * @param string $key
74213 * @param int $doc
74214 * @param int $page
74215 * @param int $reserved
74216 * @return float
74217 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
74218 **/
74219function PDF_get_pdi_value($p, $key, $doc, $page, $reserved){}
74220
74221/**
74222 * Get numerical parameter
74223 *
74224 * Gets the value of some PDFlib parameter with numerical type.
74225 *
74226 * @param resource $p
74227 * @param string $key
74228 * @param float $modifier
74229 * @return float
74230 * @since PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0
74231 **/
74232function PDF_get_value($p, $key, $modifier){}
74233
74234/**
74235 * Query detailed information about a loaded font
74236 *
74237 * Queries detailed information about a loaded font.
74238 *
74239 * @param resource $pdfdoc
74240 * @param int $font
74241 * @param string $keyword
74242 * @param string $optlist
74243 * @return float
74244 * @since PECL pdflib >= 2.1.0
74245 **/
74246function PDF_info_font($pdfdoc, $font, $keyword, $optlist){}
74247
74248/**
74249 * Query matchbox information
74250 *
74251 * Queries information about a matchbox on the current page.
74252 *
74253 * @param resource $pdfdoc
74254 * @param string $boxname
74255 * @param int $num
74256 * @param string $keyword
74257 * @return float
74258 * @since PECL pdflib >= 2.1.0
74259 **/
74260function PDF_info_matchbox($pdfdoc, $boxname, $num, $keyword){}
74261
74262/**
74263 * Retrieve table information
74264 *
74265 * Retrieves table information related to the most recently placed table
74266 * instance.
74267 *
74268 * @param resource $pdfdoc
74269 * @param int $table
74270 * @param string $keyword
74271 * @return float
74272 * @since PECL pdflib >= 2.1.0
74273 **/
74274function PDF_info_table($pdfdoc, $table, $keyword){}
74275
74276/**
74277 * Query textflow state
74278 *
74279 * Queries the current state of a textflow.
74280 *
74281 * @param resource $pdfdoc
74282 * @param int $textflow
74283 * @param string $keyword
74284 * @return float
74285 * @since PECL pdflib >= 2.0.0
74286 **/
74287function PDF_info_textflow($pdfdoc, $textflow, $keyword){}
74288
74289/**
74290 * Perform textline formatting and query metrics
74291 *
74292 * Performs textline formatting and queries the resulting metrics.
74293 *
74294 * @param resource $pdfdoc
74295 * @param string $text
74296 * @param string $keyword
74297 * @param string $optlist
74298 * @return float
74299 * @since PECL pdflib >= 2.1.0
74300 **/
74301function PDF_info_textline($pdfdoc, $text, $keyword, $optlist){}
74302
74303/**
74304 * Reset graphic state
74305 *
74306 * Reset all color and graphics state parameters to their defaults.
74307 *
74308 * @param resource $p
74309 * @return bool
74310 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
74311 **/
74312function PDF_initgraphics($p){}
74313
74314/**
74315 * Draw a line
74316 *
74317 * Draws a line from the current point to another point.
74318 *
74319 * @param resource $p
74320 * @param float $x
74321 * @param float $y
74322 * @return bool
74323 * @since PHP 4, PECL pdflib >= 1.0.0
74324 **/
74325function PDF_lineto($p, $x, $y){}
74326
74327/**
74328 * Load 3D model
74329 *
74330 * Loads a 3D model from a disk-based or virtual file.
74331 *
74332 * This function requires PDF 1.6.
74333 *
74334 * @param resource $pdfdoc
74335 * @param string $filename
74336 * @param string $optlist
74337 * @return int
74338 * @since PECL pdflib >= 2.1.0
74339 **/
74340function PDF_load_3ddata($pdfdoc, $filename, $optlist){}
74341
74342/**
74343 * Search and prepare font
74344 *
74345 * Searches for a font and prepares it for later use.
74346 *
74347 * @param resource $pdfdoc
74348 * @param string $fontname
74349 * @param string $encoding
74350 * @param string $optlist
74351 * @return int
74352 * @since PECL pdflib >= 2.0.0
74353 **/
74354function PDF_load_font($pdfdoc, $fontname, $encoding, $optlist){}
74355
74356/**
74357 * Search and prepare ICC profile
74358 *
74359 * Searches for an ICC profile, and prepares it for later use.
74360 *
74361 * @param resource $pdfdoc
74362 * @param string $profilename
74363 * @param string $optlist
74364 * @return int
74365 * @since PECL pdflib >= 2.0.0
74366 **/
74367function PDF_load_iccprofile($pdfdoc, $profilename, $optlist){}
74368
74369/**
74370 * Open image file
74371 *
74372 * Opens a disk-based or virtual image file subject to various options.
74373 *
74374 * @param resource $pdfdoc
74375 * @param string $imagetype
74376 * @param string $filename
74377 * @param string $optlist
74378 * @return int
74379 * @since PECL pdflib >= 2.0.0
74380 **/
74381function PDF_load_image($pdfdoc, $imagetype, $filename, $optlist){}
74382
74383/**
74384 * Make spot color
74385 *
74386 * Finds a built-in spot color name, or makes a named spot color from the
74387 * current fill color.
74388 *
74389 * @param resource $p
74390 * @param string $spotname
74391 * @return int
74392 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
74393 **/
74394function PDF_makespotcolor($p, $spotname){}
74395
74396/**
74397 * Set current point
74398 *
74399 * Sets the current point for graphics output.
74400 *
74401 * @param resource $p
74402 * @param float $x
74403 * @param float $y
74404 * @return bool
74405 * @since PHP 4, PECL pdflib >= 1.0.0
74406 **/
74407function PDF_moveto($p, $x, $y){}
74408
74409/**
74410 * Create PDFlib object
74411 *
74412 * Creates a new PDFlib object with default settings.
74413 *
74414 * @return resource
74415 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
74416 **/
74417function PDF_new(){}
74418
74419/**
74420 * Open raw CCITT image [deprecated]
74421 *
74422 * Opens a raw CCITT image.
74423 *
74424 * This function is deprecated since PDFlib version 5, use {@link
74425 * PDF_load_image} instead.
74426 *
74427 * @param resource $pdfdoc
74428 * @param string $filename
74429 * @param int $width
74430 * @param int $height
74431 * @param int $BitReverse
74432 * @param int $k
74433 * @param int $Blackls1
74434 * @return int
74435 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
74436 **/
74437function PDF_open_ccitt($pdfdoc, $filename, $width, $height, $BitReverse, $k, $Blackls1){}
74438
74439/**
74440 * Create PDF file [deprecated]
74441 *
74442 * Creates a new PDF file using the supplied file name.
74443 *
74444 * This function is deprecated since PDFlib version 6, use {@link
74445 * PDF_begin_document} instead.
74446 *
74447 * @param resource $p
74448 * @param string $filename
74449 * @return bool
74450 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
74451 **/
74452function PDF_open_file($p, $filename){}
74453
74454/**
74455 * Use image data [deprecated]
74456 *
74457 * Uses image data from a variety of data sources.
74458 *
74459 * This function is deprecated since PDFlib version 5, use virtual files
74460 * and {@link PDF_load_image} instead.
74461 *
74462 * @param resource $p
74463 * @param string $imagetype
74464 * @param string $source
74465 * @param string $data
74466 * @param int $length
74467 * @param int $width
74468 * @param int $height
74469 * @param int $components
74470 * @param int $bpc
74471 * @param string $params
74472 * @return int
74473 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
74474 **/
74475function PDF_open_image($p, $imagetype, $source, $data, $length, $width, $height, $components, $bpc, $params){}
74476
74477/**
74478 * Read image from file [deprecated]
74479 *
74480 * Opens an image file.
74481 *
74482 * This function is deprecated since PDFlib version 5, use {@link
74483 * PDF_load_image} with the colorize, ignoremask, invert, mask, masked,
74484 * and page options instead.
74485 *
74486 * @param resource $p
74487 * @param string $imagetype
74488 * @param string $filename
74489 * @param string $stringparam
74490 * @param int $intparam
74491 * @return int
74492 * @since PHP 4, PECL pdflib >= 1.0.0
74493 **/
74494function PDF_open_image_file($p, $imagetype, $filename, $stringparam, $intparam){}
74495
74496/**
74497 * Open image created with PHP's image functions [not supported]
74498 *
74499 * This function is not supported by PDFlib GmbH.
74500 *
74501 * @param resource $p
74502 * @param resource $image
74503 * @return int
74504 * @since PHP 4, PECL pdflib >= 1.0.0
74505 **/
74506function PDF_open_memory_image($p, $image){}
74507
74508/**
74509 * Open PDF file [deprecated]
74510 *
74511 * Opens a disk-based or virtual PDF document and prepares it for later
74512 * use.
74513 *
74514 * This function is deprecated since PDFlib version 7, use {@link
74515 * PDF_open_pdi_document} instead.
74516 *
74517 * @param resource $pdfdoc
74518 * @param string $filename
74519 * @param string $optlist
74520 * @param int $len
74521 * @return int
74522 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
74523 **/
74524function PDF_open_pdi($pdfdoc, $filename, $optlist, $len){}
74525
74526/**
74527 * Prepare a pdi document
74528 *
74529 * Open a disk-based or virtual PDF document and prepare it for later
74530 * use.
74531 *
74532 * @param resource $p
74533 * @param string $filename
74534 * @param string $optlist
74535 * @return int
74536 * @since PECL pdflib >= 2.1.0
74537 **/
74538function PDF_open_pdi_document($p, $filename, $optlist){}
74539
74540/**
74541 * Prepare a page
74542 *
74543 * Prepares a page for later use with {@link PDF_fit_pdi_page}.
74544 *
74545 * @param resource $p
74546 * @param int $doc
74547 * @param int $pagenumber
74548 * @param string $optlist
74549 * @return int
74550 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
74551 **/
74552function PDF_open_pdi_page($p, $doc, $pagenumber, $optlist){}
74553
74554/**
74555 * Get value of pCOS path with type number or boolean
74556 *
74557 * Gets the value of a pCOS path with type number or boolean.
74558 *
74559 * @param resource $p
74560 * @param int $doc
74561 * @param string $path
74562 * @return float
74563 * @since PECL pdflib >= 2.1.0
74564 **/
74565function PDF_pcos_get_number($p, $doc, $path){}
74566
74567/**
74568 * Get contents of pCOS path with type stream, fstream, or string
74569 *
74570 * Gets the contents of a pCOS path with type stream, fstream, or string.
74571 *
74572 * @param resource $p
74573 * @param int $doc
74574 * @param string $optlist
74575 * @param string $path
74576 * @return string
74577 * @since PECL pdflib >= 2.1.0
74578 **/
74579function PDF_pcos_get_stream($p, $doc, $optlist, $path){}
74580
74581/**
74582 * Get value of pCOS path with type name, string, or boolean
74583 *
74584 * Gets the value of a pCOS path with type name, string, or boolean.
74585 *
74586 * @param resource $p
74587 * @param int $doc
74588 * @param string $path
74589 * @return string
74590 * @since PECL pdflib >= 2.1.0
74591 **/
74592function PDF_pcos_get_string($p, $doc, $path){}
74593
74594/**
74595 * Place image on the page [deprecated]
74596 *
74597 * Places an image and scales it.
74598 *
74599 * This function is deprecated since PDFlib version 5, use {@link
74600 * PDF_fit_image} instead.
74601 *
74602 * @param resource $pdfdoc
74603 * @param int $image
74604 * @param float $x
74605 * @param float $y
74606 * @param float $scale
74607 * @return bool
74608 * @since PHP 4, PECL pdflib >= 1.0.0
74609 **/
74610function PDF_place_image($pdfdoc, $image, $x, $y, $scale){}
74611
74612/**
74613 * Place PDF page [deprecated]
74614 *
74615 * Places a PDF page and scales it.
74616 *
74617 * This function is deprecated since PDFlib version 5, use {@link
74618 * PDF_fit_pdi_page} instead.
74619 *
74620 * @param resource $pdfdoc
74621 * @param int $page
74622 * @param float $x
74623 * @param float $y
74624 * @param float $sx
74625 * @param float $sy
74626 * @return bool
74627 * @since PHP 4 >= 4.0.6, PECL pdflib >= 1.0.0
74628 **/
74629function PDF_place_pdi_page($pdfdoc, $page, $x, $y, $sx, $sy){}
74630
74631/**
74632 * Process imported PDF document
74633 *
74634 * Processes certain elements of an imported PDF document.
74635 *
74636 * @param resource $pdfdoc
74637 * @param int $doc
74638 * @param int $page
74639 * @param string $optlist
74640 * @return int
74641 * @since PECL pdflib >= 2.0.0
74642 **/
74643function PDF_process_pdi($pdfdoc, $doc, $page, $optlist){}
74644
74645/**
74646 * Draw rectangle
74647 *
74648 * Draws a rectangle.
74649 *
74650 * @param resource $p
74651 * @param float $x
74652 * @param float $y
74653 * @param float $width
74654 * @param float $height
74655 * @return bool
74656 * @since PHP 4, PECL pdflib >= 1.0.0
74657 **/
74658function PDF_rect($p, $x, $y, $width, $height){}
74659
74660/**
74661 * Restore graphics state
74662 *
74663 * Restores the most recently saved graphics state.
74664 *
74665 * @param resource $p
74666 * @return bool
74667 * @since PHP 4, PECL pdflib >= 1.0.0
74668 **/
74669function PDF_restore($p){}
74670
74671/**
74672 * Resume page
74673 *
74674 * Resumes a page to add more content to it.
74675 *
74676 * @param resource $pdfdoc
74677 * @param string $optlist
74678 * @return bool
74679 * @since PECL pdflib >= 2.0.0
74680 **/
74681function PDF_resume_page($pdfdoc, $optlist){}
74682
74683/**
74684 * Rotate coordinate system
74685 *
74686 * Rotates the coordinate system.
74687 *
74688 * @param resource $p
74689 * @param float $phi
74690 * @return bool
74691 * @since PHP 4, PECL pdflib >= 1.0.0
74692 **/
74693function PDF_rotate($p, $phi){}
74694
74695/**
74696 * Save graphics state
74697 *
74698 * Saves the current graphics state.
74699 *
74700 * @param resource $p
74701 * @return bool
74702 * @since PHP 4, PECL pdflib >= 1.0.0
74703 **/
74704function PDF_save($p){}
74705
74706/**
74707 * Scale coordinate system
74708 *
74709 * Scales the coordinate system.
74710 *
74711 * @param resource $p
74712 * @param float $sx
74713 * @param float $sy
74714 * @return bool
74715 * @since PHP 4, PECL pdflib >= 1.0.0
74716 **/
74717function PDF_scale($p, $sx, $sy){}
74718
74719/**
74720 * Set fill and stroke color
74721 *
74722 * Sets the current color space and color.
74723 *
74724 * @param resource $p
74725 * @param string $fstype
74726 * @param string $colorspace
74727 * @param float $c1
74728 * @param float $c2
74729 * @param float $c3
74730 * @param float $c4
74731 * @return bool
74732 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
74733 **/
74734function PDF_setcolor($p, $fstype, $colorspace, $c1, $c2, $c3, $c4){}
74735
74736/**
74737 * Set simple dash pattern
74738 *
74739 * Sets the current dash pattern to {@link b} black and {@link w} white
74740 * units.
74741 *
74742 * @param resource $pdfdoc
74743 * @param float $b
74744 * @param float $w
74745 * @return bool
74746 * @since PHP 4, PECL pdflib >= 1.0.0
74747 **/
74748function PDF_setdash($pdfdoc, $b, $w){}
74749
74750/**
74751 * Set dash pattern
74752 *
74753 * Sets a dash pattern defined by an option list.
74754 *
74755 * @param resource $pdfdoc
74756 * @param string $optlist
74757 * @return bool
74758 * @since PECL pdflib >= 2.0.0
74759 **/
74760function PDF_setdashpattern($pdfdoc, $optlist){}
74761
74762/**
74763 * Set flatness
74764 *
74765 * Sets the flatness parameter.
74766 *
74767 * @param resource $pdfdoc
74768 * @param float $flatness
74769 * @return bool
74770 * @since PHP 4, PECL pdflib >= 1.0.0
74771 **/
74772function PDF_setflat($pdfdoc, $flatness){}
74773
74774/**
74775 * Set font
74776 *
74777 * Sets the current font in the specified {@link fontsize}, using a
74778 * {@link font} handle returned by {@link PDF_load_font}.
74779 *
74780 * @param resource $pdfdoc
74781 * @param int $font
74782 * @param float $fontsize
74783 * @return bool
74784 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
74785 **/
74786function PDF_setfont($pdfdoc, $font, $fontsize){}
74787
74788/**
74789 * Set color to gray [deprecated]
74790 *
74791 * Sets the current fill and stroke color to a gray value between 0 and 1
74792 * inclusive.
74793 *
74794 * This function is deprecated since PDFlib version 4, use {@link
74795 * PDF_setcolor} instead.
74796 *
74797 * @param resource $p
74798 * @param float $g
74799 * @return bool
74800 * @since PHP 4, PECL pdflib >= 1.0.0
74801 **/
74802function PDF_setgray($p, $g){}
74803
74804/**
74805 * Set fill color to gray [deprecated]
74806 *
74807 * Sets the current fill color to a gray value between 0 and 1 inclusive.
74808 *
74809 * This function is deprecated since PDFlib version 4, use {@link
74810 * PDF_setcolor} instead.
74811 *
74812 * @param resource $p
74813 * @param float $g
74814 * @return bool
74815 * @since PHP 4, PECL pdflib >= 1.0.0
74816 **/
74817function PDF_setgray_fill($p, $g){}
74818
74819/**
74820 * Set stroke color to gray [deprecated]
74821 *
74822 * Sets the current stroke color to a gray value between 0 and 1
74823 * inclusive.
74824 *
74825 * This function is deprecated since PDFlib version 4, use {@link
74826 * PDF_setcolor} instead.
74827 *
74828 * @param resource $p
74829 * @param float $g
74830 * @return bool
74831 * @since PHP 4, PECL pdflib >= 1.0.0
74832 **/
74833function PDF_setgray_stroke($p, $g){}
74834
74835/**
74836 * Set linecap parameter
74837 *
74838 * Sets the {@link linecap} parameter to control the shape at the end of
74839 * a path with respect to stroking.
74840 *
74841 * @param resource $p
74842 * @param int $linecap
74843 * @return bool
74844 * @since PHP 4, PECL pdflib >= 1.0.0
74845 **/
74846function PDF_setlinecap($p, $linecap){}
74847
74848/**
74849 * Set linejoin parameter
74850 *
74851 * Sets the {@link linejoin} parameter to specify the shape at the
74852 * corners of paths that are stroked.
74853 *
74854 * @param resource $p
74855 * @param int $value
74856 * @return bool
74857 * @since PHP 4, PECL pdflib >= 1.0.0
74858 **/
74859function PDF_setlinejoin($p, $value){}
74860
74861/**
74862 * Set line width
74863 *
74864 * Sets the current line width.
74865 *
74866 * @param resource $p
74867 * @param float $width
74868 * @return bool
74869 * @since PHP 4, PECL pdflib >= 1.0.0
74870 **/
74871function PDF_setlinewidth($p, $width){}
74872
74873/**
74874 * Set current transformation matrix
74875 *
74876 * Explicitly sets the current transformation matrix.
74877 *
74878 * @param resource $p
74879 * @param float $a
74880 * @param float $b
74881 * @param float $c
74882 * @param float $d
74883 * @param float $e
74884 * @param float $f
74885 * @return bool
74886 * @since PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0
74887 **/
74888function PDF_setmatrix($p, $a, $b, $c, $d, $e, $f){}
74889
74890/**
74891 * Set miter limit
74892 *
74893 * Sets the miter limit.
74894 *
74895 * @param resource $pdfdoc
74896 * @param float $miter
74897 * @return bool
74898 * @since PHP 4, PECL pdflib >= 1.0.0
74899 **/
74900function PDF_setmiterlimit($pdfdoc, $miter){}
74901
74902/**
74903 * Set fill and stroke rgb color values [deprecated]
74904 *
74905 * Sets the current fill and stroke color to the supplied RGB values.
74906 *
74907 * This function is deprecated since PDFlib version 4, use {@link
74908 * PDF_setcolor} instead.
74909 *
74910 * @param resource $p
74911 * @param float $red
74912 * @param float $green
74913 * @param float $blue
74914 * @return bool
74915 * @since PHP 4, PECL pdflib >= 1.0.0
74916 **/
74917function PDF_setrgbcolor($p, $red, $green, $blue){}
74918
74919/**
74920 * Set fill rgb color values [deprecated]
74921 *
74922 * Sets the current fill color to the supplied RGB values.
74923 *
74924 * This function is deprecated since PDFlib version 4, use {@link
74925 * PDF_setcolor} instead.
74926 *
74927 * @param resource $p
74928 * @param float $red
74929 * @param float $green
74930 * @param float $blue
74931 * @return bool
74932 * @since PHP 4, PECL pdflib >= 1.0.0
74933 **/
74934function PDF_setrgbcolor_fill($p, $red, $green, $blue){}
74935
74936/**
74937 * Set stroke rgb color values [deprecated]
74938 *
74939 * Sets the current stroke color to the supplied RGB values.
74940 *
74941 * This function is deprecated since PDFlib version 4, use {@link
74942 * PDF_setcolor} instead.
74943 *
74944 * @param resource $p
74945 * @param float $red
74946 * @param float $green
74947 * @param float $blue
74948 * @return bool
74949 * @since PHP 4, PECL pdflib >= 1.0.0
74950 **/
74951function PDF_setrgbcolor_stroke($p, $red, $green, $blue){}
74952
74953/**
74954 * Set border color of annotations [deprecated]
74955 *
74956 * Sets the border color for all kinds of annotations.
74957 *
74958 * This function is deprecated since PDFlib version 6, use the option
74959 * {@link annotcolor} in {@link PDF_create_annotation} instead.
74960 *
74961 * @param resource $p
74962 * @param float $red
74963 * @param float $green
74964 * @param float $blue
74965 * @return bool
74966 * @since PHP 4, PECL pdflib >= 1.0.0
74967 **/
74968function PDF_set_border_color($p, $red, $green, $blue){}
74969
74970/**
74971 * Set border dash style of annotations [deprecated]
74972 *
74973 * Sets the border dash style for all kinds of annotations.
74974 *
74975 * This function is deprecated since PDFlib version 6, use the option
74976 * {@link dasharray} in {@link PDF_create_annotation} instead.
74977 *
74978 * @param resource $pdfdoc
74979 * @param float $black
74980 * @param float $white
74981 * @return bool
74982 * @since PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0
74983 **/
74984function PDF_set_border_dash($pdfdoc, $black, $white){}
74985
74986/**
74987 * Set border style of annotations [deprecated]
74988 *
74989 * Sets the border style for all kinds of annotations.
74990 *
74991 * This function is deprecated since PDFlib version 6, use the options
74992 * {@link borderstyle} and {@link linewidth} in {@link
74993 * PDF_create_annotation} instead.
74994 *
74995 * @param resource $pdfdoc
74996 * @param string $style
74997 * @param float $width
74998 * @return bool
74999 * @since PHP 4, PECL pdflib >= 1.0.0
75000 **/
75001function PDF_set_border_style($pdfdoc, $style, $width){}
75002
75003/**
75004 * Activate graphics state object
75005 *
75006 * Activates a graphics state object.
75007 *
75008 * @param resource $pdfdoc
75009 * @param int $gstate
75010 * @return bool
75011 * @since PECL pdflib >= 2.0.0
75012 **/
75013function PDF_set_gstate($pdfdoc, $gstate){}
75014
75015/**
75016 * Fill document info field
75017 *
75018 * Fill document information field {@link key} with {@link value}.
75019 *
75020 * @param resource $p
75021 * @param string $key
75022 * @param string $value
75023 * @return bool
75024 * @since PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0
75025 **/
75026function PDF_set_info($p, $key, $value){}
75027
75028/**
75029 * Define relationships among layers
75030 *
75031 * Defines hierarchical and group relationships among layers.
75032 *
75033 * This function requires PDF 1.5.
75034 *
75035 * @param resource $pdfdoc
75036 * @param string $type
75037 * @param string $optlist
75038 * @return bool
75039 * @since PECL pdflib >= 2.0.0
75040 **/
75041function PDF_set_layer_dependency($pdfdoc, $type, $optlist){}
75042
75043/**
75044 * Set string parameter
75045 *
75046 * Sets some PDFlib parameter with string type.
75047 *
75048 * @param resource $p
75049 * @param string $key
75050 * @param string $value
75051 * @return bool
75052 * @since PHP 4, PECL pdflib >= 1.0.0
75053 **/
75054function PDF_set_parameter($p, $key, $value){}
75055
75056/**
75057 * Set text position
75058 *
75059 * Sets the position for text output on the page.
75060 *
75061 * @param resource $p
75062 * @param float $x
75063 * @param float $y
75064 * @return bool
75065 * @since PHP 4, PECL pdflib >= 1.0.0
75066 **/
75067function PDF_set_text_pos($p, $x, $y){}
75068
75069/**
75070 * Set numerical parameter
75071 *
75072 * Sets the value of some PDFlib parameter with numerical type.
75073 *
75074 * @param resource $p
75075 * @param string $key
75076 * @param float $value
75077 * @return bool
75078 * @since PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0
75079 **/
75080function PDF_set_value($p, $key, $value){}
75081
75082/**
75083 * Define blend
75084 *
75085 * Defines a blend from the current fill color to another color.
75086 *
75087 * This function requires PDF 1.4 or above.
75088 *
75089 * @param resource $pdfdoc
75090 * @param string $shtype
75091 * @param float $x0
75092 * @param float $y0
75093 * @param float $x1
75094 * @param float $y1
75095 * @param float $c1
75096 * @param float $c2
75097 * @param float $c3
75098 * @param float $c4
75099 * @param string $optlist
75100 * @return int
75101 * @since PECL pdflib >= 2.0.0
75102 **/
75103function PDF_shading($pdfdoc, $shtype, $x0, $y0, $x1, $y1, $c1, $c2, $c3, $c4, $optlist){}
75104
75105/**
75106 * Define shading pattern
75107 *
75108 * Defines a shading pattern using a shading object.
75109 *
75110 * This function requires PDF 1.4 or above.
75111 *
75112 * @param resource $pdfdoc
75113 * @param int $shading
75114 * @param string $optlist
75115 * @return int
75116 * @since PECL pdflib >= 2.0.0
75117 **/
75118function PDF_shading_pattern($pdfdoc, $shading, $optlist){}
75119
75120/**
75121 * Fill area with shading
75122 *
75123 * Fills an area with a shading, based on a shading object.
75124 *
75125 * This function requires PDF 1.4 or above.
75126 *
75127 * @param resource $pdfdoc
75128 * @param int $shading
75129 * @return bool
75130 * @since PECL pdflib >= 2.0.0
75131 **/
75132function PDF_shfill($pdfdoc, $shading){}
75133
75134/**
75135 * Output text at current position
75136 *
75137 * Prints {@link text} in the current font and size at the current
75138 * position.
75139 *
75140 * @param resource $pdfdoc
75141 * @param string $text
75142 * @return bool
75143 * @since PHP 4, PECL pdflib >= 1.0.0
75144 **/
75145function PDF_show($pdfdoc, $text){}
75146
75147/**
75148 * Output text in a box [deprecated]
75149 *
75150 * This function is deprecated since PDFlib version 6, use {@link
75151 * PDF_fit_textline} for single lines, or the {@link PDF_*_textflow}
75152 * functions for multi-line formatting instead.
75153 *
75154 * @param resource $p
75155 * @param string $text
75156 * @param float $left
75157 * @param float $top
75158 * @param float $width
75159 * @param float $height
75160 * @param string $mode
75161 * @param string $feature
75162 * @return int
75163 * @since PHP 4, PECL pdflib >= 1.0.0
75164 **/
75165function PDF_show_boxed($p, $text, $left, $top, $width, $height, $mode, $feature){}
75166
75167/**
75168 * Output text at given position
75169 *
75170 * Prints {@link text} in the current font.
75171 *
75172 * @param resource $p
75173 * @param string $text
75174 * @param float $x
75175 * @param float $y
75176 * @return bool
75177 * @since PHP 4, PECL pdflib >= 1.0.0
75178 **/
75179function PDF_show_xy($p, $text, $x, $y){}
75180
75181/**
75182 * Skew the coordinate system
75183 *
75184 * Skews the coordinate system in x and y direction by {@link alpha} and
75185 * {@link beta} degrees, respectively.
75186 *
75187 * @param resource $p
75188 * @param float $alpha
75189 * @param float $beta
75190 * @return bool
75191 * @since PHP 4, PECL pdflib >= 1.0.0
75192 **/
75193function PDF_skew($p, $alpha, $beta){}
75194
75195/**
75196 * Return width of text
75197 *
75198 * Returns the width of {@link text} in an arbitrary font.
75199 *
75200 * @param resource $p
75201 * @param string $text
75202 * @param int $font
75203 * @param float $fontsize
75204 * @return float
75205 * @since PHP 4, PECL pdflib >= 1.0.0
75206 **/
75207function PDF_stringwidth($p, $text, $font, $fontsize){}
75208
75209/**
75210 * Stroke path
75211 *
75212 * Strokes the path with the current color and line width, and clear it.
75213 *
75214 * @param resource $p
75215 * @return bool
75216 * @since PHP 4, PECL pdflib >= 1.0.0
75217 **/
75218function PDF_stroke($p){}
75219
75220/**
75221 * Suspend page
75222 *
75223 * Suspends the current page so that it can later be resumed with {@link
75224 * PDF_resume_page}.
75225 *
75226 * @param resource $pdfdoc
75227 * @param string $optlist
75228 * @return bool
75229 * @since PECL pdflib >= 2.0.0
75230 **/
75231function PDF_suspend_page($pdfdoc, $optlist){}
75232
75233/**
75234 * Set origin of coordinate system
75235 *
75236 * Translates the origin of the coordinate system.
75237 *
75238 * @param resource $p
75239 * @param float $tx
75240 * @param float $ty
75241 * @return bool
75242 * @since PHP 4, PECL pdflib >= 1.0.0
75243 **/
75244function PDF_translate($p, $tx, $ty){}
75245
75246/**
75247 * Convert string from UTF-8 to UTF-16
75248 *
75249 * Converts a string from UTF-8 format to UTF-16.
75250 *
75251 * @param resource $pdfdoc
75252 * @param string $utf8string
75253 * @param string $ordering
75254 * @return string
75255 * @since PECL pdflib >= 2.0.3
75256 **/
75257function PDF_utf8_to_utf16($pdfdoc, $utf8string, $ordering){}
75258
75259/**
75260 * Convert string from UTF-16 to UTF-8
75261 *
75262 * Converts a string from UTF-16 format to UTF-8.
75263 *
75264 * @param resource $pdfdoc
75265 * @param string $utf16string
75266 * @return string
75267 * @since PECL pdflib >= 2.0.3
75268 **/
75269function PDF_utf16_to_utf8($pdfdoc, $utf16string){}
75270
75271/**
75272 * Convert string from UTF-32 to UTF-16
75273 *
75274 * Converts a string from UTF-32 format to UTF-16.
75275 *
75276 * @param resource $pdfdoc
75277 * @param string $utf32string
75278 * @param string $ordering
75279 * @return string
75280 * @since PECL pdflib >= Unknown future
75281 **/
75282function PDF_utf32_to_utf16($pdfdoc, $utf32string, $ordering){}
75283
75284/**
75285 * Return an array of available PDO drivers
75286 *
75287 * This function returns all currently available PDO drivers which can be
75288 * used in {@link DSN} parameter of {@link PDO::__construct}.
75289 *
75290 * @return array {@link PDO::getAvailableDrivers} returns an array of
75291 *   PDO driver names. If no drivers are available, it returns an empty
75292 *   array.
75293 * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.9.0
75294 **/
75295function pdo_drivers(){}
75296
75297/**
75298 * Open persistent Internet or Unix domain socket connection
75299 *
75300 * This function behaves exactly as {@link fsockopen} with the difference
75301 * that the connection is not closed after the script finishes. It is the
75302 * persistent version of {@link fsockopen}.
75303 *
75304 * @param string $hostname
75305 * @param int $port
75306 * @param int $errno
75307 * @param string $errstr
75308 * @param float $timeout
75309 * @return resource
75310 * @since PHP 4, PHP 5, PHP 7
75311 **/
75312function pfsockopen($hostname, $port, &$errno, &$errstr, $timeout){}
75313
75314/**
75315 * Returns number of affected records (tuples)
75316 *
75317 * {@link pg_affected_rows} returns the number of tuples
75318 * (instances/records/rows) affected by INSERT, UPDATE, and DELETE
75319 * queries.
75320 *
75321 * Since PostgreSQL 9.0 and above, the server returns the number of
75322 * SELECTed rows. Older PostgreSQL return 0 for SELECT.
75323 *
75324 * @param resource $result PostgreSQL query result resource, returned
75325 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
75326 *   (among others).
75327 * @return int The number of rows affected by the query. If no tuple is
75328 *   affected, it will return 0.
75329 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
75330 **/
75331function pg_affected_rows($result){}
75332
75333/**
75334 * Cancel an asynchronous query
75335 *
75336 * {@link pg_cancel_query} cancels an asynchronous query sent with {@link
75337 * pg_send_query}, {@link pg_send_query_params} or {@link
75338 * pg_send_execute}. You cannot cancel a query executed using {@link
75339 * pg_query}.
75340 *
75341 * @param resource $connection PostgreSQL database connection resource.
75342 * @return bool
75343 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
75344 **/
75345function pg_cancel_query($connection){}
75346
75347/**
75348 * Gets the client encoding
75349 *
75350 * PostgreSQL supports automatic character set conversion between server
75351 * and client for certain character sets. {@link pg_client_encoding}
75352 * returns the client encoding as a string. The returned string will be
75353 * one of the standard PostgreSQL encoding identifiers.
75354 *
75355 * @param resource $connection PostgreSQL database connection resource.
75356 *   When {@link connection} is not present, the default connection is
75357 *   used. The default connection is the last connection made by {@link
75358 *   pg_connect} or {@link pg_pconnect}.
75359 * @return string The client encoding, or FALSE on error.
75360 * @since PHP 4 >= 4.0.3, PHP 5, PHP 7
75361 **/
75362function pg_client_encoding($connection){}
75363
75364/**
75365 * Closes a PostgreSQL connection
75366 *
75367 * {@link pg_close} closes the non-persistent connection to a PostgreSQL
75368 * database associated with the given {@link connection} resource.
75369 *
75370 * If there is open large object resource on the connection, do not close
75371 * the connection before closing all large object resources.
75372 *
75373 * @param resource $connection PostgreSQL database connection resource.
75374 *   When {@link connection} is not present, the default connection is
75375 *   used. The default connection is the last connection made by {@link
75376 *   pg_connect} or {@link pg_pconnect}.
75377 * @return bool
75378 * @since PHP 4, PHP 5, PHP 7
75379 **/
75380function pg_close($connection){}
75381
75382/**
75383 * Open a PostgreSQL connection
75384 *
75385 * {@link pg_connect} opens a connection to a PostgreSQL database
75386 * specified by the {@link connection_string}.
75387 *
75388 * If a second call is made to {@link pg_connect} with the same {@link
75389 * connection_string} as an existing connection, the existing connection
75390 * will be returned unless you pass PGSQL_CONNECT_FORCE_NEW as {@link
75391 * connect_type}.
75392 *
75393 * The old syntax with multiple parameters $conn = pg_connect("host",
75394 * "port", "options", "tty", "dbname") has been deprecated.
75395 *
75396 * @param string $connection_string The {@link connection_string} can
75397 *   be empty to use all default parameters, or it can contain one or
75398 *   more parameter settings separated by whitespace. Each parameter
75399 *   setting is in the form keyword = value. Spaces around the equal sign
75400 *   are optional. To write an empty value or a value containing spaces,
75401 *   surround it with single quotes, e.g., keyword = 'a value'. Single
75402 *   quotes and backslashes within the value must be escaped with a
75403 *   backslash, i.e., \' and \\. The currently recognized parameter
75404 *   keywords are: {@link host}, {@link hostaddr}, {@link port}, {@link
75405 *   dbname} (defaults to value of {@link user}), {@link user}, {@link
75406 *   password}, {@link connect_timeout}, {@link options}, {@link tty}
75407 *   (ignored), {@link sslmode}, {@link requiressl} (deprecated in favor
75408 *   of {@link sslmode}), and {@link service}. Which of these arguments
75409 *   exist depends on your PostgreSQL version. The {@link options}
75410 *   parameter can be used to set command line parameters to be invoked
75411 *   by the server.
75412 * @param int $connect_type If PGSQL_CONNECT_FORCE_NEW is passed, then
75413 *   a new connection is created, even if the {@link connection_string}
75414 *   is identical to an existing connection. If PGSQL_CONNECT_ASYNC is
75415 *   given, then the connection is established asynchronously. The state
75416 *   of the connection can then be checked via {@link pg_connect_poll} or
75417 *   {@link pg_connection_status}.
75418 * @return resource PostgreSQL connection resource on success, FALSE on
75419 *   failure.
75420 * @since PHP 4, PHP 5, PHP 7
75421 **/
75422function pg_connect($connection_string, $connect_type){}
75423
75424/**
75425 * Get connection is busy or not
75426 *
75427 * {@link pg_connection_busy} determines whether or not a connection is
75428 * busy. If it is busy, a previous query is still executing. If {@link
75429 * pg_get_result} is used on the connection, it will be blocked.
75430 *
75431 * @param resource $connection PostgreSQL database connection resource.
75432 * @return bool Returns TRUE if the connection is busy, FALSE
75433 *   otherwise.
75434 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
75435 **/
75436function pg_connection_busy($connection){}
75437
75438/**
75439 * Reset connection (reconnect)
75440 *
75441 * {@link pg_connection_reset} resets the connection. It is useful for
75442 * error recovery.
75443 *
75444 * @param resource $connection PostgreSQL database connection resource.
75445 * @return bool
75446 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
75447 **/
75448function pg_connection_reset($connection){}
75449
75450/**
75451 * Get connection status
75452 *
75453 * {@link pg_connection_status} returns the status of the specified
75454 * {@link connection}.
75455 *
75456 * @param resource $connection PostgreSQL database connection resource.
75457 * @return int PGSQL_CONNECTION_OK or PGSQL_CONNECTION_BAD.
75458 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
75459 **/
75460function pg_connection_status($connection){}
75461
75462/**
75463 * Poll the status of an in-progress asynchronous PostgreSQL connection
75464 * attempt
75465 *
75466 * {@link pg_connect_poll} polls the status of a PostgreSQL connection
75467 * created by calling {@link pg_connect} with the PGSQL_CONNECT_ASYNC
75468 * option.
75469 *
75470 * @param resource $connection PostgreSQL database connection resource.
75471 * @return int Returns PGSQL_POLLING_FAILED, PGSQL_POLLING_READING,
75472 *   PGSQL_POLLING_WRITING, PGSQL_POLLING_OK, or PGSQL_POLLING_ACTIVE.
75473 * @since PHP 5 >= 5.6.0, PHP 7
75474 **/
75475function pg_connect_poll($connection){}
75476
75477/**
75478 * Reads input on the connection
75479 *
75480 * {@link pg_consume_input} consumes any input waiting to be read from
75481 * the database server.
75482 *
75483 * @param resource $connection PostgreSQL database connection resource.
75484 * @return bool TRUE if no error occurred, or FALSE if there was an
75485 *   error. Note that TRUE does not necessarily indicate that input was
75486 *   waiting to be read.
75487 * @since PHP 5 >= 5.6.0, PHP 7
75488 **/
75489function pg_consume_input($connection){}
75490
75491/**
75492 * Convert associative array values into forms suitable for SQL
75493 * statements
75494 *
75495 * {@link pg_convert} checks and converts the values in {@link
75496 * assoc_array} into suitable values for use in an SQL statement.
75497 * Precondition for {@link pg_convert} is the existence of a table {@link
75498 * table_name} which has at least as many columns as {@link assoc_array}
75499 * has elements. The fieldnames in {@link table_name} must match the
75500 * indices in {@link assoc_array} and the corresponding datatypes must be
75501 * compatible. Returns an array with the converted values on success,
75502 * FALSE otherwise.
75503 *
75504 * @param resource $connection PostgreSQL database connection resource.
75505 * @param string $table_name Name of the table against which to convert
75506 *   types.
75507 * @param array $assoc_array Data to be converted.
75508 * @param int $options Any number of PGSQL_CONV_IGNORE_DEFAULT,
75509 *   PGSQL_CONV_FORCE_NULL or PGSQL_CONV_IGNORE_NOT_NULL, combined.
75510 * @return array An array of converted values, or FALSE on error.
75511 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
75512 **/
75513function pg_convert($connection, $table_name, $assoc_array, $options){}
75514
75515/**
75516 * Insert records into a table from an array
75517 *
75518 * {@link pg_copy_from} inserts records into a table from {@link rows}.
75519 * It issues a COPY FROM SQL command internally to insert records.
75520 *
75521 * @param resource $connection PostgreSQL database connection resource.
75522 * @param string $table_name Name of the table into which to copy the
75523 *   {@link rows}.
75524 * @param array $rows An array of data to be copied into {@link
75525 *   table_name}. Each value in {@link rows} becomes a row in {@link
75526 *   table_name}. Each value in {@link rows} should be a delimited string
75527 *   of the values to insert into each field. Values should be linefeed
75528 *   terminated.
75529 * @param string $delimiter The token that separates values for each
75530 *   field in each element of {@link rows}. Default is TAB.
75531 * @param string $null_as How SQL NULL values are represented in the
75532 *   {@link rows}. Default is \N ("\\N").
75533 * @return bool
75534 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
75535 **/
75536function pg_copy_from($connection, $table_name, $rows, $delimiter, $null_as){}
75537
75538/**
75539 * Copy a table to an array
75540 *
75541 * {@link pg_copy_to} copies a table to an array. It issues COPY TO SQL
75542 * command internally to retrieve records.
75543 *
75544 * @param resource $connection PostgreSQL database connection resource.
75545 * @param string $table_name Name of the table from which to copy the
75546 *   data into {@link rows}.
75547 * @param string $delimiter The token that separates values for each
75548 *   field in each element of {@link rows}. Default is TAB.
75549 * @param string $null_as How SQL NULL values are represented in the
75550 *   {@link rows}. Default is \N ("\\N").
75551 * @return array An array with one element for each line of COPY data.
75552 *   It returns FALSE on failure.
75553 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
75554 **/
75555function pg_copy_to($connection, $table_name, $delimiter, $null_as){}
75556
75557/**
75558 * Get the database name
75559 *
75560 * {@link pg_dbname} returns the name of the database that the given
75561 * PostgreSQL {@link connection} resource.
75562 *
75563 * @param resource $connection PostgreSQL database connection resource.
75564 *   When {@link connection} is not present, the default connection is
75565 *   used. The default connection is the last connection made by {@link
75566 *   pg_connect} or {@link pg_pconnect}.
75567 * @return string A string containing the name of the database the
75568 *   {@link connection} is to, or FALSE on error.
75569 * @since PHP 4, PHP 5, PHP 7
75570 **/
75571function pg_dbname($connection){}
75572
75573/**
75574 * Deletes records
75575 *
75576 * {@link pg_delete} deletes records from a table specified by the keys
75577 * and values in {@link assoc_array}. If {@link options} is specified,
75578 * {@link pg_convert} is applied to {@link assoc_array} with the
75579 * specified options.
75580 *
75581 * If options is specified, {@link pg_convert} is applied to assoc_array
75582 * with the specified flags.
75583 *
75584 * By default {@link pg_delete} passes raw values. Values must be escaped
75585 * or PGSQL_DML_ESCAPE option must be specified. PGSQL_DML_ESCAPE quotes
75586 * and escapes parameters/identifiers. Therefore, table/column names
75587 * became case sensitive.
75588 *
75589 * Note that neither escape nor prepared query can protect LIKE query,
75590 * JSON, Array, Regex, etc. These parameters should be handled according
75591 * to their contexts. i.e. Escape/validate values.
75592 *
75593 * @param resource $connection PostgreSQL database connection resource.
75594 * @param string $table_name Name of the table from which to delete
75595 *   rows.
75596 * @param array $assoc_array An array whose keys are field names in the
75597 *   table {@link table_name}, and whose values are the values of those
75598 *   fields that are to be deleted.
75599 * @param int $options Any number of PGSQL_CONV_FORCE_NULL,
75600 *   PGSQL_DML_NO_CONV, PGSQL_DML_ESCAPE, PGSQL_DML_EXEC, PGSQL_DML_ASYNC
75601 *   or PGSQL_DML_STRING combined. If PGSQL_DML_STRING is part of the
75602 *   {@link options} then query string is returned. When
75603 *   PGSQL_DML_NO_CONV or PGSQL_DML_ESCAPE is set, it does not call
75604 *   {@link pg_convert} internally.
75605 * @return mixed Returns string if PGSQL_DML_STRING is passed via
75606 *   {@link options}.
75607 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
75608 **/
75609function pg_delete($connection, $table_name, $assoc_array, $options){}
75610
75611/**
75612 * Sync with PostgreSQL backend
75613 *
75614 * {@link pg_end_copy} syncs the PostgreSQL frontend (usually a web
75615 * server process) with the PostgreSQL server after doing a copy
75616 * operation performed by {@link pg_put_line}. {@link pg_end_copy} must
75617 * be issued, otherwise the PostgreSQL server may get out of sync with
75618 * the frontend and will report an error.
75619 *
75620 * @param resource $connection PostgreSQL database connection resource.
75621 *   When {@link connection} is not present, the default connection is
75622 *   used. The default connection is the last connection made by {@link
75623 *   pg_connect} or {@link pg_pconnect}.
75624 * @return bool
75625 * @since PHP 4 >= 4.0.3, PHP 5, PHP 7
75626 **/
75627function pg_end_copy($connection){}
75628
75629/**
75630 * Escape a string for insertion into a bytea field
75631 *
75632 * {@link pg_escape_bytea} escapes string for bytea datatype. It returns
75633 * escaped string.
75634 *
75635 * @param resource $connection PostgreSQL database connection resource.
75636 *   When {@link connection} is not present, the default connection is
75637 *   used. The default connection is the last connection made by {@link
75638 *   pg_connect} or {@link pg_pconnect}.
75639 * @param string $data A string containing text or binary data to be
75640 *   inserted into a bytea column.
75641 * @return string A string containing the escaped data.
75642 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
75643 **/
75644function pg_escape_bytea($connection, $data){}
75645
75646/**
75647 * Escape a identifier for insertion into a text field
75648 *
75649 * {@link pg_escape_identifier} escapes a identifier (e.g. table, field
75650 * names) for querying the database. It returns an escaped identifier
75651 * string for PostgreSQL server. {@link pg_escape_identifier} adds double
75652 * quotes before and after data. Users should not add double quotes. Use
75653 * of this function is recommended for identifier parameters in query.
75654 * For SQL literals (i.e. parameters except bytea), {@link
75655 * pg_escape_literal} or {@link pg_escape_string} must be used. For bytea
75656 * type fields, {@link pg_escape_bytea} must be used instead.
75657 *
75658 * @param resource $connection PostgreSQL database connection resource.
75659 *   When {@link connection} is not present, the default connection is
75660 *   used. The default connection is the last connection made by {@link
75661 *   pg_connect} or {@link pg_pconnect}.
75662 * @param string $data A string containing text to be escaped.
75663 * @return string A string containing the escaped data.
75664 * @since PHP 5 >= 5.4.4, PHP 7
75665 **/
75666function pg_escape_identifier($connection, $data){}
75667
75668/**
75669 * Escape a literal for insertion into a text field
75670 *
75671 * {@link pg_escape_literal} escapes a literal for querying the
75672 * PostgreSQL database. It returns an escaped literal in the PostgreSQL
75673 * format. {@link pg_escape_literal} adds quotes before and after data.
75674 * Users should not add quotes. Use of this function is recommended
75675 * instead of {@link pg_escape_string}. If the type of the column is
75676 * bytea, {@link pg_escape_bytea} must be used instead. For escaping
75677 * identifiers (e.g. table, field names), {@link pg_escape_identifier}
75678 * must be used.
75679 *
75680 * @param resource $connection PostgreSQL database connection resource.
75681 *   When {@link connection} is not present, the default connection is
75682 *   used. The default connection is the last connection made by {@link
75683 *   pg_connect} or {@link pg_pconnect}. When there is no default
75684 *   connection, it raises E_WARNING and returns FALSE.
75685 * @param string $data A string containing text to be escaped.
75686 * @return string A string containing the escaped data.
75687 * @since PHP 5 >= 5.4.4, PHP 7
75688 **/
75689function pg_escape_literal($connection, $data){}
75690
75691/**
75692 * Escape a string for query
75693 *
75694 * {@link pg_escape_string} escapes a string for querying the database.
75695 * It returns an escaped string in the PostgreSQL format without quotes.
75696 * {@link pg_escape_literal} is more preferred way to escape SQL
75697 * parameters for PostgreSQL. {@link addslashes} must not be used with
75698 * PostgreSQL. If the type of the column is bytea, {@link
75699 * pg_escape_bytea} must be used instead. {@link pg_escape_identifier}
75700 * must be used to escape identifiers (e.g. table names, field names)
75701 *
75702 * @param resource $connection PostgreSQL database connection resource.
75703 *   When {@link connection} is not present, the default connection is
75704 *   used. The default connection is the last connection made by {@link
75705 *   pg_connect} or {@link pg_pconnect}.
75706 * @param string $data A string containing text to be escaped.
75707 * @return string A string containing the escaped data.
75708 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
75709 **/
75710function pg_escape_string($connection, $data){}
75711
75712/**
75713 * Sends a request to execute a prepared statement with given parameters,
75714 * and waits for the result
75715 *
75716 * Sends a request to execute a prepared statement with given parameters,
75717 * and waits for the result.
75718 *
75719 * {@link pg_execute} is like {@link pg_query_params}, but the command to
75720 * be executed is specified by naming a previously-prepared statement,
75721 * instead of giving a query string. This feature allows commands that
75722 * will be used repeatedly to be parsed and planned just once, rather
75723 * than each time they are executed. The statement must have been
75724 * prepared previously in the current session. {@link pg_execute} is
75725 * supported only against PostgreSQL 7.4 or higher connections; it will
75726 * fail when using earlier versions.
75727 *
75728 * The parameters are identical to {@link pg_query_params}, except that
75729 * the name of a prepared statement is given instead of a query string.
75730 *
75731 * @param resource $connection PostgreSQL database connection resource.
75732 *   When {@link connection} is not present, the default connection is
75733 *   used. The default connection is the last connection made by {@link
75734 *   pg_connect} or {@link pg_pconnect}.
75735 * @param string $stmtname The name of the prepared statement to
75736 *   execute. if "" is specified, then the unnamed statement is executed.
75737 *   The name must have been previously prepared using {@link
75738 *   pg_prepare}, {@link pg_send_prepare} or a PREPARE SQL command.
75739 * @param array $params An array of parameter values to substitute for
75740 *   the $1, $2, etc. placeholders in the original prepared query string.
75741 *   The number of elements in the array must match the number of
75742 *   placeholders.
75743 * @return resource A query result resource on success.
75744 * @since PHP 5 >= 5.1.0, PHP 7
75745 **/
75746function pg_execute($connection, $stmtname, $params){}
75747
75748/**
75749 * Fetches all rows from a result as an array
75750 *
75751 * {@link pg_fetch_all} returns an array that contains all rows (records)
75752 * in the result resource.
75753 *
75754 * @param resource $result PostgreSQL query result resource, returned
75755 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
75756 *   (among others).
75757 * @param int $result_type
75758 * @return array An array with all rows in the result. Each row is an
75759 *   array of field values indexed by field name.
75760 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
75761 **/
75762function pg_fetch_all($result, $result_type){}
75763
75764/**
75765 * Fetches all rows in a particular result column as an array
75766 *
75767 * {@link pg_fetch_all_columns} returns an array that contains all rows
75768 * (records) in a particular column of the result resource.
75769 *
75770 * @param resource $result PostgreSQL query result resource, returned
75771 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
75772 *   (among others).
75773 * @param int $column Column number, zero-based, to be retrieved from
75774 *   the result resource. Defaults to the first column if not specified.
75775 * @return array An array with all values in the result column.
75776 * @since PHP 5 >= 5.1.0, PHP 7
75777 **/
75778function pg_fetch_all_columns($result, $column){}
75779
75780/**
75781 * Fetch a row as an array
75782 *
75783 * {@link pg_fetch_array} returns an array that corresponds to the
75784 * fetched row (record).
75785 *
75786 * {@link pg_fetch_array} is an extended version of {@link pg_fetch_row}.
75787 * In addition to storing the data in the numeric indices (field number)
75788 * to the result array, it can also store the data using associative
75789 * indices (field name). It stores both indices by default.
75790 *
75791 * {@link pg_fetch_array} is NOT significantly slower than using {@link
75792 * pg_fetch_row}, and is significantly easier to use.
75793 *
75794 * @param resource $result PostgreSQL query result resource, returned
75795 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
75796 *   (among others).
75797 * @param int $row Row number in result to fetch. Rows are numbered
75798 *   from 0 upwards. If omitted or NULL, the next row is fetched.
75799 * @param int $result_type An optional parameter that controls how the
75800 *   returned array is indexed. {@link result_type} is a constant and can
75801 *   take the following values: PGSQL_ASSOC, PGSQL_NUM and PGSQL_BOTH.
75802 *   Using PGSQL_NUM, {@link pg_fetch_array} will return an array with
75803 *   numerical indices, using PGSQL_ASSOC it will return only associative
75804 *   indices while PGSQL_BOTH, the default, will return both numerical
75805 *   and associative indices.
75806 * @return array An array indexed numerically (beginning with 0) or
75807 *   associatively (indexed by field name), or both. Each value in the
75808 *   array is represented as a string. Database NULL values are returned
75809 *   as NULL.
75810 * @since PHP 4, PHP 5, PHP 7
75811 **/
75812function pg_fetch_array($result, $row, $result_type){}
75813
75814/**
75815 * Fetch a row as an associative array
75816 *
75817 * {@link pg_fetch_assoc} returns an associative array that corresponds
75818 * to the fetched row (records).
75819 *
75820 * {@link pg_fetch_assoc} is equivalent to calling {@link pg_fetch_array}
75821 * with PGSQL_ASSOC as the optional third parameter. It only returns an
75822 * associative array. If you need the numeric indices, use {@link
75823 * pg_fetch_row}.
75824 *
75825 * {@link pg_fetch_assoc} is NOT significantly slower than using {@link
75826 * pg_fetch_row}, and is significantly easier to use.
75827 *
75828 * @param resource $result PostgreSQL query result resource, returned
75829 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
75830 *   (among others).
75831 * @param int $row Row number in result to fetch. Rows are numbered
75832 *   from 0 upwards. If omitted or NULL, the next row is fetched.
75833 * @return array An array indexed associatively (by field name). Each
75834 *   value in the array is represented as a string. Database NULL values
75835 *   are returned as NULL.
75836 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
75837 **/
75838function pg_fetch_assoc($result, $row){}
75839
75840/**
75841 * Fetch a row as an object
75842 *
75843 * {@link pg_fetch_object} returns an object with properties that
75844 * correspond to the fetched row's field names. It can optionally
75845 * instantiate an object of a specific class, and pass parameters to that
75846 * class's constructor.
75847 *
75848 * Speed-wise, the function is identical to {@link pg_fetch_array}, and
75849 * almost as fast as {@link pg_fetch_row} (the difference is
75850 * insignificant).
75851 *
75852 * @param resource $result PostgreSQL query result resource, returned
75853 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
75854 *   (among others).
75855 * @param int $row Row number in result to fetch. Rows are numbered
75856 *   from 0 upwards. If omitted or NULL, the next row is fetched.
75857 * @param int $result_type Ignored and deprecated.
75858 * @return object An object with one attribute for each field name in
75859 *   the result. Database NULL values are returned as NULL.
75860 * @since PHP 4, PHP 5, PHP 7
75861 **/
75862function pg_fetch_object($result, $row, $result_type){}
75863
75864/**
75865 * Returns values from a result resource
75866 *
75867 * {@link pg_fetch_result} returns the value of a particular row and
75868 * field (column) in a PostgreSQL result resource.
75869 *
75870 * @param resource $result PostgreSQL query result resource, returned
75871 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
75872 *   (among others).
75873 * @param int $row Row number in result to fetch. Rows are numbered
75874 *   from 0 upwards. If omitted, next row is fetched.
75875 * @param mixed $field A string representing the name of the field
75876 *   (column) to fetch, otherwise an int representing the field number to
75877 *   fetch. Fields are numbered from 0 upwards.
75878 * @return string Boolean is returned as t or f. All other types,
75879 *   including arrays are returned as strings formatted in the same
75880 *   default PostgreSQL manner that you would see in the psql program.
75881 *   Database NULL values are returned as NULL.
75882 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
75883 **/
75884function pg_fetch_result($result, $row, $field){}
75885
75886/**
75887 * Get a row as an enumerated array
75888 *
75889 * {@link pg_fetch_row} fetches one row of data from the result
75890 * associated with the specified {@link result} resource.
75891 *
75892 * @param resource $result PostgreSQL query result resource, returned
75893 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
75894 *   (among others).
75895 * @param int $row Row number in result to fetch. Rows are numbered
75896 *   from 0 upwards. If omitted or NULL, the next row is fetched.
75897 * @return array An array, indexed from 0 upwards, with each value
75898 *   represented as a string. Database NULL values are returned as NULL.
75899 * @since PHP 4, PHP 5, PHP 7
75900 **/
75901function pg_fetch_row($result, $row){}
75902
75903/**
75904 * Test if a field is SQL
75905 *
75906 * {@link pg_field_is_null} tests if a field in a PostgreSQL result
75907 * resource is SQL NULL or not.
75908 *
75909 * @param resource $result PostgreSQL query result resource, returned
75910 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
75911 *   (among others).
75912 * @param int $row Row number in result to fetch. Rows are numbered
75913 *   from 0 upwards. If omitted, current row is fetched.
75914 * @param mixed $field Field number (starting from 0) as an integer or
75915 *   the field name as a string.
75916 * @return int Returns 1 if the field in the given row is SQL NULL, 0
75917 *   if not. FALSE is returned if the row is out of range, or upon any
75918 *   other error.
75919 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
75920 **/
75921function pg_field_is_null($result, $row, $field){}
75922
75923/**
75924 * Returns the name of a field
75925 *
75926 * {@link pg_field_name} returns the name of the field occupying the
75927 * given {@link field_number} in the given PostgreSQL {@link result}
75928 * resource. Field numbering starts from 0.
75929 *
75930 * @param resource $result PostgreSQL query result resource, returned
75931 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
75932 *   (among others).
75933 * @param int $field_number Field number, starting from 0.
75934 * @return string The field name, or FALSE on error.
75935 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
75936 **/
75937function pg_field_name($result, $field_number){}
75938
75939/**
75940 * Returns the field number of the named field
75941 *
75942 * {@link pg_field_num} will return the number of the field number that
75943 * corresponds to the {@link field_name} in the given PostgreSQL {@link
75944 * result} resource.
75945 *
75946 * @param resource $result PostgreSQL query result resource, returned
75947 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
75948 *   (among others).
75949 * @param string $field_name The name of the field.
75950 * @return int The field number (numbered from 0), or -1 on error.
75951 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
75952 **/
75953function pg_field_num($result, $field_name){}
75954
75955/**
75956 * Returns the printed length
75957 *
75958 * {@link pg_field_prtlen} returns the actual printed length (number of
75959 * characters) of a specific value in a PostgreSQL {@link result}. Row
75960 * numbering starts at 0. This function will return FALSE on an error.
75961 *
75962 * {@link field_name_or_number} can be passed either as an integer or as
75963 * a string. If it is passed as an integer, PHP recognises it as the
75964 * field number, otherwise as field name.
75965 *
75966 * See the example given at the {@link pg_field_name} page.
75967 *
75968 * @param resource $result PostgreSQL query result resource, returned
75969 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
75970 *   (among others).
75971 * @param int $row_number Row number in result. Rows are numbered from
75972 *   0 upwards. If omitted, current row is fetched.
75973 * @param mixed $field_name_or_number
75974 * @return int The field printed length, or FALSE on error.
75975 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
75976 **/
75977function pg_field_prtlen($result, $row_number, $field_name_or_number){}
75978
75979/**
75980 * Returns the internal storage size of the named field
75981 *
75982 * {@link pg_field_size} returns the internal storage size (in bytes) of
75983 * the field number in the given PostgreSQL {@link result}.
75984 *
75985 * @param resource $result PostgreSQL query result resource, returned
75986 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
75987 *   (among others).
75988 * @param int $field_number Field number, starting from 0.
75989 * @return int The internal field storage size (in bytes). -1 indicates
75990 *   a variable length field. FALSE is returned on error.
75991 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
75992 **/
75993function pg_field_size($result, $field_number){}
75994
75995/**
75996 * Returns the name or oid of the tables field
75997 *
75998 * {@link pg_field_table} returns the name of the table that field
75999 * belongs to, or the table's oid if {@link oid_only} is TRUE.
76000 *
76001 * @param resource $result PostgreSQL query result resource, returned
76002 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
76003 *   (among others).
76004 * @param int $field_number Field number, starting from 0.
76005 * @param bool $oid_only By default the tables name that field belongs
76006 *   to is returned but if {@link oid_only} is set to TRUE, then the oid
76007 *   will instead be returned.
76008 * @return mixed On success either the fields table name or oid. Or,
76009 *   FALSE on failure.
76010 * @since PHP 5 >= 5.2.0, PHP 7
76011 **/
76012function pg_field_table($result, $field_number, $oid_only){}
76013
76014/**
76015 * Returns the type name for the corresponding field number
76016 *
76017 * {@link pg_field_type} returns a string containing the base type name
76018 * of the given {@link field_number} in the given PostgreSQL {@link
76019 * result} resource.
76020 *
76021 * @param resource $result PostgreSQL query result resource, returned
76022 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
76023 *   (among others).
76024 * @param int $field_number Field number, starting from 0.
76025 * @return string A string containing the base name of the field's
76026 *   type, or FALSE on error.
76027 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76028 **/
76029function pg_field_type($result, $field_number){}
76030
76031/**
76032 * Returns the type ID (OID) for the corresponding field number
76033 *
76034 * {@link pg_field_type_oid} returns an integer containing the OID of the
76035 * base type of the given {@link field_number} in the given PostgreSQL
76036 * {@link result} resource.
76037 *
76038 * You can get more information about the field type by querying
76039 * PostgreSQL's pg_type system table using the OID obtained with this
76040 * function. The PostgreSQL {@link format_type} function will convert a
76041 * type OID into an SQL standard type name.
76042 *
76043 * @param resource $result PostgreSQL query result resource, returned
76044 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
76045 *   (among others).
76046 * @param int $field_number Field number, starting from 0.
76047 * @return int The OID of the field's base type. FALSE is returned on
76048 *   error.
76049 * @since PHP 5 >= 5.1.0, PHP 7
76050 **/
76051function pg_field_type_oid($result, $field_number){}
76052
76053/**
76054 * Flush outbound query data on the connection
76055 *
76056 * {@link pg_flush} flushes any outbound query data waiting to be sent on
76057 * the connection.
76058 *
76059 * @param resource $connection PostgreSQL database connection resource.
76060 * @return mixed Returns TRUE if the flush was successful or no data
76061 *   was waiting to be flushed, 0 if part of the pending data was flushed
76062 *   but more remains.
76063 * @since PHP 5 >= 5.6.0, PHP 7
76064 **/
76065function pg_flush($connection){}
76066
76067/**
76068 * Free result memory
76069 *
76070 * {@link pg_free_result} frees the memory and data associated with the
76071 * specified PostgreSQL query result resource.
76072 *
76073 * This function need only be called if memory consumption during script
76074 * execution is a problem. Otherwise, all result memory will be
76075 * automatically freed when the script ends.
76076 *
76077 * @param resource $result PostgreSQL query result resource, returned
76078 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
76079 *   (among others).
76080 * @return bool
76081 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76082 **/
76083function pg_free_result($result){}
76084
76085/**
76086 * Gets SQL NOTIFY message
76087 *
76088 * {@link pg_get_notify} gets notifications generated by a NOTIFY SQL
76089 * command. To receive notifications, the LISTEN SQL command must be
76090 * issued.
76091 *
76092 * @param resource $connection PostgreSQL database connection resource.
76093 * @param int $result_type An optional parameter that controls how the
76094 *   returned array is indexed. {@link result_type} is a constant and can
76095 *   take the following values: PGSQL_ASSOC, PGSQL_NUM and PGSQL_BOTH.
76096 *   Using PGSQL_NUM, {@link pg_get_notify} will return an array with
76097 *   numerical indices, using PGSQL_ASSOC it will return only associative
76098 *   indices while PGSQL_BOTH, the default, will return both numerical
76099 *   and associative indices.
76100 * @return array An array containing the NOTIFY message name and
76101 *   backend PID. As of PHP 5.4.0 and if supported by the server, the
76102 *   array also contains the server version and the payload. Otherwise if
76103 *   no NOTIFY is waiting, then FALSE is returned.
76104 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
76105 **/
76106function pg_get_notify($connection, $result_type){}
76107
76108/**
76109 * Gets the backend's process ID
76110 *
76111 * {@link pg_get_pid} gets the backend's (database server process) PID.
76112 * The PID is useful to determine whether or not a NOTIFY message
76113 * received via {@link pg_get_notify} is sent from another process or
76114 * not.
76115 *
76116 * @param resource $connection PostgreSQL database connection resource.
76117 * @return int The backend database process ID.
76118 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
76119 **/
76120function pg_get_pid($connection){}
76121
76122/**
76123 * Get asynchronous query result
76124 *
76125 * {@link pg_get_result} gets the result resource from an asynchronous
76126 * query executed by {@link pg_send_query}, {@link pg_send_query_params}
76127 * or {@link pg_send_execute}.
76128 *
76129 * {@link pg_send_query} and the other asynchronous query functions can
76130 * send multiple queries to a PostgreSQL server and {@link pg_get_result}
76131 * is used to get each query's results, one by one.
76132 *
76133 * @param resource $connection PostgreSQL database connection resource.
76134 * @return resource The result resource, or FALSE if no more results
76135 *   are available.
76136 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76137 **/
76138function pg_get_result($connection){}
76139
76140/**
76141 * Returns the host name associated with the connection
76142 *
76143 * {@link pg_host} returns the host name of the given PostgreSQL {@link
76144 * connection} resource is connected to.
76145 *
76146 * @param resource $connection PostgreSQL database connection resource.
76147 *   When {@link connection} is not present, the default connection is
76148 *   used. The default connection is the last connection made by {@link
76149 *   pg_connect} or {@link pg_pconnect}.
76150 * @return string A string containing the name of the host the {@link
76151 *   connection} is to, or FALSE on error.
76152 * @since PHP 4, PHP 5, PHP 7
76153 **/
76154function pg_host($connection){}
76155
76156/**
76157 * Insert array into table
76158 *
76159 * {@link pg_insert} inserts the values of {@link assoc_array} into the
76160 * table specified by {@link table_name}. If {@link options} is
76161 * specified, {@link pg_convert} is applied to {@link assoc_array} with
76162 * the specified options.
76163 *
76164 * If options is specified, {@link pg_convert} is applied to assoc_array
76165 * with the specified flags.
76166 *
76167 * By default {@link pg_insert} passes raw values. Values must be escaped
76168 * or PGSQL_DML_ESCAPE option must be specified. PGSQL_DML_ESCAPE quotes
76169 * and escapes parameters/identifiers. Therefore, table/column names
76170 * became case sensitive.
76171 *
76172 * Note that neither escape nor prepared query can protect LIKE query,
76173 * JSON, Array, Regex, etc. These parameters should be handled according
76174 * to their contexts. i.e. Escape/validate values.
76175 *
76176 * @param resource $connection PostgreSQL database connection resource.
76177 * @param string $table_name Name of the table into which to insert
76178 *   rows. The table {@link table_name} must at least have as many
76179 *   columns as {@link assoc_array} has elements.
76180 * @param array $assoc_array An array whose keys are field names in the
76181 *   table {@link table_name}, and whose values are the values of those
76182 *   fields that are to be inserted.
76183 * @param int $options Any number of PGSQL_CONV_OPTS,
76184 *   PGSQL_DML_NO_CONV, PGSQL_DML_ESCAPE, PGSQL_DML_EXEC, PGSQL_DML_ASYNC
76185 *   or PGSQL_DML_STRING combined. If PGSQL_DML_STRING is part of the
76186 *   {@link options} then query string is returned. When
76187 *   PGSQL_DML_NO_CONV or PGSQL_DML_ESCAPE is set, it does not call
76188 *   {@link pg_convert} internally.
76189 * @return mixed Returns the connection resource on success, . Returns
76190 *   string if PGSQL_DML_STRING is passed via {@link options}.
76191 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
76192 **/
76193function pg_insert($connection, $table_name, $assoc_array, $options){}
76194
76195/**
76196 * Get the last error message string of a connection
76197 *
76198 * {@link pg_last_error} returns the last error message for a given
76199 * {@link connection}.
76200 *
76201 * Error messages may be overwritten by internal PostgreSQL (libpq)
76202 * function calls. It may not return an appropriate error message if
76203 * multiple errors occur inside a PostgreSQL module function.
76204 *
76205 * Use {@link pg_result_error}, {@link pg_result_error_field}, {@link
76206 * pg_result_status} and {@link pg_connection_status} for better error
76207 * handling.
76208 *
76209 * @param resource $connection PostgreSQL database connection resource.
76210 *   When {@link connection} is not present, the default connection is
76211 *   used. The default connection is the last connection made by {@link
76212 *   pg_connect} or {@link pg_pconnect}.
76213 * @return string A string containing the last error message on the
76214 *   given {@link connection}, or FALSE on error.
76215 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76216 **/
76217function pg_last_error($connection){}
76218
76219/**
76220 * Returns the last notice message from PostgreSQL server
76221 *
76222 * {@link pg_last_notice} returns the last notice message from the
76223 * PostgreSQL server on the specified {@link connection}. The PostgreSQL
76224 * server sends notice messages in several cases, for instance when
76225 * creating a SERIAL column in a table.
76226 *
76227 * With {@link pg_last_notice}, you can avoid issuing useless queries by
76228 * checking whether or not the notice is related to your transaction.
76229 *
76230 * Notice message tracking can be set to optional by setting 1 for
76231 * pgsql.ignore_notice in .
76232 *
76233 * Notice message logging can be set to optional by setting 0 for
76234 * pgsql.log_notice in . Unless pgsql.ignore_notice is set to 0, notice
76235 * message cannot be logged.
76236 *
76237 * @param resource $connection PostgreSQL database connection resource.
76238 * @param int $option One of PGSQL_NOTICE_LAST (to return last notice),
76239 *   PGSQL_NOTICE_ALL (to return all notices), or PGSQL_NOTICE_CLEAR (to
76240 *   clear notices).
76241 * @return mixed A string containing the last notice on the given
76242 *   {@link connection} with PGSQL_NOTICE_LAST, an array with
76243 *   PGSQL_NOTICE_ALL, a boolean with PGSQL_NOTICE_CLEAR, or FALSE on
76244 *   error.
76245 * @since PHP 4 >= 4.0.6, PHP 5, PHP 7
76246 **/
76247function pg_last_notice($connection, $option){}
76248
76249/**
76250 * Returns the last row's OID
76251 *
76252 * {@link pg_last_oid} is used to retrieve the OID assigned to an
76253 * inserted row.
76254 *
76255 * OID field became an optional field from PostgreSQL 7.2 and will not be
76256 * present by default in PostgreSQL 8.1. When the OID field is not
76257 * present in a table, the programmer must use {@link pg_result_status}
76258 * to check for successful insertion.
76259 *
76260 * To get the value of a SERIAL field in an inserted row, it is necessary
76261 * to use the PostgreSQL CURRVAL function, naming the sequence whose last
76262 * value is required. If the name of the sequence is unknown, the
76263 * pg_get_serial_sequence PostgreSQL 8.0 function is necessary.
76264 *
76265 * PostgreSQL 8.1 has a function LASTVAL that returns the value of the
76266 * most recently used sequence in the session. This avoids the need for
76267 * naming the sequence, table or column altogether.
76268 *
76269 * @param resource $result PostgreSQL query result resource, returned
76270 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
76271 *   (among others).
76272 * @return string A string containing the OID assigned to the most
76273 *   recently inserted row in the specified {@link connection}, or FALSE
76274 *   on error or no available OID.
76275 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76276 **/
76277function pg_last_oid($result){}
76278
76279/**
76280 * Close a large object
76281 *
76282 * {@link pg_lo_close} closes a large object. {@link large_object} is a
76283 * resource for the large object from {@link pg_lo_open}.
76284 *
76285 * To use the large object interface, it is necessary to enclose it
76286 * within a transaction block.
76287 *
76288 * @param resource $large_object PostgreSQL large object (LOB)
76289 *   resource, returned by {@link pg_lo_open}.
76290 * @return bool
76291 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76292 **/
76293function pg_lo_close($large_object){}
76294
76295/**
76296 * Create a large object
76297 *
76298 * {@link pg_lo_create} creates a large object and returns the OID of the
76299 * large object. PostgreSQL access modes INV_READ, INV_WRITE, and
76300 * INV_ARCHIVE are not supported, the object is created always with both
76301 * read and write access. INV_ARCHIVE has been removed from PostgreSQL
76302 * itself (version 6.3 and above).
76303 *
76304 * To use the large object interface, it is necessary to enclose it
76305 * within a transaction block.
76306 *
76307 * Instead of using the large object interface (which has no access
76308 * controls and is cumbersome to use), try PostgreSQL's bytea column type
76309 * and {@link pg_escape_bytea}.
76310 *
76311 * @param resource $connection PostgreSQL database connection resource.
76312 *   When {@link connection} is not present, the default connection is
76313 *   used. The default connection is the last connection made by {@link
76314 *   pg_connect} or {@link pg_pconnect}.
76315 * @param mixed $object_id If an {@link object_id} is given the
76316 *   function will try to create a large object with this id, else a free
76317 *   object id is assigned by the server. The parameter was added in PHP
76318 *   5.3 and relies on functionality that first appeared in PostgreSQL
76319 *   8.1.
76320 * @return int A large object OID or FALSE on error.
76321 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76322 **/
76323function pg_lo_create($connection, $object_id){}
76324
76325/**
76326 * Export a large object to file
76327 *
76328 * {@link pg_lo_export} takes a large object in a PostgreSQL database and
76329 * saves its contents to a file on the local filesystem.
76330 *
76331 * To use the large object interface, it is necessary to enclose it
76332 * within a transaction block.
76333 *
76334 * @param resource $connection PostgreSQL database connection resource.
76335 *   When {@link connection} is not present, the default connection is
76336 *   used. The default connection is the last connection made by {@link
76337 *   pg_connect} or {@link pg_pconnect}.
76338 * @param int $oid The OID of the large object in the database.
76339 * @param string $pathname The full path and file name of the file in
76340 *   which to write the large object on the client filesystem.
76341 * @return bool
76342 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76343 **/
76344function pg_lo_export($connection, $oid, $pathname){}
76345
76346/**
76347 * Import a large object from file
76348 *
76349 * {@link pg_lo_import} creates a new large object in the database using
76350 * a file on the filesystem as its data source.
76351 *
76352 * To use the large object interface, it is necessary to enclose it
76353 * within a transaction block.
76354 *
76355 * @param resource $connection PostgreSQL database connection resource.
76356 *   When {@link connection} is not present, the default connection is
76357 *   used. The default connection is the last connection made by {@link
76358 *   pg_connect} or {@link pg_pconnect}.
76359 * @param string $pathname The full path and file name of the file on
76360 *   the client filesystem from which to read the large object data.
76361 * @param mixed $object_id If an {@link object_id} is given the
76362 *   function will try to create a large object with this id, else a free
76363 *   object id is assigned by the server. The parameter was added in PHP
76364 *   5.3 and relies on functionality that first appeared in PostgreSQL
76365 *   8.1.
76366 * @return int The OID of the newly created large object, or FALSE on
76367 *   failure.
76368 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76369 **/
76370function pg_lo_import($connection, $pathname, $object_id){}
76371
76372/**
76373 * Open a large object
76374 *
76375 * {@link pg_lo_open} opens a large object in the database and returns
76376 * large object resource so that it can be manipulated.
76377 *
76378 * To use the large object interface, it is necessary to enclose it
76379 * within a transaction block.
76380 *
76381 * @param resource $connection PostgreSQL database connection resource.
76382 *   When {@link connection} is not present, the default connection is
76383 *   used. The default connection is the last connection made by {@link
76384 *   pg_connect} or {@link pg_pconnect}.
76385 * @param int $oid The OID of the large object in the database.
76386 * @param string $mode Can be either "r" for read-only, "w" for write
76387 *   only or "rw" for read and write.
76388 * @return resource A large object resource or FALSE on error.
76389 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76390 **/
76391function pg_lo_open($connection, $oid, $mode){}
76392
76393/**
76394 * Read a large object
76395 *
76396 * {@link pg_lo_read} reads at most {@link len} bytes from a large object
76397 * and returns it as a string.
76398 *
76399 * To use the large object interface, it is necessary to enclose it
76400 * within a transaction block.
76401 *
76402 * @param resource $large_object PostgreSQL large object (LOB)
76403 *   resource, returned by {@link pg_lo_open}.
76404 * @param int $len An optional maximum number of bytes to return.
76405 * @return string A string containing {@link len} bytes from the large
76406 *   object, or FALSE on error.
76407 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76408 **/
76409function pg_lo_read($large_object, $len){}
76410
76411/**
76412 * Reads an entire large object and send straight to browser
76413 *
76414 * {@link pg_lo_read_all} reads a large object and passes it straight
76415 * through to the browser after sending all pending headers. Mainly
76416 * intended for sending binary data like images or sound.
76417 *
76418 * To use the large object interface, it is necessary to enclose it
76419 * within a transaction block.
76420 *
76421 * @param resource $large_object PostgreSQL large object (LOB)
76422 *   resource, returned by {@link pg_lo_open}.
76423 * @return int Number of bytes read or FALSE on error.
76424 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76425 **/
76426function pg_lo_read_all($large_object){}
76427
76428/**
76429 * Seeks position within a large object
76430 *
76431 * {@link pg_lo_seek} seeks a position within a large object resource.
76432 *
76433 * To use the large object interface, it is necessary to enclose it
76434 * within a transaction block.
76435 *
76436 * @param resource $large_object PostgreSQL large object (LOB)
76437 *   resource, returned by {@link pg_lo_open}.
76438 * @param int $offset The number of bytes to seek.
76439 * @param int $whence One of the constants PGSQL_SEEK_SET (seek from
76440 *   object start), PGSQL_SEEK_CUR (seek from current position) or
76441 *   PGSQL_SEEK_END (seek from object end) .
76442 * @return bool
76443 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76444 **/
76445function pg_lo_seek($large_object, $offset, $whence){}
76446
76447/**
76448 * Returns current seek position a of large object
76449 *
76450 * {@link pg_lo_tell} returns the current position (offset from the
76451 * beginning) of a large object.
76452 *
76453 * To use the large object interface, it is necessary to enclose it
76454 * within a transaction block.
76455 *
76456 * @param resource $large_object PostgreSQL large object (LOB)
76457 *   resource, returned by {@link pg_lo_open}.
76458 * @return int The current seek offset (in number of bytes) from the
76459 *   beginning of the large object. If there is an error, the return
76460 *   value is negative.
76461 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76462 **/
76463function pg_lo_tell($large_object){}
76464
76465/**
76466 * Truncates a large object
76467 *
76468 * {@link pg_lo_truncate} truncates a large object resource.
76469 *
76470 * To use the large object interface, it is necessary to enclose it
76471 * within a transaction block.
76472 *
76473 * @param resource $large_object PostgreSQL large object (LOB)
76474 *   resource, returned by {@link pg_lo_open}.
76475 * @param int $size The number of bytes to truncate.
76476 * @return bool
76477 * @since PHP 5 >= 5.6.0, PHP 7
76478 **/
76479function pg_lo_truncate($large_object, $size){}
76480
76481/**
76482 * Delete a large object
76483 *
76484 * {@link pg_lo_unlink} deletes a large object with the {@link oid}.
76485 *
76486 * To use the large object interface, it is necessary to enclose it
76487 * within a transaction block.
76488 *
76489 * @param resource $connection PostgreSQL database connection resource.
76490 *   When {@link connection} is not present, the default connection is
76491 *   used. The default connection is the last connection made by {@link
76492 *   pg_connect} or {@link pg_pconnect}.
76493 * @param int $oid The OID of the large object in the database.
76494 * @return bool
76495 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76496 **/
76497function pg_lo_unlink($connection, $oid){}
76498
76499/**
76500 * Write to a large object
76501 *
76502 * {@link pg_lo_write} writes data into a large object at the current
76503 * seek position.
76504 *
76505 * To use the large object interface, it is necessary to enclose it
76506 * within a transaction block.
76507 *
76508 * @param resource $large_object PostgreSQL large object (LOB)
76509 *   resource, returned by {@link pg_lo_open}.
76510 * @param string $data The data to be written to the large object. If
76511 *   {@link len} is specified and is less than the length of {@link
76512 *   data}, only {@link len} bytes will be written.
76513 * @param int $len An optional maximum number of bytes to write. Must
76514 *   be greater than zero and no greater than the length of {@link data}.
76515 *   Defaults to the length of {@link data}.
76516 * @return int The number of bytes written to the large object, or
76517 *   FALSE on error.
76518 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76519 **/
76520function pg_lo_write($large_object, $data, $len){}
76521
76522/**
76523 * Get meta data for table
76524 *
76525 * {@link pg_meta_data} returns table definition for table_name as an
76526 * array.
76527 *
76528 * @param resource $connection PostgreSQL database connection resource.
76529 * @param string $table_name The name of the table.
76530 * @param bool $extended Flag for returning extended meta data. Default
76531 *   to FALSE.
76532 * @return array An array of the table definition, or FALSE on error.
76533 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
76534 **/
76535function pg_meta_data($connection, $table_name, $extended){}
76536
76537/**
76538 * Returns the number of fields in a result
76539 *
76540 * {@link pg_num_fields} returns the number of fields (columns) in a
76541 * PostgreSQL result resource.
76542 *
76543 * @param resource $result PostgreSQL query result resource, returned
76544 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
76545 *   (among others).
76546 * @return int The number of fields (columns) in the result. On error,
76547 *   -1 is returned.
76548 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76549 **/
76550function pg_num_fields($result){}
76551
76552/**
76553 * Returns the number of rows in a result
76554 *
76555 * {@link pg_num_rows} will return the number of rows in a PostgreSQL
76556 * result resource.
76557 *
76558 * @param resource $result PostgreSQL query result resource, returned
76559 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
76560 *   (among others).
76561 * @return int The number of rows in the result. On error, -1 is
76562 *   returned.
76563 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76564 **/
76565function pg_num_rows($result){}
76566
76567/**
76568 * Get the options associated with the connection
76569 *
76570 * {@link pg_options} will return a string containing the options
76571 * specified on the given PostgreSQL {@link connection} resource.
76572 *
76573 * @param resource $connection PostgreSQL database connection resource.
76574 *   When {@link connection} is not present, the default connection is
76575 *   used. The default connection is the last connection made by {@link
76576 *   pg_connect} or {@link pg_pconnect}.
76577 * @return string A string containing the {@link connection} options,
76578 *   or FALSE on error.
76579 * @since PHP 4, PHP 5, PHP 7
76580 **/
76581function pg_options($connection){}
76582
76583/**
76584 * Looks up a current parameter setting of the server
76585 *
76586 * Certain parameter values are reported by the server automatically at
76587 * connection startup or whenever their values change. {@link
76588 * pg_parameter_status} can be used to interrogate these settings. It
76589 * returns the current value of a parameter if known, or FALSE if the
76590 * parameter is not known.
76591 *
76592 * Parameters reported as of PostgreSQL 8.0 include server_version,
76593 * server_encoding, client_encoding, is_superuser, session_authorization,
76594 * DateStyle, TimeZone, and integer_datetimes. (server_encoding,
76595 * TimeZone, and integer_datetimes were not reported by releases before
76596 * 8.0.) Note that server_version, server_encoding and integer_datetimes
76597 * cannot change after PostgreSQL startup.
76598 *
76599 * PostgreSQL 7.3 or lower servers do not report parameter settings,
76600 * {@link pg_parameter_status} includes logic to obtain values for
76601 * server_version and client_encoding anyway. Applications are encouraged
76602 * to use {@link pg_parameter_status} rather than ad hoc code to
76603 * determine these values.
76604 *
76605 * @param resource $connection PostgreSQL database connection resource.
76606 *   When {@link connection} is not present, the default connection is
76607 *   used. The default connection is the last connection made by {@link
76608 *   pg_connect} or {@link pg_pconnect}.
76609 * @param string $param_name Possible {@link param_name} values include
76610 *   server_version, server_encoding, client_encoding, is_superuser,
76611 *   session_authorization, DateStyle, TimeZone, and integer_datetimes.
76612 * @return string A string containing the value of the parameter, FALSE
76613 *   on failure or invalid {@link param_name}.
76614 * @since PHP 5, PHP 7
76615 **/
76616function pg_parameter_status($connection, $param_name){}
76617
76618/**
76619 * Open a persistent PostgreSQL connection
76620 *
76621 * {@link pg_pconnect} opens a connection to a PostgreSQL database. It
76622 * returns a connection resource that is needed by other PostgreSQL
76623 * functions.
76624 *
76625 * If a second call is made to {@link pg_pconnect} with the same {@link
76626 * connection_string} as an existing connection, the existing connection
76627 * will be returned unless you pass PGSQL_CONNECT_FORCE_NEW as {@link
76628 * connect_type}.
76629 *
76630 * To enable persistent connection, the pgsql.allow_persistent directive
76631 * must be set to On (which is the default). The maximum number of
76632 * persistent connection can be defined with the pgsql.max_persistent
76633 * directive (defaults to -1 for no limit). The total number of
76634 * connections can be set with the pgsql.max_links directive.
76635 *
76636 * {@link pg_close} will not close persistent links generated by {@link
76637 * pg_pconnect}.
76638 *
76639 * @param string $connection_string The {@link connection_string} can
76640 *   be empty to use all default parameters, or it can contain one or
76641 *   more parameter settings separated by whitespace. Each parameter
76642 *   setting is in the form keyword = value. Spaces around the equal sign
76643 *   are optional. To write an empty value or a value containing spaces,
76644 *   surround it with single quotes, e.g., keyword = 'a value'. Single
76645 *   quotes and backslashes within the value must be escaped with a
76646 *   backslash, i.e., \' and \\. The currently recognized parameter
76647 *   keywords are: {@link host}, {@link hostaddr}, {@link port}, {@link
76648 *   dbname}, {@link user}, {@link password}, {@link connect_timeout},
76649 *   {@link options}, {@link tty} (ignored), {@link sslmode}, {@link
76650 *   requiressl} (deprecated in favor of {@link sslmode}), and {@link
76651 *   service}. Which of these arguments exist depends on your PostgreSQL
76652 *   version.
76653 * @param int $connect_type If PGSQL_CONNECT_FORCE_NEW is passed, then
76654 *   a new connection is created, even if the {@link connection_string}
76655 *   is identical to an existing connection.
76656 * @return resource PostgreSQL connection resource on success, FALSE on
76657 *   failure.
76658 * @since PHP 4, PHP 5, PHP 7
76659 **/
76660function pg_pconnect($connection_string, $connect_type){}
76661
76662/**
76663 * Ping database connection
76664 *
76665 * {@link pg_ping} pings a database connection and tries to reconnect it
76666 * if it is broken.
76667 *
76668 * @param resource $connection PostgreSQL database connection resource.
76669 *   When {@link connection} is not present, the default connection is
76670 *   used. The default connection is the last connection made by {@link
76671 *   pg_connect} or {@link pg_pconnect}.
76672 * @return bool
76673 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
76674 **/
76675function pg_ping($connection){}
76676
76677/**
76678 * Return the port number associated with the connection
76679 *
76680 * {@link pg_port} returns the port number that the given PostgreSQL
76681 * {@link connection} resource is connected to.
76682 *
76683 * @param resource $connection PostgreSQL database connection resource.
76684 *   When {@link connection} is not present, the default connection is
76685 *   used. The default connection is the last connection made by {@link
76686 *   pg_connect} or {@link pg_pconnect}.
76687 * @return int An int containing the port number of the database server
76688 *   the {@link connection} is to, or FALSE on error.
76689 * @since PHP 4, PHP 5, PHP 7
76690 **/
76691function pg_port($connection){}
76692
76693/**
76694 * Submits a request to create a prepared statement with the given
76695 * parameters, and waits for completion
76696 *
76697 * {@link pg_prepare} creates a prepared statement for later execution
76698 * with {@link pg_execute} or {@link pg_send_execute}. This feature
76699 * allows commands that will be used repeatedly to be parsed and planned
76700 * just once, rather than each time they are executed. {@link pg_prepare}
76701 * is supported only against PostgreSQL 7.4 or higher connections; it
76702 * will fail when using earlier versions.
76703 *
76704 * The function creates a prepared statement named {@link stmtname} from
76705 * the {@link query} string, which must contain a single SQL command.
76706 * {@link stmtname} may be "" to create an unnamed statement, in which
76707 * case any pre-existing unnamed statement is automatically replaced;
76708 * otherwise it is an error if the statement name is already defined in
76709 * the current session. If any parameters are used, they are referred to
76710 * in the {@link query} as $1, $2, etc.
76711 *
76712 * Prepared statements for use with {@link pg_prepare} can also be
76713 * created by executing SQL PREPARE statements. (But {@link pg_prepare}
76714 * is more flexible since it does not require parameter types to be
76715 * pre-specified.) Also, although there is no PHP function for deleting a
76716 * prepared statement, the SQL DEALLOCATE statement can be used for that
76717 * purpose.
76718 *
76719 * @param resource $connection PostgreSQL database connection resource.
76720 *   When {@link connection} is not present, the default connection is
76721 *   used. The default connection is the last connection made by {@link
76722 *   pg_connect} or {@link pg_pconnect}.
76723 * @param string $stmtname The name to give the prepared statement.
76724 *   Must be unique per-connection. If "" is specified, then an unnamed
76725 *   statement is created, overwriting any previously defined unnamed
76726 *   statement.
76727 * @param string $query The parameterized SQL statement. Must contain
76728 *   only a single statement. (multiple statements separated by
76729 *   semi-colons are not allowed.) If any parameters are used, they are
76730 *   referred to as $1, $2, etc.
76731 * @return resource A query result resource on success.
76732 * @since PHP 5 >= 5.1.0, PHP 7
76733 **/
76734function pg_prepare($connection, $stmtname, $query){}
76735
76736/**
76737 * Send a NULL-terminated string to PostgreSQL backend
76738 *
76739 * {@link pg_put_line} sends a NULL-terminated string to the PostgreSQL
76740 * backend server. This is needed in conjunction with PostgreSQL's COPY
76741 * FROM command.
76742 *
76743 * COPY is a high-speed data loading interface supported by PostgreSQL.
76744 * Data is passed in without being parsed, and in a single transaction.
76745 *
76746 * An alternative to using raw {@link pg_put_line} commands is to use
76747 * {@link pg_copy_from}. This is a far simpler interface.
76748 *
76749 * @param resource $connection PostgreSQL database connection resource.
76750 *   When {@link connection} is not present, the default connection is
76751 *   used. The default connection is the last connection made by {@link
76752 *   pg_connect} or {@link pg_pconnect}.
76753 * @param string $data A line of text to be sent directly to the
76754 *   PostgreSQL backend. A NULL terminator is added automatically.
76755 * @return bool
76756 * @since PHP 4 >= 4.0.3, PHP 5, PHP 7
76757 **/
76758function pg_put_line($connection, $data){}
76759
76760/**
76761 * Execute a query
76762 *
76763 * {@link pg_query} executes the {@link query} on the specified database
76764 * {@link connection}. {@link pg_query_params} should be preferred in
76765 * most cases.
76766 *
76767 * If an error occurs, and FALSE is returned, details of the error can be
76768 * retrieved using the {@link pg_last_error} function if the connection
76769 * is valid.
76770 *
76771 * Although {@link connection} can be omitted, it is not recommended,
76772 * since it can be the cause of hard to find bugs in scripts.
76773 *
76774 * @param resource $connection PostgreSQL database connection resource.
76775 *   When {@link connection} is not present, the default connection is
76776 *   used. The default connection is the last connection made by {@link
76777 *   pg_connect} or {@link pg_pconnect}.
76778 * @param string $query The SQL statement or statements to be executed.
76779 *   When multiple statements are passed to the function, they are
76780 *   automatically executed as one transaction, unless there are explicit
76781 *   BEGIN/COMMIT commands included in the query string. However, using
76782 *   multiple transactions in one function call is not recommended.
76783 * @return resource A query result resource on success.
76784 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76785 **/
76786function pg_query($connection, $query){}
76787
76788/**
76789 * Submits a command to the server and waits for the result, with the
76790 * ability to pass parameters separately from the SQL command text
76791 *
76792 * Submits a command to the server and waits for the result, with the
76793 * ability to pass parameters separately from the SQL command text.
76794 *
76795 * {@link pg_query_params} is like {@link pg_query}, but offers
76796 * additional functionality: parameter values can be specified separately
76797 * from the command string proper. {@link pg_query_params} is supported
76798 * only against PostgreSQL 7.4 or higher connections; it will fail when
76799 * using earlier versions.
76800 *
76801 * If parameters are used, they are referred to in the {@link query}
76802 * string as $1, $2, etc. The same parameter may appear more than once in
76803 * the {@link query}; the same value will be used in that case. {@link
76804 * params} specifies the actual values of the parameters. A NULL value in
76805 * this array means the corresponding parameter is SQL NULL.
76806 *
76807 * The primary advantage of {@link pg_query_params} over {@link pg_query}
76808 * is that parameter values may be separated from the {@link query}
76809 * string, thus avoiding the need for tedious and error-prone quoting and
76810 * escaping. Unlike {@link pg_query}, {@link pg_query_params} allows at
76811 * most one SQL command in the given string. (There can be semicolons in
76812 * it, but not more than one nonempty command.)
76813 *
76814 * @param resource $connection PostgreSQL database connection resource.
76815 *   When {@link connection} is not present, the default connection is
76816 *   used. The default connection is the last connection made by {@link
76817 *   pg_connect} or {@link pg_pconnect}.
76818 * @param string $query The parameterized SQL statement. Must contain
76819 *   only a single statement. (multiple statements separated by
76820 *   semi-colons are not allowed.) If any parameters are used, they are
76821 *   referred to as $1, $2, etc. User-supplied values should always be
76822 *   passed as parameters, not interpolated into the query string, where
76823 *   they form possible SQL injection attack vectors and introduce bugs
76824 *   when handling data containing quotes. If for some reason you cannot
76825 *   use a parameter, ensure that interpolated values are properly
76826 *   escaped.
76827 * @param array $params An array of parameter values to substitute for
76828 *   the $1, $2, etc. placeholders in the original prepared query string.
76829 *   The number of elements in the array must match the number of
76830 *   placeholders. Values intended for bytea fields are not supported as
76831 *   parameters. Use {@link pg_escape_bytea} instead, or use the large
76832 *   object functions.
76833 * @return resource A query result resource on success.
76834 * @since PHP 5 >= 5.1.0, PHP 7
76835 **/
76836function pg_query_params($connection, $query, $params){}
76837
76838/**
76839 * Get error message associated with result
76840 *
76841 * {@link pg_result_error} returns any error message associated with the
76842 * {@link result} resource. Therefore, the user has a better chance of
76843 * getting the correct error message than with {@link pg_last_error}.
76844 *
76845 * The function {@link pg_result_error_field} can give much greater
76846 * detail on result errors than {@link pg_result_error}.
76847 *
76848 * Because {@link pg_query} returns FALSE if the query fails, you must
76849 * use {@link pg_send_query} and {@link pg_get_result} to get the result
76850 * handle.
76851 *
76852 * @param resource $result PostgreSQL query result resource, returned
76853 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
76854 *   (among others).
76855 * @return string Returns a string. Returns empty string if there is no
76856 *   error. If there is an error associated with the {@link result}
76857 *   parameter, returns FALSE.
76858 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76859 **/
76860function pg_result_error($result){}
76861
76862/**
76863 * Returns an individual field of an error report
76864 *
76865 * {@link pg_result_error_field} returns one of the detailed error
76866 * message fields associated with {@link result} resource. It is only
76867 * available against a PostgreSQL 7.4 or above server. The error field is
76868 * specified by the {@link fieldcode}.
76869 *
76870 * Because {@link pg_query} and {@link pg_query_params} return FALSE if
76871 * the query fails, you must use {@link pg_send_query} and {@link
76872 * pg_get_result} to get the result handle.
76873 *
76874 * If you need to get additional error information from failed {@link
76875 * pg_query} queries, use {@link pg_set_error_verbosity} and {@link
76876 * pg_last_error} and then parse the result.
76877 *
76878 * @param resource $result A PostgreSQL query result resource from a
76879 *   previously executed statement.
76880 * @param int $fieldcode Possible {@link fieldcode} values are:
76881 *   PGSQL_DIAG_SEVERITY, PGSQL_DIAG_SQLSTATE,
76882 *   PGSQL_DIAG_MESSAGE_PRIMARY, PGSQL_DIAG_MESSAGE_DETAIL,
76883 *   PGSQL_DIAG_MESSAGE_HINT, PGSQL_DIAG_STATEMENT_POSITION,
76884 *   PGSQL_DIAG_INTERNAL_POSITION (PostgreSQL 8.0+ only),
76885 *   PGSQL_DIAG_INTERNAL_QUERY (PostgreSQL 8.0+ only),
76886 *   PGSQL_DIAG_CONTEXT, PGSQL_DIAG_SOURCE_FILE, PGSQL_DIAG_SOURCE_LINE
76887 *   or PGSQL_DIAG_SOURCE_FUNCTION.
76888 * @return string A string containing the contents of the error field,
76889 *   NULL if the field does not exist or FALSE on failure.
76890 * @since PHP 5 >= 5.1.0, PHP 7
76891 **/
76892function pg_result_error_field($result, $fieldcode){}
76893
76894/**
76895 * Set internal row offset in result resource
76896 *
76897 * {@link pg_result_seek} sets the internal row offset in a result
76898 * resource.
76899 *
76900 * @param resource $result PostgreSQL query result resource, returned
76901 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
76902 *   (among others).
76903 * @param int $offset Row to move the internal offset to in the {@link
76904 *   result} resource. Rows are numbered starting from zero.
76905 * @return bool
76906 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
76907 **/
76908function pg_result_seek($result, $offset){}
76909
76910/**
76911 * Get status of query result
76912 *
76913 * {@link pg_result_status} returns the status of a result resource, or
76914 * the PostgreSQL command completion tag associated with the result
76915 *
76916 * @param resource $result PostgreSQL query result resource, returned
76917 *   by {@link pg_query}, {@link pg_query_params} or {@link pg_execute}
76918 *   (among others).
76919 * @param int $type Either PGSQL_STATUS_LONG to return the numeric
76920 *   status of the {@link result}, or PGSQL_STATUS_STRING to return the
76921 *   command tag of the {@link result}. If not specified,
76922 *   PGSQL_STATUS_LONG is the default.
76923 * @return mixed Possible return values are PGSQL_EMPTY_QUERY,
76924 *   PGSQL_COMMAND_OK, PGSQL_TUPLES_OK, PGSQL_COPY_OUT, PGSQL_COPY_IN,
76925 *   PGSQL_BAD_RESPONSE, PGSQL_NONFATAL_ERROR and PGSQL_FATAL_ERROR if
76926 *   PGSQL_STATUS_LONG is specified. Otherwise, a string containing the
76927 *   PostgreSQL command tag is returned.
76928 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
76929 **/
76930function pg_result_status($result, $type){}
76931
76932/**
76933 * Select records
76934 *
76935 * {@link pg_select} selects records specified by assoc_array which has
76936 * field=>value. For a successful query, it returns an array containing
76937 * all records and fields that match the condition specified by
76938 * assoc_array.
76939 *
76940 * If options is specified, {@link pg_convert} is applied to assoc_array
76941 * with the specified flags.
76942 *
76943 * By default {@link pg_select} passes raw values. Values must be escaped
76944 * or PGSQL_DML_ESCAPE option must be specified. PGSQL_DML_ESCAPE quotes
76945 * and escapes parameters/identifiers. Therefore, table/column names
76946 * became case sensitive.
76947 *
76948 * Note that neither escape nor prepared query can protect LIKE query,
76949 * JSON, Array, Regex, etc. These parameters should be handled according
76950 * to their contexts. i.e. Escape/validate values.
76951 *
76952 * @param resource $connection PostgreSQL database connection resource.
76953 * @param string $table_name Name of the table from which to select
76954 *   rows.
76955 * @param array $assoc_array An array whose keys are field names in the
76956 *   table {@link table_name}, and whose values are the conditions that a
76957 *   row must meet to be retrieved.
76958 * @param int $options Any number of PGSQL_CONV_FORCE_NULL,
76959 *   PGSQL_DML_NO_CONV, PGSQL_DML_ESCAPE, PGSQL_DML_EXEC, PGSQL_DML_ASYNC
76960 *   or PGSQL_DML_STRING combined. If PGSQL_DML_STRING is part of the
76961 *   {@link options} then query string is returned. When
76962 *   PGSQL_DML_NO_CONV or PGSQL_DML_ESCAPE is set, it does not call
76963 *   {@link pg_convert} internally.
76964 * @param int $result_type
76965 * @return mixed Returns string if PGSQL_DML_STRING is passed via
76966 *   {@link options}.
76967 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
76968 **/
76969function pg_select($connection, $table_name, $assoc_array, $options, $result_type){}
76970
76971/**
76972 * Sends a request to execute a prepared statement with given parameters,
76973 * without waiting for the result(s)
76974 *
76975 * Sends a request to execute a prepared statement with given parameters,
76976 * without waiting for the result(s).
76977 *
76978 * This is similar to {@link pg_send_query_params}, but the command to be
76979 * executed is specified by naming a previously-prepared statement,
76980 * instead of giving a query string. The function's parameters are
76981 * handled identically to {@link pg_execute}. Like {@link pg_execute}, it
76982 * will not work on pre-7.4 versions of PostgreSQL.
76983 *
76984 * @param resource $connection PostgreSQL database connection resource.
76985 *   When {@link connection} is not present, the default connection is
76986 *   used. The default connection is the last connection made by {@link
76987 *   pg_connect} or {@link pg_pconnect}.
76988 * @param string $stmtname The name of the prepared statement to
76989 *   execute. if "" is specified, then the unnamed statement is executed.
76990 *   The name must have been previously prepared using {@link
76991 *   pg_prepare}, {@link pg_send_prepare} or a PREPARE SQL command.
76992 * @param array $params An array of parameter values to substitute for
76993 *   the $1, $2, etc. placeholders in the original prepared query string.
76994 *   The number of elements in the array must match the number of
76995 *   placeholders.
76996 * @return bool Returns TRUE on success, FALSE on failure. Use {@link
76997 *   pg_get_result} to determine the query result.
76998 * @since PHP 5 >= 5.1.0, PHP 7
76999 **/
77000function pg_send_execute($connection, $stmtname, $params){}
77001
77002/**
77003 * Sends a request to create a prepared statement with the given
77004 * parameters, without waiting for completion
77005 *
77006 * Sends a request to create a prepared statement with the given
77007 * parameters, without waiting for completion.
77008 *
77009 * This is an asynchronous version of {@link pg_prepare}: it returns TRUE
77010 * if it was able to dispatch the request, and FALSE if not. After a
77011 * successful call, call {@link pg_get_result} to determine whether the
77012 * server successfully created the prepared statement. The function's
77013 * parameters are handled identically to {@link pg_prepare}. Like {@link
77014 * pg_prepare}, it will not work on pre-7.4 versions of PostgreSQL.
77015 *
77016 * @param resource $connection PostgreSQL database connection resource.
77017 *   When {@link connection} is not present, the default connection is
77018 *   used. The default connection is the last connection made by {@link
77019 *   pg_connect} or {@link pg_pconnect}.
77020 * @param string $stmtname The name to give the prepared statement.
77021 *   Must be unique per-connection. If "" is specified, then an unnamed
77022 *   statement is created, overwriting any previously defined unnamed
77023 *   statement.
77024 * @param string $query The parameterized SQL statement. Must contain
77025 *   only a single statement. (multiple statements separated by
77026 *   semi-colons are not allowed.) If any parameters are used, they are
77027 *   referred to as $1, $2, etc.
77028 * @return bool Returns TRUE on success, FALSE on failure. Use {@link
77029 *   pg_get_result} to determine the query result.
77030 * @since PHP 5 >= 5.1.0, PHP 7
77031 **/
77032function pg_send_prepare($connection, $stmtname, $query){}
77033
77034/**
77035 * Sends asynchronous query
77036 *
77037 * {@link pg_send_query} sends a query or queries asynchronously to the
77038 * {@link connection}. Unlike {@link pg_query}, it can send multiple
77039 * queries at once to PostgreSQL and get the results one by one using
77040 * {@link pg_get_result}.
77041 *
77042 * Script execution is not blocked while the queries are executing. Use
77043 * {@link pg_connection_busy} to check if the connection is busy (i.e.
77044 * the query is executing). Queries may be cancelled using {@link
77045 * pg_cancel_query}.
77046 *
77047 * Although the user can send multiple queries at once, multiple queries
77048 * cannot be sent over a busy connection. If a query is sent while the
77049 * connection is busy, it waits until the last query is finished and
77050 * discards all its results.
77051 *
77052 * @param resource $connection PostgreSQL database connection resource.
77053 * @param string $query The SQL statement or statements to be executed.
77054 *   Data inside the query should be properly escaped.
77055 * @return bool
77056 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
77057 **/
77058function pg_send_query($connection, $query){}
77059
77060/**
77061 * Submits a command and separate parameters to the server without
77062 * waiting for the result(s)
77063 *
77064 * Submits a command and separate parameters to the server without
77065 * waiting for the result(s).
77066 *
77067 * This is equivalent to {@link pg_send_query} except that query
77068 * parameters can be specified separately from the {@link query} string.
77069 * The function's parameters are handled identically to {@link
77070 * pg_query_params}. Like {@link pg_query_params}, it will not work on
77071 * pre-7.4 PostgreSQL connections, and it allows only one command in the
77072 * query string.
77073 *
77074 * @param resource $connection PostgreSQL database connection resource.
77075 * @param string $query The parameterized SQL statement. Must contain
77076 *   only a single statement. (multiple statements separated by
77077 *   semi-colons are not allowed.) If any parameters are used, they are
77078 *   referred to as $1, $2, etc.
77079 * @param array $params An array of parameter values to substitute for
77080 *   the $1, $2, etc. placeholders in the original prepared query string.
77081 *   The number of elements in the array must match the number of
77082 *   placeholders.
77083 * @return bool
77084 * @since PHP 5 >= 5.1.0, PHP 7
77085 **/
77086function pg_send_query_params($connection, $query, $params){}
77087
77088/**
77089 * Set the client encoding
77090 *
77091 * {@link pg_set_client_encoding} sets the client encoding and returns 0
77092 * if success or -1 if error.
77093 *
77094 * PostgreSQL will automatically convert data in the backend database
77095 * encoding into the frontend encoding.
77096 *
77097 * @param resource $connection PostgreSQL database connection resource.
77098 *   When {@link connection} is not present, the default connection is
77099 *   used. The default connection is the last connection made by {@link
77100 *   pg_connect} or {@link pg_pconnect}.
77101 * @param string $encoding The required client encoding. One of
77102 *   SQL_ASCII, EUC_JP, EUC_CN, EUC_KR, EUC_TW, UNICODE, MULE_INTERNAL,
77103 *   LATINX (X=1...9), KOI8, WIN, ALT, SJIS, BIG5 or WIN1250. The exact
77104 *   list of available encodings depends on your PostgreSQL version, so
77105 *   check your PostgreSQL manual for a more specific list.
77106 * @return int Returns 0 on success or -1 on error.
77107 * @since PHP 4 >= 4.0.3, PHP 5, PHP 7
77108 **/
77109function pg_set_client_encoding($connection, $encoding){}
77110
77111/**
77112 * Determines the verbosity of messages returned by and
77113 *
77114 * Determines the verbosity of messages returned by {@link pg_last_error}
77115 * and {@link pg_result_error}.
77116 *
77117 * {@link pg_set_error_verbosity} sets the verbosity mode, returning the
77118 * connection's previous setting. In PGSQL_ERRORS_TERSE mode, returned
77119 * messages include severity, primary text, and position only; this will
77120 * normally fit on a single line. The default mode (PGSQL_ERRORS_DEFAULT)
77121 * produces messages that include the above plus any detail, hint, or
77122 * context fields (these may span multiple lines). The
77123 * PGSQL_ERRORS_VERBOSE mode includes all available fields. Changing the
77124 * verbosity does not affect the messages available from already-existing
77125 * result objects, only subsequently-created ones.
77126 *
77127 * @param resource $connection PostgreSQL database connection resource.
77128 *   When {@link connection} is not present, the default connection is
77129 *   used. The default connection is the last connection made by {@link
77130 *   pg_connect} or {@link pg_pconnect}.
77131 * @param int $verbosity The required verbosity: PGSQL_ERRORS_TERSE,
77132 *   PGSQL_ERRORS_DEFAULT or PGSQL_ERRORS_VERBOSE.
77133 * @return int The previous verbosity level: PGSQL_ERRORS_TERSE,
77134 *   PGSQL_ERRORS_DEFAULT or PGSQL_ERRORS_VERBOSE.
77135 * @since PHP 5 >= 5.1.0, PHP 7
77136 **/
77137function pg_set_error_verbosity($connection, $verbosity){}
77138
77139/**
77140 * Get a read only handle to the socket underlying a PostgreSQL
77141 * connection
77142 *
77143 * {@link pg_socket} returns a read only resource corresponding to the
77144 * socket underlying the given PostgreSQL connection.
77145 *
77146 * @param resource $connection PostgreSQL database connection resource.
77147 * @return resource A socket resource on success.
77148 * @since PHP 5 >= 5.6.0, PHP 7
77149 **/
77150function pg_socket($connection){}
77151
77152/**
77153 * Enable tracing a PostgreSQL connection
77154 *
77155 * {@link pg_trace} enables tracing of the PostgreSQL frontend/backend
77156 * communication to a file. To fully understand the results, one needs to
77157 * be familiar with the internals of PostgreSQL communication protocol.
77158 *
77159 * For those who are not, it can still be useful for tracing errors in
77160 * queries sent to the server, you could do for example grep '^To
77161 * backend' trace.log and see what queries actually were sent to the
77162 * PostgreSQL server. For more information, refer to the PostgreSQL
77163 * Documentation.
77164 *
77165 * @param string $pathname The full path and file name of the file in
77166 *   which to write the trace log. Same as in {@link fopen}.
77167 * @param string $mode An optional file access mode, same as for {@link
77168 *   fopen}.
77169 * @param resource $connection PostgreSQL database connection resource.
77170 *   When {@link connection} is not present, the default connection is
77171 *   used. The default connection is the last connection made by {@link
77172 *   pg_connect} or {@link pg_pconnect}.
77173 * @return bool
77174 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
77175 **/
77176function pg_trace($pathname, $mode, $connection){}
77177
77178/**
77179 * Returns the current in-transaction status of the server
77180 *
77181 * @param resource $connection PostgreSQL database connection resource.
77182 * @return int The status can be PGSQL_TRANSACTION_IDLE (currently
77183 *   idle), PGSQL_TRANSACTION_ACTIVE (a command is in progress),
77184 *   PGSQL_TRANSACTION_INTRANS (idle, in a valid transaction block), or
77185 *   PGSQL_TRANSACTION_INERROR (idle, in a failed transaction block).
77186 *   PGSQL_TRANSACTION_UNKNOWN is reported if the connection is bad.
77187 *   PGSQL_TRANSACTION_ACTIVE is reported only when a query has been sent
77188 *   to the server and not yet completed.
77189 * @since PHP 5 >= 5.1.0, PHP 7
77190 **/
77191function pg_transaction_status($connection){}
77192
77193/**
77194 * Return the TTY name associated with the connection
77195 *
77196 * {@link pg_tty} returns the TTY name that server side debugging output
77197 * is sent to on the given PostgreSQL {@link connection} resource.
77198 *
77199 * @param resource $connection PostgreSQL database connection resource.
77200 *   When {@link connection} is not present, the default connection is
77201 *   used. The default connection is the last connection made by {@link
77202 *   pg_connect} or {@link pg_pconnect}.
77203 * @return string A string containing the debug TTY of the {@link
77204 *   connection}, or FALSE on error.
77205 * @since PHP 4, PHP 5, PHP 7
77206 **/
77207function pg_tty($connection){}
77208
77209/**
77210 * Unescape binary for bytea type
77211 *
77212 * {@link pg_unescape_bytea} unescapes PostgreSQL bytea data values. It
77213 * returns the unescaped string, possibly containing binary data.
77214 *
77215 * @param string $data A string containing PostgreSQL bytea data to be
77216 *   converted into a PHP binary string.
77217 * @return string A string containing the unescaped data.
77218 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
77219 **/
77220function pg_unescape_bytea($data){}
77221
77222/**
77223 * Disable tracing of a PostgreSQL connection
77224 *
77225 * Stop tracing started by {@link pg_trace}.
77226 *
77227 * @param resource $connection PostgreSQL database connection resource.
77228 *   When {@link connection} is not present, the default connection is
77229 *   used. The default connection is the last connection made by {@link
77230 *   pg_connect} or {@link pg_pconnect}.
77231 * @return bool Always returns TRUE.
77232 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
77233 **/
77234function pg_untrace($connection){}
77235
77236/**
77237 * Update table
77238 *
77239 * {@link pg_update} updates records that matches condition with data. If
77240 * options is specified, {@link pg_convert} is applied to data with
77241 * specified options.
77242 *
77243 * {@link pg_update} updates records specified by assoc_array which has
77244 * field=>value.
77245 *
77246 * If options is specified, {@link pg_convert} is applied to assoc_array
77247 * with the specified flags.
77248 *
77249 * By default {@link pg_update} passes raw values. Values must be escaped
77250 * or PGSQL_DML_ESCAPE option must be specified. PGSQL_DML_ESCAPE quotes
77251 * and escapes parameters/identifiers. Therefore, table/column names
77252 * became case sensitive.
77253 *
77254 * Note that neither escape nor prepared query can protect LIKE query,
77255 * JSON, Array, Regex, etc. These parameters should be handled according
77256 * to their contexts. i.e. Escape/validate values.
77257 *
77258 * @param resource $connection PostgreSQL database connection resource.
77259 * @param string $table_name Name of the table into which to update
77260 *   rows.
77261 * @param array $data An array whose keys are field names in the table
77262 *   {@link table_name}, and whose values are what matched rows are to be
77263 *   updated to.
77264 * @param array $condition An array whose keys are field names in the
77265 *   table {@link table_name}, and whose values are the conditions that a
77266 *   row must meet to be updated.
77267 * @param int $options Any number of PGSQL_CONV_FORCE_NULL,
77268 *   PGSQL_DML_NO_CONV, PGSQL_DML_ESCAPE, PGSQL_DML_EXEC, PGSQL_DML_ASYNC
77269 *   or PGSQL_DML_STRING combined. If PGSQL_DML_STRING is part of the
77270 *   {@link options} then query string is returned. When
77271 *   PGSQL_DML_NO_CONV or PGSQL_DML_ESCAPE is set, it does not call
77272 *   {@link pg_convert} internally.
77273 * @return mixed Returns string if PGSQL_DML_STRING is passed via
77274 *   {@link options}.
77275 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
77276 **/
77277function pg_update($connection, $table_name, $data, $condition, $options){}
77278
77279/**
77280 * Returns an array with client, protocol and server version (when
77281 * available)
77282 *
77283 * {@link pg_version} returns an array with the client, protocol and
77284 * server version. Protocol and server versions are only available if PHP
77285 * was compiled with PostgreSQL 7.4 or later.
77286 *
77287 * For more detailed server information, use {@link pg_parameter_status}.
77288 *
77289 * @param resource $connection PostgreSQL database connection resource.
77290 *   When {@link connection} is not present, the default connection is
77291 *   used. The default connection is the last connection made by {@link
77292 *   pg_connect} or {@link pg_pconnect}.
77293 * @return array Returns an array with client, protocol and server keys
77294 *   and values (if available). Returns FALSE on error or invalid
77295 *   connection.
77296 * @since PHP 5, PHP 7
77297 **/
77298function pg_version($connection){}
77299
77300/**
77301 * Prints out the credits for PHP
77302 *
77303 * This function prints out the credits listing the PHP developers,
77304 * modules, etc. It generates the appropriate HTML codes to insert the
77305 * information in a page.
77306 *
77307 * @param int $flag To generate a custom credits page, you may want to
77308 *   use the {@link flag} parameter.
77309 *
77310 *   Pre-defined {@link phpcredits} flags name description CREDITS_ALL
77311 *   All the credits, equivalent to using: CREDITS_DOCS + CREDITS_GENERAL
77312 *   + CREDITS_GROUP + CREDITS_MODULES + CREDITS_FULLPAGE. It generates a
77313 *   complete stand-alone HTML page with the appropriate tags.
77314 *   CREDITS_DOCS The credits for the documentation team CREDITS_FULLPAGE
77315 *   Usually used in combination with the other flags. Indicates that a
77316 *   complete stand-alone HTML page needs to be printed including the
77317 *   information indicated by the other flags. CREDITS_GENERAL General
77318 *   credits: Language design and concept, PHP authors and SAPI module.
77319 *   CREDITS_GROUP A list of the core developers CREDITS_MODULES A list
77320 *   of the extension modules for PHP, and their authors CREDITS_SAPI A
77321 *   list of the server API modules for PHP, and their authors
77322 * @return bool
77323 * @since PHP 4, PHP 5, PHP 7
77324 **/
77325function phpcredits($flag){}
77326
77327/**
77328 * Inserts a breakpoint at a line in a file
77329 *
77330 * Insert a breakpoint at the given {@link line} in the given {@link
77331 * file}.
77332 *
77333 * @param string $file The name of the file.
77334 * @param int $line The line number.
77335 * @return void
77336 * @since PHP 5 >= 5.6.3, PHP 7
77337 **/
77338function phpdbg_break_file($file, $line){}
77339
77340/**
77341 * Inserts a breakpoint at entry to a function
77342 *
77343 * Insert a breakpoint at the entry to the given {@link function}.
77344 *
77345 * @param string $function The name of the function.
77346 * @return void
77347 * @since PHP 5 >= 5.6.3, PHP 7
77348 **/
77349function phpdbg_break_function($function){}
77350
77351/**
77352 * Inserts a breakpoint at entry to a method
77353 *
77354 * Insert a breakpoint at the entry to the given {@link method} of the
77355 * given {@link class}.
77356 *
77357 * @param string $class The name of the class.
77358 * @param string $method The name of the method.
77359 * @return void
77360 * @since PHP 5 >= 5.6.3, PHP 7
77361 **/
77362function phpdbg_break_method($class, $method){}
77363
77364/**
77365 * Inserts a breakpoint at the next opcode
77366 *
77367 * Insert a breakpoint at the next opcode.
77368 *
77369 * @return void
77370 * @since PHP 5 >= 5.6.3, PHP 7
77371 **/
77372function phpdbg_break_next(){}
77373
77374/**
77375 * Clears all breakpoints
77376 *
77377 * Clear all breakpoints that have been set, either via one of the {@link
77378 * phpdbg_break_*} functions or interactively in the console.
77379 *
77380 * @return void
77381 * @since PHP 5 >= 5.6.0, PHP 7
77382 **/
77383function phpdbg_clear(){}
77384
77385/**
77386 * Sets the color of certain elements
77387 *
77388 * Set the {@link color} of the given {@link element}.
77389 *
77390 * @param int $element One of the PHPDBG_COLOR_* constants.
77391 * @param string $color The name of the color. One of white, red,
77392 *   green, yellow, blue, purple, cyan or black, optionally with either a
77393 *   trailing -bold or -underline, for instance, white-bold or
77394 *   green-underline.
77395 * @return void
77396 * @since PHP 5 >= 5.6.0, PHP 7
77397 **/
77398function phpdbg_color($element, $color){}
77399
77400/**
77401 * @param array $options
77402 * @return array
77403 * @since PHP 7
77404 **/
77405function phpdbg_end_oplog($options){}
77406
77407/**
77408 * Attempts to set the execution context
77409 *
77410 * @param string $context
77411 * @return mixed If the execution context was set previously it is
77412 *   returned. If the execution context was not set previously TRUE is
77413 *   returned. If the request to set the context fails, FALSE is
77414 *   returned, and an E_WARNING raised.
77415 * @since PHP 5 >= 5.6.0, PHP 7
77416 **/
77417function phpdbg_exec($context){}
77418
77419/**
77420 * @param array $options
77421 * @return array
77422 * @since PHP 7
77423 **/
77424function phpdbg_get_executable($options){}
77425
77426/**
77427 * Sets the command prompt
77428 *
77429 * Set the command prompt to the given {@link string}.
77430 *
77431 * @param string $string The string to use as command prompt.
77432 * @return void
77433 * @since PHP 5 >= 5.6.0, PHP 7
77434 **/
77435function phpdbg_prompt($string){}
77436
77437/**
77438 * @return void
77439 * @since PHP 7
77440 **/
77441function phpdbg_start_oplog(){}
77442
77443/**
77444 * Outputs information about PHP's configuration
77445 *
77446 * Outputs a large amount of information about the current state of PHP.
77447 * This includes information about PHP compilation options and
77448 * extensions, the PHP version, server information and environment (if
77449 * compiled as a module), the PHP environment, OS version information,
77450 * paths, master and local values of configuration options, HTTP headers,
77451 * and the PHP License.
77452 *
77453 * Because every system is setup differently, {@link phpinfo} is commonly
77454 * used to check configuration settings and for available predefined
77455 * variables on a given system.
77456 *
77457 * {@link phpinfo} is also a valuable debugging tool as it contains all
77458 * EGPCS (Environment, GET, POST, Cookie, Server) data.
77459 *
77460 * @param int $what The output may be customized by passing one or more
77461 *   of the following constants bitwise values summed together in the
77462 *   optional {@link what} parameter. One can also combine the respective
77463 *   constants or bitwise values together with the bitwise or operator.
77464 *
77465 *   {@link phpinfo} options Name (constant) Value Description
77466 *   INFO_GENERAL 1 The configuration line, location, build date, Web
77467 *   Server, System and more. INFO_CREDITS 2 PHP Credits. See also {@link
77468 *   phpcredits}. INFO_CONFIGURATION 4 Current Local and Master values
77469 *   for PHP directives. See also {@link ini_get}. INFO_MODULES 8 Loaded
77470 *   modules and their respective settings. See also {@link
77471 *   get_loaded_extensions}. INFO_ENVIRONMENT 16 Environment Variable
77472 *   information that's also available in $_ENV. INFO_VARIABLES 32 Shows
77473 *   all predefined variables from EGPCS (Environment, GET, POST, Cookie,
77474 *   Server). INFO_LICENSE 64 PHP License information. See also the
77475 *   license FAQ. INFO_ALL -1 Shows all of the above.
77476 * @return bool
77477 * @since PHP 4, PHP 5, PHP 7
77478 **/
77479function phpinfo($what){}
77480
77481/**
77482 * Gets the current PHP version
77483 *
77484 * Returns a string containing the version of the currently running PHP
77485 * parser or extension.
77486 *
77487 * @param string $extension An optional extension name.
77488 * @return string If the optional {@link extension} parameter is
77489 *   specified, {@link phpversion} returns the version of that extension,
77490 *   or FALSE if there is no version information associated or the
77491 *   extension isn't enabled.
77492 * @since PHP 4, PHP 5, PHP 7
77493 **/
77494function phpversion($extension){}
77495
77496/**
77497 * Check the PHP syntax of (and execute) the specified file
77498 *
77499 * Performs a syntax (lint) check on the specified {@link filename}
77500 * testing for scripting errors.
77501 *
77502 * This is similar to using php -l from the commandline except that this
77503 * function will execute (but not output) the checked {@link filename}.
77504 *
77505 * For example, if a function is defined in {@link filename}, this
77506 * defined function will be available to the file that executed {@link
77507 * php_check_syntax}, but output from {@link filename} will be
77508 * suppressed.
77509 *
77510 * @param string $filename The name of the file being checked.
77511 * @param string $error_message If the {@link error_message} parameter
77512 *   is used, it will contain the error message generated by the syntax
77513 *   check. {@link error_message} is passed by reference.
77514 * @return bool Returns TRUE if the lint check passed, and FALSE if the
77515 *   link check failed or if {@link filename} cannot be opened.
77516 * @since PHP 5 < 5.0.5
77517 **/
77518function php_check_syntax($filename, &$error_message){}
77519
77520/**
77521 * Retrieve a path to the loaded php.ini file
77522 *
77523 * Check if a file is loaded, and retrieve its path.
77524 *
77525 * @return string The loaded path, or FALSE if one is not loaded.
77526 * @since PHP 5 >= 5.2.4, PHP 7
77527 **/
77528function php_ini_loaded_file(){}
77529
77530/**
77531 * Return a list of .ini files parsed from the additional ini dir
77532 *
77533 * {@link php_ini_scanned_files} returns a comma-separated list of
77534 * configuration files parsed after . The directories searched are set by
77535 * a compile time option and, optionally, by an environment variable at
77536 * run time: more information can be found in the installation guide.
77537 *
77538 * The returned configuration files include the full path.
77539 *
77540 * @return string Returns a comma-separated string of .ini files on
77541 *   success. Each comma is followed by a newline. If the configure
77542 *   directive --with-config-file-scan-dir wasn't set and the
77543 *   PHP_INI_SCAN_DIR environment variable isn't set, FALSE is returned.
77544 *   If it was set and the directory was empty, an empty string is
77545 *   returned. If a file is unrecognizable, the file will still make it
77546 *   into the returned string but a PHP error will also result. This PHP
77547 *   error will be seen both at compile time and while using {@link
77548 *   php_ini_scanned_files}.
77549 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
77550 **/
77551function php_ini_scanned_files(){}
77552
77553/**
77554 * Gets the logo guid
77555 *
77556 * This function returns the ID which can be used to display the PHP logo
77557 * using the built-in image. Logo is displayed only if expose_php is On.
77558 *
77559 * @return string Returns PHPE9568F34-D428-11d2-A769-00AA001ACF42.
77560 * @since PHP 4, PHP 5 < 5.5.0
77561 **/
77562function php_logo_guid(){}
77563
77564/**
77565 * Returns the type of interface between web server and PHP
77566 *
77567 * @return string Returns the interface type, as a lowercase string.
77568 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
77569 **/
77570function php_sapi_name(){}
77571
77572/**
77573 * Return source with stripped comments and whitespace
77574 *
77575 * Returns the PHP source code in {@link filename} with PHP comments and
77576 * whitespace removed. This may be useful for determining the amount of
77577 * actual code in your scripts compared with the amount of comments. This
77578 * is similar to using php -w from the commandline.
77579 *
77580 * @param string $filename Path to the PHP file.
77581 * @return string The stripped source code will be returned on success,
77582 *   or an empty string on failure.
77583 * @since PHP 5, PHP 7
77584 **/
77585function php_strip_whitespace($filename){}
77586
77587/**
77588 * Returns information about the operating system PHP is running on
77589 *
77590 * {@link php_uname} returns a description of the operating system PHP is
77591 * running on. This is the same string you see at the very top of the
77592 * {@link phpinfo} output. For the name of just the operating system,
77593 * consider using the PHP_OS constant, but keep in mind this constant
77594 * will contain the operating system PHP was built on.
77595 *
77596 * On some older UNIX platforms, it may not be able to determine the
77597 * current OS information in which case it will revert to displaying the
77598 * OS PHP was built on. This will only happen if your uname() library
77599 * call either doesn't exist or doesn't work.
77600 *
77601 * @param string $mode {@link mode} is a single character that defines
77602 *   what information is returned: 'a': This is the default. Contains all
77603 *   modes in the sequence "s n r v m". 's': Operating system name. eg.
77604 *   FreeBSD. 'n': Host name. eg. localhost.example.com. 'r': Release
77605 *   name. eg. 5.1.2-RELEASE. 'v': Version information. Varies a lot
77606 *   between operating systems. 'm': Machine type. eg. i386.
77607 * @return string Returns the description, as a string.
77608 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
77609 **/
77610function php_uname($mode){}
77611
77612/**
77613 * Get value of pi
77614 *
77615 * @return float The value of pi as float.
77616 * @since PHP 4, PHP 5, PHP 7
77617 **/
77618function pi(){}
77619
77620/**
77621 * Convert PNG image file to WBMP image file
77622 *
77623 * Converts a PNG file into a WBMP file.
77624 *
77625 * @param string $pngname Path to PNG file.
77626 * @param string $wbmpname Path to destination WBMP file.
77627 * @param int $dest_height Destination image height.
77628 * @param int $dest_width Destination image width.
77629 * @param int $threshold Threshold value, between 0 and 8 (inclusive).
77630 * @return bool
77631 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
77632 **/
77633function png2wbmp($pngname, $wbmpname, $dest_height, $dest_width, $threshold){}
77634
77635/**
77636 * Opens process file pointer
77637 *
77638 * Opens a pipe to a process executed by forking the command given by
77639 * {@link command}.
77640 *
77641 * @param string $command The command
77642 * @param string $mode The mode
77643 * @return resource Returns a file pointer identical to that returned
77644 *   by {@link fopen}, except that it is unidirectional (may only be used
77645 *   for reading or writing) and must be closed with {@link pclose}. This
77646 *   pointer may be used with {@link fgets}, {@link fgetss}, and {@link
77647 *   fwrite}. When the mode is 'r', the returned file pointer equals to
77648 *   the STDOUT of the command, when the mode is 'w', the returned file
77649 *   pointer equals to the STDIN of the command.
77650 * @since PHP 4, PHP 5, PHP 7
77651 **/
77652function popen($command, $mode){}
77653
77654/**
77655 * Return the pos element in an array
77656 *
77657 * Every array has an internal pointer to its "pos" element, which is
77658 * initialized to the first element inserted into the array.
77659 *
77660 * @param array $array The array.
77661 * @return mixed The {@link current} function simply returns the value
77662 *   of the array element that's currently being pointed to by the
77663 *   internal pointer. It does not move the pointer in any way. If the
77664 *   internal pointer points beyond the end of the elements list or the
77665 *   array is empty, {@link current} returns FALSE.
77666 * @since PHP 4, PHP 5, PHP 7
77667 **/
77668function pos($array){}
77669
77670/**
77671 * Determine accessibility of a file
77672 *
77673 * {@link posix_access} checks the user's permission of a file.
77674 *
77675 * @param string $file The name of the file to be tested.
77676 * @param int $mode A mask consisting of one or more of POSIX_F_OK,
77677 *   POSIX_R_OK, POSIX_W_OK and POSIX_X_OK. POSIX_R_OK, POSIX_W_OK and
77678 *   POSIX_X_OK request checking whether the file exists and has read,
77679 *   write and execute permissions, respectively. POSIX_F_OK just
77680 *   requests checking for the existence of the file.
77681 * @return bool
77682 * @since PHP 5 >= 5.1.0, PHP 7
77683 **/
77684function posix_access($file, $mode){}
77685
77686/**
77687 * Get path name of controlling terminal
77688 *
77689 * Generates a string which is the pathname for the current controlling
77690 * terminal for the process. On error this will set errno, which can be
77691 * checked using {@link posix_get_last_error}
77692 *
77693 * @return string Upon successful completion, returns string of the
77694 *   pathname to the current controlling terminal. Otherwise FALSE is
77695 *   returned and errno is set, which can be checked with {@link
77696 *   posix_get_last_error}.
77697 * @since PHP 4, PHP 5, PHP 7
77698 **/
77699function posix_ctermid(){}
77700
77701/**
77702 * Retrieve the error number set by the last posix function that failed
77703 *
77704 * Retrieve the error number set by the last posix function that failed.
77705 * The system error message associated with the errno may be checked with
77706 * {@link posix_strerror}.
77707 *
77708 * @return int Returns the errno (error number) set by the last posix
77709 *   function that failed. If no errors exist, 0 is returned.
77710 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
77711 **/
77712function posix_errno(){}
77713
77714/**
77715 * Pathname of current directory
77716 *
77717 * Gets the absolute pathname of the script's current working directory.
77718 * On error, it sets errno which can be checked using {@link
77719 * posix_get_last_error}
77720 *
77721 * @return string Returns a string of the absolute pathname on success.
77722 *   On error, returns FALSE and sets errno which can be checked with
77723 *   {@link posix_get_last_error}.
77724 * @since PHP 4, PHP 5, PHP 7
77725 **/
77726function posix_getcwd(){}
77727
77728/**
77729 * Return the effective group ID of the current process
77730 *
77731 * Return the numeric effective group ID of the current process.
77732 *
77733 * @return int Returns an integer of the effective group ID.
77734 * @since PHP 4, PHP 5, PHP 7
77735 **/
77736function posix_getegid(){}
77737
77738/**
77739 * Return the effective user ID of the current process
77740 *
77741 * Return the numeric effective user ID of the current process. See also
77742 * {@link posix_getpwuid} for information on how to convert this into a
77743 * useable username.
77744 *
77745 * @return int Returns the user id, as an integer
77746 * @since PHP 4, PHP 5, PHP 7
77747 **/
77748function posix_geteuid(){}
77749
77750/**
77751 * Return the real group ID of the current process
77752 *
77753 * Return the numeric real group ID of the current process.
77754 *
77755 * @return int Returns the real group id, as an integer.
77756 * @since PHP 4, PHP 5, PHP 7
77757 **/
77758function posix_getgid(){}
77759
77760/**
77761 * Return info about a group by group id
77762 *
77763 * Gets information about a group provided its id.
77764 *
77765 * @param int $gid The group id.
77766 * @return array The array elements returned are: The group information
77767 *   array Element Description name The name element contains the name of
77768 *   the group. This is a short, usually less than 16 character "handle"
77769 *   of the group, not the real, full name. passwd The passwd element
77770 *   contains the group's password in an encrypted format. Often, for
77771 *   example on a system employing "shadow" passwords, an asterisk is
77772 *   returned instead. gid Group ID, should be the same as the {@link
77773 *   gid} parameter used when calling the function, and hence redundant.
77774 *   members This consists of an array of string's for all the members in
77775 *   the group.
77776 * @since PHP 4, PHP 5, PHP 7
77777 **/
77778function posix_getgrgid($gid){}
77779
77780/**
77781 * Return info about a group by name
77782 *
77783 * Gets information about a group provided its name.
77784 *
77785 * @param string $name The name of the group
77786 * @return array Returns an array on success, . The array elements
77787 *   returned are: The group information array Element Description name
77788 *   The name element contains the name of the group. This is a short,
77789 *   usually less than 16 character "handle" of the group, not the real,
77790 *   full name. This should be the same as the {@link name} parameter
77791 *   used when calling the function, and hence redundant. passwd The
77792 *   passwd element contains the group's password in an encrypted format.
77793 *   Often, for example on a system employing "shadow" passwords, an
77794 *   asterisk is returned instead. gid Group ID of the group in numeric
77795 *   form. members This consists of an array of string's for all the
77796 *   members in the group.
77797 * @since PHP 4, PHP 5, PHP 7
77798 **/
77799function posix_getgrnam($name){}
77800
77801/**
77802 * Return the group set of the current process
77803 *
77804 * Gets the group set of the current process.
77805 *
77806 * @return array Returns an array of integers containing the numeric
77807 *   group ids of the group set of the current process.
77808 * @since PHP 4, PHP 5, PHP 7
77809 **/
77810function posix_getgroups(){}
77811
77812/**
77813 * Return login name
77814 *
77815 * Returns the login name of the user owning the current process.
77816 *
77817 * @return string Returns the login name of the user, as a string.
77818 * @since PHP 4, PHP 5, PHP 7
77819 **/
77820function posix_getlogin(){}
77821
77822/**
77823 * Get process group id for job control
77824 *
77825 * Returns the process group identifier of the process {@link pid}.
77826 *
77827 * @param int $pid The process id.
77828 * @return int Returns the identifier, as an integer.
77829 * @since PHP 4, PHP 5, PHP 7
77830 **/
77831function posix_getpgid($pid){}
77832
77833/**
77834 * Return the current process group identifier
77835 *
77836 * Return the process group identifier of the current process.
77837 *
77838 * @return int Returns the identifier, as an integer.
77839 * @since PHP 4, PHP 5, PHP 7
77840 **/
77841function posix_getpgrp(){}
77842
77843/**
77844 * Return the current process identifier
77845 *
77846 * Return the process identifier of the current process.
77847 *
77848 * @return int Returns the identifier, as an integer.
77849 * @since PHP 4, PHP 5, PHP 7
77850 **/
77851function posix_getpid(){}
77852
77853/**
77854 * Return the parent process identifier
77855 *
77856 * Return the process identifier of the parent process of the current
77857 * process.
77858 *
77859 * @return int Returns the identifier, as an integer.
77860 * @since PHP 4, PHP 5, PHP 7
77861 **/
77862function posix_getppid(){}
77863
77864/**
77865 * Return info about a user by username
77866 *
77867 * Returns an array of information about the given user.
77868 *
77869 * @param string $username An alphanumeric username.
77870 * @return array On success an array with the following elements is
77871 *   returned, else FALSE is returned: The user information array Element
77872 *   Description name The name element contains the username of the user.
77873 *   This is a short, usually less than 16 character "handle" of the
77874 *   user, not the real, full name. This should be the same as the {@link
77875 *   username} parameter used when calling the function, and hence
77876 *   redundant. passwd The passwd element contains the user's password in
77877 *   an encrypted format. Often, for example on a system employing
77878 *   "shadow" passwords, an asterisk is returned instead. uid User ID of
77879 *   the user in numeric form. gid The group ID of the user. Use the
77880 *   function {@link posix_getgrgid} to resolve the group name and a list
77881 *   of its members. gecos GECOS is an obsolete term that refers to the
77882 *   finger information field on a Honeywell batch processing system. The
77883 *   field, however, lives on, and its contents have been formalized by
77884 *   POSIX. The field contains a comma separated list containing the
77885 *   user's full name, office phone, office number, and home phone
77886 *   number. On most systems, only the user's full name is available. dir
77887 *   This element contains the absolute path to the home directory of the
77888 *   user. shell The shell element contains the absolute path to the
77889 *   executable of the user's default shell.
77890 * @since PHP 4, PHP 5, PHP 7
77891 **/
77892function posix_getpwnam($username){}
77893
77894/**
77895 * Return info about a user by user id
77896 *
77897 * Returns an array of information about the user referenced by the given
77898 * user ID.
77899 *
77900 * @param int $uid The user identifier.
77901 * @return array Returns an associative array with the following
77902 *   elements: The user information array Element Description name The
77903 *   name element contains the username of the user. This is a short,
77904 *   usually less than 16 character "handle" of the user, not the real,
77905 *   full name. passwd The passwd element contains the user's password in
77906 *   an encrypted format. Often, for example on a system employing
77907 *   "shadow" passwords, an asterisk is returned instead. uid User ID,
77908 *   should be the same as the {@link uid} parameter used when calling
77909 *   the function, and hence redundant. gid The group ID of the user. Use
77910 *   the function {@link posix_getgrgid} to resolve the group name and a
77911 *   list of its members. gecos GECOS is an obsolete term that refers to
77912 *   the finger information field on a Honeywell batch processing system.
77913 *   The field, however, lives on, and its contents have been formalized
77914 *   by POSIX. The field contains a comma separated list containing the
77915 *   user's full name, office phone, office number, and home phone
77916 *   number. On most systems, only the user's full name is available. dir
77917 *   This element contains the absolute path to the home directory of the
77918 *   user. shell The shell element contains the absolute path to the
77919 *   executable of the user's default shell.
77920 * @since PHP 4, PHP 5, PHP 7
77921 **/
77922function posix_getpwuid($uid){}
77923
77924/**
77925 * Return info about system resource limits
77926 *
77927 * {@link posix_getrlimit} returns an array of information about the
77928 * current resource's soft and hard limits.
77929 *
77930 * @return array Returns an associative array of elements for each
77931 *   limit that is defined. Each limit has a soft and a hard limit. List
77932 *   of possible limits returned Limit name Limit description core The
77933 *   maximum size of the core file. When 0, not core files are created.
77934 *   When core files are larger than this size, they will be truncated at
77935 *   this size. totalmem The maximum size of the memory of the process,
77936 *   in bytes. virtualmem The maximum size of the virtual memory for the
77937 *   process, in bytes. data The maximum size of the data segment for the
77938 *   process, in bytes. stack The maximum size of the process stack, in
77939 *   bytes. rss The maximum number of virtual pages resident in RAM
77940 *   maxproc The maximum number of processes that can be created for the
77941 *   real user ID of the calling process. memlock The maximum number of
77942 *   bytes of memory that may be locked into RAM. cpu The amount of time
77943 *   the process is allowed to use the CPU. filesize The maximum size of
77944 *   the data segment for the process, in bytes. openfiles One more than
77945 *   the maximum number of open file descriptors.
77946 * @since PHP 4, PHP 5, PHP 7
77947 **/
77948function posix_getrlimit(){}
77949
77950/**
77951 * Get the current sid of the process
77952 *
77953 * Return the session id of the process {@link pid}. The session id of a
77954 * process is the process group id of the session leader.
77955 *
77956 * @param int $pid The process identifier. If set to 0, the current
77957 *   process is assumed. If an invalid {@link pid} is specified, then
77958 *   FALSE is returned and an error is set which can be checked with
77959 *   {@link posix_get_last_error}.
77960 * @return int Returns the identifier, as an integer.
77961 * @since PHP 4, PHP 5, PHP 7
77962 **/
77963function posix_getsid($pid){}
77964
77965/**
77966 * Return the real user ID of the current process
77967 *
77968 * Return the numeric real user ID of the current process.
77969 *
77970 * @return int Returns the user id, as an integer
77971 * @since PHP 4, PHP 5, PHP 7
77972 **/
77973function posix_getuid(){}
77974
77975/**
77976 * Retrieve the error number set by the last posix function that failed
77977 *
77978 * Retrieve the error number set by the last posix function that failed.
77979 * The system error message associated with the errno may be checked with
77980 * {@link posix_strerror}.
77981 *
77982 * @return int Returns the errno (error number) set by the last posix
77983 *   function that failed. If no errors exist, 0 is returned.
77984 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
77985 **/
77986function posix_get_last_error(){}
77987
77988/**
77989 * Calculate the group access list
77990 *
77991 * Calculates the group access list for the user specified in name.
77992 *
77993 * @param string $name The user to calculate the list for.
77994 * @param int $base_group_id Typically the group number from the
77995 *   password file.
77996 * @return bool
77997 * @since PHP 5 >= 5.2.0, PHP 7
77998 **/
77999function posix_initgroups($name, $base_group_id){}
78000
78001/**
78002 * Determine if a file descriptor is an interactive terminal
78003 *
78004 * Determines if the file descriptor {@link fd} refers to a valid
78005 * terminal type device.
78006 *
78007 * @param mixed $fd
78008 * @return bool Returns TRUE if {@link fd} is an open descriptor
78009 *   connected to a terminal and FALSE otherwise.
78010 * @since PHP 4, PHP 5, PHP 7
78011 **/
78012function posix_isatty($fd){}
78013
78014/**
78015 * Send a signal to a process
78016 *
78017 * Send the signal {@link sig} to the process with the process identifier
78018 * {@link pid}.
78019 *
78020 * @param int $pid The process identifier.
78021 * @param int $sig One of the PCNTL signals constants.
78022 * @return bool
78023 * @since PHP 4, PHP 5, PHP 7
78024 **/
78025function posix_kill($pid, $sig){}
78026
78027/**
78028 * Create a fifo special file (a named pipe)
78029 *
78030 * {@link posix_mkfifo} creates a special FIFO file which exists in the
78031 * file system and acts as a bidirectional communication endpoint for
78032 * processes.
78033 *
78034 * @param string $pathname Path to the FIFO file.
78035 * @param int $mode The second parameter {@link mode} has to be given
78036 *   in octal notation (e.g. 0644). The permission of the newly created
78037 *   FIFO also depends on the setting of the current {@link umask}. The
78038 *   permissions of the created file are (mode & ~umask).
78039 * @return bool
78040 * @since PHP 4, PHP 5, PHP 7
78041 **/
78042function posix_mkfifo($pathname, $mode){}
78043
78044/**
78045 * Create a special or ordinary file (POSIX.1)
78046 *
78047 * Creates a special or ordinary file.
78048 *
78049 * @param string $pathname The file to create
78050 * @param int $mode This parameter is constructed by a bitwise OR
78051 *   between file type (one of the following constants: POSIX_S_IFREG,
78052 *   POSIX_S_IFCHR, POSIX_S_IFBLK, POSIX_S_IFIFO or POSIX_S_IFSOCK) and
78053 *   permissions.
78054 * @param int $major The major device kernel identifier (required to
78055 *   pass when using S_IFCHR or S_IFBLK).
78056 * @param int $minor The minor device kernel identifier.
78057 * @return bool
78058 * @since PHP 5 >= 5.1.0, PHP 7
78059 **/
78060function posix_mknod($pathname, $mode, $major, $minor){}
78061
78062/**
78063 * Set the effective GID of the current process
78064 *
78065 * Set the effective group ID of the current process. This is a
78066 * privileged function and needs appropriate privileges (usually root) on
78067 * the system to be able to perform this function.
78068 *
78069 * @param int $gid The group id.
78070 * @return bool
78071 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
78072 **/
78073function posix_setegid($gid){}
78074
78075/**
78076 * Set the effective UID of the current process
78077 *
78078 * Set the effective user ID of the current process. This is a privileged
78079 * function and needs appropriate privileges (usually root) on the system
78080 * to be able to perform this function.
78081 *
78082 * @param int $uid The user id.
78083 * @return bool
78084 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
78085 **/
78086function posix_seteuid($uid){}
78087
78088/**
78089 * Set the GID of the current process
78090 *
78091 * Set the real group ID of the current process. This is a privileged
78092 * function and needs appropriate privileges (usually root) on the system
78093 * to be able to perform this function. The appropriate order of function
78094 * calls is {@link posix_setgid} first, {@link posix_setuid} last.
78095 *
78096 * @param int $gid The group id.
78097 * @return bool
78098 * @since PHP 4, PHP 5, PHP 7
78099 **/
78100function posix_setgid($gid){}
78101
78102/**
78103 * Set process group id for job control
78104 *
78105 * Let the process {@link pid} join the process group {@link pgid}.
78106 *
78107 * @param int $pid The process id.
78108 * @param int $pgid The process group id.
78109 * @return bool
78110 * @since PHP 4, PHP 5, PHP 7
78111 **/
78112function posix_setpgid($pid, $pgid){}
78113
78114/**
78115 * Set system resource limits
78116 *
78117 * {@link posix_setrlimit} sets the soft and hard limits for a given
78118 * system resource.
78119 *
78120 * @param int $resource The resource limit constant corresponding to
78121 *   the limit that is being set.
78122 * @param int $softlimit The soft limit, in whatever unit the resource
78123 *   limit requires, or POSIX_RLIMIT_INFINITY.
78124 * @param int $hardlimit The hard limit, in whatever unit the resource
78125 *   limit requires, or POSIX_RLIMIT_INFINITY.
78126 * @return bool
78127 * @since PHP 7
78128 **/
78129function posix_setrlimit($resource, $softlimit, $hardlimit){}
78130
78131/**
78132 * Make the current process a session leader
78133 *
78134 * @return int Returns the session id, or -1 on errors.
78135 * @since PHP 4, PHP 5, PHP 7
78136 **/
78137function posix_setsid(){}
78138
78139/**
78140 * Set the UID of the current process
78141 *
78142 * Set the real user ID of the current process. This is a privileged
78143 * function that needs appropriate privileges (usually root) on the
78144 * system to be able to perform this function.
78145 *
78146 * @param int $uid The user id.
78147 * @return bool
78148 * @since PHP 4, PHP 5, PHP 7
78149 **/
78150function posix_setuid($uid){}
78151
78152/**
78153 * Retrieve the system error message associated with the given errno
78154 *
78155 * Returns the POSIX system error message associated with the given
78156 * {@link errno}. You may get the {@link errno} parameter by calling
78157 * {@link posix_get_last_error}.
78158 *
78159 * @param int $errno A POSIX error number, returned by {@link
78160 *   posix_get_last_error}. If set to 0, then the string "Success" is
78161 *   returned.
78162 * @return string Returns the error message, as a string.
78163 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
78164 **/
78165function posix_strerror($errno){}
78166
78167/**
78168 * Get process times
78169 *
78170 * Gets information about the current CPU usage.
78171 *
78172 * @return array Returns a hash of strings with information about the
78173 *   current process CPU usage. The indices of the hash are: ticks - the
78174 *   number of clock ticks that have elapsed since reboot. utime - user
78175 *   time used by the current process. stime - system time used by the
78176 *   current process. cutime - user time used by current process and
78177 *   children. cstime - system time used by current process and children.
78178 * @since PHP 4, PHP 5, PHP 7
78179 **/
78180function posix_times(){}
78181
78182/**
78183 * Determine terminal device name
78184 *
78185 * Returns a string for the absolute path to the current terminal device
78186 * that is open on the file descriptor {@link fd}.
78187 *
78188 * @param mixed $fd
78189 * @return string On success, returns a string of the absolute path of
78190 *   the {@link fd}. On failure, returns FALSE
78191 * @since PHP 4, PHP 5, PHP 7
78192 **/
78193function posix_ttyname($fd){}
78194
78195/**
78196 * Get system name
78197 *
78198 * Gets information about the system.
78199 *
78200 * Posix requires that assumptions must not be made about the format of
78201 * the values, e.g. the assumption that a release may contain three
78202 * digits or anything else returned by this function.
78203 *
78204 * @return array Returns a hash of strings with information about the
78205 *   system. The indices of the hash are sysname - operating system name
78206 *   (e.g. Linux) nodename - system name (e.g. valiant) release -
78207 *   operating system release (e.g. 2.2.10) version - operating system
78208 *   version (e.g. #4 Tue Jul 20 17:01:36 MEST 1999) machine - system
78209 *   architecture (e.g. i586) domainname - DNS domainname (e.g.
78210 *   example.com)
78211 * @since PHP 4, PHP 5, PHP 7
78212 **/
78213function posix_uname(){}
78214
78215/**
78216 * Exponential expression
78217 *
78218 * Returns {@link base} raised to the power of {@link exp}.
78219 *
78220 * @param number $base The base to use
78221 * @param number $exp The exponent
78222 * @return number {@link base} raised to the power of {@link exp}. If
78223 *   both arguments are non-negative integers and the result can be
78224 *   represented as an integer, the result will be returned with integer
78225 *   type, otherwise it will be returned as a float.
78226 * @since PHP 4, PHP 5, PHP 7
78227 **/
78228function pow($base, $exp){}
78229
78230/**
78231 * Perform a regular expression search and replace
78232 *
78233 * {@link preg_filter} is identical to {@link preg_replace} except it
78234 * only returns the (possibly transformed) subjects where there was a
78235 * match. For details about how this function works, read the {@link
78236 * preg_replace} documentation.
78237 *
78238 * @param mixed $pattern
78239 * @param mixed $replacement
78240 * @param mixed $subject
78241 * @param int $limit
78242 * @param int $count
78243 * @return mixed Returns an array if the {@link subject} parameter is
78244 *   an array, or a string otherwise.
78245 * @since PHP 5 >= 5.3.0, PHP 7
78246 **/
78247function preg_filter($pattern, $replacement, $subject, $limit, &$count){}
78248
78249/**
78250 * Return array entries that match the pattern
78251 *
78252 * Returns the array consisting of the elements of the {@link input}
78253 * array that match the given {@link pattern}.
78254 *
78255 * @param string $pattern The pattern to search for, as a string.
78256 * @param array $input The input array.
78257 * @param int $flags If set to PREG_GREP_INVERT, this function returns
78258 *   the elements of the input array that do not match the given {@link
78259 *   pattern}.
78260 * @return array Returns an array indexed using the keys from the
78261 *   {@link input} array.
78262 * @since PHP 4, PHP 5, PHP 7
78263 **/
78264function preg_grep($pattern, $input, $flags){}
78265
78266/**
78267 * Returns the error code of the last PCRE regex execution
78268 *
78269 * {@link preg_last_error} example
78270 *
78271 * <?php
78272 *
78273 * preg_match('/(?:\D+|<\d+>)*[!?]/', 'foobar foobar foobar');
78274 *
78275 * if (preg_last_error() == PREG_BACKTRACK_LIMIT_ERROR) { print
78276 * 'Backtrack limit was exhausted!'; }
78277 *
78278 * ?>
78279 *
78280 * Backtrack limit was exhausted!
78281 *
78282 * @return int Returns one of the following constants (explained on
78283 *   their own page): PREG_NO_ERROR PREG_INTERNAL_ERROR
78284 *   PREG_BACKTRACK_LIMIT_ERROR (see also pcre.backtrack_limit)
78285 *   PREG_RECURSION_LIMIT_ERROR (see also pcre.recursion_limit)
78286 *   PREG_BAD_UTF8_ERROR PREG_BAD_UTF8_OFFSET_ERROR (since PHP 5.3.0)
78287 *   PREG_JIT_STACKLIMIT_ERROR (since PHP 7.0.0)
78288 * @since PHP 5 >= 5.2.0, PHP 7
78289 **/
78290function preg_last_error(){}
78291
78292/**
78293 * Perform a regular expression match
78294 *
78295 * Searches {@link subject} for a match to the regular expression given
78296 * in {@link pattern}.
78297 *
78298 * @param string $pattern The pattern to search for, as a string.
78299 * @param string $subject The input string.
78300 * @param array $matches If {@link matches} is provided, then it is
78301 *   filled with the results of search. $matches[0] will contain the text
78302 *   that matched the full pattern, $matches[1] will have the text that
78303 *   matched the first captured parenthesized subpattern, and so on.
78304 * @param int $flags {@link flags} can be a combination of the
78305 *   following flags: PREG_OFFSET_CAPTURE If this flag is passed, for
78306 *   every occurring match the appendant string offset (in bytes) will
78307 *   also be returned. Note that this changes the value of {@link
78308 *   matches} into an array where every element is an array consisting of
78309 *   the matched string at offset 0 and its string offset into {@link
78310 *   subject} at offset 1.
78311 *
78312 *   <?php preg_match('/(foo)(bar)(baz)/', 'foobarbaz', $matches,
78313 *   PREG_OFFSET_CAPTURE); print_r($matches); ?>
78314 *
78315 *   Array ( [0] => Array ( [0] => foobarbaz [1] => 0 )
78316 *
78317 *   [1] => Array ( [0] => foo [1] => 0 )
78318 *
78319 *   [2] => Array ( [0] => bar [1] => 3 )
78320 *
78321 *   [3] => Array ( [0] => baz [1] => 6 )
78322 *
78323 *   )
78324 *
78325 *   PREG_UNMATCHED_AS_NULL If this flag is passed, unmatched subpatterns
78326 *   are reported as NULL; otherwise they are reported as an empty
78327 *   string.
78328 *
78329 *   <?php preg_match('/(a)(b)*(c)/', 'ac', $matches);
78330 *   var_dump($matches); preg_match('/(a)(b)*(c)/', 'ac', $matches,
78331 *   PREG_UNMATCHED_AS_NULL); var_dump($matches); ?>
78332 *
78333 *   array(4) { [0]=> string(2) "ac" [1]=> string(1) "a" [2]=> string(0)
78334 *   "" [3]=> string(1) "c" } array(4) { [0]=> string(2) "ac" [1]=>
78335 *   string(1) "a" [2]=> NULL [3]=> string(1) "c" }
78336 * @param int $offset If this flag is passed, for every occurring match
78337 *   the appendant string offset (in bytes) will also be returned. Note
78338 *   that this changes the value of {@link matches} into an array where
78339 *   every element is an array consisting of the matched string at offset
78340 *   0 and its string offset into {@link subject} at offset 1.
78341 *
78342 *   <?php preg_match('/(foo)(bar)(baz)/', 'foobarbaz', $matches,
78343 *   PREG_OFFSET_CAPTURE); print_r($matches); ?>
78344 *
78345 *   Array ( [0] => Array ( [0] => foobarbaz [1] => 0 )
78346 *
78347 *   [1] => Array ( [0] => foo [1] => 0 )
78348 *
78349 *   [2] => Array ( [0] => bar [1] => 3 )
78350 *
78351 *   [3] => Array ( [0] => baz [1] => 6 )
78352 *
78353 *   )
78354 * @return int {@link preg_match} returns 1 if the {@link pattern}
78355 *   matches given {@link subject}, 0 if it does not, or FALSE if an
78356 *   error occurred.
78357 * @since PHP 4, PHP 5, PHP 7
78358 **/
78359function preg_match($pattern, $subject, &$matches, $flags, $offset){}
78360
78361/**
78362 * Perform a global regular expression match
78363 *
78364 * Searches {@link subject} for all matches to the regular expression
78365 * given in {@link pattern} and puts them in {@link matches} in the order
78366 * specified by {@link flags}.
78367 *
78368 * After the first match is found, the subsequent searches are continued
78369 * on from end of the last match.
78370 *
78371 * @param string $pattern The pattern to search for, as a string.
78372 * @param string $subject The input string.
78373 * @param array $matches Array of all matches in multi-dimensional
78374 *   array ordered according to {@link flags}.
78375 * @param int $flags Can be a combination of the following flags (note
78376 *   that it doesn't make sense to use PREG_PATTERN_ORDER together with
78377 *   PREG_SET_ORDER): PREG_PATTERN_ORDER Orders results so that
78378 *   $matches[0] is an array of full pattern matches, $matches[1] is an
78379 *   array of strings matched by the first parenthesized subpattern, and
78380 *   so on.
78381 *
78382 *   <?php preg_match_all("|<[^>]+>(.*)</[^>]+>|U", "<b>example: </b><div
78383 *   align=left>this is a test</div>", $out, PREG_PATTERN_ORDER); echo
78384 *   $out[0][0] . ", " . $out[0][1] . "\n"; echo $out[1][0] . ", " .
78385 *   $out[1][1] . "\n"; ?>
78386 *
78387 *   <b>example: </b>, <div align=left>this is a test</div> example: ,
78388 *   this is a test
78389 *
78390 *   So, $out[0] contains array of strings that matched full pattern, and
78391 *   $out[1] contains array of strings enclosed by tags. If the pattern
78392 *   contains named subpatterns, $matches additionally contains entries
78393 *   for keys with the subpattern name. If the pattern contains duplicate
78394 *   named subpatterns, only the rightmost subpattern is stored in
78395 *   $matches[NAME].
78396 *
78397 *   <?php preg_match_all( '/(?J)(?<match>foo)|(?<match>bar)/', 'foo
78398 *   bar', $matches, PREG_PATTERN_ORDER ); print_r($matches['match']); ?>
78399 *
78400 *   Array ( [0] => [1] => bar )
78401 *
78402 *   PREG_SET_ORDER Orders results so that $matches[0] is an array of
78403 *   first set of matches, $matches[1] is an array of second set of
78404 *   matches, and so on.
78405 *
78406 *   <?php preg_match_all("|<[^>]+>(.*)</[^>]+>|U", "<b>example: </b><div
78407 *   align=\"left\">this is a test</div>", $out, PREG_SET_ORDER); echo
78408 *   $out[0][0] . ", " . $out[0][1] . "\n"; echo $out[1][0] . ", " .
78409 *   $out[1][1] . "\n"; ?>
78410 *
78411 *   <b>example: </b>, example: <div align="left">this is a test</div>,
78412 *   this is a test
78413 *
78414 *   PREG_OFFSET_CAPTURE If this flag is passed, for every occurring
78415 *   match the appendant string offset will also be returned. Note that
78416 *   this changes the value of {@link matches} into an array of arrays
78417 *   where every element is an array consisting of the matched string at
78418 *   offset 0 and its string offset into {@link subject} at offset 1.
78419 *
78420 *   <?php preg_match_all('/(foo)(bar)(baz)/', 'foobarbaz', $matches,
78421 *   PREG_OFFSET_CAPTURE); print_r($matches); ?>
78422 *
78423 *   Array ( [0] => Array ( [0] => Array ( [0] => foobarbaz [1] => 0 )
78424 *
78425 *   )
78426 *
78427 *   [1] => Array ( [0] => Array ( [0] => foo [1] => 0 )
78428 *
78429 *   )
78430 *
78431 *   [2] => Array ( [0] => Array ( [0] => bar [1] => 3 )
78432 *
78433 *   )
78434 *
78435 *   [3] => Array ( [0] => Array ( [0] => baz [1] => 6 )
78436 *
78437 *   )
78438 *
78439 *   )
78440 *
78441 *   PREG_UNMATCHED_AS_NULL If this flag is passed, unmatched subpatterns
78442 *   are reported as NULL; otherwise they are reported as an empty
78443 *   string. If no order flag is given, PREG_PATTERN_ORDER is assumed.
78444 * @param int $offset Orders results so that $matches[0] is an array of
78445 *   full pattern matches, $matches[1] is an array of strings matched by
78446 *   the first parenthesized subpattern, and so on.
78447 *
78448 *   <?php preg_match_all("|<[^>]+>(.*)</[^>]+>|U", "<b>example: </b><div
78449 *   align=left>this is a test</div>", $out, PREG_PATTERN_ORDER); echo
78450 *   $out[0][0] . ", " . $out[0][1] . "\n"; echo $out[1][0] . ", " .
78451 *   $out[1][1] . "\n"; ?>
78452 *
78453 *   <b>example: </b>, <div align=left>this is a test</div> example: ,
78454 *   this is a test
78455 *
78456 *   So, $out[0] contains array of strings that matched full pattern, and
78457 *   $out[1] contains array of strings enclosed by tags. If the pattern
78458 *   contains named subpatterns, $matches additionally contains entries
78459 *   for keys with the subpattern name. If the pattern contains duplicate
78460 *   named subpatterns, only the rightmost subpattern is stored in
78461 *   $matches[NAME].
78462 *
78463 *   <?php preg_match_all( '/(?J)(?<match>foo)|(?<match>bar)/', 'foo
78464 *   bar', $matches, PREG_PATTERN_ORDER ); print_r($matches['match']); ?>
78465 *
78466 *   Array ( [0] => [1] => bar )
78467 * @return int Returns the number of full pattern matches (which might
78468 *   be zero), or FALSE if an error occurred.
78469 * @since PHP 4, PHP 5, PHP 7
78470 **/
78471function preg_match_all($pattern, $subject, &$matches, $flags, $offset){}
78472
78473/**
78474 * Quote regular expression characters
78475 *
78476 * {@link preg_quote} takes {@link str} and puts a backslash in front of
78477 * every character that is part of the regular expression syntax. This is
78478 * useful if you have a run-time string that you need to match in some
78479 * text and the string may contain special regex characters.
78480 *
78481 * The special regular expression characters are: . \ + * ? [ ^ ] $ ( ) {
78482 * } = ! < > | : - #
78483 *
78484 * Note that / is not a special regular expression character.
78485 *
78486 * @param string $str The input string.
78487 * @param string $delimiter If the optional {@link delimiter} is
78488 *   specified, it will also be escaped. This is useful for escaping the
78489 *   delimiter that is required by the PCRE functions. The / is the most
78490 *   commonly used delimiter.
78491 * @return string Returns the quoted (escaped) string.
78492 * @since PHP 4, PHP 5, PHP 7
78493 **/
78494function preg_quote($str, $delimiter){}
78495
78496/**
78497 * Perform a regular expression search and replace
78498 *
78499 * Searches {@link subject} for matches to {@link pattern} and replaces
78500 * them with {@link replacement}.
78501 *
78502 * @param mixed $pattern The pattern to search for. It can be either a
78503 *   string or an array with strings. Several PCRE modifiers are also
78504 *   available.
78505 * @param mixed $replacement The string or an array with strings to
78506 *   replace. If this parameter is a string and the {@link pattern}
78507 *   parameter is an array, all patterns will be replaced by that string.
78508 *   If both {@link pattern} and {@link replacement} parameters are
78509 *   arrays, each {@link pattern} will be replaced by the {@link
78510 *   replacement} counterpart. If there are fewer elements in the {@link
78511 *   replacement} array than in the {@link pattern} array, any extra
78512 *   {@link pattern}s will be replaced by an empty string. {@link
78513 *   replacement} may contain references of the form \n or $n, with the
78514 *   latter form being the preferred one. Every such reference will be
78515 *   replaced by the text captured by the n'th parenthesized pattern. n
78516 *   can be from 0 to 99, and \0 or $0 refers to the text matched by the
78517 *   whole pattern. Opening parentheses are counted from left to right
78518 *   (starting from 1) to obtain the number of the capturing subpattern.
78519 *   Note that backslashes in literals may require to be escaped. When
78520 *   working with a replacement pattern where a backreference is
78521 *   immediately followed by another number (i.e.: placing a literal
78522 *   number immediately after a matched pattern), you cannot use the
78523 *   familiar \1 notation for your backreference. \11, for example, would
78524 *   confuse {@link preg_replace} since it does not know whether you want
78525 *   the \1 backreference followed by a literal 1, or the \11
78526 *   backreference followed by nothing. In this case the solution is to
78527 *   use ${1}1. This creates an isolated $1 backreference, leaving the 1
78528 *   as a literal. When using the deprecated e modifier, this function
78529 *   escapes some characters (namely ', ", \ and NULL) in the strings
78530 *   that replace the backreferences. This is done to ensure that no
78531 *   syntax errors arise from backreference usage with either single or
78532 *   double quotes (e.g. 'strlen(\'$1\')+strlen("$2")'). Make sure you
78533 *   are aware of PHP's string syntax to know exactly how the interpreted
78534 *   string will look.
78535 * @param mixed $subject The string or an array with strings to search
78536 *   and replace. If {@link subject} is an array, then the search and
78537 *   replace is performed on every entry of {@link subject}, and the
78538 *   return value is an array as well.
78539 * @param int $limit The maximum possible replacements for each pattern
78540 *   in each {@link subject} string. Defaults to -1 (no limit).
78541 * @param int $count If specified, this variable will be filled with
78542 *   the number of replacements done.
78543 * @return mixed {@link preg_replace} returns an array if the {@link
78544 *   subject} parameter is an array, or a string otherwise.
78545 * @since PHP 4, PHP 5, PHP 7
78546 **/
78547function preg_replace($pattern, $replacement, $subject, $limit, &$count){}
78548
78549/**
78550 * Perform a regular expression search and replace using a callback
78551 *
78552 * The behavior of this function is almost identical to {@link
78553 * preg_replace}, except for the fact that instead of {@link replacement}
78554 * parameter, one should specify a {@link callback}.
78555 *
78556 * @param mixed $pattern The pattern to search for. It can be either a
78557 *   string or an array with strings.
78558 * @param callable $callback A callback that will be called and passed
78559 *   an array of matched elements in the {@link subject} string. The
78560 *   callback should return the replacement string. This is the callback
78561 *   signature:
78562 *
78563 *   stringhandler array{@link matches} You'll often need the {@link
78564 *   callback} function for a {@link preg_replace_callback} in just one
78565 *   place. In this case you can use an anonymous function to declare the
78566 *   callback within the call to {@link preg_replace_callback}. By doing
78567 *   it this way you have all information for the call in one place and
78568 *   do not clutter the function namespace with a callback function's
78569 *   name not used anywhere else.
78570 *
78571 *   {@link preg_replace_callback} and anonymous function
78572 *
78573 *   <?php /* a unix-style command line filter to convert uppercase *
78574 *   letters at the beginning of paragraphs to lowercase * / $fp =
78575 *   fopen("php://stdin", "r") or die("can't read stdin"); while
78576 *   (!feof($fp)) { $line = fgets($fp); $line = preg_replace_callback(
78577 *   '|<p>\s*\w|', function ($matches) { return strtolower($matches[0]);
78578 *   }, $line ); echo $line; } fclose($fp); ?>
78579 * @param mixed $subject The string or an array with strings to search
78580 *   and replace.
78581 * @param int $limit The maximum possible replacements for each pattern
78582 *   in each {@link subject} string. Defaults to -1 (no limit).
78583 * @param int $count If specified, this variable will be filled with
78584 *   the number of replacements done.
78585 * @param int $flags {@link flags} can be a combination of the
78586 *   PREG_OFFSET_CAPTURE and PREG_UNMATCHED_AS_NULL flags, which
78587 *   influence the format of the matches array. See the description in
78588 *   {@link preg_match} for more details.
78589 * @return mixed {@link preg_replace_callback} returns an array if the
78590 *   {@link subject} parameter is an array, or a string otherwise. On
78591 *   errors the return value is NULL
78592 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
78593 **/
78594function preg_replace_callback($pattern, $callback, $subject, $limit, &$count, $flags){}
78595
78596/**
78597 * Perform a regular expression search and replace using callbacks
78598 *
78599 * The behavior of this function is similar to {@link
78600 * preg_replace_callback}, except that callbacks are executed on a
78601 * per-pattern basis.
78602 *
78603 * @param array $patterns_and_callbacks An associative array mapping
78604 *   patterns (keys) to callbacks (values).
78605 * @param mixed $subject The string or an array with strings to search
78606 *   and replace.
78607 * @param int $limit The maximum possible replacements for each pattern
78608 *   in each {@link subject} string. Defaults to -1 (no limit).
78609 * @param int $count If specified, this variable will be filled with
78610 *   the number of replacements done.
78611 * @param int $flags {@link flags} can be a combination of the
78612 *   PREG_OFFSET_CAPTURE and PREG_UNMATCHED_AS_NULL flags, which
78613 *   influence the format of the matches array. See the description in
78614 *   {@link preg_match} for more details.
78615 * @return mixed {@link preg_replace_callback_array} returns an array
78616 *   if the {@link subject} parameter is an array, or a string otherwise.
78617 *   On errors the return value is NULL
78618 * @since PHP 7
78619 **/
78620function preg_replace_callback_array($patterns_and_callbacks, $subject, $limit, &$count, $flags){}
78621
78622/**
78623 * Split string by a regular expression
78624 *
78625 * Split the given string by a regular expression.
78626 *
78627 * @param string $pattern The pattern to search for, as a string.
78628 * @param string $subject The input string.
78629 * @param int $limit If specified, then only substrings up to {@link
78630 *   limit} are returned with the rest of the string being placed in the
78631 *   last substring. A {@link limit} of -1 or 0 means "no limit".
78632 * @param int $flags {@link flags} can be any combination of the
78633 *   following flags (combined with the | bitwise operator):
78634 *   PREG_SPLIT_NO_EMPTY If this flag is set, only non-empty pieces will
78635 *   be returned by {@link preg_split}. PREG_SPLIT_DELIM_CAPTURE If this
78636 *   flag is set, parenthesized expression in the delimiter pattern will
78637 *   be captured and returned as well. PREG_SPLIT_OFFSET_CAPTURE If this
78638 *   flag is set, for every occurring match the appendant string offset
78639 *   will also be returned. Note that this changes the return value in an
78640 *   array where every element is an array consisting of the matched
78641 *   string at offset 0 and its string offset into {@link subject} at
78642 *   offset 1.
78643 * @return array Returns an array containing substrings of {@link
78644 *   subject} split along boundaries matched by {@link pattern}, .
78645 * @since PHP 4, PHP 5, PHP 7
78646 **/
78647function preg_split($pattern, $subject, $limit, $flags){}
78648
78649/**
78650 * Rewind the internal array pointer
78651 *
78652 * {@link prev} behaves just like {@link next}, except it rewinds the
78653 * internal array pointer one place instead of advancing it.
78654 *
78655 * @param array $array The input array.
78656 * @return mixed Returns the array value in the previous place that's
78657 *   pointed to by the internal array pointer, or FALSE if there are no
78658 *   more elements.
78659 * @since PHP 4, PHP 5, PHP 7
78660 **/
78661function prev(&$array){}
78662
78663/**
78664 * Output a formatted string
78665 *
78666 * @param string $format
78667 * @param mixed ...$vararg
78668 * @return int Returns the length of the outputted string.
78669 * @since PHP 4, PHP 5, PHP 7
78670 **/
78671function printf($format, ...$vararg){}
78672
78673/**
78674 * Prints human-readable information about a variable
78675 *
78676 * {@link print_r} displays information about a variable in a way that's
78677 * readable by humans.
78678 *
78679 * {@link print_r}, {@link var_dump} and {@link var_export} will also
78680 * show protected and private properties of objects. Static class members
78681 * will not be shown.
78682 *
78683 * @param mixed $expression The expression to be printed.
78684 * @param bool $return If you would like to capture the output of
78685 *   {@link print_r}, use the {@link return} parameter. When this
78686 *   parameter is set to TRUE, {@link print_r} will return the
78687 *   information rather than print it.
78688 * @return mixed If given a string, integer or float, the value itself
78689 *   will be printed. If given an array, values will be presented in a
78690 *   format that shows keys and elements. Similar notation is used for
78691 *   objects.
78692 * @since PHP 4, PHP 5, PHP 7
78693 **/
78694function print_r($expression, $return){}
78695
78696/**
78697 * Close a process opened by and return the exit code of that process
78698 *
78699 * {@link proc_close} is similar to {@link pclose} except that it only
78700 * works on processes opened by {@link proc_open}. {@link proc_close}
78701 * waits for the process to terminate, and returns its exit code. Open
78702 * pipes to that process are closed when this function is called, in
78703 * order to avoid a deadlock - the child process may not be able to exit
78704 * while the pipes are open.
78705 *
78706 * @param resource $process The {@link proc_open} resource that will be
78707 *   closed.
78708 * @return int Returns the termination status of the process that was
78709 *   run. In case of an error then -1 is returned.
78710 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
78711 **/
78712function proc_close($process){}
78713
78714/**
78715 * Get information about a process opened by
78716 *
78717 * {@link proc_get_status} fetches data about a process opened using
78718 * {@link proc_open}.
78719 *
78720 * @param resource $process The {@link proc_open} resource that will be
78721 *   evaluated.
78722 * @return array An array of collected information on success, and
78723 *   FALSE on failure. The returned array contains the following
78724 *   elements:
78725 * @since PHP 5, PHP 7
78726 **/
78727function proc_get_status($process){}
78728
78729/**
78730 * Change the priority of the current process
78731 *
78732 * {@link proc_nice} changes the priority of the current process by the
78733 * amount specified in {@link increment}. A positive {@link increment}
78734 * will lower the priority of the current process, whereas a negative
78735 * {@link increment} will raise the priority.
78736 *
78737 * {@link proc_nice} is not related to {@link proc_open} and its
78738 * associated functions in any way.
78739 *
78740 * @param int $increment The new priority value, the value of this may
78741 *   differ on platforms. On Unix, a low value, such as -20 means high
78742 *   priority wheras a positive value have a lower priority. For Windows
78743 *   the {@link increment} parameter have the following meanings:
78744 * @return bool If an error occurs, like the user lacks permission to
78745 *   change the priority, an error of level E_WARNING is also generated.
78746 * @since PHP 5, PHP 7
78747 **/
78748function proc_nice($increment){}
78749
78750/**
78751 * Execute a command and open file pointers for input/output
78752 *
78753 * {@link proc_open} is similar to {@link popen} but provides a much
78754 * greater degree of control over the program execution.
78755 *
78756 * @param mixed $cmd The commandline to execute as . Special characters
78757 *   have to be properly escaped, and proper quoting has to be applied.
78758 *   As of PHP 7.4.0, {@link cmd} may be passed as of command parameters.
78759 *   In this case the process will be opened directly (without going
78760 *   through a shell) and PHP will take care of any necessary argument
78761 *   escaping.
78762 * @param array $descriptorspec An indexed array where the key
78763 *   represents the descriptor number and the value represents how PHP
78764 *   will pass that descriptor to the child process. 0 is stdin, 1 is
78765 *   stdout, while 2 is stderr. Each element can be: An array describing
78766 *   the pipe to pass to the process. The first element is the descriptor
78767 *   type and the second element is an option for the given type. Valid
78768 *   types are pipe (the second element is either r to pass the read end
78769 *   of the pipe to the process, or w to pass the write end) and file
78770 *   (the second element is a filename). A stream resource representing a
78771 *   real file descriptor (e.g. opened file, a socket, STDIN). The file
78772 *   descriptor numbers are not limited to 0, 1 and 2 - you may specify
78773 *   any valid file descriptor number and it will be passed to the child
78774 *   process. This allows your script to interoperate with other scripts
78775 *   that run as "co-processes". In particular, this is useful for
78776 *   passing passphrases to programs like PGP, GPG and openssl in a more
78777 *   secure manner. It is also useful for reading status information
78778 *   provided by those programs on auxiliary file descriptors.
78779 * @param array $pipes Will be set to an indexed array of file pointers
78780 *   that correspond to PHP's end of any pipes that are created.
78781 * @param string $cwd The initial working dir for the command. This
78782 *   must be an absolute directory path, or NULL if you want to use the
78783 *   default value (the working dir of the current PHP process)
78784 * @param array $env An array with the environment variables for the
78785 *   command that will be run, or NULL to use the same environment as the
78786 *   current PHP process
78787 * @param array $other_options Allows you to specify additional
78788 *   options. Currently supported options include: suppress_errors
78789 *   (windows only): suppresses errors generated by this function when
78790 *   it's set to TRUE bypass_shell (windows only): bypass cmd.exe shell
78791 *   when set to TRUE blocking_pipes (windows only): force blocking pipes
78792 *   when set to TRUE create_process_group (windows only): allow the
78793 *   child process to handle CTRL events when set to TRUE
78794 *   create_new_console (windows only): the new process has a new
78795 *   console, instead of inheriting its parent's console
78796 * @return resource Returns a resource representing the process, which
78797 *   should be freed using {@link proc_close} when you are finished with
78798 *   it. On failure returns FALSE.
78799 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
78800 **/
78801function proc_open($cmd, $descriptorspec, &$pipes, $cwd, $env, $other_options){}
78802
78803/**
78804 * Kills a process opened by proc_open
78805 *
78806 * Signals a {@link process} (created using {@link proc_open}) that it
78807 * should terminate. {@link proc_terminate} returns immediately and does
78808 * not wait for the process to terminate.
78809 *
78810 * {@link proc_terminate} allows you terminate the process and continue
78811 * with other tasks. You may poll the process (to see if it has stopped
78812 * yet) by using the {@link proc_get_status} function.
78813 *
78814 * @param resource $process The {@link proc_open} resource that will be
78815 *   closed.
78816 * @param int $signal This optional parameter is only useful on POSIX
78817 *   operating systems; you may specify a signal to send to the process
78818 *   using the kill(2) system call. The default is SIGTERM.
78819 * @return bool Returns the termination status of the process that was
78820 *   run.
78821 * @since PHP 5, PHP 7
78822 **/
78823function proc_terminate($process, $signal){}
78824
78825/**
78826 * Checks if the object or class has a property
78827 *
78828 * This function checks if the given {@link property} exists in the
78829 * specified class.
78830 *
78831 * @param mixed $class The class name or an object of the class to test
78832 *   for
78833 * @param string $property The name of the property
78834 * @return bool Returns TRUE if the property exists, FALSE if it
78835 *   doesn't exist or NULL in case of an error.
78836 * @since PHP 5 >= 5.1.0, PHP 7
78837 **/
78838function property_exists($class, $property){}
78839
78840/**
78841 * Add the word to a personal wordlist
78842 *
78843 * @param int $dictionary_link
78844 * @param string $word The added word.
78845 * @return bool
78846 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
78847 **/
78848function pspell_add_to_personal($dictionary_link, $word){}
78849
78850/**
78851 * Add the word to the wordlist in the current session
78852 *
78853 * @param int $dictionary_link
78854 * @param string $word The added word.
78855 * @return bool
78856 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
78857 **/
78858function pspell_add_to_session($dictionary_link, $word){}
78859
78860/**
78861 * Check a word
78862 *
78863 * @param int $dictionary_link
78864 * @param string $word The tested word.
78865 * @return bool Returns TRUE if the spelling is correct, FALSE if not.
78866 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
78867 **/
78868function pspell_check($dictionary_link, $word){}
78869
78870/**
78871 * Clear the current session
78872 *
78873 * @param int $dictionary_link
78874 * @return bool
78875 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
78876 **/
78877function pspell_clear_session($dictionary_link){}
78878
78879/**
78880 * Create a config used to open a dictionary
78881 *
78882 * {@link pspell_config_create} has a very similar syntax to {@link
78883 * pspell_new}. In fact, using {@link pspell_config_create} immediately
78884 * followed by {@link pspell_new_config} will produce the exact same
78885 * result. However, after creating a new config, you can also use {@link
78886 * pspell_config_*} functions before calling {@link pspell_new_config} to
78887 * take advantage of some advanced functionality.
78888 *
78889 * For more information and examples, check out inline manual pspell
78890 * website:.
78891 *
78892 * @param string $language The language parameter is the language code
78893 *   which consists of the two letter ISO 639 language code and an
78894 *   optional two letter ISO 3166 country code after a dash or
78895 *   underscore.
78896 * @param string $spelling The spelling parameter is the requested
78897 *   spelling for languages with more than one spelling such as English.
78898 *   Known values are 'american', 'british', and 'canadian'.
78899 * @param string $jargon The jargon parameter contains extra
78900 *   information to distinguish two different words lists that have the
78901 *   same language and spelling parameters.
78902 * @param string $encoding The encoding parameter is the encoding that
78903 *   words are expected to be in. Valid values are 'utf-8', 'iso8859-*',
78904 *   'koi8-r', 'viscii', 'cp1252', 'machine unsigned 16', 'machine
78905 *   unsigned 32'. This parameter is largely untested, so be careful when
78906 *   using.
78907 * @return int Returns a pspell config identifier, or FALSE on error.
78908 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
78909 **/
78910function pspell_config_create($language, $spelling, $jargon, $encoding){}
78911
78912/**
78913 * Location of language data files
78914 *
78915 * @param int $conf
78916 * @param string $directory
78917 * @return bool
78918 * @since PHP 5, PHP 7
78919 **/
78920function pspell_config_data_dir($conf, $directory){}
78921
78922/**
78923 * Location of the main word list
78924 *
78925 * @param int $conf
78926 * @param string $directory
78927 * @return bool
78928 * @since PHP 5, PHP 7
78929 **/
78930function pspell_config_dict_dir($conf, $directory){}
78931
78932/**
78933 * Ignore words less than N characters long
78934 *
78935 * @param int $dictionary_link
78936 * @param int $n Words less than {@link n} characters will be skipped.
78937 * @return bool
78938 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
78939 **/
78940function pspell_config_ignore($dictionary_link, $n){}
78941
78942/**
78943 * Change the mode number of suggestions returned
78944 *
78945 * @param int $dictionary_link
78946 * @param int $mode The mode parameter is the mode in which
78947 *   spellchecker will work. There are several modes available:
78948 *   PSPELL_FAST - Fast mode (least number of suggestions) PSPELL_NORMAL
78949 *   - Normal mode (more suggestions) PSPELL_BAD_SPELLERS - Slow mode (a
78950 *   lot of suggestions)
78951 * @return bool
78952 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
78953 **/
78954function pspell_config_mode($dictionary_link, $mode){}
78955
78956/**
78957 * Set a file that contains personal wordlist
78958 *
78959 * Set a file that contains personal wordlist. The personal wordlist will
78960 * be loaded and used in addition to the standard one after you call
78961 * {@link pspell_new_config}. The file is also the file where {@link
78962 * pspell_save_wordlist} will save personal wordlist to.
78963 *
78964 * {@link pspell_config_personal} should be used on a config before
78965 * calling {@link pspell_new_config}.
78966 *
78967 * @param int $dictionary_link
78968 * @param string $file The personal wordlist. If the file does not
78969 *   exist, it will be created. The file should be writable by whoever
78970 *   PHP runs as (e.g. nobody).
78971 * @return bool
78972 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
78973 **/
78974function pspell_config_personal($dictionary_link, $file){}
78975
78976/**
78977 * Set a file that contains replacement pairs
78978 *
78979 * The replacement pairs improve the quality of the spellchecker. When a
78980 * word is misspelled, and a proper suggestion was not found in the list,
78981 * {@link pspell_store_replacement} can be used to store a replacement
78982 * pair and then {@link pspell_save_wordlist} to save the wordlist along
78983 * with the replacement pairs.
78984 *
78985 * {@link pspell_config_repl} should be used on a config before calling
78986 * {@link pspell_new_config}.
78987 *
78988 * @param int $dictionary_link
78989 * @param string $file The file should be writable by whoever PHP runs
78990 *   as (e.g. nobody).
78991 * @return bool
78992 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
78993 **/
78994function pspell_config_repl($dictionary_link, $file){}
78995
78996/**
78997 * Consider run-together words as valid compounds
78998 *
78999 * This function determines whether run-together words will be treated as
79000 * legal compounds. That is, "thecat" will be a legal compound, although
79001 * there should be a space between the two words. Changing this setting
79002 * only affects the results returned by {@link pspell_check}; {@link
79003 * pspell_suggest} will still return suggestions.
79004 *
79005 * {@link pspell_config_runtogether} should be used on a config before
79006 * calling {@link pspell_new_config}.
79007 *
79008 * @param int $dictionary_link
79009 * @param bool $flag TRUE if run-together words should be treated as
79010 *   legal compounds, FALSE otherwise.
79011 * @return bool
79012 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
79013 **/
79014function pspell_config_runtogether($dictionary_link, $flag){}
79015
79016/**
79017 * Determine whether to save a replacement pairs list along with the
79018 * wordlist
79019 *
79020 * {@link pspell_config_save_repl} determines whether {@link
79021 * pspell_save_wordlist} will save the replacement pairs along with the
79022 * wordlist. Usually there is no need to use this function because if
79023 * {@link pspell_config_repl} is used, the replacement pairs will be
79024 * saved by {@link pspell_save_wordlist} anyway, and if it is not, the
79025 * replacement pairs will not be saved.
79026 *
79027 * {@link pspell_config_save_repl} should be used on a config before
79028 * calling {@link pspell_new_config}.
79029 *
79030 * @param int $dictionary_link
79031 * @param bool $flag TRUE if replacement pairs should be saved, FALSE
79032 *   otherwise.
79033 * @return bool
79034 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
79035 **/
79036function pspell_config_save_repl($dictionary_link, $flag){}
79037
79038/**
79039 * Load a new dictionary
79040 *
79041 * {@link pspell_new} opens up a new dictionary and returns the
79042 * dictionary link identifier for use in other pspell functions.
79043 *
79044 * For more information and examples, check out inline manual pspell
79045 * website:.
79046 *
79047 * @param string $language The language parameter is the language code
79048 *   which consists of the two letter ISO 639 language code and an
79049 *   optional two letter ISO 3166 country code after a dash or
79050 *   underscore.
79051 * @param string $spelling The spelling parameter is the requested
79052 *   spelling for languages with more than one spelling such as English.
79053 *   Known values are 'american', 'british', and 'canadian'.
79054 * @param string $jargon The jargon parameter contains extra
79055 *   information to distinguish two different words lists that have the
79056 *   same language and spelling parameters.
79057 * @param string $encoding The encoding parameter is the encoding that
79058 *   words are expected to be in. Valid values are 'utf-8', 'iso8859-*',
79059 *   'koi8-r', 'viscii', 'cp1252', 'machine unsigned 16', 'machine
79060 *   unsigned 32'. This parameter is largely untested, so be careful when
79061 *   using.
79062 * @param int $mode The mode parameter is the mode in which
79063 *   spellchecker will work. There are several modes available:
79064 *   PSPELL_FAST - Fast mode (least number of suggestions) PSPELL_NORMAL
79065 *   - Normal mode (more suggestions) PSPELL_BAD_SPELLERS - Slow mode (a
79066 *   lot of suggestions) PSPELL_RUN_TOGETHER - Consider run-together
79067 *   words as legal compounds. That is, "thecat" will be a legal
79068 *   compound, although there should be a space between the two words.
79069 *   Changing this setting only affects the results returned by {@link
79070 *   pspell_check}; {@link pspell_suggest} will still return suggestions.
79071 *   Mode is a bitmask constructed from different constants listed above.
79072 *   However, PSPELL_FAST, PSPELL_NORMAL and PSPELL_BAD_SPELLERS are
79073 *   mutually exclusive, so you should select only one of them.
79074 * @return int Returns the dictionary link identifier on success.
79075 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
79076 **/
79077function pspell_new($language, $spelling, $jargon, $encoding, $mode){}
79078
79079/**
79080 * Load a new dictionary with settings based on a given config
79081 *
79082 * @param int $config The {@link config} parameter is the one returned
79083 *   by {@link pspell_config_create} when the config was created.
79084 * @return int Returns a dictionary link identifier on success, .
79085 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
79086 **/
79087function pspell_new_config($config){}
79088
79089/**
79090 * Load a new dictionary with personal wordlist
79091 *
79092 * For more information and examples, check out inline manual pspell
79093 * website:.
79094 *
79095 * @param string $personal The file where words added to the personal
79096 *   list will be stored. It should be an absolute filename beginning
79097 *   with '/' because otherwise it will be relative to $HOME, which is
79098 *   "/root" for most systems, and is probably not what you want.
79099 * @param string $language The language code which consists of the two
79100 *   letter ISO 639 language code and an optional two letter ISO 3166
79101 *   country code after a dash or underscore.
79102 * @param string $spelling The requested spelling for languages with
79103 *   more than one spelling such as English. Known values are 'american',
79104 *   'british', and 'canadian'.
79105 * @param string $jargon Extra information to distinguish two different
79106 *   words lists that have the same language and spelling parameters.
79107 * @param string $encoding The encoding that words are expected to be
79108 *   in. Valid values are utf-8, iso8859-*, koi8-r, viscii, cp1252,
79109 *   machine unsigned 16, machine unsigned 32.
79110 * @param int $mode The mode in which spellchecker will work. There are
79111 *   several modes available: PSPELL_FAST - Fast mode (least number of
79112 *   suggestions) PSPELL_NORMAL - Normal mode (more suggestions)
79113 *   PSPELL_BAD_SPELLERS - Slow mode (a lot of suggestions)
79114 *   PSPELL_RUN_TOGETHER - Consider run-together words as legal
79115 *   compounds. That is, "thecat" will be a legal compound, although
79116 *   there should be a space between the two words. Changing this setting
79117 *   only affects the results returned by {@link pspell_check}; {@link
79118 *   pspell_suggest} will still return suggestions. Mode is a bitmask
79119 *   constructed from different constants listed above. However,
79120 *   PSPELL_FAST, PSPELL_NORMAL and PSPELL_BAD_SPELLERS are mutually
79121 *   exclusive, so you should select only one of them.
79122 * @return int Returns the dictionary link identifier for use in other
79123 *   pspell functions.
79124 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
79125 **/
79126function pspell_new_personal($personal, $language, $spelling, $jargon, $encoding, $mode){}
79127
79128/**
79129 * Save the personal wordlist to a file
79130 *
79131 * @param int $dictionary_link A dictionary link identifier opened with
79132 *   {@link pspell_new_personal}.
79133 * @return bool
79134 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
79135 **/
79136function pspell_save_wordlist($dictionary_link){}
79137
79138/**
79139 * Store a replacement pair for a word
79140 *
79141 * @param int $dictionary_link A dictionary link identifier, opened
79142 *   with {@link pspell_new_personal}
79143 * @param string $misspelled The misspelled word.
79144 * @param string $correct The fixed spelling for the {@link misspelled}
79145 *   word.
79146 * @return bool
79147 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
79148 **/
79149function pspell_store_replacement($dictionary_link, $misspelled, $correct){}
79150
79151/**
79152 * Suggest spellings of a word
79153 *
79154 * @param int $dictionary_link
79155 * @param string $word The tested word.
79156 * @return array Returns an array of possible spellings.
79157 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
79158 **/
79159function pspell_suggest($dictionary_link, $word){}
79160
79161/**
79162 * Add bookmark to current page
79163 *
79164 * Adds a bookmark for the current page. Bookmarks usually appear in
79165 * PDF-Viewers left of the page in a hierarchical tree. Clicking on a
79166 * bookmark will jump to the given page.
79167 *
79168 * @param resource $psdoc Resource identifier of the postscript file as
79169 *   returned by {@link ps_new}.
79170 * @param string $text The text used for displaying the bookmark.
79171 * @param int $parent A bookmark previously created by this function
79172 *   which is used as the parent of the new bookmark.
79173 * @param int $open If {@link open} is unequal to zero the bookmark
79174 *   will be shown open by the pdf viewer.
79175 * @return int The returned value is a reference for the bookmark. It
79176 *   is only used if the bookmark shall be used as a parent. The value is
79177 *   greater zero if the function succeeds. In case of an error zero will
79178 *   be returned.
79179 * @since PECL ps >= 1.1.0
79180 **/
79181function ps_add_bookmark($psdoc, $text, $parent, $open){}
79182
79183/**
79184 * Adds link which launches file
79185 *
79186 * Places a hyperlink at the given position pointing to a file program
79187 * which is being started when clicked on. The hyperlink's source
79188 * position is a rectangle with its lower left corner at (llx, lly) and
79189 * its upper right corner at (urx, ury). The rectangle has by default a
79190 * thin blue border.
79191 *
79192 * @param resource $psdoc Resource identifier of the postscript file as
79193 *   returned by {@link ps_new}.
79194 * @param float $llx The x-coordinate of the lower left corner.
79195 * @param float $lly The y-coordinate of the lower left corner.
79196 * @param float $urx The x-coordinate of the upper right corner.
79197 * @param float $ury The y-coordinate of the upper right corner.
79198 * @param string $filename The path of the program to be started, when
79199 *   the link is clicked on.
79200 * @return bool
79201 * @since PECL ps >= 1.1.0
79202 **/
79203function ps_add_launchlink($psdoc, $llx, $lly, $urx, $ury, $filename){}
79204
79205/**
79206 * Adds link to a page in the same document
79207 *
79208 * Places a hyperlink at the given position pointing to a page in the
79209 * same document. Clicking on the link will jump to the given page. The
79210 * first page in a document has number 1.
79211 *
79212 * The hyperlink's source position is a rectangle with its lower left
79213 * corner at ({@link llx}, {@link lly}) and its upper right corner at
79214 * ({@link urx}, {@link ury}). The rectangle has by default a thin blue
79215 * border.
79216 *
79217 * @param resource $psdoc Resource identifier of the postscript file as
79218 *   returned by {@link ps_new}.
79219 * @param float $llx The x-coordinate of the lower left corner.
79220 * @param float $lly The y-coordinate of the lower left corner.
79221 * @param float $urx The x-coordinate of the upper right corner.
79222 * @param float $ury The y-coordinate of the upper right corner.
79223 * @param int $page The number of the page displayed when clicking on
79224 *   the link.
79225 * @param string $dest The parameter {@link dest} determines how the
79226 *   document is being viewed. It can be fitpage, fitwidth, fitheight, or
79227 *   fitbbox.
79228 * @return bool
79229 * @since PECL ps >= 1.1.0
79230 **/
79231function ps_add_locallink($psdoc, $llx, $lly, $urx, $ury, $page, $dest){}
79232
79233/**
79234 * Adds note to current page
79235 *
79236 * Adds a note at a certain position on the page. Notes are like little
79237 * rectangular sheets with text on it, which can be placed anywhere on a
79238 * page. They are shown either folded or unfolded. If folded, the
79239 * specified icon is used as a placeholder.
79240 *
79241 * @param resource $psdoc Resource identifier of the postscript file as
79242 *   returned by {@link ps_new}.
79243 * @param float $llx The x-coordinate of the lower left corner.
79244 * @param float $lly The y-coordinate of the lower left corner.
79245 * @param float $urx The x-coordinate of the upper right corner.
79246 * @param float $ury The y-coordinate of the upper right corner.
79247 * @param string $contents The text of the note.
79248 * @param string $title The title of the note as displayed in the
79249 *   header of the note.
79250 * @param string $icon The icon shown if the note is folded. This
79251 *   parameter can be set to comment, insert, note, paragraph,
79252 *   newparagraph, key, or help.
79253 * @param int $open If {@link open} is unequal to zero the note will be
79254 *   shown unfolded after opening the document with a pdf viewer.
79255 * @return bool
79256 * @since PECL ps >= 1.1.0
79257 **/
79258function ps_add_note($psdoc, $llx, $lly, $urx, $ury, $contents, $title, $icon, $open){}
79259
79260/**
79261 * Adds link to a page in a second pdf document
79262 *
79263 * Places a hyperlink at the given position pointing to a second pdf
79264 * document. Clicking on the link will branch to the document at the
79265 * given page. The first page in a document has number 1.
79266 *
79267 * The hyperlink's source position is a rectangle with its lower left
79268 * corner at ({@link llx}, {@link lly}) and its upper right corner at
79269 * ({@link urx}, {@link ury}). The rectangle has by default a thin blue
79270 * border.
79271 *
79272 * @param resource $psdoc Resource identifier of the postscript file as
79273 *   returned by {@link ps_new}.
79274 * @param float $llx The x-coordinate of the lower left corner.
79275 * @param float $lly The y-coordinate of the lower left corner.
79276 * @param float $urx The x-coordinate of the upper right corner.
79277 * @param float $ury The y-coordinate of the upper right corner.
79278 * @param string $filename The name of the pdf document to be opened
79279 *   when clicking on this link.
79280 * @param int $page The page number of the destination pdf document
79281 * @param string $dest The parameter {@link dest} determines how the
79282 *   document is being viewed. It can be fitpage, fitwidth, fitheight, or
79283 *   fitbbox.
79284 * @return bool
79285 * @since PECL ps >= 1.1.0
79286 **/
79287function ps_add_pdflink($psdoc, $llx, $lly, $urx, $ury, $filename, $page, $dest){}
79288
79289/**
79290 * Adds link to a web location
79291 *
79292 * Places a hyperlink at the given position pointing to a web page. The
79293 * hyperlink's source position is a rectangle with its lower left corner
79294 * at ({@link llx}, {@link lly}) and its upper right corner at ({@link
79295 * urx}, {@link ury}). The rectangle has by default a thin blue border.
79296 *
79297 * @param resource $psdoc Resource identifier of the postscript file as
79298 *   returned by {@link ps_new}.
79299 * @param float $llx The x-coordinate of the lower left corner.
79300 * @param float $lly The y-coordinate of the lower left corner.
79301 * @param float $urx The x-coordinate of the upper right corner.
79302 * @param float $ury The y-coordinate of the upper right corner.
79303 * @param string $url The url of the hyperlink to be opened when
79304 *   clicking on this link, e.g. http://www.php.net.
79305 * @return bool
79306 * @since PECL ps >= 1.1.0
79307 **/
79308function ps_add_weblink($psdoc, $llx, $lly, $urx, $ury, $url){}
79309
79310/**
79311 * Draws an arc counterclockwise
79312 *
79313 * Draws a portion of a circle with at middle point at ({@link x}, {@link
79314 * y}). The arc starts at an angle of {@link alpha} and ends at an angle
79315 * of {@link beta}. It is drawn counterclockwise (use {@link ps_arcn} to
79316 * draw clockwise). The subpath added to the current path starts on the
79317 * arc at angle {@link alpha} and ends on the arc at angle {@link beta}.
79318 *
79319 * @param resource $psdoc Resource identifier of the postscript file as
79320 *   returned by {@link ps_new}.
79321 * @param float $x The x-coordinate of the circle's middle point.
79322 * @param float $y The y-coordinate of the circle's middle point.
79323 * @param float $radius The radius of the circle
79324 * @param float $alpha The start angle given in degrees.
79325 * @param float $beta The end angle given in degrees.
79326 * @return bool
79327 * @since PECL ps >= 1.1.0
79328 **/
79329function ps_arc($psdoc, $x, $y, $radius, $alpha, $beta){}
79330
79331/**
79332 * Draws an arc clockwise
79333 *
79334 * Draws a portion of a circle with at middle point at ({@link x}, {@link
79335 * y}). The arc starts at an angle of {@link alpha} and ends at an angle
79336 * of {@link beta}. It is drawn clockwise (use {@link ps_arc} to draw
79337 * counterclockwise). The subpath added to the current path starts on the
79338 * arc at angle {@link beta} and ends on the arc at angle {@link alpha}.
79339 *
79340 * @param resource $psdoc Resource identifier of the postscript file as
79341 *   returned by {@link ps_new}.
79342 * @param float $x The x-coordinate of the circle's middle point.
79343 * @param float $y The y-coordinate of the circle's middle point.
79344 * @param float $radius The radius of the circle
79345 * @param float $alpha The starting angle given in degrees.
79346 * @param float $beta The end angle given in degrees.
79347 * @return bool
79348 * @since PECL ps >= 1.1.0
79349 **/
79350function ps_arcn($psdoc, $x, $y, $radius, $alpha, $beta){}
79351
79352/**
79353 * Start a new page
79354 *
79355 * Starts a new page. Although the parameters {@link width} and {@link
79356 * height} imply a different page size for each page, this is not
79357 * possible in PostScript. The first call of {@link ps_begin_page} will
79358 * set the page size for the whole document. Consecutive calls will have
79359 * no effect, except for creating a new page. The situation is different
79360 * if you intent to convert the PostScript document into PDF. This
79361 * function places pdfmarks into the document which can set the size for
79362 * each page indiviually. The resulting PDF document will have different
79363 * page sizes.
79364 *
79365 * Though PostScript does not know different page sizes, pslib places a
79366 * bounding box for each page into the document. This size is evaluated
79367 * by some PostScript viewers and will have precedence over the
79368 * BoundingBox in the Header of the document. This can lead to unexpected
79369 * results when you set a BoundingBox whose lower left corner is not (0,
79370 * 0), because the bounding box of the page will always have a lower left
79371 * corner (0, 0) and overwrites the global setting.
79372 *
79373 * Each page is encapsulated into save/restore. This means, that most of
79374 * the settings made on one page will not be retained on the next page.
79375 *
79376 * If there is up to the first call of {@link ps_begin_page} no call of
79377 * {@link ps_findfont}, then the header of the PostScript document will
79378 * be output and the bounding box will be set to the size of the first
79379 * page. The lower left corner of the bounding box is set to (0, 0). If
79380 * {@link ps_findfont} was called before, then the header has been output
79381 * already, and the document will not have a valid bounding box. In order
79382 * to prevent this, one should call {@link ps_set_info} to set the info
79383 * field BoundingBox and possibly Orientation before any {@link
79384 * ps_findfont} or {@link ps_begin_page} calls.
79385 *
79386 * @param resource $psdoc Resource identifier of the postscript file as
79387 *   returned by {@link ps_new}.
79388 * @param float $width The width of the page in pixel, e.g. 596 for A4
79389 *   format.
79390 * @param float $height The height of the page in pixel, e.g. 842 for
79391 *   A4 format.
79392 * @return bool
79393 * @since PECL ps >= 1.1.0
79394 **/
79395function ps_begin_page($psdoc, $width, $height){}
79396
79397/**
79398 * Start a new pattern
79399 *
79400 * Starts a new pattern. A pattern is like a page containing e.g. a
79401 * drawing which can be used for filling areas. It is used like a color
79402 * by calling {@link ps_setcolor} and setting the color space to pattern.
79403 *
79404 * @param resource $psdoc Resource identifier of the postscript file as
79405 *   returned by {@link ps_new}.
79406 * @param float $width The width of the pattern in pixel.
79407 * @param float $height The height of the pattern in pixel.
79408 * @param float $xstep The distance in pixel of placements of the
79409 *   pattern in horizontal direction.
79410 * @param float $ystep The distance in pixel of placements of the
79411 *   pattern in vertical direction.
79412 * @param int $painttype Must be 1 or 2.
79413 * @return int The identifier of the pattern .
79414 * @since PECL ps >= 1.2.0
79415 **/
79416function ps_begin_pattern($psdoc, $width, $height, $xstep, $ystep, $painttype){}
79417
79418/**
79419 * Start a new template
79420 *
79421 * Starts a new template. A template is called a form in the postscript
79422 * language. It is created similar to a pattern but used like an image.
79423 * Templates are often used for drawings which are placed several times
79424 * through out the document, e.g. like a company logo. All drawing
79425 * functions may be used within a template. The template will not be
79426 * drawn until it is placed by {@link ps_place_image}.
79427 *
79428 * @param resource $psdoc Resource identifier of the postscript file as
79429 *   returned by {@link ps_new}.
79430 * @param float $width The width of the template in pixel.
79431 * @param float $height The height of the template in pixel.
79432 * @return int
79433 * @since PECL ps >= 1.2.0
79434 **/
79435function ps_begin_template($psdoc, $width, $height){}
79436
79437/**
79438 * Draws a circle
79439 *
79440 * Draws a circle with its middle point at ({@link x}, {@link y}). The
79441 * circle starts and ends at position ({@link x}+{@link radius}, {@link
79442 * y}). If this function is called outside a path it will start a new
79443 * path. If it is called within a path it will add the circle as a
79444 * subpath. If the last drawing operation does not end in point ({@link
79445 * x}+{@link radius}, {@link y}) then there will be a gap in the path.
79446 *
79447 * @param resource $psdoc Resource identifier of the postscript file as
79448 *   returned by {@link ps_new}.
79449 * @param float $x The x-coordinate of the circle's middle point.
79450 * @param float $y The y-coordinate of the circle's middle point.
79451 * @param float $radius The radius of the circle
79452 * @return bool
79453 * @since PECL ps >= 1.1.0
79454 **/
79455function ps_circle($psdoc, $x, $y, $radius){}
79456
79457/**
79458 * Clips drawing to current path
79459 *
79460 * Takes the current path and uses it to define the border of a clipping
79461 * area. Everything drawn outside of that area will not be visible.
79462 *
79463 * @param resource $psdoc Resource identifier of the postscript file as
79464 *   returned by {@link ps_new}.
79465 * @return bool
79466 * @since PECL ps >= 1.1.0
79467 **/
79468function ps_clip($psdoc){}
79469
79470/**
79471 * Closes a PostScript document
79472 *
79473 * Closes the PostScript document.
79474 *
79475 * This function writes the trailer of the PostScript document. It also
79476 * writes the bookmark tree. {@link ps_close} does not free any
79477 * resources, which is done by {@link ps_delete}.
79478 *
79479 * This function is also called by {@link ps_delete} if it has not been
79480 * called before.
79481 *
79482 * @param resource $psdoc Resource identifier of the postscript file as
79483 *   returned by {@link ps_new}.
79484 * @return bool
79485 * @since PECL ps >= 1.1.0
79486 **/
79487function ps_close($psdoc){}
79488
79489/**
79490 * Closes path
79491 *
79492 * Connects the last point with the first point of a path. The resulting
79493 * path can be used for stroking, filling, clipping, etc..
79494 *
79495 * @param resource $psdoc Resource identifier of the postscript file as
79496 *   returned by {@link ps_new}.
79497 * @return bool
79498 * @since PECL ps >= 1.1.0
79499 **/
79500function ps_closepath($psdoc){}
79501
79502/**
79503 * Closes and strokes path
79504 *
79505 * Connects the last point with first point of a path and draws the
79506 * resulting closed line.
79507 *
79508 * @param resource $psdoc Resource identifier of the postscript file as
79509 *   returned by {@link ps_new}.
79510 * @return bool
79511 * @since PECL ps >= 1.1.0
79512 **/
79513function ps_closepath_stroke($psdoc){}
79514
79515/**
79516 * Closes image and frees memory
79517 *
79518 * Closes an image and frees its resources. Once an image is closed it
79519 * cannot be used anymore.
79520 *
79521 * @param resource $psdoc Resource identifier of the postscript file as
79522 *   returned by {@link ps_new}.
79523 * @param int $imageid Resource identifier of the image as returned by
79524 *   {@link ps_open_image} or {@link ps_open_image_file}.
79525 * @return void Returns NULL on success.
79526 * @since PECL ps >= 1.1.0
79527 **/
79528function ps_close_image($psdoc, $imageid){}
79529
79530/**
79531 * Continue text in next line
79532 *
79533 * Output a text one line below the last line. The line spacing is taken
79534 * from the value "leading" which must be set with {@link ps_set_value}.
79535 * The actual position of the text is determined by the values "textx"
79536 * and "texty" which can be requested with {@link ps_get_value}
79537 *
79538 * @param resource $psdoc Resource identifier of the postscript file as
79539 *   returned by {@link ps_new}.
79540 * @param string $text The text to output.
79541 * @return bool
79542 * @since PECL ps >= 1.1.0
79543 **/
79544function ps_continue_text($psdoc, $text){}
79545
79546/**
79547 * Draws a curve
79548 *
79549 * Add a section of a cubic Bézier curve described by the three given
79550 * control points to the current path.
79551 *
79552 * @param resource $psdoc Resource identifier of the postscript file as
79553 *   returned by {@link ps_new}.
79554 * @param float $x1 x-coordinate of first control point.
79555 * @param float $y1 y-coordinate of first control point.
79556 * @param float $x2 x-coordinate of second control point.
79557 * @param float $y2 y-coordinate of second control point.
79558 * @param float $x3 x-coordinate of third control point.
79559 * @param float $y3 y-coordinate of third control point.
79560 * @return bool
79561 * @since PECL ps >= 1.1.0
79562 **/
79563function ps_curveto($psdoc, $x1, $y1, $x2, $y2, $x3, $y3){}
79564
79565/**
79566 * Deletes all resources of a PostScript document
79567 *
79568 * Mainly frees memory used by the document. Also closes a file, if it
79569 * was not closed before with {@link ps_close}. You should in any case
79570 * close the file with {@link ps_close} before, because {@link ps_close}
79571 * not just closes the file but also outputs a trailor containing
79572 * PostScript comments like the number of pages in the document and
79573 * adding the bookmark hierarchy.
79574 *
79575 * @param resource $psdoc Resource identifier of the postscript file as
79576 *   returned by {@link ps_new}.
79577 * @return bool
79578 * @since PECL ps >= 1.1.0
79579 **/
79580function ps_delete($psdoc){}
79581
79582/**
79583 * End a page
79584 *
79585 * Ends a page which was started with {@link ps_begin_page}. Ending a
79586 * page will leave the current drawing context, which e.g. requires to
79587 * reload fonts if they were loading within the page, and to set many
79588 * other drawing parameters like the line width, or color..
79589 *
79590 * @param resource $psdoc Resource identifier of the postscript file as
79591 *   returned by {@link ps_new}.
79592 * @return bool
79593 * @since PECL ps >= 1.1.0
79594 **/
79595function ps_end_page($psdoc){}
79596
79597/**
79598 * End a pattern
79599 *
79600 * Ends a pattern which was started with {@link ps_begin_pattern}. Once a
79601 * pattern has been ended, it can be used like a color to fill areas.
79602 *
79603 * @param resource $psdoc Resource identifier of the postscript file as
79604 *   returned by {@link ps_new}.
79605 * @return bool
79606 * @since PECL ps >= 1.2.0
79607 **/
79608function ps_end_pattern($psdoc){}
79609
79610/**
79611 * End a template
79612 *
79613 * Ends a template which was started with {@link ps_begin_template}. Once
79614 * a template has been ended, it can be used like an image.
79615 *
79616 * @param resource $psdoc Resource identifier of the postscript file as
79617 *   returned by {@link ps_new}.
79618 * @return bool
79619 * @since PECL ps >= 1.2.0
79620 **/
79621function ps_end_template($psdoc){}
79622
79623/**
79624 * Fills the current path
79625 *
79626 * Fills the path constructed with previously called drawing functions
79627 * like {@link ps_lineto}.
79628 *
79629 * @param resource $psdoc Resource identifier of the postscript file as
79630 *   returned by {@link ps_new}.
79631 * @return bool
79632 * @since PECL ps >= 1.1.0
79633 **/
79634function ps_fill($psdoc){}
79635
79636/**
79637 * Fills and strokes the current path
79638 *
79639 * Fills and draws the path constructed with previously called drawing
79640 * functions like {@link ps_lineto}.
79641 *
79642 * @param resource $psdoc Resource identifier of the postscript file as
79643 *   returned by {@link ps_new}.
79644 * @return bool
79645 * @since PECL ps >= 1.1.0
79646 **/
79647function ps_fill_stroke($psdoc){}
79648
79649/**
79650 * Loads a font
79651 *
79652 * Loads a font for later use. Before text is output with a loaded font
79653 * it must be set with {@link ps_setfont}. This function needs the adobe
79654 * font metric file in order to calculate the space used up by the
79655 * characters. A font which is loaded within a page will only be
79656 * available on that page. Fonts which are to be used in the complete
79657 * document have to be loaded before the first call of {@link
79658 * ps_begin_page}. Calling {@link ps_findfont} between pages will make
79659 * that font available for all following pages.
79660 *
79661 * The name of the afm file must be {@link fontname}.afm. If the font
79662 * shall be embedded the file {@link fontname}.pfb containing the font
79663 * outline must be present as well.
79664 *
79665 * Calling {@link ps_findfont} before the first page requires to output
79666 * the postscript header which includes the BoundingBox for the whole
79667 * document. Usually the BoundingBox is set with the first call of {@link
79668 * ps_begin_page} which now comes after {@link ps_findfont}. Consequently
79669 * the BoundingBox has not been set and a warning will be issued when
79670 * {@link ps_findfont} is called. In order to prevent this situation, one
79671 * should call {@link ps_set_parameter} to set the BoundingBox before
79672 * {@link ps_findfont} is called.
79673 *
79674 * @param resource $psdoc Resource identifier of the postscript file as
79675 *   returned by {@link ps_new}.
79676 * @param string $fontname The name of the font.
79677 * @param string $encoding {@link ps_findfont} will try to load the
79678 *   file passed in the parameter {@link encoding}. Encoding files are of
79679 *   the same syntax as those used by dvips(1). They contain a font
79680 *   encoding vector (which is currently not used but must be present)
79681 *   and a list of extra ligatures to extend the list of ligatures
79682 *   derived from the afm file. {@link encoding} can be NULL or the empty
79683 *   string if the default encoding (TeXBase1) shall be used. If the
79684 *   encoding is set to builtin then there will be no reencoding and the
79685 *   font specific encoding will be used. This is very useful with symbol
79686 *   fonts.
79687 * @param bool $embed If set to a value >0 the font will be embedded
79688 *   into the document. This requires the font outline (.pfb file) to be
79689 *   present.
79690 * @return int Returns the identifier of the font or zero in case of an
79691 *   error. The identifier is a positive number.
79692 * @since PECL ps >= 1.1.0
79693 **/
79694function ps_findfont($psdoc, $fontname, $encoding, $embed){}
79695
79696/**
79697 * Fetches the full buffer containig the generated PS data
79698 *
79699 * This function is not implemented yet. It will always return an empty
79700 * string. The idea for a later implementation is to write the contents
79701 * of the postscript file into an internal buffer if in memory creation
79702 * is requested, and retrieve the buffer content with this function.
79703 * Currently, documents created in memory are send to the browser without
79704 * buffering.
79705 *
79706 * @param resource $psdoc Resource identifier of the postscript file as
79707 *   returned by {@link ps_new}.
79708 * @return string
79709 * @since PECL ps >= 1.1.0
79710 **/
79711function ps_get_buffer($psdoc){}
79712
79713/**
79714 * Gets certain parameters
79715 *
79716 * Gets several parameters which were directly set by {@link
79717 * ps_set_parameter} or indirectly by one of the other functions.
79718 * Parameters are by definition string values. This function cannot be
79719 * used to retrieve resources which were also set by {@link
79720 * ps_set_parameter}.
79721 *
79722 * The parameter {@link name} can have the following values.
79723 *
79724 * fontname The name of the currently active font or the font whose
79725 * identifier is passed in parameter {@link modifier}. fontencoding The
79726 * encoding of the currently active font. dottedversion The version of
79727 * the underlying pslib library in the format <major>.<minor>.<subminor>
79728 * scope The current drawing scope. Can be object, document, null, page,
79729 * pattern, path, template, prolog, font, glyph. ligaturedisolvechar The
79730 * character which dissolves a ligature. If your are using a font which
79731 * contains the ligature `ff' and `|' is the char to dissolve the
79732 * ligature, then `f|f' will result in two `f' instead of the ligature
79733 * `ff'. imageencoding The encoding used for encoding images. Can be
79734 * either hex or 85. hex encoding uses two bytes in the postscript file
79735 * each byte in the image. 85 stand for Ascii85 encoding. linenumbermode
79736 * Set to paragraph if lines are numbered within a paragraph or box if
79737 * they are numbered within the surrounding box. linebreak Only used if
79738 * text is output with {@link ps_show_boxed}. If set to TRUE a carriage
79739 * return will add a line break. parbreak Only used if text is output
79740 * with {@link ps_show_boxed}. If set to TRUE a carriage return will
79741 * start a new paragraph. hyphenation Only used if text is output with
79742 * {@link ps_show_boxed}. If set to TRUE the paragraph will be hyphenated
79743 * if a hypen dictionary is set and exists. hyphendict Filename of the
79744 * dictionary used for hyphenation pattern.
79745 *
79746 * @param resource $psdoc Resource identifier of the postscript file as
79747 *   returned by {@link ps_new}.
79748 * @param string $name Name of the parameter.
79749 * @param float $modifier An identifier needed if a parameter of a
79750 *   resource is requested, e.g. the size of an image. In such a case the
79751 *   resource id is passed.
79752 * @return string Returns the value of the parameter .
79753 * @since PECL ps >= 1.1.0
79754 **/
79755function ps_get_parameter($psdoc, $name, $modifier){}
79756
79757/**
79758 * Gets certain values
79759 *
79760 * Gets several values which were set by {@link ps_set_value}. Values are
79761 * by definition float values.
79762 *
79763 * The parameter {@link name} can have the following values.
79764 *
79765 * fontsize The size of the currently active font or the font whose
79766 * identifier is passed in parameter {@link modifier}. font The currently
79767 * active font itself. imagewidth The width of the image whose id is
79768 * passed in the parameter {@link modifier}. imageheight The height of
79769 * the image whose id is passed in the parameter {@link modifier}.
79770 * capheight The height of a capital M in the currently active font or
79771 * the font whose identifier is passed in parameter {@link modifier}.
79772 * ascender The ascender of the currently active font or the font whose
79773 * identifier is passed in parameter {@link modifier}. descender The
79774 * descender of the currently active font or the font whose identifier is
79775 * passed in parameter {@link modifier}. italicangle The italicangle of
79776 * the currently active font or the font whose identifier is passed in
79777 * parameter {@link modifier}. underlineposition The underlineposition of
79778 * the currently active font or the font whose identifier is passed in
79779 * parameter {@link modifier}. underlinethickness The underlinethickness
79780 * of the currently active font or the font whose identifier is passed in
79781 * parameter {@link modifier}. textx The current x-position for text
79782 * output. texty The current y-position for text output. textrendering
79783 * The current mode for text rendering. textrise The space by which text
79784 * is risen above the base line. leading The distance between text lines
79785 * in points. wordspacing The space between words as a multiple of the
79786 * width of a space char. charspacing The space between chars. If
79787 * charspacing is != 0.0 ligatures will always be dissolved.
79788 * hyphenminchars Minimum number of chars hyphenated at the end of a
79789 * word. parindent Indention of the first n line in a paragraph.
79790 * numindentlines Number of line in a paragraph to indent if parindent !=
79791 * 0.0. parskip Distance between paragraphs. linenumberspace Overall
79792 * space in front of each line for the line number. linenumbersep Space
79793 * between the line and the line number. major The major version number
79794 * of pslib. minor The minor version number of pslib. subminor, revision
79795 * The subminor version number of pslib.
79796 *
79797 * @param resource $psdoc Resource identifier of the postscript file as
79798 *   returned by {@link ps_new}.
79799 * @param string $name Name of the value.
79800 * @param float $modifier The parameter {@link modifier} specifies the
79801 *   resource for which the value is to be retrieved. This can be the id
79802 *   of a font or an image.
79803 * @return float Returns the value of the parameter or FALSE.
79804 * @since PECL ps >= 1.1.0
79805 **/
79806function ps_get_value($psdoc, $name, $modifier){}
79807
79808/**
79809 * Hyphenates a word
79810 *
79811 * Hyphenates the passed word. {@link ps_hyphenate} evaluates the value
79812 * hyphenminchars (set by {@link ps_set_value}) and the parameter
79813 * hyphendict (set by {@link ps_set_parameter}). hyphendict must be set
79814 * before calling this function.
79815 *
79816 * This function requires the locale category LC_CTYPE to be set
79817 * properly. This is done when the extension is initialized by using the
79818 * environment variables. On Unix systems read the man page of locale for
79819 * more information.
79820 *
79821 * @param resource $psdoc Resource identifier of the postscript file as
79822 *   returned by {@link ps_new}.
79823 * @param string $text {@link text} should not contain any non alpha
79824 *   characters. Possible positions for breaks are returned in an array
79825 *   of interger numbers. Each number is the position of the char in
79826 *   {@link text} after which a hyphenation can take place.
79827 * @return array An array of integers indicating the position of
79828 *   possible breaks in the text .
79829 * @since PECL ps >= 1.1.1
79830 **/
79831function ps_hyphenate($psdoc, $text){}
79832
79833/**
79834 * Reads an external file with raw PostScript code
79835 *
79836 * @param resource $psdoc Resource identifier of the postscript file as
79837 *   returned by {@link ps_new}.
79838 * @param string $file
79839 * @return bool
79840 * @since PECL ps >= 1.3.4
79841 **/
79842function ps_include_file($psdoc, $file){}
79843
79844/**
79845 * Draws a line
79846 *
79847 * Adds a straight line from the current point to the given coordinates
79848 * to the current path. Use {@link ps_moveto} to set the starting point
79849 * of the line.
79850 *
79851 * @param resource $psdoc Resource identifier of the postscript file as
79852 *   returned by {@link ps_new}.
79853 * @param float $x x-coordinate of the end point of the line.
79854 * @param float $y y-coordinate of the end point of the line.
79855 * @return bool
79856 * @since PECL ps >= 1.1.0
79857 **/
79858function ps_lineto($psdoc, $x, $y){}
79859
79860/**
79861 * Create spot color
79862 *
79863 * Creates a spot color from the current fill color. The fill color must
79864 * be defined in rgb, cmyk or gray colorspace. The spot color name can be
79865 * an arbitrary name. A spot color can be set as any color with {@link
79866 * ps_setcolor}. When the document is not printed but displayed by an
79867 * postscript viewer the given color in the specified color space is use.
79868 *
79869 * @param resource $psdoc Resource identifier of the postscript file as
79870 *   returned by {@link ps_new}.
79871 * @param string $name Name of the spot color, e.g. Pantone 5565.
79872 * @param int $reserved
79873 * @return int The id of the new spot color or 0 in case of an error.
79874 * @since PECL ps >= 1.1.0
79875 **/
79876function ps_makespotcolor($psdoc, $name, $reserved){}
79877
79878/**
79879 * Sets current point
79880 *
79881 * Sets the current point to new coordinates. If this is the first call
79882 * of {@link ps_moveto} after a previous path has been ended then it will
79883 * start a new path. If this function is called in the middle of a path
79884 * it will just set the current point and start a subpath.
79885 *
79886 * @param resource $psdoc Resource identifier of the postscript file as
79887 *   returned by {@link ps_new}.
79888 * @param float $x x-coordinate of the point to move to.
79889 * @param float $y y-coordinate of the point to move to.
79890 * @return bool
79891 * @since PECL ps >= 1.1.0
79892 **/
79893function ps_moveto($psdoc, $x, $y){}
79894
79895/**
79896 * Creates a new PostScript document object
79897 *
79898 * Creates a new document instance. It does not create the file on disk
79899 * or in memory, it just sets up everything. {@link ps_new} is usually
79900 * followed by a call of {@link ps_open_file} to actually create the
79901 * postscript document.
79902 *
79903 * @return resource Resource of PostScript document. The return value
79904 *   is passed to all other functions as the first argument.
79905 * @since PECL ps >= 1.1.0
79906 **/
79907function ps_new(){}
79908
79909/**
79910 * Opens a file for output
79911 *
79912 * Creates a new file on disk and writes the PostScript document into it.
79913 * The file will be closed when {@link ps_close} is called.
79914 *
79915 * @param resource $psdoc Resource identifier of the postscript file as
79916 *   returned by {@link ps_new}.
79917 * @param string $filename The name of the postscript file. If {@link
79918 *   filename} is not passed the document will be created in memory and
79919 *   all output will go straight to the browser.
79920 * @return bool
79921 * @since PECL ps >= 1.1.0
79922 **/
79923function ps_open_file($psdoc, $filename){}
79924
79925/**
79926 * Reads an image for later placement
79927 *
79928 * Reads an image which is already available in memory. The parameter
79929 * {@link source} is currently not evaluated and assumed to be memory.
79930 * The image data is a sequence of pixels starting in th upper left
79931 * corner and ending in the lower right corner. Each pixel consists of
79932 * {@link components} color components, and each component has {@link
79933 * bpc} bits.
79934 *
79935 * @param resource $psdoc Resource identifier of the postscript file as
79936 *   returned by {@link ps_new}.
79937 * @param string $type The type of the image. Possible values are png,
79938 *   jpeg, or eps.
79939 * @param string $source Not used.
79940 * @param string $data The image data.
79941 * @param int $lenght The length of the image data.
79942 * @param int $width The width of the image.
79943 * @param int $height The height of the image.
79944 * @param int $components The number of components for each pixel. This
79945 *   can be 1 (gray scale images), 3 (rgb images), or 4 (cmyk, rgba
79946 *   images).
79947 * @param int $bpc Number of bits per component (quite often 8).
79948 * @param string $params
79949 * @return int Returns identifier of image or zero in case of an error.
79950 *   The identifier is a positive number greater than 0.
79951 * @since PECL ps >= 1.1.0
79952 **/
79953function ps_open_image($psdoc, $type, $source, $data, $lenght, $width, $height, $components, $bpc, $params){}
79954
79955/**
79956 * Opens image from file
79957 *
79958 * Loads an image for later use.
79959 *
79960 * @param resource $psdoc Resource identifier of the postscript file as
79961 *   returned by {@link ps_new}.
79962 * @param string $type The type of the image. Possible values are png,
79963 *   jpeg, or eps.
79964 * @param string $filename The name of the file containing the image
79965 *   data.
79966 * @param string $stringparam Not used.
79967 * @param int $intparam Not used.
79968 * @return int Returns identifier of image or zero in case of an error.
79969 *   The identifier is a positive number greater than 0.
79970 * @since PECL ps >= 1.1.0
79971 **/
79972function ps_open_image_file($psdoc, $type, $filename, $stringparam, $intparam){}
79973
79974/**
79975 * Takes an GD image and returns an image for placement in a PS document
79976 *
79977 * @param resource $psdoc Resource identifier of the postscript file as
79978 *   returned by {@link ps_new}.
79979 * @param int $gd
79980 * @return int
79981 * @since PECL ps >= 1.1.0
79982 **/
79983function ps_open_memory_image($psdoc, $gd){}
79984
79985/**
79986 * Places image on the page
79987 *
79988 * Places a formerly loaded image on the page. The image can be scaled.
79989 * If the image shall be rotated as well, you will have to rotate the
79990 * coordinate system before with {@link ps_rotate}.
79991 *
79992 * @param resource $psdoc Resource identifier of the postscript file as
79993 *   returned by {@link ps_new}.
79994 * @param int $imageid The resource identifier of the image as returned
79995 *   by {@link ps_open_image} or {@link ps_open_image_file}.
79996 * @param float $x x-coordinate of the lower left corner of the image.
79997 * @param float $y y-coordinate of the lower left corner of the image.
79998 * @param float $scale The scaling factor for the image. A scale of 1.0
79999 *   will result in a resolution of 72 dpi, because each pixel is
80000 *   equivalent to 1 point.
80001 * @return bool
80002 * @since PECL ps >= 1.1.0
80003 **/
80004function ps_place_image($psdoc, $imageid, $x, $y, $scale){}
80005
80006/**
80007 * Draws a rectangle
80008 *
80009 * Draws a rectangle with its lower left corner at ({@link x}, {@link
80010 * y}). The rectangle starts and ends in its lower left corner. If this
80011 * function is called outside a path it will start a new path. If it is
80012 * called within a path it will add the rectangle as a subpath. If the
80013 * last drawing operation does not end in the lower left corner then
80014 * there will be a gap in the path.
80015 *
80016 * @param resource $psdoc Resource identifier of the postscript file as
80017 *   returned by {@link ps_new}.
80018 * @param float $x x-coordinate of the lower left corner of the
80019 *   rectangle.
80020 * @param float $y y-coordinate of the lower left corner of the
80021 *   rectangle.
80022 * @param float $width The width of the image.
80023 * @param float $height The height of the image.
80024 * @return bool
80025 * @since PECL ps >= 1.1.0
80026 **/
80027function ps_rect($psdoc, $x, $y, $width, $height){}
80028
80029/**
80030 * Restore previously save context
80031 *
80032 * Restores a previously saved graphics context. Any call of {@link
80033 * ps_save} must be accompanied by a call to {@link ps_restore}. All
80034 * coordinate transformations, line style settings, color settings, etc.
80035 * are being restored to the state before the call of {@link ps_save}.
80036 *
80037 * @param resource $psdoc Resource identifier of the postscript file as
80038 *   returned by {@link ps_new}.
80039 * @return bool
80040 * @since PECL ps >= 1.1.0
80041 **/
80042function ps_restore($psdoc){}
80043
80044/**
80045 * Sets rotation factor
80046 *
80047 * Sets the rotation of the coordinate system.
80048 *
80049 * @param resource $psdoc Resource identifier of the postscript file as
80050 *   returned by {@link ps_new}.
80051 * @param float $rot Angle of rotation in degree.
80052 * @return bool
80053 * @since PECL ps >= 1.1.0
80054 **/
80055function ps_rotate($psdoc, $rot){}
80056
80057/**
80058 * Save current context
80059 *
80060 * Saves the current graphics context, containing colors, translation and
80061 * rotation settings and some more. A saved context can be restored with
80062 * {@link ps_restore}.
80063 *
80064 * @param resource $psdoc Resource identifier of the postscript file as
80065 *   returned by {@link ps_new}.
80066 * @return bool
80067 * @since PECL ps >= 1.1.0
80068 **/
80069function ps_save($psdoc){}
80070
80071/**
80072 * Sets scaling factor
80073 *
80074 * Sets horizontal and vertical scaling of the coordinate system.
80075 *
80076 * @param resource $psdoc Resource identifier of the postscript file as
80077 *   returned by {@link ps_new}.
80078 * @param float $x Scaling factor in horizontal direction.
80079 * @param float $y Scaling factor in vertical direction.
80080 * @return bool
80081 * @since PECL ps >= 1.1.0
80082 **/
80083function ps_scale($psdoc, $x, $y){}
80084
80085/**
80086 * Sets current color
80087 *
80088 * Sets the color for drawing, filling, or both.
80089 *
80090 * @param resource $psdoc Resource identifier of the postscript file as
80091 *   returned by {@link ps_new}.
80092 * @param string $type The parameter {@link type} can be both, fill, or
80093 *   fillstroke.
80094 * @param string $colorspace The colorspace should be one of gray, rgb,
80095 *   cmyk, spot, pattern. Depending on the colorspace either only the
80096 *   first, the first three or all parameters will be used.
80097 * @param float $c1 Depending on the colorspace this is either the red
80098 *   component (rgb), the cyan component (cmyk), the gray value (gray),
80099 *   the identifier of the spot color or the identifier of the pattern.
80100 * @param float $c2 Depending on the colorspace this is either the
80101 *   green component (rgb), the magenta component (cmyk).
80102 * @param float $c3 Depending on the colorspace this is either the blue
80103 *   component (rgb), the yellow component (cmyk).
80104 * @param float $c4 This must only be set in cmyk colorspace and
80105 *   specifies the black component.
80106 * @return bool
80107 * @since PECL ps >= 1.1.0
80108 **/
80109function ps_setcolor($psdoc, $type, $colorspace, $c1, $c2, $c3, $c4){}
80110
80111/**
80112 * Sets appearance of a dashed line
80113 *
80114 * Sets the length of the black and white portions of a dashed line.
80115 *
80116 * @param resource $psdoc Resource identifier of the postscript file as
80117 *   returned by {@link ps_new}.
80118 * @param float $on The length of the dash.
80119 * @param float $off The length of the gap between dashes.
80120 * @return bool
80121 * @since PECL ps >= 1.1.0
80122 **/
80123function ps_setdash($psdoc, $on, $off){}
80124
80125/**
80126 * Sets flatness
80127 *
80128 * @param resource $psdoc Resource identifier of the postscript file as
80129 *   returned by {@link ps_new}.
80130 * @param float $value The {@link value} must be between 0.2 and 1.
80131 * @return bool
80132 * @since PECL ps >= 1.1.0
80133 **/
80134function ps_setflat($psdoc, $value){}
80135
80136/**
80137 * Sets font to use for following output
80138 *
80139 * Sets a font, which has to be loaded before with {@link ps_findfont}.
80140 * Outputting text without setting a font results in an error.
80141 *
80142 * @param resource $psdoc Resource identifier of the postscript file as
80143 *   returned by {@link ps_new}.
80144 * @param int $fontid The font identifier as returned by {@link
80145 *   ps_findfont}.
80146 * @param float $size The size of the font.
80147 * @return bool
80148 * @since PECL ps >= 1.1.0
80149 **/
80150function ps_setfont($psdoc, $fontid, $size){}
80151
80152/**
80153 * Sets gray value
80154 *
80155 * Sets the gray value for all following drawing operations.
80156 *
80157 * @param resource $psdoc Resource identifier of the postscript file as
80158 *   returned by {@link ps_new}.
80159 * @param float $gray The value must be between 0 (white) and 1
80160 *   (black).
80161 * @return bool
80162 * @since PECL ps >= 1.1.0
80163 **/
80164function ps_setgray($psdoc, $gray){}
80165
80166/**
80167 * Sets appearance of line ends
80168 *
80169 * Sets how line ends look like.
80170 *
80171 * @param resource $psdoc Resource identifier of the postscript file as
80172 *   returned by {@link ps_new}.
80173 * @param int $type The type of line ends. Possible values are
80174 *   PS_LINECAP_BUTT, PS_LINECAP_ROUND, or PS_LINECAP_SQUARED.
80175 * @return bool
80176 * @since PECL ps >= 1.1.0
80177 **/
80178function ps_setlinecap($psdoc, $type){}
80179
80180/**
80181 * Sets how contected lines are joined
80182 *
80183 * Sets how lines are joined.
80184 *
80185 * @param resource $psdoc Resource identifier of the postscript file as
80186 *   returned by {@link ps_new}.
80187 * @param int $type The way lines are joined. Possible values are
80188 *   PS_LINEJOIN_MITER, PS_LINEJOIN_ROUND, or PS_LINEJOIN_BEVEL.
80189 * @return bool
80190 * @since PECL ps >= 1.1.0
80191 **/
80192function ps_setlinejoin($psdoc, $type){}
80193
80194/**
80195 * Sets width of a line
80196 *
80197 * Sets the line width for all following drawing operations.
80198 *
80199 * @param resource $psdoc Resource identifier of the postscript file as
80200 *   returned by {@link ps_new}.
80201 * @param float $width The width of lines in points.
80202 * @return bool
80203 * @since PECL ps >= 1.1.0
80204 **/
80205function ps_setlinewidth($psdoc, $width){}
80206
80207/**
80208 * Sets the miter limit
80209 *
80210 * If two lines join in a small angle and the line join is set to
80211 * PS_LINEJOIN_MITER, then the resulting spike will be very long. The
80212 * miter limit is the maximum ratio of the miter length (the length of
80213 * the spike) and the line width.
80214 *
80215 * @param resource $psdoc Resource identifier of the postscript file as
80216 *   returned by {@link ps_new}.
80217 * @param float $value The maximum ratio between the miter length and
80218 *   the line width. Larger values (> 10) will result in very long spikes
80219 *   when two lines meet in a small angle. Keep the default unless you
80220 *   know what you are doing.
80221 * @return bool
80222 * @since PECL ps >= 1.1.0
80223 **/
80224function ps_setmiterlimit($psdoc, $value){}
80225
80226/**
80227 * Sets overprint mode
80228 *
80229 * @param resource $psdoc Resource identifier of the postscript file as
80230 *   returned by {@link ps_new}.
80231 * @param int $mode
80232 * @return bool
80233 * @since PECL ps >= 1.3.0
80234 **/
80235function ps_setoverprintmode($psdoc, $mode){}
80236
80237/**
80238 * Sets appearance of a dashed line
80239 *
80240 * Sets the length of the black and white portions of a dashed line.
80241 * {@link ps_setpolydash} is used to set more complicated dash patterns.
80242 *
80243 * @param resource $psdoc Resource identifier of the postscript file as
80244 *   returned by {@link ps_new}.
80245 * @param float $arr {@link arr} is a list of length elements
80246 *   alternately for the black and white portion.
80247 * @return bool
80248 * @since PECL ps >= 1.1.0
80249 **/
80250function ps_setpolydash($psdoc, $arr){}
80251
80252/**
80253 * Sets color of border for annotations
80254 *
80255 * Links added with one of the functions {@link ps_add_weblink}, {@link
80256 * ps_add_pdflink}, etc. will be displayed with a surounded rectangle
80257 * when the postscript document is converted to pdf and viewed in a pdf
80258 * viewer. This rectangle is not visible in the postscript document. This
80259 * function sets the color of the rectangle's border line.
80260 *
80261 * @param resource $psdoc Resource identifier of the postscript file as
80262 *   returned by {@link ps_new}.
80263 * @param float $red The red component of the border color.
80264 * @param float $green The green component of the border color.
80265 * @param float $blue The blue component of the border color.
80266 * @return bool
80267 * @since PECL ps >= 1.1.0
80268 **/
80269function ps_set_border_color($psdoc, $red, $green, $blue){}
80270
80271/**
80272 * Sets length of dashes for border of annotations
80273 *
80274 * Links added with one of the functions {@link ps_add_weblink}, {@link
80275 * ps_add_pdflink}, etc. will be displayed with a surounded rectangle
80276 * when the postscript document is converted to pdf and viewed in a pdf
80277 * viewer. This rectangle is not visible in the postscript document. This
80278 * function sets the length of the black and white portion of a dashed
80279 * border line.
80280 *
80281 * @param resource $psdoc Resource identifier of the postscript file as
80282 *   returned by {@link ps_new}.
80283 * @param float $black The length of the dash.
80284 * @param float $white The length of the gap between dashes.
80285 * @return bool
80286 * @since PECL ps >= 1.1.0
80287 **/
80288function ps_set_border_dash($psdoc, $black, $white){}
80289
80290/**
80291 * Sets border style of annotations
80292 *
80293 * Links added with one of the functions {@link ps_add_weblink}, {@link
80294 * ps_add_pdflink}, etc. will be displayed with a surounded rectangle
80295 * when the postscript document is converted to pdf and viewed in a pdf
80296 * viewer. This rectangle is not visible in the postscript document. This
80297 * function sets the appearance and width of the border line.
80298 *
80299 * @param resource $psdoc Resource identifier of the postscript file as
80300 *   returned by {@link ps_new}.
80301 * @param string $style {@link style} can be solid or dashed.
80302 * @param float $width The line width of the border.
80303 * @return bool
80304 * @since PECL ps >= 1.1.0
80305 **/
80306function ps_set_border_style($psdoc, $style, $width){}
80307
80308/**
80309 * Sets information fields of document
80310 *
80311 * Sets certain information fields of the document. This fields will be
80312 * shown as a comment in the header of the PostScript file. If the
80313 * document is converted to pdf this fields will also be used for the
80314 * document information.
80315 *
80316 * The BoundingBox is usually set to the value given to the first page.
80317 * This only works if {@link ps_findfont} has not been called before. In
80318 * such cases the BoundingBox would be left unset unless you set it
80319 * explicitly with this function.
80320 *
80321 * This function will have no effect anymore when the header of the
80322 * postscript file has been already written. It must be called before the
80323 * first page or the first call of {@link ps_findfont}.
80324 *
80325 * @param resource $p Resource identifier of the postscript file as
80326 *   returned by {@link ps_new}.
80327 * @param string $key The name of the information field to set. The
80328 *   values which can be set are Keywords, Subject, Title, Creator,
80329 *   Author, BoundingBox, and Orientation. Be aware that some of them has
80330 *   a meaning to PostScript viewers.
80331 * @param string $val The value of the information field. The field
80332 *   Orientation can be set to either Portrait or Landscape. The
80333 *   BoundingBox is a string consisting of four numbers. The first two
80334 *   numbers are the coordinates of the lower left corner of the page.
80335 *   The last two numbers are the coordinates of the upper right corner.
80336 * @return bool
80337 * @since PECL ps >= 1.1.0
80338 **/
80339function ps_set_info($p, $key, $val){}
80340
80341/**
80342 * Sets certain parameters
80343 *
80344 * Sets several parameters which are used by many functions. Parameters
80345 * are by definition string values.
80346 *
80347 * @param resource $psdoc Resource identifier of the postscript file as
80348 *   returned by {@link ps_new}.
80349 * @param string $name For a list of possible names see {@link
80350 *   ps_get_parameter}.
80351 * @param string $value The value of the parameter.
80352 * @return bool
80353 * @since PECL ps >= 1.1.0
80354 **/
80355function ps_set_parameter($psdoc, $name, $value){}
80356
80357/**
80358 * Sets position for text output
80359 *
80360 * Set the position for the next text output. You may alternatively set
80361 * the x and y value separately by calling {@link ps_set_value} and
80362 * choosing textx respectively texty as the value name.
80363 *
80364 * If you want to output text at a certain position it is more convenient
80365 * to use {@link ps_show_xy} instead of setting the text position and
80366 * calling {@link ps_show}.
80367 *
80368 * @param resource $psdoc Resource identifier of the postscript file as
80369 *   returned by {@link ps_new}.
80370 * @param float $x x-coordinate of the new text position.
80371 * @param float $y y-coordinate of the new text position.
80372 * @return bool
80373 * @since PECL ps >= 1.1.0
80374 **/
80375function ps_set_text_pos($psdoc, $x, $y){}
80376
80377/**
80378 * Sets certain values
80379 *
80380 * Sets several values which are used by many functions. Parameters are
80381 * by definition float values.
80382 *
80383 * @param resource $psdoc Resource identifier of the postscript file as
80384 *   returned by {@link ps_new}.
80385 * @param string $name The {@link name} can be one of the following:
80386 *   textrendering The way how text is shown. textx The x coordinate for
80387 *   text output. texty The y coordinate for text output. wordspacing The
80388 *   distance between words relative to the width of a space. leading The
80389 *   distance between lines in pixels.
80390 * @param float $value The way how text is shown.
80391 * @return bool
80392 * @since PECL ps >= 1.1.0
80393 **/
80394function ps_set_value($psdoc, $name, $value){}
80395
80396/**
80397 * Creates a shading for later use
80398 *
80399 * Creates a shading, which can be used by {@link ps_shfill} or {@link
80400 * ps_shading_pattern}.
80401 *
80402 * The color of the shading can be in any color space except for pattern.
80403 *
80404 * @param resource $psdoc Resource identifier of the postscript file as
80405 *   returned by {@link ps_new}.
80406 * @param string $type The type of shading can be either radial or
80407 *   axial. Each shading starts with the current fill color and ends with
80408 *   the given color values passed in the parameters {@link c1} to {@link
80409 *   c4} (see {@link ps_setcolor} for their meaning).
80410 * @param float $x0 The coordinates {@link x0}, {@link y0}, {@link x1},
80411 *   {@link y1} are the start and end point of the shading. If the type
80412 *   of shading is radial the two points are the middle points of a
80413 *   starting and ending circle.
80414 * @param float $y0 See {@link ps_setcolor} for their meaning.
80415 * @param float $x1 If the shading is of type radial the {@link
80416 *   optlist} must also contain the parameters r0 and r1 with the radius
80417 *   of the start and end circle.
80418 * @param float $y1
80419 * @param float $c1
80420 * @param float $c2
80421 * @param float $c3
80422 * @param float $c4
80423 * @param string $optlist
80424 * @return int Returns the identifier of the pattern .
80425 * @since PECL ps >= 1.3.0
80426 **/
80427function ps_shading($psdoc, $type, $x0, $y0, $x1, $y1, $c1, $c2, $c3, $c4, $optlist){}
80428
80429/**
80430 * Creates a pattern based on a shading
80431 *
80432 * Creates a pattern based on a shading, which has to be created before
80433 * with {@link ps_shading}. Shading patterns can be used like regular
80434 * patterns.
80435 *
80436 * @param resource $psdoc Resource identifier of the postscript file as
80437 *   returned by {@link ps_new}.
80438 * @param int $shadingid The identifier of a shading previously created
80439 *   with {@link ps_shading}.
80440 * @param string $optlist This argument is not currently used.
80441 * @return int The identifier of the pattern .
80442 * @since PECL ps >= 1.3.0
80443 **/
80444function ps_shading_pattern($psdoc, $shadingid, $optlist){}
80445
80446/**
80447 * Fills an area with a shading
80448 *
80449 * Fills an area with a shading, which has to be created before with
80450 * {@link ps_shading}. This is an alternative way to creating a pattern
80451 * from a shading {@link ps_shading_pattern} and using the pattern as the
80452 * filling color.
80453 *
80454 * @param resource $psdoc Resource identifier of the postscript file as
80455 *   returned by {@link ps_new}.
80456 * @param int $shadingid The identifier of a shading previously created
80457 *   with {@link ps_shading}.
80458 * @return bool
80459 * @since PECL ps >= 1.3.0
80460 **/
80461function ps_shfill($psdoc, $shadingid){}
80462
80463/**
80464 * Output text
80465 *
80466 * Output a text at the current text position. The text position can be
80467 * set by storing the x and y coordinates into the values textx and texty
80468 * with the function {@link ps_set_value}. The function will issue an
80469 * error if a font was not set before with {@link ps_setfont}.
80470 *
80471 * {@link ps_show} evaluates the following parameters and values as set
80472 * by {@link ps_set_parameter} and {@link ps_set_value}.
80473 *
80474 * @param resource $psdoc Resource identifier of the postscript file as
80475 *   returned by {@link ps_new}.
80476 * @param string $text The text to be output.
80477 * @return bool
80478 * @since PECL ps >= 1.1.0
80479 **/
80480function ps_show($psdoc, $text){}
80481
80482/**
80483 * Output a text at current position
80484 *
80485 * Output text at the current position. Do not print more than {@link
80486 * len} characters.
80487 *
80488 * @param resource $psdoc Resource identifier of the postscript file as
80489 *   returned by {@link ps_new}.
80490 * @param string $text The text to be output.
80491 * @param int $len The maximum number of characters to print.
80492 * @return bool
80493 * @since PECL ps >= 1.1.0
80494 **/
80495function ps_show2($psdoc, $text, $len){}
80496
80497/**
80498 * Output text in a box
80499 *
80500 * Outputs a text in a given box. The lower left corner of the box is at
80501 * ({@link left}, {@link bottom}). Line breaks will be inserted where
80502 * needed. Multiple spaces are treated as one. Tabulators are treated as
80503 * spaces.
80504 *
80505 * The text will be hyphenated if the parameter {@link hyphenation} is
80506 * set to TRUE and the parameter {@link hyphendict} contains a valid
80507 * filename for a hyphenation file. The line spacing is taken from the
80508 * value leading. Paragraphs can be separated by an empty line just like
80509 * in TeX. If the value parindent is set to value > 0.0 then the first n
80510 * lines will be indented. The number n of lines is set by the parameter
80511 * numindentlines. In order to prevent indenting of the first m
80512 * paragraphs set the value parindentskip to a positive number.
80513 *
80514 * @param resource $psdoc Resource identifier of the postscript file as
80515 *   returned by {@link ps_new}.
80516 * @param string $text The text to be output into the given box.
80517 * @param float $left x-coordinate of the lower left corner of the box.
80518 * @param float $bottom y-coordinate of the lower left corner of the
80519 *   box.
80520 * @param float $width Width of the box.
80521 * @param float $height Height of the box.
80522 * @param string $hmode The parameter {@link hmode} can be "justify",
80523 *   "fulljustify", "right", "left", or "center". The difference of
80524 *   "justify" and "fulljustify" just affects the last line of the box.
80525 *   In fulljustify mode the last line will be left and right justified
80526 *   unless this is also the last line of paragraph. In justify mode it
80527 *   will always be left justified.
80528 * @param string $feature
80529 * @return int Number of characters that could not be written.
80530 * @since PECL ps >= 1.1.0
80531 **/
80532function ps_show_boxed($psdoc, $text, $left, $bottom, $width, $height, $hmode, $feature){}
80533
80534/**
80535 * Output text at given position
80536 *
80537 * Output a text at the given text position.
80538 *
80539 * @param resource $psdoc Resource identifier of the postscript file as
80540 *   returned by {@link ps_new}.
80541 * @param string $text The text to be output.
80542 * @param float $x x-coordinate of the lower left corner of the box
80543 *   surrounding the text.
80544 * @param float $y y-coordinate of the lower left corner of the box
80545 *   surrounding the text.
80546 * @return bool
80547 * @since PECL ps >= 1.1.0
80548 **/
80549function ps_show_xy($psdoc, $text, $x, $y){}
80550
80551/**
80552 * Output text at position
80553 *
80554 * @param resource $psdoc
80555 * @param string $text
80556 * @param int $len
80557 * @param float $xcoor
80558 * @param float $ycoor
80559 * @return bool
80560 * @since PECL ps >= 1.1.0
80561 **/
80562function ps_show_xy2($psdoc, $text, $len, $xcoor, $ycoor){}
80563
80564/**
80565 * Gets width of a string
80566 *
80567 * Calculates the width of a string in points if it was output in the
80568 * given font and font size. This function needs an Adobe font metrics
80569 * file to calculate the precise width. If kerning is turned on, it will
80570 * be taken into account.
80571 *
80572 * @param resource $psdoc Resource identifier of the postscript file as
80573 *   returned by {@link ps_new}.
80574 * @param string $text The text for which the width is to be
80575 *   calculated.
80576 * @param int $fontid The identifier of the font to be used. If not
80577 *   font is specified the current font will be used.
80578 * @param float $size The size of the font. If no size is specified the
80579 *   current size is used.
80580 * @return float Width of a string in points.
80581 * @since PECL ps >= 1.1.0
80582 **/
80583function ps_stringwidth($psdoc, $text, $fontid, $size){}
80584
80585/**
80586 * Gets geometry of a string
80587 *
80588 * This function is similar to {@link ps_stringwidth} but returns an
80589 * array of dimensions containing the width, ascender, and descender of
80590 * the text.
80591 *
80592 * @param resource $psdoc Resource identifier of the postscript file as
80593 *   returned by {@link ps_new}.
80594 * @param string $text The text for which the geometry is to be
80595 *   calculated.
80596 * @param int $fontid The identifier of the font to be used. If not
80597 *   font is specified the current font will be used.
80598 * @param float $size The size of the font. If no size is specified the
80599 *   current size is used.
80600 * @return array An array of the dimensions of a string. The element
80601 *   'width' contains the width of the string as returned by {@link
80602 *   ps_stringwidth}. The element 'descender' contains the maximum
80603 *   descender and 'ascender' the maximum ascender of the string.
80604 * @since PECL ps >= 1.2.0
80605 **/
80606function ps_string_geometry($psdoc, $text, $fontid, $size){}
80607
80608/**
80609 * Draws the current path
80610 *
80611 * Draws the path constructed with previously called drawing functions
80612 * like {@link ps_lineto}.
80613 *
80614 * @param resource $psdoc Resource identifier of the postscript file as
80615 *   returned by {@link ps_new}.
80616 * @return bool
80617 * @since PECL ps >= 1.1.0
80618 **/
80619function ps_stroke($psdoc){}
80620
80621/**
80622 * Output a glyph
80623 *
80624 * Output the glyph at position {@link ord} in the font encoding vector
80625 * of the current font. The font encoding for a font can be set when
80626 * loading the font with {@link ps_findfont}.
80627 *
80628 * @param resource $psdoc Resource identifier of the postscript file as
80629 *   returned by {@link ps_new}.
80630 * @param int $ord The position of the glyph in the font encoding
80631 *   vector.
80632 * @return bool
80633 * @since PECL ps >= 1.2.0
80634 **/
80635function ps_symbol($psdoc, $ord){}
80636
80637/**
80638 * Gets name of a glyph
80639 *
80640 * This function needs an Adobe font metrics file to know which glyphs
80641 * are available.
80642 *
80643 * @param resource $psdoc Resource identifier of the postscript file as
80644 *   returned by {@link ps_new}.
80645 * @param int $ord The parameter {@link ord} is the position of the
80646 *   glyph in the font encoding vector.
80647 * @param int $fontid The identifier of the font to be used. If not
80648 *   font is specified the current font will be used.
80649 * @return string The name of a glyph in the given font.
80650 * @since PECL ps >= 1.2.0
80651 **/
80652function ps_symbol_name($psdoc, $ord, $fontid){}
80653
80654/**
80655 * Gets width of a glyph
80656 *
80657 * Calculates the width of a glyph in points if it was output in the
80658 * given font and font size. This function needs an Adobe font metrics
80659 * file to calculate the precise width.
80660 *
80661 * @param resource $psdoc Resource identifier of the postscript file as
80662 *   returned by {@link ps_new}.
80663 * @param int $ord The position of the glyph in the font encoding
80664 *   vector.
80665 * @param int $fontid The identifier of the font to be used. If not
80666 *   font is specified the current font will be used.
80667 * @param float $size The size of the font. If no size is specified the
80668 *   current size is used.
80669 * @return float The width of a glyph in points.
80670 * @since PECL ps >= 1.2.0
80671 **/
80672function ps_symbol_width($psdoc, $ord, $fontid, $size){}
80673
80674/**
80675 * Sets translation
80676 *
80677 * Sets a new initial point of the coordinate system.
80678 *
80679 * @param resource $psdoc Resource identifier of the postscript file as
80680 *   returned by {@link ps_new}.
80681 * @param float $x x-coordinate of the origin of the translated
80682 *   coordinate system.
80683 * @param float $y y-coordinate of the origin of the translated
80684 *   coordinate system.
80685 * @return bool
80686 * @since PECL ps >= 1.1.0
80687 **/
80688function ps_translate($psdoc, $x, $y){}
80689
80690/**
80691 * Sets the value of an environment variable
80692 *
80693 * Adds {@link setting} to the server environment. The environment
80694 * variable will only exist for the duration of the current request. At
80695 * the end of the request the environment is restored to its original
80696 * state.
80697 *
80698 * Setting certain environment variables may be a potential security
80699 * breach. The safe_mode_allowed_env_vars directive contains a
80700 * comma-delimited list of prefixes. In Safe Mode, the user may only
80701 * alter environment variables whose names begin with the prefixes
80702 * supplied by this directive. By default, users will only be able to set
80703 * environment variables that begin with PHP_ (e.g. PHP_FOO=BAR). Note:
80704 * if this directive is empty, PHP will let the user modify ANY
80705 * environment variable!
80706 *
80707 * The safe_mode_protected_env_vars directive contains a comma-delimited
80708 * list of environment variables, that the end user won't be able to
80709 * change using {@link putenv}. These variables will be protected even if
80710 * safe_mode_allowed_env_vars is set to allow to change them.
80711 *
80712 * @param string $setting The setting, like "FOO=BAR"
80713 * @return bool
80714 * @since PHP 4, PHP 5, PHP 7
80715 **/
80716function putenv($setting){}
80717
80718/**
80719 * Closes a paradox database
80720 *
80721 * Closes the paradox database. This function will not close the file.
80722 * You will have to call {@link fclose} afterwards.
80723 *
80724 * @param resource $pxdoc Resource identifier of the paradox database
80725 *   as returned by {@link px_new}.
80726 * @return bool
80727 * @since PECL paradox >= 1.0.0
80728 **/
80729function px_close($pxdoc){}
80730
80731/**
80732 * Create a new paradox database
80733 *
80734 * Create a new paradox database file. The actual file has to be opened
80735 * before with {@link fopen}. Make sure the file is writable.
80736 *
80737 * @param resource $pxdoc Resource identifier of the paradox database
80738 *   as returned by {@link px_new}.
80739 * @param resource $file File handle as returned by {@link fopen}.
80740 * @param array $fielddesc fielddesc is an array containing one element
80741 *   for each field specification. A field specification is an array
80742 *   itself with either two or three elements.The first element is always
80743 *   a string value used as the name of the field. It may not be larger
80744 *   than ten characters. The second element contains the field type
80745 *   which is one of the constants listed in the table Constants for
80746 *   field types. In the case of a character field or bcd field, you will
80747 *   have to provide a third element specifying the length respectively
80748 *   the precesion of the field. If your field specification contains
80749 *   blob fields, you will have to make sure to either make the field
80750 *   large enough for all field values to fit or specify a blob file with
80751 *   {@link px_set_blob_file} for storing the blobs. If this is not done
80752 *   the field data is truncated.
80753 * @return bool
80754 * @since PECL paradox >= 1.0.0
80755 **/
80756function px_create_fp($pxdoc, $file, $fielddesc){}
80757
80758/**
80759 * Converts a date into a string
80760 *
80761 * Turns a date as it stored in the paradox file into human readable
80762 * format. Paradox dates are the number of days since 1.1.0000. This
80763 * function is just for convenience. It can be easily replaced by some
80764 * math and the calendar functions as demonstrated in the example below.
80765 *
80766 * @param resource $pxdoc Resource identifier of the paradox database
80767 *   as returned by {@link px_new}.
80768 * @param int $value Value as stored in paradox database field of type
80769 *   PX_FIELD_DATE.
80770 * @param string $format String format similar to the format used by
80771 *   {@link date}. The placeholders support by this function is a subset
80772 *   of those supported by {@link date} (Y, y, m, n, d, j, L).
80773 * @return string
80774 * @since PECL paradox >= 1.4.0
80775 **/
80776function px_date2string($pxdoc, $value, $format){}
80777
80778/**
80779 * Deletes resource of paradox database
80780 *
80781 * Deletes the resource of the paradox file and frees all memory.
80782 *
80783 * @param resource $pxdoc Resource identifier of the paradox database
80784 *   as returned by {@link px_new}.
80785 * @return bool
80786 * @since PECL paradox >= 1.0.0
80787 **/
80788function px_delete($pxdoc){}
80789
80790/**
80791 * Deletes record from paradox database
80792 *
80793 * This function deletes a record from the database. It does not free the
80794 * space in the database file but just marks it as deleted. Inserting a
80795 * new record afterwards will reuse the space.
80796 *
80797 * @param resource $pxdoc Resource identifier of the paradox database
80798 *   as returned by {@link px_new}.
80799 * @param int $num The record number is an artificial number counting
80800 *   records in the order as they are stored in the database. The first
80801 *   record has number 0.
80802 * @return bool
80803 * @since PECL paradox >= 1.4.0
80804 **/
80805function px_delete_record($pxdoc, $num){}
80806
80807/**
80808 * Returns the specification of a single field
80809 *
80810 * @param resource $pxdoc Resource identifier of the paradox database
80811 *   as returned by {@link px_new}.
80812 * @param int $fieldno Number of the field. The first field has number
80813 *   0. Specifying a field number less than 0 and greater or equal the
80814 *   number of fields will trigger an error.
80815 * @return array Returns the specification of the fieldnoth database
80816 *   field as an associated array. The array contains three fields named
80817 *   name, type, and size.
80818 * @since PECL paradox >= 1.0.0
80819 **/
80820function px_get_field($pxdoc, $fieldno){}
80821
80822/**
80823 * Return lots of information about a paradox file
80824 *
80825 * @param resource $pxdoc Resource identifier of the paradox database
80826 *   as returned by {@link px_new}.
80827 * @return array Returns an associated array with lots of information
80828 *   about a paradox file. This array is likely to be extended in the
80829 *   future.
80830 * @since PECL paradox >= 1.0.0
80831 **/
80832function px_get_info($pxdoc){}
80833
80834/**
80835 * Gets a parameter
80836 *
80837 * Gets various parameters.
80838 *
80839 * @param resource $pxdoc Resource identifier of the paradox database
80840 *   as returned by {@link px_new}.
80841 * @param string $name The {@link name} can be one of the following:
80842 * @return string Returns the value of the parameter.
80843 * @since PECL paradox >= 1.1.0
80844 **/
80845function px_get_parameter($pxdoc, $name){}
80846
80847/**
80848 * Returns record of paradox database
80849 *
80850 * @param resource $pxdoc Resource identifier of the paradox database
80851 *   as returned by {@link px_new}.
80852 * @param int $num The record number is an artificial number counting
80853 *   records in the order as they are stored in the database. The first
80854 *   record has number 0.
80855 * @param int $mode The optional {@link mode} can be PX_KEYTOLOWER or
80856 *   PX_KEYTOUPPER in order to convert the keys of the returned array
80857 *   into lower or upper case. If {@link mode} is not passed or is 0,
80858 *   then the key will be exactly like the field name. The element values
80859 *   will contain the field values. NULL values will be retained and are
80860 *   different from 0.0, 0 or the empty string. Fields of type
80861 *   PX_FIELD_TIME will be returned as an integer counting the number of
80862 *   milliseconds starting at midnight. A timestamp (PX_FIELD_TIMESTAMP)
80863 *   and date (PX_FIELD_DATE) are floating point respectively int values
80864 *   counting milliseconds respectively days starting at the beginning of
80865 *   julian calendar. Use the functions {@link px-timestamp2string} and
80866 *   {@link px-date2string} to convert them into a character
80867 *   representation.
80868 * @return array Returns the {@link num}th record from the paradox
80869 *   database. The record is returned as an associated array with its
80870 *   keys being the field names.
80871 * @since PECL paradox >= 1.0.0
80872 **/
80873function px_get_record($pxdoc, $num, $mode){}
80874
80875/**
80876 * Returns the database schema
80877 *
80878 * {@link px_get_schema} returns the database schema.
80879 *
80880 * @param resource $pxdoc Resource identifier of the paradox database
80881 *   as returned by {@link px_new}.
80882 * @param int $mode If the optional {@link mode} is PX_KEYTOLOWER or
80883 *   PX_KEYTOUPPER the keys of the returned array will be converted to
80884 *   lower or upper case. If {@link mode} is 0 or not passed at all, then
80885 *   the key name will be identical to the field name.
80886 * @return array Returns the schema of a database file as an associated
80887 *   array. The key name is equal to the field name. Each array element
80888 *   is itself an associated array containing the two fields type and
80889 *   size. type is one of the constants in table Constants for field
80890 *   types. size is the number of bytes this field consumes in the
80891 *   record. The total of all field sizes is equal to the record size as
80892 *   it can be retrieved with {@link px-get-info}.
80893 * @since PECL paradox >= 1.0.0
80894 **/
80895function px_get_schema($pxdoc, $mode){}
80896
80897/**
80898 * Gets a value
80899 *
80900 * Gets various values.
80901 *
80902 * @param resource $pxdoc Resource identifier of the paradox database
80903 *   as returned by {@link px_new}.
80904 * @param string $name {@link name} can be one of the following.
80905 *   numprimkeys The number of primary keys. Paradox databases always use
80906 *   the first numprimkeys fields for the primary index.
80907 * @return float Returns the value of the parameter.
80908 * @since PECL paradox >= 1.1.0
80909 **/
80910function px_get_value($pxdoc, $name){}
80911
80912/**
80913 * Inserts record into paradox database
80914 *
80915 * Inserts a new record into the database. The record is not necessarily
80916 * inserted at the end of the database, but may be inserted at any
80917 * position depending on where the first free slot is found.
80918 *
80919 * The record data is passed as an array of field values. The elements in
80920 * the array must correspond to the fields in the database. If the array
80921 * has less elements than fields in the database, the remaining fields
80922 * will be set to null.
80923 *
80924 * Most field values can be passed as its equivalent php type e.g. a long
80925 * value is used for fields of type PX_FIELD_LONG, PX_FIELD_SHORT and
80926 * PX_FIELD_AUTOINC, a double values is used for fields of type
80927 * PX_FIELD_CURRENCY and PX_FIELD_NUMBER. Field values for blob and alpha
80928 * fields are passed as strings.
80929 *
80930 * Fields of type PX_FIELD_TIME and PX_FIELD_DATE both require a long
80931 * value. In the first case this is the number of milliseconds since
80932 * midnight. In the second case this is the number of days since
80933 * 1.1.0000. Below there are two examples to convert the current date or
80934 * timestamp into a value suitable for one of paradox's date/time fields.
80935 *
80936 * @param resource $pxdoc Resource identifier of the paradox database
80937 *   as returned by {@link px_new}.
80938 * @param array $data Associated or indexed array containing the field
80939 *   values as e.g. returned by {@link px_retrieve_record}.
80940 * @return int Returns FALSE on failure or the record number in case of
80941 *   success.
80942 * @since PECL paradox >= 1.4.0
80943 **/
80944function px_insert_record($pxdoc, $data){}
80945
80946/**
80947 * Create a new paradox object
80948 *
80949 * Create a new paradox object. You will have to call this function
80950 * before any further functions. {@link px_new} does not create any file
80951 * on the disk, it just creates an instance of a paradox object. This
80952 * function must not be called if the object oriented interface is used.
80953 * Use new paradox_db() instead.
80954 *
80955 * @return resource Returns FALSE on failure.
80956 * @since PECL paradox >= 1.0.0
80957 **/
80958function px_new(){}
80959
80960/**
80961 * Returns number of fields in a database
80962 *
80963 * Get the number of fields in a database file.
80964 *
80965 * @param resource $pxdoc Resource identifier of the paradox database
80966 *   as returned by {@link px_new}.
80967 * @return int Returns the number of fields in a database file. The
80968 *   return value of this function is identical to the element numfields
80969 *   in the array returned by {@link px_get_info}.
80970 * @since PECL paradox >= 1.0.0
80971 **/
80972function px_numfields($pxdoc){}
80973
80974/**
80975 * Returns number of records in a database
80976 *
80977 * Get the number of records in a database file.
80978 *
80979 * @param resource $pxdoc Resource identifier of the paradox database
80980 *   as returned by {@link px_new}.
80981 * @return int Returns the number of records in a database file. The
80982 *   return value of this function is identical to the element numrecords
80983 *   in the array returned by {@link px_get_info}.
80984 * @since PECL paradox >= 1.0.0
80985 **/
80986function px_numrecords($pxdoc){}
80987
80988/**
80989 * Open paradox database
80990 *
80991 * Open an existing paradox database file. The actual file has to be
80992 * opened before with {@link fopen}. This function can also be used to
80993 * open primary index files and tread them like a paradox database. This
80994 * is supported for those who would like to investigate a primary index.
80995 * It cannot be used to accelerate access to a database file.
80996 *
80997 * @param resource $pxdoc Resource identifier of the paradox database
80998 *   as returned by {@link px_new}.
80999 * @param resource $file {@link file} is the return value from {@link
81000 *   fopen} with the actual database file as parameter. Make sure the
81001 *   database is writable if you plan to update or insert records.
81002 * @return bool
81003 * @since PECL paradox >= 1.0.0
81004 **/
81005function px_open_fp($pxdoc, $file){}
81006
81007/**
81008 * Stores record into paradox database
81009 *
81010 * Stores a record into a paradox database. The record is always added at
81011 * the end of the database, regardless of any free slots. Use {@link
81012 * px_insert_record} to add a new record into the first free slot found
81013 * in the database.
81014 *
81015 * @param resource $pxdoc Resource identifier of the paradox database
81016 *   as returned by {@link px_new}.
81017 * @param array $record Associated or indexed array containing the
81018 *   field values as e.g. returned by {@link px_retrieve_record}.
81019 * @param int $recpos This optional parameter may be used to specify a
81020 *   record number greater than the current number of records in the
81021 *   database. The function will add as many empty records as needed.
81022 *   There is hardly any need for this parameter.
81023 * @return bool
81024 * @since PECL paradox >= 1.0.0
81025 **/
81026function px_put_record($pxdoc, $record, $recpos){}
81027
81028/**
81029 * Returns record of paradox database
81030 *
81031 * This function is very similar to {@link px_get_record} but uses
81032 * internally a different approach to retrieve the data. It relies on
81033 * pxlib for reading each single field value, which usually results in
81034 * support for more field types.
81035 *
81036 * @param resource $pxdoc Resource identifier of the paradox database
81037 *   as returned by {@link px_new}.
81038 * @param int $num The record number is an artificial number counting
81039 *   records in the order as they are stored in the database. The first
81040 *   record has number 0.
81041 * @param int $mode The optional {@link mode} can be PX_KEYTOLOWER or
81042 *   PX_KEYTOUPPER in order to convert the keys into lower or upper case.
81043 *   If {@link mode} is not passed or is 0, then the key will be exactly
81044 *   like the field name. The element values will contain the field
81045 *   values. NULL values will be retained and are different from 0.0, 0
81046 *   or the empty string. Fields of type PX_FIELD_TIME will be returned
81047 *   as an integer counting the number of milliseconds starting at
81048 *   midnight. A timestamp is a floating point value also counting
81049 *   milliseconds starting at the beginning of julian calendar.
81050 * @return array Returns the {@link num}th record from the paradox
81051 *   database. The record is returned as an associated array with its
81052 *   keys being the field names.
81053 * @since PECL paradox >= 1.4.0
81054 **/
81055function px_retrieve_record($pxdoc, $num, $mode){}
81056
81057/**
81058 * Sets the file where blobs are read from
81059 *
81060 * Sets the name of the file where blobs are going to be read from or
81061 * written into. Without calling this function, {@link px_get_record} or
81062 * {@link px_retrieve_record} will only return data in blob fields if the
81063 * data is part of the record and not stored in the blob file. Blob data
81064 * is stored in the record if it is small enough to fit in the size of
81065 * the blob field.
81066 *
81067 * Calling {@link px_put_record}, {@link px_insert_record}, or {@link
81068 * px_update_record} without calling {@link px_set_blob_file} will result
81069 * in truncated blob fields unless the data fits into the database file.
81070 *
81071 * Calling this function twice will close the first blob file and open
81072 * the new one.
81073 *
81074 * @param resource $pxdoc Resource identifier of the paradox database
81075 *   as returned by {@link px_new}.
81076 * @param string $filename The name of the file. Its extension should
81077 *   be .MB.
81078 * @return bool
81079 * @since PECL paradox >= 1.3.0
81080 **/
81081function px_set_blob_file($pxdoc, $filename){}
81082
81083/**
81084 * Sets a parameter
81085 *
81086 * Sets various parameters.
81087 *
81088 * @param resource $pxdoc Resource identifier of the paradox database
81089 *   as returned by {@link px_new}.
81090 * @param string $name Depending on the parameter you want to set,
81091 *   {@link name} can be one of the following.
81092 * @param string $value The name of the table as it will be stored in
81093 *   the database header.
81094 * @return bool
81095 * @since PECL paradox >= 1.1.0
81096 **/
81097function px_set_parameter($pxdoc, $name, $value){}
81098
81099/**
81100 * Sets the name of a table (deprecated)
81101 *
81102 * Sets the table name of a paradox database, which was created with
81103 * {@link px_create_fp}. This function is deprecated use {@link
81104 * px_set_parameter} instead.
81105 *
81106 * @param resource $pxdoc Resource identifier of the paradox database
81107 *   as returned by {@link px_new}.
81108 * @param string $name The name of the table. If it is not set
81109 *   explicitly it will be set to the name of the database file.
81110 * @return void Returns NULL on success.
81111 * @since PECL paradox >= 1.0.0
81112 **/
81113function px_set_tablename($pxdoc, $name){}
81114
81115/**
81116 * Sets the encoding for character fields (deprecated)
81117 *
81118 * Set the encoding for data retrieved from a character field. All
81119 * character fields will be recoded to the encoding set by this function.
81120 * If the encoding is not set, the character data will be returned in the
81121 * DOS code page encoding as specified in the database file. The {@link
81122 * encoding} can be any string identifier known to iconv or recode. On
81123 * Unix systems run iconv -l for a list of available encodings.
81124 *
81125 * This function is deprecated and should be replaced by calling {@link
81126 * px_set_parameter}.
81127 *
81128 * See also {@link px_get_info} to determine the DOS code page as stored
81129 * in the database file.
81130 *
81131 * @param resource $pxdoc Resource identifier of the paradox database
81132 *   as returned by {@link px_new}.
81133 * @param string $encoding The encoding for the output. Data which is
81134 *   being read from character fields is recoded into the targetencoding.
81135 * @return bool Returns FALSE if the encoding could not be set, e.g.
81136 *   the encoding is unknown, or pxlib does not support recoding at all.
81137 *   In the second case a warning will be issued.
81138 * @since PECL paradox >= 1.0.0
81139 **/
81140function px_set_targetencoding($pxdoc, $encoding){}
81141
81142/**
81143 * Sets a value
81144 *
81145 * Sets various values.
81146 *
81147 * @param resource $pxdoc Resource identifier of the paradox database
81148 *   as returned by {@link px_new}.
81149 * @param string $name {@link name} can be one of the following.
81150 * @param float $value The number of primary keys. Paradox databases
81151 *   always use the first numprimkeys fields for the primary index.
81152 * @return bool
81153 * @since PECL paradox >= 1.1.0
81154 **/
81155function px_set_value($pxdoc, $name, $value){}
81156
81157/**
81158 * Converts the timestamp into a string
81159 *
81160 * Turns a timestamp as it stored in the paradox file into human readable
81161 * format. Paradox timestamps are the number of miliseconds since
81162 * 0001-01-02. This function is just for convenience. It can be easily
81163 * replaced by some math and the calendar functions as demonstrated in
81164 * the following example.
81165 *
81166 * @param resource $pxdoc Resource identifier of the paradox database.
81167 * @param float $value Value as stored in paradox database field of
81168 *   type PX_FIELD_TIME, or PX_FIELD_TIMESTAMP.
81169 * @param string $format String format similar to the format used by
81170 *   {@link date}. The placeholders support by this function is a subset
81171 *   of those supported by {@link date} (Y, y, m, n, d, j, H, h, G, g, i,
81172 *   s, A, a, L).
81173 * @return string
81174 * @since PECL paradox >= 1.4.0
81175 **/
81176function px_timestamp2string($pxdoc, $value, $format){}
81177
81178/**
81179 * Updates record in paradox database
81180 *
81181 * Updates an exiting record in the database. The record starts at 0.
81182 *
81183 * The record data is passed as an array of field values. The elements in
81184 * the array must correspond to the fields in the database. If the array
81185 * has less elements than fields in the database, the remaining fields
81186 * will be set to null.
81187 *
81188 * @param resource $pxdoc Resource identifier of the paradox database
81189 *   as returned by {@link px_new}.
81190 * @param array $data Associated array containing the field values as
81191 *   returned by {@link px_retrieve_record}.
81192 * @param int $num The record number is an artificial number counting
81193 *   records in the order as they are stored in the database. The first
81194 *   record has number 0.
81195 * @return bool
81196 * @since PECL paradox >= 1.4.0
81197 **/
81198function px_update_record($pxdoc, $data, $num){}
81199
81200/**
81201 * Convert a quoted-printable string to an 8 bit string
81202 *
81203 * This function returns an 8-bit binary string corresponding to the
81204 * decoded quoted printable string (according to RFC2045, section 6.7,
81205 * not RFC2821, section 4.5.2, so additional periods are not stripped
81206 * from the beginning of line).
81207 *
81208 * This function is similar to {@link imap_qprint}, except this one does
81209 * not require the IMAP module to work.
81210 *
81211 * @param string $str The input string.
81212 * @return string Returns the 8-bit binary string.
81213 * @since PHP 4, PHP 5, PHP 7
81214 **/
81215function quoted_printable_decode($str){}
81216
81217/**
81218 * Convert a 8 bit string to a quoted-printable string
81219 *
81220 * Returns a quoted printable string created according to RFC2045,
81221 * section 6.7.
81222 *
81223 * This function is similar to {@link imap_8bit}, except this one does
81224 * not require the IMAP module to work.
81225 *
81226 * @param string $str The input string.
81227 * @return string Returns the encoded string.
81228 * @since PHP 5 >= 5.3.0, PHP 7
81229 **/
81230function quoted_printable_encode($str){}
81231
81232/**
81233 * Quote meta characters
81234 *
81235 * Returns a version of str with a backslash character (\) before every
81236 * character that is among these: . \ + * ? [ ^ ] ( $ )
81237 *
81238 * @param string $str The input string.
81239 * @return string Returns the string with meta characters quoted, or
81240 *   FALSE if an empty string is given as {@link str}.
81241 * @since PHP 4, PHP 5, PHP 7
81242 **/
81243function quotemeta($str){}
81244
81245/**
81246 * Converts the radian number to the equivalent number in degrees
81247 *
81248 * This function converts {@link number} from radian to degrees.
81249 *
81250 * @param float $number A radian value
81251 * @return float The equivalent of {@link number} in degrees
81252 * @since PHP 4, PHP 5, PHP 7
81253 **/
81254function rad2deg($number){}
81255
81256/**
81257 * Creates a Radius handle for accounting
81258 *
81259 * @return resource Returns a handle on success, FALSE on error. This
81260 *   function only fails if insufficient memory is available.
81261 * @since PECL radius >= 1.1.0
81262 **/
81263function radius_acct_open(){}
81264
81265/**
81266 * Adds a server
81267 *
81268 * {@link radius_add_server} may be called multiple times, and it may be
81269 * used together with {@link radius_config}. At most 10 servers may be
81270 * specified. When multiple servers are given, they are tried in
81271 * round-robin fashion until a valid response is received, or until each
81272 * server's {@link max_tries} limit has been reached.
81273 *
81274 * @param resource $radius_handle
81275 * @param string $hostname The {@link hostname} parameter specifies the
81276 *   server host, either as a fully qualified domain name or as a
81277 *   dotted-quad IP address in text form.
81278 * @param int $port The {@link port} specifies the UDP port to contact
81279 *   on the server. If port is given as 0, the library looks up the
81280 *   radius/udp or radacct/udp service in the network services database,
81281 *   and uses the port found there. If no entry is found, the library
81282 *   uses the standard Radius ports, 1812 for authentication and 1813 for
81283 *   accounting.
81284 * @param string $secret The shared secret for the server host is
81285 *   passed to the {@link secret} parameter. The Radius protocol ignores
81286 *   all but the leading 128 bytes of the shared secret.
81287 * @param int $timeout The timeout for receiving replies from the
81288 *   server is passed to the {@link timeout} parameter, in units of
81289 *   seconds.
81290 * @param int $max_tries The maximum number of repeated requests to
81291 *   make before giving up is passed into the {@link max_tries}.
81292 * @return bool
81293 * @since PECL radius >= 1.1.0
81294 **/
81295function radius_add_server($radius_handle, $hostname, $port, $secret, $timeout, $max_tries){}
81296
81297/**
81298 * Creates a Radius handle for authentication
81299 *
81300 * @return resource Returns a handle on success, FALSE on error. This
81301 *   function only fails if insufficient memory is available.
81302 * @since PECL radius >= 1.1.0
81303 **/
81304function radius_auth_open(){}
81305
81306/**
81307 * Frees all ressources
81308 *
81309 * It is not needed to call this function because php frees all resources
81310 * at the end of each request.
81311 *
81312 * @param resource $radius_handle
81313 * @return bool
81314 * @since PECL radius >= 1.1.0
81315 **/
81316function radius_close($radius_handle){}
81317
81318/**
81319 * Causes the library to read the given configuration file
81320 *
81321 * Before issuing any Radius requests, the library must be made aware of
81322 * the servers it can contact. The easiest way to configure the library
81323 * is to call {@link radius_config}. {@link radius_config} causes the
81324 * library to read a configuration file whose format is described in
81325 * radius.conf.
81326 *
81327 * @param resource $radius_handle
81328 * @param string $file The pathname of the configuration file is passed
81329 *   as the file argument to {@link radius_config}. The library can also
81330 *   be configured programmatically by calls to {@link
81331 *   radius_add_server}.
81332 * @return bool
81333 * @since PECL radius >= 1.1.0
81334 **/
81335function radius_config($radius_handle, $file){}
81336
81337/**
81338 * Create accounting or authentication request
81339 *
81340 * A Radius request consists of a code specifying the kind of request,
81341 * and zero or more attributes which provide additional information. To
81342 * begin constructing a new request, call {@link radius_create_request}.
81343 *
81344 * @param resource $radius_handle
81345 * @param int $type Type is RADIUS_ACCESS_REQUEST or
81346 *   RADIUS_ACCOUNTING_REQUEST.
81347 * @return bool
81348 * @since PECL radius >= 1.1.0
81349 **/
81350function radius_create_request($radius_handle, $type){}
81351
81352/**
81353 * Converts raw data to IP-Address
81354 *
81355 * @param string $data
81356 * @return string
81357 * @since PECL radius >= 1.1.0
81358 **/
81359function radius_cvt_addr($data){}
81360
81361/**
81362 * Converts raw data to integer
81363 *
81364 * @param string $data
81365 * @return int
81366 * @since PECL radius >= 1.1.0
81367 **/
81368function radius_cvt_int($data){}
81369
81370/**
81371 * Converts raw data to string
81372 *
81373 * @param string $data
81374 * @return string
81375 * @since PECL radius >= 1.1.0
81376 **/
81377function radius_cvt_string($data){}
81378
81379/**
81380 * Demangles data
81381 *
81382 * Some data (Passwords, MS-CHAPv1 MPPE-Keys) is mangled for security
81383 * reasons, and must be demangled before you can use them.
81384 *
81385 * @param resource $radius_handle
81386 * @param string $mangled
81387 * @return string Returns the demangled string, or FALSE on error.
81388 * @since PECL radius >= 1.2.0
81389 **/
81390function radius_demangle($radius_handle, $mangled){}
81391
81392/**
81393 * Derives mppe-keys from mangled data
81394 *
81395 * When using MPPE with MS-CHAPv2, the send- and recv-keys are mangled
81396 * (see RFC 2548), however this function is useless, because I don't
81397 * think that there is or will be a PPTP-MPPE implementation in PHP.
81398 *
81399 * @param resource $radius_handle
81400 * @param string $mangled
81401 * @return string Returns the demangled string, or FALSE on error.
81402 * @since PECL radius >= 1.2.0
81403 **/
81404function radius_demangle_mppe_key($radius_handle, $mangled){}
81405
81406/**
81407 * Extracts an attribute
81408 *
81409 * Like Radius requests, each response may contain zero or more
81410 * attributes. After a response has been received successfully by {@link
81411 * radius_send_request}, its attributes can be extracted one by one using
81412 * {@link radius_get_attr}. Each time {@link radius_get_attr} is called,
81413 * it gets the next attribute from the current response.
81414 *
81415 * @param resource $radius_handle
81416 * @return mixed Returns an associative array containing the
81417 *   attribute-type and the data, or error number <= 0.
81418 * @since PECL radius >= 1.1.0
81419 **/
81420function radius_get_attr($radius_handle){}
81421
81422/**
81423 * Extracts the data from a tagged attribute
81424 *
81425 * If a tagged attribute has been returned from {@link radius_get_attr},
81426 * {@link radius_get_tagged_attr_data} will return the data from the
81427 * attribute.
81428 *
81429 * @param string $data The tagged attribute to be decoded.
81430 * @return string Returns the data from the tagged attribute .
81431 * @since PECL radius >= 1.3.0
81432 **/
81433function radius_get_tagged_attr_data($data){}
81434
81435/**
81436 * Extracts the tag from a tagged attribute
81437 *
81438 * If a tagged attribute has been returned from {@link radius_get_attr},
81439 * {@link radius_get_tagged_attr_data} will return the tag from the
81440 * attribute.
81441 *
81442 * @param string $data The tagged attribute to be decoded.
81443 * @return int Returns the tag from the tagged attribute .
81444 * @since PECL radius >= 1.3.0
81445 **/
81446function radius_get_tagged_attr_tag($data){}
81447
81448/**
81449 * Extracts a vendor specific attribute
81450 *
81451 * If {@link radius_get_attr} returns RADIUS_VENDOR_SPECIFIC, {@link
81452 * radius_get_vendor_attr} may be called to determine the vendor.
81453 *
81454 * @param string $data
81455 * @return array Returns an associative array containing the
81456 *   attribute-type, vendor and the data, or FALSE on error.
81457 * @since PECL radius >= 1.1.0
81458 **/
81459function radius_get_vendor_attr($data){}
81460
81461/**
81462 * Attaches an IP address attribute
81463 *
81464 * Attaches an IP address attribute to the current RADIUS request.
81465 *
81466 * @param resource $radius_handle An IPv4 address in string form, such
81467 *   as 10.0.0.1.
81468 * @param int $type
81469 * @param string $addr
81470 * @param int $options
81471 * @param int $tag
81472 * @return bool
81473 * @since PECL radius >= 1.1.0
81474 **/
81475function radius_put_addr($radius_handle, $type, $addr, $options, $tag){}
81476
81477/**
81478 * Attaches a binary attribute
81479 *
81480 * Attaches a binary attribute to the current RADIUS request.
81481 *
81482 * @param resource $radius_handle The attribute value, which will be
81483 *   treated as a raw binary string.
81484 * @param int $type
81485 * @param string $value
81486 * @param int $options
81487 * @param int $tag
81488 * @return bool
81489 * @since PECL radius >= 1.1.0
81490 **/
81491function radius_put_attr($radius_handle, $type, $value, $options, $tag){}
81492
81493/**
81494 * Attaches an integer attribute
81495 *
81496 * Attaches an integer attribute to the current RADIUS request.
81497 *
81498 * @param resource $radius_handle The attribute value.
81499 * @param int $type
81500 * @param int $value
81501 * @param int $options
81502 * @param int $tag
81503 * @return bool
81504 * @since PECL radius >= 1.1.0
81505 **/
81506function radius_put_int($radius_handle, $type, $value, $options, $tag){}
81507
81508/**
81509 * Attaches a string attribute
81510 *
81511 * Attaches a string attribute to the current RADIUS request. In general,
81512 * {@link radius_put_attr} is a more useful function for attaching string
81513 * attributes, as it is binary safe.
81514 *
81515 * @param resource $radius_handle The attribute value. This value is
81516 *   expected by the underlying library to be null terminated, therefore
81517 *   this parameter is not binary safe.
81518 * @param int $type
81519 * @param string $value
81520 * @param int $options
81521 * @param int $tag
81522 * @return bool
81523 * @since PECL radius >= 1.1.0
81524 **/
81525function radius_put_string($radius_handle, $type, $value, $options, $tag){}
81526
81527/**
81528 * Attaches a vendor specific IP address attribute
81529 *
81530 * Attaches an IP address vendor specific attribute to the current RADIUS
81531 * request.
81532 *
81533 * @param resource $radius_handle An IPv4 address in string form, such
81534 *   as 10.0.0.1.
81535 * @param int $vendor
81536 * @param int $type
81537 * @param string $addr
81538 * @return bool
81539 * @since PECL radius >= 1.1.0
81540 **/
81541function radius_put_vendor_addr($radius_handle, $vendor, $type, $addr){}
81542
81543/**
81544 * Attaches a vendor specific binary attribute
81545 *
81546 * Attaches a vendor specific binary attribute to the current RADIUS
81547 * request.
81548 *
81549 * @param resource $radius_handle The attribute value, which will be
81550 *   treated as a raw binary string.
81551 * @param int $vendor
81552 * @param int $type
81553 * @param string $value
81554 * @param int $options
81555 * @param int $tag
81556 * @return bool
81557 * @since PECL radius >= 1.1.0
81558 **/
81559function radius_put_vendor_attr($radius_handle, $vendor, $type, $value, $options, $tag){}
81560
81561/**
81562 * Attaches a vendor specific integer attribute
81563 *
81564 * Attaches a vendor specific integer attribute to the current RADIUS
81565 * request.
81566 *
81567 * @param resource $radius_handle The attribute value.
81568 * @param int $vendor
81569 * @param int $type
81570 * @param int $value
81571 * @param int $options
81572 * @param int $tag
81573 * @return bool
81574 * @since PECL radius >= 1.1.0
81575 **/
81576function radius_put_vendor_int($radius_handle, $vendor, $type, $value, $options, $tag){}
81577
81578/**
81579 * Attaches a vendor specific string attribute
81580 *
81581 * Attaches a vendor specific string attribute to the current RADIUS
81582 * request. In general, {@link radius_put_vendor_attr} is a more useful
81583 * function for attaching string attributes, as it is binary safe.
81584 *
81585 * @param resource $radius_handle The attribute value. This value is
81586 *   expected by the underlying library to be null terminated, therefore
81587 *   this parameter is not binary safe.
81588 * @param int $vendor
81589 * @param int $type
81590 * @param string $value
81591 * @param int $options
81592 * @param int $tag
81593 * @return bool
81594 * @since PECL radius >= 1.1.0
81595 **/
81596function radius_put_vendor_string($radius_handle, $vendor, $type, $value, $options, $tag){}
81597
81598/**
81599 * Returns the request authenticator
81600 *
81601 * The request authenticator is needed for demangling mangled data like
81602 * passwords and encryption-keys.
81603 *
81604 * @param resource $radius_handle
81605 * @return string Returns the request authenticator as string, or FALSE
81606 *   on error.
81607 * @since PECL radius >= 1.1.0
81608 **/
81609function radius_request_authenticator($radius_handle){}
81610
81611/**
81612 * Salt-encrypts a value
81613 *
81614 * Applies the RADIUS salt-encryption algorithm to the given value.
81615 *
81616 * In general, this is achieved automatically by providing the
81617 * RADIUS_OPTION_SALT option to an attribute setter function, but this
81618 * function can be used if low-level request construction is required.
81619 *
81620 * @param resource $radius_handle The data to be salt-encrypted.
81621 * @param string $data
81622 * @return string Returns the salt-encrypted data .
81623 * @since PECL radius >= 1.3.0
81624 **/
81625function radius_salt_encrypt_attr($radius_handle, $data){}
81626
81627/**
81628 * Sends the request and waits for a reply
81629 *
81630 * After the Radius request has been constructed, it is sent by {@link
81631 * radius_send_request}.
81632 *
81633 * The {@link radius_send_request} function sends the request and waits
81634 * for a valid reply, retrying the defined servers in round-robin fashion
81635 * as necessary.
81636 *
81637 * @param resource $radius_handle
81638 * @return int If a valid response is received, {@link
81639 *   radius_send_request} returns the Radius code which specifies the
81640 *   type of the response. This will typically be RADIUS_ACCESS_ACCEPT,
81641 *   RADIUS_ACCESS_REJECT, or RADIUS_ACCESS_CHALLENGE. If no valid
81642 *   response is received, {@link radius_send_request} returns FALSE.
81643 * @since PECL radius >= 1.1.0
81644 **/
81645function radius_send_request($radius_handle){}
81646
81647/**
81648 * Returns the shared secret
81649 *
81650 * The shared secret is needed as salt for demangling mangled data like
81651 * passwords and encryption-keys.
81652 *
81653 * @param resource $radius_handle
81654 * @return string Returns the server's shared secret as string, or
81655 *   FALSE on error.
81656 * @since PECL radius >= 1.1.0
81657 **/
81658function radius_server_secret($radius_handle){}
81659
81660/**
81661 * Returns an error message
81662 *
81663 * If Radius-functions fail then they record an error message. This error
81664 * message can be retrieved with this function.
81665 *
81666 * @param resource $radius_handle
81667 * @return string Returns error messages as string from failed radius
81668 *   functions.
81669 * @since PECL radius >= 1.1.0
81670 **/
81671function radius_strerror($radius_handle){}
81672
81673/**
81674 * Generate a random integer
81675 *
81676 * @return int A pseudo random value between {@link min} (or 0) and
81677 *   {@link max} (or {@link getrandmax}, inclusive).
81678 * @since PHP 4, PHP 5, PHP 7
81679 **/
81680function rand(){}
81681
81682/**
81683 * Generates cryptographically secure pseudo-random bytes
81684 *
81685 * Generates an arbitrary length string of cryptographic random bytes
81686 * that are suitable for cryptographic use, such as when generating
81687 * salts, keys or initialization vectors.
81688 *
81689 * @param int $length The length of the random string that should be
81690 *   returned in bytes.
81691 * @return string Returns a string containing the requested number of
81692 *   cryptographically secure random bytes.
81693 * @since PHP 7
81694 **/
81695function random_bytes($length){}
81696
81697/**
81698 * Generates cryptographically secure pseudo-random integers
81699 *
81700 * Generates cryptographic random integers that are suitable for use
81701 * where unbiased results are critical, such as when shuffling a deck of
81702 * cards for a poker game.
81703 *
81704 * @param int $min The lowest value to be returned, which must be
81705 *   PHP_INT_MIN or higher.
81706 * @param int $max The highest value to be returned, which must be less
81707 *   than or equal to PHP_INT_MAX.
81708 * @return int Returns a cryptographically secure random integer in the
81709 *   range {@link min} to {@link max}, inclusive.
81710 * @since PHP 7
81711 **/
81712function random_int($min, $max){}
81713
81714/**
81715 * Create an array containing a range of elements
81716 *
81717 * @param mixed $start First value of the sequence.
81718 * @param mixed $end The sequence is ended upon reaching the {@link
81719 *   end} value.
81720 * @param number $step If a {@link step} value is given, it will be
81721 *   used as the increment between elements in the sequence. {@link step}
81722 *   should be given as a positive number. If not specified, {@link step}
81723 *   will default to 1.
81724 * @return array Returns an array of elements from {@link start} to
81725 *   {@link end}, inclusive.
81726 * @since PHP 4, PHP 5, PHP 7
81727 **/
81728function range($start, $end, $step){}
81729
81730/**
81731 * Whether opening broken archives is allowed
81732 *
81733 * This method defines whether broken archives can be read or all the
81734 * operations that attempt to extract the archive entries will fail.
81735 * Broken archives are archives for which no error is detected when the
81736 * file is opened but an error occurs when reading the entries.
81737 *
81738 * @param RarArchive $rarfile A RarArchive object, opened with {@link
81739 *   rar_open}.
81740 * @param bool $allow_broken Whether to allow reading broken files
81741 *   (TRUE) or not (FALSE).
81742 * @return bool Returns TRUE . It will only fail if the file has
81743 *   already been closed.
81744 * @since PECL rar >= 3.0.0
81745 **/
81746function rar_allow_broken_set($rarfile, $allow_broken){}
81747
81748/**
81749 * Test whether an archive is broken (incomplete)
81750 *
81751 * This function determines whether an archive is incomplete, i.e., if a
81752 * volume is missing or a volume is truncated.
81753 *
81754 * @param RarArchive $rarfile A RarArchive object, opened with {@link
81755 *   rar_open}.
81756 * @return bool Returns TRUE if the archive is broken, FALSE otherwise.
81757 *   This function may also return FALSE if the passed file has already
81758 *   been closed. The only way to tell the two cases apart is to enable
81759 *   exceptions with RarException::setUsingExceptions; however, this
81760 *   should be unnecessary as a program should not operate on closed
81761 *   files.
81762 * @since PECL rar >= 3.0.0
81763 **/
81764function rar_broken_is($rarfile){}
81765
81766/**
81767 * Close RAR archive and free all resources
81768 *
81769 * Close RAR archive and free all allocated resources.
81770 *
81771 * @param RarArchive $rarfile A RarArchive object, opened with {@link
81772 *   rar_open}.
81773 * @return bool
81774 * @since PECL rar >= 0.1
81775 **/
81776function rar_close($rarfile){}
81777
81778/**
81779 * Get comment text from the RAR archive
81780 *
81781 * Get the (global) comment stored in the RAR archive. It may be up to 64
81782 * KiB long.
81783 *
81784 * @param RarArchive $rarfile A RarArchive object, opened with {@link
81785 *   rar_open}.
81786 * @return string Returns the comment or NULL if there is none.
81787 * @since PECL rar >= 2.0.0
81788 **/
81789function rar_comment_get($rarfile){}
81790
81791/**
81792 * Get entry object from the RAR archive
81793 *
81794 * Get entry object (file or directory) from the RAR archive.
81795 *
81796 * @param RarArchive $rarfile A RarArchive object, opened with {@link
81797 *   rar_open}.
81798 * @param string $entryname Path to the entry within the RAR archive.
81799 * @return RarEntry Returns the matching RarEntry object .
81800 * @since PECL rar >= 0.1
81801 **/
81802function rar_entry_get($rarfile, $entryname){}
81803
81804/**
81805 * Get full list of entries from the RAR archive
81806 *
81807 * Get entries list (files and directories) from the RAR archive.
81808 *
81809 * @param RarArchive $rarfile A RarArchive object, opened with {@link
81810 *   rar_open}.
81811 * @return array {@link rar_list} returns array of RarEntry objects .
81812 * @since PECL rar >= 0.1
81813 **/
81814function rar_list($rarfile){}
81815
81816/**
81817 * Open RAR archive
81818 *
81819 * Open specified RAR archive and return RarArchive instance representing
81820 * it.
81821 *
81822 * @param string $filename Path to the Rar archive.
81823 * @param string $password A plain password, if needed to decrypt the
81824 *   headers. It will also be used by default if encrypted files are
81825 *   found. Note that the files may have different passwords in respect
81826 *   to the headers and among them.
81827 * @param callable $volume_callback A function that receives one
81828 *   parameter – the path of the volume that was not found – and
81829 *   returns a string with the correct path for such volume or NULL if
81830 *   such volume does not exist or is not known. The programmer should
81831 *   ensure the passed function doesn't cause loops as this function is
81832 *   called repeatedly if the path returned in a previous call did not
81833 *   correspond to the needed volume. Specifying this parameter omits the
81834 *   notice that would otherwise be emitted whenever a volume is not
81835 *   found; an implementation that only returns NULL can therefore be
81836 *   used to merely omit such notices.
81837 * @return RarArchive Returns the requested RarArchive instance .
81838 * @since PECL rar >= 0.1
81839 **/
81840function rar_open($filename, $password, $volume_callback){}
81841
81842/**
81843 * Check whether the RAR archive is solid
81844 *
81845 * Check whether the RAR archive is solid. Individual file extraction is
81846 * slower on solid archives.
81847 *
81848 * @param RarArchive $rarfile A RarArchive object, opened with {@link
81849 *   rar_open}.
81850 * @return bool Returns TRUE if the archive is solid, FALSE otherwise.
81851 * @since PECL rar >= 2.0.0
81852 **/
81853function rar_solid_is($rarfile){}
81854
81855/**
81856 * Cache hits and misses for the URL wrapper
81857 *
81858 * @return string
81859 * @since PECL rar >= 3.0.0
81860 **/
81861function rar_wrapper_cache_stats(){}
81862
81863/**
81864 * Decode URL-encoded strings
81865 *
81866 * Returns a string in which the sequences with percent (%) signs
81867 * followed by two hex digits have been replaced with literal characters.
81868 *
81869 * @param string $str The URL to be decoded.
81870 * @return string Returns the decoded URL, as a string.
81871 * @since PHP 4, PHP 5, PHP 7
81872 **/
81873function rawurldecode($str){}
81874
81875/**
81876 * URL-encode according to RFC 3986
81877 *
81878 * Encodes the given string according to RFC 3986.
81879 *
81880 * @param string $str The URL to be encoded.
81881 * @return string Returns a string in which all non-alphanumeric
81882 *   characters except -_.~ have been replaced with a percent (%) sign
81883 *   followed by two hex digits. This is the encoding described in RFC
81884 *   3986 for protecting literal characters from being interpreted as
81885 *   special URL delimiters, and for protecting URLs from being mangled
81886 *   by transmission media with character conversions (like some email
81887 *   systems). Prior to PHP 5.3.0, rawurlencode encoded tildes (~) as per
81888 *   RFC 1738.
81889 * @since PHP 4, PHP 5, PHP 7
81890 **/
81891function rawurlencode($str){}
81892
81893/**
81894 * Read entry from directory handle
81895 *
81896 * Returns the name of the next entry in the directory. The entries are
81897 * returned in the order in which they are stored by the filesystem.
81898 *
81899 * @param resource $dir_handle The directory handle resource previously
81900 *   opened with {@link opendir}. If the directory handle is not
81901 *   specified, the last link opened by {@link opendir} is assumed.
81902 * @return string Returns the entry name on success.
81903 * @since PHP 4, PHP 5, PHP 7
81904 **/
81905function readdir($dir_handle){}
81906
81907/**
81908 * Outputs a file
81909 *
81910 * Reads a file and writes it to the output buffer.
81911 *
81912 * @param string $filename The filename being read.
81913 * @param bool $use_include_path You can use the optional second
81914 *   parameter and set it to TRUE, if you want to search for the file in
81915 *   the include_path, too.
81916 * @param resource $context A context stream resource.
81917 * @return int Returns the number of bytes read from the file on
81918 *   success,
81919 * @since PHP 4, PHP 5, PHP 7
81920 **/
81921function readfile($filename, $use_include_path, $context){}
81922
81923/**
81924 * Output a gz-file
81925 *
81926 * Reads a file, decompresses it and writes it to standard output.
81927 *
81928 * {@link readgzfile} can be used to read a file which is not in gzip
81929 * format; in this case {@link readgzfile} will directly read from the
81930 * file without decompression.
81931 *
81932 * @param string $filename The file name. This file will be opened from
81933 *   the filesystem and its contents written to standard output.
81934 * @param int $use_include_path You can set this optional parameter to
81935 *   1, if you want to search for the file in the include_path too.
81936 * @return int Returns the number of (uncompressed) bytes read from the
81937 *   file on success,
81938 * @since PHP 4, PHP 5, PHP 7
81939 **/
81940function readgzfile($filename, $use_include_path){}
81941
81942/**
81943 * Reads a line
81944 *
81945 * Reads a single line from the user. You must add this line to the
81946 * history yourself using {@link readline_add_history}.
81947 *
81948 * @param string $prompt You may specify a string with which to prompt
81949 *   the user.
81950 * @return string Returns a single string from the user. The line
81951 *   returned has the ending newline removed. If there is no more data to
81952 *   read, then FALSE is returned.
81953 * @since PHP 4, PHP 5, PHP 7
81954 **/
81955function readline($prompt){}
81956
81957/**
81958 * Adds a line to the history
81959 *
81960 * This function adds a line to the command line history.
81961 *
81962 * @param string $line The line to be added in the history.
81963 * @return bool
81964 * @since PHP 4, PHP 5, PHP 7
81965 **/
81966function readline_add_history($line){}
81967
81968/**
81969 * Initializes the readline callback interface and terminal, prints the
81970 * prompt and returns immediately
81971 *
81972 * Sets up a readline callback interface then prints {@link prompt} and
81973 * immediately returns. Calling this function twice without removing the
81974 * previous callback interface will automatically and conveniently
81975 * overwrite the old interface.
81976 *
81977 * The callback feature is useful when combined with {@link
81978 * stream_select} as it allows interleaving of IO and user input, unlike
81979 * {@link readline}.
81980 *
81981 * @param string $prompt The prompt message.
81982 * @param callable $callback The {@link callback} function takes one
81983 *   parameter; the user input returned.
81984 * @return bool
81985 * @since PHP 5 >= 5.1.0, PHP 7
81986 **/
81987function readline_callback_handler_install($prompt, $callback){}
81988
81989/**
81990 * Removes a previously installed callback handler and restores terminal
81991 * settings
81992 *
81993 * Removes a previously installed callback handler and restores terminal
81994 * settings.
81995 *
81996 * @return bool Returns TRUE if a previously installed callback handler
81997 *   was removed, or FALSE if one could not be found.
81998 * @since PHP 5 >= 5.1.0, PHP 7
81999 **/
82000function readline_callback_handler_remove(){}
82001
82002/**
82003 * Reads a character and informs the readline callback interface when a
82004 * line is received
82005 *
82006 * Reads a character of user input. When a line is received, this
82007 * function informs the readline callback interface installed using
82008 * {@link readline_callback_handler_install} that a line is ready for
82009 * input.
82010 *
82011 * @return void
82012 * @since PHP 5 >= 5.1.0, PHP 7
82013 **/
82014function readline_callback_read_char(){}
82015
82016/**
82017 * Clears the history
82018 *
82019 * This function clears the entire command line history.
82020 *
82021 * @return bool
82022 * @since PHP 4, PHP 5, PHP 7
82023 **/
82024function readline_clear_history(){}
82025
82026/**
82027 * Registers a completion function
82028 *
82029 * This function registers a completion function. This is the same kind
82030 * of functionality you'd get if you hit your tab key while using Bash.
82031 *
82032 * @param callable $function You must supply the name of an existing
82033 *   function which accepts a partial command line and returns an array
82034 *   of possible matches.
82035 * @return bool
82036 * @since PHP 4, PHP 5, PHP 7
82037 **/
82038function readline_completion_function($function){}
82039
82040/**
82041 * Gets/sets various internal readline variables
82042 *
82043 * Gets or sets various internal readline variables.
82044 *
82045 * @param string $varname A variable name.
82046 * @param string $newvalue If provided, this will be the new value of
82047 *   the setting.
82048 * @return mixed If called with no parameters, this function returns an
82049 *   array of values for all the setting readline uses. The elements will
82050 *   be indexed by the following values: done, end, erase_empty_line,
82051 *   library_version, line_buffer, mark, pending_input, point, prompt,
82052 *   readline_name, and terminal_name.
82053 * @since PHP 4, PHP 5, PHP 7
82054 **/
82055function readline_info($varname, $newvalue){}
82056
82057/**
82058 * Lists the history
82059 *
82060 * Gets the entire command line history.
82061 *
82062 * @return array Returns an array of the entire command line history.
82063 *   The elements are indexed by integers starting at zero.
82064 * @since PHP 4, PHP 5, PHP 7
82065 **/
82066function readline_list_history(){}
82067
82068/**
82069 * Inform readline that the cursor has moved to a new line
82070 *
82071 * Tells readline that the cursor has moved to a new line.
82072 *
82073 * @return void
82074 * @since PHP 5 >= 5.1.0, PHP 7
82075 **/
82076function readline_on_new_line(){}
82077
82078/**
82079 * Reads the history
82080 *
82081 * This function reads a command history from a file.
82082 *
82083 * @param string $filename Path to the filename containing the command
82084 *   history.
82085 * @return bool
82086 * @since PHP 4, PHP 5, PHP 7
82087 **/
82088function readline_read_history($filename){}
82089
82090/**
82091 * Redraws the display
82092 *
82093 * Redraws readline to redraw the display.
82094 *
82095 * @return void
82096 * @since PHP 5 >= 5.1.0, PHP 7
82097 **/
82098function readline_redisplay(){}
82099
82100/**
82101 * Writes the history
82102 *
82103 * This function writes the command history to a file.
82104 *
82105 * @param string $filename Path to the saved file.
82106 * @return bool
82107 * @since PHP 4, PHP 5, PHP 7
82108 **/
82109function readline_write_history($filename){}
82110
82111/**
82112 * Returns the target of a symbolic link
82113 *
82114 * {@link readlink} does the same as the readlink C function.
82115 *
82116 * @param string $path The symbolic link path.
82117 * @return string Returns the contents of the symbolic link path or
82118 *   FALSE on error.
82119 * @since PHP 4, PHP 5, PHP 7
82120 **/
82121function readlink($path){}
82122
82123/**
82124 * Reads the headers from an image file
82125 *
82126 * {@link read_exif_data} reads the EXIF headers from an image file. This
82127 * way you can read meta data generated by digital cameras.
82128 *
82129 * EXIF headers tend to be present in JPEG/TIFF images generated by
82130 * digital cameras, but unfortunately each digital camera maker has a
82131 * different idea of how to actually tag their images, so you can't
82132 * always rely on a specific Exif header being present.
82133 *
82134 * Height and Width are computed the same way {@link getimagesize} does
82135 * so their values must not be part of any header returned. Also, html is
82136 * a height/width text string to be used inside normal HTML.
82137 *
82138 * When an Exif header contains a Copyright note, this itself can contain
82139 * two values. As the solution is inconsistent in the Exif 2.10 standard,
82140 * the COMPUTED section will return both entries Copyright.Photographer
82141 * and Copyright.Editor while the IFD0 sections contains the byte array
82142 * with the NULL character that splits both entries. Or just the first
82143 * entry if the datatype was wrong (normal behaviour of Exif). The
82144 * COMPUTED will also contain the entry Copyright which is either the
82145 * original copyright string, or a comma separated list of the photo and
82146 * editor copyright.
82147 *
82148 * The tag UserComment has the same problem as the Copyright tag. It can
82149 * store two values. First the encoding used, and second the value
82150 * itself. If so the IFD section only contains the encoding or a byte
82151 * array. The COMPUTED section will store both in the entries
82152 * UserCommentEncoding and UserComment. The entry UserComment is
82153 * available in both cases so it should be used in preference to the
82154 * value in IFD0 section.
82155 *
82156 * {@link read_exif_data} also validates EXIF data tags according to the
82157 * EXIF specification (, page 20).
82158 *
82159 * @param mixed $stream The location of the image file. This can either
82160 *   be a path to the file (stream wrappers are also supported as usual)
82161 *   or a stream resource.
82162 * @param string $sections Is a comma separated list of sections that
82163 *   need to be present in file to produce a result array. If none of the
82164 *   requested sections could be found the return value is FALSE. FILE
82165 *   FileName, FileSize, FileDateTime, SectionsFound COMPUTED html,
82166 *   Width, Height, IsColor, and more if available. Height and Width are
82167 *   computed the same way {@link getimagesize} does so their values must
82168 *   not be part of any header returned. Also, html is a height/width
82169 *   text string to be used inside normal HTML. ANY_TAG Any information
82170 *   that has a Tag e.g. IFD0, EXIF, ... IFD0 All tagged data of IFD0. In
82171 *   normal imagefiles this contains image size and so forth. THUMBNAIL A
82172 *   file is supposed to contain a thumbnail if it has a second IFD. All
82173 *   tagged information about the embedded thumbnail is stored in this
82174 *   section. COMMENT Comment headers of JPEG images. EXIF The EXIF
82175 *   section is a sub section of IFD0. It contains more detailed
82176 *   information about an image. Most of these entries are digital camera
82177 *   related.
82178 * @param bool $arrays Specifies whether or not each section becomes an
82179 *   array. The {@link sections} COMPUTED, THUMBNAIL, and COMMENT always
82180 *   become arrays as they may contain values whose names conflict with
82181 *   other sections.
82182 * @param bool $thumbnail When set to TRUE the thumbnail itself is
82183 *   read. Otherwise, only the tagged data is read.
82184 * @return array It returns an associative array where the array
82185 *   indexes are the header names and the array values are the values
82186 *   associated with those headers. If no data can be returned, {@link
82187 *   exif_read_data} will return FALSE.
82188 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
82189 **/
82190function read_exif_data($stream, $sections, $arrays, $thumbnail){}
82191
82192/**
82193 * Returns canonicalized absolute pathname
82194 *
82195 * {@link realpath} expands all symbolic links and resolves references to
82196 * /./, /../ and extra / characters in the input {@link path} and returns
82197 * the canonicalized absolute pathname.
82198 *
82199 * @param string $path The path being checked. Whilst a path must be
82200 *   supplied, the value can be an empty string. In this case, the value
82201 *   is interpreted as the current directory.
82202 * @return string Returns the canonicalized absolute pathname on
82203 *   success. The resulting path will have no symbolic link, /./ or /../
82204 *   components. Trailing delimiters, such as \ and /, are also removed.
82205 * @since PHP 4, PHP 5, PHP 7
82206 **/
82207function realpath($path){}
82208
82209/**
82210 * Get realpath cache entries
82211 *
82212 * Get the contents of the realpath cache.
82213 *
82214 * @return array Returns an array of realpath cache entries. The keys
82215 *   are original path entries, and the values are arrays of data items,
82216 *   containing the resolved path, expiration date, and other options
82217 *   kept in the cache.
82218 * @since PHP 5 >= 5.3.2, PHP 7
82219 **/
82220function realpath_cache_get(){}
82221
82222/**
82223 * Get realpath cache size
82224 *
82225 * Get the amount of memory used by the realpath cache.
82226 *
82227 * @return int Returns how much memory realpath cache is using.
82228 * @since PHP 5 >= 5.3.2, PHP 7
82229 **/
82230function realpath_cache_size(){}
82231
82232/**
82233 * Recode a string according to a recode request
82234 *
82235 * Recode the string {@link string} according to the recode request
82236 * {@link request}.
82237 *
82238 * @param string $request The desired recode request type
82239 * @param string $string The string to be recoded
82240 * @return string Returns the recoded string or FALSE, if unable to
82241 *   perform the recode request.
82242 * @since PHP 4, PHP 5, PHP 7 < 7.4.0
82243 **/
82244function recode($request, $string){}
82245
82246/**
82247 * Recode from file to file according to recode request
82248 *
82249 * Recode the file referenced by file handle {@link input} into the file
82250 * referenced by file handle {@link output} according to the recode
82251 * {@link request}.
82252 *
82253 * @param string $request The desired recode request type
82254 * @param resource $input A local file handle resource for the {@link
82255 *   input}
82256 * @param resource $output A local file handle resource for the {@link
82257 *   output}
82258 * @return bool Returns FALSE, if unable to comply, TRUE otherwise.
82259 * @since PHP 4, PHP 5, PHP 7 < 7.4.0
82260 **/
82261function recode_file($request, $input, $output){}
82262
82263/**
82264 * Recode a string according to a recode request
82265 *
82266 * Recode the string {@link string} according to the recode request
82267 * {@link request}.
82268 *
82269 * @param string $request The desired recode request type
82270 * @param string $string The string to be recoded
82271 * @return string Returns the recoded string or FALSE, if unable to
82272 *   perform the recode request.
82273 * @since PHP 4, PHP 5, PHP 7 < 7.4.0
82274 **/
82275function recode_string($request, $string){}
82276
82277/**
82278 * Register a function for execution on shutdown
82279 *
82280 * Registers a {@link callback} to be executed after script execution
82281 * finishes or {@link exit} is called.
82282 *
82283 * Multiple calls to {@link register_shutdown_function} can be made, and
82284 * each will be called in the same order as they were registered. If you
82285 * call {@link exit} within one registered shutdown function, processing
82286 * will stop completely and no other registered shutdown functions will
82287 * be called.
82288 *
82289 * @param callable $callback The shutdown callback to register. The
82290 *   shutdown callbacks are executed as the part of the request, so it's
82291 *   possible to send output from them and access output buffers.
82292 * @param mixed ...$vararg It is possible to pass parameters to the
82293 *   shutdown function by passing additional parameters.
82294 * @return void
82295 * @since PHP 4, PHP 5, PHP 7
82296 **/
82297function register_shutdown_function($callback, ...$vararg){}
82298
82299/**
82300 * Register a function for execution on each tick
82301 *
82302 * @param callable $function The function to register.
82303 * @param mixed ...$vararg
82304 * @return bool
82305 * @since PHP 4 >= 4.0.3, PHP 5, PHP 7
82306 **/
82307function register_tick_function($function, ...$vararg){}
82308
82309/**
82310 * Renames a file or directory
82311 *
82312 * Attempts to rename {@link oldname} to {@link newname}, moving it
82313 * between directories if necessary. If renaming a file and {@link
82314 * newname} exists, it will be overwritten. If renaming a directory and
82315 * {@link newname} exists, this function will emit a warning.
82316 *
82317 * @param string $oldname The old name.
82318 * @param string $newname The new name.
82319 * @param resource $context
82320 * @return bool
82321 * @since PHP 4, PHP 5, PHP 7
82322 **/
82323function rename($oldname, $newname, $context){}
82324
82325/**
82326 * Renames orig_name to new_name in the global function table
82327 *
82328 * Renames a orig_name to new_name in the global function table. Useful
82329 * for temporarily overriding built-in functions.
82330 *
82331 * @param string $original_name The original function name.
82332 * @param string $new_name The new name for the {@link original_name}
82333 *   function.
82334 * @return bool
82335 * @since PECL apd >= 0.2
82336 **/
82337function rename_function($original_name, $new_name){}
82338
82339/**
82340 * Set the internal pointer of an array to its first element
82341 *
82342 * {@link reset} rewinds {@link array}'s internal pointer to the first
82343 * element and returns the value of the first array element.
82344 *
82345 * @param array $array The input array.
82346 * @return mixed Returns the value of the first array element, or FALSE
82347 *   if the array is empty.
82348 * @since PHP 4, PHP 5, PHP 7
82349 **/
82350function reset(&$array){}
82351
82352/**
82353 * Get number of elements in the bundle
82354 *
82355 * Get the number of elements in the bundle.
82356 *
82357 * @param ResourceBundle $r ResourceBundle object.
82358 * @return int Returns number of elements in the bundle.
82359 **/
82360function resourcebundle_count($r){}
82361
82362/**
82363 * Create a resource bundle
82364 *
82365 * (method)
82366 *
82367 * (constructor):
82368 *
82369 * Creates a resource bundle.
82370 *
82371 * @param string $locale Locale for which the resources should be
82372 *   loaded (locale name, e.g. en_CA).
82373 * @param string $bundlename The directory where the data is stored or
82374 *   the name of the .dat file.
82375 * @param bool $fallback Whether locale should match exactly or
82376 *   fallback to parent locale is allowed.
82377 * @return ResourceBundle Returns ResourceBundle object or NULL on
82378 *   error.
82379 **/
82380function resourcebundle_create($locale, $bundlename, $fallback){}
82381
82382/**
82383 * Get data from the bundle
82384 *
82385 * Get the data from the bundle by index or string key.
82386 *
82387 * @param ResourceBundle $r ResourceBundle object.
82388 * @param string|int $index Data index, must be string or integer.
82389 * @param bool $fallback Whether locale should match exactly or
82390 *   fallback to parent locale is allowed.
82391 * @return mixed Returns the data located at the index or NULL on
82392 *   error. Strings, integers and binary data strings are returned as
82393 *   corresponding PHP types, integer array is returned as PHP array.
82394 *   Complex types are returned as ResourceBundle object.
82395 **/
82396function resourcebundle_get($r, $index, $fallback){}
82397
82398/**
82399 * Get bundle's last error code
82400 *
82401 * Get error code from the last function performed by the bundle object.
82402 *
82403 * @param ResourceBundle $r ResourceBundle object.
82404 * @return int Returns error code from last bundle object call.
82405 **/
82406function resourcebundle_get_error_code($r){}
82407
82408/**
82409 * Get bundle's last error message
82410 *
82411 * Get error message from the last function performed by the bundle
82412 * object.
82413 *
82414 * @param ResourceBundle $r ResourceBundle object.
82415 * @return string Returns error message from last bundle object's call.
82416 **/
82417function resourcebundle_get_error_message($r){}
82418
82419/**
82420 * Get supported locales
82421 *
82422 * Get available locales from ResourceBundle name.
82423 *
82424 * @param string $bundlename Path of ResourceBundle for which to get
82425 *   available locales, or empty string for default locales list.
82426 * @return array Returns the list of locales supported by the bundle.
82427 **/
82428function resourcebundle_locales($bundlename){}
82429
82430/**
82431 * Restores the previous error handler function
82432 *
82433 * Used after changing the error handler function using {@link
82434 * set_error_handler}, to revert to the previous error handler (which
82435 * could be the built-in or a user defined function).
82436 *
82437 * @return bool This function always returns TRUE.
82438 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
82439 **/
82440function restore_error_handler(){}
82441
82442/**
82443 * Restores the previously defined exception handler function
82444 *
82445 * Used after changing the exception handler function using {@link
82446 * set_exception_handler}, to revert to the previous exception handler
82447 * (which could be the built-in or a user defined function).
82448 *
82449 * @return bool This function always returns TRUE.
82450 * @since PHP 5, PHP 7
82451 **/
82452function restore_exception_handler(){}
82453
82454/**
82455 * Restores the value of the include_path configuration option
82456 *
82457 * @return void
82458 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
82459 **/
82460function restore_include_path(){}
82461
82462/**
82463 * Rewind the position of a file pointer
82464 *
82465 * Sets the file position indicator for {@link handle} to the beginning
82466 * of the file stream.
82467 *
82468 * @param resource $handle The file pointer must be valid, and must
82469 *   point to a file successfully opened by {@link fopen}.
82470 * @return bool
82471 * @since PHP 4, PHP 5, PHP 7
82472 **/
82473function rewind($handle){}
82474
82475/**
82476 * Rewind directory handle
82477 *
82478 * Resets the directory stream indicated by {@link dir_handle} to the
82479 * beginning of the directory.
82480 *
82481 * @param resource $dir_handle The directory handle resource previously
82482 *   opened with {@link opendir}. If the directory handle is not
82483 *   specified, the last link opened by {@link opendir} is assumed.
82484 * @return void
82485 * @since PHP 4, PHP 5, PHP 7
82486 **/
82487function rewinddir($dir_handle){}
82488
82489/**
82490 * Removes directory
82491 *
82492 * Attempts to remove the directory named by {@link dirname}. The
82493 * directory must be empty, and the relevant permissions must permit
82494 * this. A E_WARNING level error will be generated on failure.
82495 *
82496 * @param string $dirname Path to the directory.
82497 * @param resource $context
82498 * @return bool
82499 * @since PHP 4, PHP 5, PHP 7
82500 **/
82501function rmdir($dirname, $context){}
82502
82503/**
82504 * Rounds a float
82505 *
82506 * Returns the rounded value of {@link val} to specified {@link
82507 * precision} (number of digits after the decimal point). {@link
82508 * precision} can also be negative or zero (default).
82509 *
82510 * PHP doesn't handle strings like "12,300.2" correctly by default. See
82511 * converting from strings.
82512 *
82513 * @param float $val The value to round.
82514 * @param int $precision The optional number of decimal digits to round
82515 *   to. If the {@link precision} is positive, the rounding will occur
82516 *   after the decimal point. If the {@link precision} is negative, the
82517 *   rounding will occur before the decimal point. If the absolute value
82518 *   of the {@link precision} is greater than or equal to the number of
82519 *   digits, the result of the rounding is equal to 0
82520 * @param int $mode Use one of the following constants to specify the
82521 *   mode in which rounding occurs. PHP_ROUND_HALF_UP Round {@link val}
82522 *   up to {@link precision} decimal places away from zero, when it is
82523 *   half way there. Making 1.5 into 2 and -1.5 into -2.
82524 *   PHP_ROUND_HALF_DOWN Round {@link val} down to {@link precision}
82525 *   decimal places towards zero, when it is half way there. Making 1.5
82526 *   into 1 and -1.5 into -1. PHP_ROUND_HALF_EVEN Round {@link val} to
82527 *   {@link precision} decimal places towards the nearest even value.
82528 *   PHP_ROUND_HALF_ODD Round {@link val} to {@link precision} decimal
82529 *   places towards the nearest odd value.
82530 * @return float The value rounded to the given {@link precision} as a
82531 *   .
82532 * @since PHP 4, PHP 5, PHP 7
82533 **/
82534function round($val, $precision, $mode){}
82535
82536/**
82537 * Add tag retrieved in query
82538 *
82539 * Add an additional retrieved tag in subsequent queries.
82540 *
82541 * @param int $tag One of RPMTAG_* constant, see the rpminfo constants
82542 *   page.
82543 * @return bool
82544 * @since PECL rpminfo >= 0.5.0
82545 **/
82546function rpmaddtag($tag){}
82547
82548/**
82549 * Get information from installed RPM
82550 *
82551 * Retrieve information about an installed package, from the system RPM
82552 * database.
82553 *
82554 * @param string $nevr Name with optional epoch, version and release.
82555 * @param bool $full If TRUE all information headers for the file are
82556 *   retrieved, else only a minimal set.
82557 * @return array An array of array of information or NULL on error.
82558 * @since PECL rpminfo >= 0.2.0
82559 **/
82560function rpmdbinfo($nevr, $full){}
82561
82562/**
82563 * Search RPM packages
82564 *
82565 * Search packages in the system RPM database.
82566 *
82567 * @param string $pattern Value to search for.
82568 * @param int $rpmtag Search criterion, one of RPMTAG_* constant, see
82569 *   the rpminfo constants page.
82570 * @param int $rpmmire Pattern type, one of RPMMIRE_* constant, see the
82571 *   rpminfo constants page. When < 0 the criterion must equals the
82572 *   value, and database index is used if possible.
82573 * @param bool $full If TRUE all information headers for the file are
82574 *   retrieved, else only a minimal set.
82575 * @return array An array of array of information or NULL on error.
82576 * @since PECL rpminfo >= 0.3.0
82577 **/
82578function rpmdbsearch($pattern, $rpmtag, $rpmmire, $full){}
82579
82580/**
82581 * Get information from a RPM file
82582 *
82583 * Retrieve information about a local file, a RPM package.
82584 *
82585 * @param string $path Path of the RPM file.
82586 * @param bool $full If TRUE all information headers for the file are
82587 *   retrieved, else only a minimal set.
82588 * @param string $error If provided, will receive the possible error
82589 *   message, and will avoid a runtime warning.
82590 * @return array An array of information or NULL on error.
82591 * @since PECL rpminfo >= 0.1.0
82592 **/
82593function rpminfo($path, $full, &$error){}
82594
82595/**
82596 * RPM version comparison
82597 *
82598 * Compare 2 RPM versions.
82599 *
82600 * @param string $evr1 First epoch:version-release string
82601 * @param string $evr2 Second epoch:version-release string
82602 * @return int Returns < 0 if evr1 is less than evr2, > 0 if evr1 is
82603 *   greater than evr2, and 0 if they are equal.
82604 * @since PECL rpminfo >= 0.1.0
82605 **/
82606function rpmvercmp($evr1, $evr2){}
82607
82608/**
82609 * Closes an RPM file
82610 *
82611 * {@link rpm_close} will close an RPM file pointer.
82612 *
82613 * @param resource $rpmr A file pointer resource successfully opened by
82614 *   {@link rpm_open}.
82615 * @return bool
82616 * @since PECL rpmreader >= 0.1.0
82617 **/
82618function rpm_close($rpmr){}
82619
82620/**
82621 * Retrieves a header tag from an RPM file
82622 *
82623 * {@link rpm_get_tag} will retrieve a given tag from the RPM file's
82624 * header and return it.
82625 *
82626 * @param resource $rpmr A file pointer resource successfully opened by
82627 *   {@link rpm_open}.
82628 * @param int $tagnum The tag number to retrieve from the RPM header.
82629 *   This value can be specified using the list of constants defined by
82630 *   this module.
82631 * @return mixed The return value can be of various types depending on
82632 *   the {@link tagnum} supplied to the function.
82633 * @since PECL rpmreader >= 0.1.0
82634 **/
82635function rpm_get_tag($rpmr, $tagnum){}
82636
82637/**
82638 * Tests a filename for validity as an RPM file
82639 *
82640 * {@link rpm_is_valid} will test an RPM file for validity as an RPM
82641 * file. This is not the same as {@link rpm_open} as it only checks the
82642 * file for validity but does not return a file pointer to be used by
82643 * further functions.
82644 *
82645 * @param string $filename The filename of the RPM file you wish to
82646 *   check for validity.
82647 * @return bool
82648 * @since PECL rpmreader >= 0.1.0
82649 **/
82650function rpm_is_valid($filename){}
82651
82652/**
82653 * Opens an RPM file
82654 *
82655 * {@link rpm_open} will open an RPM file and will determine if the file
82656 * is a valid RPM file.
82657 *
82658 * @param string $filename The filename of the RPM file you wish to
82659 *   open.
82660 * @return resource If the open succeeds, then {@link rpm_open} will
82661 *   return a file pointer resource to the newly opened file. On error,
82662 *   the function will return FALSE.
82663 * @since PECL rpmreader >= 0.1.0
82664 **/
82665function rpm_open($filename){}
82666
82667/**
82668 * Returns a string representing the current version of the rpmreader
82669 * extension
82670 *
82671 * {@link rpm_version} will return the current version of the rpmreader
82672 * extension.
82673 *
82674 * @return string {@link rpm_version} will return a string representing
82675 *   the rpmreader version currently loaded in PHP.
82676 * @since PECL rpmreader >= 0.3.0
82677 **/
82678function rpm_version(){}
82679
82680/**
82681 * Close any outstanding connection to rrd caching daemon
82682 *
82683 * This function is automatically called when the whole PHP process is
82684 * terminated. It depends on used SAPI. For example, it's called
82685 * automatically at the end of command line script.
82686 *
82687 * It's up user whether he wants to call this function at the end of
82688 * every request or otherwise.
82689 *
82690 * @return void
82691 * @since PECL rrd >= 1.1.2
82692 **/
82693function rrdc_disconnect(){}
82694
82695/**
82696 * Creates rrd database file
82697 *
82698 * Creates the rdd database file.
82699 *
82700 * @param string $filename Filename for newly created rrd file.
82701 * @param array $options Options for rrd create - list of strings. See
82702 *   man page of rrd create for whole list of options.
82703 * @return bool
82704 * @since PECL rrd >= 0.9.0
82705 **/
82706function rrd_create($filename, $options){}
82707
82708/**
82709 * Gets latest error message
82710 *
82711 * Returns latest global rrd error message.
82712 *
82713 * @return string Latest error message.
82714 * @since PECL rrd >= 0.9.0
82715 **/
82716function rrd_error(){}
82717
82718/**
82719 * Fetch the data for graph as array
82720 *
82721 * Gets data for graph output from RRD database file as array. This
82722 * function has same result as {@link rrd_graph}, but fetched data are
82723 * returned as array, no image file is created.
82724 *
82725 * @param string $filename RRD database file name.
82726 * @param array $options Array of options for resolution specification.
82727 * @return array Returns information about retrieved graph data.
82728 * @since PECL rrd >= 0.9.0
82729 **/
82730function rrd_fetch($filename, $options){}
82731
82732/**
82733 * Gets the timestamp of the first sample from rrd file
82734 *
82735 * Returns the first data sample from the specified RRA of the RRD file.
82736 *
82737 * @param string $file RRD database file name.
82738 * @param int $raaindex The index number of the RRA that is to be
82739 *   examined. Default value is 0.
82740 * @return int Integer number of unix timestamp, FALSE if some error
82741 *   occurs.
82742 * @since PECL rrd >= 0.9.0
82743 **/
82744function rrd_first($file, $raaindex){}
82745
82746/**
82747 * Creates image from a data
82748 *
82749 * Creates image for a particular data from RRD file.
82750 *
82751 * @param string $filename The filename to output the graph to. This
82752 *   will generally end in either .png, .svg or .eps, depending on the
82753 *   format you want to output.
82754 * @param array $options Options for generating image. See man page of
82755 *   rrd graph for all possible options. All options (data definitions,
82756 *   variable defintions, etc.) are allowed.
82757 * @return array Array with information about generated image is
82758 *   returned, FALSE when error occurs.
82759 * @since PECL rrd >= 0.9.0
82760 **/
82761function rrd_graph($filename, $options){}
82762
82763/**
82764 * Gets information about rrd file
82765 *
82766 * Returns information about particular RRD database file.
82767 *
82768 * @param string $filename RRD database file name.
82769 * @return array Array with information about requsted RRD file, FALSE
82770 *   when error occurs.
82771 * @since PECL rrd >= 0.9.0
82772 **/
82773function rrd_info($filename){}
82774
82775/**
82776 * Gets unix timestamp of the last sample
82777 *
82778 * Returns the UNIX timestamp of the most recent update of the RRD
82779 * database.
82780 *
82781 * @param string $filename RRD database file name.
82782 * @return int Integer as unix timestamp of the most recent data from
82783 *   the RRD database.
82784 * @since PECL rrd >= 0.9.0
82785 **/
82786function rrd_last($filename){}
82787
82788/**
82789 * Gets information about last updated data
82790 *
82791 * Gets array of the UNIX timestamp and the values stored for each date
82792 * in the most recent update of the RRD database file.
82793 *
82794 * @param string $filename RRD database file name.
82795 * @return array Array of information about last update, FALSE when
82796 *   error occurs.
82797 * @since PECL rrd >= 0.9.0
82798 **/
82799function rrd_lastupdate($filename){}
82800
82801/**
82802 * Restores the RRD file from XML dump
82803 *
82804 * Restores the RRD file from the XML dump.
82805 *
82806 * @param string $xml_file XML filename with the dump of the original
82807 *   RRD database file.
82808 * @param string $rrd_file Restored RRD database file name.
82809 * @param array $options Array of options for restoring. See man page
82810 *   for rrd restore.
82811 * @return bool Returns TRUE on success, FALSE otherwise.
82812 * @since PECL rrd >= 0.9.0
82813 **/
82814function rrd_restore($xml_file, $rrd_file, $options){}
82815
82816/**
82817 * Tunes some RRD database file header options
82818 *
82819 * Change some options in the RRD dabase header file. E.g. renames the
82820 * source for the data etc.
82821 *
82822 * @param string $filename RRD database file name.
82823 * @param array $options Options with RRD database file properties
82824 *   which will be changed. See rrd tune man page for details.
82825 * @return bool Returns TRUE on success, FALSE otherwise.
82826 * @since PECL rrd >= 0.9.0
82827 **/
82828function rrd_tune($filename, $options){}
82829
82830/**
82831 * Updates the RRD database
82832 *
82833 * Updates the RRD database file. The input data is time interpolated
82834 * according to the properties of the RRD database file.
82835 *
82836 * @param string $filename RRD database file name. This database will
82837 *   be updated.
82838 * @param array $options Options for updating the RRD database. This is
82839 *   list of strings. See man page of rrd update for whole list of
82840 *   options.
82841 * @return bool Returns TRUE on success, FALSE when error occurs.
82842 * @since PECL rrd >= 0.9.0
82843 **/
82844function rrd_update($filename, $options){}
82845
82846/**
82847 * Gets information about underlying rrdtool library
82848 *
82849 * Returns information about underlying rrdtool library.
82850 *
82851 * @return string String with rrdtool version number e.g. "1.4.3".
82852 * @since PECL rrd >= 1.0.0
82853 **/
82854function rrd_version(){}
82855
82856/**
82857 * Exports the information about RRD database
82858 *
82859 * Exports the information about RRD database file. This data can be
82860 * converted to XML file via user space PHP script and then restored back
82861 * as RRD database file.
82862 *
82863 * @param array $options Array of options for the export, see rrd xport
82864 *   man page.
82865 * @return array Array with information about RRD database file, FALSE
82866 *   when error occurs.
82867 * @since PECL rrd >= 0.9.0
82868 **/
82869function rrd_xport($options){}
82870
82871/**
82872 * Sort an array in reverse order
82873 *
82874 * This function sorts an array in reverse order (highest to lowest).
82875 *
82876 * @param array $array The input array.
82877 * @param int $sort_flags You may modify the behavior of the sort using
82878 *   the optional parameter {@link sort_flags}, for details see {@link
82879 *   sort}.
82880 * @return bool
82881 * @since PHP 4, PHP 5, PHP 7
82882 **/
82883function rsort(&$array, $sort_flags){}
82884
82885/**
82886 * Strip whitespace (or other characters) from the end of a string
82887 *
82888 * This function returns a string with whitespace (or other characters)
82889 * stripped from the end of {@link str}.
82890 *
82891 * Without the second parameter, {@link rtrim} will strip these
82892 * characters: " " (ASCII 32 (0x20)), an ordinary space. "\t" (ASCII 9
82893 * (0x09)), a tab. "\n" (ASCII 10 (0x0A)), a new line (line feed). "\r"
82894 * (ASCII 13 (0x0D)), a carriage return. "\0" (ASCII 0 (0x00)), the
82895 * NULL-byte. "\x0B" (ASCII 11 (0x0B)), a vertical tab.
82896 *
82897 * @param string $str The input string.
82898 * @param string $character_mask You can also specify the characters
82899 *   you want to strip, by means of the {@link character_mask} parameter.
82900 *   Simply list all characters that you want to be stripped. With .. you
82901 *   can specify a range of characters.
82902 * @return string Returns the modified string.
82903 * @since PHP 4, PHP 5, PHP 7
82904 **/
82905function rtrim($str, $character_mask){}
82906
82907/**
82908 * Similar to define(), but allows defining in class definitions as well
82909 *
82910 * @param string $constname Name of constant to declare. Either a
82911 *   string to indicate a global constant, or classname::constname to
82912 *   indicate a class constant.
82913 * @param mixed $value NULL, Bool, Long, Double, String, Array, or
82914 *   Resource value to store in the new constant.
82915 * @param int $newVisibility Visibility of the constant, for class
82916 *   constants. Public by default. One of the RUNKIT7_ACC_* constants.
82917 * @return bool
82918 * @since PECL runkit7 >= Unknown
82919 **/
82920function runkit7_constant_add($constname, $value, $newVisibility){}
82921
82922/**
82923 * Redefine an already defined constant
82924 *
82925 * @param string $constname Constant to redefine. Either the name of a
82926 *   global constant, or classname::constname indicating class constant.
82927 * @param mixed $value Value to assign to the constant.
82928 * @param string $newVisibility The new visibility of the constant, for
82929 *   class constants. Unchanged by default. One of the RUNKIT7_ACC_*
82930 *   constants.
82931 * @return bool
82932 * @since PECL runkit7 >= Unknown
82933 **/
82934function runkit7_constant_redefine($constname, $value, $newVisibility){}
82935
82936/**
82937 * Remove/Delete an already defined constant
82938 *
82939 * @param string $constname Name of the constant to remove. Either the
82940 *   name of a global constant, or classname::constname indicating a
82941 *   class constant.
82942 * @return bool
82943 * @since PECL runkit7 >= Unknown
82944 **/
82945function runkit7_constant_remove($constname){}
82946
82947/**
82948 * Add a new function, similar to
82949 *
82950 * @param string $funcname Name of the function to be created
82951 * @param string $arglist Comma separated argument list
82952 * @param string $code Code making up the function
82953 * @param bool $return_by_reference A closure that defines the
82954 *   function.
82955 * @param string $doc_comment Whether the function should return by
82956 *   reference.
82957 * @param string $return_type The doc comment of the function.
82958 * @param bool $is_strict The return type of the function.
82959 * @return bool
82960 * @since PECL runkit7 >= Unknown
82961 **/
82962function runkit7_function_add($funcname, $arglist, $code, $return_by_reference, $doc_comment, $return_type, $is_strict){}
82963
82964/**
82965 * Copy a function to a new function name
82966 *
82967 * @param string $funcname Name of the existing function
82968 * @param string $targetname Name of the new function to copy the
82969 *   definition to
82970 * @return bool
82971 * @since PECL runkit7 >= Unknown
82972 **/
82973function runkit7_function_copy($funcname, $targetname){}
82974
82975/**
82976 * Replace a function definition with a new implementation
82977 *
82978 * @param string $funcname Name of function to redefine
82979 * @param string $arglist New list of arguments to be accepted by
82980 *   function
82981 * @param string $code New code implementation
82982 * @param bool $return_by_reference A closure that defines the
82983 *   function.
82984 * @param string $doc_comment Whether the function should return by
82985 *   reference.
82986 * @param string $return_type The doc comment of the function.
82987 * @param string $is_strict The return type of the function.
82988 * @return bool
82989 * @since PECL runkit7 >= Unknown
82990 **/
82991function runkit7_function_redefine($funcname, $arglist, $code, $return_by_reference, $doc_comment, $return_type, $is_strict){}
82992
82993/**
82994 * Remove a function definition
82995 *
82996 * @param string $funcname Name of the function to be deleted
82997 * @return bool
82998 * @since PECL runkit7 >= Unknown
82999 **/
83000function runkit7_function_remove($funcname){}
83001
83002/**
83003 * Change a function's name
83004 *
83005 * @param string $funcname Current function name
83006 * @param string $newname New function name
83007 * @return bool
83008 * @since PECL runkit7 >= Unknown
83009 **/
83010function runkit7_function_rename($funcname, $newname){}
83011
83012/**
83013 * Process a PHP file importing function and class definitions,
83014 * overwriting where appropriate
83015 *
83016 * Similar to {@link include}. However, any code residing outside of a
83017 * function or class is simply ignored. Additionally, depending on the
83018 * value of {@link flags}, any functions or classes which already exist
83019 * in the currently running environment may be automatically overwritten
83020 * by their new definitions.
83021 *
83022 * @param string $filename Filename to import function and class
83023 *   definitions from
83024 * @param int $flags Bitwise OR of the RUNKIT7_IMPORT_* family of
83025 *   constants.
83026 * @return bool
83027 * @since PECL runkit7 >= Unknown
83028 **/
83029function runkit7_import($filename, $flags){}
83030
83031/**
83032 * Dynamically adds a new method to a given class
83033 *
83034 * @param string $classname The class to which this method will be
83035 *   added
83036 * @param string $methodname The name of the method to add
83037 * @param string $args Comma-delimited list of arguments for the
83038 *   newly-created method
83039 * @param string $code The code to be evaluated when {@link methodname}
83040 *   is called
83041 * @param int $flags A closure that defines the method.
83042 * @param string $doc_comment The type of method to create, can be
83043 *   RUNKIT7_ACC_PUBLIC, RUNKIT7_ACC_PROTECTED or RUNKIT7_ACC_PRIVATE
83044 *   optionally combined via bitwise OR with RUNKIT7_ACC_STATIC
83045 * @param string $return_type The doc comment of the method.
83046 * @param bool $is_strict The return type of the method.
83047 * @return bool
83048 * @since PECL runkit7 >= Unknown
83049 **/
83050function runkit7_method_add($classname, $methodname, $args, $code, $flags, $doc_comment, $return_type, $is_strict){}
83051
83052/**
83053 * Copies a method from class to another
83054 *
83055 * @param string $dClass Destination class for copied method
83056 * @param string $dMethod Destination method name
83057 * @param string $sClass Source class of the method to copy
83058 * @param string $sMethod Name of the method to copy from the source
83059 *   class. If this parameter is omitted, the value of {@link dMethod} is
83060 *   assumed.
83061 * @return bool
83062 * @since PECL runkit7 >= Unknown
83063 **/
83064function runkit7_method_copy($dClass, $dMethod, $sClass, $sMethod){}
83065
83066/**
83067 * Dynamically changes the code of the given method
83068 *
83069 * @param string $classname The class in which to redefine the method
83070 * @param string $methodname The name of the method to redefine
83071 * @param string $args Comma-delimited list of arguments for the
83072 *   redefined method
83073 * @param string $code The new code to be evaluated when {@link
83074 *   methodname} is called
83075 * @param int $flags A closure that defines the method.
83076 * @param string $doc_comment The redefined method can be
83077 *   RUNKIT7_ACC_PUBLIC, RUNKIT7_ACC_PROTECTED or RUNKIT7_ACC_PRIVATE
83078 *   optionally combined via bitwise OR with RUNKIT7_ACC_STATIC
83079 * @param string $return_type The doc comment of the method.
83080 * @param bool $is_strict The return type of the method.
83081 * @return bool
83082 * @since PECL runkit7 >= Unknown
83083 **/
83084function runkit7_method_redefine($classname, $methodname, $args, $code, $flags, $doc_comment, $return_type, $is_strict){}
83085
83086/**
83087 * Dynamically removes the given method
83088 *
83089 * @param string $classname The class in which to remove the method
83090 * @param string $methodname The name of the method to remove
83091 * @return bool
83092 * @since PECL runkit7 >= Unknown
83093 **/
83094function runkit7_method_remove($classname, $methodname){}
83095
83096/**
83097 * Dynamically changes the name of the given method
83098 *
83099 * @param string $classname The class in which to rename the method
83100 * @param string $methodname The name of the method to rename
83101 * @param string $newname The new name to give to the renamed method
83102 * @return bool
83103 * @since PECL runkit7 >= Unknown
83104 **/
83105function runkit7_method_rename($classname, $methodname, $newname){}
83106
83107/**
83108 * Return the integer object handle for given object
83109 *
83110 * This function returns a unique identifier for the object. The object
83111 * id is unique for the lifetime of the object. Once the object is
83112 * destroyed, its id may be reused for other objects. This behavior is
83113 * similar to {@link spl_object_hash}.
83114 *
83115 * @param object $obj Any object.
83116 * @return int An integer identifier that is unique for each currently
83117 *   existing object and is always the same for each object.
83118 * @since PECL runkit7 >= Unknown
83119 **/
83120function runkit7_object_id($obj){}
83121
83122/**
83123 * Return numerically indexed array of registered superglobals
83124 *
83125 * @return array Returns a numerically indexed array of the currently
83126 *   registered superglobals. i.e. _GET, _POST, _REQUEST, _COOKIE,
83127 *   _SESSION, _SERVER, _ENV, _FILES
83128 * @since PECL runkit7 >= Unknown
83129 **/
83130function runkit7_superglobals(){}
83131
83132/**
83133 * Returns information about the passed in value with data types,
83134 * reference counts, etc
83135 *
83136 * @param string $value The value to return the representation of
83137 * @return array
83138 * @since PECL runkit7 >= Unknown
83139 **/
83140function runkit7_zval_inspect($value){}
83141
83142/**
83143 * Convert a base class to an inherited class, add ancestral methods when
83144 * appropriate
83145 *
83146 * @param string $classname Name of class to be adopted
83147 * @param string $parentname Parent class which child class is
83148 *   extending
83149 * @return bool
83150 * @since PECL runkit >= 0.7.0
83151 **/
83152function runkit_class_adopt($classname, $parentname){}
83153
83154/**
83155 * Convert an inherited class to a base class, removes any method whose
83156 * scope is ancestral
83157 *
83158 * @param string $classname Name of class to emancipate
83159 * @return bool
83160 * @since PECL runkit >= 0.7.0
83161 **/
83162function runkit_class_emancipate($classname){}
83163
83164/**
83165 * Similar to define(), but allows defining in class definitions as well
83166 *
83167 * @param string $constname Name of constant to declare. Either a
83168 *   string to indicate a global constant, or classname::constname to
83169 *   indicate a class constant.
83170 * @param mixed $value NULL, Bool, Long, Double, String, or Resource
83171 *   value to store in the new constant.
83172 * @return bool
83173 * @since PECL runkit >= 0.7.0
83174 **/
83175function runkit_constant_add($constname, $value){}
83176
83177/**
83178 * Redefine an already defined constant
83179 *
83180 * @param string $constname Constant to redefine. Either string
83181 *   indicating global constant, or classname::constname indicating class
83182 *   constant.
83183 * @param mixed $newvalue New value to assign to constant.
83184 * @return bool
83185 * @since PECL runkit >= 0.7.0
83186 **/
83187function runkit_constant_redefine($constname, $newvalue){}
83188
83189/**
83190 * Remove/Delete an already defined constant
83191 *
83192 * @param string $constname Name of constant to remove. Either a string
83193 *   indicating a global constant, or classname::constname indicating a
83194 *   class constant.
83195 * @return bool
83196 * @since PECL runkit >= 0.7.0
83197 **/
83198function runkit_constant_remove($constname){}
83199
83200/**
83201 * Add a new function, similar to
83202 *
83203 * @param string $funcname Name of function to be created
83204 * @param string $arglist Comma separated argument list
83205 * @param string $code Code making up the function
83206 * @param bool $return_by_reference A closure that defines the
83207 *   function.
83208 * @param string $doc_comment Whether the function should return by
83209 *   reference.
83210 * @return bool
83211 * @since PECL runkit >= 0.7.0
83212 **/
83213function runkit_function_add($funcname, $arglist, $code, $return_by_reference, $doc_comment){}
83214
83215/**
83216 * Copy a function to a new function name
83217 *
83218 * @param string $funcname Name of existing function
83219 * @param string $targetname Name of new function to copy definition to
83220 * @return bool
83221 * @since PECL runkit >= 0.7.0
83222 **/
83223function runkit_function_copy($funcname, $targetname){}
83224
83225/**
83226 * Replace a function definition with a new implementation
83227 *
83228 * @param string $funcname Name of function to redefine
83229 * @param string $arglist New list of arguments to be accepted by
83230 *   function
83231 * @param string $code New code implementation
83232 * @param bool $return_by_reference A closure that defines the
83233 *   function.
83234 * @param string $doc_comment Whether the function should return by
83235 *   reference.
83236 * @return bool
83237 * @since PECL runkit >= 0.7.0
83238 **/
83239function runkit_function_redefine($funcname, $arglist, $code, $return_by_reference, $doc_comment){}
83240
83241/**
83242 * Remove a function definition
83243 *
83244 * @param string $funcname Name of function to be deleted
83245 * @return bool
83246 * @since PECL runkit >= 0.7.0
83247 **/
83248function runkit_function_remove($funcname){}
83249
83250/**
83251 * Change a function's name
83252 *
83253 * @param string $funcname Current function name
83254 * @param string $newname New function name
83255 * @return bool
83256 * @since PECL runkit >= 0.7.0
83257 **/
83258function runkit_function_rename($funcname, $newname){}
83259
83260/**
83261 * Process a PHP file importing function and class definitions,
83262 * overwriting where appropriate
83263 *
83264 * Similar to {@link include} however any code residing outside of a
83265 * function or class is simply ignored. Additionally, depending on the
83266 * value of {@link flags}, any functions or classes which already exist
83267 * in the currently running environment may be automatically overwritten
83268 * by their new definitions.
83269 *
83270 * @param string $filename Filename to import function and class
83271 *   definitions from
83272 * @param int $flags Bitwise OR of the RUNKIT_IMPORT_* family of
83273 *   constants.
83274 * @return bool
83275 * @since PECL runkit >= 0.7.0
83276 **/
83277function runkit_import($filename, $flags){}
83278
83279/**
83280 * Check the PHP syntax of the specified php code
83281 *
83282 * The {@link runkit_lint} function performs a syntax (lint) check on the
83283 * specified php code testing for scripting errors. This is similar to
83284 * using php -l from the command line except {@link runkit_lint} accepts
83285 * actual code rather than a filename.
83286 *
83287 * @param string $code PHP Code to be lint checked
83288 * @return bool
83289 * @since PECL runkit >= 0.7.0
83290 **/
83291function runkit_lint($code){}
83292
83293/**
83294 * Check the PHP syntax of the specified file
83295 *
83296 * The {@link runkit_lint_file} function performs a syntax (lint) check
83297 * on the specified filename testing for scripting errors. This is
83298 * similar to using php -l from the commandline.
83299 *
83300 * @param string $filename File containing PHP Code to be lint checked
83301 * @return bool
83302 * @since PECL runkit >= 0.7.0
83303 **/
83304function runkit_lint_file($filename){}
83305
83306/**
83307 * Dynamically adds a new method to a given class
83308 *
83309 * @param string $classname The class to which this method will be
83310 *   added
83311 * @param string $methodname The name of the method to add
83312 * @param string $args Comma-delimited list of arguments for the
83313 *   newly-created method
83314 * @param string $code The code to be evaluated when {@link methodname}
83315 *   is called
83316 * @param int $flags A closure that defines the method.
83317 * @param string $doc_comment The type of method to create, can be
83318 *   RUNKIT_ACC_PUBLIC, RUNKIT_ACC_PROTECTED or RUNKIT_ACC_PRIVATE
83319 *   optionally combined via bitwise OR with RUNKIT_ACC_STATIC (since
83320 *   1.0.1)
83321 * @return bool
83322 * @since PECL runkit >= 0.7.0
83323 **/
83324function runkit_method_add($classname, $methodname, $args, $code, $flags, $doc_comment){}
83325
83326/**
83327 * Copies a method from class to another
83328 *
83329 * @param string $dClass Destination class for copied method
83330 * @param string $dMethod Destination method name
83331 * @param string $sClass Source class of the method to copy
83332 * @param string $sMethod Name of the method to copy from the source
83333 *   class. If this parameter is omitted, the value of {@link dMethod} is
83334 *   assumed.
83335 * @return bool
83336 * @since PECL runkit >= 0.7.0
83337 **/
83338function runkit_method_copy($dClass, $dMethod, $sClass, $sMethod){}
83339
83340/**
83341 * Dynamically changes the code of the given method
83342 *
83343 * @param string $classname The class in which to redefine the method
83344 * @param string $methodname The name of the method to redefine
83345 * @param string $args Comma-delimited list of arguments for the
83346 *   redefined method
83347 * @param string $code The new code to be evaluated when {@link
83348 *   methodname} is called
83349 * @param int $flags A closure that defines the method.
83350 * @param string $doc_comment The redefined method can be
83351 *   RUNKIT_ACC_PUBLIC, RUNKIT_ACC_PROTECTED or RUNKIT_ACC_PRIVATE
83352 *   optionally combined via bitwise OR with RUNKIT_ACC_STATIC (since
83353 *   1.0.1)
83354 * @return bool
83355 * @since PECL runkit >= 0.7.0
83356 **/
83357function runkit_method_redefine($classname, $methodname, $args, $code, $flags, $doc_comment){}
83358
83359/**
83360 * Dynamically removes the given method
83361 *
83362 * @param string $classname The class in which to remove the method
83363 * @param string $methodname The name of the method to remove
83364 * @return bool
83365 * @since PECL runkit >= 0.7.0
83366 **/
83367function runkit_method_remove($classname, $methodname){}
83368
83369/**
83370 * Dynamically changes the name of the given method
83371 *
83372 * @param string $classname The class in which to rename the method
83373 * @param string $methodname The name of the method to rename
83374 * @param string $newname The new name to give to the renamed method
83375 * @return bool
83376 * @since PECL runkit >= 0.7.0
83377 **/
83378function runkit_method_rename($classname, $methodname, $newname){}
83379
83380/**
83381 * Determines if the current functions return value will be used
83382 *
83383 * @return bool Returns TRUE if the function's return value is used by
83384 *   the calling scope, otherwise FALSE
83385 * @since PECL runkit >= 0.8.0
83386 **/
83387function runkit_return_value_used(){}
83388
83389/**
83390 * Specify a function to capture and/or process output from a runkit
83391 * sandbox
83392 *
83393 * Ordinarily, anything output (such as with {@link echo} or {@link
83394 * print}) will be output as though it were printed from the parent's
83395 * scope. Using {@link runkit_sandbox_output_handler} however, output
83396 * generated by the sandbox (including errors), can be captured by a
83397 * function outside of the sandbox.
83398 *
83399 * @param object $sandbox Object instance of Runkit_Sandbox class on
83400 *   which to set output handling.
83401 * @param mixed $callback Name of a function which expects one
83402 *   parameter. Output generated by {@link sandbox} will be passed to
83403 *   this callback. Anything returned by the callback will be displayed
83404 *   normally. If this parameter is not passed then output handling will
83405 *   not be changed. If a non-truth value is passed, output handling will
83406 *   be disabled and will revert to direct display.
83407 * @return mixed Returns the name of the previously defined output
83408 *   handler callback, or FALSE if no handler was previously defined.
83409 * @since PECL runkit >= 0.7.0
83410 **/
83411function runkit_sandbox_output_handler($sandbox, $callback){}
83412
83413/**
83414 * Return numerically indexed array of registered superglobals
83415 *
83416 * @return array Returns a numerically indexed array of the currently
83417 *   registered superglobals. i.e. _GET, _POST, _REQUEST, _COOKIE,
83418 *   _SESSION, _SERVER, _ENV, _FILES
83419 * @since PECL runkit >= 0.7.0
83420 **/
83421function runkit_superglobals(){}
83422
83423/**
83424 * Convert string from one codepage to another
83425 *
83426 * @param int|string $in_codepage The codepage of the {@link subject}
83427 *   string. Either the codepage name or identifier.
83428 * @param int|string $out_codepage The codepage to convert the {@link
83429 *   subject} string to. Either the codepage name or identifier.
83430 * @param string $subject The string to convert.
83431 * @return string The {@link subject} string converted to {@link
83432 *   out_codepage}, or NULL on failure.
83433 * @since PHP 7 >= 7.1.0
83434 **/
83435function sapi_windows_cp_conv($in_codepage, $out_codepage, $subject){}
83436
83437/**
83438 * Get process codepage
83439 *
83440 * Get the identifier of the codepage of the current process.
83441 *
83442 * @param string $kind The kind of codepage: either 'ansi' or 'oem'.
83443 * @return int Returns the codepage identifier.
83444 * @since PHP 7 >= 7.1.0
83445 **/
83446function sapi_windows_cp_get($kind){}
83447
83448/**
83449 * Indicates whether the codepage is UTF-8 compatible
83450 *
83451 * Indicates whether the codepage of the current process is UTF-8
83452 * compatible.
83453 *
83454 * @return bool Returns whether the codepage of the current process is
83455 *   UTF-8 compatible.
83456 * @since PHP 7 >= 7.1.0
83457 **/
83458function sapi_windows_cp_is_utf8(){}
83459
83460/**
83461 * Set process codepage
83462 *
83463 * Set the codepage of the current process.
83464 *
83465 * @param int $cp A codepage identifier.
83466 * @return bool
83467 * @since PHP 7 >= 7.1.0
83468 **/
83469function sapi_windows_cp_set($cp){}
83470
83471/**
83472 * Send a CTRL event to another process
83473 *
83474 * Sends a CTRL event to another process in the same process group.
83475 *
83476 * @param int $event The CTRL even to send; either
83477 *   PHP_WINDOWS_EVENT_CTRL_C or PHP_WINDOWS_EVENT_CTRL_BREAK.
83478 * @param int $pid The ID of the process to which to send the event to.
83479 *   If 0 is given, the event is sent to all processes of the process
83480 *   group.
83481 * @return bool
83482 * @since PHP 7 >= 7.4.0
83483 **/
83484function sapi_windows_generate_ctrl_event($event, $pid){}
83485
83486/**
83487 * Set or remove a CTRL event handler
83488 *
83489 * Sets or removes a CTRL event handler, which allows Windows CLI
83490 * processes to intercept or ignore CTRL+C and CTRL+BREAK events. Note
83491 * that in multithreaded environments, this is only possible when called
83492 * from the main thread.
83493 *
83494 * @param callable $callable A callback function to set or remove. If
83495 *   set, this function will be called whenever a CTRL+C or CTRL+BREAK
83496 *   event occurs. The function is supposed to have the following
83497 *   signature: voidhandler int{@link event} {@link event} The CTRL event
83498 *   which has been received; either PHP_WINDOWS_EVENT_CTRL_C or
83499 *   PHP_WINDOWS_EVENT_CTRL_BREAK. Setting a NULL {@link callable} causes
83500 *   the process to ignore CTRL+C events, but not CTRL+BREAK events.
83501 * @param bool $add
83502 * @return bool
83503 * @since PHP 7 >= 7.4.0
83504 **/
83505function sapi_windows_set_ctrl_handler($callable, $add){}
83506
83507/**
83508 * Get or set VT100 support for the specified stream associated to an
83509 * output buffer of a Windows console.
83510 *
83511 * If {@link enable} is omitted, the function returns TRUE if the stream
83512 * {@link stream} has VT100 control codes enabled, FALSE otherwise.
83513 *
83514 * If {@link enable} is specified, the function will try to enable or
83515 * disable the VT100 features of the stream {@link stream}. If the
83516 * feature has been successfully enabled (or disabled), the function will
83517 * return TRUE, or FALSE otherwise.
83518 *
83519 * At startup, PHP tries to enable the VT100 feature of the STDOUT/STDERR
83520 * streams. By the way, if those streams are redirected to a file, the
83521 * VT100 features may not be enabled.
83522 *
83523 * If VT100 support is enabled, it is possible to use control sequences
83524 * as they are known from the VT100 terminal. They allow the modification
83525 * of the terminal's output. On Windows these sequences are called
83526 * Console Virtual Terminal Sequences.
83527 *
83528 * @param resource $stream The stream on which the function will
83529 *   operate.
83530 * @param bool $enable If specified, the VT100 feature will be enabled
83531 *   (if TRUE) or disabled (if FALSE).
83532 * @return bool If {@link enable} is not specified: returns TRUE if the
83533 *   VT100 feature is enabled, FALSE otherwise.
83534 * @since PHP 7 >= 7.2.0
83535 **/
83536function sapi_windows_vt100_support($stream, $enable){}
83537
83538/**
83539 * List files and directories inside the specified path
83540 *
83541 * Returns an array of files and directories from the {@link directory}.
83542 *
83543 * @param string $directory The directory that will be scanned.
83544 * @param int $sorting_order By default, the sorted order is
83545 *   alphabetical in ascending order. If the optional {@link
83546 *   sorting_order} is set to SCANDIR_SORT_DESCENDING, then the sort
83547 *   order is alphabetical in descending order. If it is set to
83548 *   SCANDIR_SORT_NONE then the result is unsorted.
83549 * @param resource $context For a description of the {@link context}
83550 *   parameter, refer to the streams section of the manual.
83551 * @return array Returns an array of filenames on success, or FALSE on
83552 *   failure. If {@link directory} is not a directory, then boolean FALSE
83553 *   is returned, and an error of level E_WARNING is generated.
83554 * @since PHP 5, PHP 7
83555 **/
83556function scandir($directory, $sorting_order, $context){}
83557
83558/**
83559 * Returns a list of instrumented calls that have occurred
83560 *
83561 * Returns a list of any instrumented function calls since {@link
83562 * scoutapm_get_calls} was last called. The list is cleared each time the
83563 * function is called.
83564 *
83565 * @return array {@link scoutapm_get_calls} returns an array containing
83566 *   a list of all recorded calls to instrumented function calls.
83567 * @since PECL scoutapm >= 1.0.0
83568 **/
83569function scoutapm_get_calls(){}
83570
83571/**
83572 * List functions scoutapm will instrument.
83573 *
83574 * Returns a list of the functions the extension will instrument.
83575 *
83576 * @return array {@link scoutapm_list_instrumented_functions} returns
83577 *   an array containing a list of all functions that the scoutapm
83578 *   extension is able to instrument in the current installation.
83579 * @since PECL scoutapm >= 1.0.2
83580 **/
83581function scoutapm_list_instrumented_functions(){}
83582
83583/**
83584 * Get SeasLog author.
83585 *
83586 * @return string Return SeasLog author as string.
83587 * @since PECL seaslog >=1.0.0
83588 **/
83589function seaslog_get_author(){}
83590
83591/**
83592 * Get SeasLog version.
83593 *
83594 * @return string Return SeasLog version (SEASLOG_VERSION) as string.
83595 * @since PECL seaslog >=1.0.0
83596 **/
83597function seaslog_get_version(){}
83598
83599/**
83600 * Acquire a semaphore
83601 *
83602 * {@link sem_acquire} by default blocks (if necessary) until the
83603 * semaphore can be acquired. A process attempting to acquire a semaphore
83604 * which it has already acquired will block forever if acquiring the
83605 * semaphore would cause its maximum number of semaphore to be exceeded.
83606 *
83607 * After processing a request, any semaphores acquired by the process but
83608 * not explicitly released will be released automatically and a warning
83609 * will be generated.
83610 *
83611 * @param resource $sem_identifier {@link sem_identifier} is a
83612 *   semaphore resource, obtained from {@link sem_get}.
83613 * @param bool $nowait Specifies if the process shouldn't wait for the
83614 *   semaphore to be acquired. If set to true, the call will return false
83615 *   immediately if a semaphore cannot be immediately acquired.
83616 * @return bool
83617 * @since PHP 4, PHP 5, PHP 7
83618 **/
83619function sem_acquire($sem_identifier, $nowait){}
83620
83621/**
83622 * Get a semaphore id
83623 *
83624 * {@link sem_get} returns an id that can be used to access the System V
83625 * semaphore with the given {@link key}.
83626 *
83627 * A second call to {@link sem_get} for the same key will return a
83628 * different semaphore identifier, but both identifiers access the same
83629 * underlying semaphore.
83630 *
83631 * If {@link key} is 0, a new private semaphore is created for each call
83632 * to {@link sem_get}.
83633 *
83634 * @param int $key
83635 * @param int $max_acquire The number of processes that can acquire the
83636 *   semaphore simultaneously is set to {@link max_acquire}.
83637 * @param int $perm The semaphore permissions. Actually this value is
83638 *   set only if the process finds it is the only process currently
83639 *   attached to the semaphore.
83640 * @param int $auto_release Specifies if the semaphore should be
83641 *   automatically released on request shutdown.
83642 * @return resource Returns a positive semaphore identifier on success,
83643 *   or FALSE on error.
83644 * @since PHP 4, PHP 5, PHP 7
83645 **/
83646function sem_get($key, $max_acquire, $perm, $auto_release){}
83647
83648/**
83649 * Release a semaphore
83650 *
83651 * {@link sem_release} releases the semaphore if it is currently acquired
83652 * by the calling process, otherwise a warning is generated.
83653 *
83654 * After releasing the semaphore, {@link sem_acquire} may be called to
83655 * re-acquire it.
83656 *
83657 * @param resource $sem_identifier A Semaphore resource handle as
83658 *   returned by {@link sem_get}.
83659 * @return bool
83660 * @since PHP 4, PHP 5, PHP 7
83661 **/
83662function sem_release($sem_identifier){}
83663
83664/**
83665 * Remove a semaphore
83666 *
83667 * {@link sem_remove} removes the given semaphore.
83668 *
83669 * After removing the semaphore, it is no longer accessible.
83670 *
83671 * @param resource $sem_identifier A semaphore resource identifier as
83672 *   returned by {@link sem_get}.
83673 * @return bool
83674 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
83675 **/
83676function sem_remove($sem_identifier){}
83677
83678/**
83679 * Generates a storable representation of a value
83680 *
83681 * This is useful for storing or passing PHP values around without losing
83682 * their type and structure.
83683 *
83684 * To make the serialized string into a PHP value again, use {@link
83685 * unserialize}.
83686 *
83687 * @param mixed $value The value to be serialized. {@link serialize}
83688 *   handles all types, except the resource-type and some objects (see
83689 *   note below). You can even {@link serialize} arrays that contain
83690 *   references to itself. Circular references inside the array/object
83691 *   you are serializing will also be stored. Any other reference will be
83692 *   lost. When serializing objects, PHP will attempt to call the member
83693 *   functions __serialize() or __sleep() prior to serialization. This is
83694 *   to allow the object to do any last minute clean-up, etc. prior to
83695 *   being serialized. Likewise, when the object is restored using {@link
83696 *   unserialize} the __unserialize() or __wakeup() member function is
83697 *   called.
83698 * @return string Returns a string containing a byte-stream
83699 *   representation of {@link value} that can be stored anywhere.
83700 * @since PHP 4, PHP 5, PHP 7
83701 **/
83702function serialize($value){}
83703
83704/**
83705 * Discard session array changes and finish session
83706 *
83707 * {@link session_abort} finishes session without saving data. Thus the
83708 * original values in session data are kept.
83709 *
83710 * @return bool
83711 * @since PHP 5 >= 5.6.0, PHP 7
83712 **/
83713function session_abort(){}
83714
83715/**
83716 * Return current cache expire
83717 *
83718 * {@link session_cache_expire} returns the current setting of
83719 * session.cache_expire.
83720 *
83721 * The cache expire is reset to the default value of 180 stored in
83722 * session.cache_expire at request startup time. Thus, you need to call
83723 * {@link session_cache_expire} for every request (and before {@link
83724 * session_start} is called).
83725 *
83726 * @param string $new_cache_expire If {@link new_cache_expire} is
83727 *   given, the current cache expire is replaced with {@link
83728 *   new_cache_expire}.
83729 *
83730 *   Setting {@link new_cache_expire} is of value only, if
83731 *   session.cache_limiter is set to a value different from nocache.
83732 * @return int Returns the current setting of session.cache_expire. The
83733 *   value returned should be read in minutes, defaults to 180.
83734 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
83735 **/
83736function session_cache_expire($new_cache_expire){}
83737
83738/**
83739 * Get and/or set the current cache limiter
83740 *
83741 * {@link session_cache_limiter} returns the name of the current cache
83742 * limiter.
83743 *
83744 * The cache limiter defines which cache control HTTP headers are sent to
83745 * the client. These headers determine the rules by which the page
83746 * content may be cached by the client and intermediate proxies. Setting
83747 * the cache limiter to nocache disallows any client/proxy caching. A
83748 * value of public permits caching by proxies and the client, whereas
83749 * private disallows caching by proxies and permits the client to cache
83750 * the contents.
83751 *
83752 * In private mode, the Expire header sent to the client may cause
83753 * confusion for some browsers, including Mozilla. You can avoid this
83754 * problem by using private_no_expire mode. The Expire header is never
83755 * sent to the client in this mode.
83756 *
83757 * Setting the cache limiter to '' will turn off automatic sending of
83758 * cache headers entirely.
83759 *
83760 * The cache limiter is reset to the default value stored in
83761 * session.cache_limiter at request startup time. Thus, you need to call
83762 * {@link session_cache_limiter} for every request (and before {@link
83763 * session_start} is called).
83764 *
83765 * @param string $cache_limiter If {@link cache_limiter} is specified,
83766 *   the name of the current cache limiter is changed to the new value.
83767 * @return string Returns the name of the current cache limiter.
83768 * @since PHP 4 >= 4.0.3, PHP 5, PHP 7
83769 **/
83770function session_cache_limiter($cache_limiter){}
83771
83772/**
83773 * Write session data and end session
83774 *
83775 * End the current session and store session data.
83776 *
83777 * Session data is usually stored after your script terminated without
83778 * the need to call {@link session_commit}, but as session data is locked
83779 * to prevent concurrent writes only one script may operate on a session
83780 * at any time. When using framesets together with sessions you will
83781 * experience the frames loading one by one due to this locking. You can
83782 * reduce the time needed to load all the frames by ending the session as
83783 * soon as all changes to session variables are done.
83784 *
83785 * @return bool
83786 * @since PHP 4 >= 4.4.0, PHP 5, PHP 7
83787 **/
83788function session_commit(){}
83789
83790/**
83791 * Create new session id
83792 *
83793 * {@link session_create_id} is used to create new session id for the
83794 * current session. It returns collision free session id.
83795 *
83796 * If session is not active, collision check is omitted.
83797 *
83798 * Session ID is created according to php.ini settings.
83799 *
83800 * It is important to use the same user ID of your web server for GC task
83801 * script. Otherwise, you may have permission problems especially with
83802 * files save handler.
83803 *
83804 * @param string $prefix If {@link prefix} is specified, new session id
83805 *   is prefixed by {@link prefix}. Not all characters are allowed within
83806 *   the session id. Characters in the range a-z A-Z 0-9 , (comma) and -
83807 *   (minus) are allowed.
83808 * @return string {@link session_create_id} returns new collision free
83809 *   session id for the current session. If it is used without active
83810 *   session, it omits collision check.
83811 * @since PHP 7 >= 7.1.0
83812 **/
83813function session_create_id($prefix){}
83814
83815/**
83816 * Decodes session data from a session encoded string
83817 *
83818 * {@link session_decode} decodes the serialized session data provided in
83819 * {@link $data}, and populates the $_SESSION superglobal with the
83820 * result.
83821 *
83822 * By default, the unserialization method used is internal to PHP, and is
83823 * not the same as {@link unserialize}. The serialization method can be
83824 * set using session.serialize_handler.
83825 *
83826 * @param string $data The encoded data to be stored.
83827 * @return bool
83828 * @since PHP 4, PHP 5, PHP 7
83829 **/
83830function session_decode($data){}
83831
83832/**
83833 * Destroys all data registered to a session
83834 *
83835 * In order to kill the session altogether, the session ID must also be
83836 * unset. If a cookie is used to propagate the session ID (default
83837 * behavior), then the session cookie must be deleted. {@link setcookie}
83838 * may be used for that.
83839 *
83840 * When session.use_strict_mode is enabled. You do not have to remove
83841 * obsolete session ID cookie because session module will not accept
83842 * session ID cookie when there is no data associated to the session ID
83843 * and set new session ID cookie. Enabling session.use_strict_mode is
83844 * recommended for all sites.
83845 *
83846 * @return bool
83847 * @since PHP 4, PHP 5, PHP 7
83848 **/
83849function session_destroy(){}
83850
83851/**
83852 * Encodes the current session data as a session encoded string
83853 *
83854 * {@link session_encode} returns a serialized string of the contents of
83855 * the current session data stored in the $_SESSION superglobal.
83856 *
83857 * By default, the serialization method used is internal to PHP, and is
83858 * not the same as {@link serialize}. The serialization method can be set
83859 * using session.serialize_handler.
83860 *
83861 * @return string Returns the contents of the current session encoded.
83862 * @since PHP 4, PHP 5, PHP 7
83863 **/
83864function session_encode(){}
83865
83866/**
83867 * Perform session data garbage collection
83868 *
83869 * {@link session_gc} is used to perform session data GC(garbage
83870 * collection). PHP does probability based session GC by default.
83871 *
83872 * Probability based GC works somewhat but it has few problems. 1) Low
83873 * traffic sites' session data may not be deleted within the preferred
83874 * duration. 2) High traffic sites' GC may be too frequent GC. 3) GC is
83875 * performed on the user's request and the user will experience a GC
83876 * delay.
83877 *
83878 * Therefore, it is recommended to execute GC periodically for production
83879 * systems using, e.g., "cron" for UNIX-like systems. Make sure to
83880 * disable probability based GC by setting session.gc_probability to 0.
83881 *
83882 * @return int {@link session_gc} returns number of deleted session
83883 *   data for success, FALSE for failure.
83884 * @since PHP 7 >= 7.1.0
83885 **/
83886function session_gc(){}
83887
83888/**
83889 * Get the session cookie parameters
83890 *
83891 * Gets the session cookie parameters.
83892 *
83893 * @return array Returns an array with the current session cookie
83894 *   information, the array contains the following items: "lifetime" -
83895 *   The lifetime of the cookie in seconds. "path" - The path where
83896 *   information is stored. "domain" - The domain of the cookie. "secure"
83897 *   - The cookie should only be sent over secure connections. "httponly"
83898 *   - The cookie can only be accessed through the HTTP protocol.
83899 *   "samesite" - Controls the cross-domain sending of the cookie.
83900 * @since PHP 4, PHP 5, PHP 7
83901 **/
83902function session_get_cookie_params(){}
83903
83904/**
83905 * Get and/or set the current session id
83906 *
83907 * {@link session_id} is used to get or set the session id for the
83908 * current session.
83909 *
83910 * The constant SID can also be used to retrieve the current name and
83911 * session id as a string suitable for adding to URLs. See also Session
83912 * handling.
83913 *
83914 * @param string $id If {@link id} is specified, it will replace the
83915 *   current session id. {@link session_id} needs to be called before
83916 *   {@link session_start} for that purpose. Depending on the session
83917 *   handler, not all characters are allowed within the session id. For
83918 *   example, the file session handler only allows characters in the
83919 *   range a-z A-Z 0-9 , (comma) and - (minus)!
83920 * @return string {@link session_id} returns the session id for the
83921 *   current session or the empty string ("") if there is no current
83922 *   session (no current session id exists).
83923 * @since PHP 4, PHP 5, PHP 7
83924 **/
83925function session_id($id){}
83926
83927/**
83928 * Find out whether a global variable is registered in a session
83929 *
83930 * Finds out whether a global variable is registered in a session.
83931 *
83932 * @param string $name The variable name.
83933 * @return bool {@link session_is_registered} returns TRUE if there is
83934 *   a global variable with the name {@link name} registered in the
83935 *   current session, FALSE otherwise.
83936 * @since PHP 4, PHP 5 < 5.4.0
83937 **/
83938function session_is_registered($name){}
83939
83940/**
83941 * Get and/or set the current session module
83942 *
83943 * {@link session_module_name} gets the name of the current session
83944 * module, which is also known as session.save_handler.
83945 *
83946 * @param string $module If {@link module} is specified, that module
83947 *   will be used instead. Passing "user" to this parameter is forbidden.
83948 *   Instead {@link session_set_save_handler} has to be called to set a
83949 *   user defined session handler.
83950 * @return string Returns the name of the current session module.
83951 * @since PHP 4, PHP 5, PHP 7
83952 **/
83953function session_module_name($module){}
83954
83955/**
83956 * Get and/or set the current session name
83957 *
83958 * {@link session_name} returns the name of the current session. If
83959 * {@link name} is given, {@link session_name} will update the session
83960 * name and return the old session name.
83961 *
83962 * If a new session {@link name} is supplied, {@link session_name}
83963 * modifies the HTTP cookie (and output content when session.transid is
83964 * enabled). Once the HTTP cookie is sent, {@link session_name} raises
83965 * error. {@link session_name} must be called before {@link
83966 * session_start} for the session to work properly.
83967 *
83968 * The session name is reset to the default value stored in session.name
83969 * at request startup time. Thus, you need to call {@link session_name}
83970 * for every request (and before {@link session_start} is called).
83971 *
83972 * @param string $name The session name references the name of the
83973 *   session, which is used in cookies and URLs (e.g. PHPSESSID). It
83974 *   should contain only alphanumeric characters; it should be short and
83975 *   descriptive (i.e. for users with enabled cookie warnings). If {@link
83976 *   name} is specified, the name of the current session is changed to
83977 *   its value.
83978 *
83979 *   The session name can't consist of digits only, at least one letter
83980 *   must be present. Otherwise a new session id is generated every time.
83981 * @return string Returns the name of the current session. If {@link
83982 *   name} is given and function updates the session name, name of the
83983 *   old session is returned.
83984 * @since PHP 4, PHP 5, PHP 7
83985 **/
83986function session_name($name){}
83987
83988/**
83989 * Increments error counts and sets last error message
83990 *
83991 * @param int $error_level
83992 * @param string $error_message
83993 * @return bool
83994 * @since PECL session_pgsql SVN
83995 **/
83996function session_pgsql_add_error($error_level, $error_message){}
83997
83998/**
83999 * Returns number of errors and last error message
84000 *
84001 * Get the number of errors and optional the error messages.
84002 *
84003 * @param bool $with_error_message Set to TRUE the literal error
84004 *   message for each error is also returned.
84005 * @return array The number of errors are returned as array.
84006 * @since PECL session_pgsql SVN
84007 **/
84008function session_pgsql_get_error($with_error_message){}
84009
84010/**
84011 * Get custom field value
84012 *
84013 * @return string
84014 * @since PECL session_pgsql SVN
84015 **/
84016function session_pgsql_get_field(){}
84017
84018/**
84019 * Reset connection to session database servers
84020 *
84021 * Reset the connection to the session database servers.
84022 *
84023 * @return bool
84024 * @since PECL session_pgsql SVN
84025 **/
84026function session_pgsql_reset(){}
84027
84028/**
84029 * Set custom field value
84030 *
84031 * @param string $value
84032 * @return bool
84033 * @since PECL session_pgsql SVN
84034 **/
84035function session_pgsql_set_field($value){}
84036
84037/**
84038 * Get current save handler status
84039 *
84040 * @return array
84041 * @since PECL session_pgsql SVN
84042 **/
84043function session_pgsql_status(){}
84044
84045/**
84046 * Update the current session id with a newly generated one
84047 *
84048 * {@link session_regenerate_id} will replace the current session id with
84049 * a new one, and keep the current session information.
84050 *
84051 * When session.use_trans_sid is enabled, output must be started after
84052 * {@link session_regenerate_id} call. Otherwise, old session ID is used.
84053 *
84054 * @param bool $delete_old_session Whether to delete the old associated
84055 *   session file or not. You should not delete old session if you need
84056 *   to avoid races caused by deletion or detect/avoid session hijack
84057 *   attacks.
84058 * @return bool
84059 * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
84060 **/
84061function session_regenerate_id($delete_old_session){}
84062
84063/**
84064 * Register one or more global variables with the current session
84065 *
84066 * {@link session_register} accepts a variable number of arguments, any
84067 * of which can be either a string holding the name of a variable or an
84068 * array consisting of variable names or other arrays. For each name,
84069 * {@link session_register} registers the global variable with that name
84070 * in the current session.
84071 *
84072 * You can also create a session variable by simply setting the
84073 * appropriate member of the $_SESSION array.
84074 *
84075 * <?php // Use of session_register() is deprecated $barney = "A big
84076 * purple dinosaur."; session_register("barney");
84077 *
84078 * // Use of $_SESSION is preferred $_SESSION["zim"] = "An invader from
84079 * another planet."; ?>
84080 *
84081 * If {@link session_start} was not called before this function is
84082 * called, an implicit call to {@link session_start} with no parameters
84083 * will be made. $_SESSION does not mimic this behavior and requires
84084 * {@link session_start} before use.
84085 *
84086 * @param mixed $name A string holding the name of a variable or an
84087 *   array consisting of variable names or other arrays.
84088 * @param mixed ...$vararg
84089 * @return bool
84090 * @since PHP 4, PHP 5 < 5.4.0
84091 **/
84092function session_register($name, ...$vararg){}
84093
84094/**
84095 * Session shutdown function
84096 *
84097 * Registers {@link session_write_close} as a shutdown function.
84098 *
84099 * @return void
84100 * @since PHP 5 >= 5.4.0, PHP 7
84101 **/
84102function session_register_shutdown(){}
84103
84104/**
84105 * Re-initialize session array with original values
84106 *
84107 * {@link session_reset} reinitializes a session with original values
84108 * stored in session storage. This function requires an active session
84109 * and discards changes in $_SESSION.
84110 *
84111 * @return bool
84112 * @since PHP 5 >= 5.6.0, PHP 7
84113 **/
84114function session_reset(){}
84115
84116/**
84117 * Get and/or set the current session save path
84118 *
84119 * {@link session_save_path} returns the path of the current directory
84120 * used to save session data.
84121 *
84122 * @param string $path Session data path. If specified, the path to
84123 *   which data is saved will be changed. {@link session_save_path} needs
84124 *   to be called before {@link session_start} for that purpose.
84125 *
84126 *   On some operating systems, you may want to specify a path on a
84127 *   filesystem that handles lots of small files efficiently. For
84128 *   example, on Linux, reiserfs may provide better performance than
84129 *   ext2fs.
84130 * @return string Returns the path of the current directory used for
84131 *   data storage.
84132 * @since PHP 4, PHP 5, PHP 7
84133 **/
84134function session_save_path($path){}
84135
84136/**
84137 * Set the session cookie parameters
84138 *
84139 * Set cookie parameters defined in the file. The effect of this function
84140 * only lasts for the duration of the script. Thus, you need to call
84141 * {@link session_set_cookie_params} for every request and before {@link
84142 * session_start} is called.
84143 *
84144 * This function updates the runtime ini values of the corresponding PHP
84145 * ini configuration keys which can be retrieved with the {@link
84146 * ini_get}.
84147 *
84148 * @param int $lifetime Lifetime of the session cookie, defined in
84149 *   seconds.
84150 * @param string $path Path on the domain where the cookie will work.
84151 *   Use a single slash ('/') for all paths on the domain.
84152 * @param string $domain Cookie domain, for example 'www.php.net'. To
84153 *   make cookies visible on all subdomains then the domain must be
84154 *   prefixed with a dot like '.php.net'.
84155 * @param bool $secure If TRUE cookie will only be sent over secure
84156 *   connections.
84157 * @param bool $httponly If set to TRUE then PHP will attempt to send
84158 *   the httponly flag when setting the session cookie.
84159 * @return bool
84160 * @since PHP 4, PHP 5, PHP 7
84161 **/
84162function session_set_cookie_params($lifetime, $path, $domain, $secure, $httponly){}
84163
84164/**
84165 * Sets user-level session storage functions
84166 *
84167 * Since PHP 5.4 it is possible to register the following prototype:
84168 *
84169 * {@link session_set_save_handler} sets the user-level session storage
84170 * functions which are used for storing and retrieving data associated
84171 * with a session. This is most useful when a storage method other than
84172 * those supplied by PHP sessions is preferred, e.g. storing the session
84173 * data in a local database.
84174 *
84175 * @param callable $open An instance of a class implementing
84176 *   SessionHandlerInterface, and optionally SessionIdInterface and/or
84177 *   SessionUpdateTimestampHandlerInterface, such as SessionHandler, to
84178 *   register as the session handler. Since PHP 5.4 only.
84179 * @param callable $close Register {@link session_write_close} as a
84180 *   {@link register_shutdown_function} function.
84181 * @param callable $read A callable with the following signature:
84182 *   boolopen string{@link savePath} string{@link sessionName} The open
84183 *   callback works like a constructor in classes and is executed when
84184 *   the session is being opened. It is the first callback function
84185 *   executed when the session is started automatically or manually with
84186 *   {@link session_start}. Return value is TRUE for success, FALSE for
84187 *   failure.
84188 * @param callable $write A callable with the following signature:
84189 *   boolclose The close callback works like a destructor in classes and
84190 *   is executed after the session write callback has been called. It is
84191 *   also invoked when {@link session_write_close} is called. Return
84192 *   value should be TRUE for success, FALSE for failure.
84193 * @param callable $destroy A callable with the following signature:
84194 *   boolread string{@link sessionId} The {@link read} callback must
84195 *   always return a session encoded (serialized) string, or an empty
84196 *   string if there is no data to read. This callback is called
84197 *   internally by PHP when the session starts or when {@link
84198 *   session_start} is called. Before this callback is invoked PHP will
84199 *   invoke the {@link open} callback. The value this callback returns
84200 *   must be in exactly the same serialized format that was originally
84201 *   passed for storage to the {@link write} callback. The value returned
84202 *   will be unserialized automatically by PHP and used to populate the
84203 *   $_SESSION superglobal. While the data looks similar to {@link
84204 *   serialize} please note it is a different format which is specified
84205 *   in the session.serialize_handler ini setting.
84206 * @param callable $gc A callable with the following signature:
84207 *   boolwrite string{@link sessionId} string{@link data} The {@link
84208 *   write} callback is called when the session needs to be saved and
84209 *   closed. This callback receives the current session ID a serialized
84210 *   version the $_SESSION superglobal. The serialization method used
84211 *   internally by PHP is specified in the session.serialize_handler ini
84212 *   setting. The serialized session data passed to this callback should
84213 *   be stored against the passed session ID. When retrieving this data,
84214 *   the {@link read} callback must return the exact value that was
84215 *   originally passed to the {@link write} callback. This callback is
84216 *   invoked when PHP shuts down or explicitly when {@link
84217 *   session_write_close} is called. Note that after executing this
84218 *   function PHP will internally execute the {@link close} callback. The
84219 *   "write" handler is not executed until after the output stream is
84220 *   closed. Thus, output from debugging statements in the "write"
84221 *   handler will never be seen in the browser. If debugging output is
84222 *   necessary, it is suggested that the debug output be written to a
84223 *   file instead.
84224 * @param callable $create_sid A callable with the following signature:
84225 *   booldestroy string{@link sessionId} This callback is executed when a
84226 *   session is destroyed with {@link session_destroy} or with {@link
84227 *   session_regenerate_id} with the destroy parameter set to TRUE.
84228 *   Return value should be TRUE for success, FALSE for failure.
84229 * @param callable $validate_sid A callable with the following
84230 *   signature: boolgc int{@link lifetime} The garbage collector callback
84231 *   is invoked internally by PHP periodically in order to purge old
84232 *   session data. The frequency is controlled by session.gc_probability
84233 *   and session.gc_divisor. The value of lifetime which is passed to
84234 *   this callback can be set in session.gc_maxlifetime. Return value
84235 *   should be TRUE for success, FALSE for failure.
84236 * @param callable $update_timestamp A callable with the following
84237 *   signature: stringcreate_sid This callback is executed when a new
84238 *   session ID is required. No parameters are provided, and the return
84239 *   value should be a string that is a valid session ID for your
84240 *   handler.
84241 * @return bool
84242 * @since PHP 4, PHP 5, PHP 7
84243 **/
84244function session_set_save_handler($open, $close, $read, $write, $destroy, $gc, $create_sid, $validate_sid, $update_timestamp){}
84245
84246/**
84247 * Start new or resume existing session
84248 *
84249 * {@link session_start} creates a session or resumes the current one
84250 * based on a session identifier passed via a GET or POST request, or
84251 * passed via a cookie.
84252 *
84253 * When {@link session_start} is called or when a session auto starts,
84254 * PHP will call the open and read session save handlers. These will
84255 * either be a built-in save handler provided by default or by PHP
84256 * extensions (such as SQLite or Memcached); or can be custom handler as
84257 * defined by {@link session_set_save_handler}. The read callback will
84258 * retrieve any existing session data (stored in a special serialized
84259 * format) and will be unserialized and used to automatically populate
84260 * the $_SESSION superglobal when the read callback returns the saved
84261 * session data back to PHP session handling.
84262 *
84263 * To use a named session, call {@link session_name} before calling
84264 * {@link session_start}.
84265 *
84266 * When session.use_trans_sid is enabled, the {@link session_start}
84267 * function will register an internal output handler for URL rewriting.
84268 *
84269 * If a user uses ob_gzhandler or similar with {@link ob_start}, the
84270 * function order is important for proper output. For example,
84271 * ob_gzhandler must be registered before starting the session.
84272 *
84273 * @param array $options If provided, this is an associative array of
84274 *   options that will override the currently set session configuration
84275 *   directives. The keys should not include the session. prefix. In
84276 *   addition to the normal set of configuration directives, a
84277 *   read_and_close option may also be provided. If set to TRUE, this
84278 *   will result in the session being closed immediately after being
84279 *   read, thereby avoiding unnecessary locking if the session data won't
84280 *   be changed.
84281 * @return bool This function returns TRUE if a session was
84282 *   successfully started, otherwise FALSE.
84283 * @since PHP 4, PHP 5, PHP 7
84284 **/
84285function session_start($options){}
84286
84287/**
84288 * Returns the current session status
84289 *
84290 * {@link session_status} is used to return the current session status.
84291 *
84292 * @return int PHP_SESSION_DISABLED if sessions are disabled.
84293 *   PHP_SESSION_NONE if sessions are enabled, but none exists.
84294 *   PHP_SESSION_ACTIVE if sessions are enabled, and one exists.
84295 * @since PHP 5 >= 5.4.0, PHP 7
84296 **/
84297function session_status(){}
84298
84299/**
84300 * Unregister a global variable from the current session
84301 *
84302 * {@link session_unregister} unregisters the global variable named
84303 * {@link name} from the current session.
84304 *
84305 * @param string $name The variable name.
84306 * @return bool
84307 * @since PHP 4, PHP 5 < 5.4.0
84308 **/
84309function session_unregister($name){}
84310
84311/**
84312 * Free all session variables
84313 *
84314 * The {@link session_unset} function frees all session variables
84315 * currently registered.
84316 *
84317 * @return bool
84318 * @since PHP 4, PHP 5, PHP 7
84319 **/
84320function session_unset(){}
84321
84322/**
84323 * Write session data and end session
84324 *
84325 * End the current session and store session data.
84326 *
84327 * Session data is usually stored after your script terminated without
84328 * the need to call {@link session_write_close}, but as session data is
84329 * locked to prevent concurrent writes only one script may operate on a
84330 * session at any time. When using framesets together with sessions you
84331 * will experience the frames loading one by one due to this locking. You
84332 * can reduce the time needed to load all the frames by ending the
84333 * session as soon as all changes to session variables are done.
84334 *
84335 * @return bool
84336 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
84337 **/
84338function session_write_close(){}
84339
84340/**
84341 * Send a cookie
84342 *
84343 * {@link setcookie} defines a cookie to be sent along with the rest of
84344 * the HTTP headers. Like other headers, cookies must be sent before any
84345 * output from your script (this is a protocol restriction). This
84346 * requires that you place calls to this function prior to any output,
84347 * including <html> and <head> tags as well as any whitespace.
84348 *
84349 * Once the cookies have been set, they can be accessed on the next page
84350 * load with the $_COOKIE array. Cookie values may also exist in
84351 * $_REQUEST.
84352 *
84353 * @param string $name The name of the cookie.
84354 * @param string $value The value of the cookie. This value is stored
84355 *   on the clients computer; do not store sensitive information.
84356 *   Assuming the {@link name} is 'cookiename', this value is retrieved
84357 *   through $_COOKIE['cookiename']
84358 * @param int $expires The time the cookie expires. This is a Unix
84359 *   timestamp so is in number of seconds since the epoch. In other
84360 *   words, you'll most likely set this with the {@link time} function
84361 *   plus the number of seconds before you want it to expire. Or you
84362 *   might use {@link mktime}. time()+60*60*24*30 will set the cookie to
84363 *   expire in 30 days. If set to 0, or omitted, the cookie will expire
84364 *   at the end of the session (when the browser closes).
84365 *
84366 *   You may notice the {@link expires} parameter takes on a Unix
84367 *   timestamp, as opposed to the date format Wdy, DD-Mon-YYYY HH:MM:SS
84368 *   GMT, this is because PHP does this conversion internally.
84369 * @param string $path The path on the server in which the cookie will
84370 *   be available on. If set to '/', the cookie will be available within
84371 *   the entire {@link domain}. If set to '/foo/', the cookie will only
84372 *   be available within the /foo/ directory and all sub-directories such
84373 *   as /foo/bar/ of {@link domain}. The default value is the current
84374 *   directory that the cookie is being set in.
84375 * @param string $domain The (sub)domain that the cookie is available
84376 *   to. Setting this to a subdomain (such as 'www.example.com') will
84377 *   make the cookie available to that subdomain and all other
84378 *   sub-domains of it (i.e. w2.www.example.com). To make the cookie
84379 *   available to the whole domain (including all subdomains of it),
84380 *   simply set the value to the domain name ('example.com', in this
84381 *   case). Older browsers still implementing the deprecated RFC 2109 may
84382 *   require a leading . to match all subdomains.
84383 * @param bool $secure Indicates that the cookie should only be
84384 *   transmitted over a secure HTTPS connection from the client. When set
84385 *   to TRUE, the cookie will only be set if a secure connection exists.
84386 *   On the server-side, it's on the programmer to send this kind of
84387 *   cookie only on secure connection (e.g. with respect to
84388 *   $_SERVER["HTTPS"]).
84389 * @param bool $httponly When TRUE the cookie will be made accessible
84390 *   only through the HTTP protocol. This means that the cookie won't be
84391 *   accessible by scripting languages, such as JavaScript. It has been
84392 *   suggested that this setting can effectively help to reduce identity
84393 *   theft through XSS attacks (although it is not supported by all
84394 *   browsers), but that claim is often disputed. Added in PHP 5.2.0.
84395 *   TRUE or FALSE
84396 * @return bool If output exists prior to calling this function, {@link
84397 *   setcookie} will fail and return FALSE. If {@link setcookie}
84398 *   successfully runs, it will return TRUE. This does not indicate
84399 *   whether the user accepted the cookie.
84400 * @since PHP 4, PHP 5, PHP 7
84401 **/
84402function setcookie($name, $value, $expires, $path, $domain, $secure, $httponly){}
84403
84404/**
84405 * Sets left rasterizing color
84406 *
84407 * What this nonsense is about is, every edge segment borders at most two
84408 * fills. When rasterizing the object, it's pretty handy to know what
84409 * those fills are ahead of time, so the swf format requires these to be
84410 * specified.
84411 *
84412 * {@link swfshape::setleftfill} sets the fill on the left side of the
84413 * edge- that is, on the interior if you're defining the outline of the
84414 * shape in a counter-clockwise fashion. The fill object is an SWFFill
84415 * object returned from one of the addFill functions above.
84416 *
84417 * This seems to be reversed when you're defining a shape in a morph,
84418 * though. If your browser crashes, just try setting the fill on the
84419 * other side.
84420 *
84421 * @param int $red
84422 * @param int $green
84423 * @param int $blue
84424 * @param int $a
84425 * @return void
84426 **/
84427function setLeftFill($red, $green, $blue, $a){}
84428
84429/**
84430 * Sets the shape's line style
84431 *
84432 * {@link swfshape::setline} sets the shape's line style. {@link width}
84433 * is the line's width. If {@link width} is 0, the line's style is
84434 * removed (then, all other arguments are ignored). If {@link width} > 0,
84435 * then line's color is set to {@link red}, {@link green}, {@link blue}.
84436 * Last parameter {@link a} is optional.
84437 *
84438 * You must declare all line styles before you use them (see example).
84439 *
84440 * @param int $width
84441 * @param int $red
84442 * @param int $green
84443 * @param int $blue
84444 * @param int $a
84445 * @return void
84446 **/
84447function setLine($width, $red, $green, $blue, $a){}
84448
84449/**
84450 * Set locale information
84451 *
84452 * Sets locale information.
84453 *
84454 * @param int $category {@link category} is a named constant specifying
84455 *   the category of the functions affected by the locale setting: LC_ALL
84456 *   for all of the below LC_COLLATE for string comparison, see {@link
84457 *   strcoll} LC_CTYPE for character classification and conversion, for
84458 *   example {@link strtoupper} LC_MONETARY for {@link localeconv}
84459 *   LC_NUMERIC for decimal separator (See also {@link localeconv})
84460 *   LC_TIME for date and time formatting with {@link strftime}
84461 *   LC_MESSAGES for system responses (available if PHP was compiled with
84462 *   libintl)
84463 * @param string $locale If {@link locale} is NULL or the empty string
84464 *   "", the locale names will be set from the values of environment
84465 *   variables with the same names as the above categories, or from
84466 *   "LANG". If {@link locale} is "0", the locale setting is not
84467 *   affected, only the current setting is returned. If {@link locale} is
84468 *   an array or followed by additional parameters then each array
84469 *   element or parameter is tried to be set as new locale until success.
84470 *   This is useful if a locale is known under different names on
84471 *   different systems or for providing a fallback for a possibly not
84472 *   available locale.
84473 * @param string ...$vararg (Optional string or array parameters to try
84474 *   as locale settings until success.)
84475 * @return string Returns the new current locale, or FALSE if the
84476 *   locale functionality is not implemented on your platform, the
84477 *   specified locale does not exist or the category name is invalid.
84478 * @since PHP 4, PHP 5, PHP 7
84479 **/
84480function setlocale($category, $locale, ...$vararg){}
84481
84482/**
84483 * Set the process title
84484 *
84485 * Sets the process title of the current process.
84486 *
84487 * @param string $title The title to use as the process title.
84488 * @return void
84489 * @since PECL proctitle >= 0.1.0
84490 **/
84491function setproctitle($title){}
84492
84493/**
84494 * Send a cookie without urlencoding the cookie value
84495 *
84496 * {@link setrawcookie} is exactly the same as {@link setcookie} except
84497 * that the cookie value will not be automatically urlencoded when sent
84498 * to the browser.
84499 *
84500 * @param string $name
84501 * @param string $value
84502 * @param int $expires
84503 * @param string $path
84504 * @param string $domain
84505 * @param bool $secure
84506 * @param bool $httponly
84507 * @return bool
84508 * @since PHP 5, PHP 7
84509 **/
84510function setrawcookie($name, $value, $expires, $path, $domain, $secure, $httponly){}
84511
84512/**
84513 * Sets right rasterizing color
84514 *
84515 * @param int $red
84516 * @param int $green
84517 * @param int $blue
84518 * @param int $a
84519 * @return void
84520 **/
84521function setRightFill($red, $green, $blue, $a){}
84522
84523/**
84524 * Set the thread title
84525 *
84526 * Sets the thread title.
84527 *
84528 * @param string $title The title to use as the thread title.
84529 * @return bool
84530 * @since PECL proctitle >= 0.1.2
84531 **/
84532function setthreadtitle($title){}
84533
84534/**
84535 * Set the type of a variable
84536 *
84537 * Set the type of variable {@link var} to {@link type}.
84538 *
84539 * @param mixed $var The variable being converted.
84540 * @param string $type Possibles values of {@link type} are: "boolean"
84541 *   or "bool" "integer" or "int" "float" or "double" "string" "array"
84542 *   "object" "null"
84543 * @return bool
84544 * @since PHP 4, PHP 5, PHP 7
84545 **/
84546function settype(&$var, $type){}
84547
84548/**
84549 * Sets a user-defined error handler function
84550 *
84551 * Sets a user function ({@link error_handler}) to handle errors in a
84552 * script.
84553 *
84554 * This function can be used for defining your own way of handling errors
84555 * during runtime, for example in applications in which you need to do
84556 * cleanup of data/files when a critical error happens, or when you need
84557 * to trigger an error under certain conditions (using {@link
84558 * trigger_error}).
84559 *
84560 * It is important to remember that the standard PHP error handler is
84561 * completely bypassed for the error types specified by {@link
84562 * error_types} unless the callback function returns FALSE. {@link
84563 * error_reporting} settings will have no effect and your error handler
84564 * will be called regardless - however you are still able to read the
84565 * current value of error_reporting and act appropriately. Of particular
84566 * note is that this value will be 0 if the statement that caused the
84567 * error was prepended by the @ error-control operator.
84568 *
84569 * Also note that it is your responsibility to {@link die} if necessary.
84570 * If the error-handler function returns, script execution will continue
84571 * with the next statement after the one that caused an error.
84572 *
84573 * The following error types cannot be handled with a user defined
84574 * function: E_ERROR, E_PARSE, E_CORE_ERROR, E_CORE_WARNING,
84575 * E_COMPILE_ERROR, E_COMPILE_WARNING independent of where they were
84576 * raised, and most of E_STRICT raised in the file where {@link
84577 * set_error_handler} is called.
84578 *
84579 * If errors occur before the script is executed (e.g. on file uploads)
84580 * the custom error handler cannot be called since it is not registered
84581 * at that time.
84582 *
84583 * @param callable $error_handler A callback with the following
84584 *   signature. NULL may be passed instead, to reset this handler to its
84585 *   default state. Instead of a function name, an array containing an
84586 *   object reference and a method name can also be supplied.
84587 *
84588 *   boolhandler int{@link errno} string{@link errstr} string{@link
84589 *   errfile} int{@link errline} array{@link errcontext} {@link errno}
84590 *   The first parameter, {@link errno}, contains the level of the error
84591 *   raised, as an integer. {@link errstr} The second parameter, {@link
84592 *   errstr}, contains the error message, as a string. {@link errfile}
84593 *   The third parameter is optional, {@link errfile}, which contains the
84594 *   filename that the error was raised in, as a string. {@link errline}
84595 *   The fourth parameter is optional, {@link errline}, which contains
84596 *   the line number the error was raised at, as an integer. {@link
84597 *   errcontext} The fifth parameter is optional, {@link errcontext},
84598 *   which is an array that points to the active symbol table at the
84599 *   point the error occurred. In other words, {@link errcontext} will
84600 *   contain an array of every variable that existed in the scope the
84601 *   error was triggered in. User error handler must not modify error
84602 *   context. This parameter has been DEPRECATED as of PHP 7.2.0. Relying
84603 *   on it is highly discouraged. If the function returns FALSE then the
84604 *   normal error handler continues.
84605 * @param int $error_types
84606 * @return mixed Returns a string containing the previously defined
84607 *   error handler (if any). If the built-in error handler is used NULL
84608 *   is returned. NULL is also returned in case of an error such as an
84609 *   invalid callback. If the previous error handler was a class method,
84610 *   this function will return an indexed array with the class and the
84611 *   method name.
84612 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
84613 **/
84614function set_error_handler($error_handler, $error_types){}
84615
84616/**
84617 * Sets a user-defined exception handler function
84618 *
84619 * Sets the default exception handler if an exception is not caught
84620 * within a try/catch block. Execution will stop after the {@link
84621 * exception_handler} is called.
84622 *
84623 * @param callable $exception_handler Name of the function to be called
84624 *   when an uncaught exception occurs. This handler function needs to
84625 *   accept one parameter, which will be the exception object that was
84626 *   thrown. This is the handler signature before PHP 7:
84627 *
84628 *   voidhandler Exception{@link ex} Since PHP 7, most errors are
84629 *   reported by throwing Error exceptions, which will be caught by the
84630 *   handler as well. Both Error and Exception implements the Throwable
84631 *   interface. This is the handler signature since PHP 7:
84632 *
84633 *   voidhandler Throwable{@link ex} NULL may be passed instead, to reset
84634 *   this handler to its default state.
84635 * @return callable Returns the name of the previously defined
84636 *   exception handler, or NULL on error. If no previous handler was
84637 *   defined, NULL is also returned.
84638 * @since PHP 5, PHP 7
84639 **/
84640function set_exception_handler($exception_handler){}
84641
84642/**
84643 * Sets the include_path configuration option
84644 *
84645 * Sets the include_path configuration option for the duration of the
84646 * script.
84647 *
84648 * @param string $new_include_path The new value for the include_path
84649 * @return string Returns the old include_path on success.
84650 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
84651 **/
84652function set_include_path($new_include_path){}
84653
84654/**
84655 * Sets the current active configuration setting of magic_quotes_runtime
84656 *
84657 * Set the current active configuration setting of magic_quotes_runtime.
84658 *
84659 * @param bool $new_setting FALSE for off, TRUE for on.
84660 * @return bool
84661 * @since PHP 4, PHP 5
84662 **/
84663function set_magic_quotes_runtime($new_setting){}
84664
84665/**
84666 * Set blocking/non-blocking mode on a stream
84667 *
84668 * Sets blocking or non-blocking mode on a {@link stream}.
84669 *
84670 * This function works for any stream that supports non-blocking mode
84671 * (currently, regular files and socket streams).
84672 *
84673 * @param resource $stream The stream.
84674 * @param bool $mode If {@link mode} is FALSE, the given stream will be
84675 *   switched to non-blocking mode, and if TRUE, it will be switched to
84676 *   blocking mode. This affects calls like {@link fgets} and {@link
84677 *   fread} that read from the stream. In non-blocking mode an {@link
84678 *   fgets} call will always return right away while in blocking mode it
84679 *   will wait for data to become available on the stream.
84680 * @return bool
84681 * @since PHP 4, PHP 5
84682 **/
84683function set_socket_blocking($stream, $mode){}
84684
84685/**
84686 * Limits the maximum execution time
84687 *
84688 * Set the number of seconds a script is allowed to run. If this is
84689 * reached, the script returns a fatal error. The default limit is 30
84690 * seconds or, if it exists, the max_execution_time value defined in the
84691 * .
84692 *
84693 * When called, {@link set_time_limit} restarts the timeout counter from
84694 * zero. In other words, if the timeout is the default 30 seconds, and 25
84695 * seconds into script execution a call such as set_time_limit(20) is
84696 * made, the script will run for a total of 45 seconds before timing out.
84697 *
84698 * @param int $seconds The maximum execution time, in seconds. If set
84699 *   to zero, no time limit is imposed.
84700 * @return bool Returns TRUE on success, or FALSE on failure.
84701 * @since PHP 4, PHP 5, PHP 7
84702 **/
84703function set_time_limit($seconds){}
84704
84705/**
84706 * Calculate the sha1 hash of a string
84707 *
84708 * @param string $str The input string.
84709 * @param bool $raw_output If the optional {@link raw_output} is set to
84710 *   TRUE, then the sha1 digest is instead returned in raw binary format
84711 *   with a length of 20, otherwise the returned value is a 40-character
84712 *   hexadecimal number.
84713 * @return string Returns the sha1 hash as a string.
84714 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
84715 **/
84716function sha1($str, $raw_output){}
84717
84718/**
84719 * Calculate the sha1 hash of a file
84720 *
84721 * @param string $filename The filename of the file to hash.
84722 * @param bool $raw_output When TRUE, returns the digest in raw binary
84723 *   format with a length of 20.
84724 * @return string Returns a string on success, FALSE otherwise.
84725 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
84726 **/
84727function sha1_file($filename, $raw_output){}
84728
84729/**
84730 * Calculate the sha256 hash of a string
84731 *
84732 * @param string $str The string.
84733 * @param bool $raw_output Whether to return raw binary format (32
84734 *   bytes).
84735 * @return string Returns the hash.
84736 * @since Suhosin >= Unknown
84737 **/
84738function sha256($str, $raw_output){}
84739
84740/**
84741 * Calculate the sha256 hash of given filename
84742 *
84743 * @param string $filename Name of the file.
84744 * @param bool $raw_output Whether to return raw binary format (32
84745 *   bytes).
84746 * @return string Returns the hash.
84747 * @since Suhosin >= Unknown
84748 **/
84749function sha256_file($filename, $raw_output){}
84750
84751/**
84752 * Execute command via shell and return the complete output as a string
84753 *
84754 * This function is identical to the backtick operator.
84755 *
84756 * @param string $cmd The command that will be executed.
84757 * @return string The output from the executed command or NULL if an
84758 *   error occurred or the command produces no output.
84759 * @since PHP 4, PHP 5, PHP 7
84760 **/
84761function shell_exec($cmd){}
84762
84763/**
84764 * Close shared memory block
84765 *
84766 * {@link shmop_close} is used to close a shared memory block.
84767 *
84768 * @param resource $shmid The shared memory block resource created by
84769 *   {@link shmop_open}
84770 * @return void
84771 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
84772 **/
84773function shmop_close($shmid){}
84774
84775/**
84776 * Delete shared memory block
84777 *
84778 * {@link shmop_delete} is used to delete a shared memory block.
84779 *
84780 * @param resource $shmid The shared memory block resource created by
84781 *   {@link shmop_open}
84782 * @return bool
84783 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
84784 **/
84785function shmop_delete($shmid){}
84786
84787/**
84788 * Create or open shared memory block
84789 *
84790 * {@link shmop_open} can create or open a shared memory block.
84791 *
84792 * @param int $key System's id for the shared memory block. Can be
84793 *   passed as a decimal or hex.
84794 * @param string $flags The flags that you can use: "a" for access
84795 *   (sets SHM_RDONLY for shmat) use this flag when you need to open an
84796 *   existing shared memory segment for read only "c" for create (sets
84797 *   IPC_CREATE) use this flag when you need to create a new shared
84798 *   memory segment or if a segment with the same key exists, try to open
84799 *   it for read and write "w" for read & write access use this flag when
84800 *   you need to read and write to a shared memory segment, use this flag
84801 *   in most cases. "n" create a new memory segment (sets
84802 *   IPC_CREATE|IPC_EXCL) use this flag when you want to create a new
84803 *   shared memory segment but if one already exists with the same flag,
84804 *   fail. This is useful for security purposes, using this you can
84805 *   prevent race condition exploits.
84806 * @param int $mode The permissions that you wish to assign to your
84807 *   memory segment, those are the same as permission for a file.
84808 *   Permissions need to be passed in octal form, like for example 0644
84809 * @param int $size The size of the shared memory block you wish to
84810 *   create in bytes
84811 * @return resource On success {@link shmop_open} will return an
84812 *   resource that you can use to access the shared memory segment you've
84813 *   created. FALSE is returned on failure.
84814 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
84815 **/
84816function shmop_open($key, $flags, $mode, $size){}
84817
84818/**
84819 * Read data from shared memory block
84820 *
84821 * {@link shmop_read} will read a string from shared memory block.
84822 *
84823 * @param resource $shmid The shared memory block identifier created by
84824 *   {@link shmop_open}
84825 * @param int $start Offset from which to start reading
84826 * @param int $count The number of bytes to read. 0 reads
84827 *   shmop_size($shmid) - $start bytes.
84828 * @return string Returns the data.
84829 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
84830 **/
84831function shmop_read($shmid, $start, $count){}
84832
84833/**
84834 * Get size of shared memory block
84835 *
84836 * {@link shmop_size} is used to get the size, in bytes of the shared
84837 * memory block.
84838 *
84839 * @param resource $shmid The shared memory block identifier created by
84840 *   {@link shmop_open}
84841 * @return int Returns an int, which represents the number of bytes the
84842 *   shared memory block occupies.
84843 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
84844 **/
84845function shmop_size($shmid){}
84846
84847/**
84848 * Write data into shared memory block
84849 *
84850 * {@link shmop_write} will write a string into shared memory block.
84851 *
84852 * @param resource $shmid The shared memory block identifier created by
84853 *   {@link shmop_open}
84854 * @param string $data A string to write into shared memory block
84855 * @param int $offset Specifies where to start writing data inside the
84856 *   shared memory segment.
84857 * @return int The size of the written {@link data}, or FALSE on
84858 *   failure.
84859 * @since PHP 4 >= 4.0.4, PHP 5, PHP 7
84860 **/
84861function shmop_write($shmid, $data, $offset){}
84862
84863/**
84864 * Creates or open a shared memory segment
84865 *
84866 * {@link shm_attach} returns an id that can be used to access the System
84867 * V shared memory with the given {@link key}, the first call creates the
84868 * shared memory segment with {@link memsize} and the optional perm-bits
84869 * {@link perm}.
84870 *
84871 * A second call to {@link shm_attach} for the same {@link key} will
84872 * return a different shared memory identifier, but both identifiers
84873 * access the same underlying shared memory. {@link memsize} and {@link
84874 * perm} will be ignored.
84875 *
84876 * @param int $key A numeric shared memory segment ID
84877 * @param int $memsize The memory size. If not provided, default to the
84878 *   sysvshm.init_mem in the , otherwise 10000 bytes.
84879 * @param int $perm The optional permission bits. Default to 0666.
84880 * @return resource Returns a shared memory segment identifier.
84881 * @since PHP 4, PHP 5, PHP 7
84882 **/
84883function shm_attach($key, $memsize, $perm){}
84884
84885/**
84886 * Disconnects from shared memory segment
84887 *
84888 * {@link shm_detach} disconnects from the shared memory given by the
84889 * {@link shm_identifier} created by {@link shm_attach}. Remember, that
84890 * shared memory still exist in the Unix system and the data is still
84891 * present.
84892 *
84893 * @param resource $shm_identifier A shared memory resource handle as
84894 *   returned by {@link shm_attach}
84895 * @return bool {@link shm_detach} always returns TRUE.
84896 * @since PHP 4, PHP 5, PHP 7
84897 **/
84898function shm_detach($shm_identifier){}
84899
84900/**
84901 * Returns a variable from shared memory
84902 *
84903 * {@link shm_get_var} returns the variable with a given {@link
84904 * variable_key}, in the given shared memory segment. The variable is
84905 * still present in the shared memory.
84906 *
84907 * @param resource $shm_identifier Shared memory segment, obtained from
84908 *   {@link shm_attach}.
84909 * @param int $variable_key The variable key.
84910 * @return mixed Returns the variable with the given key.
84911 * @since PHP 4, PHP 5, PHP 7
84912 **/
84913function shm_get_var($shm_identifier, $variable_key){}
84914
84915/**
84916 * Check whether a specific entry exists
84917 *
84918 * Checks whether a specific key exists inside a shared memory segment.
84919 *
84920 * @param resource $shm_identifier Shared memory segment, obtained from
84921 *   {@link shm_attach}.
84922 * @param int $variable_key The variable key.
84923 * @return bool Returns TRUE if the entry exists, otherwise FALSE
84924 * @since PHP 5 >= 5.3.0, PHP 7
84925 **/
84926function shm_has_var($shm_identifier, $variable_key){}
84927
84928/**
84929 * Inserts or updates a variable in shared memory
84930 *
84931 * {@link shm_put_var} inserts or updates the {@link variable} with the
84932 * given {@link variable_key}.
84933 *
84934 * Warnings (E_WARNING level) will be issued if {@link shm_identifier} is
84935 * not a valid SysV shared memory index or if there was not enough shared
84936 * memory remaining to complete your request.
84937 *
84938 * @param resource $shm_identifier A shared memory resource handle as
84939 *   returned by {@link shm_attach}
84940 * @param int $variable_key The variable key.
84941 * @param mixed $variable The variable. All variable types that {@link
84942 *   serialize} supports may be used: generally this means all types
84943 *   except for resources and some internal objects that cannot be
84944 *   serialized.
84945 * @return bool
84946 * @since PHP 4, PHP 5, PHP 7
84947 **/
84948function shm_put_var($shm_identifier, $variable_key, $variable){}
84949
84950/**
84951 * Removes shared memory from Unix systems
84952 *
84953 * {@link shm_remove} removes the shared memory {@link shm_identifier}.
84954 * All data will be destroyed.
84955 *
84956 * @param resource $shm_identifier The shared memory identifier as
84957 *   returned by {@link shm_attach}
84958 * @return bool
84959 * @since PHP 4, PHP 5, PHP 7
84960 **/
84961function shm_remove($shm_identifier){}
84962
84963/**
84964 * Removes a variable from shared memory
84965 *
84966 * Removes a variable with a given {@link variable_key} and frees the
84967 * occupied memory.
84968 *
84969 * @param resource $shm_identifier The shared memory identifier as
84970 *   returned by {@link shm_attach}
84971 * @param int $variable_key The variable key.
84972 * @return bool
84973 * @since PHP 4, PHP 5, PHP 7
84974 **/
84975function shm_remove_var($shm_identifier, $variable_key){}
84976
84977/**
84978 * Syntax highlighting of a file
84979 *
84980 * Prints out or returns a syntax highlighted version of the code
84981 * contained in {@link filename} using the colors defined in the built-in
84982 * syntax highlighter for PHP.
84983 *
84984 * Many servers are configured to automatically highlight files with a
84985 * phps extension. For example, example.phps when viewed will show the
84986 * syntax highlighted source of the file. To enable this, add this line
84987 * to the :
84988 *
84989 * @param string $filename Path to the PHP file to be highlighted.
84990 * @param bool $return Set this parameter to TRUE to make this function
84991 *   return the highlighted code.
84992 * @return mixed If {@link return} is set to TRUE, returns the
84993 *   highlighted code as a string instead of printing it out. Otherwise,
84994 *   it will return TRUE on success, FALSE on failure.
84995 * @since PHP 4, PHP 5, PHP 7
84996 **/
84997function show_source($filename, $return){}
84998
84999/**
85000 * Shuffle an array
85001 *
85002 * This function shuffles (randomizes the order of the elements in) an
85003 * array. It uses a pseudo random number generator that is not suitable
85004 * for cryptographic purposes.
85005 *
85006 * @param array $array The array.
85007 * @return bool
85008 * @since PHP 4, PHP 5, PHP 7
85009 **/
85010function shuffle(&$array){}
85011
85012/**
85013 * Calculate the similarity between two strings
85014 *
85015 * This calculates the similarity between two strings as described in .
85016 * Note that this implementation does not use a stack as in Oliver's
85017 * pseudo code, but recursive calls which may or may not speed up the
85018 * whole process. Note also that the complexity of this algorithm is
85019 * O(N**3) where N is the length of the longest string.
85020 *
85021 * @param string $first The first string.
85022 * @param string $second The second string.
85023 * @param float $percent By passing a reference as third argument,
85024 *   {@link similar_text} will calculate the similarity in percent, by
85025 *   dividing the result of {@link similar_text} by the average of the
85026 *   lengths of the given strings times 100.
85027 * @return int Returns the number of matching chars in both strings.
85028 * @since PHP 4, PHP 5, PHP 7
85029 **/
85030function similar_text($first, $second, &$percent){}
85031
85032/**
85033 * Get a object from a DOM node
85034 *
85035 * This function takes a node of a DOM document and makes it into a
85036 * SimpleXML node. This new object can then be used as a native SimpleXML
85037 * element.
85038 *
85039 * @param DOMNode $node A DOM Element node
85040 * @param string $class_name You may use this optional parameter so
85041 *   that {@link simplexml_import_dom} will return an object of the
85042 *   specified class. That class should extend the SimpleXMLElement
85043 *   class.
85044 * @return SimpleXMLElement Returns a SimpleXMLElement.
85045 * @since PHP 5, PHP 7
85046 **/
85047function simplexml_import_dom($node, $class_name){}
85048
85049/**
85050 * Interprets an XML file into an object
85051 *
85052 * Convert the well-formed XML document in the given file to an object.
85053 *
85054 * @param string $filename Path to the XML file
85055 * @param string $class_name You may use this optional parameter so
85056 *   that {@link simplexml_load_file} will return an object of the
85057 *   specified class. That class should extend the SimpleXMLElement
85058 *   class.
85059 * @param int $options Since PHP 5.1.0 and Libxml 2.6.0, you may also
85060 *   use the {@link options} parameter to specify additional Libxml
85061 *   parameters.
85062 * @param string $ns Namespace prefix or URI.
85063 * @param bool $is_prefix TRUE if {@link ns} is a prefix, FALSE if it's
85064 *   a URI; defaults to FALSE.
85065 * @return SimpleXMLElement Returns an object of class SimpleXMLElement
85066 *   with properties containing the data held within the XML document,.
85067 * @since PHP 5, PHP 7
85068 **/
85069function simplexml_load_file($filename, $class_name, $options, $ns, $is_prefix){}
85070
85071/**
85072 * Interprets a string of XML into an object
85073 *
85074 * Takes a well-formed XML string and returns it as an object.
85075 *
85076 * @param string $data A well-formed XML string
85077 * @param string $class_name You may use this optional parameter so
85078 *   that {@link simplexml_load_string} will return an object of the
85079 *   specified class. That class should extend the SimpleXMLElement
85080 *   class.
85081 * @param int $options Since PHP 5.1.0 and Libxml 2.6.0, you may also
85082 *   use the {@link options} parameter to specify additional Libxml
85083 *   parameters.
85084 * @param string $ns Namespace prefix or URI.
85085 * @param bool $is_prefix TRUE if {@link ns} is a prefix, FALSE if it's
85086 *   a URI; defaults to FALSE.
85087 * @return SimpleXMLElement Returns an object of class SimpleXMLElement
85088 *   with properties containing the data held within the xml document,.
85089 * @since PHP 5, PHP 7
85090 **/
85091function simplexml_load_string($data, $class_name, $options, $ns, $is_prefix){}
85092
85093/**
85094 * Sine
85095 *
85096 * {@link sin} returns the sine of the {@link arg} parameter. The {@link
85097 * arg} parameter is in radians.
85098 *
85099 * @param float $arg A value in radians
85100 * @return float The sine of {@link arg}
85101 * @since PHP 4, PHP 5, PHP 7
85102 **/
85103function sin($arg){}
85104
85105/**
85106 * Hyperbolic sine
85107 *
85108 * Returns the hyperbolic sine of {@link arg}, defined as (exp(arg) -
85109 * exp(-arg))/2.
85110 *
85111 * @param float $arg The argument to process
85112 * @return float The hyperbolic sine of {@link arg}
85113 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
85114 **/
85115function sinh($arg){}
85116
85117/**
85118 * Count all elements in an array, or something in an object
85119 *
85120 * Counts all elements in an array, or something in an object.
85121 *
85122 * For objects, if you have SPL installed, you can hook into {@link
85123 * sizeof} by implementing interface Countable. The interface has exactly
85124 * one method, Countable::sizeof, which returns the return value for the
85125 * {@link sizeof} function.
85126 *
85127 * Please see the Array section of the manual for a detailed explanation
85128 * of how arrays are implemented and used in PHP.
85129 *
85130 * @param mixed $array_or_countable An array or Countable object.
85131 * @param int $mode If the optional {@link mode} parameter is set to
85132 *   COUNT_RECURSIVE (or 1), {@link count} will recursively count the
85133 *   array. This is particularly useful for counting all the elements of
85134 *   a multidimensional array.
85135 * @return int Returns the number of elements in {@link
85136 *   array_or_countable}. When the parameter is neither an array nor an
85137 *   object with implemented Countable interface, 1 will be returned.
85138 *   There is one exception, if {@link array_or_countable} is NULL, 0
85139 *   will be returned.
85140 * @since PHP 4, PHP 5, PHP 7
85141 **/
85142function sizeof($array_or_countable, $mode){}
85143
85144/**
85145 * Delay execution
85146 *
85147 * @param int $seconds Halt time in seconds.
85148 * @return int Returns zero on success, or FALSE on error.
85149 * @since PHP 4, PHP 5, PHP 7
85150 **/
85151function sleep($seconds){}
85152
85153/**
85154 * Fetch an object
85155 *
85156 * The {@link snmp2_get} function is used to read the value of an SNMP
85157 * object specified by the {@link object_id}.
85158 *
85159 * @param string $host The SNMP agent.
85160 * @param string $community The read community.
85161 * @param string $object_id The SNMP object.
85162 * @param int $timeout The number of microseconds until the first
85163 *   timeout.
85164 * @param int $retries The number of times to retry if timeouts occur.
85165 * @return string Returns SNMP object value on success or FALSE on
85166 *   error.
85167 * @since PHP 5 >= 5.2.0, PHP 7
85168 **/
85169function snmp2_get($host, $community, $object_id, $timeout, $retries){}
85170
85171/**
85172 * Fetch the object which follows the given object id
85173 *
85174 * The {@link snmp2_get_next} function is used to read the value of the
85175 * SNMP object that follows the specified {@link object_id}.
85176 *
85177 * @param string $host The hostname of the SNMP agent (server).
85178 * @param string $community The read community.
85179 * @param string $object_id The SNMP object id which precedes the
85180 *   wanted one.
85181 * @param int $timeout The number of microseconds until the first
85182 *   timeout.
85183 * @param int $retries The number of times to retry if timeouts occur.
85184 * @return string Returns SNMP object value on success or FALSE on
85185 *   error. In case of an error, an E_WARNING message is shown.
85186 * @since PHP >= 5.2.0
85187 **/
85188function snmp2_getnext($host, $community, $object_id, $timeout, $retries){}
85189
85190/**
85191 * Return all objects including their respective object ID within the
85192 * specified one
85193 *
85194 * The {@link snmp2_real_walk} function is used to traverse over a number
85195 * of SNMP objects starting from {@link object_id} and return not only
85196 * their values but also their object ids.
85197 *
85198 * @param string $host The hostname of the SNMP agent (server).
85199 * @param string $community The read community.
85200 * @param string $object_id The SNMP object id which precedes the
85201 *   wanted one.
85202 * @param int $timeout The number of microseconds until the first
85203 *   timeout.
85204 * @param int $retries The number of times to retry if timeouts occur.
85205 * @return array Returns an associative array of the SNMP object ids
85206 *   and their values on success or FALSE on error. In case of an error,
85207 *   an E_WARNING message is shown.
85208 * @since PHP >= 5.2.0
85209 **/
85210function snmp2_real_walk($host, $community, $object_id, $timeout, $retries){}
85211
85212/**
85213 * Set the value of an object
85214 *
85215 * {@link snmp2_set} is used to set the value of an SNMP object specified
85216 * by the {@link object_id}.
85217 *
85218 * @param string $host The hostname of the SNMP agent (server).
85219 * @param string $community The write community.
85220 * @param string $object_id The SNMP object id.
85221 * @param string $type
85222 * @param string $value The new value.
85223 * @param int $timeout The number of microseconds until the first
85224 *   timeout.
85225 * @param int $retries The number of times to retry if timeouts occur.
85226 * @return bool
85227 * @since PHP >= 5.2.0
85228 **/
85229function snmp2_set($host, $community, $object_id, $type, $value, $timeout, $retries){}
85230
85231/**
85232 * Fetch all the objects from an agent
85233 *
85234 * {@link snmp2_walk} function is used to read all the values from an
85235 * SNMP agent specified by the {@link hostname}.
85236 *
85237 * @param string $host The SNMP agent (server).
85238 * @param string $community The read community.
85239 * @param string $object_id If NULL, {@link object_id} is taken as the
85240 *   root of the SNMP objects tree and all objects under that tree are
85241 *   returned as an array. If {@link object_id} is specified, all the
85242 *   SNMP objects below that {@link object_id} are returned.
85243 * @param int $timeout The number of microseconds until the first
85244 *   timeout.
85245 * @param int $retries The number of times to retry if timeouts occur.
85246 * @return array Returns an array of SNMP object values starting from
85247 *   the {@link object_id} as root or FALSE on error.
85248 * @since PHP >= 5.2.0
85249 **/
85250function snmp2_walk($host, $community, $object_id, $timeout, $retries){}
85251
85252/**
85253 * Fetch an object
85254 *
85255 * The {@link snmp3_get} function is used to read the value of an SNMP
85256 * object specified by the {@link object_id}.
85257 *
85258 * @param string $host The hostname of the SNMP agent (server).
85259 * @param string $sec_name the security name, usually some kind of
85260 *   username
85261 * @param string $sec_level the security level
85262 *   (noAuthNoPriv|authNoPriv|authPriv)
85263 * @param string $auth_protocol the authentication protocol (MD5 or
85264 *   SHA)
85265 * @param string $auth_passphrase the authentication pass phrase
85266 * @param string $priv_protocol the privacy protocol (DES or AES)
85267 * @param string $priv_passphrase the privacy pass phrase
85268 * @param string $object_id The SNMP object id.
85269 * @param int $timeout The number of microseconds until the first
85270 *   timeout.
85271 * @param int $retries The number of times to retry if timeouts occur.
85272 * @return string Returns SNMP object value on success or FALSE on
85273 *   error.
85274 * @since PHP 4, PHP 5, PHP 7
85275 **/
85276function snmp3_get($host, $sec_name, $sec_level, $auth_protocol, $auth_passphrase, $priv_protocol, $priv_passphrase, $object_id, $timeout, $retries){}
85277
85278/**
85279 * Fetch the object which follows the given object id
85280 *
85281 * The {@link snmp3_getnext} function is used to read the value of the
85282 * SNMP object that follows the specified {@link object_id}.
85283 *
85284 * @param string $host The hostname of the SNMP agent (server).
85285 * @param string $sec_name the security name, usually some kind of
85286 *   username
85287 * @param string $sec_level the security level
85288 *   (noAuthNoPriv|authNoPriv|authPriv)
85289 * @param string $auth_protocol the authentication protocol (MD5 or
85290 *   SHA)
85291 * @param string $auth_passphrase the authentication pass phrase
85292 * @param string $priv_protocol the privacy protocol (DES or AES)
85293 * @param string $priv_passphrase the privacy pass phrase
85294 * @param string $object_id The SNMP object id.
85295 * @param int $timeout The number of microseconds until the first
85296 *   timeout.
85297 * @param int $retries The number of times to retry if timeouts occur.
85298 * @return string Returns SNMP object value on success or FALSE on
85299 *   error. In case of an error, an E_WARNING message is shown.
85300 * @since PHP 5, PHP 7
85301 **/
85302function snmp3_getnext($host, $sec_name, $sec_level, $auth_protocol, $auth_passphrase, $priv_protocol, $priv_passphrase, $object_id, $timeout, $retries){}
85303
85304/**
85305 * Return all objects including their respective object ID within the
85306 * specified one
85307 *
85308 * The {@link snmp3_real_walk} function is used to traverse over a number
85309 * of SNMP objects starting from {@link object_id} and return not only
85310 * their values but also their object ids.
85311 *
85312 * @param string $host The hostname of the SNMP agent (server).
85313 * @param string $sec_name the security name, usually some kind of
85314 *   username
85315 * @param string $sec_level the security level
85316 *   (noAuthNoPriv|authNoPriv|authPriv)
85317 * @param string $auth_protocol the authentication protocol (MD5 or
85318 *   SHA)
85319 * @param string $auth_passphrase the authentication pass phrase
85320 * @param string $priv_protocol the privacy protocol (DES or AES)
85321 * @param string $priv_passphrase the privacy pass phrase
85322 * @param string $object_id The SNMP object id.
85323 * @param int $timeout The number of microseconds until the first
85324 *   timeout.
85325 * @param int $retries The number of times to retry if timeouts occur.
85326 * @return array Returns an associative array of the SNMP object ids
85327 *   and their values on success or FALSE on error. In case of an error,
85328 *   an E_WARNING message is shown.
85329 * @since PHP 4, PHP 5, PHP 7
85330 **/
85331function snmp3_real_walk($host, $sec_name, $sec_level, $auth_protocol, $auth_passphrase, $priv_protocol, $priv_passphrase, $object_id, $timeout, $retries){}
85332
85333/**
85334 * Set the value of an SNMP object
85335 *
85336 * {@link snmp3_set} is used to set the value of an SNMP object specified
85337 * by the {@link object_id}.
85338 *
85339 * Even if the security level does not use an auth or priv
85340 * protocol/password valid values have to be specified.
85341 *
85342 * @param string $host The hostname of the SNMP agent (server).
85343 * @param string $sec_name the security name, usually some kind of
85344 *   username
85345 * @param string $sec_level the security level
85346 *   (noAuthNoPriv|authNoPriv|authPriv)
85347 * @param string $auth_protocol the authentication protocol (MD5 or
85348 *   SHA)
85349 * @param string $auth_passphrase the authentication pass phrase
85350 * @param string $priv_protocol the privacy protocol (DES or AES)
85351 * @param string $priv_passphrase the privacy pass phrase
85352 * @param string $object_id The SNMP object id.
85353 * @param string $type
85354 * @param string $value The new value
85355 * @param int $timeout The number of microseconds until the first
85356 *   timeout.
85357 * @param int $retries The number of times to retry if timeouts occur.
85358 * @return bool
85359 * @since PHP 4, PHP 5, PHP 7
85360 **/
85361function snmp3_set($host, $sec_name, $sec_level, $auth_protocol, $auth_passphrase, $priv_protocol, $priv_passphrase, $object_id, $type, $value, $timeout, $retries){}
85362
85363/**
85364 * Fetch all the objects from an agent
85365 *
85366 * {@link snmp3_walk} function is used to read all the values from an
85367 * SNMP agent specified by the {@link hostname}.
85368 *
85369 * Even if the security level does not use an auth or priv
85370 * protocol/password valid values have to be specified.
85371 *
85372 * @param string $host The hostname of the SNMP agent (server).
85373 * @param string $sec_name the security name, usually some kind of
85374 *   username
85375 * @param string $sec_level the security level
85376 *   (noAuthNoPriv|authNoPriv|authPriv)
85377 * @param string $auth_protocol the authentication protocol (MD5 or
85378 *   SHA)
85379 * @param string $auth_passphrase the authentication pass phrase
85380 * @param string $priv_protocol the privacy protocol (DES or AES)
85381 * @param string $priv_passphrase the privacy pass phrase
85382 * @param string $object_id If NULL, {@link object_id} is taken as the
85383 *   root of the SNMP objects tree and all objects under that tree are
85384 *   returned as an array. If {@link object_id} is specified, all the
85385 *   SNMP objects below that {@link object_id} are returned.
85386 * @param int $timeout The number of microseconds until the first
85387 *   timeout.
85388 * @param int $retries The number of times to retry if timeouts occur.
85389 * @return array Returns an array of SNMP object values starting from
85390 *   the {@link object_id} as root or FALSE on error.
85391 * @since PHP 4, PHP 5, PHP 7
85392 **/
85393function snmp3_walk($host, $sec_name, $sec_level, $auth_protocol, $auth_passphrase, $priv_protocol, $priv_passphrase, $object_id, $timeout, $retries){}
85394
85395/**
85396 * Fetch an object
85397 *
85398 * The {@link snmpget} function is used to read the value of an SNMP
85399 * object specified by the {@link object_id}.
85400 *
85401 * @param string $hostname The SNMP agent.
85402 * @param string $community The read community.
85403 * @param string $object_id The SNMP object.
85404 * @param int $timeout The number of microseconds until the first
85405 *   timeout.
85406 * @param int $retries The number of times to retry if timeouts occur.
85407 * @return string Returns SNMP object value on success or FALSE on
85408 *   error.
85409 * @since PHP 4, PHP 5, PHP 7
85410 **/
85411function snmpget($hostname, $community, $object_id, $timeout, $retries){}
85412
85413/**
85414 * Fetch the object which follows the given object id
85415 *
85416 * The {@link snmpgetnext} function is used to read the value of the SNMP
85417 * object that follows the specified {@link object_id}.
85418 *
85419 * @param string $host The hostname of the SNMP agent (server).
85420 * @param string $community The read community.
85421 * @param string $object_id The SNMP object id which precedes the
85422 *   wanted one.
85423 * @param int $timeout The number of microseconds until the first
85424 *   timeout.
85425 * @param int $retries The number of times to retry if timeouts occur.
85426 * @return string Returns SNMP object value on success or FALSE on
85427 *   error. In case of an error, an E_WARNING message is shown.
85428 * @since PHP 5, PHP 7
85429 **/
85430function snmpgetnext($host, $community, $object_id, $timeout, $retries){}
85431
85432/**
85433 * Return all objects including their respective object ID within the
85434 * specified one
85435 *
85436 * The {@link snmprealwalk} function is used to traverse over a number of
85437 * SNMP objects starting from {@link object_id} and return not only their
85438 * values but also their object ids.
85439 *
85440 * @param string $host The hostname of the SNMP agent (server).
85441 * @param string $community The read community.
85442 * @param string $object_id The SNMP object id which precedes the
85443 *   wanted one.
85444 * @param int $timeout The number of microseconds until the first
85445 *   timeout.
85446 * @param int $retries The number of times to retry if timeouts occur.
85447 * @return array Returns an associative array of the SNMP object ids
85448 *   and their values on success or FALSE on error. In case of an error,
85449 *   an E_WARNING message is shown.
85450 * @since PHP 4, PHP 5, PHP 7
85451 **/
85452function snmprealwalk($host, $community, $object_id, $timeout, $retries){}
85453
85454/**
85455 * Set the value of an object
85456 *
85457 * {@link snmpset} is used to set the value of an SNMP object specified
85458 * by the {@link object_id}.
85459 *
85460 * @param string $host The hostname of the SNMP agent (server).
85461 * @param string $community The write community.
85462 * @param string $object_id The SNMP object id.
85463 * @param string $type
85464 * @param mixed $value The new value.
85465 * @param int $timeout The number of microseconds until the first
85466 *   timeout.
85467 * @param int $retries The number of times to retry if timeouts occur.
85468 * @return bool
85469 * @since PHP 4, PHP 5, PHP 7
85470 **/
85471function snmpset($host, $community, $object_id, $type, $value, $timeout, $retries){}
85472
85473/**
85474 * Fetch all the objects from an agent
85475 *
85476 * {@link snmpwalk} function is used to read all the values from an SNMP
85477 * agent specified by the {@link hostname}.
85478 *
85479 * @param string $hostname The SNMP agent (server).
85480 * @param string $community The read community.
85481 * @param string $object_id If NULL, {@link object_id} is taken as the
85482 *   root of the SNMP objects tree and all objects under that tree are
85483 *   returned as an array. If {@link object_id} is specified, all the
85484 *   SNMP objects below that {@link object_id} are returned.
85485 * @param int $timeout The number of microseconds until the first
85486 *   timeout.
85487 * @param int $retries The number of times to retry if timeouts occur.
85488 * @return array Returns an array of SNMP object values starting from
85489 *   the {@link object_id} as root or FALSE on error.
85490 * @since PHP 4, PHP 5, PHP 7
85491 **/
85492function snmpwalk($hostname, $community, $object_id, $timeout, $retries){}
85493
85494/**
85495 * Query for a tree of information about a network entity
85496 *
85497 * {@link snmpwalkoid} function is used to read all object ids and their
85498 * respective values from an SNMP agent specified by {@link hostname}.
85499 *
85500 * The existence of {@link snmpwalkoid} and {@link snmpwalk} has
85501 * historical reasons. Both functions are provided for backward
85502 * compatibility. Use {@link snmprealwalk} instead.
85503 *
85504 * @param string $hostname The SNMP agent.
85505 * @param string $community The read community.
85506 * @param string $object_id If NULL, {@link object_id} is taken as the
85507 *   root of the SNMP objects tree and all objects under that tree are
85508 *   returned as an array. If {@link object_id} is specified, all the
85509 *   SNMP objects below that {@link object_id} are returned.
85510 * @param int $timeout The number of microseconds until the first
85511 *   timeout.
85512 * @param int $retries The number of times to retry if timeouts occur.
85513 * @return array Returns an associative array with object ids and their
85514 *   respective object value starting from the {@link object_id} as root
85515 *   or FALSE on error.
85516 * @since PHP 4, PHP 5, PHP 7
85517 **/
85518function snmpwalkoid($hostname, $community, $object_id, $timeout, $retries){}
85519
85520/**
85521 * Fetches the current value of the UCD library's quick_print setting
85522 *
85523 * Returns the current value stored in the UCD Library for quick_print.
85524 * quick_print is off by default.
85525 *
85526 * @return bool Returns TRUE if quick_print is on, FALSE otherwise.
85527 * @since PHP 4, PHP 5, PHP 7
85528 **/
85529function snmp_get_quick_print(){}
85530
85531/**
85532 * Return the method how the SNMP values will be returned
85533 *
85534 * @return int OR-ed combitantion of constants ( SNMP_VALUE_LIBRARY or
85535 *   SNMP_VALUE_PLAIN ) with possible SNMP_VALUE_OBJECT set.
85536 * @since PHP 4 >= 4.3.3, PHP 5, PHP 7
85537 **/
85538function snmp_get_valueretrieval(){}
85539
85540/**
85541 * Reads and parses a MIB file into the active MIB tree
85542 *
85543 * This function is used to load additional, e.g. vendor specific, MIBs
85544 * so that human readable OIDs like VENDOR-MIB::foo.1 instead of error
85545 * prone numeric OIDs can be used.
85546 *
85547 * The order in which the MIBs are loaded does matter as the underlying
85548 * Net-SNMP libary will print warnings if referenced objects cannot be
85549 * resolved.
85550 *
85551 * @param string $filename The filename of the MIB.
85552 * @return bool
85553 * @since PHP 5, PHP 7
85554 **/
85555function snmp_read_mib($filename){}
85556
85557/**
85558 * Return all values that are enums with their enum value instead of the
85559 * raw integer
85560 *
85561 * This function toggles if snmpwalk/snmpget etc. should automatically
85562 * lookup enum values in the MIB and return them together with their
85563 * human readable string.
85564 *
85565 * @param int $enum_print As the value is interpreted as boolean by the
85566 *   Net-SNMP library, it can only be "0" or "1".
85567 * @return bool
85568 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
85569 **/
85570function snmp_set_enum_print($enum_print){}
85571
85572/**
85573 * Set the OID output format
85574 *
85575 * {@link snmp_set_oid_output_format}.
85576 *
85577 * @param int $oid_format
85578 * @return void
85579 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
85580 **/
85581function snmp_set_oid_numeric_print($oid_format){}
85582
85583/**
85584 * Set the OID output format
85585 *
85586 * {@link snmp_set_oid_output_format} sets the output format to be full
85587 * or numeric.
85588 *
85589 * @param int $oid_format Begining from PHP 5.4.0 four additional
85590 *   constants available:
85591 *   SNMP_OID_OUTPUT_MODULEDISMAN-EVENT-MIB::sysUpTimeInstance
85592 *   SNMP_OID_OUTPUT_SUFFIXsysUpTimeInstance
85593 *   SNMP_OID_OUTPUT_UCDsystem.sysUpTime.sysUpTimeInstance
85594 *   SNMP_OID_OUTPUT_NONEUndefined
85595 * @return bool
85596 * @since PHP 5 >= 5.2.0, PHP 7
85597 **/
85598function snmp_set_oid_output_format($oid_format){}
85599
85600/**
85601 * Set the value of within the UCD library
85602 *
85603 * Sets the value of {@link quick_print} within the UCD SNMP library.
85604 * When this is set (1), the SNMP library will return 'quick printed'
85605 * values. This means that just the value will be printed. When {@link
85606 * quick_print} is not enabled (default) the UCD SNMP library prints
85607 * extra information including the type of the value (i.e. IpAddress or
85608 * OID). Additionally, if quick_print is not enabled, the library prints
85609 * additional hex values for all strings of three characters or less.
85610 *
85611 * By default the UCD SNMP library returns verbose values, quick_print is
85612 * used to return only the value.
85613 *
85614 * Currently strings are still returned with extra quotes, this will be
85615 * corrected in a later release.
85616 *
85617 * @param bool $quick_print
85618 * @return bool
85619 * @since PHP 4, PHP 5, PHP 7
85620 **/
85621function snmp_set_quick_print($quick_print){}
85622
85623/**
85624 * Specify the method how the SNMP values will be returned
85625 *
85626 * @param int $method
85627 * @return bool
85628 * @since PHP 4 >= 4.3.3, PHP 5, PHP 7
85629 **/
85630function snmp_set_valueretrieval($method){}
85631
85632/**
85633 * Accepts a connection on a socket
85634 *
85635 * After the socket {@link socket} has been created using {@link
85636 * socket_create}, bound to a name with {@link socket_bind}, and told to
85637 * listen for connections with {@link socket_listen}, this function will
85638 * accept incoming connections on that socket. Once a successful
85639 * connection is made, a new socket resource is returned, which may be
85640 * used for communication. If there are multiple connections queued on
85641 * the socket, the first will be used. If there are no pending
85642 * connections, {@link socket_accept} will block until a connection
85643 * becomes present. If {@link socket} has been made non-blocking using
85644 * {@link socket_set_blocking} or {@link socket_set_nonblock}, FALSE will
85645 * be returned.
85646 *
85647 * The socket resource returned by {@link socket_accept} may not be used
85648 * to accept new connections. The original listening socket {@link
85649 * socket}, however, remains open and may be reused.
85650 *
85651 * @param resource $socket A valid socket resource created with {@link
85652 *   socket_create}.
85653 * @return resource Returns a new socket resource on success, or FALSE
85654 *   on error. The actual error code can be retrieved by calling {@link
85655 *   socket_last_error}. This error code may be passed to {@link
85656 *   socket_strerror} to get a textual explanation of the error.
85657 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
85658 **/
85659function socket_accept($socket){}
85660
85661/**
85662 * Create and bind to a socket from a given addrinfo
85663 *
85664 * Create a Socket resource, and bind it to the provided AddrInfo
85665 * resource. The return value of this function may be used with {@link
85666 * socket_listen}.
85667 *
85668 * @param resource $addr Resource created from {@link
85669 *   socket_addrinfo_lookup}.
85670 * @return resource Returns a Socket resource on success or NULL on
85671 *   failure.
85672 * @since PHP 7 >= 7.2.0
85673 **/
85674function socket_addrinfo_bind($addr){}
85675
85676/**
85677 * Create and connect to a socket from a given addrinfo
85678 *
85679 * Create a Socket resource, and connect it to the provided AddrInfo
85680 * resource. The return value of this function may be used with the rest
85681 * of the socket functions.
85682 *
85683 * @param resource $addr Resource created from {@link
85684 *   socket_addrinfo_lookup}
85685 * @return resource Returns a Socket resource on success or NULL on
85686 *   failure.
85687 * @since PHP 7 >= 7.2.0
85688 **/
85689function socket_addrinfo_connect($addr){}
85690
85691/**
85692 * Get information about addrinfo
85693 *
85694 * {@link socket_addrinfo_explain} exposed the underlying addrinfo
85695 * structure.
85696 *
85697 * @param resource $addr Resource created from {@link
85698 *   socket_addrinfo_lookup}
85699 * @return array Returns an array containing the fields in the addrinfo
85700 *   structure.
85701 * @since PHP 7 >= 7.2.0
85702 **/
85703function socket_addrinfo_explain($addr){}
85704
85705/**
85706 * Get array with contents of getaddrinfo about the given hostname
85707 *
85708 * Lookup different ways we can connect to {@link host}. The returned
85709 * array contains a set of resources that we can bind to using {@link
85710 * socket_addrinfo_bind}.
85711 *
85712 * @param string $host Hostname to search.
85713 * @param string $service The service to connect to. If service is a
85714 *   name, it is translated to the corresponding port number.
85715 * @param array $hints Hints provide criteria for selecting addresses
85716 *   returned. You may specify the hints as defined by getadrinfo.
85717 * @return array Returns an array of AddrInfo resource handles that can
85718 *   be used with the other socket_addrinfo functions.
85719 * @since PHP 7 >= 7.2.0
85720 **/
85721function socket_addrinfo_lookup($host, $service, $hints){}
85722
85723/**
85724 * Binds a name to a socket
85725 *
85726 * Binds the name given in {@link address} to the socket described by
85727 * {@link socket}. This has to be done before a connection is be
85728 * established using {@link socket_connect} or {@link socket_listen}.
85729 *
85730 * @param resource $socket A valid socket resource created with {@link
85731 *   socket_create}.
85732 * @param string $address If the socket is of the AF_INET family, the
85733 *   {@link address} is an IP in dotted-quad notation (e.g. 127.0.0.1).
85734 *   If the socket is of the AF_UNIX family, the {@link address} is the
85735 *   path of a Unix-domain socket (e.g. /tmp/my.sock).
85736 * @param int $port The {@link port} parameter is only used when
85737 *   binding an AF_INET socket, and designates the port on which to
85738 *   listen for connections.
85739 * @return bool
85740 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
85741 **/
85742function socket_bind($socket, $address, $port){}
85743
85744/**
85745 * Clears the error on the socket or the last error code
85746 *
85747 * This function clears the error code on the given socket or the global
85748 * last socket error if no socket is specified.
85749 *
85750 * This function allows explicitly resetting the error code value either
85751 * of a socket or of the extension global last error code. This may be
85752 * useful to detect within a part of the application if an error occurred
85753 * or not.
85754 *
85755 * @param resource $socket A valid socket resource created with {@link
85756 *   socket_create}.
85757 * @return void
85758 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
85759 **/
85760function socket_clear_error($socket){}
85761
85762/**
85763 * Closes a socket resource
85764 *
85765 * {@link socket_close} closes the socket resource given by {@link
85766 * socket}. This function is specific to sockets and cannot be used on
85767 * any other type of resources.
85768 *
85769 * @param resource $socket A valid socket resource created with {@link
85770 *   socket_create} or {@link socket_accept}.
85771 * @return void
85772 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
85773 **/
85774function socket_close($socket){}
85775
85776/**
85777 * Calculate message buffer size
85778 *
85779 * Calculates the size of the buffer that should be allocated for
85780 * receiving the ancillary data.
85781 *
85782 * @param int $level
85783 * @param int $type
85784 * @param int $n
85785 * @return int
85786 * @since PHP 5 >= 5.5.0, PHP 7
85787 **/
85788function socket_cmsg_space($level, $type, $n){}
85789
85790/**
85791 * Initiates a connection on a socket
85792 *
85793 * Initiate a connection to {@link address} using the socket resource
85794 * {@link socket}, which must be a valid socket resource created with
85795 * {@link socket_create}.
85796 *
85797 * @param resource $socket
85798 * @param string $address The {@link address} parameter is either an
85799 *   IPv4 address in dotted-quad notation (e.g. 127.0.0.1) if {@link
85800 *   socket} is AF_INET, a valid IPv6 address (e.g. ::1) if IPv6 support
85801 *   is enabled and {@link socket} is AF_INET6 or the pathname of a Unix
85802 *   domain socket, if the socket family is AF_UNIX.
85803 * @param int $port The {@link port} parameter is only used and is
85804 *   mandatory when connecting to an AF_INET or an AF_INET6 socket, and
85805 *   designates the port on the remote host to which a connection should
85806 *   be made.
85807 * @return bool The error code can be retrieved with {@link
85808 *   socket_last_error}. This code may be passed to {@link
85809 *   socket_strerror} to get a textual explanation of the error.
85810 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
85811 **/
85812function socket_connect($socket, $address, $port){}
85813
85814/**
85815 * Create a socket (endpoint for communication)
85816 *
85817 * Creates and returns a socket resource, also referred to as an endpoint
85818 * of communication. A typical network connection is made up of 2
85819 * sockets, one performing the role of the client, and another performing
85820 * the role of the server.
85821 *
85822 * @param int $domain The {@link domain} parameter specifies the
85823 *   protocol family to be used by the socket.
85824 * @param int $type The {@link type} parameter selects the type of
85825 *   communication to be used by the socket.
85826 * @param int $protocol The {@link protocol} parameter sets the
85827 *   specific protocol within the specified {@link domain} to be used
85828 *   when communicating on the returned socket. The proper value can be
85829 *   retrieved by name by using {@link getprotobyname}. If the desired
85830 *   protocol is TCP, or UDP the corresponding constants SOL_TCP, and
85831 *   SOL_UDP can also be used.
85832 * @return resource {@link socket_create} returns a socket resource on
85833 *   success, or FALSE on error. The actual error code can be retrieved
85834 *   by calling {@link socket_last_error}. This error code may be passed
85835 *   to {@link socket_strerror} to get a textual explanation of the
85836 *   error.
85837 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
85838 **/
85839function socket_create($domain, $type, $protocol){}
85840
85841/**
85842 * Opens a socket on port to accept connections
85843 *
85844 * {@link socket_create_listen} creates a new socket resource of type
85845 * AF_INET listening on all local interfaces on the given port waiting
85846 * for new connections.
85847 *
85848 * This function is meant to ease the task of creating a new socket which
85849 * only listens to accept new connections.
85850 *
85851 * @param int $port The port on which to listen on all interfaces.
85852 * @param int $backlog The {@link backlog} parameter defines the
85853 *   maximum length the queue of pending connections may grow to.
85854 *   SOMAXCONN may be passed as {@link backlog} parameter, see {@link
85855 *   socket_listen} for more information.
85856 * @return resource {@link socket_create_listen} returns a new socket
85857 *   resource on success or FALSE on error. The error code can be
85858 *   retrieved with {@link socket_last_error}. This code may be passed to
85859 *   {@link socket_strerror} to get a textual explanation of the error.
85860 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
85861 **/
85862function socket_create_listen($port, $backlog){}
85863
85864/**
85865 * Creates a pair of indistinguishable sockets and stores them in an
85866 * array
85867 *
85868 * {@link socket_create_pair} creates two connected and indistinguishable
85869 * sockets, and stores them in {@link fd}. This function is commonly used
85870 * in IPC (InterProcess Communication).
85871 *
85872 * @param int $domain The {@link domain} parameter specifies the
85873 *   protocol family to be used by the socket. See {@link socket_create}
85874 *   for the full list.
85875 * @param int $type The {@link type} parameter selects the type of
85876 *   communication to be used by the socket. See {@link socket_create}
85877 *   for the full list.
85878 * @param int $protocol The {@link protocol} parameter sets the
85879 *   specific protocol within the specified {@link domain} to be used
85880 *   when communicating on the returned socket. The proper value can be
85881 *   retrieved by name by using {@link getprotobyname}. If the desired
85882 *   protocol is TCP, or UDP the corresponding constants SOL_TCP, and
85883 *   SOL_UDP can also be used. See {@link socket_create} for the full
85884 *   list of supported protocols.
85885 * @param array $fd Reference to an array in which the two socket
85886 *   resources will be inserted.
85887 * @return bool
85888 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
85889 **/
85890function socket_create_pair($domain, $type, $protocol, &$fd){}
85891
85892/**
85893 * Export a socket extension resource into a stream that encapsulates a
85894 * socket
85895 *
85896 * @param resource $socket
85897 * @return resource Return resource.
85898 * @since PHP 7 >= 7.0.7
85899 **/
85900function socket_export_stream($socket){}
85901
85902/**
85903 * Gets socket options for the socket
85904 *
85905 * The {@link socket_getopt} function retrieves the value for the option
85906 * specified by the {@link optname} parameter for the specified {@link
85907 * socket}.
85908 *
85909 * @param resource $socket A valid socket resource created with {@link
85910 *   socket_create} or {@link socket_accept}.
85911 * @param int $level The {@link level} parameter specifies the protocol
85912 *   level at which the option resides. For example, to retrieve options
85913 *   at the socket level, a {@link level} parameter of SOL_SOCKET would
85914 *   be used. Other levels, such as TCP, can be used by specifying the
85915 *   protocol number of that level. Protocol numbers can be found by
85916 *   using the {@link getprotobyname} function.
85917 * @param int $optname
85918 * @return mixed Returns the value of the given option, or FALSE on
85919 *   errors.
85920 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
85921 **/
85922function socket_getopt($socket, $level, $optname){}
85923
85924/**
85925 * Queries the remote side of the given socket which may either result in
85926 * host/port or in a Unix filesystem path, dependent on its type
85927 *
85928 * Queries the remote side of the given socket which may either result in
85929 * host/port or in a Unix filesystem path, dependent on its type.
85930 *
85931 * @param resource $socket A valid socket resource created with {@link
85932 *   socket_create} or {@link socket_accept}.
85933 * @param string $address If the given socket is of type AF_INET or
85934 *   AF_INET6, {@link socket_getpeername} will return the peers (remote)
85935 *   IP address in appropriate notation (e.g. 127.0.0.1 or fe80::1) in
85936 *   the {@link address} parameter and, if the optional {@link port}
85937 *   parameter is present, also the associated port. If the given socket
85938 *   is of type AF_UNIX, {@link socket_getpeername} will return the Unix
85939 *   filesystem path (e.g. /var/run/daemon.sock) in the {@link address}
85940 *   parameter.
85941 * @param int $port If given, this will hold the port associated to
85942 *   {@link address}.
85943 * @return bool {@link socket_getpeername} may also return FALSE if the
85944 *   socket type is not any of AF_INET, AF_INET6, or AF_UNIX, in which
85945 *   case the last socket error code is not updated.
85946 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
85947 **/
85948function socket_getpeername($socket, &$address, &$port){}
85949
85950/**
85951 * Queries the local side of the given socket which may either result in
85952 * host/port or in a Unix filesystem path, dependent on its type
85953 *
85954 * @param resource $socket A valid socket resource created with {@link
85955 *   socket_create} or {@link socket_accept}.
85956 * @param string $addr If the given socket is of type AF_INET or
85957 *   AF_INET6, {@link socket_getsockname} will return the local IP
85958 *   address in appropriate notation (e.g. 127.0.0.1 or fe80::1) in the
85959 *   {@link address} parameter and, if the optional {@link port}
85960 *   parameter is present, also the associated port. If the given socket
85961 *   is of type AF_UNIX, {@link socket_getsockname} will return the Unix
85962 *   filesystem path (e.g. /var/run/daemon.sock) in the {@link address}
85963 *   parameter.
85964 * @param int $port If provided, this will hold the associated port.
85965 * @return bool {@link socket_getsockname} may also return FALSE if the
85966 *   socket type is not any of AF_INET, AF_INET6, or AF_UNIX, in which
85967 *   case the last socket error code is not updated.
85968 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
85969 **/
85970function socket_getsockname($socket, &$addr, &$port){}
85971
85972/**
85973 * Gets socket options for the socket
85974 *
85975 * The {@link socket_get_option} function retrieves the value for the
85976 * option specified by the {@link optname} parameter for the specified
85977 * {@link socket}.
85978 *
85979 * @param resource $socket A valid socket resource created with {@link
85980 *   socket_create} or {@link socket_accept}.
85981 * @param int $level The {@link level} parameter specifies the protocol
85982 *   level at which the option resides. For example, to retrieve options
85983 *   at the socket level, a {@link level} parameter of SOL_SOCKET would
85984 *   be used. Other levels, such as TCP, can be used by specifying the
85985 *   protocol number of that level. Protocol numbers can be found by
85986 *   using the {@link getprotobyname} function.
85987 * @param int $optname
85988 * @return mixed Returns the value of the given option, or FALSE on
85989 *   errors.
85990 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
85991 **/
85992function socket_get_option($socket, $level, $optname){}
85993
85994/**
85995 * Import a stream
85996 *
85997 * Imports a stream that encapsulates a socket into a socket extension
85998 * resource.
85999 *
86000 * @param resource $stream The stream resource to import.
86001 * @return resource Returns FALSE or NULL on failure.
86002 * @since PHP 5 >= 5.4.0, PHP 7
86003 **/
86004function socket_import_stream($stream){}
86005
86006/**
86007 * Returns the last error on the socket
86008 *
86009 * If a socket resource is passed to this function, the last error which
86010 * occurred on this particular socket is returned. If the socket resource
86011 * is omitted, the error code of the last failed socket function is
86012 * returned. The latter is particularly helpful for functions like {@link
86013 * socket_create} which don't return a socket on failure and {@link
86014 * socket_select} which can fail for reasons not directly tied to a
86015 * particular socket. The error code is suitable to be fed to {@link
86016 * socket_strerror} which returns a string describing the given error
86017 * code.
86018 *
86019 * If no error had occurred, or the error had been cleared with {@link
86020 * socket_clear_error}, the function returns 0.
86021 *
86022 * @param resource $socket A valid socket resource created with {@link
86023 *   socket_create}.
86024 * @return int This function returns a socket error code.
86025 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
86026 **/
86027function socket_last_error($socket){}
86028
86029/**
86030 * Listens for a connection on a socket
86031 *
86032 * After the socket {@link socket} has been created using {@link
86033 * socket_create} and bound to a name with {@link socket_bind}, it may be
86034 * told to listen for incoming connections on {@link socket}.
86035 *
86036 * {@link socket_listen} is applicable only to sockets of type
86037 * SOCK_STREAM or SOCK_SEQPACKET.
86038 *
86039 * @param resource $socket A valid socket resource created with {@link
86040 *   socket_create} or {@link socket_addrinfo_bind}
86041 * @param int $backlog A maximum of {@link backlog} incoming
86042 *   connections will be queued for processing. If a connection request
86043 *   arrives with the queue full the client may receive an error with an
86044 *   indication of ECONNREFUSED, or, if the underlying protocol supports
86045 *   retransmission, the request may be ignored so that retries may
86046 *   succeed.
86047 * @return bool The error code can be retrieved with {@link
86048 *   socket_last_error}. This code may be passed to {@link
86049 *   socket_strerror} to get a textual explanation of the error.
86050 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
86051 **/
86052function socket_listen($socket, $backlog){}
86053
86054/**
86055 * Reads a maximum of length bytes from a socket
86056 *
86057 * The function {@link socket_read} reads from the socket resource {@link
86058 * socket} created by the {@link socket_create} or {@link socket_accept}
86059 * functions.
86060 *
86061 * @param resource $socket A valid socket resource created with {@link
86062 *   socket_create} or {@link socket_accept}.
86063 * @param int $length The maximum number of bytes read is specified by
86064 *   the {@link length} parameter. Otherwise you can use \r, \n, or \0 to
86065 *   end reading (depending on the {@link type} parameter, see below).
86066 * @param int $type Optional {@link type} parameter is a named
86067 *   constant: PHP_BINARY_READ (Default) - use the system recv()
86068 *   function. Safe for reading binary data. PHP_NORMAL_READ - reading
86069 *   stops at \n or \r.
86070 * @return string {@link socket_read} returns the data as a string on
86071 *   success, or FALSE on error (including if the remote host has closed
86072 *   the connection). The error code can be retrieved with {@link
86073 *   socket_last_error}. This code may be passed to {@link
86074 *   socket_strerror} to get a textual representation of the error.
86075 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
86076 **/
86077function socket_read($socket, $length, $type){}
86078
86079/**
86080 * Receives data from a connected socket
86081 *
86082 * The {@link socket_recv} function receives {@link len} bytes of data in
86083 * {@link buf} from {@link socket}. {@link socket_recv} can be used to
86084 * gather data from connected sockets. Additionally, one or more flags
86085 * can be specified to modify the behaviour of the function.
86086 *
86087 * {@link buf} is passed by reference, so it must be specified as a
86088 * variable in the argument list. Data read from {@link socket} by {@link
86089 * socket_recv} will be returned in {@link buf}.
86090 *
86091 * @param resource $socket The {@link socket} must be a socket resource
86092 *   previously created by socket_create().
86093 * @param string $buf The data received will be fetched to the variable
86094 *   specified with {@link buf}. If an error occurs, if the connection is
86095 *   reset, or if no data is available, {@link buf} will be set to NULL.
86096 * @param int $len Up to {@link len} bytes will be fetched from remote
86097 *   host.
86098 * @param int $flags The value of {@link flags} can be any combination
86099 *   of the following flags, joined with the binary OR (|) operator.
86100 * @return int {@link socket_recv} returns the number of bytes
86101 *   received, or FALSE if there was an error. The actual error code can
86102 *   be retrieved by calling {@link socket_last_error}. This error code
86103 *   may be passed to {@link socket_strerror} to get a textual
86104 *   explanation of the error.
86105 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
86106 **/
86107function socket_recv($socket, &$buf, $len, $flags){}
86108
86109/**
86110 * Receives data from a socket whether or not it is connection-oriented
86111 *
86112 * The {@link socket_recvfrom} function receives {@link len} bytes of
86113 * data in {@link buf} from {@link name} on port {@link port} (if the
86114 * socket is not of type AF_UNIX) using {@link socket}. {@link
86115 * socket_recvfrom} can be used to gather data from both connected and
86116 * unconnected sockets. Additionally, one or more flags can be specified
86117 * to modify the behaviour of the function.
86118 *
86119 * The {@link name} and {@link port} must be passed by reference. If the
86120 * socket is not connection-oriented, {@link name} will be set to the
86121 * internet protocol address of the remote host or the path to the UNIX
86122 * socket. If the socket is connection-oriented, {@link name} is NULL.
86123 * Additionally, the {@link port} will contain the port of the remote
86124 * host in the case of an unconnected AF_INET or AF_INET6 socket.
86125 *
86126 * @param resource $socket The {@link socket} must be a socket resource
86127 *   previously created by socket_create().
86128 * @param string $buf The data received will be fetched to the variable
86129 *   specified with {@link buf}.
86130 * @param int $len Up to {@link len} bytes will be fetched from remote
86131 *   host.
86132 * @param int $flags The value of {@link flags} can be any combination
86133 *   of the following flags, joined with the binary OR (|) operator.
86134 * @param string $name If the socket is of the type AF_UNIX type,
86135 *   {@link name} is the path to the file. Else, for unconnected sockets,
86136 *   {@link name} is the IP address of, the remote host, or NULL if the
86137 *   socket is connection-oriented.
86138 * @param int $port This argument only applies to AF_INET and AF_INET6
86139 *   sockets, and specifies the remote port from which the data is
86140 *   received. If the socket is connection-oriented, {@link port} will be
86141 *   NULL.
86142 * @return int {@link socket_recvfrom} returns the number of bytes
86143 *   received, or FALSE if there was an error. The actual error code can
86144 *   be retrieved by calling {@link socket_last_error}. This error code
86145 *   may be passed to {@link socket_strerror} to get a textual
86146 *   explanation of the error.
86147 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
86148 **/
86149function socket_recvfrom($socket, &$buf, $len, $flags, &$name, &$port){}
86150
86151/**
86152 * Read a message
86153 *
86154 * @param resource $socket
86155 * @param array $message
86156 * @param int $flags
86157 * @return int
86158 * @since PHP 5 >= 5.5.0, PHP 7
86159 **/
86160function socket_recvmsg($socket, &$message, $flags){}
86161
86162/**
86163 * Runs the select() system call on the given arrays of sockets with a
86164 * specified timeout
86165 *
86166 * {@link socket_select} accepts arrays of sockets and waits for them to
86167 * change status. Those coming with BSD sockets background will recognize
86168 * that those socket resource arrays are in fact the so-called file
86169 * descriptor sets. Three independent arrays of socket resources are
86170 * watched.
86171 *
86172 * @param array $read The sockets listed in the {@link read} array will
86173 *   be watched to see if characters become available for reading (more
86174 *   precisely, to see if a read will not block - in particular, a socket
86175 *   resource is also ready on end-of-file, in which case a {@link
86176 *   socket_read} will return a zero length string).
86177 * @param array $write The sockets listed in the {@link write} array
86178 *   will be watched to see if a write will not block.
86179 * @param array $except The sockets listed in the {@link except} array
86180 *   will be watched for exceptions.
86181 * @param int $tv_sec The {@link tv_sec} and {@link tv_usec} together
86182 *   form the timeout parameter. The timeout is an upper bound on the
86183 *   amount of time elapsed before {@link socket_select} return. {@link
86184 *   tv_sec} may be zero , causing {@link socket_select} to return
86185 *   immediately. This is useful for polling. If {@link tv_sec} is NULL
86186 *   (no timeout), {@link socket_select} can block indefinitely.
86187 * @param int $tv_usec
86188 * @return int On success {@link socket_select} returns the number of
86189 *   socket resources contained in the modified arrays, which may be zero
86190 *   if the timeout expires before anything interesting happens. On error
86191 *   FALSE is returned. The error code can be retrieved with {@link
86192 *   socket_last_error}.
86193 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
86194 **/
86195function socket_select(&$read, &$write, &$except, $tv_sec, $tv_usec){}
86196
86197/**
86198 * Sends data to a connected socket
86199 *
86200 * The function {@link socket_send} sends {@link len} bytes to the socket
86201 * {@link socket} from {@link buf}.
86202 *
86203 * @param resource $socket A valid socket resource created with {@link
86204 *   socket_create} or {@link socket_accept}.
86205 * @param string $buf A buffer containing the data that will be sent to
86206 *   the remote host.
86207 * @param int $len The number of bytes that will be sent to the remote
86208 *   host from {@link buf}.
86209 * @param int $flags The value of {@link flags} can be any combination
86210 *   of the following flags, joined with the binary OR (|) operator.
86211 *   Possible values for {@link flags} MSG_OOB Send OOB (out-of-band)
86212 *   data. MSG_EOR Indicate a record mark. The sent data completes the
86213 *   record. MSG_EOF Close the sender side of the socket and include an
86214 *   appropriate notification of this at the end of the sent data. The
86215 *   sent data completes the transaction. MSG_DONTROUTE Bypass routing,
86216 *   use direct interface.
86217 * @return int {@link socket_send} returns the number of bytes sent, or
86218 *   FALSE on error.
86219 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
86220 **/
86221function socket_send($socket, $buf, $len, $flags){}
86222
86223/**
86224 * Send a message
86225 *
86226 * @param resource $socket
86227 * @param array $message
86228 * @param int $flags
86229 * @return int Returns the number of bytes sent, .
86230 * @since PHP 5 >= 5.5.0, PHP 7
86231 **/
86232function socket_sendmsg($socket, $message, $flags){}
86233
86234/**
86235 * Sends a message to a socket, whether it is connected or not
86236 *
86237 * The function {@link socket_sendto} sends {@link len} bytes from {@link
86238 * buf} through the socket {@link socket} to the {@link port} at the
86239 * address {@link addr}.
86240 *
86241 * @param resource $socket A valid socket resource created using {@link
86242 *   socket_create}.
86243 * @param string $buf The sent data will be taken from buffer {@link
86244 *   buf}.
86245 * @param int $len {@link len} bytes from {@link buf} will be sent.
86246 * @param int $flags The value of {@link flags} can be any combination
86247 *   of the following flags, joined with the binary OR (|) operator.
86248 *   Possible values for {@link flags} MSG_OOB Send OOB (out-of-band)
86249 *   data. MSG_EOR Indicate a record mark. The sent data completes the
86250 *   record. MSG_EOF Close the sender side of the socket and include an
86251 *   appropriate notification of this at the end of the sent data. The
86252 *   sent data completes the transaction. MSG_DONTROUTE Bypass routing,
86253 *   use direct interface.
86254 * @param string $addr IP address of the remote host.
86255 * @param int $port {@link port} is the remote port number at which the
86256 *   data will be sent.
86257 * @return int {@link socket_sendto} returns the number of bytes sent
86258 *   to the remote host, or FALSE if an error occurred.
86259 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
86260 **/
86261function socket_sendto($socket, $buf, $len, $flags, $addr, $port){}
86262
86263/**
86264 * Sets socket options for the socket
86265 *
86266 * The {@link socket_setopt} function sets the option specified by the
86267 * {@link optname} parameter, at the specified protocol {@link level}, to
86268 * the value pointed to by the {@link optval} parameter for the {@link
86269 * socket}.
86270 *
86271 * @param resource $socket A valid socket resource created with {@link
86272 *   socket_create} or {@link socket_accept}.
86273 * @param int $level The {@link level} parameter specifies the protocol
86274 *   level at which the option resides. For example, to retrieve options
86275 *   at the socket level, a {@link level} parameter of SOL_SOCKET would
86276 *   be used. Other levels, such as TCP, can be used by specifying the
86277 *   protocol number of that level. Protocol numbers can be found by
86278 *   using the {@link getprotobyname} function.
86279 * @param int $optname The available socket options are the same as
86280 *   those for the {@link socket_get_option} function.
86281 * @param mixed $optval The option value.
86282 * @return bool
86283 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
86284 **/
86285function socket_setopt($socket, $level, $optname, $optval){}
86286
86287/**
86288 * Sets blocking mode on a socket resource
86289 *
86290 * The {@link socket_set_block} function removes the O_NONBLOCK flag on
86291 * the socket specified by the {@link socket} parameter.
86292 *
86293 * When an operation (e.g. receive, send, connect, accept, ...) is
86294 * performed on a blocking socket, the script will pause its execution
86295 * until it receives a signal or it can perform the operation.
86296 *
86297 * @param resource $socket A valid socket resource created with {@link
86298 *   socket_create} or {@link socket_accept}.
86299 * @return bool
86300 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
86301 **/
86302function socket_set_block($socket){}
86303
86304/**
86305 * Sets nonblocking mode for file descriptor fd
86306 *
86307 * The {@link socket_set_nonblock} function sets the O_NONBLOCK flag on
86308 * the socket specified by the {@link socket} parameter.
86309 *
86310 * When an operation (e.g. receive, send, connect, accept, ...) is
86311 * performed on a non-blocking socket, the script will not pause its
86312 * execution until it receives a signal or it can perform the operation.
86313 * Rather, if the operation would result in a block, the called function
86314 * will fail.
86315 *
86316 * @param resource $socket A valid socket resource created with {@link
86317 *   socket_create} or {@link socket_accept}.
86318 * @return bool
86319 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
86320 **/
86321function socket_set_nonblock($socket){}
86322
86323/**
86324 * Sets socket options for the socket
86325 *
86326 * The {@link socket_set_option} function sets the option specified by
86327 * the {@link optname} parameter, at the specified protocol {@link
86328 * level}, to the value pointed to by the {@link optval} parameter for
86329 * the {@link socket}.
86330 *
86331 * @param resource $socket A valid socket resource created with {@link
86332 *   socket_create} or {@link socket_accept}.
86333 * @param int $level The {@link level} parameter specifies the protocol
86334 *   level at which the option resides. For example, to retrieve options
86335 *   at the socket level, a {@link level} parameter of SOL_SOCKET would
86336 *   be used. Other levels, such as TCP, can be used by specifying the
86337 *   protocol number of that level. Protocol numbers can be found by
86338 *   using the {@link getprotobyname} function.
86339 * @param int $optname The available socket options are the same as
86340 *   those for the {@link socket_get_option} function.
86341 * @param mixed $optval The option value.
86342 * @return bool
86343 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
86344 **/
86345function socket_set_option($socket, $level, $optname, $optval){}
86346
86347/**
86348 * Shuts down a socket for receiving, sending, or both
86349 *
86350 * The {@link socket_shutdown} function allows you to stop incoming,
86351 * outgoing or all data (the default) from being sent through the {@link
86352 * socket}
86353 *
86354 * @param resource $socket A valid socket resource created with {@link
86355 *   socket_create}.
86356 * @param int $how The value of {@link how} can be one of the
86357 *   following: possible values for {@link how} 0 Shutdown socket reading
86358 *   1 Shutdown socket writing 2 Shutdown socket reading and writing
86359 * @return bool
86360 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
86361 **/
86362function socket_shutdown($socket, $how){}
86363
86364/**
86365 * Return a string describing a socket error
86366 *
86367 * {@link socket_strerror} takes as its {@link errno} parameter a socket
86368 * error code as returned by {@link socket_last_error} and returns the
86369 * corresponding explanatory text.
86370 *
86371 * @param int $errno A valid socket error number, likely produced by
86372 *   {@link socket_last_error}.
86373 * @return string Returns the error message associated with the {@link
86374 *   errno} parameter.
86375 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
86376 **/
86377function socket_strerror($errno){}
86378
86379/**
86380 * Write to a socket
86381 *
86382 * The function {@link socket_write} writes to the {@link socket} from
86383 * the given {@link buffer}.
86384 *
86385 * @param resource $socket
86386 * @param string $buffer The buffer to be written.
86387 * @param int $length The optional parameter {@link length} can specify
86388 *   an alternate length of bytes written to the socket. If this length
86389 *   is greater than the buffer length, it is silently truncated to the
86390 *   length of the buffer.
86391 * @return int Returns the number of bytes successfully written to the
86392 *   socket. The error code can be retrieved with {@link
86393 *   socket_last_error}. This code may be passed to {@link
86394 *   socket_strerror} to get a textual explanation of the error.
86395 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
86396 **/
86397function socket_write($socket, $buffer, $length){}
86398
86399/**
86400 * Exports the WSAPROTOCOL_INFO Structure
86401 *
86402 * Exports the WSAPROTOCOL_INFO structure into shared memory and returns
86403 * an identifier to be used with {@link socket_wsaprotocol_info_import}.
86404 * The exported ID is only valid for the given {@link target_pid}.
86405 *
86406 * @param resource $socket A valid socket resource.
86407 * @param int $target_pid The ID of the process which will import the
86408 *   socket.
86409 * @return string Returns an identifier to be used for the import,
86410 * @since PHP 7 >= 7.3.0
86411 **/
86412function socket_wsaprotocol_info_export($socket, $target_pid){}
86413
86414/**
86415 * Imports a Socket from another Process
86416 *
86417 * Imports a socket which has formerly been exported from another
86418 * process.
86419 *
86420 * @param string $info_id The ID which has been returned by a former
86421 *   call to {@link socket_wsaprotocol_info_export}.
86422 * @return resource Returns the socket resource,
86423 * @since PHP 7 >= 7.3.0
86424 **/
86425function socket_wsaprotocol_info_import($info_id){}
86426
86427/**
86428 * Releases an exported WSAPROTOCOL_INFO Structure
86429 *
86430 * Releases the shared memory corresponding to the given {@link info_id}.
86431 *
86432 * @param string $info_id The ID which has been returned by a former
86433 *   call to {@link socket_wsaprotocol_info_export}.
86434 * @return bool
86435 * @since PHP 7 >= 7.3.0
86436 **/
86437function socket_wsaprotocol_info_release($info_id){}
86438
86439/**
86440 * Add large numbers
86441 *
86442 * @param string $val
86443 * @param string $addv
86444 * @return void
86445 * @since PHP 7 >= 7.2.0
86446 **/
86447function sodium_add(&$val, $addv){}
86448
86449/**
86450 * @param string $b64
86451 * @param int $id
86452 * @param string $ignore
86453 * @return string
86454 * @since PHP 7 >= 7.2.0
86455 **/
86456function sodium_base642bin($b64, $id, $ignore){}
86457
86458/**
86459 * @param string $bin
86460 * @param int $id
86461 * @return string
86462 * @since PHP 7 >= 7.2.0
86463 **/
86464function sodium_bin2base64($bin, $id){}
86465
86466/**
86467 * Encode to hexadecimal
86468 *
86469 * @param string $bin
86470 * @return string
86471 * @since PHP 7 >= 7.2.0
86472 **/
86473function sodium_bin2hex($bin){}
86474
86475/**
86476 * Compare large numbers
86477 *
86478 * @param string $buf1
86479 * @param string $buf2
86480 * @return int
86481 * @since PHP 7 >= 7.2.0
86482 **/
86483function sodium_compare($buf1, $buf2){}
86484
86485/**
86486 * Decrypt in combined mode with precalculation
86487 *
86488 * @param string $ciphertext
86489 * @param string $ad
86490 * @param string $nonce
86491 * @param string $key
86492 * @return string
86493 * @since PHP 7 >= 7.2.0
86494 **/
86495function sodium_crypto_aead_aes256gcm_decrypt($ciphertext, $ad, $nonce, $key){}
86496
86497/**
86498 * Encrypt in combined mode with precalculation
86499 *
86500 * @param string $msg
86501 * @param string $ad
86502 * @param string $nonce
86503 * @param string $key
86504 * @return string
86505 * @since PHP 7 >= 7.2.0
86506 **/
86507function sodium_crypto_aead_aes256gcm_encrypt($msg, $ad, $nonce, $key){}
86508
86509/**
86510 * Check if hardware supports AES256-GCM
86511 *
86512 * @return bool
86513 * @since PHP 7 >= 7.2.0
86514 **/
86515function sodium_crypto_aead_aes256gcm_is_available(){}
86516
86517/**
86518 * Get random bytes for key
86519 *
86520 * @return string
86521 * @since PHP 7 >= 7.2.0
86522 **/
86523function sodium_crypto_aead_aes256gcm_keygen(){}
86524
86525/**
86526 * Verify that the ciphertext includes a valid tag
86527 *
86528 * @param string $ciphertext
86529 * @param string $ad
86530 * @param string $nonce
86531 * @param string $key
86532 * @return string
86533 * @since PHP 7 >= 7.2.0
86534 **/
86535function sodium_crypto_aead_chacha20poly1305_decrypt($ciphertext, $ad, $nonce, $key){}
86536
86537/**
86538 * Encrypt a message
86539 *
86540 * @param string $msg
86541 * @param string $ad
86542 * @param string $nonce
86543 * @param string $key
86544 * @return string
86545 * @since PHP 7 >= 7.2.0
86546 **/
86547function sodium_crypto_aead_chacha20poly1305_encrypt($msg, $ad, $nonce, $key){}
86548
86549/**
86550 * Verify that the ciphertext includes a valid tag
86551 *
86552 * @param string $ciphertext
86553 * @param string $ad
86554 * @param string $nonce
86555 * @param string $key
86556 * @return string
86557 * @since PHP 7 >= 7.2.0
86558 **/
86559function sodium_crypto_aead_chacha20poly1305_ietf_decrypt($ciphertext, $ad, $nonce, $key){}
86560
86561/**
86562 * Encrypt a message
86563 *
86564 * @param string $msg
86565 * @param string $ad
86566 * @param string $nonce
86567 * @param string $key
86568 * @return string
86569 * @since PHP 7 >= 7.2.0
86570 **/
86571function sodium_crypto_aead_chacha20poly1305_ietf_encrypt($msg, $ad, $nonce, $key){}
86572
86573/**
86574 * Get random bytes for key
86575 *
86576 * @return string
86577 * @since PHP 7 >= 7.2.0
86578 **/
86579function sodium_crypto_aead_chacha20poly1305_ietf_keygen(){}
86580
86581/**
86582 * Get random bytes for key
86583 *
86584 * @return string
86585 * @since PHP 7 >= 7.2.0
86586 **/
86587function sodium_crypto_aead_chacha20poly1305_keygen(){}
86588
86589/**
86590 * @param string $ciphertext
86591 * @param string $ad
86592 * @param string $nonce
86593 * @param string $key
86594 * @return string
86595 * @since PHP 7 >= 7.2.0
86596 **/
86597function sodium_crypto_aead_xchacha20poly1305_ietf_decrypt($ciphertext, $ad, $nonce, $key){}
86598
86599/**
86600 * @param string $msg
86601 * @param string $ad
86602 * @param string $nonce
86603 * @param string $key
86604 * @return string
86605 * @since PHP 7 >= 7.2.0
86606 **/
86607function sodium_crypto_aead_xchacha20poly1305_ietf_encrypt($msg, $ad, $nonce, $key){}
86608
86609/**
86610 * @return string
86611 * @since PHP 7 >= 7.2.0
86612 **/
86613function sodium_crypto_aead_xchacha20poly1305_ietf_keygen(){}
86614
86615/**
86616 * Compute a tag for the message
86617 *
86618 * @param string $msg
86619 * @param string $key
86620 * @return string
86621 * @since PHP 7 >= 7.2.0
86622 **/
86623function sodium_crypto_auth($msg, $key){}
86624
86625/**
86626 * Get random bytes for key
86627 *
86628 * @return string
86629 * @since PHP 7 >= 7.2.0
86630 **/
86631function sodium_crypto_auth_keygen(){}
86632
86633/**
86634 * Verifies that the tag is valid for the message
86635 *
86636 * @param string $signature
86637 * @param string $msg
86638 * @param string $key
86639 * @return bool
86640 * @since PHP 7 >= 7.2.0
86641 **/
86642function sodium_crypto_auth_verify($signature, $msg, $key){}
86643
86644/**
86645 * Encrypt a message
86646 *
86647 * @param string $msg
86648 * @param string $nonce
86649 * @param string $key
86650 * @return string
86651 * @since PHP 7 >= 7.2.0
86652 **/
86653function sodium_crypto_box($msg, $nonce, $key){}
86654
86655/**
86656 * Randomly generate a secret key and a corresponding public key
86657 *
86658 * @return string
86659 * @since PHP 7 >= 7.2.0
86660 **/
86661function sodium_crypto_box_keypair(){}
86662
86663/**
86664 * @param string $secret_key
86665 * @param string $public_key
86666 * @return string
86667 * @since PHP 7 >= 7.2.0
86668 **/
86669function sodium_crypto_box_keypair_from_secretkey_and_publickey($secret_key, $public_key){}
86670
86671/**
86672 * Verify and decrypt a ciphertext
86673 *
86674 * @param string $ciphertext
86675 * @param string $nonce
86676 * @param string $key
86677 * @return string
86678 * @since PHP 7 >= 7.2.0
86679 **/
86680function sodium_crypto_box_open($ciphertext, $nonce, $key){}
86681
86682/**
86683 * @param string $key
86684 * @return string
86685 * @since PHP 7 >= 7.2.0
86686 **/
86687function sodium_crypto_box_publickey($key){}
86688
86689/**
86690 * @param string $key
86691 * @return string
86692 * @since PHP 7 >= 7.2.0
86693 **/
86694function sodium_crypto_box_publickey_from_secretkey($key){}
86695
86696/**
86697 * Encrypt a message
86698 *
86699 * @param string $msg
86700 * @param string $key
86701 * @return string
86702 * @since PHP 7 >= 7.2.0
86703 **/
86704function sodium_crypto_box_seal($msg, $key){}
86705
86706/**
86707 * Decrypt the ciphertext
86708 *
86709 * @param string $ciphertext
86710 * @param string $key
86711 * @return string
86712 * @since PHP 7 >= 7.2.0
86713 **/
86714function sodium_crypto_box_seal_open($ciphertext, $key){}
86715
86716/**
86717 * @param string $key
86718 * @return string
86719 * @since PHP 7 >= 7.2.0
86720 **/
86721function sodium_crypto_box_secretkey($key){}
86722
86723/**
86724 * Deterministically derive the key pair from a single key
86725 *
86726 * @param string $key
86727 * @return string
86728 * @since PHP 7 >= 7.2.0
86729 **/
86730function sodium_crypto_box_seed_keypair($key){}
86731
86732/**
86733 * Get a hash of the message
86734 *
86735 * @param string $msg
86736 * @param string $key
86737 * @param int $length
86738 * @return string
86739 * @since PHP 7 >= 7.2.0
86740 **/
86741function sodium_crypto_generichash($msg, $key, $length){}
86742
86743/**
86744 * Complete the hash
86745 *
86746 * @param string $state
86747 * @param int $length
86748 * @return string
86749 * @since PHP 7 >= 7.2.0
86750 **/
86751function sodium_crypto_generichash_final(&$state, $length){}
86752
86753/**
86754 * Initialize a hash
86755 *
86756 * @param string $key
86757 * @param int $length
86758 * @return string
86759 * @since PHP 7 >= 7.2.0
86760 **/
86761function sodium_crypto_generichash_init($key, $length){}
86762
86763/**
86764 * Get random bytes for key
86765 *
86766 * @return string
86767 * @since PHP 7 >= 7.2.0
86768 **/
86769function sodium_crypto_generichash_keygen(){}
86770
86771/**
86772 * Add message to a hash
86773 *
86774 * @param string $state
86775 * @param string $msg
86776 * @return bool
86777 * @since PHP 7 >= 7.2.0
86778 **/
86779function sodium_crypto_generichash_update(&$state, $msg){}
86780
86781/**
86782 * Derive a subkey
86783 *
86784 * @param int $subkey_len
86785 * @param int $subkey_id
86786 * @param string $context
86787 * @param string $key
86788 * @return string
86789 * @since PHP 7 >= 7.2.0
86790 **/
86791function sodium_crypto_kdf_derive_from_key($subkey_len, $subkey_id, $context, $key){}
86792
86793/**
86794 * Get random bytes for key
86795 *
86796 * @return string
86797 * @since PHP 7 >= 7.2.0
86798 **/
86799function sodium_crypto_kdf_keygen(){}
86800
86801/**
86802 * @param string $client_keypair
86803 * @param string $server_key
86804 * @return array
86805 * @since PHP 7 >= 7.2.0
86806 **/
86807function sodium_crypto_kx_client_session_keys($client_keypair, $server_key){}
86808
86809/**
86810 * Creates a new sodium keypair
86811 *
86812 * Create a new sodium keypair consisting of the secret key (32 bytes)
86813 * followed by the public key (32 bytes). The keys can be retrieved by
86814 * calling {@link sodium_crypto_kx_secretkey} and {@link
86815 * sodium_crypto_kx_publickey}, respectively.
86816 *
86817 * @return string Returns the new keypair on success; throws an
86818 *   exception otherwise.
86819 * @since PHP 7 >= 7.2.0
86820 **/
86821function sodium_crypto_kx_keypair(){}
86822
86823/**
86824 * @param string $key
86825 * @return string
86826 * @since PHP 7 >= 7.2.0
86827 **/
86828function sodium_crypto_kx_publickey($key){}
86829
86830/**
86831 * @param string $key
86832 * @return string
86833 * @since PHP 7 >= 7.2.0
86834 **/
86835function sodium_crypto_kx_secretkey($key){}
86836
86837/**
86838 * @param string $string
86839 * @return string
86840 * @since PHP 7 >= 7.2.0
86841 **/
86842function sodium_crypto_kx_seed_keypair($string){}
86843
86844/**
86845 * @param string $server_keypair
86846 * @param string $client_key
86847 * @return array
86848 * @since PHP 7 >= 7.2.0
86849 **/
86850function sodium_crypto_kx_server_session_keys($server_keypair, $client_key){}
86851
86852/**
86853 * Derive a key from a password
86854 *
86855 * This function provides low-level access to libsodium's crypto_pwhash
86856 * key derivation function. Unless you have specific reason to use this
86857 * function, you should use {@link sodium_crypto_pwhash_str} or {@link
86858 * password_hash} functions instead.
86859 *
86860 * @param int $length integer; The length of the password hash to
86861 *   generate, in bytes.
86862 * @param string $password string; The password to generate a hash for.
86863 * @param string $salt string A salt to add to the password before
86864 *   hashing. The salt should be unpredictable, ideally generated from a
86865 *   good random mumber source such as {@link random_bytes}, and have a
86866 *   length of at least SODIUM_CRYPTO_PWHASH_SALTBYTES bytes.
86867 * @param int $opslimit Represents a maximum amount of computations to
86868 *   perform. Raising this number will make the function require more CPU
86869 *   cycles to compute a key. There are some constants available to set
86870 *   the operations limit to appropriate values depending on intended
86871 *   use, in order of strength:
86872 *   SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE,
86873 *   SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE and
86874 *   SODIUM_CRYPTO_PWHASH_OPSLIMIT_SENSITIVE.
86875 * @param int $memlimit The maximum amount of RAM that the function
86876 *   will use, in bytes. There are constants to help you choose an
86877 *   appropriate value, in order of size:
86878 *   SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE,
86879 *   SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE, and
86880 *   SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE. Typically these should be
86881 *   paired with the matching {@link opslimit} values.
86882 * @param int $alg integer A number indicating the hash algorithm to
86883 *   use. By default SODIUM_CRYPTO_PWHASH_ALG_DEFAULT (the currently
86884 *   recommended algorithm, which can change from one version of
86885 *   libsodium to another), or explicitly using
86886 *   SODIUM_CRYPTO_PWHASH_ALG_ARGON2ID13, representing the Argon2id
86887 *   algorithm version 1.3.
86888 * @return string Returns the derived key, . The return value is a
86889 *   binary string of the hash, not an ASCII-encoded representation, and
86890 *   does not contain additional information about the parameters used to
86891 *   create the hash, so you will need to keep that information if you
86892 *   are ever going to verify the password in future. Use {@link
86893 *   sodium_crypto_pwhash_str} to avoid needing to do all that.
86894 * @since PHP 7 >= 7.2.0
86895 **/
86896function sodium_crypto_pwhash($length, $password, $salt, $opslimit, $memlimit, $alg){}
86897
86898/**
86899 * Derives a key from a password
86900 *
86901 * @param int $length
86902 * @param string $password
86903 * @param string $salt
86904 * @param int $opslimit
86905 * @param int $memlimit
86906 * @return string
86907 * @since PHP 7 >= 7.2.0
86908 **/
86909function sodium_crypto_pwhash_scryptsalsa208sha256($length, $password, $salt, $opslimit, $memlimit){}
86910
86911/**
86912 * Get an ASCII encoded hash
86913 *
86914 * @param string $password
86915 * @param int $opslimit
86916 * @param int $memlimit
86917 * @return string
86918 * @since PHP 7 >= 7.2.0
86919 **/
86920function sodium_crypto_pwhash_scryptsalsa208sha256_str($password, $opslimit, $memlimit){}
86921
86922/**
86923 * Verify that the password is a valid password verification string
86924 *
86925 * @param string $hash
86926 * @param string $password
86927 * @return bool
86928 * @since PHP 7 >= 7.2.0
86929 **/
86930function sodium_crypto_pwhash_scryptsalsa208sha256_str_verify($hash, $password){}
86931
86932/**
86933 * Get an ASCII-encoded hash
86934 *
86935 * Uses a CPU- and memory-hard hash algorithm along with a
86936 * randomly-generated salt, and memory and CPU limits to generate an
86937 * ASCII-encoded hash suitable for password storage.
86938 *
86939 * @param string $password string; The password to generate a hash for.
86940 * @param int $opslimit Represents a maximum amount of computations to
86941 *   perform. Raising this number will make the function require more CPU
86942 *   cycles to compute a key. There are constants available to set the
86943 *   operations limit to appropriate values depending on intended use, in
86944 *   order of strength: SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE,
86945 *   SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE and
86946 *   SODIUM_CRYPTO_PWHASH_OPSLIMIT_SENSITIVE.
86947 * @param int $memlimit The maximum amount of RAM that the function
86948 *   will use, in bytes. There are constants to help you choose an
86949 *   appropriate value, in order of size:
86950 *   SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE,
86951 *   SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE, and
86952 *   SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE. Typically these should be
86953 *   paired with the matching opslimit values.
86954 * @return string Returns the hashed password, .
86955 * @since PHP 7 >= 7.2.0
86956 **/
86957function sodium_crypto_pwhash_str($password, $opslimit, $memlimit){}
86958
86959/**
86960 * @param string $password
86961 * @param int $opslimit
86962 * @param int $memlimit
86963 * @return bool
86964 * @since PHP 7 >= 7.2.0
86965 **/
86966function sodium_crypto_pwhash_str_needs_rehash($password, $opslimit, $memlimit){}
86967
86968/**
86969 * Verifies that a password matches a hash
86970 *
86971 * Checks that a password hash created using {@link
86972 * sodium_crypto_pwhash_str} matches a given plain-text password. Note
86973 * that the parameters are in the opposite order to the same parameters
86974 * in the similar {@link password_hash} function.
86975 *
86976 * @param string $hash
86977 * @param string $password
86978 * @return bool Returns TRUE if the password and hash match, or FALSE
86979 *   otherwise.
86980 * @since PHP 7 >= 7.2.0
86981 **/
86982function sodium_crypto_pwhash_str_verify($hash, $password){}
86983
86984/**
86985 * Compute a shared secret given a user's secret key and another user's
86986 * public key
86987 *
86988 * @param string $n
86989 * @param string $p
86990 * @return string
86991 * @since PHP 7 >= 7.2.0
86992 **/
86993function sodium_crypto_scalarmult($n, $p){}
86994
86995/**
86996 * @param string $key
86997 * @return string
86998 * @since PHP 7 >= 7.2.0
86999 **/
87000function sodium_crypto_scalarmult_base($key){}
87001
87002/**
87003 * Encrypt a message
87004 *
87005 * @param string $string
87006 * @param string $nonce
87007 * @param string $key
87008 * @return string
87009 * @since PHP 7 >= 7.2.0
87010 **/
87011function sodium_crypto_secretbox($string, $nonce, $key){}
87012
87013/**
87014 * Get random bytes for key
87015 *
87016 * @return string
87017 * @since PHP 7 >= 7.2.0
87018 **/
87019function sodium_crypto_secretbox_keygen(){}
87020
87021/**
87022 * Verify and decrypt a ciphertext
87023 *
87024 * @param string $ciphertext
87025 * @param string $nonce
87026 * @param string $key
87027 * @return string
87028 * @since PHP 7 >= 7.2.0
87029 **/
87030function sodium_crypto_secretbox_open($ciphertext, $nonce, $key){}
87031
87032/**
87033 * @param string $header
87034 * @param string $key
87035 * @return string
87036 * @since PHP 7 >= 7.2.0
87037 **/
87038function sodium_crypto_secretstream_xchacha20poly1305_init_pull($header, $key){}
87039
87040/**
87041 * @param string $key
87042 * @return array
87043 * @since PHP 7 >= 7.2.0
87044 **/
87045function sodium_crypto_secretstream_xchacha20poly1305_init_push($key){}
87046
87047/**
87048 * @return string
87049 * @since PHP 7 >= 7.2.0
87050 **/
87051function sodium_crypto_secretstream_xchacha20poly1305_keygen(){}
87052
87053/**
87054 * @param string $state
87055 * @param string $c
87056 * @param string $ad
87057 * @return array
87058 * @since PHP 7 >= 7.2.0
87059 **/
87060function sodium_crypto_secretstream_xchacha20poly1305_pull(&$state, $c, $ad){}
87061
87062/**
87063 * @param string $state
87064 * @param string $msg
87065 * @param string $ad
87066 * @param int $tag
87067 * @return string
87068 * @since PHP 7 >= 7.2.0
87069 **/
87070function sodium_crypto_secretstream_xchacha20poly1305_push(&$state, $msg, $ad, $tag){}
87071
87072/**
87073 * @param string $state
87074 * @return void
87075 * @since PHP 7 >= 7.2.0
87076 **/
87077function sodium_crypto_secretstream_xchacha20poly1305_rekey(&$state){}
87078
87079/**
87080 * Compute a fixed-size fingerprint for the message
87081 *
87082 * @param string $msg
87083 * @param string $key
87084 * @return string
87085 * @since PHP 7 >= 7.2.0
87086 **/
87087function sodium_crypto_shorthash($msg, $key){}
87088
87089/**
87090 * Get random bytes for key
87091 *
87092 * @return string
87093 * @since PHP 7 >= 7.2.0
87094 **/
87095function sodium_crypto_shorthash_keygen(){}
87096
87097/**
87098 * Sign a message
87099 *
87100 * @param string $msg
87101 * @param string $secret_key
87102 * @return string
87103 * @since PHP 7 >= 7.2.0
87104 **/
87105function sodium_crypto_sign($msg, $secret_key){}
87106
87107/**
87108 * Sign the message
87109 *
87110 * @param string $msg
87111 * @param string $secretkey
87112 * @return string
87113 * @since PHP 7 >= 7.2.0
87114 **/
87115function sodium_crypto_sign_detached($msg, $secretkey){}
87116
87117/**
87118 * Convert an Ed25519 public key to a Curve25519 public key
87119 *
87120 * @param string $key
87121 * @return string
87122 * @since PHP 7 >= 7.2.0
87123 **/
87124function sodium_crypto_sign_ed25519_pk_to_curve25519($key){}
87125
87126/**
87127 * Convert an Ed25519 secret key to a Curve25519 secret key
87128 *
87129 * @param string $key
87130 * @return string
87131 * @since PHP 7 >= 7.2.0
87132 **/
87133function sodium_crypto_sign_ed25519_sk_to_curve25519($key){}
87134
87135/**
87136 * Randomly generate a secret key and a corresponding public key
87137 *
87138 * @return string
87139 * @since PHP 7 >= 7.2.0
87140 **/
87141function sodium_crypto_sign_keypair(){}
87142
87143/**
87144 * @param string $secret_key
87145 * @param string $public_key
87146 * @return string
87147 * @since PHP 7 >= 7.2.0
87148 **/
87149function sodium_crypto_sign_keypair_from_secretkey_and_publickey($secret_key, $public_key){}
87150
87151/**
87152 * Check that the signed message has a valid signature
87153 *
87154 * @param string $string
87155 * @param string $public_key
87156 * @return string
87157 * @since PHP 7 >= 7.2.0
87158 **/
87159function sodium_crypto_sign_open($string, $public_key){}
87160
87161/**
87162 * @param string $keypair
87163 * @return string
87164 * @since PHP 7 >= 7.2.0
87165 **/
87166function sodium_crypto_sign_publickey($keypair){}
87167
87168/**
87169 * Extract the public key from the secret key
87170 *
87171 * @param string $key
87172 * @return string
87173 * @since PHP 7 >= 7.2.0
87174 **/
87175function sodium_crypto_sign_publickey_from_secretkey($key){}
87176
87177/**
87178 * @param string $key
87179 * @return string
87180 * @since PHP 7 >= 7.2.0
87181 **/
87182function sodium_crypto_sign_secretkey($key){}
87183
87184/**
87185 * Deterministically derive the key pair from a single key
87186 *
87187 * @param string $key
87188 * @return string
87189 * @since PHP 7 >= 7.2.0
87190 **/
87191function sodium_crypto_sign_seed_keypair($key){}
87192
87193/**
87194 * Verify signature for the message
87195 *
87196 * @param string $signature
87197 * @param string $msg
87198 * @param string $public_key
87199 * @return bool
87200 * @since PHP 7 >= 7.2.0
87201 **/
87202function sodium_crypto_sign_verify_detached($signature, $msg, $public_key){}
87203
87204/**
87205 * Generate a deterministic sequence of bytes from a seed
87206 *
87207 * @param int $length
87208 * @param string $nonce
87209 * @param string $key
87210 * @return string
87211 * @since PHP 7 >= 7.2.0
87212 **/
87213function sodium_crypto_stream($length, $nonce, $key){}
87214
87215/**
87216 * Get random bytes for key
87217 *
87218 * @return string
87219 * @since PHP 7 >= 7.2.0
87220 **/
87221function sodium_crypto_stream_keygen(){}
87222
87223/**
87224 * Encrypt a message
87225 *
87226 * @param string $msg
87227 * @param string $nonce
87228 * @param string $key
87229 * @return string
87230 * @since PHP 7 >= 7.2.0
87231 **/
87232function sodium_crypto_stream_xor($msg, $nonce, $key){}
87233
87234/**
87235 * Decodes a hexadecimally encoded binary string
87236 *
87237 * Like {@link sodium_bin2hex}, {@link sodium_hex2bin} is resistant to
87238 * side-channel attacks while {@link hex2bin} is not.
87239 *
87240 * @param string $hex Hexadecimal representation of data.
87241 * @param string $ignore Optional string argument for characters to
87242 *   ignore.
87243 * @return string Returns the binary representation of the given {@link
87244 *   hex} data.
87245 * @since PHP 7 >= 7.2.0
87246 **/
87247function sodium_hex2bin($hex, $ignore){}
87248
87249/**
87250 * Increment large number
87251 *
87252 * @param string $val
87253 * @return void
87254 * @since PHP 7 >= 7.2.0
87255 **/
87256function sodium_increment(&$val){}
87257
87258/**
87259 * Test for equality in constant-time
87260 *
87261 * @param string $buf1
87262 * @param string $buf2
87263 * @return int
87264 * @since PHP 7 >= 7.2.0
87265 **/
87266function sodium_memcmp($buf1, $buf2){}
87267
87268/**
87269 * Overwrite buf with zeros
87270 *
87271 * @param string $buf
87272 * @return void
87273 * @since PHP 7 >= 7.2.0
87274 **/
87275function sodium_memzero(&$buf){}
87276
87277/**
87278 * Add padding data
87279 *
87280 * @param string $unpadded
87281 * @param int $length
87282 * @return string
87283 * @since PHP 7 >= 7.2.0
87284 **/
87285function sodium_pad($unpadded, $length){}
87286
87287/**
87288 * Remove padding data
87289 *
87290 * @param string $padded
87291 * @param int $length
87292 * @return string
87293 * @since PHP 7 >= 7.2.0
87294 **/
87295function sodium_unpad($padded, $length){}
87296
87297/**
87298 * Returns the current version of the Apache Solr extension
87299 *
87300 * This function returns the current version of the extension as a
87301 * string.
87302 *
87303 * @return string It returns a string on success and FALSE on failure.
87304 * @since PECL solr >= 0.9.1
87305 **/
87306function solr_get_version(){}
87307
87308/**
87309 * Sort an array
87310 *
87311 * This function sorts an array. Elements will be arranged from lowest to
87312 * highest when this function has completed.
87313 *
87314 * @param array $array The input array.
87315 * @param int $sort_flags The optional second parameter {@link
87316 *   sort_flags} may be used to modify the sorting behavior using these
87317 *   values: Sorting type flags: SORT_REGULAR - compare items normally;
87318 *   the details are described in the comparison operators section
87319 *   SORT_NUMERIC - compare items numerically SORT_STRING - compare items
87320 *   as strings SORT_LOCALE_STRING - compare items as strings, based on
87321 *   the current locale. It uses the locale, which can be changed using
87322 *   {@link setlocale} SORT_NATURAL - compare items as strings using
87323 *   "natural ordering" like {@link natsort} SORT_FLAG_CASE - can be
87324 *   combined (bitwise OR) with SORT_STRING or SORT_NATURAL to sort
87325 *   strings case-insensitively
87326 * @return bool
87327 * @since PHP 4, PHP 5, PHP 7
87328 **/
87329function sort(&$array, $sort_flags){}
87330
87331/**
87332 * Calculate the soundex key of a string
87333 *
87334 * Calculates the soundex key of {@link str}.
87335 *
87336 * Soundex keys have the property that words pronounced similarly produce
87337 * the same soundex key, and can thus be used to simplify searches in
87338 * databases where you know the pronunciation but not the spelling. This
87339 * soundex function returns a string 4 characters long, starting with a
87340 * letter.
87341 *
87342 * This particular soundex function is one described by Donald Knuth in
87343 * "The Art Of Computer Programming, vol. 3: Sorting And Searching",
87344 * Addison-Wesley (1973), pp. 391-392.
87345 *
87346 * @param string $str The input string.
87347 * @return string Returns the soundex key as a , .
87348 * @since PHP 4, PHP 5, PHP 7
87349 **/
87350function soundex($str){}
87351
87352/**
87353 * Split string into array by regular expression
87354 *
87355 * Splits a {@link string} into array by regular expression.
87356 *
87357 * @param string $pattern Case sensitive regular expression. If you
87358 *   want to split on any of the characters which are considered special
87359 *   by regular expressions, you'll need to escape them first. If you
87360 *   think {@link split} (or any other regex function, for that matter)
87361 *   is doing something weird, please read the file regex.7, included in
87362 *   the regex/ subdirectory of the PHP distribution. It's in manpage
87363 *   format, so you'll want to do something along the lines of man
87364 *   /usr/local/src/regex/regex.7 in order to read it.
87365 * @param string $string The input string.
87366 * @param int $limit If {@link limit} is set, the returned array will
87367 *   contain a maximum of {@link limit} elements with the last element
87368 *   containing the whole rest of {@link string}.
87369 * @return array Returns an array of strings, each of which is a
87370 *   substring of {@link string} formed by splitting it on boundaries
87371 *   formed by the case-sensitive regular expression {@link pattern}.
87372 * @since PHP 4, PHP 5
87373 **/
87374function split($pattern, $string, $limit){}
87375
87376/**
87377 * Split string into array by regular expression case insensitive
87378 *
87379 * Splits a {@link string} into array by regular expression.
87380 *
87381 * This function is identical to {@link split} except that this ignores
87382 * case distinction when matching alphabetic characters.
87383 *
87384 * @param string $pattern Case insensitive regular expression. If you
87385 *   want to split on any of the characters which are considered special
87386 *   by regular expressions, you'll need to escape them first. If you
87387 *   think {@link spliti} (or any other regex function, for that matter)
87388 *   is doing something weird, please read the file regex.7, included in
87389 *   the regex/ subdirectory of the PHP distribution. It's in manpage
87390 *   format, so you'll want to do something along the lines of man
87391 *   /usr/local/src/regex/regex.7 in order to read it.
87392 * @param string $string The input string.
87393 * @param int $limit If {@link limit} is set, the returned array will
87394 *   contain a maximum of {@link limit} elements with the last element
87395 *   containing the whole rest of {@link string}.
87396 * @return array Returns an array of strings, each of which is a
87397 *   substring of {@link string} formed by splitting it on boundaries
87398 *   formed by the case insensitive regular expression {@link pattern}.
87399 * @since PHP 4 >= 4.0.1, PHP 5
87400 **/
87401function spliti($pattern, $string, $limit){}
87402
87403/**
87404 * Default implementation for __autoload()
87405 *
87406 * This function is intended to be used as a default implementation for
87407 * {@link __autoload}. If nothing else is specified and {@link
87408 * spl_autoload_register} is called without any parameters then this
87409 * function will be used for any later call to {@link __autoload}.
87410 *
87411 * @param string $class_name The lowercased name of the class (and
87412 *   namespace) being instantiated.
87413 * @param string $file_extensions By default it checks all include
87414 *   paths to contain filenames built up by the lowercase class name
87415 *   appended by the filename extensions .inc and .php.
87416 * @return void
87417 * @since PHP 5 >= 5.1.0, PHP 7
87418 **/
87419function spl_autoload($class_name, $file_extensions){}
87420
87421/**
87422 * Try all registered __autoload() functions to load the requested class
87423 *
87424 * This function can be used to manually search for a class or interface
87425 * using the registered __autoload functions.
87426 *
87427 * @param string $class_name The class name being searched.
87428 * @return void
87429 * @since PHP 5 >= 5.1.0, PHP 7
87430 **/
87431function spl_autoload_call($class_name){}
87432
87433/**
87434 * Register and return default file extensions for spl_autoload
87435 *
87436 * This function can modify and check the file extensions that the built
87437 * in {@link __autoload} fallback function {@link spl_autoload} will be
87438 * using.
87439 *
87440 * @param string $file_extensions When calling without an argument, it
87441 *   simply returns the current list of extensions each separated by
87442 *   comma. To modify the list of file extensions, simply invoke the
87443 *   functions with the new list of file extensions to use in a single
87444 *   string with each extensions separated by comma.
87445 * @return string A comma delimited list of default file extensions for
87446 *   {@link spl_autoload}.
87447 * @since PHP 5 >= 5.1.0, PHP 7
87448 **/
87449function spl_autoload_extensions($file_extensions){}
87450
87451/**
87452 * Return all registered __autoload() functions
87453 *
87454 * Get all registered __autoload() functions.
87455 *
87456 * @return array An array of all registered __autoload functions. If
87457 *   the autoload queue is not activated then the return value is FALSE.
87458 *   If no function is registered the return value will be an empty
87459 *   array.
87460 * @since PHP 5 >= 5.1.0, PHP 7
87461 **/
87462function spl_autoload_functions(){}
87463
87464/**
87465 * Register given function as __autoload() implementation
87466 *
87467 * Register a function with the spl provided __autoload queue. If the
87468 * queue is not yet activated it will be activated.
87469 *
87470 * If your code has an existing {@link __autoload} function then this
87471 * function must be explicitly registered on the __autoload queue. This
87472 * is because {@link spl_autoload_register} will effectively replace the
87473 * engine cache for the {@link __autoload} function by either {@link
87474 * spl_autoload} or {@link spl_autoload_call}.
87475 *
87476 * If there must be multiple autoload functions, {@link
87477 * spl_autoload_register} allows for this. It effectively creates a queue
87478 * of autoload functions, and runs through each of them in the order they
87479 * are defined. By contrast, {@link __autoload} may only be defined once.
87480 *
87481 * @param callable $autoload_function The autoload function being
87482 *   registered. If no parameter is provided, then the default
87483 *   implementation of {@link spl_autoload} will be registered.
87484 * @param bool $throw This parameter specifies whether {@link
87485 *   spl_autoload_register} should throw exceptions when the {@link
87486 *   autoload_function} cannot be registered.
87487 * @param bool $prepend If true, {@link spl_autoload_register} will
87488 *   prepend the autoloader on the autoload queue instead of appending
87489 *   it.
87490 * @return bool
87491 * @since PHP 5 >= 5.1.0, PHP 7
87492 **/
87493function spl_autoload_register($autoload_function, $throw, $prepend){}
87494
87495/**
87496 * Unregister given function as __autoload() implementation
87497 *
87498 * Removes a function from the autoload queue. If the queue is activated
87499 * and empty after removing the given function then it will be
87500 * deactivated.
87501 *
87502 * When this function results in the queue being deactivated, any
87503 * __autoload function that previously existed will not be reactivated.
87504 *
87505 * @param mixed $autoload_function The autoload function being
87506 *   unregistered.
87507 * @return bool
87508 * @since PHP 5 >= 5.1.0, PHP 7
87509 **/
87510function spl_autoload_unregister($autoload_function){}
87511
87512/**
87513 * Return available SPL classes
87514 *
87515 * This function returns an array with the current available SPL classes.
87516 *
87517 * @return array Returns an array containing the currently available
87518 *   SPL classes.
87519 * @since PHP 5, PHP 7
87520 **/
87521function spl_classes(){}
87522
87523/**
87524 * Return hash id for given object
87525 *
87526 * This function returns a unique identifier for the object. This id can
87527 * be used as a hash key for storing objects, or for identifying an
87528 * object, as long as the object is not destroyed. Once the object is
87529 * destroyed, its hash may be reused for other objects.
87530 *
87531 * @param object $obj Any object.
87532 * @return string A string that is unique for each currently existing
87533 *   object and is always the same for each object.
87534 * @since PHP 5 >= 5.2.0, PHP 7
87535 **/
87536function spl_object_hash($obj){}
87537
87538/**
87539 * Return the integer object handle for given object
87540 *
87541 * This function returns a unique identifier for the object. The object
87542 * id is unique for the lifetime of the object. Once the object is
87543 * destroyed, its id may be reused for other objects. This behavior is
87544 * similar to {@link spl_object_hash}.
87545 *
87546 * @param object $obj Any object.
87547 * @return int An integer identifier that is unique for each currently
87548 *   existing object and is always the same for each object.
87549 * @since PHP 7 >= 7.2.0
87550 **/
87551function spl_object_id($obj){}
87552
87553/**
87554 * Return a formatted string
87555 *
87556 * Returns a string produced according to the formatting string {@link
87557 * format}.
87558 *
87559 * @param string $format
87560 * @param mixed ...$vararg
87561 * @return string Returns a string produced according to the formatting
87562 *   string {@link format}, .
87563 * @since PHP 4, PHP 5, PHP 7
87564 **/
87565function sprintf($format, ...$vararg){}
87566
87567/**
87568 * Execute a query against a given database and returns an array
87569 *
87570 * {@link sqlite_array_query} executes the given query and returns an
87571 * array of the entire result set. It is similar to calling {@link
87572 * sqlite_query} and then {@link sqlite_fetch_array} for each row in the
87573 * result set. {@link sqlite_array_query} is significantly faster than
87574 * the aforementioned.
87575 *
87576 * @param resource $dbhandle The query to be executed. Data inside the
87577 *   query should be properly escaped.
87578 * @param string $query The SQLite Database resource; returned from
87579 *   {@link sqlite_open} when used procedurally. This parameter is not
87580 *   required when using the object-oriented method.
87581 * @param int $result_type
87582 * @param bool $decode_binary
87583 * @return array Returns an array of the entire result set; FALSE
87584 *   otherwise.
87585 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
87586 **/
87587function sqlite_array_query($dbhandle, $query, $result_type, $decode_binary){}
87588
87589/**
87590 * Set busy timeout duration, or disable busy handlers
87591 *
87592 * Set the maximum time, in milliseconds, that SQLite will wait for a
87593 * {@link dbhandle} to become ready for use.
87594 *
87595 * @param resource $dbhandle The SQLite Database resource; returned
87596 *   from {@link sqlite_open} when used procedurally. This parameter is
87597 *   not required when using the object-oriented method.
87598 * @param int $milliseconds The number of milliseconds. When set to 0,
87599 *   busy handlers will be disabled and SQLite will return immediately
87600 *   with a SQLITE_BUSY status code if another process/thread has the
87601 *   database locked for an update. PHP sets the default busy timeout to
87602 *   be 60 seconds when the database is opened.
87603 * @return void
87604 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
87605 **/
87606function sqlite_busy_timeout($dbhandle, $milliseconds){}
87607
87608/**
87609 * Returns the number of rows that were changed by the most recent SQL
87610 * statement
87611 *
87612 * Returns the numbers of rows that were changed by the most recent SQL
87613 * statement executed against the {@link dbhandle} database handle.
87614 *
87615 * @param resource $dbhandle The SQLite Database resource; returned
87616 *   from {@link sqlite_open} when used procedurally. This parameter is
87617 *   not required when using the object-oriented method.
87618 * @return int Returns the number of changed rows.
87619 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
87620 **/
87621function sqlite_changes($dbhandle){}
87622
87623/**
87624 * Closes an open SQLite database
87625 *
87626 * Closes the given {@link db_handle} database handle. If the database
87627 * was persistent, it will be closed and removed from the persistent
87628 * list.
87629 *
87630 * @param resource $dbhandle The SQLite Database resource; returned
87631 *   from {@link sqlite_open} when used procedurally.
87632 * @return void
87633 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
87634 **/
87635function sqlite_close($dbhandle){}
87636
87637/**
87638 * Fetches a column from the current row of a result set
87639 *
87640 * Fetches the value of a column named {@link index_or_name} (if it is a
87641 * string), or of the ordinal column numbered {@link index_or_name} (if
87642 * it is an integer) from the current row of the query result handle
87643 * {@link result}.
87644 *
87645 * @param resource $result The SQLite result resource. This parameter
87646 *   is not required when using the object-oriented method.
87647 * @param mixed $index_or_name The column index or name to fetch.
87648 * @param bool $decode_binary
87649 * @return mixed Returns the column value.
87650 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
87651 **/
87652function sqlite_column($result, $index_or_name, $decode_binary){}
87653
87654/**
87655 * Register an aggregating UDF for use in SQL statements
87656 *
87657 * {@link sqlite_create_aggregate} is similar to {@link
87658 * sqlite_create_function} except that it registers functions that can be
87659 * used to calculate a result aggregated across all the rows of a query.
87660 *
87661 * The key difference between this function and {@link
87662 * sqlite_create_function} is that two functions are required to manage
87663 * the aggregate; {@link step_func} is called for each row of the result
87664 * set. Your PHP function should accumulate the result and store it into
87665 * the aggregation context. Once all the rows have been processed, {@link
87666 * finalize_func} will be called and it should then take the data from
87667 * the aggregation context and return the result. Callback functions
87668 * should return a type understood by SQLite (i.e. scalar type).
87669 *
87670 * @param resource $dbhandle The SQLite Database resource; returned
87671 *   from {@link sqlite_open} when used procedurally. This parameter is
87672 *   not required when using the object-oriented method.
87673 * @param string $function_name The name of the function used in SQL
87674 *   statements.
87675 * @param callable $step_func Callback function called for each row of
87676 *   the result set. Function parameters are &$context, $value, ....
87677 * @param callable $finalize_func Callback function to aggregate the
87678 *   "stepped" data from each row. Function parameter is &$context and
87679 *   the function should return the final result of aggregation.
87680 * @param int $num_args Hint to the SQLite parser if the callback
87681 *   function accepts a predetermined number of arguments.
87682 * @return void
87683 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
87684 **/
87685function sqlite_create_aggregate($dbhandle, $function_name, $step_func, $finalize_func, $num_args){}
87686
87687/**
87688 * Registers a "regular" User Defined Function for use in SQL statements
87689 *
87690 * {@link sqlite_create_function} allows you to register a PHP function
87691 * with SQLite as an UDF (User Defined Function), so that it can be
87692 * called from within your SQL statements.
87693 *
87694 * The UDF can be used in any SQL statement that can call functions, such
87695 * as SELECT and UPDATE statements and also in triggers.
87696 *
87697 * @param resource $dbhandle The SQLite Database resource; returned
87698 *   from {@link sqlite_open} when used procedurally. This parameter is
87699 *   not required when using the object-oriented method.
87700 * @param string $function_name The name of the function used in SQL
87701 *   statements.
87702 * @param callable $callback Callback function to handle the defined
87703 *   SQL function.
87704 * @param int $num_args Hint to the SQLite parser if the callback
87705 *   function accepts a predetermined number of arguments.
87706 * @return void
87707 * @since PHP 5 < 5.4.0, sqlite >= 1.0.0
87708 **/
87709function sqlite_create_function($dbhandle, $function_name, $callback, $num_args){}
87710
87711/**
87712 * Fetches the current row from a result set as an array
87713 *
87714 * {@link sqlite_current} is identical to {@link sqlite_fetch_array}
87715 * except that it does not advance to the next row prior to returning the
87716 * data; it returns the data from the current position only.
87717 *
87718 * @param resource $result The SQLite result resource. This parameter
87719 *   is not required when using the object-oriented method.
87720 * @param int $result_type
87721 * @param bool $decode_binary
87722 * @return array Returns an array of the current row from a result set;
87723 *   FALSE if the current position is beyond the final row.
87724 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
87725 **/
87726function sqlite_current($result, $result_type, $decode_binary){}
87727
87728/**
87729 * Returns the textual description of an error code
87730 *
87731 * Returns a human readable description of the {@link error_code}
87732 * returned from {@link sqlite_last_error}.
87733 *
87734 * @param int $error_code The error code being used, which might be
87735 *   passed in from {@link sqlite_last_error}.
87736 * @return string Returns a human readable description of the {@link
87737 *   error_code}, as a string.
87738 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
87739 **/
87740function sqlite_error_string($error_code){}
87741
87742/**
87743 * Escapes a string for use as a query parameter
87744 *
87745 * {@link sqlite_escape_string} will correctly quote the string specified
87746 * by {@link item} for use in an SQLite SQL statement. This includes
87747 * doubling up single-quote characters (') and checking for binary-unsafe
87748 * characters in the query string.
87749 *
87750 * Although the encoding makes it safe to insert the data, it will render
87751 * simple text comparisons and LIKE clauses in your queries unusable for
87752 * the columns that contain the binary data. In practice, this shouldn't
87753 * be a problem, as your schema should be such that you don't use such
87754 * things on binary columns (in fact, it might be better to store binary
87755 * data using other means, such as in files).
87756 *
87757 * @param string $item The string being quoted. If the {@link item}
87758 *   contains a NUL character, or if it begins with a character whose
87759 *   ordinal value is 0x01, PHP will apply a binary encoding scheme so
87760 *   that you can safely store and retrieve binary data.
87761 * @return string Returns an escaped string for use in an SQLite SQL
87762 *   statement.
87763 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
87764 **/
87765function sqlite_escape_string($item){}
87766
87767/**
87768 * Executes a result-less query against a given database
87769 *
87770 * Executes an SQL statement given by the {@link query} against a given
87771 * database handle (specified by the {@link dbhandle} parameter).
87772 *
87773 * @param resource $dbhandle The SQLite Database resource; returned
87774 *   from {@link sqlite_open} when used procedurally. This parameter is
87775 *   not required when using the object-oriented method.
87776 * @param string $query The query to be executed. Data inside the query
87777 *   should be properly escaped.
87778 * @param string $error_msg The specified variable will be filled if an
87779 *   error occurs. This is specially important because SQL syntax errors
87780 *   can't be fetched using the {@link sqlite_last_error} function.
87781 * @return bool This function will return a boolean result; TRUE for
87782 *   success or FALSE for failure. If you need to run a query that
87783 *   returns rows, see {@link sqlite_query}.
87784 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.3
87785 **/
87786function sqlite_exec($dbhandle, $query, &$error_msg){}
87787
87788/**
87789 * Opens an SQLite database and returns an SQLiteDatabase object
87790 *
87791 * {@link sqlite_factory} behaves similarly to {@link sqlite_open} in
87792 * that it opens an SQLite database or attempts to create it if it does
87793 * not exist. However, a SQLiteDatabase object is returned rather than a
87794 * resource. Please see the {@link sqlite_open} reference page for
87795 * further usage and caveats.
87796 *
87797 * @param string $filename The filename of the SQLite database.
87798 * @param int $mode The mode of the file. Intended to be used to open
87799 *   the database in read-only mode. Presently, this parameter is ignored
87800 *   by the sqlite library. The default value for mode is the octal value
87801 *   0666 and this is the recommended value.
87802 * @param string $error_message Passed by reference and is set to hold
87803 *   a descriptive error message explaining why the database could not be
87804 *   opened if there was an error.
87805 * @return SQLiteDatabase Returns an SQLiteDatabase object on success,
87806 *   NULL on error.
87807 * @since PHP 5 < 5.4.0
87808 **/
87809function sqlite_factory($filename, $mode, &$error_message){}
87810
87811/**
87812 * Fetches all rows from a result set as an array of arrays
87813 *
87814 * {@link sqlite_fetch_all} returns an array of the entire result set
87815 * from the {@link result} resource. It is similar to calling {@link
87816 * sqlite_query} (or {@link sqlite_unbuffered_query}) and then {@link
87817 * sqlite_fetch_array} for each row in the result set.
87818 *
87819 * @param resource $result The SQLite result resource. This parameter
87820 *   is not required when using the object-oriented method.
87821 * @param int $result_type
87822 * @param bool $decode_binary
87823 * @return array Returns an array of the remaining rows in a result
87824 *   set. If called right after {@link sqlite_query}, it returns all
87825 *   rows. If called after {@link sqlite_fetch_array}, it returns the
87826 *   rest. If there are no rows in a result set, it returns an empty
87827 *   array.
87828 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
87829 **/
87830function sqlite_fetch_all($result, $result_type, $decode_binary){}
87831
87832/**
87833 * Fetches the next row from a result set as an array
87834 *
87835 * Fetches the next row from the given {@link result} handle. If there
87836 * are no more rows, returns FALSE, otherwise returns an associative
87837 * array representing the row data.
87838 *
87839 * @param resource $result The SQLite result resource. This parameter
87840 *   is not required when using the object-oriented method.
87841 * @param int $result_type
87842 * @param bool $decode_binary
87843 * @return array Returns an array of the next row from a result set;
87844 *   FALSE if the next position is beyond the final row.
87845 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
87846 **/
87847function sqlite_fetch_array($result, $result_type, $decode_binary){}
87848
87849/**
87850 * Return an array of column types from a particular table
87851 *
87852 * {@link sqlite_fetch_column_types} returns an array of column data
87853 * types from the specified {@link table_name} table.
87854 *
87855 * @param string $table_name The table name to query.
87856 * @param resource $dbhandle The SQLite Database resource; returned
87857 *   from {@link sqlite_open} when used procedurally. This parameter is
87858 *   not required when using the object-oriented method.
87859 * @param int $result_type The optional {@link result_type} parameter
87860 *   accepts a constant and determines how the returned array will be
87861 *   indexed. Using SQLITE_ASSOC will return only associative indices
87862 *   (named fields) while SQLITE_NUM will return only numerical indices
87863 *   (ordinal field numbers). SQLITE_ASSOC is the default for this
87864 *   function.
87865 * @return array Returns an array of column data types; FALSE on error.
87866 * @since PHP 5 < 5.4.0
87867 **/
87868function sqlite_fetch_column_types($table_name, $dbhandle, $result_type){}
87869
87870/**
87871 * Fetches the next row from a result set as an object
87872 *
87873 * @param resource $result
87874 * @param string $class_name
87875 * @param array $ctor_params
87876 * @param bool $decode_binary
87877 * @return object
87878 * @since PHP 5 < 5.4.0
87879 **/
87880function sqlite_fetch_object($result, $class_name, $ctor_params, $decode_binary){}
87881
87882/**
87883 * Fetches the first column of a result set as a string
87884 *
87885 * {@link sqlite_fetch_single} is identical to {@link sqlite_fetch_array}
87886 * except that it returns the value of the first column of the rowset.
87887 *
87888 * This is the most optimal way to retrieve data when you are only
87889 * interested in the values from a single column of data.
87890 *
87891 * @param resource $result The SQLite result resource. This parameter
87892 *   is not required when using the object-oriented method.
87893 * @param bool $decode_binary
87894 * @return string Returns the first column value, as a string.
87895 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.1
87896 **/
87897function sqlite_fetch_single($result, $decode_binary){}
87898
87899/**
87900 * Fetches the first column of a result set as a string
87901 *
87902 * {@link sqlite_fetch_string} is identical to {@link sqlite_fetch_array}
87903 * except that it returns the value of the first column of the rowset.
87904 *
87905 * This is the most optimal way to retrieve data when you are only
87906 * interested in the values from a single column of data.
87907 *
87908 * @param resource $result The SQLite result resource. This parameter
87909 *   is not required when using the object-oriented method.
87910 * @param bool $decode_binary
87911 * @return string Returns the first column value, as a string.
87912 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
87913 **/
87914function sqlite_fetch_string($result, $decode_binary){}
87915
87916/**
87917 * Returns the name of a particular field
87918 *
87919 * Given the ordinal column number, {@link field_index}, {@link
87920 * sqlite_field_name} returns the name of that field in the result set
87921 * {@link result}.
87922 *
87923 * @param resource $result The SQLite result resource. This parameter
87924 *   is not required when using the object-oriented method.
87925 * @param int $field_index The ordinal column number in the result set.
87926 * @return string Returns the name of a field in an SQLite result set,
87927 *   given the ordinal column number; FALSE on error.
87928 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
87929 **/
87930function sqlite_field_name($result, $field_index){}
87931
87932/**
87933 * Finds whether or not more rows are available
87934 *
87935 * Finds whether more rows are available from the given result set.
87936 *
87937 * @param resource $result The SQLite result resource.
87938 * @return bool Returns TRUE if there are more rows available from the
87939 *   {@link result} handle, or FALSE otherwise.
87940 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
87941 **/
87942function sqlite_has_more($result){}
87943
87944/**
87945 * Returns whether or not a previous row is available
87946 *
87947 * Find whether there are more previous rows from the given result
87948 * handle.
87949 *
87950 * @param resource $result The SQLite result resource. This parameter
87951 *   is not required when using the object-oriented method.
87952 * @return bool Returns TRUE if there are more previous rows available
87953 *   from the {@link result} handle, or FALSE otherwise.
87954 * @since PHP 5 < 5.4.0
87955 **/
87956function sqlite_has_prev($result){}
87957
87958/**
87959 * Returns the error code of the last error for a database
87960 *
87961 * Returns the error code from the last operation performed on {@link
87962 * dbhandle} (the database handle), or 0 when no error occurred. A human
87963 * readable description of the error code can be retrieved using {@link
87964 * sqlite_error_string}.
87965 *
87966 * @param resource $dbhandle The SQLite Database resource; returned
87967 *   from {@link sqlite_open} when used procedurally. This parameter is
87968 *   not required when using the object-oriented method.
87969 * @return int Returns an error code, or 0 if no error occurred.
87970 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
87971 **/
87972function sqlite_last_error($dbhandle){}
87973
87974/**
87975 * Returns the rowid of the most recently inserted row
87976 *
87977 * Returns the rowid of the row that was most recently inserted into the
87978 * database {@link dbhandle}, if it was created as an auto-increment
87979 * field.
87980 *
87981 * @param resource $dbhandle The SQLite Database resource; returned
87982 *   from {@link sqlite_open} when used procedurally. This parameter is
87983 *   not required when using the object-oriented method.
87984 * @return int Returns the row id, as an integer.
87985 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
87986 **/
87987function sqlite_last_insert_rowid($dbhandle){}
87988
87989/**
87990 * Returns the encoding of the linked SQLite library
87991 *
87992 * The SQLite library may be compiled in either ISO-8859-1 or UTF-8
87993 * compatible modes. This function allows you to determine which encoding
87994 * scheme is used by your version of the library.
87995 *
87996 * When compiled with UTF-8 support, sqlite handles encoding and decoding
87997 * of UTF-8 multi-byte character sequences, but does not yet do a
87998 * complete job when working with the data (no normalization is performed
87999 * for example), and some comparison operations may still not be carried
88000 * out correctly.
88001 *
88002 * @return string Returns the library encoding.
88003 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
88004 **/
88005function sqlite_libencoding(){}
88006
88007/**
88008 * Returns the version of the linked SQLite library
88009 *
88010 * @return string Returns the library version, as a string.
88011 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
88012 **/
88013function sqlite_libversion(){}
88014
88015/**
88016 * Seek to the next row number
88017 *
88018 * {@link sqlite_next} advances the result handle {@link result} to the
88019 * next row.
88020 *
88021 * @param resource $result The SQLite result resource. This parameter
88022 *   is not required when using the object-oriented method.
88023 * @return bool Returns TRUE on success, or FALSE if there are no more
88024 *   rows.
88025 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
88026 **/
88027function sqlite_next($result){}
88028
88029/**
88030 * Returns the number of fields in a result set
88031 *
88032 * Returns the number of fields in the {@link result} set.
88033 *
88034 * @param resource $result The SQLite result resource. This parameter
88035 *   is not required when using the object-oriented method.
88036 * @return int Returns the number of fields, as an integer.
88037 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
88038 **/
88039function sqlite_num_fields($result){}
88040
88041/**
88042 * Returns the number of rows in a buffered result set
88043 *
88044 * Returns the number of rows in the buffered {@link result} set.
88045 *
88046 * @param resource $result The SQLite result resource. This parameter
88047 *   is not required when using the object-oriented method.
88048 * @return int Returns the number of rows, as an integer.
88049 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
88050 **/
88051function sqlite_num_rows($result){}
88052
88053/**
88054 * Opens an SQLite database and create the database if it does not exist
88055 *
88056 * (constructor):
88057 *
88058 * Opens an SQLite database or creates the database if it does not exist.
88059 *
88060 * @param string $filename The filename of the SQLite database. If the
88061 *   file does not exist, SQLite will attempt to create it. PHP must have
88062 *   write permissions to the file if data is inserted, the database
88063 *   schema is modified or to create the database if it does not exist.
88064 * @param int $mode The mode of the file. Intended to be used to open
88065 *   the database in read-only mode. Presently, this parameter is ignored
88066 *   by the sqlite library. The default value for mode is the octal value
88067 *   0666 and this is the recommended value.
88068 * @param string $error_message Passed by reference and is set to hold
88069 *   a descriptive error message explaining why the database could not be
88070 *   opened if there was an error.
88071 * @return resource Returns a resource (database handle) on success,
88072 *   FALSE on error.
88073 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
88074 **/
88075function sqlite_open($filename, $mode, &$error_message){}
88076
88077/**
88078 * Opens a persistent handle to an SQLite database and create the
88079 * database if it does not exist
88080 *
88081 * {@link sqlite_popen} will first check to see if a persistent handle
88082 * has already been opened for the given {@link filename}. If it finds
88083 * one, it returns that handle to your script, otherwise it opens a fresh
88084 * handle to the database.
88085 *
88086 * The benefit of this approach is that you don't incur the performance
88087 * cost of re-reading the database and index schema on each page hit
88088 * served by persistent web server SAPI's (any SAPI except for regular
88089 * CGI or CLI).
88090 *
88091 * @param string $filename The filename of the SQLite database. If the
88092 *   file does not exist, SQLite will attempt to create it. PHP must have
88093 *   write permissions to the file if data is inserted, the database
88094 *   schema is modified or to create the database if it does not exist.
88095 * @param int $mode The mode of the file. Intended to be used to open
88096 *   the database in read-only mode. Presently, this parameter is ignored
88097 *   by the sqlite library. The default value for mode is the octal value
88098 *   0666 and this is the recommended value.
88099 * @param string $error_message Passed by reference and is set to hold
88100 *   a descriptive error message explaining why the database could not be
88101 *   opened if there was an error.
88102 * @return resource Returns a resource (database handle) on success,
88103 *   FALSE on error.
88104 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
88105 **/
88106function sqlite_popen($filename, $mode, &$error_message){}
88107
88108/**
88109 * Seek to the previous row number of a result set
88110 *
88111 * {@link sqlite_prev} seeks back the {@link result} handle to the
88112 * previous row.
88113 *
88114 * @param resource $result The SQLite result resource. This parameter
88115 *   is not required when using the object-oriented method.
88116 * @return bool Returns TRUE on success, or FALSE if there are no more
88117 *   previous rows.
88118 * @since PHP 5 < 5.4.0
88119 **/
88120function sqlite_prev($result){}
88121
88122/**
88123 * Executes a query against a given database and returns a result handle
88124 *
88125 * Executes an SQL statement given by the {@link query} against a given
88126 * database handle.
88127 *
88128 * @param resource $dbhandle The SQLite Database resource; returned
88129 *   from {@link sqlite_open} when used procedurally. This parameter is
88130 *   not required when using the object-oriented method.
88131 * @param string $query The query to be executed. Data inside the query
88132 *   should be properly escaped.
88133 * @param int $result_type
88134 * @param string $error_msg The specified variable will be filled if an
88135 *   error occurs. This is specially important because SQL syntax errors
88136 *   can't be fetched using the {@link sqlite_last_error} function.
88137 * @return resource This function will return a result handle. For
88138 *   queries that return rows, the result handle can then be used with
88139 *   functions such as {@link sqlite_fetch_array} and {@link
88140 *   sqlite_seek}.
88141 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
88142 **/
88143function sqlite_query($dbhandle, $query, $result_type, &$error_msg){}
88144
88145/**
88146 * Seek to the first row number
88147 *
88148 * {@link sqlite_rewind} seeks back to the first row in the given result
88149 * set.
88150 *
88151 * @param resource $result The SQLite result resource. This parameter
88152 *   is not required when using the object-oriented method.
88153 * @return bool Returns FALSE if there are no rows in the result set,
88154 *   TRUE otherwise.
88155 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
88156 **/
88157function sqlite_rewind($result){}
88158
88159/**
88160 * Seek to a particular row number of a buffered result set
88161 *
88162 * {@link sqlite_seek} seeks to the row given by the parameter {@link
88163 * rownum}.
88164 *
88165 * @param resource $result The SQLite result resource. This parameter
88166 *   is not required when using the object-oriented method.
88167 * @param int $rownum The ordinal row number to seek to. The row number
88168 *   is zero-based (0 is the first row).
88169 * @return bool Returns FALSE if the row does not exist, TRUE
88170 *   otherwise.
88171 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
88172 **/
88173function sqlite_seek($result, $rownum){}
88174
88175/**
88176 * Executes a query and returns either an array for one single column or
88177 * the value of the first row
88178 *
88179 * @param resource $db
88180 * @param string $query
88181 * @param bool $first_row_only
88182 * @param bool $decode_binary
88183 * @return array
88184 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.1
88185 **/
88186function sqlite_single_query($db, $query, $first_row_only, $decode_binary){}
88187
88188/**
88189 * Decode binary data passed as parameters to an
88190 *
88191 * Decodes binary data passed as parameters to a UDF.
88192 *
88193 * You must call this function on parameters passed to your UDF if you
88194 * need them to handle binary data, as the binary encoding employed by
88195 * PHP will obscure the content and of the parameter in its natural,
88196 * non-coded form.
88197 *
88198 * PHP does not perform this encode/decode operation automatically as it
88199 * would severely impact performance if it did.
88200 *
88201 * @param string $data The encoded data that will be decoded, data that
88202 *   was applied by either {@link sqlite_udf_encode_binary} or {@link
88203 *   sqlite_escape_string}.
88204 * @return string The decoded string.
88205 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
88206 **/
88207function sqlite_udf_decode_binary($data){}
88208
88209/**
88210 * Encode binary data before returning it from an UDF
88211 *
88212 * {@link sqlite_udf_encode_binary} applies a binary encoding to the
88213 * {@link data} so that it can be safely returned from queries (since the
88214 * underlying libsqlite API is not binary safe).
88215 *
88216 * If there is a chance that your data might be binary unsafe (e.g.: it
88217 * contains a NUL byte in the middle rather than at the end, or if it has
88218 * and 0x01 byte as the first character) then you must call this function
88219 * to encode the return value from your UDF.
88220 *
88221 * PHP does not perform this encode/decode operation automatically as it
88222 * would severely impact performance if it did.
88223 *
88224 * @param string $data The string being encoded.
88225 * @return string The encoded string.
88226 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
88227 **/
88228function sqlite_udf_encode_binary($data){}
88229
88230/**
88231 * Execute a query that does not prefetch and buffer all data
88232 *
88233 * {@link sqlite_unbuffered_query} is identical to {@link sqlite_query}
88234 * except that the result that is returned is a sequential forward-only
88235 * result set that can only be used to read each row, one after the
88236 * other.
88237 *
88238 * This function is ideal for generating things such as HTML tables where
88239 * you only need to process one row at a time and don't need to randomly
88240 * access the row data.
88241 *
88242 * @param resource $dbhandle The SQLite Database resource; returned
88243 *   from {@link sqlite_open} when used procedurally. This parameter is
88244 *   not required when using the object-oriented method.
88245 * @param string $query The query to be executed. Data inside the query
88246 *   should be properly escaped.
88247 * @param int $result_type
88248 * @param string $error_msg The specified variable will be filled if an
88249 *   error occurs. This is specially important because SQL syntax errors
88250 *   can't be fetched using the {@link sqlite_last_error} function.
88251 * @return resource Returns a result handle.
88252 * @since PHP 5 < 5.4.0, PECL sqlite >= 1.0.0
88253 **/
88254function sqlite_unbuffered_query($dbhandle, $query, $result_type, &$error_msg){}
88255
88256/**
88257 * Returns whether more rows are available
88258 *
88259 * Finds whether more rows are available from the given result handle.
88260 *
88261 * @param resource $result The SQLite result resource. This parameter
88262 *   is not required when using the object-oriented method.
88263 * @return bool Returns TRUE if there are more rows available from the
88264 *   {@link result} handle, or FALSE otherwise.
88265 * @since PHP 5 < 5.4.0
88266 **/
88267function sqlite_valid($result){}
88268
88269/**
88270 * Begins a database transaction
88271 *
88272 * The transaction begun by {@link sqlsrv_begin_transaction} includes all
88273 * statements that were executed after the call to {@link
88274 * sqlsrv_begin_transaction} and before calls to {@link sqlsrv_rollback}
88275 * or {@link sqlsrv_commit}. Explicit transactions should be started and
88276 * committed or rolled back using these functions instead of executing
88277 * SQL statements that begin and commit/roll back transactions. For more
88278 * information, see SQLSRV Transactions.
88279 *
88280 * @param resource $conn The connection resource returned by a call to
88281 *   {@link sqlsrv_connect}.
88282 * @return bool
88283 **/
88284function sqlsrv_begin_transaction($conn){}
88285
88286/**
88287 * Cancels a statement
88288 *
88289 * Cancels a statement. Any results associated with the statement that
88290 * have not been consumed are deleted. After {@link sqlsrv_cancel} has
88291 * been called, the specified statement can be re-executed if it was
88292 * created with {@link sqlsrv_prepare}. Calling {@link sqlsrv_cancel} is
88293 * not necessary if all the results associated with the statement have
88294 * been consumed.
88295 *
88296 * @param resource $stmt The statement resource to be cancelled.
88297 * @return bool
88298 **/
88299function sqlsrv_cancel($stmt){}
88300
88301/**
88302 * Returns information about the client and specified connection
88303 *
88304 * @param resource $conn The connection about which information is
88305 *   returned.
88306 * @return array Returns an associative array with keys described in
88307 *   the table below. Returns FALSE otherwise. Array returned by
88308 *   sqlsrv_client_info Key Description DriverDllName SQLNCLI10.DLL
88309 *   DriverODBCVer ODBC version (xx.yy) DriverVer SQL Server Native
88310 *   Client DLL version (10.5.xxx) ExtensionVer php_sqlsrv.dll version
88311 *   (2.0.xxx.x)
88312 **/
88313function sqlsrv_client_info($conn){}
88314
88315/**
88316 * Closes an open connection and releases resourses associated with the
88317 * connection
88318 *
88319 * @param resource $conn The connection to be closed.
88320 * @return bool
88321 **/
88322function sqlsrv_close($conn){}
88323
88324/**
88325 * Commits a transaction that was begun with
88326 *
88327 * Commits a transaction that was begun with {@link
88328 * sqlsrv_begin_transaction}. The connection is returned to auto-commit
88329 * mode after {@link sqlsrv_commit} is called. The transaction that is
88330 * committed includes all statements that were executed after the call to
88331 * {@link sqlsrv_begin_transaction}. Explicit transactions should be
88332 * started and committed or rolled back using these functions instead of
88333 * executing SQL statements that begin and commit/roll back transactions.
88334 * For more information, see SQLSRV Transactions.
88335 *
88336 * @param resource $conn The connection on which the transaction is to
88337 *   be committed.
88338 * @return bool
88339 **/
88340function sqlsrv_commit($conn){}
88341
88342/**
88343 * Changes the driver error handling and logging configurations
88344 *
88345 * @param string $setting The name of the setting to set. The possible
88346 *   values are "WarningsReturnAsErrors", "LogSubsystems", and
88347 *   "LogSeverity".
88348 * @param mixed $value The value of the specified setting. The
88349 *   following table shows possible values: Error and Logging Setting
88350 *   Options Setting Options WarningsReturnAsErrors 1 (TRUE) or 0 (FALSE)
88351 *   LogSubsystems SQLSRV_LOG_SYSTEM_ALL (-1) SQLSRV_LOG_SYSTEM_CONN (2)
88352 *   SQLSRV_LOG_SYSTEM_INIT (1) SQLSRV_LOG_SYSTEM_OFF (0)
88353 *   SQLSRV_LOG_SYSTEM_STMT (4) SQLSRV_LOG_SYSTEM_UTIL (8) LogSeverity
88354 *   SQLSRV_LOG_SEVERITY_ALL (-1) SQLSRV_LOG_SEVERITY_ERROR (1)
88355 *   SQLSRV_LOG_SEVERITY_NOTICE (4) SQLSRV_LOG_SEVERITY_WARNING (2)
88356 * @return bool
88357 **/
88358function sqlsrv_configure($setting, $value){}
88359
88360/**
88361 * Opens a connection to a Microsoft SQL Server database
88362 *
88363 * Opens a connection to a Microsoft SQL Server database. By default, the
88364 * connection is attempted using Windows Authentication. To connect using
88365 * SQL Server Authentication, include "UID" and "PWD" in the connection
88366 * options array.
88367 *
88368 * @param string $serverName The name of the server to which a
88369 *   connection is established. To connect to a specific instance, follow
88370 *   the server name with a backward slash and the instance name (e.g.
88371 *   serverName\sqlexpress).
88372 * @param array $connectionInfo An associative array that specifies
88373 *   options for connecting to the server. If values for the UID and PWD
88374 *   keys are not specified, the connection will be attempted using
88375 *   Windows Authentication. For a complete list of supported keys, see
88376 *   SQLSRV Connection Options.
88377 * @return resource A connection resource. If a connection cannot be
88378 *   successfully opened, FALSE is returned.
88379 **/
88380function sqlsrv_connect($serverName, $connectionInfo){}
88381
88382/**
88383 * Returns error and warning information about the last SQLSRV operation
88384 * performed
88385 *
88386 * @param int $errorsOrWarnings Determines whether error information,
88387 *   warning information, or both are returned. If this parameter is not
88388 *   supplied, both error information and warning information are
88389 *   returned. The following are the supported values for this parameter:
88390 *   SQLSRV_ERR_ALL, SQLSRV_ERR_ERRORS, SQLSRV_ERR_WARNINGS.
88391 * @return mixed If errors and/or warnings occurred on the last sqlsrv
88392 *   operation, an array of arrays containing error information is
88393 *   returned. If no errors and/or warnings occurred on the last sqlsrv
88394 *   operation, NULL is returned. The following table describes the
88395 *   structure of the returned arrays: Array returned by sqlsrv_errors
88396 *   Key Description SQLSTATE For errors that originate from the ODBC
88397 *   driver, the SQLSTATE returned by ODBC. For errors that originate
88398 *   from the Microsoft Drivers for PHP for SQL Server, a SQLSTATE of
88399 *   IMSSP. For warnings that originate from the Microsoft Drivers for
88400 *   PHP for SQL Server, a SQLSTATE of 01SSP. code For errors that
88401 *   originate from SQL Server, the native SQL Server error code. For
88402 *   errors that originate from the ODBC driver, the error code returned
88403 *   by ODBC. For errors that originate from the Microsoft Drivers for
88404 *   PHP for SQL Server, the Microsoft Drivers for PHP for SQL Server
88405 *   error code. message A description of the error.
88406 **/
88407function sqlsrv_errors($errorsOrWarnings){}
88408
88409/**
88410 * Executes a statement prepared with
88411 *
88412 * Executes a statement prepared with {@link sqlsrv_prepare}. This
88413 * function is ideal for executing a prepared statement multiple times
88414 * with different parameter values.
88415 *
88416 * @param resource $stmt A statement resource returned by {@link
88417 *   sqlsrv_prepare}.
88418 * @return bool
88419 **/
88420function sqlsrv_execute($stmt){}
88421
88422/**
88423 * Makes the next row in a result set available for reading
88424 *
88425 * Makes the next row in a result set available for reading. Use {@link
88426 * sqlsrv_get_field} to read the fields of the row.
88427 *
88428 * @param resource $stmt A statement resource created by executing
88429 *   {@link sqlsrv_query} or {@link sqlsrv_execute}.
88430 * @param int $row The row to be accessed. This parameter can only be
88431 *   used if the specified statement was prepared with a scrollable
88432 *   cursor. In that case, this parameter can take on one of the
88433 *   following values: SQLSRV_SCROLL_NEXT SQLSRV_SCROLL_PRIOR
88434 *   SQLSRV_SCROLL_FIRST SQLSRV_SCROLL_LAST SQLSRV_SCROLL_ABSOLUTE
88435 *   SQLSRV_SCROLL_RELATIVE
88436 * @param int $offset Specifies the row to be accessed if the row
88437 *   parameter is set to SQLSRV_SCROLL_ABSOLUTE or
88438 *   SQLSRV_SCROLL_RELATIVE. Note that the first row in a result set has
88439 *   index 0.
88440 * @return mixed Returns TRUE if the next row of a result set was
88441 *   successfully retrieved, FALSE if an error occurs, and NULL if there
88442 *   are no more rows in the result set.
88443 **/
88444function sqlsrv_fetch($stmt, $row, $offset){}
88445
88446/**
88447 * Returns a row as an array
88448 *
88449 * Returns the next available row of data as an associative array, a
88450 * numeric array, or both (the default).
88451 *
88452 * @param resource $stmt A statement resource returned by sqlsrv_query
88453 *   or sqlsrv_prepare.
88454 * @param int $fetchType A predefined constant specifying the type of
88455 *   array to return. Possible values are SQLSRV_FETCH_ASSOC,
88456 *   SQLSRV_FETCH_NUMERIC, and SQLSRV_FETCH_BOTH (the default). A fetch
88457 *   type of SQLSRV_FETCH_ASSOC should not be used when consuming a
88458 *   result set with multiple columns of the same name.
88459 * @param int $row Specifies the row to access in a result set that
88460 *   uses a scrollable cursor. Possible values are SQLSRV_SCROLL_NEXT,
88461 *   SQLSRV_SCROLL_PRIOR, SQLSRV_SCROLL_FIRST, SQLSRV_SCROLL_LAST,
88462 *   SQLSRV_SCROLL_ABSOLUTE and, SQLSRV_SCROLL_RELATIVE (the default).
88463 *   When this parameter is specified, the {@link fetchType} must be
88464 *   explicitly defined.
88465 * @param int $offset Specifies the row to be accessed if the row
88466 *   parameter is set to SQLSRV_SCROLL_ABSOLUTE or
88467 *   SQLSRV_SCROLL_RELATIVE. Note that the first row in a result set has
88468 *   index 0.
88469 * @return array Returns an array on success, NULL if there are no more
88470 *   rows to return, and FALSE if an error occurs.
88471 **/
88472function sqlsrv_fetch_array($stmt, $fetchType, $row, $offset){}
88473
88474/**
88475 * Retrieves the next row of data in a result set as an object
88476 *
88477 * Retrieves the next row of data in a result set as an instance of the
88478 * specified class with properties that match the row field names and
88479 * values that correspond to the row field values.
88480 *
88481 * @param resource $stmt A statement resource created by {@link
88482 *   sqlsrv_query} or {@link sqlsrv_execute}.
88483 * @param string $className The name of the class to instantiate. If no
88484 *   class name is specified, stdClass is instantiated.
88485 * @param array $ctorParams Values passed to the constructor of the
88486 *   specified class. If the constructor of the specified class takes
88487 *   parameters, the ctorParams array must be supplied.
88488 * @param int $row The row to be accessed. This parameter can only be
88489 *   used if the specified statement was prepared with a scrollable
88490 *   cursor. In that case, this parameter can take on one of the
88491 *   following values: SQLSRV_SCROLL_NEXT SQLSRV_SCROLL_PRIOR
88492 *   SQLSRV_SCROLL_FIRST SQLSRV_SCROLL_LAST SQLSRV_SCROLL_ABSOLUTE
88493 *   SQLSRV_SCROLL_RELATIVE
88494 * @param int $offset Specifies the row to be accessed if the row
88495 *   parameter is set to SQLSRV_SCROLL_ABSOLUTE or
88496 *   SQLSRV_SCROLL_RELATIVE. Note that the first row in a result set has
88497 *   index 0.
88498 * @return mixed Returns an object on success, NULL if there are no
88499 *   more rows to return, and FALSE if an error occurs or if the
88500 *   specified class does not exist.
88501 **/
88502function sqlsrv_fetch_object($stmt, $className, $ctorParams, $row, $offset){}
88503
88504/**
88505 * Retrieves metadata for the fields of a statement prepared by or
88506 *
88507 * Retrieves metadata for the fields of a statement prepared by {@link
88508 * sqlsrv_prepare} or {@link sqlsrv_query}. {@link sqlsrv_field_metadata}
88509 * can be called on a statement before or after statement execution.
88510 *
88511 * @param resource $stmt The statement resource for which metadata is
88512 *   returned.
88513 * @return mixed Returns an array of arrays on success. Otherwise,
88514 *   FALSE is returned. Each returned array is described by the following
88515 *   table: Array returned by sqlsrv_field_metadata Key Description Name
88516 *   The name of the field. Type The numeric value for the SQL type. Size
88517 *   The number of characters for fields of character type, the number of
88518 *   bytes for fields of binary type, or NULL for other types. Precision
88519 *   The precision for types of variable precision, NULL for other types.
88520 *   Scale The scale for types of variable scale, NULL for other types.
88521 *   Nullable An enumeration indicating whether the column is nullable,
88522 *   not nullable, or if it is not known. For more information, see
88523 *   sqlsrv_field_metadata in the Microsoft SQLSRV documentation.
88524 **/
88525function sqlsrv_field_metadata($stmt){}
88526
88527/**
88528 * Frees all resources for the specified statement
88529 *
88530 * Frees all resources for the specified statement. The statement cannot
88531 * be used after {@link sqlsrv_free_stmt} has been called on it. If
88532 * {@link sqlsrv_free_stmt} is called on an in-progress statement that
88533 * alters server state, statement execution is terminated and the
88534 * statement is rolled back.
88535 *
88536 * @param resource $stmt The statement for which resources are freed.
88537 *   Note that NULL is a valid parameter value. This allows the function
88538 *   to be called multiple times in a script.
88539 * @return bool
88540 **/
88541function sqlsrv_free_stmt($stmt){}
88542
88543/**
88544 * Returns the value of the specified configuration setting
88545 *
88546 * @param string $setting The name of the setting for which the value
88547 *   is returned. For a list of configurable settings, see {@link
88548 *   sqlsrv_configure}.
88549 * @return mixed Returns the value of the specified setting. If an
88550 *   invalid setting is specified, FALSE is returned.
88551 **/
88552function sqlsrv_get_config($setting){}
88553
88554/**
88555 * Gets field data from the currently selected row
88556 *
88557 * Gets field data from the currently selected row. Fields must be
88558 * accessed in order. Field indices start at 0.
88559 *
88560 * @param resource $stmt A statement resource returned by {@link
88561 *   sqlsrv_query} or {@link sqlsrv_execute}.
88562 * @param int $fieldIndex The index of the field to be retrieved. Field
88563 *   indices start at 0. Fields must be accessed in order. i.e. If you
88564 *   access field index 1, then field index 0 will not be available.
88565 * @param int $getAsType The PHP data type for the returned field data.
88566 *   If this parameter is not set, the field data will be returned as its
88567 *   default PHP data type. For information about default PHP data types,
88568 *   see Default PHP Data Types in the Microsoft SQLSRV documentation.
88569 * @return mixed Returns data from the specified field on success.
88570 *   Returns FALSE otherwise.
88571 **/
88572function sqlsrv_get_field($stmt, $fieldIndex, $getAsType){}
88573
88574/**
88575 * Indicates whether the specified statement has rows
88576 *
88577 * @param resource $stmt A statement resource returned by {@link
88578 *   sqlsrv_query} or {@link sqlsrv_execute}.
88579 * @return bool Returns TRUE if the specified statement has rows and
88580 *   FALSE if the statement does not have rows or if an error occurred.
88581 **/
88582function sqlsrv_has_rows($stmt){}
88583
88584/**
88585 * Makes the next result of the specified statement active
88586 *
88587 * Makes the next result of the specified statement active. Results
88588 * include result sets, row counts, and output parameters.
88589 *
88590 * @param resource $stmt The statement on which the next result is
88591 *   being called.
88592 * @return mixed Returns TRUE if the next result was successfully
88593 *   retrieved, FALSE if an error occurred, and NULL if there are no more
88594 *   results to retrieve.
88595 **/
88596function sqlsrv_next_result($stmt){}
88597
88598/**
88599 * Retrieves the number of fields (columns) on a statement
88600 *
88601 * @param resource $stmt The statement for which the number of fields
88602 *   is returned. {@link sqlsrv_num_fields} can be called on a statement
88603 *   before or after statement execution.
88604 * @return mixed Returns the number of fields on success. Returns FALSE
88605 *   otherwise.
88606 **/
88607function sqlsrv_num_fields($stmt){}
88608
88609/**
88610 * Retrieves the number of rows in a result set
88611 *
88612 * Retrieves the number of rows in a result set. This function requires
88613 * that the statement resource be created with a static or keyset cursor.
88614 * For more information, see {@link sqlsrv_query}, {@link
88615 * sqlsrv_prepare}, or Specifying a Cursor Type and Selecting Rows in the
88616 * Microsoft SQLSRV documentation.
88617 *
88618 * @param resource $stmt The statement for which the row count is
88619 *   returned. The statement resource must be created with a static or
88620 *   keyset cursor. For more information, see {@link sqlsrv_query},
88621 *   {@link sqlsrv_prepare}, or Specifying a Cursor Type and Selecting
88622 *   Rows in the Microsoft SQLSRV documentation.
88623 * @return mixed Returns the number of rows retrieved on success and
88624 *   FALSE if an error occurred. If a forward cursor (the default) or
88625 *   dynamic cursor is used, FALSE is returned.
88626 **/
88627function sqlsrv_num_rows($stmt){}
88628
88629/**
88630 * Prepares a query for execution
88631 *
88632 * Prepares a query for execution. This function is ideal for preparing a
88633 * query that will be executed multiple times with different parameter
88634 * values.
88635 *
88636 * @param resource $conn A connection resource returned by {@link
88637 *   sqlsrv_connect}.
88638 * @param string $sql The string that defines the query to be prepared
88639 *   and executed.
88640 * @param array $params An array specifying parameter information when
88641 *   executing a parameterized query. Array elements can be any of the
88642 *   following: A literal value A PHP variable An array with this
88643 *   structure: array($value [, $direction [, $phpType [, $sqlType]]])
88644 *   The following table describes the elements in the array structure
88645 *   above:
88646 * @param array $options An array specifying query property options.
88647 *   The supported keys are described in the following table:
88648 * @return mixed Returns a statement resource on success and FALSE if
88649 *   an error occurred.
88650 **/
88651function sqlsrv_prepare($conn, $sql, $params, $options){}
88652
88653/**
88654 * Prepares and executes a query
88655 *
88656 * @param resource $conn A connection resource returned by {@link
88657 *   sqlsrv_connect}.
88658 * @param string $sql The string that defines the query to be prepared
88659 *   and executed.
88660 * @param array $params An array specifying parameter information when
88661 *   executing a parameterized query. Array elements can be any of the
88662 *   following: A literal value A PHP variable An array with this
88663 *   structure: array($value [, $direction [, $phpType [, $sqlType]]])
88664 *   The following table describes the elements in the array structure
88665 *   above:
88666 * @param array $options An array specifying query property options.
88667 *   The supported keys are described in the following table:
88668 * @return mixed Returns a statement resource on success and FALSE if
88669 *   an error occurred.
88670 **/
88671function sqlsrv_query($conn, $sql, $params, $options){}
88672
88673/**
88674 * Rolls back a transaction that was begun with
88675 *
88676 * Rolls back a transaction that was begun with {@link
88677 * sqlsrv_begin_transaction} and returns the connection to auto-commit
88678 * mode.
88679 *
88680 * @param resource $conn The connection resource returned by a call to
88681 *   {@link sqlsrv_connect}.
88682 * @return bool
88683 **/
88684function sqlsrv_rollback($conn){}
88685
88686/**
88687 * Returns the number of rows modified by the last INSERT, UPDATE, or
88688 * DELETE query executed
88689 *
88690 * Returns the number of rows modified by the last INSERT, UPDATE, or
88691 * DELETE query executed. For information about the number of rows
88692 * returned by a SELECT query, see {@link sqlsrv_num_rows}.
88693 *
88694 * @param resource $stmt The executed statement resource for which the
88695 *   number of affected rows is returned.
88696 * @return int Returns the number of rows affected by the last INSERT,
88697 *   UPDATE, or DELETE query. If no rows were affected, 0 is returned. If
88698 *   the number of affected rows cannot be determined, -1 is returned. If
88699 *   an error occurred, FALSE is returned.
88700 **/
88701function sqlsrv_rows_affected($stmt){}
88702
88703/**
88704 * Sends data from parameter streams to the server
88705 *
88706 * Send data from parameter streams to the server. Up to 8 KB of data is
88707 * sent with each call.
88708 *
88709 * @param resource $stmt A statement resource returned by {@link
88710 *   sqlsrv_query} or {@link sqlsrv_execute}.
88711 * @return bool Returns TRUE if there is more data to send and FALSE if
88712 *   there is not.
88713 **/
88714function sqlsrv_send_stream_data($stmt){}
88715
88716/**
88717 * Returns information about the server
88718 *
88719 * @param resource $conn The connection resource that connects the
88720 *   client and the server.
88721 * @return array Returns an array as described in the following table:
88722 *   Returned Array CurrentDatabase The connected-to database.
88723 *   SQLServerVersion The SQL Server version. SQLServerName The name of
88724 *   the server.
88725 **/
88726function sqlsrv_server_info($conn){}
88727
88728/**
88729 * Make regular expression for case insensitive match
88730 *
88731 * Creates a regular expression for a case insensitive match.
88732 *
88733 * @param string $string The input string.
88734 * @return string Returns a valid regular expression which will match
88735 *   {@link string}, ignoring case. This expression is {@link string}
88736 *   with each alphabetic character converted to a bracket expression;
88737 *   this bracket expression contains that character's uppercase and
88738 *   lowercase form. Other characters remain unchanged.
88739 * @since PHP 4, PHP 5
88740 **/
88741function sql_regcase($string){}
88742
88743/**
88744 * Square root
88745 *
88746 * Returns the square root of {@link arg}.
88747 *
88748 * @param float $arg The argument to process
88749 * @return float The square root of {@link arg} or the special value
88750 *   NAN for negative numbers.
88751 * @since PHP 4, PHP 5, PHP 7
88752 **/
88753function sqrt($arg){}
88754
88755/**
88756 * Seed the random number generator
88757 *
88758 * Seeds the random number generator with {@link seed} or with a random
88759 * value if no {@link seed} is given.
88760 *
88761 * @param int $seed An arbitrary integer seed value.
88762 * @return void
88763 * @since PHP 4, PHP 5, PHP 7
88764 **/
88765function srand($seed){}
88766
88767/**
88768 * Parses input from a string according to a format
88769 *
88770 * The function {@link sscanf} is the input analog of {@link printf}.
88771 * {@link sscanf} reads from the string {@link str} and interprets it
88772 * according to the specified {@link format}, which is described in the
88773 * documentation for {@link sprintf}.
88774 *
88775 * Any whitespace in the format string matches any whitespace in the
88776 * input string. This means that even a tab \t in the format string can
88777 * match a single space character in the input string.
88778 *
88779 * @param string $str The input string being parsed.
88780 * @param string $format The interpreted format for {@link str}, which
88781 *   is described in the documentation for {@link sprintf} with following
88782 *   differences: Function is not locale-aware. F, g, G and b are not
88783 *   supported. D stands for decimal number. i stands for integer with
88784 *   base detection. n stands for number of characters processed so far.
88785 *   s stops reading at any whitespace character.
88786 * @param mixed ...$vararg Optionally pass in variables by reference
88787 *   that will contain the parsed values.
88788 * @return mixed If only two parameters were passed to this function,
88789 *   the values parsed will be returned as an array. Otherwise, if
88790 *   optional parameters are passed, the function will return the number
88791 *   of assigned values. The optional parameters must be passed by
88792 *   reference.
88793 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
88794 **/
88795function sscanf($str, $format, &...$vararg){}
88796
88797/**
88798 * Calculates the match score between two fuzzy hash signatures
88799 *
88800 * Calculates the match score between {@link signature1} and {@link
88801 * signature2} using context-triggered piecewise hashing, and returns the
88802 * match score.
88803 *
88804 * @param string $signature1 The first fuzzy hash signature string.
88805 * @param string $signature2 The second fuzzy hash signature string.
88806 * @return int Returns an integer from 0 to 100 on success, FALSE
88807 *   otherwise.
88808 * @since PECL ssdeep >= 1.0.0
88809 **/
88810function ssdeep_fuzzy_compare($signature1, $signature2){}
88811
88812/**
88813 * Create a fuzzy hash from a string
88814 *
88815 * {@link ssdeep_fuzzy_hash} calculates the hash of {@link to_hash} using
88816 * context-triggered piecewise hashing, and returns that hash.
88817 *
88818 * @param string $to_hash The input string.
88819 * @return string Returns a string on success, FALSE otherwise.
88820 * @since PECL ssdeep >= 1.0.0
88821 **/
88822function ssdeep_fuzzy_hash($to_hash){}
88823
88824/**
88825 * Create a fuzzy hash from a file
88826 *
88827 * {@link ssdeep_fuzzy_hash_filename} calculates the hash of the file
88828 * specified by {@link file_name} using context-triggered piecewise
88829 * hashing, and returns that hash.
88830 *
88831 * @param string $file_name The filename of the file to hash.
88832 * @return string Returns a string on success, FALSE otherwise.
88833 * @since PECL ssdeep >= 1.0.0
88834 **/
88835function ssdeep_fuzzy_hash_filename($file_name){}
88836
88837/**
88838 * Authenticate over SSH using the ssh agent
88839 *
88840 * @param resource $session An SSH connection link identifier, obtained
88841 *   from a call to {@link ssh2_connect}.
88842 * @param string $username Remote user name.
88843 * @return bool
88844 * @since PECL ssh2 >= 0.12
88845 **/
88846function ssh2_auth_agent($session, $username){}
88847
88848/**
88849 * Authenticate using a public hostkey
88850 *
88851 * Authenticate using a public hostkey read from a file.
88852 *
88853 * @param resource $session An SSH connection link identifier, obtained
88854 *   from a call to {@link ssh2_connect}.
88855 * @param string $username
88856 * @param string $hostname
88857 * @param string $pubkeyfile
88858 * @param string $privkeyfile
88859 * @param string $passphrase If {@link privkeyfile} is encrypted (which
88860 *   it should be), the passphrase must be provided.
88861 * @param string $local_username If {@link local_username} is omitted,
88862 *   then the value for {@link username} will be used for it.
88863 * @return bool
88864 * @since PECL ssh2 >= 0.9.0
88865 **/
88866function ssh2_auth_hostbased_file($session, $username, $hostname, $pubkeyfile, $privkeyfile, $passphrase, $local_username){}
88867
88868/**
88869 * Authenticate as "none"
88870 *
88871 * Attempt "none" authentication which usually will (and should) fail. As
88872 * part of the failure, this function will return an array of accepted
88873 * authentication methods.
88874 *
88875 * @param resource $session An SSH connection link identifier, obtained
88876 *   from a call to {@link ssh2_connect}.
88877 * @param string $username Remote user name.
88878 * @return mixed Returns TRUE if the server does accept "none" as an
88879 *   authentication method, or an array of accepted authentication
88880 *   methods on failure.
88881 * @since PECL ssh2 >= 0.9.0
88882 **/
88883function ssh2_auth_none($session, $username){}
88884
88885/**
88886 * Authenticate over SSH using a plain password
88887 *
88888 * Authenticate over SSH using a plain password. Since version 0.12 this
88889 * function also supports keyboard_interactive method.
88890 *
88891 * @param resource $session An SSH connection link identifier, obtained
88892 *   from a call to {@link ssh2_connect}.
88893 * @param string $username Remote user name.
88894 * @param string $password Password for {@link username}
88895 * @return bool
88896 * @since PECL ssh2 >= 0.9.0
88897 **/
88898function ssh2_auth_password($session, $username, $password){}
88899
88900/**
88901 * Authenticate using a public key
88902 *
88903 * Authenticate using a public key read from a file.
88904 *
88905 * @param resource $session An SSH connection link identifier, obtained
88906 *   from a call to {@link ssh2_connect}.
88907 * @param string $username
88908 * @param string $pubkeyfile The public key file needs to be in
88909 *   OpenSSH's format. It should look something like: ssh-rsa
88910 *   AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110
88911 * @param string $privkeyfile
88912 * @param string $passphrase If {@link privkeyfile} is encrypted (which
88913 *   it should be), the {@link passphrase} must be provided.
88914 * @return bool
88915 * @since PECL ssh2 >= 0.9.0
88916 **/
88917function ssh2_auth_pubkey_file($session, $username, $pubkeyfile, $privkeyfile, $passphrase){}
88918
88919/**
88920 * Connect to an SSH server
88921 *
88922 * Establish a connection to a remote SSH server.
88923 *
88924 * Once connected, the client should verify the server's hostkey using
88925 * {@link ssh2_fingerprint}, then authenticate using either password or
88926 * public key.
88927 *
88928 * @param string $host
88929 * @param int $port
88930 * @param array $methods {@link methods} may be an associative array
88931 *   with up to four parameters as described below.
88932 *
88933 *   {@link methods} may be an associative array with any or all of the
88934 *   following parameters. Index Meaning Supported Values* kex List of
88935 *   key exchange methods to advertise, comma separated in order of
88936 *   preference. diffie-hellman-group1-sha1, diffie-hellman-group14-sha1,
88937 *   and diffie-hellman-group-exchange-sha1 hostkey List of hostkey
88938 *   methods to advertise, comma separated in order of preference.
88939 *   ssh-rsa and ssh-dss client_to_server Associative array containing
88940 *   crypt, compression, and message authentication code (MAC) method
88941 *   preferences for messages sent from client to server.
88942 *   server_to_client Associative array containing crypt, compression,
88943 *   and message authentication code (MAC) method preferences for
88944 *   messages sent from server to client. * - Supported Values are
88945 *   dependent on methods supported by underlying library. See libssh2
88946 *   documentation for additional information.
88947 *
88948 *   {@link client_to_server} and {@link server_to_client} may be an
88949 *   associative array with any or all of the following parameters. Index
88950 *   Meaning Supported Values* crypt List of crypto methods to advertise,
88951 *   comma separated in order of preference. rijndael-cbc@lysator.liu.se,
88952 *   aes256-cbc, aes192-cbc, aes128-cbc, 3des-cbc, blowfish-cbc,
88953 *   cast128-cbc, arcfour, and none** comp List of compression methods to
88954 *   advertise, comma separated in order of preference. zlib and none mac
88955 *   List of MAC methods to advertise, comma separated in order of
88956 *   preference. hmac-sha1, hmac-sha1-96, hmac-ripemd160,
88957 *   hmac-ripemd160@openssh.com, and none**
88958 *
88959 *   Crypt and MAC method "none" For security reasons, none is disabled
88960 *   by the underlying libssh2 library unless explicitly enabled during
88961 *   build time by using the appropriate ./configure options. See
88962 *   documentation for the underlying library for more information.
88963 * @param array $callbacks {@link callbacks} may be an associative
88964 *   array with any or all of the following parameters. Callbacks
88965 *   parameters Index Meaning Prototype ignore Name of function to call
88966 *   when an SSH2_MSG_IGNORE packet is received void ignore_cb($message)
88967 *   debug Name of function to call when an SSH2_MSG_DEBUG packet is
88968 *   received void debug_cb($message, $language, $always_display)
88969 *   macerror Name of function to call when a packet is received but the
88970 *   message authentication code failed. If the callback returns TRUE,
88971 *   the mismatch will be ignored, otherwise the connection will be
88972 *   terminated. bool macerror_cb($packet) disconnect Name of function to
88973 *   call when an SSH2_MSG_DISCONNECT packet is received void
88974 *   disconnect_cb($reason, $message, $language)
88975 * @return resource Returns a resource on success, or FALSE on error.
88976 * @since PECL ssh2 >= 0.9.0
88977 **/
88978function ssh2_connect($host, $port, $methods, $callbacks){}
88979
88980/**
88981 * Close a connection to a remote SSH server
88982 *
88983 * @param resource $session An SSH connection link identifier, obtained
88984 *   from a call to {@link ssh2_connect}.
88985 * @return bool
88986 * @since PECL ssh2 >= 1.0
88987 **/
88988function ssh2_disconnect($session){}
88989
88990/**
88991 * Execute a command on a remote server
88992 *
88993 * Execute a command at the remote end and allocate a channel for it.
88994 *
88995 * @param resource $session An SSH connection link identifier, obtained
88996 *   from a call to {@link ssh2_connect}.
88997 * @param string $command
88998 * @param string $pty
88999 * @param array $env {@link env} may be passed as an associative array
89000 *   of name/value pairs to set in the target environment.
89001 * @param int $width Width of the virtual terminal.
89002 * @param int $height Height of the virtual terminal.
89003 * @param int $width_height_type {@link width_height_type} should be
89004 *   one of SSH2_TERM_UNIT_CHARS or SSH2_TERM_UNIT_PIXELS.
89005 * @return resource Returns a stream on success.
89006 * @since PECL ssh2 >= 0.9.0
89007 **/
89008function ssh2_exec($session, $command, $pty, $env, $width, $height, $width_height_type){}
89009
89010/**
89011 * Fetch an extended data stream
89012 *
89013 * Fetches an alternate substream associated with an SSH2 channel stream.
89014 * The SSH2 protocol currently defines only one substream, STDERR, which
89015 * has a substream ID of SSH2_STREAM_STDERR (defined as 1).
89016 *
89017 * @param resource $channel
89018 * @param int $streamid An SSH2 channel stream.
89019 * @return resource Returns the requested stream resource.
89020 * @since PECL ssh2 >= 0.9.0
89021 **/
89022function ssh2_fetch_stream($channel, $streamid){}
89023
89024/**
89025 * Retrieve fingerprint of remote server
89026 *
89027 * Returns a server hostkey hash from an active session.
89028 *
89029 * @param resource $session An SSH connection link identifier, obtained
89030 *   from a call to {@link ssh2_connect}.
89031 * @param int $flags {@link flags} may be either of
89032 *   SSH2_FINGERPRINT_MD5 or SSH2_FINGERPRINT_SHA1 logically ORed with
89033 *   SSH2_FINGERPRINT_HEX or SSH2_FINGERPRINT_RAW.
89034 * @return string Returns the hostkey hash as a string.
89035 * @since PECL ssh2 >= 0.9.0
89036 **/
89037function ssh2_fingerprint($session, $flags){}
89038
89039/**
89040 * Return list of negotiated methods
89041 *
89042 * Returns list of negotiated methods.
89043 *
89044 * @param resource $session An SSH connection link identifier, obtained
89045 *   from a call to {@link ssh2_connect}.
89046 * @return array
89047 * @since PECL ssh2 >= 0.9.0
89048 **/
89049function ssh2_methods_negotiated($session){}
89050
89051/**
89052 * Add an authorized publickey
89053 *
89054 * @param resource $pkey Publickey Subsystem resource created by {@link
89055 *   ssh2_publickey_init}.
89056 * @param string $algoname Publickey algorithm (e.g.): ssh-dss, ssh-rsa
89057 * @param string $blob Publickey blob as raw binary data
89058 * @param bool $overwrite If the specified key already exists, should
89059 *   it be overwritten?
89060 * @param array $attributes Associative array of attributes to assign
89061 *   to this public key. Refer to ietf-secsh-publickey-subsystem for a
89062 *   list of supported attributes. To mark an attribute as mandatory,
89063 *   precede its name with an asterisk. If the server is unable to
89064 *   support an attribute marked mandatory, it will abort the add
89065 *   process.
89066 * @return bool
89067 * @since PECL ssh2 >= 0.10
89068 **/
89069function ssh2_publickey_add($pkey, $algoname, $blob, $overwrite, $attributes){}
89070
89071/**
89072 * Initialize Publickey subsystem
89073 *
89074 * Request the Publickey subsystem from an already connected SSH2 server.
89075 *
89076 * The publickey subsystem allows an already connected and authenticated
89077 * client to manage the list of authorized public keys stored on the
89078 * target server in an implementation agnostic manner. If the remote
89079 * server does not support the publickey subsystem, the {@link
89080 * ssh2_publickey_init} function will return FALSE.
89081 *
89082 * @param resource $session
89083 * @return resource Returns an SSH2 Publickey Subsystem resource for
89084 *   use with all other ssh2_publickey_*() methods.
89085 * @since PECL ssh2 >= 0.10
89086 **/
89087function ssh2_publickey_init($session){}
89088
89089/**
89090 * List currently authorized publickeys
89091 *
89092 * List currently authorized publickeys.
89093 *
89094 * @param resource $pkey Publickey Subsystem resource
89095 * @return array Returns a numerically indexed array of keys, each of
89096 *   which is an associative array containing: name, blob, and attrs
89097 *   elements.
89098 * @since PECL ssh2 >= 0.10
89099 **/
89100function ssh2_publickey_list($pkey){}
89101
89102/**
89103 * Remove an authorized publickey
89104 *
89105 * Removes an authorized publickey.
89106 *
89107 * @param resource $pkey Publickey Subsystem Resource
89108 * @param string $algoname Publickey algorithm (e.g.): ssh-dss, ssh-rsa
89109 * @param string $blob Publickey blob as raw binary data
89110 * @return bool
89111 * @since PECL ssh2 >= 0.10
89112 **/
89113function ssh2_publickey_remove($pkey, $algoname, $blob){}
89114
89115/**
89116 * Request a file via SCP
89117 *
89118 * Copy a file from the remote server to the local filesystem using the
89119 * SCP protocol.
89120 *
89121 * @param resource $session An SSH connection link identifier, obtained
89122 *   from a call to {@link ssh2_connect}.
89123 * @param string $remote_file Path to the remote file.
89124 * @param string $local_file Path to the local file.
89125 * @return bool
89126 * @since PECL ssh2 >= 0.9.0
89127 **/
89128function ssh2_scp_recv($session, $remote_file, $local_file){}
89129
89130/**
89131 * Send a file via SCP
89132 *
89133 * Copy a file from the local filesystem to the remote server using the
89134 * SCP protocol.
89135 *
89136 * @param resource $session An SSH connection link identifier, obtained
89137 *   from a call to {@link ssh2_connect}.
89138 * @param string $local_file Path to the local file.
89139 * @param string $remote_file Path to the remote file.
89140 * @param int $create_mode The file will be created with the mode
89141 *   specified by {@link create_mode}.
89142 * @return bool
89143 * @since PECL ssh2 >= 0.9.0
89144 **/
89145function ssh2_scp_send($session, $local_file, $remote_file, $create_mode){}
89146
89147/**
89148 * Initialize SFTP subsystem
89149 *
89150 * Request the SFTP subsystem from an already connected SSH2 server.
89151 *
89152 * @param resource $session An SSH connection link identifier, obtained
89153 *   from a call to {@link ssh2_connect}.
89154 * @return resource This method returns an SSH2 SFTP resource for use
89155 *   with all other ssh2_sftp_*() methods and the ssh2.sftp:// fopen
89156 *   wrapper, .
89157 * @since PECL ssh2 >= 0.9.0
89158 **/
89159function ssh2_sftp($session){}
89160
89161/**
89162 * Changes file mode
89163 *
89164 * Attempts to change the mode of the specified file to that given in
89165 * {@link mode}.
89166 *
89167 * @param resource $sftp An SSH2 SFTP resource opened by {@link
89168 *   ssh2_sftp}.
89169 * @param string $filename Path to the file.
89170 * @param int $mode Permissions on the file. See the {@link chmod} for
89171 *   more details on this parameter.
89172 * @return bool
89173 * @since PECL ssh2 >= 0.12
89174 **/
89175function ssh2_sftp_chmod($sftp, $filename, $mode){}
89176
89177/**
89178 * Stat a symbolic link
89179 *
89180 * Stats a symbolic link on the remote filesystem without following the
89181 * link.
89182 *
89183 * This function is similar to using the {@link lstat} function with the
89184 * ssh2.sftp:// wrapper in PHP 5 and returns the same values.
89185 *
89186 * @param resource $sftp An SSH2 SFTP resource opened by {@link
89187 *   ssh2_sftp}.
89188 * @param string $path Path to the remote symbolic link.
89189 * @return array See the documentation for {@link stat} for details on
89190 *   the values which may be returned.
89191 * @since PECL ssh2 >= 0.9.0
89192 **/
89193function ssh2_sftp_lstat($sftp, $path){}
89194
89195/**
89196 * Create a directory
89197 *
89198 * Creates a directory on the remote file server with permissions set to
89199 * {@link mode}.
89200 *
89201 * This function is similar to using {@link mkdir} with the ssh2.sftp://
89202 * wrapper.
89203 *
89204 * @param resource $sftp An SSH2 SFTP resource opened by {@link
89205 *   ssh2_sftp}.
89206 * @param string $dirname Path of the new directory.
89207 * @param int $mode Permissions on the new directory.
89208 * @param bool $recursive If {@link recursive} is TRUE any parent
89209 *   directories required for {@link dirname} will be automatically
89210 *   created as well.
89211 * @return bool
89212 * @since PECL ssh2 >= 0.9.0
89213 **/
89214function ssh2_sftp_mkdir($sftp, $dirname, $mode, $recursive){}
89215
89216/**
89217 * Return the target of a symbolic link
89218 *
89219 * Returns the target of a symbolic link.
89220 *
89221 * @param resource $sftp An SSH2 SFTP resource opened by {@link
89222 *   ssh2_sftp}.
89223 * @param string $link Path of the symbolic link.
89224 * @return string Returns the target of the symbolic {@link link}.
89225 * @since PECL ssh2 >= 0.9.0
89226 **/
89227function ssh2_sftp_readlink($sftp, $link){}
89228
89229/**
89230 * Resolve the realpath of a provided path string
89231 *
89232 * Translates {@link filename} into the effective real path on the remote
89233 * filesystem.
89234 *
89235 * @param resource $sftp An SSH2 SFTP resource opened by {@link
89236 *   ssh2_sftp}.
89237 * @param string $filename
89238 * @return string Returns the real path as a string.
89239 * @since PECL ssh2 >= 0.9.0
89240 **/
89241function ssh2_sftp_realpath($sftp, $filename){}
89242
89243/**
89244 * Rename a remote file
89245 *
89246 * Renames a file on the remote filesystem.
89247 *
89248 * @param resource $sftp An SSH2 SFTP resource opened by {@link
89249 *   ssh2_sftp}.
89250 * @param string $from The current file that is being renamed.
89251 * @param string $to The new file name that replaces {@link from}.
89252 * @return bool
89253 * @since PECL ssh2 >= 0.9.0
89254 **/
89255function ssh2_sftp_rename($sftp, $from, $to){}
89256
89257/**
89258 * Remove a directory
89259 *
89260 * Removes a directory from the remote file server.
89261 *
89262 * This function is similar to using {@link rmdir} with the ssh2.sftp://
89263 * wrapper.
89264 *
89265 * @param resource $sftp An SSH2 SFTP resource opened by {@link
89266 *   ssh2_sftp}.
89267 * @param string $dirname
89268 * @return bool
89269 * @since PECL ssh2 >= 0.9.0
89270 **/
89271function ssh2_sftp_rmdir($sftp, $dirname){}
89272
89273/**
89274 * Stat a file on a remote filesystem
89275 *
89276 * Stats a file on the remote filesystem following any symbolic links.
89277 *
89278 * This function is similar to using the {@link stat} function with the
89279 * ssh2.sftp:// wrapper in PHP 5 and returns the same values.
89280 *
89281 * @param resource $sftp An SSH2 SFTP resource opened by {@link
89282 *   ssh2_sftp}.
89283 * @param string $path
89284 * @return array See the documentation for {@link stat} for details on
89285 *   the values which may be returned.
89286 * @since PECL ssh2 >= 0.9.0
89287 **/
89288function ssh2_sftp_stat($sftp, $path){}
89289
89290/**
89291 * Create a symlink
89292 *
89293 * Creates a symbolic link named {@link link} on the remote filesystem
89294 * pointing to {@link target}.
89295 *
89296 * @param resource $sftp An SSH2 SFTP resource opened by {@link
89297 *   ssh2_sftp}.
89298 * @param string $target Target of the symbolic link.
89299 * @param string $link
89300 * @return bool
89301 * @since PECL ssh2 >= 0.9.0
89302 **/
89303function ssh2_sftp_symlink($sftp, $target, $link){}
89304
89305/**
89306 * Delete a file
89307 *
89308 * Deletes a file on the remote filesystem.
89309 *
89310 * @param resource $sftp An SSH2 SFTP resource opened by {@link
89311 *   ssh2_sftp}.
89312 * @param string $filename
89313 * @return bool
89314 * @since PECL ssh2 >= 0.9.0
89315 **/
89316function ssh2_sftp_unlink($sftp, $filename){}
89317
89318/**
89319 * Request an interactive shell
89320 *
89321 * Open a shell at the remote end and allocate a stream for it.
89322 *
89323 * @param resource $session An SSH connection link identifier, obtained
89324 *   from a call to {@link ssh2_connect}.
89325 * @param string $term_type {@link term_type} should correspond to one
89326 *   of the entries in the target system's /etc/termcap file.
89327 * @param array $env {@link env} may be passed as an associative array
89328 *   of name/value pairs to set in the target environment.
89329 * @param int $width Width of the virtual terminal.
89330 * @param int $height Height of the virtual terminal.
89331 * @param int $width_height_type {@link width_height_type} should be
89332 *   one of SSH2_TERM_UNIT_CHARS or SSH2_TERM_UNIT_PIXELS.
89333 * @return resource
89334 * @since PECL ssh2 >= 0.9.0
89335 **/
89336function ssh2_shell($session, $term_type, $env, $width, $height, $width_height_type){}
89337
89338/**
89339 * Open a tunnel through a remote server
89340 *
89341 * Open a socket stream to an arbitrary host/port by way of the currently
89342 * connected SSH server.
89343 *
89344 * @param resource $session An SSH connection link identifier, obtained
89345 *   from a call to {@link ssh2_connect}.
89346 * @param string $host
89347 * @param int $port
89348 * @return resource
89349 * @since PECL ssh2 >= 0.9.0
89350 **/
89351function ssh2_tunnel($session, $host, $port){}
89352
89353/**
89354 * Gives information about a file
89355 *
89356 * Gathers the statistics of the file named by {@link filename}. If
89357 * {@link filename} is a symbolic link, statistics are from the file
89358 * itself, not the symlink. Prior to PHP 7.4.0, on Windows NTS builds the
89359 * size, atime, mtime and ctime statistics have been from the symlink, in
89360 * this case.
89361 *
89362 * {@link lstat} is identical to {@link stat} except it would instead be
89363 * based off the symlinks status.
89364 *
89365 * @param string $filename Path to the file.
89366 * @return array {@link stat} and {@link fstat} result format Numeric
89367 *   Associative Description 0 dev device number *** 1 ino inode number
89368 *   **** 2 mode inode protection mode 3 nlink number of links 4 uid
89369 *   userid of owner * 5 gid groupid of owner * 6 rdev device type, if
89370 *   inode device 7 size size in bytes 8 atime time of last access (Unix
89371 *   timestamp) 9 mtime time of last modification (Unix timestamp) 10
89372 *   ctime time of last inode change (Unix timestamp) 11 blksize
89373 *   blocksize of filesystem IO ** 12 blocks number of 512-byte blocks
89374 *   allocated **
89375 * @since PHP 4, PHP 5, PHP 7
89376 **/
89377function stat($filename){}
89378
89379/**
89380 * Returns the absolute deviation of an array of values
89381 *
89382 * Returns the absolute deviation of the values in {@link a}.
89383 *
89384 * @param array $a The input array
89385 * @return float Returns the absolute deviation of the values in {@link
89386 *   a}, or FALSE if {@link a} is empty or is not an array.
89387 * @since PECL stats >= 1.0.0
89388 **/
89389function stats_absolute_deviation($a){}
89390
89391/**
89392 * Calculates any one parameter of the beta distribution given values for
89393 * the others
89394 *
89395 * Returns the cumulative distribution function, its inverse, or one of
89396 * its parameters, of the beta distribution. The kind of the return value
89397 * and parameters ({@link par1}, {@link par2}, and {@link par3}) are
89398 * determined by {@link which}.
89399 *
89400 * The following table lists the return value and parameters by {@link
89401 * which}. CDF, x, alpha, and beta denotes cumulative distribution
89402 * function, the value of the random variable, and shape parameters of
89403 * the beta distribution, respectively. Return value and parameters
89404 * {@link which} Return value {@link par1} {@link par2} {@link par3} 1
89405 * CDF x alpha beta 2 x CDF alpha beta 3 alpha x CDF beta 4 beta x CDF
89406 * alpha
89407 *
89408 * @param float $par1 The first parameter
89409 * @param float $par2 The second parameter
89410 * @param float $par3 The third parameter
89411 * @param int $which The flag to determine what to be calculated
89412 * @return float Returns CDF, x, alpha, or beta, determined by {@link
89413 *   which}.
89414 * @since PECL stats >= 1.0.0
89415 **/
89416function stats_cdf_beta($par1, $par2, $par3, $which){}
89417
89418/**
89419 * Calculates any one parameter of the binomial distribution given values
89420 * for the others
89421 *
89422 * Returns the cumulative distribution function, its inverse, or one of
89423 * its parameters, of the binomial distribution. The kind of the return
89424 * value and parameters ({@link par1}, {@link par2}, and {@link par3})
89425 * are determined by {@link which}.
89426 *
89427 * The following table lists the return value and parameters by {@link
89428 * which}. CDF, x, n, and p denotes cumulative distribution function, the
89429 * number of successes, the number of trials, and the success rate for
89430 * each trial, respectively. Return value and parameters {@link which}
89431 * Return value {@link par1} {@link par2} {@link par3} 1 CDF x n p 2 x
89432 * CDF n p 3 n x CDF p 4 p x CDF n
89433 *
89434 * @param float $par1 The first parameter
89435 * @param float $par2 The second parameter
89436 * @param float $par3 The third parameter
89437 * @param int $which The flag to determine what to be calculated
89438 * @return float Returns CDF, x, n, or p, determined by {@link which}.
89439 * @since PECL stats >= 1.0.0
89440 **/
89441function stats_cdf_binomial($par1, $par2, $par3, $which){}
89442
89443/**
89444 * Calculates any one parameter of the Cauchy distribution given values
89445 * for the others
89446 *
89447 * Returns the cumulative distribution function, its inverse, or one of
89448 * its parameters, of the Cauchy distribution. The kind of the return
89449 * value and parameters ({@link par1}, {@link par2}, and {@link par3})
89450 * are determined by {@link which}.
89451 *
89452 * The following table lists the return value and parameters by {@link
89453 * which}. CDF, x, x0, and gamma denotes cumulative distribution
89454 * function, the value of the random variable, the location and the scale
89455 * parameter of the Cauchy distribution, respectively. Return value and
89456 * parameters {@link which} Return value {@link par1} {@link par2} {@link
89457 * par3} 1 CDF x x0 gamma 2 x CDF x0 gamma 3 x0 x CDF gamma 4 gamma x CDF
89458 * x0
89459 *
89460 * @param float $par1 The first parameter
89461 * @param float $par2 The second parameter
89462 * @param float $par3 The third parameter
89463 * @param int $which The flag to determine what to be calculated
89464 * @return float Returns CDF, x, x0, or gamma, determined by {@link
89465 *   which}.
89466 * @since PECL stats >= 1.0.0
89467 **/
89468function stats_cdf_cauchy($par1, $par2, $par3, $which){}
89469
89470/**
89471 * Calculates any one parameter of the chi-square distribution given
89472 * values for the others
89473 *
89474 * Returns the cumulative distribution function, its inverse, or one of
89475 * its parameters, of the chi-square distribution. The kind of the return
89476 * value and parameters ({@link par1} and {@link par2}) are determined by
89477 * {@link which}.
89478 *
89479 * The following table lists the return value and parameters by {@link
89480 * which}. CDF, x, and k denotes cumulative distribution function, the
89481 * value of the random variable, and the degree of freedom of the
89482 * chi-square distribution, respectively. Return value and parameters
89483 * {@link which} Return value {@link par1} {@link par2} 1 CDF x k 2 x CDF
89484 * k 3 k x CDF
89485 *
89486 * @param float $par1 The first parameter
89487 * @param float $par2 The second parameter
89488 * @param int $which The flag to determine what to be calculated
89489 * @return float Returns CDF, x, or k, determined by {@link which}.
89490 * @since PECL stats >= 1.0.0
89491 **/
89492function stats_cdf_chisquare($par1, $par2, $which){}
89493
89494/**
89495 * Calculates any one parameter of the exponential distribution given
89496 * values for the others
89497 *
89498 * Returns the cumulative distribution function, its inverse, or one of
89499 * its parameters, of the exponential distribution. The kind of the
89500 * return value and parameters ({@link par1} and {@link par2}) are
89501 * determined by {@link which}.
89502 *
89503 * The following table lists the return value and parameters by {@link
89504 * which}. CDF, x, and lambda denotes cumulative distribution function,
89505 * the value of the random variable, and the rate parameter of the
89506 * exponential distribution, respectively. Return value and parameters
89507 * {@link which} Return value {@link par1} {@link par2} 1 CDF x lambda 2
89508 * x CDF lambda 3 lambda x CDF
89509 *
89510 * @param float $par1 The first parameter
89511 * @param float $par2 The second parameter
89512 * @param int $which The flag to determine what to be calculated
89513 * @return float Returns CDF, x, or lambda, determined by {@link
89514 *   which}.
89515 * @since PECL stats >= 1.0.0
89516 **/
89517function stats_cdf_exponential($par1, $par2, $which){}
89518
89519/**
89520 * Calculates any one parameter of the F distribution given values for
89521 * the others
89522 *
89523 * Returns the cumulative distribution function, its inverse, or one of
89524 * its parameters, of the F distribution. The kind of the return value
89525 * and parameters ({@link par1}, {@link par2}, and {@link par3}) are
89526 * determined by {@link which}.
89527 *
89528 * The following table lists the return value and parameters by {@link
89529 * which}. CDF, x, d1, and d2 denotes cumulative distribution function,
89530 * the value of the random variable, and the degree of freedoms of the F
89531 * distribution, respectively. Return value and parameters {@link which}
89532 * Return value {@link par1} {@link par2} {@link par3} 1 CDF x d1 d2 2 x
89533 * CDF d1 d2 3 d1 x CDF d2 4 d2 x CDF d1
89534 *
89535 * @param float $par1 The first parameter
89536 * @param float $par2 The second parameter
89537 * @param float $par3 The third parameter
89538 * @param int $which The flag to determine what to be calculated
89539 * @return float Returns CDF, x, d1, or d2, determined by {@link
89540 *   which}.
89541 * @since PECL stats >= 1.0.0
89542 **/
89543function stats_cdf_f($par1, $par2, $par3, $which){}
89544
89545/**
89546 * Calculates any one parameter of the gamma distribution given values
89547 * for the others
89548 *
89549 * Returns the cumulative distribution function, its inverse, or one of
89550 * its parameters, of the gamma distribution. The kind of the return
89551 * value and parameters ({@link par1}, {@link par2}, and {@link par3})
89552 * are determined by {@link which}.
89553 *
89554 * The following table lists the return value and parameters by {@link
89555 * which}. CDF, x, k, and theta denotes cumulative distribution function,
89556 * the value of the random variable, and the shape and the scale
89557 * parameter of the gamma distribution, respectively. Return value and
89558 * parameters {@link which} Return value {@link par1} {@link par2} {@link
89559 * par3} 1 CDF x k theta 2 x CDF k theta 3 k x CDF theta 4 theta x CDF k
89560 *
89561 * @param float $par1 The first parameter
89562 * @param float $par2 The second parameter
89563 * @param float $par3 The third parameter
89564 * @param int $which The flag to determine what to be calculated
89565 * @return float Returns CDF, x, k, or theta, determined by {@link
89566 *   which}.
89567 * @since PECL stats >= 1.0.0
89568 **/
89569function stats_cdf_gamma($par1, $par2, $par3, $which){}
89570
89571/**
89572 * Calculates any one parameter of the Laplace distribution given values
89573 * for the others
89574 *
89575 * Returns the cumulative distribution function, its inverse, or one of
89576 * its parameters, of the Laplace distribution. The kind of the return
89577 * value and parameters ({@link par1}, {@link par2}, and {@link par3})
89578 * are determined by {@link which}.
89579 *
89580 * The following table lists the return value and parameters by {@link
89581 * which}. CDF, x, mu, and b denotes cumulative distribution function,
89582 * the value of the random variable, and the location and the scale
89583 * parameter of the Laplace distribution, respectively. Return value and
89584 * parameters {@link which} Return value {@link par1} {@link par2} {@link
89585 * par3} 1 CDF x mu b 2 x CDF mu b 3 mu x CDF b 4 b x CDF mu
89586 *
89587 * @param float $par1 The first parameter
89588 * @param float $par2 The second parameter
89589 * @param float $par3 The third parameter
89590 * @param int $which The flag to determine what to be calculated
89591 * @return float Returns CDF, x, mu, or b, determined by {@link which}.
89592 * @since PECL stats >= 1.0.0
89593 **/
89594function stats_cdf_laplace($par1, $par2, $par3, $which){}
89595
89596/**
89597 * Calculates any one parameter of the logistic distribution given values
89598 * for the others
89599 *
89600 * Returns the cumulative distribution function, its inverse, or one of
89601 * its parameters, of the logistic distribution. The kind of the return
89602 * value and parameters ({@link par1}, {@link par2}, and {@link par3})
89603 * are determined by {@link which}.
89604 *
89605 * The following table lists the return value and parameters by {@link
89606 * which}. CDF, x, mu, and s denotes cumulative distribution function,
89607 * the value of the random variable, and the location and the scale
89608 * parameter of the logistic distribution, respectively. Return value and
89609 * parameters {@link which} Return value {@link par1} {@link par2} {@link
89610 * par3} 1 CDF x mu s 2 x CDF mu s 3 mu x CDF s 4 s x CDF mu
89611 *
89612 * @param float $par1 The first parameter
89613 * @param float $par2 The second parameter
89614 * @param float $par3 The third parameter
89615 * @param int $which The flag to determine what to be calculated
89616 * @return float Returns CDF, x, mu, or s, determined by {@link which}.
89617 * @since PECL stats >= 1.0.0
89618 **/
89619function stats_cdf_logistic($par1, $par2, $par3, $which){}
89620
89621/**
89622 * Calculates any one parameter of the negative binomial distribution
89623 * given values for the others
89624 *
89625 * Returns the cumulative distribution function, its inverse, or one of
89626 * its parameters, of the negative binomial distribution. The kind of the
89627 * return value and parameters ({@link par1}, {@link par2}, and {@link
89628 * par3}) are determined by {@link which}.
89629 *
89630 * The following table lists the return value and parameters by {@link
89631 * which}. CDF, x, r, and p denotes cumulative distribution function, the
89632 * number of failure, the number of success, and the success rate for
89633 * each trial, respectively. Return value and parameters {@link which}
89634 * Return value {@link par1} {@link par2} {@link par3} 1 CDF x r p 2 x
89635 * CDF r p 3 r x CDF p 4 p x CDF r
89636 *
89637 * @param float $par1 The first parameter
89638 * @param float $par2 The second parameter
89639 * @param float $par3 The third parameter
89640 * @param int $which The flag to determine what to be calculated
89641 * @return float Returns CDF, x, r, or p, determined by {@link which}.
89642 * @since PECL stats >= 1.0.0
89643 **/
89644function stats_cdf_negative_binomial($par1, $par2, $par3, $which){}
89645
89646/**
89647 * Calculates any one parameter of the non-central chi-square
89648 * distribution given values for the others
89649 *
89650 * Returns the cumulative distribution function, its inverse, or one of
89651 * its parameters, of the non-central chi-square distribution. The kind
89652 * of the return value and parameters ({@link par1}, {@link par2}, and
89653 * {@link par3}) are determined by {@link which}.
89654 *
89655 * The following table lists the return value and parameters by {@link
89656 * which}. CDF, x, k, and lambda denotes cumulative distribution
89657 * function, the value of the random variable, the degree of freedom and
89658 * the non-centrality parameter of the distribution, respectively. Return
89659 * value and parameters {@link which} Return value {@link par1} {@link
89660 * par2} {@link par3} 1 CDF x k lambda 2 x CDF k lambda 3 k x CDF lambda
89661 * 4 lambda x CDF k
89662 *
89663 * @param float $par1 The first parameter
89664 * @param float $par2 The second parameter
89665 * @param float $par3 The third parameter
89666 * @param int $which The flag to determine what to be calculated
89667 * @return float Returns CDF, x, k, or lambda, determined by {@link
89668 *   which}.
89669 * @since PECL stats >= 1.0.0
89670 **/
89671function stats_cdf_noncentral_chisquare($par1, $par2, $par3, $which){}
89672
89673/**
89674 * Calculates any one parameter of the non-central F distribution given
89675 * values for the others
89676 *
89677 * Returns the cumulative distribution function, its inverse, or one of
89678 * its parameters, of the non-central F distribution. The kind of the
89679 * return value and parameters ({@link par1}, {@link par2}, {@link par3},
89680 * and {@link par4}) are determined by {@link which}.
89681 *
89682 * The following table lists the return value and parameters by {@link
89683 * which}. CDF, x, nu1, nu2, and lambda denotes cumulative distribution
89684 * function, the value of the random variable, the degree of freedoms and
89685 * the non-centrality parameter of the distribution, respectively. Return
89686 * value and parameters {@link which} Return value {@link par1} {@link
89687 * par2} {@link par3} {@link par4} 1 CDF x nu1 nu2 lambda 2 x CDF nu1 nu2
89688 * lambda 3 nu1 x CDF nu2 lambda 4 nu2 x CDF nu1 lambda 5 lambda x CDF
89689 * nu1 nu2
89690 *
89691 * @param float $par1 The first parameter
89692 * @param float $par2 The second parameter
89693 * @param float $par3 The third parameter
89694 * @param float $par4 The fourth parameter
89695 * @param int $which The flag to determine what to be calculated
89696 * @return float Returns CDF, x, nu1, nu2, or lambda, determined by
89697 *   {@link which}.
89698 * @since PECL stats >= 1.0.0
89699 **/
89700function stats_cdf_noncentral_f($par1, $par2, $par3, $par4, $which){}
89701
89702/**
89703 * Calculates any one parameter of the non-central t-distribution give
89704 * values for the others
89705 *
89706 * Returns the cumulative distribution function, its inverse, or one of
89707 * its parameters, of the non-central t-distribution. The kind of the
89708 * return value and parameters ({@link par1}, {@link par2}, and {@link
89709 * par3}) are determined by {@link which}.
89710 *
89711 * The following table lists the return value and parameters by {@link
89712 * which}. CDF, x, nu, and mu denotes cumulative distribution function,
89713 * the value of the random variable, the degrees of freedom and the
89714 * non-centrality parameter of the distribution, respectively. Return
89715 * value and parameters {@link which} Return value {@link par1} {@link
89716 * par2} {@link par3} 1 CDF x nu mu 2 x CDF nu mu 3 nu x CDF mu 4 mu x
89717 * CDF nu
89718 *
89719 * @param float $par1 The first parameter
89720 * @param float $par2 The second parameter
89721 * @param float $par3 The third parameter
89722 * @param int $which The flag to determine what to be calculated
89723 * @return float Returns CDF, x, nu, or mu, determined by {@link
89724 *   which}.
89725 * @since PECL stats >= 1.0.0
89726 **/
89727function stats_cdf_noncentral_t($par1, $par2, $par3, $which){}
89728
89729/**
89730 * Calculates any one parameter of the normal distribution given values
89731 * for the others
89732 *
89733 * Returns the cumulative distribution function, its inverse, or one of
89734 * its parameters, of the normal distribution. The kind of the return
89735 * value and parameters ({@link par1}, {@link par2}, and {@link par3})
89736 * are determined by {@link which}.
89737 *
89738 * The following table lists the return value and parameters by {@link
89739 * which}. CDF, x, mu, and sigma denotes cumulative distribution
89740 * function, the value of the random variable, the mean and the standard
89741 * deviation of the normal distribution, respectively. Return value and
89742 * parameters {@link which} Return value {@link par1} {@link par2} {@link
89743 * par3} 1 CDF x mu sigma 2 x CDF mu sigma 3 mu x CDF sigma 4 sigma x CDF
89744 * mu
89745 *
89746 * @param float $par1 The first parameter
89747 * @param float $par2 The second parameter
89748 * @param float $par3 The third parameter
89749 * @param int $which The flag to determine what to be calculated
89750 * @return float Returns CDF, x, mu, or sigma, determined by {@link
89751 *   which}.
89752 * @since PECL stats >= 1.0.0
89753 **/
89754function stats_cdf_normal($par1, $par2, $par3, $which){}
89755
89756/**
89757 * Calculates any one parameter of the Poisson distribution given values
89758 * for the others
89759 *
89760 * Returns the cumulative distribution function, its inverse, or one of
89761 * its parameters, of the Poisson distribution. The kind of the return
89762 * value and parameters ({@link par1} and {@link par2}) are determined by
89763 * {@link which}.
89764 *
89765 * The following table lists the return value and parameters by {@link
89766 * which}. CDF, x, and lambda denotes cumulative distribution function,
89767 * the value of the random variable, and the parameter of the Poisson
89768 * distribution, respectively. Return value and parameters {@link which}
89769 * Return value {@link par1} {@link par2} 1 CDF x lambda 2 x CDF lambda 3
89770 * lambda x CDF
89771 *
89772 * @param float $par1 The first parameter
89773 * @param float $par2 The second parameter
89774 * @param int $which The flag to determine what to be calculated
89775 * @return float Returns CDF, x, or lambda, determined by {@link
89776 *   which}.
89777 * @since PECL stats >= 1.0.0
89778 **/
89779function stats_cdf_poisson($par1, $par2, $which){}
89780
89781/**
89782 * Calculates any one parameter of the t-distribution given values for
89783 * the others
89784 *
89785 * Returns the cumulative distribution function, its inverse, or one of
89786 * its parameters, of the t-distribution. The kind of the return value
89787 * and parameters ({@link par1} and {@link par2}) are determined by
89788 * {@link which}.
89789 *
89790 * The following table lists the return value and parameters by {@link
89791 * which}. CDF, x, and nu denotes cumulative distribution function, the
89792 * value of the random variable, and the degrees of freedom of the
89793 * t-distribution, respectively. Return value and parameters {@link
89794 * which} Return value {@link par1} {@link par2} 1 CDF x nu 2 x CDF nu 3
89795 * nu x CDF
89796 *
89797 * @param float $par1 The first parameter
89798 * @param float $par2 The second parameter
89799 * @param int $which The flag to determine what to be calculated
89800 * @return float Returns CDF, x, or nu, determined by {@link which}.
89801 * @since PECL stats >= 1.0.0
89802 **/
89803function stats_cdf_t($par1, $par2, $which){}
89804
89805/**
89806 * Calculates any one parameter of the uniform distribution given values
89807 * for the others
89808 *
89809 * Returns the cumulative distribution function, its inverse, or one of
89810 * its parameters, of the uniform distribution. The kind of the return
89811 * value and parameters ({@link par1}, {@link par2}, and {@link par3})
89812 * are determined by {@link which}.
89813 *
89814 * The following table lists the return value and parameters by {@link
89815 * which}. CDF, x, a, and b denotes cumulative distribution function, the
89816 * value of the random variable, the lower bound and the higher bound of
89817 * the uniform distribution, respectively. Return value and parameters
89818 * {@link which} Return value {@link par1} {@link par2} {@link par3} 1
89819 * CDF x a b 2 x CDF a b 3 a x CDF b 4 b x CDF a
89820 *
89821 * @param float $par1 The first parameter
89822 * @param float $par2 The second parameter
89823 * @param float $par3 The third parameter
89824 * @param int $which The flag to determine what to be calculated
89825 * @return float Returns CDF, x, a, or b, determined by {@link which}.
89826 * @since PECL stats >= 1.0.0
89827 **/
89828function stats_cdf_uniform($par1, $par2, $par3, $which){}
89829
89830/**
89831 * Calculates any one parameter of the Weibull distribution given values
89832 * for the others
89833 *
89834 * Returns the cumulative distribution function, its inverse, or one of
89835 * its parameters, of the Weibull distribution. The kind of the return
89836 * value and parameters ({@link par1}, {@link par2}, and {@link par3})
89837 * are determined by {@link which}.
89838 *
89839 * The following table lists the return value and parameters by {@link
89840 * which}. CDF, x, k, and lambda denotes cumulative distribution
89841 * function, the value of the random variable, the shape and the scale
89842 * parameter of the Weibull distribution, respectively. Return value and
89843 * parameters {@link which} Return value {@link par1} {@link par2} {@link
89844 * par3} 1 CDF x k lambda 2 x CDF k lambda 3 k x CDF lambda 4 lambda x
89845 * CDF k
89846 *
89847 * @param float $par1 The first parameter
89848 * @param float $par2 The second parameter
89849 * @param float $par3 The third parameter
89850 * @param int $which The flag to determine what to be calculated
89851 * @return float Returns CDF, x, k, or lambda, determined by {@link
89852 *   which}.
89853 * @since PECL stats >= 1.0.0
89854 **/
89855function stats_cdf_weibull($par1, $par2, $par3, $which){}
89856
89857/**
89858 * Computes the covariance of two data sets
89859 *
89860 * Returns the covariance of {@link a} and {@link b}.
89861 *
89862 * @param array $a The first array
89863 * @param array $b The second array
89864 * @return float Returns the covariance of {@link a} and {@link b}, or
89865 *   FALSE on failure.
89866 * @since PECL stats >= 1.0.0
89867 **/
89868function stats_covariance($a, $b){}
89869
89870/**
89871 * Probability density function of the beta distribution
89872 *
89873 * Returns the probability density at {@link x}, where the random
89874 * variable follows the beta distribution of which the shape parameters
89875 * are {@link a} and {@link b}.
89876 *
89877 * @param float $x The value at which the probability density is
89878 *   calculated
89879 * @param float $a The shape parameter of the distribution
89880 * @param float $b The shape parameter of the distribution
89881 * @return float The probability density at {@link x} or FALSE for
89882 *   failure.
89883 * @since PECL stats >= 1.0.0
89884 **/
89885function stats_dens_beta($x, $a, $b){}
89886
89887/**
89888 * Probability density function of the Cauchy distribution
89889 *
89890 * Returns the probability density at {@link x}, where the random
89891 * variable follows the Cauchy distribution whose location and scale are
89892 * {@link ave} and {@link stdev}, respectively.
89893 *
89894 * @param float $x The value at which the probability density is
89895 *   calculated
89896 * @param float $ave The location parameter of the distribution
89897 * @param float $stdev The scale parameter of the distribution
89898 * @return float The probability density at {@link x} or FALSE for
89899 *   failure.
89900 * @since PECL stats >= 1.0.0
89901 **/
89902function stats_dens_cauchy($x, $ave, $stdev){}
89903
89904/**
89905 * Probability density function of the chi-square distribution
89906 *
89907 * Returns the probability density at {@link x}, where the random
89908 * variable follows the chi-square distribution of which the degree of
89909 * freedom is {@link dfr}.
89910 *
89911 * @param float $x The value at which the probability density is
89912 *   calculated
89913 * @param float $dfr The degree of freedom of the distribution
89914 * @return float The probability density at {@link x} or FALSE for
89915 *   failure.
89916 * @since PECL stats >= 1.0.0
89917 **/
89918function stats_dens_chisquare($x, $dfr){}
89919
89920/**
89921 * Probability density function of the exponential distribution
89922 *
89923 * Returns the probability density at {@link x}, where the random
89924 * variable follows the exponential distribution of which the scale is
89925 * {@link scale}.
89926 *
89927 * @param float $x The value at which the probability density is
89928 *   calculated
89929 * @param float $scale The scale of the distribution
89930 * @return float The probability density at {@link x} or FALSE for
89931 *   failure.
89932 * @since PECL stats >= 1.0.0
89933 **/
89934function stats_dens_exponential($x, $scale){}
89935
89936/**
89937 * Probability density function of the F distribution
89938 *
89939 * Returns the probability density at {@link x}, where the random
89940 * variable follows the F distribution of which the degree of freedoms
89941 * are {@link dfr1} and {@link dfr2}.
89942 *
89943 * @param float $x The value at which the probability density is
89944 *   calculated
89945 * @param float $dfr1 The degree of freedom of the distribution
89946 * @param float $dfr2 The degree of freedom of the distribution
89947 * @return float The probability density at {@link x} or FALSE for
89948 *   failure.
89949 * @since PECL stats >= 1.0.0
89950 **/
89951function stats_dens_f($x, $dfr1, $dfr2){}
89952
89953/**
89954 * Probability density function of the gamma distribution
89955 *
89956 * Returns the probability density at {@link x}, where the random
89957 * variable follows the gamma distribution of which the shape parameter
89958 * is {@link shape} and the scale parameter is {@link scale}.
89959 *
89960 * @param float $x The value at which the probability density is
89961 *   calculated
89962 * @param float $shape The shape parameter of the distribution
89963 * @param float $scale The scale parameter of the distribution
89964 * @return float The probability density at {@link x} or FALSE for
89965 *   failure.
89966 * @since PECL stats >= 1.0.0
89967 **/
89968function stats_dens_gamma($x, $shape, $scale){}
89969
89970/**
89971 * Probability density function of the Laplace distribution
89972 *
89973 * Returns the probability density at {@link x}, where the random
89974 * variable follows the Laplace distribution of which the location
89975 * parameter is {@link ave} and the scale parameter is {@link stdev}.
89976 *
89977 * @param float $x The value at which the probability density is
89978 *   calculated
89979 * @param float $ave The location parameter of the distribution
89980 * @param float $stdev The shape parameter of the distribution
89981 * @return float The probability density at {@link x} or FALSE for
89982 *   failure.
89983 * @since PECL stats >= 1.0.0
89984 **/
89985function stats_dens_laplace($x, $ave, $stdev){}
89986
89987/**
89988 * Probability density function of the logistic distribution
89989 *
89990 * Returns the probability density at {@link x}, where the random
89991 * variable follows the logistic distribution of which the location
89992 * parameter is {@link ave} and the scale parameter is {@link stdev}.
89993 *
89994 * @param float $x The value at which the probability density is
89995 *   calculated
89996 * @param float $ave The location parameter of the distribution
89997 * @param float $stdev The shape parameter of the distribution
89998 * @return float The probability density at {@link x} or FALSE for
89999 *   failure.
90000 * @since PECL stats >= 1.0.0
90001 **/
90002function stats_dens_logistic($x, $ave, $stdev){}
90003
90004/**
90005 * Probability density function of the normal distribution
90006 *
90007 * Returns the probability density at {@link x}, where the random
90008 * variable follows the normal distribution of which the mean is {@link
90009 * ave} and the standard deviation is {@link stdev}.
90010 *
90011 * @param float $x The value at which the probability density is
90012 *   calculated
90013 * @param float $ave The mean of the distribution
90014 * @param float $stdev The standard deviation of the distribution
90015 * @return float The probability density at {@link x} or FALSE for
90016 *   failure.
90017 * @since PECL stats >= 1.0.0
90018 **/
90019function stats_dens_normal($x, $ave, $stdev){}
90020
90021/**
90022 * Probability mass function of the binomial distribution
90023 *
90024 * Returns the probability mass at {@link x}, where the random variable
90025 * follows the binomial distribution of which the number of trials is
90026 * {@link n} and the success rate is {@link pi}.
90027 *
90028 * @param float $x The value at which the probability mass is
90029 *   calculated
90030 * @param float $n The number of trials of the distribution
90031 * @param float $pi The success rate of the distribution
90032 * @return float The probability mass at {@link x} or FALSE for
90033 *   failure.
90034 * @since PECL stats >= 1.0.0
90035 **/
90036function stats_dens_pmf_binomial($x, $n, $pi){}
90037
90038/**
90039 * Probability mass function of the hypergeometric distribution
90040 *
90041 * Returns the probability mass at {@link n1}, where the random variable
90042 * follows the hypergeometric distribution of which the number of failure
90043 * is {@link n2}, the number of success samples is {@link N1}, and the
90044 * number of failure samples is {@link N2}.
90045 *
90046 * @param float $n1 The number of success, at which the probability
90047 *   mass is calculated
90048 * @param float $n2 The number of failure of the distribution
90049 * @param float $N1 The number of success samples of the distribution
90050 * @param float $N2 The number of failure samples of the distribution
90051 * @return float The probability mass at {@link n1} or FALSE for
90052 *   failure.
90053 * @since PECL stats >= 1.0.0
90054 **/
90055function stats_dens_pmf_hypergeometric($n1, $n2, $N1, $N2){}
90056
90057/**
90058 * Probability mass function of the negative binomial distribution
90059 *
90060 * Returns the probability mass at {@link x}, where the random variable
90061 * follows the negative binomial distribution of which the number of the
90062 * success is {@link n} and the success rate is {@link pi}.
90063 *
90064 * @param float $x The value at which the probability mass is
90065 *   calculated
90066 * @param float $n The number of the success of the distribution
90067 * @param float $pi The success rate of the distribution
90068 * @return float The probability mass at {@link x} or FALSE for
90069 *   failure.
90070 * @since PECL stats >= 1.0.0
90071 **/
90072function stats_dens_pmf_negative_binomial($x, $n, $pi){}
90073
90074/**
90075 * Probability mass function of the Poisson distribution
90076 *
90077 * Returns the probability mass at {@link x}, where the random variable
90078 * follows the Poisson distribution whose parameter is {@link lb}.
90079 *
90080 * @param float $x The value at which the probability mass is
90081 *   calculated
90082 * @param float $lb The parameter of the Poisson distribution
90083 * @return float The probability mass at {@link x} or FALSE for
90084 *   failure.
90085 * @since PECL stats >= 1.0.0
90086 **/
90087function stats_dens_pmf_poisson($x, $lb){}
90088
90089/**
90090 * Probability density function of the t-distribution
90091 *
90092 * Returns the probability density at {@link x}, where the random
90093 * variable follows the t-distribution of which the degree of freedom is
90094 * {@link dfr}.
90095 *
90096 * @param float $x The value at which the probability density is
90097 *   calculated
90098 * @param float $dfr The degree of freedom of the distribution
90099 * @return float The probability density at {@link x} or FALSE for
90100 *   failure.
90101 * @since PECL stats >= 1.0.0
90102 **/
90103function stats_dens_t($x, $dfr){}
90104
90105/**
90106 * Probability density function of the uniform distribution
90107 *
90108 * Returns the probability density at {@link x}, where the random
90109 * variable follows the uniform distribution of which the lower bound is
90110 * {@link a} and the upper bound is {@link b}.
90111 *
90112 * @param float $x The value at which the probability density is
90113 *   calculated
90114 * @param float $a The lower bound of the distribution
90115 * @param float $b The upper bound of the distribution
90116 * @return float The probability density at {@link x} or FALSE for
90117 *   failure.
90118 * @since PECL stats >= 1.0.0
90119 **/
90120function stats_dens_uniform($x, $a, $b){}
90121
90122/**
90123 * Probability density function of the Weibull distribution
90124 *
90125 * Returns the probability density at {@link x}, where the random
90126 * variable follows the Weibull distribution of which the shape parameter
90127 * is {@link a} and the scale parameter is {@link b}.
90128 *
90129 * @param float $x The value at which the probability density is
90130 *   calculated
90131 * @param float $a The shape parameter of the distribution
90132 * @param float $b The scale parameter of the distribution
90133 * @return float The probability density at {@link x} or FALSE for
90134 *   failure.
90135 * @since PECL stats >= 1.0.0
90136 **/
90137function stats_dens_weibull($x, $a, $b){}
90138
90139/**
90140 * Returns the harmonic mean of an array of values
90141 *
90142 * Returns the harmonic mean of the values in {@link a}.
90143 *
90144 * @param array $a The input array
90145 * @return number Returns the harmonic mean of the values in {@link a},
90146 *   or FALSE if {@link a} is empty or is not an array.
90147 * @since PECL stats >= 1.0.0
90148 **/
90149function stats_harmonic_mean($a){}
90150
90151/**
90152 * Computes the kurtosis of the data in the array
90153 *
90154 * Returns the kurtosis of the values in {@link a}.
90155 *
90156 * @param array $a The input array
90157 * @return float Returns the kurtosis of the values in {@link a}, or
90158 *   FALSE if {@link a} is empty or is not an array.
90159 * @since PECL stats >= 1.0.0
90160 **/
90161function stats_kurtosis($a){}
90162
90163/**
90164 * Generates a random deviate from the beta distribution
90165 *
90166 * Returns a random deviate from the beta distribution with parameters A
90167 * and B. The density of the beta is x^(a-1) * (1-x)^(b-1) / B(a,b) for 0
90168 * < x <. Method R. C. H. Cheng.
90169 *
90170 * @param float $a The shape parameter of the beta distribution
90171 * @param float $b The shape parameter of the beta distribution
90172 * @return float A random deviate
90173 * @since PECL stats >= 1.0.0
90174 **/
90175function stats_rand_gen_beta($a, $b){}
90176
90177/**
90178 * Generates a random deviate from the chi-square distribution
90179 *
90180 * Returns a random deviate from the chi-square distribution where the
90181 * degrees of freedom is {@link df}.
90182 *
90183 * @param float $df The degrees of freedom
90184 * @return float A random deviate
90185 * @since PECL stats >= 1.0.0
90186 **/
90187function stats_rand_gen_chisquare($df){}
90188
90189/**
90190 * Generates a random deviate from the exponential distribution
90191 *
90192 * Returns a random deviate from the exponential distribution of which
90193 * the scale is {@link av}.
90194 *
90195 * @param float $av The scale parameter
90196 * @return float A random deviate
90197 * @since PECL stats >= 1.0.0
90198 **/
90199function stats_rand_gen_exponential($av){}
90200
90201/**
90202 * Generates a random deviate from the F distribution
90203 *
90204 * Generates a random deviate from the F (variance ratio) distribution
90205 * with "dfn" degrees of freedom in the numerator and "dfd" degrees of
90206 * freedom in the denominator. Method : directly generates ratio of
90207 * chisquare variates.
90208 *
90209 * @param float $dfn The degrees of freedom in the numerator
90210 * @param float $dfd The degrees of freedom in the denominator
90211 * @return float A random deviate
90212 * @since PECL stats >= 1.0.0
90213 **/
90214function stats_rand_gen_f($dfn, $dfd){}
90215
90216/**
90217 * Generates uniform float between low (exclusive) and high (exclusive)
90218 *
90219 * Returns a random deviate from the uniform distribution from {@link
90220 * low} to {@link high}.
90221 *
90222 * @param float $low The lower bound (inclusive)
90223 * @param float $high The upper bound (exclusive)
90224 * @return float A random deviate
90225 * @since PECL stats >= 1.0.0
90226 **/
90227function stats_rand_gen_funiform($low, $high){}
90228
90229/**
90230 * Generates a random deviate from the gamma distribution
90231 *
90232 * Generates a random deviate from the gamma distribution whose density
90233 * is (A**R)/Gamma(R) * X**(R-1) * Exp(-A*X).
90234 *
90235 * @param float $a location parameter of Gamma distribution ({@link a}
90236 *   > 0).
90237 * @param float $r shape parameter of Gamma distribution ({@link r} >
90238 *   0).
90239 * @return float A random deviate
90240 * @since PECL stats >= 1.0.0
90241 **/
90242function stats_rand_gen_gamma($a, $r){}
90243
90244/**
90245 * Generates a random deviate from the binomial distribution
90246 *
90247 * Returns a random deviate from the binomial distribution whose number
90248 * of trials is {@link n} and whose probability of an event in each trial
90249 * is {@link pp}.
90250 *
90251 * @param int $n The number of trials
90252 * @param float $pp The probability of an event in each trial
90253 * @return int A random deviate
90254 * @since PECL stats >= 1.0.0
90255 **/
90256function stats_rand_gen_ibinomial($n, $pp){}
90257
90258/**
90259 * Generates a random deviate from the negative binomial distribution
90260 *
90261 * Returns a random deviate from a negative binomial distribution where
90262 * the number of success is {@link n} and the success rate is {@link p}.
90263 *
90264 * @param int $n The number of success
90265 * @param float $p The success rate
90266 * @return int A random deviate, which is the number of failure.
90267 * @since PECL stats >= 1.0.0
90268 **/
90269function stats_rand_gen_ibinomial_negative($n, $p){}
90270
90271/**
90272 * Generates random integer between 1 and 2147483562
90273 *
90274 * Returns a random integer between 1 and 2147483562
90275 *
90276 * @return int A random integer
90277 * @since PECL stats >= 1.0.0
90278 **/
90279function stats_rand_gen_int(){}
90280
90281/**
90282 * Generates a single random deviate from a Poisson distribution
90283 *
90284 * Returns a random deviate from the Poisson distribution with parameter
90285 * {@link mu}.
90286 *
90287 * @param float $mu The parameter of the Poisson distribution
90288 * @return int A random deviate
90289 * @since PECL stats >= 1.0.0
90290 **/
90291function stats_rand_gen_ipoisson($mu){}
90292
90293/**
90294 * Generates integer uniformly distributed between LOW (inclusive) and
90295 * HIGH (inclusive)
90296 *
90297 * Returns a random integer from the discrete uniform distribution
90298 * between {@link low} (inclusive) and {@link high} (inclusive).
90299 *
90300 * @param int $low The lower bound
90301 * @param int $high The upper bound
90302 * @return int A random integer
90303 * @since PECL stats >= 1.0.0
90304 **/
90305function stats_rand_gen_iuniform($low, $high){}
90306
90307/**
90308 * Generates a random deviate from the non-central chi-square
90309 * distribution
90310 *
90311 * Returns a random deviate from the non-central chi-square distribution
90312 * with degrees of freedom, {@link df}, and non-centrality parameter,
90313 * {@link xnonc}.
90314 *
90315 * @param float $df The degrees of freedom
90316 * @param float $xnonc The non-centrality parameter
90317 * @return float A random deviate
90318 * @since PECL stats >= 1.0.0
90319 **/
90320function stats_rand_gen_noncentral_chisquare($df, $xnonc){}
90321
90322/**
90323 * Generates a random deviate from the noncentral F distribution
90324 *
90325 * Returns a random deviate from the non-central F distribution where the
90326 * degrees of freedoms are {@link dfn} (numerator) and {@link dfd}
90327 * (denominator), and the non-centrality parameter is {@link xnonc}.
90328 *
90329 * @param float $dfn The degrees of freedom of the numerator
90330 * @param float $dfd The degrees of freedom of the denominator
90331 * @param float $xnonc The non-centrality parameter
90332 * @return float A random deviate
90333 * @since PECL stats >= 1.0.0
90334 **/
90335function stats_rand_gen_noncentral_f($dfn, $dfd, $xnonc){}
90336
90337/**
90338 * Generates a single random deviate from a non-central t-distribution
90339 *
90340 * Returns a random deviate from the non-central t-distribution with the
90341 * degrees of freedom, {@link df}, and the non-centrality parameter,
90342 * {@link xnonc}.
90343 *
90344 * @param float $df The degrees of freedom
90345 * @param float $xnonc The non-centrality parameter
90346 * @return float A random deviate
90347 * @since PECL stats >= 1.0.0
90348 **/
90349function stats_rand_gen_noncentral_t($df, $xnonc){}
90350
90351/**
90352 * Generates a single random deviate from a normal distribution
90353 *
90354 * Returns a random deviate from the normal distribution with mean,
90355 * {@link av}, and standard deviation, {@link sd}.
90356 *
90357 * @param float $av The mean of the normal distribution
90358 * @param float $sd The standard deviation of the normal distribution
90359 * @return float A random deviate
90360 * @since PECL stats >= 1.0.0
90361 **/
90362function stats_rand_gen_normal($av, $sd){}
90363
90364/**
90365 * Generates a single random deviate from a t-distribution
90366 *
90367 * Returns a random deviate from the t-distribution with the degrees of
90368 * freedom, {@link df}.
90369 *
90370 * @param float $df The degrees of freedom
90371 * @return float A random deviate
90372 * @since PECL stats >= 1.0.0
90373 **/
90374function stats_rand_gen_t($df){}
90375
90376/**
90377 * Get the seed values of the random number generator
90378 *
90379 * Returns the current seed values of the random number generator
90380 *
90381 * @return array Returns an array of two integers.
90382 * @since PECL stats >= 1.0.0
90383 **/
90384function stats_rand_get_seeds(){}
90385
90386/**
90387 * Generate two seeds for the RGN random number generator
90388 *
90389 * Generate two seeds for the random number generator from a {@link
90390 * phrase}.
90391 *
90392 * @param string $phrase The input phrase
90393 * @return array Returns an array of two integers.
90394 * @since PECL stats >= 1.0.0
90395 **/
90396function stats_rand_phrase_to_seeds($phrase){}
90397
90398/**
90399 * Generates a random floating point number between 0 and 1
90400 *
90401 * Returns a random floating point number from a uniform distribution
90402 * between 0 (exclusive) and 1 (exclusive).
90403 *
90404 * @return float A random floating point number
90405 * @since PECL stats >= 1.0.0
90406 **/
90407function stats_rand_ranf(){}
90408
90409/**
90410 * Set seed values to the random generator
90411 *
90412 * Set {@link iseed1} and {@link iseed2} as seed values to the random
90413 * generator used in statistic functions.
90414 *
90415 * @param int $iseed1 The value which is used as the random seed
90416 * @param int $iseed2 The value which is used as the random seed
90417 * @return void No values are returned.
90418 * @since PECL stats >= 1.0.0
90419 **/
90420function stats_rand_setall($iseed1, $iseed2){}
90421
90422/**
90423 * Computes the skewness of the data in the array
90424 *
90425 * Returns the skewness of the values in {@link a}.
90426 *
90427 * @param array $a The input array
90428 * @return float Returns the skewness of the values in {@link a}, or
90429 *   FALSE if {@link a} is empty or is not an array.
90430 * @since PECL stats >= 1.0.0
90431 **/
90432function stats_skew($a){}
90433
90434/**
90435 * Returns the standard deviation
90436 *
90437 * Returns the standard deviation of the values in {@link a}.
90438 *
90439 * @param array $a The array of data to find the standard deviation
90440 *   for. Note that all values of the array will be cast to float.
90441 * @param bool $sample Indicates if {@link a} represents a sample of
90442 *   the population; defaults to FALSE.
90443 * @return float Returns the standard deviation on success; FALSE on
90444 *   failure.
90445 * @since PECL stats >= 1.0.0
90446 **/
90447function stats_standard_deviation($a, $sample){}
90448
90449/**
90450 * Returns a binomial coefficient
90451 *
90452 * Returns the binomial coefficient of {@link n} choose {@link x}.
90453 *
90454 * @param int $x The number of chooses from the set
90455 * @param int $n The number of elements in the set
90456 * @return float Returns the binomial coefficient
90457 * @since PECL stats >= 1.0.0
90458 **/
90459function stats_stat_binomial_coef($x, $n){}
90460
90461/**
90462 * Returns the Pearson correlation coefficient of two data sets
90463 *
90464 * Returns the Pearson correlation coefficient between {@link arr1} and
90465 * {@link arr2}.
90466 *
90467 * @param array $arr1 The first array
90468 * @param array $arr2 The second array
90469 * @return float Returns the Pearson correlation coefficient between
90470 *   {@link arr1} and {@link arr2}, or FALSE on failure.
90471 * @since PECL stats >= 1.0.0
90472 **/
90473function stats_stat_correlation($arr1, $arr2){}
90474
90475/**
90476 * Returns the factorial of an integer
90477 *
90478 * Returns the factorial of an integer, {@link n}.
90479 *
90480 * @param int $n An integer
90481 * @return float The factorial of {@link n}.
90482 * @since PECL stats >= 1.0.0
90483 **/
90484function stats_stat_factorial($n){}
90485
90486/**
90487 * Returns the t-value from the independent two-sample t-test
90488 *
90489 * Returns the t-value of the independent two-sample t-test between
90490 * {@link arr1} and {@link arr2}.
90491 *
90492 * @param array $arr1 The first set of values
90493 * @param array $arr2 The second set of values
90494 * @return float Returns the t-value, or FALSE if failure.
90495 * @since PECL stats >= 1.0.0
90496 **/
90497function stats_stat_independent_t($arr1, $arr2){}
90498
90499/**
90500 * Returns the inner product of two vectors
90501 *
90502 * Returns the inner product of {@link arr1} and {@link arr2}.
90503 *
90504 * @param array $arr1 The first array
90505 * @param array $arr2 The second array
90506 * @return float Returns the inner product of {@link arr1} and {@link
90507 *   arr2}, or FALSE on failure.
90508 * @since PECL stats >= 1.0.0
90509 **/
90510function stats_stat_innerproduct($arr1, $arr2){}
90511
90512/**
90513 * Returns the t-value of the dependent t-test for paired samples
90514 *
90515 * Returns the t-value of the dependent t-test for paired samples {@link
90516 * arr1} and {@link arr2}.
90517 *
90518 * @param array $arr1 The first samples
90519 * @param array $arr2 The second samples
90520 * @return float Returns the t-value, or FALSE if failure.
90521 * @since PECL stats >= 1.0.0
90522 **/
90523function stats_stat_paired_t($arr1, $arr2){}
90524
90525/**
90526 * Returns the percentile value
90527 *
90528 * Returns the {@link perc}-th percentile value of the array {@link arr}.
90529 *
90530 * @param array $arr The input array
90531 * @param float $perc The percentile
90532 * @return float Returns the percentile values of the input array.
90533 * @since PECL stats >= 1.0.0
90534 **/
90535function stats_stat_percentile($arr, $perc){}
90536
90537/**
90538 * Returns the power sum of a vector
90539 *
90540 * Returns the sum of the {@link power}-th power of a vector represented
90541 * as an array {@link arr}.
90542 *
90543 * @param array $arr The input array
90544 * @param float $power The power
90545 * @return float Returns the power sum of the input array.
90546 * @since PECL stats >= 1.0.0
90547 **/
90548function stats_stat_powersum($arr, $power){}
90549
90550/**
90551 * Returns the variance
90552 *
90553 * Returns the variance of the values in {@link a}.
90554 *
90555 * @param array $a The array of data to find the standard deviation
90556 *   for. Note that all values of the array will be cast to float.
90557 * @param bool $sample Indicates if {@link a} represents a sample of
90558 *   the population; defaults to FALSE.
90559 * @return float Returns the variance on success; FALSE on failure.
90560 * @since PECL stats >= 1.0.0
90561 **/
90562function stats_variance($a, $sample){}
90563
90564/**
90565 * Rolls back a transaction in progress
90566 *
90567 * @param resource $link The transaction to abort.
90568 * @param string $transaction_id
90569 * @param array $headers
90570 * @return bool
90571 **/
90572function stomp_abort($link, $transaction_id, $headers){}
90573
90574/**
90575 * Acknowledges consumption of a message
90576 *
90577 * Acknowledges consumption of a message from a subscription using client
90578 * acknowledgment.
90579 *
90580 * @param resource $link The message/messageId to be acknowledged.
90581 * @param mixed $msg
90582 * @param array $headers
90583 * @return bool
90584 **/
90585function stomp_ack($link, $msg, $headers){}
90586
90587/**
90588 * Starts a transaction
90589 *
90590 * @param resource $link The transaction id.
90591 * @param string $transaction_id
90592 * @param array $headers
90593 * @return bool
90594 **/
90595function stomp_begin($link, $transaction_id, $headers){}
90596
90597/**
90598 * Closes stomp connection
90599 *
90600 * (destructor):
90601 *
90602 * Closes a previously opened connection.
90603 *
90604 * @param resource $link
90605 * @return bool
90606 **/
90607function stomp_close($link){}
90608
90609/**
90610 * Commits a transaction in progress
90611 *
90612 * @param resource $link The transaction id.
90613 * @param string $transaction_id
90614 * @param array $headers
90615 * @return bool
90616 **/
90617function stomp_commit($link, $transaction_id, $headers){}
90618
90619/**
90620 * Opens a connection
90621 *
90622 * (constructor):
90623 *
90624 * Opens a connection to a stomp compliant Message Broker.
90625 *
90626 * @param string $broker The broker URI
90627 * @param string $username The username.
90628 * @param string $password The password.
90629 * @param array $headers
90630 * @return resource
90631 **/
90632function stomp_connect($broker, $username, $password, $headers){}
90633
90634/**
90635 * Returns a string description of the last connect error
90636 *
90637 * @return string A string that describes the error, or NULL if no
90638 *   error occurred.
90639 * @since PECL stomp >= 0.3.0
90640 **/
90641function stomp_connect_error(){}
90642
90643/**
90644 * Gets the last stomp error
90645 *
90646 * @param resource $link
90647 * @return string Returns an error string or FALSE if no error
90648 *   occurred.
90649 **/
90650function stomp_error($link){}
90651
90652/**
90653 * Gets read timeout
90654 *
90655 * @param resource $link
90656 * @return array Returns an array with 2 elements: sec and usec.
90657 **/
90658function stomp_get_read_timeout($link){}
90659
90660/**
90661 * Gets the current stomp session ID
90662 *
90663 * @param resource $link
90664 * @return string session id on success.
90665 **/
90666function stomp_get_session_id($link){}
90667
90668/**
90669 * Indicates whether or not there is a frame ready to read
90670 *
90671 * @param resource $link
90672 * @return bool Returns TRUE if a frame is ready to read, or FALSE
90673 *   otherwise.
90674 **/
90675function stomp_has_frame($link){}
90676
90677/**
90678 * Reads the next frame
90679 *
90680 * Reads the next frame. It is possible to instantiate an object of a
90681 * specific class, and pass parameters to that class's constructor.
90682 *
90683 * @param resource $link The name of the class to instantiate. If not
90684 *   specified, a stompFrame object is returned.
90685 * @return array
90686 **/
90687function stomp_read_frame($link){}
90688
90689/**
90690 * Sends a message
90691 *
90692 * Sends a message to the Message Broker.
90693 *
90694 * @param resource $link Where to send the message
90695 * @param string $destination Message to send.
90696 * @param mixed $msg
90697 * @param array $headers
90698 * @return bool
90699 **/
90700function stomp_send($link, $destination, $msg, $headers){}
90701
90702/**
90703 * Sets read timeout
90704 *
90705 * @param resource $link The seconds part of the timeout to be set.
90706 * @param int $seconds The microseconds part of the timeout to be set.
90707 * @param int $microseconds
90708 * @return void
90709 **/
90710function stomp_set_read_timeout($link, $seconds, $microseconds){}
90711
90712/**
90713 * Registers to listen to a given destination
90714 *
90715 * @param resource $link Destination to subscribe to.
90716 * @param string $destination
90717 * @param array $headers
90718 * @return bool
90719 **/
90720function stomp_subscribe($link, $destination, $headers){}
90721
90722/**
90723 * Removes an existing subscription
90724 *
90725 * @param resource $link Subscription to remove.
90726 * @param string $destination
90727 * @param array $headers
90728 * @return bool
90729 **/
90730function stomp_unsubscribe($link, $destination, $headers){}
90731
90732/**
90733 * Gets the current stomp extension version
90734 *
90735 * Returns a string containing the version of the current stomp
90736 * extension.
90737 *
90738 * @return string It returns the current stomp extension version
90739 * @since PECL stomp >= 0.1.0
90740 **/
90741function stomp_version(){}
90742
90743/**
90744 * Binary safe case-insensitive string comparison
90745 *
90746 * @param string $str1 The first string
90747 * @param string $str2 The second string
90748 * @return int Returns < 0 if {@link str1} is less than {@link str2}; >
90749 *   0 if {@link str1} is greater than {@link str2}, and 0 if they are
90750 *   equal.
90751 * @since PHP 4, PHP 5, PHP 7
90752 **/
90753function strcasecmp($str1, $str2){}
90754
90755/**
90756 * Find the first occurrence of a string
90757 *
90758 * Returns part of {@link haystack} string starting from and including
90759 * the first occurrence of {@link needle} to the end of {@link haystack}.
90760 *
90761 * @param string $haystack The input string.
90762 * @param mixed $needle
90763 * @param bool $before_needle If TRUE, {@link strstr} returns the part
90764 *   of the {@link haystack} before the first occurrence of the {@link
90765 *   needle} (excluding the needle).
90766 * @return string Returns the portion of string, or FALSE if {@link
90767 *   needle} is not found.
90768 * @since PHP 4, PHP 5, PHP 7
90769 **/
90770function strchr($haystack, $needle, $before_needle){}
90771
90772/**
90773 * Binary safe string comparison
90774 *
90775 * @param string $str1 The first string.
90776 * @param string $str2 The second string.
90777 * @return int Returns < 0 if {@link str1} is less than {@link str2}; >
90778 *   0 if {@link str1} is greater than {@link str2}, and 0 if they are
90779 *   equal.
90780 * @since PHP 4, PHP 5, PHP 7
90781 **/
90782function strcmp($str1, $str2){}
90783
90784/**
90785 * Locale based string comparison
90786 *
90787 * Note that this comparison is case sensitive, and unlike {@link strcmp}
90788 * this function is not binary safe.
90789 *
90790 * {@link strcoll} uses the current locale for doing the comparisons. If
90791 * the current locale is C or POSIX, this function is equivalent to
90792 * {@link strcmp}.
90793 *
90794 * @param string $str1 The first string.
90795 * @param string $str2 The second string.
90796 * @return int Returns < 0 if {@link str1} is less than {@link str2}; >
90797 *   0 if {@link str1} is greater than {@link str2}, and 0 if they are
90798 *   equal.
90799 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
90800 **/
90801function strcoll($str1, $str2){}
90802
90803/**
90804 * Find length of initial segment not matching mask
90805 *
90806 * Returns the length of the initial segment of {@link subject} which
90807 * does not contain any of the characters in {@link mask}.
90808 *
90809 * If {@link start} and {@link length} are omitted, then all of {@link
90810 * subject} will be examined. If they are included, then the effect will
90811 * be the same as calling strcspn(substr($subject, $start, $length),
90812 * $mask) (see for more information).
90813 *
90814 * @param string $subject The string to examine.
90815 * @param string $mask The string containing every disallowed
90816 *   character.
90817 * @param int $start The position in {@link subject} to start
90818 *   searching. If {@link start} is given and is non-negative, then
90819 *   {@link strcspn} will begin examining {@link subject} at the {@link
90820 *   start}'th position. For instance, in the string 'abcdef', the
90821 *   character at position 0 is 'a', the character at position 2 is 'c',
90822 *   and so forth. If {@link start} is given and is negative, then {@link
90823 *   strcspn} will begin examining {@link subject} at the {@link
90824 *   start}'th position from the end of {@link subject}.
90825 * @param int $length The length of the segment from {@link subject} to
90826 *   examine. If {@link length} is given and is non-negative, then {@link
90827 *   subject} will be examined for {@link length} characters after the
90828 *   starting position. If {@link length} is given and is negative, then
90829 *   {@link subject} will be examined from the starting position up to
90830 *   {@link length} characters from the end of {@link subject}.
90831 * @return int Returns the length of the initial segment of {@link
90832 *   subject} which consists entirely of characters not in {@link mask}.
90833 * @since PHP 4, PHP 5, PHP 7
90834 **/
90835function strcspn($subject, $mask, $start, $length){}
90836
90837/**
90838 * Append bucket to brigade
90839 *
90840 * @param resource $brigade
90841 * @param object $bucket
90842 * @return void
90843 * @since PHP 5, PHP 7
90844 **/
90845function stream_bucket_append($brigade, $bucket){}
90846
90847/**
90848 * Return a bucket object from the brigade for operating on
90849 *
90850 * @param resource $brigade
90851 * @return object
90852 * @since PHP 5, PHP 7
90853 **/
90854function stream_bucket_make_writeable($brigade){}
90855
90856/**
90857 * Create a new bucket for use on the current stream
90858 *
90859 * @param resource $stream
90860 * @param string $buffer
90861 * @return object
90862 * @since PHP 5, PHP 7
90863 **/
90864function stream_bucket_new($stream, $buffer){}
90865
90866/**
90867 * Prepend bucket to brigade
90868 *
90869 * This function can be called to prepend a bucket to a bucket brigade.
90870 * It is typically called from php_user_filter::filter.
90871 *
90872 * @param resource $brigade {@link brigade} is a resource pointing to a
90873 *   bucket brigade which contains one or more bucket objects.
90874 * @param object $bucket A bucket object.
90875 * @return void
90876 * @since PHP 5, PHP 7
90877 **/
90878function stream_bucket_prepend($brigade, $bucket){}
90879
90880/**
90881 * Creates a stream context
90882 *
90883 * Creates and returns a stream context with any options supplied in
90884 * {@link options} preset.
90885 *
90886 * @param array $options Must be an associative array of associative
90887 *   arrays in the format $arr['wrapper']['option'] = $value. Refer to
90888 *   context options for a list of available wrappers and options.
90889 *   Default to an empty array.
90890 * @param array $params Must be an associative array in the format
90891 *   $arr['parameter'] = $value. Refer to context parameters for a
90892 *   listing of standard stream parameters.
90893 * @return resource A stream context resource.
90894 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
90895 **/
90896function stream_context_create($options, $params){}
90897
90898/**
90899 * Retrieve the default stream context
90900 *
90901 * @param array $options
90902 * @return resource A stream context resource.
90903 * @since PHP 5 >= 5.1.0, PHP 7
90904 **/
90905function stream_context_get_default($options){}
90906
90907/**
90908 * Retrieve options for a stream/wrapper/context
90909 *
90910 * @param resource $stream_or_context The stream or context to get
90911 *   options from
90912 * @return array Returns an associative array with the options.
90913 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
90914 **/
90915function stream_context_get_options($stream_or_context){}
90916
90917/**
90918 * Retrieves parameters from a context
90919 *
90920 * Retrieves parameter and options information from the stream or
90921 * context.
90922 *
90923 * @param resource $stream_or_context A stream resource or a context
90924 *   resource
90925 * @return array Returns an associate array containing all context
90926 *   options and parameters.
90927 * @since PHP 5 >= 5.3.0, PHP 7
90928 **/
90929function stream_context_get_params($stream_or_context){}
90930
90931/**
90932 * Set the default stream context
90933 *
90934 * @param array $options The options to set for the default context.
90935 * @return resource Returns the default stream context.
90936 * @since PHP 5 >= 5.3.0, PHP 7
90937 **/
90938function stream_context_set_default($options){}
90939
90940/**
90941 * Sets an option for a stream/wrapper/context
90942 *
90943 * @param resource $stream_or_context The stream or context resource to
90944 *   apply the options to.
90945 * @param string $wrapper The options to set for {@link
90946 *   stream_or_context}.
90947 * @param string $option
90948 * @param mixed $value
90949 * @return bool
90950 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
90951 **/
90952function stream_context_set_option($stream_or_context, $wrapper, $option, $value){}
90953
90954/**
90955 * Set parameters for a stream/wrapper/context
90956 *
90957 * Sets parameters on the specified context.
90958 *
90959 * @param resource $stream_or_context The stream or context to apply
90960 *   the parameters too.
90961 * @param array $params An array of parameters to set.
90962 * @return bool
90963 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
90964 **/
90965function stream_context_set_params($stream_or_context, $params){}
90966
90967/**
90968 * Copies data from one stream to another
90969 *
90970 * Makes a copy of up to {@link maxlength} bytes of data from the current
90971 * position (or from the {@link offset} position, if specified) in {@link
90972 * source} to {@link dest}. If {@link maxlength} is not specified, all
90973 * remaining content in {@link source} will be copied.
90974 *
90975 * @param resource $source The source stream
90976 * @param resource $dest The destination stream
90977 * @param int $maxlength Maximum bytes to copy
90978 * @param int $offset The offset where to start to copy data
90979 * @return int Returns the total count of bytes copied, .
90980 * @since PHP 5, PHP 7
90981 **/
90982function stream_copy_to_stream($source, $dest, $maxlength, $offset){}
90983
90984/**
90985 * Attach a filter to a stream
90986 *
90987 * Adds {@link filtername} to the list of filters attached to {@link
90988 * stream}.
90989 *
90990 * @param resource $stream The target stream.
90991 * @param string $filtername The filter name.
90992 * @param int $read_write By default, {@link stream_filter_append} will
90993 *   attach the filter to the read filter chain if the file was opened
90994 *   for reading (i.e. File Mode: r, and/or +). The filter will also be
90995 *   attached to the write filter chain if the file was opened for
90996 *   writing (i.e. File Mode: w, a, and/or +). STREAM_FILTER_READ,
90997 *   STREAM_FILTER_WRITE, and/or STREAM_FILTER_ALL can also be passed to
90998 *   the {@link read_write} parameter to override this behavior.
90999 * @param mixed $params This filter will be added with the specified
91000 *   {@link params} to the end of the list and will therefore be called
91001 *   last during stream operations. To add a filter to the beginning of
91002 *   the list, use {@link stream_filter_prepend}.
91003 * @return resource Returns a resource on success or FALSE on failure.
91004 *   The resource can be used to refer to this filter instance during a
91005 *   call to {@link stream_filter_remove}.
91006 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
91007 **/
91008function stream_filter_append($stream, $filtername, $read_write, $params){}
91009
91010/**
91011 * Attach a filter to a stream
91012 *
91013 * Adds {@link filtername} to the list of filters attached to {@link
91014 * stream}.
91015 *
91016 * @param resource $stream The target stream.
91017 * @param string $filtername The filter name.
91018 * @param int $read_write By default, {@link stream_filter_prepend}
91019 *   will attach the filter to the read filter chain if the file was
91020 *   opened for reading (i.e. File Mode: r, and/or +). The filter will
91021 *   also be attached to the write filter chain if the file was opened
91022 *   for writing (i.e. File Mode: w, a, and/or +). STREAM_FILTER_READ,
91023 *   STREAM_FILTER_WRITE, and/or STREAM_FILTER_ALL can also be passed to
91024 *   the {@link read_write} parameter to override this behavior. See
91025 *   {@link stream_filter_append} for an example of using this parameter.
91026 * @param mixed $params This filter will be added with the specified
91027 *   {@link params} to the beginning of the list and will therefore be
91028 *   called first during stream operations. To add a filter to the end of
91029 *   the list, use {@link stream_filter_append}.
91030 * @return resource Returns a resource on success or FALSE on failure.
91031 *   The resource can be used to refer to this filter instance during a
91032 *   call to {@link stream_filter_remove}.
91033 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
91034 **/
91035function stream_filter_prepend($stream, $filtername, $read_write, $params){}
91036
91037/**
91038 * Register a user defined stream filter
91039 *
91040 * {@link stream_filter_register} allows you to implement your own filter
91041 * on any registered stream used with all the other filesystem functions
91042 * (such as {@link fopen}, {@link fread} etc.).
91043 *
91044 * @param string $filtername The filter name to be registered.
91045 * @param string $classname To implement a filter, you need to define a
91046 *   class as an extension of php_user_filter with a number of member
91047 *   functions. When performing read/write operations on the stream to
91048 *   which your filter is attached, PHP will pass the data through your
91049 *   filter (and any other filters attached to that stream) so that the
91050 *   data may be modified as desired. You must implement the methods
91051 *   exactly as described in php_user_filter - doing otherwise will lead
91052 *   to undefined behaviour.
91053 * @return bool
91054 * @since PHP 5, PHP 7
91055 **/
91056function stream_filter_register($filtername, $classname){}
91057
91058/**
91059 * Remove a filter from a stream
91060 *
91061 * Removes a stream filter previously added to a stream with {@link
91062 * stream_filter_prepend} or {@link stream_filter_append}. Any data
91063 * remaining in the filter's internal buffer will be flushed through to
91064 * the next filter before removing it.
91065 *
91066 * @param resource $stream_filter The stream filter to be removed.
91067 * @return bool
91068 * @since PHP 5 >= 5.1.0, PHP 7
91069 **/
91070function stream_filter_remove($stream_filter){}
91071
91072/**
91073 * Reads remainder of a stream into a string
91074 *
91075 * Identical to {@link file_get_contents}, except that {@link
91076 * stream_get_contents} operates on an already open stream resource and
91077 * returns the remaining contents in a string, up to {@link maxlength}
91078 * bytes and starting at the specified {@link offset}.
91079 *
91080 * @param resource $handle A stream resource (e.g. returned from {@link
91081 *   fopen})
91082 * @param int $maxlength The maximum bytes to read. Defaults to -1
91083 *   (read all the remaining buffer).
91084 * @param int $offset Seek to the specified offset before reading. If
91085 *   this number is negative, no seeking will occur and reading will
91086 *   start from the current position.
91087 * @return string Returns a string.
91088 * @since PHP 5, PHP 7
91089 **/
91090function stream_get_contents($handle, $maxlength, $offset){}
91091
91092/**
91093 * Retrieve list of registered filters
91094 *
91095 * @return array Returns an indexed array containing the name of all
91096 *   stream filters available.
91097 * @since PHP 5, PHP 7
91098 **/
91099function stream_get_filters(){}
91100
91101/**
91102 * Gets line from stream resource up to a given delimiter
91103 *
91104 * Gets a line from the given handle.
91105 *
91106 * Reading ends when {@link length} bytes have been read, when the string
91107 * specified by {@link ending} is found (which is not included in the
91108 * return value), or on EOF (whichever comes first).
91109 *
91110 * This function is nearly identical to {@link fgets} except in that it
91111 * allows end of line delimiters other than the standard \n, \r, and
91112 * \r\n, and does not return the delimiter itself.
91113 *
91114 * @param resource $handle A valid file handle.
91115 * @param int $length The number of bytes to read from the handle.
91116 * @param string $ending An optional string delimiter.
91117 * @return string Returns a string of up to {@link length} bytes read
91118 *   from the file pointed to by {@link handle}.
91119 * @since PHP 5, PHP 7
91120 **/
91121function stream_get_line($handle, $length, $ending){}
91122
91123/**
91124 * Retrieves header/meta data from streams/file pointers
91125 *
91126 * Returns information about an existing {@link stream}.
91127 *
91128 * @param resource $stream The stream can be any stream created by
91129 *   {@link fopen}, {@link fsockopen} and {@link pfsockopen}.
91130 * @return array The result array contains the following items:
91131 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
91132 **/
91133function stream_get_meta_data($stream){}
91134
91135/**
91136 * Retrieve list of registered socket transports
91137 *
91138 * @return array Returns an indexed array of socket transports names.
91139 * @since PHP 5, PHP 7
91140 **/
91141function stream_get_transports(){}
91142
91143/**
91144 * Retrieve list of registered streams
91145 *
91146 * Retrieve list of registered streams available on the running system.
91147 *
91148 * @return array Returns an indexed array containing the name of all
91149 *   stream wrappers available on the running system.
91150 * @since PHP 5, PHP 7
91151 **/
91152function stream_get_wrappers(){}
91153
91154/**
91155 * Check if a stream is a TTY
91156 *
91157 * Determines if stream {@link stream} refers to a valid terminal type
91158 * device. This is a more portable version of {@link posix_isatty}, since
91159 * it works on Windows systems too.
91160 *
91161 * @param resource $stream
91162 * @return bool
91163 * @since PHP 7 >= 7.2.0
91164 **/
91165function stream_isatty($stream){}
91166
91167/**
91168 * Checks if a stream is a local stream
91169 *
91170 * Checks if a stream, or a URL, is a local one or not.
91171 *
91172 * @param mixed $stream_or_url The stream resource or URL to check.
91173 * @return bool
91174 * @since PHP 5 >= 5.2.4, PHP 7
91175 **/
91176function stream_is_local($stream_or_url){}
91177
91178/**
91179 * A callback function for the context parameter
91180 *
91181 * A callable function, used by the notification context parameter,
91182 * called during an event.
91183 *
91184 * @param int $notification_code One of the STREAM_NOTIFY_*
91185 *   notification constants.
91186 * @param int $severity One of the STREAM_NOTIFY_SEVERITY_*
91187 *   notification constants.
91188 * @param string $message Passed if a descriptive message is available
91189 *   for the event.
91190 * @param int $message_code Passed if a descriptive message code is
91191 *   available for the event. The meaning of this value is dependent on
91192 *   the specific wrapper in use.
91193 * @param int $bytes_transferred If applicable, the {@link
91194 *   bytes_transferred} will be populated.
91195 * @param int $bytes_max If applicable, the {@link bytes_max} will be
91196 *   populated.
91197 * @return void
91198 * @since PHP 5 >= 5.2.0, PHP 7
91199 **/
91200function stream_notification_callback($notification_code, $severity, $message, $message_code, $bytes_transferred, $bytes_max){}
91201
91202/**
91203 * Register a URL wrapper implemented as a PHP class
91204 *
91205 * Allows you to implement your own protocol handlers and streams for use
91206 * with all the other filesystem functions (such as {@link fopen}, {@link
91207 * fread} etc.).
91208 *
91209 * @param string $protocol The wrapper name to be registered.
91210 * @param string $classname The classname which implements the {@link
91211 *   protocol}.
91212 * @param int $flags Should be set to STREAM_IS_URL if {@link protocol}
91213 *   is a URL protocol. Default is 0, local stream.
91214 * @return bool
91215 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
91216 **/
91217function stream_register_wrapper($protocol, $classname, $flags){}
91218
91219/**
91220 * Resolve filename against the include path
91221 *
91222 * Resolve {@link filename} against the include path according to the
91223 * same rules as {@link fopen}/{@link include}.
91224 *
91225 * @param string $filename The filename to resolve.
91226 * @return string Returns a string containing the resolved absolute
91227 *   filename, .
91228 * @since PHP 5 >= 5.3.2, PHP 7
91229 **/
91230function stream_resolve_include_path($filename){}
91231
91232/**
91233 * Runs the equivalent of the select() system call on the given arrays of
91234 * streams with a timeout specified by tv_sec and tv_usec
91235 *
91236 * The {@link stream_select} function accepts arrays of streams and waits
91237 * for them to change status. Its operation is equivalent to that of the
91238 * {@link socket_select} function except in that it acts on streams.
91239 *
91240 * @param array $read The streams listed in the {@link read} array will
91241 *   be watched to see if characters become available for reading (more
91242 *   precisely, to see if a read will not block - in particular, a stream
91243 *   resource is also ready on end-of-file, in which case an {@link
91244 *   fread} will return a zero length string).
91245 * @param array $write The streams listed in the {@link write} array
91246 *   will be watched to see if a write will not block.
91247 * @param array $except The streams listed in the {@link except} array
91248 *   will be watched for high priority exceptional ("out-of-band") data
91249 *   arriving.
91250 * @param int $tv_sec The {@link tv_sec} and {@link tv_usec} together
91251 *   form the timeout parameter, {@link tv_sec} specifies the number of
91252 *   seconds while {@link tv_usec} the number of microseconds. The {@link
91253 *   timeout} is an upper bound on the amount of time that {@link
91254 *   stream_select} will wait before it returns. If {@link tv_sec} and
91255 *   {@link tv_usec} are both set to 0, {@link stream_select} will not
91256 *   wait for data - instead it will return immediately, indicating the
91257 *   current status of the streams. If {@link tv_sec} is NULL {@link
91258 *   stream_select} can block indefinitely, returning only when an event
91259 *   on one of the watched streams occurs (or if a signal interrupts the
91260 *   system call).
91261 * @param int $tv_usec See {@link tv_sec} description.
91262 * @return int On success {@link stream_select} returns the number of
91263 *   stream resources contained in the modified arrays, which may be zero
91264 *   if the timeout expires before anything interesting happens. On error
91265 *   FALSE is returned and a warning raised (this can happen if the
91266 *   system call is interrupted by an incoming signal).
91267 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
91268 **/
91269function stream_select(&$read, &$write, &$except, $tv_sec, $tv_usec){}
91270
91271/**
91272 * Set blocking/non-blocking mode on a stream
91273 *
91274 * Sets blocking or non-blocking mode on a {@link stream}.
91275 *
91276 * This function works for any stream that supports non-blocking mode
91277 * (currently, regular files and socket streams).
91278 *
91279 * @param resource $stream The stream.
91280 * @param bool $mode If {@link mode} is FALSE, the given stream will be
91281 *   switched to non-blocking mode, and if TRUE, it will be switched to
91282 *   blocking mode. This affects calls like {@link fgets} and {@link
91283 *   fread} that read from the stream. In non-blocking mode an {@link
91284 *   fgets} call will always return right away while in blocking mode it
91285 *   will wait for data to become available on the stream.
91286 * @return bool
91287 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
91288 **/
91289function stream_set_blocking($stream, $mode){}
91290
91291/**
91292 * Set the stream chunk size
91293 *
91294 * @param resource $fp The target stream.
91295 * @param int $chunk_size The desired new chunk size.
91296 * @return int Returns the previous chunk size on success.
91297 * @since PHP 5 >= 5.4.0, PHP 7
91298 **/
91299function stream_set_chunk_size($fp, $chunk_size){}
91300
91301/**
91302 * Set read file buffering on the given stream
91303 *
91304 * Sets the read buffer. It's the equivalent of {@link
91305 * stream_set_write_buffer}, but for read operations.
91306 *
91307 * @param resource $stream The file pointer.
91308 * @param int $buffer The number of bytes to buffer. If {@link buffer}
91309 *   is 0 then read operations are unbuffered. This ensures that all
91310 *   reads with {@link fread} are completed before other processes are
91311 *   allowed to read from that input stream.
91312 * @return int Returns 0 on success, or another value if the request
91313 *   cannot be honored.
91314 * @since PHP 5 >= 5.3.3, PHP 7
91315 **/
91316function stream_set_read_buffer($stream, $buffer){}
91317
91318/**
91319 * Set timeout period on a stream
91320 *
91321 * Sets the timeout value on {@link stream}, expressed in the sum of
91322 * {@link seconds} and {@link microseconds}.
91323 *
91324 * When the stream times out, the 'timed_out' key of the array returned
91325 * by {@link stream_get_meta_data} is set to TRUE, although no
91326 * error/warning is generated.
91327 *
91328 * @param resource $stream The target stream.
91329 * @param int $seconds The seconds part of the timeout to be set.
91330 * @param int $microseconds The microseconds part of the timeout to be
91331 *   set.
91332 * @return bool
91333 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
91334 **/
91335function stream_set_timeout($stream, $seconds, $microseconds){}
91336
91337/**
91338 * Sets write file buffering on the given stream
91339 *
91340 * Sets the buffering for write operations on the given {@link stream} to
91341 * {@link buffer} bytes.
91342 *
91343 * @param resource $stream The file pointer.
91344 * @param int $buffer The number of bytes to buffer. If {@link buffer}
91345 *   is 0 then write operations are unbuffered. This ensures that all
91346 *   writes with {@link fwrite} are completed before other processes are
91347 *   allowed to write to that output stream.
91348 * @return int Returns 0 on success, or another value if the request
91349 *   cannot be honored.
91350 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
91351 **/
91352function stream_set_write_buffer($stream, $buffer){}
91353
91354/**
91355 * Accept a connection on a socket created by
91356 *
91357 * Accept a connection on a socket previously created by {@link
91358 * stream_socket_server}.
91359 *
91360 * @param resource $server_socket The server socket to accept a
91361 *   connection from.
91362 * @param float $timeout Override the default socket accept timeout.
91363 *   Time should be given in seconds.
91364 * @param string $peername Will be set to the name (address) of the
91365 *   client which connected, if included and available from the selected
91366 *   transport.
91367 * @return resource Returns a stream to the accepted socket connection.
91368 * @since PHP 5, PHP 7
91369 **/
91370function stream_socket_accept($server_socket, $timeout, &$peername){}
91371
91372/**
91373 * Open Internet or Unix domain socket connection
91374 *
91375 * Initiates a stream or datagram connection to the destination specified
91376 * by {@link remote_socket}. The type of socket created is determined by
91377 * the transport specified using standard URL formatting:
91378 * transport://target. For Internet Domain sockets (AF_INET) such as TCP
91379 * and UDP, the target portion of the {@link remote_socket} parameter
91380 * should consist of a hostname or IP address followed by a colon and a
91381 * port number. For Unix domain sockets, the {@link target} portion
91382 * should point to the socket file on the filesystem.
91383 *
91384 * @param string $remote_socket Address to the socket to connect to.
91385 * @param int $errno Will be set to the system level error number if
91386 *   connection fails.
91387 * @param string $errstr Will be set to the system level error message
91388 *   if the connection fails.
91389 * @param float $timeout Number of seconds until the connect() system
91390 *   call should timeout. This parameter only applies when not making
91391 *   asynchronous connection attempts. To set a timeout for
91392 *   reading/writing data over the socket, use the {@link
91393 *   stream_set_timeout}, as the {@link timeout} only applies while
91394 *   making connecting the socket.
91395 * @param int $flags Bitmask field which may be set to any combination
91396 *   of connection flags. Currently the select of connection flags is
91397 *   limited to STREAM_CLIENT_CONNECT (default),
91398 *   STREAM_CLIENT_ASYNC_CONNECT and STREAM_CLIENT_PERSISTENT.
91399 * @param resource $context A valid context resource created with
91400 *   {@link stream_context_create}.
91401 * @return resource On success a stream resource is returned which may
91402 *   be used together with the other file functions (such as {@link
91403 *   fgets}, {@link fgetss}, {@link fwrite}, {@link fclose}, and {@link
91404 *   feof}), FALSE on failure.
91405 * @since PHP 5, PHP 7
91406 **/
91407function stream_socket_client($remote_socket, &$errno, &$errstr, $timeout, $flags, $context){}
91408
91409/**
91410 * Turns encryption on/off on an already connected socket
91411 *
91412 * @param resource $stream The stream resource.
91413 * @param bool $enable Enable/disable cryptography on the stream.
91414 * @param int $crypto_type Setup encryption on the stream. Valid
91415 *   methods are STREAM_CRYPTO_METHOD_SSLv2_CLIENT
91416 *   STREAM_CRYPTO_METHOD_SSLv3_CLIENT STREAM_CRYPTO_METHOD_SSLv23_CLIENT
91417 *   STREAM_CRYPTO_METHOD_ANY_CLIENT STREAM_CRYPTO_METHOD_TLS_CLIENT
91418 *   STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT
91419 *   STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT
91420 *   STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT
91421 *   STREAM_CRYPTO_METHOD_SSLv2_SERVER STREAM_CRYPTO_METHOD_SSLv3_SERVER
91422 *   STREAM_CRYPTO_METHOD_SSLv23_SERVER STREAM_CRYPTO_METHOD_ANY_SERVER
91423 *   STREAM_CRYPTO_METHOD_TLS_SERVER STREAM_CRYPTO_METHOD_TLSv1_0_SERVER
91424 *   STREAM_CRYPTO_METHOD_TLSv1_1_SERVER
91425 *   STREAM_CRYPTO_METHOD_TLSv1_2_SERVER If omitted, the crypto_method
91426 *   context option on the stream's SSL context will be used instead.
91427 * @param resource $session_stream Seed the stream with settings from
91428 *   {@link session_stream}.
91429 * @return mixed Returns TRUE on success, FALSE if negotiation has
91430 *   failed or 0 if there isn't enough data and you should try again
91431 *   (only for non-blocking sockets).
91432 * @since PHP 5 >= 5.1.0, PHP 7
91433 **/
91434function stream_socket_enable_crypto($stream, $enable, $crypto_type, $session_stream){}
91435
91436/**
91437 * Retrieve the name of the local or remote sockets
91438 *
91439 * Returns the local or remote name of a given socket connection.
91440 *
91441 * @param resource $handle The socket to get the name of.
91442 * @param bool $want_peer If set to TRUE the remote socket name will be
91443 *   returned, if set to FALSE the local socket name will be returned.
91444 * @return string The name of the socket.
91445 * @since PHP 5, PHP 7
91446 **/
91447function stream_socket_get_name($handle, $want_peer){}
91448
91449/**
91450 * Creates a pair of connected, indistinguishable socket streams
91451 *
91452 * {@link stream_socket_pair} creates a pair of connected,
91453 * indistinguishable socket streams. This function is commonly used in
91454 * IPC (Inter-Process Communication).
91455 *
91456 * @param int $domain The protocol family to be used: STREAM_PF_INET,
91457 *   STREAM_PF_INET6 or STREAM_PF_UNIX
91458 * @param int $type The type of communication to be used:
91459 *   STREAM_SOCK_DGRAM, STREAM_SOCK_RAW, STREAM_SOCK_RDM,
91460 *   STREAM_SOCK_SEQPACKET or STREAM_SOCK_STREAM
91461 * @param int $protocol The protocol to be used: STREAM_IPPROTO_ICMP,
91462 *   STREAM_IPPROTO_IP, STREAM_IPPROTO_RAW, STREAM_IPPROTO_TCP or
91463 *   STREAM_IPPROTO_UDP
91464 * @return array Returns an array with the two socket resources on
91465 *   success, or FALSE on failure.
91466 * @since PHP 5 >= 5.1.0, PHP 7
91467 **/
91468function stream_socket_pair($domain, $type, $protocol){}
91469
91470/**
91471 * Receives data from a socket, connected or not
91472 *
91473 * {@link stream_socket_recvfrom} accepts data from a remote socket up to
91474 * {@link length} bytes.
91475 *
91476 * @param resource $socket The remote socket.
91477 * @param int $length The number of bytes to receive from the {@link
91478 *   socket}.
91479 * @param int $flags The value of {@link flags} can be any combination
91480 *   of the following: Possible values for {@link flags} STREAM_OOB
91481 *   Process OOB (out-of-band) data. STREAM_PEEK Retrieve data from the
91482 *   socket, but do not consume the buffer. Subsequent calls to {@link
91483 *   fread} or {@link stream_socket_recvfrom} will see the same data.
91484 * @param string $address If {@link address} is provided it will be
91485 *   populated with the address of the remote socket.
91486 * @return string Returns the read data, as a string
91487 * @since PHP 5, PHP 7
91488 **/
91489function stream_socket_recvfrom($socket, $length, $flags, &$address){}
91490
91491/**
91492 * Sends a message to a socket, whether it is connected or not
91493 *
91494 * Sends the specified {@link data} through the {@link socket}.
91495 *
91496 * @param resource $socket The socket to send {@link data} to.
91497 * @param string $data The data to be sent.
91498 * @param int $flags The value of {@link flags} can be any combination
91499 *   of the following: possible values for {@link flags} STREAM_OOB
91500 *   Process OOB (out-of-band) data.
91501 * @param string $address The address specified when the socket stream
91502 *   was created will be used unless an alternate address is specified in
91503 *   {@link address}. If specified, it must be in dotted quad (or [ipv6])
91504 *   format.
91505 * @return int Returns a result code, as an integer.
91506 * @since PHP 5, PHP 7
91507 **/
91508function stream_socket_sendto($socket, $data, $flags, $address){}
91509
91510/**
91511 * Create an Internet or Unix domain server socket
91512 *
91513 * Creates a stream or datagram socket on the specified {@link
91514 * local_socket}.
91515 *
91516 * This function only creates a socket, to begin accepting connections
91517 * use {@link stream_socket_accept}.
91518 *
91519 * @param string $local_socket The type of socket created is determined
91520 *   by the transport specified using standard URL formatting:
91521 *   transport://target. For Internet Domain sockets (AF_INET) such as
91522 *   TCP and UDP, the target portion of the {@link remote_socket}
91523 *   parameter should consist of a hostname or IP address followed by a
91524 *   colon and a port number. For Unix domain sockets, the target portion
91525 *   should point to the socket file on the filesystem. Depending on the
91526 *   environment, Unix domain sockets may not be available. A list of
91527 *   available transports can be retrieved using {@link
91528 *   stream_get_transports}. See for a list of bulitin transports.
91529 * @param int $errno If the optional {@link errno} and {@link errstr}
91530 *   arguments are present they will be set to indicate the actual system
91531 *   level error that occurred in the system-level socket(), bind(), and
91532 *   listen() calls. If the value returned in {@link errno} is 0 and the
91533 *   function returned FALSE, it is an indication that the error occurred
91534 *   before the bind() call. This is most likely due to a problem
91535 *   initializing the socket. Note that the {@link errno} and {@link
91536 *   errstr} arguments will always be passed by reference.
91537 * @param string $errstr See {@link errno} description.
91538 * @param int $flags A bitmask field which may be set to any
91539 *   combination of socket creation flags.
91540 * @param resource $context
91541 * @return resource Returns the created stream, or FALSE on error.
91542 * @since PHP 5, PHP 7
91543 **/
91544function stream_socket_server($local_socket, &$errno, &$errstr, $flags, $context){}
91545
91546/**
91547 * Shutdown a full-duplex connection
91548 *
91549 * Shutdowns (partially or not) a full-duplex connection.
91550 *
91551 * @param resource $stream An open stream (opened with {@link
91552 *   stream_socket_client}, for example)
91553 * @param int $how One of the following constants: STREAM_SHUT_RD
91554 *   (disable further receptions), STREAM_SHUT_WR (disable further
91555 *   transmissions) or STREAM_SHUT_RDWR (disable further receptions and
91556 *   transmissions).
91557 * @return bool
91558 * @since PHP 5 >= 5.2.1, PHP 7
91559 **/
91560function stream_socket_shutdown($stream, $how){}
91561
91562/**
91563 * Tells whether the stream supports locking
91564 *
91565 * Tells whether the stream supports locking through {@link flock}.
91566 *
91567 * @param resource $stream The stream to check.
91568 * @return bool
91569 * @since PHP 5 >= 5.3.0, PHP 7
91570 **/
91571function stream_supports_lock($stream){}
91572
91573/**
91574 * Register a URL wrapper implemented as a PHP class
91575 *
91576 * Allows you to implement your own protocol handlers and streams for use
91577 * with all the other filesystem functions (such as {@link fopen}, {@link
91578 * fread} etc.).
91579 *
91580 * @param string $protocol The wrapper name to be registered.
91581 * @param string $classname The classname which implements the {@link
91582 *   protocol}.
91583 * @param int $flags Should be set to STREAM_IS_URL if {@link protocol}
91584 *   is a URL protocol. Default is 0, local stream.
91585 * @return bool
91586 * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
91587 **/
91588function stream_wrapper_register($protocol, $classname, $flags){}
91589
91590/**
91591 * Restores a previously unregistered built-in wrapper
91592 *
91593 * Restores a built-in wrapper previously unregistered with {@link
91594 * stream_wrapper_unregister}.
91595 *
91596 * @param string $protocol
91597 * @return bool
91598 * @since PHP 5 >= 5.1.0, PHP 7
91599 **/
91600function stream_wrapper_restore($protocol){}
91601
91602/**
91603 * Unregister a URL wrapper
91604 *
91605 * Allows you to disable an already defined stream wrapper. Once the
91606 * wrapper has been disabled you may override it with a user-defined
91607 * wrapper using {@link stream_wrapper_register} or reenable it later on
91608 * with {@link stream_wrapper_restore}.
91609 *
91610 * @param string $protocol
91611 * @return bool
91612 * @since PHP 5 >= 5.1.0, PHP 7
91613 **/
91614function stream_wrapper_unregister($protocol){}
91615
91616/**
91617 * Format a local time/date according to locale settings
91618 *
91619 * Format the time and/or date according to locale settings. Month and
91620 * weekday names and other language-dependent strings respect the current
91621 * locale set with {@link setlocale}.
91622 *
91623 * Not all conversion specifiers may be supported by your C library, in
91624 * which case they will not be supported by PHP's {@link strftime}.
91625 * Additionally, not all platforms support negative timestamps, so your
91626 * date range may be limited to no earlier than the Unix epoch. This
91627 * means that %e, %T, %R and, %D (and possibly others) - as well as dates
91628 * prior to Jan 1, 1970 - will not work on Windows, some Linux
91629 * distributions, and a few other operating systems. For Windows systems,
91630 * a complete overview of supported conversion specifiers can be found at
91631 * MSDN.
91632 *
91633 * @param string $format The following characters are recognized in the
91634 *   {@link format} parameter string {@link format} Description Example
91635 *   returned values Day --- --- %a An abbreviated textual representation
91636 *   of the day Sun through Sat %A A full textual representation of the
91637 *   day Sunday through Saturday %d Two-digit day of the month (with
91638 *   leading zeros) 01 to 31 %e Day of the month, with a space preceding
91639 *   single digits. Not implemented as described on Windows. See below
91640 *   for more information. 1 to 31 %j Day of the year, 3 digits with
91641 *   leading zeros 001 to 366 %u ISO-8601 numeric representation of the
91642 *   day of the week 1 (for Monday) through 7 (for Sunday) %w Numeric
91643 *   representation of the day of the week 0 (for Sunday) through 6 (for
91644 *   Saturday) Week --- --- %U Week number of the given year, starting
91645 *   with the first Sunday as the first week 13 (for the 13th full week
91646 *   of the year) %V ISO-8601:1988 week number of the given year,
91647 *   starting with the first week of the year with at least 4 weekdays,
91648 *   with Monday being the start of the week 01 through 53 (where 53
91649 *   accounts for an overlapping week) %W A numeric representation of the
91650 *   week of the year, starting with the first Monday as the first week
91651 *   46 (for the 46th week of the year beginning with a Monday) Month ---
91652 *   --- %b Abbreviated month name, based on the locale Jan through Dec
91653 *   %B Full month name, based on the locale January through December %h
91654 *   Abbreviated month name, based on the locale (an alias of %b) Jan
91655 *   through Dec %m Two digit representation of the month 01 (for
91656 *   January) through 12 (for December) Year --- --- %C Two digit
91657 *   representation of the century (year divided by 100, truncated to an
91658 *   integer) 19 for the 20th Century %g Two digit representation of the
91659 *   year going by ISO-8601:1988 standards (see %V) Example: 09 for the
91660 *   week of January 6, 2009 %G The full four-digit version of %g
91661 *   Example: 2008 for the week of January 3, 2009 %y Two digit
91662 *   representation of the year Example: 09 for 2009, 79 for 1979 %Y Four
91663 *   digit representation for the year Example: 2038 Time --- --- %H Two
91664 *   digit representation of the hour in 24-hour format 00 through 23 %k
91665 *   Hour in 24-hour format, with a space preceding single digits 0
91666 *   through 23 %I Two digit representation of the hour in 12-hour format
91667 *   01 through 12 %l (lower-case 'L') Hour in 12-hour format, with a
91668 *   space preceding single digits 1 through 12 %M Two digit
91669 *   representation of the minute 00 through 59 %p UPPER-CASE 'AM' or
91670 *   'PM' based on the given time Example: AM for 00:31, PM for 22:23 %P
91671 *   lower-case 'am' or 'pm' based on the given time Example: am for
91672 *   00:31, pm for 22:23 %r Same as "%I:%M:%S %p" Example: 09:34:17 PM
91673 *   for 21:34:17 %R Same as "%H:%M" Example: 00:35 for 12:35 AM, 16:44
91674 *   for 4:44 PM %S Two digit representation of the second 00 through 59
91675 *   %T Same as "%H:%M:%S" Example: 21:34:17 for 09:34:17 PM %X Preferred
91676 *   time representation based on locale, without the date Example:
91677 *   03:59:16 or 15:59:16 %z The time zone offset. Not implemented as
91678 *   described on Windows. See below for more information. Example: -0500
91679 *   for US Eastern Time %Z The time zone abbreviation. Not implemented
91680 *   as described on Windows. See below for more information. Example:
91681 *   EST for Eastern Time Time and Date Stamps --- --- %c Preferred date
91682 *   and time stamp based on locale Example: Tue Feb 5 00:45:10 2009 for
91683 *   February 5, 2009 at 12:45:10 AM %D Same as "%m/%d/%y" Example:
91684 *   02/05/09 for February 5, 2009 %F Same as "%Y-%m-%d" (commonly used
91685 *   in database datestamps) Example: 2009-02-05 for February 5, 2009 %s
91686 *   Unix Epoch Time timestamp (same as the {@link time} function)
91687 *   Example: 305815200 for September 10, 1979 08:40:00 AM %x Preferred
91688 *   date representation based on locale, without the time Example:
91689 *   02/05/09 for February 5, 2009 Miscellaneous --- --- %n A newline
91690 *   character ("\n") --- %t A Tab character ("\t") --- %% A literal
91691 *   percentage character ("%") --- Maximum length of this parameter is
91692 *   1023 characters.
91693 * @param int $timestamp
91694 * @return string Returns a string formatted according {@link format}
91695 *   using the given {@link timestamp} or the current local time if no
91696 *   timestamp is given. Month and weekday names and other
91697 *   language-dependent strings respect the current locale set with
91698 *   {@link setlocale}.
91699 * @since PHP 4, PHP 5, PHP 7
91700 **/
91701function strftime($format, $timestamp){}
91702
91703/**
91704 * Un-quote string quoted with
91705 *
91706 * Returns a string with backslashes stripped off. Recognizes C-like \n,
91707 * \r ..., octal and hexadecimal representation.
91708 *
91709 * @param string $str The string to be unescaped.
91710 * @return string Returns the unescaped string.
91711 * @since PHP 4, PHP 5, PHP 7
91712 **/
91713function stripcslashes($str){}
91714
91715/**
91716 * Find the position of the first occurrence of a case-insensitive
91717 * substring in a string
91718 *
91719 * Find the numeric position of the first occurrence of {@link needle} in
91720 * the {@link haystack} string.
91721 *
91722 * Unlike the {@link strpos}, {@link stripos} is case-insensitive.
91723 *
91724 * @param string $haystack The string to search in.
91725 * @param mixed $needle Note that the {@link needle} may be a string of
91726 *   one or more characters.
91727 * @param int $offset If specified, search will start this number of
91728 *   characters counted from the beginning of the string. If the offset
91729 *   is negative, the search will start this number of characters counted
91730 *   from the end of the string.
91731 * @return int Returns the position of where the needle exists relative
91732 *   to the beginnning of the {@link haystack} string (independent of
91733 *   offset). Also note that string positions start at 0, and not 1.
91734 * @since PHP 5, PHP 7
91735 **/
91736function stripos($haystack, $needle, $offset){}
91737
91738/**
91739 * Un-quotes a quoted string
91740 *
91741 * An example use of {@link stripslashes} is when the PHP directive
91742 * magic_quotes_gpc is on (it was on by default before PHP 5.4), and you
91743 * aren't inserting this data into a place (such as a database) that
91744 * requires escaping. For example, if you're simply outputting data
91745 * straight from an HTML form.
91746 *
91747 * @param string $str The input string.
91748 * @return string Returns a string with backslashes stripped off. (\'
91749 *   becomes ' and so on.) Double backslashes (\\) are made into a single
91750 *   backslash (\).
91751 * @since PHP 4, PHP 5, PHP 7
91752 **/
91753function stripslashes($str){}
91754
91755/**
91756 * Strip HTML and PHP tags from a string
91757 *
91758 * This function tries to return a string with all NULL bytes, HTML and
91759 * PHP tags stripped from a given {@link str}. It uses the same tag
91760 * stripping state machine as the {@link fgetss} function.
91761 *
91762 * @param string $str The input string.
91763 * @param mixed $allowable_tags You can use the optional second
91764 *   parameter to specify tags which should not be stripped. These are
91765 *   either given as , or as of PHP 7.4.0, as . Refer to the example
91766 *   below regarding the format of this parameter.
91767 * @return string Returns the stripped string.
91768 * @since PHP 4, PHP 5, PHP 7
91769 **/
91770function strip_tags($str, $allowable_tags){}
91771
91772/**
91773 * Case-insensitive
91774 *
91775 * Returns all of {@link haystack} starting from and including the first
91776 * occurrence of {@link needle} to the end.
91777 *
91778 * @param string $haystack The string to search in
91779 * @param mixed $needle
91780 * @param bool $before_needle If TRUE, {@link stristr} returns the part
91781 *   of the {@link haystack} before the first occurrence of the {@link
91782 *   needle} (excluding needle).
91783 * @return string Returns the matched substring. If {@link needle} is
91784 *   not found, returns FALSE.
91785 * @since PHP 4, PHP 5, PHP 7
91786 **/
91787function stristr($haystack, $needle, $before_needle){}
91788
91789/**
91790 * Get string length
91791 *
91792 * Returns the length of the given {@link string}.
91793 *
91794 * @param string $string The string being measured for length.
91795 * @return int The length of the {@link string} on success, and 0 if
91796 *   the {@link string} is empty.
91797 * @since PHP 4, PHP 5, PHP 7
91798 **/
91799function strlen($string){}
91800
91801/**
91802 * Case insensitive string comparisons using a "natural order" algorithm
91803 *
91804 * This function implements a comparison algorithm that orders
91805 * alphanumeric strings in the way a human being would. The behaviour of
91806 * this function is similar to {@link strnatcmp}, except that the
91807 * comparison is not case sensitive. For more information see: Martin
91808 * Pool's Natural Order String Comparison page.
91809 *
91810 * @param string $str1 The first string.
91811 * @param string $str2 The second string.
91812 * @return int Similar to other string comparison functions, this one
91813 *   returns < 0 if {@link str1} is less than {@link str2} > 0 if {@link
91814 *   str1} is greater than {@link str2}, and 0 if they are equal.
91815 * @since PHP 4, PHP 5, PHP 7
91816 **/
91817function strnatcasecmp($str1, $str2){}
91818
91819/**
91820 * String comparisons using a "natural order" algorithm
91821 *
91822 * This function implements a comparison algorithm that orders
91823 * alphanumeric strings in the way a human being would, this is described
91824 * as a "natural ordering". Note that this comparison is case sensitive.
91825 *
91826 * @param string $str1 The first string.
91827 * @param string $str2 The second string.
91828 * @return int Similar to other string comparison functions, this one
91829 *   returns < 0 if {@link str1} is less than {@link str2}; > 0 if {@link
91830 *   str1} is greater than {@link str2}, and 0 if they are equal.
91831 * @since PHP 4, PHP 5, PHP 7
91832 **/
91833function strnatcmp($str1, $str2){}
91834
91835/**
91836 * Binary safe case-insensitive string comparison of the first n
91837 * characters
91838 *
91839 * This function is similar to {@link strcasecmp}, with the difference
91840 * that you can specify the (upper limit of the) number of characters
91841 * from each string to be used in the comparison.
91842 *
91843 * @param string $str1 The first string.
91844 * @param string $str2 The second string.
91845 * @param int $len The length of strings to be used in the comparison.
91846 * @return int Returns < 0 if {@link str1} is less than {@link str2}; >
91847 *   0 if {@link str1} is greater than {@link str2}, and 0 if they are
91848 *   equal.
91849 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
91850 **/
91851function strncasecmp($str1, $str2, $len){}
91852
91853/**
91854 * Binary safe string comparison of the first n characters
91855 *
91856 * This function is similar to {@link strcmp}, with the difference that
91857 * you can specify the (upper limit of the) number of characters from
91858 * each string to be used in the comparison.
91859 *
91860 * Note that this comparison is case sensitive.
91861 *
91862 * @param string $str1 The first string.
91863 * @param string $str2 The second string.
91864 * @param int $len Number of characters to use in the comparison.
91865 * @return int Returns < 0 if {@link str1} is less than {@link str2}; >
91866 *   0 if {@link str1} is greater than {@link str2}, and 0 if they are
91867 *   equal.
91868 * @since PHP 4, PHP 5, PHP 7
91869 **/
91870function strncmp($str1, $str2, $len){}
91871
91872/**
91873 * Search a string for any of a set of characters
91874 *
91875 * {@link strpbrk} searches the {@link haystack} string for a {@link
91876 * char_list}.
91877 *
91878 * @param string $haystack The string where {@link char_list} is looked
91879 *   for.
91880 * @param string $char_list This parameter is case sensitive.
91881 * @return string Returns a string starting from the character found,
91882 *   or FALSE if it is not found.
91883 * @since PHP 5, PHP 7
91884 **/
91885function strpbrk($haystack, $char_list){}
91886
91887/**
91888 * Find the position of the first occurrence of a substring in a string
91889 *
91890 * Find the numeric position of the first occurrence of {@link needle} in
91891 * the {@link haystack} string.
91892 *
91893 * @param string $haystack The string to search in.
91894 * @param mixed $needle
91895 * @param int $offset If specified, search will start this number of
91896 *   characters counted from the beginning of the string. If the offset
91897 *   is negative, the search will start this number of characters counted
91898 *   from the end of the string.
91899 * @return int Returns the position of where the needle exists relative
91900 *   to the beginning of the {@link haystack} string (independent of
91901 *   offset). Also note that string positions start at 0, and not 1.
91902 * @since PHP 4, PHP 5, PHP 7
91903 **/
91904function strpos($haystack, $needle, $offset){}
91905
91906/**
91907 * Parse a time/date generated with
91908 *
91909 * {@link strptime} returns an array with the {@link date} parsed, or
91910 * FALSE on error.
91911 *
91912 * Month and weekday names and other language dependent strings respect
91913 * the current locale set with {@link setlocale} (LC_TIME).
91914 *
91915 * @param string $date The string to parse (e.g. returned from {@link
91916 *   strftime}).
91917 * @param string $format The format used in {@link date} (e.g. the same
91918 *   as used in {@link strftime}). Note that some of the format options
91919 *   available to {@link strftime} may not have any effect within {@link
91920 *   strptime}; the exact subset that are supported will vary based on
91921 *   the operating system and C library in use. For more information
91922 *   about the format options, read the {@link strftime} page.
91923 * @return array Returns an array.
91924 * @since PHP 5 >= 5.1.0, PHP 7
91925 **/
91926function strptime($date, $format){}
91927
91928/**
91929 * Find the last occurrence of a character in a string
91930 *
91931 * This function returns the portion of {@link haystack} which starts at
91932 * the last occurrence of {@link needle} and goes until the end of {@link
91933 * haystack}.
91934 *
91935 * @param string $haystack The string to search in
91936 * @param mixed $needle If {@link needle} contains more than one
91937 *   character, only the first is used. This behavior is different from
91938 *   that of {@link strstr}.
91939 * @return string This function returns the portion of string, or FALSE
91940 *   if {@link needle} is not found.
91941 * @since PHP 4, PHP 5, PHP 7
91942 **/
91943function strrchr($haystack, $needle){}
91944
91945/**
91946 * Reverse a string
91947 *
91948 * Returns {@link string}, reversed.
91949 *
91950 * @param string $string The string to be reversed.
91951 * @return string Returns the reversed string.
91952 * @since PHP 4, PHP 5, PHP 7
91953 **/
91954function strrev($string){}
91955
91956/**
91957 * Find the position of the last occurrence of a case-insensitive
91958 * substring in a string
91959 *
91960 * Find the numeric position of the last occurrence of {@link needle} in
91961 * the {@link haystack} string.
91962 *
91963 * Unlike the {@link strrpos}, {@link strripos} is case-insensitive.
91964 *
91965 * @param string $haystack The string to search in.
91966 * @param mixed $needle
91967 * @param int $offset If zero or positive, the search is performed left
91968 *   to right skipping the first {@link offset} bytes of the {@link
91969 *   haystack}. If negative, the search is performed right to left
91970 *   skipping the last {@link offset} bytes of the {@link haystack} and
91971 *   searching for the first occurrence of {@link needle}. This is
91972 *   effectively looking for the last occurrence of {@link needle} before
91973 *   the last {@link offset} bytes.
91974 * @return int Returns the position where the needle exists relative to
91975 *   the beginnning of the {@link haystack} string (independent of search
91976 *   direction or offset). String positions start at 0, and not 1.
91977 * @since PHP 5, PHP 7
91978 **/
91979function strripos($haystack, $needle, $offset){}
91980
91981/**
91982 * Find the position of the last occurrence of a substring in a string
91983 *
91984 * Find the numeric position of the last occurrence of {@link needle} in
91985 * the {@link haystack} string.
91986 *
91987 * @param string $haystack The string to search in.
91988 * @param mixed $needle
91989 * @param int $offset If zero or positive, the search is performed left
91990 *   to right skipping the first {@link offset} bytes of the {@link
91991 *   haystack}. If negative, the search is performed right to left
91992 *   skipping the last {@link offset} bytes of the {@link haystack} and
91993 *   searching for the first occurrence of {@link needle}. This is
91994 *   effectively looking for the last occurrence of {@link needle} before
91995 *   the last {@link offset} bytes.
91996 * @return int Returns the position where the needle exists relative to
91997 *   the beginning of the {@link haystack} string (independent of search
91998 *   direction or offset). String positions start at 0, and not 1.
91999 * @since PHP 4, PHP 5, PHP 7
92000 **/
92001function strrpos($haystack, $needle, $offset){}
92002
92003/**
92004 * Finds the length of the initial segment of a string consisting
92005 * entirely of characters contained within a given mask
92006 *
92007 * Finds the length of the initial segment of {@link subject} that
92008 * contains only characters from {@link mask}.
92009 *
92010 * If {@link start} and {@link length} are omitted, then all of {@link
92011 * subject} will be examined. If they are included, then the effect will
92012 * be the same as calling strspn(substr($subject, $start, $length),
92013 * $mask) (see for more information).
92014 *
92015 * The line of code:
92016 *
92017 * <?php $var = strspn("42 is the answer to the 128th question.",
92018 * "1234567890"); ?>
92019 *
92020 * will assign 2 to $var, because the string "42" is the initial segment
92021 * of {@link subject} that consists only of characters contained within
92022 * "1234567890".
92023 *
92024 * @param string $subject The string to examine.
92025 * @param string $mask The list of allowable characters.
92026 * @param int $start The position in {@link subject} to start
92027 *   searching. If {@link start} is given and is non-negative, then
92028 *   {@link strspn} will begin examining {@link subject} at the {@link
92029 *   start}'th position. For instance, in the string 'abcdef', the
92030 *   character at position 0 is 'a', the character at position 2 is 'c',
92031 *   and so forth. If {@link start} is given and is negative, then {@link
92032 *   strspn} will begin examining {@link subject} at the {@link start}'th
92033 *   position from the end of {@link subject}.
92034 * @param int $length The length of the segment from {@link subject} to
92035 *   examine. If {@link length} is given and is non-negative, then {@link
92036 *   subject} will be examined for {@link length} characters after the
92037 *   starting position. If {@link length} is given and is negative, then
92038 *   {@link subject} will be examined from the starting position up to
92039 *   {@link length} characters from the end of {@link subject}.
92040 * @return int Returns the length of the initial segment of {@link
92041 *   subject} which consists entirely of characters in {@link mask}.
92042 * @since PHP 4, PHP 5, PHP 7
92043 **/
92044function strspn($subject, $mask, $start, $length){}
92045
92046/**
92047 * Find the first occurrence of a string
92048 *
92049 * Returns part of {@link haystack} string starting from and including
92050 * the first occurrence of {@link needle} to the end of {@link haystack}.
92051 *
92052 * @param string $haystack The input string.
92053 * @param mixed $needle
92054 * @param bool $before_needle If TRUE, {@link strstr} returns the part
92055 *   of the {@link haystack} before the first occurrence of the {@link
92056 *   needle} (excluding the needle).
92057 * @return string Returns the portion of string, or FALSE if {@link
92058 *   needle} is not found.
92059 * @since PHP 4, PHP 5, PHP 7
92060 **/
92061function strstr($haystack, $needle, $before_needle){}
92062
92063/**
92064 * Tokenize string
92065 *
92066 * {@link strtok} splits a string ({@link str}) into smaller strings
92067 * (tokens), with each token being delimited by any character from {@link
92068 * token}. That is, if you have a string like "This is an example string"
92069 * you could tokenize this string into its individual words by using the
92070 * space character as the token.
92071 *
92072 * Note that only the first call to strtok uses the string argument.
92073 * Every subsequent call to strtok only needs the token to use, as it
92074 * keeps track of where it is in the current string. To start over, or to
92075 * tokenize a new string you simply call strtok with the string argument
92076 * again to initialize it. Note that you may put multiple tokens in the
92077 * token parameter. The string will be tokenized when any one of the
92078 * characters in the argument is found.
92079 *
92080 * @param string $str The string being split up into smaller strings
92081 *   (tokens).
92082 * @param string $token The delimiter used when splitting up {@link
92083 *   str}.
92084 * @return string A string token.
92085 * @since PHP 4, PHP 5, PHP 7
92086 **/
92087function strtok($str, $token){}
92088
92089/**
92090 * Make a string lowercase
92091 *
92092 * Returns {@link string} with all alphabetic characters converted to
92093 * lowercase.
92094 *
92095 * Note that 'alphabetic' is determined by the current locale. This means
92096 * that e.g. in the default "C" locale, characters such as umlaut-A (Ä)
92097 * will not be converted.
92098 *
92099 * @param string $string The input string.
92100 * @return string Returns the lowercased string.
92101 * @since PHP 4, PHP 5, PHP 7
92102 **/
92103function strtolower($string){}
92104
92105/**
92106 * Parse about any English textual datetime description into a Unix
92107 * timestamp
92108 *
92109 * Each parameter of this function uses the default time zone unless a
92110 * time zone is specified in that parameter. Be careful not to use
92111 * different time zones in each parameter unless that is intended. See
92112 * {@link date_default_timezone_get} on the various ways to define the
92113 * default time zone.
92114 *
92115 * @param string $datetime
92116 * @param int $now The timestamp which is used as a base for the
92117 *   calculation of relative dates.
92118 * @return int Returns a timestamp on success, FALSE otherwise.
92119 *   Previous to PHP 5.1.0, this function would return -1 on failure.
92120 * @since PHP 4, PHP 5, PHP 7
92121 **/
92122function strtotime($datetime, $now){}
92123
92124/**
92125 * Make a string uppercase
92126 *
92127 * Returns {@link string} with all alphabetic characters converted to
92128 * uppercase.
92129 *
92130 * Note that 'alphabetic' is determined by the current locale. For
92131 * instance, in the default "C" locale characters such as umlaut-a (ä)
92132 * will not be converted.
92133 *
92134 * @param string $string The input string.
92135 * @return string Returns the uppercased string.
92136 * @since PHP 4, PHP 5, PHP 7
92137 **/
92138function strtoupper($string){}
92139
92140/**
92141 * Translate characters or replace substrings
92142 *
92143 * If given three arguments, this function returns a copy of {@link str}
92144 * where all occurrences of each (single-byte) character in {@link from}
92145 * have been translated to the corresponding character in {@link to},
92146 * i.e., every occurrence of $from[$n] has been replaced with $to[$n],
92147 * where $n is a valid offset in both arguments.
92148 *
92149 * If {@link from} and {@link to} have different lengths, the extra
92150 * characters in the longer of the two are ignored. The length of {@link
92151 * str} will be the same as the return value's.
92152 *
92153 * If given two arguments, the second should be an array in the form
92154 * array('from' => 'to', ...). The return value is a string where all the
92155 * occurrences of the array keys have been replaced by the corresponding
92156 * values. The longest keys will be tried first. Once a substring has
92157 * been replaced, its new value will not be searched again.
92158 *
92159 * In this case, the keys and the values may have any length, provided
92160 * that there is no empty key; additionally, the length of the return
92161 * value may differ from that of {@link str}. However, this function will
92162 * be the most efficient when all the keys have the same size.
92163 *
92164 * @param string $str The string being translated.
92165 * @param string $from The string being translated to {@link to}.
92166 * @param string $to The string replacing {@link from}.
92167 * @return string Returns the translated string.
92168 * @since PHP 4, PHP 5, PHP 7
92169 **/
92170function strtr($str, $from, $to){}
92171
92172/**
92173 * Get string value of a variable
92174 *
92175 * @param mixed $var The variable that is being converted to a string.
92176 *   {@link var} may be any scalar type or an object that implements the
92177 *   __toString() method. You cannot use {@link strval} on arrays or on
92178 *   objects that do not implement the __toString() method.
92179 * @return string The string value of {@link var}.
92180 * @since PHP 4, PHP 5, PHP 7
92181 **/
92182function strval($var){}
92183
92184/**
92185 * Parse a CSV string into an array
92186 *
92187 * Parses a string input for fields in CSV format and returns an array
92188 * containing the fields read.
92189 *
92190 * @param string $input The string to parse.
92191 * @param string $delimiter Set the field delimiter (one character
92192 *   only).
92193 * @param string $enclosure Set the field enclosure character (one
92194 *   character only).
92195 * @param string $escape Set the escape character (at most one
92196 *   character). Defaults as a backslash (\) An empty string ("")
92197 *   disables the proprietary escape mechanism.
92198 * @return array Returns an indexed array containing the fields read.
92199 * @since PHP 5 >= 5.3.0, PHP 7
92200 **/
92201function str_getcsv($input, $delimiter, $enclosure, $escape){}
92202
92203/**
92204 * Case-insensitive version of
92205 *
92206 * This function returns a string or an array with all occurrences of
92207 * {@link search} in {@link subject} (ignoring case) replaced with the
92208 * given {@link replace} value. If you don't need fancy replacing rules,
92209 * you should generally use this function instead of {@link preg_replace}
92210 * with the i modifier.
92211 *
92212 * @param mixed $search The value being searched for, otherwise known
92213 *   as the needle. An array may be used to designate multiple needles.
92214 * @param mixed $replace The replacement value that replaces found
92215 *   {@link search} values. An array may be used to designate multiple
92216 *   replacements.
92217 * @param mixed $subject The string or array being searched and
92218 *   replaced on, otherwise known as the haystack. If {@link subject} is
92219 *   an array, then the search and replace is performed with every entry
92220 *   of {@link subject}, and the return value is an array as well.
92221 * @param int $count If passed, this will be set to the number of
92222 *   replacements performed.
92223 * @return mixed Returns a string or an array of replacements.
92224 * @since PHP 5, PHP 7
92225 **/
92226function str_ireplace($search, $replace, $subject, &$count){}
92227
92228/**
92229 * Pad a string to a certain length with another string
92230 *
92231 * This function returns the {@link input} string padded on the left, the
92232 * right, or both sides to the specified padding length. If the optional
92233 * argument {@link pad_string} is not supplied, the {@link input} is
92234 * padded with spaces, otherwise it is padded with characters from {@link
92235 * pad_string} up to the limit.
92236 *
92237 * @param string $input The input string.
92238 * @param int $pad_length If the value of {@link pad_length} is
92239 *   negative, less than, or equal to the length of the input string, no
92240 *   padding takes place, and {@link input} will be returned.
92241 * @param string $pad_string
92242 * @param int $pad_type Optional argument {@link pad_type} can be
92243 *   STR_PAD_RIGHT, STR_PAD_LEFT, or STR_PAD_BOTH. If {@link pad_type} is
92244 *   not specified it is assumed to be STR_PAD_RIGHT.
92245 * @return string Returns the padded string.
92246 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
92247 **/
92248function str_pad($input, $pad_length, $pad_string, $pad_type){}
92249
92250/**
92251 * Repeat a string
92252 *
92253 * Returns {@link input} repeated {@link multiplier} times.
92254 *
92255 * @param string $input The string to be repeated.
92256 * @param int $multiplier Number of time the {@link input} string
92257 *   should be repeated. {@link multiplier} has to be greater than or
92258 *   equal to 0. If the {@link multiplier} is set to 0, the function will
92259 *   return an empty string.
92260 * @return string Returns the repeated string.
92261 * @since PHP 4, PHP 5, PHP 7
92262 **/
92263function str_repeat($input, $multiplier){}
92264
92265/**
92266 * Replace all occurrences of the search string with the replacement
92267 * string
92268 *
92269 * This function returns a string or an array with all occurrences of
92270 * {@link search} in {@link subject} replaced with the given {@link
92271 * replace} value.
92272 *
92273 * If you don't need fancy replacing rules (like regular expressions),
92274 * you should use this function instead of {@link preg_replace}.
92275 *
92276 * @param mixed $search The value being searched for, otherwise known
92277 *   as the needle. An array may be used to designate multiple needles.
92278 * @param mixed $replace The replacement value that replaces found
92279 *   {@link search} values. An array may be used to designate multiple
92280 *   replacements.
92281 * @param mixed $subject The string or array being searched and
92282 *   replaced on, otherwise known as the haystack. If {@link subject} is
92283 *   an array, then the search and replace is performed with every entry
92284 *   of {@link subject}, and the return value is an array as well.
92285 * @param int $count If passed, this will be set to the number of
92286 *   replacements performed.
92287 * @return mixed This function returns a string or an array with the
92288 *   replaced values.
92289 * @since PHP 4, PHP 5, PHP 7
92290 **/
92291function str_replace($search, $replace, $subject, &$count){}
92292
92293/**
92294 * Perform the rot13 transform on a string
92295 *
92296 * Performs the ROT13 encoding on the {@link str} argument and returns
92297 * the resulting string.
92298 *
92299 * The ROT13 encoding simply shifts every letter by 13 places in the
92300 * alphabet while leaving non-alpha characters untouched. Encoding and
92301 * decoding are done by the same function, passing an encoded string as
92302 * argument will return the original version.
92303 *
92304 * @param string $str The input string.
92305 * @return string Returns the ROT13 version of the given string.
92306 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
92307 **/
92308function str_rot13($str){}
92309
92310/**
92311 * Randomly shuffles a string
92312 *
92313 * @param string $str The input string.
92314 * @return string Returns the shuffled string.
92315 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
92316 **/
92317function str_shuffle($str){}
92318
92319/**
92320 * Convert a string to an array
92321 *
92322 * Converts a string to an array.
92323 *
92324 * @param string $string The input string.
92325 * @param int $split_length Maximum length of the chunk.
92326 * @return array If the optional {@link split_length} parameter is
92327 *   specified, the returned array will be broken down into chunks with
92328 *   each being {@link split_length} in length, otherwise each chunk will
92329 *   be one character in length.
92330 * @since PHP 5, PHP 7
92331 **/
92332function str_split($string, $split_length){}
92333
92334/**
92335 * Return information about words used in a string
92336 *
92337 * Counts the number of words inside {@link string}. If the optional
92338 * {@link format} is not specified, then the return value will be an
92339 * integer representing the number of words found. In the event the
92340 * {@link format} is specified, the return value will be an array,
92341 * content of which is dependent on the {@link format}. The possible
92342 * value for the {@link format} and the resultant outputs are listed
92343 * below.
92344 *
92345 * For the purpose of this function, 'word' is defined as a locale
92346 * dependent string containing alphabetic characters, which also may
92347 * contain, but not start with ' and - characters.
92348 *
92349 * @param string $string The string
92350 * @param int $format Specify the return value of this function. The
92351 *   current supported values are: 0 - returns the number of words found
92352 *   1 - returns an array containing all the words found inside the
92353 *   {@link string} 2 - returns an associative array, where the key is
92354 *   the numeric position of the word inside the {@link string} and the
92355 *   value is the actual word itself
92356 * @param string $charlist A list of additional characters which will
92357 *   be considered as 'word'
92358 * @return mixed Returns an array or an integer, depending on the
92359 *   {@link format} chosen.
92360 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
92361 **/
92362function str_word_count($string, $format, $charlist){}
92363
92364/**
92365 * Return part of a string
92366 *
92367 * Returns the portion of {@link string} specified by the {@link start}
92368 * and {@link length} parameters.
92369 *
92370 * @param string $string The input string.
92371 * @param int $start If {@link start} is non-negative, the returned
92372 *   string will start at the {@link start}'th position in {@link
92373 *   string}, counting from zero. For instance, in the string 'abcdef',
92374 *   the character at position 0 is 'a', the character at position 2 is
92375 *   'c', and so forth. If {@link start} is negative, the returned string
92376 *   will start at the {@link start}'th character from the end of {@link
92377 *   string}. If {@link string} is less than {@link start} characters
92378 *   long, FALSE will be returned.
92379 *
92380 *   Using a negative {@link start}
92381 *
92382 *   <?php $rest = substr("abcdef", -1); // returns "f" $rest =
92383 *   substr("abcdef", -2); // returns "ef" $rest = substr("abcdef", -3,
92384 *   1); // returns "d" ?>
92385 * @param int $length If {@link length} is given and is positive, the
92386 *   string returned will contain at most {@link length} characters
92387 *   beginning from {@link start} (depending on the length of {@link
92388 *   string}). If {@link length} is given and is negative, then that many
92389 *   characters will be omitted from the end of {@link string} (after the
92390 *   start position has been calculated when a {@link start} is
92391 *   negative). If {@link start} denotes the position of this truncation
92392 *   or beyond, FALSE will be returned. If {@link length} is given and is
92393 *   0, FALSE or NULL, an empty string will be returned. If {@link
92394 *   length} is omitted, the substring starting from {@link start} until
92395 *   the end of the string will be returned.
92396 * @return string Returns the extracted part of {@link string}; , or an
92397 *   empty string.
92398 * @since PHP 4, PHP 5, PHP 7
92399 **/
92400function substr($string, $start, $length){}
92401
92402/**
92403 * Binary safe comparison of two strings from an offset, up to length
92404 * characters
92405 *
92406 * {@link substr_compare} compares {@link main_str} from position {@link
92407 * offset} with {@link str} up to {@link length} characters.
92408 *
92409 * @param string $main_str The main string being compared.
92410 * @param string $str The secondary string being compared.
92411 * @param int $offset The start position for the comparison. If
92412 *   negative, it starts counting from the end of the string.
92413 * @param int $length The length of the comparison. The default value
92414 *   is the largest of the length of the {@link str} compared to the
92415 *   length of {@link main_str} minus the {@link offset}.
92416 * @param bool $case_insensitivity If {@link case_insensitivity} is
92417 *   TRUE, comparison is case insensitive.
92418 * @return int Returns < 0 if {@link main_str} from position {@link
92419 *   offset} is less than {@link str}, > 0 if it is greater than {@link
92420 *   str}, and 0 if they are equal. If {@link offset} is equal to (prior
92421 *   to PHP 7.2.18, 7.3.5) or greater than the length of {@link
92422 *   main_str}, or the {@link length} is set and is less than 0, (or,
92423 *   prior to PHP 5.5.11, less than 1) {@link substr_compare} prints a
92424 *   warning and returns FALSE.
92425 * @since PHP 5, PHP 7
92426 **/
92427function substr_compare($main_str, $str, $offset, $length, $case_insensitivity){}
92428
92429/**
92430 * Count the number of substring occurrences
92431 *
92432 * {@link substr_count} returns the number of times the {@link needle}
92433 * substring occurs in the {@link haystack} string. Please note that
92434 * {@link needle} is case sensitive.
92435 *
92436 * @param string $haystack The string to search in
92437 * @param string $needle The substring to search for
92438 * @param int $offset The offset where to start counting. If the offset
92439 *   is negative, counting starts from the end of the string.
92440 * @param int $length The maximum length after the specified offset to
92441 *   search for the substring. It outputs a warning if the offset plus
92442 *   the length is greater than the {@link haystack} length. A negative
92443 *   length counts from the end of {@link haystack}.
92444 * @return int This function returns an integer.
92445 * @since PHP 4, PHP 5, PHP 7
92446 **/
92447function substr_count($haystack, $needle, $offset, $length){}
92448
92449/**
92450 * Replace text within a portion of a string
92451 *
92452 * {@link substr_replace} replaces a copy of {@link string} delimited by
92453 * the {@link start} and (optionally) {@link length} parameters with the
92454 * string given in {@link replacement}.
92455 *
92456 * @param mixed $string The input string. An array of strings can be
92457 *   provided, in which case the replacements will occur on each string
92458 *   in turn. In this case, the {@link replacement}, {@link start} and
92459 *   {@link length} parameters may be provided either as scalar values to
92460 *   be applied to each input string in turn, or as arrays, in which case
92461 *   the corresponding array element will be used for each input string.
92462 * @param mixed $replacement The replacement string.
92463 * @param mixed $start If {@link start} is non-negative, the replacing
92464 *   will begin at the {@link start}'th offset into {@link string}. If
92465 *   {@link start} is negative, the replacing will begin at the {@link
92466 *   start}'th character from the end of {@link string}.
92467 * @param mixed $length If given and is positive, it represents the
92468 *   length of the portion of {@link string} which is to be replaced. If
92469 *   it is negative, it represents the number of characters from the end
92470 *   of {@link string} at which to stop replacing. If it is not given,
92471 *   then it will default to strlen( {@link string} ); i.e. end the
92472 *   replacing at the end of {@link string}. Of course, if {@link length}
92473 *   is zero then this function will have the effect of inserting {@link
92474 *   replacement} into {@link string} at the given {@link start} offset.
92475 * @return mixed The result string is returned. If {@link string} is an
92476 *   array then array is returned.
92477 * @since PHP 4, PHP 5, PHP 7
92478 **/
92479function substr_replace($string, $replacement, $start, $length){}
92480
92481/**
92482 * Encrypts a cookie value according to current cookie encrpytion setting
92483 *
92484 * @param string $name Cookie name.
92485 * @param string $value Cookie value.
92486 * @return string Returns the encrypted string.
92487 * @since Suhosin >= 0.9.9
92488 **/
92489function suhosin_encrypt_cookie($name, $value){}
92490
92491/**
92492 * Returns an array containing the raw cookie values
92493 *
92494 * @return array Returns an array containing the raw cookie values.
92495 * @since Suhosin >= 0.9.9
92496 **/
92497function suhosin_get_raw_cookies(){}
92498
92499/**
92500 * Schedules the addition of an item in a working directory
92501 *
92502 * Adds the file, directory or symbolic link at {@link path} to the
92503 * working directory. The item will be added to the repository the next
92504 * time you call {@link svn_commit} on the working copy.
92505 *
92506 * @param string $path Path of item to add.
92507 * @param bool $recursive If item is directory, whether or not to
92508 *   recursively add all of its contents. Default is TRUE
92509 * @param bool $force If true, Subversion will recurse into already
92510 *   versioned directories in order to add unversioned files that may be
92511 *   hiding in those directories. Default is FALSE
92512 * @return bool
92513 * @since PECL svn >= 0.1.0
92514 **/
92515function svn_add($path, $recursive, $force){}
92516
92517/**
92518 * Retrieves authentication parameter
92519 *
92520 * Retrieves authentication parameter at {@link key}. For a list of valid
92521 * keys and their meanings, consult the authentication constants list.
92522 *
92523 * @param string $key String key name. Use the authentication constants
92524 *   defined by this extension to specify a key.
92525 * @return string Returns the string value of the parameter at {@link
92526 *   key}; returns NULL if parameter does not exist.
92527 * @since PECL svn >= 0.1.0
92528 **/
92529function svn_auth_get_parameter($key){}
92530
92531/**
92532 * Sets an authentication parameter
92533 *
92534 * Sets authentication parameter at {@link key} to {@link value}. For a
92535 * list of valid keys and their meanings, consult the authentication
92536 * constants list.
92537 *
92538 * @param string $key String key name. Use the authentication constants
92539 *   defined by this extension to specify a key.
92540 * @param string $value String value to set to parameter at key. Format
92541 *   of value varies with the parameter.
92542 * @return void
92543 * @since PECL svn >= 0.1.0
92544 **/
92545function svn_auth_set_parameter($key, $value){}
92546
92547/**
92548 * Get the SVN blame for a file
92549 *
92550 * Get the SVN blame of a file from a repository URL.
92551 *
92552 * @param string $repository_url The repository URL.
92553 * @param int $revision_no The revision number.
92554 * @return array An array of SVN blame information separated by line
92555 *   which includes the revision number, line number, line of code,
92556 *   author, and date.
92557 * @since PECL svn >= 0.3.0
92558 **/
92559function svn_blame($repository_url, $revision_no){}
92560
92561/**
92562 * Returns the contents of a file in a repository
92563 *
92564 * Returns the contents of the URL {@link repos_url} to a file in the
92565 * repository, optionally at revision number {@link revision_no}.
92566 *
92567 * @param string $repos_url String URL path to item in a repository.
92568 * @param int $revision_no Integer revision number of item to retrieve,
92569 *   default is the HEAD revision.
92570 * @return string Returns the string contents of the item from the
92571 *   repository on success, and FALSE on failure.
92572 * @since PECL svn >= 0.1.0
92573 **/
92574function svn_cat($repos_url, $revision_no){}
92575
92576/**
92577 * Checks out a working copy from the repository
92578 *
92579 * Checks out a working copy from the repository at {@link repos} to
92580 * {@link targetpath} at revision {@link revision}.
92581 *
92582 * @param string $repos String URL path to directory in repository to
92583 *   check out.
92584 * @param string $targetpath String local path to directory to check
92585 *   out in to
92586 * @param int $revision Integer revision number of repository to check
92587 *   out. Default is HEAD, the most recent revision.
92588 * @param int $flags Any combination of SVN_NON_RECURSIVE and
92589 *   SVN_IGNORE_EXTERNALS.
92590 * @return bool
92591 * @since PECL svn >= 0.1.0
92592 **/
92593function svn_checkout($repos, $targetpath, $revision, $flags){}
92594
92595/**
92596 * Recursively cleanup a working copy directory, finishing incomplete
92597 * operations and removing locks
92598 *
92599 * Recursively cleanup working copy directory {@link workingdir},
92600 * finishing any incomplete operations and removing working copy locks.
92601 * Use when a working copy is in limbo and needs to be usable again.
92602 *
92603 * @param string $workingdir String path to local working directory to
92604 *   cleanup
92605 * @return bool
92606 * @since PECL svn >= 0.1.0
92607 **/
92608function svn_cleanup($workingdir){}
92609
92610/**
92611 * Returns the version of the SVN client libraries
92612 *
92613 * @return string String version number, usually in form of x.y.z.
92614 * @since PECL svn >= 0.1.0
92615 **/
92616function svn_client_version(){}
92617
92618/**
92619 * Sends changes from the local working copy to the repository
92620 *
92621 * Commits changes made in the local working copy files enumerated in the
92622 * {@link targets} array to the repository, with the log message {@link
92623 * log}. Directories in the {@link targets} array will be recursively
92624 * committed unless {@link recursive} is set to FALSE.
92625 *
92626 * @param string $log String log text to commit
92627 * @param array $targets Array of local paths of files to be committed
92628 * @param bool $recursive Boolean flag to disable recursive committing
92629 *   of directories in the {@link targets} array. Default is TRUE.
92630 * @return array Returns array in form of:
92631 * @since PECL svn >= 0.1.0
92632 **/
92633function svn_commit($log, $targets, $recursive){}
92634
92635/**
92636 * Delete items from a working copy or repository
92637 *
92638 * Deletes the file, directory or symbolic link at {@link path} from the
92639 * working directory. The item will be deleted from the repository the
92640 * next time you call {@link svn_commit} on the working copy.
92641 *
92642 * @param string $path Path of item to delete.
92643 * @param bool $force If TRUE, the file will be deleted even if it has
92644 *   local modifications. Otherwise, local modifications will result in a
92645 *   failure. Default is FALSE
92646 * @return bool
92647 * @since PECL svn >= 0.4.0
92648 **/
92649function svn_delete($path, $force){}
92650
92651/**
92652 * Recursively diffs two paths
92653 *
92654 * Recursively diffs two paths, {@link path1} and {@link path2}.
92655 *
92656 * @param string $path1 First path to diff. This can be a URL to a
92657 *   file/directory in an SVN repository or a local file/directory path.
92658 * @param int $rev1 First path's revision number. Use SVN_REVISION_HEAD
92659 *   to specify the most recent revision.
92660 * @param string $path2 Second path to diff. See {@link path1} for
92661 *   description.
92662 * @param int $rev2 Second path's revision number. See {@link rev1} for
92663 *   description.
92664 * @return array Returns an array-list consisting of two streams: the
92665 *   first is the diff output and the second contains error stream
92666 *   output. The streams can be read using {@link fread}. Returns FALSE
92667 *   or NULL on error.
92668 * @since PECL svn >= 0.1.0
92669 **/
92670function svn_diff($path1, $rev1, $path2, $rev2){}
92671
92672/**
92673 * Export the contents of a SVN directory
92674 *
92675 * Export the contents of either a working copy or repository into a
92676 * 'clean' directory.
92677 *
92678 * @param string $frompath The path to the current repository.
92679 * @param string $topath The path to the new repository.
92680 * @param bool $working_copy If TRUE, it will export uncommitted files
92681 *   from the working copy.
92682 * @param int $revision_no
92683 * @return bool
92684 * @since PECL svn >= 0.3.0
92685 **/
92686function svn_export($frompath, $topath, $working_copy, $revision_no){}
92687
92688/**
92689 * Abort a transaction, returns true if everything is okay, false
92690 * otherwise
92691 *
92692 * @param resource $txn
92693 * @return bool
92694 * @since PECL svn >= 0.2.0
92695 **/
92696function svn_fs_abort_txn($txn){}
92697
92698/**
92699 * Creates and returns a stream that will be used to replace
92700 *
92701 * @param resource $root
92702 * @param string $path
92703 * @return resource
92704 * @since PECL svn >= 0.2.0
92705 **/
92706function svn_fs_apply_text($root, $path){}
92707
92708/**
92709 * Create a new transaction
92710 *
92711 * @param resource $repos
92712 * @param int $rev
92713 * @return resource
92714 * @since PECL svn >= 0.2.0
92715 **/
92716function svn_fs_begin_txn2($repos, $rev){}
92717
92718/**
92719 * Return true if everything is ok, false otherwise
92720 *
92721 * @param resource $root
92722 * @param string $path
92723 * @param string $name
92724 * @param string $value
92725 * @return bool
92726 * @since PECL svn >= 0.2.0
92727 **/
92728function svn_fs_change_node_prop($root, $path, $name, $value){}
92729
92730/**
92731 * Determines what kind of item lives at path in a given repository
92732 * fsroot
92733 *
92734 * @param resource $fsroot
92735 * @param string $path
92736 * @return int
92737 * @since PECL svn >= 0.1.0
92738 **/
92739function svn_fs_check_path($fsroot, $path){}
92740
92741/**
92742 * Return true if content is different, false otherwise
92743 *
92744 * @param resource $root1
92745 * @param string $path1
92746 * @param resource $root2
92747 * @param string $path2
92748 * @return bool
92749 * @since PECL svn >= 0.2.0
92750 **/
92751function svn_fs_contents_changed($root1, $path1, $root2, $path2){}
92752
92753/**
92754 * Copies a file or a directory, returns true if all is ok, false
92755 * otherwise
92756 *
92757 * @param resource $from_root
92758 * @param string $from_path
92759 * @param resource $to_root
92760 * @param string $to_path
92761 * @return bool
92762 * @since PECL svn >= 0.2.0
92763 **/
92764function svn_fs_copy($from_root, $from_path, $to_root, $to_path){}
92765
92766/**
92767 * Deletes a file or a directory, return true if all is ok, false
92768 * otherwise
92769 *
92770 * @param resource $root
92771 * @param string $path
92772 * @return bool
92773 * @since PECL svn >= 0.2.0
92774 **/
92775function svn_fs_delete($root, $path){}
92776
92777/**
92778 * Enumerates the directory entries under path; returns a hash of dir
92779 * names to file type
92780 *
92781 * @param resource $fsroot
92782 * @param string $path
92783 * @return array
92784 * @since PECL svn >= 0.1.0
92785 **/
92786function svn_fs_dir_entries($fsroot, $path){}
92787
92788/**
92789 * Returns a stream to access the contents of a file from a given version
92790 * of the fs
92791 *
92792 * @param resource $fsroot
92793 * @param string $path
92794 * @return resource
92795 * @since PECL svn >= 0.1.0
92796 **/
92797function svn_fs_file_contents($fsroot, $path){}
92798
92799/**
92800 * Returns the length of a file from a given version of the fs
92801 *
92802 * @param resource $fsroot
92803 * @param string $path
92804 * @return int
92805 * @since PECL svn >= 0.1.0
92806 **/
92807function svn_fs_file_length($fsroot, $path){}
92808
92809/**
92810 * Return true if the path points to a directory, false otherwise
92811 *
92812 * @param resource $root
92813 * @param string $path
92814 * @return bool
92815 * @since PECL svn >= 0.2.0
92816 **/
92817function svn_fs_is_dir($root, $path){}
92818
92819/**
92820 * Return true if the path points to a file, false otherwise
92821 *
92822 * @param resource $root
92823 * @param string $path
92824 * @return bool
92825 * @since PECL svn >= 0.2.0
92826 **/
92827function svn_fs_is_file($root, $path){}
92828
92829/**
92830 * Creates a new empty directory, returns true if all is ok, false
92831 * otherwise
92832 *
92833 * @param resource $root
92834 * @param string $path
92835 * @return bool
92836 * @since PECL svn >= 0.2.0
92837 **/
92838function svn_fs_make_dir($root, $path){}
92839
92840/**
92841 * Creates a new empty file, returns true if all is ok, false otherwise
92842 *
92843 * @param resource $root
92844 * @param string $path
92845 * @return bool
92846 * @since PECL svn >= 0.2.0
92847 **/
92848function svn_fs_make_file($root, $path){}
92849
92850/**
92851 * Returns the revision in which path under fsroot was created
92852 *
92853 * @param resource $fsroot
92854 * @param string $path
92855 * @return int
92856 * @since PECL svn >= 0.1.0
92857 **/
92858function svn_fs_node_created_rev($fsroot, $path){}
92859
92860/**
92861 * Returns the value of a property for a node
92862 *
92863 * @param resource $fsroot
92864 * @param string $path
92865 * @param string $propname
92866 * @return string
92867 * @since PECL svn >= 0.1.0
92868 **/
92869function svn_fs_node_prop($fsroot, $path, $propname){}
92870
92871/**
92872 * Return true if props are different, false otherwise
92873 *
92874 * @param resource $root1
92875 * @param string $path1
92876 * @param resource $root2
92877 * @param string $path2
92878 * @return bool
92879 * @since PECL svn >= 0.2.0
92880 **/
92881function svn_fs_props_changed($root1, $path1, $root2, $path2){}
92882
92883/**
92884 * Fetches the value of a named property
92885 *
92886 * @param resource $fs
92887 * @param int $revnum
92888 * @param string $propname
92889 * @return string
92890 * @since PECL svn >= 0.1.0
92891 **/
92892function svn_fs_revision_prop($fs, $revnum, $propname){}
92893
92894/**
92895 * Get a handle on a specific version of the repository root
92896 *
92897 * @param resource $fs
92898 * @param int $revnum
92899 * @return resource
92900 * @since PECL svn >= 0.1.0
92901 **/
92902function svn_fs_revision_root($fs, $revnum){}
92903
92904/**
92905 * Creates and returns a transaction root
92906 *
92907 * @param resource $txn
92908 * @return resource
92909 * @since PECL svn >= 0.2.0
92910 **/
92911function svn_fs_txn_root($txn){}
92912
92913/**
92914 * Returns the number of the youngest revision in the filesystem
92915 *
92916 * @param resource $fs
92917 * @return int
92918 * @since PECL svn >= 0.1.0
92919 **/
92920function svn_fs_youngest_rev($fs){}
92921
92922/**
92923 * Imports an unversioned path into a repository
92924 *
92925 * Commits unversioned {@link path} into repository at {@link url}. If
92926 * {@link path} is a directory and {@link nonrecursive} is FALSE, the
92927 * directory will be imported recursively.
92928 *
92929 * @param string $path Path of file or directory to import.
92930 * @param string $url Repository URL to import into.
92931 * @param bool $nonrecursive Whether or not to refrain from recursively
92932 *   processing directories.
92933 * @return bool
92934 * @since PECL svn >= 0.2.0
92935 **/
92936function svn_import($path, $url, $nonrecursive){}
92937
92938/**
92939 * Returns the commit log messages of a repository URL
92940 *
92941 * {@link svn_log} returns the complete history of the item at the
92942 * repository URL {@link repos_url}, or the history of a specific
92943 * revision if {@link start_revision} is set. This function is equivalent
92944 * to svn log --verbose -r $start_revision $repos_url.
92945 *
92946 * @param string $repos_url Repository URL of the item to retrieve log
92947 *   history from.
92948 * @param int $start_revision Revision number of the first log to
92949 *   retrieve. Use SVN_REVISION_HEAD to retrieve the log from the most
92950 *   recent revision.
92951 * @param int $end_revision Revision number of the last log to
92952 *   retrieve. Defaults to {@link start_revision} if specified or to
92953 *   SVN_REVISION_INITIAL otherwise.
92954 * @param int $limit Number of logs to retrieve.
92955 * @param int $flags Any combination of SVN_OMIT_MESSAGES,
92956 *   SVN_DISCOVER_CHANGED_PATHS and SVN_STOP_ON_COPY.
92957 * @return array On success, this function returns an array file
92958 *   listing in the format of:
92959 *
92960 *   [0] => Array, ordered most recent (highest) revision first ( [rev]
92961 *   => integer revision number [author] => string author name [msg] =>
92962 *   string log message [date] => string date formatted per ISO 8601,
92963 *   i.e. date('c') [paths] => Array, describing changed files ( [0] =>
92964 *   Array ( [action] => string letter signifying change [path] =>
92965 *   absolute repository path of changed file ) [1] => ... ) ) [1] => ...
92966 * @since PECL svn >= 0.1.0
92967 **/
92968function svn_log($repos_url, $start_revision, $end_revision, $limit, $flags){}
92969
92970/**
92971 * Returns list of directory contents in repository URL, optionally at
92972 * revision number
92973 *
92974 * This function queries the repository URL and returns a list of files
92975 * and directories, optionally from a specific revision. This is
92976 * equivalent to svn list $repos_url[@$revision_no]
92977 *
92978 * @param string $repos_url URL of the repository, eg.
92979 *   http://www.example.com/svnroot. To access a local Subversion
92980 *   repository via filesystem, use the file URI scheme, eg.
92981 *   file:///home/user/svn-repos
92982 * @param int $revision_no Integer revision number to retrieve listing
92983 *   of. When omitted, the HEAD revision is used.
92984 * @param bool $recurse Enables recursion.
92985 * @param bool $peg
92986 * @return array On success, this function returns an array file
92987 *   listing in the format of:
92988 *
92989 *   [0] => Array ( [created_rev] => integer revision number of last edit
92990 *   [last_author] => string author name of last edit [size] => integer
92991 *   byte file size of file [time] => string date of last edit in form 'M
92992 *   d H:i' or 'M d Y', depending on how old the file is [time_t] =>
92993 *   integer unix timestamp of last edit [name] => name of file/directory
92994 *   [type] => type, can be 'file' or 'dir' ) [1] => ...
92995 * @since PECL svn >= 0.1.0
92996 **/
92997function svn_ls($repos_url, $revision_no, $recurse, $peg){}
92998
92999/**
93000 * Creates a directory in a working copy or repository
93001 *
93002 * @param string $path The path to the working copy or repository.
93003 * @param string $log_message
93004 * @return bool
93005 * @since PECL svn >= 0.4.0
93006 **/
93007function svn_mkdir($path, $log_message){}
93008
93009/**
93010 * Create a new subversion repository at path
93011 *
93012 * @param string $path
93013 * @param array $config
93014 * @param array $fsconfig
93015 * @return resource
93016 * @since PECL svn >= 0.1.0
93017 **/
93018function svn_repos_create($path, $config, $fsconfig){}
93019
93020/**
93021 * Gets a handle on the filesystem for a repository
93022 *
93023 * @param resource $repos
93024 * @return resource
93025 * @since PECL svn >= 0.1.0
93026 **/
93027function svn_repos_fs($repos){}
93028
93029/**
93030 * Create a new transaction
93031 *
93032 * @param resource $repos
93033 * @param int $rev
93034 * @param string $author
93035 * @param string $log_msg
93036 * @return resource
93037 * @since PECL svn >= 0.2.0
93038 **/
93039function svn_repos_fs_begin_txn_for_commit($repos, $rev, $author, $log_msg){}
93040
93041/**
93042 * Commits a transaction and returns the new revision
93043 *
93044 * @param resource $txn
93045 * @return int
93046 * @since PECL svn >= 0.2.0
93047 **/
93048function svn_repos_fs_commit_txn($txn){}
93049
93050/**
93051 * Make a hot-copy of the repos at repospath; copy it to destpath
93052 *
93053 * @param string $repospath
93054 * @param string $destpath
93055 * @param bool $cleanlogs
93056 * @return bool
93057 * @since PECL svn >= 0.1.0
93058 **/
93059function svn_repos_hotcopy($repospath, $destpath, $cleanlogs){}
93060
93061/**
93062 * Open a shared lock on a repository
93063 *
93064 * @param string $path
93065 * @return resource
93066 * @since PECL svn >= 0.1.0
93067 **/
93068function svn_repos_open($path){}
93069
93070/**
93071 * Run recovery procedures on the repository located at path
93072 *
93073 * @param string $path
93074 * @return bool
93075 * @since PECL svn >= 0.1.0
93076 **/
93077function svn_repos_recover($path){}
93078
93079/**
93080 * Revert changes to the working copy
93081 *
93082 * Revert any local changes to the path in a working copy.
93083 *
93084 * @param string $path The path to the working repository.
93085 * @param bool $recursive Optionally make recursive changes.
93086 * @return bool
93087 * @since PECL svn >= 0.3.0
93088 **/
93089function svn_revert($path, $recursive){}
93090
93091/**
93092 * Returns the status of working copy files and directories
93093 *
93094 * Returns the status of working copy files and directories, giving
93095 * modifications, additions, deletions and other changes to items in the
93096 * working copy.
93097 *
93098 * @param string $path Local path to file or directory to retrieve
93099 *   status of.
93100 * @param int $flags Any combination of Svn::NON_RECURSIVE, Svn::ALL
93101 *   (regardless of modification status), Svn::SHOW_UPDATES (entries will
93102 *   be added for items that are out-of-date), Svn::NO_IGNORE (disregard
93103 *   svn:ignore properties when scanning for new files) and
93104 *   Svn::IGNORE_EXTERNALS.
93105 * @return array Returns a numerically indexed array of associative
93106 *   arrays detailing the status of items in the repository:
93107 * @since PECL svn >= 0.1.0
93108 **/
93109function svn_status($path, $flags){}
93110
93111/**
93112 * Update working copy
93113 *
93114 * Update working copy at {@link path} to revision {@link revno}. If
93115 * {@link recurse} is true, directories will be recursively updated.
93116 *
93117 * @param string $path Path to local working copy.
93118 * @param int $revno Revision number to update to, default is
93119 *   SVN_REVISION_HEAD.
93120 * @param bool $recurse Whether or not to recursively update
93121 *   directories.
93122 * @return int Returns new revision number on success, returns FALSE on
93123 *   failure.
93124 * @since PECL svn >= 0.1.0
93125 **/
93126function svn_update($path, $revno, $recurse){}
93127
93128/**
93129 * Async and non-blocking hostname to IP lookup
93130 *
93131 * @param string $hostname The host name.
93132 * @param callable $callback
93133 * @return bool
93134 * @since PECL swoole >= 1.9.0
93135 **/
93136function swoole_async_dns_lookup($hostname, $callback){}
93137
93138/**
93139 * Read file stream asynchronously
93140 *
93141 * @param string $filename The filename of the file being read.
93142 * @param callable $callback
93143 * @param int $chunk_size The name of the file.
93144 * @param int $offset The content readed from the file stream.
93145 * @return bool Whether the read is succeed.
93146 * @since PECL swoole >= 1.9.0
93147 **/
93148function swoole_async_read($filename, $callback, $chunk_size, $offset){}
93149
93150/**
93151 * Read a file asynchronously
93152 *
93153 * @param string $filename The filename of the file being read.
93154 * @param callable $callback
93155 * @return bool
93156 * @since PECL swoole >= 1.9.0
93157 **/
93158function swoole_async_readfile($filename, $callback){}
93159
93160/**
93161 * Update the async I/O options
93162 *
93163 * @param array $settings
93164 * @return void
93165 * @since PECL swoole >= 1.9.0
93166 **/
93167function swoole_async_set($settings){}
93168
93169/**
93170 * Write data to a file stream asynchronously
93171 *
93172 * @param string $filename The filename being written.
93173 * @param string $content The content writing to the file.
93174 * @param integer $offset The offset.
93175 * @param callable $callback
93176 * @return bool
93177 * @since PECL swoole >= 1.9.0
93178 **/
93179function swoole_async_write($filename, $content, $offset, $callback){}
93180
93181/**
93182 * Write data to a file asynchronously
93183 *
93184 * @param string $filename The filename being written.
93185 * @param string $content The content writing to the file.
93186 * @param callable $callback
93187 * @param int $flags
93188 * @return bool
93189 * @since PECL swoole >= 1.9.0
93190 **/
93191function swoole_async_writefile($filename, $content, $callback, $flags){}
93192
93193/**
93194 * Get the file description which are ready to read/write or error
93195 *
93196 * @param array $read_array
93197 * @param array $write_array
93198 * @param array $error_array
93199 * @param float $timeout
93200 * @return int
93201 * @since PECL swoole >= 1.9.0
93202 **/
93203function swoole_client_select(&$read_array, &$write_array, &$error_array, $timeout){}
93204
93205/**
93206 * Get the number of CPU
93207 *
93208 * @return int The number of CPU.
93209 * @since PECL swoole >= 1.9.0
93210 **/
93211function swoole_cpu_num(){}
93212
93213/**
93214 * Get the error code of the latest system call
93215 *
93216 * @return int
93217 * @since PECL swoole >= 1.9.0
93218 **/
93219function swoole_errno(){}
93220
93221/**
93222 * Add new callback functions of a socket into the EventLoop
93223 *
93224 * @param int $fd
93225 * @param callable $read_callback
93226 * @param callable $write_callback
93227 * @param int $events
93228 * @return int
93229 * @since PECL swoole >= 1.9.0
93230 **/
93231function swoole_event_add($fd, $read_callback, $write_callback, $events){}
93232
93233/**
93234 * Add callback function to the next event loop
93235 *
93236 * @param callable $callback
93237 * @return bool
93238 * @since PECL swoole >= 1.9.0
93239 **/
93240function swoole_event_defer($callback){}
93241
93242/**
93243 * Remove all event callback functions of a socket
93244 *
93245 * @param int $fd
93246 * @return bool
93247 * @since PECL swoole >= 1.9.0
93248 **/
93249function swoole_event_del($fd){}
93250
93251/**
93252 * Exit the eventloop, only available at the client side
93253 *
93254 * @return void
93255 * @since PECL swoole >= 1.9.0
93256 **/
93257function swoole_event_exit(){}
93258
93259/**
93260 * Update the event callback functions of a socket
93261 *
93262 * @param int $fd
93263 * @param callable $read_callback
93264 * @param callable $write_callback
93265 * @param int $events
93266 * @return bool
93267 * @since PECL swoole >= 1.9.0
93268 **/
93269function swoole_event_set($fd, $read_callback, $write_callback, $events){}
93270
93271/**
93272 * Start the event loop
93273 *
93274 * @return void
93275 * @since PECL swoole >= 1.9.0
93276 **/
93277function swoole_event_wait(){}
93278
93279/**
93280 * Write data to a socket
93281 *
93282 * @param int $fd
93283 * @param string $data
93284 * @return bool
93285 * @since PECL swoole >= 1.9.0
93286 **/
93287function swoole_event_write($fd, $data){}
93288
93289/**
93290 * Get the IPv4 IP addresses of each NIC on the machine
93291 *
93292 * @return array
93293 * @since PECL swoole >= 1.9.0
93294 **/
93295function swoole_get_local_ip(){}
93296
93297/**
93298 * Get the lastest error message
93299 *
93300 * @return int
93301 * @since PECL swoole >= 1.9.0
93302 **/
93303function swoole_last_error(){}
93304
93305/**
93306 * Load a swoole extension
93307 *
93308 * @param string $filename
93309 * @return mixed
93310 * @since PECL swoole >= 1.9.0
93311 **/
93312function swoole_load_module($filename){}
93313
93314/**
93315 * Select the file descriptions which are ready to read/write or error in
93316 * the eventloop
93317 *
93318 * @param array $read_array
93319 * @param array $write_array
93320 * @param array $error_array
93321 * @param float $timeout
93322 * @return int
93323 * @since PECL swoole >= 1.9.0
93324 **/
93325function swoole_select(&$read_array, &$write_array, &$error_array, $timeout){}
93326
93327/**
93328 * Set the process name
93329 *
93330 * @param string $process_name
93331 * @param int $size
93332 * @return void
93333 * @since PECL swoole >= 1.9.0
93334 **/
93335function swoole_set_process_name($process_name, $size){}
93336
93337/**
93338 * Convert the Errno into error messages
93339 *
93340 * @param int $errno
93341 * @param int $error_type
93342 * @return string
93343 * @since PECL swoole >= 1.9.0
93344 **/
93345function swoole_strerror($errno, $error_type){}
93346
93347/**
93348 * Trigger a one time callback function in the future
93349 *
93350 * @param int $ms
93351 * @param callable $callback
93352 * @param mixed $param
93353 * @return int
93354 * @since PECL swoole >= 1.9.0
93355 **/
93356function swoole_timer_after($ms, $callback, $param){}
93357
93358/**
93359 * Stop and destory a timer.
93360 *
93361 * Stop and destory a timer
93362 *
93363 * @param integer $timer_id
93364 * @return void
93365 * @since PECL swoole >= 1.9.0
93366 **/
93367function swoole_timer_clear($timer_id){}
93368
93369/**
93370 * Check if a timer callback function is existed
93371 *
93372 * @param int $timer_id
93373 * @return bool
93374 * @since PECL swoole >= 1.9.0
93375 **/
93376function swoole_timer_exists($timer_id){}
93377
93378/**
93379 * Trigger a timer tick callback function by time interval
93380 *
93381 * @param int $ms
93382 * @param callable $callback
93383 * @param mixed $param
93384 * @return int
93385 * @since PECL swoole >= 1.9.0
93386 **/
93387function swoole_timer_tick($ms, $callback, $param){}
93388
93389/**
93390 * Get the version of Swoole
93391 *
93392 * @return string The version of Swoole.
93393 * @since PECL swoole >= 1.9.0
93394 **/
93395function swoole_version(){}
93396
93397/**
93398 * Gets number of affected rows in last query
93399 *
93400 * {@link sybase_affected_rows} returns the number of rows affected by
93401 * the last INSERT, UPDATE or DELETE query on the server associated with
93402 * the specified link identifier.
93403 *
93404 * This command is not effective for SELECT statements, only on
93405 * statements which modify records. To retrieve the number of rows
93406 * returned from a SELECT, use {@link sybase_num_rows}.
93407 *
93408 * @param resource $link_identifier If the link identifier isn't
93409 *   specified, the last opened link is assumed.
93410 * @return int Returns the number of affected rows, as an integer.
93411 * @since PHP 4, PHP 5
93412 **/
93413function sybase_affected_rows($link_identifier){}
93414
93415/**
93416 * Closes a Sybase connection
93417 *
93418 * {@link sybase_close} closes the link to a Sybase database that's
93419 * associated with the specified link {@link link_identifier}.
93420 *
93421 * Note that this isn't usually necessary, as non-persistent open links
93422 * are automatically closed at the end of the script's execution.
93423 *
93424 * {@link sybase_close} will not close persistent links generated by
93425 * {@link sybase_pconnect}.
93426 *
93427 * @param resource $link_identifier If the link identifier isn't
93428 *   specified, the last opened link is assumed.
93429 * @return bool
93430 * @since PHP 4, PHP 5
93431 **/
93432function sybase_close($link_identifier){}
93433
93434/**
93435 * Opens a Sybase server connection
93436 *
93437 * {@link sybase_connect} establishes a connection to a Sybase server.
93438 *
93439 * In case a second call is made to {@link sybase_connect} with the same
93440 * arguments, no new link will be established, but instead, the link
93441 * identifier of the already opened link will be returned.
93442 *
93443 * The link to the server will be closed as soon as the execution of the
93444 * script ends, unless it's closed earlier by explicitly calling {@link
93445 * sybase_close}.
93446 *
93447 * @param string $servername The servername argument has to be a valid
93448 *   servername that is defined in the 'interfaces' file.
93449 * @param string $username Sybase user name
93450 * @param string $password Password associated with {@link username}.
93451 * @param string $charset Specifies the charset for the connection
93452 * @param string $appname Specifies an appname for the Sybase
93453 *   connection. This allow you to make separate connections in the same
93454 *   script to the same database. This may come handy when you have
93455 *   started a transaction in your current connection, and you need to be
93456 *   able to do a separate query which cannot be performed inside this
93457 *   transaction.
93458 * @param bool $new Whether to open a new connection or use the
93459 *   existing one.
93460 * @return resource Returns a positive Sybase link identifier on
93461 *   success, or FALSE on failure.
93462 * @since PHP 4, PHP 5
93463 **/
93464function sybase_connect($servername, $username, $password, $charset, $appname, $new){}
93465
93466/**
93467 * Moves internal row pointer
93468 *
93469 * {@link sybase_data_seek} moves the internal row pointer of the Sybase
93470 * result associated with the specified result identifier to pointer to
93471 * the specified row number. The next call to {@link sybase_fetch_row}
93472 * would return that row.
93473 *
93474 * @param resource $result_identifier
93475 * @param int $row_number
93476 * @return bool
93477 * @since PHP 4, PHP 5
93478 **/
93479function sybase_data_seek($result_identifier, $row_number){}
93480
93481/**
93482 * Sets the deadlock retry count
93483 *
93484 * Using {@link sybase_deadlock_retry_count}, the number of retries can
93485 * be defined in cases of deadlocks. By default, every deadlock is
93486 * retried an infinite number of times or until the process is killed by
93487 * Sybase, the executing script is killed (for instance, by {@link
93488 * set_time_limit}) or the query succeeds.
93489 *
93490 * @param int $retry_count Values for retry_count -1 Retry forever
93491 *   (default) 0 Do not retry n Retry n times
93492 * @return void
93493 * @since PHP 4 >= 4.3.0, PHP 5
93494 **/
93495function sybase_deadlock_retry_count($retry_count){}
93496
93497/**
93498 * Fetch row as array
93499 *
93500 * {@link sybase_fetch_array} is an extended version of {@link
93501 * sybase_fetch_row}. In addition to storing the data in the numeric
93502 * indices of the result array, it also stores the data in associative
93503 * indices, using the field names as keys.
93504 *
93505 * An important thing to note is that using {@link sybase_fetch_array} is
93506 * NOT significantly slower than using {@link sybase_fetch_row}, while it
93507 * provides a significant added value.
93508 *
93509 * @param resource $result
93510 * @return array Returns an array that corresponds to the fetched row,
93511 *   or FALSE if there are no more rows.
93512 * @since PHP 4, PHP 5
93513 **/
93514function sybase_fetch_array($result){}
93515
93516/**
93517 * Fetch a result row as an associative array
93518 *
93519 * {@link sybase_fetch_assoc} is a version of {@link sybase_fetch_row}
93520 * that uses column names instead of integers for indices in the result
93521 * array. Columns from different tables with the same names are returned
93522 * as name, name1, name2, ..., nameN.
93523 *
93524 * An important thing to note is that using {@link sybase_fetch_assoc} is
93525 * NOT significantly slower than using {@link sybase_fetch_row}, while it
93526 * provides a significant added value.
93527 *
93528 * @param resource $result
93529 * @return array Returns an array that corresponds to the fetched row,
93530 *   or FALSE if there are no more rows.
93531 * @since PHP 4 >= 4.3.0, PHP 5
93532 **/
93533function sybase_fetch_assoc($result){}
93534
93535/**
93536 * Get field information from a result
93537 *
93538 * {@link sybase_fetch_field} can be used in order to obtain information
93539 * about fields in a certain query result.
93540 *
93541 * @param resource $result
93542 * @param int $field_offset If the field offset isn't specified, the
93543 *   next field that wasn't yet retrieved by {@link sybase_fetch_field}
93544 *   is retrieved.
93545 * @return object Returns an object containing field information.
93546 * @since PHP 4, PHP 5
93547 **/
93548function sybase_fetch_field($result, $field_offset){}
93549
93550/**
93551 * Fetch a row as an object
93552 *
93553 * {@link sybase_fetch_object} is similar to {@link sybase_fetch_assoc},
93554 * with one difference - an object is returned, instead of an array.
93555 *
93556 * Speed-wise, the function is identical to {@link sybase_fetch_array},
93557 * and almost as quick as {@link sybase_fetch_row} (the difference is
93558 * insignificant).
93559 *
93560 * @param resource $result
93561 * @param mixed $object Use the second {@link object} to specify the
93562 *   type of object you want to return. If this parameter is omitted, the
93563 *   object will be of type stdClass.
93564 * @return object Returns an object with properties that correspond to
93565 *   the fetched row, or FALSE if there are no more rows.
93566 * @since PHP 4, PHP 5
93567 **/
93568function sybase_fetch_object($result, $object){}
93569
93570/**
93571 * Get a result row as an enumerated array
93572 *
93573 * {@link sybase_fetch_row} fetches one row of data from the result
93574 * associated with the specified result identifier.
93575 *
93576 * Subsequent call to {@link sybase_fetch_row} would return the next row
93577 * in the result set, or FALSE if there are no more rows.
93578 *
93579 * @param resource $result
93580 * @return array Returns an array that corresponds to the fetched row,
93581 *   or FALSE if there are no more rows. Each result column is stored in
93582 *   an array offset, starting at offset 0.
93583 * @since PHP 4, PHP 5
93584 **/
93585function sybase_fetch_row($result){}
93586
93587/**
93588 * Sets field offset
93589 *
93590 * Seeks to the specified field offset. If the next call to {@link
93591 * sybase_fetch_field} won't include a field offset, this field would be
93592 * returned.
93593 *
93594 * @param resource $result
93595 * @param int $field_offset
93596 * @return bool
93597 * @since PHP 4, PHP 5
93598 **/
93599function sybase_field_seek($result, $field_offset){}
93600
93601/**
93602 * Frees result memory
93603 *
93604 * {@link sybase_free_result} only needs to be called if you are worried
93605 * about using too much memory while your script is running. All result
93606 * memory will automatically be freed when the script ends. You may call
93607 * {@link sybase_free_result} with the result identifier as an argument
93608 * and the associated result memory will be freed.
93609 *
93610 * @param resource $result
93611 * @return bool
93612 * @since PHP 4, PHP 5
93613 **/
93614function sybase_free_result($result){}
93615
93616/**
93617 * Returns the last message from the server
93618 *
93619 * {@link sybase_get_last_message} returns the last message reported by
93620 * the server.
93621 *
93622 * @return string Returns the message as a string.
93623 * @since PHP 4, PHP 5
93624 **/
93625function sybase_get_last_message(){}
93626
93627/**
93628 * Sets minimum client severity
93629 *
93630 * {@link sybase_min_client_severity} sets the minimum client severity
93631 * level.
93632 *
93633 * @param int $severity
93634 * @return void
93635 * @since PHP 4, PHP 5
93636 **/
93637function sybase_min_client_severity($severity){}
93638
93639/**
93640 * Sets minimum error severity
93641 *
93642 * {@link sybase_min_error_severity} sets the minimum error severity
93643 * level.
93644 *
93645 * @param int $severity
93646 * @return void
93647 * @since PHP 4, PHP 5
93648 **/
93649function sybase_min_error_severity($severity){}
93650
93651/**
93652 * Sets minimum message severity
93653 *
93654 * {@link sybase_min_message_severity} sets the minimum message severity
93655 * level.
93656 *
93657 * @param int $severity
93658 * @return void
93659 * @since PHP 4, PHP 5
93660 **/
93661function sybase_min_message_severity($severity){}
93662
93663/**
93664 * Sets minimum server severity
93665 *
93666 * {@link sybase_min_server_severity} sets the minimum server severity
93667 * level.
93668 *
93669 * @param int $severity
93670 * @return void
93671 * @since PHP 4, PHP 5
93672 **/
93673function sybase_min_server_severity($severity){}
93674
93675/**
93676 * Gets the number of fields in a result set
93677 *
93678 * {@link sybase_num_fields} returns the number of fields in a result
93679 * set.
93680 *
93681 * @param resource $result
93682 * @return int Returns the number of fields as an integer.
93683 * @since PHP 4, PHP 5
93684 **/
93685function sybase_num_fields($result){}
93686
93687/**
93688 * Get number of rows in a result set
93689 *
93690 * {@link sybase_num_rows} returns the number of rows in a result set.
93691 *
93692 * @param resource $result
93693 * @return int Returns the number of rows as an integer.
93694 * @since PHP 4, PHP 5
93695 **/
93696function sybase_num_rows($result){}
93697
93698/**
93699 * Open persistent Sybase connection
93700 *
93701 * {@link sybase_pconnect} acts very much like {@link sybase_connect}
93702 * with two major differences.
93703 *
93704 * First, when connecting, the function would first try to find a
93705 * (persistent) link that's already open with the same host, username and
93706 * password. If one is found, an identifier for it will be returned
93707 * instead of opening a new connection.
93708 *
93709 * Second, the connection to the SQL server will not be closed when the
93710 * execution of the script ends. Instead, the link will remain open for
93711 * future use ({@link sybase_close} will not close links established by
93712 * {@link sybase_pconnect}).
93713 *
93714 * This type of links is therefore called 'persistent'.
93715 *
93716 * @param string $servername The servername argument has to be a valid
93717 *   servername that is defined in the 'interfaces' file.
93718 * @param string $username Sybase user name
93719 * @param string $password Password associated with {@link username}.
93720 * @param string $charset Specifies the charset for the connection
93721 * @param string $appname Specifies an appname for the Sybase
93722 *   connection. This allow you to make separate connections in the same
93723 *   script to the same database. This may come handy when you have
93724 *   started a transaction in your current connection, and you need to be
93725 *   able to do a separate query which cannot be performed inside this
93726 *   transaction.
93727 * @return resource Returns a positive Sybase persistent link
93728 *   identifier on success, or FALSE on error.
93729 * @since PHP 4, PHP 5
93730 **/
93731function sybase_pconnect($servername, $username, $password, $charset, $appname){}
93732
93733/**
93734 * Sends a Sybase query
93735 *
93736 * {@link sybase_query} sends a query to the currently active database on
93737 * the server that's associated with the specified link identifier.
93738 *
93739 * @param string $query
93740 * @param resource $link_identifier If the link identifier isn't
93741 *   specified, the last opened link is assumed. If no link is open, the
93742 *   function tries to establish a link as if {@link sybase_connect} was
93743 *   called, and use it.
93744 * @return mixed Returns a positive Sybase result identifier on
93745 *   success, FALSE on error, or TRUE if the query was successful but
93746 *   didn't return any columns.
93747 * @since PHP 4, PHP 5
93748 **/
93749function sybase_query($query, $link_identifier){}
93750
93751/**
93752 * Get result data
93753 *
93754 * Returns the contents of the cell at the row and offset in the
93755 * specified Sybase result set.
93756 *
93757 * When working on large result sets, you should consider using one of
93758 * the functions that fetch an entire row (specified below). As these
93759 * functions return the contents of multiple cells in one function call,
93760 * they're MUCH quicker than sybase_result(). Also, note that specifying
93761 * a numeric offset for the field argument is much quicker than
93762 * specifying a fieldname or tablename.fieldname argument.
93763 *
93764 * Recommended high-performance alternatives: {@link sybase_fetch_row},
93765 * {@link sybase_fetch_array} and {@link sybase_fetch_object}.
93766 *
93767 * @param resource $result
93768 * @param int $row
93769 * @param mixed $field The field argument can be the field's offset, or
93770 *   the field's name, or the field's table dot field's name
93771 *   (tablename.fieldname). If the column name has been aliased ('select
93772 *   foo as bar from...'), use the alias instead of the column name.
93773 * @return string {@link sybase_result} returns the contents of one
93774 *   cell from a Sybase result set.
93775 * @since PHP 4, PHP 5
93776 **/
93777function sybase_result($result, $row, $field){}
93778
93779/**
93780 * Selects a Sybase database
93781 *
93782 * {@link sybase_select_db} sets the current active database on the
93783 * server that's associated with the specified link identifier.
93784 *
93785 * Every subsequent call to {@link sybase_query} will be made on the
93786 * active database.
93787 *
93788 * @param string $database_name
93789 * @param resource $link_identifier If no link identifier is specified,
93790 *   the last opened link is assumed. If no link is open, the function
93791 *   will try to establish a link as if {@link sybase_connect} was
93792 *   called, and use it.
93793 * @return bool
93794 * @since PHP 4, PHP 5
93795 **/
93796function sybase_select_db($database_name, $link_identifier){}
93797
93798/**
93799 * Sets the handler called when a server message is raised
93800 *
93801 * {@link sybase_set_message_handler} sets a user function to handle
93802 * messages generated by the server. You may specify the name of a global
93803 * function, or use an array to specify an object reference and a method
93804 * name.
93805 *
93806 * @param callable $handler The handler expects five arguments in the
93807 *   following order: message number, severity, state, line number and
93808 *   description. The first four are integers. The last is a string. If
93809 *   the function returns FALSE, PHP generates an ordinary error message.
93810 * @param resource $link_identifier If the link identifier isn't
93811 *   specified, the last opened link is assumed.
93812 * @return bool
93813 * @since PHP 4 >= 4.3.0, PHP 5
93814 **/
93815function sybase_set_message_handler($handler, $link_identifier){}
93816
93817/**
93818 * Send a Sybase query and do not block
93819 *
93820 * {@link sybase_unbuffered_query} sends a query to the currently active
93821 * database on the server that's associated with the specified link
93822 * identifier. If the link identifier isn't specified, the last opened
93823 * link is assumed. If no link is open, the function tries to establish a
93824 * link as if {@link sybase_connect} was called, and use it.
93825 *
93826 * Unlike {@link sybase_query}, {@link sybase_unbuffered_query} reads
93827 * only the first row of the result set. {@link sybase_fetch_array} and
93828 * similar function read more rows as needed. {@link sybase_data_seek}
93829 * reads up to the target row. The behavior may produce better
93830 * performance for large result sets.
93831 *
93832 * {@link sybase_num_rows} will only return the correct number of rows if
93833 * all result sets have been read. To Sybase, the number of rows is not
93834 * known and is therefore computed by the client implementation.
93835 *
93836 * @param string $query
93837 * @param resource $link_identifier
93838 * @param bool $store_result The optional {@link store_result} can be
93839 *   FALSE to indicate the resultsets shouldn't be fetched into memory,
93840 *   thus minimizing memory usage which is particularly interesting with
93841 *   very large resultsets.
93842 * @return resource Returns a positive Sybase result identifier on
93843 *   success, or FALSE on error.
93844 * @since PHP 4 >= 4.3.0, PHP 5
93845 **/
93846function sybase_unbuffered_query($query, $link_identifier, $store_result){}
93847
93848/**
93849 * Creates a symbolic link
93850 *
93851 * {@link symlink} creates a symbolic link to the existing {@link target}
93852 * with the specified name {@link link}.
93853 *
93854 * @param string $target Target of the link.
93855 * @param string $link The link name.
93856 * @return bool
93857 * @since PHP 4, PHP 5, PHP 7
93858 **/
93859function symlink($target, $link){}
93860
93861/**
93862 * Generate a system log message
93863 *
93864 * {@link syslog} generates a log message that will be distributed by the
93865 * system logger.
93866 *
93867 * For information on setting up a user defined log handler, see the
93868 * syslog.conf 5 Unix manual page. More information on the syslog
93869 * facilities and option can be found in the man pages for syslog 3 on
93870 * Unix machines.
93871 *
93872 * @param int $priority {@link priority} is a combination of the
93873 *   facility and the level. Possible values are: {@link syslog}
93874 *   Priorities (in descending order) Constant Description LOG_EMERG
93875 *   system is unusable LOG_ALERT action must be taken immediately
93876 *   LOG_CRIT critical conditions LOG_ERR error conditions LOG_WARNING
93877 *   warning conditions LOG_NOTICE normal, but significant, condition
93878 *   LOG_INFO informational message LOG_DEBUG debug-level message
93879 * @param string $message The message to send, except that the two
93880 *   characters %m will be replaced by the error message string
93881 *   (strerror) corresponding to the present value of errno.
93882 * @return bool
93883 * @since PHP 4, PHP 5, PHP 7
93884 **/
93885function syslog($priority, $message){}
93886
93887/**
93888 * Execute an external program and display the output
93889 *
93890 * {@link system} is just like the C version of the function in that it
93891 * executes the given {@link command} and outputs the result.
93892 *
93893 * The {@link system} call also tries to automatically flush the web
93894 * server's output buffer after each line of output if PHP is running as
93895 * a server module.
93896 *
93897 * If you need to execute a command and have all the data from the
93898 * command passed directly back without any interference, use the {@link
93899 * passthru} function.
93900 *
93901 * @param string $command The command that will be executed.
93902 * @param int $return_var If the {@link return_var} argument is
93903 *   present, then the return status of the executed command will be
93904 *   written to this variable.
93905 * @return string Returns the last line of the command output on
93906 *   success, and FALSE on failure.
93907 * @since PHP 4, PHP 5, PHP 7
93908 **/
93909function system($command, &$return_var){}
93910
93911/**
93912 * Gets system load average
93913 *
93914 * Returns three samples representing the average system load (the number
93915 * of processes in the system run queue) over the last 1, 5 and 15
93916 * minutes, respectively.
93917 *
93918 * @return array Returns an array with three samples (last 1, 5 and 15
93919 *   minutes).
93920 * @since PHP 5 >= 5.1.3, PHP 7
93921 **/
93922function sys_getloadavg(){}
93923
93924/**
93925 * Returns directory path used for temporary files
93926 *
93927 * Returns the path of the directory PHP stores temporary files in by
93928 * default.
93929 *
93930 * @return string Returns the path of the temporary directory.
93931 * @since PHP 5 >= 5.2.1, PHP 7
93932 **/
93933function sys_get_temp_dir(){}
93934
93935/**
93936 * Taint a string
93937 *
93938 * Make a string tainted. This is used for testing purpose only.
93939 *
93940 * @param string $string
93941 * @param string ...$vararg
93942 * @return bool Return TRUE if the transformation is done. Always
93943 *   return TRUE if the taint extension is not enabled.
93944 * @since PECL taint >=0.1.0
93945 **/
93946function taint(&$string, ...$vararg){}
93947
93948/**
93949 * Tangent
93950 *
93951 * {@link tan} returns the tangent of the {@link arg} parameter. The
93952 * {@link arg} parameter is in radians.
93953 *
93954 * @param float $arg The argument to process in radians
93955 * @return float The tangent of {@link arg}
93956 * @since PHP 4, PHP 5, PHP 7
93957 **/
93958function tan($arg){}
93959
93960/**
93961 * Hyperbolic tangent
93962 *
93963 * Returns the hyperbolic tangent of {@link arg}, defined as
93964 * sinh(arg)/cosh(arg).
93965 *
93966 * @param float $arg The argument to process
93967 * @return float The hyperbolic tangent of {@link arg}
93968 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
93969 **/
93970function tanh($arg){}
93971
93972/**
93973 * Performs a tcpwrap check
93974 *
93975 * This function consults the /etc/hosts.allow and /etc/hosts.deny files
93976 * to check if access to service {@link daemon} should be granted or
93977 * denied for a client.
93978 *
93979 * @param string $daemon The service name.
93980 * @param string $address The client remote address. Can be either an
93981 *   IP address or a domain name.
93982 * @param string $user An optional user name.
93983 * @param bool $nodns If {@link address} looks like domain name then
93984 *   DNS is used to resolve it to IP address; set {@link nodns} to TRUE
93985 *   to avoid this.
93986 * @return bool This function returns TRUE if access should be granted,
93987 *   FALSE otherwise.
93988 * @since PECL tcpwrap >= 0.1.0
93989 **/
93990function tcpwrap_check($daemon, $address, $user, $nodns){}
93991
93992/**
93993 * Create file with unique file name
93994 *
93995 * Creates a file with a unique filename, with access permission set to
93996 * 0600, in the specified directory. If the directory does not exist or
93997 * is not writable, {@link tempnam} may generate a file in the system's
93998 * temporary directory, and return the full path to that file, including
93999 * its name.
94000 *
94001 * @param string $dir The directory where the temporary filename will
94002 *   be created.
94003 * @param string $prefix The prefix of the generated temporary
94004 *   filename.
94005 * @return string Returns the new temporary filename (with path), or
94006 *   FALSE on failure.
94007 * @since PHP 4, PHP 5, PHP 7
94008 **/
94009function tempnam($dir, $prefix){}
94010
94011/**
94012 * Sets the default domain
94013 *
94014 * This function sets the domain to search within when calls are made to
94015 * {@link gettext}, usually the named after an application.
94016 *
94017 * @param string $text_domain The new message domain, or NULL to get
94018 *   the current setting without changing it
94019 * @return string If successful, this function returns the current
94020 *   message domain, after possibly changing it.
94021 * @since PHP 4, PHP 5, PHP 7
94022 **/
94023function textdomain($text_domain){}
94024
94025/**
94026 * Returns the Number of Tidy accessibility warnings encountered for
94027 * specified document
94028 *
94029 * {@link tidy_access_count} returns the number of accessibility warnings
94030 * found for the specified document.
94031 *
94032 * @param tidy $object
94033 * @return int Returns the number of warnings.
94034 * @since PHP 5, PHP 7, PECL tidy >= 0.5.2
94035 **/
94036function tidy_access_count($object){}
94037
94038/**
94039 * Execute configured cleanup and repair operations on parsed markup
94040 *
94041 * This function cleans and repairs the given tidy {@link object}.
94042 *
94043 * @param tidy $object
94044 * @return bool
94045 * @since PHP 5, PHP 7, PECL tidy >= 0.5.2
94046 **/
94047function tidy_clean_repair($object){}
94048
94049/**
94050 * Returns the Number of Tidy configuration errors encountered for
94051 * specified document
94052 *
94053 * Returns the number of errors encountered in the configuration of the
94054 * specified tidy {@link object}.
94055 *
94056 * @param tidy $object
94057 * @return int Returns the number of errors.
94058 * @since PHP 5, PHP 7, PECL tidy >= 0.5.2
94059 **/
94060function tidy_config_count($object){}
94061
94062/**
94063 * Run configured diagnostics on parsed and repaired markup
94064 *
94065 * Runs diagnostic tests on the given tidy {@link object}, adding some
94066 * more information about the document in the error buffer.
94067 *
94068 * @param tidy $object
94069 * @return bool
94070 * @since PHP 5, PHP 7, PECL tidy >= 0.5.2
94071 **/
94072function tidy_diagnose($object){}
94073
94074/**
94075 * Returns the Number of Tidy errors encountered for specified document
94076 *
94077 * Returns the number of Tidy errors encountered for the specified
94078 * document.
94079 *
94080 * @param tidy $object
94081 * @return int Returns the number of errors.
94082 * @since PHP 5, PHP 7, PECL tidy >= 0.5.2
94083 **/
94084function tidy_error_count($object){}
94085
94086/**
94087 * Returns the value of the specified configuration option for the tidy
94088 * document
94089 *
94090 * Returns the value of the specified {@link option} for the specified
94091 * tidy {@link object}.
94092 *
94093 * @param tidy $object
94094 * @param string $option You will find a list with each configuration
94095 *   option and their types at: .
94096 * @return mixed Returns the value of the specified {@link option}. The
94097 *   return type depends on the type of the specified one.
94098 * @since PHP 5, PHP 7, PECL tidy >= 0.5.2
94099 **/
94100function tidy_getopt($object, $option){}
94101
94102/**
94103 * Returns a object starting from the tag of the tidy parse tree
94104 *
94105 * Returns a tidyNode object starting from the <body> tag of the tidy
94106 * parse tree.
94107 *
94108 * @param tidy $object
94109 * @return tidyNode Returns a tidyNode object starting from the <body>
94110 *   tag of the tidy parse tree.
94111 * @since PHP 5, PHP 7, PECL tidy 0.5.2-1.0
94112 **/
94113function tidy_get_body($object){}
94114
94115/**
94116 * Get current Tidy configuration
94117 *
94118 * Gets the list of the configuration options in use by the given tidy
94119 * {@link object}.
94120 *
94121 * @param tidy $object
94122 * @return array Returns an array of configuration options.
94123 * @since PHP 5, PHP 7, PECL tidy >= 0.7.0
94124 **/
94125function tidy_get_config($object){}
94126
94127/**
94128 * Return warnings and errors which occurred parsing the specified
94129 * document
94130 *
94131 * (property):
94132 *
94133 * Returns warnings and errors which occurred parsing the specified
94134 * document.
94135 *
94136 * @param tidy $tidy
94137 * @return string Returns the error buffer as a string.
94138 * @since PHP 5, PHP 7, PECL tidy >= 0.5.2
94139 **/
94140function tidy_get_error_buffer($tidy){}
94141
94142/**
94143 * Returns a object starting from the tag of the tidy parse tree
94144 *
94145 * Returns a tidyNode object starting from the <head> tag of the tidy
94146 * parse tree.
94147 *
94148 * @param tidy $object
94149 * @return tidyNode Returns the tidyNode object.
94150 * @since PHP 5, PHP 7, PECL tidy 0.5.2-1.0.0
94151 **/
94152function tidy_get_head($object){}
94153
94154/**
94155 * Returns a object starting from the tag of the tidy parse tree
94156 *
94157 * Returns a tidyNode object starting from the <html> tag of the tidy
94158 * parse tree.
94159 *
94160 * @param tidy $object
94161 * @return tidyNode Returns the tidyNode object.
94162 * @since PHP 5, PHP 7, PECL tidy 0.5.2-1.0.0
94163 **/
94164function tidy_get_html($object){}
94165
94166/**
94167 * Get the Detected HTML version for the specified document
94168 *
94169 * Returns the detected HTML version for the specified tidy {@link
94170 * object}.
94171 *
94172 * @param tidy $object
94173 * @return int Returns the detected HTML version.
94174 * @since PHP 5, PHP 7, PECL tidy >= 0.5.2
94175 **/
94176function tidy_get_html_ver($object){}
94177
94178/**
94179 * Returns the documentation for the given option name
94180 *
94181 * {@link tidy_get_opt_doc} returns the documentation for the given
94182 * option name.
94183 *
94184 * @param tidy $object
94185 * @param string $optname The option name
94186 * @return string Returns a string if the option exists and has
94187 *   documentation available, or FALSE otherwise.
94188 * @since PHP 5 >= 5.1.0, PHP 7
94189 **/
94190function tidy_get_opt_doc($object, $optname){}
94191
94192/**
94193 * Return a string representing the parsed tidy markup
94194 *
94195 * Gets a string with the repaired html.
94196 *
94197 * @param tidy $object
94198 * @return string Returns the parsed tidy markup.
94199 * @since PHP 5, PHP 7, PECL tidy >= 0.5.2
94200 **/
94201function tidy_get_output($object){}
94202
94203/**
94204 * Get release date (version) for Tidy library
94205 *
94206 * Gets the release date of the Tidy library.
94207 *
94208 * @return string Returns a string with the release date of the Tidy
94209 *   library, which may be 'unknown'.
94210 * @since PHP 5, PHP 7, PECL tidy >= 0.5.2
94211 **/
94212function tidy_get_release(){}
94213
94214/**
94215 * Returns a object representing the root of the tidy parse tree
94216 *
94217 * Returns a tidyNode object representing the root of the tidy parse
94218 * tree.
94219 *
94220 * @param tidy $object
94221 * @return tidyNode Returns the tidyNode object.
94222 * @since PHP 5, PHP 7, PECL tidy 0.5.2-1.0.0
94223 **/
94224function tidy_get_root($object){}
94225
94226/**
94227 * Get status of specified document
94228 *
94229 * Returns the status for the specified tidy {@link object}.
94230 *
94231 * @param tidy $object
94232 * @return int Returns 0 if no error/warning was raised, 1 for warnings
94233 *   or accessibility errors, or 2 for errors.
94234 * @since PHP 5, PHP 7, PECL tidy >= 0.5.2
94235 **/
94236function tidy_get_status($object){}
94237
94238/**
94239 * Indicates if the document is a XHTML document
94240 *
94241 * Tells if the document is a XHTML document.
94242 *
94243 * @param tidy $object
94244 * @return bool This function returns TRUE if the specified tidy {@link
94245 *   object} is a XHTML document, or FALSE otherwise.
94246 * @since PHP 5, PHP 7, PECL tidy >= 0.5.2
94247 **/
94248function tidy_is_xhtml($object){}
94249
94250/**
94251 * Indicates if the document is a generic (non HTML/XHTML) XML document
94252 *
94253 * Tells if the document is a generic (non HTML/XHTML) XML document.
94254 *
94255 * @param tidy $object
94256 * @return bool This function returns TRUE if the specified tidy {@link
94257 *   object} is a generic XML document (non HTML/XHTML), or FALSE
94258 *   otherwise.
94259 * @since PHP 5, PHP 7, PECL tidy >= 0.5.2
94260 **/
94261function tidy_is_xml($object){}
94262
94263/**
94264 * Parse markup in file or URI
94265 *
94266 * Parses the given file.
94267 *
94268 * @param string $filename If the {@link filename} parameter is given,
94269 *   this function will also read that file and initialize the object
94270 *   with the file, acting like {@link tidy_parse_file}.
94271 * @param mixed $config The config {@link config} can be passed either
94272 *   as an array or as a string. If a string is passed, it is interpreted
94273 *   as the name of the configuration file, otherwise, it is interpreted
94274 *   as the options themselves. For an explanation about each option, see
94275 *   .
94276 * @param string $encoding The {@link encoding} parameter sets the
94277 *   encoding for input/output documents. The possible values for
94278 *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
94279 *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
94280 * @param bool $use_include_path Search for the file in the
94281 *   include_path.
94282 * @return tidy
94283 * @since PHP 5, PHP 7, PECL tidy >= 0.5.2
94284 **/
94285function tidy_parse_file($filename, $config, $encoding, $use_include_path){}
94286
94287/**
94288 * Parse a document stored in a string
94289 *
94290 * Parses a document stored in a string.
94291 *
94292 * @param string $input The data to be parsed.
94293 * @param mixed $config The config {@link config} can be passed either
94294 *   as an array or as a string. If a string is passed, it is interpreted
94295 *   as the name of the configuration file, otherwise, it is interpreted
94296 *   as the options themselves. For an explanation about each option,
94297 *   visit .
94298 * @param string $encoding The {@link encoding} parameter sets the
94299 *   encoding for input/output documents. The possible values for
94300 *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
94301 *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
94302 * @return tidy Returns a new tidy instance.
94303 * @since PHP 5, PHP 7, PECL tidy >= 0.5.2
94304 **/
94305function tidy_parse_string($input, $config, $encoding){}
94306
94307/**
94308 * Repair a file and return it as a string
94309 *
94310 * Repairs the given file and returns it as a string.
94311 *
94312 * @param string $filename The file to be repaired.
94313 * @param mixed $config The config {@link config} can be passed either
94314 *   as an array or as a string. If a string is passed, it is interpreted
94315 *   as the name of the configuration file, otherwise, it is interpreted
94316 *   as the options themselves. Check
94317 *   http://tidy.sourceforge.net/docs/quickref.html for an explanation
94318 *   about each option.
94319 * @param string $encoding The {@link encoding} parameter sets the
94320 *   encoding for input/output documents. The possible values for
94321 *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
94322 *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
94323 * @param bool $use_include_path Search for the file in the
94324 *   include_path.
94325 * @return string Returns the repaired contents as a string.
94326 * @since PHP 5, PHP 7, PECL tidy >= 0.7.0
94327 **/
94328function tidy_repair_file($filename, $config, $encoding, $use_include_path){}
94329
94330/**
94331 * Repair a string using an optionally provided configuration file
94332 *
94333 * Repairs the given string.
94334 *
94335 * @param string $data The data to be repaired.
94336 * @param mixed $config The config {@link config} can be passed either
94337 *   as an array or as a string. If a string is passed, it is interpreted
94338 *   as the name of the configuration file, otherwise, it is interpreted
94339 *   as the options themselves. Check for an explanation about each
94340 *   option.
94341 * @param string $encoding The {@link encoding} parameter sets the
94342 *   encoding for input/output documents. The possible values for
94343 *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
94344 *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
94345 * @return string Returns the repaired string.
94346 * @since PHP 5, PHP 7, PECL tidy >= 0.7.0
94347 **/
94348function tidy_repair_string($data, $config, $encoding){}
94349
94350/**
94351 * Returns the Number of Tidy warnings encountered for specified document
94352 *
94353 * Returns the number of Tidy warnings encountered for the specified
94354 * document.
94355 *
94356 * @param tidy $object
94357 * @return int Returns the number of warnings.
94358 * @since PHP 5, PHP 7, PECL tidy >= 0.5.2
94359 **/
94360function tidy_warning_count($object){}
94361
94362/**
94363 * Return current Unix timestamp
94364 *
94365 * Returns the current time measured in the number of seconds since the
94366 * Unix Epoch (January 1 1970 00:00:00 GMT).
94367 *
94368 * @return int
94369 * @since PHP 4, PHP 5, PHP 7
94370 **/
94371function time(){}
94372
94373/**
94374 * Returns associative array containing dst, offset and the timezone name
94375 *
94376 * @return array Returns array on success.
94377 * @since PHP 5 >= 5.2.0, PHP 7
94378 **/
94379function timezone_abbreviations_list(){}
94380
94381/**
94382 * Returns a numerically indexed array containing all defined timezone
94383 * identifiers
94384 *
94385 * @param int $timezoneGroup One of the DateTimeZone class constants
94386 *   (or a combination).
94387 * @param string $countryCode A two-letter ISO 3166-1 compatible
94388 *   country code.
94389 * @return array Returns array on success.
94390 * @since PHP 5 >= 5.2.0, PHP 7
94391 **/
94392function timezone_identifiers_list($timezoneGroup, $countryCode){}
94393
94394/**
94395 * Returns location information for a timezone
94396 *
94397 * Returns location information for a timezone, including country code,
94398 * latitude/longitude and comments.
94399 *
94400 * @param DateTimeZone $object
94401 * @return array Array containing location information about timezone.
94402 * @since PHP 5 >= 5.3.0, PHP 7
94403 **/
94404function timezone_location_get($object){}
94405
94406/**
94407 * Returns the timezone name from abbreviation
94408 *
94409 * @param string $abbr Time zone abbreviation.
94410 * @param int $utcOffset Offset from GMT in seconds. Defaults to -1
94411 *   which means that first found time zone corresponding to {@link abbr}
94412 *   is returned. Otherwise exact offset is searched and only if not
94413 *   found then the first time zone with any offset is returned.
94414 * @param int $isDST Daylight saving time indicator. Defaults to -1,
94415 *   which means that whether the time zone has daylight saving or not is
94416 *   not taken into consideration when searching. If this is set to 1,
94417 *   then the {@link utcOffset} is assumed to be an offset with daylight
94418 *   saving in effect; if 0, then {@link utcOffset} is assumed to be an
94419 *   offset without daylight saving in effect. If {@link abbr} doesn't
94420 *   exist then the time zone is searched solely by the {@link utcOffset}
94421 *   and {@link isDST}.
94422 * @return string Returns time zone name on success.
94423 * @since PHP 5 >= 5.1.3, PHP 7
94424 **/
94425function timezone_name_from_abbr($abbr, $utcOffset, $isDST){}
94426
94427/**
94428 * Returns the name of the timezone
94429 *
94430 * @param DateTimeZone $object The DateTimeZone for which to get a
94431 *   name.
94432 * @return string One of the timezone names in the list of timezones.
94433 * @since PHP 5 >= 5.2.0, PHP 7
94434 **/
94435function timezone_name_get($object){}
94436
94437/**
94438 * Returns the timezone offset from GMT
94439 *
94440 * This function returns the offset to GMT for the date/time specified in
94441 * the {@link datetime} parameter. The GMT offset is calculated with the
94442 * timezone information contained in the DateTimeZone object being used.
94443 *
94444 * @param DateTimeZone $object DateTime that contains the date/time to
94445 *   compute the offset from.
94446 * @param DateTimeInterface $datetime
94447 * @return int Returns time zone offset in seconds on success.
94448 * @since PHP 5 >= 5.2.0, PHP 7
94449 **/
94450function timezone_offset_get($object, $datetime){}
94451
94452/**
94453 * Creates new DateTimeZone object
94454 *
94455 * @param string $timezone One of the supported timezone names or an
94456 *   offset value (+0200).
94457 * @return DateTimeZone Returns DateTimeZone on success.
94458 * @since PHP 5 >= 5.2.0, PHP 7
94459 **/
94460function timezone_open($timezone){}
94461
94462/**
94463 * Returns all transitions for the timezone
94464 *
94465 * @param DateTimeZone $object Begin timestamp.
94466 * @param int $timestampBegin End timestamp.
94467 * @param int $timestampEnd
94468 * @return array Returns numerically indexed array containing
94469 *   associative array with all transitions on success.
94470 * @since PHP 5 >= 5.2.0, PHP 7
94471 **/
94472function timezone_transitions_get($object, $timestampBegin, $timestampEnd){}
94473
94474/**
94475 * Gets the version of the timezonedb
94476 *
94477 * Returns the current version of the timezonedb.
94478 *
94479 * @return string Returns a string.
94480 * @since PHP 5 >= 5.3.0, PHP 7
94481 **/
94482function timezone_version_get(){}
94483
94484/**
94485 * Delay for a number of seconds and nanoseconds
94486 *
94487 * Delays program execution for the given number of {@link seconds} and
94488 * {@link nanoseconds}.
94489 *
94490 * @param int $seconds Must be a non-negative integer.
94491 * @param int $nanoseconds Must be a non-negative integer less than 1
94492 *   billion.
94493 * @return mixed
94494 * @since PHP 5, PHP 7
94495 **/
94496function time_nanosleep($seconds, $nanoseconds){}
94497
94498/**
94499 * Make the script sleep until the specified time
94500 *
94501 * Makes the script sleep until the specified {@link timestamp}.
94502 *
94503 * @param float $timestamp The timestamp when the script should wake.
94504 * @return bool
94505 * @since PHP 5 >= 5.1.0, PHP 7
94506 **/
94507function time_sleep_until($timestamp){}
94508
94509/**
94510 * Creates a temporary file
94511 *
94512 * Creates a temporary file with a unique name in read-write (w+) mode
94513 * and returns a file handle.
94514 *
94515 * The file is automatically removed when closed (for example, by calling
94516 * {@link fclose}, or when there are no remaining references to the file
94517 * handle returned by {@link tmpfile}), or when the script ends.
94518 *
94519 * @return resource Returns a file handle, similar to the one returned
94520 *   by {@link fopen}, for the new file.
94521 * @since PHP 4, PHP 5, PHP 7
94522 **/
94523function tmpfile(){}
94524
94525/**
94526 * Split given source into PHP tokens
94527 *
94528 * {@link token_get_all} parses the given {@link source} string into PHP
94529 * language tokens using the Zend engines lexical scanner.
94530 *
94531 * For a list of parser tokens, see , or use {@link token_name} to
94532 * translate a token value into its string representation.
94533 *
94534 * @param string $source The PHP source to parse.
94535 * @param int $flags Valid flags: TOKEN_PARSE - Recognises the ability
94536 *   to use reserved words in specific contexts.
94537 * @return array An array of token identifiers. Each individual token
94538 *   identifier is either a single character (i.e.: ;, ., >, !, etc...),
94539 *   or a three element array containing the token index in element 0,
94540 *   the string content of the original token in element 1 and the line
94541 *   number in element 2.
94542 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
94543 **/
94544function token_get_all($source, $flags){}
94545
94546/**
94547 * Get the symbolic name of a given PHP token
94548 *
94549 * {@link token_name} gets the symbolic name for a PHP {@link token}
94550 * value.
94551 *
94552 * @param int $token The token value.
94553 * @return string The symbolic name of the given {@link token}.
94554 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
94555 **/
94556function token_name($token){}
94557
94558/**
94559 * Sets access and modification time of file
94560 *
94561 * Attempts to set the access and modification times of the file named in
94562 * the {@link filename} parameter to the value given in {@link time}.
94563 * Note that the access time is always modified, regardless of the number
94564 * of parameters.
94565 *
94566 * If the file does not exist, it will be created.
94567 *
94568 * @param string $filename The name of the file being touched.
94569 * @param int $time The touch time. If {@link time} is not supplied,
94570 *   the current system time is used.
94571 * @param int $atime If present, the access time of the given filename
94572 *   is set to the value of {@link atime}. Otherwise, it is set to the
94573 *   value passed to the {@link time} parameter. If neither are present,
94574 *   the current system time is used.
94575 * @return bool
94576 * @since PHP 4, PHP 5, PHP 7
94577 **/
94578function touch($filename, $time, $atime){}
94579
94580/**
94581 * Vector Trigonometric ACos
94582 *
94583 * Calculates the arc cosine for each value in {@link real} and returns
94584 * the resulting array.
94585 *
94586 * @param array $real
94587 * @return array Returns an array with calculated data or false on
94588 *   failure.
94589 * @since PECL trader >= 0.2.0
94590 **/
94591function trader_acos($real){}
94592
94593/**
94594 * Chaikin A/D Line
94595 *
94596 * @param array $high
94597 * @param array $low
94598 * @param array $close
94599 * @param array $volume
94600 * @return array Returns an array with calculated data or false on
94601 *   failure.
94602 * @since PECL trader >= 0.2.0
94603 **/
94604function trader_ad($high, $low, $close, $volume){}
94605
94606/**
94607 * Vector Arithmetic Add
94608 *
94609 * Calculates the vector addition of {@link real0} to {@link real1} and
94610 * returns the resulting vector.
94611 *
94612 * @param array $real0
94613 * @param array $real1
94614 * @return array Returns an array with calculated data or false on
94615 *   failure.
94616 * @since PECL trader >= 0.2.0
94617 **/
94618function trader_add($real0, $real1){}
94619
94620/**
94621 * Chaikin A/D Oscillator
94622 *
94623 * @param array $high
94624 * @param array $low
94625 * @param array $close
94626 * @param array $volume
94627 * @param int $fastPeriod
94628 * @param int $slowPeriod
94629 * @return array Returns an array with calculated data or false on
94630 *   failure.
94631 * @since PECL trader >= 0.2.0
94632 **/
94633function trader_adosc($high, $low, $close, $volume, $fastPeriod, $slowPeriod){}
94634
94635/**
94636 * Average Directional Movement Index
94637 *
94638 * @param array $high
94639 * @param array $low
94640 * @param array $close
94641 * @param int $timePeriod
94642 * @return array Returns an array with calculated data or false on
94643 *   failure.
94644 * @since PECL trader >= 0.2.0
94645 **/
94646function trader_adx($high, $low, $close, $timePeriod){}
94647
94648/**
94649 * Average Directional Movement Index Rating
94650 *
94651 * @param array $high
94652 * @param array $low
94653 * @param array $close
94654 * @param int $timePeriod
94655 * @return array Returns an array with calculated data or false on
94656 *   failure.
94657 * @since PECL trader >= 0.2.0
94658 **/
94659function trader_adxr($high, $low, $close, $timePeriod){}
94660
94661/**
94662 * Absolute Price Oscillator
94663 *
94664 * @param array $real
94665 * @param int $fastPeriod
94666 * @param int $slowPeriod
94667 * @param int $mAType
94668 * @return array Returns an array with calculated data or false on
94669 *   failure.
94670 * @since PECL trader >= 0.2.0
94671 **/
94672function trader_apo($real, $fastPeriod, $slowPeriod, $mAType){}
94673
94674/**
94675 * Aroon
94676 *
94677 * @param array $high
94678 * @param array $low
94679 * @param int $timePeriod
94680 * @return array Returns an array with calculated data or false on
94681 *   failure.
94682 * @since PECL trader >= 0.2.0
94683 **/
94684function trader_aroon($high, $low, $timePeriod){}
94685
94686/**
94687 * Aroon Oscillator
94688 *
94689 * @param array $high
94690 * @param array $low
94691 * @param int $timePeriod
94692 * @return array Returns an array with calculated data or false on
94693 *   failure.
94694 * @since PECL trader >= 0.2.0
94695 **/
94696function trader_aroonosc($high, $low, $timePeriod){}
94697
94698/**
94699 * Vector Trigonometric ASin
94700 *
94701 * Calculates the arc sine for each value in {@link real} and returns the
94702 * resulting array.
94703 *
94704 * @param array $real
94705 * @return array Returns an array with calculated data or false on
94706 *   failure.
94707 * @since PECL trader >= 0.2.0
94708 **/
94709function trader_asin($real){}
94710
94711/**
94712 * Vector Trigonometric ATan
94713 *
94714 * Calculates the arc tangent for each value in {@link real} and returns
94715 * the resulting array.
94716 *
94717 * @param array $real
94718 * @return array Returns an array with calculated data or false on
94719 *   failure.
94720 * @since PECL trader >= 0.2.0
94721 **/
94722function trader_atan($real){}
94723
94724/**
94725 * Average True Range
94726 *
94727 * @param array $high
94728 * @param array $low
94729 * @param array $close
94730 * @param int $timePeriod
94731 * @return array Returns an array with calculated data or false on
94732 *   failure.
94733 * @since PECL trader >= 0.2.0
94734 **/
94735function trader_atr($high, $low, $close, $timePeriod){}
94736
94737/**
94738 * Average Price
94739 *
94740 * @param array $open
94741 * @param array $high
94742 * @param array $low
94743 * @param array $close
94744 * @return array Returns an array with calculated data or false on
94745 *   failure.
94746 * @since PECL trader >= 0.2.0
94747 **/
94748function trader_avgprice($open, $high, $low, $close){}
94749
94750/**
94751 * Bollinger Bands
94752 *
94753 * @param array $real
94754 * @param int $timePeriod
94755 * @param float $nbDevUp
94756 * @param float $nbDevDn
94757 * @param int $mAType
94758 * @return array Returns an array with calculated data or false on
94759 *   failure.
94760 * @since PECL trader >= 0.2.0
94761 **/
94762function trader_bbands($real, $timePeriod, $nbDevUp, $nbDevDn, $mAType){}
94763
94764/**
94765 * Beta
94766 *
94767 * @param array $real0
94768 * @param array $real1
94769 * @param int $timePeriod
94770 * @return array Returns an array with calculated data or false on
94771 *   failure.
94772 * @since PECL trader >= 0.2.0
94773 **/
94774function trader_beta($real0, $real1, $timePeriod){}
94775
94776/**
94777 * Balance Of Power
94778 *
94779 * @param array $open
94780 * @param array $high
94781 * @param array $low
94782 * @param array $close
94783 * @return array Returns an array with calculated data or false on
94784 *   failure.
94785 * @since PECL trader >= 0.2.0
94786 **/
94787function trader_bop($open, $high, $low, $close){}
94788
94789/**
94790 * Commodity Channel Index
94791 *
94792 * @param array $high
94793 * @param array $low
94794 * @param array $close
94795 * @param int $timePeriod
94796 * @return array Returns an array with calculated data or false on
94797 *   failure.
94798 * @since PECL trader >= 0.2.0
94799 **/
94800function trader_cci($high, $low, $close, $timePeriod){}
94801
94802/**
94803 * Two Crows
94804 *
94805 * @param array $open
94806 * @param array $high
94807 * @param array $low
94808 * @param array $close
94809 * @return array Returns an array with calculated data or false on
94810 *   failure.
94811 * @since PECL trader >= 0.2.0
94812 **/
94813function trader_cdl2crows($open, $high, $low, $close){}
94814
94815/**
94816 * Three Black Crows
94817 *
94818 * @param array $open
94819 * @param array $high
94820 * @param array $low
94821 * @param array $close
94822 * @return array Returns an array with calculated data or false on
94823 *   failure.
94824 * @since PECL trader >= 0.2.0
94825 **/
94826function trader_cdl3blackcrows($open, $high, $low, $close){}
94827
94828/**
94829 * Three Inside Up/Down
94830 *
94831 * @param array $open
94832 * @param array $high
94833 * @param array $low
94834 * @param array $close
94835 * @return array Returns an array with calculated data or false on
94836 *   failure.
94837 * @since PECL trader >= 0.2.0
94838 **/
94839function trader_cdl3inside($open, $high, $low, $close){}
94840
94841/**
94842 * Three-Line Strike
94843 *
94844 * @param array $open
94845 * @param array $high
94846 * @param array $low
94847 * @param array $close
94848 * @return array Returns an array with calculated data or false on
94849 *   failure.
94850 * @since PECL trader >= 0.2.0
94851 **/
94852function trader_cdl3linestrike($open, $high, $low, $close){}
94853
94854/**
94855 * Three Outside Up/Down
94856 *
94857 * @param array $open
94858 * @param array $high
94859 * @param array $low
94860 * @param array $close
94861 * @return array Returns an array with calculated data or false on
94862 *   failure.
94863 * @since PECL trader >= 0.2.0
94864 **/
94865function trader_cdl3outside($open, $high, $low, $close){}
94866
94867/**
94868 * Three Stars In The South
94869 *
94870 * @param array $open
94871 * @param array $high
94872 * @param array $low
94873 * @param array $close
94874 * @return array Returns an array with calculated data or false on
94875 *   failure.
94876 * @since PECL trader >= 0.2.0
94877 **/
94878function trader_cdl3starsinsouth($open, $high, $low, $close){}
94879
94880/**
94881 * Three Advancing White Soldiers
94882 *
94883 * @param array $open
94884 * @param array $high
94885 * @param array $low
94886 * @param array $close
94887 * @return array Returns an array with calculated data or false on
94888 *   failure.
94889 * @since PECL trader >= 0.2.0
94890 **/
94891function trader_cdl3whitesoldiers($open, $high, $low, $close){}
94892
94893/**
94894 * Abandoned Baby
94895 *
94896 * @param array $open
94897 * @param array $high
94898 * @param array $low
94899 * @param array $close
94900 * @param float $penetration
94901 * @return array Returns an array with calculated data or false on
94902 *   failure.
94903 * @since PECL trader >= 0.2.0
94904 **/
94905function trader_cdlabandonedbaby($open, $high, $low, $close, $penetration){}
94906
94907/**
94908 * Advance Block
94909 *
94910 * @param array $open
94911 * @param array $high
94912 * @param array $low
94913 * @param array $close
94914 * @return array Returns an array with calculated data or false on
94915 *   failure.
94916 * @since PECL trader >= 0.2.0
94917 **/
94918function trader_cdladvanceblock($open, $high, $low, $close){}
94919
94920/**
94921 * Belt-hold
94922 *
94923 * @param array $open
94924 * @param array $high
94925 * @param array $low
94926 * @param array $close
94927 * @return array Returns an array with calculated data or false on
94928 *   failure.
94929 * @since PECL trader >= 0.2.0
94930 **/
94931function trader_cdlbelthold($open, $high, $low, $close){}
94932
94933/**
94934 * Breakaway
94935 *
94936 * @param array $open
94937 * @param array $high
94938 * @param array $low
94939 * @param array $close
94940 * @return array Returns an array with calculated data or false on
94941 *   failure.
94942 * @since PECL trader >= 0.2.0
94943 **/
94944function trader_cdlbreakaway($open, $high, $low, $close){}
94945
94946/**
94947 * Closing Marubozu
94948 *
94949 * @param array $open
94950 * @param array $high
94951 * @param array $low
94952 * @param array $close
94953 * @return array Returns an array with calculated data or false on
94954 *   failure.
94955 * @since PECL trader >= 0.2.0
94956 **/
94957function trader_cdlclosingmarubozu($open, $high, $low, $close){}
94958
94959/**
94960 * Concealing Baby Swallow
94961 *
94962 * @param array $open
94963 * @param array $high
94964 * @param array $low
94965 * @param array $close
94966 * @return array Returns an array with calculated data or false on
94967 *   failure.
94968 * @since PECL trader >= 0.2.0
94969 **/
94970function trader_cdlconcealbabyswall($open, $high, $low, $close){}
94971
94972/**
94973 * Counterattack
94974 *
94975 * @param array $open
94976 * @param array $high
94977 * @param array $low
94978 * @param array $close
94979 * @return array Returns an array with calculated data or false on
94980 *   failure.
94981 * @since PECL trader >= 0.2.0
94982 **/
94983function trader_cdlcounterattack($open, $high, $low, $close){}
94984
94985/**
94986 * Dark Cloud Cover
94987 *
94988 * @param array $open
94989 * @param array $high
94990 * @param array $low
94991 * @param array $close
94992 * @param float $penetration
94993 * @return array Returns an array with calculated data or false on
94994 *   failure.
94995 * @since PECL trader >= 0.2.0
94996 **/
94997function trader_cdldarkcloudcover($open, $high, $low, $close, $penetration){}
94998
94999/**
95000 * Doji
95001 *
95002 * @param array $open
95003 * @param array $high
95004 * @param array $low
95005 * @param array $close
95006 * @return array Returns an array with calculated data or false on
95007 *   failure.
95008 * @since PECL trader >= 0.2.0
95009 **/
95010function trader_cdldoji($open, $high, $low, $close){}
95011
95012/**
95013 * Doji Star
95014 *
95015 * @param array $open
95016 * @param array $high
95017 * @param array $low
95018 * @param array $close
95019 * @return array Returns an array with calculated data or false on
95020 *   failure.
95021 * @since PECL trader >= 0.2.0
95022 **/
95023function trader_cdldojistar($open, $high, $low, $close){}
95024
95025/**
95026 * Dragonfly Doji
95027 *
95028 * @param array $open
95029 * @param array $high
95030 * @param array $low
95031 * @param array $close
95032 * @return array Returns an array with calculated data or false on
95033 *   failure.
95034 * @since PECL trader >= 0.2.0
95035 **/
95036function trader_cdldragonflydoji($open, $high, $low, $close){}
95037
95038/**
95039 * Engulfing Pattern
95040 *
95041 * @param array $open
95042 * @param array $high
95043 * @param array $low
95044 * @param array $close
95045 * @return array Returns an array with calculated data or false on
95046 *   failure.
95047 * @since PECL trader >= 0.2.0
95048 **/
95049function trader_cdlengulfing($open, $high, $low, $close){}
95050
95051/**
95052 * Evening Doji Star
95053 *
95054 * @param array $open
95055 * @param array $high
95056 * @param array $low
95057 * @param array $close
95058 * @param float $penetration
95059 * @return array Returns an array with calculated data or false on
95060 *   failure.
95061 * @since PECL trader >= 0.2.0
95062 **/
95063function trader_cdleveningdojistar($open, $high, $low, $close, $penetration){}
95064
95065/**
95066 * Evening Star
95067 *
95068 * @param array $open
95069 * @param array $high
95070 * @param array $low
95071 * @param array $close
95072 * @param float $penetration
95073 * @return array Returns an array with calculated data or false on
95074 *   failure.
95075 * @since PECL trader >= 0.2.0
95076 **/
95077function trader_cdleveningstar($open, $high, $low, $close, $penetration){}
95078
95079/**
95080 * Up/Down-gap side-by-side white lines
95081 *
95082 * @param array $open
95083 * @param array $high
95084 * @param array $low
95085 * @param array $close
95086 * @return array Returns an array with calculated data or false on
95087 *   failure.
95088 * @since PECL trader >= 0.2.0
95089 **/
95090function trader_cdlgapsidesidewhite($open, $high, $low, $close){}
95091
95092/**
95093 * Gravestone Doji
95094 *
95095 * @param array $open
95096 * @param array $high
95097 * @param array $low
95098 * @param array $close
95099 * @return array Returns an array with calculated data or false on
95100 *   failure.
95101 * @since PECL trader >= 0.2.0
95102 **/
95103function trader_cdlgravestonedoji($open, $high, $low, $close){}
95104
95105/**
95106 * Hammer
95107 *
95108 * @param array $open
95109 * @param array $high
95110 * @param array $low
95111 * @param array $close
95112 * @return array Returns an array with calculated data or false on
95113 *   failure.
95114 * @since PECL trader >= 0.2.0
95115 **/
95116function trader_cdlhammer($open, $high, $low, $close){}
95117
95118/**
95119 * Hanging Man
95120 *
95121 * @param array $open
95122 * @param array $high
95123 * @param array $low
95124 * @param array $close
95125 * @return array Returns an array with calculated data or false on
95126 *   failure.
95127 * @since PECL trader >= 0.2.0
95128 **/
95129function trader_cdlhangingman($open, $high, $low, $close){}
95130
95131/**
95132 * Harami Pattern
95133 *
95134 * @param array $open
95135 * @param array $high
95136 * @param array $low
95137 * @param array $close
95138 * @return array Returns an array with calculated data or false on
95139 *   failure.
95140 * @since PECL trader >= 0.2.0
95141 **/
95142function trader_cdlharami($open, $high, $low, $close){}
95143
95144/**
95145 * Harami Cross Pattern
95146 *
95147 * @param array $open
95148 * @param array $high
95149 * @param array $low
95150 * @param array $close
95151 * @return array Returns an array with calculated data or false on
95152 *   failure.
95153 * @since PECL trader >= 0.2.0
95154 **/
95155function trader_cdlharamicross($open, $high, $low, $close){}
95156
95157/**
95158 * High-Wave Candle
95159 *
95160 * @param array $open
95161 * @param array $high
95162 * @param array $low
95163 * @param array $close
95164 * @return array Returns an array with calculated data or false on
95165 *   failure.
95166 * @since PECL trader >= 0.2.0
95167 **/
95168function trader_cdlhighwave($open, $high, $low, $close){}
95169
95170/**
95171 * Hikkake Pattern
95172 *
95173 * @param array $open
95174 * @param array $high
95175 * @param array $low
95176 * @param array $close
95177 * @return array Returns an array with calculated data or false on
95178 *   failure.
95179 * @since PECL trader >= 0.2.0
95180 **/
95181function trader_cdlhikkake($open, $high, $low, $close){}
95182
95183/**
95184 * Modified Hikkake Pattern
95185 *
95186 * @param array $open
95187 * @param array $high
95188 * @param array $low
95189 * @param array $close
95190 * @return array Returns an array with calculated data or false on
95191 *   failure.
95192 * @since PECL trader >= 0.2.0
95193 **/
95194function trader_cdlhikkakemod($open, $high, $low, $close){}
95195
95196/**
95197 * Homing Pigeon
95198 *
95199 * @param array $open
95200 * @param array $high
95201 * @param array $low
95202 * @param array $close
95203 * @return array Returns an array with calculated data or false on
95204 *   failure.
95205 * @since PECL trader >= 0.2.0
95206 **/
95207function trader_cdlhomingpigeon($open, $high, $low, $close){}
95208
95209/**
95210 * Identical Three Crows
95211 *
95212 * @param array $open
95213 * @param array $high
95214 * @param array $low
95215 * @param array $close
95216 * @return array Returns an array with calculated data or false on
95217 *   failure.
95218 * @since PECL trader >= 0.2.0
95219 **/
95220function trader_cdlidentical3crows($open, $high, $low, $close){}
95221
95222/**
95223 * In-Neck Pattern
95224 *
95225 * @param array $open
95226 * @param array $high
95227 * @param array $low
95228 * @param array $close
95229 * @return array Returns an array with calculated data or false on
95230 *   failure.
95231 * @since PECL trader >= 0.2.0
95232 **/
95233function trader_cdlinneck($open, $high, $low, $close){}
95234
95235/**
95236 * Inverted Hammer
95237 *
95238 * @param array $open
95239 * @param array $high
95240 * @param array $low
95241 * @param array $close
95242 * @return array Returns an array with calculated data or false on
95243 *   failure.
95244 * @since PECL trader >= 0.2.0
95245 **/
95246function trader_cdlinvertedhammer($open, $high, $low, $close){}
95247
95248/**
95249 * Kicking
95250 *
95251 * @param array $open
95252 * @param array $high
95253 * @param array $low
95254 * @param array $close
95255 * @return array Returns an array with calculated data or false on
95256 *   failure.
95257 * @since PECL trader >= 0.2.0
95258 **/
95259function trader_cdlkicking($open, $high, $low, $close){}
95260
95261/**
95262 * Kicking - bull/bear determined by the longer marubozu
95263 *
95264 * @param array $open
95265 * @param array $high
95266 * @param array $low
95267 * @param array $close
95268 * @return array Returns an array with calculated data or false on
95269 *   failure.
95270 * @since PECL trader >= 0.2.0
95271 **/
95272function trader_cdlkickingbylength($open, $high, $low, $close){}
95273
95274/**
95275 * Ladder Bottom
95276 *
95277 * @param array $open
95278 * @param array $high
95279 * @param array $low
95280 * @param array $close
95281 * @return array Returns an array with calculated data or false on
95282 *   failure.
95283 * @since PECL trader >= 0.2.0
95284 **/
95285function trader_cdlladderbottom($open, $high, $low, $close){}
95286
95287/**
95288 * Long Legged Doji
95289 *
95290 * @param array $open
95291 * @param array $high
95292 * @param array $low
95293 * @param array $close
95294 * @return array Returns an array with calculated data or false on
95295 *   failure.
95296 * @since PECL trader >= 0.2.0
95297 **/
95298function trader_cdllongleggeddoji($open, $high, $low, $close){}
95299
95300/**
95301 * Long Line Candle
95302 *
95303 * @param array $open
95304 * @param array $high
95305 * @param array $low
95306 * @param array $close
95307 * @return array Returns an array with calculated data or false on
95308 *   failure.
95309 * @since PECL trader >= 0.2.0
95310 **/
95311function trader_cdllongline($open, $high, $low, $close){}
95312
95313/**
95314 * Marubozu
95315 *
95316 * @param array $open
95317 * @param array $high
95318 * @param array $low
95319 * @param array $close
95320 * @return array Returns an array with calculated data or false on
95321 *   failure.
95322 * @since PECL trader >= 0.2.0
95323 **/
95324function trader_cdlmarubozu($open, $high, $low, $close){}
95325
95326/**
95327 * Matching Low
95328 *
95329 * @param array $open
95330 * @param array $high
95331 * @param array $low
95332 * @param array $close
95333 * @return array Returns an array with calculated data or false on
95334 *   failure.
95335 * @since PECL trader >= 0.2.0
95336 **/
95337function trader_cdlmatchinglow($open, $high, $low, $close){}
95338
95339/**
95340 * Mat Hold
95341 *
95342 * @param array $open
95343 * @param array $high
95344 * @param array $low
95345 * @param array $close
95346 * @param float $penetration
95347 * @return array Returns an array with calculated data or false on
95348 *   failure.
95349 * @since PECL trader >= 0.2.0
95350 **/
95351function trader_cdlmathold($open, $high, $low, $close, $penetration){}
95352
95353/**
95354 * Morning Doji Star
95355 *
95356 * @param array $open
95357 * @param array $high
95358 * @param array $low
95359 * @param array $close
95360 * @param float $penetration
95361 * @return array Returns an array with calculated data or false on
95362 *   failure.
95363 * @since PECL trader >= 0.2.0
95364 **/
95365function trader_cdlmorningdojistar($open, $high, $low, $close, $penetration){}
95366
95367/**
95368 * Morning Star
95369 *
95370 * @param array $open
95371 * @param array $high
95372 * @param array $low
95373 * @param array $close
95374 * @param float $penetration
95375 * @return array Returns an array with calculated data or false on
95376 *   failure.
95377 * @since PECL trader >= 0.2.0
95378 **/
95379function trader_cdlmorningstar($open, $high, $low, $close, $penetration){}
95380
95381/**
95382 * On-Neck Pattern
95383 *
95384 * @param array $open
95385 * @param array $high
95386 * @param array $low
95387 * @param array $close
95388 * @return array Returns an array with calculated data or false on
95389 *   failure.
95390 * @since PECL trader >= 0.2.0
95391 **/
95392function trader_cdlonneck($open, $high, $low, $close){}
95393
95394/**
95395 * Piercing Pattern
95396 *
95397 * @param array $open
95398 * @param array $high
95399 * @param array $low
95400 * @param array $close
95401 * @return array Returns an array with calculated data or false on
95402 *   failure.
95403 * @since PECL trader >= 0.2.0
95404 **/
95405function trader_cdlpiercing($open, $high, $low, $close){}
95406
95407/**
95408 * Rickshaw Man
95409 *
95410 * @param array $open
95411 * @param array $high
95412 * @param array $low
95413 * @param array $close
95414 * @return array Returns an array with calculated data or false on
95415 *   failure.
95416 * @since PECL trader >= 0.2.0
95417 **/
95418function trader_cdlrickshawman($open, $high, $low, $close){}
95419
95420/**
95421 * Rising/Falling Three Methods
95422 *
95423 * @param array $open
95424 * @param array $high
95425 * @param array $low
95426 * @param array $close
95427 * @return array Returns an array with calculated data or false on
95428 *   failure.
95429 * @since PECL trader >= 0.2.0
95430 **/
95431function trader_cdlrisefall3methods($open, $high, $low, $close){}
95432
95433/**
95434 * Separating Lines
95435 *
95436 * @param array $open
95437 * @param array $high
95438 * @param array $low
95439 * @param array $close
95440 * @return array Returns an array with calculated data or false on
95441 *   failure.
95442 * @since PECL trader >= 0.2.0
95443 **/
95444function trader_cdlseparatinglines($open, $high, $low, $close){}
95445
95446/**
95447 * Shooting Star
95448 *
95449 * @param array $open
95450 * @param array $high
95451 * @param array $low
95452 * @param array $close
95453 * @return array Returns an array with calculated data or false on
95454 *   failure.
95455 * @since PECL trader >= 0.2.0
95456 **/
95457function trader_cdlshootingstar($open, $high, $low, $close){}
95458
95459/**
95460 * Short Line Candle
95461 *
95462 * @param array $open
95463 * @param array $high
95464 * @param array $low
95465 * @param array $close
95466 * @return array Returns an array with calculated data or false on
95467 *   failure.
95468 * @since PECL trader >= 0.2.0
95469 **/
95470function trader_cdlshortline($open, $high, $low, $close){}
95471
95472/**
95473 * Spinning Top
95474 *
95475 * @param array $open
95476 * @param array $high
95477 * @param array $low
95478 * @param array $close
95479 * @return array Returns an array with calculated data or false on
95480 *   failure.
95481 * @since PECL trader >= 0.2.0
95482 **/
95483function trader_cdlspinningtop($open, $high, $low, $close){}
95484
95485/**
95486 * Stalled Pattern
95487 *
95488 * @param array $open
95489 * @param array $high
95490 * @param array $low
95491 * @param array $close
95492 * @return array Returns an array with calculated data or false on
95493 *   failure.
95494 * @since PECL trader >= 0.2.0
95495 **/
95496function trader_cdlstalledpattern($open, $high, $low, $close){}
95497
95498/**
95499 * Stick Sandwich
95500 *
95501 * @param array $open
95502 * @param array $high
95503 * @param array $low
95504 * @param array $close
95505 * @return array Returns an array with calculated data or false on
95506 *   failure.
95507 * @since PECL trader >= 0.2.0
95508 **/
95509function trader_cdlsticksandwich($open, $high, $low, $close){}
95510
95511/**
95512 * Takuri (Dragonfly Doji with very long lower shadow)
95513 *
95514 * @param array $open
95515 * @param array $high
95516 * @param array $low
95517 * @param array $close
95518 * @return array Returns an array with calculated data or false on
95519 *   failure.
95520 * @since PECL trader >= 0.2.0
95521 **/
95522function trader_cdltakuri($open, $high, $low, $close){}
95523
95524/**
95525 * Tasuki Gap
95526 *
95527 * @param array $open
95528 * @param array $high
95529 * @param array $low
95530 * @param array $close
95531 * @return array Returns an array with calculated data or false on
95532 *   failure.
95533 * @since PECL trader >= 0.2.0
95534 **/
95535function trader_cdltasukigap($open, $high, $low, $close){}
95536
95537/**
95538 * Thrusting Pattern
95539 *
95540 * @param array $open
95541 * @param array $high
95542 * @param array $low
95543 * @param array $close
95544 * @return array Returns an array with calculated data or false on
95545 *   failure.
95546 * @since PECL trader >= 0.2.0
95547 **/
95548function trader_cdlthrusting($open, $high, $low, $close){}
95549
95550/**
95551 * Tristar Pattern
95552 *
95553 * @param array $open
95554 * @param array $high
95555 * @param array $low
95556 * @param array $close
95557 * @return array Returns an array with calculated data or false on
95558 *   failure.
95559 * @since PECL trader >= 0.2.0
95560 **/
95561function trader_cdltristar($open, $high, $low, $close){}
95562
95563/**
95564 * Unique 3 River
95565 *
95566 * @param array $open
95567 * @param array $high
95568 * @param array $low
95569 * @param array $close
95570 * @return array Returns an array with calculated data or false on
95571 *   failure.
95572 * @since PECL trader >= 0.2.0
95573 **/
95574function trader_cdlunique3river($open, $high, $low, $close){}
95575
95576/**
95577 * Upside Gap Two Crows
95578 *
95579 * @param array $open
95580 * @param array $high
95581 * @param array $low
95582 * @param array $close
95583 * @return array Returns an array with calculated data or false on
95584 *   failure.
95585 * @since PECL trader >= 0.2.0
95586 **/
95587function trader_cdlupsidegap2crows($open, $high, $low, $close){}
95588
95589/**
95590 * Upside/Downside Gap Three Methods
95591 *
95592 * @param array $open
95593 * @param array $high
95594 * @param array $low
95595 * @param array $close
95596 * @return array Returns an array with calculated data or false on
95597 *   failure.
95598 * @since PECL trader >= 0.2.0
95599 **/
95600function trader_cdlxsidegap3methods($open, $high, $low, $close){}
95601
95602/**
95603 * Vector Ceil
95604 *
95605 * Calculates the next highest integer for each value in {@link real} and
95606 * returns the resulting array.
95607 *
95608 * @param array $real
95609 * @return array Returns an array with calculated data or false on
95610 *   failure.
95611 * @since PECL trader >= 0.2.0
95612 **/
95613function trader_ceil($real){}
95614
95615/**
95616 * Chande Momentum Oscillator
95617 *
95618 * @param array $real
95619 * @param int $timePeriod
95620 * @return array Returns an array with calculated data or false on
95621 *   failure.
95622 * @since PECL trader >= 0.2.0
95623 **/
95624function trader_cmo($real, $timePeriod){}
95625
95626/**
95627 * Pearson's Correlation Coefficient (r)
95628 *
95629 * @param array $real0
95630 * @param array $real1
95631 * @param int $timePeriod
95632 * @return array Returns an array with calculated data or false on
95633 *   failure.
95634 * @since PECL trader >= 0.2.0
95635 **/
95636function trader_correl($real0, $real1, $timePeriod){}
95637
95638/**
95639 * Vector Trigonometric Cos
95640 *
95641 * Calculates the cosine for each value in {@link real} and returns the
95642 * resulting array.
95643 *
95644 * @param array $real
95645 * @return array Returns an array with calculated data or false on
95646 *   failure.
95647 * @since PECL trader >= 0.2.0
95648 **/
95649function trader_cos($real){}
95650
95651/**
95652 * Vector Trigonometric Cosh
95653 *
95654 * Calculates the hyperbolic cosine for each value in {@link real} and
95655 * returns the resulting array.
95656 *
95657 * @param array $real
95658 * @return array Returns an array with calculated data or false on
95659 *   failure.
95660 * @since PECL trader >= 0.2.0
95661 **/
95662function trader_cosh($real){}
95663
95664/**
95665 * Double Exponential Moving Average
95666 *
95667 * @param array $real
95668 * @param int $timePeriod
95669 * @return array Returns an array with calculated data or false on
95670 *   failure.
95671 * @since PECL trader >= 0.2.0
95672 **/
95673function trader_dema($real, $timePeriod){}
95674
95675/**
95676 * Vector Arithmetic Div
95677 *
95678 * Divides each value from {@link real0} by the corresponding value from
95679 * {@link real1} and returns the resulting array.
95680 *
95681 * @param array $real0
95682 * @param array $real1
95683 * @return array Returns an array with calculated data or false on
95684 *   failure.
95685 * @since PECL trader >= 0.2.0
95686 **/
95687function trader_div($real0, $real1){}
95688
95689/**
95690 * Directional Movement Index
95691 *
95692 * @param array $high
95693 * @param array $low
95694 * @param array $close
95695 * @param int $timePeriod
95696 * @return array Returns an array with calculated data or false on
95697 *   failure.
95698 * @since PECL trader >= 0.2.0
95699 **/
95700function trader_dx($high, $low, $close, $timePeriod){}
95701
95702/**
95703 * Exponential Moving Average
95704 *
95705 * @param array $real
95706 * @param int $timePeriod
95707 * @return array Returns an array with calculated data or false on
95708 *   failure.
95709 * @since PECL trader >= 0.2.0
95710 **/
95711function trader_ema($real, $timePeriod){}
95712
95713/**
95714 * Get error code
95715 *
95716 * Get error code of the last operation.
95717 *
95718 * @return int Returns the error code identified by one of the
95719 *   TRADER_ERR_* constants.
95720 * @since PECL trader >= 0.3.0
95721 **/
95722function trader_errno(){}
95723
95724/**
95725 * Vector Arithmetic Exp
95726 *
95727 * Calculates e raised to the power of each value in {@link real}.
95728 * Returns an array with the calculated data.
95729 *
95730 * @param array $real
95731 * @return array Returns an array with calculated data or false on
95732 *   failure.
95733 * @since PECL trader >= 0.2.0
95734 **/
95735function trader_exp($real){}
95736
95737/**
95738 * Vector Floor
95739 *
95740 * Calculates the next lowest integer for each value in {@link real} and
95741 * returns the resulting array.
95742 *
95743 * @param array $real
95744 * @return array Returns an array with calculated data or false on
95745 *   failure.
95746 * @since PECL trader >= 0.2.0
95747 **/
95748function trader_floor($real){}
95749
95750/**
95751 * Get compatibility mode
95752 *
95753 * Get compatibility mode which affects the way calculations are done by
95754 * all the extension functions.
95755 *
95756 * @return int Returns the compatibility mode id which can be
95757 *   identified by TRADER_COMPATIBILITY_* series of constants.
95758 * @since PECL trader >= 0.2.2
95759 **/
95760function trader_get_compat(){}
95761
95762/**
95763 * Get unstable period
95764 *
95765 * Get unstable period factor for a particular function.
95766 *
95767 * @param int $functionId Function ID the factor to be read for.
95768 *   TRADER_FUNC_UNST_* series of constants should be used.
95769 * @return int Returns the unstable period factor for the corresponding
95770 *   function.
95771 * @since PECL trader >= 0.2.2
95772 **/
95773function trader_get_unstable_period($functionId){}
95774
95775/**
95776 * Hilbert Transform - Dominant Cycle Period
95777 *
95778 * @param array $real
95779 * @return array Returns an array with calculated data or false on
95780 *   failure.
95781 * @since PECL trader >= 0.2.0
95782 **/
95783function trader_ht_dcperiod($real){}
95784
95785/**
95786 * Hilbert Transform - Dominant Cycle Phase
95787 *
95788 * @param array $real
95789 * @return array Returns an array with calculated data or false on
95790 *   failure.
95791 * @since PECL trader >= 0.2.0
95792 **/
95793function trader_ht_dcphase($real){}
95794
95795/**
95796 * Hilbert Transform - Phasor Components
95797 *
95798 * @param array $real
95799 * @return array Returns an array with calculated data or false on
95800 *   failure.
95801 * @since PECL trader >= 0.2.0
95802 **/
95803function trader_ht_phasor($real){}
95804
95805/**
95806 * Hilbert Transform - SineWave
95807 *
95808 * @param array $real
95809 * @return array Returns an array with calculated data or false on
95810 *   failure.
95811 * @since PECL trader >= 0.2.0
95812 **/
95813function trader_ht_sine($real){}
95814
95815/**
95816 * Hilbert Transform - Instantaneous Trendline
95817 *
95818 * @param array $real
95819 * @return array Returns an array with calculated data or false on
95820 *   failure.
95821 * @since PECL trader >= 0.2.0
95822 **/
95823function trader_ht_trendline($real){}
95824
95825/**
95826 * Hilbert Transform - Trend vs Cycle Mode
95827 *
95828 * @param array $real
95829 * @return array Returns an array with calculated data or false on
95830 *   failure.
95831 * @since PECL trader >= 0.2.0
95832 **/
95833function trader_ht_trendmode($real){}
95834
95835/**
95836 * Kaufman Adaptive Moving Average
95837 *
95838 * @param array $real
95839 * @param int $timePeriod
95840 * @return array Returns an array with calculated data or false on
95841 *   failure.
95842 * @since PECL trader >= 0.2.0
95843 **/
95844function trader_kama($real, $timePeriod){}
95845
95846/**
95847 * Linear Regression
95848 *
95849 * @param array $real
95850 * @param int $timePeriod
95851 * @return array Returns an array with calculated data or false on
95852 *   failure.
95853 * @since PECL trader >= 0.2.0
95854 **/
95855function trader_linearreg($real, $timePeriod){}
95856
95857/**
95858 * Linear Regression Angle
95859 *
95860 * @param array $real
95861 * @param int $timePeriod
95862 * @return array Returns an array with calculated data or false on
95863 *   failure.
95864 * @since PECL trader >= 0.2.0
95865 **/
95866function trader_linearreg_angle($real, $timePeriod){}
95867
95868/**
95869 * Linear Regression Intercept
95870 *
95871 * @param array $real
95872 * @param int $timePeriod
95873 * @return array Returns an array with calculated data or false on
95874 *   failure.
95875 * @since PECL trader >= 0.2.0
95876 **/
95877function trader_linearreg_intercept($real, $timePeriod){}
95878
95879/**
95880 * Linear Regression Slope
95881 *
95882 * @param array $real
95883 * @param int $timePeriod
95884 * @return array Returns an array with calculated data or false on
95885 *   failure.
95886 * @since PECL trader >= 0.2.0
95887 **/
95888function trader_linearreg_slope($real, $timePeriod){}
95889
95890/**
95891 * Vector Log Natural
95892 *
95893 * Calculates the natural logarithm for each value in {@link real} and
95894 * returns the resulting array.
95895 *
95896 * @param array $real
95897 * @return array Returns an array with calculated data or false on
95898 *   failure.
95899 * @since PECL trader >= 0.2.0
95900 **/
95901function trader_ln($real){}
95902
95903/**
95904 * Vector Log10
95905 *
95906 * Calculates the base-10 logarithm for each value in {@link real} and
95907 * returns the resulting array.
95908 *
95909 * @param array $real
95910 * @return array Returns an array with calculated data or false on
95911 *   failure.
95912 * @since PECL trader >= 0.2.0
95913 **/
95914function trader_log10($real){}
95915
95916/**
95917 * Moving average
95918 *
95919 * @param array $real
95920 * @param int $timePeriod
95921 * @param int $mAType
95922 * @return array Returns an array with calculated data or false on
95923 *   failure.
95924 * @since PECL trader >= 0.2.0
95925 **/
95926function trader_ma($real, $timePeriod, $mAType){}
95927
95928/**
95929 * Moving Average Convergence/Divergence
95930 *
95931 * @param array $real
95932 * @param int $fastPeriod
95933 * @param int $slowPeriod
95934 * @param int $signalPeriod
95935 * @return array Returns an array with calculated data or false on
95936 *   failure.
95937 * @since PECL trader >= 0.2.0
95938 **/
95939function trader_macd($real, $fastPeriod, $slowPeriod, $signalPeriod){}
95940
95941/**
95942 * MACD with controllable MA type
95943 *
95944 * @param array $real
95945 * @param int $fastPeriod
95946 * @param int $fastMAType
95947 * @param int $slowPeriod
95948 * @param int $slowMAType
95949 * @param int $signalPeriod
95950 * @param int $signalMAType
95951 * @return array Returns an array with calculated data or false on
95952 *   failure.
95953 * @since PECL trader >= 0.2.0
95954 **/
95955function trader_macdext($real, $fastPeriod, $fastMAType, $slowPeriod, $slowMAType, $signalPeriod, $signalMAType){}
95956
95957/**
95958 * Moving Average Convergence/Divergence Fix 12/26
95959 *
95960 * @param array $real
95961 * @param int $signalPeriod
95962 * @return array Returns an array with calculated data or false on
95963 *   failure.
95964 * @since PECL trader >= 0.2.0
95965 **/
95966function trader_macdfix($real, $signalPeriod){}
95967
95968/**
95969 * MESA Adaptive Moving Average
95970 *
95971 * @param array $real
95972 * @param float $fastLimit
95973 * @param float $slowLimit
95974 * @return array Returns an array with calculated data or false on
95975 *   failure.
95976 * @since PECL trader >= 0.2.0
95977 **/
95978function trader_mama($real, $fastLimit, $slowLimit){}
95979
95980/**
95981 * Moving average with variable period
95982 *
95983 * @param array $real
95984 * @param array $periods
95985 * @param int $minPeriod
95986 * @param int $maxPeriod
95987 * @param int $mAType
95988 * @return array Returns an array with calculated data or false on
95989 *   failure.
95990 * @since PECL trader >= 0.2.0
95991 **/
95992function trader_mavp($real, $periods, $minPeriod, $maxPeriod, $mAType){}
95993
95994/**
95995 * Highest value over a specified period
95996 *
95997 * @param array $real
95998 * @param int $timePeriod
95999 * @return array Returns an array with calculated data or false on
96000 *   failure.
96001 * @since PECL trader >= 0.2.0
96002 **/
96003function trader_max($real, $timePeriod){}
96004
96005/**
96006 * Index of highest value over a specified period
96007 *
96008 * @param array $real
96009 * @param int $timePeriod
96010 * @return array Returns an array with calculated data or false on
96011 *   failure.
96012 * @since PECL trader >= 0.2.0
96013 **/
96014function trader_maxindex($real, $timePeriod){}
96015
96016/**
96017 * Median Price
96018 *
96019 * @param array $high
96020 * @param array $low
96021 * @return array Returns an array with calculated data or false on
96022 *   failure.
96023 * @since PECL trader >= 0.2.0
96024 **/
96025function trader_medprice($high, $low){}
96026
96027/**
96028 * Money Flow Index
96029 *
96030 * @param array $high
96031 * @param array $low
96032 * @param array $close
96033 * @param array $volume
96034 * @param int $timePeriod
96035 * @return array Returns an array with calculated data or false on
96036 *   failure.
96037 * @since PECL trader >= 0.2.0
96038 **/
96039function trader_mfi($high, $low, $close, $volume, $timePeriod){}
96040
96041/**
96042 * MidPoint over period
96043 *
96044 * @param array $real
96045 * @param int $timePeriod
96046 * @return array Returns an array with calculated data or false on
96047 *   failure.
96048 * @since PECL trader >= 0.2.0
96049 **/
96050function trader_midpoint($real, $timePeriod){}
96051
96052/**
96053 * Midpoint Price over period
96054 *
96055 * @param array $high
96056 * @param array $low
96057 * @param int $timePeriod
96058 * @return array Returns an array with calculated data or false on
96059 *   failure.
96060 * @since PECL trader >= 0.2.0
96061 **/
96062function trader_midprice($high, $low, $timePeriod){}
96063
96064/**
96065 * Lowest value over a specified period
96066 *
96067 * @param array $real
96068 * @param int $timePeriod
96069 * @return array Returns an array with calculated data or false on
96070 *   failure.
96071 * @since PECL trader >= 0.2.0
96072 **/
96073function trader_min($real, $timePeriod){}
96074
96075/**
96076 * Index of lowest value over a specified period
96077 *
96078 * @param array $real
96079 * @param int $timePeriod
96080 * @return array Returns an array with calculated data or false on
96081 *   failure.
96082 * @since PECL trader >= 0.2.0
96083 **/
96084function trader_minindex($real, $timePeriod){}
96085
96086/**
96087 * Lowest and highest values over a specified period
96088 *
96089 * @param array $real
96090 * @param int $timePeriod
96091 * @return array Returns an array with calculated data or false on
96092 *   failure.
96093 * @since PECL trader >= 0.2.0
96094 **/
96095function trader_minmax($real, $timePeriod){}
96096
96097/**
96098 * Indexes of lowest and highest values over a specified period
96099 *
96100 * @param array $real
96101 * @param int $timePeriod
96102 * @return array Returns an array with calculated data or false on
96103 *   failure.
96104 * @since PECL trader >= 0.2.0
96105 **/
96106function trader_minmaxindex($real, $timePeriod){}
96107
96108/**
96109 * Minus Directional Indicator
96110 *
96111 * @param array $high
96112 * @param array $low
96113 * @param array $close
96114 * @param int $timePeriod
96115 * @return array Returns an array with calculated data or false on
96116 *   failure.
96117 * @since PECL trader >= 0.2.0
96118 **/
96119function trader_minus_di($high, $low, $close, $timePeriod){}
96120
96121/**
96122 * Minus Directional Movement
96123 *
96124 * @param array $high
96125 * @param array $low
96126 * @param int $timePeriod
96127 * @return array Returns an array with calculated data or false on
96128 *   failure.
96129 * @since PECL trader >= 0.2.0
96130 **/
96131function trader_minus_dm($high, $low, $timePeriod){}
96132
96133/**
96134 * Momentum
96135 *
96136 * @param array $real
96137 * @param int $timePeriod
96138 * @return array Returns an array with calculated data or false on
96139 *   failure.
96140 * @since PECL trader >= 0.2.0
96141 **/
96142function trader_mom($real, $timePeriod){}
96143
96144/**
96145 * Vector Arithmetic Mult
96146 *
96147 * Calculates the vector dot product of {@link real0} with {@link real1}
96148 * and returns the resulting vector.
96149 *
96150 * @param array $real0
96151 * @param array $real1
96152 * @return array Returns an array with calculated data or false on
96153 *   failure.
96154 * @since PECL trader >= 0.2.0
96155 **/
96156function trader_mult($real0, $real1){}
96157
96158/**
96159 * Normalized Average True Range
96160 *
96161 * @param array $high
96162 * @param array $low
96163 * @param array $close
96164 * @param int $timePeriod
96165 * @return array Returns an array with calculated data or false on
96166 *   failure.
96167 * @since PECL trader >= 0.2.0
96168 **/
96169function trader_natr($high, $low, $close, $timePeriod){}
96170
96171/**
96172 * On Balance Volume
96173 *
96174 * @param array $real
96175 * @param array $volume
96176 * @return array Returns an array with calculated data or false on
96177 *   failure.
96178 * @since PECL trader >= 0.2.0
96179 **/
96180function trader_obv($real, $volume){}
96181
96182/**
96183 * Plus Directional Indicator
96184 *
96185 * @param array $high
96186 * @param array $low
96187 * @param array $close
96188 * @param int $timePeriod
96189 * @return array Returns an array with calculated data or false on
96190 *   failure.
96191 * @since PECL trader >= 0.2.0
96192 **/
96193function trader_plus_di($high, $low, $close, $timePeriod){}
96194
96195/**
96196 * Plus Directional Movement
96197 *
96198 * @param array $high
96199 * @param array $low
96200 * @param int $timePeriod
96201 * @return array Returns an array with calculated data or false on
96202 *   failure.
96203 * @since PECL trader >= 0.2.0
96204 **/
96205function trader_plus_dm($high, $low, $timePeriod){}
96206
96207/**
96208 * Percentage Price Oscillator
96209 *
96210 * @param array $real
96211 * @param int $fastPeriod
96212 * @param int $slowPeriod
96213 * @param int $mAType
96214 * @return array Returns an array with calculated data or false on
96215 *   failure.
96216 * @since PECL trader >= 0.2.0
96217 **/
96218function trader_ppo($real, $fastPeriod, $slowPeriod, $mAType){}
96219
96220/**
96221 * Rate of change : ((price/prevPrice)-1)*100
96222 *
96223 * @param array $real
96224 * @param int $timePeriod
96225 * @return array Returns an array with calculated data or false on
96226 *   failure.
96227 * @since PECL trader >= 0.2.0
96228 **/
96229function trader_roc($real, $timePeriod){}
96230
96231/**
96232 * Rate of change Percentage: (price-prevPrice)/prevPrice
96233 *
96234 * @param array $real
96235 * @param int $timePeriod
96236 * @return array Returns an array with calculated data or false on
96237 *   failure.
96238 * @since PECL trader >= 0.2.0
96239 **/
96240function trader_rocp($real, $timePeriod){}
96241
96242/**
96243 * Rate of change ratio: (price/prevPrice)
96244 *
96245 * @param array $real
96246 * @param int $timePeriod
96247 * @return array Returns an array with calculated data or false on
96248 *   failure.
96249 * @since PECL trader >= 0.2.0
96250 **/
96251function trader_rocr($real, $timePeriod){}
96252
96253/**
96254 * Rate of change ratio 100 scale: (price/prevPrice)*100
96255 *
96256 * @param array $real
96257 * @param int $timePeriod
96258 * @return array Returns an array with calculated data or false on
96259 *   failure.
96260 * @since PECL trader >= 0.2.0
96261 **/
96262function trader_rocr100($real, $timePeriod){}
96263
96264/**
96265 * Relative Strength Index
96266 *
96267 * @param array $real
96268 * @param int $timePeriod
96269 * @return array Returns an array with calculated data or false on
96270 *   failure.
96271 * @since PECL trader >= 0.2.0
96272 **/
96273function trader_rsi($real, $timePeriod){}
96274
96275/**
96276 * Parabolic SAR
96277 *
96278 * @param array $high
96279 * @param array $low
96280 * @param float $acceleration Acceleration Factor used up to the
96281 *   Maximum value. Valid range from 0 to TRADER_REAL_MAX.
96282 * @param float $maximum Acceleration Factor Maximum value. Valid range
96283 *   from 0 to TRADER_REAL_MAX.
96284 * @return array Returns an array with calculated data or false on
96285 *   failure.
96286 * @since PECL trader >= 0.2.0
96287 **/
96288function trader_sar($high, $low, $acceleration, $maximum){}
96289
96290/**
96291 * Parabolic SAR - Extended
96292 *
96293 * @param array $high
96294 * @param array $low
96295 * @param float $startValue Start value and direction. 0 for Auto, >0
96296 *   for Long, <0 for Short. Valid range from TRADER_REAL_MIN to
96297 *   TRADER_REAL_MAX.
96298 * @param float $offsetOnReverse Percent offset added/removed to
96299 *   initial stop on short/long reversal. Valid range from 0 to
96300 *   TRADER_REAL_MAX.
96301 * @param float $accelerationInitLong Acceleration Factor initial value
96302 *   for the Long direction. Valid range from 0 to TRADER_REAL_MAX.
96303 * @param float $accelerationLong Acceleration Factor for the Long
96304 *   direction. Valid range from 0 to TRADER_REAL_MAX.
96305 * @param float $accelerationMaxLong Acceleration Factor maximum value
96306 *   for the Long direction. Valid range from 0 to TRADER_REAL_MAX.
96307 * @param float $accelerationInitShort Acceleration Factor initial
96308 *   value for the Short direction. Valid range from 0 to
96309 *   TRADER_REAL_MAX.
96310 * @param float $accelerationShort Acceleration Factor for the Short
96311 *   direction. Valid range from 0 to TRADER_REAL_MAX.
96312 * @param float $accelerationMaxShort Acceleration Factor maximum value
96313 *   for the Short direction. Valid range from 0 to TRADER_REAL_MAX.
96314 * @return array Returns an array with calculated data or false on
96315 *   failure.
96316 * @since PECL trader >= 0.2.0
96317 **/
96318function trader_sarext($high, $low, $startValue, $offsetOnReverse, $accelerationInitLong, $accelerationLong, $accelerationMaxLong, $accelerationInitShort, $accelerationShort, $accelerationMaxShort){}
96319
96320/**
96321 * Set compatibility mode
96322 *
96323 * Set compatibility mode which will affect the way calculations are done
96324 * by all the extension functions.
96325 *
96326 * @param int $compatId Compatibility Id. TRADER_COMPATIBILITY_* series
96327 *   of constants should be used.
96328 * @return void
96329 * @since PECL trader >= 0.2.2
96330 **/
96331function trader_set_compat($compatId){}
96332
96333/**
96334 * Set unstable period
96335 *
96336 * Influences unstable period factor for functions, which are sensible to
96337 * it. More information about unstable periods can be found on the TA-Lib
96338 * API documentation page.
96339 *
96340 * @param int $functionId Function ID the factor should be set for.
96341 *   TRADER_FUNC_UNST_* constant series can be used to affect the
96342 *   corresponding function.
96343 * @param int $timePeriod Unstable period value.
96344 * @return void
96345 * @since PECL trader >= 0.2.2
96346 **/
96347function trader_set_unstable_period($functionId, $timePeriod){}
96348
96349/**
96350 * Vector Trigonometric Sin
96351 *
96352 * Calculates the sine for each value in {@link real} and returns the
96353 * resulting array.
96354 *
96355 * @param array $real
96356 * @return array Returns an array with calculated data or false on
96357 *   failure.
96358 * @since PECL trader >= 0.2.0
96359 **/
96360function trader_sin($real){}
96361
96362/**
96363 * Vector Trigonometric Sinh
96364 *
96365 * Calculates the hyperbolic sine for each value in {@link real} and
96366 * returns the resulting array.
96367 *
96368 * @param array $real
96369 * @return array Returns an array with calculated data or false on
96370 *   failure.
96371 * @since PECL trader >= 0.2.0
96372 **/
96373function trader_sinh($real){}
96374
96375/**
96376 * Simple Moving Average
96377 *
96378 * @param array $real
96379 * @param int $timePeriod
96380 * @return array Returns an array with calculated data or false on
96381 *   failure.
96382 * @since PECL trader >= 0.2.0
96383 **/
96384function trader_sma($real, $timePeriod){}
96385
96386/**
96387 * Vector Square Root
96388 *
96389 * Calculates the square root of each value in {@link real} and returns
96390 * the resulting array.
96391 *
96392 * @param array $real
96393 * @return array Returns an array with calculated data or false on
96394 *   failure.
96395 * @since PECL trader >= 0.2.0
96396 **/
96397function trader_sqrt($real){}
96398
96399/**
96400 * Standard Deviation
96401 *
96402 * @param array $real
96403 * @param int $timePeriod
96404 * @param float $nbDev
96405 * @return array Returns an array with calculated data or false on
96406 *   failure.
96407 * @since PECL trader >= 0.2.0
96408 **/
96409function trader_stddev($real, $timePeriod, $nbDev){}
96410
96411/**
96412 * Stochastic
96413 *
96414 * @param array $high
96415 * @param array $low
96416 * @param array $close
96417 * @param int $fastK_Period
96418 * @param int $slowK_Period
96419 * @param int $slowK_MAType
96420 * @param int $slowD_Period
96421 * @param int $slowD_MAType
96422 * @return array Returns an array with calculated data or false on
96423 *   failure.
96424 * @since PECL trader >= 0.2.0
96425 **/
96426function trader_stoch($high, $low, $close, $fastK_Period, $slowK_Period, $slowK_MAType, $slowD_Period, $slowD_MAType){}
96427
96428/**
96429 * Stochastic Fast
96430 *
96431 * @param array $high
96432 * @param array $low
96433 * @param array $close
96434 * @param int $fastK_Period
96435 * @param int $fastD_Period
96436 * @param int $fastD_MAType
96437 * @return array Returns an array with calculated data or false on
96438 *   failure.
96439 * @since PECL trader >= 0.2.0
96440 **/
96441function trader_stochf($high, $low, $close, $fastK_Period, $fastD_Period, $fastD_MAType){}
96442
96443/**
96444 * Stochastic Relative Strength Index
96445 *
96446 * @param array $real
96447 * @param int $timePeriod
96448 * @param int $fastK_Period
96449 * @param int $fastD_Period
96450 * @param int $fastD_MAType
96451 * @return array Returns an array with calculated data or false on
96452 *   failure.
96453 * @since PECL trader >= 0.2.0
96454 **/
96455function trader_stochrsi($real, $timePeriod, $fastK_Period, $fastD_Period, $fastD_MAType){}
96456
96457/**
96458 * Vector Arithmetic Subtraction
96459 *
96460 * Calculates the vector subtraction of {@link real1} from {@link real0}
96461 * and returns the resulting vector.
96462 *
96463 * @param array $real0
96464 * @param array $real1
96465 * @return array Returns an array with calculated data or false on
96466 *   failure.
96467 * @since PECL trader >= 0.2.0
96468 **/
96469function trader_sub($real0, $real1){}
96470
96471/**
96472 * Summation
96473 *
96474 * @param array $real
96475 * @param int $timePeriod
96476 * @return array Returns an array with calculated data or false on
96477 *   failure.
96478 * @since PECL trader >= 0.2.0
96479 **/
96480function trader_sum($real, $timePeriod){}
96481
96482/**
96483 * Triple Exponential Moving Average (T3)
96484 *
96485 * @param array $real
96486 * @param int $timePeriod
96487 * @param float $vFactor
96488 * @return array Returns an array with calculated data or false on
96489 *   failure.
96490 * @since PECL trader >= 0.2.0
96491 **/
96492function trader_t3($real, $timePeriod, $vFactor){}
96493
96494/**
96495 * Vector Trigonometric Tan
96496 *
96497 * Calculates the tangent for each value in {@link real} and returns the
96498 * resulting array.
96499 *
96500 * @param array $real
96501 * @return array Returns an array with calculated data or false on
96502 *   failure.
96503 * @since PECL trader >= 0.2.0
96504 **/
96505function trader_tan($real){}
96506
96507/**
96508 * Vector Trigonometric Tanh
96509 *
96510 * Calculates the hyperbolic tangent for each value in {@link real} and
96511 * returns the resulting array.
96512 *
96513 * @param array $real
96514 * @return array Returns an array with calculated data or false on
96515 *   failure.
96516 * @since PECL trader >= 0.2.0
96517 **/
96518function trader_tanh($real){}
96519
96520/**
96521 * Triple Exponential Moving Average
96522 *
96523 * @param array $real
96524 * @param int $timePeriod
96525 * @return array Returns an array with calculated data or false on
96526 *   failure.
96527 * @since PECL trader >= 0.2.0
96528 **/
96529function trader_tema($real, $timePeriod){}
96530
96531/**
96532 * True Range
96533 *
96534 * @param array $high
96535 * @param array $low
96536 * @param array $close
96537 * @return array Returns an array with calculated data or false on
96538 *   failure.
96539 * @since PECL trader >= 0.2.0
96540 **/
96541function trader_trange($high, $low, $close){}
96542
96543/**
96544 * Triangular Moving Average
96545 *
96546 * @param array $real
96547 * @param int $timePeriod
96548 * @return array Returns an array with calculated data or false on
96549 *   failure.
96550 * @since PECL trader >= 0.2.0
96551 **/
96552function trader_trima($real, $timePeriod){}
96553
96554/**
96555 * 1-day Rate-Of-Change (ROC) of a Triple Smooth EMA
96556 *
96557 * @param array $real
96558 * @param int $timePeriod
96559 * @return array Returns an array with calculated data or false on
96560 *   failure.
96561 * @since PECL trader >= 0.2.0
96562 **/
96563function trader_trix($real, $timePeriod){}
96564
96565/**
96566 * Time Series Forecast
96567 *
96568 * @param array $real
96569 * @param int $timePeriod
96570 * @return array Returns an array with calculated data or false on
96571 *   failure.
96572 * @since PECL trader >= 0.2.0
96573 **/
96574function trader_tsf($real, $timePeriod){}
96575
96576/**
96577 * Typical Price
96578 *
96579 * @param array $high
96580 * @param array $low
96581 * @param array $close
96582 * @return array Returns an array with calculated data or false on
96583 *   failure.
96584 * @since PECL trader >= 0.2.0
96585 **/
96586function trader_typprice($high, $low, $close){}
96587
96588/**
96589 * Ultimate Oscillator
96590 *
96591 * @param array $high
96592 * @param array $low
96593 * @param array $close
96594 * @param int $timePeriod1 Number of bars for 1st period. Valid range
96595 *   from 1 to 100000.
96596 * @param int $timePeriod2 Number of bars for 2nd period. Valid range
96597 *   from 1 to 100000.
96598 * @param int $timePeriod3 Number of bars for 3rd period. Valid range
96599 *   from 1 to 100000.
96600 * @return array Returns an array with calculated data or false on
96601 *   failure.
96602 * @since PECL trader >= 0.2.0
96603 **/
96604function trader_ultosc($high, $low, $close, $timePeriod1, $timePeriod2, $timePeriod3){}
96605
96606/**
96607 * Variance
96608 *
96609 * @param array $real
96610 * @param int $timePeriod
96611 * @param float $nbDev
96612 * @return array Returns an array with calculated data or false on
96613 *   failure.
96614 * @since PECL trader >= 0.2.0
96615 **/
96616function trader_var($real, $timePeriod, $nbDev){}
96617
96618/**
96619 * Weighted Close Price
96620 *
96621 * @param array $high
96622 * @param array $low
96623 * @param array $close
96624 * @return array Returns an array with calculated data or false on
96625 *   failure.
96626 * @since PECL trader >= 0.2.0
96627 **/
96628function trader_wclprice($high, $low, $close){}
96629
96630/**
96631 * Williams' %R
96632 *
96633 * @param array $high
96634 * @param array $low
96635 * @param array $close
96636 * @param int $timePeriod
96637 * @return array Returns an array with calculated data or false on
96638 *   failure.
96639 * @since PECL trader >= 0.2.0
96640 **/
96641function trader_willr($high, $low, $close, $timePeriod){}
96642
96643/**
96644 * Weighted Moving Average
96645 *
96646 * @param array $real
96647 * @param int $timePeriod
96648 * @return array Returns an array with calculated data or false on
96649 *   failure.
96650 * @since PECL trader >= 0.2.0
96651 **/
96652function trader_wma($real, $timePeriod){}
96653
96654/**
96655 * Checks if the trait exists
96656 *
96657 * @param string $traitname Name of the trait to check
96658 * @param bool $autoload Whether to autoload if not already loaded.
96659 * @return bool Returns TRUE if trait exists, FALSE if not, NULL in
96660 *   case of an error.
96661 * @since PHP 5 >= 5.4.0, PHP 7
96662 **/
96663function trait_exists($traitname, $autoload){}
96664
96665/**
96666 * Create a transliterator
96667 *
96668 * Opens a Transliterator by id.
96669 *
96670 * @param string $id The id.
96671 * @param int $direction The direction, defaults to
96672 *   >Transliterator::FORWARD. May also be set to
96673 *   Transliterator::REVERSE.
96674 * @return Transliterator Returns a Transliterator object on success,
96675 *   or NULL on failure.
96676 **/
96677function transliterator_create($id, $direction){}
96678
96679/**
96680 * Create transliterator from rules
96681 *
96682 * Creates a Transliterator from rules.
96683 *
96684 * @param string $id The rules as defined in Transform Rules Syntax of
96685 *   UTS #35: Unicode LDML.
96686 * @param int $direction The direction, defaults to
96687 *   >Transliterator::FORWARD. May also be set to
96688 *   Transliterator::REVERSE.
96689 * @return Transliterator Returns a Transliterator object on success,
96690 *   or NULL on failure.
96691 **/
96692function transliterator_create_from_rules($id, $direction){}
96693
96694/**
96695 * Create an inverse transliterator
96696 *
96697 * Opens the inverse transliterator.
96698 *
96699 * @return Transliterator Returns a Transliterator object on success,
96700 *   or NULL on failure
96701 **/
96702function transliterator_create_inverse(){}
96703
96704/**
96705 * Get last error code
96706 *
96707 * Gets the last error code for this transliterator.
96708 *
96709 * @param Transliterator $trans
96710 * @return int The error code on success, or FALSE if none exists, or
96711 *   on failure.
96712 **/
96713function transliterator_get_error_code($trans){}
96714
96715/**
96716 * Get last error message
96717 *
96718 * Gets the last error message for this transliterator.
96719 *
96720 * @param Transliterator $trans
96721 * @return string The error message on success, or FALSE if none
96722 *   exists, or on failure.
96723 **/
96724function transliterator_get_error_message($trans){}
96725
96726/**
96727 * Get transliterator IDs
96728 *
96729 * Returns an array with the registered transliterator IDs.
96730 *
96731 * @return array An array of registered transliterator IDs on success,
96732 *   .
96733 **/
96734function transliterator_list_ids(){}
96735
96736/**
96737 * Transliterate a string
96738 *
96739 * Transforms a string or part thereof using an ICU transliterator.
96740 *
96741 * @param mixed $transliterator In the procedural version, either a
96742 *   Transliterator or a string from which a Transliterator can be built.
96743 * @param string $subject The string to be transformed.
96744 * @param int $start The start index (in UTF-16 code units) from which
96745 *   the string will start to be transformed, inclusive. Indexing starts
96746 *   at 0. The text before will be left as is.
96747 * @param int $end The end index (in UTF-16 code units) until which the
96748 *   string will be transformed, exclusive. Indexing starts at 0. The
96749 *   text after will be left as is.
96750 **/
96751function transliterator_transliterate($transliterator, $subject, $start, $end){}
96752
96753/**
96754 * Generates a user-level error/warning/notice message
96755 *
96756 * Used to trigger a user error condition, it can be used in conjunction
96757 * with the built-in error handler, or with a user defined function that
96758 * has been set as the new error handler ({@link set_error_handler}).
96759 *
96760 * This function is useful when you need to generate a particular
96761 * response to an exception at runtime.
96762 *
96763 * @param string $error_msg The designated error message for this
96764 *   error. It's limited to 1024 bytes in length. Any additional
96765 *   characters beyond 1024 bytes will be truncated.
96766 * @param int $error_type The designated error type for this error. It
96767 *   only works with the E_USER family of constants, and will default to
96768 *   E_USER_NOTICE.
96769 * @return bool This function returns FALSE if wrong {@link error_type}
96770 *   is specified, TRUE otherwise.
96771 * @since PHP 4 >= 4.0.1, PHP 5, PHP 7
96772 **/
96773function trigger_error($error_msg, $error_type){}
96774
96775/**
96776 * Strip whitespace (or other characters) from the beginning and end of a
96777 * string
96778 *
96779 * This function returns a string with whitespace stripped from the
96780 * beginning and end of {@link str}. Without the second parameter, {@link
96781 * trim} will strip these characters: " " (ASCII 32 (0x20)), an ordinary
96782 * space. "\t" (ASCII 9 (0x09)), a tab. "\n" (ASCII 10 (0x0A)), a new
96783 * line (line feed). "\r" (ASCII 13 (0x0D)), a carriage return. "\0"
96784 * (ASCII 0 (0x00)), the NUL-byte. "\x0B" (ASCII 11 (0x0B)), a vertical
96785 * tab.
96786 *
96787 * @param string $str The string that will be trimmed.
96788 * @param string $character_mask Optionally, the stripped characters
96789 *   can also be specified using the {@link character_mask} parameter.
96790 *   Simply list all characters that you want to be stripped. With .. you
96791 *   can specify a range of characters.
96792 * @return string The trimmed string.
96793 * @since PHP 4, PHP 5, PHP 7
96794 **/
96795function trim($str, $character_mask){}
96796
96797/**
96798 * Sort an array with a user-defined comparison function and maintain
96799 * index association
96800 *
96801 * This function sorts an array such that array indices maintain their
96802 * correlation with the array elements they are associated with, using a
96803 * user-defined comparison function.
96804 *
96805 * This is used mainly when sorting associative arrays where the actual
96806 * element order is significant.
96807 *
96808 * @param array $array The input array.
96809 * @param callable $value_compare_func See {@link usort} and {@link
96810 *   uksort} for examples of user-defined comparison functions.
96811 * @return bool
96812 * @since PHP 4, PHP 5, PHP 7
96813 **/
96814function uasort(&$array, $value_compare_func){}
96815
96816/**
96817 * Make a string's first character uppercase
96818 *
96819 * Returns a string with the first character of {@link str} capitalized,
96820 * if that character is alphabetic.
96821 *
96822 * Note that 'alphabetic' is determined by the current locale. For
96823 * instance, in the default "C" locale characters such as umlaut-a (ä)
96824 * will not be converted.
96825 *
96826 * @param string $str The input string.
96827 * @return string Returns the resulting string.
96828 * @since PHP 4, PHP 5, PHP 7
96829 **/
96830function ucfirst($str){}
96831
96832/**
96833 * Uppercase the first character of each word in a string
96834 *
96835 * Returns a string with the first character of each word in {@link str}
96836 * capitalized, if that character is alphabetic.
96837 *
96838 * The definition of a word is any string of characters that is
96839 * immediately after any character listed in the {@link delimiters}
96840 * parameter (By default these are: space, form-feed, newline, carriage
96841 * return, horizontal tab, and vertical tab).
96842 *
96843 * @param string $str The input string.
96844 * @param string $delimiters The optional {@link delimiters} contains
96845 *   the word separator characters.
96846 * @return string Returns the modified string.
96847 * @since PHP 4, PHP 5, PHP 7
96848 **/
96849function ucwords($str, $delimiters){}
96850
96851/**
96852 * Add various search limits
96853 *
96854 * {@link udm_add_search_limit} adds search restrictions.
96855 *
96856 * @param resource $agent A link to Agent, received after call to
96857 *   {@link udm_alloc_agent}.
96858 * @param int $var Defines the parameter, indicating limits. Possible
96859 *   {@link var} values: UDM_LIMIT_URL - defines document URL limitations
96860 *   to limit the search through subsection of the database. It supports
96861 *   SQL % and _ LIKE wildcards, where % matches any number of
96862 *   characters, even zero characters, and _ matches exactly one
96863 *   character. E.g. http://www.example.___/catalog may stand for
96864 *   http://www.example.com/catalog and http://www.example.net/catalog.
96865 *   UDM_LIMIT_TAG - defines site TAG limitations. In indexer-conf you
96866 *   can assign specific TAGs to various sites and parts of a site. Tags
96867 *   in mnoGoSearch 3.1.x are lines, that may contain metasymbols % and
96868 *   _. Metasymbols allow searching among groups of tags. E.g. there are
96869 *   links with tags ABCD and ABCE, and search restriction is by ABC_ -
96870 *   the search will be made among both of the tags. UDM_LIMIT_LANG -
96871 *   defines document language limitations. UDM_LIMIT_CAT - defines
96872 *   document category limitations. Categories are similar to tag
96873 *   feature, but nested. So you can have one category inside another and
96874 *   so on. You have to use two characters for each level. Use a hex
96875 *   number going from 0-F or a 36 base number going from 0-Z. Therefore
96876 *   a top-level category like 'Auto' would be 01. If it has a
96877 *   subcategory like 'Ford', then it would be 01 (the parent category)
96878 *   and then 'Ford' which we will give 01. Put those together and you
96879 *   get 0101. If 'Auto' had another subcategory named 'VW', then it's id
96880 *   would be 01 because it belongs to the 'Ford' category and then 02
96881 *   because it's the next category. So it's id would be 0102. If VW had
96882 *   a sub category called 'Engine' then it's id would start at 01 again
96883 *   and it would get the 'VW' id 02 and 'Auto' id of 01, making it
96884 *   010201. If you want to search for sites under that category then you
96885 *   pass it cat=010201 in the URL. UDM_LIMIT_DATE - defines limitation
96886 *   by date the document was modified. Format of parameter value: a
96887 *   string with first character < or >, then with no space - date in
96888 *   unixtime format, for example:
96889 *
96890 *   <?php udm_add_search_limit($udm, UDM_LIMIT_DATE, "&lt;908012006");
96891 *   ?>
96892 *
96893 *   If > character is used, then the search will be restricted to those
96894 *   documents having a modification date greater than entered, if <,
96895 *   then smaller.
96896 * @param string $val Defines the value of the current parameter.
96897 * @return bool
96898 * @since PHP 4 >= 4.0.5, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
96899 **/
96900function udm_add_search_limit($agent, $var, $val){}
96901
96902/**
96903 * Allocate mnoGoSearch session
96904 *
96905 * Allocate a mnoGoSearch session.
96906 *
96907 * @param string $dbaddr {@link dbaddr} - URL-style database
96908 *   description, with options (type, host, database name, port, user and
96909 *   password) to connect to SQL database. Do not matter for built-in
96910 *   text files support. Format for {@link dbaddr}:
96911 *   DBType:[//[DBUser[:DBPass]@]DBHost[:DBPort]]/DBName/. Currently
96912 *   supported DBType values are: mysql, pgsql, msql, solid, mssql,
96913 *   oracle, and ibase. Actually, it does not matter for native libraries
96914 *   support, but ODBC users should specify one of the supported values.
96915 *   If your database type is not supported, you may use unknown instead.
96916 * @param string $dbmode {@link dbmode} - You may select the SQL
96917 *   database mode of words storage. Possible values of {@link dbmode}
96918 *   are: single, multi, crc, or crc-multi. When single is specified, all
96919 *   words are stored in the same table. If multi is selected, words will
96920 *   be located in different tables depending of their lengths. "multi"
96921 *   mode is usually faster, but requires more tables in the database. If
96922 *   "crc" mode is selected, mnoGoSearch will store 32 bit integer word
96923 *   IDs calculated by CRC32 algorithm instead of words. This mode
96924 *   requires less disk space and it is faster comparing with "single"
96925 *   and "multi" modes. crc-multi uses the same storage structure with
96926 *   the "crc" mode, but also stores words in different tables depending
96927 *   on words lengths like in "multi" mode.
96928 * @return resource Returns a mnogosearch agent identifier on success,
96929 *   FALSE on failure. This function creates a session with database
96930 *   parameters.
96931 * @since PHP 4 >= 4.0.5, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
96932 **/
96933function udm_alloc_agent($dbaddr, $dbmode){}
96934
96935/**
96936 * Allocate mnoGoSearch session
96937 *
96938 * {@link udm_alloc_agent_array} will create an agent with multiple
96939 * database connections.
96940 *
96941 * @param array $databases The array {@link databases} must contain one
96942 *   database URL per element, analog to the first parameter of {@link
96943 *   udm_alloc_agent}.
96944 * @return resource Returns a resource link identifier on success.
96945 * @since PHP 4 >= 4.3.3, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
96946 **/
96947function udm_alloc_agent_array($databases){}
96948
96949/**
96950 * Get mnoGoSearch API version
96951 *
96952 * Gets the mnoGoSearch API version.
96953 *
96954 * This function allows the user to identify which API functions are
96955 * available, e.g. {@link udm_get_doc_count} function is only available
96956 * in mnoGoSearch 3.1.11 or later.
96957 *
96958 * @return int {@link udm_api_version} returns the mnoGoSearch API
96959 *   version number. E.g. if mnoGoSearch 3.1.10 API is used, this
96960 *   function will return 30110.
96961 * @since PHP 4 >= 4.0.5, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
96962 **/
96963function udm_api_version(){}
96964
96965/**
96966 * Get all the categories on the same level with the current one
96967 *
96968 * Gets all the categories on the same level with the current one.
96969 *
96970 * The function can be useful for developing categories tree browser.
96971 *
96972 * @param resource $agent A link to Agent, received after call to
96973 *   {@link udm_alloc_agent}.
96974 * @param string $category
96975 * @return array Returns an array listing all categories of the same
96976 *   level as the current {@link category} in the categories tree.
96977 * @since PHP 4 >= 4.0.6, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
96978 **/
96979function udm_cat_list($agent, $category){}
96980
96981/**
96982 * Get the path to the current category
96983 *
96984 * Returns an array describing the path in the categories tree from the
96985 * tree root to the current one, specified by {@link category}.
96986 *
96987 * @param resource $agent A link to Agent, received after call to
96988 *   {@link udm_alloc_agent}.
96989 * @param string $category
96990 * @return array The returned array consists of pairs. Elements with
96991 *   even index numbers contain the category paths, odd elements contain
96992 *   the corresponding category names.
96993 * @since PHP 4 >= 4.0.6, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
96994 **/
96995function udm_cat_path($agent, $category){}
96996
96997/**
96998 * Check if the given charset is known to mnogosearch
96999 *
97000 * @param resource $agent
97001 * @param string $charset
97002 * @return bool
97003 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
97004 **/
97005function udm_check_charset($agent, $charset){}
97006
97007/**
97008 * Clear all mnoGoSearch search restrictions
97009 *
97010 * {@link udm_clear_search_limits} resets defined search limitations.
97011 *
97012 * @param resource $agent A link to Agent, received after call to
97013 *   {@link udm_alloc_agent}.
97014 * @return bool Returns TRUE.
97015 * @since PHP 4 >= 4.0.5, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
97016 **/
97017function udm_clear_search_limits($agent){}
97018
97019/**
97020 * Return CRC32 checksum of given string
97021 *
97022 * @param resource $agent
97023 * @param string $str
97024 * @return int
97025 * @since PHP 4 >= 4.2.0, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
97026 **/
97027function udm_crc32($agent, $str){}
97028
97029/**
97030 * Get mnoGoSearch error number
97031 *
97032 * Receiving numeric agent error code.
97033 *
97034 * @param resource $agent A link to Agent, received after call to
97035 *   {@link udm_alloc_agent}.
97036 * @return int Returns the mnoGoSearch error number, zero if no error.
97037 * @since PHP 4 >= 4.0.5, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
97038 **/
97039function udm_errno($agent){}
97040
97041/**
97042 * Get mnoGoSearch error message
97043 *
97044 * Gets the agent error message.
97045 *
97046 * @param resource $agent A link to Agent, received after call to
97047 *   {@link udm_alloc_agent}.
97048 * @return string {@link udm_error} returns mnoGoSearch error message,
97049 *   empty string if no error.
97050 * @since PHP 4 >= 4.0.5, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
97051 **/
97052function udm_error($agent){}
97053
97054/**
97055 * Perform search
97056 *
97057 * Performs a search.
97058 *
97059 * The search itself. The first argument - session, the next one - query
97060 * itself. To find something just type words you want to find and press
97061 * SUBMIT button. For example, "mysql odbc". You should not use quotes "
97062 * in query, they are written here only to divide a query from other
97063 * text. mnoGoSearch will find all documents that contain word "mysql"
97064 * and/or word "odbc". Best documents having bigger weights will be
97065 * displayed first. If you use search mode ALL, search will return
97066 * documents that contain both (or more) words you entered. In case you
97067 * use mode ANY, the search will return list of documents that contain
97068 * any of the words you entered. If you want more advanced results you
97069 * may use query language. You should select "bool" match mode in the
97070 * search from.
97071 *
97072 * @param resource $agent A link to Agent, received after call to
97073 *   {@link udm_alloc_agent}.
97074 * @param string $query mnoGoSearch understands the following boolean
97075 *   operators: & - logical AND. For example, mysql & odbc. mnoGoSearch
97076 *   will find any URLs that contain both mysql and odbc. | - logical OR.
97077 *   For example mysql|odbc. mnoGoSearch will find any URLs, that contain
97078 *   word mysql or word odbc. ~ - logical NOT. For example mysql & ~odbc.
97079 *   mnoGoSearch will find URLs that contain word mysql and do not
97080 *   contain word odbc at the same time. Note that ~ just excludes given
97081 *   word from results. Query ~odbc will find nothing! () - group command
97082 *   to compose more complex queries. For example (mysql | msql) &
97083 *   ~postgres. Query language is simple and powerful at the same time.
97084 *   Just consider query as usual boolean expression.
97085 * @return resource Returns a result link identifier on success.
97086 * @since PHP 4 >= 4.0.5, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
97087 **/
97088function udm_find($agent, $query){}
97089
97090/**
97091 * Free mnoGoSearch session
97092 *
97093 * Freeing up memory allocated for agent session.
97094 *
97095 * @param resource $agent A link to Agent, received after call to
97096 *   {@link udm_alloc_agent}.
97097 * @return int
97098 * @since PHP 4 >= 4.0.5, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
97099 **/
97100function udm_free_agent($agent){}
97101
97102/**
97103 * Free memory allocated for ispell data
97104 *
97105 * Frees the memory allocated for ispell data.
97106 *
97107 * @param int $agent A link to Agent, received after call to {@link
97108 *   udm_alloc_agent}.
97109 * @return bool {@link udm_free_ispell_data} always returns TRUE.
97110 * @since PHP 4 >= 4.0.5, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
97111 **/
97112function udm_free_ispell_data($agent){}
97113
97114/**
97115 * Free mnoGoSearch result
97116 *
97117 * Freeing up memory allocated for results.
97118 *
97119 * @param resource $res A link to a result identifier, received after
97120 *   call to {@link udm_find}.
97121 * @return bool
97122 * @since PHP 4 >= 4.0.5, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
97123 **/
97124function udm_free_res($res){}
97125
97126/**
97127 * Get total number of documents in database
97128 *
97129 * {@link udm_get_doc_count} returns the number of documents in the
97130 * database.
97131 *
97132 * @param resource $agent A link to Agent, received after call to
97133 *   {@link udm_alloc_agent}.
97134 * @return int Returns the number of documents.
97135 * @since PHP 4 >= 4.0.5, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
97136 **/
97137function udm_get_doc_count($agent){}
97138
97139/**
97140 * Fetch a result field
97141 *
97142 * Fetch a mnoGoSearch result field.
97143 *
97144 * @param resource $res {@link res} - a link to result identifier,
97145 *   received after call to {@link udm_find}.
97146 * @param int $row {@link row} - the number of the link on the current
97147 *   page. May have values from 0 to {@link UDM_PARAM_NUM_ROWS-1}.
97148 * @param int $field {@link field} - field identifier, may have the
97149 *   following values: UDM_FIELD_URL - document URL field
97150 *   UDM_FIELD_CONTENT - document Content-type field (for example,
97151 *   text/html). UDM_FIELD_CATEGORY - document category field. Use {@link
97152 *   udm_cat_path} to get full path to current category from the
97153 *   categories tree root. (This parameter is available only in PHP 4.0.6
97154 *   or later). UDM_FIELD_TITLE - document title field.
97155 *   UDM_FIELD_KEYWORDS - document keywords field (from META KEYWORDS
97156 *   tag). UDM_FIELD_DESC - document description field (from META
97157 *   DESCRIPTION tag). UDM_FIELD_TEXT - document body text (the first
97158 *   couple of lines to give an idea of what the document is about).
97159 *   UDM_FIELD_SIZE - document size. UDM_FIELD_URLID - unique URL ID of
97160 *   the link. UDM_FIELD_RATING - page rating (as calculated by
97161 *   mnoGoSearch). UDM_FIELD_MODIFIED - last-modified field in unixtime
97162 *   format. UDM_FIELD_ORDER - the number of the current document in set
97163 *   of found documents. UDM_FIELD_CRC - document CRC.
97164 * @return string {@link udm_get_res_field} returns result field value
97165 *   on success, FALSE on error.
97166 * @since PHP 4 >= 4.0.5, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
97167 **/
97168function udm_get_res_field($res, $row, $field){}
97169
97170/**
97171 * Get mnoGoSearch result parameters
97172 *
97173 * Gets the mnoGoSearch result parameters.
97174 *
97175 * @param resource $res {@link res} - a link to result identifier,
97176 *   received after call to {@link udm_find}.
97177 * @param int $param {@link param} - parameter identifier, may have the
97178 *   following values: UDM_PARAM_NUM_ROWS - number of received found
97179 *   links on the current page. It is equal to UDM_PARAM_PAGE_SIZE for
97180 *   all search pages, on the last page - the rest of links.
97181 *   UDM_PARAM_FOUND - total number of results matching the query.
97182 *   UDM_PARAM_WORDINFO - information on the words found. E.g. search for
97183 *   "a good book" will return "a: stopword, good:5637, book: 120"
97184 *   UDM_PARAM_SEARCHTIME - search time in seconds. UDM_PARAM_FIRST_DOC -
97185 *   the number of the first document displayed on current page.
97186 *   UDM_PARAM_LAST_DOC - the number of the last document displayed on
97187 *   current page.
97188 * @return string {@link udm_get_res_param} returns result parameter
97189 *   value on success, FALSE on error.
97190 * @since PHP 4 >= 4.0.5, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
97191 **/
97192function udm_get_res_param($res, $param){}
97193
97194/**
97195 * Return Hash32 checksum of given string
97196 *
97197 * {@link udm_hash32} will take a string {@link str} and return a quite
97198 * unique 32-bit hash number from it.
97199 *
97200 * @param resource $agent A link to Agent, received after call to
97201 *   {@link udm_alloc_agent}.
97202 * @param string $str The input string.
97203 * @return int Returns a 32-bit hash number.
97204 * @since PHP 4 >= 4.3.3, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
97205 **/
97206function udm_hash32($agent, $str){}
97207
97208/**
97209 * Load ispell data
97210 *
97211 * {@link udm_load_ispell_data} loads ispell data.
97212 *
97213 * After using this function to free memory allocated for ispell data,
97214 * please use {@link udm_free_ispell_data}, even if you use
97215 * UDM_ISPELL_TYPE_SERVER mode.
97216 *
97217 * @param resource $agent A link to Agent, received after call to
97218 *   {@link udm_alloc_agent}.
97219 * @param int $var Indicates the source for ispell data. May have the
97220 *   following values: UDM_ISPELL_TYPE_DB - indicates that ispell data
97221 *   should be loaded from SQL. In this case, parameters {@link val1} and
97222 *   {@link val2} are ignored and should be left blank. {@link flag}
97223 *   should be equal to 1. {@link flag} indicates that after loading
97224 *   ispell data from defined source it should be sorted (it is necessary
97225 *   for correct functioning of ispell). In case of loading ispell data
97226 *   from files there may be several calls to {@link
97227 *   udm_load_ispell_data}, and there is no sense to sort data after
97228 *   every call, but only after the last one. Since in db mode all the
97229 *   data is loaded by one call, this parameter should have the value 1.
97230 *   In this mode in case of error, e.g. if ispell tables are absent, the
97231 *   function will return FALSE and code and error message will be
97232 *   accessible through {@link udm_error} and {@link udm_errno}.
97233 *   UDM_ISPELL_TYPE_AFFIX - indicates that ispell data should be loaded
97234 *   from file and initiates loading affixes file. In this case {@link
97235 *   val1} defines double letter language code for which affixes are
97236 *   loaded, and {@link val2} - file path. Please note, that if a
97237 *   relative path entered, the module looks for the file not in
97238 *   UDM_CONF_DIR, but in relation to current path, i.e. to the path
97239 *   where the script is executed. In case of error in this mode, e.g. if
97240 *   file is absent, the function will return FALSE, and an error message
97241 *   will be displayed. Error message text cannot be accessed through
97242 *   {@link udm_error} and {@link udm_errno}, since those functions can
97243 *   only return messages associated with SQL. Please, see {@link flag}
97244 *   parameter description in UDM_ISPELL_TYPE_DB. {@link
97245 *   udm_load_ispell_data} example
97246 *
97247 *   <?php if ((! udm_load_ispell_data($udm, UDM_ISPELL_TYPE_AFFIX, 'en',
97248 *   '/opt/ispell/en.aff', 0)) || (! udm_load_ispell_data($udm,
97249 *   UDM_ISPELL_TYPE_AFFIX, 'ru', '/opt/ispell/ru.aff', 0)) || (!
97250 *   udm_load_ispell_data($udm, UDM_ISPELL_TYPE_SPELL, 'en',
97251 *   '/opt/ispell/en.dict', 0)) || (! udm_load_ispell_data($udm,
97252 *   UDM_ISPELL_TYPE_SPELL, 'ru', '/opt/ispell/ru.dict', 1))) { exit; }
97253 *   ?>
97254 *
97255 *   {@link flag} is equal to 1 only in the last call.
97256 *   UDM_ISPELL_TYPE_SPELL - indicates that ispell data should be loaded
97257 *   from file and initiates loading of ispell dictionary file. In this
97258 *   case {@link val1} defines double letter language code for which
97259 *   affixes are loaded, and {@link val2} - file path. Please note, that
97260 *   if a relative path entered, the module looks for the file not in
97261 *   UDM_CONF_DIR, but in relation to current path, i.e. to the path
97262 *   where the script is executed. In case of error in this mode, e.g. if
97263 *   file is absent, the function will return FALSE, and an error message
97264 *   will be displayed. Error message text cannot be accessed through
97265 *   {@link udm_error} and {@link udm_errno}, since those functions can
97266 *   only return messages associated with SQL. Please, see {@link flag}
97267 *   parameter description in UDM_ISPELL_TYPE_DB.
97268 *
97269 *   <?php if ((! udm_load_ispell_data($udm, UDM_ISPELL_TYPE_AFFIX, 'en',
97270 *   '/opt/ispell/en.aff', 0)) || (! udm_load_ispell_data($udm,
97271 *   UDM_ISPELL_TYPE_AFFIX, 'ru', '/opt/ispell/ru.aff', 0)) || (!
97272 *   udm_load_ispell_data($udm, UDM_ISPELL_TYPE_SPELL, 'en',
97273 *   '/opt/ispell/en.dict', 0)) || (! udm_load_ispell_data($udm,
97274 *   UDM_ISPELL_TYPE_SPELL, 'ru', '/opt/ispell/ru.dict', 1))) { exit; }
97275 *   ?>
97276 *
97277 *   {@link flag} is equal to 1 only in the last call.
97278 *   UDM_ISPELL_TYPE_SERVER - enables spell server support. {@link val1}
97279 *   parameter indicates address of the host running spell server. {@link
97280 *   val2} ` is not used yet, but in future releases it is going to
97281 *   indicate number of port used by spell server. {@link flag} parameter
97282 *   in this case is not needed since ispell data is stored on
97283 *   spellserver already sorted. Spelld server reads spell-data from a
97284 *   separate configuration file (/usr/local/mnogosearch/etc/spelld.conf
97285 *   by default), sorts it and stores in memory. With clients server
97286 *   communicates in two ways: to indexer all the data is transferred (so
97287 *   that indexer starts faster), from search.cgi server receives word to
97288 *   normalize and then passes over to client (search.cgi) list of
97289 *   normalized word forms. This allows fastest, compared to db and text
97290 *   modes processing of search queries (by omitting loading and sorting
97291 *   all the spell data). {@link udm_load_ispell_data} function in
97292 *   UDM_ISPELL_TYPE_SERVER mode does not actually load ispell data, but
97293 *   only defines server address. In fact, server is automatically used
97294 *   by {@link udm_find} function when performing search. In case of
97295 *   errors, e.g. if spellserver is not running or invalid host
97296 *   indicated, there are no messages returned and ispell conversion does
97297 *   not work. This function is available in mnoGoSearch 3.1.12 or later.
97298 *   Example:
97299 *
97300 *   <?php if (!udm_load_ispell_data($udm, UDM_ISPELL_TYPE_SERVER, '',
97301 *   '', 1)) { echo "Error loading ispell data from server<br />\n";
97302 *   exit; } ?>
97303 *
97304 *   The fastest mode is UDM_ISPELL_TYPE_SERVER. UDM_ISPELL_TYPE_TEXT is
97305 *   slower and UDM_ISPELL_TYPE_DB is the slowest. The above pattern is
97306 *   TRUE for mnoGoSearch 3.1.10 - 3.1.11. It is planned to speed up DB
97307 *   mode in future versions and it is going to be faster than TEXT mode.
97308 * @param string $val1
97309 * @param string $val2
97310 * @param int $flag
97311 * @return bool
97312 * @since PHP 4 >= 4.0.5, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
97313 **/
97314function udm_load_ispell_data($agent, $var, $val1, $val2, $flag){}
97315
97316/**
97317 * Set mnoGoSearch agent session parameters
97318 *
97319 * Defines mnoGoSearch session parameters.
97320 *
97321 * @param resource $agent A link to Agent, received after call to
97322 *   {@link udm_alloc_agent}.
97323 * @param int $var The following parameters and their values are
97324 *   available: UDM_PARAM_PAGE_NUM - used to choose search results page
97325 *   number (results are returned by pages beginning from 0, with
97326 *   UDM_PARAM_PAGE_SIZE results per page). UDM_PARAM_PAGE_SIZE - number
97327 *   of search results displayed on one page. UDM_PARAM_SEARCH_MODE -
97328 *   search mode. The following values available: UDM_MODE_ALL - search
97329 *   for all words; UDM_MODE_ANY - search for any word; UDM_MODE_PHRASE -
97330 *   phrase search; UDM_MODE_BOOL - boolean search. See {@link udm_find}
97331 *   for details on boolean search. UDM_PARAM_CACHE_MODE - turns on or
97332 *   off search result cache mode. When enabled, the search engine will
97333 *   store search results to disk. In case a similar search is performed
97334 *   later, the engine will take results from the cache for faster
97335 *   performance. Available values: UDM_CACHE_ENABLED,
97336 *   UDM_CACHE_DISABLED. UDM_PARAM_TRACK_MODE - turns on or off
97337 *   trackquery mode. Since version 3.1.2 mnoGoSearch has a query
97338 *   tracking support. Note that tracking is implemented in SQL version
97339 *   only and not available in built-in database. To use tracking, you
97340 *   have to create tables for tracking support. For MySQL, use
97341 *   create/mysql/track.txt. When doing a search, front-end uses those
97342 *   tables to store query words, a number of found documents and current
97343 *   Unix timestamp in seconds. Available values: UDM_TRACK_ENABLED,
97344 *   UDM_TRACK_DISABLED. UDM_PARAM_PHRASE_MODE - defines whether index
97345 *   database using phrases ("phrase" parameter in indexer.conf).
97346 *   Possible values: UDM_PHRASE_ENABLED and UDM_PHRASE_DISABLED. Please
97347 *   note, that if phrase search is enabled (UDM_PHRASE_ENABLED), it is
97348 *   still possible to do search in any mode (ANY, ALL, BOOL or PHRASE).
97349 *   In 3.1.10 version of mnoGoSearch phrase search is supported only in
97350 *   sql and built-in database modes, while beginning with 3.1.11 phrases
97351 *   are supported in cachemode as well. Examples of phrase search:
97352 *   "Arizona desert" - This query returns all indexed documents that
97353 *   contain "Arizona desert" as a phrase. Notice that you need to put
97354 *   double quotes around the phrase UDM_PARAM_CHARSET - defines local
97355 *   charset. Available values: set of charsets supported by mnoGoSearch,
97356 *   e.g. koi8-r, cp1251, ... UDM_PARAM_STOPFILE - Defines name and path
97357 *   to stopwords file. (There is a small difference with mnoGoSearch -
97358 *   while in mnoGoSearch if relative path or no path entered, it looks
97359 *   for this file in relation to UDM_CONF_DIR, the module looks for the
97360 *   file in relation to current path, i.e. to the path where the PHP
97361 *   script is executed.) UDM_PARAM_STOPTABLE - Load stop words from the
97362 *   given SQL table. You may use several StopwordTable commands. This
97363 *   command has no effect when compiled without SQL database support.
97364 *   UDM_PARAM_WEIGHT_FACTOR - represents weight factors for specific
97365 *   document parts. Currently body, title, keywords, description, url
97366 *   are supported. To activate this feature please use degrees of 2 in
97367 *   *Weight commands of the indexer.conf. Let's imagine that we have
97368 *   these weights: URLWeight 1 BodyWeight 2 TitleWeight 4 KeywordWeight
97369 *   8 DescWeight 16 As far as indexer uses bit OR operation for word
97370 *   weights when some word presents several time in the same document,
97371 *   it is possible at search time to detect word appearance in different
97372 *   document parts. Word which appears only in the body will have
97373 *   00000010 aggregate weight (in binary notation). Word used in all
97374 *   document parts will have 00011111 aggregate weight. This parameter's
97375 *   value is a string of hex digits ABCDE. Each digit is a factor for
97376 *   corresponding bit in word weight. For the given above weights
97377 *   configuration: E is a factor for weight 1 (URL Weight bit) D is a
97378 *   factor for weight 2 (BodyWeight bit) C is a factor for weight 4
97379 *   (TitleWeight bit) B is a factor for weight 8 (KeywordWeight bit) A
97380 *   is a factor for weight 16 (DescWeight bit) Examples:
97381 *   UDM_PARAM_WEIGHT_FACTOR=00001 will search through URLs only.
97382 *   UDM_PARAM_WEIGHT_FACTOR=00100 will search through Titles only.
97383 *   UDM_PARAM_WEIGHT_FACTOR=11100 will search through
97384 *   Title,Keywords,Description but not through URL and Body.
97385 *   UDM_PARAM_WEIGHT_FACTOR=F9421 will search through: Description with
97386 *   factor 15 (F hex) Keywords with factor 9 Title with factor 4 Body
97387 *   with factor 2 URL with factor 1 If UDM_PARAM_WEIGHT_FACTOR variable
97388 *   is omitted, original weight value is taken to sort results. For a
97389 *   given above weight configuration it means that document description
97390 *   has a most big weight 16. UDM_PARAM_WORD_MATCH - word match. You may
97391 *   use this parameter to choose word match type. This feature works
97392 *   only in "single" and "multi" modes using SQL based and built-in
97393 *   database. It does not work in cachemode and other modes since they
97394 *   use word CRC and do not support substring search. Available values:
97395 *   UDM_MATCH_BEGIN - word beginning match; UDM_MATCH_END - word ending
97396 *   match; UDM_MATCH_WORD - whole word match; UDM_MATCH_SUBSTR - word
97397 *   substring match. UDM_PARAM_MIN_WORD_LEN - defines minimal word
97398 *   length. Any word shorter this limit is considered to be a stopword.
97399 *   Please note that this parameter value is inclusive, i.e. if
97400 *   UDM_PARAM_MIN_WORD_LEN=3, a word 3 characters long will not be
97401 *   considered a stopword, while a word 2 characters long will be.
97402 *   Default value is 1. UDM_PARAM_ISPELL_PREFIXES - Possible values:
97403 *   UDM_PREFIXES_ENABLED and UDM_PREFIXES_DISABLED, that respectively
97404 *   enable or disable using prefixes. E.g. if a word "tested" is in
97405 *   search query, also words like "test", "testing", etc. Only suffixes
97406 *   are supported by default. Prefixes usually change word meanings, for
97407 *   example if somebody is searching for the word "tested" one hardly
97408 *   wants "untested" to be found. Prefixes support may also be found
97409 *   useful for site's spelling checking purposes. In order to enable
97410 *   ispell, you have to load ispell data with {@link
97411 *   udm_load_ispell_data}. UDM_PARAM_CROSS_WORDS - enables or disables
97412 *   crosswords support. Possible values: UDM_CROSS_WORDS_ENABLED and
97413 *   UDM_CROSS_WORDS_DISABLED. The crosswords feature allows to assign
97414 *   words between <a href="xxx"> and </a> also to a document this link
97415 *   leads to. It works in SQL database mode and is not supported in
97416 *   built-in database and Cachemode. UDM_PARAM_VARDIR - specifies a
97417 *   custom path to directory where indexer stores data when using
97418 *   built-in database and in cache mode. By default /var directory of
97419 *   mnoGoSearch installation is used. Can have only string values.
97420 * @param string $val
97421 * @return bool
97422 * @since PHP 4 >= 4.0.5, PHP 5 < 5.1.0, PECL mnogosearch >= 1.0.0
97423 **/
97424function udm_set_agent_param($agent, $var, $val){}
97425
97426namespace UI\Draw\Text\Font {
97427
97428/**
97429 * Retrieve Font Families
97430 *
97431 * Returns an array of valid font families for the current system
97432 *
97433 * @return array
97434 **/
97435function fontFamilies(){}
97436
97437}
97438
97439namespace UI {
97440
97441/**
97442 * Quit UI Loop
97443 *
97444 * Shall cause the main loop to be exited
97445 *
97446 * @return void
97447 **/
97448function quit(){}
97449
97450}
97451
97452namespace UI {
97453
97454/**
97455 * Enter UI Loop
97456 *
97457 * Shall cause PHP to enter into the main loop, by default control will
97458 * not be returned to the caller
97459 *
97460 * @param int $flags Set UI\Loop to return control, and UI\Wait to
97461 *   return control after waiting
97462 * @return void
97463 **/
97464function run($flags){}
97465
97466}
97467
97468/**
97469 * Sort an array by keys using a user-defined comparison function
97470 *
97471 * {@link uksort} will sort the keys of an array using a user-supplied
97472 * comparison function. If the array you wish to sort needs to be sorted
97473 * by some non-trivial criteria, you should use this function.
97474 *
97475 * @param array $array The input array.
97476 * @param callable $key_compare_func
97477 * @return bool
97478 * @since PHP 4, PHP 5, PHP 7
97479 **/
97480function uksort(&$array, $key_compare_func){}
97481
97482/**
97483 * Changes the current umask
97484 *
97485 * {@link umask} sets PHP's umask to {@link mask} & 0777 and returns the
97486 * old umask. When PHP is being used as a server module, the umask is
97487 * restored when each request is finished.
97488 *
97489 * @param int $mask The new umask.
97490 * @return int {@link umask} without arguments simply returns the
97491 *   current umask otherwise the old umask is returned.
97492 * @since PHP 4, PHP 5, PHP 7
97493 **/
97494function umask($mask){}
97495
97496/**
97497 * Generate a unique ID
97498 *
97499 * Gets a prefixed unique identifier based on the current time in
97500 * microseconds.
97501 *
97502 * @param string $prefix Can be useful, for instance, if you generate
97503 *   identifiers simultaneously on several hosts that might happen to
97504 *   generate the identifier at the same microsecond. With an empty
97505 *   {@link prefix}, the returned string will be 13 characters long. If
97506 *   {@link more_entropy} is TRUE, it will be 23 characters.
97507 * @param bool $more_entropy If set to TRUE, {@link uniqid} will add
97508 *   additional entropy (using the combined linear congruential
97509 *   generator) at the end of the return value, which increases the
97510 *   likelihood that the result will be unique.
97511 * @return string Returns timestamp based unique identifier as a
97512 *   string.
97513 * @since PHP 4, PHP 5, PHP 7
97514 **/
97515function uniqid($prefix, $more_entropy){}
97516
97517/**
97518 * Convert Unix timestamp to Julian Day
97519 *
97520 * Return the Julian Day for a Unix {@link timestamp} (seconds since
97521 * 1.1.1970), or for the current day if no {@link timestamp} is given.
97522 * Either way, the time is regarded as local time (not UTC).
97523 *
97524 * @param int $timestamp A unix timestamp to convert.
97525 * @return int A julian day number as integer.
97526 * @since PHP 4, PHP 5, PHP 7
97527 **/
97528function unixtojd($timestamp){}
97529
97530/**
97531 * Deletes a file
97532 *
97533 * Deletes {@link filename}. Similar to the Unix C unlink() function. An
97534 * E_WARNING level error will be generated on failure.
97535 *
97536 * @param string $filename Path to the file.
97537 * @param resource $context
97538 * @return bool
97539 * @since PHP 4, PHP 5, PHP 7
97540 **/
97541function unlink($filename, $context){}
97542
97543/**
97544 * Unpack data from binary string
97545 *
97546 * Unpacks from a binary string into an array according to the given
97547 * {@link format}.
97548 *
97549 * The unpacked data is stored in an associative array. To accomplish
97550 * this you have to name the different format codes and separate them by
97551 * a slash /. If a repeater argument is present, then each of the array
97552 * keys will have a sequence number behind the given name.
97553 *
97554 * @param string $format See {@link pack} for an explanation of the
97555 *   format codes.
97556 * @param string $data The packed data.
97557 * @param int $offset The offset to begin unpacking from.
97558 * @return array Returns an associative array containing unpacked
97559 *   elements of binary string.
97560 * @since PHP 4, PHP 5, PHP 7
97561 **/
97562function unpack($format, $data, $offset){}
97563
97564/**
97565 * De-register a function for execution on each tick
97566 *
97567 * @param callable $function The function to de-register.
97568 * @return void
97569 * @since PHP 4 >= 4.0.3, PHP 5, PHP 7
97570 **/
97571function unregister_tick_function($function){}
97572
97573/**
97574 * Creates a PHP value from a stored representation
97575 *
97576 * @param string $str The serialized string. If the variable being
97577 *   unserialized is an object, after successfully reconstructing the
97578 *   object PHP will automatically attempt to call the __unserialize() or
97579 *   __wakeup() methods (if one exists).
97580 *
97581 *   unserialize_callback_func directive It's possible to set a
97582 *   callback-function which will be called, if an undefined class should
97583 *   be instantiated during unserializing. (to prevent getting an
97584 *   incomplete object "__PHP_Incomplete_Class".) Use your , {@link
97585 *   ini_set} or to define unserialize_callback_func. Everytime an
97586 *   undefined class should be instantiated, it'll be called. To disable
97587 *   this feature just empty this setting.
97588 * @param array $options Any options to be provided to {@link
97589 *   unserialize}, as an associative array.
97590 * @return mixed The converted value is returned, and can be a boolean,
97591 *   integer, float, string, array or object.
97592 * @since PHP 4, PHP 5, PHP 7
97593 **/
97594function unserialize($str, $options){}
97595
97596/**
97597 * Untaint strings
97598 *
97599 * @param string $string
97600 * @param string ...$vararg
97601 * @return bool
97602 * @since PECL taint >=0.1.0
97603 **/
97604function untaint(&$string, ...$vararg){}
97605
97606/**
97607 * Adds non-existent function or method
97608 *
97609 * Adds a non-existent function or method.
97610 *
97611 * @param string $function The name of the class.
97612 * @param Closure $handler The name of the function or method.
97613 * @param int $flags The Closure that defines the new function or
97614 *   method.
97615 * @return bool
97616 * @since PECL uopz 5, PECL uopz 6
97617 **/
97618function uopz_add_function($function, $handler, &$flags){}
97619
97620/**
97621 * Allows control over disabled exit opcode
97622 *
97623 * By default uopz disables the exit opcode, so {@link exit} calls are
97624 * practically ignored. {@link uopz_allow_exit} allows to control this
97625 * behavior.
97626 *
97627 * @param bool $allow Whether to allow the execution of exit opcodes or
97628 *   not.
97629 * @return void
97630 * @since PECL uopz 5, PECL uopz 6
97631 **/
97632function uopz_allow_exit($allow){}
97633
97634/**
97635 * Backup a function
97636 *
97637 * Backup a function at runtime, to be restored on shutdown
97638 *
97639 * @param string $function The name of the class containing the
97640 *   function to backup
97641 * @return void
97642 * @since PECL uopz 1 >= 1.0.3, PECL uopz 2
97643 **/
97644function uopz_backup($function){}
97645
97646/**
97647 * Compose a class
97648 *
97649 * Creates a new class of the given name that implements, extends, or
97650 * uses all of the provided classes
97651 *
97652 * @param string $name A legal class name
97653 * @param array $classes An array of class, interface and trait names
97654 * @param array $methods An associative array of methods, values are
97655 *   either closures or [modifiers => closure]
97656 * @param array $properties An associative array of properties, keys
97657 *   are names, values are modifiers
97658 * @param int $flags Entry type, by default ZEND_ACC_CLASS
97659 * @return void
97660 * @since PECL uopz 1, PECL uopz 2
97661 **/
97662function uopz_compose($name, $classes, $methods, $properties, $flags){}
97663
97664/**
97665 * Copy a function
97666 *
97667 * Copy a function by name
97668 *
97669 * @param string $function The name of the class containing the
97670 *   function to copy
97671 * @return Closure A Closure for the specified function
97672 * @since PECL uopz 1 >= 1.0.4, PECL uopz 2
97673 **/
97674function uopz_copy($function){}
97675
97676/**
97677 * Delete a function
97678 *
97679 * Deletes a function or method
97680 *
97681 * @param string $function
97682 * @return void
97683 * @since PECL uopz 1, PECL uopz 2
97684 **/
97685function uopz_delete($function){}
97686
97687/**
97688 * Deletes previously added function or method
97689 *
97690 * Deletes a previously added function or method.
97691 *
97692 * @param string $function The name of the class.
97693 * @return bool
97694 * @since PECL uopz 5, PECL uopz 6
97695 **/
97696function uopz_del_function($function){}
97697
97698/**
97699 * Extend a class at runtime
97700 *
97701 * Makes {@link class} extend {@link parent}
97702 *
97703 * @param string $class The name of the class to extend
97704 * @param string $parent The name of the class to inherit
97705 * @return bool
97706 * @since PECL uopz 1, PECL uopz 2, PECL uopz 5, PECL uopz 6
97707 **/
97708function uopz_extend($class, $parent){}
97709
97710/**
97711 * Get or set flags on function or class
97712 *
97713 * Get or set the flags on a class or function entry at runtime
97714 *
97715 * @param string $function The name of a class
97716 * @param int $flags The name of the function
97717 * @return int If setting, returns old flags, else returns flags
97718 * @since PECL uopz 2 >= 2.0.2, PECL uopz 5, PECL uopz 6
97719 **/
97720function uopz_flags($function, $flags){}
97721
97722/**
97723 * Creates a function at runtime
97724 *
97725 * @param string $function The name of the class to receive the new
97726 *   function
97727 * @param Closure $handler The name of the function
97728 * @param int $modifiers The Closure for the function
97729 * @return void
97730 * @since PECL uopz 1, PECL uopz 2
97731 **/
97732function uopz_function($function, $handler, $modifiers){}
97733
97734/**
97735 * Retrieve the last set exit status
97736 *
97737 * Retrieves the last set exit status, i.e. the value passed to {@link
97738 * exit}.
97739 *
97740 * @return mixed This function returns the last exit status, or NULL if
97741 *   {@link exit} has not been called.
97742 * @since PECL uopz 5, PECL uopz 6
97743 **/
97744function uopz_get_exit_status(){}
97745
97746/**
97747 * Gets previously set hook on function or method
97748 *
97749 * Gets the previously set hook on a function or method.
97750 *
97751 * @param string $function The name of the class.
97752 * @return Closure Returns the previously set hook on a function or
97753 *   method, or NULL if no hook has been set.
97754 * @since PECL uopz 5, PECL uopz 6
97755 **/
97756function uopz_get_hook($function){}
97757
97758/**
97759 * Get the current mock for a class
97760 *
97761 * Returns the current mock for {@link class}.
97762 *
97763 * @param string $class The name of the mocked class.
97764 * @return mixed Either a string containing the name of the mock, or an
97765 *   object, or NULL if no mock has been set.
97766 * @since PECL uopz 5, PECL uopz 6
97767 **/
97768function uopz_get_mock($class){}
97769
97770/**
97771 * Gets value of class or instance property
97772 *
97773 * Gets the value of a static class property, if {@link class} is given,
97774 * or the value of an instance property, if {@link instance} is given.
97775 *
97776 * @param string $class The name of the class.
97777 * @param string $property The object instance.
97778 * @return mixed Returns the value of the class or instance property,
97779 *   or NULL if the property is not defined.
97780 * @since PECL uopz 5, PECL uopz 6
97781 **/
97782function uopz_get_property($class, $property){}
97783
97784/**
97785 * Gets a previous set return value for a function
97786 *
97787 * Gets the return value of the {@link function} previously set by
97788 * uopz_set_return.
97789 *
97790 * @param string $function The name of the class containing the
97791 *   function
97792 * @return mixed The return value or Closure previously set.
97793 * @since PECL uopz 5, PECL uopz 6
97794 **/
97795function uopz_get_return($function){}
97796
97797/**
97798 * Gets the static variables from function or method scope
97799 *
97800 * @param string $class The name of the class.
97801 * @param string $function The name of the function or method.
97802 * @return array Returns an associative array of variable names mapped
97803 *   to their current values on success, or NULL if the function or
97804 *   method does not exist.
97805 * @since PECL uopz 5, PECL uopz 6
97806 **/
97807function uopz_get_static($class, $function){}
97808
97809/**
97810 * Implements an interface at runtime
97811 *
97812 * Makes {@link class} implement {@link interface}
97813 *
97814 * @param string $class
97815 * @param string $interface
97816 * @return bool
97817 * @since PECL uopz 1, PECL uopz 2, PECL uopz 5, PECL uopz 6
97818 **/
97819function uopz_implement($class, $interface){}
97820
97821/**
97822 * Overload a VM opcode
97823 *
97824 * Overloads the specified {@link opcode} with the user defined function
97825 *
97826 * @param int $opcode A valid opcode, see constants for details of
97827 *   supported codes
97828 * @param Callable $callable
97829 * @return void
97830 * @since PECL uopz 1, PECL uopz 2
97831 **/
97832function uopz_overload($opcode, $callable){}
97833
97834/**
97835 * Redefine a constant
97836 *
97837 * Redefines the given {@link constant} as {@link value}
97838 *
97839 * @param string $constant The name of the class containing the
97840 *   constant
97841 * @param mixed $value The name of the constant
97842 * @return bool
97843 * @since PECL uopz 1, PECL uopz 2, PECL uopz 5, PECL uopz 6
97844 **/
97845function uopz_redefine($constant, $value){}
97846
97847/**
97848 * Rename a function at runtime
97849 *
97850 * Renames {@link function} to {@link rename}
97851 *
97852 * @param string $function The name of the class containing the
97853 *   function
97854 * @param string $rename The name of an existing function
97855 * @return void
97856 * @since PECL uopz 1, PECL uopz 2
97857 **/
97858function uopz_rename($function, $rename){}
97859
97860/**
97861 * Restore a previously backed up function
97862 *
97863 * @param string $function The name of the class containing the
97864 *   function to restore
97865 * @return void
97866 * @since PECL uopz 1 >= 1.0.3, PECL uopz 2
97867 **/
97868function uopz_restore($function){}
97869
97870/**
97871 * Sets hook to execute when entering a function or method
97872 *
97873 * Sets a hook to execute when entering a function or method.
97874 *
97875 * @param string $function The name of the class.
97876 * @param Closure $hook The name of the function or method.
97877 * @return bool
97878 * @since PECL uopz 5, PECL uopz 6
97879 **/
97880function uopz_set_hook($function, $hook){}
97881
97882/**
97883 * Use mock instead of class for new objects
97884 *
97885 * If {@link mock} is a string containing the name of a class then it
97886 * will be instantiated instead of {@link class}. {@link mock} can also
97887 * be an object.
97888 *
97889 * @param string $class The name of the class to be mocked.
97890 * @param mixed $mock The mock to use in the form of a string
97891 *   containing the name of the class to use or an object. If a string is
97892 *   passed, it has to be the fully qualified class name. It is
97893 *   recommended to use the ::class magic constant in this case.
97894 * @return void
97895 * @since PECL uopz 5, PECL uopz 6
97896 **/
97897function uopz_set_mock($class, $mock){}
97898
97899/**
97900 * Sets value of existing class or instance property
97901 *
97902 * Sets the value of an existing static class property, if {@link class}
97903 * is given, or the value of an instance property (regardless whether the
97904 * instance property already exists), if {@link instance} is given.
97905 *
97906 * @param string $class The name of the class.
97907 * @param string $property The object instance.
97908 * @param mixed $value The name of the property.
97909 * @return void
97910 * @since PECL uopz 5, PECL uopz 6
97911 **/
97912function uopz_set_property($class, $property, $value){}
97913
97914/**
97915 * Provide a return value for an existing function
97916 *
97917 * Sets the return value of the {@link function} to {@link value}. If
97918 * {@link value} is a Closure and {@link execute} is set, the Closure
97919 * will be executed in place of the original function. It is possible to
97920 * call the original function from the Closure.
97921 *
97922 * @param string $function The name of the class containing the
97923 *   function
97924 * @param mixed $value The name of an existing function
97925 * @param bool $execute The value the function should return. If a
97926 *   Closure is provided and the execute flag is set, the Closure will be
97927 *   executed in place of the original function.
97928 * @return bool True if succeeded, false otherwise.
97929 * @since PECL uopz 5, PECL uopz 6
97930 **/
97931function uopz_set_return($function, $value, $execute){}
97932
97933/**
97934 * Sets the static variables in function or method scope
97935 *
97936 * @param string $function The name of the class.
97937 * @param array $static The name of the function or method.
97938 * @return void
97939 * @since PECL uopz 5, PECL uopz 6
97940 **/
97941function uopz_set_static($function, $static){}
97942
97943/**
97944 * Undefine a constant
97945 *
97946 * Removes the constant at runtime
97947 *
97948 * @param string $constant The name of the class containing {@link
97949 *   constant}
97950 * @return bool
97951 * @since PECL uopz 1, PECL uopz 2, PECL uopz 5, PECL uopz 6
97952 **/
97953function uopz_undefine($constant){}
97954
97955/**
97956 * Removes previously set hook on function or method
97957 *
97958 * Removes the previously set hook on a function or method.
97959 *
97960 * @param string $function The name of the class.
97961 * @return bool
97962 * @since PECL uopz 5, PECL uopz 6
97963 **/
97964function uopz_unset_hook($function){}
97965
97966/**
97967 * Unset previously set mock
97968 *
97969 * Unsets the previously set mock for {@link class}.
97970 *
97971 * @param string $class The name of the mocked class.
97972 * @return void
97973 * @since PECL uopz 5, PECL uopz 6
97974 **/
97975function uopz_unset_mock($class){}
97976
97977/**
97978 * Unsets a previously set return value for a function
97979 *
97980 * Unsets the return value of the {@link function} previously set by
97981 * uopz_set_return.
97982 *
97983 * @param string $function The name of the class containing the
97984 *   function
97985 * @return bool True on success
97986 * @since PECL uopz 5, PECL uopz 6
97987 **/
97988function uopz_unset_return($function){}
97989
97990/**
97991 * Decodes URL-encoded string
97992 *
97993 * Decodes any %## encoding in the given string. Plus symbols ('+') are
97994 * decoded to a space character.
97995 *
97996 * @param string $str The string to be decoded.
97997 * @return string Returns the decoded string.
97998 * @since PHP 4, PHP 5, PHP 7
97999 **/
98000function urldecode($str){}
98001
98002/**
98003 * URL-encodes string
98004 *
98005 * This function is convenient when encoding a string to be used in a
98006 * query part of a URL, as a convenient way to pass variables to the next
98007 * page.
98008 *
98009 * @param string $str The string to be encoded.
98010 * @return string Returns a string in which all non-alphanumeric
98011 *   characters except -_. have been replaced with a percent (%) sign
98012 *   followed by two hex digits and spaces encoded as plus (+) signs. It
98013 *   is encoded the same way that the posted data from a WWW form is
98014 *   encoded, that is the same way as in
98015 *   application/x-www-form-urlencoded media type. This differs from the
98016 *   RFC 3986 encoding (see {@link rawurlencode}) in that for historical
98017 *   reasons, spaces are encoded as plus (+) signs.
98018 * @since PHP 4, PHP 5, PHP 7
98019 **/
98020function urlencode($str){}
98021
98022/**
98023 * Generates a user-level error/warning/notice message
98024 *
98025 * Used to trigger a user error condition, it can be used in conjunction
98026 * with the built-in error handler, or with a user defined function that
98027 * has been set as the new error handler ({@link set_error_handler}).
98028 *
98029 * This function is useful when you need to generate a particular
98030 * response to an exception at runtime.
98031 *
98032 * @param string $error_msg The designated error message for this
98033 *   error. It's limited to 1024 bytes in length. Any additional
98034 *   characters beyond 1024 bytes will be truncated.
98035 * @param int $error_type The designated error type for this error. It
98036 *   only works with the E_USER family of constants, and will default to
98037 *   E_USER_NOTICE.
98038 * @return bool This function returns FALSE if wrong {@link error_type}
98039 *   is specified, TRUE otherwise.
98040 * @since PHP 4, PHP 5, PHP 7
98041 **/
98042function user_error($error_msg, $error_type){}
98043
98044/**
98045 * Set whether to use the SOAP error handler
98046 *
98047 * This function sets whether or not to use the SOAP error handler in the
98048 * SOAP server. It will return the previous value. If set to TRUE,
98049 * details of errors in a SoapServer application will be sent to the
98050 * client as a SOAP fault message. If FALSE, the standard PHP error
98051 * handler is used. The default is to send error to the client as SOAP
98052 * fault message.
98053 *
98054 * @param bool $handler Set to TRUE to send error details to clients.
98055 * @return bool Returns the original value.
98056 * @since PHP 5, PHP 7
98057 **/
98058function use_soap_error_handler($handler){}
98059
98060/**
98061 * Delay execution in microseconds
98062 *
98063 * Delays program execution for the given number of microseconds.
98064 *
98065 * @param int $micro_seconds Halt time in microseconds. A microsecond
98066 *   is one millionth of a second.
98067 * @return void
98068 * @since PHP 4, PHP 5, PHP 7
98069 **/
98070function usleep($micro_seconds){}
98071
98072/**
98073 * Sort an array by values using a user-defined comparison function
98074 *
98075 * This function will sort an array by its values using a user-supplied
98076 * comparison function. If the array you wish to sort needs to be sorted
98077 * by some non-trivial criteria, you should use this function.
98078 *
98079 * @param array $array The input array.
98080 * @param callable $value_compare_func
98081 * @return bool
98082 * @since PHP 4, PHP 5, PHP 7
98083 **/
98084function usort(&$array, $value_compare_func){}
98085
98086/**
98087 * Converts a string with ISO-8859-1 characters encoded with UTF-8 to
98088 * single-byte ISO-8859-1
98089 *
98090 * This function converts the string {@link data} from the UTF-8 encoding
98091 * to ISO-8859-1. Bytes in the string which are not valid UTF-8, and
98092 * UTF-8 characters which do not exist in ISO-8859-1 (that is, characters
98093 * above U+00FF) are replaced with ?.
98094 *
98095 * @param string $data A UTF-8 encoded string.
98096 * @return string Returns the ISO-8859-1 translation of {@link data}.
98097 * @since PHP 4, PHP 5, PHP 7
98098 **/
98099function utf8_decode($data){}
98100
98101/**
98102 * Encodes an ISO-8859-1 string to UTF-8
98103 *
98104 * This function converts the string {@link data} from the ISO-8859-1
98105 * encoding to UTF-8.
98106 *
98107 * @param string $data An ISO-8859-1 string.
98108 * @return string Returns the UTF-8 translation of {@link data}.
98109 * @since PHP 4, PHP 5, PHP 7
98110 **/
98111function utf8_encode($data){}
98112
98113/**
98114 * Returns the absolute value of a variant
98115 *
98116 * @param mixed $val The variant.
98117 * @return variant Returns the absolute value of {@link val}.
98118 * @since PHP 5, PHP 7
98119 **/
98120function variant_abs($val){}
98121
98122/**
98123 * "Adds" two variant values together and returns the result
98124 *
98125 * Adds {@link left} to {@link right} using the following rules (taken
98126 * from the MSDN library), which correspond to those of Visual Basic:
98127 * Variant Addition Rules If Then Both expressions are of the string type
98128 * Concatenation One expression is a string type and the other a
98129 * character Addition One expression is numeric and the other is a string
98130 * Addition Both expressions are numeric Addition Either expression is
98131 * NULL NULL is returned Both expressions are empty Integer subtype is
98132 * returned
98133 *
98134 * @param mixed $left The left operand.
98135 * @param mixed $right The right operand.
98136 * @return variant Returns the result.
98137 * @since PHP 5, PHP 7
98138 **/
98139function variant_add($left, $right){}
98140
98141/**
98142 * Performs a bitwise AND operation between two variants
98143 *
98144 * Performs a bitwise AND operation. Note that this is slightly different
98145 * from a regular AND operation.
98146 *
98147 * @param mixed $left The left operand.
98148 * @param mixed $right The right operand.
98149 * @return variant Variant AND Rules If {@link left} is If {@link
98150 *   right} is then the result is TRUETRUETRUE TRUEFALSEFALSE
98151 *   TRUENULLNULL FALSETRUEFALSE FALSEFALSEFALSE FALSENULLFALSE
98152 *   NULLTRUENULL NULLFALSEFALSE NULLNULLNULL
98153 * @since PHP 5, PHP 7
98154 **/
98155function variant_and($left, $right){}
98156
98157/**
98158 * Convert a variant into a new variant object of another type
98159 *
98160 * This function makes a copy of {@link variant} and then performs a
98161 * variant cast operation to force the copy to have the type given by
98162 * {@link type}.
98163 *
98164 * This function wraps VariantChangeType() in the COM library; consult
98165 * MSDN for more information.
98166 *
98167 * @param variant $variant The variant.
98168 * @param int $type {@link type} should be one of the VT_XXX constants.
98169 * @return variant Returns a variant of given {@link type}.
98170 * @since PHP 5, PHP 7
98171 **/
98172function variant_cast($variant, $type){}
98173
98174/**
98175 * Concatenates two variant values together and returns the result
98176 *
98177 * Concatenates {@link left} with {@link right} and returns the result.
98178 *
98179 * This function is notionally equivalent to {@link $left} . {@link
98180 * $right}.
98181 *
98182 * @param mixed $left The left operand.
98183 * @param mixed $right The right operand.
98184 * @return variant Returns the result of the concatenation.
98185 * @since PHP 5, PHP 7
98186 **/
98187function variant_cat($left, $right){}
98188
98189/**
98190 * Compares two variants
98191 *
98192 * Compares {@link left} with {@link right}.
98193 *
98194 * This function will only compare scalar values, not arrays or variant
98195 * records.
98196 *
98197 * @param mixed $left The left operand.
98198 * @param mixed $right The right operand.
98199 * @param int $lcid A valid Locale Identifier to use when comparing
98200 *   strings (this affects string collation).
98201 * @param int $flags {@link flags} can be one or more of the following
98202 *   values OR'd together, and affects string comparisons: Variant
98203 *   Comparision Flags value meaning NORM_IGNORECASE Compare case
98204 *   insensitively NORM_IGNORENONSPACE Ignore nonspacing characters
98205 *   NORM_IGNORESYMBOLS Ignore symbols NORM_IGNOREWIDTH Ignore string
98206 *   width NORM_IGNOREKANATYPE Ignore Kana type NORM_IGNOREKASHIDA Ignore
98207 *   Arabic kashida characters
98208 * @return int Returns one of the following: Variant Comparision
98209 *   Results value meaning VARCMP_LT {@link left} is less than {@link
98210 *   right} VARCMP_EQ {@link left} is equal to {@link right} VARCMP_GT
98211 *   {@link left} is greater than {@link right} VARCMP_NULL Either {@link
98212 *   left}, {@link right} or both are NULL
98213 * @since PHP 5, PHP 7
98214 **/
98215function variant_cmp($left, $right, $lcid, $flags){}
98216
98217/**
98218 * Returns a variant date representation of a Unix timestamp
98219 *
98220 * Converts {@link timestamp} from a unix timestamp value into a variant
98221 * of type VT_DATE. This allows easier interopability between the
98222 * unix-ish parts of PHP and COM.
98223 *
98224 * @param int $timestamp A unix timestamp.
98225 * @return variant Returns a VT_DATE variant.
98226 * @since PHP 5, PHP 7
98227 **/
98228function variant_date_from_timestamp($timestamp){}
98229
98230/**
98231 * Converts a variant date/time value to Unix timestamp
98232 *
98233 * Converts {@link variant} from a VT_DATE (or similar) value into a Unix
98234 * timestamp. This allows easier interopability between the Unix-ish
98235 * parts of PHP and COM.
98236 *
98237 * @param variant $variant The variant.
98238 * @return int Returns a unix timestamp.
98239 * @since PHP 5, PHP 7
98240 **/
98241function variant_date_to_timestamp($variant){}
98242
98243/**
98244 * Returns the result from dividing two variants
98245 *
98246 * Divides {@link left} by {@link right} and returns the result.
98247 *
98248 * @param mixed $left The left operand.
98249 * @param mixed $right The right operand.
98250 * @return variant Variant Division Rules If Then Both expressions are
98251 *   of the string, date, character, boolean type Double is returned One
98252 *   expression is a string type and the other a character Division and a
98253 *   double is returned One expression is numeric and the other is a
98254 *   string Division and a double is returned. Both expressions are
98255 *   numeric Division and a double is returned Either expression is NULL
98256 *   NULL is returned {@link right} is empty and {@link left} is anything
98257 *   but empty A com_exception with code DISP_E_DIVBYZERO is thrown
98258 *   {@link left} is empty and {@link right} is anything but empty. 0 as
98259 *   type double is returned Both expressions are empty A com_exception
98260 *   with code DISP_E_OVERFLOW is thrown
98261 * @since PHP 5, PHP 7
98262 **/
98263function variant_div($left, $right){}
98264
98265/**
98266 * Performs a bitwise equivalence on two variants
98267 *
98268 * @param mixed $left The left operand.
98269 * @param mixed $right The right operand.
98270 * @return variant If each bit in {@link left} is equal to the
98271 *   corresponding bit in {@link right} then TRUE is returned, otherwise
98272 *   FALSE is returned.
98273 * @since PHP 5, PHP 7
98274 **/
98275function variant_eqv($left, $right){}
98276
98277/**
98278 * Returns the integer portion of a variant
98279 *
98280 * Gets the integer portion of a variant.
98281 *
98282 * @param mixed $variant The variant.
98283 * @return variant If {@link variant} is negative, then the first
98284 *   negative integer greater than or equal to the variant is returned,
98285 *   otherwise returns the integer portion of the value of {@link
98286 *   variant}.
98287 * @since PHP 5, PHP 7
98288 **/
98289function variant_fix($variant){}
98290
98291/**
98292 * Returns the type of a variant object
98293 *
98294 * @param variant $variant The variant object.
98295 * @return int This function returns an integer value that indicates
98296 *   the type of {@link variant}, which can be an instance of , or
98297 *   classes. The return value can be compared to one of the VT_XXX
98298 *   constants.
98299 * @since PHP 5, PHP 7
98300 **/
98301function variant_get_type($variant){}
98302
98303/**
98304 * Converts variants to integers and then returns the result from
98305 * dividing them
98306 *
98307 * Converts {@link left} and {@link right} to integer values, and then
98308 * performs integer division.
98309 *
98310 * @param mixed $left The left operand.
98311 * @param mixed $right The right operand.
98312 * @return variant Variant Integer Division Rules If Then Both
98313 *   expressions are of the string, date, character, boolean type
98314 *   Division and integer is returned One expression is a string type and
98315 *   the other a character Division One expression is numeric and the
98316 *   other is a string Division Both expressions are numeric Division
98317 *   Either expression is NULL NULL is returned Both expressions are
98318 *   empty A com_exception with code DISP_E_DIVBYZERO is thrown
98319 * @since PHP 5, PHP 7
98320 **/
98321function variant_idiv($left, $right){}
98322
98323/**
98324 * Performs a bitwise implication on two variants
98325 *
98326 * Performs a bitwise implication operation.
98327 *
98328 * @param mixed $left The left operand.
98329 * @param mixed $right The right operand.
98330 * @return variant Variant Implication Table If {@link left} is If
98331 *   {@link right} is then the result is TRUETRUETRUE TRUEFALSEFALSE
98332 *   TRUENULLTRUE FALSETRUETRUE FALSEFALSETRUE FALSENULLTRUE NULLTRUETRUE
98333 *   NULLFALSENULL NULLNULLNULL
98334 * @since PHP 5, PHP 7
98335 **/
98336function variant_imp($left, $right){}
98337
98338/**
98339 * Returns the integer portion of a variant
98340 *
98341 * Gets the integer portion of a variant.
98342 *
98343 * @param mixed $variant The variant.
98344 * @return variant If {@link variant} is negative, then the first
98345 *   negative integer greater than or equal to the variant is returned,
98346 *   otherwise returns the integer portion of the value of {@link
98347 *   variant}.
98348 * @since PHP 5, PHP 7
98349 **/
98350function variant_int($variant){}
98351
98352/**
98353 * Divides two variants and returns only the remainder
98354 *
98355 * Divides {@link left} by {@link right} and returns the remainder.
98356 *
98357 * @param mixed $left The left operand.
98358 * @param mixed $right The right operand.
98359 * @return variant Returns the remainder of the division.
98360 * @since PHP 5, PHP 7
98361 **/
98362function variant_mod($left, $right){}
98363
98364/**
98365 * Multiplies the values of the two variants
98366 *
98367 * Multiplies {@link left} by {@link right}.
98368 *
98369 * @param mixed $left The left operand.
98370 * @param mixed $right The right operand.
98371 * @return variant Variant Multiplication Rules If Then Both
98372 *   expressions are of the string, date, character, boolean type
98373 *   Multiplication One expression is a string type and the other a
98374 *   character Multiplication One expression is numeric and the other is
98375 *   a string Multiplication Both expressions are numeric Multiplication
98376 *   Either expression is NULL NULL is returned Both expressions are
98377 *   empty Empty string is returned
98378 * @since PHP 5, PHP 7
98379 **/
98380function variant_mul($left, $right){}
98381
98382/**
98383 * Performs logical negation on a variant
98384 *
98385 * Performs logical negation of {@link variant}.
98386 *
98387 * @param mixed $variant The variant.
98388 * @return variant Returns the result of the logical negation.
98389 * @since PHP 5, PHP 7
98390 **/
98391function variant_neg($variant){}
98392
98393/**
98394 * Performs bitwise not negation on a variant
98395 *
98396 * Performs bitwise not negation on {@link variant} and returns the
98397 * result.
98398 *
98399 * @param mixed $variant The variant.
98400 * @return variant Returns the bitwise not negation. If {@link variant}
98401 *   is NULL, the result will also be NULL.
98402 * @since PHP 5, PHP 7
98403 **/
98404function variant_not($variant){}
98405
98406/**
98407 * Performs a logical disjunction on two variants
98408 *
98409 * Performs a bitwise OR operation. Note that this is slightly different
98410 * from a regular OR operation.
98411 *
98412 * @param mixed $left The left operand.
98413 * @param mixed $right The right operand.
98414 * @return variant Variant OR Rules If {@link left} is If {@link right}
98415 *   is then the result is TRUETRUETRUE TRUEFALSETRUE TRUENULLTRUE
98416 *   FALSETRUETRUE FALSEFALSEFALSE FALSENULLNULL NULLTRUETRUE
98417 *   NULLFALSENULL NULLNULLNULL
98418 * @since PHP 5, PHP 7
98419 **/
98420function variant_or($left, $right){}
98421
98422/**
98423 * Returns the result of performing the power function with two variants
98424 *
98425 * Returns the result of {@link left} to the power of {@link right}.
98426 *
98427 * @param mixed $left The left operand.
98428 * @param mixed $right The right operand.
98429 * @return variant Returns the result of {@link left} to the power of
98430 *   {@link right}.
98431 * @since PHP 5, PHP 7
98432 **/
98433function variant_pow($left, $right){}
98434
98435/**
98436 * Rounds a variant to the specified number of decimal places
98437 *
98438 * Returns the value of {@link variant} rounded to {@link decimals}
98439 * decimal places.
98440 *
98441 * @param mixed $variant The variant.
98442 * @param int $decimals Number of decimal places.
98443 * @return mixed Returns the rounded value.
98444 * @since PHP 5, PHP 7
98445 **/
98446function variant_round($variant, $decimals){}
98447
98448/**
98449 * Assigns a new value for a variant object
98450 *
98451 * Converts {@link value} to a variant and assigns it to the {@link
98452 * variant} object; no new variant object is created, and the old value
98453 * of {@link variant} is freed/released.
98454 *
98455 * @param variant $variant The variant.
98456 * @param mixed $value
98457 * @return void
98458 * @since PHP 5, PHP 7
98459 **/
98460function variant_set($variant, $value){}
98461
98462/**
98463 * Convert a variant into another type "in-place"
98464 *
98465 * This function is similar to {@link variant_cast} except that the
98466 * variant is modified "in-place"; no new variant is created. The
98467 * parameters for this function have identical meaning to those of {@link
98468 * variant_cast}.
98469 *
98470 * @param variant $variant The variant.
98471 * @param int $type
98472 * @return void
98473 * @since PHP 5, PHP 7
98474 **/
98475function variant_set_type($variant, $type){}
98476
98477/**
98478 * Subtracts the value of the right variant from the left variant value
98479 *
98480 * Subtracts {@link right} from {@link left}.
98481 *
98482 * @param mixed $left The left operand.
98483 * @param mixed $right The right operand.
98484 * @return variant Variant Subtraction Rules If Then Both expressions
98485 *   are of the string type Subtraction One expression is a string type
98486 *   and the other a character Subtraction One expression is numeric and
98487 *   the other is a string Subtraction. Both expressions are numeric
98488 *   Subtraction Either expression is NULL NULL is returned Both
98489 *   expressions are empty Empty string is returned
98490 * @since PHP 5, PHP 7
98491 **/
98492function variant_sub($left, $right){}
98493
98494/**
98495 * Performs a logical exclusion on two variants
98496 *
98497 * Performs a logical exclusion.
98498 *
98499 * @param mixed $left The left operand.
98500 * @param mixed $right The right operand.
98501 * @return variant Variant XOR Rules If {@link left} is If {@link
98502 *   right} is then the result is TRUETRUEFALSE TRUEFALSETRUE
98503 *   FALSETRUETRUE FALSEFALSEFALSE NULLNULLNULL
98504 * @since PHP 5, PHP 7
98505 **/
98506function variant_xor($left, $right){}
98507
98508/**
98509 * Dumps information about a variable
98510 *
98511 * @param mixed $expression The variable you want to dump.
98512 * @param mixed ...$vararg
98513 * @return void
98514 * @since PHP 4, PHP 5, PHP 7
98515 **/
98516function var_dump($expression, ...$vararg){}
98517
98518/**
98519 * Outputs or returns a parsable string representation of a variable
98520 *
98521 * @param mixed $expression The variable you want to export.
98522 * @param bool $return If used and set to TRUE, {@link var_export} will
98523 *   return the variable representation instead of outputting it.
98524 * @return mixed Returns the variable representation when the {@link
98525 *   return} parameter is used and evaluates to TRUE. Otherwise, this
98526 *   function will return NULL.
98527 * @since PHP 4 >= 4.2.0, PHP 5, PHP 7
98528 **/
98529function var_export($expression, $return){}
98530
98531/**
98532 * Compares two "PHP-standardized" version number strings
98533 *
98534 * {@link version_compare} compares two "PHP-standardized" version number
98535 * strings.
98536 *
98537 * The function first replaces _, - and + with a dot . in the version
98538 * strings and also inserts dots . before and after any non number so
98539 * that for example '4.3.2RC1' becomes '4.3.2.RC.1'. Then it compares the
98540 * parts starting from left to right. If a part contains special version
98541 * strings these are handled in the following order: any string not found
98542 * in this list < dev < alpha = a < beta = b < RC = rc < # < pl = p. This
98543 * way not only versions with different levels like '4.1' and '4.1.2' can
98544 * be compared but also any PHP specific version containing development
98545 * state.
98546 *
98547 * @param string $version1 First version number.
98548 * @param string $version2 Second version number.
98549 * @return int By default, {@link version_compare} returns -1 if the
98550 *   first version is lower than the second, 0 if they are equal, and 1
98551 *   if the second is lower.
98552 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
98553 **/
98554function version_compare($version1, $version2){}
98555
98556/**
98557 * Write a formatted string to a stream
98558 *
98559 * Write a string produced according to {@link format} to the stream
98560 * resource specified by {@link handle}.
98561 *
98562 * Operates as {@link fprintf} but accepts an array of arguments, rather
98563 * than a variable number of arguments.
98564 *
98565 * @param resource $handle
98566 * @param string $format
98567 * @param array $args
98568 * @return int Returns the length of the outputted string.
98569 * @since PHP 5, PHP 7
98570 **/
98571function vfprintf($handle, $format, $args){}
98572
98573/**
98574 * Perform an Apache sub-request
98575 *
98576 * {@link virtual} is an Apache-specific function which is similar to
98577 * <!--#include virtual...--> in mod_include. It performs an Apache
98578 * sub-request. It is useful for including CGI scripts or .shtml files,
98579 * or anything else that you would parse through Apache. Note that for a
98580 * CGI script, the script must generate valid CGI headers. At the minimum
98581 * that means it must generate a Content-Type header.
98582 *
98583 * To run the sub-request, all buffers are terminated and flushed to the
98584 * browser, pending headers are sent too.
98585 *
98586 * @param string $filename The file that the virtual command will be
98587 *   performed on.
98588 * @return bool Performs the virtual command on success, or returns
98589 *   FALSE on failure.
98590 * @since PHP 4, PHP 5, PHP 7
98591 **/
98592function virtual($filename){}
98593
98594/**
98595 * Add an alias for a virtual domain
98596 *
98597 * @param string $domain
98598 * @param string $aliasdomain
98599 * @return bool
98600 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
98601 **/
98602function vpopmail_add_alias_domain($domain, $aliasdomain){}
98603
98604/**
98605 * Add alias to an existing virtual domain
98606 *
98607 * @param string $olddomain
98608 * @param string $newdomain
98609 * @return bool
98610 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
98611 **/
98612function vpopmail_add_alias_domain_ex($olddomain, $newdomain){}
98613
98614/**
98615 * Add a new virtual domain
98616 *
98617 * @param string $domain
98618 * @param string $dir
98619 * @param int $uid
98620 * @param int $gid
98621 * @return bool
98622 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
98623 **/
98624function vpopmail_add_domain($domain, $dir, $uid, $gid){}
98625
98626/**
98627 * Add a new virtual domain
98628 *
98629 * @param string $domain
98630 * @param string $passwd
98631 * @param string $quota
98632 * @param string $bounce
98633 * @param bool $apop
98634 * @return bool
98635 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
98636 **/
98637function vpopmail_add_domain_ex($domain, $passwd, $quota, $bounce, $apop){}
98638
98639/**
98640 * Add a new user to the specified virtual domain
98641 *
98642 * @param string $user
98643 * @param string $domain
98644 * @param string $password
98645 * @param string $gecos
98646 * @param bool $apop
98647 * @return bool
98648 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
98649 **/
98650function vpopmail_add_user($user, $domain, $password, $gecos, $apop){}
98651
98652/**
98653 * Insert a virtual alias
98654 *
98655 * @param string $user
98656 * @param string $domain
98657 * @param string $alias
98658 * @return bool
98659 * @since PHP 4 >= 4.0.7, PECL vpopmail >= 0.2
98660 **/
98661function vpopmail_alias_add($user, $domain, $alias){}
98662
98663/**
98664 * Deletes all virtual aliases of a user
98665 *
98666 * @param string $user
98667 * @param string $domain
98668 * @return bool
98669 * @since PHP 4 >= 4.0.7, PECL vpopmail >= 0.2
98670 **/
98671function vpopmail_alias_del($user, $domain){}
98672
98673/**
98674 * Deletes all virtual aliases of a domain
98675 *
98676 * @param string $domain
98677 * @return bool
98678 * @since PHP 4 >= 4.0.7, PECL vpopmail >= 0.2
98679 **/
98680function vpopmail_alias_del_domain($domain){}
98681
98682/**
98683 * Get all lines of an alias for a domain
98684 *
98685 * @param string $alias
98686 * @param string $domain
98687 * @return array
98688 * @since PHP 4 >= 4.0.7, PECL vpopmail >= 0.2
98689 **/
98690function vpopmail_alias_get($alias, $domain){}
98691
98692/**
98693 * Get all lines of an alias for a domain
98694 *
98695 * @param string $domain
98696 * @return array
98697 * @since PHP 4 >= 4.0.7, PECL vpopmail >= 0.2
98698 **/
98699function vpopmail_alias_get_all($domain){}
98700
98701/**
98702 * Attempt to validate a username/domain/password
98703 *
98704 * @param string $user
98705 * @param string $domain
98706 * @param string $password
98707 * @param string $apop
98708 * @return bool
98709 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
98710 **/
98711function vpopmail_auth_user($user, $domain, $password, $apop){}
98712
98713/**
98714 * Delete a virtual domain
98715 *
98716 * @param string $domain
98717 * @return bool
98718 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
98719 **/
98720function vpopmail_del_domain($domain){}
98721
98722/**
98723 * Delete a virtual domain
98724 *
98725 * @param string $domain
98726 * @return bool
98727 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
98728 **/
98729function vpopmail_del_domain_ex($domain){}
98730
98731/**
98732 * Delete a user from a virtual domain
98733 *
98734 * @param string $user
98735 * @param string $domain
98736 * @return bool
98737 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
98738 **/
98739function vpopmail_del_user($user, $domain){}
98740
98741/**
98742 * Get text message for last vpopmail error
98743 *
98744 * @return string
98745 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
98746 **/
98747function vpopmail_error(){}
98748
98749/**
98750 * Change a virtual user's password
98751 *
98752 * @param string $user
98753 * @param string $domain
98754 * @param string $password
98755 * @param bool $apop
98756 * @return bool
98757 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
98758 **/
98759function vpopmail_passwd($user, $domain, $password, $apop){}
98760
98761/**
98762 * Sets a virtual user's quota
98763 *
98764 * @param string $user
98765 * @param string $domain
98766 * @param string $quota
98767 * @return bool
98768 * @since PHP 4 >= 4.0.5, PECL vpopmail >= 0.2
98769 **/
98770function vpopmail_set_user_quota($user, $domain, $quota){}
98771
98772/**
98773 * Output a formatted string
98774 *
98775 * Display array values as a formatted string according to {@link format}
98776 * (which is described in the documentation for {@link sprintf}).
98777 *
98778 * Operates as {@link printf} but accepts an array of arguments, rather
98779 * than a variable number of arguments.
98780 *
98781 * @param string $format
98782 * @param array $args
98783 * @return int Returns the length of the outputted string.
98784 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
98785 **/
98786function vprintf($format, $args){}
98787
98788/**
98789 * Return a formatted string
98790 *
98791 * Operates as {@link sprintf} but accepts an array of arguments, rather
98792 * than a variable number of arguments.
98793 *
98794 * @param string $format
98795 * @param array $args
98796 * @return string Return array values as a formatted string according
98797 *   to {@link format}, .
98798 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
98799 **/
98800function vsprintf($format, $args){}
98801
98802/**
98803 * Add variables to a WDDX packet with the specified ID
98804 *
98805 * Serializes the passed variables and add the result to the given
98806 * packet.
98807 *
98808 * @param resource $packet_id A WDDX packet, returned by {@link
98809 *   wddx_packet_start}.
98810 * @param mixed $var_name Can be either a string naming a variable or
98811 *   an array containing strings naming the variables or another array,
98812 *   etc.
98813 * @param mixed ...$vararg
98814 * @return bool
98815 * @since PHP 4, PHP 5, PHP 7
98816 **/
98817function wddx_add_vars($packet_id, $var_name, ...$vararg){}
98818
98819/**
98820 * Unserializes a WDDX packet
98821 *
98822 * Unserializes a WDDX {@link packet}.
98823 *
98824 * @param string $packet A WDDX packet, as a string or stream.
98825 * @return mixed Returns the deserialized value which can be a string,
98826 *   a number or an array. Note that structures are deserialized into
98827 *   associative arrays.
98828 * @since PHP 4, PHP 5, PHP 7
98829 **/
98830function wddx_deserialize($packet){}
98831
98832/**
98833 * Ends a WDDX packet with the specified ID
98834 *
98835 * Ends and returns the given WDDX packet.
98836 *
98837 * @param resource $packet_id A WDDX packet, returned by {@link
98838 *   wddx_packet_start}.
98839 * @return string Returns the string containing the WDDX packet.
98840 * @since PHP 4, PHP 5, PHP 7
98841 **/
98842function wddx_packet_end($packet_id){}
98843
98844/**
98845 * Starts a new WDDX packet with structure inside it
98846 *
98847 * Start a new WDDX packet for incremental addition of variables. It
98848 * automatically creates a structure definition inside the packet to
98849 * contain the variables.
98850 *
98851 * @param string $comment An optional comment string.
98852 * @return resource Returns a packet ID for use in later functions, or
98853 *   FALSE on error.
98854 * @since PHP 4, PHP 5, PHP 7
98855 **/
98856function wddx_packet_start($comment){}
98857
98858/**
98859 * Serialize a single value into a WDDX packet
98860 *
98861 * Creates a WDDX packet from a single given value.
98862 *
98863 * @param mixed $var The value to be serialized
98864 * @param string $comment An optional comment string that appears in
98865 *   the packet header.
98866 * @return string Returns the WDDX packet, or FALSE on error.
98867 * @since PHP 4, PHP 5, PHP 7
98868 **/
98869function wddx_serialize_value($var, $comment){}
98870
98871/**
98872 * Serialize variables into a WDDX packet
98873 *
98874 * Creates a WDDX packet with a structure that contains the serialized
98875 * representation of the passed variables.
98876 *
98877 * @param mixed $var_name Can be either a string naming a variable or
98878 *   an array containing strings naming the variables or another array,
98879 *   etc.
98880 * @param mixed ...$vararg
98881 * @return string Returns the WDDX packet, or FALSE on error.
98882 * @since PHP 4, PHP 5, PHP 7
98883 **/
98884function wddx_serialize_vars($var_name, ...$vararg){}
98885
98886/**
98887 * Resumes a paused service
98888 *
98889 * Resumes a paused, named service. Requires administrative privileges or
98890 * an account with appropriate rights set in the service's ACL.
98891 *
98892 * @param string $servicename The short name of the service.
98893 * @param string $machine Optional machine name. If omitted, the local
98894 *   machine is used.
98895 * @return int
98896 **/
98897function win32_continue_service($servicename, $machine){}
98898
98899/**
98900 * Creates a new service entry in the SCM database
98901 *
98902 * Attempts to add a service into the SCM database. Administrative
98903 * privileges are required for this to succeed.
98904 *
98905 * @param array $details An array of service details: {@link service}
98906 *   The short name of the service. This is the name that you will use to
98907 *   control the service using the net command. The service must be
98908 *   unique (no two services can share the same name), and, ideally,
98909 *   should avoid having spaces in the name. {@link display} The display
98910 *   name of the service. This is the name that you will see in the
98911 *   Services Applet. {@link description} The long description of the
98912 *   service. This is the description that you will see in the Services
98913 *   Applet. {@link user} The name of the user account under which you
98914 *   want the service to run. If omitted, the service will run as the
98915 *   LocalSystem account. If the username is specified, you must also
98916 *   provide a password. {@link password} The password that corresponds
98917 *   to the {@link user}. {@link path} The full path to the executable
98918 *   module that will be launched when the service is started. If
98919 *   omitted, the path to the current PHP process will be used. {@link
98920 *   params} Command line parameters to pass to the service when it
98921 *   starts. If you want to run a PHP script as the service, then the
98922 *   first parameter should be the full path to the PHP script that you
98923 *   intend to run. If the script name or path contains spaces, then wrap
98924 *   the full path to the PHP script with ". {@link load_order} Controls
98925 *   the load_order. This is not yet fully supported. {@link svc_type}
98926 *   Sets the service type. If omitted, the default value is
98927 *   WIN32_SERVICE_WIN32_OWN_PROCESS. Don't change this unless you know
98928 *   what you're doing. {@link start_type} Specifies how the service
98929 *   should be started. The default is WIN32_SERVICE_AUTO_START which
98930 *   means the service will be launched when the machine starts up.
98931 *   {@link error_control} Informs the SCM what it should do when it
98932 *   detects a problem with the service. The default is
98933 *   WIN32_SERVER_ERROR_IGNORE. Changing this value is not yet fully
98934 *   supported. {@link delayed_start} If {@link delayed_start} is set to
98935 *   TRUE, then this will inform the SCM that this service should be
98936 *   started after other auto-start services are started plus a short
98937 *   delay. Any service can be marked as a delayed auto-start service;
98938 *   however, this setting has no effect unless the service's {@link
98939 *   start_type} is WIN32_SERVICE_AUTO_START. This setting is only
98940 *   applicable on Windows Vista and Windows Server 2008 or greater.
98941 *   {@link base_priority} To reduce the impact on processor utilisation,
98942 *   it may be necessary to set a base priority lower than normal. The
98943 *   {@link base_priority} can be set to one of the constants define in
98944 *   Win32 Base Priority Classes. {@link dependencies} To define the
98945 *   dependencies for your service, it may be necessary to set this
98946 *   parameter to the list of the services names in an array. {@link
98947 *   recovery_delay} This parameter defines the delay between the fail
98948 *   and the execution of recovery action. The value is in milliseconds.
98949 *   The default value is 60000. {@link recovery_action_1} The action
98950 *   will be executed on first failure. The default value is
98951 *   WIN32_SC_ACTION_NONE. The {@link recovery_action_1} can be set to
98952 *   one of the constants defined in Win32 Recovery action. {@link
98953 *   recovery_action_2} The action will be executed on second failure.
98954 *   The default value is WIN32_SC_ACTION_NONE. The {@link
98955 *   recovery_action_2} can be set to one of the constants defined in
98956 *   Win32 Recovery action. {@link recovery_action_3} The action will be
98957 *   executed on next failures. The default value is
98958 *   WIN32_SC_ACTION_NONE. The {@link recovery_action_3} can be set to
98959 *   one of the constants defined in Win32 Recovery action. {@link
98960 *   recovery_reset_period} The failure count will be reset after the
98961 *   delay defined in the parameter. The delay is expirement in seconds.
98962 *   The default value is 86400. {@link recovery_enabled} Set this
98963 *   parameter at TRUE to enable the recovery settings, FALSE to disable.
98964 *   The default value is FALSE {@link recovery_reboot_msg} Set this
98965 *   parameter to define the message saved into the Windows Event Log
98966 *   before the reboot. Used only if one action is set to
98967 *   WIN32_SC_ACTION_REBOOT. {@link recovery_command} Set this parameter
98968 *   to define the command executed when one action is defined on
98969 *   WIN32_SC_ACTION_RUN_COMMAND.
98970 * @param string $machine The short name of the service. This is the
98971 *   name that you will use to control the service using the net command.
98972 *   The service must be unique (no two services can share the same
98973 *   name), and, ideally, should avoid having spaces in the name.
98974 * @return mixed
98975 **/
98976function win32_create_service($details, $machine){}
98977
98978/**
98979 * Deletes a service entry from the SCM database
98980 *
98981 * Attempts to delete a service from the SCM database. Administrative
98982 * privileges are required for this to succeed.
98983 *
98984 * This function really just marks the service for deletion. If other
98985 * processes (such as the Services Applet) are open, then the deletion
98986 * will be deferred until those applications are closed. If a service is
98987 * marked for deletion, further attempts to delete it will fail, and
98988 * attempts to create a new service with that name will also fail.
98989 *
98990 * @param string $servicename The short name of the service.
98991 * @param string $machine The optional machine name. If omitted, the
98992 *   local machine will be used.
98993 * @return mixed
98994 **/
98995function win32_delete_service($servicename, $machine){}
98996
98997/**
98998 * Returns the last control message that was sent to this service
98999 *
99000 * Returns the control code that was last sent to this service process.
99001 * When running as a service you should periodically check this to
99002 * determine if your service needs to stop running.
99003 *
99004 * @return int Returns a control constant which will be one of the
99005 *   Win32Service Service Control Message Constants:
99006 *   WIN32_SERVICE_CONTROL_CONTINUE, WIN32_SERVICE_CONTROL_INTERROGATE,
99007 *   WIN32_SERVICE_CONTROL_PAUSE, WIN32_SERVICE_CONTROL_PRESHUTDOWN,
99008 *   WIN32_SERVICE_CONTROL_SHUTDOWN, WIN32_SERVICE_CONTROL_STOP.
99009 **/
99010function win32_get_last_control_message(){}
99011
99012/**
99013 * Pauses a service
99014 *
99015 * Pauses a named service. Requires administrative privileges or an
99016 * account with appropriate rights set in the service's ACL.
99017 *
99018 * @param string $servicename The short name of the service.
99019 * @param string $machine Optional machine name. If omitted, the local
99020 *   machine is used.
99021 * @return int
99022 **/
99023function win32_pause_service($servicename, $machine){}
99024
99025/**
99026 * List running processes
99027 *
99028 * Retrieves statistics about all running processes.
99029 *
99030 * @return array Returns FALSE on failure, or an array consisting of
99031 *   process statistics like {@link win32_ps_stat_proc} returns for all
99032 *   running processes on success.
99033 * @since PECL win32ps >= 1.0.1
99034 **/
99035function win32_ps_list_procs(){}
99036
99037/**
99038 * Stat memory utilization
99039 *
99040 * Retrieves statistics about the global memory utilization.
99041 *
99042 * @return array Returns FALSE on failure, or an array consisting of
99043 *   the following information on success:
99044 * @since PECL win32ps >= 1.0.1
99045 **/
99046function win32_ps_stat_mem(){}
99047
99048/**
99049 * Stat process
99050 *
99051 * Retrieves statistics about the process with the process id {@link
99052 * pid}.
99053 *
99054 * @param int $pid The process id of the process to stat. If omitted,
99055 *   the id of the current process.
99056 * @return array Returns FALSE on failure, or an array consisting of
99057 *   the following information on success:
99058 * @since PECL win32ps >= 1.0.1
99059 **/
99060function win32_ps_stat_proc($pid){}
99061
99062/**
99063 * Queries the status of a service
99064 *
99065 * Queries the current status for a service, returning an array of
99066 * information.
99067 *
99068 * @param string $servicename The short name of the service.
99069 * @param string $machine The optional machine name. If omitted, the
99070 *   local machine will be used.
99071 * @return mixed Returns an array consisting of the following
99072 *   information on success
99073 **/
99074function win32_query_service_status($servicename, $machine){}
99075
99076/**
99077 * Send a custom control to the service
99078 *
99079 * See Microsoft ControlService function for more details
99080 *
99081 * @param string $servicename The short name of the service.
99082 * @param int $control The custom contole value between 128 and 255.
99083 * @param string $machine Optional machine name. If omitted, the local
99084 *   machine is used.
99085 * @return int
99086 **/
99087function win32_send_custom_control($servicename, $control, $machine){}
99088
99089/**
99090 * Define or return the exit code for the current running service
99091 *
99092 * Change or return the exit code. The exit code is used only if the exit
99093 * mode is not graceful. If the value is not zero, the recovery
99094 * configuration can be used after service fail. See Microsoft system
99095 * error codes for more details
99096 *
99097 * @param int $exitCode The return code used on exit.
99098 * @return int Return the current or old exit code.
99099 **/
99100function win32_set_service_exit_code($exitCode){}
99101
99102/**
99103 * Define or return the exit mode for the current running service
99104 *
99105 * If {@link gracefulMode} parameter is provided, the exit mode is
99106 * changed. When the exit mode is not gracefuly, the exit code used can
99107 * be set with the {@link win32_set_service_exit_code} function.
99108 *
99109 * @param bool $gracefulMode TRUE for exit graceful. FALSE for exit
99110 *   with error.
99111 * @return bool Return the current or old exit mode.
99112 **/
99113function win32_set_service_exit_mode($gracefulMode){}
99114
99115/**
99116 * Update the service status
99117 *
99118 * Informs the SCM of the current status of a running service. This call
99119 * is only valid for a running service process.
99120 *
99121 * @param int $status The service status code, one of
99122 *   WIN32_SERVICE_RUNNING, WIN32_SERVICE_STOPPED,
99123 *   WIN32_SERVICE_STOP_PENDING, WIN32_SERVICE_START_PENDING,
99124 *   WIN32_SERVICE_CONTINUE_PENDING, WIN32_SERVICE_PAUSE_PENDING,
99125 *   WIN32_SERVICE_PAUSED.
99126 * @param int $checkpoint The checkpoint value the service increments
99127 *   periodically to report its progress during a lengthy start, stop,
99128 *   pause, or continue operation. For example, the service should
99129 *   increment this value as it completes each step of its initialization
99130 *   when it is starting up. The {@link checkpoint} is only valid when
99131 *   the {@link status} is one of WIN32_SERVICE_STOP_PENDING,
99132 *   WIN32_SERVICE_START_PENDING, WIN32_SERVICE_CONTINUE_PENDING or
99133 *   WIN32_SERVICE_PAUSE_PENDING.
99134 * @return bool
99135 **/
99136function win32_set_service_status($status, $checkpoint){}
99137
99138/**
99139 * Starts a service
99140 *
99141 * Attempts to start the named service. Requires administrative
99142 * privileges or an account with appropriate rights set in the service's
99143 * ACL.
99144 *
99145 * @param string $servicename The short name of the service.
99146 * @param string $machine Optional machine name. If omitted, the local
99147 *   machine is used.
99148 * @return int
99149 **/
99150function win32_start_service($servicename, $machine){}
99151
99152/**
99153 * Registers the script with the SCM, so that it can act as the service
99154 * with the given name
99155 *
99156 * When launched via the Service Control Manager, a service process is
99157 * required to "check-in" with it to establish service monitoring and
99158 * communication facilities. This function performs the check-in by
99159 * spawning a thread to handle the lower-level communication with the
99160 * service control manager.
99161 *
99162 * Once started, the service process should do 2 things. The first is to
99163 * tell the Service Control Manager that the service is running. This is
99164 * achieved by calling {@link win32_set_service_status} with the
99165 * WIN32_SERVICE_RUNNING constant. If you need to perform some lengthy
99166 * process before the service is actually running, then you can use the
99167 * WIN32_SERVICE_START_PENDING constant. The second is to continue to
99168 * check-in with the service control manager so that it can determine if
99169 * it should terminate. This is achieved by periodically calling {@link
99170 * win32_get_last_control_message} and handling the return code
99171 * appropriately.
99172 *
99173 * @param string $name The short-name of the service, as registered by
99174 *   {@link win32_create_service}.
99175 * @param bool $gracefulMode TRUE for exit graceful. FALSE for exit
99176 *   with error. See {@link win32_set_service_exit_mode} for more
99177 *   details.
99178 * @return mixed
99179 **/
99180function win32_start_service_ctrl_dispatcher($name, $gracefulMode){}
99181
99182/**
99183 * Stops a service
99184 *
99185 * Stops a named service. Requires administrative privileges or an
99186 * account with appropriate rights set in the service's ACL.
99187 *
99188 * @param string $servicename The short name of the service.
99189 * @param string $machine Optional machine name. If omitted, the local
99190 *   machine is used.
99191 * @return int
99192 **/
99193function win32_stop_service($servicename, $machine){}
99194
99195/**
99196 * Retrieves information about files cached in the file cache
99197 *
99198 * Retrieves information about file cache content and its usage.
99199 *
99200 * @param bool $summaryonly Controls whether the returned array will
99201 *   contain information about individual cache entries along with the
99202 *   file cache summary.
99203 * @return array Array of meta data about file cache
99204 * @since PECL wincache >= 1.0.0
99205 **/
99206function wincache_fcache_fileinfo($summaryonly){}
99207
99208/**
99209 * Retrieves information about file cache memory usage
99210 *
99211 * Retrieves information about memory usage by file cache.
99212 *
99213 * @return array Array of meta data about file cache memory usage
99214 * @since PECL wincache >= 1.0.0
99215 **/
99216function wincache_fcache_meminfo(){}
99217
99218/**
99219 * Acquires an exclusive lock on a given key
99220 *
99221 * Obtains an exclusive lock on a given key. The execution of the current
99222 * script will be blocked until the lock can be obtained. Once the lock
99223 * is obtained, the other scripts that try to request the lock by using
99224 * the same key will be blocked, until the current script releases the
99225 * lock by using {@link wincache_unlock}.
99226 *
99227 * @param string $key Name of the key in the cache to get the lock on.
99228 * @param bool $isglobal Controls whether the scope of the lock is
99229 *   system-wide or local. Local locks are scoped to the application pool
99230 *   in IIS FastCGI case or to all php processes that have the same
99231 *   parent process identifier.
99232 * @return bool
99233 * @since PECL wincache >= 1.1.0
99234 **/
99235function wincache_lock($key, $isglobal){}
99236
99237/**
99238 * Retrieves information about files cached in the opcode cache
99239 *
99240 * Retrieves information about opcode cache content and its usage.
99241 *
99242 * @param bool $summaryonly Controls whether the returned array will
99243 *   contain information about individual cache entries along with the
99244 *   opcode cache summary.
99245 * @return array Array of meta data about opcode cache
99246 * @since PECL wincache >= 1.0.0
99247 **/
99248function wincache_ocache_fileinfo($summaryonly){}
99249
99250/**
99251 * Retrieves information about opcode cache memory usage
99252 *
99253 * Retrieves information about memory usage by opcode cache.
99254 *
99255 * @return array Array of meta data about opcode cache memory usage
99256 * @since PECL wincache >= 1.0.0
99257 **/
99258function wincache_ocache_meminfo(){}
99259
99260/**
99261 * Refreshes the cache entries for the cached files
99262 *
99263 * Refreshes the cache entries for the files, whose names were passed in
99264 * the input argument. If no argument is specified then refreshes all the
99265 * entries in the cache.
99266 *
99267 * @param array $files An array of file names for files that need to be
99268 *   refreshed. An absolute or relative file paths can be used.
99269 * @return bool
99270 * @since PECL wincache >= 1.0.0
99271 **/
99272function wincache_refresh_if_changed($files){}
99273
99274/**
99275 * Retrieves information about resolve file path cache
99276 *
99277 * Retrieves information about cached mappings between relative file
99278 * paths and corresponding absolute file paths.
99279 *
99280 * @param bool $summaryonly
99281 * @return array Array of meta data about the resolve file path cache
99282 * @since PECL wincache >= 1.0.0
99283 **/
99284function wincache_rplist_fileinfo($summaryonly){}
99285
99286/**
99287 * Retrieves information about memory usage by the resolve file path
99288 * cache
99289 *
99290 * Retrieves information about memory usage by resolve file path cache.
99291 *
99292 * @return array Array of meta data that describes memory usage by
99293 *   resolve file path cache.
99294 * @since PECL wincache >= 1.0.0
99295 **/
99296function wincache_rplist_meminfo(){}
99297
99298/**
99299 * Retrieves information about files cached in the session cache
99300 *
99301 * Retrieves information about session cache content and its usage.
99302 *
99303 * @param bool $summaryonly Controls whether the returned array will
99304 *   contain information about individual cache entries along with the
99305 *   session cache summary.
99306 * @return array Array of meta data about session cache
99307 * @since PECL wincache >= 1.1.0
99308 **/
99309function wincache_scache_info($summaryonly){}
99310
99311/**
99312 * Retrieves information about session cache memory usage
99313 *
99314 * Retrieves information about memory usage by session cache.
99315 *
99316 * @return array Array of meta data about session cache memory usage
99317 * @since PECL wincache >= 1.1.0
99318 **/
99319function wincache_scache_meminfo(){}
99320
99321/**
99322 * Adds a variable in user cache only if variable does not already exist
99323 * in the cache
99324 *
99325 * Adds a variable in user cache, only if this variable doesn't already
99326 * exist in the cache. The added variable remains in the user cache
99327 * unless its time to live expires or it is deleted by using {@link
99328 * wincache_ucache_delete} or {@link wincache_ucache_clear} functions.
99329 *
99330 * @param string $key Store the variable using this {@link key} name.
99331 *   If a variable with same key is already present the function will
99332 *   fail and return FALSE. {@link key} is case sensitive. To override
99333 *   the value even if {@link key} is present use {@link
99334 *   wincache_ucache_set} function instad. {@link key} can also take
99335 *   array of name => value pairs where names will be used as keys. This
99336 *   can be used to add multiple values in the cache in one operation,
99337 *   thus avoiding race condition.
99338 * @param mixed $value Value of a variable to store. {@link Value}
99339 *   supports all data types except resources, such as file handles. This
99340 *   paramter is ignored if first argument is an array. A general
99341 *   guidance is to pass NULL as {@link value} while using array as
99342 *   {@link key}. If {@link value} is an object, or an array containing
99343 *   objects, then the objects will be serialized. See __sleep() for
99344 *   details on serializing objects.
99345 * @param int $ttl Associative array of keys and values.
99346 * @return bool If {@link key} is an array, the function returns: If
99347 *   all the name => value pairs in the array can be set, function
99348 *   returns an empty array; If all the name => value pairs in the array
99349 *   cannot be set, function returns FALSE; If some can be set while
99350 *   others cannot, function returns an array with name=>value pair for
99351 *   which the addition failed in the user cache.
99352 * @since PECL wincache >= 1.1.0
99353 **/
99354function wincache_ucache_add($key, $value, $ttl){}
99355
99356/**
99357 * Compares the variable with old value and assigns new value to it
99358 *
99359 * Compares the variable associated with the {@link key} with {@link
99360 * old_value} and if it matches then assigns the {@link new_value} to it.
99361 *
99362 * @param string $key The {@link key} that is used to store the
99363 *   variable in the cache. {@link key} is case sensitive.
99364 * @param int $old_value Old value of the variable pointed by {@link
99365 *   key} in the user cache. The value should be of type long, otherwise
99366 *   the function returns FALSE.
99367 * @param int $new_value New value which will get assigned to variable
99368 *   pointer by {@link key} if a match is found. The value should be of
99369 *   type long, otherwise the function returns FALSE.
99370 * @return bool
99371 * @since PECL wincache >= 1.1.0
99372 **/
99373function wincache_ucache_cas($key, $old_value, $new_value){}
99374
99375/**
99376 * Deletes entire content of the user cache
99377 *
99378 * Clears/deletes all the values stored in the user cache.
99379 *
99380 * @return bool
99381 * @since PECL wincache >= 1.1.0
99382 **/
99383function wincache_ucache_clear(){}
99384
99385/**
99386 * Decrements the value associated with the key
99387 *
99388 * Decrements the value associated with the {@link key} by 1 or as
99389 * specified by {@link dec_by}.
99390 *
99391 * @param string $key The {@link key} that was used to store the
99392 *   variable in the cache. {@link key} is case sensitive.
99393 * @param int $dec_by The value by which the variable associated with
99394 *   the {@link key} will get decremented. If the argument is a floating
99395 *   point number it will be truncated to nearest integer. The variable
99396 *   associated with the {@link key} should be of type long, otherwise
99397 *   the function fails and returns FALSE.
99398 * @param bool $success Will be set to TRUE on success and FALSE on
99399 *   failure.
99400 * @return mixed
99401 * @since PECL wincache >= 1.1.0
99402 **/
99403function wincache_ucache_dec($key, $dec_by, &$success){}
99404
99405/**
99406 * Deletes variables from the user cache
99407 *
99408 * Deletes the elements in the user cache pointed by {@link key}.
99409 *
99410 * @param mixed $key The {@link key} that was used to store the
99411 *   variable in the cache. {@link key} is case sensitive. {@link key}
99412 *   can be an array of keys.
99413 * @return bool
99414 * @since PECL wincache >= 1.1.0
99415 **/
99416function wincache_ucache_delete($key){}
99417
99418/**
99419 * Checks if a variable exists in the user cache
99420 *
99421 * Checks if a variable with the {@link key} exists in the user cache or
99422 * not.
99423 *
99424 * @param string $key The {@link key} that was used to store the
99425 *   variable in the cache. {@link key} is case sensitive.
99426 * @return bool Returns TRUE if variable with the {@link key} exitsts,
99427 *   otherwise returns FALSE.
99428 * @since PECL wincache >= 1.1.0
99429 **/
99430function wincache_ucache_exists($key){}
99431
99432/**
99433 * Gets a variable stored in the user cache
99434 *
99435 * Gets a variable stored in the user cache.
99436 *
99437 * @param mixed $key The {@link key} that was used to store the
99438 *   variable in the cache. {@link key} is case sensitive. {@link key}
99439 *   can be an array of keys. In this case the return value will be an
99440 *   array of values of each element in the {@link key} array. If an
99441 *   object, or an array containing objects, is returned, then the
99442 *   objects will be unserialized. See __wakeup() for details on
99443 *   unserializing objects.
99444 * @param bool $success Will be set to TRUE on success and FALSE on
99445 *   failure.
99446 * @return mixed
99447 * @since PECL wincache >= 1.1.0
99448 **/
99449function wincache_ucache_get($key, &$success){}
99450
99451/**
99452 * Increments the value associated with the key
99453 *
99454 * Increments the value associated with the {@link key} by 1 or as
99455 * specified by {@link inc_by}.
99456 *
99457 * @param string $key The {@link key} that was used to store the
99458 *   variable in the cache. {@link key} is case sensitive.
99459 * @param int $inc_by The value by which the variable associated with
99460 *   the {@link key} will get incremented. If the argument is a floating
99461 *   point number it will be truncated to nearest integer. The variable
99462 *   associated with the {@link key} should be of type long, otherwise
99463 *   the function fails and returns FALSE.
99464 * @param bool $success Will be set to TRUE on success and FALSE on
99465 *   failure.
99466 * @return mixed
99467 * @since PECL wincache >= 1.1.0
99468 **/
99469function wincache_ucache_inc($key, $inc_by, &$success){}
99470
99471/**
99472 * Retrieves information about data stored in the user cache
99473 *
99474 * Retrieves information about data stored in the user cache.
99475 *
99476 * @param bool $summaryonly Controls whether the returned array will
99477 *   contain information about individual cache entries along with the
99478 *   user cache summary.
99479 * @param string $key The key of an entry in the user cache. If
99480 *   specified then the returned array will contain information only
99481 *   about that cache entry. If not specified and {@link summaryonly} is
99482 *   set to FALSE then the returned array will contain information about
99483 *   all entries in the cache.
99484 * @return array Array of meta data about user cache
99485 * @since PECL wincache >= 1.1.0
99486 **/
99487function wincache_ucache_info($summaryonly, $key){}
99488
99489/**
99490 * Retrieves information about user cache memory usage
99491 *
99492 * Retrieves information about memory usage by user cache.
99493 *
99494 * @return array Array of meta data about user cache memory usage
99495 * @since PECL wincache >= 1.1.0
99496 **/
99497function wincache_ucache_meminfo(){}
99498
99499/**
99500 * Adds a variable in user cache and overwrites a variable if it already
99501 * exists in the cache
99502 *
99503 * Adds a variable in user cache. Overwrites a variable if it already
99504 * exists in the cache. The added or updated variable remains in the user
99505 * cache unless its time to live expires or it is deleted by using {@link
99506 * wincache_ucache_delete} or {@link wincache_ucache_clear} functions.
99507 *
99508 * @param mixed $key Store the variable using this {@link key} name. If
99509 *   a variable with same {@link key} is already present the function
99510 *   will overwrite the previous value with the new one. {@link key} is
99511 *   case sensitive. {@link key} can also take array of name => value
99512 *   pairs where names will be used as keys. This can be used to add
99513 *   multiple values in the cache in one operation, thus avoiding race
99514 *   condition.
99515 * @param mixed $value Value of a variable to store. {@link Value}
99516 *   supports all data types except resources, such as file handles. This
99517 *   paramter is ignored if first argument is an array. A general
99518 *   guidance is to pass NULL as {@link value} while using array as
99519 *   {@link key}. If {@link value} is an object, or an array containing
99520 *   objects, then the objects will be serialized. See __sleep() for
99521 *   details on serializing objects.
99522 * @param int $ttl Associative array of keys and values.
99523 * @return bool If {@link key} is an array, the function returns: If
99524 *   all the name => value pairs in the array can be set, function
99525 *   returns an empty array; If all the name => value pairs in the array
99526 *   cannot be set, function returns FALSE; If some can be set while
99527 *   others cannot, function returns an array with name=>value pair for
99528 *   which the addition failed in the user cache.
99529 * @since PECL wincache >= 1.1.0
99530 **/
99531function wincache_ucache_set($key, $value, $ttl){}
99532
99533/**
99534 * Releases an exclusive lock on a given key
99535 *
99536 * Releases an exclusive lock that was obtained on a given key by using
99537 * {@link wincache_lock}. If any other process was blocked waiting for
99538 * the lock on this key, that process will be able to obtain the lock.
99539 *
99540 * @param string $key Name of the key in the cache to release the lock
99541 *   on.
99542 * @return bool
99543 * @since PECL wincache >= 1.1.0
99544 **/
99545function wincache_unlock($key){}
99546
99547/**
99548 * Wraps a string to a given number of characters
99549 *
99550 * Wraps a string to a given number of characters using a string break
99551 * character.
99552 *
99553 * @param string $str The input string.
99554 * @param int $width The number of characters at which the string will
99555 *   be wrapped.
99556 * @param string $break The line is broken using the optional {@link
99557 *   break} parameter.
99558 * @param bool $cut If the {@link cut} is set to TRUE, the string is
99559 *   always wrapped at or before the specified {@link width}. So if you
99560 *   have a word that is larger than the given width, it is broken apart.
99561 *   (See second example). When FALSE the function does not split the
99562 *   word even if the {@link width} is smaller than the word width.
99563 * @return string Returns the given string wrapped at the specified
99564 *   length.
99565 * @since PHP 4 >= 4.0.2, PHP 5, PHP 7
99566 **/
99567function wordwrap($str, $width, $break, $cut){}
99568
99569/**
99570 * Get an extended attribute
99571 *
99572 * This function gets the value of an extended attribute of a file.
99573 *
99574 * @param string $filename The file from which we get the attribute.
99575 * @param string $name The name of the attribute.
99576 * @param int $flags Supported xattr flags XATTR_DONTFOLLOW Do not
99577 *   follow the symbolic link but operate on symbolic link itself.
99578 *   XATTR_ROOT Set attribute in root (trusted) namespace. Requires root
99579 *   privileges.
99580 * @return string Returns a string containing the value or FALSE if the
99581 *   attribute doesn't exist.
99582 * @since PECL xattr >= 0.9.0
99583 **/
99584function xattr_get($filename, $name, $flags){}
99585
99586/**
99587 * Get a list of extended attributes
99588 *
99589 * This functions gets a list of names of extended attributes of a file.
99590 *
99591 * @param string $filename The path of the file.
99592 * @param int $flags Supported xattr flags XATTR_DONTFOLLOW Do not
99593 *   follow the symbolic link but operate on symbolic link itself.
99594 *   XATTR_ROOT Set attribute in root (trusted) namespace. Requires root
99595 *   privileges.
99596 * @return array This function returns an array with names of extended
99597 *   attributes.
99598 * @since PECL xattr >= 0.9.0
99599 **/
99600function xattr_list($filename, $flags){}
99601
99602/**
99603 * Remove an extended attribute
99604 *
99605 * This function removes an extended attribute of a file.
99606 *
99607 * @param string $filename The file from which we remove the attribute.
99608 * @param string $name The name of the attribute to remove.
99609 * @param int $flags Supported xattr flags XATTR_DONTFOLLOW Do not
99610 *   follow the symbolic link but operate on symbolic link itself.
99611 *   XATTR_ROOT Set attribute in root (trusted) namespace. Requires root
99612 *   privileges.
99613 * @return bool
99614 * @since PECL xattr >= 0.9.0
99615 **/
99616function xattr_remove($filename, $name, $flags){}
99617
99618/**
99619 * Set an extended attribute
99620 *
99621 * This function sets the value of an extended attribute of a file.
99622 *
99623 * @param string $filename The file in which we set the attribute.
99624 * @param string $name The name of the extended attribute. This
99625 *   attribute will be created if it doesn't exist or replaced otherwise.
99626 *   You can change this behaviour by using the {@link flags} parameter.
99627 * @param string $value The value of the attribute.
99628 * @param int $flags Supported xattr flags XATTR_CREATE Function will
99629 *   fail if extended attribute already exists. XATTR_REPLACE Function
99630 *   will fail if extended attribute doesn't exist. XATTR_DONTFOLLOW Do
99631 *   not follow the symbolic link but operate on symbolic link itself.
99632 *   XATTR_ROOT Set attribute in root (trusted) namespace. Requires root
99633 *   privileges.
99634 * @return bool
99635 * @since PECL xattr >= 0.9.0
99636 **/
99637function xattr_set($filename, $name, $value, $flags){}
99638
99639/**
99640 * Check if filesystem supports extended attributes
99641 *
99642 * This functions checks if the filesystem holding the given file
99643 * supports extended attributes. Read access to the file is required.
99644 *
99645 * @param string $filename The path of the tested file.
99646 * @param int $flags Supported xattr flags XATTR_DONTFOLLOW Do not
99647 *   follow the symbolic link but operate on symbolic link itself.
99648 * @return bool This function returns TRUE if filesystem supports
99649 *   extended attributes, FALSE if it doesn't and NULL if it can't be
99650 *   determined (for example wrong path or lack of permissions to file).
99651 * @since PECL xattr >= 1.0.0
99652 **/
99653function xattr_supported($filename, $flags){}
99654
99655/**
99656 * Make binary diff of two files
99657 *
99658 * Makes a binary diff of two files and stores the result in a patch
99659 * file. This function works with both text and binary files. Resulting
99660 * patch file can be later applied using {@link xdiff_file_bpatch}/{@link
99661 * xdiff_string_bpatch}.
99662 *
99663 * @param string $old_file Path to the first file. This file acts as
99664 *   "old" file.
99665 * @param string $new_file Path to the second file. This file acts as
99666 *   "new" file.
99667 * @param string $dest Path of the resulting patch file. Resulting file
99668 *   contains differences between "old" and "new" files. It is in binary
99669 *   format and is human-unreadable.
99670 * @return bool
99671 * @since PECL xdiff >= 1.5.0
99672 **/
99673function xdiff_file_bdiff($old_file, $new_file, $dest){}
99674
99675/**
99676 * Read a size of file created by applying a binary diff
99677 *
99678 * Returns a size of a result file that would be created after applying
99679 * binary patch from file {@link file} to the original file.
99680 *
99681 * @param string $file The path to the binary patch created by {@link
99682 *   xdiff_string_bdiff} or {@link xdiff_string_rabdiff} function.
99683 * @return int Returns the size of file that would be created.
99684 * @since PECL xdiff >= 1.5.0
99685 **/
99686function xdiff_file_bdiff_size($file){}
99687
99688/**
99689 * Patch a file with a binary diff
99690 *
99691 * Patches a {@link file} with a binary {@link patch} and stores the
99692 * result in a file {@link dest}. This function accepts patches created
99693 * both via {@link xdiff_file_bdiff} and {@link xdiff_file_rabdiff}
99694 * functions or their string counterparts.
99695 *
99696 * @param string $file The original file.
99697 * @param string $patch The binary patch file.
99698 * @param string $dest Path of the resulting file.
99699 * @return bool
99700 * @since PECL xdiff >= 1.5.0
99701 **/
99702function xdiff_file_bpatch($file, $patch, $dest){}
99703
99704/**
99705 * Make unified diff of two files
99706 *
99707 * Makes an unified diff containing differences between {@link old_file}
99708 * and {@link new_file} and stores it in {@link dest} file. The resulting
99709 * file is human-readable. An optional {@link context} parameter
99710 * specifies how many lines of context should be added around each
99711 * change. Setting {@link minimal} parameter to true will result in
99712 * outputting the shortest patch file possible (can take a long time).
99713 *
99714 * @param string $old_file Path to the first file. This file acts as
99715 *   "old" file.
99716 * @param string $new_file Path to the second file. This file acts as
99717 *   "new" file.
99718 * @param string $dest Path of the resulting patch file.
99719 * @param int $context Indicates how many lines of context you want to
99720 *   include in diff result.
99721 * @param bool $minimal Set this parameter to TRUE if you want to
99722 *   minimalize size of the result (can take a long time).
99723 * @return bool
99724 * @since PECL xdiff >= 0.2.0
99725 **/
99726function xdiff_file_diff($old_file, $new_file, $dest, $context, $minimal){}
99727
99728/**
99729 * Alias of xdiff_file_bdiff
99730 *
99731 * Makes a binary diff of two files and stores the result in a patch
99732 * file. This function works with both text and binary files. Resulting
99733 * patch file can be later applied using {@link xdiff_file_bpatch}.
99734 *
99735 * Starting with version 1.5.0 this function is an alias of {@link
99736 * xdiff_file_bdiff}.
99737 *
99738 * @param string $old_file Path to the first file. This file acts as
99739 *   "old" file.
99740 * @param string $new_file Path to the second file. This file acts as
99741 *   "new" file.
99742 * @param string $dest Path of the resulting patch file. Resulting file
99743 *   contains differences between "old" and "new" files. It is in binary
99744 *   format and is human-unreadable.
99745 * @return bool
99746 * @since PECL xdiff >= 0.2.0
99747 **/
99748function xdiff_file_diff_binary($old_file, $new_file, $dest){}
99749
99750/**
99751 * Merge 3 files into one
99752 *
99753 * Merges three files into one and stores the result in a file {@link
99754 * dest}. The {@link old_file} is an original version while {@link
99755 * new_file1} and {@link new_file2} are modified versions of an original.
99756 *
99757 * @param string $old_file Path to the first file. It acts as "old"
99758 *   file.
99759 * @param string $new_file1 Path to the second file. It acts as
99760 *   modified version of {@link old_file}.
99761 * @param string $new_file2 Path to the third file. It acts as modified
99762 *   version of {@link old_file}.
99763 * @param string $dest Path of the resulting file, containing merged
99764 *   changed from both {@link new_file1} and {@link new_file2}.
99765 * @return mixed Returns TRUE if merge was successful, string with
99766 *   rejected chunks if it was not or FALSE if an internal error
99767 *   happened.
99768 * @since PECL xdiff >= 0.2.0
99769 **/
99770function xdiff_file_merge3($old_file, $new_file1, $new_file2, $dest){}
99771
99772/**
99773 * Patch a file with an unified diff
99774 *
99775 * Patches a {@link file} with a {@link patch} and stores the result in a
99776 * file. {@link patch} has to be an unified diff created by {@link
99777 * xdiff_file_diff}/{@link xdiff_string_diff} function. An optional
99778 * {@link flags} parameter specifies mode of operation.
99779 *
99780 * @param string $file The original file.
99781 * @param string $patch The unified patch file. It has to be created
99782 *   using {@link xdiff_string_diff}, {@link xdiff_file_diff} functions
99783 *   or compatible tools.
99784 * @param string $dest Path of the resulting file.
99785 * @param int $flags Can be either XDIFF_PATCH_NORMAL (default mode,
99786 *   normal patch) or XDIFF_PATCH_REVERSE (reversed patch). Starting from
99787 *   version 1.5.0, you can also use binary OR to enable
99788 *   XDIFF_PATCH_IGNORESPACE flag.
99789 * @return mixed Returns FALSE if an internal error happened, string
99790 *   with rejected chunks if patch couldn't be applied or TRUE if patch
99791 *   has been successfully applied.
99792 * @since PECL xdiff >= 0.2.0
99793 **/
99794function xdiff_file_patch($file, $patch, $dest, $flags){}
99795
99796/**
99797 * Alias of xdiff_file_bpatch
99798 *
99799 * Patches a {@link file} with a binary {@link patch} and stores the
99800 * result in a file {@link dest}. This function accepts patches created
99801 * both via {@link xdiff_file_bdiff} or {@link xdiff_file_rabdiff}
99802 * functions or their string counterparts.
99803 *
99804 * Starting with version 1.5.0 this function is an alias of {@link
99805 * xdiff_file_bpatch}.
99806 *
99807 * @param string $file The original file.
99808 * @param string $patch The binary patch file.
99809 * @param string $dest Path of the resulting file.
99810 * @return bool
99811 * @since PECL xdiff >= 0.2.0
99812 **/
99813function xdiff_file_patch_binary($file, $patch, $dest){}
99814
99815/**
99816 * Make binary diff of two files using the Rabin's polynomial
99817 * fingerprinting algorithm
99818 *
99819 * Makes a binary diff of two files and stores the result in a patch
99820 * file. The difference between this function and {@link
99821 * xdiff_file_bdiff} is different algorithm used which should result in
99822 * faster execution and smaller diff produced. This function works with
99823 * both text and binary files. Resulting patch file can be later applied
99824 * using {@link xdiff_file_bpatch}/{@link xdiff_string_bpatch}.
99825 *
99826 * For more details about differences between algorithm used please check
99827 * libxdiff website.
99828 *
99829 * @param string $old_file Path to the first file. This file acts as
99830 *   "old" file.
99831 * @param string $new_file Path to the second file. This file acts as
99832 *   "new" file.
99833 * @param string $dest Path of the resulting patch file. Resulting file
99834 *   contains differences between "old" and "new" files. It is in binary
99835 *   format and is human-unreadable.
99836 * @return bool
99837 * @since PECL xdiff >= 1.5.0
99838 **/
99839function xdiff_file_rabdiff($old_file, $new_file, $dest){}
99840
99841/**
99842 * Make binary diff of two strings using the Rabin's polynomial
99843 * fingerprinting algorithm
99844 *
99845 * Makes a binary diff of two strings and returns the result. The
99846 * difference between this function and {@link xdiff_string_bdiff} is
99847 * different algorithm used which should result in faster execution and
99848 * smaller diff produced. This function works with both text and binary
99849 * data. Resulting patch can be later applied using {@link
99850 * xdiff_string_bpatch}/{@link xdiff_file_bpatch}.
99851 *
99852 * For more details about differences between algorithm used please check
99853 * libxdiff website.
99854 *
99855 * @param string $old_data First string with binary data. It acts as
99856 *   "old" data.
99857 * @param string $new_data Second string with binary data. It acts as
99858 *   "new" data.
99859 * @return string Returns string with binary diff containing
99860 *   differences between "old" and "new" data or FALSE if an internal
99861 *   error occurred.
99862 * @since PECL xdiff >= 1.5.0
99863 **/
99864function xdiff_string_bdiff($old_data, $new_data){}
99865
99866/**
99867 * Read a size of file created by applying a binary diff
99868 *
99869 * Returns a size of a result file that would be created after applying
99870 * binary {@link patch} to the original file.
99871 *
99872 * @param string $patch The binary patch created by {@link
99873 *   xdiff_string_bdiff} or {@link xdiff_string_rabdiff} function.
99874 * @return int Returns the size of file that would be created.
99875 * @since PECL xdiff >= 1.5.0
99876 **/
99877function xdiff_string_bdiff_size($patch){}
99878
99879/**
99880 * Patch a string with a binary diff
99881 *
99882 * Patches a string {@link str} with a binary {@link patch}. This
99883 * function accepts patches created both via {@link xdiff_string_bdiff}
99884 * and {@link xdiff_string_rabdiff} functions or their file counterparts.
99885 *
99886 * @param string $str The original binary string.
99887 * @param string $patch The binary patch string.
99888 * @return string Returns the patched string, or FALSE on error.
99889 * @since PECL xdiff >= 1.5.0
99890 **/
99891function xdiff_string_bpatch($str, $patch){}
99892
99893/**
99894 * Make unified diff of two strings
99895 *
99896 * Makes an unified diff containing differences between {@link old_data}
99897 * string and {@link new_data} string and returns it. The resulting diff
99898 * is human-readable. An optional {@link context} parameter specifies how
99899 * many lines of context should be added around each change. Setting
99900 * {@link minimal} parameter to true will result in outputting the
99901 * shortest patch file possible (can take a long time).
99902 *
99903 * @param string $old_data First string with data. It acts as "old"
99904 *   data.
99905 * @param string $new_data Second string with data. It acts as "new"
99906 *   data.
99907 * @param int $context Indicates how many lines of context you want to
99908 *   include in the diff result.
99909 * @param bool $minimal Set this parameter to TRUE if you want to
99910 *   minimalize the size of the result (can take a long time).
99911 * @return string Returns string with resulting diff or FALSE if an
99912 *   internal error happened.
99913 * @since PECL xdiff >= 0.2.0
99914 **/
99915function xdiff_string_diff($old_data, $new_data, $context, $minimal){}
99916
99917/**
99918 * Merge 3 strings into one
99919 *
99920 * Merges three strings into one and returns the result. The {@link
99921 * old_data} is an original version of data while {@link new_data1} and
99922 * {@link new_data2} are modified versions of an original. An optional
99923 * {@link error} is used to pass any rejected parts during merging
99924 * process.
99925 *
99926 * @param string $old_data First string with data. It acts as "old"
99927 *   data.
99928 * @param string $new_data1 Second string with data. It acts as
99929 *   modified version of {@link old_data}.
99930 * @param string $new_data2 Third string with data. It acts as modified
99931 *   version of {@link old_data}.
99932 * @param string $error If provided then rejected parts are stored
99933 *   inside this variable.
99934 * @return mixed Returns the merged string, FALSE if an internal error
99935 *   happened, or TRUE if merged string is empty.
99936 * @since PECL xdiff >= 0.2.0
99937 **/
99938function xdiff_string_merge3($old_data, $new_data1, $new_data2, &$error){}
99939
99940/**
99941 * Patch a string with an unified diff
99942 *
99943 * Patches a {@link str} string with an unified patch in {@link patch}
99944 * parameter and returns the result. {@link patch} has to be an unified
99945 * diff created by {@link xdiff_file_diff}/{@link xdiff_string_diff}
99946 * function. An optional {@link flags} parameter specifies mode of
99947 * operation. Any rejected parts of the patch will be stored inside
99948 * {@link error} variable if it is provided.
99949 *
99950 * @param string $str The original string.
99951 * @param string $patch The unified patch string. It has to be created
99952 *   using {@link xdiff_string_diff}, {@link xdiff_file_diff} functions
99953 *   or compatible tools.
99954 * @param int $flags {@link flags} can be either XDIFF_PATCH_NORMAL
99955 *   (default mode, normal patch) or XDIFF_PATCH_REVERSE (reversed
99956 *   patch). Starting from version 1.5.0, you can also use binary OR to
99957 *   enable XDIFF_PATCH_IGNORESPACE flag.
99958 * @param string $error If provided then rejected parts are stored
99959 *   inside this variable.
99960 * @return string Returns the patched string, or FALSE on error.
99961 * @since PECL xdiff >= 0.2.0
99962 **/
99963function xdiff_string_patch($str, $patch, $flags, &$error){}
99964
99965/**
99966 * Alias of xdiff_string_bpatch
99967 *
99968 * Patches a string {@link str} with a binary {@link patch}. This
99969 * function accepts patches created both via {@link xdiff_string_bdiff}
99970 * and {@link xdiff_string_rabdiff} functions or their file counterparts.
99971 *
99972 * Starting with version 1.5.0 this function is an alias of {@link
99973 * xdiff_string_bpatch}.
99974 *
99975 * @param string $str The original binary string.
99976 * @param string $patch The binary patch string.
99977 * @return string Returns the patched string, or FALSE on error.
99978 * @since PECL xdiff >= 0.2.0
99979 **/
99980function xdiff_string_patch_binary($str, $patch){}
99981
99982/**
99983 * Stops xhprof profiler
99984 *
99985 * Stops the profiler, and returns xhprof data from the run.
99986 *
99987 * @return array An array of xhprof data, from the run.
99988 * @since PECL xhprof >= 0.9.0
99989 **/
99990function xhprof_disable(){}
99991
99992/**
99993 * Start xhprof profiler
99994 *
99995 * Start xhprof profiling.
99996 *
99997 * @param int $flags Optional flags to add additional information to
99998 *   the profiling. See the XHprof constants for further information
99999 *   about these flags, e.g., XHPROF_FLAGS_MEMORY to enable memory
100000 *   profiling.
100001 * @param array $options An array of optional options, namely, the
100002 *   'ignored_functions' option to pass in functions to be ignored during
100003 *   profiling.
100004 * @return void NULL
100005 * @since PECL xhprof >= 0.9.0
100006 **/
100007function xhprof_enable($flags, $options){}
100008
100009/**
100010 * Stops xhprof sample profiler
100011 *
100012 * Stops the sample mode xhprof profiler, and
100013 *
100014 * @return array An array of xhprof sample data, from the run.
100015 * @since PECL xhprof >= 0.9.0
100016 **/
100017function xhprof_sample_disable(){}
100018
100019/**
100020 * Start XHProf profiling in sampling mode
100021 *
100022 * Starts profiling in sample mode, which is a lighter weight version of
100023 * {@link xhprof_enable}. The sampling interval is 0.1 seconds, and
100024 * samples record the full function call stack. The main use case is when
100025 * lower overhead is required when doing performance monitoring and
100026 * diagnostics.
100027 *
100028 * @return void NULL
100029 * @since PECL xhprof >= 0.9.0
100030 **/
100031function xhprof_sample_enable(){}
100032
100033/**
100034 * Decodes XML into native PHP types
100035 *
100036 * @param string $xml XML response returned by XMLRPC method.
100037 * @param string $encoding Input encoding supported by iconv.
100038 * @return mixed Returns either an array, or an integer, or a string,
100039 *   or a boolean according to the response returned by the XMLRPC
100040 *   method.
100041 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
100042 **/
100043function xmlrpc_decode($xml, $encoding){}
100044
100045/**
100046 * Decodes XML into native PHP types
100047 *
100048 * @param string $xml
100049 * @param string $method
100050 * @param string $encoding
100051 * @return mixed
100052 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
100053 **/
100054function xmlrpc_decode_request($xml, &$method, $encoding){}
100055
100056/**
100057 * Generates XML for a PHP value
100058 *
100059 * @param mixed $value
100060 * @return string
100061 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
100062 **/
100063function xmlrpc_encode($value){}
100064
100065/**
100066 * Generates XML for a method request
100067 *
100068 * @param string $method Name of the method to call.
100069 * @param mixed $params Method parameters compatible with method
100070 *   signature.
100071 * @param array $output_options Array specifying output options may
100072 *   contain (default values are emphasised): output_type: php, xml
100073 *   verbosity: no_white_space, newlines_only, pretty escaping: cdata,
100074 *   non-ascii, non-print, markup (may be a string with one value or an
100075 *   array with multiple values) version: simple, xmlrpc, soap 1.1, auto
100076 *   encoding: iso-8859-1, other character set supported by iconv
100077 * @return string Returns a string containing the XML representation of
100078 *   the request.
100079 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
100080 **/
100081function xmlrpc_encode_request($method, $params, $output_options){}
100082
100083/**
100084 * Gets xmlrpc type for a PHP value
100085 *
100086 * This function is especially useful for base64 and datetime strings.
100087 *
100088 * @param mixed $value PHP value
100089 * @return string Returns the XML-RPC type.
100090 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
100091 **/
100092function xmlrpc_get_type($value){}
100093
100094/**
100095 * Determines if an array value represents an XMLRPC fault
100096 *
100097 * @param array $arg Array returned by {@link xmlrpc_decode}.
100098 * @return bool Returns TRUE if the argument means fault, FALSE
100099 *   otherwise. Fault description is available in $arg["faultString"],
100100 *   fault code is in $arg["faultCode"].
100101 * @since PHP 4 >= 4.3.0, PHP 5, PHP 7
100102 **/
100103function xmlrpc_is_fault($arg){}
100104
100105/**
100106 * Decodes XML into a list of method descriptions
100107 *
100108 * @param string $xml
100109 * @return array
100110 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
100111 **/
100112function xmlrpc_parse_method_descriptions($xml){}
100113
100114/**
100115 * Adds introspection documentation
100116 *
100117 * @param resource $server
100118 * @param array $desc
100119 * @return int
100120 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
100121 **/
100122function xmlrpc_server_add_introspection_data($server, $desc){}
100123
100124/**
100125 * Parses XML requests and call methods
100126 *
100127 * @param resource $server
100128 * @param string $xml
100129 * @param mixed $user_data
100130 * @param array $output_options
100131 * @return string
100132 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
100133 **/
100134function xmlrpc_server_call_method($server, $xml, $user_data, $output_options){}
100135
100136/**
100137 * Creates an xmlrpc server
100138 *
100139 * @return resource
100140 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
100141 **/
100142function xmlrpc_server_create(){}
100143
100144/**
100145 * Destroys server resources
100146 *
100147 * @param resource $server
100148 * @return bool
100149 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
100150 **/
100151function xmlrpc_server_destroy($server){}
100152
100153/**
100154 * Register a PHP function to generate documentation
100155 *
100156 * @param resource $server
100157 * @param string $function
100158 * @return bool
100159 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
100160 **/
100161function xmlrpc_server_register_introspection_callback($server, $function){}
100162
100163/**
100164 * Register a PHP function to resource method matching method_name
100165 *
100166 * @param resource $server
100167 * @param string $method_name
100168 * @param string $function
100169 * @return bool
100170 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
100171 **/
100172function xmlrpc_server_register_method($server, $method_name, $function){}
100173
100174/**
100175 * Sets xmlrpc type, base64 or datetime, for a PHP string value
100176 *
100177 * @param string $value Value to set the type
100178 * @param string $type 'base64' or 'datetime'
100179 * @return bool If successful, {@link value} is converted to an object.
100180 * @since PHP 4 >= 4.1.0, PHP 5, PHP 7
100181 **/
100182function xmlrpc_set_type(&$value, $type){}
100183
100184/**
100185 * End attribute
100186 *
100187 * Ends the current attribute.
100188 *
100189 * @param resource $xmlwriter
100190 * @return bool
100191 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100192 **/
100193function xmlwriter_end_attribute($xmlwriter){}
100194
100195/**
100196 * End current CDATA
100197 *
100198 * Ends the current CDATA section.
100199 *
100200 * @param resource $xmlwriter
100201 * @return bool
100202 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100203 **/
100204function xmlwriter_end_cdata($xmlwriter){}
100205
100206/**
100207 * Create end comment
100208 *
100209 * Ends the current comment.
100210 *
100211 * @param resource $xmlwriter
100212 * @return bool
100213 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 1.0.0
100214 **/
100215function xmlwriter_end_comment($xmlwriter){}
100216
100217/**
100218 * End current document
100219 *
100220 * Ends the current document.
100221 *
100222 * @param resource $xmlwriter
100223 * @return bool
100224 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100225 **/
100226function xmlwriter_end_document($xmlwriter){}
100227
100228/**
100229 * End current DTD
100230 *
100231 * Ends the DTD of the document.
100232 *
100233 * @param resource $xmlwriter
100234 * @return bool
100235 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100236 **/
100237function xmlwriter_end_dtd($xmlwriter){}
100238
100239/**
100240 * End current DTD AttList
100241 *
100242 * Ends the current DTD attribute list.
100243 *
100244 * @param resource $xmlwriter
100245 * @return bool
100246 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100247 **/
100248function xmlwriter_end_dtd_attlist($xmlwriter){}
100249
100250/**
100251 * End current DTD element
100252 *
100253 * Ends the current DTD element.
100254 *
100255 * @param resource $xmlwriter
100256 * @return bool
100257 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100258 **/
100259function xmlwriter_end_dtd_element($xmlwriter){}
100260
100261/**
100262 * End current DTD Entity
100263 *
100264 * Ends the current DTD entity.
100265 *
100266 * @param resource $xmlwriter
100267 * @return bool
100268 * @since PHP 5 >= 5.2.1, PHP 7, PECL xmlwriter >= 0.1.0
100269 **/
100270function xmlwriter_end_dtd_entity($xmlwriter){}
100271
100272/**
100273 * End current element
100274 *
100275 * Ends the current element.
100276 *
100277 * @param resource $xmlwriter
100278 * @return bool
100279 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100280 **/
100281function xmlwriter_end_element($xmlwriter){}
100282
100283/**
100284 * End current PI
100285 *
100286 * Ends the current processing instruction.
100287 *
100288 * @param resource $xmlwriter
100289 * @return bool
100290 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100291 **/
100292function xmlwriter_end_pi($xmlwriter){}
100293
100294/**
100295 * Flush current buffer
100296 *
100297 * Flushes the current buffer.
100298 *
100299 * @param resource $xmlwriter Whether to empty the buffer or not.
100300 *   Default is TRUE.
100301 * @param bool $empty
100302 * @return mixed If you opened the writer in memory, this function
100303 *   returns the generated XML buffer, Else, if using URI, this function
100304 *   will write the buffer and return the number of written bytes.
100305 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 1.0.0
100306 **/
100307function xmlwriter_flush($xmlwriter, $empty){}
100308
100309/**
100310 * End current element
100311 *
100312 * End the current xml element. Writes an end tag even if the element is
100313 * empty.
100314 *
100315 * @param resource $xmlwriter
100316 * @return bool
100317 * @since PHP 5 >= 5.2.0, PHP 7, PECL xmlwriter >= 2.0.4
100318 **/
100319function xmlwriter_full_end_element($xmlwriter){}
100320
100321/**
100322 * Create new xmlwriter using memory for string output
100323 *
100324 * Creates a new XMLWriter using memory for string output.
100325 *
100326 * @return resource :
100327 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100328 **/
100329function xmlwriter_open_memory(){}
100330
100331/**
100332 * Create new xmlwriter using source uri for output
100333 *
100334 * Creates a new XMLWriter using {@link uri} for the output.
100335 *
100336 * @param string $uri The URI of the resource for the output.
100337 * @return resource :
100338 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100339 **/
100340function xmlwriter_open_uri($uri){}
100341
100342/**
100343 * Returns current buffer
100344 *
100345 * Returns the current buffer.
100346 *
100347 * @param resource $xmlwriter Whether to flush the output buffer or
100348 *   not. Default is TRUE.
100349 * @param bool $flush
100350 * @return string Returns the current buffer as a string.
100351 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100352 **/
100353function xmlwriter_output_memory($xmlwriter, $flush){}
100354
100355/**
100356 * Toggle indentation on/off
100357 *
100358 * Toggles indentation on or off.
100359 *
100360 * @param resource $xmlwriter Whether indentation is enabled.
100361 * @param bool $indent
100362 * @return bool
100363 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100364 **/
100365function xmlwriter_set_indent($xmlwriter, $indent){}
100366
100367/**
100368 * Set string used for indenting
100369 *
100370 * Sets the string which will be used to indent each element/attribute of
100371 * the resulting xml.
100372 *
100373 * @param resource $xmlwriter The indentation string.
100374 * @param string $indentString
100375 * @return bool
100376 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100377 **/
100378function xmlwriter_set_indent_string($xmlwriter, $indentString){}
100379
100380/**
100381 * Create start attribute
100382 *
100383 * Starts an attribute.
100384 *
100385 * @param resource $xmlwriter The attribute name.
100386 * @param string $name
100387 * @return bool
100388 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100389 **/
100390function xmlwriter_start_attribute($xmlwriter, $name){}
100391
100392/**
100393 * Create start namespaced attribute
100394 *
100395 * Starts a namespaced attribute.
100396 *
100397 * @param resource $xmlwriter The namespace prefix.
100398 * @param string $prefix The attribute name.
100399 * @param string $name The namespace URI.
100400 * @param string $uri
100401 * @return bool
100402 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100403 **/
100404function xmlwriter_start_attribute_ns($xmlwriter, $prefix, $name, $uri){}
100405
100406/**
100407 * Create start CDATA tag
100408 *
100409 * Starts a CDATA.
100410 *
100411 * @param resource $xmlwriter
100412 * @return bool
100413 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100414 **/
100415function xmlwriter_start_cdata($xmlwriter){}
100416
100417/**
100418 * Create start comment
100419 *
100420 * Starts a comment.
100421 *
100422 * @param resource $xmlwriter
100423 * @return bool
100424 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 1.0.0
100425 **/
100426function xmlwriter_start_comment($xmlwriter){}
100427
100428/**
100429 * Create document tag
100430 *
100431 * Starts a document.
100432 *
100433 * @param resource $xmlwriter The version number of the document as
100434 *   part of the XML declaration.
100435 * @param string $version The encoding of the document as part of the
100436 *   XML declaration.
100437 * @param string $encoding yes or no.
100438 * @param string $standalone
100439 * @return bool
100440 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100441 **/
100442function xmlwriter_start_document($xmlwriter, $version, $encoding, $standalone){}
100443
100444/**
100445 * Create start DTD tag
100446 *
100447 * Starts a DTD.
100448 *
100449 * @param resource $xmlwriter The qualified name of the document type
100450 *   to create.
100451 * @param string $qualifiedName The external subset public identifier.
100452 * @param string $publicId The external subset system identifier.
100453 * @param string $systemId
100454 * @return bool
100455 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100456 **/
100457function xmlwriter_start_dtd($xmlwriter, $qualifiedName, $publicId, $systemId){}
100458
100459/**
100460 * Create start DTD AttList
100461 *
100462 * Starts a DTD attribute list.
100463 *
100464 * @param resource $xmlwriter The attribute list name.
100465 * @param string $name
100466 * @return bool
100467 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100468 **/
100469function xmlwriter_start_dtd_attlist($xmlwriter, $name){}
100470
100471/**
100472 * Create start DTD element
100473 *
100474 * Starts a DTD element.
100475 *
100476 * @param resource $xmlwriter The qualified name of the document type
100477 *   to create.
100478 * @param string $qualifiedName
100479 * @return bool
100480 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100481 **/
100482function xmlwriter_start_dtd_element($xmlwriter, $qualifiedName){}
100483
100484/**
100485 * Create start DTD Entity
100486 *
100487 * Starts a DTD entity.
100488 *
100489 * @param resource $xmlwriter The name of the entity.
100490 * @param string $name
100491 * @param bool $isparam
100492 * @return bool
100493 * @since PHP 5 >= 5.2.1, PHP 7, PECL xmlwriter >= 0.1.0
100494 **/
100495function xmlwriter_start_dtd_entity($xmlwriter, $name, $isparam){}
100496
100497/**
100498 * Create start element tag
100499 *
100500 * Starts an element.
100501 *
100502 * @param resource $xmlwriter The element name.
100503 * @param string $name
100504 * @return bool
100505 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100506 **/
100507function xmlwriter_start_element($xmlwriter, $name){}
100508
100509/**
100510 * Create start namespaced element tag
100511 *
100512 * Starts a namespaced element.
100513 *
100514 * @param resource $xmlwriter The namespace prefix.
100515 * @param string $prefix The element name.
100516 * @param string $name The namespace URI.
100517 * @param string $uri
100518 * @return bool
100519 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100520 **/
100521function xmlwriter_start_element_ns($xmlwriter, $prefix, $name, $uri){}
100522
100523/**
100524 * Create start PI tag
100525 *
100526 * Starts a processing instruction tag.
100527 *
100528 * @param resource $xmlwriter The target of the processing instruction.
100529 * @param string $target
100530 * @return bool
100531 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100532 **/
100533function xmlwriter_start_pi($xmlwriter, $target){}
100534
100535/**
100536 * Write text
100537 *
100538 * Writes a text.
100539 *
100540 * @param resource $xmlwriter The contents of the text.
100541 * @param string $content
100542 * @return bool
100543 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100544 **/
100545function xmlwriter_text($xmlwriter, $content){}
100546
100547/**
100548 * Write full attribute
100549 *
100550 * Writes a full attribute.
100551 *
100552 * @param resource $xmlwriter The name of the attribute.
100553 * @param string $name The value of the attribute.
100554 * @param string $value
100555 * @return bool
100556 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100557 **/
100558function xmlwriter_write_attribute($xmlwriter, $name, $value){}
100559
100560/**
100561 * Write full namespaced attribute
100562 *
100563 * Writes a full namespaced attribute.
100564 *
100565 * @param resource $xmlwriter The namespace prefix.
100566 * @param string $prefix The attribute name.
100567 * @param string $name The namespace URI.
100568 * @param string $uri The attribute value.
100569 * @param string $content
100570 * @return bool
100571 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100572 **/
100573function xmlwriter_write_attribute_ns($xmlwriter, $prefix, $name, $uri, $content){}
100574
100575/**
100576 * Write full CDATA tag
100577 *
100578 * Writes a full CDATA.
100579 *
100580 * @param resource $xmlwriter The contents of the CDATA.
100581 * @param string $content
100582 * @return bool
100583 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100584 **/
100585function xmlwriter_write_cdata($xmlwriter, $content){}
100586
100587/**
100588 * Write full comment tag
100589 *
100590 * Writes a full comment.
100591 *
100592 * @param resource $xmlwriter The contents of the comment.
100593 * @param string $content
100594 * @return bool
100595 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100596 **/
100597function xmlwriter_write_comment($xmlwriter, $content){}
100598
100599/**
100600 * Write full DTD tag
100601 *
100602 * Writes a full DTD.
100603 *
100604 * @param resource $xmlwriter The DTD name.
100605 * @param string $name The external subset public identifier.
100606 * @param string $publicId The external subset system identifier.
100607 * @param string $systemId The content of the DTD.
100608 * @param string $subset
100609 * @return bool
100610 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100611 **/
100612function xmlwriter_write_dtd($xmlwriter, $name, $publicId, $systemId, $subset){}
100613
100614/**
100615 * Write full DTD AttList tag
100616 *
100617 * Writes a DTD attribute list.
100618 *
100619 * @param resource $xmlwriter The name of the DTD attribute list.
100620 * @param string $name The content of the DTD attribute list.
100621 * @param string $content
100622 * @return bool
100623 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100624 **/
100625function xmlwriter_write_dtd_attlist($xmlwriter, $name, $content){}
100626
100627/**
100628 * Write full DTD element tag
100629 *
100630 * Writes a full DTD element.
100631 *
100632 * @param resource $xmlwriter The name of the DTD element.
100633 * @param string $name The content of the element.
100634 * @param string $content
100635 * @return bool
100636 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100637 **/
100638function xmlwriter_write_dtd_element($xmlwriter, $name, $content){}
100639
100640/**
100641 * Write full DTD Entity tag
100642 *
100643 * Writes a full DTD entity.
100644 *
100645 * @param resource $xmlwriter The name of the entity.
100646 * @param string $name The content of the entity.
100647 * @param string $content
100648 * @param bool $pe
100649 * @param string $pubid
100650 * @param string $sysid
100651 * @param string $ndataid
100652 * @return bool
100653 * @since PHP 5 >= 5.2.1, PHP 7, PECL xmlwriter >= 0.1.0
100654 **/
100655function xmlwriter_write_dtd_entity($xmlwriter, $name, $content, $pe, $pubid, $sysid, $ndataid){}
100656
100657/**
100658 * Write full element tag
100659 *
100660 * Writes a full element tag.
100661 *
100662 * @param resource $xmlwriter The element name.
100663 * @param string $name The element contents.
100664 * @param string $content
100665 * @return bool
100666 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100667 **/
100668function xmlwriter_write_element($xmlwriter, $name, $content){}
100669
100670/**
100671 * Write full namespaced element tag
100672 *
100673 * Writes a full namespaced element tag.
100674 *
100675 * @param resource $xmlwriter The namespace prefix.
100676 * @param string $prefix The element name.
100677 * @param string $name The namespace URI.
100678 * @param string $uri The element contents.
100679 * @param string $content
100680 * @return bool
100681 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100682 **/
100683function xmlwriter_write_element_ns($xmlwriter, $prefix, $name, $uri, $content){}
100684
100685/**
100686 * Writes a PI
100687 *
100688 * Writes a processing instruction.
100689 *
100690 * @param resource $xmlwriter The target of the processing instruction.
100691 * @param string $target The content of the processing instruction.
100692 * @param string $content
100693 * @return bool
100694 * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
100695 **/
100696function xmlwriter_write_pi($xmlwriter, $target, $content){}
100697
100698/**
100699 * Write a raw XML text
100700 *
100701 * Writes a raw xml text.
100702 *
100703 * @param resource $xmlwriter The text string to write.
100704 * @param string $content
100705 * @return bool
100706 * @since PHP 5 >= 5.2.0, PHP 7, PECL xmlwriter >= 2.0.4
100707 **/
100708function xmlwriter_write_raw($xmlwriter, $content){}
100709
100710/**
100711 * Get XML parser error string
100712 *
100713 * Gets the XML parser error string associated with the given {@link
100714 * code}.
100715 *
100716 * @param int $code An error code from {@link xml_get_error_code}.
100717 * @return string Returns a string with a textual description of the
100718 *   error {@link code}, or FALSE if no description was found.
100719 * @since PHP 4, PHP 5, PHP 7
100720 **/
100721function xml_error_string($code){}
100722
100723/**
100724 * Get current byte index for an XML parser
100725 *
100726 * Gets the current byte index of the given XML parser.
100727 *
100728 * @param resource $parser A reference to the XML parser to get byte
100729 *   index from.
100730 * @return int This function returns FALSE if {@link parser} does not
100731 *   refer to a valid parser, or else it returns which byte index the
100732 *   parser is currently at in its data buffer (starting at 0).
100733 * @since PHP 4, PHP 5, PHP 7
100734 **/
100735function xml_get_current_byte_index($parser){}
100736
100737/**
100738 * Get current column number for an XML parser
100739 *
100740 * Gets the current column number of the given XML parser.
100741 *
100742 * @param resource $parser A reference to the XML parser to get column
100743 *   number from.
100744 * @return int This function returns FALSE if {@link parser} does not
100745 *   refer to a valid parser, or else it returns which column on the
100746 *   current line (as given by {@link xml_get_current_line_number}) the
100747 *   parser is currently at.
100748 * @since PHP 4, PHP 5, PHP 7
100749 **/
100750function xml_get_current_column_number($parser){}
100751
100752/**
100753 * Get current line number for an XML parser
100754 *
100755 * Gets the current line number for the given XML parser.
100756 *
100757 * @param resource $parser A reference to the XML parser to get line
100758 *   number from.
100759 * @return int This function returns FALSE if {@link parser} does not
100760 *   refer to a valid parser, or else it returns which line the parser is
100761 *   currently at in its data buffer.
100762 * @since PHP 4, PHP 5, PHP 7
100763 **/
100764function xml_get_current_line_number($parser){}
100765
100766/**
100767 * Get XML parser error code
100768 *
100769 * Gets the XML parser error code.
100770 *
100771 * @param resource $parser A reference to the XML parser to get error
100772 *   code from.
100773 * @return int This function returns FALSE if {@link parser} does not
100774 *   refer to a valid parser, or else it returns one of the error codes
100775 *   listed in the error codes section.
100776 * @since PHP 4, PHP 5, PHP 7
100777 **/
100778function xml_get_error_code($parser){}
100779
100780/**
100781 * Start parsing an XML document
100782 *
100783 * {@link xml_parse} parses an XML document. The handlers for the
100784 * configured events are called as many times as necessary.
100785 *
100786 * @param resource $parser A reference to the XML parser to use.
100787 * @param string $data Chunk of data to parse. A document may be parsed
100788 *   piece-wise by calling {@link xml_parse} several times with new data,
100789 *   as long as the {@link is_final} parameter is set and TRUE when the
100790 *   last data is parsed.
100791 * @param bool $is_final If set and TRUE, {@link data} is the last
100792 *   piece of data sent in this parse.
100793 * @return int Returns 1 on success or 0 on failure.
100794 * @since PHP 4, PHP 5, PHP 7
100795 **/
100796function xml_parse($parser, $data, $is_final){}
100797
100798/**
100799 * Create an XML parser
100800 *
100801 * {@link xml_parser_create} creates a new XML parser and returns a
100802 * resource handle referencing it to be used by the other XML functions.
100803 *
100804 * @param string $encoding The optional {@link encoding} specifies the
100805 *   character encoding for the input/output in PHP 4. Starting from PHP
100806 *   5, the input encoding is automatically detected, so that the {@link
100807 *   encoding} parameter specifies only the output encoding. In PHP 4,
100808 *   the default output encoding is the same as the input charset. If
100809 *   empty string is passed, the parser attempts to identify which
100810 *   encoding the document is encoded in by looking at the heading 3 or 4
100811 *   bytes. In PHP 5.0.0 and 5.0.1, the default output charset is
100812 *   ISO-8859-1, while in PHP 5.0.2 and upper is UTF-8. The supported
100813 *   encodings are ISO-8859-1, UTF-8 and US-ASCII.
100814 * @return resource Returns a resource handle for the new XML parser, .
100815 * @since PHP 4, PHP 5, PHP 7
100816 **/
100817function xml_parser_create($encoding){}
100818
100819/**
100820 * Create an XML parser with namespace support
100821 *
100822 * {@link xml_parser_create_ns} creates a new XML parser with XML
100823 * namespace support and returns a resource handle referencing it to be
100824 * used by the other XML functions.
100825 *
100826 * @param string $encoding The input encoding is automatically
100827 *   detected, so that the {@link encoding} parameter specifies only the
100828 *   output encoding. In PHP 5.0.0 and 5.0.1, the default output charset
100829 *   is ISO-8859-1, while in PHP 5.0.2 and upper is UTF-8. The supported
100830 *   encodings are ISO-8859-1, UTF-8 and US-ASCII.
100831 * @param string $separator With a namespace aware parser tag
100832 *   parameters passed to the various handler functions will consist of
100833 *   namespace and tag name separated by the string specified in {@link
100834 *   separator}.
100835 * @return resource Returns a resource handle for the new XML parser, .
100836 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
100837 **/
100838function xml_parser_create_ns($encoding, $separator){}
100839
100840/**
100841 * Free an XML parser
100842 *
100843 * Frees the given XML {@link parser}.
100844 *
100845 * @param resource $parser
100846 * @return bool This function returns FALSE if {@link parser} does not
100847 *   refer to a valid parser, or else it frees the parser and returns
100848 *   TRUE.
100849 * @since PHP 4, PHP 5, PHP 7
100850 **/
100851function xml_parser_free($parser){}
100852
100853/**
100854 * Get options from an XML parser
100855 *
100856 * Gets an option value from an XML parser.
100857 *
100858 * @param resource $parser
100859 * @param int $option
100860 * @return mixed This function returns FALSE if {@link parser} does not
100861 *   refer to a valid parser or if {@link option} isn't valid (generates
100862 *   also a E_WARNING). Else the option's value is returned.
100863 * @since PHP 4, PHP 5, PHP 7
100864 **/
100865function xml_parser_get_option($parser, $option){}
100866
100867/**
100868 * Set options in an XML parser
100869 *
100870 * Sets an option in an XML parser.
100871 *
100872 * @param resource $parser A reference to the XML parser to set an
100873 *   option in.
100874 * @param int $option Which option to set. See below. The following
100875 *   options are available: XML parser options Option constant Data type
100876 *   Description XML_OPTION_CASE_FOLDING integer Controls whether
100877 *   case-folding is enabled for this XML parser. Enabled by default.
100878 *   XML_OPTION_SKIP_TAGSTART integer Specify how many characters should
100879 *   be skipped in the beginning of a tag name. XML_OPTION_SKIP_WHITE
100880 *   integer Whether to skip values consisting of whitespace characters.
100881 *   XML_OPTION_TARGET_ENCODING string Sets which target encoding to use
100882 *   in this XML parser.By default, it is set to the same as the source
100883 *   encoding used by {@link xml_parser_create}. Supported target
100884 *   encodings are ISO-8859-1, US-ASCII and UTF-8.
100885 * @param mixed $value The option's new value.
100886 * @return bool This function returns FALSE if {@link parser} does not
100887 *   refer to a valid parser, or if the option could not be set. Else the
100888 *   option is set and TRUE is returned.
100889 * @since PHP 4, PHP 5, PHP 7
100890 **/
100891function xml_parser_set_option($parser, $option, $value){}
100892
100893/**
100894 * Parse XML data into an array structure
100895 *
100896 * This function parses an XML string into 2 parallel array structures,
100897 * one ({@link index}) containing pointers to the location of the
100898 * appropriate values in the {@link values} array. These last two
100899 * parameters must be passed by reference.
100900 *
100901 * @param resource $parser A reference to the XML parser.
100902 * @param string $data A string containing the XML data.
100903 * @param array $values An array containing the values of the XML data
100904 * @param array $index An array containing pointers to the location of
100905 *   the appropriate values in the $values.
100906 * @return int {@link xml_parse_into_struct} returns 0 for failure and
100907 *   1 for success. This is not the same as FALSE and TRUE, be careful
100908 *   with operators such as ===.
100909 * @since PHP 4, PHP 5, PHP 7
100910 **/
100911function xml_parse_into_struct($parser, $data, &$values, &$index){}
100912
100913/**
100914 * Set up character data handler
100915 *
100916 * Sets the character data handler function for the XML parser {@link
100917 * parser}.
100918 *
100919 * @param resource $parser A reference to the XML parser to set up
100920 *   character data handler function.
100921 * @param callable $handler {@link handler} is a string containing the
100922 *   name of a function that must exist when {@link xml_parse} is called
100923 *   for {@link parser}. The function named by {@link handler} must
100924 *   accept two parameters: handler resource{@link parser} string{@link
100925 *   data} {@link parser} The first parameter, parser, is a reference to
100926 *   the XML parser calling the handler. {@link data} The second
100927 *   parameter, {@link data}, contains the character data as a string.
100928 *   Character data handler is called for every piece of a text in the
100929 *   XML document. It can be called multiple times inside each fragment
100930 *   (e.g. for non-ASCII strings). If a handler function is set to an
100931 *   empty string, or FALSE, the handler in question is disabled.
100932 * @return bool
100933 * @since PHP 4, PHP 5, PHP 7
100934 **/
100935function xml_set_character_data_handler($parser, $handler){}
100936
100937/**
100938 * Set up default handler
100939 *
100940 * Sets the default handler function for the XML parser {@link parser}.
100941 *
100942 * @param resource $parser A reference to the XML parser to set up
100943 *   default handler function.
100944 * @param callable $handler {@link handler} is a string containing the
100945 *   name of a function that must exist when {@link xml_parse} is called
100946 *   for {@link parser}. The function named by {@link handler} must
100947 *   accept two parameters: handler resource{@link parser} string{@link
100948 *   data} {@link parser} The first parameter, parser, is a reference to
100949 *   the XML parser calling the handler. {@link data} The second
100950 *   parameter, {@link data}, contains the character data.This may be the
100951 *   XML declaration, document type declaration, entities or other data
100952 *   for which no other handler exists. If a handler function is set to
100953 *   an empty string, or FALSE, the handler in question is disabled.
100954 * @return bool
100955 * @since PHP 4, PHP 5, PHP 7
100956 **/
100957function xml_set_default_handler($parser, $handler){}
100958
100959/**
100960 * Set up start and end element handlers
100961 *
100962 * Sets the element handler functions for the XML {@link parser}. {@link
100963 * start_element_handler} and {@link end_element_handler} are strings
100964 * containing the names of functions that must exist when {@link
100965 * xml_parse} is called for {@link parser}.
100966 *
100967 * @param resource $parser A reference to the XML parser to set up
100968 *   start and end element handler functions.
100969 * @param callable $start_element_handler The function named by {@link
100970 *   start_element_handler} must accept three parameters:
100971 *   start_element_handler resource{@link parser} string{@link name}
100972 *   array{@link attribs} {@link parser} The first parameter, parser, is
100973 *   a reference to the XML parser calling the handler. {@link name} The
100974 *   second parameter, {@link name}, contains the name of the element for
100975 *   which this handler is called.If case-folding is in effect for this
100976 *   parser, the element name will be in uppercase letters. {@link
100977 *   attribs} The third parameter, {@link attribs}, contains an
100978 *   associative array with the element's attributes (if any).The keys of
100979 *   this array are the attribute names, the values are the attribute
100980 *   values.Attribute names are case-folded on the same criteria as
100981 *   element names.Attribute values are not case-folded. The original
100982 *   order of the attributes can be retrieved by walking through {@link
100983 *   attribs} the normal way, using {@link each}.The first key in the
100984 *   array was the first attribute, and so on.
100985 * @param callable $end_element_handler
100986 * @return bool
100987 * @since PHP 4, PHP 5, PHP 7
100988 **/
100989function xml_set_element_handler($parser, $start_element_handler, $end_element_handler){}
100990
100991/**
100992 * Set up end namespace declaration handler
100993 *
100994 * Set a handler to be called when leaving the scope of a namespace
100995 * declaration. This will be called, for each namespace declaration,
100996 * after the handler for the end tag of the element in which the
100997 * namespace was declared.
100998 *
100999 * @param resource $parser A reference to the XML parser.
101000 * @param callable $handler {@link handler} is a string containing the
101001 *   name of a function that must exist when {@link xml_parse} is called
101002 *   for {@link parser}. The function named by {@link handler} must
101003 *   accept two parameters, and should return an integer value. If the
101004 *   value returned from the handler is FALSE (which it will be if no
101005 *   value is returned), the XML parser will stop parsing and {@link
101006 *   xml_get_error_code} will return XML_ERROR_EXTERNAL_ENTITY_HANDLING.
101007 *   handler resource{@link parser} string{@link prefix} {@link parser}
101008 *   The first parameter, parser, is a reference to the XML parser
101009 *   calling the handler. {@link prefix} The prefix is a string used to
101010 *   reference the namespace within an XML object. If a handler function
101011 *   is set to an empty string, or FALSE, the handler in question is
101012 *   disabled.
101013 * @return bool
101014 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
101015 **/
101016function xml_set_end_namespace_decl_handler($parser, $handler){}
101017
101018/**
101019 * Set up external entity reference handler
101020 *
101021 * Sets the external entity reference handler function for the XML parser
101022 * {@link parser}.
101023 *
101024 * @param resource $parser A reference to the XML parser to set up
101025 *   external entity reference handler function.
101026 * @param callable $handler {@link handler} is a string containing the
101027 *   name of a function that must exist when {@link xml_parse} is called
101028 *   for {@link parser}. The function named by {@link handler} must
101029 *   accept five parameters, and should return an integer value.If the
101030 *   value returned from the handler is FALSE (which it will be if no
101031 *   value is returned), the XML parser will stop parsing and {@link
101032 *   xml_get_error_code} will return XML_ERROR_EXTERNAL_ENTITY_HANDLING.
101033 *   handler resource{@link parser} string{@link open_entity_names}
101034 *   string{@link base} string{@link system_id} string{@link public_id}
101035 *   {@link parser} The first parameter, parser, is a reference to the
101036 *   XML parser calling the handler. {@link open_entity_names} The second
101037 *   parameter, {@link open_entity_names}, is a space-separated list of
101038 *   the names of the entities that are open for the parse of this entity
101039 *   (including the name of the referenced entity). {@link base} This is
101040 *   the base for resolving the system identifier ({@link system_id}) of
101041 *   the external entity.Currently this parameter will always be set to
101042 *   an empty string. {@link system_id} The fourth parameter, {@link
101043 *   system_id}, is the system identifier as specified in the entity
101044 *   declaration. {@link public_id} The fifth parameter, {@link
101045 *   public_id}, is the public identifier as specified in the entity
101046 *   declaration, or an empty string if none was specified; the
101047 *   whitespace in the public identifier will have been normalized as
101048 *   required by the XML spec. If a handler function is set to an empty
101049 *   string, or FALSE, the handler in question is disabled.
101050 * @return bool
101051 * @since PHP 4, PHP 5, PHP 7
101052 **/
101053function xml_set_external_entity_ref_handler($parser, $handler){}
101054
101055/**
101056 * Set up notation declaration handler
101057 *
101058 * Sets the notation declaration handler function for the XML parser
101059 * {@link parser}.
101060 *
101061 * A notation declaration is part of the document's DTD and has the
101062 * following format:
101063 *
101064 * <!NOTATION <parameter>name</parameter> {
101065 * <parameter>systemId</parameter> | <parameter>publicId</parameter>?>
101066 *
101067 * See section 4.7 of the XML 1.0 spec for the definition of notation
101068 * declarations.
101069 *
101070 * @param resource $parser A reference to the XML parser to set up
101071 *   notation declaration handler function.
101072 * @param callable $handler {@link handler} is a string containing the
101073 *   name of a function that must exist when {@link xml_parse} is called
101074 *   for {@link parser}. The function named by {@link handler} must
101075 *   accept five parameters: handler resource{@link parser} string{@link
101076 *   notation_name} string{@link base} string{@link system_id}
101077 *   string{@link public_id} {@link parser} The first parameter, parser,
101078 *   is a reference to the XML parser calling the handler. {@link
101079 *   notation_name} This is the notation's {@link name}, as per the
101080 *   notation format described above. {@link base} This is the base for
101081 *   resolving the system identifier ({@link system_id}) of the notation
101082 *   declaration. Currently this parameter will always be set to an empty
101083 *   string. {@link system_id} System identifier of the external notation
101084 *   declaration. {@link public_id} Public identifier of the external
101085 *   notation declaration. If a handler function is set to an empty
101086 *   string, or FALSE, the handler in question is disabled.
101087 * @return bool
101088 * @since PHP 4, PHP 5, PHP 7
101089 **/
101090function xml_set_notation_decl_handler($parser, $handler){}
101091
101092/**
101093 * Use XML Parser within an object
101094 *
101095 * This function allows to use {@link parser} inside {@link object}. All
101096 * callback functions could be set with {@link xml_set_element_handler}
101097 * etc and assumed to be methods of {@link object}.
101098 *
101099 * @param resource $parser A reference to the XML parser to use inside
101100 *   the object.
101101 * @param object $object The object where to use the XML parser.
101102 * @return bool
101103 * @since PHP 4, PHP 5, PHP 7
101104 **/
101105function xml_set_object($parser, &$object){}
101106
101107/**
101108 * Set up processing instruction (PI) handler
101109 *
101110 * Sets the processing instruction (PI) handler function for the XML
101111 * parser {@link parser}.
101112 *
101113 * A processing instruction has the following format: <?target data?> You
101114 * can put PHP code into such a tag, but be aware of one limitation: in
101115 * an XML PI, the PI end tag (?>) can not be quoted, so this character
101116 * sequence should not appear in the PHP code you embed with PIs in XML
101117 * documents.If it does, the rest of the PHP code, as well as the "real"
101118 * PI end tag, will be treated as character data.
101119 *
101120 * @param resource $parser A reference to the XML parser to set up
101121 *   processing instruction (PI) handler function.
101122 * @param callable $handler {@link handler} is a string containing the
101123 *   name of a function that must exist when {@link xml_parse} is called
101124 *   for {@link parser}. The function named by {@link handler} must
101125 *   accept three parameters: handler resource{@link parser} string{@link
101126 *   target} string{@link data} {@link parser} The first parameter,
101127 *   parser, is a reference to the XML parser calling the handler. {@link
101128 *   target} The second parameter, {@link target}, contains the PI
101129 *   target. {@link data} The third parameter, {@link data}, contains the
101130 *   PI data. If a handler function is set to an empty string, or FALSE,
101131 *   the handler in question is disabled.
101132 * @return bool
101133 * @since PHP 4, PHP 5, PHP 7
101134 **/
101135function xml_set_processing_instruction_handler($parser, $handler){}
101136
101137/**
101138 * Set up start namespace declaration handler
101139 *
101140 * Set a handler to be called when a namespace is declared. Namespace
101141 * declarations occur inside start tags. But the namespace declaration
101142 * start handler is called before the start tag handler for each
101143 * namespace declared in that start tag.
101144 *
101145 * @param resource $parser A reference to the XML parser.
101146 * @param callable $handler {@link handler} is a string containing the
101147 *   name of a function that must exist when {@link xml_parse} is called
101148 *   for {@link parser}. The function named by {@link handler} must
101149 *   accept three parameters, and should return an integer value. If the
101150 *   value returned from the handler is FALSE (which it will be if no
101151 *   value is returned), the XML parser will stop parsing and {@link
101152 *   xml_get_error_code} will return XML_ERROR_EXTERNAL_ENTITY_HANDLING.
101153 *   handler resource{@link parser} string{@link prefix} string{@link
101154 *   uri} {@link parser} The first parameter, parser, is a reference to
101155 *   the XML parser calling the handler. {@link prefix} The prefix is a
101156 *   string used to reference the namespace within an XML object. {@link
101157 *   uri} Uniform Resource Identifier (URI) of namespace. If a handler
101158 *   function is set to an empty string, or FALSE, the handler in
101159 *   question is disabled.
101160 * @return bool
101161 * @since PHP 4 >= 4.0.5, PHP 5, PHP 7
101162 **/
101163function xml_set_start_namespace_decl_handler($parser, $handler){}
101164
101165/**
101166 * Set up unparsed entity declaration handler
101167 *
101168 * Sets the unparsed entity declaration handler function for the XML
101169 * parser {@link parser}.
101170 *
101171 * The {@link handler} will be called if the XML parser encounters an
101172 * external entity declaration with an NDATA declaration, like the
101173 * following:
101174 *
101175 * <!ENTITY <parameter>name</parameter> {<parameter>publicId</parameter>
101176 * | <parameter>systemId</parameter>} NDATA
101177 * <parameter>notationName</parameter>
101178 *
101179 * See section 4.2.2 of the XML 1.0 spec for the definition of notation
101180 * declared external entities.
101181 *
101182 * @param resource $parser A reference to the XML parser to set up
101183 *   unparsed entity declaration handler function.
101184 * @param callable $handler {@link handler} is a string containing the
101185 *   name of a function that must exist when {@link xml_parse} is called
101186 *   for {@link parser}. The function named by {@link handler} must
101187 *   accept six parameters: handler resource{@link parser} string{@link
101188 *   entity_name} string{@link base} string{@link system_id} string{@link
101189 *   public_id} string{@link notation_name} {@link parser} The first
101190 *   parameter, parser, is a reference to the XML parser calling the
101191 *   handler. {@link entity_name} The name of the entity that is about to
101192 *   be defined. {@link base} This is the base for resolving the system
101193 *   identifier ({@link systemId}) of the external entity.Currently this
101194 *   parameter will always be set to an empty string. {@link system_id}
101195 *   System identifier for the external entity. {@link public_id} Public
101196 *   identifier for the external entity. {@link notation_name} Name of
101197 *   the notation of this entity (see {@link
101198 *   xml_set_notation_decl_handler}). If a handler function is set to an
101199 *   empty string, or FALSE, the handler in question is disabled.
101200 * @return bool
101201 * @since PHP 4, PHP 5, PHP 7
101202 **/
101203function xml_set_unparsed_entity_decl_handler($parser, $handler){}
101204
101205/**
101206 * Returns the YAML representation of a value
101207 *
101208 * Generate a YAML representation of the provided {@link data}.
101209 *
101210 * @param mixed $data The {@link data} being encoded. Can be any type
101211 *   except a resource.
101212 * @param int $encoding Output character encoding chosen from
101213 *   YAML_ANY_ENCODING, YAML_UTF8_ENCODING, YAML_UTF16LE_ENCODING,
101214 *   YAML_UTF16BE_ENCODING.
101215 * @param int $linebreak Output linebreak style chosen from
101216 *   YAML_ANY_BREAK, YAML_CR_BREAK, YAML_LN_BREAK, YAML_CRLN_BREAK.
101217 * @param array $callbacks Content handlers for emitting YAML nodes.
101218 *   Associative array of classname => callable mappings. See emit
101219 *   callbacks for more details.
101220 * @return string Returns a YAML encoded string on success.
101221 * @since PECL yaml >= 0.5.0
101222 **/
101223function yaml_emit($data, $encoding, $linebreak, $callbacks){}
101224
101225/**
101226 * Send the YAML representation of a value to a file
101227 *
101228 * Generate a YAML representation of the provided {@link data} in the
101229 * {@link filename}.
101230 *
101231 * @param string $filename Path to the file.
101232 * @param mixed $data The {@link data} being encoded. Can be any type
101233 *   except a resource.
101234 * @param int $encoding Output character encoding chosen from
101235 *   YAML_ANY_ENCODING, YAML_UTF8_ENCODING, YAML_UTF16LE_ENCODING,
101236 *   YAML_UTF16BE_ENCODING.
101237 * @param int $linebreak Output linebreak style chosen from
101238 *   YAML_ANY_BREAK, YAML_CR_BREAK, YAML_LN_BREAK, YAML_CRLN_BREAK.
101239 * @param array $callbacks Content handlers for emitting YAML nodes.
101240 *   Associative array of classname => callable mappings. See emit
101241 *   callbacks for more details.
101242 * @return bool Returns TRUE on success.
101243 * @since PECL yaml >= 0.5.0
101244 **/
101245function yaml_emit_file($filename, $data, $encoding, $linebreak, $callbacks){}
101246
101247/**
101248 * Parse a YAML stream
101249 *
101250 * Convert all or part of a YAML document stream to a PHP variable.
101251 *
101252 * @param string $input The string to parse as a YAML document stream.
101253 * @param int $pos Document to extract from stream (-1 for all
101254 *   documents, 0 for first document, ...).
101255 * @param int $ndocs If {@link ndocs} is provided, then it is filled
101256 *   with the number of documents found in stream.
101257 * @param array $callbacks Content handlers for YAML nodes. Associative
101258 *   array of YAML tag => callable mappings. See parse callbacks for more
101259 *   details.
101260 * @return mixed Returns the value encoded in {@link input} in
101261 *   appropriate PHP type. If {@link pos} is -1 an array will be returned
101262 *   with one entry for each document found in the stream.
101263 * @since PECL yaml >= 0.4.0
101264 **/
101265function yaml_parse($input, $pos, &$ndocs, $callbacks){}
101266
101267/**
101268 * Parse a YAML stream from a file
101269 *
101270 * Convert all or part of a YAML document stream read from a file to a
101271 * PHP variable.
101272 *
101273 * @param string $filename Path to the file.
101274 * @param int $pos Document to extract from stream (-1 for all
101275 *   documents, 0 for first document, ...).
101276 * @param int $ndocs If {@link ndocs} is provided, then it is filled
101277 *   with the number of documents found in stream.
101278 * @param array $callbacks Content handlers for YAML nodes. Associative
101279 *   array of YAML tag => callable mappings. See parse callbacks for more
101280 *   details.
101281 * @return mixed Returns the value encoded in {@link input} in
101282 *   appropriate PHP type. If {@link pos} is -1 an array will be returned
101283 *   with one entry for each document found in the stream.
101284 * @since PECL yaml >= 0.4.0
101285 **/
101286function yaml_parse_file($filename, $pos, &$ndocs, $callbacks){}
101287
101288/**
101289 * Parse a Yaml stream from a URL
101290 *
101291 * Convert all or part of a YAML document stream read from a URL to a PHP
101292 * variable.
101293 *
101294 * @param string $url {@link url} should be of the form "scheme://...".
101295 *   PHP will search for a protocol handler (also known as a wrapper) for
101296 *   that scheme. If no wrappers for that protocol are registered, PHP
101297 *   will emit a notice to help you track potential problems in your
101298 *   script and then continue as though filename specifies a regular
101299 *   file.
101300 * @param int $pos Document to extract from stream (-1 for all
101301 *   documents, 0 for first document, ...).
101302 * @param int $ndocs If {@link ndocs} is provided, then it is filled
101303 *   with the number of documents found in stream.
101304 * @param array $callbacks Content handlers for YAML nodes. Associative
101305 *   array of YAML tag => callable mappings. See parse callbacks for more
101306 * @return mixed Returns the value encoded in {@link input} in
101307 *   appropriate PHP type. If {@link pos} is -1 an array will be returned
101308 *   with one entry for each document found in the stream.
101309 * @since PECL yaml >= 0.4.0
101310 **/
101311function yaml_parse_url($url, $pos, &$ndocs, $callbacks){}
101312
101313/**
101314 * Returns additional error information
101315 *
101316 * Returns additional error information for the last request on the
101317 * server.
101318 *
101319 * With some servers, this function may return the same string as {@link
101320 * yaz_error}.
101321 *
101322 * @param resource $id The connection resource returned by {@link
101323 *   yaz_connect}.
101324 * @return string A string containing additional error information or
101325 *   an empty string if the last operation was successful or if no
101326 *   additional information was provided by the server.
101327 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
101328 **/
101329function yaz_addinfo($id){}
101330
101331/**
101332 * Configure CCL parser
101333 *
101334 * This function configures the CCL query parser for a server with
101335 * definitions of access points (CCL qualifiers) and their mapping to
101336 * RPN.
101337 *
101338 * To map a specific CCL query to RPN afterwards call the {@link
101339 * yaz_ccl_parse} function.
101340 *
101341 * @param resource $id The connection resource returned by {@link
101342 *   yaz_connect}.
101343 * @param array $config An array of configuration. Each key of the
101344 *   array is the name of a CCL field and the corresponding value holds a
101345 *   string that specifies a mapping to RPN. The mapping is a sequence of
101346 *   attribute-type, attribute-value pairs. Attribute-type and
101347 *   attribute-value is separated by an equal sign (=). Each pair is
101348 *   separated by white space. Additional information can be found on the
101349 *   CCL page.
101350 * @return void
101351 * @since PHP 4 >= 4.0.5, PECL yaz >= 0.9.0
101352 **/
101353function yaz_ccl_conf($id, $config){}
101354
101355/**
101356 * Invoke CCL Parser
101357 *
101358 * This function invokes a CCL parser. It converts a given CCL FIND query
101359 * to an RPN query which may be passed to the {@link yaz_search} function
101360 * to perform a search.
101361 *
101362 * To define a set of valid CCL fields call {@link yaz_ccl_conf} prior to
101363 * this function.
101364 *
101365 * @param resource $id The connection resource returned by {@link
101366 *   yaz_connect}.
101367 * @param string $query The CCL FIND query.
101368 * @param array $result If the function was executed successfully, this
101369 *   will be an array containing the valid RPN query under the key rpn.
101370 *   Upon failure, three indexes are set in this array to indicate the
101371 *   cause of failure: errorcode - the CCL error code (integer)
101372 *   errorstring - the CCL error string errorpos - approximate position
101373 *   in query of failure (integer is character position)
101374 * @return bool
101375 * @since PHP 4 >= 4.0.5, PECL yaz >= 0.9.0
101376 **/
101377function yaz_ccl_parse($id, $query, &$result){}
101378
101379/**
101380 * Close YAZ connection
101381 *
101382 * Closes the connection given by parameter {@link id}.
101383 *
101384 * @param resource $id The connection resource returned by {@link
101385 *   yaz_connect}.
101386 * @return bool
101387 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
101388 **/
101389function yaz_close($id){}
101390
101391/**
101392 * Prepares for a connection to a Z39.50 server
101393 *
101394 * This function returns a connection resource on success, zero on
101395 * failure.
101396 *
101397 * {@link yaz_connect} prepares for a connection to a Z39.50 server. This
101398 * function is non-blocking and does not attempt to establish a
101399 * connection - it merely prepares a connect to be performed later when
101400 * {@link yaz_wait} is called.
101401 *
101402 * @param string $zurl A string that takes the form
101403 *   host[:port][/database]. If port is omitted, port 210 is used. If
101404 *   database is omitted Default is used.
101405 * @param mixed $options If given as a string, it is treated as the
101406 *   Z39.50 V2 authentication string (OpenAuth). If given as an array,
101407 *   the contents of the array serves as options. user Username for
101408 *   authentication. group Group for authentication. password Password
101409 *   for authentication. cookie Cookie for session (YAZ proxy). proxy
101410 *   Proxy for connection (YAZ proxy). persistent A boolean. If TRUE the
101411 *   connection is persistent; If FALSE the connection is not persistent.
101412 *   By default connections are persistent. If you open a persistent
101413 *   connection, you won't be able to close it later with {@link
101414 *   yaz_close}. piggyback A boolean. If TRUE piggyback is enabled for
101415 *   searches; If FALSE piggyback is disabled. By default piggyback is
101416 *   enabled. Enabling piggyback is more efficient and usually saves a
101417 *   network-round-trip for first time fetches of records. However, a few
101418 *   Z39.50 servers do not support piggyback or they ignore element set
101419 *   names. For those, piggyback should be disabled. charset A string
101420 *   that specifies character set to be used in Z39.50 language and
101421 *   character set negotiation. Use strings such as: ISO-8859-1, UTF-8,
101422 *   UTF-16. Most Z39.50 servers do not support this feature (and thus,
101423 *   this is ignored). Many servers use the ISO-8859-1 encoding for
101424 *   queries and messages. MARC21/USMARC records are not affected by this
101425 *   setting.
101426 *
101427 *   preferredMessageSize An integer that specifies the maximum byte size
101428 *   of all records to be returned by a target during retrieval. See the
101429 *   Z39.50 standard for more information. This option is supported in
101430 *   PECL YAZ 1.0.5 or later.
101431 *
101432 *   maximumRecordSize An integer that specifies the maximum byte size of
101433 *   a single record to be returned by a target during retrieval. This
101434 *   entity is referred to as Exceptional-record-size in the Z39.50
101435 *   standard. This option is supported in PECL YAZ 1.0.5 or later.
101436 * @return mixed A connection resource on success, FALSE on error.
101437 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
101438 **/
101439function yaz_connect($zurl, $options){}
101440
101441/**
101442 * Specifies the databases within a session
101443 *
101444 * This function allows you to change databases within a session by
101445 * specifying one or more databases to be used in search, retrieval, etc.
101446 * - overriding databases specified in call to {@link yaz_connect}.
101447 *
101448 * @param resource $id The connection resource returned by {@link
101449 *   yaz_connect}.
101450 * @param string $databases A string containing one or more databases.
101451 *   Multiple databases are separated by a plus sign +.
101452 * @return bool
101453 * @since PHP 4 >= 4.0.6, PECL yaz >= 0.9.0
101454 **/
101455function yaz_database($id, $databases){}
101456
101457/**
101458 * Specifies Element-Set Name for retrieval
101459 *
101460 * This function sets the element set name for retrieval.
101461 *
101462 * Call this function before {@link yaz_search} or {@link yaz_present} to
101463 * specify the element set name for records to be retrieved.
101464 *
101465 * @param resource $id The connection resource returned by {@link
101466 *   yaz_connect}.
101467 * @param string $elementset Most servers support F (for full records)
101468 *   and B (for brief records).
101469 * @return bool
101470 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
101471 **/
101472function yaz_element($id, $elementset){}
101473
101474/**
101475 * Returns error number
101476 *
101477 * Returns an error number for the server (last request) identified by
101478 * {@link id}.
101479 *
101480 * {@link yaz_errno} should be called after network activity for each
101481 * server - (after {@link yaz_wait} returns) to determine the success or
101482 * failure of the last operation (e.g. search).
101483 *
101484 * @param resource $id The connection resource returned by {@link
101485 *   yaz_connect}.
101486 * @return int Returns an error code. The error code is either a Z39.50
101487 *   diagnostic code (usually a Bib-1 diagnostic) or a client side error
101488 *   code which is generated by PHP/YAZ itself, such as "Connect failed",
101489 *   "Init Rejected", etc.
101490 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
101491 **/
101492function yaz_errno($id){}
101493
101494/**
101495 * Returns error description
101496 *
101497 * {@link yaz_error} returns an English text message corresponding to the
101498 * last error number as returned by {@link yaz_errno}.
101499 *
101500 * @param resource $id The connection resource returned by {@link
101501 *   yaz_connect}.
101502 * @return string Returns an error text message for server (last
101503 *   request), identified by parameter {@link id}. An empty string is
101504 *   returned if the last operation was successful.
101505 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
101506 **/
101507function yaz_error($id){}
101508
101509/**
101510 * Prepares for an Extended Service Request
101511 *
101512 * This function prepares for an Extended Service Request. Extended
101513 * Services is family of various Z39.50 facilities, such as Record
101514 * Update, Item Order, Database administration etc.
101515 *
101516 * The {@link yaz_es} creates an Extended Service Request packages and
101517 * puts it into a queue of operations. Use {@link yaz_wait} to send the
101518 * request(s) to the server. After completion of {@link yaz_wait} the
101519 * result of the Extended Service operation should be expected with a
101520 * call to {@link yaz_es_result}.
101521 *
101522 * @param resource $id The connection resource returned by {@link
101523 *   yaz_connect}.
101524 * @param string $type A string which represents the type of the
101525 *   Extended Service: itemorder (Item Order), create (Create Database),
101526 *   drop (Drop Database), commit (Commit Operation), update (Update
101527 *   Record), xmlupdate (XML Update). Each type is specified in the
101528 *   following section.
101529 * @param array $args An array with extended service options plus
101530 *   package specific options. The options are identical to those offered
101531 *   in the C API of ZOOM C. Refer to the ZOOM Extended Services.
101532 * @return void
101533 * @since PECL yaz >= 0.9.0
101534 **/
101535function yaz_es($id, $type, $args){}
101536
101537/**
101538 * Inspects Extended Services Result
101539 *
101540 * This function inspects the last returned Extended Service result from
101541 * a server. An Extended Service is initiated by either {@link
101542 * yaz_item_order} or {@link yaz_es}.
101543 *
101544 * @param resource $id The connection resource returned by {@link
101545 *   yaz_connect}.
101546 * @return array Returns array with element targetReference for the
101547 *   reference for the extended service operation (generated and returned
101548 *   from the server).
101549 * @since PHP 4 >= 4.2.0, PECL yaz >= 0.9.0
101550 **/
101551function yaz_es_result($id){}
101552
101553/**
101554 * Returns value of option for connection
101555 *
101556 * Returns the value of the option specified with {@link name}.
101557 *
101558 * @param resource $id The connection resource returned by {@link
101559 *   yaz_connect}.
101560 * @param string $name The option name.
101561 * @return string Returns the value of the specified option or an empty
101562 *   string if the option wasn't set.
101563 * @since PECL yaz >= 0.9.0
101564 **/
101565function yaz_get_option($id, $name){}
101566
101567/**
101568 * Returns number of hits for last search
101569 *
101570 * {@link yaz_hits} returns the number of hits for the last search.
101571 *
101572 * @param resource $id The connection resource returned by {@link
101573 *   yaz_connect}.
101574 * @param array $searchresult Result array for detailed search result
101575 *   information.
101576 * @return int Returns the number of hits for the last search or 0 if
101577 *   no search was performed.
101578 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
101579 **/
101580function yaz_hits($id, &$searchresult){}
101581
101582/**
101583 * Prepares for Z39.50 Item Order with an ILL-Request package
101584 *
101585 * This function prepares for an Extended Services request using the
101586 * Profile for the Use of Z39.50 Item Order Extended Service to Transport
101587 * ILL (Profile/1). See this and the specification.
101588 *
101589 * @param resource $id The connection resource returned by {@link
101590 *   yaz_connect}.
101591 * @param array $args Must be an associative array with information
101592 *   about the Item Order request to be sent. The key of the hash is the
101593 *   name of the corresponding ASN.1 tag path. For example, the ISBN
101594 *   below the Item-ID has the key item-id,ISBN. The ILL-Request
101595 *   parameters are: There are also a few parameters that are part of the
101596 *   Extended Services Request package and the ItemOrder package:
101597 * @return void
101598 * @since PHP 4 >= 4.0.5, PECL yaz >= 0.9.0
101599 **/
101600function yaz_itemorder($id, $args){}
101601
101602/**
101603 * Prepares for retrieval (Z39.50 present)
101604 *
101605 * This function prepares for retrieval of records after a successful
101606 * search.
101607 *
101608 * The {@link yaz_range} function should be called prior to this function
101609 * to specify the range of records to be retrieved.
101610 *
101611 * @param resource $id The connection resource returned by {@link
101612 *   yaz_connect}.
101613 * @return bool
101614 * @since PHP 4 >= 4.0.5, PECL yaz >= 0.9.0
101615 **/
101616function yaz_present($id){}
101617
101618/**
101619 * Specifies a range of records to retrieve
101620 *
101621 * Specifies a range of records to retrieve.
101622 *
101623 * This function should be called before {@link yaz_search} or {@link
101624 * yaz_present}.
101625 *
101626 * @param resource $id The connection resource returned by {@link
101627 *   yaz_connect}.
101628 * @param int $start Specifies the position of the first record to be
101629 *   retrieved. The records numbers goes from 1 to {@link yaz_hits}.
101630 * @param int $number Specifies the number of records to be retrieved.
101631 * @return void
101632 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
101633 **/
101634function yaz_range($id, $start, $number){}
101635
101636/**
101637 * Returns a record
101638 *
101639 * The {@link yaz_record} function inspects a record in the current
101640 * result set at the position specified by parameter {@link pos}.
101641 *
101642 * @param resource $id The connection resource returned by {@link
101643 *   yaz_connect}.
101644 * @param int $pos The record position. Records positions in a result
101645 *   set are numbered 1, 2, ... $hits where $hits is the count returned
101646 *   by {@link yaz_hits}.
101647 * @param string $type The {@link type} specifies the form of the
101648 *   returned record. Besides conversion of the transfer record to a
101649 *   string/array, PHP/YAZ it is also possible to perform a character set
101650 *   conversion of the record. Especially for USMARC/MARC21 that is
101651 *   recommended since these are typically returned in the character set
101652 *   MARC-8 that is not supported by browsers, etc. To specify a
101653 *   conversion, add ; charset=from, to where from is the original
101654 *   character set of the record and to is the resulting character set
101655 *   (as seen by PHP).
101656 * @return string Returns the record at position {@link pos} or an
101657 *   empty string if no record exists at the given position.
101658 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
101659 **/
101660function yaz_record($id, $pos, $type){}
101661
101662/**
101663 * Prepares for a scan
101664 *
101665 * This function prepares for a Z39.50 Scan Request on the specified
101666 * connection.
101667 *
101668 * To actually transfer the Scan Request to the server and receive the
101669 * Scan Response, {@link yaz_wait} must be called. Upon completion of
101670 * {@link yaz_wait} call {@link yaz_error} and {@link yaz_scan_result} to
101671 * handle the response.
101672 *
101673 * @param resource $id The connection resource returned by {@link
101674 *   yaz_connect}.
101675 * @param string $type Currently only type rpn is supported.
101676 * @param string $startterm Starting term point for the scan. The form
101677 *   in which the starting term is specified is given by parameter {@link
101678 *   type}. The syntax this parameter is similar to the RPN query as
101679 *   described in {@link yaz_search}. It consists of zero or more
101680 *   @attr-operator specifications, then followed by exactly one token.
101681 * @param array $flags This optional parameter specifies additional
101682 *   information to control the behaviour of the scan request. Three
101683 *   indexes are currently read from the flags array: number (number of
101684 *   terms requested), position (preferred position of term) and stepSize
101685 *   (preferred step size).
101686 * @return void
101687 * @since PHP 4 >= 4.0.5, PECL yaz >= 0.9.0
101688 **/
101689function yaz_scan($id, $type, $startterm, $flags){}
101690
101691/**
101692 * Returns Scan Response result
101693 *
101694 * {@link yaz_scan_result} returns terms and associated information as
101695 * received from the server in the last performed {@link yaz_scan}.
101696 *
101697 * @param resource $id The connection resource returned by {@link
101698 *   yaz_connect}.
101699 * @param array $result If given, this array will be modified to hold
101700 *   additional information taken from the Scan Response: number - Number
101701 *   of entries returned stepsize - Step size position - Position of term
101702 *   status - Scan status
101703 * @return array Returns an array (0..n-1) where n is the number of
101704 *   terms returned. Each value is a pair where the first item is the
101705 *   term, and the second item is the result-count.
101706 * @since PHP 4 >= 4.0.5, PECL yaz >= 0.9.0
101707 **/
101708function yaz_scan_result($id, &$result){}
101709
101710/**
101711 * Specifies schema for retrieval
101712 *
101713 * {@link yaz_schema} specifies the schema for retrieval.
101714 *
101715 * This function should be called before {@link yaz_search} or {@link
101716 * yaz_present}.
101717 *
101718 * @param resource $id The connection resource returned by {@link
101719 *   yaz_connect}.
101720 * @param string $schema Must be specified as an OID (Object
101721 *   Identifier) in a raw dot-notation (like 1.2.840.10003.13.4) or as
101722 *   one of the known registered schemas: GILS-schema, Holdings, Zthes,
101723 *   ...
101724 * @return void
101725 * @since PHP 4 >= 4.2.0, PECL yaz >= 0.9.0
101726 **/
101727function yaz_schema($id, $schema){}
101728
101729/**
101730 * Prepares for a search
101731 *
101732 * {@link yaz_search} prepares for a search on the given connection.
101733 *
101734 * Like {@link yaz_connect} this function is non-blocking and only
101735 * prepares for a search to be executed later when {@link yaz_wait} is
101736 * called.
101737 *
101738 * @param resource $id The connection resource returned by {@link
101739 *   yaz_connect}.
101740 * @param string $type This parameter represents the query type - only
101741 *   "rpn" is supported now in which case the third argument specifies a
101742 *   Type-1 query in prefix query notation.
101743 * @param string $query The RPN query is a textual representation of
101744 *   the Type-1 query as defined by the Z39.50 standard. However, in the
101745 *   text representation as used by YAZ a prefix notation is used, that
101746 *   is the operator precedes the operands. The query string is a
101747 *   sequence of tokens where white space is ignored unless surrounded by
101748 *   double quotes. Tokens beginning with an at-character (@) are
101749 *   considered operators, otherwise they are treated as search terms.
101750 *   You can find information about attributes at the Z39.50 Maintenance
101751 *   Agency site.
101752 * @return bool
101753 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
101754 **/
101755function yaz_search($id, $type, $query){}
101756
101757/**
101758 * Sets one or more options for connection
101759 *
101760 * Sets one or more options on the given connection.
101761 *
101762 * @param resource $id The connection resource returned by {@link
101763 *   yaz_connect}.
101764 * @param string $name May be either a string or an array. If given as
101765 *   a string, this will be the name of the option to set. You'll need to
101766 *   give it's {@link value}. If given as an array, this will be an
101767 *   associative array (option name => option value).
101768 * @param string $value The new value of the option. Use this only if
101769 *   the previous argument is a string.
101770 * @return void
101771 * @since PECL yaz >= 0.9.0
101772 **/
101773function yaz_set_option($id, $name, $value){}
101774
101775/**
101776 * Sets sorting criteria
101777 *
101778 * This function sets sorting criteria and enables Z39.50 Sort.
101779 *
101780 * Call this function before {@link yaz_search}. Using this function
101781 * alone does not have any effect. When used in conjunction with {@link
101782 * yaz_search}, a Z39.50 Sort will be sent after a search response has
101783 * been received and before any records are retrieved with Z39.50 Present
101784 * ({@link yaz_present}.
101785 *
101786 * @param resource $id The connection resource returned by {@link
101787 *   yaz_connect}.
101788 * @param string $criteria A string that takes the form field1 flags1
101789 *   field2 flags2 where field1 specifies the primary attributes for
101790 *   sort, field2 seconds, etc.. The field specifies either a numerical
101791 *   attribute combinations consisting of type=value pairs separated by
101792 *   comma (e.g. 1=4,2=1) ; or the field may specify a plain string
101793 *   criteria (e.g. title. The flags is a sequence of the following
101794 *   characters which may not be separated by any white space.
101795 *
101796 *   Sort Flags a Sort ascending d Sort descending i Case insensitive
101797 *   sorting s Case sensitive sorting
101798 * @return void
101799 * @since PHP 4 >= 4.0.7, PECL yaz >= 0.9.0
101800 **/
101801function yaz_sort($id, $criteria){}
101802
101803/**
101804 * Specifies the preferred record syntax for retrieval
101805 *
101806 * {@link yaz_syntax} specifies the preferred record syntax for retrieval
101807 *
101808 * This function should be called before {@link yaz_search} or {@link
101809 * yaz_present}.
101810 *
101811 * @param resource $id The connection resource returned by {@link
101812 *   yaz_connect}.
101813 * @param string $syntax The syntax must be specified as an OID (Object
101814 *   Identifier) in a raw dot-notation (like 1.2.840.10003.5.10) or as
101815 *   one of the known registered record syntaxes (sutrs, usmarc, grs1,
101816 *   xml, etc.).
101817 * @return void
101818 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
101819 **/
101820function yaz_syntax($id, $syntax){}
101821
101822/**
101823 * Wait for Z39.50 requests to complete
101824 *
101825 * This function carries out networked (blocked) activity for outstanding
101826 * requests which have been prepared by the functions {@link
101827 * yaz_connect}, {@link yaz_search}, {@link yaz_present}, {@link
101828 * yaz_scan} and {@link yaz_itemorder}.
101829 *
101830 * {@link yaz_wait} returns when all servers have either completed all
101831 * requests or aborted (in case of errors).
101832 *
101833 * @param array $options An associative array of options: timeout Sets
101834 *   timeout in seconds. If a server has not responded within the timeout
101835 *   it is considered dead and {@link yaz_wait} returns. The default
101836 *   value for timeout is 15 seconds. event A boolean.
101837 * @return mixed In event mode, returns resource .
101838 * @since PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
101839 **/
101840function yaz_wait(&$options){}
101841
101842/**
101843 * Traverse the map and call a function on each entry
101844 *
101845 * @param string $domain The NIS domain name.
101846 * @param string $map The NIS map.
101847 * @param string $callback
101848 * @return void
101849 * @since PHP 4 >= 4.0.6, PHP 5 < 5.1.0
101850 **/
101851function yp_all($domain, $map, $callback){}
101852
101853/**
101854 * Return an array containing the entire map
101855 *
101856 * Returns all map entries.
101857 *
101858 * @param string $domain The NIS domain name.
101859 * @param string $map The NIS map.
101860 * @return array Returns an array of all map entries, the maps key
101861 *   values as array indices and the maps entries as array data.
101862 * @since PHP 4 >= 4.0.6, PHP 5 < 5.1.0
101863 **/
101864function yp_cat($domain, $map){}
101865
101866/**
101867 * Returns the error code of the previous operation
101868 *
101869 * @return int Returns one of the YPERR_XXX error constants.
101870 * @since PHP 4 >= 4.0.6, PHP 5 < 5.1.0
101871 **/
101872function yp_errno(){}
101873
101874/**
101875 * Returns the error string associated with the given error code
101876 *
101877 * Returns the error message associated with the given error code. Useful
101878 * to indicate what exactly went wrong.
101879 *
101880 * @param int $errorcode The error code.
101881 * @return string Returns the error message, as a string.
101882 * @since PHP 4 >= 4.0.6, PHP 5 < 5.1.0
101883 **/
101884function yp_err_string($errorcode){}
101885
101886/**
101887 * Returns the first key-value pair from the named map
101888 *
101889 * Gets the first key-value pair from the named {@link map} in the named
101890 * {@link domain}.
101891 *
101892 * @param string $domain The NIS domain name.
101893 * @param string $map The NIS map.
101894 * @return array Returns the first key-value pair as an array on
101895 *   success, or FALSE on errors.
101896 * @since PHP 4, PHP 5 < 5.1.0
101897 **/
101898function yp_first($domain, $map){}
101899
101900/**
101901 * Fetches the machine's default NIS domain
101902 *
101903 * Returns the default domain of the node. Can be used as the domain
101904 * parameter for successive NIS calls.
101905 *
101906 * A NIS domain can be described a group of NIS maps. Every host that
101907 * needs to look up information binds itself to a certain domain. Refer
101908 * to the documents mentioned at the beginning for more detailed
101909 * information.
101910 *
101911 * @return string Returns the default domain of the node or FALSE. Can
101912 *   be used as the domain parameter for successive NIS calls.
101913 * @since PHP 4, PHP 5 < 5.1.0
101914 **/
101915function yp_get_default_domain(){}
101916
101917/**
101918 * Returns the machine name of the master NIS server for a map
101919 *
101920 * Returns the machine name of the master NIS server for a {@link map}.
101921 *
101922 * @param string $domain The NIS domain name.
101923 * @param string $map The NIS map.
101924 * @return string
101925 * @since PHP 4, PHP 5 < 5.1.0
101926 **/
101927function yp_master($domain, $map){}
101928
101929/**
101930 * Returns the matched line
101931 *
101932 * Returns the value associated with the passed {@link key} out of the
101933 * specified {@link map}.
101934 *
101935 * @param string $domain The NIS domain name.
101936 * @param string $map The NIS map.
101937 * @param string $key This key must be exact.
101938 * @return string Returns the value, or FALSE on errors.
101939 * @since PHP 4, PHP 5 < 5.1.0
101940 **/
101941function yp_match($domain, $map, $key){}
101942
101943/**
101944 * Returns the next key-value pair in the named map
101945 *
101946 * Returns the next key-value pair in the named {@link map} after the
101947 * specified {@link key}.
101948 *
101949 * @param string $domain
101950 * @param string $map
101951 * @param string $key
101952 * @return array Returns the next key-value pair as an array, or FALSE
101953 *   on errors.
101954 * @since PHP 4, PHP 5 < 5.1.0
101955 **/
101956function yp_next($domain, $map, $key){}
101957
101958/**
101959 * Returns the order number for a map
101960 *
101961 * Gets the order number for a map.
101962 *
101963 * @param string $domain
101964 * @param string $map
101965 * @return int Returns the order number for a map or FALSE on error.
101966 * @since PHP 4, PHP 5 < 5.1.0
101967 **/
101968function yp_order($domain, $map){}
101969
101970/**
101971 * Gets the Zend guid
101972 *
101973 * This function returns the ID which can be used to display the Zend
101974 * logo using the built-in image.
101975 *
101976 * @return string Returns PHPE9568F35-D428-11d2-A769-00AA001ACF42.
101977 * @since PHP 4, PHP < 5.5.0
101978 **/
101979function zend_logo_guid(){}
101980
101981/**
101982 * Returns a unique identifier for the current thread
101983 *
101984 * This function returns a unique identifier for the current thread.
101985 *
101986 * @return int
101987 * @since PHP 5, PHP 7
101988 **/
101989function zend_thread_id(){}
101990
101991/**
101992 * Gets the version of the current Zend engine
101993 *
101994 * Returns a string containing the version of the currently running Zend
101995 * Engine.
101996 *
101997 * @return string Returns the Zend Engine version number, as a string.
101998 * @since PHP 4, PHP 5, PHP 7
101999 **/
102000function zend_version(){}
102001
102002/**
102003 * Close a ZIP file archive
102004 *
102005 * Closes the given ZIP file archive.
102006 *
102007 * @param resource $zip A ZIP file previously opened with {@link
102008 *   zip_open}.
102009 * @return void
102010 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.0.0
102011 **/
102012function zip_close($zip){}
102013
102014/**
102015 * Close a directory entry
102016 *
102017 * Closes the specified directory entry.
102018 *
102019 * @param resource $zip_entry A directory entry previously opened
102020 *   {@link zip_entry_open}.
102021 * @return bool
102022 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.0.0
102023 **/
102024function zip_entry_close($zip_entry){}
102025
102026/**
102027 * Retrieve the compressed size of a directory entry
102028 *
102029 * Returns the compressed size of the specified directory entry.
102030 *
102031 * @param resource $zip_entry A directory entry returned by {@link
102032 *   zip_read}.
102033 * @return int The compressed size.
102034 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.0.0
102035 **/
102036function zip_entry_compressedsize($zip_entry){}
102037
102038/**
102039 * Retrieve the compression method of a directory entry
102040 *
102041 * Returns the compression method of the directory entry specified by
102042 * {@link zip_entry}.
102043 *
102044 * @param resource $zip_entry A directory entry returned by {@link
102045 *   zip_read}.
102046 * @return string The compression method.
102047 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.0.0
102048 **/
102049function zip_entry_compressionmethod($zip_entry){}
102050
102051/**
102052 * Retrieve the actual file size of a directory entry
102053 *
102054 * Returns the actual size of the specified directory entry.
102055 *
102056 * @param resource $zip_entry A directory entry returned by {@link
102057 *   zip_read}.
102058 * @return int The size of the directory entry.
102059 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.0.0
102060 **/
102061function zip_entry_filesize($zip_entry){}
102062
102063/**
102064 * Retrieve the name of a directory entry
102065 *
102066 * Returns the name of the specified directory entry.
102067 *
102068 * @param resource $zip_entry A directory entry returned by {@link
102069 *   zip_read}.
102070 * @return string The name of the directory entry.
102071 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.0.0
102072 **/
102073function zip_entry_name($zip_entry){}
102074
102075/**
102076 * Open a directory entry for reading
102077 *
102078 * Opens a directory entry in a zip file for reading.
102079 *
102080 * @param resource $zip A valid resource handle returned by {@link
102081 *   zip_open}.
102082 * @param resource $zip_entry A directory entry returned by {@link
102083 *   zip_read}.
102084 * @param string $mode Any of the modes specified in the documentation
102085 *   of {@link fopen}.
102086 * @return bool
102087 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.0.0
102088 **/
102089function zip_entry_open($zip, $zip_entry, $mode){}
102090
102091/**
102092 * Read from an open directory entry
102093 *
102094 * Reads from an open directory entry.
102095 *
102096 * @param resource $zip_entry A directory entry returned by {@link
102097 *   zip_read}.
102098 * @param int $length The number of bytes to return.
102099 * @return string Returns the data read, empty string on end of a file,
102100 *   or FALSE on error.
102101 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.0.0
102102 **/
102103function zip_entry_read($zip_entry, $length){}
102104
102105/**
102106 * Open a ZIP file archive
102107 *
102108 * Opens a new zip archive for reading.
102109 *
102110 * @param string $filename The file name of the ZIP archive to open.
102111 * @return resource Returns a resource handle for later use with {@link
102112 *   zip_read} and {@link zip_close} or returns the number of error if
102113 *   {@link filename} does not exist or in case of other error.
102114 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.0.0
102115 **/
102116function zip_open($filename){}
102117
102118/**
102119 * Read next entry in a ZIP file archive
102120 *
102121 * Reads the next entry in a zip file archive.
102122 *
102123 * @param resource $zip A ZIP file previously opened with {@link
102124 *   zip_open}.
102125 * @return resource Returns a directory entry resource for later use
102126 *   with the zip_entry_... functions, or FALSE if there are no more
102127 *   entries to read, or an error code if an error occurred.
102128 * @since PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.0.0
102129 **/
102130function zip_read($zip){}
102131
102132/**
102133 * Uncompress any raw/gzip/zlib encoded data
102134 *
102135 * @param string $data
102136 * @param string $max_decoded_len
102137 * @return string Returns the uncompressed data, .
102138 * @since PHP 5 >= 5.4.0, PHP 7
102139 **/
102140function zlib_decode($data, $max_decoded_len){}
102141
102142/**
102143 * Compress data with the specified encoding
102144 *
102145 * @param string $data The data to compress.
102146 * @param int $encoding The compression algorithm. Either
102147 *   ZLIB_ENCODING_RAW, ZLIB_ENCODING_DEFLATE or ZLIB_ENCODING_GZIP.
102148 * @param int $level
102149 * @return string
102150 * @since PHP 5 >= 5.4.0, PHP 7
102151 **/
102152function zlib_encode($data, $encoding, $level){}
102153
102154/**
102155 * Returns the coding type used for output compression
102156 *
102157 * @return string Possible return values are gzip, deflate, or FALSE.
102158 * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
102159 **/
102160function zlib_get_coding_type(){}
102161
102162/**
102163 * Calls callbacks for pending operations
102164 *
102165 * The {@link zookeeper_dispatch} function calls the callbacks passwd by
102166 * operations like Zookeeper::get or Zookeeper::exists.
102167 *
102168 * After PHP 7.1, you can ignore this function. This extension uses
102169 * EG(vm_interrupt) to implement async dispatch.
102170 *
102171 * @return void
102172 * @since PECL zookeeper >= 0.4.0
102173 **/
102174function zookeeper_dispatch(){}
102175
102176/**
102177 * Attempt to load undefined class
102178 *
102179 * You can define this function to enable classes autoloading.
102180 *
102181 * @param string $class Name of the class to load
102182 * @return void
102183 * @since PHP 5, PHP 7
102184 **/
102185function __autoload($class){}
102186
102187/**
102188 * Iterates through a file system in a similar fashion to {@link glob}.
102189 **/
102190class GlobIterator extends FilesystemIterator implements SeekableIterator, Countable {
102191    /**
102192     * Get the number of directories and files
102193     *
102194     * Gets the number of directories and files found by the glob expression.
102195     *
102196     * @return int The number of returned directories and files, as an
102197     *   integer.
102198     * @since PHP 5 >= 5.3.0, PHP 7
102199     **/
102200    public function count(){}
102201
102202    /**
102203     * Construct a directory using glob
102204     *
102205     * Constructs a new directory iterator from a glob expression.
102206     *
102207     * @param string $pattern A {@link glob} pattern.
102208     * @param int $flags Option flags, the flags may be a bitmask of the
102209     *   FilesystemIterator constants.
102210     * @since PHP 5 >= 5.3.0, PHP 7
102211     **/
102212    public function __construct($pattern, $flags){}
102213
102214}
102215class Gmagick {
102216    const ALIGN_CENTER = 0;
102217
102218    const ALIGN_LEFT = 0;
102219
102220    const ALIGN_RIGHT = 0;
102221
102222    const ALIGN_UNDEFINED = 0;
102223
102224    const CHANNEL_ALL = 0;
102225
102226    const CHANNEL_ALPHA = 0;
102227
102228    const CHANNEL_BLACK = 0;
102229
102230    const CHANNEL_BLUE = 0;
102231
102232    const CHANNEL_CYAN = 0;
102233
102234    const CHANNEL_GRAY = 0;
102235
102236    const CHANNEL_GREEN = 0;
102237
102238    const CHANNEL_INDEX = 0;
102239
102240    const CHANNEL_MAGENTA = 0;
102241
102242    const CHANNEL_MATTE = 0;
102243
102244    const CHANNEL_OPACITY = 0;
102245
102246    const CHANNEL_RED = 0;
102247
102248    const CHANNEL_UNDEFINED = 0;
102249
102250    const CHANNEL_YELLOW = 0;
102251
102252    const COLORSPACE_CMYK = 0;
102253
102254    const COLORSPACE_GRAY = 0;
102255
102256    const COLORSPACE_HSB = 0;
102257
102258    const COLORSPACE_HSL = 0;
102259
102260    const COLORSPACE_HWB = 0;
102261
102262    const COLORSPACE_LAB = 0;
102263
102264    const COLORSPACE_LOG = 0;
102265
102266    const COLORSPACE_OHTA = 0;
102267
102268    const COLORSPACE_REC601LUMA = 0;
102269
102270    const COLORSPACE_REC709LUMA = 0;
102271
102272    const COLORSPACE_RGB = 0;
102273
102274    const COLORSPACE_SRGB = 0;
102275
102276    const COLORSPACE_TRANSPARENT = 0;
102277
102278    const COLORSPACE_UNDEFINED = 0;
102279
102280    const COLORSPACE_XYZ = 0;
102281
102282    const COLORSPACE_YCBCR = 0;
102283
102284    const COLORSPACE_YCC = 0;
102285
102286    const COLORSPACE_YIQ = 0;
102287
102288    const COLORSPACE_YPBPR = 0;
102289
102290    const COLORSPACE_YUV = 0;
102291
102292    const COLOR_ALPHA = 0;
102293
102294    const COLOR_BLACK = 0;
102295
102296    const COLOR_BLUE = 0;
102297
102298    const COLOR_CYAN = 0;
102299
102300    const COLOR_FUZZ = 0;
102301
102302    const COLOR_GREEN = 0;
102303
102304    const COLOR_MAGENTA = 0;
102305
102306    const COLOR_OPACITY = 0;
102307
102308    const COLOR_RED = 0;
102309
102310    const COLOR_YELLOW = 0;
102311
102312    const COMPOSITE_ADD = 0;
102313
102314    const COMPOSITE_ATOP = 0;
102315
102316    const COMPOSITE_BLEND = 0;
102317
102318    const COMPOSITE_BUMPMAP = 0;
102319
102320    const COMPOSITE_CLEAR = 0;
102321
102322    const COMPOSITE_COLORBURN = 0;
102323
102324    const COMPOSITE_COLORDODGE = 0;
102325
102326    const COMPOSITE_COLORIZE = 0;
102327
102328    const COMPOSITE_COPY = 0;
102329
102330    const COMPOSITE_COPYBLACK = 0;
102331
102332    const COMPOSITE_COPYBLUE = 0;
102333
102334    const COMPOSITE_COPYCYAN = 0;
102335
102336    const COMPOSITE_COPYGREEN = 0;
102337
102338    const COMPOSITE_COPYMAGENTA = 0;
102339
102340    const COMPOSITE_COPYOPACITY = 0;
102341
102342    const COMPOSITE_COPYRED = 0;
102343
102344    const COMPOSITE_COPYYELLOW = 0;
102345
102346    const COMPOSITE_DARKEN = 0;
102347
102348    const COMPOSITE_DEFAULT = 0;
102349
102350    const COMPOSITE_DIFFERENCE = 0;
102351
102352    const COMPOSITE_DISPLACE = 0;
102353
102354    const COMPOSITE_DISSOLVE = 0;
102355
102356    const COMPOSITE_DST = 0;
102357
102358    const COMPOSITE_DSTATOP = 0;
102359
102360    const COMPOSITE_DSTIN = 0;
102361
102362    const COMPOSITE_DSTOUT = 0;
102363
102364    const COMPOSITE_DSTOVER = 0;
102365
102366    const COMPOSITE_EXCLUSION = 0;
102367
102368    const COMPOSITE_HARDLIGHT = 0;
102369
102370    const COMPOSITE_HUE = 0;
102371
102372    const COMPOSITE_IN = 0;
102373
102374    const COMPOSITE_LIGHTEN = 0;
102375
102376    const COMPOSITE_LUMINIZE = 0;
102377
102378    const COMPOSITE_MINUS = 0;
102379
102380    const COMPOSITE_MODULATE = 0;
102381
102382    const COMPOSITE_MULTIPLY = 0;
102383
102384    const COMPOSITE_NO = 0;
102385
102386    const COMPOSITE_OUT = 0;
102387
102388    const COMPOSITE_OVER = 0;
102389
102390    const COMPOSITE_OVERLAY = 0;
102391
102392    const COMPOSITE_PLUS = 0;
102393
102394    const COMPOSITE_REPLACE = 0;
102395
102396    const COMPOSITE_SATURATE = 0;
102397
102398    const COMPOSITE_SCREEN = 0;
102399
102400    const COMPOSITE_SOFTLIGHT = 0;
102401
102402    const COMPOSITE_SRC = 0;
102403
102404    const COMPOSITE_SRCATOP = 0;
102405
102406    const COMPOSITE_SRCIN = 0;
102407
102408    const COMPOSITE_SRCOUT = 0;
102409
102410    const COMPOSITE_SRCOVER = 0;
102411
102412    const COMPOSITE_SUBTRACT = 0;
102413
102414    const COMPOSITE_THRESHOLD = 0;
102415
102416    const COMPOSITE_UNDEFINED = 0;
102417
102418    const COMPOSITE_XOR = 0;
102419
102420    const COMPRESSION_BZIP = 0;
102421
102422    const COMPRESSION_FAX = 0;
102423
102424    const COMPRESSION_GROUP4 = 0;
102425
102426    const COMPRESSION_JPEG = 0;
102427
102428    const COMPRESSION_JPEG2000 = 0;
102429
102430    const COMPRESSION_LOSSLESSJPEG = 0;
102431
102432    const COMPRESSION_LZW = 0;
102433
102434    const COMPRESSION_NO = 0;
102435
102436    const COMPRESSION_RLE = 0;
102437
102438    const COMPRESSION_UNDEFINED = 0;
102439
102440    const COMPRESSION_ZIP = 0;
102441
102442    const DECORATION_LINETROUGH = 0;
102443
102444    const DECORATION_NO = 0;
102445
102446    const DECORATION_OVERLINE = 0;
102447
102448    const DECORATION_UNDERLINE = 0;
102449
102450    const FILLRULE_EVENODD = 0;
102451
102452    const FILLRULE_NONZERO = 0;
102453
102454    const FILLRULE_UNDEFINED = 0;
102455
102456    const FILTER_BESSEL = 0;
102457
102458    const FILTER_BLACKMAN = 0;
102459
102460    const FILTER_BOX = 0;
102461
102462    const FILTER_CATROM = 0;
102463
102464    const FILTER_CUBIC = 0;
102465
102466    const FILTER_GAUSSIAN = 0;
102467
102468    const FILTER_HAMMING = 0;
102469
102470    const FILTER_HANNING = 0;
102471
102472    const FILTER_HERMITE = 0;
102473
102474    const FILTER_LANCZOS = 0;
102475
102476    const FILTER_MITCHELL = 0;
102477
102478    const FILTER_POINT = 0;
102479
102480    const FILTER_QUADRATIC = 0;
102481
102482    const FILTER_SINC = 0;
102483
102484    const FILTER_TRIANGLE = 0;
102485
102486    const FILTER_UNDEFINED = 0;
102487
102488    const GRAVITY_CENTER = 0;
102489
102490    const GRAVITY_EAST = 0;
102491
102492    const GRAVITY_NORTH = 0;
102493
102494    const GRAVITY_NORTHEAST = 0;
102495
102496    const GRAVITY_NORTHWEST = 0;
102497
102498    const GRAVITY_SOUTH = 0;
102499
102500    const GRAVITY_SOUTHEAST = 0;
102501
102502    const GRAVITY_SOUTHWEST = 0;
102503
102504    const GRAVITY_WEST = 0;
102505
102506    const IMGTYPE_BILEVEL = 0;
102507
102508    const IMGTYPE_COLORSEPARATION = 0;
102509
102510    const IMGTYPE_COLORSEPARATIONMATTE = 0;
102511
102512    const IMGTYPE_GRAYSCALE = 0;
102513
102514    const IMGTYPE_GRAYSCALEMATTE = 0;
102515
102516    const IMGTYPE_OPTIMIZE = 0;
102517
102518    const IMGTYPE_PALETTE = 0;
102519
102520    const IMGTYPE_PALETTEMATTE = 0;
102521
102522    const IMGTYPE_TRUECOLOR = 0;
102523
102524    const IMGTYPE_TRUECOLORMATTE = 0;
102525
102526    const IMGTYPE_UNDEFINED = 0;
102527
102528    const LINECAP_BUTT = 0;
102529
102530    const LINECAP_ROUND = 0;
102531
102532    const LINECAP_SQUARE = 0;
102533
102534    const LINECAP_UNDEFINED = 0;
102535
102536    const LINEJOIN_BEVEL = 0;
102537
102538    const LINEJOIN_MITER = 0;
102539
102540    const LINEJOIN_ROUND = 0;
102541
102542    const LINEJOIN_UNDEFINED = 0;
102543
102544    const METRIC_MEANABSOLUTEERROR = 0;
102545
102546    const METRIC_MEANSQUAREERROR = 0;
102547
102548    const METRIC_PEAKABSOLUTEERROR = 0;
102549
102550    const METRIC_PEAKSIGNALTONOISERATIO = 0;
102551
102552    const METRIC_ROOTMEANSQUAREDERROR = 0;
102553
102554    const METRIC_UNDEFINED = 0;
102555
102556    const MONTAGEMODE_CONCATENATE = 0;
102557
102558    const MONTAGEMODE_FRAME = 0;
102559
102560    const MONTAGEMODE_UNFRAME = 0;
102561
102562    const NOISE_GAUSSIAN = 0;
102563
102564    const NOISE_IMPULSE = 0;
102565
102566    const NOISE_LAPLACIAN = 0;
102567
102568    const NOISE_MULTIPLICATIVEGAUSSIAN = 0;
102569
102570    const NOISE_POISSON = 0;
102571
102572    const NOISE_UNIFORM = 0;
102573
102574    const ORIENTATION_BOTTOMLEFT = 0;
102575
102576    const ORIENTATION_BOTTOMRIGHT = 0;
102577
102578    const ORIENTATION_LEFTBOTTOM = 0;
102579
102580    const ORIENTATION_LEFTTOP = 0;
102581
102582    const ORIENTATION_RIGHTBOTTOM = 0;
102583
102584    const ORIENTATION_RIGHTTOP = 0;
102585
102586    const ORIENTATION_TOPLEFT = 0;
102587
102588    const ORIENTATION_TOPRIGHT = 0;
102589
102590    const ORIENTATION_UNDEFINED = 0;
102591
102592    const PAINT_FILLTOBORDER = 0;
102593
102594    const PAINT_FLOODFILL = 0;
102595
102596    const PAINT_POINT = 0;
102597
102598    const PAINT_REPLACE = 0;
102599
102600    const PAINT_RESET = 0;
102601
102602    const PATHUNITS_OBJECTBOUNDINGBOX = 0;
102603
102604    const PATHUNITS_UNDEFINED = 0;
102605
102606    const PATHUNITS_USERSPACE = 0;
102607
102608    const PATHUNITS_USERSPACEONUSE = 0;
102609
102610    const PIXEL_CHAR = 0;
102611
102612    const PIXEL_DOUBLE = 0;
102613
102614    const PIXEL_FLOAT = 0;
102615
102616    const PIXEL_INTEGER = 0;
102617
102618    const PIXEL_LONG = 0;
102619
102620    const PIXEL_QUANTUM = 0;
102621
102622    const PIXEL_SHORT = 0;
102623
102624    const PREVIEW_ADDNOISE = 0;
102625
102626    const PREVIEW_BLUR = 0;
102627
102628    const PREVIEW_BRIGHTNESS = 0;
102629
102630    const PREVIEW_CHARCOALDRAWING = 0;
102631
102632    const PREVIEW_DESPECKLE = 0;
102633
102634    const PREVIEW_DULL = 0;
102635
102636    const PREVIEW_EDGEDETECT = 0;
102637
102638    const PREVIEW_GAMMA = 0;
102639
102640    const PREVIEW_GRAYSCALE = 0;
102641
102642    const PREVIEW_HUE = 0;
102643
102644    const PREVIEW_IMPLODE = 0;
102645
102646    const PREVIEW_JPEG = 0;
102647
102648    const PREVIEW_OILPAINT = 0;
102649
102650    const PREVIEW_QUANTIZE = 0;
102651
102652    const PREVIEW_RAISE = 0;
102653
102654    const PREVIEW_REDUCENOISE = 0;
102655
102656    const PREVIEW_ROLL = 0;
102657
102658    const PREVIEW_ROTATE = 0;
102659
102660    const PREVIEW_SATURATION = 0;
102661
102662    const PREVIEW_SEGMENT = 0;
102663
102664    const PREVIEW_SHADE = 0;
102665
102666    const PREVIEW_SHARPEN = 0;
102667
102668    const PREVIEW_SHEAR = 0;
102669
102670    const PREVIEW_SOLARIZE = 0;
102671
102672    const PREVIEW_SPIFF = 0;
102673
102674    const PREVIEW_SPREAD = 0;
102675
102676    const PREVIEW_SWIRL = 0;
102677
102678    const PREVIEW_THRESHOLD = 0;
102679
102680    const PREVIEW_UNDEFINED = 0;
102681
102682    const PREVIEW_WAVE = 0;
102683
102684    const RENDERINGINTENT_ABSOLUTE = 0;
102685
102686    const RENDERINGINTENT_PERCEPTUAL = 0;
102687
102688    const RENDERINGINTENT_RELATIVE = 0;
102689
102690    const RENDERINGINTENT_SATURATION = 0;
102691
102692    const RENDERINGINTENT_UNDEFINED = 0;
102693
102694    const RESOLUTION_PIXELSPERCENTIMETER = 0;
102695
102696    const RESOLUTION_PIXELSPERINCH = 0;
102697
102698    const RESOLUTION_UNDEFINED = 0;
102699
102700    const RESOURCETYPE_AREA = 0;
102701
102702    const RESOURCETYPE_DISK = 0;
102703
102704    const RESOURCETYPE_FILE = 0;
102705
102706    const RESOURCETYPE_MAP = 0;
102707
102708    const RESOURCETYPE_MEMORY = 0;
102709
102710    const RESOURCETYPE_UNDEFINED = 0;
102711
102712    const STRETCH_ANY = 0;
102713
102714    const STRETCH_CONDENSED = 0;
102715
102716    const STRETCH_EXPANDED = 0;
102717
102718    const STRETCH_EXTRAEXPANDED = 0;
102719
102720    const STRETCH_NORMAL = 0;
102721
102722    const STRETCH_SEMICONDENSED = 0;
102723
102724    const STRETCH_SEMIEXPANDED = 0;
102725
102726    const STRETCH_ULTRACONDENSED = 0;
102727
102728    const STRETCH_ULTRAEXPANDED = 0;
102729
102730    const STYLE_ANY = 0;
102731
102732    const STYLE_ITALIC = 0;
102733
102734    const STYLE_NORMAL = 0;
102735
102736    const STYLE_OBLIQUE = 0;
102737
102738    const VIRTUALPIXELMETHOD_BACKGROUND = 0;
102739
102740    const VIRTUALPIXELMETHOD_CONSTANT = 0;
102741
102742    const VIRTUALPIXELMETHOD_EDGE = 0;
102743
102744    const VIRTUALPIXELMETHOD_MIRROR = 0;
102745
102746    const VIRTUALPIXELMETHOD_TILE = 0;
102747
102748    const VIRTUALPIXELMETHOD_TRANSPARENT = 0;
102749
102750    const VIRTUALPIXELMETHOD_UNDEFINED = 0;
102751
102752    /**
102753     * Adds new image to Gmagick object image list
102754     *
102755     * Adds new image to Gmagick object from the current position of the
102756     * source object. After the operation iterator position is moved at the
102757     * end of the list.
102758     *
102759     * @param Gmagick $source The source Gmagick object
102760     * @return Gmagick The Gmagick object with image added
102761     * @since PECL gmagick >= Unknown
102762     **/
102763    public function addimage($source){}
102764
102765    /**
102766     * Adds random noise to the image
102767     *
102768     * @param int $noise_type The type of the noise. Refer to this list of
102769     *   noise constants.
102770     * @return Gmagick The Gmagick object with noise added.
102771     * @since PECL gmagick >= Unknown
102772     **/
102773    public function addnoiseimage($noise_type){}
102774
102775    /**
102776     * Annotates an image with text
102777     *
102778     * @param GmagickDraw $GmagickDraw The GmagickDraw object that contains
102779     *   settings for drawing the text
102780     * @param float $x Horizontal offset in pixels to the left of text
102781     * @param float $y Vertical offset in pixels to the baseline of text
102782     * @param float $angle The angle at which to write the text
102783     * @param string $text The string to draw
102784     * @return Gmagick The Gmagick object with annotation made.
102785     * @since PECL gmagick >= Unknown
102786     **/
102787    public function annotateimage($GmagickDraw, $x, $y, $angle, $text){}
102788
102789    /**
102790     * Adds blur filter to image
102791     *
102792     * @param float $radius Blur radius
102793     * @param float $sigma Standard deviation
102794     * @param int $channel
102795     * @return Gmagick The blurred Gmagick object
102796     * @since PECL gmagick >= Unknown
102797     **/
102798    public function blurimage($radius, $sigma, $channel){}
102799
102800    /**
102801     * Surrounds the image with a border
102802     *
102803     * Surrounds the image with a border of the color defined by the
102804     * bordercolor GmagickPixel object or a color string.
102805     *
102806     * @param GmagickPixel $color GmagickPixel object or a string
102807     *   containing the border color
102808     * @param int $width Border width
102809     * @param int $height Border height
102810     * @return Gmagick The Gmagick object with border defined
102811     * @since PECL gmagick >= Unknown
102812     **/
102813    public function borderimage($color, $width, $height){}
102814
102815    /**
102816     * Simulates a charcoal drawing
102817     *
102818     * @param float $radius The radius of the Gaussian, in pixels, not
102819     *   counting the center pixel
102820     * @param float $sigma The standard deviation of the Gaussian, in
102821     *   pixels
102822     * @return Gmagick The Gmagick object with charcoal simulation
102823     * @since PECL gmagick >= Unknown
102824     **/
102825    public function charcoalimage($radius, $sigma){}
102826
102827    /**
102828     * Removes a region of an image and trims
102829     *
102830     * Removes a region of an image and collapses the image to occupy the
102831     * removed portion.
102832     *
102833     * @param int $width Width of the chopped area
102834     * @param int $height Height of the chopped area
102835     * @param int $x X origo of the chopped area
102836     * @param int $y Y origo of the chopped area
102837     * @return Gmagick The chopped Gmagick object
102838     * @since PECL gmagick >= Unknown
102839     **/
102840    public function chopimage($width, $height, $x, $y){}
102841
102842    /**
102843     * Clears all resources associated to Gmagick object
102844     *
102845     * @return Gmagick The cleared Gmagick object
102846     * @since PECL gmagick >= Unknown
102847     **/
102848    public function clear(){}
102849
102850    /**
102851     * Adds a comment to your image
102852     *
102853     * @param string $comment The comment to add
102854     * @return Gmagick The Gmagick object with comment added.
102855     * @since PECL gmagick >= Unknown
102856     **/
102857    public function commentimage($comment){}
102858
102859    /**
102860     * Composite one image onto another
102861     *
102862     * Composite one image onto another at the specified offset.
102863     *
102864     * @param Gmagick $source Gmagick object which holds the composite
102865     *   image
102866     * @param int $COMPOSE Composite operator.
102867     * @param int $x The column offset of the composited image
102868     * @param int $y The row offset of the composited image
102869     * @return Gmagick The Gmagick object with compositions.
102870     * @since PECL gmagick >= Unknown
102871     **/
102872    public function compositeimage($source, $COMPOSE, $x, $y){}
102873
102874    /**
102875     * Extracts a region of the image
102876     *
102877     * @param int $width The width of the crop
102878     * @param int $height The height of the crop
102879     * @param int $x The X coordinate of the cropped region's top left
102880     *   corner
102881     * @param int $y The Y coordinate of the cropped region's top left
102882     *   corner
102883     * @return Gmagick The cropped Gmagick object
102884     * @since PECL gmagick >= Unknown
102885     **/
102886    public function cropimage($width, $height, $x, $y){}
102887
102888    /**
102889     * Creates a crop thumbnail
102890     *
102891     * Creates a fixed size thumbnail by first scaling the image down and
102892     * cropping a specified area from the center.
102893     *
102894     * @param int $width The width of the thumbnail
102895     * @param int $height The Height of the thumbnail
102896     * @return Gmagick The cropped Gmagick object
102897     * @since PECL gmagick >= Unknown
102898     **/
102899    public function cropthumbnailimage($width, $height){}
102900
102901    /**
102902     * The current purpose
102903     *
102904     * Returns reference to the current gmagick object with image pointer at
102905     * the correct sequence.
102906     *
102907     * @return Gmagick Returns self on success.
102908     * @since PECL gmagick >= Unknown
102909     **/
102910    public function current(){}
102911
102912    /**
102913     * Displaces an image's colormap
102914     *
102915     * Displaces an image's colormap by a given number of positions. If you
102916     * cycle the colormap a number of times you can produce a psychedelic
102917     * effect.
102918     *
102919     * @param int $displace The amount to displace the colormap.
102920     * @return Gmagick Returns self on success.
102921     * @since PECL gmagick >= Unknown
102922     **/
102923    public function cyclecolormapimage($displace){}
102924
102925    /**
102926     * Returns certain pixel differences between images
102927     *
102928     * Compares each image with the next in a sequence and returns the
102929     * maximum bounding region of any pixel differences it discovers.
102930     *
102931     * @return Gmagick Returns a new Gmagick object on success.
102932     * @since PECL gmagick >= Unknown
102933     **/
102934    public function deconstructimages(){}
102935
102936    /**
102937     * The despeckleimage purpose
102938     *
102939     * Reduces the speckle noise in an image while preserving the edges of
102940     * the original image.
102941     *
102942     * @return Gmagick The despeckled Gmagick object on success.
102943     * @since PECL gmagick >= Unknown
102944     **/
102945    public function despeckleimage(){}
102946
102947    /**
102948     * The destroy purpose
102949     *
102950     * Destroys the Gmagick object and frees all resources associated with it
102951     *
102952     * @return bool
102953     * @since PECL gmagick >= Unknown
102954     **/
102955    public function destroy(){}
102956
102957    /**
102958     * Renders the GmagickDraw object on the current image
102959     *
102960     * @param GmagickDraw $GmagickDraw The drawing operations to render on
102961     *   the image.
102962     * @return Gmagick The drawn Gmagick object
102963     * @since PECL gmagick >= Unknown
102964     **/
102965    public function drawimage($GmagickDraw){}
102966
102967    /**
102968     * Enhance edges within the image
102969     *
102970     * Enhance edges within the image with a convolution filter of the given
102971     * radius. Use radius 0 and it will be auto-selected.
102972     *
102973     * @param float $radius The radius of the operation.
102974     * @return Gmagick The Gmagick object with edges enhanced.
102975     * @since PECL gmagick >= Unknown
102976     **/
102977    public function edgeimage($radius){}
102978
102979    /**
102980     * Returns a grayscale image with a three-dimensional effect
102981     *
102982     * Returns a grayscale image with a three-dimensional effect. We convolve
102983     * the image with a Gaussian operator of the given radius and standard
102984     * deviation (sigma). For reasonable results, radius should be larger
102985     * than sigma. Use a radius of 0 and it will choose a suitable radius for
102986     * you.
102987     *
102988     * @param float $radius The radius of the effect
102989     * @param float $sigma The sigma of the effect
102990     * @return Gmagick The embossed Gmagick object.
102991     * @since PECL gmagick >= Unknown
102992     **/
102993    public function embossimage($radius, $sigma){}
102994
102995    /**
102996     * Improves the quality of a noisy image
102997     *
102998     * Applies a digital filter that improves the quality of a noisy image.
102999     *
103000     * @return Gmagick The enhanced Gmagick object.
103001     * @since PECL gmagick >= Unknown
103002     **/
103003    public function enhanceimage(){}
103004
103005    /**
103006     * Equalizes the image histogram
103007     *
103008     * @return Gmagick The equalized Gmagick object.
103009     * @since PECL gmagick >= Unknown
103010     **/
103011    public function equalizeimage(){}
103012
103013    /**
103014     * Creates a vertical mirror image
103015     *
103016     * Creates a vertical mirror image by reflecting the pixels around the
103017     * central x-axis.
103018     *
103019     * @return Gmagick The flipped Gmagick object.
103020     * @since PECL gmagick >= Unknown
103021     **/
103022    public function flipimage(){}
103023
103024    /**
103025     * The flopimage purpose
103026     *
103027     * Creates a horizontal mirror image by reflecting the pixels around the
103028     * central y-axis.
103029     *
103030     * @return Gmagick The flopped Gmagick object.
103031     * @since PECL gmagick >= Unknown
103032     **/
103033    public function flopimage(){}
103034
103035    /**
103036     * Adds a simulated three-dimensional border
103037     *
103038     * Adds a simulated three-dimensional border around the image. The width
103039     * and height specify the border width of the vertical and horizontal
103040     * sides of the frame. The inner and outer bevels indicate the width of
103041     * the inner and outer shadows of the frame.
103042     *
103043     * @param GmagickPixel $color GmagickPixel object or a float
103044     *   representing the matte color
103045     * @param int $width The width of the border
103046     * @param int $height The height of the border
103047     * @param int $inner_bevel The inner bevel width
103048     * @param int $outer_bevel The outer bevel width
103049     * @return Gmagick The framed Gmagick object.
103050     * @since PECL gmagick >= Unknown
103051     **/
103052    public function frameimage($color, $width, $height, $inner_bevel, $outer_bevel){}
103053
103054    /**
103055     * Gamma-corrects an image
103056     *
103057     * Gamma-corrects an image. The same image viewed on different devices
103058     * will have perceptual differences in the way the image's intensities
103059     * are represented on the screen. Specify individual gamma levels for the
103060     * red, green, and blue channels, or adjust all three with the gamma
103061     * parameter. Values typically range from 0.8 to 2.3.
103062     *
103063     * @param float $gamma The amount of gamma-correction.
103064     * @return Gmagick The gamma corrected Gmagick object.
103065     * @since PECL gmagick >= Unknown
103066     **/
103067    public function gammaimage($gamma){}
103068
103069    /**
103070     * Returns the GraphicsMagick API copyright as a string
103071     *
103072     * @return string Returns a string containing the copyright notice of
103073     *   GraphicsMagick and Magickwand C API.
103074     * @since PECL gmagick >= Unknown
103075     **/
103076    public function getcopyright(){}
103077
103078    /**
103079     * The filename associated with an image sequence
103080     *
103081     * Returns the filename associated with an image sequence.
103082     *
103083     * @return string Returns a string on success.
103084     * @since PECL gmagick >= Unknown
103085     **/
103086    public function getfilename(){}
103087
103088    /**
103089     * Returns the image background color
103090     *
103091     * @return GmagickPixel Returns an GmagickPixel set to the background
103092     *   color of the image.
103093     * @since PECL gmagick >= Unknown
103094     **/
103095    public function getimagebackgroundcolor(){}
103096
103097    /**
103098     * Returns the chromaticy blue primary point
103099     *
103100     * Returns the chromaticity blue primary point for the image.
103101     *
103102     * @return array Array consisting of "x" and "y" coordinates of point.
103103     * @since PECL gmagick >= Unknown
103104     **/
103105    public function getimageblueprimary(){}
103106
103107    /**
103108     * Returns the image border color
103109     *
103110     * @return GmagickPixel GmagickPixel object representing the color of
103111     *   the border
103112     * @since PECL gmagick >= Unknown
103113     **/
103114    public function getimagebordercolor(){}
103115
103116    /**
103117     * Gets the depth for a particular image channel
103118     *
103119     * @param int $channel_type
103120     * @return int Depth of image channel
103121     * @since PECL gmagick >= Unknown
103122     **/
103123    public function getimagechanneldepth($channel_type){}
103124
103125    /**
103126     * Returns the color of the specified colormap index
103127     *
103128     * Returns the color of the specified colormap index.
103129     *
103130     * @return int The number of colors in image.
103131     * @since PECL gmagick >= Unknown
103132     **/
103133    public function getimagecolors(){}
103134
103135    /**
103136     * Gets the image colorspace
103137     *
103138     * @return int Colorspace
103139     * @since PECL gmagick >= Unknown
103140     **/
103141    public function getimagecolorspace(){}
103142
103143    /**
103144     * Returns the composite operator associated with the image
103145     *
103146     * @return int Returns the composite operator associated with the
103147     *   image.
103148     * @since PECL gmagick >= Unknown
103149     **/
103150    public function getimagecompose(){}
103151
103152    /**
103153     * Gets the image delay
103154     *
103155     * @return int Returns the composite operator associated with the
103156     *   image.
103157     * @since PECL gmagick >= Unknown
103158     **/
103159    public function getimagedelay(){}
103160
103161    /**
103162     * Gets the depth of the image
103163     *
103164     * @return int Image depth
103165     * @since PECL gmagick >= Unknown
103166     **/
103167    public function getimagedepth(){}
103168
103169    /**
103170     * Gets the image disposal method
103171     *
103172     * @return int Returns the dispose method on success.
103173     * @since PECL gmagick >= Unknown
103174     **/
103175    public function getimagedispose(){}
103176
103177    /**
103178     * Gets the extrema for the image
103179     *
103180     * Returns an associative array with the keys "min" and "max".
103181     *
103182     * @return array Returns an associative array with the keys "min" and
103183     *   "max".
103184     * @since PECL gmagick >= Unknown
103185     **/
103186    public function getimageextrema(){}
103187
103188    /**
103189     * Returns the filename of a particular image in a sequence
103190     *
103191     * @return string Returns a string with the filename of the image
103192     * @since PECL gmagick >= Unknown
103193     **/
103194    public function getimagefilename(){}
103195
103196    /**
103197     * Returns the format of a particular image in a sequence
103198     *
103199     * @return string Returns a string containing the image format on
103200     *   success.
103201     * @since PECL gmagick >= Unknown
103202     **/
103203    public function getimageformat(){}
103204
103205    /**
103206     * Gets the image gamma
103207     *
103208     * @return float Returns the image gamma on success
103209     * @since PECL gmagick >= Unknown
103210     **/
103211    public function getimagegamma(){}
103212
103213    /**
103214     * Returns the chromaticy green primary point
103215     *
103216     * Returns the chromaticity green primary point. Returns an array with
103217     * the keys "x" and "y".
103218     *
103219     * @return array Returns an array with the keys "x" and "y" on success.
103220     * @since PECL gmagick >= Unknown
103221     **/
103222    public function getimagegreenprimary(){}
103223
103224    /**
103225     * Returns the image height
103226     *
103227     * @return int Returns the image height in pixels.
103228     * @since PECL gmagick >= Unknown
103229     **/
103230    public function getimageheight(){}
103231
103232    /**
103233     * Gets the image histogram
103234     *
103235     * Returns the image histogram as an array of GmagickPixel objects. Throw
103236     * an GmagickException on error.
103237     *
103238     * @return array Returns the image histogram as an array of
103239     *   GmagickPixel objects.
103240     * @since PECL gmagick >= Unknown
103241     **/
103242    public function getimagehistogram(){}
103243
103244    /**
103245     * Gets the index of the current active image
103246     *
103247     * Returns the index of the current active image within the Gmagick
103248     * object.
103249     *
103250     * @return int Index of current active image
103251     * @since PECL gmagick >= Unknown
103252     **/
103253    public function getimageindex(){}
103254
103255    /**
103256     * Gets the image interlace scheme
103257     *
103258     * @return int Returns the interlace scheme as an integer on success
103259     * @since PECL gmagick >= Unknown
103260     **/
103261    public function getimageinterlacescheme(){}
103262
103263    /**
103264     * Gets the image iterations
103265     *
103266     * @return int Returns the image iterations as an integer.
103267     * @since PECL gmagick >= Unknown
103268     **/
103269    public function getimageiterations(){}
103270
103271    /**
103272     * Check if the image has a matte channel
103273     *
103274     * Returns TRUE if the image has a matte channel, otherwise FALSE.
103275     *
103276     * @return int Returns TRUE if the image has a matte channel, otherwise
103277     *   FALSE.
103278     * @since PECL gmagick >= Unknown
103279     **/
103280    public function getimagematte(){}
103281
103282    /**
103283     * Returns the image matte color
103284     *
103285     * Returns GmagickPixel object on success. Throw an GmagickException on
103286     * error.
103287     *
103288     * @return GmagickPixel Returns GmagickPixel object on success.
103289     * @since PECL gmagick >= Unknown
103290     **/
103291    public function getimagemattecolor(){}
103292
103293    /**
103294     * Returns the named image profile
103295     *
103296     * @param string $name
103297     * @return string Returns a string containing the image profile.
103298     * @since PECL gmagick >= Unknown
103299     **/
103300    public function getimageprofile($name){}
103301
103302    /**
103303     * Returns the chromaticity red primary point
103304     *
103305     * Returns the chromaticity red primary point as an array with the keys
103306     * "x" and "y".
103307     *
103308     * @return array Returns the chromaticity red primary point as an array
103309     *   with the keys "x" and "y".
103310     * @since PECL gmagick >= Unknown
103311     **/
103312    public function getimageredprimary(){}
103313
103314    /**
103315     * Gets the image rendering intent
103316     *
103317     * @return int Extracts a region of the image and returns it as a new
103318     *   wand
103319     * @since PECL gmagick >= Unknown
103320     **/
103321    public function getimagerenderingintent(){}
103322
103323    /**
103324     * Gets the image X and Y resolution
103325     *
103326     * Returns the resolution as an array.
103327     *
103328     * @return array Returns the resolution as an array.
103329     * @since PECL gmagick >= Unknown
103330     **/
103331    public function getimageresolution(){}
103332
103333    /**
103334     * Gets the image scene
103335     *
103336     * @return int Returns the image scene.
103337     * @since PECL gmagick >= Unknown
103338     **/
103339    public function getimagescene(){}
103340
103341    /**
103342     * Generates an SHA-256 message digest
103343     *
103344     * Generates an SHA-256 message digest for the image pixel stream.
103345     *
103346     * @return string Returns a string containing the SHA-256 hash of the
103347     *   file.
103348     * @since PECL gmagick >= Unknown
103349     **/
103350    public function getimagesignature(){}
103351
103352    /**
103353     * Gets the potential image type
103354     *
103355     * @return int Returns the potential image type.
103356     * @since PECL gmagick >= Unknown
103357     **/
103358    public function getimagetype(){}
103359
103360    /**
103361     * Gets the image units of resolution
103362     *
103363     * @return int Returns the image units of resolution.
103364     * @since PECL gmagick >= Unknown
103365     **/
103366    public function getimageunits(){}
103367
103368    /**
103369     * Returns the chromaticity white point
103370     *
103371     * Returns the chromaticity white point as an associative array with the
103372     * keys "x" and "y".
103373     *
103374     * @return array Returns the chromaticity white point as an associative
103375     *   array with the keys "x" and "y".
103376     * @since PECL gmagick >= Unknown
103377     **/
103378    public function getimagewhitepoint(){}
103379
103380    /**
103381     * Returns the width of the image
103382     *
103383     * @return int Returns the image width.
103384     * @since PECL gmagick >= Unknown
103385     **/
103386    public function getimagewidth(){}
103387
103388    /**
103389     * Returns the GraphicsMagick package name
103390     *
103391     * @return string Returns the GraphicsMagick package name as a string.
103392     * @since PECL gmagick >= Unknown
103393     **/
103394    public function getpackagename(){}
103395
103396    /**
103397     * Returns the Gmagick quantum depth as a string
103398     *
103399     * @return array Returns the Gmagick quantum depth as a string.
103400     * @since PECL gmagick >= Unknown
103401     **/
103402    public function getquantumdepth(){}
103403
103404    /**
103405     * Returns the GraphicsMagick release date as a string
103406     *
103407     * @return string Returns the GraphicsMagick release date as a string.
103408     * @since PECL gmagick >= Unknown
103409     **/
103410    public function getreleasedate(){}
103411
103412    /**
103413     * Gets the horizontal and vertical sampling factor
103414     *
103415     * @return array Returns an associative array with the horizontal and
103416     *   vertical sampling factors of the image.
103417     * @since PECL gmagick >= Unknown
103418     **/
103419    public function getsamplingfactors(){}
103420
103421    /**
103422     * Returns the size associated with the Gmagick object
103423     *
103424     * Returns the size associated with the Gmagick object as an array with
103425     * the keys "columns" and "rows".
103426     *
103427     * @return array Returns the size associated with the Gmagick object as
103428     *   an array with the keys "columns" and "rows".
103429     * @since PECL gmagick >= Unknown
103430     **/
103431    public function getsize(){}
103432
103433    /**
103434     * Returns the GraphicsMagick API version
103435     *
103436     * Returns the GraphicsMagick API version as a string and as a number.
103437     *
103438     * @return array Returns the GraphicsMagick API version as a string and
103439     *   as a number.
103440     * @since PECL gmagick >= Unknown
103441     **/
103442    public function getversion(){}
103443
103444    /**
103445     * Checks if the object has more images
103446     *
103447     * Returns TRUE if the object has more images when traversing the list in
103448     * the forward direction.
103449     *
103450     * @return mixed Returns TRUE if the object has more images when
103451     *   traversing the list in the forward direction, returns FALSE if there
103452     *   are none.
103453     * @since PECL gmagick >= Unknown
103454     **/
103455    public function hasnextimage(){}
103456
103457    /**
103458     * Checks if the object has a previous image
103459     *
103460     * Returns TRUE if the object has more images when traversing the list in
103461     * the reverse direction
103462     *
103463     * @return mixed Returns TRUE if the object has more images when
103464     *   traversing the list in the reverse direction, returns FALSE if there
103465     *   are none.
103466     * @since PECL gmagick >= Unknown
103467     **/
103468    public function haspreviousimage(){}
103469
103470    /**
103471     * Creates a new image as a copy
103472     *
103473     * Creates a new image that is a copy of an existing one with the image
103474     * pixels "imploded" by the specified percentage.
103475     *
103476     * @param float $radius The radius of the implode
103477     * @return mixed Returns imploded Gmagick object.
103478     * @since PECL gmagick >= Unknown
103479     **/
103480    public function implodeimage($radius){}
103481
103482    /**
103483     * Adds a label to an image
103484     *
103485     * @param string $label The label to add
103486     * @return mixed Gmagick with label.
103487     * @since PECL gmagick >= Unknown
103488     **/
103489    public function labelimage($label){}
103490
103491    /**
103492     * Adjusts the levels of an image
103493     *
103494     * Adjusts the levels of an image by scaling the colors falling between
103495     * specified white and black points to the full available quantum range.
103496     * The parameters provided represent the black, mid, and white points.
103497     * The black point specifies the darkest color in the image. Colors
103498     * darker than the black point are set to zero. Mid point specifies a
103499     * gamma correction to apply to the image. White point specifies the
103500     * lightest color in the image. Colors brighter than the white point are
103501     * set to the maximum quantum value.
103502     *
103503     * @param float $blackPoint The image black point
103504     * @param float $gamma The gamma value
103505     * @param float $whitePoint The image white point
103506     * @param int $channel Provide any channel constant that is valid for
103507     *   your channel mode. To apply to more than one channel, combine
103508     *   channeltype constants using bitwise operators. Refer to this list of
103509     *   channel constants.
103510     * @return mixed Gmagick object with image levelled.
103511     * @since PECL gmagick >= Unknown
103512     **/
103513    public function levelimage($blackPoint, $gamma, $whitePoint, $channel){}
103514
103515    /**
103516     * Scales an image proportionally 2x
103517     *
103518     * Conveniently scales an image proportionally to twice its original
103519     * size.
103520     *
103521     * @return mixed Magnified Gmagick object.
103522     * @since PECL gmagick >= Unknown
103523     **/
103524    public function magnifyimage(){}
103525
103526    /**
103527     * Replaces the colors of an image with the closest color from a
103528     * reference image
103529     *
103530     * @param gmagick $gmagick The reference image
103531     * @param bool $dither Set this integer value to something other than
103532     *   zero to dither the mapped image
103533     * @return Gmagick Gmagick object
103534     * @since PECL gmagick >= Unknown
103535     **/
103536    public function mapimage($gmagick, $dither){}
103537
103538    /**
103539     * Applies a digital filter
103540     *
103541     * Applies a digital filter that improves the quality of a noisy image.
103542     * Each pixel is replaced by the median in a set of neighboring pixels as
103543     * defined by radius.
103544     *
103545     * @param float $radius The radius of the pixel neighborhood.
103546     * @return void Gmagick object with median filter applied.
103547     * @since PECL gmagick >= Unknown
103548     **/
103549    public function medianfilterimage($radius){}
103550
103551    /**
103552     * Scales an image proportionally to half its size
103553     *
103554     * A convenient method that scales an image proportionally to one-half
103555     * its original size
103556     *
103557     * @return Gmagick The Gmagick object on success
103558     * @since PECL gmagick >= Unknown
103559     **/
103560    public function minifyimage(){}
103561
103562    /**
103563     * Control the brightness, saturation, and hue
103564     *
103565     * Lets you control the brightness, saturation, and hue of an image. Hue
103566     * is the percentage of absolute rotation from the current position. For
103567     * example 50 results in a counter-clockwise rotation of 90 degrees, 150
103568     * results in a clockwise rotation of 90 degrees, with 0 and 200 both
103569     * resulting in a rotation of 180 degrees.
103570     *
103571     * @param float $brightness The percent change in brighness (-100 thru
103572     *   +100).
103573     * @param float $saturation The percent change in saturation (-100 thru
103574     *   +100)
103575     * @param float $hue The percent change in hue (-100 thru +100)
103576     * @return Gmagick The Gmagick object on success
103577     * @since PECL gmagick >= Unknown
103578     **/
103579    public function modulateimage($brightness, $saturation, $hue){}
103580
103581    /**
103582     * Simulates motion blur
103583     *
103584     * Simulates motion blur. We convolve the image with a Gaussian operator
103585     * of the given radius and standard deviation (sigma). For reasonable
103586     * results, radius should be larger than sigma. Use a radius of 0 and
103587     * MotionBlurImage() selects a suitable radius for you. Angle gives the
103588     * angle of the blurring motion.
103589     *
103590     * @param float $radius The radius of the Gaussian, in pixels, not
103591     *   counting the center pixel.
103592     * @param float $sigma The standard deviation of the Gaussian, in
103593     *   pixels.
103594     * @param float $angle Apply the effect along this angle.
103595     * @return Gmagick The Gmagick object on success
103596     * @since PECL gmagick >= Unknown
103597     **/
103598    public function motionblurimage($radius, $sigma, $angle){}
103599
103600    /**
103601     * Creates a new image
103602     *
103603     * Creates a new image with the specified background color
103604     *
103605     * @param int $width Width of the new image
103606     * @param int $height Height of the new image
103607     * @param string $background The background color used for this image
103608     *   (as float)
103609     * @param string $format Image format.
103610     * @return Gmagick The Gmagick object on success
103611     * @since PECL gmagick >= Unknown
103612     **/
103613    public function newimage($width, $height, $background, $format){}
103614
103615    /**
103616     * Moves to the next image
103617     *
103618     * Associates the next image in the image list with an Gmagick object.
103619     *
103620     * @return bool
103621     * @since PECL gmagick >= Unknown
103622     **/
103623    public function nextimage(){}
103624
103625    /**
103626     * Enhances the contrast of a color image
103627     *
103628     * Enhances the contrast of a color image by adjusting the pixels color
103629     * to span the entire range of colors available.
103630     *
103631     * @param int $channel Identify which channel to normalize
103632     * @return Gmagick The Gmagick object on success
103633     * @since PECL gmagick >= Unknown
103634     **/
103635    public function normalizeimage($channel){}
103636
103637    /**
103638     * Simulates an oil painting
103639     *
103640     * Applies a special effect filter that simulates an oil painting. Each
103641     * pixel is replaced by the most frequent color occurring in a circular
103642     * region defined by radius.
103643     *
103644     * @param float $radius The radius of the circular neighborhood.
103645     * @return Gmagick The Gmagick object on success
103646     * @since PECL gmagick >= Unknown
103647     **/
103648    public function oilpaintimage($radius){}
103649
103650    /**
103651     * Move to the previous image in the object
103652     *
103653     * Associates the previous image in an image list with the Gmagick
103654     * object.
103655     *
103656     * @return bool
103657     * @since PECL gmagick >= Unknown
103658     **/
103659    public function previousimage(){}
103660
103661    /**
103662     * Adds or removes a profile from an image
103663     *
103664     * Adds or removes a ICC, IPTC, or generic profile from an image. If the
103665     * profile is NULL, it is removed from the image otherwise added. Use a
103666     * name of '*' and a profile of NULL to remove all profiles from the
103667     * image.
103668     *
103669     * @param string $name Name of profile to add or remove: ICC, IPTC, or
103670     *   generic profile.
103671     * @param string $profile The profile.
103672     * @return Gmagick The Gmagick object on success
103673     * @since PECL gmagick >= Unknown
103674     **/
103675    public function profileimage($name, $profile){}
103676
103677    /**
103678     * Analyzes the colors within a reference image
103679     *
103680     * Analyzes the colors within a reference image and chooses a fixed
103681     * number of colors to represent the image. The goal of the algorithm is
103682     * to minimize the color difference between the input and output image
103683     * while minimizing the processing time.
103684     *
103685     * @param int $numColors The number of colors.
103686     * @param int $colorspace Perform color reduction in this colorspace,
103687     *   typically RGBColorspace.
103688     * @param int $treeDepth Normally, this integer value is zero or one. A
103689     *   zero or one tells Quantize to choose a optimal tree depth of
103690     *   Log4(number_colors).% A tree of this depth generally allows the best
103691     *   representation of the reference image with the least amount of
103692     *   memory and the fastest computational speed. In some cases, such as
103693     *   an image with low color dispersion (a few number of colors), a value
103694     *   other than Log4(number_colors) is required. To expand the color tree
103695     *   completely, use a value of 8.
103696     * @param bool $dither A value other than zero distributes the
103697     *   difference between an original image and the corresponding color
103698     *   reduced algorithm to neighboring pixels along a Hilbert curve.
103699     * @param bool $measureError A value other than zero measures the
103700     *   difference between the original and quantized images. This
103701     *   difference is the total quantization error. The error is computed by
103702     *   summing over all pixels in an image the distance squared in RGB
103703     *   space between each reference pixel value and its quantized value.
103704     * @return Gmagick The Gmagick object on success
103705     * @since PECL gmagick >= Unknown
103706     **/
103707    public function quantizeimage($numColors, $colorspace, $treeDepth, $dither, $measureError){}
103708
103709    /**
103710     * The quantizeimages purpose
103711     *
103712     * Analyzes the colors within a sequence of images and chooses a fixed
103713     * number of colors to represent the image. The goal of the algorithm is
103714     * to minimize the color difference between the input and output image
103715     * while minimizing the processing time.
103716     *
103717     * @param int $numColors The number of colors.
103718     * @param int $colorspace Perform color reduction in this colorspace,
103719     *   typically RGBColorspace.
103720     * @param int $treeDepth Normally, this integer value is zero or one. A
103721     *   zero or one tells Quantize to choose a optimal tree depth of
103722     *   Log4(number_colors).% A tree of this depth generally allows the best
103723     *   representation of the reference image with the least amount of
103724     *   memory and the fastest computational speed. In some cases, such as
103725     *   an image with low color dispersion (a few number of colors), a value
103726     *   other than Log4(number_colors) is required. To expand the color tree
103727     *   completely, use a value of 8.
103728     * @param bool $dither A value other than zero distributes the
103729     *   difference between an original image and the corresponding color
103730     *   reduced algorithm to neighboring pixels along a Hilbert curve.
103731     * @param bool $measureError A value other than zero measures the
103732     *   difference between the original and quantized images. This
103733     *   difference is the total quantization error. The error is computed by
103734     *   summing over all pixels in an image the distance squared in RGB
103735     *   space between each reference pixel value and its quantized value.
103736     * @return Gmagick The Gmagick object on success
103737     * @since PECL gmagick >= Unknown
103738     **/
103739    public function quantizeimages($numColors, $colorspace, $treeDepth, $dither, $measureError){}
103740
103741    /**
103742     * Returns an array representing the font metrics
103743     *
103744     * MagickQueryFontMetrics() returns an array representing the font
103745     * metrics.
103746     *
103747     * @param GmagickDraw $draw
103748     * @param string $text
103749     * @return array The Gmagick object on success
103750     * @since PECL gmagick >= Unknown
103751     **/
103752    public function queryfontmetrics($draw, $text){}
103753
103754    /**
103755     * Returns the configured fonts
103756     *
103757     * Returns fonts supported by Gmagick.
103758     *
103759     * @param string $pattern
103760     * @return array The Gmagick object on success
103761     * @since PECL gmagick >= Unknown
103762     **/
103763    public function queryfonts($pattern){}
103764
103765    /**
103766     * Returns formats supported by Gmagick
103767     *
103768     * @param string $pattern Specifies a string containing a pattern.
103769     * @return array The Gmagick object on success
103770     * @since PECL gmagick >= Unknown
103771     **/
103772    public function queryformats($pattern){}
103773
103774    /**
103775     * Radial blurs an image
103776     *
103777     * @param float $angle The angle of the blur in degrees.
103778     * @param int $channel Related channel
103779     * @return Gmagick The Gmagick object on success
103780     * @since PECL gmagick >= Unknown
103781     **/
103782    public function radialblurimage($angle, $channel){}
103783
103784    /**
103785     * Creates a simulated 3d button-like effect
103786     *
103787     * Creates a simulated three-dimensional button-like effect by lightening
103788     * and darkening the edges of the image. Members width and height of
103789     * raise_info define the width of the vertical and horizontal edge of the
103790     * effect.
103791     *
103792     * @param int $width Width of the area to raise.
103793     * @param int $height Height of the area to raise.
103794     * @param int $x X coordinate
103795     * @param int $y Y coordinate
103796     * @param bool $raise A value other than zero creates a 3-D raise
103797     *   effect, otherwise it has a lowered effect.
103798     * @return Gmagick The Gmagick object on success
103799     * @since PECL gmagick >= Unknown
103800     **/
103801    public function raiseimage($width, $height, $x, $y, $raise){}
103802
103803    /**
103804     * Reads image from filename
103805     *
103806     * @param string $filename The image filename.
103807     * @return Gmagick The Gmagick object on success
103808     * @since PECL gmagick >= Unknown
103809     **/
103810    public function read($filename){}
103811
103812    /**
103813     * Reads image from filename
103814     *
103815     * @param string $filename The image filename.
103816     * @return Gmagick The Gmagick object on success
103817     * @since PECL gmagick >= Unknown
103818     **/
103819    public function readimage($filename){}
103820
103821    /**
103822     * Reads image from a binary string
103823     *
103824     * @param string $imageContents Content of image
103825     * @param string $filename The image filename.
103826     * @return Gmagick The Gmagick object on success
103827     * @since PECL gmagick >= Unknown
103828     **/
103829    public function readimageblob($imageContents, $filename){}
103830
103831    /**
103832     * The readimagefile purpose
103833     *
103834     * Reads an image or image sequence from an open file descriptor.
103835     *
103836     * @param resource $fp The file descriptor.
103837     * @param string $filename
103838     * @return Gmagick The Gmagick object on success
103839     * @since PECL gmagick >= Unknown
103840     **/
103841    public function readimagefile($fp, $filename){}
103842
103843    /**
103844     * Smooths the contours of an image
103845     *
103846     * Smooths the contours of an image while still preserving edge
103847     * information. The algorithm works by replacing each pixel with its
103848     * neighbor closest in value. A neighbor is defined by radius. Use a
103849     * radius of 0 and Gmagick::reduceNoiseImage() selects a suitable radius
103850     * for you.
103851     *
103852     * @param float $radius The radius of the pixel neighborhood.
103853     * @return Gmagick The Gmagick object on success
103854     * @since PECL gmagick >= Unknown
103855     **/
103856    public function reducenoiseimage($radius){}
103857
103858    /**
103859     * Removes an image from the image list
103860     *
103861     * @return Gmagick The Gmagick object on success.
103862     * @since PECL gmagick >= Unknown
103863     **/
103864    public function removeimage(){}
103865
103866    /**
103867     * Removes the named image profile and returns it
103868     *
103869     * @param string $name Name of profile to return: ICC, IPTC, or generic
103870     *   profile.
103871     * @return string The named profile.
103872     * @since PECL gmagick >= Unknown
103873     **/
103874    public function removeimageprofile($name){}
103875
103876    /**
103877     * Resample image to desired resolution
103878     *
103879     * @param float $xResolution The new image x resolution.
103880     * @param float $yResolution The new image y resolution.
103881     * @param int $filter Image filter to use.
103882     * @param float $blur The blur factor where larger than 1 is blurry,
103883     *   smaller than 1 is sharp.
103884     * @return Gmagick The Gmagick object on success
103885     * @since PECL gmagick >= Unknown
103886     **/
103887    public function resampleimage($xResolution, $yResolution, $filter, $blur){}
103888
103889    /**
103890     * Scales an image
103891     *
103892     * Scales an image to the desired dimensions with a filter.
103893     *
103894     * @param int $width The number of columns in the scaled image.
103895     * @param int $height The number of rows in the scaled image.
103896     * @param int $filter Image filter to use.
103897     * @param float $blur The blur factor where larger than 1 is blurry,
103898     *   lesser than 1 is sharp.
103899     * @param bool $fit
103900     * @return Gmagick The Gmagick object on success
103901     * @since PECL gmagick >= Unknown
103902     **/
103903    public function resizeimage($width, $height, $filter, $blur, $fit){}
103904
103905    /**
103906     * Offsets an image
103907     *
103908     * Offsets an image as defined by x and y.
103909     *
103910     * @param int $x The x offset.
103911     * @param int $y The y offset.
103912     * @return Gmagick The Gmagick object on success
103913     * @since PECL gmagick >= Unknown
103914     **/
103915    public function rollimage($x, $y){}
103916
103917    /**
103918     * Rotates an image
103919     *
103920     * Rotates an image the specified number of degrees. Empty triangles left
103921     * over from rotating the image are filled with the background color.
103922     *
103923     * @param mixed $color The background pixel.
103924     * @param float $degrees The number of degrees to rotate the image.
103925     * @return Gmagick The Gmagick object on success
103926     * @since PECL gmagick >= Unknown
103927     **/
103928    public function rotateimage($color, $degrees){}
103929
103930    /**
103931     * Scales the size of an image
103932     *
103933     * Scales the size of an image to the given dimensions. The other
103934     * parameter will be calculated if 0 is passed as either param.
103935     *
103936     * @param int $width The number of columns in the scaled image.
103937     * @param int $height The number of rows in the scaled image.
103938     * @param bool $fit
103939     * @return Gmagick The Gmagick object on success.
103940     * @since PECL gmagick >= Unknown
103941     **/
103942    public function scaleimage($width, $height, $fit){}
103943
103944    /**
103945     * Separates a channel from the image
103946     *
103947     * Separates a channel from the image and returns a grayscale image. A
103948     * channel is a particular color component of each pixel in the image.
103949     *
103950     * @param int $channel Identify which channel to extract: RedChannel,
103951     *   GreenChannel, BlueChannel, OpacityChannel, CyanChannel,
103952     *   MagentaChannel, YellowChannel, BlackChannel.
103953     * @return Gmagick The Gmagick object on success
103954     * @since PECL gmagick >= Unknown
103955     **/
103956    public function separateimagechannel($channel){}
103957
103958    /**
103959     * Sets the object's default compression quality
103960     *
103961     * @param int $quality
103962     * @return Gmagick The Gmagick object on success
103963     **/
103964    function setCompressionQuality($quality){}
103965
103966    /**
103967     * Sets the filename before you read or write the image
103968     *
103969     * Sets the filename before you read or write an image file.
103970     *
103971     * @param string $filename The image filename.
103972     * @return Gmagick The Gmagick object on success
103973     * @since PECL gmagick >= Unknown
103974     **/
103975    public function setfilename($filename){}
103976
103977    /**
103978     * Sets the image background color
103979     *
103980     * @param GmagickPixel $color The background pixel wand.
103981     * @return Gmagick The Gmagick object on success
103982     * @since PECL gmagick >= Unknown
103983     **/
103984    public function setimagebackgroundcolor($color){}
103985
103986    /**
103987     * Sets the image chromaticity blue primary point
103988     *
103989     * @param float $x The blue primary x-point.
103990     * @param float $y The blue primary y-point.
103991     * @return Gmagick The Gmagick object on success
103992     * @since PECL gmagick >= Unknown
103993     **/
103994    public function setimageblueprimary($x, $y){}
103995
103996    /**
103997     * Sets the image border color
103998     *
103999     * @param GmagickPixel $color The border pixel wand.
104000     * @return Gmagick The Gmagick object on success
104001     * @since PECL gmagick >= Unknown
104002     **/
104003    public function setimagebordercolor($color){}
104004
104005    /**
104006     * Sets the depth of a particular image channel
104007     *
104008     * @param int $channel Identify which channel to extract: RedChannel,
104009     *   GreenChannel, BlueChannel, OpacityChannel, CyanChannel,
104010     *   MagentaChannel, YellowChannel, BlackChannel.
104011     * @param int $depth The image depth in bits.
104012     * @return Gmagick The Gmagick object on success
104013     * @since PECL gmagick >= Unknown
104014     **/
104015    public function setimagechanneldepth($channel, $depth){}
104016
104017    /**
104018     * Sets the image colorspace
104019     *
104020     * @param int $colorspace The image colorspace: UndefinedColorspace,
104021     *   RGBColorspace, GRAYColorspace, TransparentColorspace,
104022     *   OHTAColorspace, XYZColorspace, YCbCrColorspace, YCCColorspace,
104023     *   YIQColorspace, YPbPrColorspace, YPbPrColorspace, YUVColorspace,
104024     *   CMYKColorspace, sRGBColorspace, HSLColorspace, or HWBColorspace.
104025     * @return Gmagick The Gmagick object on success
104026     * @since PECL gmagick >= Unknown
104027     **/
104028    public function setimagecolorspace($colorspace){}
104029
104030    /**
104031     * Sets the image composite operator
104032     *
104033     * @param int $composite The image composite operator.
104034     * @return Gmagick The Gmagick object on success
104035     * @since PECL gmagick >= Unknown
104036     **/
104037    public function setimagecompose($composite){}
104038
104039    /**
104040     * Sets the image delay
104041     *
104042     * @param int $delay The image delay in 1/100th of a second.
104043     * @return Gmagick The Gmagick object on success.
104044     * @since PECL gmagick >= Unknown
104045     **/
104046    public function setimagedelay($delay){}
104047
104048    /**
104049     * Sets the image depth
104050     *
104051     * @param int $depth The image depth in bits: 8, 16, or 32.
104052     * @return Gmagick The Gmagick object on success.
104053     * @since PECL gmagick >= Unknown
104054     **/
104055    public function setimagedepth($depth){}
104056
104057    /**
104058     * Sets the image disposal method
104059     *
104060     * @param int $disposeType The image disposal type.
104061     * @return Gmagick The Gmagick object on success
104062     * @since PECL gmagick >= Unknown
104063     **/
104064    public function setimagedispose($disposeType){}
104065
104066    /**
104067     * Sets the filename of a particular image in a sequence
104068     *
104069     * @param string $filename The image filename.
104070     * @return Gmagick The Gmagick object on success.
104071     * @since PECL gmagick >= Unknown
104072     **/
104073    public function setimagefilename($filename){}
104074
104075    /**
104076     * Sets the format of a particular image
104077     *
104078     * Sets the format of a particular image in a sequence.
104079     *
104080     * @param string $imageFormat The image format.
104081     * @return Gmagick The Gmagick object on success.
104082     * @since PECL gmagick >= Unknown
104083     **/
104084    public function setimageformat($imageFormat){}
104085
104086    /**
104087     * Sets the image gamma
104088     *
104089     * @param float $gamma The image gamma.
104090     * @return Gmagick The Gmagick object on success
104091     * @since PECL gmagick >= Unknown
104092     **/
104093    public function setimagegamma($gamma){}
104094
104095    /**
104096     * Sets the image chromaticity green primary point
104097     *
104098     * @param float $x The chromaticity green primary x-point.
104099     * @param float $y The chromaticity green primary y-point.
104100     * @return Gmagick The Gmagick object on success.
104101     * @since PECL gmagick >= Unknown
104102     **/
104103    public function setimagegreenprimary($x, $y){}
104104
104105    /**
104106     * Set the iterator to the position in the image list specified with the
104107     * index parameter
104108     *
104109     * @param int $index The scene number.
104110     * @return Gmagick The Gmagick object on success.
104111     * @since PECL gmagick >= Unknown
104112     **/
104113    public function setimageindex($index){}
104114
104115    /**
104116     * Sets the interlace scheme of the image
104117     *
104118     * @param int $interlace The image interlace scheme: NoInterlace,
104119     *   LineInterlace, PlaneInterlace, PartitionInterlace.
104120     * @return Gmagick The Gmagick object on success
104121     * @since PECL gmagick >= Unknown
104122     **/
104123    public function setimageinterlacescheme($interlace){}
104124
104125    /**
104126     * Sets the image iterations
104127     *
104128     * @param int $iterations The image delay in 1/100th of a second.
104129     * @return Gmagick The Gmagick object on success.
104130     * @since PECL gmagick >= Unknown
104131     **/
104132    public function setimageiterations($iterations){}
104133
104134    /**
104135     * Adds a named profile to the Gmagick object
104136     *
104137     * Adds a named profile to the Gmagick object. If a profile with the same
104138     * name already exists, it is replaced. This method differs from the
104139     * Gmagick::profileimage() method in that it does not apply any CMS color
104140     * profiles.
104141     *
104142     * @param string $name Name of profile to add or remove: ICC, IPTC, or
104143     *   generic profile.
104144     * @param string $profile The profile.
104145     * @return Gmagick The Gmagick object on success.
104146     * @since PECL gmagick >= Unknown
104147     **/
104148    public function setimageprofile($name, $profile){}
104149
104150    /**
104151     * Sets the image chromaticity red primary point
104152     *
104153     * @param float $x The red primary x-point.
104154     * @param float $y The red primary y-point.
104155     * @return Gmagick The Gmagick object on success.
104156     * @since PECL gmagick >= Unknown
104157     **/
104158    public function setimageredprimary($x, $y){}
104159
104160    /**
104161     * Sets the image rendering intent
104162     *
104163     * @param int $rendering_intent The image rendering intent:
104164     *   UndefinedIntent, SaturationIntent, PerceptualIntent, AbsoluteIntent,
104165     *   or RelativeIntent.
104166     * @return Gmagick The Gmagick object on success.
104167     * @since PECL gmagick >= Unknown
104168     **/
104169    public function setimagerenderingintent($rendering_intent){}
104170
104171    /**
104172     * Sets the image resolution
104173     *
104174     * @param float $xResolution The image x resolution.
104175     * @param float $yResolution The image y resolution.
104176     * @return Gmagick The Gmagick object on success.
104177     * @since PECL gmagick >= Unknown
104178     **/
104179    public function setimageresolution($xResolution, $yResolution){}
104180
104181    /**
104182     * Sets the image scene
104183     *
104184     * @param int $scene The image scene number.
104185     * @return Gmagick The Gmagick object on success.
104186     * @since PECL gmagick >= Unknown
104187     **/
104188    public function setimagescene($scene){}
104189
104190    /**
104191     * Sets the image type
104192     *
104193     * @param int $imgType The image type: UndefinedType, BilevelType,
104194     *   GrayscaleType, GrayscaleMatteType, PaletteType, PaletteMatteType,
104195     *   TrueColorType, TrueColorMatteType, ColorSeparationType,
104196     *   ColorSeparationMatteType, or OptimizeType.
104197     * @return Gmagick The Gmagick object on success.
104198     * @since PECL gmagick >= Unknown
104199     **/
104200    public function setimagetype($imgType){}
104201
104202    /**
104203     * Sets the image units of resolution
104204     *
104205     * @param int $resolution The image units of resolution :
104206     *   Undefinedresolution, PixelsPerInchResolution, or
104207     *   PixelsPerCentimeterResolution.
104208     * @return Gmagick The Gmagick object on success.
104209     * @since PECL gmagick >= Unknown
104210     **/
104211    public function setimageunits($resolution){}
104212
104213    /**
104214     * Sets the image chromaticity white point
104215     *
104216     * @param float $x The white x-point.
104217     * @param float $y The white y-point.
104218     * @return Gmagick The Gmagick object on success.
104219     * @since PECL gmagick >= Unknown
104220     **/
104221    public function setimagewhitepoint($x, $y){}
104222
104223    /**
104224     * Sets the image sampling factors
104225     *
104226     * @param array $factors An array of doubles representing the sampling
104227     *   factor for each color component (in RGB order).
104228     * @return Gmagick The Gmagick object on success.
104229     * @since PECL gmagick >= Unknown
104230     **/
104231    public function setsamplingfactors($factors){}
104232
104233    /**
104234     * Sets the size of the Gmagick object
104235     *
104236     * Sets the size of the Gmagick object. Set it before you read a raw
104237     * image format such as RGB, GRAY, or CMYK.
104238     *
104239     * @param int $columns The width in pixels.
104240     * @param int $rows The height in pixels.
104241     * @return Gmagick The Gmagick object on success.
104242     * @since PECL gmagick >= Unknown
104243     **/
104244    public function setsize($columns, $rows){}
104245
104246    /**
104247     * Creating a parallelogram
104248     *
104249     * Slides one edge of an image along the X or Y axis, creating a
104250     * parallelogram. An X direction shear slides an edge along the X axis,
104251     * while a Y direction shear slides an edge along the Y axis. The amount
104252     * of the shear is controlled by a shear angle. For X direction shears,
104253     * x_shear is measured relative to the Y axis, and similarly, for Y
104254     * direction shears y_shear is measured relative to the X axis. Empty
104255     * triangles left over from shearing the image are filled with the
104256     * background color.
104257     *
104258     * @param mixed $color The background pixel wand.
104259     * @param float $xShear The number of degrees to shear the image.
104260     * @param float $yShear The number of degrees to shear the image.
104261     * @return Gmagick The Gmagick object on success
104262     * @since PECL gmagick >= Unknown
104263     **/
104264    public function shearimage($color, $xShear, $yShear){}
104265
104266    /**
104267     * Applies a solarizing effect to the image
104268     *
104269     * Applies a special effect to the image, similar to the effect achieved
104270     * in a photo darkroom by selectively exposing areas of photo sensitive
104271     * paper to light. Threshold ranges from 0 to QuantumRange and is a
104272     * measure of the extent of the solarization.
104273     *
104274     * @param int $threshold Define the extent of the solarization.
104275     * @return Gmagick The Gmagick object on success.
104276     * @since PECL gmagick >= Unknown
104277     **/
104278    public function solarizeimage($threshold){}
104279
104280    /**
104281     * Randomly displaces each pixel in a block
104282     *
104283     * Special effects method that randomly displaces each pixel in a block
104284     * defined by the radius parameter.
104285     *
104286     * @param float $radius Choose a random pixel in a neighborhood of this
104287     *   extent.
104288     * @return Gmagick The Gmagick object on success
104289     * @since PECL gmagick >= Unknown
104290     **/
104291    public function spreadimage($radius){}
104292
104293    /**
104294     * Strips an image of all profiles and comments
104295     *
104296     * @return Gmagick The Gmagick object on success
104297     * @since PECL gmagick >= Unknown
104298     **/
104299    public function stripimage(){}
104300
104301    /**
104302     * Swirls the pixels about the center of the image
104303     *
104304     * Swirls the pixels about the center of the image, where degrees
104305     * indicates the sweep of the arc through which each pixel is moved. You
104306     * get a more dramatic effect as the degrees move from 1 to 360.
104307     *
104308     * @param float $degrees Define the tightness of the swirling effect.
104309     * @return Gmagick The Gmagick object on success
104310     * @since PECL gmagick >= Unknown
104311     **/
104312    public function swirlimage($degrees){}
104313
104314    /**
104315     * Changes the size of an image
104316     *
104317     * Changes the size of an image to the given dimensions and removes any
104318     * associated profiles. The goal is to produce small low cost thumbnail
104319     * images suited for display on the Web. If TRUE is given as a third
104320     * parameter then columns and rows parameters are used as maximums for
104321     * each side. Both sides will be scaled down until the match or are
104322     * smaller than the parameter given for the side.
104323     *
104324     * @param int $width Image width
104325     * @param int $height Image height
104326     * @param bool $fit
104327     * @return Gmagick The Gmagick object on success.
104328     * @since PECL gmagick >= Unknown
104329     **/
104330    public function thumbnailimage($width, $height, $fit){}
104331
104332    /**
104333     * Remove edges from the image
104334     *
104335     * Remove edges that are the background color from the image.
104336     *
104337     * @param float $fuzz By default target must match a particular pixel
104338     *   color exactly. However, in many cases two colors may differ by a
104339     *   small amount. The fuzz member of image defines how much tolerance is
104340     *   acceptable to consider two colors as the same. This parameter
104341     *   represents the variation on the quantum range.
104342     * @return Gmagick The Gmagick object
104343     * @since PECL gmagick >= Unknown
104344     **/
104345    public function trimimage($fuzz){}
104346
104347    /**
104348     * Writes an image to the specified filename
104349     *
104350     * Writes an image to the specified filename. If the filename parameter
104351     * is NULL, the image is written to the filename set by
104352     * Gmagick::ReadImage() or Gmagick::SetImageFilename().
104353     *
104354     * @param string $filename The image filename.
104355     * @param bool $all_frames
104356     * @return Gmagick The Gmagick object
104357     * @since PECL gmagick >= Unknown
104358     **/
104359    public function writeimage($filename, $all_frames){}
104360
104361    /**
104362     * The Gmagick constructor
104363     *
104364     * @param string $filename The path to an image to load or array of
104365     *   paths
104366     * @since PECL gmagick >= Unknown
104367     **/
104368    public function __construct($filename){}
104369
104370}
104371class GmagickDraw {
104372    /**
104373     * Draws text on the image
104374     *
104375     * @param float $x x ordinate to left of text
104376     * @param float $y y ordinate to text baseline
104377     * @param string $text text to draw
104378     * @return GmagickDraw The GmagickDraw object on success.
104379     * @since PECL gmagick >= Unknown
104380     **/
104381    public function annotate($x, $y, $text){}
104382
104383    /**
104384     * Draws an arc
104385     *
104386     * Draws an arc falling within a specified bounding rectangle on the
104387     * image.
104388     *
104389     * @param float $sx starting x ordinate of bounding rectangle
104390     * @param float $sy starting y ordinate of bounding rectangle
104391     * @param float $ex ending x ordinate of bounding rectangle
104392     * @param float $ey ending y ordinate of bounding rectangle
104393     * @param float $sd starting degrees of rotation
104394     * @param float $ed ending degrees of rotation
104395     * @return GmagickDraw The GmagickDraw object on success.
104396     * @since PECL gmagick >= Unknown
104397     **/
104398    public function arc($sx, $sy, $ex, $ey, $sd, $ed){}
104399
104400    /**
104401     * Draws a bezier curve
104402     *
104403     * Draws a bezier curve through a set of points on the image.
104404     *
104405     * @param array $coordinate_array Coordinates array
104406     * @return GmagickDraw The GmagickDraw object on success
104407     * @since PECL gmagick >= Unknown
104408     **/
104409    public function bezier($coordinate_array){}
104410
104411    /**
104412     * Draws an ellipse on the image
104413     *
104414     * @param float $ox origin x ordinate
104415     * @param float $oy origin y ordinate
104416     * @param float $rx radius in x
104417     * @param float $ry radius in y
104418     * @param float $start starting rotation in degrees
104419     * @param float $end ending rotation in degrees
104420     * @return GmagickDraw The GmagickDraw object on success
104421     * @since PECL gmagick >= Unknown
104422     **/
104423    public function ellipse($ox, $oy, $rx, $ry, $start, $end){}
104424
104425    /**
104426     * Returns the fill color
104427     *
104428     * Returns the fill color used for drawing filled objects.
104429     *
104430     * @return GmagickPixel The GmagickPixel fill color used for drawing
104431     *   filled objects.
104432     * @since PECL gmagick >= Unknown
104433     **/
104434    public function getfillcolor(){}
104435
104436    /**
104437     * Returns the opacity used when drawing
104438     *
104439     * @return float Returns the opacity used when drawing using the fill
104440     *   color or fill texture. Fully opaque is 1.0.
104441     * @since PECL gmagick >= Unknown
104442     **/
104443    public function getfillopacity(){}
104444
104445    /**
104446     * Returns the font
104447     *
104448     * Returns a string specifying the font used when annotating with text.
104449     *
104450     * @return mixed Returns a string on success and FALSE if no font is
104451     *   set.
104452     * @since PECL gmagick >= Unknown
104453     **/
104454    public function getfont(){}
104455
104456    /**
104457     * Returns the font pointsize
104458     *
104459     * Returns the font pointsize used when annotating with text.
104460     *
104461     * @return float Returns the font size associated with the current
104462     *   GmagickDraw object.
104463     * @since PECL gmagick >= Unknown
104464     **/
104465    public function getfontsize(){}
104466
104467    /**
104468     * Returns the font style
104469     *
104470     * Returns the font style used when annotating with text.
104471     *
104472     * @return int Returns the font style constant (STYLE_) associated with
104473     *   the GmagickDraw object or 0 if no style is set.
104474     * @since PECL gmagick >= Unknown
104475     **/
104476    public function getfontstyle(){}
104477
104478    /**
104479     * Returns the font weight
104480     *
104481     * Returns the font weight used when annotating with text.
104482     *
104483     * @return int Returns an int on success and 0 if no weight is set.
104484     * @since PECL gmagick >= Unknown
104485     **/
104486    public function getfontweight(){}
104487
104488    /**
104489     * Returns the color used for stroking object outlines
104490     *
104491     * @return GmagickPixel Returns an GmagickPixel object which describes
104492     *   the color.
104493     * @since PECL gmagick >= Unknown
104494     **/
104495    public function getstrokecolor(){}
104496
104497    /**
104498     * Returns the opacity of stroked object outlines
104499     *
104500     * @return float Returns a double describing the opacity.
104501     * @since PECL gmagick >= Unknown
104502     **/
104503    public function getstrokeopacity(){}
104504
104505    /**
104506     * Returns the width of the stroke used to draw object outlines
104507     *
104508     * @return float Returns a double describing the stroke width.
104509     * @since PECL gmagick >= Unknown
104510     **/
104511    public function getstrokewidth(){}
104512
104513    /**
104514     * Returns the text decoration
104515     *
104516     * Returns the decoration applied when annotating with text.
104517     *
104518     * @return int Returns one of the DECORATION_ constants and 0 if no
104519     *   decoration is set.
104520     * @since PECL gmagick >= Unknown
104521     **/
104522    public function gettextdecoration(){}
104523
104524    /**
104525     * Returns the code set used for text annotations
104526     *
104527     * Returns a string which specifies the code set used for text
104528     * annotations.
104529     *
104530     * @return mixed Returns a string specifying the code set or FALSE if
104531     *   text encoding is not set.
104532     * @since PECL gmagick >= Unknown
104533     **/
104534    public function gettextencoding(){}
104535
104536    /**
104537     * The line purpose
104538     *
104539     * Draws a line on the image using the current stroke color, stroke
104540     * opacity, and stroke width.
104541     *
104542     * @param float $sx starting x ordinate
104543     * @param float $sy starting y ordinate
104544     * @param float $ex ending x ordinate
104545     * @param float $ey ending y ordinate
104546     * @return GmagickDraw The GmagickDraw object on success
104547     * @since PECL gmagick >= Unknown
104548     **/
104549    public function line($sx, $sy, $ex, $ey){}
104550
104551    /**
104552     * Draws a point
104553     *
104554     * Draws a point using the current stroke color and stroke thickness at
104555     * the specified coordinates.
104556     *
104557     * @param float $x target x coordinate
104558     * @param float $y target y coordinate
104559     * @return GmagickDraw The GmagickDraw object on success
104560     * @since PECL gmagick >= Unknown
104561     **/
104562    public function point($x, $y){}
104563
104564    /**
104565     * Draws a polygon
104566     *
104567     * Draws a polygon using the current stroke, stroke width, and fill color
104568     * or texture, using the specified array of coordinates.
104569     *
104570     * @param array $coordinates coordinate array
104571     * @return GmagickDraw The GmagickDraw object on success
104572     * @since PECL gmagick >= Unknown
104573     **/
104574    public function polygon($coordinates){}
104575
104576    /**
104577     * Draws a polyline
104578     *
104579     * Draws a polyline using the current stroke, stroke width, and fill
104580     * color or texture, using the specified array of coordinates.
104581     *
104582     * @param array $coordinate_array The array of coordinates
104583     * @return GmagickDraw The GmagickDraw object on success
104584     * @since PECL gmagick >= Unknown
104585     **/
104586    public function polyline($coordinate_array){}
104587
104588    /**
104589     * Draws a rectangle
104590     *
104591     * Draws a rectangle given two coordinates and using the current stroke,
104592     * stroke width, and fill settings.
104593     *
104594     * @param float $x1 x ordinate of first coordinate
104595     * @param float $y1 y ordinate of first coordinate
104596     * @param float $x2 x ordinate of second coordinate
104597     * @param float $y2 y ordinate of second coordinate
104598     * @return GmagickDraw The GmagickDraw object on success
104599     * @since PECL gmagick >= Unknown
104600     **/
104601    public function rectangle($x1, $y1, $x2, $y2){}
104602
104603    /**
104604     * Applies the specified rotation to the current coordinate space
104605     *
104606     * @param float $degrees degrees of rotation
104607     * @return GmagickDraw The GmagickDraw object on success
104608     * @since PECL gmagick >= Unknown
104609     **/
104610    public function rotate($degrees){}
104611
104612    /**
104613     * Draws a rounded rectangle
104614     *
104615     * Draws a rounded rectangle given two coordinates, x and y corner
104616     * radiuses and using the current stroke, stroke width, and fill
104617     * settings.
104618     *
104619     * @param float $x1 x ordinate of first coordinate
104620     * @param float $y1 y ordinate of first coordinate
104621     * @param float $x2 x ordinate of second coordinate
104622     * @param float $y2 y ordinate of second coordinate
104623     * @param float $rx radius of corner in horizontal direction
104624     * @param float $ry radius of corner in vertical direction
104625     * @return GmagickDraw The GmagickDraw object on success
104626     * @since PECL gmagick >= Unknown
104627     **/
104628    public function roundrectangle($x1, $y1, $x2, $y2, $rx, $ry){}
104629
104630    /**
104631     * Adjusts the scaling factor
104632     *
104633     * Adjusts the scaling factor to apply in the horizontal and vertical
104634     * directions to the current coordinate space.
104635     *
104636     * @param float $x horizontal scale factor
104637     * @param float $y vertical scale factor
104638     * @return GmagickDraw The GmagickDraw object on success
104639     * @since PECL gmagick >= Unknown
104640     **/
104641    public function scale($x, $y){}
104642
104643    /**
104644     * Sets the fill color to be used for drawing filled objects
104645     *
104646     * @param mixed $color GmagickPixel or string indicating color to use
104647     *   for filling.
104648     * @return GmagickDraw The GmagickDraw object on success.
104649     * @since PECL gmagick >= Unknown
104650     **/
104651    public function setfillcolor($color){}
104652
104653    /**
104654     * The setfillopacity purpose
104655     *
104656     * Sets the opacity to use when drawing using the fill color or fill
104657     * texture. Setting it to 1.0 will make fill full opaque.
104658     *
104659     * @param float $fill_opacity Fill opacity
104660     * @return GmagickDraw The GmagickDraw object on success
104661     * @since PECL gmagick >= Unknown
104662     **/
104663    public function setfillopacity($fill_opacity){}
104664
104665    /**
104666     * Sets the fully-specified font to use when annotating with text
104667     *
104668     * @param string $font font name
104669     * @return GmagickDraw The GmagickDraw object on success
104670     * @since PECL gmagick >= Unknown
104671     **/
104672    public function setfont($font){}
104673
104674    /**
104675     * Sets the font pointsize to use when annotating with text
104676     *
104677     * @param float $pointsize Text pointsize
104678     * @return GmagickDraw The GmagickDraw object on success
104679     * @since PECL gmagick >= Unknown
104680     **/
104681    public function setfontsize($pointsize){}
104682
104683    /**
104684     * Sets the font style to use when annotating with text
104685     *
104686     * Sets the font style to use when annotating with text. The AnyStyle
104687     * enumeration acts as a wild-card "don't care" option.
104688     *
104689     * @param int $style Font style (NormalStyle, ItalicStyle,
104690     *   ObliqueStyle, AnyStyle)
104691     * @return GmagickDraw The GmagickDraw object on success
104692     * @since PECL gmagick >= Unknown
104693     **/
104694    public function setfontstyle($style){}
104695
104696    /**
104697     * Sets the font weight
104698     *
104699     * Sets the font weight to use when annotating with text.
104700     *
104701     * @param int $weight Font weight (valid range 100-900)
104702     * @return GmagickDraw The GmagickDraw object on success
104703     * @since PECL gmagick >= Unknown
104704     **/
104705    public function setfontweight($weight){}
104706
104707    /**
104708     * Sets the color used for stroking object outlines
104709     *
104710     * @param mixed $color GmagickPixel or string representing the color
104711     *   for the stroke.
104712     * @return GmagickDraw The GmagickDraw object on success.
104713     * @since PECL gmagick >= Unknown
104714     **/
104715    public function setstrokecolor($color){}
104716
104717    /**
104718     * Specifies the opacity of stroked object outlines
104719     *
104720     * @param float $stroke_opacity Stroke opacity. The value 1.0 is
104721     *   opaque.
104722     * @return GmagickDraw The GmagickDraw object on success
104723     * @since PECL gmagick >= Unknown
104724     **/
104725    public function setstrokeopacity($stroke_opacity){}
104726
104727    /**
104728     * Sets the width of the stroke used to draw object outlines
104729     *
104730     * @param float $width Stroke width
104731     * @return GmagickDraw The GmagickDraw object on success
104732     * @since PECL gmagick >= Unknown
104733     **/
104734    public function setstrokewidth($width){}
104735
104736    /**
104737     * Specifies a decoration
104738     *
104739     * Specifies a decoration to be applied when annotating with text.
104740     *
104741     * @param int $decoration Text decoration. One of NoDecoration,
104742     *   UnderlineDecoration, OverlineDecoration, or LineThroughDecoration
104743     * @return GmagickDraw The GmagickDraw object on success
104744     * @since PECL gmagick >= Unknown
104745     **/
104746    public function settextdecoration($decoration){}
104747
104748    /**
104749     * Specifies the text code set
104750     *
104751     * Specifies the code set to use for text annotations. The only character
104752     * encoding which may be specified at this time is "UTF-8" for
104753     * representing Unicode as a sequence of bytes. Specify an empty string
104754     * to set text encoding to the system's default. Successful text
104755     * annotation using Unicode may require fonts designed to support
104756     * Unicode.
104757     *
104758     * @param string $encoding Character string specifying text encoding
104759     * @return GmagickDraw The GmagickDraw object on success
104760     * @since PECL gmagick >= Unknown
104761     **/
104762    public function settextencoding($encoding){}
104763
104764}
104765/**
104766 * GmagickException class
104767 **/
104768class GmagickException extends Exception {
104769}
104770class GmagickPixel {
104771    /**
104772     * Returns the color
104773     *
104774     * Returns the color described by the GmagickPixel object, as a string or
104775     * an array. If the color has an opacity channel set, this is provided as
104776     * a fourth value in the list.
104777     *
104778     * @param bool $as_array TRUE to indicate return of array instead of
104779     *   string.
104780     * @param bool $normalize_array TRUE to normalize the color values.
104781     * @return mixed A string or an array of channel values, each
104782     *   normalized if TRUE is given as {@link normalize_array}. Throws
104783     *   GmagickPixelException on error.
104784     * @since PECL gmagick >= Unknown
104785     **/
104786    public function getcolor($as_array, $normalize_array){}
104787
104788    /**
104789     * Returns the color count associated with this color
104790     *
104791     * @return int Returns the color count as an integer on success, throws
104792     *   GmagickPixelException on failure.
104793     * @since PECL gmagick >= Unknown
104794     **/
104795    public function getcolorcount(){}
104796
104797    /**
104798     * Gets the normalized value of the provided color channel
104799     *
104800     * Retrieves the value of the color channel specified, as a
104801     * floating-point number between 0 and 1.
104802     *
104803     * @param int $color The channel to check, specified as one of the
104804     *   Gmagick channel constants.
104805     * @return float The value of the channel, as a normalized
104806     *   floating-point number, throwing GmagickPixelException on error.
104807     * @since PECL gmagick >= Unknown
104808     **/
104809    public function getcolorvalue($color){}
104810
104811    /**
104812     * Sets the color
104813     *
104814     * Sets the color described by the GmagickPixel object, with a string
104815     * (e.g. "blue", "#0000ff", "rgb(0,0,255)", "cmyk(100,100,100,10)",
104816     * etc.).
104817     *
104818     * @param string $color The color definition to use in order to
104819     *   initialise the GmagickPixel object.
104820     * @return GmagickPixel The GmagickPixel object on success.
104821     * @since PECL gmagick >= Unknown
104822     **/
104823    public function setcolor($color){}
104824
104825    /**
104826     * Sets the normalized value of one of the channels
104827     *
104828     * Sets the value of the specified channel of this object to the provided
104829     * value, which should be between 0 and 1. This function can be used to
104830     * provide an opacity channel to a GmagickPixel object.
104831     *
104832     * @param int $color One of the Gmagick channel color constants.
104833     * @param float $value The value to set this channel to, ranging from 0
104834     *   to 1.
104835     * @return GmagickPixel The GmagickPixel object on success.
104836     * @since PECL gmagick >= Unknown
104837     **/
104838    public function setcolorvalue($color, $value){}
104839
104840    /**
104841     * The GmagickPixel constructor
104842     *
104843     * Constructs an GmagickPixel object. If a color is specified, the object
104844     * is constructed and then initialised with that color before being
104845     * returned.
104846     *
104847     * @param string $color The optional color string to use as the initial
104848     *   value of this object.
104849     * @since PECL gmagick >= Unknown
104850     **/
104851    public function __construct($color){}
104852
104853}
104854class GmagickPixelException extends Exception {
104855}
104856/**
104857 * A GMP number. These objects support overloaded arithmetic, bitwise and
104858 * comparison operators.
104859 **/
104860class GMP implements Serializable {
104861}
104862/**
104863 * Haru PDF Annotation Class.
104864 **/
104865class HaruAnnotation {
104866    /**
104867     * Set the border style of the annotation
104868     *
104869     * Defines the style of the border of the annotation. This function may
104870     * be used with link annotations only.
104871     *
104872     * @param float $width The width of the border line.
104873     * @param int $dash_on The dash style.
104874     * @param int $dash_off The dash style.
104875     * @return bool Returns TRUE on success.
104876     * @since PECL haru >= 0.0.1
104877     **/
104878    function setBorderStyle($width, $dash_on, $dash_off){}
104879
104880    /**
104881     * Set the highlighting mode of the annotation
104882     *
104883     * Defines the appearance of the annotation when clicked. This function
104884     * may be used with link annotations only.
104885     *
104886     * @param int $mode The highlighting mode of the annotation. Can take
104887     *   only these values: HaruAnnotation::NO_HIGHLIGHT - no highlighting.
104888     *   HaruAnnotation::INVERT_BOX - invert the contents of the annotation.
104889     *   HaruAnnotation::INVERT_BORDER - invert the border of the annotation.
104890     *   HaruAnnotation::DOWN_APPEARANCE - dent the annotation.
104891     * @return bool Returns TRUE on success.
104892     * @since PECL haru >= 0.0.1
104893     **/
104894    function setHighlightMode($mode){}
104895
104896    /**
104897     * Set the icon style of the annotation
104898     *
104899     * Defines the style of the annotation icon. This function may be used
104900     * with text annotations only.
104901     *
104902     * @param int $icon The style of the icon. Can take only these values:
104903     *   HaruAnnotation::ICON_COMMENT HaruAnnotation::ICON_KEY
104904     *   HaruAnnotation::ICON_NOTE HaruAnnotation::ICON_HELP
104905     *   HaruAnnotation::ICON_NEW_PARAGRAPH HaruAnnotation::ICON_PARAGRAPH
104906     *   HaruAnnotation::ICON_INSERT
104907     * @return bool Returns TRUE on success.
104908     * @since PECL haru >= 0.0.1
104909     **/
104910    function setIcon($icon){}
104911
104912    /**
104913     * Set the initial state of the annotation
104914     *
104915     * Defines whether the annotation is initially displayed open. This
104916     * function may be used with text annotations only.
104917     *
104918     * @param bool $opened TRUE means the annotation is initially displayed
104919     *   open, FALSE - means it's closed.
104920     * @return bool Returns TRUE on success.
104921     * @since PECL haru >= 0.0.1
104922     **/
104923    function setOpened($opened){}
104924
104925}
104926/**
104927 * Haru PDF Destination Class.
104928 **/
104929class HaruDestination {
104930    /**
104931     * Set the appearance of the page to fit the window
104932     *
104933     * Defines the appearance of the page to fit the window.
104934     *
104935     * @return bool Returns TRUE on success.
104936     * @since PECL haru >= 0.0.1
104937     **/
104938    function setFit(){}
104939
104940    /**
104941     * Set the appearance of the page to fit the bounding box of the page
104942     * within the window
104943     *
104944     * Defines the appearance of the page to fit the bounding box of the page
104945     * within the window.
104946     *
104947     * @return bool Returns TRUE on success.
104948     * @since PECL haru >= 0.0.1
104949     **/
104950    function setFitB(){}
104951
104952    /**
104953     * Set the appearance of the page to fit the width of the bounding box
104954     *
104955     * Defines the appearance of the page to magnifying to fit the width of
104956     * the bounding box and setting the top position of the page to the value
104957     * of {@link top}.
104958     *
104959     * @param float $top The top coordinates of the page.
104960     * @return bool Returns TRUE on success.
104961     * @since PECL haru >= 0.0.1
104962     **/
104963    function setFitBH($top){}
104964
104965    /**
104966     * Set the appearance of the page to fit the height of the boudning box
104967     *
104968     * Defines the appearance of the page to magnifying to fit the height of
104969     * the bounding box and setting the left position of the page to the
104970     * value of {@link left}.
104971     *
104972     * @param float $left The left coordinates of the page.
104973     * @return bool Returns TRUE on success.
104974     * @since PECL haru >= 0.0.1
104975     **/
104976    function setFitBV($left){}
104977
104978    /**
104979     * Set the appearance of the page to fit the window width
104980     *
104981     * Defines the appearance of the page to fit the window width and sets
104982     * the top position of the page to the value of {@link top}.
104983     *
104984     * @param float $top The top position of the page.
104985     * @return bool Returns TRUE on success.
104986     * @since PECL haru >= 0.0.1
104987     **/
104988    function setFitH($top){}
104989
104990    /**
104991     * Set the appearance of the page to fit the specified rectangle
104992     *
104993     * Defines the appearance of the page to fit the rectangle by the
104994     * parameters.
104995     *
104996     * @param float $left The left coordinates of the page.
104997     * @param float $bottom The bottom coordinates of the page.
104998     * @param float $right The right coordinates of the page.
104999     * @param float $top The top coordinates of the page.
105000     * @return bool Returns TRUE on success.
105001     * @since PECL haru >= 0.0.1
105002     **/
105003    function setFitR($left, $bottom, $right, $top){}
105004
105005    /**
105006     * Set the appearance of the page to fit the window height
105007     *
105008     * Defines the appearance of the page to fit the window height.
105009     *
105010     * @param float $left The left position of the page.
105011     * @return bool Returns TRUE on success.
105012     * @since PECL haru >= 0.0.1
105013     **/
105014    function setFitV($left){}
105015
105016    /**
105017     * Set the appearance of the page
105018     *
105019     * Defines the appearance of the page using three parameters: {@link
105020     * left}, {@link top} and {@link zoom}.
105021     *
105022     * @param float $left The left position of the page.
105023     * @param float $top The top position of the page.
105024     * @param float $zoom The magnification factor. The value must be
105025     *   between 0.08 (8%) and 32 (3200%).
105026     * @return bool Returns TRUE on success.
105027     * @since PECL haru >= 0.0.1
105028     **/
105029    function setXYZ($left, $top, $zoom){}
105030
105031}
105032/**
105033 * Haru PDF Document Class.
105034 **/
105035class HaruDoc {
105036    /**
105037     * Add new page to the document
105038     *
105039     * Adds a new page to the document.
105040     *
105041     * @return object Returns a new HaruPage instance.
105042     * @since PECL haru >= 0.0.1
105043     **/
105044    function addPage(){}
105045
105046    /**
105047     * Set the numbering style for the specified range of pages
105048     *
105049     * @param int $first_page The first page included into the labeling
105050     *   range.
105051     * @param int $style The numbering style. The following values are
105052     *   allowed: HaruPage::NUM_STYLE_DECIMAL - page label is displayed using
105053     *   decimal numerals. HaruPage::NUM_STYLE_UPPER_ROMAN - page label is
105054     *   displayed using uppercase Roman numerals.
105055     *   HaruPage::NUM_STYLE_LOWER_ROMAN - page label is displayed using
105056     *   lowercase Roman numerals. HaruPage::NUM_STYLE_UPPER_LETTER - page
105057     *   label is displayed using uppercase letters (from A to Z).
105058     *   HaruPage::NUM_STYLE_LOWER_LETTERS - page label is displayed using
105059     *   lowercase letters (from a to z).
105060     * @param int $first_num The first page number in this range.
105061     * @param string $prefix The prefix for the page label.
105062     * @return bool Returns TRUE on success.
105063     * @since PECL haru >= 0.0.1
105064     **/
105065    function addPageLabel($first_page, $style, $first_num, $prefix){}
105066
105067    /**
105068     * Create a instance
105069     *
105070     * Create a HaruOutline instance.
105071     *
105072     * @param string $title The caption of new outline object.
105073     * @param object $parent_outline A valid HaruOutline instance or NULL.
105074     * @param object $encoder A valid HaruEncoder instance or NULL.
105075     * @return object Returns a new HaruOutline instance.
105076     * @since PECL haru >= 0.0.1
105077     **/
105078    function createOutline($title, $parent_outline, $encoder){}
105079
105080    /**
105081     * Get currently used in the document
105082     *
105083     * Get the HaruEncoder currently used in the document.
105084     *
105085     * @return object Returns HaruEncoder currently used in the document or
105086     *   FALSE if encoder is not set.
105087     * @since PECL haru >= 0.0.1
105088     **/
105089    function getCurrentEncoder(){}
105090
105091    /**
105092     * Return current page of the document
105093     *
105094     * Get current page of the document.
105095     *
105096     * @return object Returns HaruPage instance on success or FALSE if
105097     *   there is no current page at the moment.
105098     * @since PECL haru >= 0.0.1
105099     **/
105100    function getCurrentPage(){}
105101
105102    /**
105103     * Get instance for the specified encoding
105104     *
105105     * Get the HaruEncoder instance for the specified encoding.
105106     *
105107     * @param string $encoding The encoding name. See Builtin Encodings for
105108     *   the list of allowed values.
105109     * @return object Returns a HaruEncoder instance for the specified
105110     *   encoding.
105111     * @since PECL haru >= 0.0.1
105112     **/
105113    function getEncoder($encoding){}
105114
105115    /**
105116     * Get instance
105117     *
105118     * Get a HaruFont instance.
105119     *
105120     * @param string $fontname The name of the font. See Builtin Fonts for
105121     *   the list of builtin fonts. You can also use the name of a font
105122     *   loaded via HaruDoc::loadTTF, HaruDoc::loadTTC and
105123     *   HaruDoc::loadType1.
105124     * @param string $encoding The encoding to use. See Builtin Encodings
105125     *   for the list of supported encodings.
105126     * @return object Returns a HaruFont instance with the specified {@link
105127     *   fontname} and {@link encoding}.
105128     * @since PECL haru >= 0.0.1
105129     **/
105130    function getFont($fontname, $encoding){}
105131
105132    /**
105133     * Get current value of the specified document attribute
105134     *
105135     * Get the current value of the specified document attribute.
105136     *
105137     * @param int $type The type of the attribute. The following values are
105138     *   available: HaruDoc::INFO_AUTHOR HaruDoc::INFO_CREATOR
105139     *   HaruDoc::INFO_TITLE HaruDoc::INFO_SUBJECT HaruDoc::INFO_KEYWORDS
105140     *   HaruDoc::INFO_CREATION_DATE HaruDoc::INFO_MOD_DATE
105141     * @return string Returns the string value of the specified document
105142     *   attribute.
105143     * @since PECL haru >= 0.0.1
105144     **/
105145    function getInfoAttr($type){}
105146
105147    /**
105148     * Get current page layout
105149     *
105150     * Get the current page layout. See HaruDoc::setPageLayout for the list
105151     * of possible values.
105152     *
105153     * @return int Returns the page layout currently set in the document or
105154     *   FALSE if page layout was not set. See HaruDoc::setPageLayout for the
105155     *   list of possible values.
105156     * @since PECL haru >= 0.0.1
105157     **/
105158    function getPageLayout(){}
105159
105160    /**
105161     * Get current page mode
105162     *
105163     * Get the current page mode. See HaruDoc::setPageMode for the list of
105164     * possible values.
105165     *
105166     * @return int Returns the page mode currently set in the document. See
105167     *   HaruDoc::setPageMode for the list of possible values.
105168     * @since PECL haru >= 0.0.1
105169     **/
105170    function getPageMode(){}
105171
105172    /**
105173     * Get the size of the temporary stream
105174     *
105175     * @return int Returns the size of the data in the temporary stream of
105176     *   the document. The size is zero if the document was not saved to the
105177     *   temporary stream.
105178     * @since PECL haru >= 0.0.1
105179     **/
105180    function getStreamSize(){}
105181
105182    /**
105183     * Insert new page just before the specified page
105184     *
105185     * Creates a new page and inserts just before the specified page.
105186     *
105187     * @param object $page A valid HaruPage instance.
105188     * @return object Returns a new HaruPage instance.
105189     * @since PECL haru >= 0.0.1
105190     **/
105191    function insertPage($page){}
105192
105193    /**
105194     * Load a JPEG image
105195     *
105196     * Loads the specified JPEG image.
105197     *
105198     * @param string $filename A valid JPEG image file.
105199     * @return object Returns a new HaruImage instance.
105200     * @since PECL haru >= 0.0.1
105201     **/
105202    function loadJPEG($filename){}
105203
105204    /**
105205     * Load PNG image and return instance
105206     *
105207     * Loads a PNG image.
105208     *
105209     * Libharu might be built without libpng support, in this case each call
105210     * to this function would result in exception.
105211     *
105212     * @param string $filename The name of a PNG image file.
105213     * @param bool $deferred Do not load data immediately. You can set
105214     *   {@link deferred} parameter to TRUE for deferred data loading, in
105215     *   this case only size and color are loaded immediately.
105216     * @return object Returns a HaruImage instance.
105217     * @since PECL haru >= 0.0.1
105218     **/
105219    function loadPNG($filename, $deferred){}
105220
105221    /**
105222     * Load a RAW image
105223     *
105224     * Loads a RAW image.
105225     *
105226     * @param string $filename The name of a RAW image file.
105227     * @param int $width The width of the image.
105228     * @param int $height The height of the image.
105229     * @param int $color_space The color space of the image. Can be one of
105230     *   the following values: HaruDoc::CS_DEVICE_GRAY HaruDoc::CS_DEVICE_RGB
105231     *   HaruDoc::CS_DEVICE_CMYK
105232     * @return object Returns a HaruImage instance.
105233     * @since PECL haru >= 0.0.1
105234     **/
105235    function loadRaw($filename, $width, $height, $color_space){}
105236
105237    /**
105238     * Load the font with the specified index from TTC file
105239     *
105240     * Loads the TrueType font with the specified index from a TrueType
105241     * collection file.
105242     *
105243     * @param string $fontfile The TrueType collection file.
105244     * @param int $index The index of the font in the collection file.
105245     * @param bool $embed When set to TRUE, the glyph data of the font is
105246     *   embedded into the PDF file, otherwise only the matrix data is
105247     *   included.
105248     * @return string Returns the name of the loaded font on success.
105249     * @since PECL haru >= 0.0.1
105250     **/
105251    function loadTTC($fontfile, $index, $embed){}
105252
105253    /**
105254     * Load TTF font file
105255     *
105256     * Loads the given TTF file and (optionally) embed its data into the
105257     * document.
105258     *
105259     * @param string $fontfile The TTF file to load.
105260     * @param bool $embed When set to TRUE, the glyph data of the font is
105261     *   embedded into the PDF file, otherwise only the matrix data is
105262     *   included.
105263     * @return string Returns the name of the loaded font on success.
105264     * @since PECL haru >= 0.0.1
105265     **/
105266    function loadTTF($fontfile, $embed){}
105267
105268    /**
105269     * Load Type1 font
105270     *
105271     * Loads Type1 font from the given file and registers it in the PDF
105272     * document.
105273     *
105274     * @param string $afmfile Path to an AFM file.
105275     * @param string $pfmfile Path to a PFA/PFB file, optional. If it's not
105276     *   set only the glyph data of the font is embedded into the PDF
105277     *   document.
105278     * @return string Returns the name of the loaded font on success.
105279     * @since PECL haru >= 0.0.1
105280     **/
105281    function loadType1($afmfile, $pfmfile){}
105282
105283    /**
105284     * Write the document data to the output buffer
105285     *
105286     * Writes the document data into standard output.
105287     *
105288     * @return bool Returns TRUE on success.
105289     * @since PECL haru >= 0.0.1
105290     **/
105291    function output(){}
105292
105293    /**
105294     * Read data from the temporary stream
105295     *
105296     * @param int $bytes The {@link bytes} parameter specifies how many
105297     *   bytes to read, though the stream may contain less bytes than
105298     *   requested.
105299     * @return string Returns data from the temporary stream.
105300     * @since PECL haru >= 0.0.1
105301     **/
105302    function readFromStream($bytes){}
105303
105304    /**
105305     * Reset error state of the document handle
105306     *
105307     * Once an error code is set, most of the operations, including I/O
105308     * processing functions cannot be performed. In case if you want to
105309     * continue after the cause of the error has been fixed, you have to
105310     * invoke this function in order to reset the document error state.
105311     *
105312     * @return bool Always succeeds and returns TRUE.
105313     * @since PECL haru >= 0.0.1
105314     **/
105315    function resetError(){}
105316
105317    /**
105318     * Rewind the temporary stream
105319     *
105320     * Rewinds the temporary stream of the document.
105321     *
105322     * @return bool Returns TRUE on success.
105323     * @since PECL haru >= 0.0.1
105324     **/
105325    function resetStream(){}
105326
105327    /**
105328     * Save the document into the specified file
105329     *
105330     * Saves the document into the specified file.
105331     *
105332     * @param string $file The file to save the document to.
105333     * @return bool Returns TRUE on success.
105334     * @since PECL haru >= 0.0.1
105335     **/
105336    function save($file){}
105337
105338    /**
105339     * Save the document into a temporary stream
105340     *
105341     * Saves the document data into a temporary stream.
105342     *
105343     * @return bool Returns TRUE on success.
105344     * @since PECL haru >= 0.0.1
105345     **/
105346    function saveToStream(){}
105347
105348    /**
105349     * Set compression mode for the document
105350     *
105351     * Defines compression mode for the document. In case when libharu was
105352     * compiled without Zlib support this function will always throw
105353     * HaruException.
105354     *
105355     * @param int $mode The compression mode to use. The value is a
105356     *   combination of the following flags: HaruDoc::COMP_NONE - all
105357     *   contents is not compressed. HaruDoc::COMP_TEXT - compress the text
105358     *   data. HaruDoc::COMP_IMAGE - compress the image data.
105359     *   HaruDoc::COMP_METADATA - compress other data (fonts, cmaps).
105360     *   HaruDoc::COMP_ALL - compress all data.
105361     * @return bool Returns TRUE on success.
105362     * @since PECL haru >= 0.0.1
105363     **/
105364    function setCompressionMode($mode){}
105365
105366    /**
105367     * Set the current encoder for the document
105368     *
105369     * Defines the encoder currently used in the document.
105370     *
105371     * @param string $encoding The name of the encoding to use. See Builtin
105372     *   Encodings for the list of allowed values.
105373     * @return bool Returns TRUE on success.
105374     * @since PECL haru >= 0.0.1
105375     **/
105376    function setCurrentEncoder($encoding){}
105377
105378    /**
105379     * Set encryption mode for the document
105380     *
105381     * Defines encryption mode for the document. The encryption mode cannot
105382     * be set before setting the password.
105383     *
105384     * @param int $mode The encryption mode to use. Can be one of the
105385     *   following: HaruDoc::ENCRYPT_R2 - use "revision2" algorithm.
105386     *   HaruDoc::ENCRYPT_R3 - use "revision3" algorithm. Using this value
105387     *   bumps the version of PDF to 1.4.
105388     * @param int $key_len The encryption key length in bytes. This
105389     *   parameter is optional and used only when mode is
105390     *   HaruDoc::ENCRYPT_R3. The default value is 5 (40bit).
105391     * @return bool Returns TRUE on success.
105392     * @since PECL haru >= 0.0.1
105393     **/
105394    function setEncryptionMode($mode, $key_len){}
105395
105396    /**
105397     * Set the info attribute of the document
105398     *
105399     * Defines an info attribute. Uses the current encoding of the document.
105400     *
105401     * @param int $type The type of the attribute. Can be one of the
105402     *   following: HaruDoc::INFO_AUTHOR HaruDoc::INFO_CREATOR
105403     *   HaruDoc::INFO_TITLE HaruDoc::INFO_SUBJECT HaruDoc::INFO_KEYWORDS
105404     * @param string $info The value of the attribute.
105405     * @return bool Returns TRUE on success.
105406     * @since PECL haru >= 0.0.1
105407     **/
105408    function setInfoAttr($type, $info){}
105409
105410    /**
105411     * Set the datetime info attributes of the document
105412     *
105413     * Sets the datetime info attributes of the document.
105414     *
105415     * @param int $type The type of the attribute. Can be one of the
105416     *   following: HaruDoc::INFO_CREATION_DATE HaruDoc::INFO_MOD_DATE
105417     * @param int $year
105418     * @param int $month Between 1 and 12.
105419     * @param int $day Between 1 and 31, 30, 29 or 28 (different for each
105420     *   month).
105421     * @param int $hour Between 0 and 23.
105422     * @param int $min Between 0 and 59.
105423     * @param int $sec Between 0 and 59.
105424     * @param string $ind The timezone relation to UTC, can be "", " ",
105425     *   "+", "-" and "Z".
105426     * @param int $off_hour If {@link ind} is not " " or "", values between
105427     *   0 and 23 are valid. Otherwise, this parameter is ignored.
105428     * @param int $off_min If {@link ind} is not " " or "", values between
105429     *   0 and 59 are valid. Otherwise, this parameter is ignored.
105430     * @return bool Returns TRUE on success.
105431     * @since PECL haru >= 0.0.1
105432     **/
105433    function setInfoDateAttr($type, $year, $month, $day, $hour, $min, $sec, $ind, $off_hour, $off_min){}
105434
105435    /**
105436     * Define which page is shown when the document is opened
105437     *
105438     * Defines which page should be shown when the document is opened.
105439     *
105440     * @param object $destination A valid HaruDestination instance.
105441     * @return bool Returns TRUE on success.
105442     * @since PECL haru >= 0.0.1
105443     **/
105444    function setOpenAction($destination){}
105445
105446    /**
105447     * Set how pages should be displayed
105448     *
105449     * Defines how pages should be displayed.
105450     *
105451     * @param int $layout The following values are accepted:
105452     *   HaruDoc::PAGE_LAYOUT_SINGLE - only one page is displayed.
105453     *   HaruDoc::PAGE_LAYOUT_ONE_COLUMN - display the pages in one column.
105454     *   HaruDoc::PAGE_LAYOUT_TWO_COLUMN_LEFT - display pages in two columns,
105455     *   first page left. HaruDoc::PAGE_LAYOUT_TWO_COLUMN_RIGHT - display
105456     *   pages in two columns, first page right.
105457     * @return bool Returns TRUE on success.
105458     * @since PECL haru >= 0.0.1
105459     **/
105460    function setPageLayout($layout){}
105461
105462    /**
105463     * Set how the document should be displayed
105464     *
105465     * Defines how the document should be displayed.
105466     *
105467     * @param int $mode The following values are accepted:
105468     *   HaruDoc::PAGE_MODE_USE_NONE - display the document with neither
105469     *   outline nor thumbnail. HaruDoc::PAGE_MODE_USE_OUTLINE - display the
105470     *   document with outline pane. HaruDoc::PAGE_MODE_USE_THUMBS - display
105471     *   the document with thumbnail pane. HaruDoc::PAGE_MODE_FULL_SCREEN -
105472     *   display the document with full screen mode.
105473     * @return bool Returns TRUE on success.
105474     * @since PECL haru >= 0.0.1
105475     **/
105476    function setPageMode($mode){}
105477
105478    /**
105479     * Set the number of pages per set of pages
105480     *
105481     * By default the document has one pages object as a root for all pages.
105482     * All page objects are create as branches of this object. One pages
105483     * object can contain only 8191, therefore the maximum number of pages
105484     * per document is 8191. But you can change that fact by setting {@link
105485     * page_per_pages} parameter, so that the root pages object contains 8191
105486     * more pages (not page) objects, which in turn contain 8191 pages each.
105487     * So the maximum number of pages in the document becomes 8191*{@link
105488     * page_per_pages}.
105489     *
105490     * @param int $page_per_pages The numbers of pages that a pages object
105491     *   can contain.
105492     * @return bool Returns TRUE on success.
105493     * @since PECL haru >= 0.0.1
105494     **/
105495    function setPagesConfiguration($page_per_pages){}
105496
105497    /**
105498     * Set owner and user passwords for the document
105499     *
105500     * Defines owner and user passwords for the document. Setting the
105501     * passwords makes the document contents encrypted.
105502     *
105503     * @param string $owner_password The password of the owner, which can
105504     *   change permissions of the document. Empty password is not accepted.
105505     *   Owner's password cannot be the same as the user's password.
105506     * @param string $user_password The password of the user. Can be empty.
105507     * @return bool Returns TRUE on success.
105508     * @since PECL haru >= 0.0.1
105509     **/
105510    function setPassword($owner_password, $user_password){}
105511
105512    /**
105513     * Set permissions for the document
105514     *
105515     * Defines permissions for the document.
105516     *
105517     * @param int $permission The values is a combination of these flags:
105518     *   HaruDoc::ENABLE_READ - user can read the document.
105519     *   HaruDoc::ENABLE_PRINT - user can print the document.
105520     *   HaruDoc::ENABLE_EDIT_ALL - user can edit the contents of the
105521     *   document other than annotations and form fields.
105522     *   HaruDoc::ENABLE_COPY - user can copy the text and the graphics of
105523     *   the document. HaruDoc::ENABLE_EDIT - user can add or modify the
105524     *   annotations and form fields of the document.
105525     * @return bool Returns TRUE on success.
105526     * @since PECL haru >= 0.0.1
105527     **/
105528    function setPermission($permission){}
105529
105530    /**
105531     * Enable Chinese simplified encodings
105532     *
105533     * Enables Chinese simplified encodings.
105534     *
105535     * @return bool Returns TRUE on success.
105536     * @since PECL haru >= 0.0.1
105537     **/
105538    function useCNSEncodings(){}
105539
105540    /**
105541     * Enable builtin Chinese simplified fonts
105542     *
105543     * Enables builtin Chinese simplified fonts.
105544     *
105545     * @return bool Returns TRUE on success.
105546     * @since PECL haru >= 0.0.1
105547     **/
105548    function useCNSFonts(){}
105549
105550    /**
105551     * Enable Chinese traditional encodings
105552     *
105553     * Enables Chinese traditional encodings.
105554     *
105555     * @return bool Returns TRUE on success.
105556     * @since PECL haru >= 0.0.1
105557     **/
105558    function useCNTEncodings(){}
105559
105560    /**
105561     * Enable builtin Chinese traditional fonts
105562     *
105563     * Enables builtin Chinese traditional fonts.
105564     *
105565     * @return bool Returns TRUE on success.
105566     * @since PECL haru >= 0.0.1
105567     **/
105568    function useCNTFonts(){}
105569
105570    /**
105571     * Enable Japanese encodings
105572     *
105573     * Enables Japanese encodings.
105574     *
105575     * @return bool Returns TRUE on success.
105576     * @since PECL haru >= 0.0.1
105577     **/
105578    function useJPEncodings(){}
105579
105580    /**
105581     * Enable builtin Japanese fonts
105582     *
105583     * Enables builtin Japanese fonts.
105584     *
105585     * @return bool Returns TRUE on success.
105586     * @since PECL haru >= 0.0.1
105587     **/
105588    function useJPFonts(){}
105589
105590    /**
105591     * Enable Korean encodings
105592     *
105593     * Enables Korean encodings.
105594     *
105595     * @return bool Returns TRUE on success.
105596     * @since PECL haru >= 0.0.1
105597     **/
105598    function useKREncodings(){}
105599
105600    /**
105601     * Enable builtin Korean fonts
105602     *
105603     * Enables builtin Korean fonts.
105604     *
105605     * @return bool Returns TRUE on success.
105606     * @since PECL haru >= 0.0.1
105607     **/
105608    function useKRFonts(){}
105609
105610    /**
105611     * Construct new instance
105612     *
105613     * Constructs new HaruDoc instance.
105614     *
105615     * @since PECL haru >= 0.0.1
105616     **/
105617    function __construct(){}
105618
105619}
105620/**
105621 * Haru PDF Encoder Class.
105622 **/
105623class HaruEncoder {
105624    /**
105625     * Get the type of the byte in the text
105626     *
105627     * @param string $text The text.
105628     * @param int $index The position in the text.
105629     * @return int Returns the type of the byte in the text on the
105630     *   specified position. The result is one of the following values:
105631     *   HaruEncoder::BYTE_TYPE_SINGLE - single byte character.
105632     *   HaruEncoder::BYTE_TYPE_LEAD - lead byte of a double-byte character.
105633     *   HaruEncoder::BYTE_TYPE_TRAIL - trailing byte of a double-byte
105634     *   character. HaruEncoder::BYTE_TYPE_UNKNOWN - invalid encoder or
105635     *   cannot detect the byte type.
105636     * @since PECL haru >= 0.0.1
105637     **/
105638    function getByteType($text, $index){}
105639
105640    /**
105641     * Get the type of the encoder
105642     *
105643     * @return int Returns the type of the encoder. The result is one of
105644     *   the following values: HaruEncoder::TYPE_SINGLE_BYTE - the encoder is
105645     *   for single byte characters. HaruEncoder::TYPE_DOUBLE_BYTE - the
105646     *   encoder is for multibyte characters. HaruEncoder::TYPE_UNINITIALIZED
105647     *   - the encoder is not initialized. HaruEncoder::UNKNOWN - the encoder
105648     *   is invalid.
105649     * @since PECL haru >= 0.0.1
105650     **/
105651    function getType(){}
105652
105653    /**
105654     * Convert the specified character to unicode
105655     *
105656     * Converts the specified character to unicode.
105657     *
105658     * @param int $character The character code to convert.
105659     * @return int
105660     * @since PECL haru >= 0.0.1
105661     **/
105662    function getUnicode($character){}
105663
105664    /**
105665     * Get the writing mode of the encoder
105666     *
105667     * @return int Returns the writing mode of the encoder. The result
105668     *   value is on of the following: HaruEncoder::WMODE_HORIZONTAL -
105669     *   horizontal writing mode. HaruEncoder::WMODE_VERTICAL - vertical
105670     *   writing mode.
105671     * @since PECL haru >= 0.0.1
105672     **/
105673    function getWritingMode(){}
105674
105675}
105676/**
105677 * Haru PDF Exception Class.
105678 **/
105679class HaruException extends Exception {
105680}
105681/**
105682 * Haru PDF Font Class.
105683 **/
105684class HaruFont {
105685    /**
105686     * Get the vertical ascent of the font
105687     *
105688     * @return int Returns the vertical ascent of the font.
105689     * @since PECL haru >= 0.0.1
105690     **/
105691    function getAscent(){}
105692
105693    /**
105694     * Get the distance from the baseline of uppercase letters
105695     *
105696     * @return int Returns the distance from the baseline of uppercase
105697     *   letters.
105698     * @since PECL haru >= 0.0.1
105699     **/
105700    function getCapHeight(){}
105701
105702    /**
105703     * Get the vertical descent of the font
105704     *
105705     * @return int Return the vertical descent of the font.
105706     * @since PECL haru >= 0.0.1
105707     **/
105708    function getDescent(){}
105709
105710    /**
105711     * Get the name of the encoding
105712     *
105713     * Get the name of the font encoding.
105714     *
105715     * @return string Returns the name of the font encoding.
105716     * @since PECL haru >= 0.0.1
105717     **/
105718    function getEncodingName(){}
105719
105720    /**
105721     * Get the name of the font
105722     *
105723     * @return string Returns the name of the font.
105724     * @since PECL haru >= 0.0.1
105725     **/
105726    function getFontName(){}
105727
105728    /**
105729     * Get the total width of the text, number of characters, number of words
105730     * and number of spaces
105731     *
105732     * Get the total width of the text, number of characters, number of words
105733     * and number of spaces.
105734     *
105735     * @param string $text The text to measure.
105736     * @return array Returns the total width of the text, number of
105737     *   characters, number of words and number of spaces in the given text.
105738     * @since PECL haru >= 0.0.1
105739     **/
105740    function getTextWidth($text){}
105741
105742    /**
105743     * Get the width of the character in the font
105744     *
105745     * @param int $character The code of the character.
105746     * @return int Returns the width of the character in the font.
105747     * @since PECL haru >= 0.0.1
105748     **/
105749    function getUnicodeWidth($character){}
105750
105751    /**
105752     * Get the distance from the baseline of lowercase letters
105753     *
105754     * Gets the distance from the baseline of lowercase letters.
105755     *
105756     * @return int Returns the distance from the baseline of lowercase
105757     *   letters.
105758     * @since PECL haru >= 0.0.1
105759     **/
105760    function getXHeight(){}
105761
105762    /**
105763     * Calculate the number of characters which can be included within the
105764     * specified width
105765     *
105766     * Calculate the number of characters which can be included within the
105767     * specified width.
105768     *
105769     * @param string $text The text to fit the width.
105770     * @param float $width The width of the area to put the text to.
105771     * @param float $font_size The size of the font.
105772     * @param float $char_space The character spacing.
105773     * @param float $word_space The word spacing.
105774     * @param bool $word_wrap When this parameter is set to TRUE the
105775     *   function "emulates" word wrapping and doesn't include the part of
105776     *   the current word if reached the end of the area.
105777     * @return int Returns the number of characters which can be included
105778     *   within the specified width.
105779     * @since PECL haru >= 0.0.1
105780     **/
105781    function measureText($text, $width, $font_size, $char_space, $word_space, $word_wrap){}
105782
105783}
105784/**
105785 * Haru PDF Image Class.
105786 **/
105787class HaruImage {
105788    /**
105789     * Get the number of bits used to describe each color component of the
105790     * image
105791     *
105792     * Gets the number of bits used to describe each color component of the
105793     * image.
105794     *
105795     * @return int Returns the number of bits used to describe each color
105796     *   component of the image.
105797     * @since PECL haru >= 0.0.1
105798     **/
105799    function getBitsPerComponent(){}
105800
105801    /**
105802     * Get the name of the color space
105803     *
105804     * @return string Returns the name of the color space of the image. The
105805     *   name is one of the following values: "DeviceGray" "DeviceRGB"
105806     *   "DeviceCMYK" "Indexed"
105807     * @since PECL haru >= 0.0.1
105808     **/
105809    function getColorSpace(){}
105810
105811    /**
105812     * Get the height of the image
105813     *
105814     * @return int Returns the height of the image.
105815     * @since PECL haru >= 0.0.1
105816     **/
105817    function getHeight(){}
105818
105819    /**
105820     * Get size of the image
105821     *
105822     * Get the size of the image.
105823     *
105824     * @return array Returns an array with two elements: width and height,
105825     *   which contain appropriate dimensions of the image.
105826     * @since PECL haru >= 0.0.1
105827     **/
105828    function getSize(){}
105829
105830    /**
105831     * Get the width of the image
105832     *
105833     * @return int Returns the width of the image.
105834     * @since PECL haru >= 0.0.1
105835     **/
105836    function getWidth(){}
105837
105838    /**
105839     * Set the color mask of the image
105840     *
105841     * Defines the transparent color of the image using the RGB range values.
105842     * The color within the range is displayed as a transparent color. The
105843     * color space of the image must be RGB.
105844     *
105845     * @param int $rmin The lower limit of red. Must be between 0 and 255.
105846     * @param int $rmax The upper limit of red. Must be between 0 and 255.
105847     * @param int $gmin The lower limit of green. Must be between 0 and
105848     *   255.
105849     * @param int $gmax The upper limit of green. Must be between 0 and
105850     *   255.
105851     * @param int $bmin The lower limit of blue. Must be between 0 and 255.
105852     * @param int $bmax The upper limit of blue. Must be between 0 and 255.
105853     * @return bool Returns TRUE on success.
105854     * @since PECL haru >= 0.0.1
105855     **/
105856    function setColorMask($rmin, $rmax, $gmin, $gmax, $bmin, $bmax){}
105857
105858    /**
105859     * Set the image mask
105860     *
105861     * Sets the image used as image-mask. It must be 1bit gray-scale color
105862     * image.
105863     *
105864     * @param object $mask_image A valid HaruImage instance.
105865     * @return bool Returns TRUE on success.
105866     * @since PECL haru >= 0.0.1
105867     **/
105868    function setMaskImage($mask_image){}
105869
105870}
105871/**
105872 * Haru PDF Outline Class.
105873 **/
105874class HaruOutline {
105875    /**
105876     * Set the destination for the outline
105877     *
105878     * Sets a destination object which becomes a target to jump to when the
105879     * outline is clicked.
105880     *
105881     * @param object $destination A valid HaruDestination instance.
105882     * @return bool Returns TRUE on success.
105883     * @since PECL haru >= 0.0.1
105884     **/
105885    function setDestination($destination){}
105886
105887    /**
105888     * Set the initial state of the outline
105889     *
105890     * Defines whether this node is opened or not when the outline is
105891     * displayed for the first time.
105892     *
105893     * @param bool $opened TRUE means open, FALSE - closed.
105894     * @return bool Returns TRUE on success.
105895     * @since PECL haru >= 0.0.1
105896     **/
105897    function setOpened($opened){}
105898
105899}
105900/**
105901 * Haru PDF Page Class.
105902 **/
105903class HaruPage {
105904    /**
105905     * Append an arc to the current path
105906     *
105907     * Appends an arc to the current path.
105908     *
105909     * @param float $x Horizontal coordinate of the center.
105910     * @param float $y Vertical coordinate of the center.
105911     * @param float $ray The ray of the arc.
105912     * @param float $ang1 The angle of the beginning.
105913     * @param float $ang2 The angle of the end. Must be greater than {@link
105914     *   ang1}.
105915     * @return bool Returns TRUE on success.
105916     * @since PECL haru >= 0.0.1
105917     **/
105918    function arc($x, $y, $ray, $ang1, $ang2){}
105919
105920    /**
105921     * Begin a text object and set the current text position to (0,0)
105922     *
105923     * Begins new text object and sets the current text position to (0,0).
105924     *
105925     * @return bool Returns TRUE on success.
105926     * @since PECL haru >= 0.0.1
105927     **/
105928    function beginText(){}
105929
105930    /**
105931     * Append a circle to the current path
105932     *
105933     * Appends a circle to the current path.
105934     *
105935     * @param float $x Horizontal coordinate of the center point.
105936     * @param float $y Vertical coordinate of the center point.
105937     * @param float $ray The ray of the circle.
105938     * @return bool Returns TRUE on success.
105939     * @since PECL haru >= 0.0.1
105940     **/
105941    function circle($x, $y, $ray){}
105942
105943    /**
105944     * Append a straight line from the current point to the start point of
105945     * the path
105946     *
105947     * Appends a straight line from the current point to the start point of
105948     * the path.
105949     *
105950     * @return bool Returns TRUE on success.
105951     * @since PECL haru >= 0.0.1
105952     **/
105953    function closePath(){}
105954
105955    /**
105956     * Concatenate current transformation matrix of the page and the
105957     * specified matrix
105958     *
105959     * Concatenates current transformation matrix of the page and the
105960     * specified matrix.
105961     *
105962     * @param float $a
105963     * @param float $b
105964     * @param float $c
105965     * @param float $d
105966     * @param float $x
105967     * @param float $y
105968     * @return bool Returns TRUE on success.
105969     * @since PECL haru >= 0.0.1
105970     **/
105971    function concat($a, $b, $c, $d, $x, $y){}
105972
105973    /**
105974     * Create new instance
105975     *
105976     * Create a new HaruDestination instance.
105977     *
105978     * @return object Returns a new HaruDestination instance.
105979     * @since PECL haru >= 0.0.1
105980     **/
105981    function createDestination(){}
105982
105983    /**
105984     * Create new instance
105985     *
105986     * Creates a new HaruAnnotation instance.
105987     *
105988     * @param array $rectangle An array with 4 coordinates of the clickable
105989     *   area.
105990     * @param object $destination Valid HaruDestination instance.
105991     * @return object Returns a new HaruAnnotation instance.
105992     * @since PECL haru >= 0.0.1
105993     **/
105994    function createLinkAnnotation($rectangle, $destination){}
105995
105996    /**
105997     * Create new instance
105998     *
105999     * Creates a new HaruAnnotation instance.
106000     *
106001     * @param array $rectangle An array with 4 coordinates of the
106002     *   annotation area.
106003     * @param string $text The text to be displayed.
106004     * @param object $encoder Optional HaruEncoder instance.
106005     * @return object Returns a new HaruAnnotation instance.
106006     * @since PECL haru >= 0.0.1
106007     **/
106008    function createTextAnnotation($rectangle, $text, $encoder){}
106009
106010    /**
106011     * Create and return new instance
106012     *
106013     * Creates a new HaruAnnotation instance.
106014     *
106015     * @param array $rectangle An array with 4 coordinates of the clickable
106016     *   area.
106017     * @param string $url The URL to open.
106018     * @return object Returns a new HaruAnnotation instance.
106019     * @since PECL haru >= 0.0.1
106020     **/
106021    function createURLAnnotation($rectangle, $url){}
106022
106023    /**
106024     * Append a Bezier curve to the current path
106025     *
106026     * Append a Bezier curve to the current path. The point (x1, y1) and the
106027     * point (x2, y2) are used as the control points for a Bezier curve and
106028     * current point is moved to the point (x3, y3).
106029     *
106030     * @param float $x1 A Bezier curve control point.
106031     * @param float $y1 A Bezier curve control point.
106032     * @param float $x2 A Bezier curve control point.
106033     * @param float $y2 A Bezier curve control point.
106034     * @param float $x3 The current point moves here.
106035     * @param float $y3 The current point moves here.
106036     * @return bool Returns TRUE on success.
106037     * @since PECL haru >= 0.0.1
106038     **/
106039    function curveTo($x1, $y1, $x2, $y2, $x3, $y3){}
106040
106041    /**
106042     * Append a Bezier curve to the current path
106043     *
106044     * Appends a Bezier curve to the current path. The current point and the
106045     * point (x2, y2) are used as the control points for the Bezier curve and
106046     * current point is moved to the point (x3, y3).
106047     *
106048     * @param float $x2 A Bezier curve control point.
106049     * @param float $y2 A Bezier curve control point.
106050     * @param float $x3 The current point moves here.
106051     * @param float $y3 The current point moves here.
106052     * @return bool Returns TRUE on success.
106053     * @since PECL haru >= 0.0.1
106054     **/
106055    function curveTo2($x2, $y2, $x3, $y3){}
106056
106057    /**
106058     * Append a Bezier curve to the current path
106059     *
106060     * Appends a Bezier curve to the current path. The point (x1, y1) and the
106061     * point (x3, y3) are used as the control points for a Bezier curve and
106062     * current point is moved to the point (x3, y3).
106063     *
106064     * @param float $x1 A Bezier curve control point.
106065     * @param float $y1 A Bezier curve control point.
106066     * @param float $x3 The current point moves here.
106067     * @param float $y3 The current point moves here.
106068     * @return bool Returns TRUE on success.
106069     * @since PECL haru >= 0.0.1
106070     **/
106071    function curveTo3($x1, $y1, $x3, $y3){}
106072
106073    /**
106074     * Show image at the page
106075     *
106076     * @param object $image Valid HaruImage instance.
106077     * @param float $x The left border of the area where the image is
106078     *   displayed.
106079     * @param float $y The lower border of the area where the image is
106080     *   displayed.
106081     * @param float $width The width of the image area.
106082     * @param float $height The height of the image area.
106083     * @return bool Returns TRUE on success.
106084     * @since PECL haru >= 0.0.1
106085     **/
106086    function drawImage($image, $x, $y, $width, $height){}
106087
106088    /**
106089     * Append an ellipse to the current path
106090     *
106091     * Appends an ellipse to the current path.
106092     *
106093     * @param float $x Horizontal coordinate of the center.
106094     * @param float $y Vertical coordinate of the center.
106095     * @param float $xray The ray of the ellipse in the x direction.
106096     * @param float $yray The ray of the ellipse in the y direction.
106097     * @return bool Returns TRUE on success.
106098     * @since PECL haru >= 0.0.1
106099     **/
106100    function ellipse($x, $y, $xray, $yray){}
106101
106102    /**
106103     * End current path object without filling and painting operations
106104     *
106105     * Ends current path object without performing filling and painting
106106     * operations.
106107     *
106108     * @return bool Returns TRUE on success.
106109     * @since PECL haru >= 0.0.1
106110     **/
106111    function endPath(){}
106112
106113    /**
106114     * End current text object
106115     *
106116     * Finalizes current text object.
106117     *
106118     * @return bool Returns TRUE on success.
106119     * @since PECL haru >= 0.0.1
106120     **/
106121    function endText(){}
106122
106123    /**
106124     * Fill current path using even-odd rule
106125     *
106126     * Fills current path using even-odd rule.
106127     *
106128     * @return bool Returns TRUE on success.
106129     * @since PECL haru >= 0.0.1
106130     **/
106131    function eofill(){}
106132
106133    /**
106134     * Fill current path using even-odd rule, then paint the path
106135     *
106136     * Fills current path using even-odd rule, then paints the path.
106137     *
106138     * @param bool $close_path Optional parameter. When set to TRUE, the
106139     *   function closes the current path. Default to FALSE.
106140     * @return bool Returns TRUE on success.
106141     * @since PECL haru >= 0.0.1
106142     **/
106143    function eoFillStroke($close_path){}
106144
106145    /**
106146     * Fill current path using nonzero winding number rule
106147     *
106148     * Fills current path using nonzero winding number rule.
106149     *
106150     * @return bool Returns TRUE on success.
106151     * @since PECL haru >= 0.0.1
106152     **/
106153    function fill(){}
106154
106155    /**
106156     * Fill current path using nonzero winding number rule, then paint the
106157     * path
106158     *
106159     * Fills current path using nonzero winding number rule, then paints the
106160     * path.
106161     *
106162     * @param bool $close_path Optional parameter. When set to TRUE, the
106163     *   function closes the current path. Default to FALSE.
106164     * @return bool Returns TRUE on success.
106165     * @since PECL haru >= 0.0.1
106166     **/
106167    function fillStroke($close_path){}
106168
106169    /**
106170     * Get the current value of character spacing
106171     *
106172     * @return float Returns the current value of character spacing.
106173     * @since PECL haru >= 0.0.1
106174     **/
106175    function getCharSpace(){}
106176
106177    /**
106178     * Get the current filling color
106179     *
106180     * Returns the current filling color.
106181     *
106182     * @return array Returns the current filling color as an array with 4
106183     *   elements ("c", "m", "y" and "k").
106184     * @since PECL haru >= 0.0.1
106185     **/
106186    function getCMYKFill(){}
106187
106188    /**
106189     * Get the current stroking color
106190     *
106191     * @return array Returns the current stroking color as an array with 4
106192     *   elements ("c", "m", "y" and "k").
106193     * @since PECL haru >= 0.0.1
106194     **/
106195    function getCMYKStroke(){}
106196
106197    /**
106198     * Get the currently used font
106199     *
106200     * @return object Returns the currently used font as an instance of
106201     *   HaruFont.
106202     * @since PECL haru >= 0.0.1
106203     **/
106204    function getCurrentFont(){}
106205
106206    /**
106207     * Get the current font size
106208     *
106209     * @return float Returns the current font size.
106210     * @since PECL haru >= 0.0.1
106211     **/
106212    function getCurrentFontSize(){}
106213
106214    /**
106215     * Get the current position for path painting
106216     *
106217     * @return array Returns the current position for path painting as an
106218     *   array of with two elements - "x" and "y".
106219     * @since PECL haru >= 0.0.1
106220     **/
106221    function getCurrentPos(){}
106222
106223    /**
106224     * Get the current position for text printing
106225     *
106226     * @return array Returns the current position for text printing as an
106227     *   array with 2 elements - "x" and "y".
106228     * @since PECL haru >= 0.0.1
106229     **/
106230    function getCurrentTextPos(){}
106231
106232    /**
106233     * Get the current dash pattern
106234     *
106235     * Get the current dash pattern. See HaruPage::setDash for more
106236     * information on dash patterns.
106237     *
106238     * @return array Returns the current dash pattern as an array of two
106239     *   elements - "pattern" and "phase" or FALSE if dash pattern was not
106240     *   set.
106241     * @since PECL haru >= 0.0.1
106242     **/
106243    function getDash(){}
106244
106245    /**
106246     * Get the current filling color space
106247     *
106248     * @return int Returns the current filling color space. The result
106249     *   value is one of the following: HaruDoc::CS_DEVICE_GRAY
106250     *   HaruDoc::CS_DEVICE_RGB HaruDoc::CS_DEVICE_CMYK HaruDoc::CS_CAL_GRAY
106251     *   HaruDoc::CS_CAL_RGB HaruDoc::CS_LAB HaruDoc::CS_ICC_BASED
106252     *   HaruDoc::CS_SEPARATION HaruDoc::CS_DEVICE_N HaruDoc::CS_INDEXED
106253     *   HaruDoc::CS_PATTERN
106254     * @since PECL haru >= 0.0.1
106255     **/
106256    function getFillingColorSpace(){}
106257
106258    /**
106259     * Get the flatness of the page
106260     *
106261     * @return float Returns the flatness of the page.
106262     * @since PECL haru >= 0.0.1
106263     **/
106264    function getFlatness(){}
106265
106266    /**
106267     * Get the current graphics mode
106268     *
106269     * @return int Returns the current graphics mode. The result value is
106270     *   one of the following:
106271     * @since PECL haru >= 0.0.1
106272     **/
106273    function getGMode(){}
106274
106275    /**
106276     * Get the current filling color
106277     *
106278     * @return float Returns the current filling color.
106279     * @since PECL haru >= 0.0.1
106280     **/
106281    function getGrayFill(){}
106282
106283    /**
106284     * Get the current stroking color
106285     *
106286     * @return float Returns the current stroking color.
106287     * @since PECL haru >= 0.0.1
106288     **/
106289    function getGrayStroke(){}
106290
106291    /**
106292     * Get the height of the page
106293     *
106294     * @return float Returns the height of the page.
106295     * @since PECL haru >= 0.0.1
106296     **/
106297    function getHeight(){}
106298
106299    /**
106300     * Get the current value of horizontal scaling
106301     *
106302     * Get the current value of the horizontal scaling.
106303     *
106304     * @return float Returns the current value of horizontal scaling.
106305     * @since PECL haru >= 0.0.1
106306     **/
106307    function getHorizontalScaling(){}
106308
106309    /**
106310     * Get the current line cap style
106311     *
106312     * @return int Returns the current line cap style. The result value is
106313     *   one of the following: HaruPage::BUTT_END - the line is squared off
106314     *   at the endpoint of the path. HaruPage::ROUND_END - the end of the
106315     *   line becomes a semicircle with center in the end point of the path.
106316     *   HaruPage::PROJECTING_SCUARE_END - the line continues to the point
106317     *   that exceeds half of the stroke width the end point.
106318     * @since PECL haru >= 0.0.1
106319     **/
106320    function getLineCap(){}
106321
106322    /**
106323     * Get the current line join style
106324     *
106325     * @return int Returns the current line join style. The result value is
106326     *   one of the following: HaruPage::MITER_JOIN HaruPage::ROUND_JOIN
106327     *   HaruPage::BEVEL_JOIN
106328     * @since PECL haru >= 0.0.1
106329     **/
106330    function getLineJoin(){}
106331
106332    /**
106333     * Get the current line width
106334     *
106335     * @return float Returns the current line width.
106336     * @since PECL haru >= 0.0.1
106337     **/
106338    function getLineWidth(){}
106339
106340    /**
106341     * Get the value of miter limit
106342     *
106343     * Get the value of the miter limit.
106344     *
106345     * @return float Returns the value of the miter limit.
106346     * @since PECL haru >= 0.0.1
106347     **/
106348    function getMiterLimit(){}
106349
106350    /**
106351     * Get the current filling color
106352     *
106353     * @return array Returns the current filling color as an array with 3
106354     *   elements: "r", "g" and "b".
106355     * @since PECL haru >= 0.0.1
106356     **/
106357    function getRGBFill(){}
106358
106359    /**
106360     * Get the current stroking color
106361     *
106362     * @return array Returns the current stroking color.
106363     * @since PECL haru >= 0.0.1
106364     **/
106365    function getRGBStroke(){}
106366
106367    /**
106368     * Get the current stroking color space
106369     *
106370     * @return int Returns the current stroking color space. The list of
106371     *   return values is the same as for HaruPage::getFillingColorSpace
106372     * @since PECL haru >= 0.0.1
106373     **/
106374    function getStrokingColorSpace(){}
106375
106376    /**
106377     * Get the current value of line spacing
106378     *
106379     * @return float Returns the current value of line spacing.
106380     * @since PECL haru >= 0.0.1
106381     **/
106382    function getTextLeading(){}
106383
106384    /**
106385     * Get the current text transformation matrix of the page
106386     *
106387     * @return array Returns the current text transformation matrix of the
106388     *   page as an array of 6 elements: "a", "b", "c", "d", "x" and "y".
106389     * @since PECL haru >= 0.0.1
106390     **/
106391    function getTextMatrix(){}
106392
106393    /**
106394     * Get the current text rendering mode
106395     *
106396     * @return int Returns the current text rendering mode. The result
106397     *   value is one of the following: HaruPage::FILL HaruPage::STROKE
106398     *   HaruPage::FILL_THEN_STROKE HaruPage::INVISIBLE
106399     *   HaruPage::FILL_CLIPPING HaruPage::STROKE_CLIPPING
106400     *   HaruPage::FILL_STROKE_CLIPPING HaruPage::CLIPPING
106401     * @since PECL haru >= 0.0.1
106402     **/
106403    function getTextRenderingMode(){}
106404
106405    /**
106406     * Get the current value of text rising
106407     *
106408     * @return float Returns the current value of text rising.
106409     * @since PECL haru >= 0.0.1
106410     **/
106411    function getTextRise(){}
106412
106413    /**
106414     * Get the width of the text using current fontsize, character spacing
106415     * and word spacing
106416     *
106417     * @param string $text The text to measure.
106418     * @return float Returns the width of the text using current fontsize,
106419     *   character spacing and word spacing.
106420     * @since PECL haru >= 0.0.1
106421     **/
106422    function getTextWidth($text){}
106423
106424    /**
106425     * Get the current transformation matrix of the page
106426     *
106427     * @return array Returns the current transformation matrix of the page
106428     *   as an array of 6 elements: "a", "b", "c", "d", "x" and "y".
106429     * @since PECL haru >= 0.0.1
106430     **/
106431    function getTransMatrix(){}
106432
106433    /**
106434     * Get the width of the page
106435     *
106436     * @return float Returns the width of the page.
106437     * @since PECL haru >= 0.0.1
106438     **/
106439    function getWidth(){}
106440
106441    /**
106442     * Get the current value of word spacing
106443     *
106444     * @return float Returns the current value of word spacing.
106445     * @since PECL haru >= 0.0.1
106446     **/
106447    function getWordSpace(){}
106448
106449    /**
106450     * Draw a line from the current point to the specified point
106451     *
106452     * Draws a line from the current point to the specified point.
106453     *
106454     * @param float $x
106455     * @param float $y
106456     * @return bool Returns TRUE on success.
106457     * @since PECL haru >= 0.0.1
106458     **/
106459    function lineTo($x, $y){}
106460
106461    /**
106462     * Calculate the byte length of characters which can be included on one
106463     * line of the specified width
106464     *
106465     * Get the byte length of characters which can be included on one line of
106466     * the specified width.
106467     *
106468     * @param string $text The text to measure.
106469     * @param float $width The width of the line.
106470     * @param bool $wordwrap When this parameter is set to TRUE the
106471     *   function "emulates" word wrapping by stopping after the last full
106472     *   word (delimited by whitespace) that can fit on the line.
106473     * @return int Returns the byte length of characters which can be
106474     *   included within the specified width. For single-byte encodings, this
106475     *   is equal to the number of characters. For multi-byte encodings, this
106476     *   is not necessarily the case.
106477     * @since PECL haru >= 0.0.1
106478     **/
106479    function measureText($text, $width, $wordwrap){}
106480
106481    /**
106482     * Move text position to the specified offset
106483     *
106484     * Moves text position to the specified offset. If the start position of
106485     * the current line is (x1, y1), the start of the next line is (x1 +
106486     * {@link x}, y1 + {@link y}).
106487     *
106488     * @param float $x The specified text position offset.
106489     * @param float $y The specified text position offset.
106490     * @param bool $set_leading If set to TRUE, the function sets the text
106491     *   leading to -{@link y}.
106492     * @return bool Returns TRUE on success.
106493     * @since PECL haru >= 0.0.1
106494     **/
106495    function moveTextPos($x, $y, $set_leading){}
106496
106497    /**
106498     * Set starting point for new drawing path
106499     *
106500     * Defines starting point for new drawing path.
106501     *
106502     * @param float $x A new starting point coordinate.
106503     * @param float $y A new starting point coordinate.
106504     * @return bool Returns TRUE on success.
106505     * @since PECL haru >= 0.0.1
106506     **/
106507    function moveTo($x, $y){}
106508
106509    /**
106510     * Move text position to the start of the next line
106511     *
106512     * Moves text position to the start of the next line.
106513     *
106514     * @return bool Returns TRUE on success.
106515     * @since PECL haru >= 0.0.1
106516     **/
106517    function moveToNextLine(){}
106518
106519    /**
106520     * Append a rectangle to the current path
106521     *
106522     * Appends a rectangle to the current drawing path.
106523     *
106524     * @param float $x The left border of the rectangle.
106525     * @param float $y The lower border of the rectangle.
106526     * @param float $width The width of the rectangle.
106527     * @param float $height The height of the rectangle.
106528     * @return bool Returns TRUE on success.
106529     * @since PECL haru >= 0.0.1
106530     **/
106531    function rectangle($x, $y, $width, $height){}
106532
106533    /**
106534     * Set character spacing for the page
106535     *
106536     * Defines character spacing for the page.
106537     *
106538     * @param float $char_space The new character spacing for the page.
106539     * @return bool Returns TRUE on success.
106540     * @since PECL haru >= 0.0.1
106541     **/
106542    function setCharSpace($char_space){}
106543
106544    /**
106545     * Set filling color for the page
106546     *
106547     * Defines filling color for the page.
106548     *
106549     * @param float $c
106550     * @param float $m
106551     * @param float $y
106552     * @param float $k
106553     * @return bool Returns TRUE on success.
106554     * @since PECL haru >= 0.0.1
106555     **/
106556    function setCMYKFill($c, $m, $y, $k){}
106557
106558    /**
106559     * Set stroking color for the page
106560     *
106561     * Defines stroking color for the page.
106562     *
106563     * @param float $c
106564     * @param float $m
106565     * @param float $y
106566     * @param float $k
106567     * @return bool Returns TRUE on success.
106568     * @since PECL haru >= 0.0.1
106569     **/
106570    function setCMYKStroke($c, $m, $y, $k){}
106571
106572    /**
106573     * Set the dash pattern for the page
106574     *
106575     * Defines the dash pattern for the page.
106576     *
106577     * @param array $pattern An array (8 elements max) which contains a
106578     *   pattern of dashes and gaps used for lines on the page.
106579     * @param int $phase The phase on which the pattern begins.
106580     * @return bool Returns TRUE on success.
106581     * @since PECL haru >= 0.0.1
106582     **/
106583    function setDash($pattern, $phase){}
106584
106585    /**
106586     * Set flatness for the page
106587     *
106588     * Defines flatness for the page.
106589     *
106590     * @param float $flatness The defined flatness for the page.
106591     * @return bool Returns TRUE on success.
106592     * @since PECL haru >= 0.0.1
106593     **/
106594    function setFlatness($flatness){}
106595
106596    /**
106597     * Set font and fontsize for the page
106598     *
106599     * Defines current font and its size for the page.
106600     *
106601     * @param object $font A valid HaruFont instance.
106602     * @param float $size The size of the font.
106603     * @return bool Returns TRUE on success.
106604     * @since PECL haru >= 0.0.1
106605     **/
106606    function setFontAndSize($font, $size){}
106607
106608    /**
106609     * Set filling color for the page
106610     *
106611     * Defines filling color for the page.
106612     *
106613     * @param float $value The value of gray level between 0 and 1.
106614     * @return bool Returns TRUE on success.
106615     * @since PECL haru >= 0.0.1
106616     **/
106617    function setGrayFill($value){}
106618
106619    /**
106620     * Sets stroking color for the page
106621     *
106622     * Defines stroking color for the page.
106623     *
106624     * @param float $value The value of gray level between 0 and 1.
106625     * @return bool Returns TRUE on success.
106626     * @since PECL haru >= 0.0.1
106627     **/
106628    function setGrayStroke($value){}
106629
106630    /**
106631     * Set height of the page
106632     *
106633     * Defines height of the page.
106634     *
106635     * @param float $height The defined height for the page.
106636     * @return bool Returns TRUE on success.
106637     * @since PECL haru >= 0.0.1
106638     **/
106639    function setHeight($height){}
106640
106641    /**
106642     * Set horizontal scaling for the page
106643     *
106644     * Set the horizontal scaling for the page.
106645     *
106646     * @param float $scaling The horizontal scaling for text showing on the
106647     *   page. The initial value is 100.
106648     * @return bool Returns TRUE on success.
106649     * @since PECL haru >= 0.0.1
106650     **/
106651    function setHorizontalScaling($scaling){}
106652
106653    /**
106654     * Set the shape to be used at the ends of lines
106655     *
106656     * Defines the shape to be used at the ends of lines.
106657     *
106658     * @param int $cap Must be one of the following values:
106659     *   HaruPage::BUTT_END - the line is squared off at the endpoint of the
106660     *   path. HaruPage::ROUND_END - the end of the line becomes a semicircle
106661     *   with center in the end point of the path.
106662     *   HaruPage::PROJECTING_SCUARE_END - the line continues to the point
106663     *   that exceeds half of the stroke width the end point.
106664     * @return bool Returns TRUE on success.
106665     * @since PECL haru >= 0.0.1
106666     **/
106667    function setLineCap($cap){}
106668
106669    /**
106670     * Set line join style for the page
106671     *
106672     * Defines line join style for the page.
106673     *
106674     * @param int $join Must be one of the following values:
106675     *   HaruPage::MITER_JOIN HaruPage::ROUND_JOIN HaruPage::BEVEL_JOIN
106676     * @return bool Returns TRUE on success.
106677     * @since PECL haru >= 0.0.1
106678     **/
106679    function setLineJoin($join){}
106680
106681    /**
106682     * Set line width for the page
106683     *
106684     * Defines line width for the page.
106685     *
106686     * @param float $width The defined line width for the page.
106687     * @return bool Returns TRUE on success.
106688     * @since PECL haru >= 0.0.1
106689     **/
106690    function setLineWidth($width){}
106691
106692    /**
106693     * Set the current value of the miter limit of the page
106694     *
106695     * @param float $limit Defines the current value of the miter limit of
106696     *   the page.
106697     * @return bool Returns TRUE on success.
106698     * @since PECL haru >= 0.0.1
106699     **/
106700    function setMiterLimit($limit){}
106701
106702    /**
106703     * Set filling color for the page
106704     *
106705     * Defines filling color for the page. All values must be between 0 and
106706     * 1.
106707     *
106708     * @param float $r
106709     * @param float $g
106710     * @param float $b
106711     * @return bool Returns TRUE on success.
106712     * @since PECL haru >= 0.0.1
106713     **/
106714    function setRGBFill($r, $g, $b){}
106715
106716    /**
106717     * Set stroking color for the page
106718     *
106719     * Defines stroking color for the page. All values must be between 0 and
106720     * 1.
106721     *
106722     * @param float $r
106723     * @param float $g
106724     * @param float $b
106725     * @return bool Returns TRUE on success.
106726     * @since PECL haru >= 0.0.1
106727     **/
106728    function setRGBStroke($r, $g, $b){}
106729
106730    /**
106731     * Set rotation angle of the page
106732     *
106733     * Defines rotation angle of the page.
106734     *
106735     * @param int $angle Must be a multiple of 90 degrees.
106736     * @return bool Returns TRUE on success.
106737     * @since PECL haru >= 0.0.1
106738     **/
106739    function setRotate($angle){}
106740
106741    /**
106742     * Set size and direction of the page
106743     *
106744     * Changes size and direction of the page to a predefined format.
106745     *
106746     * @param int $size Must be one of the following values:
106747     *   HaruPage::SIZE_LETTER HaruPage::SIZE_LEGAL HaruPage::SIZE_A3
106748     *   HaruPage::SIZE_A4 HaruPage::SIZE_A5 HaruPage::SIZE_B4
106749     *   HaruPage::SIZE_B5 HaruPage::SIZE_EXECUTIVE HaruPage::SIZE_US4x6
106750     *   HaruPage::SIZE_US4x8 HaruPage::SIZE_US5x7 HaruPage::SIZE_COMM10
106751     * @param int $direction Must be one of the following values:
106752     *   HaruPage::PORTRAIT HaruPage::LANDSCAPE
106753     * @return bool Returns TRUE on success.
106754     * @since PECL haru >= 0.0.1
106755     **/
106756    function setSize($size, $direction){}
106757
106758    /**
106759     * Set transition style for the page
106760     *
106761     * Defines transition style for the page.
106762     *
106763     * @param int $type Must be one of the following values:
106764     *   HaruPage::TS_WIPE_RIGHT HaruPage::TS_WIPE_LEFT HaruPage::TS_WIPE_UP
106765     *   HaruPage::TS_WIPE_DOWN HaruPage::TS_BARN_DOORS_HORIZONTAL_OUT
106766     *   HaruPage::TS_BARN_DOORS_HORIZONTAL_IN
106767     *   HaruPage::TS_BARN_DOORS_VERTICAL_OUT
106768     *   HaruPage::TS_BARN_DOORS_VERTICAL_IN HaruPage::TS_BOX_OUT
106769     *   HaruPage::TS_BOX_IN HaruPage::TS_BLINDS_HORIZONTAL
106770     *   HaruPage::TS_BLINDS_VERTICAL HaruPage::TS_DISSOLVE
106771     *   HaruPage::TS_GLITTER_RIGHT HaruPage::TS_GLITTER_DOWN
106772     *   HaruPage::TS_GLITTER_TOP_LEFT_TO_BOTTOM_RIGHT HaruPage::TS_REPLACE
106773     * @param float $disp_time The display duration of the page in seconds.
106774     * @param float $trans_time The duration of the transition effect in
106775     *   seconds.
106776     * @return bool Returns TRUE on success.
106777     * @since PECL haru >= 0.0.1
106778     **/
106779    function setSlideShow($type, $disp_time, $trans_time){}
106780
106781    /**
106782     * Set text leading (line spacing) for the page
106783     *
106784     * Set the text leading (line spacing) for the page.
106785     *
106786     * @param float $text_leading Defines line spacing for the page.
106787     * @return bool Returns TRUE on success.
106788     * @since PECL haru >= 0.0.1
106789     **/
106790    function setTextLeading($text_leading){}
106791
106792    /**
106793     * Set the current text transformation matrix of the page
106794     *
106795     * Defines the text transformation matrix of the page.
106796     *
106797     * @param float $a Width multiplier.
106798     * @param float $b Vertical skew in radians.
106799     * @param float $c Horizontal skew in radians.
106800     * @param float $d Height multiplier.
106801     * @param float $x Horizontal position for text.
106802     * @param float $y Vertical position for text.
106803     * @return bool Returns TRUE on success.
106804     * @since PECL haru >= 0.0.1
106805     **/
106806    function setTextMatrix($a, $b, $c, $d, $x, $y){}
106807
106808    /**
106809     * Set text rendering mode for the page
106810     *
106811     * Defines text rendering mode for the page.
106812     *
106813     * @param int $mode Must be one of the following values: HaruPage::FILL
106814     *   HaruPage::STROKE HaruPage::FILL_THEN_STROKE HaruPage::INVISIBLE
106815     *   HaruPage::FILL_CLIPPING HaruPage::STROKE_CLIPPING
106816     *   HaruPage::FILL_STROKE_CLIPPING HaruPage::CLIPPING
106817     * @return bool Returns TRUE on success.
106818     * @since PECL haru >= 0.0.1
106819     **/
106820    function setTextRenderingMode($mode){}
106821
106822    /**
106823     * Set the current value of text rising
106824     *
106825     * @param float $rise Defines the current value of text rising.
106826     * @return bool Returns TRUE on success.
106827     * @since PECL haru >= 0.0.1
106828     **/
106829    function setTextRise($rise){}
106830
106831    /**
106832     * Set width of the page
106833     *
106834     * Set the width of the page.
106835     *
106836     * @param float $width Defines width of the page.
106837     * @return bool Returns TRUE on success.
106838     * @since PECL haru >= 0.0.1
106839     **/
106840    function setWidth($width){}
106841
106842    /**
106843     * Set word spacing for the page
106844     *
106845     * Set the word spacing for the page.
106846     *
106847     * @param float $word_space Defines word spacing for the page.
106848     * @return bool Returns TRUE on success.
106849     * @since PECL haru >= 0.0.1
106850     **/
106851    function setWordSpace($word_space){}
106852
106853    /**
106854     * Print text at the current position of the page
106855     *
106856     * Prints out the text at the current position of the page.
106857     *
106858     * @param string $text The text to show.
106859     * @return bool Returns TRUE on success.
106860     * @since PECL haru >= 0.0.1
106861     **/
106862    function showText($text){}
106863
106864    /**
106865     * Move the current position to the start of the next line and print the
106866     * text
106867     *
106868     * Moves the current position to the start of the next line and print out
106869     * the text.
106870     *
106871     * @param string $text The text to show.
106872     * @param float $word_space The word spacing.
106873     * @param float $char_space The character spacing.
106874     * @return bool Returns TRUE on success.
106875     * @since PECL haru >= 0.0.1
106876     **/
106877    function showTextNextLine($text, $word_space, $char_space){}
106878
106879    /**
106880     * Paint current path
106881     *
106882     * Paints the current path.
106883     *
106884     * @param bool $close_path Closes the current path if set to TRUE.
106885     * @return bool Returns TRUE on success.
106886     * @since PECL haru >= 0.0.1
106887     **/
106888    function stroke($close_path){}
106889
106890    /**
106891     * Print the text on the specified position
106892     *
106893     * Prints the text on the specified position.
106894     *
106895     * @param float $x
106896     * @param float $y
106897     * @param string $text
106898     * @return bool Returns TRUE on success.
106899     * @since PECL haru >= 0.0.1
106900     **/
106901    function textOut($x, $y, $text){}
106902
106903    /**
106904     * Print the text inside the specified region
106905     *
106906     * Prints the text inside the specified region.
106907     *
106908     * @param float $left Left border of the text area.
106909     * @param float $top Top border of the text area.
106910     * @param float $right Right border of the text area.
106911     * @param float $bottom Lower border of the text area.
106912     * @param string $text The text to print.
106913     * @param int $align Text alignment. Must be one of the following
106914     *   values: HaruPage::TALIGN_LEFT HaruPage::TALIGN_RIGHT
106915     *   HaruPage::TALIGN_CENTER HaruPage::TALIGN_JUSTIFY
106916     * @return bool Returns TRUE on success.
106917     * @since PECL haru >= 0.0.1
106918     **/
106919    function textRect($left, $top, $right, $bottom, $text, $align){}
106920
106921}
106922class HashContext {
106923}
106924namespace HRTime {
106925class PerformanceCounter {
106926    /**
106927     * Timer frequency in ticks per second
106928     *
106929     * Returns the timer frequency in ticks per second. This value is
106930     * constant after the system start on almost any operating system.
106931     *
106932     * @return int Returns indicating the timer frequency.
106933     **/
106934    public static function getFrequency(){}
106935
106936    /**
106937     * Current ticks from the system
106938     *
106939     * Returns the ticks count.
106940     *
106941     * @return int Returns indicating the ticks count.
106942     **/
106943    public static function getTicks(){}
106944
106945    /**
106946     * Ticks elapsed since the given value
106947     *
106948     * Returns the ticks count elapsed since the given start value.
106949     *
106950     * @param int $start Starting ticks value.
106951     * @return int Returns indicating the ticks count.
106952     **/
106953    public static function getTicksSince($start){}
106954
106955}
106956}
106957namespace HRTime {
106958class StopWatch extends HRTime\PerformanceCounter {
106959    /**
106960     * Get elapsed ticks for all intervals
106961     *
106962     * Get elapsed ticks for all the previously closed intervals.
106963     *
106964     * @return int Returns indicating elapsed ticks.
106965     **/
106966    public function getElapsedTicks(){}
106967
106968    /**
106969     * Get elapsed time for all intervals
106970     *
106971     * Get elapsed time for all the previously closed intervals.
106972     *
106973     * @param int $unit Time unit represented by a HRTime\Unit constant.
106974     *   Default is HRTime\Unit::SECOND.
106975     * @return float Returns indicating elapsed time.
106976     **/
106977    public function getElapsedTime($unit){}
106978
106979    /**
106980     * Get elapsed ticks for the last interval
106981     *
106982     * Get elapsed ticks for the previously closed interval.
106983     *
106984     * @return int Returns indicating elapsed ticks.
106985     **/
106986    public function getLastElapsedTicks(){}
106987
106988    /**
106989     * Get elapsed time for the last interval
106990     *
106991     * Get elapsed time for the previously closed interval.
106992     *
106993     * @param int $unit Time unit represented by a HRTime\Unit constant.
106994     *   Default is HRTime\Unit::SECOND.
106995     * @return float Returns indicating elapsed time.
106996     **/
106997    public function getLastElapsedTime($unit){}
106998
106999    /**
107000     * Whether the measurement is running
107001     *
107002     * Reveals whether the measurement was started.
107003     *
107004     * @return bool Returns indicating whetehr the measurement is running.
107005     **/
107006    public function isRunning(){}
107007
107008    /**
107009     * Start time measurement
107010     *
107011     * Starts the time measurement. It has no effect if the measurement was
107012     * already started. The measurement will be continued if it was
107013     * previously stopped.
107014     *
107015     * @return void Returns void.
107016     **/
107017    public function start(){}
107018
107019    /**
107020     * Stop time measurement
107021     *
107022     * Stop the time measurement for the previously started interval.
107023     *
107024     * @return void Returns void.
107025     **/
107026    public function stop(){}
107027
107028}
107029}
107030namespace HRTime {
107031class Unit {
107032}
107033}
107034class hw_api {
107035    /**
107036     * Checks in an object
107037     *
107038     * This function checks in an object or a whole hierarchy of objects. The
107039     * parameters array contains the required element 'objectIdentifier' and
107040     * the optional element 'version', 'comment', 'mode' and 'objectQuery'.
107041     * 'version' sets the version of the object. It consists of the major and
107042     * minor version separated by a period. If the version is not set, the
107043     * minor version is incremented. 'mode' can be one of the following
107044     * values: HW_API_CHECKIN_NORMAL Checks in and commits the object. The
107045     * object must be a document. HW_API_CHECKIN_RECURSIVE If the object to
107046     * check in is a collection, all children will be checked in recursively
107047     * if they are documents. Trying to check in a collection would result in
107048     * an error. HW_API_CHECKIN_FORCE_VERSION_CONTROL Checks in an object
107049     * even if it is not under version control.
107050     * HW_API_CHECKIN_REVERT_IF_NOT_CHANGED Check if the new version is
107051     * different from the last version. Unless this is the case the object
107052     * will be checked in. HW_API_CHECKIN_KEEP_TIME_MODIFIED Keeps the time
107053     * modified from the most recent object. HW_API_CHECKIN_NO_AUTO_COMMIT
107054     * The object is not automatically committed on check-in.
107055     *
107056     * @param array $parameter
107057     * @return bool
107058     **/
107059    function checkin($parameter){}
107060
107061    /**
107062     * Checks out an object
107063     *
107064     * This function checks out an object or a whole hierarchy of objects.
107065     *
107066     * @param array $parameter The parameters array contains the required
107067     *   element 'objectIdentifier' and the optional element 'version',
107068     *   'mode' and 'objectQuery'. 'mode' can be one of the following values:
107069     *   HW_API_CHECKIN_NORMAL Checks out an object. The object must be a
107070     *   document. HW_API_CHECKIN_RECURSIVE If the object to check out is a
107071     *   collection, all children will be checked out recursively if they are
107072     *   documents. Trying to check out a collection would result in an
107073     *   error.
107074     * @return bool
107075     **/
107076    function checkout($parameter){}
107077
107078    /**
107079     * Returns children of an object
107080     *
107081     * Retrieves the children of a collection or the attributes of a
107082     * document. The children can be further filtered by specifying an object
107083     * query.
107084     *
107085     * @param array $parameter The parameter array contains the required
107086     *   elements 'objectIdentifier' and the optional elements
107087     *   'attributeSelector' and 'objectQuery'.
107088     * @return array The return value is an array of objects of type
107089     *   HW_API_Object or HW_API_Error.
107090     **/
107091    function children($parameter){}
107092
107093    /**
107094     * Returns content of an object
107095     *
107096     * This function returns the content of a document as an object of type
107097     * hw_api_content.
107098     *
107099     * @param array $parameter The parameter array contains the required
107100     *   elements 'objectidentifier' and the optional element 'mode'. The
107101     *   mode can be one of the constants HW_API_CONTENT_ALLLINKS,
107102     *   HW_API_CONTENT_REACHABLELINKS or HW_API_CONTENT_PLAIN.
107103     *   HW_API_CONTENT_ALLLINKS means to insert all anchors even if the
107104     *   destination is not reachable. HW_API_CONTENT_REACHABLELINKS tells
107105     *   this method to insert only reachable links and HW_API_CONTENT_PLAIN
107106     *   will lead to document without any links.
107107     * @return HW_API_Content Returns an instance of hw_api_content.
107108     **/
107109    function content($parameter){}
107110
107111    /**
107112     * Copies physically
107113     *
107114     * This function will make a physical copy including the content if it
107115     * exists and returns the new object or an error object.
107116     *
107117     * @param array $parameter The parameter array contains the required
107118     *   elements 'objectIdentifier' and 'destinationParentIdentifier'. The
107119     *   optional parameter is 'attributeSelector'`
107120     * @return hw_api_content Returns the copied object.
107121     **/
107122    function copy($parameter){}
107123
107124    /**
107125     * Returns statistics about database server
107126     *
107127     * @param array $parameter
107128     * @return hw_api_object
107129     **/
107130    function dbstat($parameter){}
107131
107132    /**
107133     * Returns statistics about document cache server
107134     *
107135     * @param array $parameter
107136     * @return hw_api_object
107137     **/
107138    function dcstat($parameter){}
107139
107140    /**
107141     * Returns a list of all destination anchors
107142     *
107143     * Retrieves all destination anchors of an object.
107144     *
107145     * @param array $parameter The parameter array contains the required
107146     *   element 'objectIdentifier' and the optional elements
107147     *   'attributeSelector' and 'objectQuery'.
107148     * @return array
107149     **/
107150    function dstanchors($parameter){}
107151
107152    /**
107153     * Returns destination of a source anchor
107154     *
107155     * Retrieves the destination object pointed by the specified source
107156     * anchors. The destination object can either be a destination anchor or
107157     * a whole document.
107158     *
107159     * @param array $parameter The parameters array contains the required
107160     *   element 'objectIdentifier' and the optional element
107161     *   'attributeSelector'.
107162     * @return hw_api_object
107163     **/
107164    function dstofsrcanchor($parameter){}
107165
107166    /**
107167     * Search for objects
107168     *
107169     * This functions searches for objects either by executing a key or/and
107170     * full text query. The found objects can further be filtered by an
107171     * optional object query. They are sorted by their importance. The second
107172     * search operation is relatively slow and its result can be limited to a
107173     * certain number of hits. This allows to perform an incremental search,
107174     * each returning just a subset of all found documents, starting at a
107175     * given index.
107176     *
107177     * @param array $parameter The parameter array contains the 'keyquery'
107178     *   or/and 'fulltextquery' depending on who you would like to search.
107179     *   Optional parameters are 'objectquery', 'scope', 'languages' and
107180     *   'attributeselector'. In case of an incremental search the optional
107181     *   parameters 'startIndex', 'numberOfObjectsToGet' and 'exactMatchUnit'
107182     *   can be passed.
107183     * @return array
107184     **/
107185    function find($parameter){}
107186
107187    /**
107188     * Returns statistics about fulltext server
107189     *
107190     * @param array $parameter
107191     * @return hw_api_object
107192     **/
107193    function ftstat($parameter){}
107194
107195    /**
107196     * Returns statistics about Hyperwave server
107197     *
107198     * @param array $parameter
107199     * @return hw_api_object
107200     **/
107201    function hwstat($parameter){}
107202
107203    /**
107204     * Log into Hyperwave Server
107205     *
107206     * Logs into the Hyperwave Server.
107207     *
107208     * @param array $parameter The parameter array must contain the
107209     *   elements 'username' and 'password'.
107210     * @return bool Returns an object of typeHW_API_Error if identification
107211     *   failed or TRUE if it was successful.
107212     **/
107213    function identify($parameter){}
107214
107215    /**
107216     * Returns information about server configuration
107217     *
107218     * @param array $parameter
107219     * @return array
107220     **/
107221    function info($parameter){}
107222
107223    /**
107224     * Inserts a new object
107225     *
107226     * Insert a new object. The object type can be user, group, document or
107227     * anchor. Depending on the type other object attributes has to be set.
107228     *
107229     * @param array $parameter The parameter array contains the required
107230     *   elements 'object' and 'content' (if the object is a document) and
107231     *   the optional parameters 'parameters', 'mode' and
107232     *   'attributeSelector'. The 'object' must contain all attributes of the
107233     *   object. 'parameters' is an object as well holding further attributes
107234     *   like the destination (attribute key is 'Parent'). 'content' is the
107235     *   content of the document. 'mode' can be a combination of the
107236     *   following flags: HW_API_INSERT_NORMAL The object in inserted into
107237     *   the server. HW_API_INSERT_FORCE_VERSION_CONTROL
107238     *   HW_API_INSERT_AUTOMATIC_CHECKOUT HW_API_INSERT_PLAIN
107239     *   HW_API_INSERT_KEEP_TIME_MODIFIED HW_API_INSERT_DELAY_INDEXING
107240     * @return hw_api_object
107241     **/
107242    function insert($parameter){}
107243
107244    /**
107245     * Inserts a new object of type anchor
107246     *
107247     * This function is a shortcut for {@link hwapi_insert}. It inserts an
107248     * object of type anchor and sets some of the attributes required for an
107249     * anchor.
107250     *
107251     * @param array $parameter The parameter array contains the required
107252     *   elements 'object' and 'documentIdentifier' and the optional elements
107253     *   'destinationIdentifier', 'parameter', 'hint' and
107254     *   'attributeSelector'. The 'documentIdentifier' specifies the document
107255     *   where the anchor shall be inserted. The target of the anchor is set
107256     *   in 'destinationIdentifier' if it already exists. If the target does
107257     *   not exists the element 'hint' has to be set to the name of object
107258     *   which is supposed to be inserted later. Once it is inserted the
107259     *   anchor target is resolved automatically.
107260     * @return hw_api_object
107261     **/
107262    function insertanchor($parameter){}
107263
107264    /**
107265     * Inserts a new object of type collection
107266     *
107267     * This function is a shortcut for {@link hwapi_insert}. It inserts an
107268     * object of type collection and sets some of the attributes required for
107269     * a collection.
107270     *
107271     * @param array $parameter The parameter array contains the required
107272     *   elements 'object' and 'parentIdentifier' and the optional elements
107273     *   'parameter' and 'attributeSelector'. See {@link hwapi_insert} for
107274     *   the meaning of each element.
107275     * @return hw_api_object
107276     **/
107277    function insertcollection($parameter){}
107278
107279    /**
107280     * Inserts a new object of type document
107281     *
107282     * This function is a shortcut for {@link hwapi_insert}. It inserts an
107283     * object with content and sets some of the attributes required for a
107284     * document.
107285     *
107286     * @param array $parameter The parameter array contains the required
107287     *   elements 'object', 'parentIdentifier' and 'content' and the optional
107288     *   elements 'mode', 'parameter' and 'attributeSelector'. See {@link
107289     *   hwapi_insert} for the meaning of each element.
107290     * @return hw_api_object
107291     **/
107292    function insertdocument($parameter){}
107293
107294    /**
107295     * Creates a link to an object
107296     *
107297     * Creates a link to an object. Accessing this link is like accessing the
107298     * object to links points to.
107299     *
107300     * @param array $parameter The parameter array contains the required
107301     *   elements 'objectIdentifier' and 'destinationParentIdentifier'.
107302     *   'destinationParentIdentifier' is the target collection.
107303     * @return bool The function returns TRUE on success or an error
107304     *   object.
107305     **/
107306    function link($parameter){}
107307
107308    /**
107309     * Locks an object
107310     *
107311     * Locks an object for exclusive editing by the user calling this
107312     * function. The object can be only unlocked by this user or the system
107313     * user.
107314     *
107315     * @param array $parameter The parameter array contains the required
107316     *   element 'objectIdentifier' and the optional parameters 'mode' and
107317     *   'objectquery'. 'mode' determines how an object is locked.
107318     *   HW_API_LOCK_NORMAL means, an object is locked until it is unlocked.
107319     *   HW_API_LOCK_RECURSIVE is only valid for collection and locks all
107320     *   objects within the collection and possible subcollections.
107321     *   HW_API_LOCK_SESSION means, an object is locked only as long as the
107322     *   session is valid.
107323     * @return bool
107324     **/
107325    function lock($parameter){}
107326
107327    /**
107328     * Moves object between collections
107329     *
107330     * @param array $parameter
107331     * @return bool
107332     **/
107333    function move($parameter){}
107334
107335    /**
107336     * Retrieve attribute information
107337     *
107338     * This function retrieves the attribute information of an object of any
107339     * version. It will not return the document content.
107340     *
107341     * @param array $parameter The parameter array contains the required
107342     *   elements 'objectIdentifier' and the optional elements
107343     *   'attributeSelector' and 'version'.
107344     * @return hw_api_object The returned object is an instance of class
107345     *   HW_API_Object on success or HW_API_Error if an error occurred.
107346     **/
107347    function object($parameter){}
107348
107349    /**
107350     * Returns the object an anchor belongs to
107351     *
107352     * This function retrieves an object the specified anchor belongs to.
107353     *
107354     * @param array $parameter The parameter array contains the required
107355     *   element 'objectIdentifier' and the optional element
107356     *   'attributeSelector'.
107357     * @return hw_api_object
107358     **/
107359    function objectbyanchor($parameter){}
107360
107361    /**
107362     * Returns parents of an object
107363     *
107364     * Retrieves the parents of an object. The parents can be further
107365     * filtered by specifying an object query.
107366     *
107367     * @param array $parameter The parameter array contains the required
107368     *   elements 'objectidentifier' and the optional elements
107369     *   'attributeselector' and 'objectquery'.
107370     * @return array The return value is an array of objects of type
107371     *   HW_API_Object or HW_API_Error.
107372     **/
107373    function parents($parameter){}
107374
107375    /**
107376     * Delete an object
107377     *
107378     * Removes an object from the specified parent. Collections will be
107379     * removed recursively.
107380     *
107381     * @param array $parameter You can pass an optional object query to
107382     *   remove only those objects which match the query. An object will be
107383     *   deleted physically if it is the last instance. The parameter array
107384     *   contains the required elements 'objectidentifier' and
107385     *   'parentidentifier'. If you want to remove a user or group
107386     *   'parentidentifier' can be skipped. The optional parameter 'mode'
107387     *   determines how the deletion is performed. In normal mode the object
107388     *   will not be removed physically until all instances are removed. In
107389     *   physical mode all instances of the object will be deleted
107390     *   immediately. In removelinks mode all references to and from the
107391     *   objects will be deleted as well. In nonrecursive the deletion is not
107392     *   performed recursive. Removing a collection which is not empty will
107393     *   cause an error.
107394     * @return bool
107395     **/
107396    function remove($parameter){}
107397
107398    /**
107399     * Replaces an object
107400     *
107401     * Replaces the attributes and the content of an object.
107402     *
107403     * @param array $parameter The parameter array contains the required
107404     *   elements 'objectIdentifier' and 'object' and the optional parameters
107405     *   'content', 'parameters', 'mode' and 'attributeSelector'.
107406     *   'objectIdentifier' contains the object to be replaced. 'object'
107407     *   contains the new object. 'content' contains the new content.
107408     *   'parameters' contain extra information for HTML documents.
107409     *   HTML_Language is the letter abbreviation of the language of the
107410     *   title. HTML_Base sets the base attribute of the HTML document.
107411     *   'mode' can be a combination of the following flags:
107412     *   HW_API_REPLACE_NORMAL The object on the server is replace with the
107413     *   object passed. HW_API_REPLACE_FORCE_VERSION_CONTROL
107414     *   HW_API_REPLACE_AUTOMATIC_CHECKOUT HW_API_REPLACE_AUTOMATIC_CHECKIN
107415     *   HW_API_REPLACE_PLAIN HW_API_REPLACE_REVERT_IF_NOT_CHANGED
107416     *   HW_API_REPLACE_KEEP_TIME_MODIFIED
107417     * @return hw_api_object
107418     **/
107419    function replace($parameter){}
107420
107421    /**
107422     * Commits version other than last version
107423     *
107424     * Commits a version of a document. The committed version is the one
107425     * which is visible to users with read access. By default the last
107426     * version is the committed version.
107427     *
107428     * @param array $parameter
107429     * @return hw_api_object
107430     **/
107431    function setcommittedversion($parameter){}
107432
107433    /**
107434     * Returns a list of all source anchors
107435     *
107436     * Retrieves all source anchors of an object.
107437     *
107438     * @param array $parameter The parameter array contains the required
107439     *   element 'objectIdentifier' and the optional elements
107440     *   'attributeSelector' and 'objectQuery'.
107441     * @return array
107442     **/
107443    function srcanchors($parameter){}
107444
107445    /**
107446     * Returns source of a destination object
107447     *
107448     * Retrieves all the source anchors pointing to the specified
107449     * destination. The destination object can either be a destination anchor
107450     * or a whole document.
107451     *
107452     * @param array $parameter The parameters array contains the required
107453     *   element 'objectIdentifier' and the optional element
107454     *   'attributeSelector' and 'objectQuery'. The function returns an array
107455     *   of objects or an error.
107456     * @return array
107457     **/
107458    function srcsofdst($parameter){}
107459
107460    /**
107461     * Unlocks a locked object
107462     *
107463     * Unlocks a locked object. Only the user who has locked the object and
107464     * the system user may unlock an object.
107465     *
107466     * @param array $parameter The parameter array contains the required
107467     *   element 'objectIdentifier' and the optional parameters 'mode' and
107468     *   'objectquery'. The meaning of 'mode' is the same as in function
107469     *   {@link hwapi_lock}.
107470     * @return bool Returns TRUE on success or an object of class
107471     *   HW_API_Error.
107472     **/
107473    function unlock($parameter){}
107474
107475    /**
107476     * Returns the own user object
107477     *
107478     * @param array $parameter
107479     * @return hw_api_object
107480     **/
107481    function user($parameter){}
107482
107483    /**
107484     * Returns a list of all logged in users
107485     *
107486     * @param array $parameter
107487     * @return array
107488     **/
107489    function userlist($parameter){}
107490
107491}
107492class hw_api_attribute {
107493    /**
107494     * Returns key of the attribute
107495     *
107496     * Returns the name of the attribute.
107497     *
107498     * @return string Returns the name of the attribute as a string.
107499     **/
107500    function key(){}
107501
107502    /**
107503     * Returns value for a given language
107504     *
107505     * Returns the value in the given language of the attribute.
107506     *
107507     * @param string $language
107508     * @return string Returns the value of the attribute as a string.
107509     **/
107510    function langdepvalue($language){}
107511
107512    /**
107513     * Returns value of the attribute
107514     *
107515     * Gets the value of the attribute.
107516     *
107517     * @return string Returns the value, as a string.
107518     **/
107519    function value(){}
107520
107521    /**
107522     * Returns all values of the attribute
107523     *
107524     * Gets all values of the attribute.
107525     *
107526     * @return array Returns an array of attribute values.
107527     **/
107528    function values(){}
107529
107530}
107531class hw_api_content {
107532    /**
107533     * Returns mimetype
107534     *
107535     * Returns the mimetype of the content.
107536     *
107537     * @return string Returns the mimetype as a string.
107538     **/
107539    function mimetype(){}
107540
107541    /**
107542     * Read content
107543     *
107544     * Reads {@link len} bytes from the content into the given buffer.
107545     *
107546     * @param string $buffer
107547     * @param int $len Number of bytes to read.
107548     * @return string
107549     **/
107550    function read($buffer, $len){}
107551
107552}
107553class hw_api_error {
107554    /**
107555     * Returns number of reasons
107556     *
107557     * Returns the number of error reasons.
107558     *
107559     * @return int Returns the number of errors, as an integer.
107560     **/
107561    function count(){}
107562
107563    /**
107564     * Returns reason of error
107565     *
107566     * Returns the first error reason.
107567     *
107568     * @return HW_API_Reason
107569     **/
107570    function reason(){}
107571
107572}
107573class hw_api_object {
107574    /**
107575     * Clones object
107576     *
107577     * Clones the attributes of an object.
107578     *
107579     * @param array $parameter
107580     * @return bool
107581     **/
107582    function assign($parameter){}
107583
107584    /**
107585     * Checks whether an attribute is editable
107586     *
107587     * @param array $parameter
107588     * @return bool Returns TRUE if the attribute is editable, FALSE
107589     *   otherwise.
107590     **/
107591    function attreditable($parameter){}
107592
107593    /**
107594     * Returns number of attributes
107595     *
107596     * Returns the number of attributes.
107597     *
107598     * @param array $parameter
107599     * @return int Returns the number as an integer.
107600     **/
107601    function count($parameter){}
107602
107603    /**
107604     * Inserts new attribute
107605     *
107606     * Adds an attribute to the object.
107607     *
107608     * @param HW_API_Attribute $attribute
107609     * @return bool
107610     **/
107611    function insert($attribute){}
107612
107613    /**
107614     * Removes attribute
107615     *
107616     * Removes the attribute with the given name.
107617     *
107618     * @param string $name The attribute name.
107619     * @return bool
107620     **/
107621    function remove($name){}
107622
107623    /**
107624     * Returns the title attribute
107625     *
107626     * @param array $parameter
107627     * @return string Returns the title as a string.
107628     **/
107629    function title($parameter){}
107630
107631    /**
107632     * Returns value of attribute
107633     *
107634     * Returns value of an attribute.
107635     *
107636     * @param string $name The attribute name.
107637     * @return string Returns the value of the attribute with the given
107638     *   name or FALSE if an error occurred.
107639     **/
107640    function value($name){}
107641
107642}
107643class hw_api_reason {
107644    /**
107645     * Returns description of reason
107646     *
107647     * Returns the description of a reason
107648     *
107649     * @return string Returns the description, as a string.
107650     **/
107651    function description(){}
107652
107653    /**
107654     * Returns type of reason
107655     *
107656     * Returns the type of a reason.
107657     *
107658     * @return HW_API_Reason Returns an instance of HW_API_Reason.
107659     **/
107660    function type(){}
107661
107662}
107663/**
107664 * The Imagick class has the ability to hold and operate on multiple
107665 * images simultaneously. This is achieved through an internal stack.
107666 * There is always an internal pointer that points at the current image.
107667 * Some functions operate on all images in the Imagick class, but most
107668 * operate only on the current image in the internal stack. As a
107669 * convention, method names can contain the word Image to denote they
107670 * affect only the current image in the stack. Because there are so many
107671 * methods, here is a handy list of methods, somewhat reduced to their
107672 * general purpose:
107673 **/
107674class Imagick implements Iterator {
107675    /**
107676     * Adds adaptive blur filter to image
107677     *
107678     * Adds an adaptive blur filter to image. The intensity of an adaptive
107679     * blur depends is dramatically decreased at edge of the image, whereas a
107680     * standard blur is uniform across the image.
107681     *
107682     * @param float $radius The radius of the Gaussian, in pixels, not
107683     *   counting the center pixel. Provide a value of 0 and the radius will
107684     *   be chosen automagically.
107685     * @param float $sigma The standard deviation of the Gaussian, in
107686     *   pixels.
107687     * @param int $channel
107688     * @return bool
107689     * @since PECL imagick 2.0.0
107690     **/
107691    function adaptiveBlurImage($radius, $sigma, $channel){}
107692
107693    /**
107694     * Adaptively resize image with data dependent triangulation
107695     *
107696     * Adaptively resize image with data-dependent triangulation. Avoids
107697     * blurring across sharp color changes. Most useful when used to shrink
107698     * images slightly to a slightly smaller "web size"; may not look good
107699     * when a full-sized image is adaptively resized to a thumbnail.
107700     *
107701     * @param int $columns The number of columns in the scaled image.
107702     * @param int $rows The number of rows in the scaled image.
107703     * @param bool $bestfit Whether to fit the image inside a bounding box.
107704     * @param bool $legacy
107705     * @return bool
107706     * @since PECL imagick 2.0.0
107707     **/
107708    function adaptiveResizeImage($columns, $rows, $bestfit, $legacy){}
107709
107710    /**
107711     * Adaptively sharpen the image
107712     *
107713     * Adaptively sharpen the image by sharpening more intensely near image
107714     * edges and less intensely far from edges.
107715     *
107716     * @param float $radius The radius of the Gaussian, in pixels, not
107717     *   counting the center pixel. Use 0 for auto-select.
107718     * @param float $sigma The standard deviation of the Gaussian, in
107719     *   pixels.
107720     * @param int $channel
107721     * @return bool
107722     * @since PECL imagick 2.0.0
107723     **/
107724    function adaptiveSharpenImage($radius, $sigma, $channel){}
107725
107726    /**
107727     * Selects a threshold for each pixel based on a range of intensity
107728     *
107729     * Selects an individual threshold for each pixel based on the range of
107730     * intensity values in its local neighborhood. This allows for
107731     * thresholding of an image whose global intensity histogram doesn't
107732     * contain distinctive peaks.
107733     *
107734     * @param int $width Width of the local neighborhood.
107735     * @param int $height Height of the local neighborhood.
107736     * @param int $offset The mean offset
107737     * @return bool
107738     * @since PECL imagick 2.0.0
107739     **/
107740    function adaptiveThresholdImage($width, $height, $offset){}
107741
107742    /**
107743     * Adds new image to Imagick object image list
107744     *
107745     * Adds new image to Imagick object from the current position of the
107746     * source object. After the operation iterator position is moved at the
107747     * end of the list.
107748     *
107749     * @param Imagick $source The source Imagick object
107750     * @return bool
107751     * @since PECL imagick 2.0.0
107752     **/
107753    function addImage($source){}
107754
107755    /**
107756     * Adds random noise to the image
107757     *
107758     * @param int $noise_type The type of the noise. Refer to this list of
107759     *   noise constants.
107760     * @param int $channel
107761     * @return bool
107762     * @since PECL imagick 2.0.0
107763     **/
107764    function addNoiseImage($noise_type, $channel){}
107765
107766    /**
107767     * Transforms an image
107768     *
107769     * Transforms an image as dictated by the affine matrix.
107770     *
107771     * @param ImagickDraw $matrix The affine matrix
107772     * @return bool
107773     * @since PECL imagick 2.0.0
107774     **/
107775    function affineTransformImage($matrix){}
107776
107777    /**
107778     * Animates an image or images
107779     *
107780     * This method animates the image onto a local or remote X server. This
107781     * method is not available on Windows.
107782     *
107783     * @param string $x_server X server address
107784     * @return bool
107785     **/
107786    function animateImages($x_server){}
107787
107788    /**
107789     * Annotates an image with text
107790     *
107791     * @param ImagickDraw $draw_settings The ImagickDraw object that
107792     *   contains settings for drawing the text
107793     * @param float $x Horizontal offset in pixels to the left of text
107794     * @param float $y Vertical offset in pixels to the baseline of text
107795     * @param float $angle The angle at which to write the text
107796     * @param string $text The string to draw
107797     * @return bool
107798     * @since PECL imagick 2.0.0
107799     **/
107800    function annotateImage($draw_settings, $x, $y, $angle, $text){}
107801
107802    /**
107803     * Append a set of images
107804     *
107805     * Append a set of images into one larger image.
107806     *
107807     * @param bool $stack Whether to stack the images vertically. By
107808     *   default (or if FALSE is specified) images are stacked left-to-right.
107809     *   If {@link stack} is TRUE, images are stacked top-to-bottom.
107810     * @return Imagick Returns Imagick instance on success.
107811     * @since PECL imagick 2.0.0
107812     **/
107813    function appendImages($stack){}
107814
107815    /**
107816     * Adjusts the levels of a particular image channel by scaling the
107817     * minimum and maximum values to the full quantum range.
107818     *
107819     * @param int $channel Which channel should the auto-levelling should
107820     *   be done on.
107821     * @return bool
107822     **/
107823    public function autoLevelImage($channel){}
107824
107825    /**
107826     * Average a set of images
107827     *
107828     * @return Imagick Returns a new Imagick object on success.
107829     * @since PECL imagick 2.0.0
107830     **/
107831    function averageImages(){}
107832
107833    /**
107834     * Forces all pixels below the threshold into black
107835     *
107836     * Is like Imagick::thresholdImage() but forces all pixels below the
107837     * threshold into black while leaving all pixels above the threshold
107838     * unchanged.
107839     *
107840     * @param mixed $threshold The threshold below which everything turns
107841     *   black
107842     * @return bool
107843     * @since PECL imagick 2.0.0
107844     **/
107845    function blackThresholdImage($threshold){}
107846
107847    /**
107848     * Mutes the colors of the image to simulate a scene at nighttime in the
107849     * moonlight.
107850     *
107851     * @param float $factor
107852     * @return bool
107853     **/
107854    public function blueShiftImage($factor){}
107855
107856    /**
107857     * Adds blur filter to image
107858     *
107859     * Adds blur filter to image. Optional third parameter to blur a specific
107860     * channel.
107861     *
107862     * @param float $radius Blur radius
107863     * @param float $sigma Standard deviation
107864     * @param int $channel The Channeltype constant. When not supplied, all
107865     *   channels are blurred.
107866     * @return bool
107867     * @since PECL imagick 2.0.0
107868     **/
107869    function blurImage($radius, $sigma, $channel){}
107870
107871    /**
107872     * Surrounds the image with a border
107873     *
107874     * Surrounds the image with a border of the color defined by the
107875     * bordercolor ImagickPixel object.
107876     *
107877     * @param mixed $bordercolor ImagickPixel object or a string containing
107878     *   the border color
107879     * @param int $width Border width
107880     * @param int $height Border height
107881     * @return bool
107882     * @since PECL imagick 2.0.0
107883     **/
107884    function borderImage($bordercolor, $width, $height){}
107885
107886    /**
107887     * Change the brightness and/or contrast of an image. It converts the
107888     * brightness and contrast parameters into slope and intercept and calls
107889     * a polynomical function to apply to the image.
107890     *
107891     * @param float $brightness
107892     * @param float $contrast
107893     * @param int $channel
107894     * @return bool
107895     **/
107896    public function brightnessContrastImage($brightness, $contrast, $channel){}
107897
107898    /**
107899     * Simulates a charcoal drawing
107900     *
107901     * @param float $radius The radius of the Gaussian, in pixels, not
107902     *   counting the center pixel
107903     * @param float $sigma The standard deviation of the Gaussian, in
107904     *   pixels
107905     * @return bool
107906     * @since PECL imagick 2.0.0
107907     **/
107908    function charcoalImage($radius, $sigma){}
107909
107910    /**
107911     * Removes a region of an image and trims
107912     *
107913     * Removes a region of an image and collapses the image to occupy the
107914     * removed portion.
107915     *
107916     * @param int $width Width of the chopped area
107917     * @param int $height Height of the chopped area
107918     * @param int $x X origo of the chopped area
107919     * @param int $y Y origo of the chopped area
107920     * @return bool
107921     * @since PECL imagick 2.0.0
107922     **/
107923    function chopImage($width, $height, $x, $y){}
107924
107925    /**
107926     * Restricts the color range from 0 to the quantum depth.
107927     *
107928     * @param int $channel
107929     * @return bool
107930     **/
107931    public function clampImage($channel){}
107932
107933    /**
107934     * Clears all resources associated to Imagick object
107935     *
107936     * @return bool
107937     * @since PECL imagick 2.0.0
107938     **/
107939    function clear(){}
107940
107941    /**
107942     * Clips along the first path from the 8BIM profile
107943     *
107944     * Clips along the first path from the 8BIM profile, if present.
107945     *
107946     * @return bool
107947     * @since PECL imagick 2.0.0
107948     **/
107949    function clipImage(){}
107950
107951    /**
107952     * Clips along the named paths from the 8BIM profile, if present. Later
107953     * operations take effect inside the path. Id may be a number if preceded
107954     * with #, to work on a numbered path, e.g., "#1" to use the first path.
107955     *
107956     * @param string $pathname
107957     * @param string $inside
107958     * @return void
107959     **/
107960    public function clipImagePath($pathname, $inside){}
107961
107962    /**
107963     * Clips along the named paths from the 8BIM profile
107964     *
107965     * Clips along the named paths from the 8BIM profile, if present. Later
107966     * operations take effect inside the path. It may be a number if preceded
107967     * with #, to work on a numbered path, e.g., "#1" to use the first path.
107968     *
107969     * @param string $pathname The name of the path
107970     * @param bool $inside If TRUE later operations take effect inside
107971     *   clipping path. Otherwise later operations take effect outside
107972     *   clipping path.
107973     * @return bool
107974     * @since PECL imagick 2.0.0
107975     **/
107976    function clipPathImage($pathname, $inside){}
107977
107978    /**
107979     * Replaces colors in the image
107980     *
107981     * Replaces colors in the image from a color lookup table. Optional
107982     * second parameter to replace colors in a specific channel.
107983     *
107984     * @param Imagick $lookup_table Imagick object containing the color
107985     *   lookup table
107986     * @param int $channel The Channeltype constant. When not supplied,
107987     *   default channels are replaced.
107988     * @return bool
107989     * @since PECL imagick 2.0.0
107990     **/
107991    function clutImage($lookup_table, $channel){}
107992
107993    /**
107994     * Composites a set of images
107995     *
107996     * Composites a set of images while respecting any page offsets and
107997     * disposal methods. GIF, MIFF, and MNG animation sequences typically
107998     * start with an image background and each subsequent image varies in
107999     * size and offset. Returns a new Imagick object where each image in the
108000     * sequence is the same size as the first and composited with the next
108001     * image in the sequence.
108002     *
108003     * @return Imagick Returns a new Imagick object on success.
108004     * @since PECL imagick 2.0.0
108005     **/
108006    function coalesceImages(){}
108007
108008    /**
108009     * Changes the color value of any pixel that matches target
108010     *
108011     * Changes the color value of any pixel that matches target and is an
108012     * immediate neighbor.
108013     *
108014     * @param mixed $fill ImagickPixel object containing the fill color
108015     * @param float $fuzz The amount of fuzz. For example, set fuzz to 10
108016     *   and the color red at intensities of 100 and 102 respectively are now
108017     *   interpreted as the same color for the purposes of the floodfill.
108018     * @param mixed $bordercolor ImagickPixel object containing the border
108019     *   color
108020     * @param int $x X start position of the floodfill
108021     * @param int $y Y start position of the floodfill
108022     * @return bool
108023     * @since PECL imagick 2.0.0
108024     **/
108025    function colorFloodfillImage($fill, $fuzz, $bordercolor, $x, $y){}
108026
108027    /**
108028     * Blends the fill color with the image
108029     *
108030     * Blends the fill color with each pixel in the image.
108031     *
108032     * @param mixed $colorize ImagickPixel object or a string containing
108033     *   the colorize color
108034     * @param mixed $opacity ImagickPixel object or an float containing the
108035     *   opacity value. 1.0 is fully opaque and 0.0 is fully transparent.
108036     * @param bool $legacy
108037     * @return bool
108038     * @since PECL imagick 2.0.0
108039     **/
108040    function colorizeImage($colorize, $opacity, $legacy){}
108041
108042    /**
108043     * Apply color transformation to an image. The method permits saturation
108044     * changes, hue rotation, luminance to alpha, and various other effects.
108045     * Although variable-sized transformation matrices can be used, typically
108046     * one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA (or RGBA
108047     * with offsets). The matrix is similar to those used by Adobe Flash
108048     * except offsets are in column 6 rather than 5 (in support of CMYKA
108049     * images) and offsets are normalized (divide Flash offset by 255)
108050     *
108051     * @param array $color_matrix
108052     * @return bool
108053     **/
108054    public function colorMatrixImage($color_matrix){}
108055
108056    /**
108057     * Combines one or more images into a single image
108058     *
108059     * Combines one or more images into a single image. The grayscale value
108060     * of the pixels of each image in the sequence is assigned in order to
108061     * the specified channels of the combined image. The typical ordering
108062     * would be image 1 => Red, 2 => Green, 3 => Blue, etc.
108063     *
108064     * @param int $channelType Provide any channel constant that is valid
108065     *   for your channel mode. To apply to more than one channel, combine
108066     *   channeltype constants using bitwise operators. Refer to this list of
108067     *   channel constants.
108068     * @return Imagick
108069     * @since PECL imagick 2.0.0
108070     **/
108071    function combineImages($channelType){}
108072
108073    /**
108074     * Adds a comment to your image
108075     *
108076     * @param string $comment The comment to add
108077     * @return bool
108078     * @since PECL imagick 2.0.0
108079     **/
108080    function commentImage($comment){}
108081
108082    /**
108083     * Returns the difference in one or more images
108084     *
108085     * Compares one or more images and returns the difference image.
108086     *
108087     * @param Imagick $image Imagick object containing the image to
108088     *   compare.
108089     * @param int $channelType Provide any channel constant that is valid
108090     *   for your channel mode. To apply to more than one channel, combine
108091     *   channeltype constants using bitwise operators. Refer to this list of
108092     *   channel constants.
108093     * @param int $metricType One of the metric type constants.
108094     * @return array Array consisting of new_wand and distortion.
108095     * @since PECL imagick 2.0.0
108096     **/
108097    function compareImageChannels($image, $channelType, $metricType){}
108098
108099    /**
108100     * Returns the maximum bounding region between images
108101     *
108102     * Compares each image with the next in a sequence and returns the
108103     * maximum bounding region of any pixel differences it discovers.
108104     *
108105     * @param int $method One of the layer method constants.
108106     * @return Imagick
108107     * @since PECL imagick 2.0.0
108108     **/
108109    function compareImageLayers($method){}
108110
108111    /**
108112     * Compares an image to a reconstructed image
108113     *
108114     * Returns an array containing a reconstructed image and the difference
108115     * between images.
108116     *
108117     * @param Imagick $compare An image to compare to.
108118     * @param int $metric Provide a valid metric type constant. Refer to
108119     *   this list of metric constants.
108120     * @return array Returns an array containing a reconstructed image and
108121     *   the difference between images.
108122     * @since PECL imagick 2.0.0
108123     **/
108124    function compareImages($compare, $metric){}
108125
108126    /**
108127     * Composite one image onto another
108128     *
108129     * Composite one image onto another at the specified offset. Any extra
108130     * arguments needed for the compose algorithm should passed to
108131     * setImageArtifact with 'compose:args' as the first parameter and the
108132     * data as the second parameter.
108133     *
108134     * @param Imagick $composite_object Imagick object which holds the
108135     *   composite image
108136     * @param int $composite Composite operator. See Composite Operator
108137     *   Constants
108138     * @param int $x The column offset of the composited image
108139     * @param int $y The row offset of the composited image
108140     * @param int $channel Provide any channel constant that is valid for
108141     *   your channel mode. To apply to more than one channel, combine
108142     *   channeltype constants using bitwise operators. Refer to this list of
108143     *   channel constants.
108144     * @return bool
108145     * @since PECL imagick 2.0.0
108146     **/
108147    function compositeImage($composite_object, $composite, $x, $y, $channel){}
108148
108149    /**
108150     * Change the contrast of the image
108151     *
108152     * Enhances the intensity differences between the lighter and darker
108153     * elements of the image. Set sharpen to a value other than 0 to increase
108154     * the image contrast otherwise the contrast is reduced.
108155     *
108156     * @param bool $sharpen The sharpen value
108157     * @return bool
108158     * @since PECL imagick 2.0.0
108159     **/
108160    function contrastImage($sharpen){}
108161
108162    /**
108163     * Enhances the contrast of a color image
108164     *
108165     * Enhances the contrast of a color image by adjusting the pixels color
108166     * to span the entire range of colors available.
108167     *
108168     * @param float $black_point The black point.
108169     * @param float $white_point The white point.
108170     * @param int $channel Provide any channel constant that is valid for
108171     *   your channel mode. To apply to more than one channel, combine
108172     *   channeltype constants using bitwise operators. Imagick::CHANNEL_ALL.
108173     *   Refer to this list of channel constants.
108174     * @return bool
108175     * @since PECL imagick 2.0.0
108176     **/
108177    function contrastStretchImage($black_point, $white_point, $channel){}
108178
108179    /**
108180     * Applies a custom convolution kernel to the image
108181     *
108182     * @param array $kernel The convolution kernel
108183     * @param int $channel Provide any channel constant that is valid for
108184     *   your channel mode. To apply to more than one channel, combine
108185     *   channeltype constants using bitwise operators. Refer to this list of
108186     *   channel constants.
108187     * @return bool
108188     * @since PECL imagick 2.0.0
108189     **/
108190    function convolveImage($kernel, $channel){}
108191
108192    /**
108193     * Get the number of images
108194     *
108195     * Returns the number of images.
108196     *
108197     * @param int $mode An unused argument. Currently there is a
108198     *   non-particularly well defined feature in PHP where calling count()
108199     *   on a countable object might (or might not) require this method to
108200     *   accept a parameter. This parameter is here to be conformant with the
108201     *   interface of countable, even though the param is not used.
108202     * @return int Returns the number of images.
108203     **/
108204    public function count($mode){}
108205
108206    /**
108207     * Extracts a region of the image
108208     *
108209     * @param int $width The width of the crop
108210     * @param int $height The height of the crop
108211     * @param int $x The X coordinate of the cropped region's top left
108212     *   corner
108213     * @param int $y The Y coordinate of the cropped region's top left
108214     *   corner
108215     * @return bool
108216     * @since PECL imagick 2.0.0
108217     **/
108218    function cropImage($width, $height, $x, $y){}
108219
108220    /**
108221     * Creates a crop thumbnail
108222     *
108223     * Creates a fixed size thumbnail by first scaling the image up or down
108224     * and cropping a specified area from the center.
108225     *
108226     * @param int $width The width of the thumbnail
108227     * @param int $height The Height of the thumbnail
108228     * @param bool $legacy
108229     * @return bool
108230     * @since PECL imagick 2.0.0
108231     **/
108232    function cropThumbnailImage($width, $height, $legacy){}
108233
108234    /**
108235     * Returns a reference to the current Imagick object
108236     *
108237     * Returns reference to the current imagick object with image pointer at
108238     * the correct sequence.
108239     *
108240     * @return Imagick Returns self on success.
108241     * @since PECL imagick 2.0.0
108242     **/
108243    function current(){}
108244
108245    /**
108246     * Displaces an image's colormap
108247     *
108248     * Displaces an image's colormap by a given number of positions. If you
108249     * cycle the colormap a number of times you can produce a psychedelic
108250     * effect.
108251     *
108252     * @param int $displace The amount to displace the colormap.
108253     * @return bool
108254     * @since PECL imagick 2.0.0
108255     **/
108256    function cycleColormapImage($displace){}
108257
108258    /**
108259     * Deciphers an image
108260     *
108261     * Deciphers image that has been enciphered before. The image must be
108262     * enciphered using {@link Imagick::encipherImage}.
108263     *
108264     * @param string $passphrase The passphrase
108265     * @return bool
108266     **/
108267    function decipherImage($passphrase){}
108268
108269    /**
108270     * Returns certain pixel differences between images
108271     *
108272     * Compares each image with the next in a sequence and returns the
108273     * maximum bounding region of any pixel differences it discovers.
108274     *
108275     * @return Imagick Returns a new Imagick object on success.
108276     * @since PECL imagick 2.0.0
108277     **/
108278    function deconstructImages(){}
108279
108280    /**
108281     * Delete image artifact
108282     *
108283     * Deletes an artifact associated with the image. The difference between
108284     * image properties and image artifacts is that properties are public and
108285     * artifacts are private.
108286     *
108287     * @param string $artifact The name of the artifact to delete
108288     * @return bool
108289     **/
108290    function deleteImageArtifact($artifact){}
108291
108292    /**
108293     * Deletes an image property.
108294     *
108295     * @param string $name The name of the property to delete.
108296     * @return bool
108297     **/
108298    public function deleteImageProperty($name){}
108299
108300    /**
108301     * Removes skew from the image
108302     *
108303     * This method can be used to remove skew from for example scanned images
108304     * where the paper was not properly placed on the scanning surface.
108305     *
108306     * @param float $threshold Deskew threshold
108307     * @return bool
108308     **/
108309    public function deskewImage($threshold){}
108310
108311    /**
108312     * Reduces the speckle noise in an image
108313     *
108314     * Reduces the speckle noise in an image while preserving the edges of
108315     * the original image.
108316     *
108317     * @return bool
108318     * @since PECL imagick 2.0.0
108319     **/
108320    function despeckleImage(){}
108321
108322    /**
108323     * Destroys the Imagick object
108324     *
108325     * Destroys the Imagick object and frees all resources associated with
108326     * it. This method is deprecated in favour of Imagick::clear.
108327     *
108328     * @return bool
108329     * @since PECL imagick 2.0.0
108330     **/
108331    function destroy(){}
108332
108333    /**
108334     * Displays an image
108335     *
108336     * This method displays an image on a X server.
108337     *
108338     * @param string $servername The X server name
108339     * @return bool
108340     * @since PECL imagick 2.0.0
108341     **/
108342    function displayImage($servername){}
108343
108344    /**
108345     * Displays an image or image sequence
108346     *
108347     * Displays an image or image sequence on a X server.
108348     *
108349     * @param string $servername The X server name
108350     * @return bool
108351     * @since PECL imagick 2.0.0
108352     **/
108353    function displayImages($servername){}
108354
108355    /**
108356     * Distorts an image using various distortion methods
108357     *
108358     * Distorts an image using various distortion methods, by mapping color
108359     * lookups of the source image to a new destination image usually of the
108360     * same size as the source image, unless 'bestfit' is set to TRUE.
108361     *
108362     * If 'bestfit' is enabled, and distortion allows it, the destination
108363     * image is adjusted to ensure the whole source 'image' will just fit
108364     * within the final destination image, which will be sized and offset
108365     * accordingly. Also in many cases the virtual offset of the source image
108366     * will be taken into account in the mapping.
108367     *
108368     * @param int $method The method of image distortion. See distortion
108369     *   constants
108370     * @param array $arguments The arguments for this distortion method
108371     * @param bool $bestfit Attempt to resize destination to fit distorted
108372     *   source
108373     * @return bool
108374     * @since PECL imagick 2.0.1
108375     **/
108376    function distortImage($method, $arguments, $bestfit){}
108377
108378    /**
108379     * Renders the ImagickDraw object on the current image
108380     *
108381     * @param ImagickDraw $draw The drawing operations to render on the
108382     *   image.
108383     * @return bool
108384     * @since PECL imagick 2.0.0
108385     **/
108386    function drawImage($draw){}
108387
108388    /**
108389     * Enhance edges within the image
108390     *
108391     * Enhance edges within the image with a convolution filter of the given
108392     * radius. Use radius 0 and it will be auto-selected.
108393     *
108394     * @param float $radius The radius of the operation.
108395     * @return bool
108396     * @since PECL imagick 2.0.0
108397     **/
108398    function edgeImage($radius){}
108399
108400    /**
108401     * Returns a grayscale image with a three-dimensional effect
108402     *
108403     * Returns a grayscale image with a three-dimensional effect. We convolve
108404     * the image with a Gaussian operator of the given radius and standard
108405     * deviation (sigma). For reasonable results, radius should be larger
108406     * than sigma. Use a radius of 0 and it will choose a suitable radius for
108407     * you.
108408     *
108409     * @param float $radius The radius of the effect
108410     * @param float $sigma The sigma of the effect
108411     * @return bool
108412     * @since PECL imagick 2.0.0
108413     **/
108414    function embossImage($radius, $sigma){}
108415
108416    /**
108417     * Enciphers an image
108418     *
108419     * Converts plain pixels to enciphered pixels. The image is not readable
108420     * until it has been deciphered using {@link Imagick::decipherImage}
108421     *
108422     * @param string $passphrase The passphrase
108423     * @return bool
108424     **/
108425    function encipherImage($passphrase){}
108426
108427    /**
108428     * Improves the quality of a noisy image
108429     *
108430     * Applies a digital filter that improves the quality of a noisy image.
108431     *
108432     * @return bool
108433     * @since PECL imagick 2.0.0
108434     **/
108435    function enhanceImage(){}
108436
108437    /**
108438     * Equalizes the image histogram
108439     *
108440     * @return bool
108441     * @since PECL imagick 2.0.0
108442     **/
108443    function equalizeImage(){}
108444
108445    /**
108446     * Applies an expression to an image
108447     *
108448     * Applys an arithmetic, relational, or logical expression to an image.
108449     * Use these operators to lighten or darken an image, to increase or
108450     * decrease contrast in an image, or to produce the "negative" of an
108451     * image.
108452     *
108453     * @param int $op The evaluation operator
108454     * @param float $constant The value of the operator
108455     * @param int $channel Provide any channel constant that is valid for
108456     *   your channel mode. To apply to more than one channel, combine
108457     *   channeltype constants using bitwise operators. Refer to this list of
108458     *   channel constants.
108459     * @return bool
108460     * @since PECL imagick 2.0.0
108461     **/
108462    function evaluateImage($op, $constant, $channel){}
108463
108464    /**
108465     * Exports raw image pixels
108466     *
108467     * Exports image pixels into an array. The map defines the ordering of
108468     * the exported pixels. The size of the returned array is width * height
108469     * * strlen(map).
108470     *
108471     * @param int $x X-coordinate of the exported area
108472     * @param int $y Y-coordinate of the exported area
108473     * @param int $width Width of the exported aread
108474     * @param int $height Height of the exported area
108475     * @param string $map Ordering of the exported pixels. For example
108476     *   "RGB". Valid characters for the map are R, G, B, A, O, C, Y, M, K, I
108477     *   and P.
108478     * @param int $STORAGE Refer to this list of pixel type constants
108479     * @return array Returns an array containing the pixels values.
108480     **/
108481    public function exportImagePixels($x, $y, $width, $height, $map, $STORAGE){}
108482
108483    /**
108484     * Set image size
108485     *
108486     * Comfortability method for setting image size. The method sets the
108487     * image size and allows setting x,y coordinates where the new area
108488     * begins.
108489     *
108490     * @param int $width The new width
108491     * @param int $height The new height
108492     * @param int $x X position for the new size
108493     * @param int $y Y position for the new size
108494     * @return bool
108495     **/
108496    function extentImage($width, $height, $x, $y){}
108497
108498    /**
108499     * Applies a custom convolution kernel to the image.
108500     *
108501     * @param ImagickKernel $ImagickKernel An instance of ImagickKernel
108502     *   that represents either a single kernel or a linked series of
108503     *   kernels.
108504     * @param int $channel
108505     * @return bool
108506     **/
108507    public function filter($ImagickKernel, $channel){}
108508
108509    /**
108510     * Merges a sequence of images
108511     *
108512     * Merges a sequence of images. This is useful for combining Photoshop
108513     * layers into a single image.
108514     *
108515     * @return Imagick
108516     * @since PECL imagick 2.0.0
108517     **/
108518    function flattenImages(){}
108519
108520    /**
108521     * Creates a vertical mirror image
108522     *
108523     * Creates a vertical mirror image by reflecting the pixels around the
108524     * central x-axis.
108525     *
108526     * @return bool
108527     * @since PECL imagick 2.0.0
108528     **/
108529    function flipImage(){}
108530
108531    /**
108532     * Changes the color value of any pixel that matches target
108533     *
108534     * Changes the color value of any pixel that matches target and is an
108535     * immediate neighbor. This method is a replacement for deprecated {@link
108536     * Imagick::paintFloodFillImage}.
108537     *
108538     * @param mixed $fill ImagickPixel object or a string containing the
108539     *   fill color
108540     * @param float $fuzz
108541     * @param mixed $target ImagickPixel object or a string containing the
108542     *   target color to paint
108543     * @param int $x X start position of the floodfill
108544     * @param int $y Y start position of the floodfill
108545     * @param bool $invert If TRUE paints any pixel that does not match the
108546     *   target color.
108547     * @param int $channel
108548     * @return bool
108549     **/
108550    function floodFillPaintImage($fill, $fuzz, $target, $x, $y, $invert, $channel){}
108551
108552    /**
108553     * Creates a vertical mirror image
108554     *
108555     * Creates a vertical mirror image by reflecting the pixels around the
108556     * central y-axis.
108557     *
108558     * @return bool
108559     * @since PECL imagick 2.0.0
108560     **/
108561    function flopImage(){}
108562
108563    /**
108564     * Implements the discrete Fourier transform (DFT) of the image either as
108565     * a magnitude / phase or real / imaginary image pair.
108566     *
108567     * @param bool $magnitude If true, return as magnitude / phase pair
108568     *   otherwise a real / imaginary image pair.
108569     * @return bool
108570     **/
108571    public function forwardFourierTransformimage($magnitude){}
108572
108573    /**
108574     * Adds a simulated three-dimensional border
108575     *
108576     * Adds a simulated three-dimensional border around the image. The width
108577     * and height specify the border width of the vertical and horizontal
108578     * sides of the frame. The inner and outer bevels indicate the width of
108579     * the inner and outer shadows of the frame.
108580     *
108581     * @param mixed $matte_color ImagickPixel object or a string
108582     *   representing the matte color
108583     * @param int $width The width of the border
108584     * @param int $height The height of the border
108585     * @param int $inner_bevel The inner bevel width
108586     * @param int $outer_bevel The outer bevel width
108587     * @return bool
108588     * @since PECL imagick 2.0.0
108589     **/
108590    function frameImage($matte_color, $width, $height, $inner_bevel, $outer_bevel){}
108591
108592    /**
108593     * Applies a function on the image
108594     *
108595     * Applies an arithmetic, relational, or logical expression to a pseudo
108596     * image.
108597     *
108598     * See also ImageMagick v6 Examples - Image Transformations — Function,
108599     * Multi-Argument Evaluate
108600     *
108601     * @param int $function Refer to this list of function constants
108602     * @param array $arguments Array of arguments to pass to this function.
108603     * @param int $channel
108604     * @return bool
108605     **/
108606    public function functionImage($function, $arguments, $channel){}
108607
108608    /**
108609     * Evaluate expression for each pixel in the image
108610     *
108611     * Evaluate expression for each pixel in the image. Consult The Fx
108612     * Special Effects Image Operator for more information.
108613     *
108614     * @param string $expression The expression.
108615     * @param int $channel Provide any channel constant that is valid for
108616     *   your channel mode. To apply to more than one channel, combine
108617     *   channeltype constants using bitwise operators. Refer to this list of
108618     *   channel constants.
108619     * @return Imagick
108620     * @since PECL imagick 2.0.0
108621     **/
108622    function fxImage($expression, $channel){}
108623
108624    /**
108625     * Gamma-corrects an image
108626     *
108627     * Gamma-corrects an image. The same image viewed on different devices
108628     * will have perceptual differences in the way the image's intensities
108629     * are represented on the screen. Specify individual gamma levels for the
108630     * red, green, and blue channels, or adjust all three with the gamma
108631     * parameter. Values typically range from 0.8 to 2.3.
108632     *
108633     * @param float $gamma The amount of gamma-correction.
108634     * @param int $channel Provide any channel constant that is valid for
108635     *   your channel mode. To apply to more than one channel, combine
108636     *   channeltype constants using bitwise operators. Refer to this list of
108637     *   channel constants.
108638     * @return bool
108639     * @since PECL imagick 2.0.0
108640     **/
108641    function gammaImage($gamma, $channel){}
108642
108643    /**
108644     * Blurs an image
108645     *
108646     * Blurs an image. We convolve the image with a Gaussian operator of the
108647     * given radius and standard deviation (sigma). For reasonable results,
108648     * the radius should be larger than sigma. Use a radius of 0 and selects
108649     * a suitable radius for you.
108650     *
108651     * @param float $radius The radius of the Gaussian, in pixels, not
108652     *   counting the center pixel.
108653     * @param float $sigma The standard deviation of the Gaussian, in
108654     *   pixels.
108655     * @param int $channel Provide any channel constant that is valid for
108656     *   your channel mode. To apply to more than one channel, combine
108657     *   channeltype constants using bitwise operators. Refer to this list of
108658     *   channel constants.
108659     * @return bool
108660     * @since PECL imagick 2.0.0
108661     **/
108662    function gaussianBlurImage($radius, $sigma, $channel){}
108663
108664    /**
108665     * Gets the colorspace
108666     *
108667     * Gets the global colorspace value.
108668     *
108669     * @return int Returns an integer which can be compared against
108670     *   COLORSPACE constants.
108671     **/
108672    function getColorspace(){}
108673
108674    /**
108675     * Gets the object compression type
108676     *
108677     * @return int Returns the compression constant
108678     * @since PECL imagick 2.0.0
108679     **/
108680    function getCompression(){}
108681
108682    /**
108683     * Gets the object compression quality
108684     *
108685     * @return int Returns integer describing the compression quality
108686     * @since PECL imagick 2.0.0
108687     **/
108688    function getCompressionQuality(){}
108689
108690    /**
108691     * Returns the ImageMagick API copyright as a string
108692     *
108693     * @return string Returns a string containing the copyright notice of
108694     *   Imagemagick and Magickwand C API.
108695     * @since PECL imagick 2.0.0
108696     **/
108697    function getCopyright(){}
108698
108699    /**
108700     * The filename associated with an image sequence
108701     *
108702     * Returns the filename associated with an image sequence.
108703     *
108704     * @return string Returns a string on success.
108705     * @since PECL imagick 2.0.0
108706     **/
108707    function getFilename(){}
108708
108709    /**
108710     * Gets font
108711     *
108712     * Returns the objects font property.
108713     *
108714     * @return string Returns the string containing the font name or FALSE
108715     *   if not font is set.
108716     * @since PECL imagick 2.1.0
108717     **/
108718    function getFont(){}
108719
108720    /**
108721     * Returns the format of the Imagick object
108722     *
108723     * @return string Returns the format of the image.
108724     * @since PECL imagick 2.0.0
108725     **/
108726    function getFormat(){}
108727
108728    /**
108729     * Gets the gravity
108730     *
108731     * Gets the global gravity property for the Imagick object.
108732     *
108733     * @return int Returns the gravity property. Refer to the list of
108734     *   gravity constants.
108735     **/
108736    function getGravity(){}
108737
108738    /**
108739     * Returns the ImageMagick home URL
108740     *
108741     * @return string Returns a link to the imagemagick homepage.
108742     * @since PECL imagick 2.0.0
108743     **/
108744    function getHomeURL(){}
108745
108746    /**
108747     * Returns a new Imagick object
108748     *
108749     * Returns a new Imagick object with the current image sequence.
108750     *
108751     * @return Imagick Returns a new Imagick object with the current image
108752     *   sequence.
108753     * @since PECL imagick 2.0.0
108754     **/
108755    function getImage(){}
108756
108757    /**
108758     * Gets the image alpha channel
108759     *
108760     * Gets the image alpha channel value. The returned value is one of the
108761     * alpha channel constants.
108762     *
108763     * @return int Returns a constant defining the current alpha channel
108764     *   value. Refer to this list of alpha channel constants.
108765     **/
108766    function getImageAlphaChannel(){}
108767
108768    /**
108769     * Get image artifact
108770     *
108771     * Gets an artifact associated with the image. The difference between
108772     * image properties and image artifacts is that properties are public and
108773     * artifacts are private.
108774     *
108775     * @param string $artifact The name of the artifact
108776     * @return string Returns the artifact value on success.
108777     **/
108778    function getImageArtifact($artifact){}
108779
108780    /**
108781     * Returns a named attribute.
108782     *
108783     * @param string $key The key of the attribute to get.
108784     * @return string
108785     **/
108786    public function getImageAttribute($key){}
108787
108788    /**
108789     * Returns the image background color
108790     *
108791     * @return ImagickPixel Returns an ImagickPixel set to the background
108792     *   color of the image.
108793     * @since PECL imagick 2.0.0
108794     **/
108795    function getImageBackgroundColor(){}
108796
108797    /**
108798     * Returns the image sequence as a blob
108799     *
108800     * Implements direct to memory image formats. It returns the image
108801     * sequence as a string. The format of the image determines the format of
108802     * the returned blob (GIF, JPEG, PNG, etc.). To return a different image
108803     * format, use Imagick::setImageFormat().
108804     *
108805     * @return string Returns a string containing the image.
108806     * @since PECL imagick 2.0.0
108807     **/
108808    function getImageBlob(){}
108809
108810    /**
108811     * Returns the chromaticy blue primary point
108812     *
108813     * Returns the chromaticity blue primary point for the image.
108814     *
108815     * @return array Array consisting of "x" and "y" coordinates of point.
108816     * @since PECL imagick 2.0.0
108817     **/
108818    function getImageBluePrimary(){}
108819
108820    /**
108821     * Returns the image border color
108822     *
108823     * @return ImagickPixel
108824     * @since PECL imagick 2.0.0
108825     **/
108826    function getImageBorderColor(){}
108827
108828    /**
108829     * Gets the depth for a particular image channel
108830     *
108831     * @param int $channel
108832     * @return int
108833     * @since PECL imagick 2.0.0
108834     **/
108835    function getImageChannelDepth($channel){}
108836
108837    /**
108838     * Compares image channels of an image to a reconstructed image
108839     *
108840     * Compares one or more image channels of an image to a reconstructed
108841     * image and returns the specified distortion metric.
108842     *
108843     * @param Imagick $reference Imagick object to compare to.
108844     * @param int $channel Provide any channel constant that is valid for
108845     *   your channel mode. To apply to more than one channel, combine
108846     *   channeltype constants using bitwise operators. Refer to this list of
108847     *   channel constants.
108848     * @param int $metric One of the metric type constants.
108849     * @return float
108850     * @since PECL imagick 2.0.0
108851     **/
108852    function getImageChannelDistortion($reference, $channel, $metric){}
108853
108854    /**
108855     * Gets channel distortions
108856     *
108857     * Compares one or more image channels of an image to a reconstructed
108858     * image and returns the specified distortion metrics
108859     *
108860     * @param Imagick $reference Imagick object containing the reference
108861     *   image
108862     * @param int $metric Refer to this list of metric type constants.
108863     * @param int $channel
108864     * @return float Returns a double describing the channel distortion.
108865     **/
108866    function getImageChannelDistortions($reference, $metric, $channel){}
108867
108868    /**
108869     * Gets the extrema for one or more image channels
108870     *
108871     * Gets the extrema for one or more image channels. Return value is an
108872     * associative array with the keys "minima" and "maxima".
108873     *
108874     * @param int $channel Provide any channel constant that is valid for
108875     *   your channel mode. To apply to more than one channel, combine
108876     *   channeltype constants using bitwise operators. Refer to this list of
108877     *   channel constants.
108878     * @return array
108879     * @since PECL imagick 2.0.0
108880     **/
108881    function getImageChannelExtrema($channel){}
108882
108883    /**
108884     * The getImageChannelKurtosis purpose
108885     *
108886     * Get the kurtosis and skewness of a specific channel.
108887     *
108888     * @param int $channel
108889     * @return array Returns an array with kurtosis and skewness members.
108890     **/
108891    public function getImageChannelKurtosis($channel){}
108892
108893    /**
108894     * Gets the mean and standard deviation
108895     *
108896     * Gets the mean and standard deviation of one or more image channels.
108897     * Return value is an associative array with the keys "mean" and
108898     * "standardDeviation".
108899     *
108900     * @param int $channel Provide any channel constant that is valid for
108901     *   your channel mode. To apply to more than one channel, combine
108902     *   channeltype constants using bitwise operators. Refer to this list of
108903     *   channel constants.
108904     * @return array
108905     * @since PECL imagick 2.0.0
108906     **/
108907    function getImageChannelMean($channel){}
108908
108909    /**
108910     * Gets channel range
108911     *
108912     * Gets the range for one or more image channels.
108913     *
108914     * @param int $channel
108915     * @return array Returns an array containing minima and maxima values
108916     *   of the channel(s).
108917     * @since PECL imagick 2.2.1
108918     **/
108919    function getImageChannelRange($channel){}
108920
108921    /**
108922     * Returns statistics for each channel in the image
108923     *
108924     * Returns statistics for each channel in the image. The statistics
108925     * include the channel depth, its minima and maxima, the mean, and the
108926     * standard deviation. You can access the red channel mean, for example,
108927     * like this:
108928     *
108929     * @return array
108930     * @since PECL imagick 2.0.0
108931     **/
108932    function getImageChannelStatistics(){}
108933
108934    /**
108935     * Gets image clip mask
108936     *
108937     * Returns the image clip mask. The clip mask is an Imagick object
108938     * containing the clip mask.
108939     *
108940     * @return Imagick Returns an Imagick object containing the clip mask.
108941     **/
108942    function getImageClipMask(){}
108943
108944    /**
108945     * Returns the color of the specified colormap index
108946     *
108947     * @param int $index The offset into the image colormap.
108948     * @return ImagickPixel
108949     * @since PECL imagick 2.0.0
108950     **/
108951    function getImageColormapColor($index){}
108952
108953    /**
108954     * Gets the number of unique colors in the image
108955     *
108956     * @return int Returns an integer, the number of unique colors in the
108957     *   image.
108958     * @since PECL imagick 2.0.0
108959     **/
108960    function getImageColors(){}
108961
108962    /**
108963     * Gets the image colorspace
108964     *
108965     * @return int Returns an integer which can be compared against
108966     *   COLORSPACE constants.
108967     * @since PECL imagick 2.0.0
108968     **/
108969    function getImageColorspace(){}
108970
108971    /**
108972     * Returns the composite operator associated with the image
108973     *
108974     * @return int
108975     * @since PECL imagick 2.0.0
108976     **/
108977    function getImageCompose(){}
108978
108979    /**
108980     * Gets the current image's compression type
108981     *
108982     * @return int Returns the compression constant
108983     * @since PECL imagick 2.2.2
108984     **/
108985    function getImageCompression(){}
108986
108987    /**
108988     * Gets the current image's compression quality
108989     *
108990     * @return int Returns integer describing the images compression
108991     *   quality
108992     * @since PECL imagick 2.2.2
108993     **/
108994    function getImageCompressionQuality(){}
108995
108996    /**
108997     * Gets the image delay
108998     *
108999     * @return int Returns the image delay.
109000     * @since PECL imagick 2.0.0
109001     **/
109002    function getImageDelay(){}
109003
109004    /**
109005     * Gets the image depth
109006     *
109007     * @return int The image depth.
109008     **/
109009    function getImageDepth(){}
109010
109011    /**
109012     * Gets the image disposal method
109013     *
109014     * @return int Returns the dispose method on success.
109015     * @since PECL imagick 2.0.0
109016     **/
109017    function getImageDispose(){}
109018
109019    /**
109020     * Compares an image to a reconstructed image
109021     *
109022     * Compares an image to a reconstructed image and returns the specified
109023     * distortion metric.
109024     *
109025     * @param MagickWand $reference Imagick object to compare to.
109026     * @param int $metric One of the metric type constants.
109027     * @return float Returns the distortion metric used on the image (or
109028     *   the best guess thereof).
109029     * @since PECL imagick 2.0.0
109030     **/
109031    function getImageDistortion($reference, $metric){}
109032
109033    /**
109034     * Gets the extrema for the image
109035     *
109036     * Gets the extrema for the image. Returns an associative array with the
109037     * keys "min" and "max".
109038     *
109039     * @return array Returns an associative array with the keys "min" and
109040     *   "max".
109041     * @since PECL imagick 2.0.0
109042     **/
109043    function getImageExtrema(){}
109044
109045    /**
109046     * Returns the filename of a particular image in a sequence
109047     *
109048     * @return string Returns a string with the filename of the image.
109049     * @since PECL imagick 2.0.0
109050     **/
109051    function getImageFilename(){}
109052
109053    /**
109054     * Returns the format of a particular image in a sequence
109055     *
109056     * @return string Returns a string containing the image format on
109057     *   success.
109058     * @since PECL imagick 2.0.0
109059     **/
109060    function getImageFormat(){}
109061
109062    /**
109063     * Gets the image gamma
109064     *
109065     * @return float Returns the image gamma on success.
109066     * @since PECL imagick 2.0.0
109067     **/
109068    function getImageGamma(){}
109069
109070    /**
109071     * Gets the width and height as an associative array
109072     *
109073     * Returns the width and height as an associative array.
109074     *
109075     * @return array Returns an array with the width/height of the image.
109076     * @since PECL imagick 2.0.0
109077     **/
109078    function getImageGeometry(){}
109079
109080    /**
109081     * Gets the image gravity
109082     *
109083     * Gets the current gravity value of the image. Unlike {@link
109084     * Imagick::getGravity}, this method returns the gravity defined for the
109085     * current image sequence.
109086     *
109087     * @return int Returns the images gravity property. Refer to the list
109088     *   of gravity constants.
109089     **/
109090    function getImageGravity(){}
109091
109092    /**
109093     * Returns the chromaticy green primary point
109094     *
109095     * Returns the chromaticity green primary point. Returns an array with
109096     * the keys "x" and "y".
109097     *
109098     * @return array Returns an array with the keys "x" and "y" on success,
109099     *   throws an ImagickException on failure.
109100     * @since PECL imagick 2.0.0
109101     **/
109102    function getImageGreenPrimary(){}
109103
109104    /**
109105     * Returns the image height
109106     *
109107     * @return int Returns the image height in pixels.
109108     * @since PECL imagick 2.0.0
109109     **/
109110    function getImageHeight(){}
109111
109112    /**
109113     * Gets the image histogram
109114     *
109115     * Returns the image histogram as an array of ImagickPixel objects.
109116     *
109117     * @return array Returns the image histogram as an array of
109118     *   ImagickPixel objects.
109119     * @since PECL imagick 2.0.0
109120     **/
109121    function getImageHistogram(){}
109122
109123    /**
109124     * Gets the index of the current active image
109125     *
109126     * Returns the index of the current active image within the Imagick
109127     * object. This method has been deprecated. See {@link
109128     * Imagick::getIteratorIndex}.
109129     *
109130     * @return int Returns an integer containing the index of the image in
109131     *   the stack.
109132     * @since PECL imagick 2.0.0
109133     **/
109134    function getImageIndex(){}
109135
109136    /**
109137     * Gets the image interlace scheme
109138     *
109139     * @return int Returns the interlace scheme as an integer on success.
109140     * @since PECL imagick 2.0.0
109141     **/
109142    function getImageInterlaceScheme(){}
109143
109144    /**
109145     * Returns the interpolation method
109146     *
109147     * Returns the interpolation method for the specified image. The method
109148     * is one of the Imagick::INTERPOLATE_* constants.
109149     *
109150     * @return int Returns the interpolate method on success.
109151     * @since PECL imagick 2.0.0
109152     **/
109153    function getImageInterpolateMethod(){}
109154
109155    /**
109156     * Gets the image iterations
109157     *
109158     * @return int Returns the image iterations as an integer.
109159     * @since PECL imagick 2.0.0
109160     **/
109161    function getImageIterations(){}
109162
109163    /**
109164     * Returns the image length in bytes
109165     *
109166     * @return int Returns an int containing the current image size.
109167     * @since PECL imagick 2.0.0
109168     **/
109169    function getImageLength(){}
109170
109171    /**
109172     * Returns a string containing the ImageMagick license
109173     *
109174     * @return string Returns a string containing the ImageMagick license.
109175     * @since PECL imagick 2.0.0
109176     **/
109177    function getImageMagickLicense(){}
109178
109179    /**
109180     * Return if the image has a matte channel
109181     *
109182     * Returns TRUE if the image has a matte channel otherwise false.
109183     *
109184     * @return bool
109185     * @since PECL imagick 2.0.0
109186     **/
109187    function getImageMatte(){}
109188
109189    /**
109190     * Returns the image matte color
109191     *
109192     * @return ImagickPixel Returns ImagickPixel object on success.
109193     * @since PECL imagick 2.0.0
109194     **/
109195    function getImageMatteColor(){}
109196
109197    /**
109198     * Returns the image mime-type.
109199     *
109200     * @return string
109201     **/
109202    public function getImageMimeType(){}
109203
109204    /**
109205     * Gets the image orientation
109206     *
109207     * Gets the image orientation. The return value is one of the orientation
109208     * constants.
109209     *
109210     * @return int Returns an int on success.
109211     * @since PECL imagick 2.0.0
109212     **/
109213    function getImageOrientation(){}
109214
109215    /**
109216     * Returns the page geometry
109217     *
109218     * Returns the page geometry associated with the image in an array with
109219     * the keys "width", "height", "x", and "y".
109220     *
109221     * @return array Returns the page geometry associated with the image in
109222     *   an array with the keys "width", "height", "x", and "y".
109223     * @since PECL imagick 2.0.0
109224     **/
109225    function getImagePage(){}
109226
109227    /**
109228     * Returns the color of the specified pixel
109229     *
109230     * @param int $x The x-coordinate of the pixel
109231     * @param int $y The y-coordinate of the pixel
109232     * @return ImagickPixel Returns an ImagickPixel instance for the color
109233     *   at the coordinates given.
109234     * @since PECL imagick 2.0.0
109235     **/
109236    function getImagePixelColor($x, $y){}
109237
109238    /**
109239     * Returns the named image profile
109240     *
109241     * @param string $name The name of the profile to return.
109242     * @return string Returns a string containing the image profile.
109243     * @since PECL imagick 2.0.0
109244     **/
109245    function getImageProfile($name){}
109246
109247    /**
109248     * Returns the image profiles
109249     *
109250     * Returns all associated profiles that match the pattern. If FALSE is
109251     * passed as second parameter only the profile names are returned.
109252     *
109253     * @param string $pattern The pattern for profile names.
109254     * @param bool $include_values Whether to return only profile names. If
109255     *   FALSE then only profile names will be returned.
109256     * @return array Returns an array containing the image profiles or
109257     *   profile names.
109258     * @since PECL imagick 2.0.0
109259     **/
109260    function getImageProfiles($pattern, $include_values){}
109261
109262    /**
109263     * Returns the image properties
109264     *
109265     * Returns all associated properties that match the pattern. If FALSE is
109266     * passed as second parameter only the property names are returned.
109267     *
109268     * @param string $pattern The pattern for property names.
109269     * @param bool $include_values Whether to return only property names.
109270     *   If FALSE then only property names will be returned.
109271     * @return array Returns an array containing the image properties or
109272     *   property names.
109273     * @since PECL imagick 2.0.0
109274     **/
109275    function getImageProperties($pattern, $include_values){}
109276
109277    /**
109278     * Returns the named image property
109279     *
109280     * @param string $name name of the property (for example Exif:DateTime)
109281     * @return string Returns a string containing the image property, false
109282     *   if a property with the given name does not exist.
109283     * @since PECL imagick 2.0.0
109284     **/
109285    function getImageProperty($name){}
109286
109287    /**
109288     * Returns the chromaticity red primary point
109289     *
109290     * Returns the chromaticity red primary point as an array with the keys
109291     * "x" and "y".
109292     *
109293     * @return array Returns the chromaticity red primary point as an array
109294     *   with the keys "x" and "y".
109295     * @since PECL imagick 2.0.0
109296     **/
109297    function getImageRedPrimary(){}
109298
109299    /**
109300     * Extracts a region of the image
109301     *
109302     * Extracts a region of the image and returns it as a new Imagick object.
109303     *
109304     * @param int $width The width of the extracted region.
109305     * @param int $height The height of the extracted region.
109306     * @param int $x X-coordinate of the top-left corner of the extracted
109307     *   region.
109308     * @param int $y Y-coordinate of the top-left corner of the extracted
109309     *   region.
109310     * @return Imagick Extracts a region of the image and returns it as a
109311     *   new wand.
109312     * @since PECL imagick 2.0.0
109313     **/
109314    function getImageRegion($width, $height, $x, $y){}
109315
109316    /**
109317     * Gets the image rendering intent
109318     *
109319     * @return int Returns the image rendering intent.
109320     * @since PECL imagick 2.0.0
109321     **/
109322    function getImageRenderingIntent(){}
109323
109324    /**
109325     * Gets the image X and Y resolution
109326     *
109327     * @return array Returns the resolution as an array.
109328     * @since PECL imagick 2.0.0
109329     **/
109330    function getImageResolution(){}
109331
109332    /**
109333     * Returns all image sequences as a blob
109334     *
109335     * Implements direct to memory image formats. It returns all image
109336     * sequences as a string. The format of the image determines the format
109337     * of the returned blob (GIF, JPEG, PNG, etc.). To return a different
109338     * image format, use Imagick::setImageFormat().
109339     *
109340     * @return string Returns a string containing the images. On failure,
109341     *   throws ImagickException.
109342     * @since PECL imagick 2.0.0
109343     **/
109344    function getImagesBlob(){}
109345
109346    /**
109347     * Gets the image scene
109348     *
109349     * @return int Returns the image scene.
109350     * @since PECL imagick 2.0.0
109351     **/
109352    function getImageScene(){}
109353
109354    /**
109355     * Generates an SHA-256 message digest
109356     *
109357     * Generates an SHA-256 message digest for the image pixel stream.
109358     *
109359     * @return string Returns a string containing the SHA-256 hash of the
109360     *   file.
109361     * @since PECL imagick 2.0.0
109362     **/
109363    function getImageSignature(){}
109364
109365    /**
109366     * Returns the image length in bytes
109367     *
109368     * Returns the image length in bytes. Deprecated in favour of
109369     * Imagick::getImageLength()
109370     *
109371     * @return int Returns an int containing the current image size.
109372     * @since PECL imagick 2.0.0
109373     **/
109374    function getImageSize(){}
109375
109376    /**
109377     * Gets the image ticks-per-second
109378     *
109379     * @return int Returns the image ticks-per-second.
109380     * @since PECL imagick 2.0.0
109381     **/
109382    function getImageTicksPerSecond(){}
109383
109384    /**
109385     * Gets the image total ink density
109386     *
109387     * @return float Returns the image total ink density of the image.
109388     * @since PECL imagick 2.0.0
109389     **/
109390    function getImageTotalInkDensity(){}
109391
109392    /**
109393     * Gets the potential image type
109394     *
109395     * @return int Returns the potential image type.
109396     *   imagick::IMGTYPE_UNDEFINED imagick::IMGTYPE_BILEVEL
109397     *   imagick::IMGTYPE_GRAYSCALE imagick::IMGTYPE_GRAYSCALEMATTE
109398     *   imagick::IMGTYPE_PALETTE imagick::IMGTYPE_PALETTEMATTE
109399     *   imagick::IMGTYPE_TRUECOLOR imagick::IMGTYPE_TRUECOLORMATTE
109400     *   imagick::IMGTYPE_COLORSEPARATION
109401     *   imagick::IMGTYPE_COLORSEPARATIONMATTE imagick::IMGTYPE_OPTIMIZE
109402     **/
109403    function getImageType(){}
109404
109405    /**
109406     * Gets the image units of resolution
109407     *
109408     * @return int Returns the image units of resolution.
109409     * @since PECL imagick 2.0.0
109410     **/
109411    function getImageUnits(){}
109412
109413    /**
109414     * Returns the virtual pixel method
109415     *
109416     * Returns the virtual pixel method for the specified image.
109417     *
109418     * @return int Returns the virtual pixel method on success.
109419     * @since PECL imagick 2.0.0
109420     **/
109421    function getImageVirtualPixelMethod(){}
109422
109423    /**
109424     * Returns the chromaticity white point
109425     *
109426     * Returns the chromaticity white point as an associative array with the
109427     * keys "x" and "y".
109428     *
109429     * @return array Returns the chromaticity white point as an associative
109430     *   array with the keys "x" and "y".
109431     * @since PECL imagick 2.0.0
109432     **/
109433    function getImageWhitePoint(){}
109434
109435    /**
109436     * Returns the image width
109437     *
109438     * @return int Returns the image width.
109439     * @since PECL imagick 2.0.0
109440     **/
109441    function getImageWidth(){}
109442
109443    /**
109444     * Gets the object interlace scheme
109445     *
109446     * @return int Gets the wand interlace scheme.
109447     * @since PECL imagick 2.0.0
109448     **/
109449    function getInterlaceScheme(){}
109450
109451    /**
109452     * Gets the index of the current active image
109453     *
109454     * Returns the index of the current active image within the Imagick
109455     * object.
109456     *
109457     * @return int Returns an integer containing the index of the image in
109458     *   the stack.
109459     * @since PECL imagick 2.0.0
109460     **/
109461    function getIteratorIndex(){}
109462
109463    /**
109464     * Returns the number of images in the object
109465     *
109466     * Returns the number of images associated with Imagick object.
109467     *
109468     * @return int Returns the number of images associated with Imagick
109469     *   object.
109470     * @since PECL imagick 2.0.0
109471     **/
109472    function getNumberImages(){}
109473
109474    /**
109475     * Returns a value associated with the specified key
109476     *
109477     * Returns a value associated within the object for the specified key.
109478     *
109479     * @param string $key The name of the option
109480     * @return string Returns a value associated with a wand and the
109481     *   specified key.
109482     * @since PECL imagick 2.0.0
109483     **/
109484    function getOption($key){}
109485
109486    /**
109487     * Returns the ImageMagick package name
109488     *
109489     * @return string Returns the ImageMagick package name as a string.
109490     * @since PECL imagick 2.0.0
109491     **/
109492    function getPackageName(){}
109493
109494    /**
109495     * Returns the page geometry
109496     *
109497     * Returns the page geometry associated with the Imagick object in an
109498     * associative array with the keys "width", "height", "x", and "y".
109499     *
109500     * @return array Returns the page geometry associated with the Imagick
109501     *   object in an associative array with the keys "width", "height", "x",
109502     *   and "y", throwing ImagickException on error.
109503     * @since PECL imagick 2.0.0
109504     **/
109505    function getPage(){}
109506
109507    /**
109508     * Returns a MagickPixelIterator
109509     *
109510     * @return ImagickPixelIterator Returns an ImagickPixelIterator on
109511     *   success.
109512     * @since PECL imagick 2.0.0
109513     **/
109514    function getPixelIterator(){}
109515
109516    /**
109517     * Get an ImagickPixelIterator for an image section
109518     *
109519     * @param int $x The x-coordinate of the region.
109520     * @param int $y The y-coordinate of the region.
109521     * @param int $columns The width of the region.
109522     * @param int $rows The height of the region.
109523     * @return ImagickPixelIterator Returns an ImagickPixelIterator for an
109524     *   image section.
109525     * @since PECL imagick 2.0.0
109526     **/
109527    function getPixelRegionIterator($x, $y, $columns, $rows){}
109528
109529    /**
109530     * Gets point size
109531     *
109532     * Returns the objects point size property.
109533     *
109534     * @return float Returns a containing the point size.
109535     **/
109536    function getPointSize(){}
109537
109538    /**
109539     * Returns the ImageMagick quantum range as an integer.
109540     *
109541     * @return int
109542     **/
109543    public static function getQuantum(){}
109544
109545    /**
109546     * Gets the quantum depth
109547     *
109548     * Returns the Imagick quantum depth as a string.
109549     *
109550     * @return array Returns the Imagick quantum depth as a string.
109551     * @since PECL imagick 2.0.0
109552     **/
109553    function getQuantumDepth(){}
109554
109555    /**
109556     * Returns the Imagick quantum range
109557     *
109558     * Returns the quantum range for the Imagick instance.
109559     *
109560     * @return array Returns an associative array containing the quantum
109561     *   range as an integer ("quantumRangeLong") and as a string
109562     *   ("quantumRangeString").
109563     * @since PECL imagick 2.0.0
109564     **/
109565    function getQuantumRange(){}
109566
109567    /**
109568     * Get the StringRegistry entry for the named key or false if not set.
109569     *
109570     * @param string $key The entry to get.
109571     * @return string
109572     **/
109573    public static function getRegistry($key){}
109574
109575    /**
109576     * Returns the ImageMagick release date
109577     *
109578     * Returns the ImageMagick release date as a string.
109579     *
109580     * @return string Returns the ImageMagick release date as a string.
109581     * @since PECL imagick 2.0.0
109582     **/
109583    function getReleaseDate(){}
109584
109585    /**
109586     * Returns the specified resource's memory usage
109587     *
109588     * Returns the specified resource's memory usage in megabytes.
109589     *
109590     * @param int $type Refer to the list of resourcetype constants.
109591     * @return int Returns the specified resource's memory usage in
109592     *   megabytes.
109593     * @since PECL imagick 2.0.0
109594     **/
109595    function getResource($type){}
109596
109597    /**
109598     * Returns the specified resource limit
109599     *
109600     * @param int $type One of the resourcetype constants. The unit depends
109601     *   on the type of the resource being limited.
109602     * @return int Returns the specified resource limit in megabytes.
109603     * @since PECL imagick 2.0.0
109604     **/
109605    function getResourceLimit($type){}
109606
109607    /**
109608     * Gets the horizontal and vertical sampling factor
109609     *
109610     * @return array Returns an associative array with the horizontal and
109611     *   vertical sampling factors of the image.
109612     * @since PECL imagick 2.0.0
109613     **/
109614    function getSamplingFactors(){}
109615
109616    /**
109617     * Returns the size associated with the Imagick object
109618     *
109619     * Get the size in pixels associated with the Imagick object, previously
109620     * set by {@link Imagick::setSize}.
109621     *
109622     * @return array Returns the size associated with the Imagick object as
109623     *   an array with the keys "columns" and "rows".
109624     * @since PECL imagick 2.0.0
109625     **/
109626    function getSize(){}
109627
109628    /**
109629     * Returns the size offset
109630     *
109631     * Returns the size offset associated with the Imagick object.
109632     *
109633     * @return int Returns the size offset associated with the Imagick
109634     *   object.
109635     * @since PECL imagick 2.0.0
109636     **/
109637    function getSizeOffset(){}
109638
109639    /**
109640     * Returns the ImageMagick API version
109641     *
109642     * Returns the ImageMagick API version as a string and as a number.
109643     *
109644     * @return array Returns the ImageMagick API version as a string and as
109645     *   a number.
109646     * @since PECL imagick 2.0.0
109647     **/
109648    function getVersion(){}
109649
109650    /**
109651     * Replaces colors in the image
109652     *
109653     * Replaces colors in the image using a Hald lookup table. Hald images
109654     * can be created using HALD color coder.
109655     *
109656     * @param Imagick $clut Imagick object containing the Hald lookup
109657     *   image.
109658     * @param int $channel
109659     * @return bool
109660     **/
109661    public function haldClutImage($clut, $channel){}
109662
109663    /**
109664     * Checks if the object has more images
109665     *
109666     * Returns TRUE if the object has more images when traversing the list in
109667     * the forward direction.
109668     *
109669     * @return bool Returns TRUE if the object has more images when
109670     *   traversing the list in the forward direction, returns FALSE if there
109671     *   are none.
109672     * @since PECL imagick 2.0.0
109673     **/
109674    function hasNextImage(){}
109675
109676    /**
109677     * Checks if the object has a previous image
109678     *
109679     * Returns TRUE if the object has more images when traversing the list in
109680     * the reverse direction
109681     *
109682     * @return bool Returns TRUE if the object has more images when
109683     *   traversing the list in the reverse direction, returns FALSE if there
109684     *   are none.
109685     * @since PECL imagick 2.0.0
109686     **/
109687    function hasPreviousImage(){}
109688
109689    /**
109690     * Replaces any embedded formatting characters with the appropriate image
109691     * property and returns the interpreted text. See
109692     * http://www.imagemagick.org/script/escape.php for escape sequences.
109693     *
109694     * @param string $embedText A string containing formatting sequences
109695     *   e.g. "Trim box: %@ number of unique colors: %k".
109696     * @return string Returns format.
109697     **/
109698    public function identifyFormat($embedText){}
109699
109700    /**
109701     * Identifies an image and fetches attributes
109702     *
109703     * Identifies an image and returns the attributes. Attributes include the
109704     * image width, height, size, and others.
109705     *
109706     * @param bool $appendRawOutput If TRUE then the raw output is appended
109707     *   to the array.
109708     * @return array Identifies an image and returns the attributes.
109709     *   Attributes include the image width, height, size, and others.
109710     * @since PECL imagick 2.0.0
109711     **/
109712    function identifyImage($appendRawOutput){}
109713
109714    /**
109715     * Creates a new image as a copy
109716     *
109717     * Creates a new image that is a copy of an existing one with the image
109718     * pixels "imploded" by the specified percentage.
109719     *
109720     * @param float $radius The radius of the implode
109721     * @return bool
109722     * @since PECL imagick 2.0.0
109723     **/
109724    function implodeImage($radius){}
109725
109726    /**
109727     * Imports image pixels
109728     *
109729     * Imports pixels from an array into an image. The {@link map} is usually
109730     * 'RGB'. This method imposes the following constraints for the
109731     * parameters: amount of pixels in the array must match {@link width} x
109732     * {@link height} x length of the map.
109733     *
109734     * @param int $x The image x position
109735     * @param int $y The image y position
109736     * @param int $width The image width
109737     * @param int $height The image height
109738     * @param string $map Map of pixel ordering as a string. This can be
109739     *   for example RGB. The value can be any combination or order of R =
109740     *   red, G = green, B = blue, A = alpha (0 is transparent), O = opacity
109741     *   (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I =
109742     *   intensity (for grayscale), P = pad.
109743     * @param int $storage The pixel storage method. Refer to this list of
109744     *   pixel constants.
109745     * @param array $pixels The array of pixels
109746     * @return bool
109747     **/
109748    public function importImagePixels($x, $y, $width, $height, $map, $storage, $pixels){}
109749
109750    /**
109751     * Implements the inverse discrete Fourier transform (DFT) of the image
109752     * either as a magnitude / phase or real / imaginary image pair.
109753     *
109754     * @param Imagick $complement The second image to combine with this one
109755     *   to form either the magnitude / phase or real / imaginary image pair.
109756     * @param bool $magnitude If true, combine as magnitude / phase pair
109757     *   otherwise a real / imaginary image pair.
109758     * @return bool
109759     **/
109760    public function inverseFourierTransformImage($complement, $magnitude){}
109761
109762    /**
109763     * Adds a label to an image
109764     *
109765     * @param string $label The label to add
109766     * @return bool
109767     * @since PECL imagick 2.0.0
109768     **/
109769    function labelImage($label){}
109770
109771    /**
109772     * Adjusts the levels of an image
109773     *
109774     * Adjusts the levels of an image by scaling the colors falling between
109775     * specified white and black points to the full available quantum range.
109776     * The parameters provided represent the black, mid, and white points.
109777     * The black point specifies the darkest color in the image. Colors
109778     * darker than the black point are set to zero. Mid point specifies a
109779     * gamma correction to apply to the image. White point specifies the
109780     * lightest color in the image. Colors brighter than the white point are
109781     * set to the maximum quantum value.
109782     *
109783     * @param float $blackPoint The image black point
109784     * @param float $gamma The gamma value
109785     * @param float $whitePoint The image white point
109786     * @param int $channel Provide any channel constant that is valid for
109787     *   your channel mode. To apply to more than one channel, combine
109788     *   channeltype constants using bitwise operators. Refer to this list of
109789     *   channel constants.
109790     * @return bool
109791     * @since PECL imagick 2.0.0
109792     **/
109793    function levelImage($blackPoint, $gamma, $whitePoint, $channel){}
109794
109795    /**
109796     * Stretches with saturation the image intensity
109797     *
109798     * @param float $blackPoint The image black point
109799     * @param float $whitePoint The image white point
109800     * @return bool
109801     * @since PECL imagick 2.0.0
109802     **/
109803    function linearStretchImage($blackPoint, $whitePoint){}
109804
109805    /**
109806     * Animates an image or images
109807     *
109808     * This method scales the images using liquid rescaling method. This
109809     * method is an implementation of a technique called seam carving. In
109810     * order for this method to work as expected ImageMagick must be compiled
109811     * with liblqr support.
109812     *
109813     * @param int $width The width of the target size
109814     * @param int $height The height of the target size
109815     * @param float $delta_x How much the seam can traverse on x-axis.
109816     *   Passing 0 causes the seams to be straight.
109817     * @param float $rigidity Introduces a bias for non-straight seams.
109818     *   This parameter is typically 0.
109819     * @return bool
109820     **/
109821    function liquidRescaleImage($width, $height, $delta_x, $rigidity){}
109822
109823    /**
109824     * List all the registry settings. Returns an array of all the key/value
109825     * pairs in the registry
109826     *
109827     * @return array An array containing the key/values from the registry.
109828     **/
109829    public static function listRegistry(){}
109830
109831    /**
109832     * Scales an image proportionally 2x
109833     *
109834     * Is a convenience method that scales an image proportionally to twice
109835     * its original size.
109836     *
109837     * @return bool
109838     * @since PECL imagick 2.0.0
109839     **/
109840    function magnifyImage(){}
109841
109842    /**
109843     * Replaces the colors of an image with the closest color from a
109844     * reference image
109845     *
109846     * @param Imagick $map
109847     * @param bool $dither
109848     * @return bool
109849     * @since PECL imagick 2.0.0
109850     **/
109851    function mapImage($map, $dither){}
109852
109853    /**
109854     * Changes the transparency value of a color
109855     *
109856     * Changes the transparency value of any pixel that matches target and is
109857     * an immediate neighbor. If the method FillToBorderMethod is specified,
109858     * the transparency value is changed for any neighbor pixel that does not
109859     * match the bordercolor member of image.
109860     *
109861     * @param float $alpha The level of transparency: 1.0 is fully opaque
109862     *   and 0.0 is fully transparent.
109863     * @param float $fuzz The fuzz member of image defines how much
109864     *   tolerance is acceptable to consider two colors as the same.
109865     * @param mixed $bordercolor An ImagickPixel object or string
109866     *   representing the border color.
109867     * @param int $x The starting x coordinate of the operation.
109868     * @param int $y The starting y coordinate of the operation.
109869     * @return bool
109870     * @since PECL imagick 2.0.0
109871     **/
109872    function matteFloodfillImage($alpha, $fuzz, $bordercolor, $x, $y){}
109873
109874    /**
109875     * Applies a digital filter
109876     *
109877     * Applies a digital filter that improves the quality of a noisy image.
109878     * Each pixel is replaced by the median in a set of neighboring pixels as
109879     * defined by radius.
109880     *
109881     * @param float $radius The radius of the pixel neighborhood.
109882     * @return bool
109883     * @since PECL imagick 2.0.0
109884     **/
109885    function medianFilterImage($radius){}
109886
109887    /**
109888     * Merges image layers
109889     *
109890     * Merges image layers into one. This method is useful when working with
109891     * image formats that use multiple layers such as PSD. The merging is
109892     * controlled using the {@link layer_method} which defines how the layers
109893     * are merged.
109894     *
109895     * @param int $layer_method One of the Imagick::LAYERMETHOD_* constants
109896     * @return Imagick Returns an Imagick object containing the merged
109897     *   image.
109898     * @since PECL imagick 2.1.0
109899     **/
109900    function mergeImageLayers($layer_method){}
109901
109902    /**
109903     * Scales an image proportionally to half its size
109904     *
109905     * Is a convenience method that scales an image proportionally to
109906     * one-half its original size
109907     *
109908     * @return bool
109909     * @since PECL imagick 2.0.0
109910     **/
109911    function minifyImage(){}
109912
109913    /**
109914     * Control the brightness, saturation, and hue
109915     *
109916     * Lets you control the brightness, saturation, and hue of an image. Hue
109917     * is the percentage of absolute rotation from the current position. For
109918     * example 50 results in a counter-clockwise rotation of 90 degrees, 150
109919     * results in a clockwise rotation of 90 degrees, with 0 and 200 both
109920     * resulting in a rotation of 180 degrees.
109921     *
109922     * @param float $brightness
109923     * @param float $saturation
109924     * @param float $hue
109925     * @return bool
109926     * @since PECL imagick 2.0.0
109927     **/
109928    function modulateImage($brightness, $saturation, $hue){}
109929
109930    /**
109931     * Creates a composite image
109932     *
109933     * Creates a composite image by combining several separate images. The
109934     * images are tiled on the composite image with the name of the image
109935     * optionally appearing just below the individual tile.
109936     *
109937     * @param ImagickDraw $draw The font name, size, and color are obtained
109938     *   from this object.
109939     * @param string $tile_geometry The number of tiles per row and page
109940     *   (e.g. 6x4+0+0).
109941     * @param string $thumbnail_geometry Preferred image size and border
109942     *   size of each thumbnail (e.g. 120x120+4+3>).
109943     * @param int $mode Thumbnail framing mode, see Montage Mode constants.
109944     * @param string $frame Surround the image with an ornamental border
109945     *   (e.g. 15x15+3+3). The frame color is that of the thumbnail's matte
109946     *   color.
109947     * @return Imagick
109948     * @since PECL imagick 2.0.0
109949     **/
109950    function montageImage($draw, $tile_geometry, $thumbnail_geometry, $mode, $frame){}
109951
109952    /**
109953     * Method morphs a set of images
109954     *
109955     * Method morphs a set of images. Both the image pixels and size are
109956     * linearly interpolated to give the appearance of a meta-morphosis from
109957     * one image to the next.
109958     *
109959     * @param int $number_frames The number of in-between images to
109960     *   generate.
109961     * @return Imagick This method returns a new Imagick object on success.
109962     * @since PECL imagick 2.0.0
109963     **/
109964    function morphImages($number_frames){}
109965
109966    /**
109967     * Applies a user supplied kernel to the image according to the given
109968     * morphology method.
109969     *
109970     * @param int $morphologyMethod Which morphology method to use one of
109971     *   the \Imagick::MORPHOLOGY_* constants.
109972     * @param int $iterations The number of iteration to apply the
109973     *   morphology function. A value of -1 means loop until no change found.
109974     *   How this is applied may depend on the morphology method. Typically
109975     *   this is a value of 1.
109976     * @param ImagickKernel $ImagickKernel
109977     * @param int $channel
109978     * @return bool
109979     **/
109980    public function morphology($morphologyMethod, $iterations, $ImagickKernel, $channel){}
109981
109982    /**
109983     * Forms a mosaic from images
109984     *
109985     * Inlays an image sequence to form a single coherent picture. It returns
109986     * a wand with each image in the sequence composited at the location
109987     * defined by the page offset of the image.
109988     *
109989     * @return Imagick
109990     * @since PECL imagick 2.0.0
109991     **/
109992    function mosaicImages(){}
109993
109994    /**
109995     * Simulates motion blur
109996     *
109997     * Simulates motion blur. We convolve the image with a Gaussian operator
109998     * of the given radius and standard deviation (sigma). For reasonable
109999     * results, radius should be larger than sigma. Use a radius of 0 and
110000     * MotionBlurImage() selects a suitable radius for you. Angle gives the
110001     * angle of the blurring motion.
110002     *
110003     * @param float $radius The radius of the Gaussian, in pixels, not
110004     *   counting the center pixel.
110005     * @param float $sigma The standard deviation of the Gaussian, in
110006     *   pixels.
110007     * @param float $angle Apply the effect along this angle.
110008     * @param int $channel Provide any channel constant that is valid for
110009     *   your channel mode. To apply to more than one channel, combine
110010     *   channeltype constants using bitwise operators. Refer to this list of
110011     *   channel constants. The channel argument affects only if Imagick is
110012     *   compiled against ImageMagick version 6.4.4 or greater.
110013     * @return bool
110014     * @since PECL imagick 2.0.0
110015     **/
110016    function motionBlurImage($radius, $sigma, $angle, $channel){}
110017
110018    /**
110019     * Negates the colors in the reference image
110020     *
110021     * Negates the colors in the reference image. The Grayscale option means
110022     * that only grayscale values within the image are negated.
110023     *
110024     * @param bool $gray Whether to only negate grayscale pixels within the
110025     *   image.
110026     * @param int $channel Provide any channel constant that is valid for
110027     *   your channel mode. To apply to more than one channel, combine
110028     *   channeltype constants using bitwise operators. Refer to this list of
110029     *   channel constants.
110030     * @return bool
110031     * @since PECL imagick 2.0.0
110032     **/
110033    function negateImage($gray, $channel){}
110034
110035    /**
110036     * Creates a new image
110037     *
110038     * Creates a new image and associates ImagickPixel value as background
110039     * color
110040     *
110041     * @param int $cols Columns in the new image
110042     * @param int $rows Rows in the new image
110043     * @param mixed $background The background color used for this image
110044     * @param string $format Image format. This parameter was added in
110045     *   Imagick version 2.0.1.
110046     * @return bool
110047     * @since PECL imagick 2.0.0
110048     **/
110049    function newImage($cols, $rows, $background, $format){}
110050
110051    /**
110052     * Creates a new image
110053     *
110054     * Creates a new image using ImageMagick pseudo-formats.
110055     *
110056     * @param int $columns columns in the new image
110057     * @param int $rows rows in the new image
110058     * @param string $pseudoString string containing pseudo image
110059     *   definition.
110060     * @return bool
110061     * @since PECL imagick 2.0.0
110062     **/
110063    function newPseudoImage($columns, $rows, $pseudoString){}
110064
110065    /**
110066     * Moves to the next image
110067     *
110068     * Associates the next image in the image list with an Imagick object.
110069     *
110070     * @return bool
110071     * @since PECL imagick 2.0.0
110072     **/
110073    function nextImage(){}
110074
110075    /**
110076     * Enhances the contrast of a color image
110077     *
110078     * Enhances the contrast of a color image by adjusting the pixels color
110079     * to span the entire range of colors available.
110080     *
110081     * @param int $channel Provide any channel constant that is valid for
110082     *   your channel mode. To apply to more than one channel, combine
110083     *   channeltype constants using bitwise operators. Refer to this list of
110084     *   channel constants.
110085     * @return bool
110086     * @since PECL imagick 2.0.0
110087     **/
110088    function normalizeImage($channel){}
110089
110090    /**
110091     * Simulates an oil painting
110092     *
110093     * Applies a special effect filter that simulates an oil painting. Each
110094     * pixel is replaced by the most frequent color occurring in a circular
110095     * region defined by radius.
110096     *
110097     * @param float $radius The radius of the circular neighborhood.
110098     * @return bool
110099     * @since PECL imagick 2.0.0
110100     **/
110101    function oilPaintImage($radius){}
110102
110103    /**
110104     * Changes the color value of any pixel that matches target
110105     *
110106     * Changes any pixel that matches color with the color defined by fill.
110107     *
110108     * @param mixed $target ImagickPixel object or a string containing the
110109     *   color to change
110110     * @param mixed $fill The replacement color
110111     * @param float $fuzz
110112     * @param bool $invert If TRUE paints any pixel that does not match the
110113     *   target color.
110114     * @param int $channel
110115     * @return bool
110116     **/
110117    function opaquePaintImage($target, $fill, $fuzz, $invert, $channel){}
110118
110119    /**
110120     * Removes repeated portions of images to optimize
110121     *
110122     * Compares each image the GIF disposed forms of the previous image in
110123     * the sequence. From this it attempts to select the smallest cropped
110124     * image to replace each frame, while preserving the results of the
110125     * animation.
110126     *
110127     * @return bool
110128     * @since PECL imagick 2.0.0
110129     **/
110130    function optimizeImageLayers(){}
110131
110132    /**
110133     * Performs an ordered dither
110134     *
110135     * Performs an ordered dither based on a number of pre-defined dithering
110136     * threshold maps, but over multiple intensity levels, which can be
110137     * different for different channels, according to the input arguments.
110138     *
110139     * @param string $threshold_map A string containing the name of the
110140     *   threshold dither map to use
110141     * @param int $channel Provide any channel constant that is valid for
110142     *   your channel mode. To apply to more than one channel, combine
110143     *   channeltype constants using bitwise operators. Refer to this list of
110144     *   channel constants.
110145     * @return bool
110146     * @since PECL imagick 2.2.2
110147     **/
110148    function orderedPosterizeImage($threshold_map, $channel){}
110149
110150    /**
110151     * Changes the color value of any pixel that matches target
110152     *
110153     * Changes the color value of any pixel that matches target and is an
110154     * immediate neighbor. As of ImageMagick 6.3.8 this method has been
110155     * deprecated and {@link Imagick::floodfillPaintImage} should be used
110156     * instead.
110157     *
110158     * @param mixed $fill ImagickPixel object or a string containing the
110159     *   fill color
110160     * @param float $fuzz The amount of fuzz. For example, set fuzz to 10
110161     *   and the color red at intensities of 100 and 102 respectively are now
110162     *   interpreted as the same color for the purposes of the floodfill.
110163     * @param mixed $bordercolor ImagickPixel object or a string containing
110164     *   the border color
110165     * @param int $x X start position of the floodfill
110166     * @param int $y Y start position of the floodfill
110167     * @param int $channel
110168     * @return bool
110169     * @since PECL imagick 2.1.0
110170     **/
110171    function paintFloodfillImage($fill, $fuzz, $bordercolor, $x, $y, $channel){}
110172
110173    /**
110174     * Change any pixel that matches color
110175     *
110176     * Changes any pixel that matches color with the color defined by fill.
110177     *
110178     * @param mixed $target Change this target color to the fill color
110179     *   within the image. An ImagickPixel object or a string representing
110180     *   the target color.
110181     * @param mixed $fill An ImagickPixel object or a string representing
110182     *   the fill color.
110183     * @param float $fuzz The fuzz member of image defines how much
110184     *   tolerance is acceptable to consider two colors as the same.
110185     * @param int $channel Provide any channel constant that is valid for
110186     *   your channel mode. To apply to more than one channel, combine
110187     *   channeltype constants using bitwise operators. Refer to this list of
110188     *   channel constants.
110189     * @return bool
110190     * @since PECL imagick 2.0.0
110191     **/
110192    function paintOpaqueImage($target, $fill, $fuzz, $channel){}
110193
110194    /**
110195     * Changes any pixel that matches color with the color defined by fill
110196     *
110197     * @param mixed $target Change this target color to specified opacity
110198     *   value within the image.
110199     * @param float $alpha The level of transparency: 1.0 is fully opaque
110200     *   and 0.0 is fully transparent.
110201     * @param float $fuzz The fuzz member of image defines how much
110202     *   tolerance is acceptable to consider two colors as the same.
110203     * @return bool
110204     * @since PECL imagick 2.0.0
110205     **/
110206    function paintTransparentImage($target, $alpha, $fuzz){}
110207
110208    /**
110209     * Fetch basic attributes about the image
110210     *
110211     * This method can be used to query image width, height, size, and format
110212     * without reading the whole image in to memory.
110213     *
110214     * @param string $filename The filename to read the information from.
110215     * @return bool
110216     * @since PECL imagick 2.0.0
110217     **/
110218    function pingImage($filename){}
110219
110220    /**
110221     * Quickly fetch attributes
110222     *
110223     * This method can be used to query image width, height, size, and format
110224     * without reading the whole image to memory.
110225     *
110226     * @param string $image A string containing the image.
110227     * @return bool
110228     * @since PECL imagick 2.0.0
110229     **/
110230    function pingImageBlob($image){}
110231
110232    /**
110233     * Get basic image attributes in a lightweight manner
110234     *
110235     * This method can be used to query image width, height, size, and format
110236     * without reading the whole image to memory.
110237     *
110238     * @param resource $filehandle An open filehandle to the image.
110239     * @param string $fileName Optional filename for this image.
110240     * @return bool
110241     * @since PECL imagick 2.0.0
110242     **/
110243    function pingImageFile($filehandle, $fileName){}
110244
110245    /**
110246     * Simulates a Polaroid picture
110247     *
110248     * @param ImagickDraw $properties The polaroid properties
110249     * @param float $angle The polaroid angle
110250     * @return bool
110251     * @since PECL imagick 2.0.0
110252     **/
110253    function polaroidImage($properties, $angle){}
110254
110255    /**
110256     * Reduces the image to a limited number of color level
110257     *
110258     * @param int $levels
110259     * @param bool $dither
110260     * @return bool
110261     * @since PECL imagick 2.0.0
110262     **/
110263    function posterizeImage($levels, $dither){}
110264
110265    /**
110266     * Quickly pin-point appropriate parameters for image processing
110267     *
110268     * Tiles 9 thumbnails of the specified image with an image processing
110269     * operation applied at varying strengths. This is helpful to quickly
110270     * pin-point an appropriate parameter for an image processing operation.
110271     *
110272     * @param int $preview Preview type. See Preview type constants
110273     * @return bool
110274     * @since PECL imagick 2.0.0
110275     **/
110276    function previewImages($preview){}
110277
110278    /**
110279     * Move to the previous image in the object
110280     *
110281     * Assocates the previous image in an image list with the Imagick object.
110282     *
110283     * @return bool
110284     * @since PECL imagick 2.0.0
110285     **/
110286    function previousImage(){}
110287
110288    /**
110289     * Adds or removes a profile from an image
110290     *
110291     * Adds or removes a ICC, IPTC, or generic profile from an image. If the
110292     * profile is NULL, it is removed from the image otherwise added. Use a
110293     * name of '*' and a profile of NULL to remove all profiles from the
110294     * image.
110295     *
110296     * @param string $name
110297     * @param string $profile
110298     * @return bool
110299     * @since PECL imagick 2.0.0
110300     **/
110301    function profileImage($name, $profile){}
110302
110303    /**
110304     * Analyzes the colors within a reference image
110305     *
110306     * @param int $numberColors
110307     * @param int $colorspace
110308     * @param int $treedepth
110309     * @param bool $dither
110310     * @param bool $measureError
110311     * @return bool
110312     * @since PECL imagick 2.0.0
110313     **/
110314    function quantizeImage($numberColors, $colorspace, $treedepth, $dither, $measureError){}
110315
110316    /**
110317     * Analyzes the colors within a sequence of images
110318     *
110319     * @param int $numberColors
110320     * @param int $colorspace
110321     * @param int $treedepth
110322     * @param bool $dither
110323     * @param bool $measureError
110324     * @return bool
110325     * @since PECL imagick 2.0.0
110326     **/
110327    function quantizeImages($numberColors, $colorspace, $treedepth, $dither, $measureError){}
110328
110329    /**
110330     * Returns an array representing the font metrics
110331     *
110332     * Returns a multi-dimensional array representing the font metrics.
110333     *
110334     * @param ImagickDraw $properties ImagickDraw object containing font
110335     *   properties
110336     * @param string $text The text
110337     * @param bool $multiline Multiline parameter. If left empty it is
110338     *   autodetected
110339     * @return array Returns a multi-dimensional array representing the
110340     *   font metrics.
110341     * @since PECL imagick 2.0.0
110342     **/
110343    function queryFontMetrics($properties, $text, $multiline){}
110344
110345    /**
110346     * Returns the configured fonts
110347     *
110348     * @param string $pattern The query pattern
110349     * @return array Returns an array containing the configured fonts.
110350     * @since PECL imagick 2.0.0
110351     **/
110352    function queryFonts($pattern){}
110353
110354    /**
110355     * Returns formats supported by Imagick
110356     *
110357     * @param string $pattern
110358     * @return array Returns an array containing the formats supported by
110359     *   Imagick.
110360     * @since PECL imagick 2.0.0
110361     **/
110362    function queryFormats($pattern){}
110363
110364    /**
110365     * Radial blurs an image
110366     *
110367     * @param float $angle
110368     * @param int $channel
110369     * @return bool
110370     * @since PECL imagick 2.0.0
110371     **/
110372    function radialBlurImage($angle, $channel){}
110373
110374    /**
110375     * Creates a simulated 3d button-like effect
110376     *
110377     * Creates a simulated three-dimensional button-like effect by lightening
110378     * and darkening the edges of the image. Members width and height of
110379     * raise_info define the width of the vertical and horizontal edge of the
110380     * effect.
110381     *
110382     * @param int $width
110383     * @param int $height
110384     * @param int $x
110385     * @param int $y
110386     * @param bool $raise
110387     * @return bool
110388     * @since PECL imagick 2.0.0
110389     **/
110390    function raiseImage($width, $height, $x, $y, $raise){}
110391
110392    /**
110393     * Creates a high-contrast, two-color image
110394     *
110395     * Changes the value of individual pixels based on the intensity of each
110396     * pixel compared to threshold. The result is a high-contrast, two color
110397     * image.
110398     *
110399     * @param float $low The low point
110400     * @param float $high The high point
110401     * @param int $channel Provide any channel constant that is valid for
110402     *   your channel mode. To apply to more than one channel, combine
110403     *   channeltype constants using bitwise operators. Refer to this list of
110404     *   channel constants.
110405     * @return bool
110406     * @since PECL imagick 2.0.0
110407     **/
110408    function randomThresholdImage($low, $high, $channel){}
110409
110410    /**
110411     * Reads image from filename
110412     *
110413     * @param string $filename
110414     * @return bool
110415     **/
110416    function readImage($filename){}
110417
110418    /**
110419     * Reads image from a binary string
110420     *
110421     * @param string $image
110422     * @param string $filename
110423     * @return bool
110424     * @since PECL imagick 2.0.0
110425     **/
110426    function readImageBlob($image, $filename){}
110427
110428    /**
110429     * Reads image from open filehandle
110430     *
110431     * @param resource $filehandle
110432     * @param string $fileName
110433     * @return bool
110434     * @since PECL imagick 2.0.0
110435     **/
110436    function readImageFile($filehandle, $fileName){}
110437
110438    /**
110439     * Reads image from an array of filenames. All the images are held in a
110440     * single Imagick object.
110441     *
110442     * @param array $filenames
110443     * @return bool
110444     **/
110445    public function readImages($filenames){}
110446
110447    /**
110448     * Recolors image
110449     *
110450     * Translate, scale, shear, or rotate image colors. This method supports
110451     * variable sized matrices but normally 5x5 matrix is used for RGBA and
110452     * 6x6 is used for CMYK. The last row should contain the normalized
110453     * values.
110454     *
110455     * @param array $matrix The matrix containing the color values
110456     * @return bool
110457     **/
110458    function recolorImage($matrix){}
110459
110460    /**
110461     * Smooths the contours of an image
110462     *
110463     * Smooths the contours of an image while still preserving edge
110464     * information. The algorithm works by replacing each pixel with its
110465     * neighbor closest in value. A neighbor is defined by radius. Use a
110466     * radius of 0 and Imagick::reduceNoiseImage() selects a suitable radius
110467     * for you.
110468     *
110469     * @param float $radius
110470     * @return bool
110471     * @since PECL imagick 2.0.0
110472     **/
110473    function reduceNoiseImage($radius){}
110474
110475    /**
110476     * Remaps image colors
110477     *
110478     * Replaces colors an image with those defined by {@link replacement}.
110479     * The colors are replaced with the closest possible color.
110480     *
110481     * @param Imagick $replacement An Imagick object containing the
110482     *   replacement colors
110483     * @param int $DITHER Refer to this list of dither method constants
110484     * @return bool
110485     **/
110486    public function remapImage($replacement, $DITHER){}
110487
110488    /**
110489     * Removes an image from the image list
110490     *
110491     * @return bool
110492     * @since PECL imagick 2.0.0
110493     **/
110494    function removeImage(){}
110495
110496    /**
110497     * Removes the named image profile and returns it
110498     *
110499     * @param string $name
110500     * @return string Returns a string containing the profile of the image.
110501     * @since PECL imagick 2.0.0
110502     **/
110503    function removeImageProfile($name){}
110504
110505    /**
110506     * Renders all preceding drawing commands
110507     *
110508     * @return bool
110509     * @since PECL imagick 2.0.0
110510     **/
110511    function render(){}
110512
110513    /**
110514     * Resample image to desired resolution
110515     *
110516     * @param float $x_resolution
110517     * @param float $y_resolution
110518     * @param int $filter
110519     * @param float $blur
110520     * @return bool
110521     * @since PECL imagick 2.0.0
110522     **/
110523    function resampleImage($x_resolution, $y_resolution, $filter, $blur){}
110524
110525    /**
110526     * Reset image page
110527     *
110528     * The page definition as a string. The string is in format WxH+x+y.
110529     *
110530     * @param string $page The page definition. For example 7168x5147+0+0
110531     * @return bool
110532     **/
110533    function resetImagePage($page){}
110534
110535    /**
110536     * Scales an image
110537     *
110538     * Scales an image to the desired dimensions with a filter.
110539     *
110540     * @param int $columns Width of the image
110541     * @param int $rows Height of the image
110542     * @param int $filter Refer to the list of filter constants.
110543     * @param float $blur The blur factor where > 1 is blurry, < 1 is
110544     *   sharp.
110545     * @param bool $bestfit Optional fit parameter.
110546     * @param bool $legacy
110547     * @return bool
110548     * @since PECL imagick 2.0.0
110549     **/
110550    function resizeImage($columns, $rows, $filter, $blur, $bestfit, $legacy){}
110551
110552    /**
110553     * Offsets an image
110554     *
110555     * Offsets an image as defined by x and y.
110556     *
110557     * @param int $x The X offset.
110558     * @param int $y The Y offset.
110559     * @return bool
110560     * @since PECL imagick 2.0.0
110561     **/
110562    function rollImage($x, $y){}
110563
110564    /**
110565     * Rotates an image
110566     *
110567     * Rotates an image the specified number of degrees. Empty triangles left
110568     * over from rotating the image are filled with the background color.
110569     *
110570     * @param mixed $background The background color
110571     * @param float $degrees Rotation angle, in degrees. The rotation angle
110572     *   is interpreted as the number of degrees to rotate the image
110573     *   clockwise.
110574     * @return bool
110575     * @since PECL imagick 2.0.0
110576     **/
110577    function rotateImage($background, $degrees){}
110578
110579    /**
110580     * Rotational blurs an image.
110581     *
110582     * @param float $angle The angle to apply the blur over.
110583     * @param int $channel
110584     * @return bool
110585     **/
110586    public function rotationalBlurImage($angle, $channel){}
110587
110588    /**
110589     * Rounds image corners
110590     *
110591     * Rounds image corners. The first two parameters control the amount of
110592     * rounding and the three last parameters can be used to fine-tune the
110593     * rounding process.
110594     *
110595     * @param float $x_rounding x rounding
110596     * @param float $y_rounding y rounding
110597     * @param float $stroke_width stroke width
110598     * @param float $displace image displace
110599     * @param float $size_correction size correction
110600     * @return bool
110601     * @since PECL imagick 2.0.0
110602     **/
110603    function roundCorners($x_rounding, $y_rounding, $stroke_width, $displace, $size_correction){}
110604
110605    /**
110606     * Scales an image with pixel sampling
110607     *
110608     * Scales an image to the desired dimensions with pixel sampling. Unlike
110609     * other scaling methods, this method does not introduce any additional
110610     * color into the scaled image.
110611     *
110612     * @param int $columns
110613     * @param int $rows
110614     * @return bool
110615     * @since PECL imagick 2.0.0
110616     **/
110617    function sampleImage($columns, $rows){}
110618
110619    /**
110620     * Scales the size of an image
110621     *
110622     * Scales the size of an image to the given dimensions. The other
110623     * parameter will be calculated if 0 is passed as either param.
110624     *
110625     * @param int $cols
110626     * @param int $rows
110627     * @param bool $bestfit
110628     * @param bool $legacy
110629     * @return bool
110630     * @since PECL imagick 2.0.0
110631     **/
110632    function scaleImage($cols, $rows, $bestfit, $legacy){}
110633
110634    /**
110635     * Segments an image
110636     *
110637     * Analyses the image and identifies units that are similar.
110638     *
110639     * @param int $COLORSPACE One of the COLORSPACE constants.
110640     * @param float $cluster_threshold A percentage describing minimum
110641     *   number of pixels contained in hexedra before it is considered valid.
110642     * @param float $smooth_threshold Eliminates noise from the histogram.
110643     * @param bool $verbose Whether to output detailed information about
110644     *   recognised classes.
110645     * @return bool
110646     **/
110647    public function segmentImage($COLORSPACE, $cluster_threshold, $smooth_threshold, $verbose){}
110648
110649    /**
110650     * Selectively blur an image within a contrast threshold. It is similar
110651     * to the unsharpen mask that sharpens everything with contrast above a
110652     * certain threshold.
110653     *
110654     * @param float $radius
110655     * @param float $sigma
110656     * @param float $threshold
110657     * @param int $channel
110658     * @return bool
110659     **/
110660    public function selectiveBlurImage($radius, $sigma, $threshold, $channel){}
110661
110662    /**
110663     * Separates a channel from the image
110664     *
110665     * Separates a channel from the image and returns a grayscale image. A
110666     * channel is a particular color component of each pixel in the image.
110667     *
110668     * @param int $channel Which 'channel' to return. For colorspaces other
110669     *   than RGB, you can still use the CHANNEL_RED, CHANNEL_GREEN,
110670     *   CHANNEL_BLUE constants to indicate the 1st, 2nd and 3rd channels.
110671     * @return bool
110672     * @since PECL imagick 2.0.0
110673     **/
110674    function separateImageChannel($channel){}
110675
110676    /**
110677     * Sepia tones an image
110678     *
110679     * Applies a special effect to the image, similar to the effect achieved
110680     * in a photo darkroom by sepia toning. Threshold ranges from 0 to
110681     * QuantumRange and is a measure of the extent of the sepia toning. A
110682     * threshold of 80 is a good starting point for a reasonable tone.
110683     *
110684     * @param float $threshold
110685     * @return bool
110686     * @since PECL imagick 2.0.0
110687     **/
110688    function sepiaToneImage($threshold){}
110689
110690    /**
110691     * Sets the object's default background color
110692     *
110693     * @param mixed $background
110694     * @return bool
110695     * @since PECL imagick 2.0.0
110696     **/
110697    function setBackgroundColor($background){}
110698
110699    /**
110700     * Set colorspace
110701     *
110702     * Sets the global colorspace value for the object.
110703     *
110704     * @param int $COLORSPACE One of the COLORSPACE constants
110705     * @return bool
110706     **/
110707    function setColorspace($COLORSPACE){}
110708
110709    /**
110710     * Sets the object's default compression type
110711     *
110712     * @param int $compression The compression type. See the
110713     *   Imagick::COMPRESSION_* constants.
110714     * @return bool
110715     * @since PECL imagick 2.0.0
110716     **/
110717    function setCompression($compression){}
110718
110719    /**
110720     * Sets the object's default compression quality
110721     *
110722     * @param int $quality An between 1 and 100, 1 = high compression, 100
110723     *   low compression.
110724     * @return bool
110725     **/
110726    function setCompressionQuality($quality){}
110727
110728    /**
110729     * Sets the filename before you read or write the image
110730     *
110731     * Sets the filename before you read or write an image file.
110732     *
110733     * @param string $filename
110734     * @return bool
110735     * @since PECL imagick 2.0.0
110736     **/
110737    function setFilename($filename){}
110738
110739    /**
110740     * Sets the Imagick iterator to the first image
110741     *
110742     * @return bool
110743     * @since PECL imagick 2.0.0
110744     **/
110745    function setFirstIterator(){}
110746
110747    /**
110748     * Sets font
110749     *
110750     * Sets object's font property. This method can be used for example to
110751     * set font for caption: pseudo-format. The font needs to be configured
110752     * in ImageMagick configuration or a file by the name of {@link font}
110753     * must exist. This method should not be confused with {@link
110754     * ImagickDraw::setFont} which sets the font for a specific ImagickDraw
110755     * object.
110756     *
110757     * @param string $font Font name or a filename
110758     * @return bool
110759     * @since PECL imagick 2.1.0
110760     **/
110761    function setFont($font){}
110762
110763    /**
110764     * Sets the format of the Imagick object
110765     *
110766     * @param string $format
110767     * @return bool
110768     * @since PECL imagick 2.0.0
110769     **/
110770    function setFormat($format){}
110771
110772    /**
110773     * Sets the gravity
110774     *
110775     * Sets the global gravity property for the Imagick object.
110776     *
110777     * @param int $gravity The gravity property. Refer to the list of
110778     *   gravity constants.
110779     * @return bool
110780     **/
110781    function setGravity($gravity){}
110782
110783    /**
110784     * Replaces image in the object
110785     *
110786     * Replaces the current image sequence with the image from replace
110787     * object.
110788     *
110789     * @param Imagick $replace The replace Imagick object
110790     * @return bool
110791     * @since PECL imagick 2.0.0
110792     **/
110793    function setImage($replace){}
110794
110795    /**
110796     * Sets image alpha channel
110797     *
110798     * Activate or deactivate image alpha channel. The {@link mode} is one of
110799     * the Imagick::ALPHACHANNEL_* constants.
110800     *
110801     * @param int $mode One of the Imagick::ALPHACHANNEL_* constants
110802     * @return bool
110803     **/
110804    function setImageAlphaChannel($mode){}
110805
110806    /**
110807     * Set image artifact
110808     *
110809     * Associates an artifact with the image. The difference between image
110810     * properties and image artifacts is that properties are public and
110811     * artifacts are private.
110812     *
110813     * @param string $artifact The name of the artifact
110814     * @param string $value The value of the artifact
110815     * @return bool
110816     **/
110817    function setImageArtifact($artifact, $value){}
110818
110819    /**
110820     * @param string $key
110821     * @param string $value
110822     * @return bool
110823     **/
110824    public function setImageAttribute($key, $value){}
110825
110826    /**
110827     * Sets the image background color
110828     *
110829     * @param mixed $background
110830     * @return bool
110831     * @since PECL imagick 2.0.0
110832     **/
110833    function setImageBackgroundColor($background){}
110834
110835    /**
110836     * Sets the image bias for any method that convolves an image
110837     *
110838     * Sets the image bias for any method that convolves an image (e.g.
110839     * Imagick::ConvolveImage()).
110840     *
110841     * @param float $bias
110842     * @return bool
110843     * @since PECL imagick 2.0.0
110844     **/
110845    function setImageBias($bias){}
110846
110847    /**
110848     * @param string $bias
110849     * @return void
110850     **/
110851    public function setImageBiasQuantum($bias){}
110852
110853    /**
110854     * Sets the image chromaticity blue primary point
110855     *
110856     * @param float $x
110857     * @param float $y
110858     * @return bool
110859     * @since PECL imagick 2.0.0
110860     **/
110861    function setImageBluePrimary($x, $y){}
110862
110863    /**
110864     * Sets the image border color
110865     *
110866     * @param mixed $border The border color
110867     * @return bool
110868     * @since PECL imagick 2.0.0
110869     **/
110870    function setImageBorderColor($border){}
110871
110872    /**
110873     * Sets the depth of a particular image channel
110874     *
110875     * @param int $channel
110876     * @param int $depth
110877     * @return bool
110878     * @since PECL imagick 2.0.0
110879     **/
110880    function setImageChannelDepth($channel, $depth){}
110881
110882    /**
110883     * Sets image clip mask
110884     *
110885     * Sets image clip mask from another Imagick object.
110886     *
110887     * @param Imagick $clip_mask The Imagick object containing the clip
110888     *   mask
110889     * @return bool
110890     **/
110891    function setImageClipMask($clip_mask){}
110892
110893    /**
110894     * Sets the color of the specified colormap index
110895     *
110896     * @param int $index
110897     * @param ImagickPixel $color
110898     * @return bool
110899     * @since PECL imagick 2.0.0
110900     **/
110901    function setImageColormapColor($index, $color){}
110902
110903    /**
110904     * Sets the image colorspace
110905     *
110906     * Sets the image colorspace. This method should be used when creating
110907     * new images. To change the colorspace of an existing image, you should
110908     * use Imagick::transformImageColorspace.
110909     *
110910     * @param int $colorspace One of the COLORSPACE constants
110911     * @return bool
110912     * @since PECL imagick 2.0.0
110913     **/
110914    function setImageColorspace($colorspace){}
110915
110916    /**
110917     * Sets the image composite operator
110918     *
110919     * Sets the image composite operator, useful for specifying how to
110920     * composite the image thumbnail when using the Imagick::montageImage()
110921     * method.
110922     *
110923     * @param int $compose
110924     * @return bool
110925     * @since PECL imagick 2.0.0
110926     **/
110927    function setImageCompose($compose){}
110928
110929    /**
110930     * Sets the image compression
110931     *
110932     * @param int $compression One of the COMPRESSION constants
110933     * @return bool
110934     * @since PECL imagick 2.0.0
110935     **/
110936    function setImageCompression($compression){}
110937
110938    /**
110939     * Sets the image compression quality
110940     *
110941     * @param int $quality The image compression quality as an integer
110942     * @return bool
110943     **/
110944    function setImageCompressionQuality($quality){}
110945
110946    /**
110947     * Sets the image delay
110948     *
110949     * Sets the image delay. For an animated image this is the amount of time
110950     * that this frame of the image should be displayed for, before
110951     * displaying the next frame.
110952     *
110953     * The delay can be set individually for each frame in an image.
110954     *
110955     * @param int $delay The amount of time expressed in 'ticks' that the
110956     *   image should be displayed for. For animated GIFs there are 100 ticks
110957     *   per second, so a value of 20 would be 20/100 of a second aka 1/5th
110958     *   of a second.
110959     * @return bool
110960     * @since PECL imagick 2.0.0
110961     **/
110962    function setImageDelay($delay){}
110963
110964    /**
110965     * Sets the image depth
110966     *
110967     * @param int $depth
110968     * @return bool
110969     * @since PECL imagick 2.0.0
110970     **/
110971    function setImageDepth($depth){}
110972
110973    /**
110974     * Sets the image disposal method
110975     *
110976     * @param int $dispose
110977     * @return bool
110978     * @since PECL imagick 2.0.0
110979     **/
110980    function setImageDispose($dispose){}
110981
110982    /**
110983     * Sets the image size
110984     *
110985     * Sets the image size (i.e. columns & rows).
110986     *
110987     * @param int $columns
110988     * @param int $rows
110989     * @return bool
110990     * @since PECL imagick 2.0.0
110991     **/
110992    function setImageExtent($columns, $rows){}
110993
110994    /**
110995     * Sets the filename of a particular image
110996     *
110997     * Sets the filename of a particular image in a sequence.
110998     *
110999     * @param string $filename
111000     * @return bool
111001     * @since PECL imagick 2.0.0
111002     **/
111003    function setImageFilename($filename){}
111004
111005    /**
111006     * Sets the format of a particular image
111007     *
111008     * Sets the format of a particular image in a sequence.
111009     *
111010     * @param string $format String presentation of the image format.
111011     *   Format support depends on the ImageMagick installation.
111012     * @return bool
111013     * @since PECL imagick 2.0.0
111014     **/
111015    function setImageFormat($format){}
111016
111017    /**
111018     * Sets the image gamma
111019     *
111020     * @param float $gamma
111021     * @return bool
111022     * @since PECL imagick 2.0.0
111023     **/
111024    function setImageGamma($gamma){}
111025
111026    /**
111027     * Sets the image gravity
111028     *
111029     * Sets the gravity property for the current image. This method can be
111030     * used to set the gravity property for a single image sequence.
111031     *
111032     * @param int $gravity The gravity property. Refer to the list of
111033     *   gravity constants.
111034     * @return bool
111035     **/
111036    function setImageGravity($gravity){}
111037
111038    /**
111039     * Sets the image chromaticity green primary point
111040     *
111041     * @param float $x
111042     * @param float $y
111043     * @return bool
111044     * @since PECL imagick 2.0.0
111045     **/
111046    function setImageGreenPrimary($x, $y){}
111047
111048    /**
111049     * Set the iterator position
111050     *
111051     * Set the iterator to the position in the image list specified with the
111052     * index parameter.
111053     *
111054     * This method has been deprecated. See {@link
111055     * Imagick::setIteratorIndex}.
111056     *
111057     * @param int $index The position to set the iterator to
111058     * @return bool
111059     * @since PECL imagick 2.0.0
111060     **/
111061    function setImageIndex($index){}
111062
111063    /**
111064     * Sets the image compression
111065     *
111066     * @param int $interlace_scheme
111067     * @return bool
111068     * @since PECL imagick 2.0.0
111069     **/
111070    function setImageInterlaceScheme($interlace_scheme){}
111071
111072    /**
111073     * Sets the image interpolate pixel method
111074     *
111075     * @param int $method The method is one of the Imagick::INTERPOLATE_*
111076     *   constants
111077     * @return bool
111078     * @since PECL imagick 2.0.0
111079     **/
111080    function setImageInterpolateMethod($method){}
111081
111082    /**
111083     * Sets the image iterations
111084     *
111085     * Sets the number of iterations an animated image is repeated.
111086     *
111087     * @param int $iterations The number of iterations the image should
111088     *   loop over. Set to '0' to loop continuously.
111089     * @return bool
111090     * @since PECL imagick 2.0.0
111091     **/
111092    function setImageIterations($iterations){}
111093
111094    /**
111095     * Sets the image matte channel
111096     *
111097     * @param bool $matte True activates the matte channel and false
111098     *   disables it.
111099     * @return bool
111100     * @since PECL imagick 2.0.0
111101     **/
111102    function setImageMatte($matte){}
111103
111104    /**
111105     * Sets the image matte color
111106     *
111107     * @param mixed $matte
111108     * @return bool
111109     * @since PECL imagick 2.0.0
111110     **/
111111    function setImageMatteColor($matte){}
111112
111113    /**
111114     * Sets the image opacity level
111115     *
111116     * Sets the image to the specified opacity level. This method operates on
111117     * all channels, which means that for example opacity value of 0.5 will
111118     * set all transparent areas to partially opaque. To add transparency to
111119     * areas that are not already transparent use Imagick::evaluateImage()
111120     *
111121     * @param float $opacity The level of transparency: 1.0 is fully opaque
111122     *   and 0.0 is fully transparent.
111123     * @return bool
111124     * @since PECL imagick 2.0.0
111125     **/
111126    function setImageOpacity($opacity){}
111127
111128    /**
111129     * Sets the image orientation
111130     *
111131     * @param int $orientation One of the orientation constants
111132     * @return bool
111133     * @since PECL imagick 2.0.0
111134     **/
111135    function setImageOrientation($orientation){}
111136
111137    /**
111138     * Sets the page geometry of the image
111139     *
111140     * @param int $width
111141     * @param int $height
111142     * @param int $x
111143     * @param int $y
111144     * @return bool
111145     * @since PECL imagick 2.0.0
111146     **/
111147    function setImagePage($width, $height, $x, $y){}
111148
111149    /**
111150     * Adds a named profile to the Imagick object
111151     *
111152     * Adds a named profile to the Imagick object. If a profile with the same
111153     * name already exists, it is replaced. This method differs from the
111154     * Imagick::ProfileImage() method in that it does not apply any CMS color
111155     * profiles.
111156     *
111157     * @param string $name
111158     * @param string $profile
111159     * @return bool
111160     * @since PECL imagick 2.0.0
111161     **/
111162    function setImageProfile($name, $profile){}
111163
111164    /**
111165     * Sets an image property
111166     *
111167     * Sets a named property to the image.
111168     *
111169     * @param string $name
111170     * @param string $value
111171     * @return bool
111172     * @since PECL imagick 2.0.0
111173     **/
111174    function setImageProperty($name, $value){}
111175
111176    /**
111177     * Sets the image chromaticity red primary point
111178     *
111179     * @param float $x
111180     * @param float $y
111181     * @return bool
111182     * @since PECL imagick 2.0.0
111183     **/
111184    function setImageRedPrimary($x, $y){}
111185
111186    /**
111187     * Sets the image rendering intent
111188     *
111189     * @param int $rendering_intent
111190     * @return bool
111191     * @since PECL imagick 2.0.0
111192     **/
111193    function setImageRenderingIntent($rendering_intent){}
111194
111195    /**
111196     * Sets the image resolution
111197     *
111198     * @param float $x_resolution
111199     * @param float $y_resolution
111200     * @return bool
111201     * @since PECL imagick 2.0.0
111202     **/
111203    function setImageResolution($x_resolution, $y_resolution){}
111204
111205    /**
111206     * Sets the image scene
111207     *
111208     * @param int $scene
111209     * @return bool
111210     * @since PECL imagick 2.0.0
111211     **/
111212    function setImageScene($scene){}
111213
111214    /**
111215     * Sets the image ticks-per-second
111216     *
111217     * Adjust the amount of time that a frame of an animated image is
111218     * displayed for.
111219     *
111220     * @param int $ticks_per_second The duration for which an image should
111221     *   be displayed expressed in ticks per second.
111222     * @return bool
111223     * @since PECL imagick 2.0.0
111224     **/
111225    function setImageTicksPerSecond($ticks_per_second){}
111226
111227    /**
111228     * Sets the image type
111229     *
111230     * @param int $image_type
111231     * @return bool
111232     * @since PECL imagick 2.0.0
111233     **/
111234    function setImageType($image_type){}
111235
111236    /**
111237     * Sets the image units of resolution
111238     *
111239     * @param int $units
111240     * @return bool
111241     * @since PECL imagick 2.0.0
111242     **/
111243    function setImageUnits($units){}
111244
111245    /**
111246     * Sets the image virtual pixel method
111247     *
111248     * @param int $method
111249     * @return bool
111250     * @since PECL imagick 2.0.0
111251     **/
111252    function setImageVirtualPixelMethod($method){}
111253
111254    /**
111255     * Sets the image chromaticity white point
111256     *
111257     * @param float $x
111258     * @param float $y
111259     * @return bool
111260     * @since PECL imagick 2.0.0
111261     **/
111262    function setImageWhitePoint($x, $y){}
111263
111264    /**
111265     * Sets the image compression
111266     *
111267     * @param int $interlace_scheme
111268     * @return bool
111269     * @since PECL imagick 2.0.0
111270     **/
111271    function setInterlaceScheme($interlace_scheme){}
111272
111273    /**
111274     * Set the iterator position
111275     *
111276     * Set the iterator to the position in the image list specified with the
111277     * index parameter.
111278     *
111279     * @param int $index The position to set the iterator to
111280     * @return bool
111281     * @since PECL imagick 2.0.0
111282     **/
111283    function setIteratorIndex($index){}
111284
111285    /**
111286     * Sets the Imagick iterator to the last image
111287     *
111288     * @return bool
111289     * @since PECL imagick 2.0.1
111290     **/
111291    function setLastIterator(){}
111292
111293    /**
111294     * Set an option
111295     *
111296     * Associates one or more options with the wand.
111297     *
111298     * @param string $key
111299     * @param string $value
111300     * @return bool
111301     * @since PECL imagick 2.0.0
111302     **/
111303    function setOption($key, $value){}
111304
111305    /**
111306     * Sets the page geometry of the Imagick object
111307     *
111308     * @param int $width
111309     * @param int $height
111310     * @param int $x
111311     * @param int $y
111312     * @return bool
111313     * @since PECL imagick 2.0.0
111314     **/
111315    function setPage($width, $height, $x, $y){}
111316
111317    /**
111318     * Sets point size
111319     *
111320     * Sets object's point size property. This method can be used for example
111321     * to set font size for caption: pseudo-format.
111322     *
111323     * @param float $point_size Point size
111324     * @return bool
111325     * @since PECL imagick 2.1.0
111326     **/
111327    function setPointSize($point_size){}
111328
111329    /**
111330     * Set a callback that will be called during the processing of the
111331     * Imagick image.
111332     *
111333     * @param callable $callback The progress function to call. It should
111334     *   return true if image processing should continue, or false if it
111335     *   should be cancelled. The offset parameter indicates the progress and
111336     *   the span parameter indicates the total amount of work needed to be
111337     *   done.
111338     * @return bool
111339     **/
111340    public function setProgressMonitor($callback){}
111341
111342    /**
111343     * Sets the ImageMagick registry entry named key to value. This is most
111344     * useful for setting "temporary-path" which controls where ImageMagick
111345     * creates temporary images e.g. while processing PDFs.
111346     *
111347     * @param string $key
111348     * @param string $value
111349     * @return bool
111350     **/
111351    public static function setRegistry($key, $value){}
111352
111353    /**
111354     * Sets the image resolution
111355     *
111356     * @param float $x_resolution The horizontal resolution.
111357     * @param float $y_resolution The vertical resolution.
111358     * @return bool
111359     * @since PECL imagick 2.0.0
111360     **/
111361    function setResolution($x_resolution, $y_resolution){}
111362
111363    /**
111364     * Sets the limit for a particular resource
111365     *
111366     * This method is used to modify the resource limits of the underlying
111367     * ImageMagick library.
111368     *
111369     * @param int $type Refer to the list of resourcetype constants.
111370     * @param int $limit One of the resourcetype constants. The unit
111371     *   depends on the type of the resource being limited.
111372     * @return bool
111373     * @since PECL imagick 2.0.0
111374     **/
111375    function setResourceLimit($type, $limit){}
111376
111377    /**
111378     * Sets the image sampling factors
111379     *
111380     * @param array $factors
111381     * @return bool
111382     * @since PECL imagick 2.0.0
111383     **/
111384    function setSamplingFactors($factors){}
111385
111386    /**
111387     * Sets the size of the Imagick object
111388     *
111389     * Sets the size of the Imagick object. Set it before you read a raw
111390     * image format such as RGB, GRAY, or CMYK.
111391     *
111392     * @param int $columns
111393     * @param int $rows
111394     * @return bool
111395     * @since PECL imagick 2.0.0
111396     **/
111397    function setSize($columns, $rows){}
111398
111399    /**
111400     * Sets the size and offset of the Imagick object
111401     *
111402     * Sets the size and offset of the Imagick object. Set it before you read
111403     * a raw image format such as RGB, GRAY, or CMYK.
111404     *
111405     * @param int $columns The width in pixels.
111406     * @param int $rows The height in pixels.
111407     * @param int $offset The image offset.
111408     * @return bool
111409     * @since PECL imagick 2.0.0
111410     **/
111411    function setSizeOffset($columns, $rows, $offset){}
111412
111413    /**
111414     * Sets the image type attribute
111415     *
111416     * @param int $image_type
111417     * @return bool
111418     * @since PECL imagick 2.0.0
111419     **/
111420    function setType($image_type){}
111421
111422    /**
111423     * Creates a 3D effect
111424     *
111425     * Shines a distant light on an image to create a three-dimensional
111426     * effect. You control the positioning of the light with azimuth and
111427     * elevation; azimuth is measured in degrees off the x axis and elevation
111428     * is measured in pixels above the Z axis.
111429     *
111430     * @param bool $gray A value other than zero shades the intensity of
111431     *   each pixel.
111432     * @param float $azimuth Defines the light source direction.
111433     * @param float $elevation Defines the light source direction.
111434     * @return bool
111435     * @since PECL imagick 2.0.0
111436     **/
111437    function shadeImage($gray, $azimuth, $elevation){}
111438
111439    /**
111440     * Simulates an image shadow
111441     *
111442     * @param float $opacity
111443     * @param float $sigma
111444     * @param int $x
111445     * @param int $y
111446     * @return bool
111447     * @since PECL imagick 2.0.0
111448     **/
111449    function shadowImage($opacity, $sigma, $x, $y){}
111450
111451    /**
111452     * Sharpens an image
111453     *
111454     * Sharpens an image. We convolve the image with a Gaussian operator of
111455     * the given radius and standard deviation (sigma). For reasonable
111456     * results, the radius should be larger than sigma. Use a radius of 0 and
111457     * {@link Imagick::sharpenImage} selects a suitable radius for you.
111458     *
111459     * @param float $radius
111460     * @param float $sigma
111461     * @param int $channel
111462     * @return bool
111463     * @since PECL imagick 2.0.0
111464     **/
111465    function sharpenImage($radius, $sigma, $channel){}
111466
111467    /**
111468     * Shaves pixels from the image edges
111469     *
111470     * Shaves pixels from the image edges. It allocates the memory necessary
111471     * for the new Image structure and returns a pointer to the new image.
111472     *
111473     * @param int $columns
111474     * @param int $rows
111475     * @return bool
111476     * @since PECL imagick 2.0.0
111477     **/
111478    function shaveImage($columns, $rows){}
111479
111480    /**
111481     * Creating a parallelogram
111482     *
111483     * Slides one edge of an image along the X or Y axis, creating a
111484     * parallelogram. An X direction shear slides an edge along the X axis,
111485     * while a Y direction shear slides an edge along the Y axis. The amount
111486     * of the shear is controlled by a shear angle. For X direction shears,
111487     * x_shear is measured relative to the Y axis, and similarly, for Y
111488     * direction shears y_shear is measured relative to the X axis. Empty
111489     * triangles left over from shearing the image are filled with the
111490     * background color.
111491     *
111492     * @param mixed $background The background color
111493     * @param float $x_shear The number of degrees to shear on the x axis
111494     * @param float $y_shear The number of degrees to shear on the y axis
111495     * @return bool
111496     * @since PECL imagick 2.0.0
111497     **/
111498    function shearImage($background, $x_shear, $y_shear){}
111499
111500    /**
111501     * Adjusts the contrast of an image
111502     *
111503     * Adjusts the contrast of an image with a non-linear sigmoidal contrast
111504     * algorithm. Increase the contrast of the image using a sigmoidal
111505     * transfer function without saturating highlights or shadows. Contrast
111506     * indicates how much to increase the contrast (0 is none; 3 is typical;
111507     * 20 is pushing it); mid-point indicates where midtones fall in the
111508     * resultant image (0 is white; 50 is middle-gray; 100 is black). Set
111509     * sharpen to TRUE to increase the image contrast otherwise the contrast
111510     * is reduced.
111511     *
111512     * See also ImageMagick v6 Examples - Image Transformations — Sigmoidal
111513     * Non-linearity Contrast
111514     *
111515     * @param bool $sharpen If true increase the contrast, if false
111516     *   decrease the contrast.
111517     * @param float $alpha The amount of contrast to apply. 1 is very
111518     *   little, 5 is a significant amount, 20 is extreme.
111519     * @param float $beta Where the midpoint of the gradient will be. This
111520     *   value should be in the range 0 to 1 - mutliplied by the quantum
111521     *   value for ImageMagick.
111522     * @param int $channel Which color channels the contrast will be
111523     *   applied to.
111524     * @return bool
111525     * @since PECL imagick 2.0.0
111526     **/
111527    function sigmoidalContrastImage($sharpen, $alpha, $beta, $channel){}
111528
111529    /**
111530     * Simulates a pencil sketch
111531     *
111532     * Simulates a pencil sketch. We convolve the image with a Gaussian
111533     * operator of the given radius and standard deviation (sigma). For
111534     * reasonable results, radius should be larger than sigma. Use a radius
111535     * of 0 and Imagick::sketchImage() selects a suitable radius for you.
111536     * Angle gives the angle of the blurring motion.
111537     *
111538     * @param float $radius The radius of the Gaussian, in pixels, not
111539     *   counting the center pixel
111540     * @param float $sigma The standard deviation of the Gaussian, in
111541     *   pixels.
111542     * @param float $angle Apply the effect along this angle.
111543     * @return bool
111544     * @since PECL imagick 2.0.0
111545     **/
111546    function sketchImage($radius, $sigma, $angle){}
111547
111548    /**
111549     * Takes all images from the current image pointer to the end of the
111550     * image list and smushs them to each other top-to-bottom if the stack
111551     * parameter is true, otherwise left-to-right.
111552     *
111553     * @param bool $stack
111554     * @param int $offset
111555     * @return Imagick The new smushed image.
111556     **/
111557    public function smushImages($stack, $offset){}
111558
111559    /**
111560     * Applies a solarizing effect to the image
111561     *
111562     * Applies a special effect to the image, similar to the effect achieved
111563     * in a photo darkroom by selectively exposing areas of photo sensitive
111564     * paper to light. Threshold ranges from 0 to QuantumRange and is a
111565     * measure of the extent of the solarization.
111566     *
111567     * @param int $threshold
111568     * @return bool
111569     * @since PECL imagick 2.0.0
111570     **/
111571    function solarizeImage($threshold){}
111572
111573    /**
111574     * Interpolates colors
111575     *
111576     * Given the arguments array containing numeric values this method
111577     * interpolates the colors found at those coordinates across the whole
111578     * image using {@link sparse_method}.
111579     *
111580     * @param int $SPARSE_METHOD Refer to this list of sparse method
111581     *   constants
111582     * @param array $arguments An array containing the coordinates. The
111583     *   array is in format array(1,1, 2,45)
111584     * @param int $channel
111585     * @return bool
111586     **/
111587    public function sparseColorImage($SPARSE_METHOD, $arguments, $channel){}
111588
111589    /**
111590     * Splices a solid color into the image
111591     *
111592     * @param int $width
111593     * @param int $height
111594     * @param int $x
111595     * @param int $y
111596     * @return bool
111597     * @since PECL imagick 2.0.0
111598     **/
111599    function spliceImage($width, $height, $x, $y){}
111600
111601    /**
111602     * Randomly displaces each pixel in a block
111603     *
111604     * Special effects method that randomly displaces each pixel in a block
111605     * defined by the radius parameter.
111606     *
111607     * @param float $radius
111608     * @return bool
111609     * @since PECL imagick 2.0.0
111610     **/
111611    function spreadImage($radius){}
111612
111613    /**
111614     * Replace each pixel with corresponding statistic from the neighborhood
111615     * of the specified width and height.
111616     *
111617     * @param int $type
111618     * @param int $width
111619     * @param int $height
111620     * @param int $channel
111621     * @return bool
111622     **/
111623    public function statisticImage($type, $width, $height, $channel){}
111624
111625    /**
111626     * Hides a digital watermark within the image
111627     *
111628     * Hides a digital watermark within the image. Recover the hidden
111629     * watermark later to prove that the authenticity of an image. Offset
111630     * defines the start position within the image to hide the watermark.
111631     *
111632     * @param Imagick $watermark_wand
111633     * @param int $offset
111634     * @return Imagick
111635     * @since PECL imagick 2.0.0
111636     **/
111637    function steganoImage($watermark_wand, $offset){}
111638
111639    /**
111640     * Composites two images
111641     *
111642     * Composites two images and produces a single image that is the
111643     * composite of a left and right image of a stereo pair.
111644     *
111645     * @param Imagick $offset_wand
111646     * @return bool
111647     * @since PECL imagick 2.0.0
111648     **/
111649    function stereoImage($offset_wand){}
111650
111651    /**
111652     * Strips an image of all profiles and comments
111653     *
111654     * @return bool
111655     * @since PECL imagick 2.0.0
111656     **/
111657    function stripImage(){}
111658
111659    /**
111660     * Searches for a subimage in the current image and returns a similarity
111661     * image such that an exact match location is completely white and if
111662     * none of the pixels match, black, otherwise some gray level in-between.
111663     * You can also pass in the optional parameters bestMatch and similarity.
111664     * After calling the function similarity will be set to the 'score' of
111665     * the similarity between the subimage and the matching position in the
111666     * larger image, bestMatch will contain an associative array with
111667     * elements x, y, width, height that describe the matching region.
111668     *
111669     * @param Imagick $Imagick
111670     * @param array $offset
111671     * @param float $similarity A new image that displays the amount of
111672     *   similarity at each pixel.
111673     * @return Imagick
111674     **/
111675    public function subImageMatch($Imagick, &$offset, &$similarity){}
111676
111677    /**
111678     * Swirls the pixels about the center of the image
111679     *
111680     * Swirls the pixels about the center of the image, where degrees
111681     * indicates the sweep of the arc through which each pixel is moved. You
111682     * get a more dramatic effect as the degrees move from 1 to 360.
111683     *
111684     * @param float $degrees
111685     * @return bool
111686     * @since PECL imagick 2.0.0
111687     **/
111688    function swirlImage($degrees){}
111689
111690    /**
111691     * Repeatedly tiles the texture image
111692     *
111693     * Repeatedly tiles the texture image across and down the image canvas.
111694     *
111695     * @param Imagick $texture_wand Imagick object to use as texture image
111696     * @return Imagick Returns a new Imagick object that has the repeated
111697     *   texture applied.
111698     * @since PECL imagick 2.0.0
111699     **/
111700    function textureImage($texture_wand){}
111701
111702    /**
111703     * Changes the value of individual pixels based on a threshold
111704     *
111705     * Changes the value of individual pixels based on the intensity of each
111706     * pixel compared to threshold. The result is a high-contrast, two color
111707     * image.
111708     *
111709     * @param float $threshold
111710     * @param int $channel
111711     * @return bool
111712     * @since PECL imagick 2.0.0
111713     **/
111714    function thresholdImage($threshold, $channel){}
111715
111716    /**
111717     * Changes the size of an image
111718     *
111719     * Changes the size of an image to the given dimensions and removes any
111720     * associated profiles. The goal is to produce small, low cost thumbnail
111721     * images suited for display on the Web.
111722     *
111723     * If TRUE is given as a third parameter then columns and rows parameters
111724     * are used as maximums for each side. Both sides will be scaled down
111725     * until they match or are smaller than the parameter given for the side.
111726     *
111727     * @param int $columns Image width
111728     * @param int $rows Image height
111729     * @param bool $bestfit Whether to force maximum values
111730     * @param bool $fill
111731     * @param bool $legacy
111732     * @return bool
111733     * @since PECL imagick 2.0.0
111734     **/
111735    function thumbnailImage($columns, $rows, $bestfit, $fill, $legacy){}
111736
111737    /**
111738     * Applies a color vector to each pixel in the image
111739     *
111740     * Applies a color vector to each pixel in the image. The length of the
111741     * vector is 0 for black and white and at its maximum for the midtones.
111742     * The vector weighing function is f(x)=(1-(4.0*((x-0.5)*(x-0.5)))).
111743     *
111744     * @param mixed $tint
111745     * @param mixed $opacity
111746     * @param bool $legacy
111747     * @return bool
111748     * @since PECL imagick 2.0.0
111749     **/
111750    function tintImage($tint, $opacity, $legacy){}
111751
111752    /**
111753     * Convenience method for setting crop size and the image geometry
111754     *
111755     * A convenience method for setting crop size and the image geometry from
111756     * strings.
111757     *
111758     * @param string $crop A crop geometry string. This geometry defines a
111759     *   subregion of the image to crop.
111760     * @param string $geometry An image geometry string. This geometry
111761     *   defines the final size of the image.
111762     * @return Imagick Returns an Imagick object containing the transformed
111763     *   image.
111764     * @since PECL imagick 2.0.0
111765     **/
111766    function transformImage($crop, $geometry){}
111767
111768    /**
111769     * Transforms an image to a new colorspace
111770     *
111771     * @param int $colorspace The colorspace the image should be
111772     *   transformed to, one of the COLORSPACE constants e.g.
111773     *   Imagick::COLORSPACE_CMYK.
111774     * @return bool
111775     **/
111776    function transformImageColorspace($colorspace){}
111777
111778    /**
111779     * Paints pixels transparent
111780     *
111781     * Paints pixels matching the target color transparent.
111782     *
111783     * @param mixed $target The target color to paint
111784     * @param float $alpha
111785     * @param float $fuzz
111786     * @param bool $invert If TRUE paints any pixel that does not match the
111787     *   target color.
111788     * @return bool
111789     **/
111790    function transparentPaintImage($target, $alpha, $fuzz, $invert){}
111791
111792    /**
111793     * Creates a vertical mirror image
111794     *
111795     * Creates a vertical mirror image by reflecting the pixels around the
111796     * central x-axis while rotating them 90-degrees.
111797     *
111798     * @return bool
111799     * @since PECL imagick 2.0.0
111800     **/
111801    function transposeImage(){}
111802
111803    /**
111804     * Creates a horizontal mirror image
111805     *
111806     * Creates a horizontal mirror image by reflecting the pixels around the
111807     * central y-axis while rotating them 270-degrees.
111808     *
111809     * @return bool
111810     * @since PECL imagick 2.0.0
111811     **/
111812    function transverseImage(){}
111813
111814    /**
111815     * Remove edges from the image
111816     *
111817     * Remove edges that are the background color from the image.
111818     *
111819     * @param float $fuzz By default target must match a particular pixel
111820     *   color exactly. However, in many cases two colors may differ by a
111821     *   small amount. The fuzz member of image defines how much tolerance is
111822     *   acceptable to consider two colors as the same. This parameter
111823     *   represents the variation on the quantum range.
111824     * @return bool
111825     * @since PECL imagick 2.0.0
111826     **/
111827    function trimImage($fuzz){}
111828
111829    /**
111830     * Discards all but one of any pixel color
111831     *
111832     * @return bool
111833     * @since PECL imagick 2.0.0
111834     **/
111835    function uniqueImageColors(){}
111836
111837    /**
111838     * Sharpens an image
111839     *
111840     * Sharpens an image. We convolve the image with a Gaussian operator of
111841     * the given radius and standard deviation (sigma). For reasonable
111842     * results, radius should be larger than sigma. Use a radius of 0 and
111843     * Imagick::UnsharpMaskImage() selects a suitable radius for you.
111844     *
111845     * @param float $radius
111846     * @param float $sigma
111847     * @param float $amount
111848     * @param float $threshold
111849     * @param int $channel
111850     * @return bool
111851     * @since PECL imagick 2.0.0
111852     **/
111853    function unsharpMaskImage($radius, $sigma, $amount, $threshold, $channel){}
111854
111855    /**
111856     * Checks if the current item is valid
111857     *
111858     * @return bool
111859     * @since PECL imagick 2.0.0
111860     **/
111861    function valid(){}
111862
111863    /**
111864     * Adds vignette filter to the image
111865     *
111866     * Softens the edges of the image in vignette style.
111867     *
111868     * @param float $blackPoint The black point.
111869     * @param float $whitePoint The white point
111870     * @param int $x X offset of the ellipse
111871     * @param int $y Y offset of the ellipse
111872     * @return bool
111873     * @since PECL imagick 2.0.0
111874     **/
111875    function vignetteImage($blackPoint, $whitePoint, $x, $y){}
111876
111877    /**
111878     * Applies wave filter to the image
111879     *
111880     * Applies a wave filter to the image.
111881     *
111882     * @param float $amplitude The amplitude of the wave.
111883     * @param float $length The length of the wave.
111884     * @return bool
111885     * @since PECL imagick 2.0.0
111886     **/
111887    function waveImage($amplitude, $length){}
111888
111889    /**
111890     * Force all pixels above the threshold into white
111891     *
111892     * Is like Imagick::ThresholdImage() but force all pixels above the
111893     * threshold into white while leaving all pixels below the threshold
111894     * unchanged.
111895     *
111896     * @param mixed $threshold
111897     * @return bool
111898     * @since PECL imagick 2.0.0
111899     **/
111900    function whiteThresholdImage($threshold){}
111901
111902    /**
111903     * Writes an image to the specified filename
111904     *
111905     * Writes an image to the specified filename. If the filename parameter
111906     * is NULL, the image is written to the filename set by
111907     * Imagick::readImage() or Imagick::setImageFilename().
111908     *
111909     * @param string $filename Filename where to write the image. The
111910     *   extension of the filename defines the type of the file. Format can
111911     *   be forced regardless of file extension using format: prefix, for
111912     *   example "jpg:test.png".
111913     * @return bool
111914     **/
111915    function writeImage($filename){}
111916
111917    /**
111918     * Writes an image to a filehandle
111919     *
111920     * Writes the image sequence to an open filehandle. The handle must be
111921     * opened with for example fopen.
111922     *
111923     * @param resource $filehandle Filehandle where to write the image
111924     * @param string $format
111925     * @return bool
111926     **/
111927    function writeImageFile($filehandle, $format){}
111928
111929    /**
111930     * Writes an image or image sequence
111931     *
111932     * @param string $filename
111933     * @param bool $adjoin
111934     * @return bool
111935     **/
111936    function writeImages($filename, $adjoin){}
111937
111938    /**
111939     * Writes frames to a filehandle
111940     *
111941     * Writes all image frames into an open filehandle. This method can be
111942     * used to write animated gifs or other multiframe images into open
111943     * filehandle.
111944     *
111945     * @param resource $filehandle Filehandle where to write the images
111946     * @param string $format
111947     * @return bool
111948     **/
111949    function writeImagesFile($filehandle, $format){}
111950
111951    /**
111952     * The Imagick constructor
111953     *
111954     * Creates an Imagick instance for a specified image or set of images.
111955     *
111956     * @param mixed $files The path to an image to load or an array of
111957     *   paths. Paths can include wildcards for file names, or can be URLs.
111958     **/
111959    function __construct($files){}
111960
111961    /**
111962     * Returns the image as a string
111963     *
111964     * Returns the current image as string. This will only return a single
111965     * image; it should not be used for Imagick objects that contain multiple
111966     * images e.g. an animated GIF or PDF with multiple pages.
111967     *
111968     * @return string Returns the string content on success or an empty
111969     *   string on failure.
111970     **/
111971    function __toString(){}
111972
111973}
111974class ImagickDraw {
111975    /**
111976     * Adjusts the current affine transformation matrix
111977     *
111978     * Adjusts the current affine transformation matrix with the specified
111979     * affine transformation matrix.
111980     *
111981     * @param array $affine Affine matrix parameters
111982     * @return bool
111983     * @since PECL imagick 2.0.0
111984     **/
111985    function affine($affine){}
111986
111987    /**
111988     * Draws text on the image
111989     *
111990     * @param float $x The x coordinate where text is drawn
111991     * @param float $y The y coordinate where text is drawn
111992     * @param string $text The text to draw on the image
111993     * @return bool
111994     * @since PECL imagick 2.0.0
111995     **/
111996    function annotation($x, $y, $text){}
111997
111998    /**
111999     * Draws an arc
112000     *
112001     * Draws an arc falling within a specified bounding rectangle on the
112002     * image.
112003     *
112004     * @param float $sx Starting x ordinate of bounding rectangle
112005     * @param float $sy starting y ordinate of bounding rectangle
112006     * @param float $ex ending x ordinate of bounding rectangle
112007     * @param float $ey ending y ordinate of bounding rectangle
112008     * @param float $sd starting degrees of rotation
112009     * @param float $ed ending degrees of rotation
112010     * @return bool
112011     * @since PECL imagick 2.0.0
112012     **/
112013    function arc($sx, $sy, $ex, $ey, $sd, $ed){}
112014
112015    /**
112016     * Draws a bezier curve
112017     *
112018     * Draws a bezier curve through a set of points on the image.
112019     *
112020     * @param array $coordinates Multidimensional array like array( array(
112021     *   'x' => 1, 'y' => 2 ), array( 'x' => 3, 'y' => 4 ) )
112022     * @return bool
112023     * @since PECL imagick 2.0.0
112024     **/
112025    function bezier($coordinates){}
112026
112027    /**
112028     * Draws a circle
112029     *
112030     * Draws a circle on the image.
112031     *
112032     * @param float $ox origin x coordinate
112033     * @param float $oy origin y coordinate
112034     * @param float $px perimeter x coordinate
112035     * @param float $py perimeter y coordinate
112036     * @return bool
112037     * @since PECL imagick 2.0.0
112038     **/
112039    function circle($ox, $oy, $px, $py){}
112040
112041    /**
112042     * Clears the ImagickDraw
112043     *
112044     * Clears the ImagickDraw object of any accumulated commands, and resets
112045     * the settings it contains to their defaults.
112046     *
112047     * @return bool Returns an ImagickDraw object.
112048     * @since PECL imagick 2.0.0
112049     **/
112050    function clear(){}
112051
112052    /**
112053     * Draws color on image
112054     *
112055     * Draws color on image using the current fill color, starting at
112056     * specified position, and using specified paint method.
112057     *
112058     * @param float $x x coordinate of the paint
112059     * @param float $y y coordinate of the paint
112060     * @param int $paintMethod one of the PAINT_ constants
112061     * @return bool
112062     * @since PECL imagick 2.0.0
112063     **/
112064    function color($x, $y, $paintMethod){}
112065
112066    /**
112067     * Adds a comment
112068     *
112069     * Adds a comment to a vector output stream.
112070     *
112071     * @param string $comment The comment string to add to vector output
112072     *   stream
112073     * @return bool
112074     * @since PECL imagick 2.0.0
112075     **/
112076    function comment($comment){}
112077
112078    /**
112079     * Composites an image onto the current image
112080     *
112081     * Composites an image onto the current image, using the specified
112082     * composition operator, specified position, and at the specified size.
112083     *
112084     * @param int $compose composition operator. One of COMPOSITE_
112085     *   constants
112086     * @param float $x x coordinate of the top left corner
112087     * @param float $y y coordinate of the top left corner
112088     * @param float $width width of the composition image
112089     * @param float $height height of the composition image
112090     * @param Imagick $compositeWand the Imagick object where composition
112091     *   image is taken from
112092     * @return bool
112093     * @since PECL imagick 2.0.0
112094     **/
112095    function composite($compose, $x, $y, $width, $height, $compositeWand){}
112096
112097    /**
112098     * Frees all associated resources
112099     *
112100     * Frees all resources associated with the ImagickDraw object.
112101     *
112102     * @return bool
112103     * @since PECL imagick 2.0.0
112104     **/
112105    function destroy(){}
112106
112107    /**
112108     * Draws an ellipse on the image
112109     *
112110     * @param float $ox
112111     * @param float $oy
112112     * @param float $rx
112113     * @param float $ry
112114     * @param float $start
112115     * @param float $end
112116     * @return bool
112117     * @since PECL imagick 2.0.0
112118     **/
112119    function ellipse($ox, $oy, $rx, $ry, $start, $end){}
112120
112121    /**
112122     * Obtains the current clipping path ID
112123     *
112124     * @return string Returns a string containing the clip path ID or false
112125     *   if no clip path exists.
112126     * @since PECL imagick 2.0.0
112127     **/
112128    function getClipPath(){}
112129
112130    /**
112131     * Returns the current polygon fill rule
112132     *
112133     * Returns the current polygon fill rule to be used by the clipping path.
112134     *
112135     * @return int Returns one of the FILLRULE_ constants.
112136     * @since PECL imagick 2.0.0
112137     **/
112138    function getClipRule(){}
112139
112140    /**
112141     * Returns the interpretation of clip path units
112142     *
112143     * @return int Returns an int on success.
112144     * @since PECL imagick 2.0.0
112145     **/
112146    function getClipUnits(){}
112147
112148    /**
112149     * Returns the fill color
112150     *
112151     * Returns the fill color used for drawing filled objects.
112152     *
112153     * @return ImagickPixel Returns an ImagickPixel object.
112154     * @since PECL imagick 2.0.0
112155     **/
112156    function getFillColor(){}
112157
112158    /**
112159     * Returns the opacity used when drawing
112160     *
112161     * Returns the opacity used when drawing using the fill color or fill
112162     * texture. Fully opaque is 1.0.
112163     *
112164     * @return float The opacity.
112165     * @since PECL imagick 2.0.0
112166     **/
112167    function getFillOpacity(){}
112168
112169    /**
112170     * Returns the fill rule
112171     *
112172     * Returns the fill rule used while drawing polygons.
112173     *
112174     * @return int Returns a FILLRULE_ constant
112175     * @since PECL imagick 2.0.0
112176     **/
112177    function getFillRule(){}
112178
112179    /**
112180     * Returns the font
112181     *
112182     * Returns a string specifying the font used when annotating with text.
112183     *
112184     * @return string Returns a string on success and false if no font is
112185     *   set.
112186     * @since PECL imagick 2.0.0
112187     **/
112188    function getFont(){}
112189
112190    /**
112191     * Returns the font family
112192     *
112193     * Returns the font family to use when annotating with text.
112194     *
112195     * @return string Returns the font family currently selected or false
112196     *   if font family is not set.
112197     * @since PECL imagick 2.0.0
112198     **/
112199    function getFontFamily(){}
112200
112201    /**
112202     * Returns the font pointsize
112203     *
112204     * Returns the font pointsize used when annotating with text.
112205     *
112206     * @return float Returns the font size associated with the current
112207     *   ImagickDraw object.
112208     * @since PECL imagick 2.0.0
112209     **/
112210    function getFontSize(){}
112211
112212    /**
112213     * Gets the font stretch to use when annotating with text. Returns a
112214     * StretchType.
112215     *
112216     * @return int
112217     **/
112218    public function getFontStretch(){}
112219
112220    /**
112221     * Returns the font style
112222     *
112223     * Returns the font style used when annotating with text.
112224     *
112225     * @return int Returns the font style constant (STYLE_) associated with
112226     *   the ImagickDraw object or 0 if no style is set.
112227     * @since PECL imagick 2.0.0
112228     **/
112229    function getFontStyle(){}
112230
112231    /**
112232     * Returns the font weight
112233     *
112234     * Returns the font weight used when annotating with text.
112235     *
112236     * @return int Returns an int on success and 0 if no weight is set.
112237     * @since PECL imagick 2.0.0
112238     **/
112239    function getFontWeight(){}
112240
112241    /**
112242     * Returns the text placement gravity
112243     *
112244     * Returns the text placement gravity used when annotating with text.
112245     *
112246     * @return int Returns a GRAVITY_ constant on success and 0 if no
112247     *   gravity is set.
112248     * @since PECL imagick 2.0.0
112249     **/
112250    function getGravity(){}
112251
112252    /**
112253     * Returns the current stroke antialias setting
112254     *
112255     * Returns the current stroke antialias setting. Stroked outlines are
112256     * antialiased by default. When antialiasing is disabled stroked pixels
112257     * are thresholded to determine if the stroke color or underlying canvas
112258     * color should be used.
112259     *
112260     * @return bool Returns TRUE if antialiasing is on and false if it is
112261     *   off.
112262     * @since PECL imagick 2.0.0
112263     **/
112264    function getStrokeAntialias(){}
112265
112266    /**
112267     * Returns the color used for stroking object outlines
112268     *
112269     * @return ImagickPixel Returns an ImagickPixel object which describes
112270     *   the color.
112271     * @since PECL imagick 2.0.0
112272     **/
112273    function getStrokeColor(){}
112274
112275    /**
112276     * Returns an array representing the pattern of dashes and gaps used to
112277     * stroke paths
112278     *
112279     * Returns an array representing the pattern of dashes and gaps used to
112280     * stroke paths.
112281     *
112282     * @return array Returns an array on success and empty array if not
112283     *   set.
112284     * @since PECL imagick 2.0.0
112285     **/
112286    function getStrokeDashArray(){}
112287
112288    /**
112289     * Returns the offset into the dash pattern to start the dash
112290     *
112291     * @return float Returns a float representing the offset and 0 if it's
112292     *   not set.
112293     * @since PECL imagick 2.0.0
112294     **/
112295    function getStrokeDashOffset(){}
112296
112297    /**
112298     * Returns the shape to be used at the end of open subpaths when they are
112299     * stroked
112300     *
112301     * Returns the shape to be used at the end of open subpaths when they are
112302     * stroked.
112303     *
112304     * @return int Returns one of the LINECAP_ constants or 0 if stroke
112305     *   linecap is not set.
112306     * @since PECL imagick 2.0.0
112307     **/
112308    function getStrokeLineCap(){}
112309
112310    /**
112311     * Returns the shape to be used at the corners of paths when they are
112312     * stroked
112313     *
112314     * Returns the shape to be used at the corners of paths (or other vector
112315     * shapes) when they are stroked.
112316     *
112317     * @return int Returns one of the LINEJOIN_ constants or 0 if stroke
112318     *   line join is not set.
112319     * @since PECL imagick 2.0.0
112320     **/
112321    function getStrokeLineJoin(){}
112322
112323    /**
112324     * Returns the stroke miter limit
112325     *
112326     * Returns the miter limit. When two line segments meet at a sharp angle
112327     * and miter joins have been specified for 'lineJoin', it is possible for
112328     * the miter to extend far beyond the thickness of the line stroking the
112329     * path. The 'miterLimit' imposes a limit on the ratio of the miter
112330     * length to the 'lineWidth'.
112331     *
112332     * @return int Returns an int describing the miter limit and 0 if no
112333     *   miter limit is set.
112334     * @since PECL imagick 2.0.0
112335     **/
112336    function getStrokeMiterLimit(){}
112337
112338    /**
112339     * Returns the opacity of stroked object outlines
112340     *
112341     * @return float Returns a double describing the opacity.
112342     * @since PECL imagick 2.0.0
112343     **/
112344    function getStrokeOpacity(){}
112345
112346    /**
112347     * Returns the width of the stroke used to draw object outlines
112348     *
112349     * @return float Returns a double describing the stroke width.
112350     * @since PECL imagick 2.0.0
112351     **/
112352    function getStrokeWidth(){}
112353
112354    /**
112355     * Returns the text alignment
112356     *
112357     * Returns the alignment applied when annotating with text.
112358     *
112359     * @return int Returns one of the ALIGN_ constants and 0 if no align is
112360     *   set.
112361     * @since PECL imagick 2.0.0
112362     **/
112363    function getTextAlignment(){}
112364
112365    /**
112366     * Returns the current text antialias setting
112367     *
112368     * Returns the current text antialias setting, which determines whether
112369     * text is antialiased. Text is antialiased by default.
112370     *
112371     * @return bool Returns TRUE if text is antialiased and false if not.
112372     * @since PECL imagick 2.0.0
112373     **/
112374    function getTextAntialias(){}
112375
112376    /**
112377     * Returns the text decoration
112378     *
112379     * Returns the decoration applied when annotating with text.
112380     *
112381     * @return int Returns one of the DECORATION_ constants and 0 if no
112382     *   decoration is set.
112383     * @since PECL imagick 2.0.0
112384     **/
112385    function getTextDecoration(){}
112386
112387    /**
112388     * Returns the code set used for text annotations
112389     *
112390     * Returns a string which specifies the code set used for text
112391     * annotations.
112392     *
112393     * @return string Returns a string specifying the code set or false if
112394     *   text encoding is not set.
112395     * @since PECL imagick 2.0.0
112396     **/
112397    function getTextEncoding(){}
112398
112399    /**
112400     * Gets the text interword spacing.
112401     *
112402     * @return float
112403     **/
112404    public function getTextInterlineSpacing(){}
112405
112406    /**
112407     * Gets the text interword spacing.
112408     *
112409     * @return float
112410     **/
112411    public function getTextInterwordSpacing(){}
112412
112413    /**
112414     * Gets the text kerning.
112415     *
112416     * @return float
112417     **/
112418    public function getTextKerning(){}
112419
112420    /**
112421     * Returns the text under color
112422     *
112423     * Returns the color of a background rectangle to place under text
112424     * annotations.
112425     *
112426     * @return ImagickPixel Returns an ImagickPixel object describing the
112427     *   color.
112428     * @since PECL imagick 2.0.0
112429     **/
112430    function getTextUnderColor(){}
112431
112432    /**
112433     * Returns a string containing vector graphics
112434     *
112435     * Returns a string which specifies the vector graphics generated by any
112436     * graphics calls made since the ImagickDraw object was instantiated.
112437     *
112438     * @return string Returns a string containing the vector graphics.
112439     * @since PECL imagick 2.0.0
112440     **/
112441    function getVectorGraphics(){}
112442
112443    /**
112444     * Draws a line
112445     *
112446     * Draws a line on the image using the current stroke color, stroke
112447     * opacity, and stroke width.
112448     *
112449     * @param float $sx starting x coordinate
112450     * @param float $sy starting y coordinate
112451     * @param float $ex ending x coordinate
112452     * @param float $ey ending y coordinate
112453     * @return bool
112454     * @since PECL imagick 2.0.0
112455     **/
112456    function line($sx, $sy, $ex, $ey){}
112457
112458    /**
112459     * Paints on the image's opacity channel
112460     *
112461     * Paints on the image's opacity channel in order to set effected pixels
112462     * to transparent, to influence the opacity of pixels.
112463     *
112464     * @param float $x x coordinate of the matte
112465     * @param float $y y coordinate of the matte
112466     * @param int $paintMethod PAINT_ constant
112467     * @return bool
112468     * @since PECL imagick 2.0.0
112469     **/
112470    function matte($x, $y, $paintMethod){}
112471
112472    /**
112473     * Adds a path element to the current path
112474     *
112475     * Adds a path element to the current path which closes the current
112476     * subpath by drawing a straight line from the current point to the
112477     * current subpath's most recent starting point (usually, the most recent
112478     * moveto point).
112479     *
112480     * @return bool
112481     * @since PECL imagick 2.0.0
112482     **/
112483    function pathClose(){}
112484
112485    /**
112486     * Draws a cubic Bezier curve
112487     *
112488     * Draws a cubic Bezier curve from the current point to (x,y) using
112489     * (x1,y1) as the control point at the beginning of the curve and (x2,y2)
112490     * as the control point at the end of the curve using absolute
112491     * coordinates. At the end of the command, the new current point becomes
112492     * the final (x,y) coordinate pair used in the polybezier.
112493     *
112494     * @param float $x1 x coordinate of the first control point
112495     * @param float $y1 y coordinate of the first control point
112496     * @param float $x2 x coordinate of the second control point
112497     * @param float $y2 y coordinate of the first control point
112498     * @param float $x x coordinate of the curve end
112499     * @param float $y y coordinate of the curve end
112500     * @return bool
112501     * @since PECL imagick 2.0.0
112502     **/
112503    function pathCurveToAbsolute($x1, $y1, $x2, $y2, $x, $y){}
112504
112505    /**
112506     * Draws a quadratic Bezier curve
112507     *
112508     * Draws a quadratic Bezier curve from the current point to (x,y) using
112509     * (x1,y1) as the control point using absolute coordinates. At the end of
112510     * the command, the new current point becomes the final (x,y) coordinate
112511     * pair used in the polybezier.
112512     *
112513     * @param float $x1 x coordinate of the control point
112514     * @param float $y1 y coordinate of the control point
112515     * @param float $x x coordinate of the end point
112516     * @param float $y y coordinate of the end point
112517     * @return bool
112518     * @since PECL imagick 2.0.0
112519     **/
112520    function pathCurveToQuadraticBezierAbsolute($x1, $y1, $x, $y){}
112521
112522    /**
112523     * Draws a quadratic Bezier curve
112524     *
112525     * Draws a quadratic Bezier curve from the current point to (x,y) using
112526     * (x1,y1) as the control point using relative coordinates. At the end of
112527     * the command, the new current point becomes the final (x,y) coordinate
112528     * pair used in the polybezier.
112529     *
112530     * @param float $x1 starting x coordinate
112531     * @param float $y1 starting y coordinate
112532     * @param float $x ending x coordinate
112533     * @param float $y ending y coordinate
112534     * @return bool
112535     * @since PECL imagick 2.0.0
112536     **/
112537    function pathCurveToQuadraticBezierRelative($x1, $y1, $x, $y){}
112538
112539    /**
112540     * Draws a quadratic Bezier curve
112541     *
112542     * Draws a quadratic Bezier curve (using absolute coordinates) from the
112543     * current point to (x,y). The control point is assumed to be the
112544     * reflection of the control point on the previous command relative to
112545     * the current point. (If there is no previous command or if the previous
112546     * command was not a DrawPathCurveToQuadraticBezierAbsolute,
112547     * DrawPathCurveToQuadraticBezierRelative,
112548     * DrawPathCurveToQuadraticBezierSmoothAbsolut or
112549     * DrawPathCurveToQuadraticBezierSmoothRelative, assume the control point
112550     * is coincident with the current point.). At the end of the command, the
112551     * new current point becomes the final (x,y) coordinate pair used in the
112552     * polybezier.
112553     *
112554     * This function cannot be used to continue a cubic Bezier curve
112555     * smoothly. It can only continue from a quadratic curve smoothly.
112556     *
112557     * @param float $x ending x coordinate
112558     * @param float $y ending y coordinate
112559     * @return bool
112560     * @since PECL imagick 2.0.0
112561     **/
112562    function pathCurveToQuadraticBezierSmoothAbsolute($x, $y){}
112563
112564    /**
112565     * Draws a quadratic Bezier curve
112566     *
112567     * Draws a quadratic Bezier curve (using relative coordinates) from the
112568     * current point to (x, y). The control point is assumed to be the
112569     * reflection of the control point on the previous command relative to
112570     * the current point. (If there is no previous command or if the previous
112571     * command was not a DrawPathCurveToQuadraticBezierAbsolute,
112572     * DrawPathCurveToQuadraticBezierRelative,
112573     * DrawPathCurveToQuadraticBezierSmoothAbsolut or
112574     * DrawPathCurveToQuadraticBezierSmoothRelative, assume the control point
112575     * is coincident with the current point). At the end of the command, the
112576     * new current point becomes the final (x, y) coordinate pair used in the
112577     * polybezier.
112578     *
112579     * This function cannot be used to continue a cubic Bezier curve
112580     * smoothly. It can only continue from a quadratic curve smoothly.
112581     *
112582     * @param float $x ending x coordinate
112583     * @param float $y ending y coordinate
112584     * @return bool
112585     * @since PECL imagick 2.0.0
112586     **/
112587    function pathCurveToQuadraticBezierSmoothRelative($x, $y){}
112588
112589    /**
112590     * Draws a cubic Bezier curve
112591     *
112592     * Draws a cubic Bezier curve from the current point to (x,y) using
112593     * (x1,y1) as the control point at the beginning of the curve and (x2,y2)
112594     * as the control point at the end of the curve using relative
112595     * coordinates. At the end of the command, the new current point becomes
112596     * the final (x,y) coordinate pair used in the polybezier.
112597     *
112598     * @param float $x1 x coordinate of starting control point
112599     * @param float $y1 y coordinate of starting control point
112600     * @param float $x2 x coordinate of ending control point
112601     * @param float $y2 y coordinate of ending control point
112602     * @param float $x ending x coordinate
112603     * @param float $y ending y coordinate
112604     * @return bool
112605     * @since PECL imagick 2.0.0
112606     **/
112607    function pathCurveToRelative($x1, $y1, $x2, $y2, $x, $y){}
112608
112609    /**
112610     * Draws a cubic Bezier curve
112611     *
112612     * Draws a cubic Bezier curve from the current point to (x,y) using
112613     * absolute coordinates. The first control point is assumed to be the
112614     * reflection of the second control point on the previous command
112615     * relative to the current point. (If there is no previous command or if
112616     * the previous command was not an DrawPathCurveToAbsolute,
112617     * DrawPathCurveToRelative, DrawPathCurveToSmoothAbsolute or
112618     * DrawPathCurveToSmoothRelative, assume the first control point is
112619     * coincident with the current point.) (x2,y2) is the second control
112620     * point (i.e., the control point at the end of the curve). At the end of
112621     * the command, the new current point becomes the final (x,y) coordinate
112622     * pair used in the polybezier.
112623     *
112624     * @param float $x2 x coordinate of the second control point
112625     * @param float $y2 y coordinate of the second control point
112626     * @param float $x x coordinate of the ending point
112627     * @param float $y y coordinate of the ending point
112628     * @return bool
112629     * @since PECL imagick 2.0.0
112630     **/
112631    function pathCurveToSmoothAbsolute($x2, $y2, $x, $y){}
112632
112633    /**
112634     * Draws a cubic Bezier curve
112635     *
112636     * Draws a cubic Bezier curve from the current point to (x,y) using
112637     * relative coordinates. The first control point is assumed to be the
112638     * reflection of the second control point on the previous command
112639     * relative to the current point. (If there is no previous command or if
112640     * the previous command was not an DrawPathCurveToAbsolute,
112641     * DrawPathCurveToRelative, DrawPathCurveToSmoothAbsolute or
112642     * DrawPathCurveToSmoothRelative, assume the first control point is
112643     * coincident with the current point.) (x2,y2) is the second control
112644     * point (i.e., the control point at the end of the curve). At the end of
112645     * the command, the new current point becomes the final (x,y) coordinate
112646     * pair used in the polybezier.
112647     *
112648     * @param float $x2 x coordinate of the second control point
112649     * @param float $y2 y coordinate of the second control point
112650     * @param float $x x coordinate of the ending point
112651     * @param float $y y coordinate of the ending point
112652     * @return bool
112653     * @since PECL imagick 2.0.0
112654     **/
112655    function pathCurveToSmoothRelative($x2, $y2, $x, $y){}
112656
112657    /**
112658     * Draws an elliptical arc
112659     *
112660     * Draws an elliptical arc from the current point to (x, y) using
112661     * absolute coordinates. The size and orientation of the ellipse are
112662     * defined by two radii (rx, ry) and an xAxisRotation, which indicates
112663     * how the ellipse as a whole is rotated relative to the current
112664     * coordinate system. The center (cx, cy) of the ellipse is calculated
112665     * automatically to satisfy the constraints imposed by the other
112666     * parameters. largeArcFlag and sweepFlag contribute to the automatic
112667     * calculations and help determine how the arc is drawn. If largeArcFlag
112668     * is TRUE then draw the larger of the available arcs. If sweepFlag is
112669     * true, then draw the arc matching a clock-wise rotation.
112670     *
112671     * @param float $rx x radius
112672     * @param float $ry y radius
112673     * @param float $x_axis_rotation x axis rotation
112674     * @param bool $large_arc_flag large arc flag
112675     * @param bool $sweep_flag sweep flag
112676     * @param float $x x coordinate
112677     * @param float $y y coordinate
112678     * @return bool
112679     * @since PECL imagick 2.0.0
112680     **/
112681    function pathEllipticArcAbsolute($rx, $ry, $x_axis_rotation, $large_arc_flag, $sweep_flag, $x, $y){}
112682
112683    /**
112684     * Draws an elliptical arc
112685     *
112686     * Draws an elliptical arc from the current point to (x, y) using
112687     * relative coordinates. The size and orientation of the ellipse are
112688     * defined by two radii (rx, ry) and an xAxisRotation, which indicates
112689     * how the ellipse as a whole is rotated relative to the current
112690     * coordinate system. The center (cx, cy) of the ellipse is calculated
112691     * automatically to satisfy the constraints imposed by the other
112692     * parameters. largeArcFlag and sweepFlag contribute to the automatic
112693     * calculations and help determine how the arc is drawn. If largeArcFlag
112694     * is TRUE then draw the larger of the available arcs. If sweepFlag is
112695     * true, then draw the arc matching a clock-wise rotation.
112696     *
112697     * @param float $rx x radius
112698     * @param float $ry y radius
112699     * @param float $x_axis_rotation x axis rotation
112700     * @param bool $large_arc_flag large arc flag
112701     * @param bool $sweep_flag sweep flag
112702     * @param float $x x coordinate
112703     * @param float $y y coordinate
112704     * @return bool
112705     * @since PECL imagick 2.0.0
112706     **/
112707    function pathEllipticArcRelative($rx, $ry, $x_axis_rotation, $large_arc_flag, $sweep_flag, $x, $y){}
112708
112709    /**
112710     * Terminates the current path
112711     *
112712     * @return bool
112713     * @since PECL imagick 2.0.0
112714     **/
112715    function pathFinish(){}
112716
112717    /**
112718     * Draws a line path
112719     *
112720     * Draws a line path from the current point to the given coordinate using
112721     * absolute coordinates. The coordinate then becomes the new current
112722     * point.
112723     *
112724     * @param float $x starting x coordinate
112725     * @param float $y ending x coordinate
112726     * @return bool
112727     * @since PECL imagick 2.0.0
112728     **/
112729    function pathLineToAbsolute($x, $y){}
112730
112731    /**
112732     * Draws a horizontal line path
112733     *
112734     * Draws a horizontal line path from the current point to the target
112735     * point using absolute coordinates. The target point then becomes the
112736     * new current point.
112737     *
112738     * @param float $x x coordinate
112739     * @return bool
112740     * @since PECL imagick 2.0.0
112741     **/
112742    function pathLineToHorizontalAbsolute($x){}
112743
112744    /**
112745     * Draws a horizontal line
112746     *
112747     * Draws a horizontal line path from the current point to the target
112748     * point using relative coordinates. The target point then becomes the
112749     * new current point.
112750     *
112751     * @param float $x x coordinate
112752     * @return bool
112753     * @since PECL imagick 2.0.0
112754     **/
112755    function pathLineToHorizontalRelative($x){}
112756
112757    /**
112758     * Draws a line path
112759     *
112760     * Draws a line path from the current point to the given coordinate using
112761     * relative coordinates. The coordinate then becomes the new current
112762     * point.
112763     *
112764     * @param float $x starting x coordinate
112765     * @param float $y starting y coordinate
112766     * @return bool
112767     * @since PECL imagick 2.0.0
112768     **/
112769    function pathLineToRelative($x, $y){}
112770
112771    /**
112772     * Draws a vertical line
112773     *
112774     * Draws a vertical line path from the current point to the target point
112775     * using absolute coordinates. The target point then becomes the new
112776     * current point.
112777     *
112778     * @param float $y y coordinate
112779     * @return bool
112780     * @since PECL imagick 2.0.0
112781     **/
112782    function pathLineToVerticalAbsolute($y){}
112783
112784    /**
112785     * Draws a vertical line path
112786     *
112787     * Draws a vertical line path from the current point to the target point
112788     * using relative coordinates. The target point then becomes the new
112789     * current point.
112790     *
112791     * @param float $y y coordinate
112792     * @return bool
112793     * @since PECL imagick 2.0.0
112794     **/
112795    function pathLineToVerticalRelative($y){}
112796
112797    /**
112798     * Starts a new sub-path
112799     *
112800     * Starts a new sub-path at the given coordinate using absolute
112801     * coordinates. The current point then becomes the specified coordinate.
112802     *
112803     * @param float $x x coordinate of the starting point
112804     * @param float $y y coordinate of the starting point
112805     * @return bool
112806     * @since PECL imagick 2.0.0
112807     **/
112808    function pathMoveToAbsolute($x, $y){}
112809
112810    /**
112811     * Starts a new sub-path
112812     *
112813     * Starts a new sub-path at the given coordinate using relative
112814     * coordinates. The current point then becomes the specified coordinate.
112815     *
112816     * @param float $x target x coordinate
112817     * @param float $y target y coordinate
112818     * @return bool
112819     * @since PECL imagick 2.0.0
112820     **/
112821    function pathMoveToRelative($x, $y){}
112822
112823    /**
112824     * Declares the start of a path drawing list
112825     *
112826     * Declares the start of a path drawing list which is terminated by a
112827     * matching DrawPathFinish() command. All other DrawPath commands must be
112828     * enclosed between a and a DrawPathFinish() command. This is because
112829     * path drawing commands are subordinate commands and they do not
112830     * function by themselves.
112831     *
112832     * @return bool
112833     * @since PECL imagick 2.0.0
112834     **/
112835    function pathStart(){}
112836
112837    /**
112838     * Draws a point
112839     *
112840     * Draws a point using the current stroke color and stroke thickness at
112841     * the specified coordinates.
112842     *
112843     * @param float $x point's x coordinate
112844     * @param float $y point's y coordinate
112845     * @return bool
112846     * @since PECL imagick 2.0.0
112847     **/
112848    function point($x, $y){}
112849
112850    /**
112851     * Draws a polygon
112852     *
112853     * Draws a polygon using the current stroke, stroke width, and fill color
112854     * or texture, using the specified array of coordinates.
112855     *
112856     * @param array $coordinates multidimensional array like array( array(
112857     *   'x' => 3, 'y' => 4 ), array( 'x' => 2, 'y' => 6 ) );
112858     * @return bool
112859     * @since PECL imagick 2.0.0
112860     **/
112861    function polygon($coordinates){}
112862
112863    /**
112864     * Draws a polyline
112865     *
112866     * Draws a polyline using the current stroke, stroke width, and fill
112867     * color or texture, using the specified array of coordinates.
112868     *
112869     * @param array $coordinates array of x and y coordinates: array(
112870     *   array( 'x' => 4, 'y' => 6 ), array( 'x' => 8, 'y' => 10 ) )
112871     * @return bool
112872     * @since PECL imagick 2.0.0
112873     **/
112874    function polyline($coordinates){}
112875
112876    /**
112877     * Destroys the current ImagickDraw in the stack, and returns to the
112878     * previously pushed ImagickDraw
112879     *
112880     * Destroys the current ImagickDraw in the stack, and returns to the
112881     * previously pushed ImagickDraw. Multiple ImagickDraws may exist. It is
112882     * an error to attempt to pop more ImagickDraws than have been pushed,
112883     * and it is proper form to pop all ImagickDraws which have been pushed.
112884     *
112885     * @return bool Returns TRUE on success and false on failure.
112886     * @since PECL imagick 2.0.0
112887     **/
112888    function pop(){}
112889
112890    /**
112891     * Terminates a clip path definition
112892     *
112893     * @return bool
112894     * @since PECL imagick 2.0.0
112895     **/
112896    function popClipPath(){}
112897
112898    /**
112899     * Terminates a definition list
112900     *
112901     * @return bool
112902     * @since PECL imagick 2.0.0
112903     **/
112904    function popDefs(){}
112905
112906    /**
112907     * Terminates a pattern definition
112908     *
112909     * @return bool
112910     * @since PECL imagick 2.0.0
112911     **/
112912    function popPattern(){}
112913
112914    /**
112915     * Clones the current ImagickDraw and pushes it to the stack
112916     *
112917     * Clones the current ImagickDraw to create a new ImagickDraw, which is
112918     * then added to the ImagickDraw stack. The original drawing
112919     * ImagickDraw(s) may be returned to by invoking pop(). The ImagickDraws
112920     * are stored on a ImagickDraw stack. For every Pop there must have
112921     * already been an equivalent Push.
112922     *
112923     * @return bool
112924     * @since PECL imagick 2.0.0
112925     **/
112926    function push(){}
112927
112928    /**
112929     * Starts a clip path definition
112930     *
112931     * Starts a clip path definition which is comprised of any number of
112932     * drawing commands and terminated by a ImagickDraw::popClipPath()
112933     * command.
112934     *
112935     * @param string $clip_mask_id Clip mask Id
112936     * @return bool
112937     * @since PECL imagick 2.0.0
112938     **/
112939    function pushClipPath($clip_mask_id){}
112940
112941    /**
112942     * Indicates that following commands create named elements for early
112943     * processing
112944     *
112945     * Indicates that commands up to a terminating ImagickDraw::popDefs()
112946     * command create named elements (e.g. clip-paths, textures, etc.) which
112947     * may safely be processed earlier for the sake of efficiency.
112948     *
112949     * @return bool
112950     * @since PECL imagick 2.0.0
112951     **/
112952    function pushDefs(){}
112953
112954    /**
112955     * Indicates that subsequent commands up to a ImagickDraw::opPattern()
112956     * command comprise the definition of a named pattern
112957     *
112958     * Indicates that subsequent commands up to a DrawPopPattern() command
112959     * comprise the definition of a named pattern. The pattern space is
112960     * assigned top left corner coordinates, a width and height, and becomes
112961     * its own drawing space. Anything which can be drawn may be used in a
112962     * pattern definition. Named patterns may be used as stroke or brush
112963     * definitions.
112964     *
112965     * @param string $pattern_id the pattern Id
112966     * @param float $x x coordinate of the top-left corner
112967     * @param float $y y coordinate of the top-left corner
112968     * @param float $width width of the pattern
112969     * @param float $height height of the pattern
112970     * @return bool
112971     * @since PECL imagick 2.0.0
112972     **/
112973    function pushPattern($pattern_id, $x, $y, $width, $height){}
112974
112975    /**
112976     * Draws a rectangle
112977     *
112978     * Draws a rectangle given two coordinates and using the current stroke,
112979     * stroke width, and fill settings.
112980     *
112981     * @param float $x1 x coordinate of the top left corner
112982     * @param float $y1 y coordinate of the top left corner
112983     * @param float $x2 x coordinate of the bottom right corner
112984     * @param float $y2 y coordinate of the bottom right corner
112985     * @return bool
112986     * @since PECL imagick 2.0.0
112987     **/
112988    function rectangle($x1, $y1, $x2, $y2){}
112989
112990    /**
112991     * Renders all preceding drawing commands onto the image
112992     *
112993     * @return bool
112994     * @since PECL imagick 2.0.0
112995     **/
112996    function render(){}
112997
112998    /**
112999     * Resets the vector graphics.
113000     *
113001     * @return bool
113002     **/
113003    public function resetVectorGraphics(){}
113004
113005    /**
113006     * Applies the specified rotation to the current coordinate space
113007     *
113008     * @param float $degrees degrees to rotate
113009     * @return bool
113010     * @since PECL imagick 2.0.0
113011     **/
113012    function rotate($degrees){}
113013
113014    /**
113015     * Draws a rounded rectangle
113016     *
113017     * Draws a rounded rectangle given two coordinates, x & y corner radiuses
113018     * and using the current stroke, stroke width, and fill settings.
113019     *
113020     * @param float $x1 x coordinate of the top left corner
113021     * @param float $y1 y coordinate of the top left corner
113022     * @param float $x2 x coordinate of the bottom right
113023     * @param float $y2 y coordinate of the bottom right
113024     * @param float $rx x rounding
113025     * @param float $ry y rounding
113026     * @return bool
113027     * @since PECL imagick 2.0.0
113028     **/
113029    function roundRectangle($x1, $y1, $x2, $y2, $rx, $ry){}
113030
113031    /**
113032     * Adjusts the scaling factor
113033     *
113034     * Adjusts the scaling factor to apply in the horizontal and vertical
113035     * directions to the current coordinate space.
113036     *
113037     * @param float $x horizontal factor
113038     * @param float $y vertical factor
113039     * @return bool
113040     * @since PECL imagick 2.0.0
113041     **/
113042    function scale($x, $y){}
113043
113044    /**
113045     * Associates a named clipping path with the image
113046     *
113047     * Associates a named clipping path with the image. Only the areas drawn
113048     * on by the clipping path will be modified as long as it remains in
113049     * effect.
113050     *
113051     * @param string $clip_mask the clipping path name
113052     * @return bool
113053     * @since PECL imagick 2.0.0
113054     **/
113055    function setClipPath($clip_mask){}
113056
113057    /**
113058     * Set the polygon fill rule to be used by the clipping path
113059     *
113060     * @param int $fill_rule FILLRULE_ constant
113061     * @return bool
113062     * @since PECL imagick 2.0.0
113063     **/
113064    function setClipRule($fill_rule){}
113065
113066    /**
113067     * Sets the interpretation of clip path units
113068     *
113069     * @param int $clip_units the number of clip units
113070     * @return bool
113071     * @since PECL imagick 2.0.0
113072     **/
113073    function setClipUnits($clip_units){}
113074
113075    /**
113076     * Sets the opacity to use when drawing using the fill color or fill
113077     * texture
113078     *
113079     * Sets the opacity to use when drawing using the fill color or fill
113080     * texture. Fully opaque is 1.0.
113081     *
113082     * @param float $opacity fill alpha
113083     * @return bool
113084     * @since PECL imagick 2.0.0
113085     **/
113086    function setFillAlpha($opacity){}
113087
113088    /**
113089     * Sets the fill color to be used for drawing filled objects
113090     *
113091     * @param ImagickPixel $fill_pixel ImagickPixel to use to set the color
113092     * @return bool
113093     * @since PECL imagick 2.0.0
113094     **/
113095    function setFillColor($fill_pixel){}
113096
113097    /**
113098     * Sets the opacity to use when drawing using the fill color or fill
113099     * texture
113100     *
113101     * Sets the opacity to use when drawing using the fill color or fill
113102     * texture. Fully opaque is 1.0.
113103     *
113104     * @param float $fillOpacity the fill opacity
113105     * @return bool
113106     * @since PECL imagick 2.0.0
113107     **/
113108    function setFillOpacity($fillOpacity){}
113109
113110    /**
113111     * Sets the URL to use as a fill pattern for filling objects
113112     *
113113     * Sets the URL to use as a fill pattern for filling objects. Only local
113114     * URLs ("#identifier") are supported at this time. These local URLs are
113115     * normally created by defining a named fill pattern with
113116     * DrawPushPattern/DrawPopPattern.
113117     *
113118     * @param string $fill_url URL to use to obtain fill pattern.
113119     * @return bool
113120     * @since PECL imagick 2.0.0
113121     **/
113122    function setFillPatternURL($fill_url){}
113123
113124    /**
113125     * Sets the fill rule to use while drawing polygons
113126     *
113127     * @param int $fill_rule FILLRULE_ constant
113128     * @return bool
113129     * @since PECL imagick 2.0.0
113130     **/
113131    function setFillRule($fill_rule){}
113132
113133    /**
113134     * Sets the fully-specified font to use when annotating with text
113135     *
113136     * @param string $font_name
113137     * @return bool
113138     * @since PECL imagick 2.0.0
113139     **/
113140    function setFont($font_name){}
113141
113142    /**
113143     * Sets the font family to use when annotating with text
113144     *
113145     * @param string $font_family the font family
113146     * @return bool
113147     * @since PECL imagick 2.0.0
113148     **/
113149    function setFontFamily($font_family){}
113150
113151    /**
113152     * Sets the font pointsize to use when annotating with text
113153     *
113154     * @param float $pointsize the point size
113155     * @return bool
113156     * @since PECL imagick 2.0.0
113157     **/
113158    function setFontSize($pointsize){}
113159
113160    /**
113161     * Sets the font stretch to use when annotating with text
113162     *
113163     * Sets the font stretch to use when annotating with text. The AnyStretch
113164     * enumeration acts as a wild-card "don't care" option.
113165     *
113166     * @param int $fontStretch STRETCH_ constant
113167     * @return bool
113168     * @since PECL imagick 2.0.0
113169     **/
113170    function setFontStretch($fontStretch){}
113171
113172    /**
113173     * Sets the font style to use when annotating with text
113174     *
113175     * Sets the font style to use when annotating with text. The AnyStyle
113176     * enumeration acts as a wild-card "don't care" option.
113177     *
113178     * @param int $style STYLETYPE_ constant
113179     * @return bool
113180     * @since PECL imagick 2.0.0
113181     **/
113182    function setFontStyle($style){}
113183
113184    /**
113185     * Sets the font weight
113186     *
113187     * Sets the font weight to use when annotating with text.
113188     *
113189     * @param int $font_weight
113190     * @return bool
113191     * @since PECL imagick 2.0.0
113192     **/
113193    function setFontWeight($font_weight){}
113194
113195    /**
113196     * Sets the text placement gravity
113197     *
113198     * Sets the text placement gravity to use when annotating with text.
113199     *
113200     * @param int $gravity GRAVITY_ constant
113201     * @return bool
113202     * @since PECL imagick 2.0.0
113203     **/
113204    function setGravity($gravity){}
113205
113206    /**
113207     * Sets the resolution.
113208     *
113209     * @param float $x_resolution
113210     * @param float $y_resolution
113211     * @return bool
113212     **/
113213    public function setResolution($x_resolution, $y_resolution){}
113214
113215    /**
113216     * Specifies the opacity of stroked object outlines
113217     *
113218     * @param float $opacity opacity
113219     * @return bool
113220     * @since PECL imagick 2.0.0
113221     **/
113222    function setStrokeAlpha($opacity){}
113223
113224    /**
113225     * Controls whether stroked outlines are antialiased
113226     *
113227     * Controls whether stroked outlines are antialiased. Stroked outlines
113228     * are antialiased by default. When antialiasing is disabled stroked
113229     * pixels are thresholded to determine if the stroke color or underlying
113230     * canvas color should be used.
113231     *
113232     * @param bool $stroke_antialias the antialias setting
113233     * @return bool
113234     * @since PECL imagick 2.0.0
113235     **/
113236    function setStrokeAntialias($stroke_antialias){}
113237
113238    /**
113239     * Sets the color used for stroking object outlines
113240     *
113241     * @param ImagickPixel $stroke_pixel the stroke color
113242     * @return bool
113243     * @since PECL imagick 2.0.0
113244     **/
113245    function setStrokeColor($stroke_pixel){}
113246
113247    /**
113248     * Specifies the pattern of dashes and gaps used to stroke paths
113249     *
113250     * Specifies the pattern of dashes and gaps used to stroke paths. The
113251     * strokeDashArray represents an array of numbers that specify the
113252     * lengths of alternating dashes and gaps in pixels. If an odd number of
113253     * values is provided, then the list of values is repeated to yield an
113254     * even number of values. To remove an existing dash array, pass a zero
113255     * number_elements argument and null dash_array. A typical
113256     * strokeDashArray_ array might contain the members 5 3 2.
113257     *
113258     * @param array $dashArray array of floats
113259     * @return bool
113260     * @since PECL imagick 2.0.0
113261     **/
113262    function setStrokeDashArray($dashArray){}
113263
113264    /**
113265     * Specifies the offset into the dash pattern to start the dash
113266     *
113267     * @param float $dash_offset dash offset
113268     * @return bool
113269     * @since PECL imagick 2.0.0
113270     **/
113271    function setStrokeDashOffset($dash_offset){}
113272
113273    /**
113274     * Specifies the shape to be used at the end of open subpaths when they
113275     * are stroked
113276     *
113277     * Specifies the shape to be used at the end of open subpaths when they
113278     * are stroked.
113279     *
113280     * @param int $linecap LINECAP_ constant
113281     * @return bool
113282     * @since PECL imagick 2.0.0
113283     **/
113284    function setStrokeLineCap($linecap){}
113285
113286    /**
113287     * Specifies the shape to be used at the corners of paths when they are
113288     * stroked
113289     *
113290     * Specifies the shape to be used at the corners of paths (or other
113291     * vector shapes) when they are stroked.
113292     *
113293     * @param int $linejoin LINEJOIN_ constant
113294     * @return bool
113295     * @since PECL imagick 2.0.0
113296     **/
113297    function setStrokeLineJoin($linejoin){}
113298
113299    /**
113300     * Specifies the miter limit
113301     *
113302     * Specifies the miter limit. When two line segments meet at a sharp
113303     * angle and miter joins have been specified for 'lineJoin', it is
113304     * possible for the miter to extend far beyond the thickness of the line
113305     * stroking the path. The miterLimit' imposes a limit on the ratio of the
113306     * miter length to the 'lineWidth'.
113307     *
113308     * @param int $miterlimit the miter limit
113309     * @return bool
113310     * @since PECL imagick 2.0.0
113311     **/
113312    function setStrokeMiterLimit($miterlimit){}
113313
113314    /**
113315     * Specifies the opacity of stroked object outlines
113316     *
113317     * @param float $stroke_opacity stroke opacity. 1.0 is fully opaque
113318     * @return bool
113319     * @since PECL imagick 2.0.0
113320     **/
113321    function setStrokeOpacity($stroke_opacity){}
113322
113323    /**
113324     * Sets the pattern used for stroking object outlines
113325     *
113326     * @param string $stroke_url stroke URL
113327     * @return bool imagick.imagickdraw.return.success;
113328     * @since PECL imagick 2.0.0
113329     **/
113330    function setStrokePatternURL($stroke_url){}
113331
113332    /**
113333     * Sets the width of the stroke used to draw object outlines
113334     *
113335     * @param float $stroke_width stroke width
113336     * @return bool
113337     * @since PECL imagick 2.0.0
113338     **/
113339    function setStrokeWidth($stroke_width){}
113340
113341    /**
113342     * Specifies a text alignment
113343     *
113344     * Specifies a text alignment to be applied when annotating with text.
113345     *
113346     * @param int $alignment ALIGN_ constant
113347     * @return bool
113348     * @since PECL imagick 2.0.0
113349     **/
113350    function setTextAlignment($alignment){}
113351
113352    /**
113353     * Controls whether text is antialiased
113354     *
113355     * Controls whether text is antialiased. Text is antialiased by default.
113356     *
113357     * @param bool $antiAlias
113358     * @return bool
113359     * @since PECL imagick 2.0.0
113360     **/
113361    function setTextAntialias($antiAlias){}
113362
113363    /**
113364     * Specifies a decoration
113365     *
113366     * Specifies a decoration to be applied when annotating with text.
113367     *
113368     * @param int $decoration DECORATION_ constant
113369     * @return bool
113370     * @since PECL imagick 2.0.0
113371     **/
113372    function setTextDecoration($decoration){}
113373
113374    /**
113375     * Specifies the text code set
113376     *
113377     * Specifies the code set to use for text annotations. The only character
113378     * encoding which may be specified at this time is "UTF-8" for
113379     * representing Unicode as a sequence of bytes. Specify an empty string
113380     * to set text encoding to the system's default. Successful text
113381     * annotation using Unicode may require fonts designed to support
113382     * Unicode.
113383     *
113384     * @param string $encoding the encoding name
113385     * @return bool
113386     * @since PECL imagick 2.0.0
113387     **/
113388    function setTextEncoding($encoding){}
113389
113390    /**
113391     * Sets the text interline spacing.
113392     *
113393     * @param float $spacing
113394     * @return bool
113395     **/
113396    public function setTextInterlineSpacing($spacing){}
113397
113398    /**
113399     * Sets the text interword spacing.
113400     *
113401     * @param float $spacing
113402     * @return bool
113403     **/
113404    public function setTextInterwordSpacing($spacing){}
113405
113406    /**
113407     * Sets the text kerning
113408     *
113409     * @param float $kerning
113410     * @return bool
113411     **/
113412    public function setTextKerning($kerning){}
113413
113414    /**
113415     * Specifies the color of a background rectangle
113416     *
113417     * Specifies the color of a background rectangle to place under text
113418     * annotations.
113419     *
113420     * @param ImagickPixel $under_color the under color
113421     * @return bool
113422     * @since PECL imagick 2.0.0
113423     **/
113424    function setTextUnderColor($under_color){}
113425
113426    /**
113427     * Sets the vector graphics
113428     *
113429     * Sets the vector graphics associated with the specified ImagickDraw
113430     * object. Use this method with ImagickDraw::getVectorGraphics() as a
113431     * method to persist the vector graphics state.
113432     *
113433     * @param string $xml xml containing the vector graphics
113434     * @return bool
113435     * @since PECL imagick 2.0.0
113436     **/
113437    function setVectorGraphics($xml){}
113438
113439    /**
113440     * Sets the overall canvas size
113441     *
113442     * Sets the overall canvas size to be recorded with the drawing vector
113443     * data. Usually this will be specified using the same size as the canvas
113444     * image. When the vector data is saved to SVG or MVG formats, the
113445     * viewbox is use to specify the size of the canvas image that a viewer
113446     * will render the vector data on.
113447     *
113448     * @param int $x1 left x coordinate
113449     * @param int $y1 left y coordinate
113450     * @param int $x2 right x coordinate
113451     * @param int $y2 right y coordinate
113452     * @return bool
113453     * @since PECL imagick 2.0.0
113454     **/
113455    function setViewbox($x1, $y1, $x2, $y2){}
113456
113457    /**
113458     * Skews the current coordinate system in the horizontal direction
113459     *
113460     * @param float $degrees degrees to skew
113461     * @return bool
113462     * @since PECL imagick 2.0.0
113463     **/
113464    function skewX($degrees){}
113465
113466    /**
113467     * Skews the current coordinate system in the vertical direction
113468     *
113469     * @param float $degrees degrees to skew
113470     * @return bool
113471     * @since PECL imagick 2.0.0
113472     **/
113473    function skewY($degrees){}
113474
113475    /**
113476     * Applies a translation to the current coordinate system
113477     *
113478     * Applies a translation to the current coordinate system which moves the
113479     * coordinate system origin to the specified coordinate.
113480     *
113481     * @param float $x horizontal translation
113482     * @param float $y vertical translation
113483     * @return bool
113484     * @since PECL imagick 2.0.0
113485     **/
113486    function translate($x, $y){}
113487
113488    /**
113489     * The ImagickDraw constructor
113490     **/
113491    function __construct(){}
113492
113493}
113494class ImagickKernel {
113495    /**
113496     * Attach another kernel to this kernel to allow them to both be applied
113497     * in a single morphology or filter function. Returns the new combined
113498     * kernel.
113499     *
113500     * @param ImagickKernel $ImagickKernel
113501     * @return void
113502     * @since PECL imagick >= 3.3.0
113503     **/
113504    public function addKernel($ImagickKernel){}
113505
113506    /**
113507     * Adds a given amount of the 'Unity' Convolution Kernel to the given
113508     * pre-scaled and normalized Kernel. This in effect adds that amount of
113509     * the original image into the resulting convolution kernel. The
113510     * resulting effect is to convert the defined kernels into blended
113511     * soft-blurs, unsharp kernels or into sharpening kernels.
113512     *
113513     * @param float $scale
113514     * @return void
113515     * @since PECL imagick >= 3.3.0
113516     **/
113517    public function addUnityKernel($scale){}
113518
113519    /**
113520     * Create a kernel from a builtin in kernel. See
113521     * http://www.imagemagick.org/Usage/morphology/#kernel for examples.
113522     * Currently the 'rotation' symbols are not supported. Example:
113523     * $diamondKernel = ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DIAMOND,
113524     * "2");
113525     *
113526     * @param int $kernelType The type of kernel to build e.g.
113527     *   \Imagick::KERNEL_DIAMOND
113528     * @param string $kernelString A string that describes the parameters
113529     *   e.g. "4,2.5"
113530     * @return ImagickKernel
113531     * @since PECL imagick >= 3.3.0
113532     **/
113533    public static function fromBuiltin($kernelType, $kernelString){}
113534
113535    /**
113536     * Create a kernel from an 2d matrix of values. Each value should either
113537     * be a float (if the element should be used) or 'false' if the element
113538     * should be skipped. For matrices that are odd sizes in both dimensions
113539     * the origin pixel will default to the centre of the kernel. For all
113540     * other kernel sizes the origin pixel must be specified.
113541     *
113542     * @param array $matrix A matrix (i.e. 2d array) of values that define
113543     *   the kernel. Each element should be either a float value, or FALSE if
113544     *   that element shouldn't be used by the kernel.
113545     * @param array $origin Which element of the kernel should be used as
113546     *   the origin pixel. e.g. For a 3x3 matrix specifying the origin as [2,
113547     *   2] would specify that the bottom right element should be the origin
113548     *   pixel.
113549     * @return ImagickKernel The generated ImagickKernel.
113550     * @since PECL imagick >= 3.3.0
113551     **/
113552    public static function fromMatrix($matrix, $origin){}
113553
113554    /**
113555     * Get the 2d matrix of values used in this kernel. The elements are
113556     * either float for elements that are used or 'false' if the element
113557     * should be skipped.
113558     *
113559     * @return array A matrix (2d array) of the values that represent the
113560     *   kernel.
113561     * @since PECL imagick >= 3.3.0
113562     **/
113563    public function getMatrix(){}
113564
113565    /**
113566     * ScaleKernelInfo() scales the given kernel list by the given amount,
113567     * with or without normalization of the sum of the kernel values (as per
113568     * given flags).
113569     *
113570     * The exact behaviour of this function depends on the normalization type
113571     * being used please see
113572     * http://www.imagemagick.org/api/morphology.php#ScaleKernelInfo for
113573     * details.
113574     *
113575     * Flag should be one of Imagick::NORMALIZE_KERNEL_VALUE,
113576     * Imagick::NORMALIZE_KERNEL_CORRELATE, Imagick::NORMALIZE_KERNEL_PERCENT
113577     * or not set.
113578     *
113579     * @param float $scale
113580     * @param int $normalizeFlag
113581     * @return void
113582     * @since PECL imagick >= 3.3.0
113583     **/
113584    public function scale($scale, $normalizeFlag){}
113585
113586    /**
113587     * Separates a linked set of kernels and returns an array of
113588     * ImagickKernels.
113589     *
113590     * @return array
113591     * @since PECL imagick >= 3.3.0
113592     **/
113593    public function separate(){}
113594
113595}
113596class ImagickKernelException extends Exception {
113597}
113598class ImagickPixel {
113599    /**
113600     * Clears resources associated with this object
113601     *
113602     * Clears the ImagickPixel object, leaving it in a fresh state. This also
113603     * unsets any color associated with the object.
113604     *
113605     * @return bool
113606     * @since PECL imagick 2.0.0
113607     **/
113608    function clear(){}
113609
113610    /**
113611     * Deallocates resources associated with this object
113612     *
113613     * Deallocates any resources used by the ImagickPixel object, and unsets
113614     * any associated color. The object should not be used after the destroy
113615     * function has been called.
113616     *
113617     * @return bool
113618     * @since PECL imagick 2.0.0
113619     **/
113620    function destroy(){}
113621
113622    /**
113623     * Returns the color
113624     *
113625     * Returns the color described by the ImagickPixel object, as an array.
113626     * If the color has an opacity channel set, this is provided as a fourth
113627     * value in the list.
113628     *
113629     * @param int $normalized Normalize the color values
113630     * @return array An array of channel values, each normalized if TRUE is
113631     *   given as param. Throws ImagickPixelException on error.
113632     * @since PECL imagick 2.0.0
113633     **/
113634    function getColor($normalized){}
113635
113636    /**
113637     * Returns the color as a string
113638     *
113639     * Returns the color of the ImagickPixel object as a string.
113640     *
113641     * @return string Returns the color of the ImagickPixel object as a
113642     *   string.
113643     * @since PECL imagick 2.1.0
113644     **/
113645    function getColorAsString(){}
113646
113647    /**
113648     * Returns the color count associated with this color
113649     *
113650     * The color count is the number of pixels in the image that have the
113651     * same color as this ImagickPixel.
113652     *
113653     * ImagickPixel::getColorCount appears to only work for ImagickPixel
113654     * objects created through Imagick::getImageHistogram()
113655     *
113656     * @return int Returns the color count as an integer on success, throws
113657     *   ImagickPixelException on failure.
113658     * @since PECL imagick 2.0.0
113659     **/
113660    function getColorCount(){}
113661
113662    /**
113663     * Returns the color of the pixel in an array as Quantum values. If
113664     * ImageMagick was compiled as HDRI these will be floats, otherwise they
113665     * will be integers.
113666     *
113667     * @return array Returns an array with keys "r", "g", "b", "a".
113668     **/
113669    public function getColorQuantum(){}
113670
113671    /**
113672     * Gets the normalized value of the provided color channel
113673     *
113674     * Retrieves the value of the color channel specified, as a
113675     * floating-point number between 0 and 1.
113676     *
113677     * @param int $color The color to get the value of, specified as one of
113678     *   the Imagick color constants. This can be one of the RGB colors, CMYK
113679     *   colors, alpha and opacity e.g (Imagick::COLOR_BLUE,
113680     *   Imagick::COLOR_MAGENTA).
113681     * @return float The value of the channel, as a normalized
113682     *   floating-point number, throwing ImagickPixelException on error.
113683     * @since PECL imagick 2.0.0
113684     **/
113685    function getColorValue($color){}
113686
113687    /**
113688     * Gets the quantum value of a color in the ImagickPixel. Return value is
113689     * a float if ImageMagick was compiled with HDRI, otherwise an integer.
113690     *
113691     * @param int $color
113692     * @return number The quantum value of the color element. Float if
113693     *   ImageMagick was compiled with HDRI, otherwise an int.
113694     **/
113695    public function getColorValueQuantum($color){}
113696
113697    /**
113698     * Returns the normalized HSL color of the ImagickPixel object
113699     *
113700     * Returns the normalized HSL color described by the ImagickPixel object,
113701     * with each of the three values as floating point numbers between 0.0
113702     * and 1.0.
113703     *
113704     * @return array Returns the HSL value in an array with the keys "hue",
113705     *   "saturation", and "luminosity". Throws ImagickPixelException on
113706     *   failure.
113707     * @since PECL imagick 2.0.0
113708     **/
113709    function getHSL(){}
113710
113711    /**
113712     * Gets the colormap index of the pixel wand.
113713     *
113714     * @return int
113715     **/
113716    public function getIndex(){}
113717
113718    /**
113719     * Check the distance between this color and another
113720     *
113721     * Checks the distance between the color described by this ImagickPixel
113722     * object and that of the provided object, by plotting their RGB values
113723     * on the color cube. If the distance between the two points is less than
113724     * the fuzz value given, the colors are similar. This method replaces
113725     * ImagickPixel::isSimilar() and correctly normalises the fuzz value to
113726     * ImageMagick QuantumRange.
113727     *
113728     * @param ImagickPixel $color The ImagickPixel object to compare this
113729     *   object against.
113730     * @param float $fuzz The maximum distance within which to consider
113731     *   these colors as similar. The theoretical maximum for this value is
113732     *   the square root of three (1.732).
113733     * @return bool
113734     **/
113735    function isPixelSimilar($color, $fuzz){}
113736
113737    /**
113738     * Returns true if the distance between two colors is less than the
113739     * specified distance. The fuzz value should be in the range
113740     * 0-QuantumRange. The maximum value represents the longest possible
113741     * distance in the colorspace. e.g. from RGB(0, 0, 0) to RGB(255, 255,
113742     * 255) for the RGB colorspace
113743     *
113744     * @param string $color
113745     * @param string $fuzz
113746     * @return bool
113747     **/
113748    public function isPixelSimilarQuantum($color, $fuzz){}
113749
113750    /**
113751     * Check the distance between this color and another
113752     *
113753     * Checks the distance between the color described by this ImagickPixel
113754     * object and that of the provided object, by plotting their RGB values
113755     * on the color cube. If the distance between the two points is less than
113756     * the fuzz value given, the colors are similar. Deprecated in favour of
113757     * ImagickPixel::isPixelSimilar().
113758     *
113759     * @param ImagickPixel $color The ImagickPixel object to compare this
113760     *   object against.
113761     * @param float $fuzz The maximum distance within which to consider
113762     *   these colors as similar. The theoretical maximum for this value is
113763     *   the square root of three (1.732).
113764     * @return bool
113765     * @since PECL imagick 2.0.0
113766     **/
113767    function isSimilar($color, $fuzz){}
113768
113769    /**
113770     * Sets the color
113771     *
113772     * Sets the color described by the ImagickPixel object, with a string
113773     * (e.g. "blue", "#0000ff", "rgb(0,0,255)", "cmyk(100,100,100,10)",
113774     * etc.).
113775     *
113776     * @param string $color The color definition to use in order to
113777     *   initialise the ImagickPixel object.
113778     * @return bool Returns TRUE if the specified color was set, FALSE
113779     *   otherwise.
113780     * @since PECL imagick 2.0.0
113781     **/
113782    function setColor($color){}
113783
113784    /**
113785     * Sets the color count associated with this color.
113786     *
113787     * @param int $colorCount
113788     * @return bool
113789     **/
113790    public function setcolorcount($colorCount){}
113791
113792    /**
113793     * Sets the normalized value of one of the channels
113794     *
113795     * Sets the value of the specified channel of this object to the provided
113796     * value, which should be between 0 and 1. This function can be used to
113797     * provide an opacity channel to an ImagickPixel object.
113798     *
113799     * @param int $color One of the Imagick color constants e.g.
113800     *   \Imagick::COLOR_GREEN or \Imagick::COLOR_ALPHA.
113801     * @param float $value The value to set this channel to, ranging from 0
113802     *   to 1.
113803     * @return bool
113804     * @since PECL imagick 2.0.0
113805     **/
113806    function setColorValue($color, $value){}
113807
113808    /**
113809     * Sets the quantum value of a color element of the ImagickPixel.
113810     *
113811     * @param int $color Which color element to set e.g.
113812     *   \Imagick::COLOR_GREEN.
113813     * @param number $value The quantum value to set the color element to.
113814     *   This should be a float if ImageMagick was compiled with HDRI
113815     *   otherwise an int in the range 0 to Imagick::getQuantum().
113816     * @return bool
113817     **/
113818    public function setColorValueQuantum($color, $value){}
113819
113820    /**
113821     * Sets the normalized HSL color
113822     *
113823     * Sets the color described by the ImagickPixel object using normalized
113824     * values for hue, saturation and luminosity.
113825     *
113826     * @param float $hue The normalized value for hue, described as a
113827     *   fractional arc (between 0 and 1) of the hue circle, where the zero
113828     *   value is red.
113829     * @param float $saturation The normalized value for saturation, with 1
113830     *   as full saturation.
113831     * @param float $luminosity The normalized value for luminosity, on a
113832     *   scale from black at 0 to white at 1, with the full HS value at 0.5
113833     *   luminosity.
113834     * @return bool
113835     * @since PECL imagick 2.0.0
113836     **/
113837    function setHSL($hue, $saturation, $luminosity){}
113838
113839    /**
113840     * Sets the colormap index of the pixel wand.
113841     *
113842     * @param int $index
113843     * @return bool
113844     **/
113845    public function setIndex($index){}
113846
113847    /**
113848     * The ImagickPixel constructor
113849     *
113850     * Constructs an ImagickPixel object. If a color is specified, the object
113851     * is constructed and then initialised with that color before being
113852     * returned.
113853     *
113854     * @param string $color The optional color string to use as the initial
113855     *   value of this object.
113856     * @since PECL imagick 2.0.0
113857     **/
113858    function __construct($color){}
113859
113860}
113861class ImagickPixelIterator {
113862    /**
113863     * Clear resources associated with a PixelIterator
113864     *
113865     * @return bool
113866     * @since PECL imagick 2.0.0
113867     **/
113868    function clear(){}
113869
113870    /**
113871     * Deallocates resources associated with a PixelIterator
113872     *
113873     * @return bool
113874     * @since PECL imagick 2.0.0
113875     **/
113876    function destroy(){}
113877
113878    /**
113879     * Returns the current row of ImagickPixel objects
113880     *
113881     * Returns the current row as an array of ImagickPixel objects from the
113882     * pixel iterator.
113883     *
113884     * @return array Returns a row as an array of ImagickPixel objects that
113885     *   can themselves be iterated.
113886     * @since PECL imagick 2.0.0
113887     **/
113888    function getCurrentIteratorRow(){}
113889
113890    /**
113891     * Returns the current pixel iterator row
113892     *
113893     * @return int Returns the integer offset of the row, throwing
113894     *   ImagickPixelIteratorException on error.
113895     * @since PECL imagick 2.0.0
113896     **/
113897    function getIteratorRow(){}
113898
113899    /**
113900     * Returns the next row of the pixel iterator
113901     *
113902     * Returns the next row as an array of pixel wands from the pixel
113903     * iterator.
113904     *
113905     * @return array Returns the next row as an array of ImagickPixel
113906     *   objects, throwing ImagickPixelIteratorException on error.
113907     * @since PECL imagick 2.0.0
113908     **/
113909    function getNextIteratorRow(){}
113910
113911    /**
113912     * Returns the previous row
113913     *
113914     * Returns the previous row as an array of pixel wands from the pixel
113915     * iterator.
113916     *
113917     * @return array Returns the previous row as an array of
113918     *   ImagickPixelWand objects from the ImagickPixelIterator, throwing
113919     *   ImagickPixelIteratorException on error.
113920     * @since PECL imagick 2.0.0
113921     **/
113922    function getPreviousIteratorRow(){}
113923
113924    /**
113925     * Returns a new pixel iterator
113926     *
113927     * @param Imagick $wand
113928     * @return bool Throwing ImagickPixelIteratorException.
113929     * @since PECL imagick 2.0.0
113930     **/
113931    function newPixelIterator($wand){}
113932
113933    /**
113934     * Returns a new pixel iterator
113935     *
113936     * @param Imagick $wand
113937     * @param int $x
113938     * @param int $y
113939     * @param int $columns
113940     * @param int $rows
113941     * @return bool Returns a new ImagickPixelIterator on success; on
113942     *   failure, throws ImagickPixelIteratorException.
113943     * @since PECL imagick 2.0.0
113944     **/
113945    function newPixelRegionIterator($wand, $x, $y, $columns, $rows){}
113946
113947    /**
113948     * Resets the pixel iterator
113949     *
113950     * Resets the pixel iterator. Use it in conjunction with
113951     * ImagickPixelIterator::getNextIteratorRow() to iterate over all the
113952     * pixels in a pixel container.
113953     *
113954     * @return bool
113955     * @since PECL imagick 2.0.0
113956     **/
113957    function resetIterator(){}
113958
113959    /**
113960     * Sets the pixel iterator to the first pixel row
113961     *
113962     * @return bool
113963     * @since PECL imagick 2.0.0
113964     **/
113965    function setIteratorFirstRow(){}
113966
113967    /**
113968     * Sets the pixel iterator to the last pixel row
113969     *
113970     * @return bool
113971     * @since PECL imagick 2.0.0
113972     **/
113973    function setIteratorLastRow(){}
113974
113975    /**
113976     * Set the pixel iterator row
113977     *
113978     * @param int $row
113979     * @return bool
113980     * @since PECL imagick 2.0.0
113981     **/
113982    function setIteratorRow($row){}
113983
113984    /**
113985     * Syncs the pixel iterator
113986     *
113987     * @return bool
113988     * @since PECL imagick 2.0.0
113989     **/
113990    function syncIterator(){}
113991
113992    /**
113993     * The ImagickPixelIterator constructor
113994     *
113995     * @param Imagick $wand
113996     * @since PECL imagick 2.0.0
113997     **/
113998    function __construct($wand){}
113999
114000}
114001/**
114002 * The InfiniteIterator allows one to infinitely iterate over an iterator
114003 * without having to manually rewind the iterator upon reaching its end.
114004 **/
114005class InfiniteIterator extends IteratorIterator implements OuterIterator {
114006    /**
114007     * Moves the inner Iterator forward or rewinds it
114008     *
114009     * Moves the inner Iterator forward to its next element if there is one,
114010     * otherwise rewinds the inner Iterator back to the beginning.
114011     *
114012     * @return void
114013     * @since PHP 5 >= 5.1.0, PHP 7
114014     **/
114015    public function next(){}
114016
114017    /**
114018     * Constructs an InfiniteIterator
114019     *
114020     * Constructs an InfiniteIterator from an Iterator.
114021     *
114022     * @param Iterator $iterator The iterator to infinitely iterate over.
114023     * @since PHP 5 >= 5.1.0, PHP 7
114024     **/
114025    public function __construct($iterator){}
114026
114027}
114028/**
114029 * A “break iterator” is an ICU object that exposes methods for
114030 * locating boundaries in text (e.g. word or sentence boundaries). The
114031 * PHP IntlBreakIterator serves as the base class for all types of ICU
114032 * break iterators. Where extra functionality is available, the intl
114033 * extension may expose the ICU break iterator with suitable subclasses,
114034 * such as IntlRuleBasedBreakIterator or IntlCodePointBreakIterator. This
114035 * class implements Traversable. Traversing an IntlBreakIterator yields
114036 * non-negative integer values representing the successive locations of
114037 * the text boundaries, expressed as UTF-8 code units (byte) counts,
114038 * taken from the beginning of the text (which has the location 0). The
114039 * keys yielded by the iterator simply form the sequence of natural
114040 * numbers {0, 1, 2, …}.
114041 **/
114042class IntlBreakIterator implements Traversable {
114043    /**
114044     * @var integer
114045     **/
114046    const DONE = 0;
114047
114048    /**
114049     * @var integer
114050     **/
114051    const LINE_HARD = 0;
114052
114053    /**
114054     * @var integer
114055     **/
114056    const LINE_HARD_LIMIT = 0;
114057
114058    /**
114059     * @var integer
114060     **/
114061    const LINE_SOFT = 0;
114062
114063    /**
114064     * @var integer
114065     **/
114066    const LINE_SOFT_LIMIT = 0;
114067
114068    /**
114069     * @var integer
114070     **/
114071    const SENTENCE_SEP = 0;
114072
114073    /**
114074     * @var integer
114075     **/
114076    const SENTENCE_SEP_LIMIT = 0;
114077
114078    /**
114079     * @var integer
114080     **/
114081    const SENTENCE_TERM = 0;
114082
114083    /**
114084     * @var integer
114085     **/
114086    const SENTENCE_TERM_LIMIT = 0;
114087
114088    /**
114089     * @var integer
114090     **/
114091    const WORD_IDEO = 0;
114092
114093    /**
114094     * @var integer
114095     **/
114096    const WORD_IDEO_LIMIT = 0;
114097
114098    /**
114099     * @var integer
114100     **/
114101    const WORD_KANA = 0;
114102
114103    /**
114104     * @var integer
114105     **/
114106    const WORD_KANA_LIMIT = 0;
114107
114108    /**
114109     * @var integer
114110     **/
114111    const WORD_LETTER = 0;
114112
114113    /**
114114     * @var integer
114115     **/
114116    const WORD_LETTER_LIMIT = 0;
114117
114118    /**
114119     * @var integer
114120     **/
114121    const WORD_NONE = 0;
114122
114123    /**
114124     * @var integer
114125     **/
114126    const WORD_NONE_LIMIT = 0;
114127
114128    /**
114129     * @var integer
114130     **/
114131    const WORD_NUMBER = 0;
114132
114133    /**
114134     * @var integer
114135     **/
114136    const WORD_NUMBER_LIMIT = 0;
114137
114138    /**
114139     * Create break iterator for boundaries of combining character sequences
114140     *
114141     * @param string $locale
114142     * @return IntlBreakIterator
114143     * @since PHP 5 >= 5.5.0, PHP 7
114144     **/
114145    public static function createCharacterInstance($locale){}
114146
114147    /**
114148     * Create break iterator for boundaries of code points
114149     *
114150     * @return IntlBreakIterator
114151     * @since PHP 5 >= 5.5.0, PHP 7
114152     **/
114153    public static function createCodePointInstance(){}
114154
114155    /**
114156     * Create break iterator for logically possible line breaks
114157     *
114158     * @param string $locale
114159     * @return IntlBreakIterator
114160     * @since PHP 5 >= 5.5.0, PHP 7
114161     **/
114162    public static function createLineInstance($locale){}
114163
114164    /**
114165     * Create break iterator for sentence breaks
114166     *
114167     * @param string $locale
114168     * @return IntlBreakIterator
114169     * @since PHP 5 >= 5.5.0, PHP 7
114170     **/
114171    public static function createSentenceInstance($locale){}
114172
114173    /**
114174     * Create break iterator for title-casing breaks
114175     *
114176     * @param string $locale
114177     * @return IntlBreakIterator
114178     * @since PHP 5 >= 5.5.0, PHP 7
114179     **/
114180    public static function createTitleInstance($locale){}
114181
114182    /**
114183     * Create break iterator for word breaks
114184     *
114185     * @param string $locale
114186     * @return IntlBreakIterator
114187     * @since PHP 5 >= 5.5.0, PHP 7
114188     **/
114189    public static function createWordInstance($locale){}
114190
114191    /**
114192     * Get index of current position
114193     *
114194     * @return int
114195     * @since PHP 5 >= 5.5.0, PHP 7
114196     **/
114197    public function current(){}
114198
114199    /**
114200     * Set position to the first character in the text
114201     *
114202     * @return int
114203     * @since PHP 5 >= 5.5.0, PHP 7
114204     **/
114205    public function first(){}
114206
114207    /**
114208     * Advance the iterator to the first boundary following specified offset
114209     *
114210     * @param int $offset
114211     * @return int
114212     * @since PHP 5 >= 5.5.0, PHP 7
114213     **/
114214    public function following($offset){}
114215
114216    /**
114217     * Get last error code on the object
114218     *
114219     * @return int
114220     * @since PHP 5 >= 5.5.0, PHP 7
114221     **/
114222    public function getErrorCode(){}
114223
114224    /**
114225     * Get last error message on the object
114226     *
114227     * @return string
114228     * @since PHP 5 >= 5.5.0, PHP 7
114229     **/
114230    public function getErrorMessage(){}
114231
114232    /**
114233     * Get the locale associated with the object
114234     *
114235     * @param string $locale_type
114236     * @return string
114237     * @since PHP 5 >= 5.5.0, PHP 7
114238     **/
114239    public function getLocale($locale_type){}
114240
114241    /**
114242     * Create iterator for navigating fragments between boundaries
114243     *
114244     * @param int $key_type Optional key type. Possible values are:
114245     *   IntlPartsIterator::KEY_SEQUENTIAL - The default. Sequentially
114246     *   increasing integers used as key. IntlPartsIterator::KEY_LEFT - Byte
114247     *   offset left of current part used as key.
114248     *   IntlPartsIterator::KEY_RIGHT - Byte offset right of current part
114249     *   used as key.
114250     * @return IntlPartsIterator
114251     * @since PHP 5 >= 5.5.0, PHP 7
114252     **/
114253    public function getPartsIterator($key_type){}
114254
114255    /**
114256     * Get the text being scanned
114257     *
114258     * @return string
114259     * @since PHP 5 >= 5.5.0, PHP 7
114260     **/
114261    public function getText(){}
114262
114263    /**
114264     * Tell whether an offset is a boundaryʼs offset
114265     *
114266     * @param int $offset
114267     * @return bool
114268     * @since PHP 5 >= 5.5.0, PHP 7
114269     **/
114270    public function isBoundary($offset){}
114271
114272    /**
114273     * Set the iterator position to index beyond the last character
114274     *
114275     * @return int
114276     * @since PHP 5 >= 5.5.0, PHP 7
114277     **/
114278    public function last(){}
114279
114280    /**
114281     * Advance the iterator the next boundary
114282     *
114283     * @param int $offset
114284     * @return int
114285     * @since PHP 5 >= 5.5.0, PHP 7
114286     **/
114287    public function next($offset){}
114288
114289    /**
114290     * Set the iterator position to the first boundary before an offset
114291     *
114292     * @param int $offset
114293     * @return int
114294     * @since PHP 5 >= 5.5.0, PHP 7
114295     **/
114296    public function preceding($offset){}
114297
114298    /**
114299     * Set the iterator position to the boundary immediately before the
114300     * current
114301     *
114302     * @return int
114303     * @since PHP 5 >= 5.5.0, PHP 7
114304     **/
114305    public function previous(){}
114306
114307    /**
114308     * Set the text being scanned
114309     *
114310     * @param string $text
114311     * @return bool
114312     * @since PHP 5 >= 5.5.0, PHP 7
114313     **/
114314    public function setText($text){}
114315
114316    /**
114317     * Private constructor for disallowing instantiation
114318     *
114319     * @since PHP 5 >= 5.5.0, PHP 7
114320     **/
114321    private function __construct(){}
114322
114323}
114324class IntlCalendar {
114325    /**
114326     * @var integer
114327     **/
114328    const DOW_FRIDAY = 0;
114329
114330    /**
114331     * @var integer
114332     **/
114333    const DOW_MONDAY = 0;
114334
114335    /**
114336     * @var integer
114337     **/
114338    const DOW_SATURDAY = 0;
114339
114340    /**
114341     * @var integer
114342     **/
114343    const DOW_SUNDAY = 0;
114344
114345    /**
114346     * @var integer
114347     **/
114348    const DOW_THURSDAY = 0;
114349
114350    /**
114351     * @var integer
114352     **/
114353    const DOW_TUESDAY = 0;
114354
114355    /**
114356     * @var integer
114357     **/
114358    const DOW_TYPE_WEEKDAY = 0;
114359
114360    /**
114361     * @var integer
114362     **/
114363    const DOW_TYPE_WEEKEND = 0;
114364
114365    /**
114366     * @var integer
114367     **/
114368    const DOW_TYPE_WEEKEND_CEASE = 0;
114369
114370    /**
114371     * @var integer
114372     **/
114373    const DOW_TYPE_WEEKEND_OFFSET = 0;
114374
114375    /**
114376     * @var integer
114377     **/
114378    const DOW_WEDNESDAY = 0;
114379
114380    /**
114381     * @var integer
114382     **/
114383    const FIELD_AM_PM = 0;
114384
114385    /**
114386     * @var integer
114387     **/
114388    const FIELD_DATE = 0;
114389
114390    /**
114391     * @var integer
114392     **/
114393    const FIELD_DAY_OF_MONTH = 0;
114394
114395    /**
114396     * @var integer
114397     **/
114398    const FIELD_DAY_OF_WEEK = 0;
114399
114400    /**
114401     * @var integer
114402     **/
114403    const FIELD_DAY_OF_WEEK_IN_MONTH = 0;
114404
114405    /**
114406     * @var integer
114407     **/
114408    const FIELD_DAY_OF_YEAR = 0;
114409
114410    /**
114411     * @var integer
114412     **/
114413    const FIELD_DOW_LOCAL = 0;
114414
114415    /**
114416     * @var integer
114417     **/
114418    const FIELD_DST_OFFSET = 0;
114419
114420    /**
114421     * @var integer
114422     **/
114423    const FIELD_ERA = 0;
114424
114425    /**
114426     * @var integer
114427     **/
114428    const FIELD_EXTENDED_YEAR = 0;
114429
114430    /**
114431     * The total number of fields.
114432     *
114433     * @var mixed
114434     **/
114435    const FIELD_FIELD_COUNT = 0;
114436
114437    /**
114438     * @var integer
114439     **/
114440    const FIELD_FIELD_COUNT  = 0;
114441
114442    /**
114443     * @var integer
114444     **/
114445    const FIELD_HOUR = 0;
114446
114447    /**
114448     * @var integer
114449     **/
114450    const FIELD_HOUR_OF_DAY = 0;
114451
114452    /**
114453     * @var integer
114454     **/
114455    const FIELD_IS_LEAP_MONTH = 0;
114456
114457    /**
114458     * @var integer
114459     **/
114460    const FIELD_JULIAN_DAY = 0;
114461
114462    /**
114463     * @var integer
114464     **/
114465    const FIELD_MILLISECOND = 0;
114466
114467    /**
114468     * @var integer
114469     **/
114470    const FIELD_MILLISECONDS_IN_DAY = 0;
114471
114472    /**
114473     * @var integer
114474     **/
114475    const FIELD_MINUTE = 0;
114476
114477    /**
114478     * @var integer
114479     **/
114480    const FIELD_MONTH = 0;
114481
114482    /**
114483     * @var integer
114484     **/
114485    const FIELD_SECOND = 0;
114486
114487    /**
114488     * @var integer
114489     **/
114490    const FIELD_WEEK_OF_MONTH = 0;
114491
114492    /**
114493     * @var integer
114494     **/
114495    const FIELD_WEEK_OF_YEAR = 0;
114496
114497    /**
114498     * @var integer
114499     **/
114500    const FIELD_YEAR = 0;
114501
114502    /**
114503     * @var integer
114504     **/
114505    const FIELD_YEAR_WOY = 0;
114506
114507    /**
114508     * @var integer
114509     **/
114510    const FIELD_ZONE_OFFSET = 0;
114511
114512    /**
114513     * @var integer
114514     **/
114515    const WALLTIME_FIRST = 0;
114516
114517    /**
114518     * @var integer
114519     **/
114520    const WALLTIME_LAST = 0;
114521
114522    /**
114523     * @var integer
114524     **/
114525    const WALLTIME_NEXT_VALID = 0;
114526
114527    /**
114528     * Add a (signed) amount of time to a field
114529     *
114530     * Add a signed amount to a field. Adding a positive amount allows
114531     * advances in time, even if the numeric value of the field decreases
114532     * (e.g. when working with years in BC dates).
114533     *
114534     * Other fields may need to adjusted – for instance, adding a month to
114535     * the 31st of January will result in the 28th (or 29th) of February.
114536     * Contrary to {@link IntlCalendar::roll}, when a value wraps around,
114537     * more significant fields may change. For instance, adding a day to the
114538     * 31st of January will result in the 1st of February, not the 1st of
114539     * January.
114540     *
114541     * @param int $field The IntlCalendar resource.
114542     * @param int $amount
114543     * @return bool Returns TRUE on success.
114544     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114545     **/
114546    public function add($field, $amount){}
114547
114548    /**
114549     * Whether this objectʼs time is after that of the passed object
114550     *
114551     * Returns whether this objectʼs time succeeds the argumentʼs time.
114552     *
114553     * @param IntlCalendar $other The IntlCalendar resource.
114554     * @return bool Returns TRUE if this objectʼs current time is after
114555     *   that of the {@link calendar} argumentʼs time. Returns FALSE
114556     *   otherwise. Also returns FALSE on failure. You can use exceptions or
114557     *   {@link intl_get_error_code} to detect error conditions.
114558     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114559     **/
114560    public function after($other){}
114561
114562    /**
114563     * Whether this objectʼs time is before that of the passed object
114564     *
114565     * Returns whether this objectʼs time precedes the argumentʼs time.
114566     *
114567     * @param IntlCalendar $other The IntlCalendar resource.
114568     * @return bool Returns TRUE if this objectʼs current time is before
114569     *   that of the {@link calendar} argumentʼs time. Returns FALSE
114570     *   otherwise. Also returns FALSE on failure. You can use exceptions or
114571     *   {@link intl_get_error_code} to detect error conditions.
114572     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114573     **/
114574    public function before($other){}
114575
114576    /**
114577     * Clear a field or all fields
114578     *
114579     * Clears either all of the fields or a specific field. A cleared field
114580     * is marked as unset, giving it the lowest priority against overlapping
114581     * fields or even default values when calculating the time. Additionally,
114582     * its value is set to 0, though given the fieldʼs low priority, its
114583     * value may have been internally set to another value by the time the
114584     * field has finished been queried.
114585     *
114586     * @param int $field The IntlCalendar resource.
114587     * @return bool Returns TRUE on success. Failure can only occur is
114588     *   invalid arguments are provided.
114589     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114590     **/
114591    public function clear($field){}
114592
114593    /**
114594     * Create a new IntlCalendar
114595     *
114596     * Given a timezone and locale, this method creates an IntlCalendar
114597     * object. This factory method may return a subclass of IntlCalendar.
114598     *
114599     * The calendar created will represent the time instance at which it was
114600     * created, based on the system time. The fields can all be cleared by
114601     * calling {@link IntCalendar::clear} with no arguments. See also {@link
114602     * IntlGregorianCalendar::__construct}.
114603     *
114604     * @param mixed $timeZone The timezone to use.
114605     * @param string $locale A locale to use or NULL to use the default
114606     *   locale.
114607     * @return IntlCalendar The created IntlCalendar instance or NULL on
114608     *   failure.
114609     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114610     **/
114611    public static function createInstance($timeZone, $locale){}
114612
114613    /**
114614     * Compare time of two IntlCalendar objects for equality
114615     *
114616     * Returns true if this calendar and the given calendar have the same
114617     * time. The settings, calendar types and field states do not have to be
114618     * the same.
114619     *
114620     * @param IntlCalendar $other The IntlCalendar resource.
114621     * @return bool Returns TRUE if the current time of both this and the
114622     *   passed in IntlCalendar object are the same, or FALSE otherwise. The
114623     *   value FALSE can also be returned on failure. This can only happen if
114624     *   bad arguments are passed in. In any case, the two cases can be
114625     *   distinguished by calling {@link intl_get_error_code}.
114626     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114627     **/
114628    public function equals($other){}
114629
114630    /**
114631     * Calculate difference between given time and this objectʼs time
114632     *
114633     * Return the difference between the given time and the time this object
114634     * is set to, with respect to the quantity specified the {@link field}
114635     * parameter.
114636     *
114637     * This method is meant to be called successively, first with the most
114638     * significant field of interest down to the least significant field. To
114639     * this end, as a side effect, this calendarʼs value for the field
114640     * specified is advanced by the amount returned.
114641     *
114642     * @param float $when The IntlCalendar resource.
114643     * @param int $field The time against which to compare the quantity
114644     *   represented by the {@link field}. For the result to be positive, the
114645     *   time given for this parameter must be ahead of the time of the
114646     *   object the method is being invoked on.
114647     * @return int Returns a (signed) difference of time in the unit
114648     *   associated with the specified field.
114649     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114650     **/
114651    public function fieldDifference($when, $field){}
114652
114653    /**
114654     * Create an IntlCalendar from a DateTime object or string
114655     *
114656     * Creates an IntlCalendar object either from a DateTime object or from a
114657     * string from which a DateTime object can be built.
114658     *
114659     * The new calendar will represent not only the same instant as the given
114660     * DateTime (subject to precision loss for dates very far into the past
114661     * or future), but also the same timezone (subject to the caveat that
114662     * different timezone databases will be used, and therefore the results
114663     * may differ).
114664     *
114665     * @param mixed $dateTime A DateTime object or a string that can be
114666     *   passed to {@link DateTime::__construct}.
114667     * @return IntlCalendar The created IntlCalendar object or NULL in case
114668     *   of failure. If a string is passed, any exception that occurs inside
114669     *   the DateTime constructor is propagated.
114670     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a2
114671     **/
114672    public static function fromDateTime($dateTime){}
114673
114674    /**
114675     * Get the value for a field
114676     *
114677     * Gets the value for a specific field.
114678     *
114679     * @param int $field The IntlCalendar resource.
114680     * @return int An integer with the value of the time field.
114681     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114682     **/
114683    public function get($field){}
114684
114685    /**
114686     * The maximum value for a field, considering the objectʼs current time
114687     *
114688     * Returns a fieldʼs relative maximum value around the current time. The
114689     * exact semantics vary by field, but in the general case this is the
114690     * value that would be obtained if one would set the field value into the
114691     * smallest relative maximum for the field and would increment it until
114692     * reaching the global maximum or the field value wraps around, in which
114693     * the value returned would be the global maximum or the value before the
114694     * wrapping, respectively.
114695     *
114696     * For instance, in the gregorian calendar, the actual maximum value for
114697     * the day of month would vary between 28 and 31, depending on the month
114698     * and year of the current time.
114699     *
114700     * @param int $field The IntlCalendar resource.
114701     * @return int An int representing the maximum value in the units
114702     *   associated with the given {@link field}.
114703     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114704     **/
114705    public function getActualMaximum($field){}
114706
114707    /**
114708     * The minimum value for a field, considering the objectʼs current time
114709     *
114710     * Returns a fieldʼs relative minimum value around the current time. The
114711     * exact semantics vary by field, but in the general case this is the
114712     * value that would be obtained if one would set the field value into the
114713     * greatest relative minimum for the field and would decrement it until
114714     * reaching the global minimum or the field value wraps around, in which
114715     * the value returned would be the global minimum or the value before the
114716     * wrapping, respectively.
114717     *
114718     * For the Gregorian calendar, this is always the same as {@link
114719     * IntlCalendar::getMinimum}.
114720     *
114721     * @param int $field The IntlCalendar resource.
114722     * @return int An int representing the minimum value in the fieldʼs
114723     *   unit.
114724     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114725     **/
114726    public function getActualMinimum($field){}
114727
114728    /**
114729     * Get array of locales for which there is data
114730     *
114731     * Gives the list of locales for which calendars are installed. As of ICU
114732     * 51, this is the list of all installed ICU locales.
114733     *
114734     * @return array An array of strings, one for which locale.
114735     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114736     **/
114737    public static function getAvailableLocales(){}
114738
114739    /**
114740     * Tell whether a day is a weekday, weekend or a day that has a
114741     * transition between the two
114742     *
114743     * Returns whether the passed day is a weekday
114744     * (IntlCalendar::DOW_TYPE_WEEKDAY), a weekend day
114745     * (IntlCalendar::DOW_TYPE_WEEKEND), a day during which a transition
114746     * occurs into the weekend (IntlCalendar::DOW_TYPE_WEEKEND_OFFSET) or a
114747     * day during which the weekend ceases
114748     * (IntlCalendar::DOW_TYPE_WEEKEND_CEASE).
114749     *
114750     * If the return is either IntlCalendar::DOW_TYPE_WEEKEND_OFFSET or
114751     * IntlCalendar::DOW_TYPE_WEEKEND_CEASE, then {@link
114752     * IntlCalendar::getWeekendTransition} can be called to obtain the time
114753     * of the transition.
114754     *
114755     * This function requires ICU 4.4 or later.
114756     *
114757     * @param int $dayOfWeek The IntlCalendar resource.
114758     * @return int Returns one of the constants
114759     *   IntlCalendar::DOW_TYPE_WEEKDAY, IntlCalendar::DOW_TYPE_WEEKEND,
114760     *   IntlCalendar::DOW_TYPE_WEEKEND_OFFSET or
114761     *   IntlCalendar::DOW_TYPE_WEEKEND_CEASE.
114762     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114763     **/
114764    public function getDayOfWeekType($dayOfWeek){}
114765
114766    /**
114767     * Get last error code on the object
114768     *
114769     * Returns the numeric ICU error code for the last call on this object
114770     * (including cloning) or the IntlCalendar given for the {@link calendar}
114771     * parameter (in the procedural‒style version). This may indicate only
114772     * a warning (negative error code) or no error at all (U_ZERO_ERROR). The
114773     * actual presence of an error can be tested with {@link
114774     * intl_is_failure}.
114775     *
114776     * Invalid arguments detected on the PHP side (before invoking functions
114777     * of the ICU library) are not recorded for the purposes of this
114778     * function.
114779     *
114780     * The last error that occurred in any call to a function of the intl
114781     * extension, including early argument errors, can be obtained with
114782     * {@link intl_get_error_code}. This function resets the global error
114783     * code, but not the objectʼs error code.
114784     *
114785     * @return int An ICU error code indicating either success, failure or
114786     *   a warning.
114787     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114788     **/
114789    public function getErrorCode(){}
114790
114791    /**
114792     * Get last error message on the object
114793     *
114794     * Returns the error message (if any) associated with the error reported
114795     * by {@link IntlCalendar::getErrorCode} or {@link
114796     * intlcal_get_error_code}. If there is no associated error message, only
114797     * the string representation of the name of the error constant will be
114798     * returned. Otherwise, the message also includes a message set on the
114799     * side of the PHP binding.
114800     *
114801     * @return string The error message associated with last error that
114802     *   occurred in a function call on this object, or a string indicating
114803     *   the non-existance of an error.
114804     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114805     **/
114806    public function getErrorMessage(){}
114807
114808    /**
114809     * Get the first day of the week for the calendarʼs locale
114810     *
114811     * The week day deemed to start a week, either the default value for this
114812     * locale or the value set with {@link IntlCalendar::setFirstDayOfWeek}.
114813     *
114814     * @return int One of the constants IntlCalendar::DOW_SUNDAY,
114815     *   IntlCalendar::DOW_MONDAY, …, IntlCalendar::DOW_SATURDAY.
114816     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114817     **/
114818    public function getFirstDayOfWeek(){}
114819
114820    /**
114821     * Get the largest local minimum value for a field
114822     *
114823     * Returns the largest local minimum for a field. This should be a value
114824     * larger or equal to that returned by {@link
114825     * IntlCalendar::getActualMinimum}, which is in its turn larger or equal
114826     * to that returned by {@link IntlCalendar::getMinimum}. All these three
114827     * functions return the same value for the Gregorian calendar.
114828     *
114829     * @param int $field The IntlCalendar resource.
114830     * @return int An int representing a field value, in the fieldʼs
114831     *   unit,.
114832     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114833     **/
114834    public function getGreatestMinimum($field){}
114835
114836    /**
114837     * Get set of locale keyword values
114838     *
114839     * For a given locale key, get the set of values for that key that would
114840     * result in a different behavior. For now, only the 'calendar' keyword
114841     * is supported.
114842     *
114843     * This function requires ICU 4.2 or later.
114844     *
114845     * @param string $key The locale keyword for which relevant values are
114846     *   to be queried. Only 'calendar' is supported.
114847     * @param string $locale The locale onto which the keyword/value pair
114848     *   are to be appended.
114849     * @param bool $commonlyUsed Whether to show only the values commonly
114850     *   used for the specified locale.
114851     * @return Iterator An iterator that yields strings with the locale
114852     *   keyword values.
114853     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114854     **/
114855    public static function getKeywordValuesForLocale($key, $locale, $commonlyUsed){}
114856
114857    /**
114858     * Get the smallest local maximum for a field
114859     *
114860     * Returns the smallest local maximumw for a field. This should be a
114861     * value smaller or equal to that returned by {@link
114862     * IntlCalendar::getActualMaxmimum}, which is in its turn smaller or
114863     * equal to that returned by {@link IntlCalendar::getMaximum}.
114864     *
114865     * @param int $field The IntlCalendar resource.
114866     * @return int An int representing a field value in the fieldʼs unit.
114867     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114868     **/
114869    public function getLeastMaximum($field){}
114870
114871    /**
114872     * Get the locale associated with the object
114873     *
114874     * Returns the locale used by this calendar object.
114875     *
114876     * @param int $localeType The IntlCalendar resource.
114877     * @return string A locale string.
114878     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114879     **/
114880    public function getLocale($localeType){}
114881
114882    /**
114883     * Get the global maximum value for a field
114884     *
114885     * Gets the global maximum for a field, in this specific calendar. This
114886     * value is larger or equal to that returned by {@link
114887     * IntlCalendar::getActualMaximum}, which is in its turn larger or equal
114888     * to that returned by {@link IntlCalendar::getLeastMaximum}.
114889     *
114890     * @param int $field The IntlCalendar resource.
114891     * @return int An int representing a field value in the fieldʼs unit.
114892     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114893     **/
114894    public function getMaximum($field){}
114895
114896    /**
114897     * Get minimal number of days the first week in a year or month can have
114898     *
114899     * Returns the smallest number of days the first week of a year or month
114900     * must have in the new year or month. For instance, in the Gregorian
114901     * calendar, if this value is 1, then the first week of the year will
114902     * necessarily include January 1st, while if this value is 7, then the
114903     * week with January 1st will be the first week of the year only if the
114904     * day of the week for January 1st matches the day of the week returned
114905     * by {@link IntlCalendar::getFirstDayOfWeek}; otherwise it will be the
114906     * previous yearʼs last week.
114907     *
114908     * @return int An int representing a number of days.
114909     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114910     **/
114911    public function getMinimalDaysInFirstWeek(){}
114912
114913    /**
114914     * Get the global minimum value for a field
114915     *
114916     * Gets the global minimum for a field, in this specific calendar. This
114917     * value is smaller or equal to that returned by {@link
114918     * IntlCalendar::getActualMinimum}, which is in its turn smaller or equal
114919     * to that returned by {@link IntlCalendar::getGreatestMinimum}. For the
114920     * Gregorian calendar, these three functions always return the same value
114921     * (for each field).
114922     *
114923     * @param int $field The IntlCalendar resource.
114924     * @return int An int representing a value for the given field in the
114925     *   fieldʼs unit.
114926     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114927     **/
114928    public function getMinimum($field){}
114929
114930    /**
114931     * Get number representing the current time
114932     *
114933     * The number of milliseconds that have passed since the reference date.
114934     * This number is derived from the system time.
114935     *
114936     * @return float A float representing a number of milliseconds since
114937     *   the epoch, not counting leap seconds.
114938     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114939     **/
114940    public static function getNow(){}
114941
114942    /**
114943     * Get behavior for handling repeating wall time
114944     *
114945     * Gets the current strategy for dealing with wall times that are
114946     * repeated whenever the clock is set back during dailight saving time
114947     * end transitions. The default value is IntlCalendar::WALLTIME_LAST.
114948     *
114949     * This function requires ICU 4.9 or later.
114950     *
114951     * @return int One of the constants IntlCalendar::WALLTIME_FIRST or
114952     *   IntlCalendar::WALLTIME_LAST.
114953     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114954     **/
114955    public function getRepeatedWallTimeOption(){}
114956
114957    /**
114958     * Get behavior for handling skipped wall time
114959     *
114960     * Gets the current strategy for dealing with wall times that are skipped
114961     * whenever the clock is forwarded during dailight saving time start
114962     * transitions. The default value is IntlCalendar::WALLTIME_LAST.
114963     *
114964     * The calendar must be lenient for this option to have any effect,
114965     * otherwise attempting to set a non-existing time will cause an error.
114966     *
114967     * This function requires ICU 4.9 or later.
114968     *
114969     * @return int One of the constants IntlCalendar::WALLTIME_FIRST,
114970     *   IntlCalendar::WALLTIME_LAST or IntlCalendar::WALLTIME_NEXT_VALID.
114971     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114972     **/
114973    public function getSkippedWallTimeOption(){}
114974
114975    /**
114976     * Get time currently represented by the object
114977     *
114978     * Returns the time associated with this object, expressed as the number
114979     * of milliseconds since the epoch.
114980     *
114981     * @return float A float representing the number of milliseconds
114982     *   elapsed since the reference time (1 Jan 1970 00:00:00 UTC).
114983     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114984     **/
114985    public function getTime(){}
114986
114987    /**
114988     * Get the objectʼs timezone
114989     *
114990     * Returns the IntlTimeZone object associated with this calendar.
114991     *
114992     * @return IntlTimeZone An IntlTimeZone object corresponding to the one
114993     *   used internally in this object.
114994     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
114995     **/
114996    public function getTimeZone(){}
114997
114998    /**
114999     * Get the calendar type
115000     *
115001     * A string describing the type of this calendar. This is one of the
115002     * valid values for the calendar keyword value 'calendar'.
115003     *
115004     * @return string A string representing the calendar type, such as
115005     *   'gregorian', 'islamic', etc.
115006     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
115007     **/
115008    public function getType(){}
115009
115010    /**
115011     * Get time of the day at which weekend begins or ends
115012     *
115013     * Returns the number of milliseconds after midnight at which the weekend
115014     * begins or ends.
115015     *
115016     * This is only applicable for days of the week for which {@link
115017     * IntlCalendar::getDayOfWeekType} returns either
115018     * IntlCalendar::DOW_TYPE_WEEKEND_OFFSET or
115019     * IntlCalendar::DOW_TYPE_WEEKEND_CEASE. Calling this function for other
115020     * days of the week is an error condition.
115021     *
115022     * This function requires ICU 4.4 or later.
115023     *
115024     * @param string $dayOfWeek The IntlCalendar resource.
115025     * @return int The number of milliseconds into the day at which the
115026     *   weekend begins or ends.
115027     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
115028     **/
115029    public function getWeekendTransition($dayOfWeek){}
115030
115031    /**
115032     * Whether the objectʼs time is in Daylight Savings Time
115033     *
115034     * Whether, for the instant represented by this object and for this
115035     * objectʼs timezone, daylight saving time is in place.
115036     *
115037     * @return bool Returns TRUE if the date is in Daylight Savings Time,
115038     *   FALSE otherwise. The value FALSE may also be returned on failure,
115039     *   for instance after specifying invalid field values on non-lenient
115040     *   mode; use exceptions or query {@link intl_get_error_code} to
115041     *   disambiguate.
115042     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
115043     **/
115044    public function inDaylightTime(){}
115045
115046    /**
115047     * Whether another calendar is equal but for a different time
115048     *
115049     * Returns whether this and the given object are equivalent for all
115050     * purposes except as to the time they have set. The locales do not have
115051     * to match, as long as no change in behavior results from such mismatch.
115052     * This includes the timezone, whether the lenient mode is set, the
115053     * repeated and skipped wall time settings, the days of the week when the
115054     * weekend starts and ceases and the times where such transitions occur.
115055     * It may also include other calendar specific settings, such as the
115056     * Gregorian/Julian transition instant.
115057     *
115058     * @param IntlCalendar $other The IntlCalendar resource.
115059     * @return bool Assuming there are no argument errors, returns TRUE if
115060     *   the calendars are equivalent except possibly for their set time.
115061     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
115062     **/
115063    public function isEquivalentTo($other){}
115064
115065    /**
115066     * Whether date/time interpretation is in lenient mode
115067     *
115068     * Returns whether the current date/time interpretations is lenient (the
115069     * default). If that is case, some out of range values for fields will be
115070     * accepted instead of raising an error.
115071     *
115072     * @return bool A bool representing whether the calendar is set to
115073     *   lenient mode.
115074     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
115075     **/
115076    public function isLenient(){}
115077
115078    /**
115079     * Whether a certain date/time is in the weekend
115080     *
115081     * Returns whether either the obejctʼs current time or the provided
115082     * timestamp occur during a weekend in this objectʼs calendar system.
115083     *
115084     * This function requires ICU 4.4 or later.
115085     *
115086     * @param float $date The IntlCalendar resource.
115087     * @return bool A bool indicating whether the given or this objectʼs
115088     *   time occurs in a weekend.
115089     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
115090     **/
115091    public function isWeekend($date){}
115092
115093    /**
115094     * Add value to field without carrying into more significant fields
115095     *
115096     * Adds a (signed) amount to a field. The difference with respect to
115097     * {@link IntlCalendar::add} is that when the field value overflows, it
115098     * does not carry into more significant fields.
115099     *
115100     * @param int $field The IntlCalendar resource.
115101     * @param mixed $amountOrUpOrDown
115102     * @return bool Returns TRUE on success or FALSE on failure.
115103     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
115104     **/
115105    public function roll($field, $amountOrUpOrDown){}
115106
115107    /**
115108     * Set a time field or several common fields at once
115109     *
115110     * Sets either a specific field to the given value, or sets at once
115111     * several common fields. The range of values that are accepted depend on
115112     * whether the calendar is using the lenient mode.
115113     *
115114     * For fields that conflict, the fields that are set later have priority.
115115     *
115116     * This method cannot be called with exactly four arguments.
115117     *
115118     * @param int $field The IntlCalendar resource.
115119     * @param int $value
115120     * @return bool Returns TRUE on success and FALSE on failure.
115121     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
115122     **/
115123    public function set($field, $value){}
115124
115125    /**
115126     * Set the day on which the week is deemed to start
115127     *
115128     * Defines the day of week deemed to start the week. This affects the
115129     * behavior of fields that depend on the concept of week start and end
115130     * such as IntlCalendar::FIELD_WEEK_OF_YEAR and
115131     * IntlCalendar::FIELD_YEAR_WOY.
115132     *
115133     * @param int $dayOfWeek The IntlCalendar resource.
115134     * @return bool Returns TRUE on success. Failure can only happen due to
115135     *   invalid parameters.
115136     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
115137     **/
115138    public function setFirstDayOfWeek($dayOfWeek){}
115139
115140    /**
115141     * Set whether date/time interpretation is to be lenient
115142     *
115143     * Defines whether the calendar is ‘lenient mode’. In such a mode,
115144     * some of out-of-bounds values for some fields are accepted, the
115145     * behavior being similar to that of {@link IntlCalendar::add} (i.e., the
115146     * value wraps around, carrying into more significant fields each time).
115147     * If the lenient mode is off, then such values will generate an error.
115148     *
115149     * @param bool $isLenient The IntlCalendar resource.
115150     * @return bool Returns TRUE on success. Failure can only happen due to
115151     *   invalid parameters.
115152     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
115153     **/
115154    public function setLenient($isLenient){}
115155
115156    /**
115157     * Set minimal number of days the first week in a year or month can have
115158     *
115159     * Sets the smallest number of days the first week of a year or month
115160     * must have in the new year or month. For instance, in the Gregorian
115161     * calendar, if this value is 1, then the first week of the year will
115162     * necessarily include January 1st, while if this value is 7, then the
115163     * week with January 1st will be the first week of the year only if the
115164     * day of the week for January 1st matches the day of the week returned
115165     * by {@link IntlCalendar::getFirstDayOfWeek}; otherwise it will be the
115166     * previous yearʼs last week.
115167     *
115168     * @param int $minimalDays The IntlCalendar resource.
115169     * @return bool TRUE on success, FALSE on failure.
115170     * @since PHP 5 >= 5.5.1, PHP 7
115171     **/
115172    public function setMinimalDaysInFirstWeek($minimalDays){}
115173
115174    /**
115175     * Set behavior for handling repeating wall times at negative timezone
115176     * offset transitions
115177     *
115178     * Sets the current strategy for dealing with wall times that are
115179     * repeated whenever the clock is set back during dailight saving time
115180     * end transitions. The default value is IntlCalendar::WALLTIME_LAST
115181     * (take the post-DST instant). The other possible value is
115182     * IntlCalendar::WALLTIME_FIRST (take the instant that occurs during
115183     * DST).
115184     *
115185     * This function requires ICU 4.9 or later.
115186     *
115187     * @param int $wallTimeOption The IntlCalendar resource.
115188     * @return bool Returns TRUE on success. Failure can only happen due to
115189     *   invalid parameters.
115190     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
115191     **/
115192    public function setRepeatedWallTimeOption($wallTimeOption){}
115193
115194    /**
115195     * Set behavior for handling skipped wall times at positive timezone
115196     * offset transitions
115197     *
115198     * Sets the current strategy for dealing with wall times that are skipped
115199     * whenever the clock is forwarded during dailight saving time start
115200     * transitions. The default value is IntlCalendar::WALLTIME_LAST (take it
115201     * as being the same instant as the one when the wall time is one hour
115202     * more). Alternative values are IntlCalendar::WALLTIME_FIRST (same
115203     * instant as the one with a wall time of one hour less) and
115204     * IntlCalendar::WALLTIME_NEXT_VALID (same instant as when DST begins).
115205     *
115206     * This affects only the instant represented by the calendar (as reported
115207     * by {@link IntlCalendar::getTime}), the field values will not be
115208     * rewritten accordingly.
115209     *
115210     * The calendar must be lenient for this option to have any effect,
115211     * otherwise attempting to set a non-existing time will cause an error.
115212     *
115213     * This function requires ICU 4.9 or later.
115214     *
115215     * @param int $wallTimeOption The IntlCalendar resource.
115216     * @return bool Returns TRUE on success. Failure can only happen due to
115217     *   invalid parameters.
115218     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
115219     **/
115220    public function setSkippedWallTimeOption($wallTimeOption){}
115221
115222    /**
115223     * Set the calendar time in milliseconds since the epoch
115224     *
115225     * Sets the instant represented by this object. The instant is
115226     * represented by a float whose value should be an integer number of
115227     * milliseconds since the epoch (1 Jan 1970 00:00:00.000 UTC), ignoring
115228     * leap seconds. All the field values will be recalculated accordingly.
115229     *
115230     * @param float $date The IntlCalendar resource.
115231     * @return bool Returns TRUE on success and FALSE on failure.
115232     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
115233     **/
115234    public function setTime($date){}
115235
115236    /**
115237     * Set the timezone used by this calendar
115238     *
115239     * Defines a new timezone for this calendar. The time represented by the
115240     * object is preserved to the detriment of the field values.
115241     *
115242     * @param mixed $timeZone The IntlCalendar resource.
115243     * @return bool Returns TRUE on success and FALSE on failure.
115244     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
115245     **/
115246    public function setTimeZone($timeZone){}
115247
115248    /**
115249     * Convert an IntlCalendar into a DateTime object
115250     *
115251     * Create a DateTime object that represents the same instant (up to
115252     * second precision, with a rounding error of less than 1 second) and has
115253     * an analog timezone to this object (the difference being DateTimeʼs
115254     * timezone will be backed by PHPʼs timezone while IntlCalendarʼs
115255     * timezone is backed by ICUʼs).
115256     *
115257     * @return DateTime A DateTime object with the same timezone as this
115258     *   object (though using PHPʼs database instead of ICUʼs) and the same
115259     *   time, except for the smaller precision (second precision instead of
115260     *   millisecond). Returns FALSE on failure.
115261     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a2
115262     **/
115263    public function toDateTime(){}
115264
115265    /**
115266     * Private constructor for disallowing instantiation
115267     *
115268     * A private constructor for disallowing instantiation with the new
115269     * operator.
115270     *
115271     * Call {@link IntlCalendar::createInstance} instead.
115272     *
115273     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
115274     **/
115275    private function __construct(){}
115276
115277}
115278/**
115279 * IntlChar provides access to a number of utility methods that can be
115280 * used to access information about Unicode characters. The methods and
115281 * constants adhere closely to the names and behavior used by the
115282 * underlying ICU library.
115283 **/
115284class IntlChar {
115285    /**
115286     * @var integer
115287     **/
115288    const BLOCK_CODE_AEGEAN_NUMBERS = 0;
115289
115290    /**
115291     * @var integer
115292     **/
115293    const BLOCK_CODE_ALCHEMICAL_SYMBOLS = 0;
115294
115295    /**
115296     * @var integer
115297     **/
115298    const BLOCK_CODE_ALPHABETIC_PRESENTATION_FORMS = 0;
115299
115300    /**
115301     * @var integer
115302     **/
115303    const BLOCK_CODE_ANCIENT_GREEK_MUSICAL_NOTATION = 0;
115304
115305    /**
115306     * @var integer
115307     **/
115308    const BLOCK_CODE_ANCIENT_GREEK_NUMBERS = 0;
115309
115310    /**
115311     * @var integer
115312     **/
115313    const BLOCK_CODE_ANCIENT_SYMBOLS = 0;
115314
115315    /**
115316     * @var integer
115317     **/
115318    const BLOCK_CODE_ARABIC = 0;
115319
115320    /**
115321     * @var integer
115322     **/
115323    const BLOCK_CODE_ARABIC_EXTENDED_A = 0;
115324
115325    /**
115326     * @var integer
115327     **/
115328    const BLOCK_CODE_ARABIC_MATHEMATICAL_ALPHABETIC_SYMBOLS = 0;
115329
115330    /**
115331     * @var integer
115332     **/
115333    const BLOCK_CODE_ARABIC_PRESENTATION_FORMS_A = 0;
115334
115335    /**
115336     * @var integer
115337     **/
115338    const BLOCK_CODE_ARABIC_PRESENTATION_FORMS_B = 0;
115339
115340    /**
115341     * @var integer
115342     **/
115343    const BLOCK_CODE_ARABIC_SUPPLEMENT = 0;
115344
115345    /**
115346     * @var integer
115347     **/
115348    const BLOCK_CODE_ARMENIAN = 0;
115349
115350    /**
115351     * @var integer
115352     **/
115353    const BLOCK_CODE_ARROWS = 0;
115354
115355    /**
115356     * @var integer
115357     **/
115358    const BLOCK_CODE_AVESTAN = 0;
115359
115360    /**
115361     * @var integer
115362     **/
115363    const BLOCK_CODE_BALINESE = 0;
115364
115365    /**
115366     * @var integer
115367     **/
115368    const BLOCK_CODE_BAMUM = 0;
115369
115370    /**
115371     * @var integer
115372     **/
115373    const BLOCK_CODE_BAMUM_SUPPLEMENT = 0;
115374
115375    /**
115376     * @var integer
115377     **/
115378    const BLOCK_CODE_BASIC_LATIN = 0;
115379
115380    /**
115381     * @var integer
115382     **/
115383    const BLOCK_CODE_BATAK = 0;
115384
115385    /**
115386     * @var integer
115387     **/
115388    const BLOCK_CODE_BENGALI = 0;
115389
115390    /**
115391     * @var integer
115392     **/
115393    const BLOCK_CODE_BLOCK_ELEMENTS = 0;
115394
115395    /**
115396     * @var integer
115397     **/
115398    const BLOCK_CODE_BOPOMOFO = 0;
115399
115400    /**
115401     * @var integer
115402     **/
115403    const BLOCK_CODE_BOPOMOFO_EXTENDED = 0;
115404
115405    /**
115406     * @var integer
115407     **/
115408    const BLOCK_CODE_BOX_DRAWING = 0;
115409
115410    /**
115411     * @var integer
115412     **/
115413    const BLOCK_CODE_BRAHMI = 0;
115414
115415    /**
115416     * @var integer
115417     **/
115418    const BLOCK_CODE_BRAILLE_PATTERNS = 0;
115419
115420    /**
115421     * @var integer
115422     **/
115423    const BLOCK_CODE_BUGINESE = 0;
115424
115425    /**
115426     * @var integer
115427     **/
115428    const BLOCK_CODE_BUHID = 0;
115429
115430    /**
115431     * @var integer
115432     **/
115433    const BLOCK_CODE_BYZANTINE_MUSICAL_SYMBOLS = 0;
115434
115435    /**
115436     * @var integer
115437     **/
115438    const BLOCK_CODE_CARIAN = 0;
115439
115440    /**
115441     * @var integer
115442     **/
115443    const BLOCK_CODE_CHAKMA = 0;
115444
115445    /**
115446     * @var integer
115447     **/
115448    const BLOCK_CODE_CHAM = 0;
115449
115450    /**
115451     * @var integer
115452     **/
115453    const BLOCK_CODE_CHEROKEE = 0;
115454
115455    /**
115456     * @var integer
115457     **/
115458    const BLOCK_CODE_CJK_COMPATIBILITY = 0;
115459
115460    /**
115461     * @var integer
115462     **/
115463    const BLOCK_CODE_CJK_COMPATIBILITY_FORMS = 0;
115464
115465    /**
115466     * @var integer
115467     **/
115468    const BLOCK_CODE_CJK_COMPATIBILITY_IDEOGRAPHS = 0;
115469
115470    /**
115471     * @var integer
115472     **/
115473    const BLOCK_CODE_CJK_COMPATIBILITY_IDEOGRAPHS_SUPPLEMENT = 0;
115474
115475    /**
115476     * @var integer
115477     **/
115478    const BLOCK_CODE_CJK_RADICALS_SUPPLEMENT = 0;
115479
115480    /**
115481     * @var integer
115482     **/
115483    const BLOCK_CODE_CJK_STROKES = 0;
115484
115485    /**
115486     * @var integer
115487     **/
115488    const BLOCK_CODE_CJK_SYMBOLS_AND_PUNCTUATION = 0;
115489
115490    /**
115491     * @var integer
115492     **/
115493    const BLOCK_CODE_CJK_UNIFIED_IDEOGRAPHS = 0;
115494
115495    /**
115496     * @var integer
115497     **/
115498    const BLOCK_CODE_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_A = 0;
115499
115500    /**
115501     * @var integer
115502     **/
115503    const BLOCK_CODE_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_B = 0;
115504
115505    /**
115506     * @var integer
115507     **/
115508    const BLOCK_CODE_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_C = 0;
115509
115510    /**
115511     * @var integer
115512     **/
115513    const BLOCK_CODE_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_D = 0;
115514
115515    /**
115516     * @var integer
115517     **/
115518    const BLOCK_CODE_COMBINING_DIACRITICAL_MARKS = 0;
115519
115520    /**
115521     * @var integer
115522     **/
115523    const BLOCK_CODE_COMBINING_DIACRITICAL_MARKS_SUPPLEMENT = 0;
115524
115525    /**
115526     * @var integer
115527     **/
115528    const BLOCK_CODE_COMBINING_HALF_MARKS = 0;
115529
115530    /**
115531     * @var integer
115532     **/
115533    const BLOCK_CODE_COMBINING_MARKS_FOR_SYMBOLS = 0;
115534
115535    /**
115536     * @var integer
115537     **/
115538    const BLOCK_CODE_COMMON_INDIC_NUMBER_FORMS = 0;
115539
115540    /**
115541     * @var integer
115542     **/
115543    const BLOCK_CODE_CONTROL_PICTURES = 0;
115544
115545    /**
115546     * @var integer
115547     **/
115548    const BLOCK_CODE_COPTIC = 0;
115549
115550    /**
115551     * @var integer
115552     **/
115553    const BLOCK_CODE_COUNT = 0;
115554
115555    /**
115556     * @var integer
115557     **/
115558    const BLOCK_CODE_COUNTING_ROD_NUMERALS = 0;
115559
115560    /**
115561     * @var integer
115562     **/
115563    const BLOCK_CODE_CUNEIFORM = 0;
115564
115565    /**
115566     * @var integer
115567     **/
115568    const BLOCK_CODE_CUNEIFORM_NUMBERS_AND_PUNCTUATION = 0;
115569
115570    /**
115571     * @var integer
115572     **/
115573    const BLOCK_CODE_CURRENCY_SYMBOLS = 0;
115574
115575    /**
115576     * @var integer
115577     **/
115578    const BLOCK_CODE_CYPRIOT_SYLLABARY = 0;
115579
115580    /**
115581     * @var integer
115582     **/
115583    const BLOCK_CODE_CYRILLIC = 0;
115584
115585    /**
115586     * @var integer
115587     **/
115588    const BLOCK_CODE_CYRILLIC_EXTENDED_A = 0;
115589
115590    /**
115591     * @var integer
115592     **/
115593    const BLOCK_CODE_CYRILLIC_EXTENDED_B = 0;
115594
115595    /**
115596     * @var integer
115597     **/
115598    const BLOCK_CODE_CYRILLIC_SUPPLEMENT = 0;
115599
115600    /**
115601     * @var integer
115602     **/
115603    const BLOCK_CODE_CYRILLIC_SUPPLEMENTARY = 0;
115604
115605    /**
115606     * @var integer
115607     **/
115608    const BLOCK_CODE_DESERET = 0;
115609
115610    /**
115611     * @var integer
115612     **/
115613    const BLOCK_CODE_DEVANAGARI = 0;
115614
115615    /**
115616     * @var integer
115617     **/
115618    const BLOCK_CODE_DEVANAGARI_EXTENDED = 0;
115619
115620    /**
115621     * @var integer
115622     **/
115623    const BLOCK_CODE_DINGBATS = 0;
115624
115625    /**
115626     * @var integer
115627     **/
115628    const BLOCK_CODE_DOMINO_TILES = 0;
115629
115630    /**
115631     * @var integer
115632     **/
115633    const BLOCK_CODE_EGYPTIAN_HIEROGLYPHS = 0;
115634
115635    /**
115636     * @var integer
115637     **/
115638    const BLOCK_CODE_EMOTICONS = 0;
115639
115640    /**
115641     * @var integer
115642     **/
115643    const BLOCK_CODE_ENCLOSED_ALPHANUMERICS = 0;
115644
115645    /**
115646     * @var integer
115647     **/
115648    const BLOCK_CODE_ENCLOSED_ALPHANUMERIC_SUPPLEMENT = 0;
115649
115650    /**
115651     * @var integer
115652     **/
115653    const BLOCK_CODE_ENCLOSED_CJK_LETTERS_AND_MONTHS = 0;
115654
115655    /**
115656     * @var integer
115657     **/
115658    const BLOCK_CODE_ENCLOSED_IDEOGRAPHIC_SUPPLEMENT = 0;
115659
115660    /**
115661     * @var integer
115662     **/
115663    const BLOCK_CODE_ETHIOPIC = 0;
115664
115665    /**
115666     * @var integer
115667     **/
115668    const BLOCK_CODE_ETHIOPIC_EXTENDED = 0;
115669
115670    /**
115671     * @var integer
115672     **/
115673    const BLOCK_CODE_ETHIOPIC_EXTENDED_A = 0;
115674
115675    /**
115676     * @var integer
115677     **/
115678    const BLOCK_CODE_ETHIOPIC_SUPPLEMENT = 0;
115679
115680    /**
115681     * @var integer
115682     **/
115683    const BLOCK_CODE_GENERAL_PUNCTUATION = 0;
115684
115685    /**
115686     * @var integer
115687     **/
115688    const BLOCK_CODE_GEOMETRIC_SHAPES = 0;
115689
115690    /**
115691     * @var integer
115692     **/
115693    const BLOCK_CODE_GEORGIAN = 0;
115694
115695    /**
115696     * @var integer
115697     **/
115698    const BLOCK_CODE_GEORGIAN_SUPPLEMENT = 0;
115699
115700    /**
115701     * @var integer
115702     **/
115703    const BLOCK_CODE_GLAGOLITIC = 0;
115704
115705    /**
115706     * @var integer
115707     **/
115708    const BLOCK_CODE_GOTHIC = 0;
115709
115710    /**
115711     * @var integer
115712     **/
115713    const BLOCK_CODE_GREEK = 0;
115714
115715    /**
115716     * @var integer
115717     **/
115718    const BLOCK_CODE_GREEK_EXTENDED = 0;
115719
115720    /**
115721     * @var integer
115722     **/
115723    const BLOCK_CODE_GUJARATI = 0;
115724
115725    /**
115726     * @var integer
115727     **/
115728    const BLOCK_CODE_GURMUKHI = 0;
115729
115730    /**
115731     * @var integer
115732     **/
115733    const BLOCK_CODE_HALFWIDTH_AND_FULLWIDTH_FORMS = 0;
115734
115735    /**
115736     * @var integer
115737     **/
115738    const BLOCK_CODE_HANGUL_COMPATIBILITY_JAMO = 0;
115739
115740    /**
115741     * @var integer
115742     **/
115743    const BLOCK_CODE_HANGUL_JAMO = 0;
115744
115745    /**
115746     * @var integer
115747     **/
115748    const BLOCK_CODE_HANGUL_JAMO_EXTENDED_A = 0;
115749
115750    /**
115751     * @var integer
115752     **/
115753    const BLOCK_CODE_HANGUL_JAMO_EXTENDED_B = 0;
115754
115755    /**
115756     * @var integer
115757     **/
115758    const BLOCK_CODE_HANGUL_SYLLABLES = 0;
115759
115760    /**
115761     * @var integer
115762     **/
115763    const BLOCK_CODE_HANUNOO = 0;
115764
115765    /**
115766     * @var integer
115767     **/
115768    const BLOCK_CODE_HEBREW = 0;
115769
115770    /**
115771     * @var integer
115772     **/
115773    const BLOCK_CODE_HIGH_PRIVATE_USE_SURROGATES = 0;
115774
115775    /**
115776     * @var integer
115777     **/
115778    const BLOCK_CODE_HIGH_SURROGATES = 0;
115779
115780    /**
115781     * @var integer
115782     **/
115783    const BLOCK_CODE_HIRAGANA = 0;
115784
115785    /**
115786     * @var integer
115787     **/
115788    const BLOCK_CODE_IDEOGRAPHIC_DESCRIPTION_CHARACTERS = 0;
115789
115790    /**
115791     * @var integer
115792     **/
115793    const BLOCK_CODE_IMPERIAL_ARAMAIC = 0;
115794
115795    /**
115796     * @var integer
115797     **/
115798    const BLOCK_CODE_INSCRIPTIONAL_PAHLAVI = 0;
115799
115800    /**
115801     * @var integer
115802     **/
115803    const BLOCK_CODE_INSCRIPTIONAL_PARTHIAN = 0;
115804
115805    /**
115806     * @var integer
115807     **/
115808    const BLOCK_CODE_INVALID_CODE = 0;
115809
115810    /**
115811     * @var integer
115812     **/
115813    const BLOCK_CODE_IPA_EXTENSIONS = 0;
115814
115815    /**
115816     * @var integer
115817     **/
115818    const BLOCK_CODE_JAVANESE = 0;
115819
115820    /**
115821     * @var integer
115822     **/
115823    const BLOCK_CODE_KAITHI = 0;
115824
115825    /**
115826     * @var integer
115827     **/
115828    const BLOCK_CODE_KANA_SUPPLEMENT = 0;
115829
115830    /**
115831     * @var integer
115832     **/
115833    const BLOCK_CODE_KANBUN = 0;
115834
115835    /**
115836     * @var integer
115837     **/
115838    const BLOCK_CODE_KANGXI_RADICALS = 0;
115839
115840    /**
115841     * @var integer
115842     **/
115843    const BLOCK_CODE_KANNADA = 0;
115844
115845    /**
115846     * @var integer
115847     **/
115848    const BLOCK_CODE_KATAKANA = 0;
115849
115850    /**
115851     * @var integer
115852     **/
115853    const BLOCK_CODE_KATAKANA_PHONETIC_EXTENSIONS = 0;
115854
115855    /**
115856     * @var integer
115857     **/
115858    const BLOCK_CODE_KAYAH_LI = 0;
115859
115860    /**
115861     * @var integer
115862     **/
115863    const BLOCK_CODE_KHAROSHTHI = 0;
115864
115865    /**
115866     * @var integer
115867     **/
115868    const BLOCK_CODE_KHMER = 0;
115869
115870    /**
115871     * @var integer
115872     **/
115873    const BLOCK_CODE_KHMER_SYMBOLS = 0;
115874
115875    /**
115876     * @var integer
115877     **/
115878    const BLOCK_CODE_LAO = 0;
115879
115880    /**
115881     * @var integer
115882     **/
115883    const BLOCK_CODE_LATIN_1_SUPPLEMENT = 0;
115884
115885    /**
115886     * @var integer
115887     **/
115888    const BLOCK_CODE_LATIN_EXTENDED_A = 0;
115889
115890    /**
115891     * @var integer
115892     **/
115893    const BLOCK_CODE_LATIN_EXTENDED_ADDITIONAL = 0;
115894
115895    /**
115896     * @var integer
115897     **/
115898    const BLOCK_CODE_LATIN_EXTENDED_B = 0;
115899
115900    /**
115901     * @var integer
115902     **/
115903    const BLOCK_CODE_LATIN_EXTENDED_C = 0;
115904
115905    /**
115906     * @var integer
115907     **/
115908    const BLOCK_CODE_LATIN_EXTENDED_D = 0;
115909
115910    /**
115911     * @var integer
115912     **/
115913    const BLOCK_CODE_LEPCHA = 0;
115914
115915    /**
115916     * @var integer
115917     **/
115918    const BLOCK_CODE_LETTERLIKE_SYMBOLS = 0;
115919
115920    /**
115921     * @var integer
115922     **/
115923    const BLOCK_CODE_LIMBU = 0;
115924
115925    /**
115926     * @var integer
115927     **/
115928    const BLOCK_CODE_LINEAR_B_IDEOGRAMS = 0;
115929
115930    /**
115931     * @var integer
115932     **/
115933    const BLOCK_CODE_LINEAR_B_SYLLABARY = 0;
115934
115935    /**
115936     * @var integer
115937     **/
115938    const BLOCK_CODE_LISU = 0;
115939
115940    /**
115941     * @var integer
115942     **/
115943    const BLOCK_CODE_LOW_SURROGATES = 0;
115944
115945    /**
115946     * @var integer
115947     **/
115948    const BLOCK_CODE_LYCIAN = 0;
115949
115950    /**
115951     * @var integer
115952     **/
115953    const BLOCK_CODE_LYDIAN = 0;
115954
115955    /**
115956     * @var integer
115957     **/
115958    const BLOCK_CODE_MAHJONG_TILES = 0;
115959
115960    /**
115961     * @var integer
115962     **/
115963    const BLOCK_CODE_MALAYALAM = 0;
115964
115965    /**
115966     * @var integer
115967     **/
115968    const BLOCK_CODE_MANDAIC = 0;
115969
115970    /**
115971     * @var integer
115972     **/
115973    const BLOCK_CODE_MATHEMATICAL_ALPHANUMERIC_SYMBOLS = 0;
115974
115975    /**
115976     * @var integer
115977     **/
115978    const BLOCK_CODE_MATHEMATICAL_OPERATORS = 0;
115979
115980    /**
115981     * @var integer
115982     **/
115983    const BLOCK_CODE_MEETEI_MAYEK = 0;
115984
115985    /**
115986     * @var integer
115987     **/
115988    const BLOCK_CODE_MEETEI_MAYEK_EXTENSIONS = 0;
115989
115990    /**
115991     * @var integer
115992     **/
115993    const BLOCK_CODE_MEROITIC_CURSIVE = 0;
115994
115995    /**
115996     * @var integer
115997     **/
115998    const BLOCK_CODE_MEROITIC_HIEROGLYPHS = 0;
115999
116000    /**
116001     * @var integer
116002     **/
116003    const BLOCK_CODE_MIAO = 0;
116004
116005    /**
116006     * @var integer
116007     **/
116008    const BLOCK_CODE_MISCELLANEOUS_MATHEMATICAL_SYMBOLS_A = 0;
116009
116010    /**
116011     * @var integer
116012     **/
116013    const BLOCK_CODE_MISCELLANEOUS_MATHEMATICAL_SYMBOLS_B = 0;
116014
116015    /**
116016     * @var integer
116017     **/
116018    const BLOCK_CODE_MISCELLANEOUS_SYMBOLS = 0;
116019
116020    /**
116021     * @var integer
116022     **/
116023    const BLOCK_CODE_MISCELLANEOUS_SYMBOLS_AND_ARROWS = 0;
116024
116025    /**
116026     * @var integer
116027     **/
116028    const BLOCK_CODE_MISCELLANEOUS_SYMBOLS_AND_PICTOGRAPHS = 0;
116029
116030    /**
116031     * @var integer
116032     **/
116033    const BLOCK_CODE_MISCELLANEOUS_TECHNICAL = 0;
116034
116035    /**
116036     * @var integer
116037     **/
116038    const BLOCK_CODE_MODIFIER_TONE_LETTERS = 0;
116039
116040    /**
116041     * @var integer
116042     **/
116043    const BLOCK_CODE_MONGOLIAN = 0;
116044
116045    /**
116046     * @var integer
116047     **/
116048    const BLOCK_CODE_MUSICAL_SYMBOLS = 0;
116049
116050    /**
116051     * @var integer
116052     **/
116053    const BLOCK_CODE_MYANMAR = 0;
116054
116055    /**
116056     * @var integer
116057     **/
116058    const BLOCK_CODE_MYANMAR_EXTENDED_A = 0;
116059
116060    /**
116061     * @var integer
116062     **/
116063    const BLOCK_CODE_NEW_TAI_LUE = 0;
116064
116065    /**
116066     * @var integer
116067     **/
116068    const BLOCK_CODE_NKO = 0;
116069
116070    /**
116071     * @var integer
116072     **/
116073    const BLOCK_CODE_NO_BLOCK = 0;
116074
116075    /**
116076     * @var integer
116077     **/
116078    const BLOCK_CODE_NUMBER_FORMS = 0;
116079
116080    /**
116081     * @var integer
116082     **/
116083    const BLOCK_CODE_OGHAM = 0;
116084
116085    /**
116086     * @var integer
116087     **/
116088    const BLOCK_CODE_OLD_ITALIC = 0;
116089
116090    /**
116091     * @var integer
116092     **/
116093    const BLOCK_CODE_OLD_PERSIAN = 0;
116094
116095    /**
116096     * @var integer
116097     **/
116098    const BLOCK_CODE_OLD_SOUTH_ARABIAN = 0;
116099
116100    /**
116101     * @var integer
116102     **/
116103    const BLOCK_CODE_OLD_TURKIC = 0;
116104
116105    /**
116106     * @var integer
116107     **/
116108    const BLOCK_CODE_OL_CHIKI = 0;
116109
116110    /**
116111     * @var integer
116112     **/
116113    const BLOCK_CODE_OPTICAL_CHARACTER_RECOGNITION = 0;
116114
116115    /**
116116     * @var integer
116117     **/
116118    const BLOCK_CODE_ORIYA = 0;
116119
116120    /**
116121     * @var integer
116122     **/
116123    const BLOCK_CODE_OSMANYA = 0;
116124
116125    /**
116126     * @var integer
116127     **/
116128    const BLOCK_CODE_PHAGS_PA = 0;
116129
116130    /**
116131     * @var integer
116132     **/
116133    const BLOCK_CODE_PHAISTOS_DISC = 0;
116134
116135    /**
116136     * @var integer
116137     **/
116138    const BLOCK_CODE_PHOENICIAN = 0;
116139
116140    /**
116141     * @var integer
116142     **/
116143    const BLOCK_CODE_PHONETIC_EXTENSIONS = 0;
116144
116145    /**
116146     * @var integer
116147     **/
116148    const BLOCK_CODE_PHONETIC_EXTENSIONS_SUPPLEMENT = 0;
116149
116150    /**
116151     * @var integer
116152     **/
116153    const BLOCK_CODE_PLAYING_CARDS = 0;
116154
116155    /**
116156     * @var integer
116157     **/
116158    const BLOCK_CODE_PRIVATE_USE = 0;
116159
116160    /**
116161     * @var integer
116162     **/
116163    const BLOCK_CODE_PRIVATE_USE_AREA = 0;
116164
116165    /**
116166     * @var integer
116167     **/
116168    const BLOCK_CODE_REJANG = 0;
116169
116170    /**
116171     * @var integer
116172     **/
116173    const BLOCK_CODE_RUMI_NUMERAL_SYMBOLS = 0;
116174
116175    /**
116176     * @var integer
116177     **/
116178    const BLOCK_CODE_RUNIC = 0;
116179
116180    /**
116181     * @var integer
116182     **/
116183    const BLOCK_CODE_SAMARITAN = 0;
116184
116185    /**
116186     * @var integer
116187     **/
116188    const BLOCK_CODE_SAURASHTRA = 0;
116189
116190    /**
116191     * @var integer
116192     **/
116193    const BLOCK_CODE_SHARADA = 0;
116194
116195    /**
116196     * @var integer
116197     **/
116198    const BLOCK_CODE_SHAVIAN = 0;
116199
116200    /**
116201     * @var integer
116202     **/
116203    const BLOCK_CODE_SINHALA = 0;
116204
116205    /**
116206     * @var integer
116207     **/
116208    const BLOCK_CODE_SMALL_FORM_VARIANTS = 0;
116209
116210    /**
116211     * @var integer
116212     **/
116213    const BLOCK_CODE_SORA_SOMPENG = 0;
116214
116215    /**
116216     * @var integer
116217     **/
116218    const BLOCK_CODE_SPACING_MODIFIER_LETTERS = 0;
116219
116220    /**
116221     * @var integer
116222     **/
116223    const BLOCK_CODE_SPECIALS = 0;
116224
116225    /**
116226     * @var integer
116227     **/
116228    const BLOCK_CODE_SUNDANESE = 0;
116229
116230    /**
116231     * @var integer
116232     **/
116233    const BLOCK_CODE_SUNDANESE_SUPPLEMENT = 0;
116234
116235    /**
116236     * @var integer
116237     **/
116238    const BLOCK_CODE_SUPERSCRIPTS_AND_SUBSCRIPTS = 0;
116239
116240    /**
116241     * @var integer
116242     **/
116243    const BLOCK_CODE_SUPPLEMENTAL_ARROWS_A = 0;
116244
116245    /**
116246     * @var integer
116247     **/
116248    const BLOCK_CODE_SUPPLEMENTAL_ARROWS_B = 0;
116249
116250    /**
116251     * @var integer
116252     **/
116253    const BLOCK_CODE_SUPPLEMENTAL_MATHEMATICAL_OPERATORS = 0;
116254
116255    /**
116256     * @var integer
116257     **/
116258    const BLOCK_CODE_SUPPLEMENTAL_PUNCTUATION = 0;
116259
116260    /**
116261     * @var integer
116262     **/
116263    const BLOCK_CODE_SUPPLEMENTARY_PRIVATE_USE_AREA_A = 0;
116264
116265    /**
116266     * @var integer
116267     **/
116268    const BLOCK_CODE_SUPPLEMENTARY_PRIVATE_USE_AREA_B = 0;
116269
116270    /**
116271     * @var integer
116272     **/
116273    const BLOCK_CODE_SYLOTI_NAGRI = 0;
116274
116275    /**
116276     * @var integer
116277     **/
116278    const BLOCK_CODE_SYRIAC = 0;
116279
116280    /**
116281     * @var integer
116282     **/
116283    const BLOCK_CODE_TAGALOG = 0;
116284
116285    /**
116286     * @var integer
116287     **/
116288    const BLOCK_CODE_TAGBANWA = 0;
116289
116290    /**
116291     * @var integer
116292     **/
116293    const BLOCK_CODE_TAGS = 0;
116294
116295    /**
116296     * @var integer
116297     **/
116298    const BLOCK_CODE_TAI_LE = 0;
116299
116300    /**
116301     * @var integer
116302     **/
116303    const BLOCK_CODE_TAI_THAM = 0;
116304
116305    /**
116306     * @var integer
116307     **/
116308    const BLOCK_CODE_TAI_VIET = 0;
116309
116310    /**
116311     * @var integer
116312     **/
116313    const BLOCK_CODE_TAI_XUAN_JING_SYMBOLS = 0;
116314
116315    /**
116316     * @var integer
116317     **/
116318    const BLOCK_CODE_TAKRI = 0;
116319
116320    /**
116321     * @var integer
116322     **/
116323    const BLOCK_CODE_TAMIL = 0;
116324
116325    /**
116326     * @var integer
116327     **/
116328    const BLOCK_CODE_TELUGU = 0;
116329
116330    /**
116331     * @var integer
116332     **/
116333    const BLOCK_CODE_THAANA = 0;
116334
116335    /**
116336     * @var integer
116337     **/
116338    const BLOCK_CODE_THAI = 0;
116339
116340    /**
116341     * @var integer
116342     **/
116343    const BLOCK_CODE_TIBETAN = 0;
116344
116345    /**
116346     * @var integer
116347     **/
116348    const BLOCK_CODE_TIFINAGH = 0;
116349
116350    /**
116351     * @var integer
116352     **/
116353    const BLOCK_CODE_TRANSPORT_AND_MAP_SYMBOLS = 0;
116354
116355    /**
116356     * @var integer
116357     **/
116358    const BLOCK_CODE_UGARITIC = 0;
116359
116360    /**
116361     * @var integer
116362     **/
116363    const BLOCK_CODE_UNIFIED_CANADIAN_ABORIGINAL_SYLLABICS = 0;
116364
116365    /**
116366     * @var integer
116367     **/
116368    const BLOCK_CODE_UNIFIED_CANADIAN_ABORIGINAL_SYLLABICS_EXTENDED = 0;
116369
116370    /**
116371     * @var integer
116372     **/
116373    const BLOCK_CODE_VAI = 0;
116374
116375    /**
116376     * @var integer
116377     **/
116378    const BLOCK_CODE_VARIATION_SELECTORS = 0;
116379
116380    /**
116381     * @var integer
116382     **/
116383    const BLOCK_CODE_VARIATION_SELECTORS_SUPPLEMENT = 0;
116384
116385    /**
116386     * @var integer
116387     **/
116388    const BLOCK_CODE_VEDIC_EXTENSIONS = 0;
116389
116390    /**
116391     * @var integer
116392     **/
116393    const BLOCK_CODE_VERTICAL_FORMS = 0;
116394
116395    /**
116396     * @var integer
116397     **/
116398    const BLOCK_CODE_YIJING_HEXAGRAM_SYMBOLS = 0;
116399
116400    /**
116401     * @var integer
116402     **/
116403    const BLOCK_CODE_YI_RADICALS = 0;
116404
116405    /**
116406     * @var integer
116407     **/
116408    const BLOCK_CODE_YI_SYLLABLES = 0;
116409
116410    /**
116411     * @var integer
116412     **/
116413    const BPT_CLOSE = 0;
116414
116415    /**
116416     * @var integer
116417     **/
116418    const BPT_COUNT = 0;
116419
116420    /**
116421     * @var integer
116422     **/
116423    const BPT_NONE = 0;
116424
116425    /**
116426     * @var integer
116427     **/
116428    const BPT_OPEN = 0;
116429
116430    /**
116431     * @var integer
116432     **/
116433    const CHAR_CATEGORY_CHAR_CATEGORY_COUNT = 0;
116434
116435    /**
116436     * @var integer
116437     **/
116438    const CHAR_CATEGORY_COMBINING_SPACING_MARK = 0;
116439
116440    /**
116441     * @var integer
116442     **/
116443    const CHAR_CATEGORY_CONNECTOR_PUNCTUATION = 0;
116444
116445    /**
116446     * @var integer
116447     **/
116448    const CHAR_CATEGORY_CONTROL_CHAR = 0;
116449
116450    /**
116451     * @var integer
116452     **/
116453    const CHAR_CATEGORY_CURRENCY_SYMBOL = 0;
116454
116455    /**
116456     * @var integer
116457     **/
116458    const CHAR_CATEGORY_DASH_PUNCTUATION = 0;
116459
116460    /**
116461     * @var integer
116462     **/
116463    const CHAR_CATEGORY_DECIMAL_DIGIT_NUMBER = 0;
116464
116465    /**
116466     * @var integer
116467     **/
116468    const CHAR_CATEGORY_ENCLOSING_MARK = 0;
116469
116470    /**
116471     * @var integer
116472     **/
116473    const CHAR_CATEGORY_END_PUNCTUATION = 0;
116474
116475    /**
116476     * @var integer
116477     **/
116478    const CHAR_CATEGORY_FINAL_PUNCTUATION = 0;
116479
116480    /**
116481     * @var integer
116482     **/
116483    const CHAR_CATEGORY_FORMAT_CHAR = 0;
116484
116485    /**
116486     * @var integer
116487     **/
116488    const CHAR_CATEGORY_GENERAL_OTHER_TYPES = 0;
116489
116490    /**
116491     * @var integer
116492     **/
116493    const CHAR_CATEGORY_INITIAL_PUNCTUATION = 0;
116494
116495    /**
116496     * @var integer
116497     **/
116498    const CHAR_CATEGORY_LETTER_NUMBER = 0;
116499
116500    /**
116501     * @var integer
116502     **/
116503    const CHAR_CATEGORY_LINE_SEPARATOR = 0;
116504
116505    /**
116506     * @var integer
116507     **/
116508    const CHAR_CATEGORY_LOWERCASE_LETTER = 0;
116509
116510    /**
116511     * @var integer
116512     **/
116513    const CHAR_CATEGORY_MATH_SYMBOL = 0;
116514
116515    /**
116516     * @var integer
116517     **/
116518    const CHAR_CATEGORY_MODIFIER_LETTER = 0;
116519
116520    /**
116521     * @var integer
116522     **/
116523    const CHAR_CATEGORY_MODIFIER_SYMBOL = 0;
116524
116525    /**
116526     * @var integer
116527     **/
116528    const CHAR_CATEGORY_NON_SPACING_MARK = 0;
116529
116530    /**
116531     * @var integer
116532     **/
116533    const CHAR_CATEGORY_OTHER_LETTER = 0;
116534
116535    /**
116536     * @var integer
116537     **/
116538    const CHAR_CATEGORY_OTHER_NUMBER = 0;
116539
116540    /**
116541     * @var integer
116542     **/
116543    const CHAR_CATEGORY_OTHER_PUNCTUATION = 0;
116544
116545    /**
116546     * @var integer
116547     **/
116548    const CHAR_CATEGORY_OTHER_SYMBOL = 0;
116549
116550    /**
116551     * @var integer
116552     **/
116553    const CHAR_CATEGORY_PARAGRAPH_SEPARATOR = 0;
116554
116555    /**
116556     * @var integer
116557     **/
116558    const CHAR_CATEGORY_PRIVATE_USE_CHAR = 0;
116559
116560    /**
116561     * @var integer
116562     **/
116563    const CHAR_CATEGORY_SPACE_SEPARATOR = 0;
116564
116565    /**
116566     * @var integer
116567     **/
116568    const CHAR_CATEGORY_START_PUNCTUATION = 0;
116569
116570    /**
116571     * @var integer
116572     **/
116573    const CHAR_CATEGORY_SURROGATE = 0;
116574
116575    /**
116576     * @var integer
116577     **/
116578    const CHAR_CATEGORY_TITLECASE_LETTER = 0;
116579
116580    /**
116581     * @var integer
116582     **/
116583    const CHAR_CATEGORY_UNASSIGNED = 0;
116584
116585    /**
116586     * @var integer
116587     **/
116588    const CHAR_CATEGORY_UPPERCASE_LETTER = 0;
116589
116590    /**
116591     * @var integer
116592     **/
116593    const CHAR_DIRECTION_ARABIC_NUMBER = 0;
116594
116595    /**
116596     * @var integer
116597     **/
116598    const CHAR_DIRECTION_BLOCK_SEPARATOR = 0;
116599
116600    /**
116601     * @var integer
116602     **/
116603    const CHAR_DIRECTION_BOUNDARY_NEUTRAL = 0;
116604
116605    /**
116606     * @var integer
116607     **/
116608    const CHAR_DIRECTION_CHAR_DIRECTION_COUNT = 0;
116609
116610    /**
116611     * @var integer
116612     **/
116613    const CHAR_DIRECTION_COMMON_NUMBER_SEPARATOR = 0;
116614
116615    /**
116616     * @var integer
116617     **/
116618    const CHAR_DIRECTION_DIR_NON_SPACING_MARK = 0;
116619
116620    /**
116621     * @var integer
116622     **/
116623    const CHAR_DIRECTION_EUROPEAN_NUMBER = 0;
116624
116625    /**
116626     * @var integer
116627     **/
116628    const CHAR_DIRECTION_EUROPEAN_NUMBER_SEPARATOR = 0;
116629
116630    /**
116631     * @var integer
116632     **/
116633    const CHAR_DIRECTION_EUROPEAN_NUMBER_TERMINATOR = 0;
116634
116635    /**
116636     * @var integer
116637     **/
116638    const CHAR_DIRECTION_FIRST_STRONG_ISOLATE = 0;
116639
116640    /**
116641     * @var integer
116642     **/
116643    const CHAR_DIRECTION_LEFT_TO_RIGHT = 0;
116644
116645    /**
116646     * @var integer
116647     **/
116648    const CHAR_DIRECTION_LEFT_TO_RIGHT_EMBEDDING = 0;
116649
116650    /**
116651     * @var integer
116652     **/
116653    const CHAR_DIRECTION_LEFT_TO_RIGHT_ISOLATE = 0;
116654
116655    /**
116656     * @var integer
116657     **/
116658    const CHAR_DIRECTION_LEFT_TO_RIGHT_OVERRIDE = 0;
116659
116660    /**
116661     * @var integer
116662     **/
116663    const CHAR_DIRECTION_OTHER_NEUTRAL = 0;
116664
116665    /**
116666     * @var integer
116667     **/
116668    const CHAR_DIRECTION_POP_DIRECTIONAL_FORMAT = 0;
116669
116670    /**
116671     * @var integer
116672     **/
116673    const CHAR_DIRECTION_POP_DIRECTIONAL_ISOLATE = 0;
116674
116675    /**
116676     * @var integer
116677     **/
116678    const CHAR_DIRECTION_RIGHT_TO_LEFT = 0;
116679
116680    /**
116681     * @var integer
116682     **/
116683    const CHAR_DIRECTION_RIGHT_TO_LEFT_ARABIC = 0;
116684
116685    /**
116686     * @var integer
116687     **/
116688    const CHAR_DIRECTION_RIGHT_TO_LEFT_EMBEDDING = 0;
116689
116690    /**
116691     * @var integer
116692     **/
116693    const CHAR_DIRECTION_RIGHT_TO_LEFT_ISOLATE = 0;
116694
116695    /**
116696     * @var integer
116697     **/
116698    const CHAR_DIRECTION_RIGHT_TO_LEFT_OVERRIDE = 0;
116699
116700    /**
116701     * @var integer
116702     **/
116703    const CHAR_DIRECTION_SEGMENT_SEPARATOR = 0;
116704
116705    /**
116706     * @var integer
116707     **/
116708    const CHAR_DIRECTION_WHITE_SPACE_NEUTRAL = 0;
116709
116710    /**
116711     * @var integer
116712     **/
116713    const CHAR_NAME_ALIAS = 0;
116714
116715    /**
116716     * @var integer
116717     **/
116718    const CHAR_NAME_CHOICE_COUNT = 0;
116719
116720    /**
116721     * @var integer
116722     **/
116723    const CODEPOINT_MAX = 0;
116724
116725    /**
116726     * @var integer
116727     **/
116728    const CODEPOINT_MIN = 0;
116729
116730    /**
116731     * @var integer
116732     **/
116733    const DT_CANONICAL = 0;
116734
116735    /**
116736     * @var integer
116737     **/
116738    const DT_CIRCLE = 0;
116739
116740    /**
116741     * @var integer
116742     **/
116743    const DT_COMPAT = 0;
116744
116745    /**
116746     * @var integer
116747     **/
116748    const DT_COUNT = 0;
116749
116750    /**
116751     * @var integer
116752     **/
116753    const DT_FINAL = 0;
116754
116755    /**
116756     * @var integer
116757     **/
116758    const DT_FONT = 0;
116759
116760    /**
116761     * @var integer
116762     **/
116763    const DT_FRACTION = 0;
116764
116765    /**
116766     * @var integer
116767     **/
116768    const DT_INITIAL = 0;
116769
116770    /**
116771     * @var integer
116772     **/
116773    const DT_ISOLATED = 0;
116774
116775    /**
116776     * @var integer
116777     **/
116778    const DT_MEDIAL = 0;
116779
116780    /**
116781     * @var integer
116782     **/
116783    const DT_NARROW = 0;
116784
116785    /**
116786     * @var integer
116787     **/
116788    const DT_NOBREAK = 0;
116789
116790    /**
116791     * @var integer
116792     **/
116793    const DT_NONE = 0;
116794
116795    /**
116796     * @var integer
116797     **/
116798    const DT_SMALL = 0;
116799
116800    /**
116801     * @var integer
116802     **/
116803    const DT_SQUARE = 0;
116804
116805    /**
116806     * @var integer
116807     **/
116808    const DT_SUB = 0;
116809
116810    /**
116811     * @var integer
116812     **/
116813    const DT_SUPER = 0;
116814
116815    /**
116816     * @var integer
116817     **/
116818    const DT_VERTICAL = 0;
116819
116820    /**
116821     * @var integer
116822     **/
116823    const DT_WIDE = 0;
116824
116825    /**
116826     * @var integer
116827     **/
116828    const EA_AMBIGUOUS = 0;
116829
116830    /**
116831     * @var integer
116832     **/
116833    const EA_COUNT = 0;
116834
116835    /**
116836     * @var integer
116837     **/
116838    const EA_FULLWIDTH = 0;
116839
116840    /**
116841     * @var integer
116842     **/
116843    const EA_HALFWIDTH = 0;
116844
116845    /**
116846     * @var integer
116847     **/
116848    const EA_NARROW = 0;
116849
116850    /**
116851     * @var integer
116852     **/
116853    const EA_NEUTRAL = 0;
116854
116855    /**
116856     * @var integer
116857     **/
116858    const EA_WIDE = 0;
116859
116860    /**
116861     * @var integer
116862     **/
116863    const EXTENDED_CHAR_NAME = 0;
116864
116865    /**
116866     * @var mixed
116867     **/
116868    const FOLD_CASE_DEFAULT = 0;
116869
116870    /**
116871     * @var mixed
116872     **/
116873    const FOLD_CASE_EXCLUDE_SPECIAL_I = 0;
116874
116875    /**
116876     * @var integer
116877     **/
116878    const GCB_CONTROL = 0;
116879
116880    /**
116881     * @var integer
116882     **/
116883    const GCB_COUNT = 0;
116884
116885    /**
116886     * @var integer
116887     **/
116888    const GCB_CR = 0;
116889
116890    /**
116891     * @var integer
116892     **/
116893    const GCB_EXTEND = 0;
116894
116895    /**
116896     * @var integer
116897     **/
116898    const GCB_L = 0;
116899
116900    /**
116901     * @var integer
116902     **/
116903    const GCB_LF = 0;
116904
116905    /**
116906     * @var integer
116907     **/
116908    const GCB_LV = 0;
116909
116910    /**
116911     * @var integer
116912     **/
116913    const GCB_LVT = 0;
116914
116915    /**
116916     * @var integer
116917     **/
116918    const GCB_OTHER = 0;
116919
116920    /**
116921     * @var integer
116922     **/
116923    const GCB_PREPEND = 0;
116924
116925    /**
116926     * @var integer
116927     **/
116928    const GCB_REGIONAL_INDICATOR = 0;
116929
116930    /**
116931     * @var integer
116932     **/
116933    const GCB_SPACING_MARK = 0;
116934
116935    /**
116936     * @var integer
116937     **/
116938    const GCB_T = 0;
116939
116940    /**
116941     * @var integer
116942     **/
116943    const GCB_V = 0;
116944
116945    /**
116946     * @var integer
116947     **/
116948    const HST_COUNT = 0;
116949
116950    /**
116951     * @var integer
116952     **/
116953    const HST_LEADING_JAMO = 0;
116954
116955    /**
116956     * @var integer
116957     **/
116958    const HST_LVT_SYLLABLE = 0;
116959
116960    /**
116961     * @var integer
116962     **/
116963    const HST_LV_SYLLABLE = 0;
116964
116965    /**
116966     * @var integer
116967     **/
116968    const HST_NOT_APPLICABLE = 0;
116969
116970    /**
116971     * @var integer
116972     **/
116973    const HST_TRAILING_JAMO = 0;
116974
116975    /**
116976     * @var integer
116977     **/
116978    const HST_VOWEL_JAMO = 0;
116979
116980    /**
116981     * @var integer
116982     **/
116983    const JG_AIN = 0;
116984
116985    /**
116986     * @var integer
116987     **/
116988    const JG_ALAPH = 0;
116989
116990    /**
116991     * @var integer
116992     **/
116993    const JG_ALEF = 0;
116994
116995    /**
116996     * @var integer
116997     **/
116998    const JG_BEH = 0;
116999
117000    /**
117001     * @var integer
117002     **/
117003    const JG_BETH = 0;
117004
117005    /**
117006     * @var integer
117007     **/
117008    const JG_BURUSHASKI_YEH_BARREE = 0;
117009
117010    /**
117011     * @var integer
117012     **/
117013    const JG_COUNT = 0;
117014
117015    /**
117016     * @var integer
117017     **/
117018    const JG_DAL = 0;
117019
117020    /**
117021     * @var integer
117022     **/
117023    const JG_DALATH_RISH = 0;
117024
117025    /**
117026     * @var integer
117027     **/
117028    const JG_E = 0;
117029
117030    /**
117031     * @var integer
117032     **/
117033    const JG_FARSI_YEH = 0;
117034
117035    /**
117036     * @var integer
117037     **/
117038    const JG_FE = 0;
117039
117040    /**
117041     * @var integer
117042     **/
117043    const JG_FEH = 0;
117044
117045    /**
117046     * @var integer
117047     **/
117048    const JG_FINAL_SEMKATH = 0;
117049
117050    /**
117051     * @var integer
117052     **/
117053    const JG_GAF = 0;
117054
117055    /**
117056     * @var integer
117057     **/
117058    const JG_GAMAL = 0;
117059
117060    /**
117061     * @var integer
117062     **/
117063    const JG_HAH = 0;
117064
117065    /**
117066     * @var integer
117067     **/
117068    const JG_HAMZA_ON_HEH_GOAL = 0;
117069
117070    /**
117071     * @var integer
117072     **/
117073    const JG_HE = 0;
117074
117075    /**
117076     * @var integer
117077     **/
117078    const JG_HEH = 0;
117079
117080    /**
117081     * @var integer
117082     **/
117083    const JG_HEH_GOAL = 0;
117084
117085    /**
117086     * @var integer
117087     **/
117088    const JG_HETH = 0;
117089
117090    /**
117091     * @var integer
117092     **/
117093    const JG_KAF = 0;
117094
117095    /**
117096     * @var integer
117097     **/
117098    const JG_KAPH = 0;
117099
117100    /**
117101     * @var integer
117102     **/
117103    const JG_KHAPH = 0;
117104
117105    /**
117106     * @var integer
117107     **/
117108    const JG_KNOTTED_HEH = 0;
117109
117110    /**
117111     * @var integer
117112     **/
117113    const JG_LAM = 0;
117114
117115    /**
117116     * @var integer
117117     **/
117118    const JG_LAMADH = 0;
117119
117120    /**
117121     * @var integer
117122     **/
117123    const JG_MEEM = 0;
117124
117125    /**
117126     * @var integer
117127     **/
117128    const JG_MIM = 0;
117129
117130    /**
117131     * @var integer
117132     **/
117133    const JG_NOON = 0;
117134
117135    /**
117136     * @var integer
117137     **/
117138    const JG_NO_JOINING_GROUP = 0;
117139
117140    /**
117141     * @var integer
117142     **/
117143    const JG_NUN = 0;
117144
117145    /**
117146     * @var integer
117147     **/
117148    const JG_NYA = 0;
117149
117150    /**
117151     * @var integer
117152     **/
117153    const JG_PE = 0;
117154
117155    /**
117156     * @var integer
117157     **/
117158    const JG_QAF = 0;
117159
117160    /**
117161     * @var integer
117162     **/
117163    const JG_QAPH = 0;
117164
117165    /**
117166     * @var integer
117167     **/
117168    const JG_REH = 0;
117169
117170    /**
117171     * @var integer
117172     **/
117173    const JG_REVERSED_PE = 0;
117174
117175    /**
117176     * @var integer
117177     **/
117178    const JG_ROHINGYA_YEH = 0;
117179
117180    /**
117181     * @var integer
117182     **/
117183    const JG_SAD = 0;
117184
117185    /**
117186     * @var integer
117187     **/
117188    const JG_SADHE = 0;
117189
117190    /**
117191     * @var integer
117192     **/
117193    const JG_SEEN = 0;
117194
117195    /**
117196     * @var integer
117197     **/
117198    const JG_SEMKATH = 0;
117199
117200    /**
117201     * @var integer
117202     **/
117203    const JG_SHIN = 0;
117204
117205    /**
117206     * @var integer
117207     **/
117208    const JG_SWASH_KAF = 0;
117209
117210    /**
117211     * @var integer
117212     **/
117213    const JG_SYRIAC_WAW = 0;
117214
117215    /**
117216     * @var integer
117217     **/
117218    const JG_TAH = 0;
117219
117220    /**
117221     * @var integer
117222     **/
117223    const JG_TAW = 0;
117224
117225    /**
117226     * @var integer
117227     **/
117228    const JG_TEH_MARBUTA = 0;
117229
117230    /**
117231     * @var integer
117232     **/
117233    const JG_TEH_MARBUTA_GOAL = 0;
117234
117235    /**
117236     * @var integer
117237     **/
117238    const JG_TETH = 0;
117239
117240    /**
117241     * @var integer
117242     **/
117243    const JG_WAW = 0;
117244
117245    /**
117246     * @var integer
117247     **/
117248    const JG_YEH = 0;
117249
117250    /**
117251     * @var integer
117252     **/
117253    const JG_YEH_BARREE = 0;
117254
117255    /**
117256     * @var integer
117257     **/
117258    const JG_YEH_WITH_TAIL = 0;
117259
117260    /**
117261     * @var integer
117262     **/
117263    const JG_YUDH = 0;
117264
117265    /**
117266     * @var integer
117267     **/
117268    const JG_YUDH_HE = 0;
117269
117270    /**
117271     * @var integer
117272     **/
117273    const JG_ZAIN = 0;
117274
117275    /**
117276     * @var integer
117277     **/
117278    const JG_ZHAIN = 0;
117279
117280    /**
117281     * @var integer
117282     **/
117283    const JT_COUNT = 0;
117284
117285    /**
117286     * @var integer
117287     **/
117288    const JT_DUAL_JOINING = 0;
117289
117290    /**
117291     * @var integer
117292     **/
117293    const JT_JOIN_CAUSING = 0;
117294
117295    /**
117296     * @var integer
117297     **/
117298    const JT_LEFT_JOINING = 0;
117299
117300    /**
117301     * @var integer
117302     **/
117303    const JT_NON_JOINING = 0;
117304
117305    /**
117306     * @var integer
117307     **/
117308    const JT_RIGHT_JOINING = 0;
117309
117310    /**
117311     * @var integer
117312     **/
117313    const JT_TRANSPARENT = 0;
117314
117315    /**
117316     * @var integer
117317     **/
117318    const LB_ALPHABETIC = 0;
117319
117320    /**
117321     * @var integer
117322     **/
117323    const LB_AMBIGUOUS = 0;
117324
117325    /**
117326     * @var integer
117327     **/
117328    const LB_BREAK_AFTER = 0;
117329
117330    /**
117331     * @var integer
117332     **/
117333    const LB_BREAK_BEFORE = 0;
117334
117335    /**
117336     * @var integer
117337     **/
117338    const LB_BREAK_BOTH = 0;
117339
117340    /**
117341     * @var integer
117342     **/
117343    const LB_BREAK_SYMBOLS = 0;
117344
117345    /**
117346     * @var integer
117347     **/
117348    const LB_CARRIAGE_RETURN = 0;
117349
117350    /**
117351     * @var integer
117352     **/
117353    const LB_CLOSE_PARENTHESIS = 0;
117354
117355    /**
117356     * @var integer
117357     **/
117358    const LB_CLOSE_PUNCTUATION = 0;
117359
117360    /**
117361     * @var integer
117362     **/
117363    const LB_COMBINING_MARK = 0;
117364
117365    /**
117366     * @var integer
117367     **/
117368    const LB_COMPLEX_CONTEXT = 0;
117369
117370    /**
117371     * @var integer
117372     **/
117373    const LB_CONDITIONAL_JAPANESE_STARTER = 0;
117374
117375    /**
117376     * @var integer
117377     **/
117378    const LB_CONTINGENT_BREAK = 0;
117379
117380    /**
117381     * @var integer
117382     **/
117383    const LB_COUNT = 0;
117384
117385    /**
117386     * @var integer
117387     **/
117388    const LB_EXCLAMATION = 0;
117389
117390    /**
117391     * @var integer
117392     **/
117393    const LB_GLUE = 0;
117394
117395    /**
117396     * @var integer
117397     **/
117398    const LB_H2 = 0;
117399
117400    /**
117401     * @var integer
117402     **/
117403    const LB_H3 = 0;
117404
117405    /**
117406     * @var integer
117407     **/
117408    const LB_HEBREW_LETTER = 0;
117409
117410    /**
117411     * @var integer
117412     **/
117413    const LB_HYPHEN = 0;
117414
117415    /**
117416     * @var integer
117417     **/
117418    const LB_IDEOGRAPHIC = 0;
117419
117420    /**
117421     * @var integer
117422     **/
117423    const LB_INFIX_NUMERIC = 0;
117424
117425    /**
117426     * @var integer
117427     **/
117428    const LB_INSEPARABLE = 0;
117429
117430    /**
117431     * @var integer
117432     **/
117433    const LB_INSEPERABLE = 0;
117434
117435    /**
117436     * @var integer
117437     **/
117438    const LB_JL = 0;
117439
117440    /**
117441     * @var integer
117442     **/
117443    const LB_JT = 0;
117444
117445    /**
117446     * @var integer
117447     **/
117448    const LB_JV = 0;
117449
117450    /**
117451     * @var integer
117452     **/
117453    const LB_LINE_FEED = 0;
117454
117455    /**
117456     * @var integer
117457     **/
117458    const LB_MANDATORY_BREAK = 0;
117459
117460    /**
117461     * @var integer
117462     **/
117463    const LB_NEXT_LINE = 0;
117464
117465    /**
117466     * @var integer
117467     **/
117468    const LB_NONSTARTER = 0;
117469
117470    /**
117471     * @var integer
117472     **/
117473    const LB_NUMERIC = 0;
117474
117475    /**
117476     * @var integer
117477     **/
117478    const LB_OPEN_PUNCTUATION = 0;
117479
117480    /**
117481     * @var integer
117482     **/
117483    const LB_POSTFIX_NUMERIC = 0;
117484
117485    /**
117486     * @var integer
117487     **/
117488    const LB_PREFIX_NUMERIC = 0;
117489
117490    /**
117491     * @var integer
117492     **/
117493    const LB_QUOTATION = 0;
117494
117495    /**
117496     * @var integer
117497     **/
117498    const LB_REGIONAL_INDICATOR = 0;
117499
117500    /**
117501     * @var integer
117502     **/
117503    const LB_SPACE = 0;
117504
117505    /**
117506     * @var integer
117507     **/
117508    const LB_SURROGATE = 0;
117509
117510    /**
117511     * @var integer
117512     **/
117513    const LB_UNKNOWN = 0;
117514
117515    /**
117516     * @var integer
117517     **/
117518    const LB_WORD_JOINER = 0;
117519
117520    /**
117521     * @var integer
117522     **/
117523    const LB_ZWSPACE = 0;
117524
117525    /**
117526     * @var integer
117527     **/
117528    const LONG_PROPERTY_NAME = 0;
117529
117530    /**
117531     * @var float
117532     **/
117533    const NO_NUMERIC_VALUE = 0.0;
117534
117535    /**
117536     * @var integer
117537     **/
117538    const NT_COUNT = 0;
117539
117540    /**
117541     * @var integer
117542     **/
117543    const NT_DECIMAL = 0;
117544
117545    /**
117546     * @var integer
117547     **/
117548    const NT_DIGIT = 0;
117549
117550    /**
117551     * @var integer
117552     **/
117553    const NT_NONE = 0;
117554
117555    /**
117556     * @var integer
117557     **/
117558    const NT_NUMERIC = 0;
117559
117560    /**
117561     * @var integer
117562     **/
117563    const PROPERTY_AGE = 0;
117564
117565    /**
117566     * @var integer
117567     **/
117568    const PROPERTY_ALPHABETIC = 0;
117569
117570    /**
117571     * @var integer
117572     **/
117573    const PROPERTY_ASCII_HEX_DIGIT = 0;
117574
117575    /**
117576     * @var integer
117577     **/
117578    const PROPERTY_BIDI_CLASS = 0;
117579
117580    /**
117581     * @var integer
117582     **/
117583    const PROPERTY_BIDI_CONTROL = 0;
117584
117585    /**
117586     * @var integer
117587     **/
117588    const PROPERTY_BIDI_MIRRORED = 0;
117589
117590    /**
117591     * @var integer
117592     **/
117593    const PROPERTY_BIDI_MIRRORING_GLYPH = 0;
117594
117595    /**
117596     * @var integer
117597     **/
117598    const PROPERTY_BIDI_PAIRED_BRACKET = 0;
117599
117600    /**
117601     * @var integer
117602     **/
117603    const PROPERTY_BIDI_PAIRED_BRACKET_TYPE = 0;
117604
117605    /**
117606     * @var integer
117607     **/
117608    const PROPERTY_BINARY_LIMIT = 0;
117609
117610    /**
117611     * @var integer
117612     **/
117613    const PROPERTY_BINARY_START = 0;
117614
117615    /**
117616     * @var integer
117617     **/
117618    const PROPERTY_BLOCK = 0;
117619
117620    /**
117621     * @var integer
117622     **/
117623    const PROPERTY_CANONICAL_COMBINING_CLASS = 0;
117624
117625    /**
117626     * @var integer
117627     **/
117628    const PROPERTY_CASED = 0;
117629
117630    /**
117631     * @var integer
117632     **/
117633    const PROPERTY_CASE_FOLDING = 0;
117634
117635    /**
117636     * @var integer
117637     **/
117638    const PROPERTY_CASE_IGNORABLE = 0;
117639
117640    /**
117641     * @var integer
117642     **/
117643    const PROPERTY_CASE_SENSITIVE = 0;
117644
117645    /**
117646     * @var integer
117647     **/
117648    const PROPERTY_CHANGES_WHEN_CASEFOLDED = 0;
117649
117650    /**
117651     * @var integer
117652     **/
117653    const PROPERTY_CHANGES_WHEN_CASEMAPPED = 0;
117654
117655    /**
117656     * @var integer
117657     **/
117658    const PROPERTY_CHANGES_WHEN_LOWERCASED = 0;
117659
117660    /**
117661     * @var integer
117662     **/
117663    const PROPERTY_CHANGES_WHEN_NFKC_CASEFOLDED = 0;
117664
117665    /**
117666     * @var integer
117667     **/
117668    const PROPERTY_CHANGES_WHEN_TITLECASED = 0;
117669
117670    /**
117671     * @var integer
117672     **/
117673    const PROPERTY_CHANGES_WHEN_UPPERCASED = 0;
117674
117675    /**
117676     * @var integer
117677     **/
117678    const PROPERTY_DASH = 0;
117679
117680    /**
117681     * @var integer
117682     **/
117683    const PROPERTY_DECOMPOSITION_TYPE = 0;
117684
117685    /**
117686     * @var integer
117687     **/
117688    const PROPERTY_DEFAULT_IGNORABLE_CODE_POINT = 0;
117689
117690    /**
117691     * @var integer
117692     **/
117693    const PROPERTY_DEPRECATED = 0;
117694
117695    /**
117696     * @var integer
117697     **/
117698    const PROPERTY_DIACRITIC = 0;
117699
117700    /**
117701     * @var integer
117702     **/
117703    const PROPERTY_DOUBLE_LIMIT = 0;
117704
117705    /**
117706     * @var integer
117707     **/
117708    const PROPERTY_DOUBLE_START = 0;
117709
117710    /**
117711     * @var integer
117712     **/
117713    const PROPERTY_EAST_ASIAN_WIDTH = 0;
117714
117715    /**
117716     * @var integer
117717     **/
117718    const PROPERTY_EXTENDER = 0;
117719
117720    /**
117721     * @var integer
117722     **/
117723    const PROPERTY_FULL_COMPOSITION_EXCLUSION = 0;
117724
117725    /**
117726     * @var integer
117727     **/
117728    const PROPERTY_GENERAL_CATEGORY = 0;
117729
117730    /**
117731     * @var integer
117732     **/
117733    const PROPERTY_GENERAL_CATEGORY_MASK = 0;
117734
117735    /**
117736     * @var integer
117737     **/
117738    const PROPERTY_GRAPHEME_BASE = 0;
117739
117740    /**
117741     * @var integer
117742     **/
117743    const PROPERTY_GRAPHEME_CLUSTER_BREAK = 0;
117744
117745    /**
117746     * @var integer
117747     **/
117748    const PROPERTY_GRAPHEME_EXTEND = 0;
117749
117750    /**
117751     * @var integer
117752     **/
117753    const PROPERTY_GRAPHEME_LINK = 0;
117754
117755    /**
117756     * @var integer
117757     **/
117758    const PROPERTY_HANGUL_SYLLABLE_TYPE = 0;
117759
117760    /**
117761     * @var integer
117762     **/
117763    const PROPERTY_HEX_DIGIT = 0;
117764
117765    /**
117766     * @var integer
117767     **/
117768    const PROPERTY_HYPHEN = 0;
117769
117770    /**
117771     * @var integer
117772     **/
117773    const PROPERTY_IDEOGRAPHIC = 0;
117774
117775    /**
117776     * @var integer
117777     **/
117778    const PROPERTY_IDS_BINARY_OPERATOR = 0;
117779
117780    /**
117781     * @var integer
117782     **/
117783    const PROPERTY_IDS_TRINARY_OPERATOR = 0;
117784
117785    /**
117786     * @var integer
117787     **/
117788    const PROPERTY_ID_CONTINUE = 0;
117789
117790    /**
117791     * @var integer
117792     **/
117793    const PROPERTY_ID_START = 0;
117794
117795    /**
117796     * @var integer
117797     **/
117798    const PROPERTY_INT_LIMIT = 0;
117799
117800    /**
117801     * @var integer
117802     **/
117803    const PROPERTY_INT_START = 0;
117804
117805    /**
117806     * @var integer
117807     **/
117808    const PROPERTY_INVALID_CODE = 0;
117809
117810    /**
117811     * @var integer
117812     **/
117813    const PROPERTY_ISO_COMMENT = 0;
117814
117815    /**
117816     * @var integer
117817     **/
117818    const PROPERTY_JOINING_GROUP = 0;
117819
117820    /**
117821     * @var integer
117822     **/
117823    const PROPERTY_JOINING_TYPE = 0;
117824
117825    /**
117826     * @var integer
117827     **/
117828    const PROPERTY_JOIN_CONTROL = 0;
117829
117830    /**
117831     * @var integer
117832     **/
117833    const PROPERTY_LEAD_CANONICAL_COMBINING_CLASS = 0;
117834
117835    /**
117836     * @var integer
117837     **/
117838    const PROPERTY_LINE_BREAK = 0;
117839
117840    /**
117841     * @var integer
117842     **/
117843    const PROPERTY_LOGICAL_ORDER_EXCEPTION = 0;
117844
117845    /**
117846     * @var integer
117847     **/
117848    const PROPERTY_LOWERCASE = 0;
117849
117850    /**
117851     * @var integer
117852     **/
117853    const PROPERTY_LOWERCASE_MAPPING = 0;
117854
117855    /**
117856     * @var integer
117857     **/
117858    const PROPERTY_MASK_LIMIT = 0;
117859
117860    /**
117861     * @var integer
117862     **/
117863    const PROPERTY_MASK_START = 0;
117864
117865    /**
117866     * @var integer
117867     **/
117868    const PROPERTY_MATH = 0;
117869
117870    /**
117871     * @var integer
117872     **/
117873    const PROPERTY_NAME = 0;
117874
117875    /**
117876     * @var integer
117877     **/
117878    const PROPERTY_NAME_CHOICE_COUNT = 0;
117879
117880    /**
117881     * @var integer
117882     **/
117883    const PROPERTY_NFC_INERT = 0;
117884
117885    /**
117886     * @var integer
117887     **/
117888    const PROPERTY_NFC_QUICK_CHECK = 0;
117889
117890    /**
117891     * @var integer
117892     **/
117893    const PROPERTY_NFD_INERT = 0;
117894
117895    /**
117896     * @var integer
117897     **/
117898    const PROPERTY_NFD_QUICK_CHECK = 0;
117899
117900    /**
117901     * @var integer
117902     **/
117903    const PROPERTY_NFKC_INERT = 0;
117904
117905    /**
117906     * @var integer
117907     **/
117908    const PROPERTY_NFKC_QUICK_CHECK = 0;
117909
117910    /**
117911     * @var integer
117912     **/
117913    const PROPERTY_NFKD_INERT = 0;
117914
117915    /**
117916     * @var integer
117917     **/
117918    const PROPERTY_NFKD_QUICK_CHECK = 0;
117919
117920    /**
117921     * @var integer
117922     **/
117923    const PROPERTY_NONCHARACTER_CODE_POINT = 0;
117924
117925    /**
117926     * @var integer
117927     **/
117928    const PROPERTY_NUMERIC_TYPE = 0;
117929
117930    /**
117931     * @var integer
117932     **/
117933    const PROPERTY_NUMERIC_VALUE = 0;
117934
117935    /**
117936     * @var integer
117937     **/
117938    const PROPERTY_OTHER_PROPERTY_LIMIT = 0;
117939
117940    /**
117941     * @var integer
117942     **/
117943    const PROPERTY_OTHER_PROPERTY_START = 0;
117944
117945    /**
117946     * @var integer
117947     **/
117948    const PROPERTY_PATTERN_SYNTAX = 0;
117949
117950    /**
117951     * @var integer
117952     **/
117953    const PROPERTY_PATTERN_WHITE_SPACE = 0;
117954
117955    /**
117956     * @var integer
117957     **/
117958    const PROPERTY_POSIX_ALNUM = 0;
117959
117960    /**
117961     * @var integer
117962     **/
117963    const PROPERTY_POSIX_BLANK = 0;
117964
117965    /**
117966     * @var integer
117967     **/
117968    const PROPERTY_POSIX_GRAPH = 0;
117969
117970    /**
117971     * @var integer
117972     **/
117973    const PROPERTY_POSIX_PRINT = 0;
117974
117975    /**
117976     * @var integer
117977     **/
117978    const PROPERTY_POSIX_XDIGIT = 0;
117979
117980    /**
117981     * @var integer
117982     **/
117983    const PROPERTY_QUOTATION_MARK = 0;
117984
117985    /**
117986     * @var integer
117987     **/
117988    const PROPERTY_RADICAL = 0;
117989
117990    /**
117991     * @var integer
117992     **/
117993    const PROPERTY_SCRIPT = 0;
117994
117995    /**
117996     * @var integer
117997     **/
117998    const PROPERTY_SCRIPT_EXTENSIONS = 0;
117999
118000    /**
118001     * @var integer
118002     **/
118003    const PROPERTY_SEGMENT_STARTER = 0;
118004
118005    /**
118006     * @var integer
118007     **/
118008    const PROPERTY_SENTENCE_BREAK = 0;
118009
118010    /**
118011     * @var integer
118012     **/
118013    const PROPERTY_SIMPLE_CASE_FOLDING = 0;
118014
118015    /**
118016     * @var integer
118017     **/
118018    const PROPERTY_SIMPLE_LOWERCASE_MAPPING = 0;
118019
118020    /**
118021     * @var integer
118022     **/
118023    const PROPERTY_SIMPLE_TITLECASE_MAPPING = 0;
118024
118025    /**
118026     * @var integer
118027     **/
118028    const PROPERTY_SIMPLE_UPPERCASE_MAPPING = 0;
118029
118030    /**
118031     * @var integer
118032     **/
118033    const PROPERTY_SOFT_DOTTED = 0;
118034
118035    /**
118036     * @var integer
118037     **/
118038    const PROPERTY_STRING_LIMIT = 0;
118039
118040    /**
118041     * @var integer
118042     **/
118043    const PROPERTY_STRING_START = 0;
118044
118045    /**
118046     * @var integer
118047     **/
118048    const PROPERTY_S_TERM = 0;
118049
118050    /**
118051     * @var integer
118052     **/
118053    const PROPERTY_TERMINAL_PUNCTUATION = 0;
118054
118055    /**
118056     * @var integer
118057     **/
118058    const PROPERTY_TITLECASE_MAPPING = 0;
118059
118060    /**
118061     * @var integer
118062     **/
118063    const PROPERTY_TRAIL_CANONICAL_COMBINING_CLASS = 0;
118064
118065    /**
118066     * @var integer
118067     **/
118068    const PROPERTY_UNICODE_1_NAME = 0;
118069
118070    /**
118071     * @var integer
118072     **/
118073    const PROPERTY_UNIFIED_IDEOGRAPH = 0;
118074
118075    /**
118076     * @var integer
118077     **/
118078    const PROPERTY_UPPERCASE = 0;
118079
118080    /**
118081     * @var integer
118082     **/
118083    const PROPERTY_UPPERCASE_MAPPING = 0;
118084
118085    /**
118086     * @var integer
118087     **/
118088    const PROPERTY_VARIATION_SELECTOR = 0;
118089
118090    /**
118091     * @var integer
118092     **/
118093    const PROPERTY_WHITE_SPACE = 0;
118094
118095    /**
118096     * @var integer
118097     **/
118098    const PROPERTY_WORD_BREAK = 0;
118099
118100    /**
118101     * @var integer
118102     **/
118103    const PROPERTY_XID_CONTINUE = 0;
118104
118105    /**
118106     * @var integer
118107     **/
118108    const PROPERTY_XID_START = 0;
118109
118110    /**
118111     * @var integer
118112     **/
118113    const SB_ATERM = 0;
118114
118115    /**
118116     * @var integer
118117     **/
118118    const SB_CLOSE = 0;
118119
118120    /**
118121     * @var integer
118122     **/
118123    const SB_COUNT = 0;
118124
118125    /**
118126     * @var integer
118127     **/
118128    const SB_CR = 0;
118129
118130    /**
118131     * @var integer
118132     **/
118133    const SB_EXTEND = 0;
118134
118135    /**
118136     * @var integer
118137     **/
118138    const SB_FORMAT = 0;
118139
118140    /**
118141     * @var integer
118142     **/
118143    const SB_LF = 0;
118144
118145    /**
118146     * @var integer
118147     **/
118148    const SB_LOWER = 0;
118149
118150    /**
118151     * @var integer
118152     **/
118153    const SB_NUMERIC = 0;
118154
118155    /**
118156     * @var integer
118157     **/
118158    const SB_OLETTER = 0;
118159
118160    /**
118161     * @var integer
118162     **/
118163    const SB_OTHER = 0;
118164
118165    /**
118166     * @var integer
118167     **/
118168    const SB_SCONTINUE = 0;
118169
118170    /**
118171     * @var integer
118172     **/
118173    const SB_SEP = 0;
118174
118175    /**
118176     * @var integer
118177     **/
118178    const SB_SP = 0;
118179
118180    /**
118181     * @var integer
118182     **/
118183    const SB_STERM = 0;
118184
118185    /**
118186     * @var integer
118187     **/
118188    const SB_UPPER = 0;
118189
118190    /**
118191     * @var integer
118192     **/
118193    const SHORT_PROPERTY_NAME = 0;
118194
118195    /**
118196     * @var integer
118197     **/
118198    const UNICODE_10_CHAR_NAME = 0;
118199
118200    /**
118201     * @var integer
118202     **/
118203    const UNICODE_CHAR_NAME = 0;
118204
118205    /**
118206     * @var string
118207     **/
118208    const UNICODE_VERSION = '';
118209
118210    /**
118211     * @var integer
118212     **/
118213    const WB_ALETTER = 0;
118214
118215    /**
118216     * @var integer
118217     **/
118218    const WB_COUNT = 0;
118219
118220    /**
118221     * @var integer
118222     **/
118223    const WB_CR = 0;
118224
118225    /**
118226     * @var integer
118227     **/
118228    const WB_DOUBLE_QUOTE = 0;
118229
118230    /**
118231     * @var integer
118232     **/
118233    const WB_EXTEND = 0;
118234
118235    /**
118236     * @var integer
118237     **/
118238    const WB_EXTENDNUMLET = 0;
118239
118240    /**
118241     * @var integer
118242     **/
118243    const WB_FORMAT = 0;
118244
118245    /**
118246     * @var integer
118247     **/
118248    const WB_HEBREW_LETTER = 0;
118249
118250    /**
118251     * @var integer
118252     **/
118253    const WB_KATAKANA = 0;
118254
118255    /**
118256     * @var integer
118257     **/
118258    const WB_LF = 0;
118259
118260    /**
118261     * @var integer
118262     **/
118263    const WB_MIDLETTER = 0;
118264
118265    /**
118266     * @var integer
118267     **/
118268    const WB_MIDNUM = 0;
118269
118270    /**
118271     * @var integer
118272     **/
118273    const WB_MIDNUMLET = 0;
118274
118275    /**
118276     * @var integer
118277     **/
118278    const WB_NEWLINE = 0;
118279
118280    /**
118281     * @var integer
118282     **/
118283    const WB_NUMERIC = 0;
118284
118285    /**
118286     * @var integer
118287     **/
118288    const WB_OTHER = 0;
118289
118290    /**
118291     * @var integer
118292     **/
118293    const WB_REGIONAL_INDICATOR = 0;
118294
118295    /**
118296     * @var integer
118297     **/
118298    const WB_SINGLE_QUOTE = 0;
118299
118300    /**
118301     * Get the "age" of the code point
118302     *
118303     * Gets the "age" of the code point.
118304     *
118305     * The "age" is the Unicode version when the code point was first
118306     * designated (as a non-character or for Private Use) or assigned a
118307     * character. This can be useful to avoid emitting code points to
118308     * receiving processes that do not accept newer characters.
118309     *
118310     * @param mixed $codepoint
118311     * @return array The Unicode version number, as an array. For example,
118312     *   version 1.3.31.2 would be represented as [1, 3, 31, 2].
118313     * @since PHP 7
118314     **/
118315    public static function charAge($codepoint){}
118316
118317    /**
118318     * Get the decimal digit value of a decimal digit character
118319     *
118320     * Returns the decimal digit value of a decimal digit character.
118321     *
118322     * Such characters have the general category "Nd" (decimal digit numbers)
118323     * and a Numeric_Type of Decimal.
118324     *
118325     * @param mixed $codepoint
118326     * @return int The decimal digit value of {@link codepoint}, or -1 if
118327     *   it is not a decimal digit character.
118328     * @since PHP 7
118329     **/
118330    public static function charDigitValue($codepoint){}
118331
118332    /**
118333     * Get bidirectional category value for a code point
118334     *
118335     * Returns the bidirectional category value for the code point, which is
118336     * used in the Unicode bidirectional algorithm (UAX #9).
118337     *
118338     * @param mixed $codepoint
118339     * @return int The bidirectional category value; one of the following
118340     *   constants: IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT
118341     *   IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT
118342     *   IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER
118343     *   IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER_SEPARATOR
118344     *   IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER_TERMINATOR
118345     *   IntlChar::CHAR_DIRECTION_ARABIC_NUMBER
118346     *   IntlChar::CHAR_DIRECTION_COMMON_NUMBER_SEPARATOR
118347     *   IntlChar::CHAR_DIRECTION_BLOCK_SEPARATOR
118348     *   IntlChar::CHAR_DIRECTION_SEGMENT_SEPARATOR
118349     *   IntlChar::CHAR_DIRECTION_WHITE_SPACE_NEUTRAL
118350     *   IntlChar::CHAR_DIRECTION_OTHER_NEUTRAL
118351     *   IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_EMBEDDING
118352     *   IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_OVERRIDE
118353     *   IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_ARABIC
118354     *   IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_EMBEDDING
118355     *   IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_OVERRIDE
118356     *   IntlChar::CHAR_DIRECTION_POP_DIRECTIONAL_FORMAT
118357     *   IntlChar::CHAR_DIRECTION_DIR_NON_SPACING_MARK
118358     *   IntlChar::CHAR_DIRECTION_BOUNDARY_NEUTRAL
118359     *   IntlChar::CHAR_DIRECTION_FIRST_STRONG_ISOLATE
118360     *   IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_ISOLATE
118361     *   IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_ISOLATE
118362     *   IntlChar::CHAR_DIRECTION_POP_DIRECTIONAL_ISOLATE
118363     *   IntlChar::CHAR_DIRECTION_CHAR_DIRECTION_COUNT
118364     * @since PHP 7
118365     **/
118366    public static function charDirection($codepoint){}
118367
118368    /**
118369     * Find Unicode character by name and return its code point value
118370     *
118371     * Finds a Unicode character by its name and returns its code point
118372     * value.
118373     *
118374     * The name is matched exactly and completely. If the name does not
118375     * correspond to a code point, NULL is returned.
118376     *
118377     * A Unicode 1.0 name is matched only if it differs from the modern name.
118378     * Unicode names are all uppercase. Extended names are lowercase followed
118379     * by an uppercase hexadecimal number, and within angle brackets.
118380     *
118381     * @param string $characterName Full name of the Unicode character.
118382     * @param int $nameChoice Which set of names to use for the lookup. Can
118383     *   be any of these constants: IntlChar::UNICODE_CHAR_NAME (default)
118384     *   IntlChar::UNICODE_10_CHAR_NAME IntlChar::EXTENDED_CHAR_NAME
118385     *   IntlChar::CHAR_NAME_ALIAS IntlChar::CHAR_NAME_CHOICE_COUNT
118386     * @return int The Unicode value of the code point with the given name
118387     *   (as an integer), or NULL if there is no such code point.
118388     * @since PHP 7
118389     **/
118390    public static function charFromName($characterName, $nameChoice){}
118391
118392    /**
118393     * Get the "mirror-image" character for a code point
118394     *
118395     * Maps the specified character to a "mirror-image" character.
118396     *
118397     * For characters with the Bidi_Mirrored property, implementations
118398     * sometimes need a "poor man's" mapping to another Unicode character
118399     * (code point) such that the default glyph may serve as the mirror-image
118400     * of the default glyph of the specified character. This is useful for
118401     * text conversion to and from codepages with visual order, and for
118402     * displays without glyph selection capabilities.
118403     *
118404     * @param mixed $codepoint
118405     * @return mixed Returns another Unicode code point that may serve as a
118406     *   mirror-image substitute, or {@link codepoint} itself if there is no
118407     *   such mapping or {@link codepoint} does not have the Bidi_Mirrored
118408     *   property.
118409     * @since PHP 7
118410     **/
118411    public static function charMirror($codepoint){}
118412
118413    /**
118414     * Retrieve the name of a Unicode character
118415     *
118416     * Retrieves the name of a Unicode character.
118417     *
118418     * Depending on {@link nameChoice}, the resulting character name is the
118419     * "modern" name or the name that was defined in Unicode version 1.0. The
118420     * name contains only "invariant" characters like A-Z, 0-9, space, and
118421     * '-'. Unicode 1.0 names are only retrieved if they are different from
118422     * the modern names and if ICU contains the data for them.
118423     *
118424     * @param mixed $codepoint
118425     * @param int $nameChoice Which set of names to use for the lookup. Can
118426     *   be any of these constants: IntlChar::UNICODE_CHAR_NAME (default)
118427     *   IntlChar::UNICODE_10_CHAR_NAME IntlChar::EXTENDED_CHAR_NAME
118428     *   IntlChar::CHAR_NAME_ALIAS IntlChar::CHAR_NAME_CHOICE_COUNT
118429     * @return string The corresponding name, or an empty string if there
118430     *   is no name for this character, or NULL if there is no such code
118431     *   point.
118432     * @since PHP 7
118433     **/
118434    public static function charName($codepoint, $nameChoice){}
118435
118436    /**
118437     * Get the general category value for a code point
118438     *
118439     * Returns the general category value for the code point.
118440     *
118441     * @param mixed $codepoint
118442     * @return int Returns the general category type, which may be one of
118443     *   the following constants: IntlChar::CHAR_CATEGORY_UNASSIGNED
118444     *   IntlChar::CHAR_CATEGORY_GENERAL_OTHER_TYPES
118445     *   IntlChar::CHAR_CATEGORY_UPPERCASE_LETTER
118446     *   IntlChar::CHAR_CATEGORY_LOWERCASE_LETTER
118447     *   IntlChar::CHAR_CATEGORY_TITLECASE_LETTER
118448     *   IntlChar::CHAR_CATEGORY_MODIFIER_LETTER
118449     *   IntlChar::CHAR_CATEGORY_OTHER_LETTER
118450     *   IntlChar::CHAR_CATEGORY_NON_SPACING_MARK
118451     *   IntlChar::CHAR_CATEGORY_ENCLOSING_MARK
118452     *   IntlChar::CHAR_CATEGORY_COMBINING_SPACING_MARK
118453     *   IntlChar::CHAR_CATEGORY_DECIMAL_DIGIT_NUMBER
118454     *   IntlChar::CHAR_CATEGORY_LETTER_NUMBER
118455     *   IntlChar::CHAR_CATEGORY_OTHER_NUMBER
118456     *   IntlChar::CHAR_CATEGORY_SPACE_SEPARATOR
118457     *   IntlChar::CHAR_CATEGORY_LINE_SEPARATOR
118458     *   IntlChar::CHAR_CATEGORY_PARAGRAPH_SEPARATOR
118459     *   IntlChar::CHAR_CATEGORY_CONTROL_CHAR
118460     *   IntlChar::CHAR_CATEGORY_FORMAT_CHAR
118461     *   IntlChar::CHAR_CATEGORY_PRIVATE_USE_CHAR
118462     *   IntlChar::CHAR_CATEGORY_SURROGATE
118463     *   IntlChar::CHAR_CATEGORY_DASH_PUNCTUATION
118464     *   IntlChar::CHAR_CATEGORY_START_PUNCTUATION
118465     *   IntlChar::CHAR_CATEGORY_END_PUNCTUATION
118466     *   IntlChar::CHAR_CATEGORY_CONNECTOR_PUNCTUATION
118467     *   IntlChar::CHAR_CATEGORY_OTHER_PUNCTUATION
118468     *   IntlChar::CHAR_CATEGORY_MATH_SYMBOL
118469     *   IntlChar::CHAR_CATEGORY_CURRENCY_SYMBOL
118470     *   IntlChar::CHAR_CATEGORY_MODIFIER_SYMBOL
118471     *   IntlChar::CHAR_CATEGORY_OTHER_SYMBOL
118472     *   IntlChar::CHAR_CATEGORY_INITIAL_PUNCTUATION
118473     *   IntlChar::CHAR_CATEGORY_FINAL_PUNCTUATION
118474     *   IntlChar::CHAR_CATEGORY_CHAR_CATEGORY_COUNT
118475     * @since PHP 7
118476     **/
118477    public static function charType($codepoint){}
118478
118479    /**
118480     * Return Unicode character by code point value
118481     *
118482     * Returns a string containing the character specified by the Unicode
118483     * code point value.
118484     *
118485     * This function compliments {@link IntlChar::ord}.
118486     *
118487     * @param mixed $codepoint
118488     * @return string A string containing the single character specified by
118489     *   the Unicode code point value.
118490     * @since PHP 7
118491     **/
118492    public static function chr($codepoint){}
118493
118494    /**
118495     * Get the decimal digit value of a code point for a given radix
118496     *
118497     * Returns the decimal digit value of the code point in the specified
118498     * radix.
118499     *
118500     * If the radix is not in the range 2<=radix<=36 or if the value of
118501     * {@link codepoint} is not a valid digit in the specified radix, FALSE
118502     * is returned. A character is a valid digit if at least one of the
118503     * following is true: The character has a decimal digit value. Such
118504     * characters have the general category "Nd" (decimal digit numbers) and
118505     * a Numeric_Type of Decimal. In this case the value is the character's
118506     * decimal digit value. The character is one of the uppercase Latin
118507     * letters 'A' through 'Z'. In this case the value is c-'A'+10. The
118508     * character is one of the lowercase Latin letters 'a' through 'z'. In
118509     * this case the value is ch-'a'+10. Latin letters from both the ASCII
118510     * range (0061..007A, 0041..005A) as well as from the Fullwidth ASCII
118511     * range (FF41..FF5A, FF21..FF3A) are recognized.
118512     *
118513     * @param string $codepoint
118514     * @param int $radix The radix (defaults to 10).
118515     * @return int Returns the numeric value represented by the character
118516     *   in the specified radix, or FALSE if there is no value or if the
118517     *   value exceeds the radix.
118518     * @since PHP 7
118519     **/
118520    public static function digit($codepoint, $radix){}
118521
118522    /**
118523     * Enumerate all assigned Unicode characters within a range
118524     *
118525     * Enumerate all assigned Unicode characters between the start and limit
118526     * code points (start inclusive, limit exclusive) and call a function for
118527     * each, passing the code point value and the character name.
118528     *
118529     * For Unicode 1.0 names, only those are enumerated that differ from the
118530     * modern names.
118531     *
118532     * @param mixed $start The first code point in the enumeration range.
118533     * @param mixed $limit One more than the last code point in the
118534     *   enumeration range (the first one after the range).
118535     * @param callable $callback The function that is to be called for each
118536     *   character name. The following three arguments will be passed into
118537     *   it: integer $codepoint - The numeric code point value integer
118538     *   $nameChoice - The same value as the {@link nameChoice} parameter
118539     *   below string $name - The name of the character
118540     * @param int $nameChoice Selector for which kind of names to
118541     *   enumerate. Can be any of these constants:
118542     *   IntlChar::UNICODE_CHAR_NAME (default) IntlChar::UNICODE_10_CHAR_NAME
118543     *   IntlChar::EXTENDED_CHAR_NAME IntlChar::CHAR_NAME_ALIAS
118544     *   IntlChar::CHAR_NAME_CHOICE_COUNT
118545     * @return void
118546     * @since PHP 7
118547     **/
118548    public static function enumCharNames($start, $limit, $callback, $nameChoice){}
118549
118550    /**
118551     * Enumerate all code points with their Unicode general categories
118552     *
118553     * Enumerates efficiently all code points with their Unicode general
118554     * categories. This is useful for building data structures, for
118555     * enumerating all assigned code points, etc.
118556     *
118557     * For each contiguous range of code points with a given general category
118558     * ("character type"), the {@link callback} function is called. Adjacent
118559     * ranges have different types. The Unicode Standard guarantees that the
118560     * numeric value of the type is 0..31.
118561     *
118562     * @param callable $callback The function that is to be called for each
118563     *   contiguous range of code points with the same general category. The
118564     *   following three arguments will be passed into it: integer $start -
118565     *   The starting code point of the range integer $end - The ending code
118566     *   point of the range integer $name - The category type (one of the
118567     *   IntlChar::CHAR_CATEGORY_* constants)
118568     * @return void
118569     * @since PHP 7
118570     **/
118571    public static function enumCharTypes($callback){}
118572
118573    /**
118574     * Perform case folding on a code point
118575     *
118576     * The given character is mapped to its case folding equivalent; if the
118577     * character has no case folding equivalent, the character itself is
118578     * returned.
118579     *
118580     * @param mixed $codepoint
118581     * @param int $options Either IntlChar::FOLD_CASE_DEFAULT (default) or
118582     *   IntlChar::FOLD_CASE_EXCLUDE_SPECIAL_I.
118583     * @return mixed Returns the Simple_Case_Folding of the code point, if
118584     *   any; otherwise the code point itself.
118585     * @since PHP 7
118586     **/
118587    public static function foldCase($codepoint, $options){}
118588
118589    /**
118590     * Get character representation for a given digit and radix
118591     *
118592     * Determines the character representation for a specific digit in the
118593     * specified radix.
118594     *
118595     * If the value of radix is not a valid radix, or the value of digit is
118596     * not a valid digit in the specified radix, the null character (U+0000)
118597     * is returned.
118598     *
118599     * The radix argument is valid if it is greater than or equal to 2 and
118600     * less than or equal to 36. The digit argument is valid if 0 <= digit <
118601     * radix.
118602     *
118603     * If the digit is less than 10, then '0' + digit is returned. Otherwise,
118604     * the value 'a' + digit - 10 is returned.
118605     *
118606     * @param int $digit The number to convert to a character.
118607     * @param int $radix The radix (defaults to 10).
118608     * @return int The character representation (as a string) of the
118609     *   specified digit in the specified radix.
118610     * @since PHP 7
118611     **/
118612    public static function forDigit($digit, $radix){}
118613
118614    /**
118615     * Get the paired bracket character for a code point
118616     *
118617     * Maps the specified character to its paired bracket character.
118618     *
118619     * For Bidi_Paired_Bracket_Type!=None, this is the same as {@link
118620     * IntlChar::charMirror}. Otherwise {@link codepoint} itself is returned.
118621     *
118622     * @param mixed $codepoint
118623     * @return mixed Returns the paired bracket code point, or {@link
118624     *   codepoint} itself if there is no such mapping.
118625     * @since PHP 7
118626     **/
118627    public static function getBidiPairedBracket($codepoint){}
118628
118629    /**
118630     * Get the Unicode allocation block containing a code point
118631     *
118632     * Returns the Unicode allocation block that contains the character.
118633     *
118634     * @param mixed $codepoint
118635     * @return int Returns the block value for {@link codepoint}. See the
118636     *   IntlChar::BLOCK_CODE_* constants for possible return values.
118637     * @since PHP 7
118638     **/
118639    public static function getBlockCode($codepoint){}
118640
118641    /**
118642     * Get the combining class of a code point
118643     *
118644     * Returns the combining class of the code point.
118645     *
118646     * @param mixed $codepoint
118647     * @return int Returns the combining class of the character.
118648     * @since PHP 7
118649     **/
118650    public static function getCombiningClass($codepoint){}
118651
118652    /**
118653     * Get the FC_NFKC_Closure property for a code point
118654     *
118655     * Gets the FC_NFKC_Closure property string for a character.
118656     *
118657     * @param mixed $codepoint
118658     * @return string Returns the FC_NFKC_Closure property string for the
118659     *   {@link codepoint}, or an empty string if there is none.
118660     **/
118661    public static function getFC_NFKC_Closure($codepoint){}
118662
118663    /**
118664     * Get the max value for a Unicode property
118665     *
118666     * Gets the maximum value for an enumerated/integer/binary Unicode
118667     * property.
118668     *
118669     * @param int $property
118670     * @return int The maximum value returned by {@link
118671     *   IntlChar::getIntPropertyValue} for a Unicode property. <=0 if the
118672     *   property selector is out of range.
118673     * @since PHP 7
118674     **/
118675    public static function getIntPropertyMaxValue($property){}
118676
118677    /**
118678     * Get the min value for a Unicode property
118679     *
118680     * Gets the minimum value for an enumerated/integer/binary Unicode
118681     * property.
118682     *
118683     * @param int $property
118684     * @return int The minimum value returned by {@link
118685     *   IntlChar::getIntPropertyValue} for a Unicode property. 0 if the
118686     *   property selector is out of range.
118687     * @since PHP 7
118688     **/
118689    public static function getIntPropertyMinValue($property){}
118690
118691    /**
118692     * Get the value for a Unicode property for a code point
118693     *
118694     * Gets the property value for an enumerated or integer Unicode property
118695     * for a code point. Also returns binary and mask property values.
118696     *
118697     * @param mixed $codepoint
118698     * @param int $property
118699     * @return int Returns the numeric value that is directly the property
118700     *   value or, for enumerated properties, corresponds to the numeric
118701     *   value of the enumerated constant of the respective property value
118702     *   enumeration type.
118703     * @since PHP 7
118704     **/
118705    public static function getIntPropertyValue($codepoint, $property){}
118706
118707    /**
118708     * Get the numeric value for a Unicode code point
118709     *
118710     * Gets the numeric value for a Unicode code point as defined in the
118711     * Unicode Character Database.
118712     *
118713     * For characters without any numeric values in the Unicode Character
118714     * Database, this function will return IntlChar::NO_NUMERIC_VALUE.
118715     *
118716     * @param mixed $codepoint
118717     * @return float Numeric value of {@link codepoint}, or
118718     *   IntlChar::NO_NUMERIC_VALUE if none is defined. This constant was
118719     *   added in PHP 7.0.6, prior to this version the literal value
118720     *   (float)-123456789 may be used instead.
118721     * @since PHP 7
118722     **/
118723    public static function getNumericValue($codepoint){}
118724
118725    /**
118726     * Get the property constant value for a given property name
118727     *
118728     * Returns the property constant value for a given property name, as
118729     * specified in the Unicode database file PropertyAliases.txt. Short,
118730     * long, and any other variants are recognized.
118731     *
118732     * In addition, this function maps the synthetic names "gcm" /
118733     * "General_Category_Mask" to the property
118734     * IntlChar::PROPERTY_GENERAL_CATEGORY_MASK. These names are not in
118735     * PropertyAliases.txt.
118736     *
118737     * This function compliments {@link IntlChar::getPropertyName}.
118738     *
118739     * @param string $alias The property name to be matched. The name is
118740     *   compared using "loose matching" as described in PropertyAliases.txt.
118741     * @return int Returns an IntlChar::PROPERTY_ constant value, or
118742     *   IntlChar::PROPERTY_INVALID_CODE if the given name does not match any
118743     *   property.
118744     * @since PHP 7
118745     **/
118746    public static function getPropertyEnum($alias){}
118747
118748    /**
118749     * Get the Unicode name for a property
118750     *
118751     * Returns the Unicode name for a given property, as given in the Unicode
118752     * database file PropertyAliases.txt.
118753     *
118754     * In addition, this function maps the property
118755     * IntlChar::PROPERTY_GENERAL_CATEGORY_MASK to the synthetic names "gcm"
118756     * / "General_Category_Mask". These names are not in PropertyAliases.txt.
118757     *
118758     * This function compliments {@link IntlChar::getPropertyEnum}.
118759     *
118760     * @param int $property IntlChar::PROPERTY_INVALID_CODE should not be
118761     *   used. Also, if {@link property} is out of range, FALSE is returned.
118762     * @param int $nameChoice Selector for which name to get. If out of
118763     *   range, FALSE is returned. All properties have a long name. Most have
118764     *   a short name, but some do not. Unicode allows for additional names;
118765     *   if present these will be returned by adding 1, 2, etc. to
118766     *   IntlChar::LONG_PROPERTY_NAME.
118767     * @return string Returns the name, or FALSE if either the {@link
118768     *   property} or the {@link nameChoice} is out of range.
118769     * @since PHP 7
118770     **/
118771    public static function getPropertyName($property, $nameChoice){}
118772
118773    /**
118774     * Get the property value for a given value name
118775     *
118776     * Returns the property value integer for a given value name, as
118777     * specified in the Unicode database file PropertyValueAliases.txt.
118778     * Short, long, and any other variants are recognized.
118779     *
118780     * @param int $property If out of range, or this method doesn't work
118781     *   with the given value, IntlChar::PROPERTY_INVALID_CODE is returned.
118782     * @param string $name The value name to be matched. The name is
118783     *   compared using "loose matching" as described in
118784     *   PropertyValueAliases.txt.
118785     * @return int Returns the corresponding value integer, or
118786     *   IntlChar::PROPERTY_INVALID_CODE if the given name does not match any
118787     *   value of the given property, or if the property is invalid.
118788     * @since PHP 7
118789     **/
118790    public static function getPropertyValueEnum($property, $name){}
118791
118792    /**
118793     * Get the Unicode name for a property value
118794     *
118795     * Returns the Unicode name for a given property value, as given in the
118796     * Unicode database file PropertyValueAliases.txt.
118797     *
118798     * @param int $property If out of range, or this method doesn't work
118799     *   with the given value, FALSE is returned.
118800     * @param int $value Selector for a value for the given property. If
118801     *   out of range, FALSE is returned. In general, valid values range from
118802     *   0 up to some maximum. There are a couple exceptions:
118803     *   IntlChar::PROPERTY_BLOCK values begin at the non-zero value
118804     *   IntlChar::BLOCK_CODE_BASIC_LATIN
118805     *   IntlChar::PROPERTY_CANONICAL_COMBINING_CLASS values are not
118806     *   contiguous and range from 0..240.
118807     * @param int $nameChoice Selector for which name to get. If out of
118808     *   range, FALSE is returned. All values have a long name. Most have a
118809     *   short name, but some do not. Unicode allows for additional names; if
118810     *   present these will be returned by adding 1, 2, etc. to
118811     *   IntlChar::LONG_PROPERTY_NAME.
118812     * @return string Returns the name, or FALSE if either the {@link
118813     *   property} or the {@link nameChoice} is out of range.
118814     * @since PHP 7
118815     **/
118816    public static function getPropertyValueName($property, $value, $nameChoice){}
118817
118818    /**
118819     * Get the Unicode version
118820     *
118821     * Gets the Unicode version information.
118822     *
118823     * The version array is filled in with the version information for the
118824     * Unicode standard that is currently used by ICU. For example, Unicode
118825     * version 3.1.1 is represented as an array with the values [3, 1, 1, 0].
118826     *
118827     * @return array An array containing the Unicode version number.
118828     * @since PHP 7
118829     **/
118830    public static function getUnicodeVersion(){}
118831
118832    /**
118833     * Check a binary Unicode property for a code point
118834     *
118835     * Checks a binary Unicode property for a code point.
118836     *
118837     * Unicode, especially in version 3.2, defines many more properties than
118838     * the original set in UnicodeData.txt.
118839     *
118840     * The properties APIs are intended to reflect Unicode properties as
118841     * defined in the Unicode Character Database (UCD) and Unicode Technical
118842     * Reports (UTR). For details about the properties see
118843     * http://www.unicode.org/ucd/. For names of Unicode properties see the
118844     * UCD file PropertyAliases.txt.
118845     *
118846     * @param mixed $codepoint
118847     * @param int $property
118848     * @return bool Returns TRUE or FALSE according to the binary Unicode
118849     *   property value for {@link codepoint}. Also FALSE if {@link property}
118850     *   is out of bounds or if the Unicode version does not have data for
118851     *   the property at all, or not for this code point.
118852     * @since PHP 7
118853     **/
118854    public static function hasBinaryProperty($codepoint, $property){}
118855
118856    /**
118857     * Check if code point is an alphanumeric character
118858     *
118859     * Determines whether the specified code point is an alphanumeric
118860     * character (letter or digit). TRUE for characters with general
118861     * categories "L" (letters) and "Nd" (decimal digit numbers).
118862     *
118863     * @param mixed $codepoint
118864     * @return bool Returns TRUE if {@link codepoint} is an alphanumeric
118865     *   character, FALSE if not.
118866     * @since PHP 7
118867     **/
118868    public static function isalnum($codepoint){}
118869
118870    /**
118871     * Check if code point is a letter character
118872     *
118873     * Determines whether the specified code point is a letter character.
118874     * TRUE for general categories "L" (letters).
118875     *
118876     * @param mixed $codepoint
118877     * @return bool Returns TRUE if {@link codepoint} is a letter
118878     *   character, FALSE if not.
118879     * @since PHP 7
118880     **/
118881    public static function isalpha($codepoint){}
118882
118883    /**
118884     * Check if code point is a base character
118885     *
118886     * Determines whether the specified code point is a base character. TRUE
118887     * for general categories "L" (letters), "N" (numbers), "Mc" (spacing
118888     * combining marks), and "Me" (enclosing marks).
118889     *
118890     * @param mixed $codepoint
118891     * @return bool Returns TRUE if {@link codepoint} is a base character,
118892     *   FALSE if not.
118893     * @since PHP 7
118894     **/
118895    public static function isbase($codepoint){}
118896
118897    /**
118898     * Check if code point is a "blank" or "horizontal space" character
118899     *
118900     * Determines whether the specified code point is a "blank" or
118901     * "horizontal space", a character that visibly separates words on a
118902     * line.
118903     *
118904     * The following are equivalent definitions: TRUE for Unicode White_Space
118905     * characters except for "vertical space controls" where "vertical space
118906     * controls" are the following characters: U+000A (LF) U+000B (VT) U+000C
118907     * (FF) U+000D (CR) U+0085 (NEL) U+2028 (LS) U+2029 (PS) TRUE for U+0009
118908     * (TAB) and characters with general category "Zs" (space separators)
118909     * except Zero Width Space (ZWSP, U+200B).
118910     *
118911     * @param mixed $codepoint
118912     * @return bool Returns TRUE if {@link codepoint} is either a "blank"
118913     *   or "horizontal space" character, FALSE if not.
118914     * @since PHP 7
118915     **/
118916    public static function isblank($codepoint){}
118917
118918    /**
118919     * Check if code point is a control character
118920     *
118921     * Determines whether the specified code point is a control character.
118922     *
118923     * A control character is one of the following: ISO 8-bit control
118924     * character (U+0000..U+001f and U+007f..U+009f)
118925     * IntlChar::CHAR_CATEGORY_CONTROL_CHAR (Cc)
118926     * IntlChar::CHAR_CATEGORY_FORMAT_CHAR (Cf)
118927     * IntlChar::CHAR_CATEGORY_LINE_SEPARATOR (Zl)
118928     * IntlChar::CHAR_CATEGORY_PARAGRAPH_SEPARATOR (Zp)
118929     *
118930     * @param mixed $codepoint
118931     * @return bool Returns TRUE if {@link codepoint} is a control
118932     *   character, FALSE if not.
118933     * @since PHP 7
118934     **/
118935    public static function iscntrl($codepoint){}
118936
118937    /**
118938     * Check whether the code point is defined
118939     *
118940     * Determines whether the specified code point is "defined", which
118941     * usually means that it is assigned a character.
118942     *
118943     * TRUE for general categories other than "Cn" (other, not assigned).
118944     *
118945     * @param mixed $codepoint
118946     * @return bool Returns TRUE if {@link codepoint} is a defined
118947     *   character, FALSE if not.
118948     * @since PHP 7
118949     **/
118950    public static function isdefined($codepoint){}
118951
118952    /**
118953     * Check if code point is a digit character
118954     *
118955     * Determines whether the specified code point is a digit character.
118956     *
118957     * TRUE for characters with general category "Nd" (decimal digit
118958     * numbers). Beginning with Unicode 4, this is the same as testing for
118959     * the Numeric_Type of Decimal.
118960     *
118961     * @param mixed $codepoint
118962     * @return bool Returns TRUE if {@link codepoint} is a digit character,
118963     *   FALSE if not.
118964     * @since PHP 7
118965     **/
118966    public static function isdigit($codepoint){}
118967
118968    /**
118969     * Check if code point is a graphic character
118970     *
118971     * Determines whether the specified code point is a "graphic" character
118972     * (printable, excluding spaces).
118973     *
118974     * TRUE for all characters except those with general categories "Cc"
118975     * (control codes), "Cf" (format controls), "Cs" (surrogates), "Cn"
118976     * (unassigned), and "Z" (separators).
118977     *
118978     * @param mixed $codepoint
118979     * @return bool Returns TRUE if {@link codepoint} is a "graphic"
118980     *   character, FALSE if not.
118981     * @since PHP 7
118982     **/
118983    public static function isgraph($codepoint){}
118984
118985    /**
118986     * Check if code point is an ignorable character
118987     *
118988     * Determines if the specified character should be regarded as an
118989     * ignorable character in an identifier.
118990     *
118991     * TRUE for characters with general category "Cf" (format controls) as
118992     * well as non-whitespace ISO controls (U+0000..U+0008, U+000E..U+001B,
118993     * U+007F..U+009F).
118994     *
118995     * @param mixed $codepoint
118996     * @return bool Returns TRUE if {@link codepoint} is ignorable in
118997     *   identifiers, FALSE if not.
118998     * @since PHP 7
118999     **/
119000    public static function isIDIgnorable($codepoint){}
119001
119002    /**
119003     * Check if code point is permissible in an identifier
119004     *
119005     * Determines if the specified character is permissible in an identifier.
119006     *
119007     * TRUE for characters with general categories "L" (letters), "Nl"
119008     * (letter numbers), "Nd" (decimal digits), "Mc" and "Mn" (combining
119009     * marks), "Pc" (connecting punctuation), and u_isIDIgnorable(c).
119010     *
119011     * @param mixed $codepoint
119012     * @return bool Returns TRUE if {@link codepoint} is the code point may
119013     *   occur in an identifier, FALSE if not.
119014     * @since PHP 7
119015     **/
119016    public static function isIDPart($codepoint){}
119017
119018    /**
119019     * Check if code point is permissible as the first character in an
119020     * identifier
119021     *
119022     * Determines if the specified character is permissible as the first
119023     * character in an identifier according to Unicode (The Unicode Standard,
119024     * Version 3.0, chapter 5.16 Identifiers).
119025     *
119026     * TRUE for characters with general categories "L" (letters) and "Nl"
119027     * (letter numbers).
119028     *
119029     * @param mixed $codepoint
119030     * @return bool Returns TRUE if {@link codepoint} may start an
119031     *   identifier, FALSE if not.
119032     * @since PHP 7
119033     **/
119034    public static function isIDStart($codepoint){}
119035
119036    /**
119037     * Check if code point is an ISO control code
119038     *
119039     * Determines whether the specified code point is an ISO control code.
119040     *
119041     * TRUE for U+0000..U+001f and U+007f..U+009f (general category "Cc").
119042     *
119043     * @param mixed $codepoint
119044     * @return bool Returns TRUE if {@link codepoint} is an ISO control
119045     *   code, FALSE if not.
119046     * @since PHP 7
119047     **/
119048    public static function isISOControl($codepoint){}
119049
119050    /**
119051     * Check if code point is permissible in a Java identifier
119052     *
119053     * Determines if the specified character is permissible in a Java
119054     * identifier.
119055     *
119056     * In addition to {@link IntlChar::isIDPart}, TRUE for characters with
119057     * general category "Sc" (currency symbols).
119058     *
119059     * @param mixed $codepoint
119060     * @return bool Returns TRUE if {@link codepoint} may occur in a Java
119061     *   identifier, FALSE if not.
119062     * @since PHP 7
119063     **/
119064    public static function isJavaIDPart($codepoint){}
119065
119066    /**
119067     * Check if code point is permissible as the first character in a Java
119068     * identifier
119069     *
119070     * Determines if the specified character is permissible as the start of a
119071     * Java identifier.
119072     *
119073     * In addition to {@link IntlChar::isIDStart}, TRUE for characters with
119074     * general categories "Sc" (currency symbols) and "Pc" (connecting
119075     * punctuation).
119076     *
119077     * @param mixed $codepoint
119078     * @return bool Returns TRUE if {@link codepoint} may start a Java
119079     *   identifier, FALSE if not.
119080     * @since PHP 7
119081     **/
119082    public static function isJavaIDStart($codepoint){}
119083
119084    /**
119085     * Check if code point is a space character according to Java
119086     *
119087     * Determine if the specified code point is a space character according
119088     * to Java.
119089     *
119090     * TRUE for characters with general categories "Z" (separators), which
119091     * does not include control codes (e.g., TAB or Line Feed).
119092     *
119093     * @param mixed $codepoint
119094     * @return bool Returns TRUE if {@link codepoint} is a space character
119095     *   according to Java, FALSE if not.
119096     * @since PHP 7
119097     **/
119098    public static function isJavaSpaceChar($codepoint){}
119099
119100    /**
119101     * Check if code point is a lowercase letter
119102     *
119103     * Determines whether the specified code point has the general category
119104     * "Ll" (lowercase letter).
119105     *
119106     * @param mixed $codepoint
119107     * @return bool Returns TRUE if {@link codepoint} is an Ll lowercase
119108     *   letter, FALSE if not.
119109     * @since PHP 7
119110     **/
119111    public static function islower($codepoint){}
119112
119113    /**
119114     * Check if code point has the Bidi_Mirrored property
119115     *
119116     * Determines whether the code point has the Bidi_Mirrored property.
119117     *
119118     * This property is set for characters that are commonly used in
119119     * Right-To-Left contexts and need to be displayed with a "mirrored"
119120     * glyph.
119121     *
119122     * @param mixed $codepoint
119123     * @return bool Returns TRUE if {@link codepoint} has the Bidi_Mirrored
119124     *   property, FALSE if not.
119125     * @since PHP 7
119126     **/
119127    public static function isMirrored($codepoint){}
119128
119129    /**
119130     * Check if code point is a printable character
119131     *
119132     * Determines whether the specified code point is a printable character.
119133     *
119134     * TRUE for general categories other than "C" (controls).
119135     *
119136     * @param mixed $codepoint
119137     * @return bool Returns TRUE if {@link codepoint} is a printable
119138     *   character, FALSE if not.
119139     * @since PHP 7
119140     **/
119141    public static function isprint($codepoint){}
119142
119143    /**
119144     * Check if code point is punctuation character
119145     *
119146     * Determines whether the specified code point is a punctuation
119147     * character.
119148     *
119149     * TRUE for characters with general categories "P" (punctuation).
119150     *
119151     * @param mixed $codepoint
119152     * @return bool Returns TRUE if {@link codepoint} is a punctuation
119153     *   character, FALSE if not.
119154     * @since PHP 7
119155     **/
119156    public static function ispunct($codepoint){}
119157
119158    /**
119159     * Check if code point is a space character
119160     *
119161     * Determines if the specified character is a space character or not.
119162     *
119163     * @param mixed $codepoint
119164     * @return bool Returns TRUE if {@link codepoint} is a space character,
119165     *   FALSE if not.
119166     * @since PHP 7
119167     **/
119168    public static function isspace($codepoint){}
119169
119170    /**
119171     * Check if code point is a titlecase letter
119172     *
119173     * Determines whether the specified code point is a titlecase letter.
119174     *
119175     * TRUE for general category "Lt" (titlecase letter).
119176     *
119177     * @param mixed $codepoint
119178     * @return bool Returns TRUE if {@link codepoint} is a titlecase
119179     *   letter, FALSE if not.
119180     * @since PHP 7
119181     **/
119182    public static function istitle($codepoint){}
119183
119184    /**
119185     * Check if code point has the Alphabetic Unicode property
119186     *
119187     * Check if a code point has the Alphabetic Unicode property.
119188     *
119189     * This is the same as IntlChar::hasBinaryProperty($codepoint,
119190     * IntlChar::PROPERTY_ALPHABETIC)
119191     *
119192     * @param mixed $codepoint
119193     * @return bool Returns TRUE if {@link codepoint} has the Alphabetic
119194     *   Unicode property, FALSE if not.
119195     * @since PHP 7
119196     **/
119197    public static function isUAlphabetic($codepoint){}
119198
119199    /**
119200     * Check if code point has the Lowercase Unicode property
119201     *
119202     * Check if a code point has the Lowercase Unicode property.
119203     *
119204     * This is the same as IntlChar::hasBinaryProperty($codepoint,
119205     * IntlChar::PROPERTY_LOWERCASE)
119206     *
119207     * @param mixed $codepoint
119208     * @return bool Returns TRUE if {@link codepoint} has the Lowercase
119209     *   Unicode property, FALSE if not.
119210     * @since PHP 7
119211     **/
119212    public static function isULowercase($codepoint){}
119213
119214    /**
119215     * Check if code point has the general category "Lu" (uppercase letter)
119216     *
119217     * Determines whether the specified code point has the general category
119218     * "Lu" (uppercase letter).
119219     *
119220     * @param mixed $codepoint
119221     * @return bool Returns TRUE if {@link codepoint} is an Lu uppercase
119222     *   letter, FALSE if not.
119223     * @since PHP 7
119224     **/
119225    public static function isupper($codepoint){}
119226
119227    /**
119228     * Check if code point has the Uppercase Unicode property
119229     *
119230     * Check if a code point has the Uppercase Unicode property.
119231     *
119232     * This is the same as IntlChar::hasBinaryProperty($codepoint,
119233     * IntlChar::PROPERTY_UPPERCASE)
119234     *
119235     * @param mixed $codepoint
119236     * @return bool Returns TRUE if {@link codepoint} has the Uppercase
119237     *   Unicode property, FALSE if not.
119238     * @since PHP 7
119239     **/
119240    public static function isUUppercase($codepoint){}
119241
119242    /**
119243     * Check if code point has the White_Space Unicode property
119244     *
119245     * Check if a code point has the White_Space Unicode property.
119246     *
119247     * This is the same as IntlChar::hasBinaryProperty($codepoint,
119248     * IntlChar::PROPERTY_WHITE_SPACE)
119249     *
119250     * @param mixed $codepoint
119251     * @return bool Returns TRUE if {@link codepoint} has the White_Space
119252     *   Unicode property, FALSE if not.
119253     * @since PHP 7
119254     **/
119255    public static function isUWhiteSpace($codepoint){}
119256
119257    /**
119258     * Check if code point is a whitespace character according to ICU
119259     *
119260     * Determines if the specified code point is a whitespace character
119261     * according to ICU.
119262     *
119263     * A character is considered to be a ICU whitespace character if and only
119264     * if it satisfies one of the following criteria: It is a Unicode
119265     * Separator character (categories "Z" = "Zs" or "Zl" or "Zp"), but is
119266     * not also a non-breaking space (U+00A0 NBSP or U+2007 Figure Space or
119267     * U+202F Narrow NBSP). It is U+0009 HORIZONTAL TABULATION. It is U+000A
119268     * LINE FEED. It is U+000B VERTICAL TABULATION. It is U+000C FORM FEED.
119269     * It is U+000D CARRIAGE RETURN. It is U+001C FILE SEPARATOR. It is
119270     * U+001D GROUP SEPARATOR. It is U+001E RECORD SEPARATOR. It is U+001F
119271     * UNIT SEPARATOR.
119272     *
119273     * @param mixed $codepoint
119274     * @return bool Returns TRUE if {@link codepoint} is a whitespace
119275     *   character according to ICU, FALSE if not.
119276     * @since PHP 7
119277     **/
119278    public static function isWhitespace($codepoint){}
119279
119280    /**
119281     * Check if code point is a hexadecimal digit
119282     *
119283     * Determines whether the specified code point is a hexadecimal digit.
119284     *
119285     * TRUE for characters with general category "Nd" (decimal digit numbers)
119286     * as well as Latin letters a-f and A-F in both ASCII and Fullwidth
119287     * ASCII. (That is, for letters with code points 0041..0046, 0061..0066,
119288     * FF21..FF26, FF41..FF46.)
119289     *
119290     * This is equivalent to IntlChar::digit($codepoint, 16) >= 0.
119291     *
119292     * @param mixed $codepoint
119293     * @return bool Returns TRUE if {@link codepoint} is a hexadecimal
119294     *   character, FALSE if not.
119295     * @since PHP 7
119296     **/
119297    public static function isxdigit($codepoint){}
119298
119299    /**
119300     * Return Unicode code point value of character
119301     *
119302     * Returns the Unicode code point value of the given character.
119303     *
119304     * This function compliments {@link IntlChar::chr}.
119305     *
119306     * @param mixed $character A Unicode character.
119307     * @return int Returns the Unicode code point value as an integer.
119308     * @since PHP 7
119309     **/
119310    public static function ord($character){}
119311
119312    /**
119313     * Make Unicode character lowercase
119314     *
119315     * The given character is mapped to its lowercase equivalent. If the
119316     * character has no lowercase equivalent, the original character itself
119317     * is returned.
119318     *
119319     * @param mixed $codepoint
119320     * @return mixed Returns the Simple_Lowercase_Mapping of the code
119321     *   point, if any; otherwise the code point itself.
119322     * @since PHP 7
119323     **/
119324    public static function tolower($codepoint){}
119325
119326    /**
119327     * Make Unicode character titlecase
119328     *
119329     * The given character is mapped to its titlecase equivalent. If the
119330     * character has no titlecase equivalent, the original character itself
119331     * is returned.
119332     *
119333     * @param mixed $codepoint
119334     * @return mixed Returns the Simple_Titlecase_Mapping of the code
119335     *   point, if any; otherwise the code point itself.
119336     * @since PHP 7
119337     **/
119338    public static function totitle($codepoint){}
119339
119340    /**
119341     * Make Unicode character uppercase
119342     *
119343     * The given character is mapped to its uppercase equivalent. If the
119344     * character has no uppercase equivalent, the character itself is
119345     * returned.
119346     *
119347     * @param mixed $codepoint
119348     * @return mixed Returns the Simple_Uppercase_Mapping of the code
119349     *   point, if any; otherwise the code point itself.
119350     * @since PHP 7
119351     **/
119352    public static function toupper($codepoint){}
119353
119354}
119355/**
119356 * This break iterator identifies the boundaries between UTF-8 code
119357 * points.
119358 **/
119359class IntlCodePointBreakIterator extends IntlBreakIterator implements Traversable {
119360    /**
119361     * Get last code point passed over after advancing or receding the
119362     * iterator
119363     *
119364     * @return int
119365     * @since PHP 5 >= 5.5.0, PHP 7
119366     **/
119367    public function getLastCodePoint(){}
119368
119369}
119370/**
119371 * ICU Date formatter ICU Date formats
119372 **/
119373class IntlDateFormatter {
119374    /**
119375     * Create a date formatter
119376     *
119377     * (constructor)
119378     *
119379     * @param string $locale Locale to use when formatting or parsing or
119380     *   NULL to use the value specified in the ini setting
119381     *   intl.default_locale.
119382     * @param int $datetype Date type to use (none, short, medium, long,
119383     *   full). This is one of the IntlDateFormatter constants. It can also
119384     *   be NULL, in which case ICUʼs default date type will be used.
119385     * @param int $timetype Time type to use (none, short, medium, long,
119386     *   full). This is one of the IntlDateFormatter constants. It can also
119387     *   be NULL, in which case ICUʼs default time type will be used.
119388     * @param mixed $timezone Time zone ID. The default (and the one used
119389     *   if NULL is given) is the one returned by {@link
119390     *   date_default_timezone_get} or, if applicable, that of the
119391     *   IntlCalendar object passed for the {@link calendar} parameter. This
119392     *   ID must be a valid identifier on ICUʼs database or an ID
119393     *   representing an explicit offset, such as GMT-05:30. This can also be
119394     *   an IntlTimeZone or a DateTimeZone object.
119395     * @param mixed $calendar Calendar to use for formatting or parsing.
119396     *   The default value is NULL, which corresponds to
119397     *   IntlDateFormatter::GREGORIAN. This can either be one of the
119398     *   IntlDateFormatter calendar constants or an IntlCalendar. Any
119399     *   IntlCalendar object passed will be clone; it will not be changed by
119400     *   the IntlDateFormatter. This will determine the calendar type used
119401     *   (gregorian, islamic, persian, etc.) and, if NULL is given for the
119402     *   {@link timezone} parameter, also the timezone used.
119403     * @param string $pattern Optional pattern to use when formatting or
119404     *   parsing. Possible patterns are documented at .
119405     * @return IntlDateFormatter The created IntlDateFormatter or FALSE in
119406     *   case of failure.
119407     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
119408     **/
119409    public static function create($locale, $datetype, $timetype, $timezone, $calendar, $pattern){}
119410
119411    /**
119412     * Format the date/time value as a string
119413     *
119414     * Formats the time value as a string.
119415     *
119416     * @param mixed $value The date formatter resource.
119417     * @return string The formatted string or, if an error occurred, FALSE.
119418     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
119419     **/
119420    public function format($value){}
119421
119422    /**
119423     * Formats an object
119424     *
119425     * This function allows formatting an IntlCalendar or DateTime object
119426     * without first explicitly creating a IntlDateFormatter object.
119427     *
119428     * The temporary IntlDateFormatter that will be created will take the
119429     * timezone from the passed in object. The timezone database bundled with
119430     * PHP will not be used – ICU's will be used instead. The timezone
119431     * identifier used in DateTime objects must therefore also exist in ICU's
119432     * database.
119433     *
119434     * @param object $object An object of type IntlCalendar or DateTime.
119435     *   The timezone information in the object will be used.
119436     * @param mixed $format How to format the date/time. This can either be
119437     *   an array with two elements (first the date style, then the time
119438     *   style, these being one of the constants IntlDateFormatter::NONE,
119439     *   IntlDateFormatter::SHORT, IntlDateFormatter::MEDIUM,
119440     *   IntlDateFormatter::LONG, IntlDateFormatter::FULL), an integer with
119441     *   the value of one of these constants (in which case it will be used
119442     *   both for the time and the date) or a string with the format
119443     *   described in the ICU documentation. If NULL, the default style will
119444     *   be used.
119445     * @param string $locale The locale to use, or NULL to use the default
119446     *   one.
119447     * @return string A string with result.
119448     * @since PHP 5 >= 5.5.0, PHP 7, PECL intl >= 3.0.0
119449     **/
119450    public static function formatObject($object, $format, $locale){}
119451
119452    /**
119453     * Get the calendar type used for the IntlDateFormatter
119454     *
119455     * @return int The calendar type being used by the formatter. Either
119456     *   IntlDateFormatter::TRADITIONAL or IntlDateFormatter::GREGORIAN.
119457     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
119458     **/
119459    public function getCalendar(){}
119460
119461    /**
119462     * Get copy of formatterʼs calendar object
119463     *
119464     * Obtain a copy of the calendar object used internally by this
119465     * formatter. This calendar will have a type (as in gregorian, japanese,
119466     * buddhist, roc, persian, islamic, etc.) and a timezone that match the
119467     * type and timezone used by the formatter. The date/time of the object
119468     * is unspecified.
119469     *
119470     * @return IntlCalendar A copy of the internal calendar object used by
119471     *   this formatter.
119472     * @since PHP 5 >= 5.5.0, PHP 7, PECL intl >= 3.0.0
119473     **/
119474    public function getCalendarObject(){}
119475
119476    /**
119477     * Get the datetype used for the IntlDateFormatter
119478     *
119479     * Returns date type used by the formatter.
119480     *
119481     * @return int The current date type value of the formatter.
119482     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
119483     **/
119484    public function getDateType(){}
119485
119486    /**
119487     * Get the error code from last operation
119488     *
119489     * Get the error code from last operation. Returns error code from the
119490     * last number formatting operation.
119491     *
119492     * @return int The error code, one of UErrorCode values. Initial value
119493     *   is U_ZERO_ERROR.
119494     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
119495     **/
119496    public function getErrorCode(){}
119497
119498    /**
119499     * Get the error text from the last operation
119500     *
119501     * @return string Description of the last error.
119502     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
119503     **/
119504    public function getErrorMessage(){}
119505
119506    /**
119507     * Get the locale used by formatter
119508     *
119509     * Get locale used by the formatter.
119510     *
119511     * @param int $which The formatter resource
119512     * @return string the locale of this formatter or 'false' if error
119513     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
119514     **/
119515    public function getLocale($which){}
119516
119517    /**
119518     * Get the pattern used for the IntlDateFormatter
119519     *
119520     * Get pattern used by the formatter.
119521     *
119522     * @return string The pattern string being used to format/parse.
119523     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
119524     **/
119525    public function getPattern(){}
119526
119527    /**
119528     * Get the timetype used for the IntlDateFormatter
119529     *
119530     * Return time type used by the formatter.
119531     *
119532     * @return int The current date type value of the formatter.
119533     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
119534     **/
119535    public function getTimeType(){}
119536
119537    /**
119538     * Get formatterʼs timezone
119539     *
119540     * Returns an IntlTimeZone object representing the timezone that will be
119541     * used by this object to format dates and times. When formatting
119542     * IntlCalendar and DateTime objects with this IntlDateFormatter, the
119543     * timezone used will be the one returned by this method, not the one
119544     * associated with the objects being formatted.
119545     *
119546     * @return IntlTimeZone The associated IntlTimeZone object.
119547     * @since PHP 5 >= 5.5.0, PHP 7, PECL intl >= 3.0.0
119548     **/
119549    public function getTimeZone(){}
119550
119551    /**
119552     * Get the timezone-id used for the IntlDateFormatter
119553     *
119554     * @return string ID string for the time zone used by this formatter.
119555     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
119556     **/
119557    public function getTimeZoneId(){}
119558
119559    /**
119560     * Get the lenient used for the IntlDateFormatter
119561     *
119562     * Check if the parser is strict or lenient in interpreting inputs that
119563     * do not match the pattern exactly.
119564     *
119565     * @return bool TRUE if parser is lenient, FALSE if parser is strict.
119566     *   By default the parser is lenient.
119567     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
119568     **/
119569    public function isLenient(){}
119570
119571    /**
119572     * Parse string to a field-based time value
119573     *
119574     * Converts string $value to a field-based time value ( an array of
119575     * various fields), starting at $parse_pos and consuming as much of the
119576     * input value as possible.
119577     *
119578     * @param string $value The formatter resource
119579     * @param int $position string to convert to a time
119580     * @return array Localtime compatible array of integers : contains 24
119581     *   hour clock value in tm_hour field
119582     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
119583     **/
119584    public function localtime($value, &$position){}
119585
119586    /**
119587     * Parse string to a timestamp value
119588     *
119589     * Converts string $value to an incremental time value, starting at
119590     * $parse_pos and consuming as much of the input value as possible.
119591     *
119592     * @param string $value The formatter resource
119593     * @param int $position string to convert to a time
119594     * @return int timestamp parsed value, or FALSE if value can't be
119595     *   parsed.
119596     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
119597     **/
119598    public function parse($value, &$position){}
119599
119600    /**
119601     * Sets the calendar type used by the formatter
119602     *
119603     * Sets the calendar or calendar type used by the formatter.
119604     *
119605     * @param mixed $which The formatter resource.
119606     * @return bool
119607     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
119608     **/
119609    public function setCalendar($which){}
119610
119611    /**
119612     * Set the leniency of the parser
119613     *
119614     * Define if the parser is strict or lenient in interpreting inputs that
119615     * do not match the pattern exactly. Enabling lenient parsing allows the
119616     * parser to accept otherwise flawed date or time patterns, parsing as
119617     * much as possible to obtain a value. Extra space, unrecognized tokens,
119618     * or invalid values ("February 30th") are not accepted.
119619     *
119620     * @param bool $lenient The formatter resource
119621     * @return bool
119622     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
119623     **/
119624    public function setLenient($lenient){}
119625
119626    /**
119627     * Set the pattern used for the IntlDateFormatter
119628     *
119629     * @param string $pattern The formatter resource.
119630     * @return bool Bad formatstrings are usually the cause of the failure.
119631     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
119632     **/
119633    public function setPattern($pattern){}
119634
119635    /**
119636     * Sets formatterʼs timezone
119637     *
119638     * Sets the timezone used for the IntlDateFormatter. object.
119639     *
119640     * @param mixed $zone The formatter resource.
119641     * @return bool Returns TRUE on success and FALSE on failure.
119642     * @since PHP 5 >= 5.5.0, PHP 7, PECL intl >= 3.0.0
119643     **/
119644    public function setTimeZone($zone){}
119645
119646    /**
119647     * Sets the time zone to use
119648     *
119649     * @param string $zone The formatter resource.
119650     * @return bool
119651     * @since PHP 5 >= 5.3.0, PECL intl >= 1.0.0
119652     **/
119653    public function setTimeZoneId($zone){}
119654
119655}
119656/**
119657 * This class is used for generating exceptions when errors occur inside
119658 * intl functions. Such exceptions are only generated when
119659 * intl.use_exceptions is enabled.
119660 **/
119661class IntlException extends Exception {
119662}
119663class IntlGregorianCalendar extends IntlCalendar {
119664    /**
119665     * Get the Gregorian Calendar change date
119666     *
119667     * @return float Returns the change date.
119668     * @since PHP 5 >= 5.5.0, PHP 7
119669     **/
119670    public function getGregorianChange(){}
119671
119672    /**
119673     * Determine if the given year is a leap year
119674     *
119675     * @param int $year
119676     * @return bool Returns TRUE for leap years, FALSE otherwise and on
119677     *   failure.
119678     * @since PHP 5 >= 5.5.0, PHP 7
119679     **/
119680    public function isLeapYear($year){}
119681
119682    /**
119683     * Set the Gregorian Calendar the change date
119684     *
119685     * @param float $date
119686     * @return bool
119687     * @since PHP 5 >= 5.5.0, PHP 7
119688     **/
119689    public function setGregorianChange($date){}
119690
119691}
119692/**
119693 * This class represents iterator objects throughout the intl extension
119694 * whenever the iterator cannot be identified with any other object
119695 * provided by the extension. The distinct iterator object used
119696 * internally by the foreach construct can only be obtained (in the
119697 * relevant part here) from objects, so objects of this class serve the
119698 * purpose of providing the hook through which this internal object can
119699 * be obtained. As a convenience, this class also implements the Iterator
119700 * interface, allowing the collection of values to be navigated using the
119701 * methods defined in that interface. Both these methods and the internal
119702 * iterator objects provided to foreach are backed by the same state
119703 * (e.g. the position of the iterator and its current value). Subclasses
119704 * may provide richer functionality.
119705 **/
119706class IntlIterator implements Iterator {
119707    /**
119708     * Get the current element
119709     *
119710     * @return mixed
119711     * @since PHP 5 >= 5.5.0, PHP 7
119712     **/
119713    public function current(){}
119714
119715    /**
119716     * Get the current key
119717     *
119718     * @return string
119719     * @since PHP 5 >= 5.5.0, PHP 7
119720     **/
119721    public function key(){}
119722
119723    /**
119724     * Move forward to the next element
119725     *
119726     * @return void
119727     * @since PHP 5 >= 5.5.0, PHP 7
119728     **/
119729    public function next(){}
119730
119731    /**
119732     * Rewind the iterator to the first element
119733     *
119734     * @return void
119735     * @since PHP 5 >= 5.5.0, PHP 7
119736     **/
119737    public function rewind(){}
119738
119739    /**
119740     * Check if current position is valid
119741     *
119742     * @return bool
119743     * @since PHP 5 >= 5.5.0, PHP 7
119744     **/
119745    public function valid(){}
119746
119747}
119748/**
119749 * Objects of this class can be obtained from IntlBreakIterator objects.
119750 * While the break iterators provide a sequence of boundary positions
119751 * when iterated, IntlPartsIterator objects provide, as a convenience,
119752 * the text fragments comprehended between two successive boundaries. The
119753 * keys may represent the offset of the left boundary, right boundary, or
119754 * they may just the sequence of non-negative integers. See {@link
119755 * IntlBreakIterator::getPartsIterator}.
119756 **/
119757class IntlPartsIterator extends IntlIterator implements Iterator {
119758    /**
119759     * @var integer
119760     **/
119761    const KEY_LEFT = 0;
119762
119763    /**
119764     * @var integer
119765     **/
119766    const KEY_RIGHT = 0;
119767
119768    /**
119769     * @var integer
119770     **/
119771    const KEY_SEQUENTIAL = 0;
119772
119773    /**
119774     * Get IntlBreakIterator backing this parts iterator
119775     *
119776     * @return IntlBreakIterator
119777     * @since PHP 5 >= 5.5.0, PHP 7
119778     **/
119779    public function getBreakIterator(){}
119780
119781}
119782/**
119783 * A subclass of IntlBreakIterator that encapsulates ICU break iterators
119784 * whose behavior is specified using a set of rules. This is the most
119785 * common kind of break iterators. These rules are described in the ICU
119786 * Boundary Analysis User Guide.
119787 **/
119788class IntlRuleBasedBreakIterator extends IntlBreakIterator implements Traversable {
119789    /**
119790     * Get the binary form of compiled rules
119791     *
119792     * @return string
119793     * @since PHP 5 >= 5.5.0, PHP 7
119794     **/
119795    public function getBinaryRules(){}
119796
119797    /**
119798     * Get the rule set used to create this object
119799     *
119800     * @return string
119801     * @since PHP 5 >= 5.5.0, PHP 7
119802     **/
119803    public function getRules(){}
119804
119805    /**
119806     * Get the largest status value from the break rules that determined the
119807     * current break position
119808     *
119809     * @return int
119810     * @since PHP 5 >= 5.5.0, PHP 7
119811     **/
119812    public function getRuleStatus(){}
119813
119814    /**
119815     * Get the status values from the break rules that determined the current
119816     * break position
119817     *
119818     * @return array
119819     * @since PHP 5 >= 5.5.0, PHP 7
119820     **/
119821    public function getRuleStatusVec(){}
119822
119823    /**
119824     * Create iterator from ruleset
119825     *
119826     * @param string $rules
119827     * @param string $areCompiled
119828     * @since PHP 5 >= 5.5.0, PHP 7
119829     **/
119830    public function __construct($rules, $areCompiled){}
119831
119832}
119833class IntlTimeZone {
119834    /**
119835     * @var integer
119836     **/
119837    const DISPLAY_LONG = 0;
119838
119839    /**
119840     * @var integer
119841     **/
119842    const DISPLAY_SHORT = 0;
119843
119844    /**
119845     * Get the number of IDs in the equivalency group that includes the given
119846     * ID
119847     *
119848     * @param string $zoneId
119849     * @return int
119850     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
119851     **/
119852    public static function countEquivalentIDs($zoneId){}
119853
119854    /**
119855     * Create a new copy of the default timezone for this host
119856     *
119857     * @return IntlTimeZone
119858     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
119859     **/
119860    public static function createDefault(){}
119861
119862    /**
119863     * Get an enumeration over time zone IDs associated with the given
119864     * country or offset
119865     *
119866     * @param mixed $countryOrRawOffset
119867     * @return IntlIterator
119868     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
119869     **/
119870    public static function createEnumeration($countryOrRawOffset){}
119871
119872    /**
119873     * Create a timezone object for the given ID
119874     *
119875     * @param string $zoneId
119876     * @return IntlTimeZone
119877     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
119878     **/
119879    public static function createTimeZone($zoneId){}
119880
119881    /**
119882     * Get an enumeration over system time zone IDs with the given filter
119883     * conditions
119884     *
119885     * @param int $zoneType
119886     * @param string $region
119887     * @param int $rawOffset
119888     * @return IntlIterator Returns IntlIterator.
119889     * @since PHP 5 >= 5.5.0, PHP 7
119890     **/
119891    public static function createTimeZoneIDEnumeration($zoneType, $region, $rawOffset){}
119892
119893    /**
119894     * Create a timezone object from
119895     *
119896     * @param DateTimeZone $zoneId
119897     * @return IntlTimeZone
119898     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
119899     **/
119900    public static function fromDateTimeZone($zoneId){}
119901
119902    /**
119903     * Get the canonical system timezone ID or the normalized custom time
119904     * zone ID for the given time zone ID
119905     *
119906     * @param string $zoneId
119907     * @param bool $isSystemID
119908     * @return string
119909     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
119910     **/
119911    public static function getCanonicalID($zoneId, &$isSystemID){}
119912
119913    /**
119914     * Get a name of this time zone suitable for presentation to the user
119915     *
119916     * @param bool $isDaylight
119917     * @param int $style
119918     * @param string $locale
119919     * @return string
119920     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
119921     **/
119922    public function getDisplayName($isDaylight, $style, $locale){}
119923
119924    /**
119925     * Get the amount of time to be added to local standard time to get local
119926     * wall clock time
119927     *
119928     * @return int
119929     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
119930     **/
119931    public function getDSTSavings(){}
119932
119933    /**
119934     * Get an ID in the equivalency group that includes the given ID
119935     *
119936     * @param string $zoneId
119937     * @param int $index
119938     * @return string
119939     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
119940     **/
119941    public static function getEquivalentID($zoneId, $index){}
119942
119943    /**
119944     * Get last error code on the object
119945     *
119946     * @return int
119947     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
119948     **/
119949    public function getErrorCode(){}
119950
119951    /**
119952     * Get last error message on the object
119953     *
119954     * @return string
119955     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
119956     **/
119957    public function getErrorMessage(){}
119958
119959    /**
119960     * Create GMT (UTC) timezone
119961     *
119962     * @return IntlTimeZone
119963     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
119964     **/
119965    public static function getGMT(){}
119966
119967    /**
119968     * Get timezone ID
119969     *
119970     * @return string
119971     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
119972     **/
119973    public function getID(){}
119974
119975    /**
119976     * Translate a Windows timezone into a system timezone
119977     *
119978     * Translates a Windows timezone (e.g. "Pacific Standard Time") into a
119979     * system timezone (e.g. "America/Los_Angeles").
119980     *
119981     * @param string $timezone
119982     * @param string $region
119983     * @return string Returns the system timezone.
119984     * @since PHP 7 >= 7.1.0
119985     **/
119986    public static function getIDForWindowsID($timezone, $region){}
119987
119988    /**
119989     * Get the time zone raw and GMT offset for the given moment in time
119990     *
119991     * @param float $date
119992     * @param bool $local
119993     * @param int $rawOffset
119994     * @param int $dstOffset
119995     * @return int
119996     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
119997     **/
119998    public function getOffset($date, $local, &$rawOffset, &$dstOffset){}
119999
120000    /**
120001     * Get the raw GMT offset (before taking daylight savings time into
120002     * account
120003     *
120004     * @return int
120005     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
120006     **/
120007    public function getRawOffset(){}
120008
120009    /**
120010     * Get the region code associated with the given system time zone ID
120011     *
120012     * @param string $zoneId
120013     * @return string Return region.
120014     * @since PHP 5 >= 5.5.0, PHP 7
120015     **/
120016    public static function getRegion($zoneId){}
120017
120018    /**
120019     * Get the timezone data version currently used by ICU
120020     *
120021     * @return string
120022     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
120023     **/
120024    public static function getTZDataVersion(){}
120025
120026    /**
120027     * Get the "unknown" time zone
120028     *
120029     * @return IntlTimeZone Returns IntlTimeZone or NULL on failure.
120030     * @since PHP 5 >= 5.5.0, PHP 7
120031     **/
120032    public static function getUnknown(){}
120033
120034    /**
120035     * Translate a system timezone into a Windows timezone
120036     *
120037     * Translates a system timezone (e.g. "America/Los_Angeles") into a
120038     * Windows timezone (e.g. "Pacific Standard Time").
120039     *
120040     * @param string $timezone
120041     * @return string Returns the Windows timezone.
120042     * @since PHP 7 >= 7.1.0
120043     **/
120044    public static function getWindowsID($timezone){}
120045
120046    /**
120047     * Check if this zone has the same rules and offset as another zone
120048     *
120049     * @param IntlTimeZone $otherTimeZone
120050     * @return bool
120051     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
120052     **/
120053    public function hasSameRules($otherTimeZone){}
120054
120055    /**
120056     * Convert to object
120057     *
120058     * @return DateTimeZone
120059     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
120060     **/
120061    public function toDateTimeZone(){}
120062
120063    /**
120064     * Check if this time zone uses daylight savings time
120065     *
120066     * @return bool
120067     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
120068     **/
120069    public function useDaylightTime(){}
120070
120071}
120072/**
120073 * Exception thrown if an argument is not of the expected type.
120074 **/
120075class InvalidArgumentException extends LogicException {
120076}
120077/**
120078 * Interface to create an external Iterator.
120079 **/
120080interface IteratorAggregate extends Traversable {
120081    /**
120082     * Retrieve an external iterator
120083     *
120084     * Returns an external iterator.
120085     *
120086     * @return Traversable An instance of an object implementing Iterator
120087     *   or Traversable
120088     * @since PHP 5, PHP 7
120089     **/
120090    public function getIterator();
120091
120092}
120093/**
120094 * This iterator wrapper allows the conversion of anything that is
120095 * Traversable into an Iterator. It is important to understand that most
120096 * classes that do not implement Iterators have reasons as most likely
120097 * they do not allow the full Iterator feature set. If so, techniques
120098 * should be provided to prevent misuse, otherwise expect exceptions or
120099 * fatal errors.
120100 **/
120101class IteratorIterator implements OuterIterator {
120102    /**
120103     * Get the current value
120104     *
120105     * Get the value of the current element.
120106     *
120107     * @return mixed The value of the current element.
120108     * @since PHP 5 >= 5.1.0, PHP 7
120109     **/
120110    public function current(){}
120111
120112    /**
120113     * Get the inner iterator
120114     *
120115     * @return Traversable The inner iterator as passed to
120116     *   IteratorIterator::__construct.
120117     * @since PHP 5 >= 5.1.0, PHP 7
120118     **/
120119    public function getInnerIterator(){}
120120
120121    /**
120122     * Get the key of the current element
120123     *
120124     * @return mixed The key of the current element.
120125     * @since PHP 5 >= 5.1.0, PHP 7
120126     **/
120127    public function key(){}
120128
120129    /**
120130     * Forward to the next element
120131     *
120132     * @return void
120133     * @since PHP 5 >= 5.1.0, PHP 7
120134     **/
120135    public function next(){}
120136
120137    /**
120138     * Rewind to the first element
120139     *
120140     * Rewinds to the first element.
120141     *
120142     * @return void
120143     * @since PHP 5 >= 5.1.0, PHP 7
120144     **/
120145    public function rewind(){}
120146
120147    /**
120148     * Checks if the iterator is valid
120149     *
120150     * @return bool Returns TRUE if the iterator is valid, otherwise FALSE
120151     * @since PHP 5 >= 5.1.0, PHP 7
120152     **/
120153    public function valid(){}
120154
120155    /**
120156     * Create an iterator from anything that is traversable
120157     *
120158     * Creates an iterator from anything that is traversable.
120159     *
120160     * @param Traversable $iterator The traversable iterator.
120161     * @since PHP 5 >= 5.1.0, PHP 7
120162     **/
120163    public function __construct($iterator){}
120164
120165}
120166/**
120167 * Exception thrown if JSON_THROW_ON_ERROR option is set for {@link
120168 * json_encode} or {@link json_decode}. code contains the error type, for
120169 * possible values see {@link json_last_error}.
120170 **/
120171class JsonException extends Exception {
120172}
120173/**
120174 * Objects implementing JsonSerializable can customize their JSON
120175 * representation when encoded with {@link json_encode}.
120176 **/
120177interface JsonSerializable {
120178    /**
120179     * Specify data which should be serialized to JSON
120180     *
120181     * Serializes the object to a value that can be serialized natively by
120182     * {@link json_encode}.
120183     *
120184     * @return mixed Returns data which can be serialized by {@link
120185     *   json_encode}, which is a value of any type other than a .
120186     * @since PHP 5 >= 5.4.0, PHP 7
120187     **/
120188    public function jsonSerialize();
120189
120190}
120191/**
120192 * The Judy class implements the ArrayAccess interface and the Iterator
120193 * interface. This class, once instantiated, can be accessed like a PHP
120194 * array. A PHP Judy object (or Judy Array) can be one of the following
120195 * type :
120196 *
120197 * Judy::BITSET Judy::INT_TO_INT Judy::INT_TO_MIXED Judy::STRING_TO_INT
120198 * Judy::STRING_TO_MIXED Judy array example
120199 **/
120200class Judy implements ArrayAccess, Iterator {
120201    /**
120202     * Define the Judy Array as a Bitset with keys as Integer and Values as a
120203     * Boolean
120204     *
120205     * @var integer
120206     **/
120207    const BITSET = 0;
120208
120209    /**
120210     * @var integer
120211     **/
120212    const INT_TO_INT = 0;
120213
120214    /**
120215     * @var integer
120216     **/
120217    const INT_TO_MIXED = 0;
120218
120219    /**
120220     * @var integer
120221     **/
120222    const STRING_TO_INT = 0;
120223
120224    /**
120225     * @var integer
120226     **/
120227    const STRING_TO_MIXED = 0;
120228
120229    /**
120230     * Locate the Nth index present in the array
120231     *
120232     * Locate the Nth index present in the Judy array.
120233     *
120234     * @param int $nth_index Nth index to return. If nth_index equal 1,
120235     *   then it will return the first index in the array.
120236     * @return int Return the index at the given Nth position.
120237     * @since PECL judy >= 0.1.1
120238     **/
120239    public function byCount($nth_index){}
120240
120241    /**
120242     * Count the number of elements in the array
120243     *
120244     * Count the number of elements in the Judy array.
120245     *
120246     * @param int $index_start Start counting from the given index. Default
120247     *   is first index.
120248     * @param int $index_end Stop counting when reaching this index.
120249     *   Default is last index.
120250     * @return int Return the number of elements.
120251     * @since PECL judy >= 0.1.1
120252     **/
120253    public function count($index_start, $index_end){}
120254
120255    /**
120256     * Search for the first index in the array
120257     *
120258     * Search (inclusive) for the first index present that is equal to or
120259     * greater than the passed Index.
120260     *
120261     * @param mixed $index The index can be an integer or a string
120262     *   corresponding to the index where to start the search.
120263     * @return mixed Return the corresponding index in the array.
120264     * @since PECL judy >= 0.1.1
120265     **/
120266    public function first($index){}
120267
120268    /**
120269     * Search for the first absent index in the array
120270     *
120271     * Search (inclusive) for the first absent index that is equal to or
120272     * greater than the passed Index.
120273     *
120274     * @param mixed $index The index can be an integer or a string
120275     *   corresponding to the index where to start the search.
120276     * @return int Return the corresponding index in the array.
120277     * @since PECL judy >= 0.1.1
120278     **/
120279    public function firstEmpty($index){}
120280
120281    /**
120282     * Free the entire array
120283     *
120284     * Free the entire Judy array.
120285     *
120286     * @return int
120287     * @since PECL judy >= 0.1.1
120288     **/
120289    public function free(){}
120290
120291    /**
120292     * Return the type of the current array
120293     *
120294     * Return an integer corresponding to the Judy type of the current
120295     * object.
120296     *
120297     * @return int Return an integer corresponding to a Judy type.
120298     * @since PECL judy >= 0.1.1
120299     **/
120300    public function getType(){}
120301
120302    /**
120303     * Search for the last index in the array
120304     *
120305     * Search (inclusive) for the last index present that is equal to or less
120306     * than the passed Index.
120307     *
120308     * @param string $index The index can be an integer or a string
120309     *   corresponding to the index where to start the search.
120310     * @return void Return the corresponding index in the array.
120311     * @since PECL judy >= 0.1.1
120312     **/
120313    public function last($index){}
120314
120315    /**
120316     * Search for the last absent index in the array
120317     *
120318     * Search (inclusive) for the last absent index that is equal to or less
120319     * than the passed Index.
120320     *
120321     * @param int $index The index can be an integer or a string
120322     *   corresponding to the index where to start the search.
120323     * @return int Return the corresponding index in the array.
120324     * @since PECL judy >= 0.1.1
120325     **/
120326    public function lastEmpty($index){}
120327
120328    /**
120329     * Return the memory used by the array
120330     *
120331     * Return the memory used by the Judy array.
120332     *
120333     * @return int Return the memory used in bytes.
120334     * @since PECL judy >= 0.1.1
120335     **/
120336    public function memoryUsage(){}
120337
120338    /**
120339     * Search for the next index in the array
120340     *
120341     * Search (exclusive) for the next index present that is greater than the
120342     * passed Index.
120343     *
120344     * @param mixed $index The index can be an integer or a string
120345     *   corresponding to the index where to start the search.
120346     * @return mixed Return the corresponding index in the array.
120347     * @since PECL judy >= 0.1.1
120348     **/
120349    public function next($index){}
120350
120351    /**
120352     * Search for the next absent index in the array
120353     *
120354     * Search (exclusive) for the next absent index that is greater than the
120355     * passed Index.
120356     *
120357     * @param int $index The index can be an integer or a string
120358     *   corresponding to the index where to start the search.
120359     * @return int Return the corresponding index in the array.
120360     * @since PECL judy >= 0.1.1
120361     **/
120362    public function nextEmpty($index){}
120363
120364    /**
120365     * Whether a offset exists
120366     *
120367     * Whether or not an offset exists.
120368     *
120369     * @param mixed $offset An offset to check for.
120370     * @return bool Returns TRUE on success or FALSE on failure.
120371     * @since PECL judy >= 0.1.1
120372     **/
120373    public function offsetExists($offset){}
120374
120375    /**
120376     * Offset to retrieve
120377     *
120378     * Returns the value at specified offset.
120379     *
120380     * @param mixed $offset The offset to retrieve.
120381     * @return mixed Can return all value types.
120382     * @since PECL judy >= 0.1.1
120383     **/
120384    public function offsetGet($offset){}
120385
120386    /**
120387     * Offset to set
120388     *
120389     * Assigns a value to the specified offset.
120390     *
120391     * @param mixed $offset The offset to assign the value to.
120392     * @param mixed $value The value to set.
120393     * @return bool No value is returned.
120394     * @since PECL judy >= 0.1.1
120395     **/
120396    public function offsetSet($offset, $value){}
120397
120398    /**
120399     * Offset to unset
120400     *
120401     * Unsets an offset.
120402     *
120403     * @param mixed $offset The offset to unset.
120404     * @return bool No value is returned.
120405     * @since PECL judy >= 0.1.1
120406     **/
120407    public function offsetUnset($offset){}
120408
120409    /**
120410     * Search for the previous index in the array
120411     *
120412     * Search (exclusive) for the previous index present that is less than
120413     * the passed Index.
120414     *
120415     * @param mixed $index The index can be an integer or a string
120416     *   corresponding to the index where to start the search.
120417     * @return mixed Return the corresponding index in the array.
120418     * @since PECL judy >= 0.1.1
120419     **/
120420    public function prev($index){}
120421
120422    /**
120423     * Search for the previous absent index in the array
120424     *
120425     * Search (exclusive) for the previous index absent that is less than the
120426     * passed Index.
120427     *
120428     * @param mixed $index The index can be an integer or a string
120429     *   corresponding to the index where to start the search.
120430     * @return int Return the corresponding index in the array.
120431     * @since PECL judy >= 0.1.1
120432     **/
120433    public function prevEmpty($index){}
120434
120435    /**
120436     * Return the size of the current array
120437     *
120438     * Judy::count.
120439     *
120440     * @return void Return an integer.
120441     * @since PECL judy >= 0.1.1
120442     **/
120443    public function size(){}
120444
120445    /**
120446     * Construct a new object
120447     *
120448     * Construct a new Judy object. A Judy object can be accessed like a PHP
120449     * Array.
120450     *
120451     * @param int $judy_type The Judy type to be used.
120452     * @since PECL judy >= 0.1.1
120453     **/
120454    public function __construct($judy_type){}
120455
120456    /**
120457     * Destruct a Judy object
120458     *
120459     * @return void
120460     * @since PECL judy >= 0.1.1
120461     **/
120462    public function __destruct(){}
120463
120464}
120465class KTaglib_ID3v2_AttachedPictureFrame {
120466    const Artist = 0;
120467
120468    const BackCover = 0;
120469
120470    const Band = 0;
120471
120472    const BandLogo = 0;
120473
120474    const ColouredFish = 0;
120475
120476    const Composer = 0;
120477
120478    const Conductor = 0;
120479
120480    const DuringPerformance = 0;
120481
120482    const DuringRecording = 0;
120483
120484    const FileIcon = 0;
120485
120486    const FrontCover = 0;
120487
120488    const Illustration = 0;
120489
120490    const LeadArtist = 0;
120491
120492    const LeafletPage = 0;
120493
120494    const Lyricist = 0;
120495
120496    const Media = 0;
120497
120498    const MovieScreenCapture = 0;
120499
120500    const Other = 0;
120501
120502    const OtherFileIcon = 0;
120503
120504    const RecordingLocation = 0;
120505
120506    /**
120507     * Returns a description for the picture in a picture frame
120508     *
120509     * Returns the attached description for a picture frame in an ID3v2.x
120510     * frame.
120511     *
120512     * @return string Returns a description for the picture in a picture
120513     *   frame
120514     * @since 0.0.1
120515     **/
120516    public function getDescription(){}
120517
120518    /**
120519     * Returns the mime type of the picture
120520     *
120521     * Returns the mime type of the image represented by the attached picture
120522     * frame.
120523     *
120524     * Please notice that this method might return different types. While
120525     * ID3v2.2 have a mime type that doesn't start with "image/", ID3v2.3 and
120526     * v2.4 usually start with "image/". Therefore the method might return
120527     * "image/png" for IDv2.3 frames and just "PNG" for ID3v2.2 frames.
120528     *
120529     * Notice that even the frame is an attached picture, the mime type might
120530     * not be set and therefore an empty string might be returned.
120531     *
120532     * @return string Returns the mime type of the image represented by the
120533     *   attached picture frame.
120534     * @since 0.2.0
120535     **/
120536    public function getMimeType(){}
120537
120538    /**
120539     * Returns the type of the image
120540     *
120541     * The ID3v2 specification allows an AttachedPictureFrame to set the type
120542     * of an image. This can be e.g. FrontCover or FileIcon. Please refer to
120543     * the KTaglib_ID3v2_AttachedPictureFrame class description for a list of
120544     * available types.
120545     *
120546     * @return int Returns the integer representation of the type.
120547     * @since 0.2.0
120548     **/
120549    public function getType(){}
120550
120551    /**
120552     * Saves the picture to a file
120553     *
120554     * Saves the attached picture to the given filename.
120555     *
120556     * @param string $filename
120557     * @return bool Returns true on success, otherwise false
120558     * @since 0.0.1
120559     **/
120560    public function savePicture($filename){}
120561
120562    /**
120563     * Sets the frame picture to the given image
120564     *
120565     * Sets the picture to the give image. The image is loaded from the given
120566     * filename. Please note that the picture is not saved unless you call
120567     * the save method of the corresponding file object.
120568     *
120569     * @param string $filename
120570     * @return void Returns true on success, otherwise false
120571     * @since 0.0.1
120572     **/
120573    public function setPicture($filename){}
120574
120575    /**
120576     * Set the type of the image
120577     *
120578     * Sets the type of the image. This can be e.g. FrontCover or FileIcon.
120579     * Please refer to the KTaglib_ID3v2_AttachedPictureFrame class
120580     * description for a list of available types and their constant mappings.
120581     *
120582     * @param int $type
120583     * @return void
120584     * @since 0.2.0
120585     **/
120586    public function setType($type){}
120587
120588}
120589class KTaglib_ID3v2_Frame extends KTaglib_ID3v2_Frame {
120590    /**
120591     * Returns the size of the frame in bytes
120592     *
120593     * Returns the size of the frame in bytes. Please refer to id3.org to see
120594     * what ID3v2 frames are and how they are defined.
120595     *
120596     * @return int Returns the size of the frame in bytes
120597     * @since 0.0.1
120598     **/
120599    public function getSize(){}
120600
120601    /**
120602     * Returns a string representation of the frame
120603     *
120604     * Returns a string representation of the frame. This might be just the
120605     * frame id, but might contain more information. Please see the ktaglib
120606     * documentation for more information
120607     *
120608     * @return string Returns a string representation of the frame.
120609     * @since 0.0.1
120610     **/
120611    public function __toString(){}
120612
120613}
120614class KTaglib_ID3v2_Tag {
120615    /**
120616     * Add a frame to the ID3v2 tag
120617     *
120618     * Adds a frame to the ID3v2 tag. The frame must be a valid
120619     * KTaglib_ID3v2_Frame object. To save the tag, the save function needs
120620     * to be invoked.
120621     *
120622     * @param KTaglib_ID3v2_Frame $frame
120623     * @return bool Returns true on success, otherwise false.
120624     * @since 0.0.1
120625     **/
120626    public function addFrame($frame){}
120627
120628    /**
120629     * Returns an array of ID3v2 frames, associated with the ID3v2 tag
120630     *
120631     * @return array Return an array of KTaglib_ID3v2_Frame objects
120632     * @since 0.0.1
120633     **/
120634    public function getFrameList(){}
120635
120636}
120637class KTaglib_MPEG_AudioProperties {
120638    /**
120639     * Returns the bitrate of the MPEG file
120640     *
120641     * @return int Returns the bitrate as an integer
120642     * @since 0.0.1
120643     **/
120644    public function getBitrate(){}
120645
120646    /**
120647     * Returns the amount of channels of a MPEG file
120648     *
120649     * Returns the amount of channels of the MPEG file
120650     *
120651     * @return int Returns the channel count as an integer
120652     * @since 0.0.1
120653     **/
120654    public function getChannels(){}
120655
120656    /**
120657     * Returns the layer of a MPEG file
120658     *
120659     * Returns the layer of the MPEG file (usually 3 for MP3).
120660     *
120661     * @return int Returns the layer as an integer
120662     * @since 0.0.1
120663     **/
120664    public function getLayer(){}
120665
120666    /**
120667     * Returns the length of a MPEG file
120668     *
120669     * Returns the length of the MPEG file
120670     *
120671     * @return int Returns the length as an integer
120672     * @since 0.0.1
120673     **/
120674    public function getLength(){}
120675
120676    /**
120677     * Returns the sample bitrate of a MPEG file
120678     *
120679     * Returns the sample bitrate of the MPEG file
120680     *
120681     * @return int Returns the sample bitrate as an integer
120682     * @since 0.0.1
120683     **/
120684    public function getSampleBitrate(){}
120685
120686    /**
120687     * Returns the version of a MPEG file
120688     *
120689     * Returns the version of the MPEG file header. The possible versions are
120690     * defined in Tag_MPEG_Header (Version1, Version2, Version2.5).
120691     *
120692     * @return int Returns the version
120693     * @since 0.0.1
120694     **/
120695    public function getVersion(){}
120696
120697    /**
120698     * Returns the copyright status of an MPEG file
120699     *
120700     * Returns true if the MPEG file is copyrighted
120701     *
120702     * @return bool Returns true if the MPEG file is copyrighted
120703     * @since 0.0.1
120704     **/
120705    public function isCopyrighted(){}
120706
120707    /**
120708     * Returns if the file is marked as the original file
120709     *
120710     * Returns true if the file is marked as the original file
120711     *
120712     * @return bool Returns true if the file is marked as the original file
120713     * @since 0.0.1
120714     **/
120715    public function isOriginal(){}
120716
120717    /**
120718     * Returns if protection mechanisms of an MPEG file are enabled
120719     *
120720     * Returns true if protection mechanisms (like DRM) are enabled for this
120721     * file
120722     *
120723     * @return bool Returns true if protection mechanisms (like DRM) are
120724     *   enabled for this file
120725     * @since 0.0.1
120726     **/
120727    public function isProtectionEnabled(){}
120728
120729}
120730class KTaglib_MPEG_File {
120731    /**
120732     * Returns an object that provides access to the audio properties
120733     *
120734     * Returns an object that provides access to the audio properties of the
120735     * mpeg file.
120736     *
120737     * @return KTaglib_MPEG_File Returns an KTaglib_MPEG_AudioProperties
120738     *   object or false.
120739     * @since 0.0.1
120740     **/
120741    public function getAudioProperties(){}
120742
120743    /**
120744     * Returns an object representing an ID3v1 tag
120745     *
120746     * Returns an object that represents an ID3v1 tag, which can be used to
120747     * get information about the ID3v1 tag.
120748     *
120749     * @param bool $create
120750     * @return KTaglib_ID3v1_Tag Returns an KTaglib_MPEG_ID3v1Tag object or
120751     *   false if there is no ID3v1 tag.
120752     * @since 0.0.1
120753     **/
120754    public function getID3v1Tag($create){}
120755
120756    /**
120757     * Returns a ID3v2 object
120758     *
120759     * Returns a ID3v2 object for the mpeg file. If no ID3v2 Tag is present,
120760     * an KTaglib_TagNotFoundException is thrown.
120761     *
120762     * @param bool $create
120763     * @return KTaglib_ID3v2_Tag Returns the KTaglib_ID3v2_Tag object of
120764     *   the MPEG file or false if there is no ID3v2 tag
120765     * @since 0.0.1
120766     **/
120767    public function getID3v2Tag($create){}
120768
120769}
120770class KTaglib_MPEG_Header {
120771    const Version1 = 0;
120772
120773    const Version2 = 0;
120774
120775    const Version2_5 = 0;
120776
120777}
120778class KTaglib_Tag extends KTaglib_Tag {
120779    /**
120780     * Returns the album string from a ID3 tag
120781     *
120782     * Returns the album string of an ID3 tag. This method is implemented in
120783     * ID3v1 and ID3v2 tags.
120784     *
120785     * @return string Returns the album string
120786     * @since 0.0.1
120787     **/
120788    public function getAlbum(){}
120789
120790    /**
120791     * Returns the artist string from a ID3 tag
120792     *
120793     * Returns the artist string of an ID3 tag. This method is implemented in
120794     * ID3v1 and ID3v2 tags.
120795     *
120796     * @return string Returns the artist string
120797     * @since 0.0.1
120798     **/
120799    public function getArtist(){}
120800
120801    /**
120802     * Returns the comment from a ID3 tag
120803     *
120804     * Returns the comment of an ID3 tag. This method is implemented in ID3v1
120805     * and ID3v2 tags.
120806     *
120807     * @return string Returns the comment string
120808     * @since 0.0.1
120809     **/
120810    public function getComment(){}
120811
120812    /**
120813     * Returns the genre from a ID3 tag
120814     *
120815     * Returns the genre of an ID3 tag. This method is implemented in ID3v1
120816     * and ID3v2 tags.
120817     *
120818     * @return string Returns the genre string
120819     * @since 0.0.1
120820     **/
120821    public function getGenre(){}
120822
120823    /**
120824     * Returns the title string from a ID3 tag
120825     *
120826     * Returns the title string of an ID3 tag. This method is implemented in
120827     * ID3v1 and ID3v2 tags.
120828     *
120829     * @return string Returns the title string
120830     * @since 0.0.1
120831     **/
120832    public function getTitle(){}
120833
120834    /**
120835     * Returns the track number from a ID3 tag
120836     *
120837     * Returns the track number of an ID3 tag. This method is implemented in
120838     * ID3v1 and ID3v2 tags.
120839     *
120840     * @return int Returns the track number as an integer
120841     * @since 0.0.1
120842     **/
120843    public function getTrack(){}
120844
120845    /**
120846     * Returns the year from a ID3 tag
120847     *
120848     * Returns the year of an ID3 tag. This method is implemented in ID3v1
120849     * and ID3v2 tags.
120850     *
120851     * @return int Returns the year as an integer
120852     * @since 0.0.1
120853     **/
120854    public function getYear(){}
120855
120856    /**
120857     * Returns true if the tag is empty
120858     *
120859     * Returns true if the tag exists, but is empty. This method is
120860     * implemented in ID3v1 and ID3v2 tags.
120861     *
120862     * @return bool Returns true if the tag is empty, otherwise false.
120863     * @since 0.0.1
120864     **/
120865    public function isEmpty(){}
120866
120867}
120868/**
120869 * LAPACK is written in Fortran 90 and provides routines for solving
120870 * systems of simultaneous linear equations, least-squares solutions of
120871 * linear systems of equations, eigenvalue problems, and singular value
120872 * problems. This extension wraps the LAPACKE C bindings to allow access
120873 * to several processes exposed by the library. Most functions work with
120874 * arrays of arrays, representing rectangular matrices in row major order
120875 * - so a two by two matrix [1 2; 3 4] would be array(array(1, 2),
120876 * array(3, 4)). All of the functions are called statically, for example
120877 * $eig = Lapack::eigenvalues($a);
120878 **/
120879class Lapack {
120880    /**
120881     * This function returns the eigenvalues for a given square matrix
120882     *
120883     * Calculate the eigenvalues for a square matrix, and optionally
120884     * calculate the left and right eigenvectors.
120885     *
120886     * @param array $a The matrix to calculate the eigenvalues for.
120887     * @param array $left Optional parameter - if an array is passed here,
120888     *   it will be filled with the left eigenvectors
120889     * @param array $right Optional parameter - if an array is passed here,
120890     *   it will be filled with the right eigenvectors
120891     * @return array Returns an array of arrays representing the
120892     *   eigenvalues for the array.
120893     * @since PECL lapack >= 0.1.0
120894     **/
120895    public static function eigenValues($a, $left, $right){}
120896
120897    /**
120898     * Return an identity matrix
120899     *
120900     * Return a size n identity matrix
120901     *
120902     * @param int $n The height and width of the identity matrix.
120903     * @return array Will return a an array of n arrays, each containing n
120904     *   entries. The diagonals of the matrix will be 1s, the other positions
120905     *   0.
120906     * @since PECL lapack >= 0.1.0
120907     **/
120908    public static function identity($n){}
120909
120910    /**
120911     * Calculate the linear least squares solution of a matrix using QR
120912     * factorisation
120913     *
120914     * Solve the linear least squares problem, find min x in || B - Ax ||
120915     * Returns an array representing x. Expects arrays of arrays, and will
120916     * return an array of arrays in the dimension B num cols x A num cols.
120917     * Uses QR or LQ factorisation on matrix A.
120918     *
120919     * @param array $a Matrix A
120920     * @param array $b Matrix B
120921     * @return array Array of the solution matrix
120922     * @since PECL lapack >= 0.1.0
120923     **/
120924    public static function leastSquaresByFactorisation($a, $b){}
120925
120926    /**
120927     * Solve the linear least squares problem, using SVD
120928     *
120929     * Solve the linear least squares problem, find min x in || B - Ax ||
120930     * Returns an array representing x. Expects arrays of arrays, and will
120931     * return an array of arrays in the dimension B num cols x A num cols.
120932     * Uses SVD with a divide and conquer algorithm.
120933     *
120934     * @param array $a Matrix A
120935     * @param array $b Matrix B
120936     * @return array Returns the solution as an array of arrays.
120937     * @since PECL lapack >= 0.1.0
120938     **/
120939    public static function leastSquaresBySVD($a, $b){}
120940
120941    /**
120942     * Calculate the inverse of a matrix
120943     *
120944     * Find the pseudoinverse of a matrix A.
120945     *
120946     * @param array $a Matrix to invert
120947     * @return array Inverted matrix (array of arrays).
120948     * @since PECL lapack >= 0.1.0
120949     **/
120950    public static function pseudoInverse($a){}
120951
120952    /**
120953     * Calculated the singular values of a matrix
120954     *
120955     * Calculate the singular values of the matrix A.
120956     *
120957     * @param array $a The matrix to calculate the singular values for
120958     * @return array The singular values
120959     * @since PECL lapack >= 0.1.0
120960     **/
120961    public static function singularValues($a){}
120962
120963    /**
120964     * Solve a system of linear equations
120965     *
120966     * This function computes the solution to the system of linear equations
120967     * with a square matrix A and multiple right-hand sides B. Solves A * X =
120968     * B for multiple B.
120969     *
120970     * @param array $a Square matrix of linear equations
120971     * @param array $b Right hand side to be solved for
120972     * @return array Matrix X
120973     * @since PECL lapack >= 0.1.0
120974     **/
120975    public static function solveLinearEquation($a, $b){}
120976
120977}
120978/**
120979 * Exception thrown when an error is caught in the LAPACK functions
120980 **/
120981class lapackexception extends Exception {
120982}
120983/**
120984 * Exception thrown if a length is invalid.
120985 **/
120986class LengthException extends LogicException {
120987}
120988/**
120989 * Contains various information about errors thrown by libxml. The error
120990 * codes are described within the official xmlError API documentation.
120991 **/
120992class libXMLError {
120993    /**
120994     * The error's code.
120995     *
120996     * @var int
120997     **/
120998    public $code;
120999
121000    /**
121001     * The column where the error occurred.
121002     *
121003     * @var int
121004     **/
121005    public $column;
121006
121007    /**
121008     * The filename, or empty if the XML was loaded from a string.
121009     *
121010     * @var string
121011     **/
121012    public $file;
121013
121014    /**
121015     * the severity of the error (one of the following constants:
121016     * LIBXML_ERR_WARNING, LIBXML_ERR_ERROR or LIBXML_ERR_FATAL)
121017     *
121018     * @var int
121019     **/
121020    public $level;
121021
121022    /**
121023     * The line where the error occurred.
121024     *
121025     * @var int
121026     **/
121027    public $line;
121028
121029    /**
121030     * The error message, if any.
121031     *
121032     * @var string
121033     **/
121034    public $message;
121035
121036}
121037/**
121038 * The LimitIterator class allows iteration over a limited subset of
121039 * items in an Iterator. LimitIterator usage example
121040 *
121041 * string(5) "apple" string(6) "banana" string(6) "cherry"
121042 *
121043 * string(6) "cherry" string(6) "damson" string(10) "elderberry"
121044 **/
121045class LimitIterator extends IteratorIterator implements OuterIterator {
121046    /**
121047     * Get current element
121048     *
121049     * Gets the current element of the inner Iterator.
121050     *
121051     * @return mixed Returns the current element or NULL if there is none.
121052     * @since PHP 5 >= 5.1.0, PHP 7
121053     **/
121054    public function current(){}
121055
121056    /**
121057     * Get inner iterator
121058     *
121059     * Gets the inner Iterator.
121060     *
121061     * @return Iterator The inner iterator passed to
121062     *   LimitIterator::__construct.
121063     * @since PHP 5 >= 5.1.0, PHP 7
121064     **/
121065    public function getInnerIterator(){}
121066
121067    /**
121068     * Return the current position
121069     *
121070     * Gets the current zero-based position of the inner Iterator.
121071     *
121072     * @return int The current position.
121073     * @since PHP 5 >= 5.1.0, PHP 7
121074     **/
121075    public function getPosition(){}
121076
121077    /**
121078     * Get current key
121079     *
121080     * Gets the key for the current item in the inner Iterator.
121081     *
121082     * @return mixed Returns the key for the current item.
121083     * @since PHP 5 >= 5.1.0, PHP 7
121084     **/
121085    public function key(){}
121086
121087    /**
121088     * Move the iterator forward
121089     *
121090     * Moves the iterator forward.
121091     *
121092     * @return void
121093     * @since PHP 5 >= 5.1.0, PHP 7
121094     **/
121095    public function next(){}
121096
121097    /**
121098     * Rewind the iterator to the specified starting offset
121099     *
121100     * Rewinds the iterator to the starting offset specified in
121101     * LimitIterator::__construct.
121102     *
121103     * @return void
121104     * @since PHP 5 >= 5.1.0, PHP 7
121105     **/
121106    public function rewind(){}
121107
121108    /**
121109     * Seek to the given position
121110     *
121111     * Moves the iterator to the offset specified by {@link position}.
121112     *
121113     * @param int $position The position to seek to.
121114     * @return int Returns the offset position after seeking.
121115     * @since PHP 5 >= 5.1.0, PHP 7
121116     **/
121117    public function seek($position){}
121118
121119    /**
121120     * Check whether the current element is valid
121121     *
121122     * Checks whether the current element is valid.
121123     *
121124     * @return bool
121125     * @since PHP 5 >= 5.1.0, PHP 7
121126     **/
121127    public function valid(){}
121128
121129    /**
121130     * Construct a LimitIterator
121131     *
121132     * Constructs a new LimitIterator from an {@link iterator} with a given
121133     * starting {@link offset} and maximum {@link count}.
121134     *
121135     * @param Iterator $iterator The Iterator to limit.
121136     * @param int $offset Optional offset of the limit.
121137     * @param int $count Optional count of the limit.
121138     * @since PHP 5 >= 5.1.0, PHP 7
121139     **/
121140    public function __construct($iterator, $offset, $count){}
121141
121142}
121143/**
121144 * Examples of identifiers include: en-US (English, United States)
121145 * zh-Hant-TW (Chinese, Traditional Script, Taiwan) fr-CA, fr-FR (French
121146 * for Canada and France respectively) RFC 4646 - Tags for Identifying
121147 * Languages RFC 4647 - Matching of Language Tags Unicode CLDR
121148 * Project:Common Locale Data Repository IANA Language Subtags Registry
121149 * ICU User Guide - Locale ICU Locale api
121150 **/
121151class Locale {
121152    /**
121153     * Tries to find out best available locale based on HTTP
121154     * "Accept-Language" header
121155     *
121156     * Tries to find locale that can satisfy the language list that is
121157     * requested by the HTTP "Accept-Language" header.
121158     *
121159     * @param string $header The string containing the "Accept-Language"
121160     *   header according to format in RFC 2616.
121161     * @return string The corresponding locale identifier.
121162     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
121163     **/
121164    public static function acceptFromHttp($header){}
121165
121166    /**
121167     * Canonicalize the locale string
121168     *
121169     * @param string $locale
121170     * @return string
121171     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
121172     **/
121173    public static function canonicalize($locale){}
121174
121175    /**
121176     * Returns a correctly ordered and delimited locale ID
121177     *
121178     * Returns a correctly ordered and delimited locale ID the keys identify
121179     * the particular locale ID subtags, and the values are the associated
121180     * subtag values.
121181     *
121182     * @param array $subtags an array containing a list of key-value pairs,
121183     *   where the keys identify the particular locale ID subtags, and the
121184     *   values are the associated subtag values. The 'variant' and 'private'
121185     *   subtags can take maximum 15 values whereas 'extlang' can take
121186     *   maximum 3 values.e.g. Variants are allowed with the suffix ranging
121187     *   from 0-14. Hence the keys for the input array can be variant0,
121188     *   variant1, ...,variant14. In the returned locale id, the subtag is
121189     *   ordered by suffix resulting in variant0 followed by variant1
121190     *   followed by variant2 and so on. The 'variant', 'private' and
121191     *   'extlang' multiple values can be specified both as array under
121192     *   specific key (e.g. 'variant') and as multiple numbered keys (e.g.
121193     *   'variant0', 'variant1', etc.).
121194     * @return string The corresponding locale identifier.
121195     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
121196     **/
121197    public static function composeLocale($subtags){}
121198
121199    /**
121200     * Checks if a language tag filter matches with locale
121201     *
121202     * Checks if a $langtag filter matches with $locale according to RFC
121203     * 4647's basic filtering algorithm
121204     *
121205     * @param string $langtag The language tag to check
121206     * @param string $locale The language range to check against
121207     * @param bool $canonicalize If true, the arguments will be converted
121208     *   to canonical form before matching.
121209     * @return bool TRUE if $locale matches $langtag FALSE otherwise.
121210     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
121211     **/
121212    public static function filterMatches($langtag, $locale, $canonicalize){}
121213
121214    /**
121215     * Gets the variants for the input locale
121216     *
121217     * @param string $locale The locale to extract the variants from
121218     * @return array The array containing the list of all variants subtag
121219     *   for the locale or NULL if not present
121220     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
121221     **/
121222    public static function getAllVariants($locale){}
121223
121224    /**
121225     * Gets the default locale value from the INTL global 'default_locale'
121226     *
121227     * Gets the default locale value. At the PHP initialization this value is
121228     * set to 'intl.default_locale' value from if that value exists or from
121229     * ICU's function uloc_getDefault().
121230     *
121231     * @return string The current runtime locale
121232     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
121233     **/
121234    public static function getDefault(){}
121235
121236    /**
121237     * Returns an appropriately localized display name for language of the
121238     * inputlocale
121239     *
121240     * Returns an appropriately localized display name for language of the
121241     * input locale. If is NULL then the default locale is used.
121242     *
121243     * @param string $locale The locale to return a display language for
121244     * @param string $in_locale Optional format locale to use to display
121245     *   the language name
121246     * @return string display name of the language for the $locale in the
121247     *   format appropriate for $in_locale.
121248     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
121249     **/
121250    public static function getDisplayLanguage($locale, $in_locale){}
121251
121252    /**
121253     * Returns an appropriately localized display name for the input locale
121254     *
121255     * Returns an appropriately localized display name for the input locale.
121256     * If $locale is NULL then the default locale is used.
121257     *
121258     * @param string $locale The locale to return a display name for.
121259     * @param string $in_locale optional format locale
121260     * @return string Display name of the locale in the format appropriate
121261     *   for $in_locale.
121262     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
121263     **/
121264    public static function getDisplayName($locale, $in_locale){}
121265
121266    /**
121267     * Returns an appropriately localized display name for region of the
121268     * input locale
121269     *
121270     * Returns an appropriately localized display name for region of the
121271     * input locale. If is NULL then the default locale is used.
121272     *
121273     * @param string $locale The locale to return a display region for.
121274     * @param string $in_locale Optional format locale to use to display
121275     *   the region name
121276     * @return string display name of the region for the $locale in the
121277     *   format appropriate for $in_locale.
121278     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
121279     **/
121280    public static function getDisplayRegion($locale, $in_locale){}
121281
121282    /**
121283     * Returns an appropriately localized display name for script of the
121284     * input locale
121285     *
121286     * Returns an appropriately localized display name for script of the
121287     * input locale. If is NULL then the default locale is used.
121288     *
121289     * @param string $locale The locale to return a display script for
121290     * @param string $in_locale Optional format locale to use to display
121291     *   the script name
121292     * @return string Display name of the script for the $locale in the
121293     *   format appropriate for $in_locale.
121294     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
121295     **/
121296    public static function getDisplayScript($locale, $in_locale){}
121297
121298    /**
121299     * Returns an appropriately localized display name for variants of the
121300     * input locale
121301     *
121302     * Returns an appropriately localized display name for variants of the
121303     * input locale. If is NULL then the default locale is used.
121304     *
121305     * @param string $locale The locale to return a display variant for
121306     * @param string $in_locale Optional format locale to use to display
121307     *   the variant name
121308     * @return string Display name of the variant for the $locale in the
121309     *   format appropriate for $in_locale.
121310     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
121311     **/
121312    public static function getDisplayVariant($locale, $in_locale){}
121313
121314    /**
121315     * Gets the keywords for the input locale
121316     *
121317     * @param string $locale The locale to extract the keywords from
121318     * @return array Associative array containing the keyword-value pairs
121319     *   for this locale
121320     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
121321     **/
121322    public static function getKeywords($locale){}
121323
121324    /**
121325     * Gets the primary language for the input locale
121326     *
121327     * @param string $locale The locale to extract the primary language
121328     *   code from
121329     * @return string The language code associated with the language or
121330     *   NULL in case of error.
121331     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
121332     **/
121333    public static function getPrimaryLanguage($locale){}
121334
121335    /**
121336     * Gets the region for the input locale
121337     *
121338     * @param string $locale The locale to extract the region code from
121339     * @return string The region subtag for the locale or NULL if not
121340     *   present
121341     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
121342     **/
121343    public static function getRegion($locale){}
121344
121345    /**
121346     * Gets the script for the input locale
121347     *
121348     * @param string $locale The locale to extract the script code from
121349     * @return string The script subtag for the locale or NULL if not
121350     *   present
121351     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
121352     **/
121353    public static function getScript($locale){}
121354
121355    /**
121356     * Searches the language tag list for the best match to the language
121357     *
121358     * Searches the items in {@link langtag} for the best match to the
121359     * language range specified in {@link locale} according to RFC 4647's
121360     * lookup algorithm.
121361     *
121362     * @param array $langtag An array containing a list of language tags to
121363     *   compare to {@link locale}. Maximum 100 items allowed.
121364     * @param string $locale The locale to use as the language range when
121365     *   matching.
121366     * @param bool $canonicalize If true, the arguments will be converted
121367     *   to canonical form before matching.
121368     * @param string $default The locale to use if no match is found.
121369     * @return string The closest matching language tag or default value.
121370     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
121371     **/
121372    public static function lookup($langtag, $locale, $canonicalize, $default){}
121373
121374    /**
121375     * Returns a key-value array of locale ID subtag elements
121376     *
121377     * @param string $locale The locale to extract the subtag array from.
121378     *   Note: The 'variant' and 'private' subtags can take maximum 15 values
121379     *   whereas 'extlang' can take maximum 3 values.
121380     * @return array Returns an array containing a list of key-value pairs,
121381     *   where the keys identify the particular locale ID subtags, and the
121382     *   values are the associated subtag values. The array will be ordered
121383     *   as the locale id subtags e.g. in the locale id if variants are
121384     *   '-varX-varY-varZ' then the returned array will have variant0=>varX ,
121385     *   variant1=>varY , variant2=>varZ
121386     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
121387     **/
121388    public static function parseLocale($locale){}
121389
121390    /**
121391     * Sets the default runtime locale
121392     *
121393     * Sets the default runtime locale to $locale. This changes the value of
121394     * INTL global 'default_locale' locale identifier. UAX #35 extensions are
121395     * accepted.
121396     *
121397     * @param string $locale Is a BCP 47 compliant language tag.
121398     * @return bool
121399     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
121400     **/
121401    public static function setDefault($locale){}
121402
121403}
121404/**
121405 * Exception that represents error in the program logic. This kind of
121406 * exception should lead directly to a fix in your code.
121407 **/
121408class LogicException extends Exception {
121409}
121410class Lua {
121411    /**
121412     * @var string
121413     **/
121414    const LUA_VERSION = '';
121415
121416    /**
121417     * Assign a PHP variable to Lua
121418     *
121419     * @param string $name
121420     * @param string $value
121421     * @return mixed Returns $this or NULL on failure.
121422     * @since PECL lua >=0.9.0
121423     **/
121424    public function assign($name, $value){}
121425
121426    /**
121427     * Call Lua functions
121428     *
121429     * @param callable $lua_func Function name in lua
121430     * @param array $args Arguments passed to the Lua function
121431     * @param int $use_self Whether to use self
121432     * @return mixed Returns result of the called function, NULL for wrong
121433     *   arguments or FALSE on other failure.
121434     * @since PECL lua >=0.9.0
121435     **/
121436    public function call($lua_func, $args, $use_self){}
121437
121438    /**
121439     * Evaluate a string as Lua code
121440     *
121441     * @param string $statements
121442     * @return mixed Returns result of evaled code, NULL for wrong
121443     *   arguments or FALSE on other failure.
121444     * @since PECL lua >=0.9.0
121445     **/
121446    public function eval($statements){}
121447
121448    /**
121449     * The getversion purpose
121450     *
121451     * @return string Returns Lua::LUA_VERSION.
121452     * @since PECL lua >=0.9.0
121453     **/
121454    public function getVersion(){}
121455
121456    /**
121457     * Parse a Lua script file
121458     *
121459     * @param string $file
121460     * @return mixed Returns result of included code, NULL for wrong
121461     *   arguments or FALSE on other failure.
121462     * @since PECL lua >=0.9.0
121463     **/
121464    public function include($file){}
121465
121466    /**
121467     * Register a PHP function to Lua
121468     *
121469     * Register a PHP function to Lua as a function named "$name"
121470     *
121471     * @param string $name
121472     * @param callable $function A valid PHP function callback
121473     * @return mixed Returns $this, NULL for wrong arguments or FALSE on
121474     *   other failure.
121475     **/
121476    public function registerCallback($name, $function){}
121477
121478    /**
121479     * Call Lua functions
121480     *
121481     * @param callable $lua_func Function name in lua
121482     * @param array $args Arguments passed to the Lua function
121483     * @param int $use_self Whether to use self
121484     * @return mixed Returns result of the called function, NULL for wrong
121485     *   arguments or FALSE on other failure.
121486     * @since PECL lua >=0.9.0
121487     **/
121488    public function __call($lua_func, $args, $use_self){}
121489
121490    /**
121491     * Lua constructor
121492     *
121493     * @param string $lua_script_file
121494     * @since PECL lua >=0.9.0
121495     **/
121496    public function __construct($lua_script_file){}
121497
121498}
121499/**
121500 * LuaClosure is a wrapper class for LUA_TFUNCTION which could be return
121501 * from calling to Lua function.
121502 **/
121503class LuaClosure {
121504    /**
121505     * Invoke luaclosure
121506     *
121507     * @param mixed ...$vararg
121508     * @return void
121509     * @since PECL lua >=0.9.0
121510     **/
121511    public function __invoke(...$vararg){}
121512
121513}
121514class LuaException extends Exception {
121515}
121516/**
121517 * The LuaSandbox class creates a Lua environment and allows for
121518 * execution of Lua code.
121519 **/
121520class LuaSandbox {
121521    /**
121522     * Used with LuaSandbox::getProfilerFunctionReport to return timings in
121523     * percentages of the total.
121524     *
121525     * @var integer
121526     **/
121527    const PERCENT = 0;
121528
121529    /**
121530     * Used with LuaSandbox::getProfilerFunctionReport to return timings in
121531     * samples.
121532     *
121533     * @var integer
121534     **/
121535    const SAMPLES = 0;
121536
121537    /**
121538     * Used with LuaSandbox::getProfilerFunctionReport to return timings in
121539     * seconds.
121540     *
121541     * @var integer
121542     **/
121543    const SECONDS = 0;
121544
121545    /**
121546     * Call a function in a Lua global variable
121547     *
121548     * Calls a function in a Lua global variable.
121549     *
121550     * If the name contains "." characters, the function is located via
121551     * recursive table accesses, as if the name were a Lua expression.
121552     *
121553     * If the variable does not exist, or is not a function, false will be
121554     * returned and a warning issued.
121555     *
121556     * For more information about calling Lua functions and the return
121557     * values, see LuaSandboxFunction::call.
121558     *
121559     * @param string $name Lua variable name.
121560     * @param mixed ...$vararg Arguments to the function.
121561     * @return array|bool Returns an array of values returned by the Lua
121562     *   function, which may be empty, or false in case of failure.
121563     * @since PECL luasandbox >= 1.0.0
121564     **/
121565    public function callFunction($name, ...$vararg){}
121566
121567    /**
121568     * Disable the profiler
121569     *
121570     * Disables the profiler.
121571     *
121572     * @return void
121573     * @since PECL luasandbox >= 1.1.0
121574     **/
121575    public function disableProfiler(){}
121576
121577    /**
121578     * Enable the profiler.
121579     *
121580     * Enables the profiler. Profiling will begin when Lua code is entered.
121581     *
121582     * The profiler periodically samples the Lua environment to record the
121583     * running function. Testing indicates that at least on Linux, setting a
121584     * period less than 1ms will lead to a high overrun count but no
121585     * performance problems.
121586     *
121587     * @param float $period Sampling period in seconds.
121588     * @return bool Returns a boolean indicating whether the profiler is
121589     *   enabled.
121590     * @since PECL luasandbox >= 1.1.0
121591     **/
121592    public function enableProfiler($period){}
121593
121594    /**
121595     * Fetch the current CPU time usage of the Lua environment
121596     *
121597     * Fetches the current CPU time usage of the Lua environment.
121598     *
121599     * This includes time spent in PHP callbacks.
121600     *
121601     * @return float Returns the current CPU time usage in seconds.
121602     * @since PECL luasandbox >= 1.0.0
121603     **/
121604    public function getCPUUsage(){}
121605
121606    /**
121607     * Fetch the current memory usage of the Lua environment
121608     *
121609     * Fetches the current memory usage of the Lua environment.
121610     *
121611     * @return int Returns the current memory usage in bytes.
121612     * @since PECL luasandbox >= 1.0.0
121613     **/
121614    public function getMemoryUsage(){}
121615
121616    /**
121617     * Fetch the peak memory usage of the Lua environment
121618     *
121619     * Fetches the peak memory usage of the Lua environment.
121620     *
121621     * @return int Returns the peak memory usage in bytes.
121622     * @since PECL luasandbox >= 1.0.0
121623     **/
121624    public function getPeakMemoryUsage(){}
121625
121626    /**
121627     * Fetch profiler data
121628     *
121629     * For a profiling instance previously started by
121630     * LuaSandbox::enableProfiler, get a report of the cost of each function.
121631     *
121632     * The measurement unit used for the cost is determined by the $units
121633     * parameter:
121634     *
121635     * LuaSandbox::SAMPLES Measure in number of samples. LuaSandbox::SECONDS
121636     * Measure in seconds of CPU time. LuaSandbox::PERCENT Measure percentage
121637     * of CPU time.
121638     *
121639     * @param int $units Measurement unit constant.
121640     * @return array Returns profiler measurements, sorted in descending
121641     *   order, as an associative array. Keys are the Lua function names
121642     *   (with source file and line defined in angle brackets), values are
121643     *   the measurements as integer or float.
121644     * @since PECL luasandbox >= 1.1.0
121645     **/
121646    public function getProfilerFunctionReport($units){}
121647
121648    /**
121649     * Return the versions of LuaSandbox and Lua
121650     *
121651     * Returns the versions of LuaSandbox and Lua.
121652     *
121653     * @return array Returns an array with two keys:
121654     * @since PECL luasandbox >= 1.6.0
121655     **/
121656    public static function getVersionInfo(){}
121657
121658    /**
121659     * Load a precompiled binary chunk into the Lua environment
121660     *
121661     * Loads data generated by LuaSandboxFunction::dump.
121662     *
121663     * @param string $code Data from LuaSandboxFunction::dump.
121664     * @param string $chunkName Name for the loaded function.
121665     * @return LuaSandboxFunction Returns a LuaSandboxFunction.
121666     * @since PECL luasandbox >= 1.0.0
121667     **/
121668    public function loadBinary($code, $chunkName){}
121669
121670    /**
121671     * Load Lua code into the Lua environment
121672     *
121673     * Loads Lua code into the Lua environment.
121674     *
121675     * This is the equivalent of standard Lua's loadstring() function.
121676     *
121677     * @param string $code Lua code.
121678     * @param string $chunkName Name for the loaded chunk, for use in error
121679     *   traces.
121680     * @return LuaSandboxFunction Returns a LuaSandboxFunction which, when
121681     *   executed, will execute the passed $code.
121682     * @since PECL luasandbox >= 1.0.0
121683     **/
121684    public function loadString($code, $chunkName){}
121685
121686    /**
121687     * Pause the CPU usage timer
121688     *
121689     * Pauses the CPU usage timer.
121690     *
121691     * This only has effect when called from within a callback from Lua. When
121692     * execution returns to Lua, the timer will be automatically unpaused. If
121693     * a new call into Lua is made, the timer will be unpaused for the
121694     * duration of that call.
121695     *
121696     * If a PHP callback calls into Lua again with timer not paused, and then
121697     * that Lua function calls into PHP again, the second PHP call will not
121698     * be able to pause the timer. The logic is that even though the second
121699     * PHP call would avoid counting the CPU usage against the limit, the
121700     * first call still counts it.
121701     *
121702     * @return bool Returns a boolean indicating whether the timer is now
121703     *   paused.
121704     * @since PECL luasandbox >= 1.4.0
121705     **/
121706    public function pauseUsageTimer(){}
121707
121708    /**
121709     * Register a set of PHP functions as a Lua library
121710     *
121711     * Registers a set of PHP functions as a Lua library, so that Lua can
121712     * call the relevant PHP code.
121713     *
121714     * For more information about calling Lua functions and the return
121715     * values, see LuaSandboxFunction::call.
121716     *
121717     * @param string $libname The name of the library. In the Lua state,
121718     *   the global variable of this name will be set to the table of
121719     *   functions. If the table already exists, the new functions will be
121720     *   added to it.
121721     * @param array $functions An array, where each key is a function name,
121722     *   and each value is a corresponding PHP callable.
121723     * @return void
121724     * @since PECL luasandbox >= 1.0.0
121725     **/
121726    public function registerLibrary($libname, $functions){}
121727
121728    /**
121729     * Set the CPU time limit for the Lua environment
121730     *
121731     * Sets the CPU time limit for the Lua environment.
121732     *
121733     * If the total user and system time used by the environment after the
121734     * call to this method exceeds this limit, a LuaSandboxTimeoutError
121735     * exception is thrown.
121736     *
121737     * Time used in PHP callbacks is included in the limit.
121738     *
121739     * Setting the time limit from a callback while Lua is running causes the
121740     * timer to be reset, or started if it was not already running.
121741     *
121742     * @param float|bool $limit Limit as a float in seconds, or false for
121743     *   no limit.
121744     * @return void
121745     * @since PECL luasandbox >= 1.0.0
121746     **/
121747    public function setCPULimit($limit){}
121748
121749    /**
121750     * Set the memory limit for the Lua environment
121751     *
121752     * Sets the memory limit for the Lua environment.
121753     *
121754     * If this limit is exceeded, a LuaSandboxMemoryError exception is
121755     * thrown.
121756     *
121757     * @param int $limit Memory limit in bytes.
121758     * @return void
121759     * @since PECL luasandbox >= 1.0.0
121760     **/
121761    public function setMemoryLimit($limit){}
121762
121763    /**
121764     * Unpause the timer paused by
121765     *
121766     * Unpauses the timer paused by LuaSandbox::pauseUsageTimer.
121767     *
121768     * @return void
121769     * @since PECL luasandbox >= 1.4.0
121770     **/
121771    public function unpauseUsageTimer(){}
121772
121773    /**
121774     * Wrap a PHP callable in a
121775     *
121776     * Wraps a PHP callable in a LuaSandboxFunction, so it can be passed into
121777     * Lua as an anonymous function.
121778     *
121779     * The function must return either an array of values (which may be
121780     * empty), or NULL which is equivalent to returning the empty array.
121781     *
121782     * Exceptions will be raised as errors in Lua, however only
121783     * LuaSandboxRuntimeError exceptions may be caught inside Lua with
121784     * pcall() or xpcall().
121785     *
121786     * For more information about calling Lua functions and the return
121787     * values, see LuaSandboxFunction::call.
121788     *
121789     * @param callable $function Callable to wrap.
121790     * @return LuaSandboxFunction Returns a LuaSandboxFunction.
121791     * @since PECL luasandbox >= 1.2.0
121792     **/
121793    public function wrapPhpFunction($function){}
121794
121795}
121796/**
121797 * Base class for LuaSandbox exceptions
121798 **/
121799class LuaSandboxError extends Exception {
121800    /**
121801     * @var integer
121802     **/
121803    const ERR = 0;
121804
121805    /**
121806     * @var integer
121807     **/
121808    const MEM = 0;
121809
121810    /**
121811     * @var integer
121812     **/
121813    const RUN = 0;
121814
121815    /**
121816     * @var integer
121817     **/
121818    const SYNTAX = 0;
121819
121820}
121821/**
121822 * Exception thrown when Lua encounters an error inside an error handler.
121823 **/
121824class LuaSandboxErrorError extends LuaSandboxFatalError {
121825}
121826/**
121827 * Uncatchable LuaSandbox exceptions. These may not be caught inside Lua
121828 * using pcall() or xpcall().
121829 **/
121830class LuaSandboxFatalError extends LuaSandboxError {
121831}
121832/**
121833 * Represents a Lua function, allowing it to be called from PHP. A
121834 * LuaSandboxFunction may be obtained as a return value from Lua, as a
121835 * parameter passed to a callback from Lua, or by using
121836 * LuaSandbox::wrapPhpFunction, LuaSandbox::loadString, or
121837 * LuaSandbox::loadBinary.
121838 **/
121839class LuaSandboxFunction {
121840    /**
121841     * Call a Lua function
121842     *
121843     * Calls a Lua function.
121844     *
121845     * Errors considered to be the fault of the PHP code will result in the
121846     * function returning false and E_WARNING being raised, for example, a
121847     * resource type being used as an argument. Lua errors will result in a
121848     * LuaSandboxRuntimeError exception being thrown.
121849     *
121850     * PHP and Lua types are converted as follows:
121851     *
121852     * PHP NULL is Lua nil, and vice versa. PHP integers and floats are
121853     * converted to Lua numbers. Infinity and NAN are supported. Lua numbers
121854     * without a fractional part between approximately -2**53 and 2**53 are
121855     * converted to PHP integers, with others being converted to PHP floats.
121856     * PHP booleans are Lua booleans, and vice versa. PHP strings are Lua
121857     * strings, and vice versa. Lua functions are PHP LuaSandboxFunction
121858     * objects, and vice versa. General PHP callables are not supported. PHP
121859     * arrays are converted to Lua tables, and vice versa. Note that Lua
121860     * typically indexes arrays from 1, while PHP indexes arrays from 0. No
121861     * adjustment is made for these differing conventions. Self-referential
121862     * arrays are not supported in either direction. PHP references are
121863     * dereferenced. Lua __pairs and __ipairs are processed. __index is
121864     * ignored. When converting from PHP to Lua, integer keys between -2**53
121865     * and 2**53 are represented as Lua numbers. All other keys are
121866     * represented as Lua strings. When converting from Lua to PHP, keys
121867     * other than strings and numbers will result in an error, as will
121868     * collisions when converting numbers to strings or vice versa (since PHP
121869     * considers things like $a[0] and $a["0"] as being equivalent). All
121870     * other types are unsupported and will raise an error/exception,
121871     * including general PHP objects and Lua userdata and thread types.
121872     *
121873     * Lua functions inherently return a list of results. So on success, this
121874     * method returns an array containing all of the values returned by Lua,
121875     * with integer keys starting from zero. Lua may return no results, in
121876     * which case an empty array is returned.
121877     *
121878     * @param string ...$vararg Arguments passed to the function.
121879     * @return array|bool Returns an array of values returned by the
121880     *   function, which may be empty, or false on error.
121881     * @since PECL luasandbox >= 1.0.0
121882     **/
121883    public function call(...$vararg){}
121884
121885    /**
121886     * Dump the function as a binary blob
121887     *
121888     * Dumps the function as a binary blob.
121889     *
121890     * @return string Returns a string that may be passed to
121891     *   LuaSandbox::loadBinary.
121892     * @since PECL luasandbox >= 1.0.0
121893     **/
121894    public function dump(){}
121895
121896}
121897/**
121898 * Exception thrown when Lua cannot allocate memory.
121899 * LuaSandbox::setMemoryLimit
121900 **/
121901class LuaSandboxMemoryError extends LuaSandboxFatalError {
121902}
121903/**
121904 * Catchable LuaSandbox runtime exceptions. These may be caught inside
121905 * Lua using pcall() or xpcall().
121906 **/
121907class LuaSandboxRuntimeError extends LuaSandboxError {
121908}
121909/**
121910 * Exception thrown when Lua code cannot be parsed.
121911 **/
121912class LuaSandboxSyntaxError extends LuaSandboxFatalError {
121913}
121914/**
121915 * Exception thrown when the configured CPU time limit is exceeded.
121916 * LuaSandbox::setCPULimit
121917 **/
121918class LuaSandboxTimeoutError extends LuaSandboxFatalError {
121919}
121920class maxdb {
121921    /**
121922     * Gets the number of affected rows in a previous MaxDB operation
121923     *
121924     * {@link maxdb_affected_rows} returns the number of rows affected by the
121925     * last INSERT, UPDATE, or DELETE query associated with the provided
121926     * {@link link} parameter. If this number cannot be determined, this
121927     * function will return -1.
121928     *
121929     * The {@link maxdb_affected_rows} function only works with queries which
121930     * modify a table. In order to return the number of rows from a SELECT
121931     * query, use the {@link maxdb_num_rows} function instead.
121932     *
121933     * @var int
121934     **/
121935    public $affected_rows;
121936
121937    /**
121938     * Returns the error code for the most recent function call
121939     *
121940     * The {@link maxdb_errno} function will return the last error code for
121941     * the most recent MaxDB function call that can succeed or fail with
121942     * respect to the database link defined by the {@link link} parameter. If
121943     * no errors have occurred, this function will return zero.
121944     *
121945     * @var int
121946     **/
121947    public $errno;
121948
121949    /**
121950     * Returns a string description of the last error
121951     *
121952     * The {@link maxdb_error} function is identical to the corresponding
121953     * {@link maxdb_errno} function in every way, except instead of returning
121954     * an integer error code the {@link maxdb_error} function will return a
121955     * string representation of the last error to occur for the database
121956     * connection represented by the {@link link} parameter. If no error has
121957     * occurred, this function will return an empty string.
121958     *
121959     * @var string
121960     **/
121961    public $error;
121962
121963    /**
121964     * Returns a string representing the type of connection used
121965     *
121966     * The {@link maxdb_get_host_info} function returns a string describing
121967     * the connection represented by the {@link link} parameter is using.
121968     *
121969     * @var string
121970     **/
121971    public $host_info;
121972
121973    /**
121974     * Retrieves information about the most recently executed query
121975     *
121976     * The {@link maxdb_info} function returns a string providing information
121977     * about the last query executed. The nature of this string is provided
121978     * below:
121979     *
121980     * Possible maxdb_info return values Query type Example result string
121981     * INSERT INTO...SELECT... Records: 100 Duplicates: 0 Warnings: 0 INSERT
121982     * INTO...VALUES (...),(...),(...) Records: 3 Duplicates: 0 Warnings: 0
121983     * LOAD DATA INFILE ... Records: 1 Deleted: 0 Skipped: 0 Warnings: 0
121984     * ALTER TABLE ... Records: 3 Duplicates: 0 Warnings: 0 UPDATE ... Rows
121985     * matched: 40 Changed: 40 Warnings: 0
121986     *
121987     * @var string
121988     **/
121989    public $info;
121990
121991    /**
121992     * Returns the auto generated id used in the last query
121993     *
121994     * The {@link maxdb_insert_id} function returns the ID generated by a
121995     * query on a table with a column having the DEFAULT SERIAL attribute. If
121996     * the last query wasn't an INSERT or UPDATE statement or if the modified
121997     * table does not have a column with the DEFAULT SERIAL attribute, this
121998     * function will return zero.
121999     *
122000     * @var mixed
122001     **/
122002    public $insert_id;
122003
122004    /**
122005     * Gets the number of rows in a result
122006     *
122007     * Returns the number of rows in the result set.
122008     *
122009     * The use of {@link maxdb_num_rows} depends on whether you use buffered
122010     * or unbuffered result sets. In case you use unbuffered resultsets
122011     * {@link maxdb_num_rows} will not correct the correct number of rows
122012     * until all the rows in the result have been retrieved.
122013     *
122014     * @var int
122015     **/
122016    public $num_rows;
122017
122018    /**
122019     * Returns the version of the MaxDB protocol used
122020     *
122021     * Returns an integer representing the MaxDB protocol version used by the
122022     * connection represented by the {@link link} parameter.
122023     *
122024     * @var string
122025     **/
122026    public $protocol_version;
122027
122028    /**
122029     * Returns the version of the MaxDB server
122030     *
122031     * Returns a string representing the version of the MaxDB server that the
122032     * MaxDB extension is connected to (represented by the {@link link}
122033     * parameter).
122034     *
122035     * @var string
122036     **/
122037    public $server_info;
122038
122039    /**
122040     * Returns the version of the MaxDB server as an integer
122041     *
122042     * The {@link maxdb_get_server_version} function returns the version of
122043     * the server connected to (represented by the {@link link} parameter) as
122044     * an integer.
122045     *
122046     * The form of this version number is main_version * 10000 +
122047     * minor_version * 100 + sub_version (i.e. version 7.5.0 is 70500).
122048     *
122049     * @var int
122050     **/
122051    public $server_version;
122052
122053    /**
122054     * Returns the SQLSTATE error from previous MaxDB operation
122055     *
122056     * Returns a string containing the SQLSTATE error code for the last
122057     * error. The error code consists of five characters. '00000' means no
122058     * error. The values are specified by ANSI SQL and ODBC.
122059     *
122060     * @var string
122061     **/
122062    public $sqlstate;
122063
122064    /**
122065     * Returns the thread ID for the current connection
122066     *
122067     * The {@link maxdb_thread_id} function returns the thread ID for the
122068     * current connection which can then be killed using the {@link
122069     * maxdb_kill} function. If the connection is lost and you reconnect with
122070     * {@link maxdb_ping}, the thread ID will be other. Therefore you should
122071     * get the thread ID only when you need it.
122072     *
122073     * @var int
122074     **/
122075    public $thread_id;
122076
122077    /**
122078     * Returns the number of warnings from the last query for the given link
122079     *
122080     * {@link maxdb_warning_count} returns the number of warnings from the
122081     * last query in the connection represented by the {@link link}
122082     * parameter.
122083     *
122084     * @var int
122085     **/
122086    public $warning_count;
122087
122088    /**
122089     * Turns on or off auto-commiting database modifications
122090     *
122091     * {@link maxdb_autocommit} is used to turn on or off auto-commit mode on
122092     * queries for the database connection represented by the {@link link}
122093     * resource.
122094     *
122095     * @param bool $mode
122096     * @return bool
122097     **/
122098    function auto_commit($mode){}
122099
122100    /**
122101     * Changes the user of the specified database connection
122102     *
122103     * {@link maxdb_change_user} is used to change the user of the specified
122104     * database connection as given by the {@link link} parameter and to set
122105     * the current database to that specified by the {@link database}
122106     * parameter.
122107     *
122108     * In order to successfully change users a valid {@link username} and
122109     * {@link password} parameters must be provided and that user must have
122110     * sufficient permissions to access the desired database. If for any
122111     * reason authorization fails, the current user authentication will
122112     * remain.
122113     *
122114     * @param string $user
122115     * @param string $password
122116     * @param string $database
122117     * @return bool
122118     **/
122119    function change_user($user, $password, $database){}
122120
122121    /**
122122     * Returns the default character set for the database connection
122123     *
122124     * Returns the current character set for the database connection
122125     * specified by the {@link link} parameter.
122126     *
122127     * @return string The default character set for the current connection,
122128     *   either ascii or unicode.
122129     **/
122130    function character_set_name(){}
122131
122132    /**
122133     * Closes a previously opened database connection
122134     *
122135     * The {@link maxdb_close} function closes a previously opened database
122136     * connection specified by the {@link link} parameter.
122137     *
122138     * @return bool
122139     **/
122140    function close(){}
122141
122142    /**
122143     * Commits the current transaction
122144     *
122145     * Commits the current transaction for the database connection specified
122146     * by the {@link link} parameter.
122147     *
122148     * @return bool
122149     **/
122150    function commit(){}
122151
122152    /**
122153     * Disable reads from master
122154     *
122155     * @return void
122156     **/
122157    function disable_reads_from_master(){}
122158
122159    /**
122160     * Returns the number of columns for the most recent query
122161     *
122162     * Returns the number of columns for the most recent query on the
122163     * connection represented by the {@link link} parameter. This function
122164     * can be useful when using the {@link maxdb_store_result} function to
122165     * determine if the query should have produced a non-empty result set or
122166     * not without knowing the nature of the query.
122167     *
122168     * @return int An integer representing the number of fields in a result
122169     *   set.
122170     **/
122171    function field_count(){}
122172
122173    /**
122174     * Disconnects from a MaxDB server
122175     *
122176     * This function is used to disconnect from a MaxDB server specified by
122177     * the {@link processid} parameter.
122178     *
122179     * @param int $processid
122180     * @return bool
122181     **/
122182    function kill($processid){}
122183
122184    /**
122185     * Returns the default character set for the database connection
122186     *
122187     * Returns the current character set for the database connection
122188     * specified by the {@link link} parameter.
122189     *
122190     * @return string The default character set for the current connection,
122191     *   either ascii or unicode.
122192     **/
122193    function maxdb_client_encoding(){}
122194
122195    /**
122196     * Escapes special characters in a string for use in an SQL statement,
122197     * taking into account the current charset of the connection
122198     *
122199     * This function is used to create a legal SQL string that you can use in
122200     * an SQL statement. The string escapestr is encoded to an escaped SQL
122201     * string, taking into account the current character set of the
122202     * connection.
122203     *
122204     * Characters encoded are ', ".
122205     *
122206     * @param string $escapestr
122207     * @return string Returns an escaped string.
122208     **/
122209    function maxdb_escape_string($escapestr){}
122210
122211    /**
122212     * Set maxdb_set_opt
122213     *
122214     * {@link maxdb_maxdb_set_opt} can be used to set extra connect
122215     * maxdb_set_opt and affect behavior for a connection.
122216     *
122217     * This function may be called multiple times to set several
122218     * maxdb_set_opt.
122219     *
122220     * {@link maxdb_maxdb_set_opt} should be called after {@link maxdb_init}
122221     * and before {@link maxdb_real_connect}.
122222     *
122223     * The parameter {@link option} is the option that you want to set, the
122224     * {@link value} is the value for the option. For detailed description of
122225     * the maxdb_set_opt see The parameter {@link option} can be one of the
122226     * following values: Valid maxdb_set_opt Name Description MAXDB_COMPNAME
122227     * The component name used to initialise the SQLDBC runtime environment.
122228     * MAXDB_APPLICATION The application to be connected to the database.
122229     * MAXDB_APPVERSION The version of the application. MAXDB_SQLMODE The SQL
122230     * mode. MAXDB_UNICODE TRUE, if the connection is an unicode (UCS2)
122231     * client or FALSE, if not. MAXDB_TIMEOUT The maximum allowed time of
122232     * inactivity after which the connection to the database is closed by the
122233     * system. MAXDB_ISOLATIONLEVEL Specifies whether and how shared locks
122234     * and exclusive locks are implicitly requested or released.
122235     * MAXDB_PACKETCOUNT The number of different request packets used for the
122236     * connection. MAXDB_STATEMENTCACHESIZE The number of prepared statements
122237     * to be cached for the connection for re-use. MAXDB_CURSORPREFIX The
122238     * prefix to use for result tables that are automatically named.
122239     *
122240     * @param int $option
122241     * @param mixed $value
122242     * @return bool
122243     **/
122244    function maxdb_set_opt($option, $value){}
122245
122246    /**
122247     * Performs a query on the database
122248     *
122249     * The {@link maxdb_multi_query} works like the function {@link
122250     * maxdb_query}. Multiple queries are not yet supported.
122251     *
122252     * @param string $query
122253     * @return bool
122254     **/
122255    function multi_query($query){}
122256
122257    /**
122258     * Set options
122259     *
122260     * {@link maxdb_options} can be used to set extra connect options and
122261     * affect behavior for a connection.
122262     *
122263     * This function may be called multiple times to set several options.
122264     *
122265     * {@link maxdb_options} should be called after {@link maxdb_init} and
122266     * before {@link maxdb_real_connect}.
122267     *
122268     * The parameter {@link option} is the option that you want to set, the
122269     * {@link value} is the value for the option. For detailed description of
122270     * the options see The parameter {@link option} can be one of the
122271     * following values: Valid options Name Description MAXDB_COMPNAME The
122272     * component name used to initialise the SQLDBC runtime environment.
122273     * MAXDB_APPLICATION The application to be connected to the database.
122274     * MAXDB_APPVERSION The version of the application. MAXDB_SQLMODE The SQL
122275     * mode. MAXDB_UNICODE TRUE, if the connection is an unicode (UCS2)
122276     * client or FALSE, if not. MAXDB_TIMEOUT The maximum allowed time of
122277     * inactivity after which the connection to the database is closed by the
122278     * system. MAXDB_ISOLATIONLEVEL Specifies whether and how shared locks
122279     * and exclusive locks are implicitly requested or released.
122280     * MAXDB_PACKETCOUNT The number of different request packets used for the
122281     * connection. MAXDB_STATEMENTCACHESIZE The number of prepared statements
122282     * to be cached for the connection for re-use. MAXDB_CURSORPREFIX The
122283     * prefix to use for result tables that are automatically named.
122284     *
122285     * @param int $option
122286     * @param mixed $value
122287     * @return bool
122288     **/
122289    function options($option, $value){}
122290
122291    /**
122292     * Pings a server connection, or tries to reconnect if the connection has
122293     * gone down
122294     *
122295     * Checks whether the connection to the server is working. If it has gone
122296     * down, and global option maxdb.reconnect is enabled an automatic
122297     * reconnection is attempted.
122298     *
122299     * This function can be used by clients that remain idle for a long
122300     * while, to check whether the server has closed the connection and
122301     * reconnect if necessary.
122302     *
122303     * @return bool
122304     **/
122305    function ping(){}
122306
122307    /**
122308     * Prepare an SQL statement for execution
122309     *
122310     * {@link maxdb_prepare} prepares the SQL query pointed to by the
122311     * null-terminated string query, and returns a statement handle to be
122312     * used for further operations on the statement. The query must consist
122313     * of a single SQL statement.
122314     *
122315     * The parameter {@link query} can include one or more parameter markers
122316     * in the SQL statement by embedding question mark (?) characters at the
122317     * appropriate positions.
122318     *
122319     * The parameter markers must be bound to application variables using
122320     * {@link maxdb_stmt_bind_param} and/or {@link maxdb_stmt_bind_result}
122321     * before executing the statement or fetching rows.
122322     *
122323     * @param string $query
122324     * @return maxdb_stmt {@link maxdb_prepare} returns a statement
122325     *   resource or FALSE if an error occurred.
122326     **/
122327    function prepare($query){}
122328
122329    /**
122330     * Performs a query on the database
122331     *
122332     * The {@link maxdb_query} function is used to simplify the act of
122333     * performing a query against the database represented by the {@link
122334     * link} parameter.
122335     *
122336     * @param string $query
122337     * @return mixed For SELECT, SHOW, DESCRIBE or EXPLAIN {@link
122338     *   maxdb_query} will return a result resource.
122339     **/
122340    function query($query){}
122341
122342    /**
122343     * Opens a connection to a MaxDB server
122344     *
122345     * {@link maxdb_real_connect} attempts to establish a connection to a
122346     * MaxDB database engine running on {@link hostname}.
122347     *
122348     * This function differs from {@link maxdb_connect}:
122349     *
122350     * @param string $hostname
122351     * @param string $username
122352     * @param string $passwd
122353     * @param string $dbname
122354     * @param int $port
122355     * @param string $socket
122356     * @return bool
122357     **/
122358    function real_connect($hostname, $username, $passwd, $dbname, $port, $socket){}
122359
122360    /**
122361     * Escapes special characters in a string for use in an SQL statement,
122362     * taking into account the current charset of the connection
122363     *
122364     * This function is used to create a legal SQL string that you can use in
122365     * an SQL statement. The string escapestr is encoded to an escaped SQL
122366     * string, taking into account the current character set of the
122367     * connection.
122368     *
122369     * Characters encoded are ', ".
122370     *
122371     * @param string $escapestr
122372     * @return string Returns an escaped string.
122373     **/
122374    function real_escape_string($escapestr){}
122375
122376    /**
122377     * Execute an SQL query
122378     *
122379     * The {@link maxdb_real_query} is functionally identical with the {@link
122380     * maxdb_query}.
122381     *
122382     * @param string $query
122383     * @return bool
122384     **/
122385    function real_query($query){}
122386
122387    /**
122388     * Rolls back current transaction
122389     *
122390     * Rollbacks the current transaction for the database specified by the
122391     * {@link link} parameter.
122392     *
122393     * @return bool
122394     **/
122395    function rollback(){}
122396
122397    /**
122398     * Returns RPL query type
122399     *
122400     * @return int
122401     **/
122402    function rpl_query_type(){}
122403
122404    /**
122405     * Send the query and return
122406     *
122407     * @param string $query
122408     * @return bool
122409     **/
122410    function send_query($query){}
122411
122412    /**
122413     * Used for establishing secure connections using SSL
122414     *
122415     * @param string $key
122416     * @param string $cert
122417     * @param string $ca
122418     * @param string $capath
122419     * @param string $cipher
122420     * @return bool
122421     **/
122422    function ssl_set($key, $cert, $ca, $capath, $cipher){}
122423
122424    /**
122425     * Gets the current system status
122426     *
122427     * {@link maxdb_stat} returns a string containing several information
122428     * about the MaxDB server running.
122429     *
122430     * @return string A string describing the server status. FALSE if an
122431     *   error occurred.
122432     **/
122433    function stat(){}
122434
122435    /**
122436     * Initializes a statement and returns an resource for use with
122437     * maxdb_stmt_prepare
122438     *
122439     * Allocates and initializes a statement resource suitable for {@link
122440     * maxdb_stmt_prepare}.
122441     *
122442     * @return object Returns an resource.
122443     **/
122444    function stmt_init(){}
122445
122446    /**
122447     * Transfers a result set from the last query
122448     *
122449     * This function has no functionally effect.
122450     *
122451     * @return object Returns a result resource or FALSE if an error
122452     *   occurred.
122453     **/
122454    function store_result(){}
122455
122456    /**
122457     * Initiate a result set retrieval
122458     *
122459     * {@link maxdb_use_result} has no effect.
122460     *
122461     * @return resource Returns result .
122462     **/
122463    function use_result(){}
122464
122465}
122466class maxdb_result {
122467    /**
122468     * Get current field offset of a result pointer
122469     *
122470     * Returns the position of the field cursor used for the last {@link
122471     * maxdb_fetch_field} call. This value can be used as an argument to
122472     * {@link maxdb_field_seek}.
122473     *
122474     * @var int
122475     **/
122476    public $current_field;
122477
122478    /**
122479     * Get the number of fields in a result
122480     *
122481     * {@link maxdb_num_fields} returns the number of fields from specified
122482     * result set.
122483     *
122484     * @var int
122485     **/
122486    public $field_count;
122487
122488    /**
122489     * Returns the lengths of the columns of the current row in the result
122490     * set
122491     *
122492     * The {@link maxdb_fetch_lengths} function returns an array containing
122493     * the lengths of every column of the current row within the result set
122494     * represented by the {@link result} parameter. If successful, a
122495     * numerically indexed array representing the lengths of each column is
122496     * returned.
122497     *
122498     * @var array
122499     **/
122500    public $lengths;
122501
122502    /**
122503     * Adjusts the result pointer to an arbitary row in the result
122504     *
122505     * The {@link maxdb_data_seek} function seeks to an arbitrary result
122506     * pointer specified by the {@link offset} in the result set represented
122507     * by {@link result}. The {@link offset} parameter must be between zero
122508     * and the total number of rows minus one (0..{@link maxdb_num_rows} -
122509     * 1).
122510     *
122511     * @param int $offset
122512     * @return bool
122513     **/
122514    function data_seek($offset){}
122515
122516    /**
122517     * Fetch a result row as an associative, a numeric array, or both
122518     *
122519     * Returns an array that corresponds to the fetched row or NULL if there
122520     * are no more rows for the resultset represented by the {@link result}
122521     * parameter.
122522     *
122523     * {@link maxdb_fetch_array} is an extended version of the {@link
122524     * maxdb_fetch_row} function. In addition to storing the data in the
122525     * numeric indices of the result array, the {@link maxdb_fetch_array}
122526     * function can also store the data in associative indices, using the
122527     * field names of the result set as keys.
122528     *
122529     * If two or more columns of the result have the same field names, the
122530     * last column will take precedence and overwrite the earlier data. In
122531     * order to access multiple columns with the same name, the numerically
122532     * indexed version of the row must be used.
122533     *
122534     * The optional second argument {@link resulttype} is a constant
122535     * indicating what type of array should be produced from the current row
122536     * data. The possible values for this parameter are the constants
122537     * MAXDB_ASSOC, MAXDB_ASSOC_UPPER, MAXDB_ASSOC_LOWER, MAXDB_NUM, or
122538     * MAXDB_BOTH. By default the {@link maxdb_fetch_array} function will
122539     * assume MAXDB_BOTH, which is a combination of MAXDB_NUM and MAXDB_ASSOC
122540     * for this parameter.
122541     *
122542     * By using the MAXDB_ASSOC constant this function will behave
122543     * identically to the {@link maxdb_fetch_assoc}, while MAXDB_NUM will
122544     * behave identically to the {@link maxdb_fetch_row} function. The final
122545     * option MAXDB_BOTH will create a single array with the attributes of
122546     * both.
122547     *
122548     * By using the MAXDB_ASSOC_UPPER constant, the behaviour of this
122549     * function is identical to the use of MAXDB_ASSOC except the array index
122550     * of a column is the fieldname in upper case.
122551     *
122552     * By using the MAXDB_ASSOC_LOWER constant, the behaviour of this
122553     * function is identical to the use of MAXDB_ASSOC except the array index
122554     * of a column is the fieldname in lower case.
122555     *
122556     * @param int $resulttype
122557     * @return mixed Returns an array that corresponds to the fetched row
122558     *   or NULL if there are no more rows in resultset.
122559     **/
122560    function fetch_array($resulttype){}
122561
122562    /**
122563     * Fetch a result row as an associative array
122564     *
122565     * Returns an associative array that corresponds to the fetched row or
122566     * NULL if there are no more rows.
122567     *
122568     * The {@link maxdb_fetch_assoc} function is used to return an
122569     * associative array representing the next row in the result set for the
122570     * result represented by the {@link result} parameter, where each key in
122571     * the array represents the name of one of the result set's columns.
122572     *
122573     * If two or more columns of the result have the same field names, the
122574     * last column will take precedence. To access the other column(s) of the
122575     * same name, you either need to access the result with numeric indices
122576     * by using {@link maxdb_fetch_row} or add alias names.
122577     *
122578     * @return array Returns an array that corresponds to the fetched row
122579     *   or NULL if there are no more rows in resultset.
122580     **/
122581    function fetch_assoc(){}
122582
122583    /**
122584     * Returns the next field in the result set
122585     *
122586     * The {@link maxdb_fetch_field} returns the definition of one column of
122587     * a result set as an resource. Call this function repeatedly to retrieve
122588     * information about all columns in the result set. {@link
122589     * maxdb_fetch_field} returns FALSE when no more fields are left.
122590     *
122591     * @return mixed Returns an resource which contains field definition
122592     *   information or FALSE if no field information is available.
122593     **/
122594    function fetch_field(){}
122595
122596    /**
122597     * Returns an array of resources representing the fields in a result set
122598     *
122599     * This function serves an identical purpose to the {@link
122600     * maxdb_fetch_field} function with the single difference that, instead
122601     * of returning one resource at a time for each field, the columns are
122602     * returned as an array of resources.
122603     *
122604     * @return mixed Returns an array of resources which contains field
122605     *   definition information or FALSE if no field information is
122606     *   available.
122607     **/
122608    function fetch_fields(){}
122609
122610    /**
122611     * Fetch meta-data for a single field
122612     *
122613     * {@link maxdb_fetch_field_direct} returns an resource which contains
122614     * field definition information from specified resultset. The value of
122615     * fieldnr must be in the range from 0 to number of fields - 1.
122616     *
122617     * @param int $fieldnr
122618     * @return mixed Returns an resource which contains field definition
122619     *   information or FALSE if no field information for specified fieldnr
122620     *   is available.
122621     **/
122622    function fetch_field_direct($fieldnr){}
122623
122624    /**
122625     * Returns the current row of a result set as an object
122626     *
122627     * The {@link maxdb_fetch_object} will return the current row result set
122628     * as an object where the attributes of the object represent the names of
122629     * the fields found within the result set. If no more rows exist in the
122630     * current result set, NULL is returned.
122631     *
122632     * @return object Returns an object that corresponds to the fetched row
122633     *   or NULL if there are no more rows in resultset.
122634     **/
122635    function fetch_object(){}
122636
122637    /**
122638     * Get a result row as an enumerated array
122639     *
122640     * Returns an array that corresponds to the fetched row, or NULL if there
122641     * are no more rows.
122642     *
122643     * {@link maxdb_fetch_row} fetches one row of data from the result set
122644     * represented by {@link result} and returns it as an enumerated array,
122645     * where each column is stored in an array offset starting from 0 (zero).
122646     * Each subsequent call to the {@link maxdb_fetch_row} function will
122647     * return the next row within the result set, or FALSE if there are no
122648     * more rows.
122649     *
122650     * @return mixed {@link maxdb_fetch_row} returns an array that
122651     *   corresponds to the fetched row or NULL if there are no more rows in
122652     *   result set.
122653     **/
122654    function fetch_row(){}
122655
122656    /**
122657     * Set result pointer to a specified field offset
122658     *
122659     * Sets the field cursor to the given offset. The next call to {@link
122660     * maxdb_fetch_field} will retrieve the field definition of the column
122661     * associated with that offset.
122662     *
122663     * @param int $fieldnr
122664     * @return bool {@link maxdb_field_seek} returns previuos value of
122665     *   field cursor.
122666     **/
122667    function field_seek($fieldnr){}
122668
122669    /**
122670     * Frees the memory associated with a result
122671     *
122672     * The {@link maxdb_free_result} function frees the memory associated
122673     * with the result represented by the {@link result} parameter, which was
122674     * allocated by {@link maxdb_query}, {@link maxdb_store_result} or {@link
122675     * maxdb_use_result}.
122676     *
122677     * @return void This function doesn't return any value.
122678     **/
122679    function free(){}
122680
122681}
122682class maxdb_stmt {
122683    /**
122684     * Returns the total number of rows changed, deleted, or inserted by the
122685     * last executed statement
122686     *
122687     * {@link maxdb_stmt_affected_rows} returns the number of rows affected
122688     * by INSERT, UPDATE, or DELETE query. If the last query was invalid or
122689     * the number of rows can not determined, this function will return -1.
122690     *
122691     * @var int
122692     **/
122693    public $affected_rows;
122694
122695    /**
122696     * Returns the error code for the most recent statement call
122697     *
122698     * For the statement specified by stmt, {@link maxdb_stmt_errno} returns
122699     * the error code for the most recently invoked statement function that
122700     * can succeed or fail.
122701     *
122702     * @var int
122703     **/
122704    public $errno;
122705
122706    /**
122707     * Returns a string description for last statement error
122708     *
122709     * For the statement specified by stmt, {@link maxdb_stmt_error} returns
122710     * a containing the error message for the most recently invoked statement
122711     * function that can succeed or fail.
122712     *
122713     * @var string
122714     **/
122715    public $error;
122716
122717    /**
122718     * Return the number of rows in statements result set
122719     *
122720     * Returns the number of rows in the result set.
122721     *
122722     * @var int
122723     **/
122724    public $num_rows;
122725
122726    /**
122727     * Returns the number of parameter for the given statement
122728     *
122729     * {@link maxdb_stmt_param_count} returns the number of parameter markers
122730     * present in the prepared statement.
122731     *
122732     * @var int
122733     **/
122734    public $param_count;
122735
122736    /**
122737     * Binds variables to a prepared statement as parameters
122738     *
122739     * (extended syntax):
122740     *
122741     * (extended syntax):
122742     *
122743     * {@link maxdb_stmt_bind_param} is used to bind variables for the
122744     * parameter markers in the SQL statement that was passed to {@link
122745     * maxdb_prepare}. The string {@link types} contains one or more
122746     * characters which specify the types for the corresponding bind
122747     * variables.
122748     *
122749     * The extended syntax of {@link maxdb_stmt_bind_param} allows to give
122750     * the parameters as an array instead of a variable list of PHP variables
122751     * to the function. If the array variable has not been used before
122752     * calling {@link maxdb_stmt_bind_param}, it has to be initialized as an
122753     * emtpy array. See the examples how to use {@link maxdb_stmt_bind_param}
122754     * with extended syntax.
122755     *
122756     * Variables for SELECT INTO SQL statements can also be bound using
122757     * {@link maxdb_stmt_bind_param}. Parameters for database procedures can
122758     * be bound using {@link maxdb_stmt_bind_param}. See the examples how to
122759     * use {@link maxdb_stmt_bind_param} in this cases.
122760     *
122761     * If a variable bound as INTO variable to an SQL statement was used
122762     * before, the content of this variable is overwritten by the data of the
122763     * SELECT INTO statement. A reference to this variable will be invalid
122764     * after a call to {@link maxdb_stmt_bind_param}.
122765     *
122766     * For INOUT parameters of database procedures the content of the bound
122767     * INOUT variable is overwritten by the output value of the database
122768     * procedure. A reference to this variable will be invalid after a call
122769     * to {@link maxdb_stmt_bind_param}.
122770     *
122771     * Type specification chars Character Description i corresponding
122772     * variable has type integer d corresponding variable has type double s
122773     * corresponding variable has type string b corresponding variable is a
122774     * blob and will be sent in packages
122775     *
122776     * @param string $types
122777     * @param mixed $var1
122778     * @param mixed ...$vararg
122779     * @return bool
122780     **/
122781    function bind_param($types, &$var1, &...$vararg){}
122782
122783    /**
122784     * Binds variables to a prepared statement for result storage
122785     *
122786     * {@link maxdb_stmt_bind_result} is used to associate (bind) columns in
122787     * the result set to variables. When {@link maxdb_stmt_fetch} is called
122788     * to fetch data, the MaxDB client/server protocol places the data for
122789     * the bound columns into the specified variables {@link var1, ...}.
122790     *
122791     * @param mixed $var1
122792     * @param mixed ...$vararg
122793     * @return bool
122794     **/
122795    function bind_result(&$var1, &...$vararg){}
122796
122797    /**
122798     * Closes a prepared statement
122799     *
122800     * Closes a prepared statement. {@link maxdb_stmt_close} also deallocates
122801     * the statement handle pointed to by {@link stmt}. If the current
122802     * statement has pending or unread results, this function cancels them so
122803     * that the next query can be executed.
122804     *
122805     * @return bool
122806     **/
122807    function close(){}
122808
122809    /**
122810     * Ends a sequence of
122811     *
122812     * This function has to be called after a sequence of {@link
122813     * maxdb_stmt_send_long_data}, that was started after {@link
122814     * maxdb_execute}.
122815     *
122816     * {@link param_nr} indicates which parameter to associate the end of
122817     * data with. Parameters are numbered beginning with 0.
122818     *
122819     * @return bool
122820     **/
122821    function close_long_data(){}
122822
122823    /**
122824     * Seeks to an arbitray row in statement result set
122825     *
122826     * The {@link maxdb_stmt_data_seek} function seeks to an arbitrary result
122827     * pointer specified by the {@link offset} in the statement result set
122828     * represented by {@link statement}. The {@link offset} parameter must be
122829     * between zero and the total number of rows minus one (0..{@link
122830     * maxdb_stmt_num_rows} - 1).
122831     *
122832     * @param int $offset
122833     * @return bool
122834     **/
122835    function data_seek($offset){}
122836
122837    /**
122838     * Executes a prepared Query
122839     *
122840     * The {@link maxdb_stmt_execute} function executes a query that has been
122841     * previously prepared using the {@link maxdb_prepare} function
122842     * represented by the {@link stmt} resource. When executed any parameter
122843     * markers which exist will automatically be replaced with the
122844     * appropriate data.
122845     *
122846     * If the statement is UPDATE, DELETE, or INSERT, the total number of
122847     * affected rows can be determined by using the {@link
122848     * maxdb_stmt_affected_rows} function. Likewise, if the query yields a
122849     * result set the {@link maxdb_fetch} function is used.
122850     *
122851     * @return bool
122852     **/
122853    function execute(){}
122854
122855    /**
122856     * Fetch results from a prepared statement into the bound variables
122857     *
122858     * {@link maxdb_stmt_fetch} returns row data using the variables bound by
122859     * {@link maxdb_stmt_bind_result}.
122860     *
122861     * @return bool
122862     **/
122863    function fetch(){}
122864
122865    /**
122866     * Frees stored result memory for the given statement handle
122867     *
122868     * The {@link maxdb_stmt_free_result} function frees the result memory
122869     * associated with the statement represented by the {@link stmt}
122870     * parameter, which was allocated by {@link maxdb_stmt_store_result}.
122871     *
122872     * @return void This function doesn't return any value.
122873     **/
122874    function free_result(){}
122875
122876    /**
122877     * Binds variables to a prepared statement as parameters
122878     *
122879     * (extended syntax):
122880     *
122881     * (extended syntax):
122882     *
122883     * {@link maxdb_stmt_maxdb_bind_param} is used to bind variables for the
122884     * parameter markers in the SQL statement that was passed to {@link
122885     * maxdb_prepare}. The string {@link types} contains one or more
122886     * characters which specify the types for the corresponding bind
122887     * variables.
122888     *
122889     * The extended syntax of {@link maxdb_stmt_maxdb_bind_param} allows to
122890     * give the parameters as an array instead of a variable list of PHP
122891     * variables to the function. If the array variable has not been used
122892     * before calling {@link maxdb_stmt_maxdb_bind_param}, it has to be
122893     * initialized as an emtpy array. See the examples how to use {@link
122894     * maxdb_stmt_maxdb_bind_param} with extended syntax.
122895     *
122896     * Variables for SELECT INTO SQL statements can also be bound using
122897     * {@link maxdb_stmt_maxdb_bind_param}. Parameters for database
122898     * procedures can be bound using {@link maxdb_stmt_maxdb_bind_param}. See
122899     * the examples how to use {@link maxdb_stmt_maxdb_bind_param} in this
122900     * cases.
122901     *
122902     * If a variable bound as INTO variable to an SQL statement was used
122903     * before, the content of this variable is overwritten by the data of the
122904     * SELECT INTO statement. A reference to this variable will be invalid
122905     * after a call to {@link maxdb_stmt_maxdb_bind_param}.
122906     *
122907     * For INOUT parameters of database procedures the content of the bound
122908     * INOUT variable is overwritten by the output value of the database
122909     * procedure. A reference to this variable will be invalid after a call
122910     * to {@link maxdb_stmt_maxdb_bind_param}.
122911     *
122912     * Type specification chars Character Description i corresponding
122913     * variable has type integer d corresponding variable has type double s
122914     * corresponding variable has type string b corresponding variable is a
122915     * blob and will be sent in packages
122916     *
122917     * @param string $types
122918     * @param mixed $var1
122919     * @param mixed ...$vararg
122920     * @return bool
122921     **/
122922    function maxdb_bind_param($types, &$var1, &...$vararg){}
122923
122924    /**
122925     * Binds variables to a prepared statement for result storage
122926     *
122927     * {@link maxdb_stmt_maxdb_bind_result} is used to associate (bind)
122928     * columns in the result set to variables. When {@link maxdb_stmt_fetch}
122929     * is called to fetch data, the MaxDB client/server protocol places the
122930     * data for the bound columns into the specified variables {@link var1,
122931     * ...}.
122932     *
122933     * @param mixed $var1
122934     * @param mixed ...$vararg
122935     * @return bool
122936     **/
122937    function maxdb_bind_result(&$var1, &...$vararg){}
122938
122939    /**
122940     * Ends a sequence of
122941     *
122942     * This function has to be called after a sequence of {@link
122943     * maxdb_stmt_send_long_data}, that was started after {@link
122944     * maxdb_execute}.
122945     *
122946     * {@link param_nr} indicates which parameter to associate the end of
122947     * data with. Parameters are numbered beginning with 0.
122948     *
122949     * @return bool
122950     **/
122951    function maxdb_close_long_data(){}
122952
122953    /**
122954     * Executes a prepared Query
122955     *
122956     * The {@link maxdb_stmt_maxdb_execute} function maxdb_executes a query
122957     * that has been previously prepared using the {@link maxdb_prepare}
122958     * function represented by the {@link stmt} resource. When maxdb_executed
122959     * any parameter markers which exist will automatically be replaced with
122960     * the appropriate data.
122961     *
122962     * If the statement is UPDATE, DELETE, or INSERT, the total number of
122963     * affected rows can be determined by using the {@link
122964     * maxdb_stmt_affected_rows} function. Likewise, if the query yields a
122965     * result set the {@link maxdb_fetch} function is used.
122966     *
122967     * @return bool
122968     **/
122969    function maxdb_execute(){}
122970
122971    /**
122972     * Fetch results from a prepared statement into the bound variables
122973     *
122974     * {@link maxdb_stmt_maxdb_fetch} returns row data using the variables
122975     * bound by {@link maxdb_stmt_bind_result}.
122976     *
122977     * @return bool
122978     **/
122979    function maxdb_fetch(){}
122980
122981    /**
122982     * Returns result set metadata from a prepared statement
122983     *
122984     * If a statement passed to {@link maxdb_prepare} is one that produces a
122985     * result set, {@link maxdb_stmt_maxdb_get_metadata} returns the result
122986     * resource that can be used to process the meta information such as
122987     * total number of fields and individual field information.
122988     *
122989     * The result set structure should be freed when you are done with it,
122990     * which you can do by passing it to {@link maxdb_free_result}
122991     *
122992     * @return resource {@link maxdb_stmt_result_metadata} returns a result
122993     *   resource or FALSE if an error occurred.
122994     **/
122995    function maxdb_get_metadata(){}
122996
122997    /**
122998     * Send data in blocks
122999     *
123000     * Allows to send parameter data to the server in pieces (or chunks).
123001     * This function can be called multiple times to send the parts of a
123002     * character or binary data value for a column, which must be one of the
123003     * TEXT or BLOB datatypes.
123004     *
123005     * {@link param_nr} indicates which parameter to associate the data with.
123006     * Parameters are numbered beginning with 0. {@link data} is a string
123007     * containing data to be sent.
123008     *
123009     * @param int $param_nr
123010     * @param string $data
123011     * @return bool
123012     **/
123013    function maxdb_send_long_data($param_nr, $data){}
123014
123015    /**
123016     * Prepare an SQL statement for execution
123017     *
123018     * {@link maxdb_stmt_prepare} prepares the SQL query pointed to by the
123019     * null-terminated string query. The statement resource has to be
123020     * allocated by {@link maxdb_stmt_init}. The query must consist of a
123021     * single SQL statement.
123022     *
123023     * The parameter {@link query} can include one or more parameter markers
123024     * in the SQL statement by embedding question mark (?) characters at the
123025     * appropriate positions.
123026     *
123027     * The parameter markers must be bound to application variables using
123028     * {@link maxdb_stmt_bind_param} and/or {@link maxdb_stmt_bind_result}
123029     * before executing the statement or fetching rows.
123030     *
123031     * @param string $query
123032     * @return mixed
123033     **/
123034    function prepare($query){}
123035
123036    /**
123037     * Resets a prepared statement
123038     *
123039     * @return bool
123040     **/
123041    function reset(){}
123042
123043    /**
123044     * Returns result set metadata from a prepared statement
123045     *
123046     * If a statement passed to {@link maxdb_prepare} is one that produces a
123047     * result set, {@link maxdb_stmt_result_metadata} returns the result
123048     * resource that can be used to process the meta information such as
123049     * total number of fields and individual field information.
123050     *
123051     * The result set structure should be freed when you are done with it,
123052     * which you can do by passing it to {@link maxdb_free_result}
123053     *
123054     * @return resource {@link maxdb_stmt_result_metadata} returns a result
123055     *   resource or FALSE if an error occurred.
123056     **/
123057    function result_metadata(){}
123058
123059    /**
123060     * Send data in blocks
123061     *
123062     * Allows to send parameter data to the server in pieces (or chunks).
123063     * This function can be called multiple times to send the parts of a
123064     * character or binary data value for a column, which must be one of the
123065     * TEXT or BLOB datatypes.
123066     *
123067     * {@link param_nr} indicates which parameter to associate the data with.
123068     * Parameters are numbered beginning with 0. {@link data} is a string
123069     * containing data to be sent.
123070     *
123071     * @param int $param_nr
123072     * @param string $data
123073     * @return bool
123074     **/
123075    function stmt_send_long_data($param_nr, $data){}
123076
123077    /**
123078     * Transfers a result set from a prepared statement
123079     *
123080     * {@link maxdb_stmt_store_result} has no functionally effect and should
123081     * not be used for retrieving data from MaxDB server.
123082     *
123083     * @return object
123084     **/
123085    function store_result(){}
123086
123087}
123088/**
123089 * Represents a connection to a set of memcache servers.
123090 **/
123091class Memcache {
123092    /**
123093     * Add an item to the server
123094     *
123095     * {@link Memcache::add} stores variable {@link var} with {@link key}
123096     * only if such key doesn't exist at the server yet. Also you can use
123097     * {@link memcache_add} function.
123098     *
123099     * @param string $key The key that will be associated with the item.
123100     * @param mixed $var The variable to store. Strings and integers are
123101     *   stored as is, other types are stored serialized.
123102     * @param int $flag Use MEMCACHE_COMPRESSED to store the item
123103     *   compressed (uses zlib).
123104     * @param int $expire Expiration time of the item. If it's equal to
123105     *   zero, the item will never expire. You can also use Unix timestamp or
123106     *   a number of seconds starting from current time, but in the latter
123107     *   case the number of seconds may not exceed 2592000 (30 days).
123108     * @return bool Returns FALSE if such key already exist. For the rest
123109     *   {@link Memcache::add} behaves similarly to {@link Memcache::set}.
123110     * @since PECL memcache >= 0.2.0
123111     **/
123112    function add($key, $var, $flag, $expire){}
123113
123114    /**
123115     * Add a memcached server to connection pool
123116     *
123117     * {@link Memcache::addServer} adds a server to the connection pool. You
123118     * can also use the {@link memcache_add_server} function.
123119     *
123120     * When using this method (as opposed to {@link Memcache::connect} and
123121     * {@link Memcache::pconnect}) the network connection is not established
123122     * until actually needed. Thus there is no overhead in adding a large
123123     * number of servers to the pool, even though they might not all be used.
123124     *
123125     * Failover may occur at any stage in any of the methods, as long as
123126     * other servers are available the request the user won't notice. Any
123127     * kind of socket or Memcached server level errors (except out-of-memory)
123128     * may trigger the failover. Normal client errors such as adding an
123129     * existing key will not trigger a failover.
123130     *
123131     * @param string $host Point to the host where memcached is listening
123132     *   for connections. This parameter may also specify other transports
123133     *   like unix:///path/to/memcached.sock to use UNIX domain sockets, in
123134     *   this case {@link port} must also be set to 0.
123135     * @param int $port Point to the port where memcached is listening for
123136     *   connections. Set this parameter to 0 when using UNIX domain sockets.
123137     *   Please note: {@link port} defaults to memcache.default_port if not
123138     *   specified. For this reason it is wise to specify the port explicitly
123139     *   in this method call.
123140     * @param bool $persistent Controls the use of a persistent connection.
123141     *   Default to TRUE.
123142     * @param int $weight Number of buckets to create for this server which
123143     *   in turn control its probability of it being selected. The
123144     *   probability is relative to the total weight of all servers.
123145     * @param int $timeout Value in seconds which will be used for
123146     *   connecting to the daemon. Think twice before changing the default
123147     *   value of 1 second - you can lose all the advantages of caching if
123148     *   your connection is too slow.
123149     * @param int $retry_interval Controls how often a failed server will
123150     *   be retried, the default value is 15 seconds. Setting this parameter
123151     *   to -1 disables automatic retry. Neither this nor the {@link
123152     *   persistent} parameter has any effect when the extension is loaded
123153     *   dynamically via {@link dl}. Each failed connection struct has its
123154     *   own timeout and before it has expired the struct will be skipped
123155     *   when selecting backends to serve a request. Once expired the
123156     *   connection will be successfully reconnected or marked as failed for
123157     *   another {@link retry_interval} seconds. The typical effect is that
123158     *   each web server child will retry the connection about every {@link
123159     *   retry_interval} seconds when serving a page.
123160     * @param bool $status Controls if the server should be flagged as
123161     *   online. Setting this parameter to FALSE and {@link retry_interval}
123162     *   to -1 allows a failed server to be kept in the pool so as not to
123163     *   affect the key distribution algorithm. Requests for this server will
123164     *   then failover or fail immediately depending on the {@link
123165     *   memcache.allow_failover} setting. Default to TRUE, meaning the
123166     *   server should be considered online.
123167     * @param callable $failure_callback Allows the user to specify a
123168     *   callback function to run upon encountering an error. The callback is
123169     *   run before failover is attempted. The function takes two parameters,
123170     *   the hostname and port of the failed server.
123171     * @param int $timeoutms
123172     * @return bool
123173     * @since PECL memcache >= 2.0.0
123174     **/
123175    function addServer($host, $port, $persistent, $weight, $timeout, $retry_interval, $status, $failure_callback, $timeoutms){}
123176
123177    /**
123178     * Close memcached server connection
123179     *
123180     * {@link Memcache::close} closes connection to memcached server. This
123181     * function doesn't close persistent connections, which are closed only
123182     * during web-server shutdown/restart. Also you can use {@link
123183     * memcache_close} function.
123184     *
123185     * @return bool
123186     * @since PECL memcache >= 0.4.0
123187     **/
123188    function close(){}
123189
123190    /**
123191     * Open memcached server connection
123192     *
123193     * {@link Memcache::connect} establishes a connection to the memcached
123194     * server. The connection, which was opened using {@link
123195     * Memcache::connect} will be automatically closed at the end of script
123196     * execution. Also you can close it with {@link Memcache::close}. Also
123197     * you can use {@link memcache_connect} function.
123198     *
123199     * @param string $host Point to the host where memcached is listening
123200     *   for connections. This parameter may also specify other transports
123201     *   like unix:///path/to/memcached.sock to use UNIX domain sockets, in
123202     *   this case {@link port} must also be set to 0.
123203     * @param int $port Point to the port where memcached is listening for
123204     *   connections. Set this parameter to 0 when using UNIX domain sockets.
123205     *   Please note: {@link port} defaults to memcache.default_port if not
123206     *   specified. For this reason it is wise to specify the port explicitly
123207     *   in this method call.
123208     * @param int $timeout Value in seconds which will be used for
123209     *   connecting to the daemon. Think twice before changing the default
123210     *   value of 1 second - you can lose all the advantages of caching if
123211     *   your connection is too slow.
123212     * @return bool
123213     * @since PECL memcache >= 0.2.0
123214     **/
123215    function connect($host, $port, $timeout){}
123216
123217    /**
123218     * Decrement item's value
123219     *
123220     * {@link Memcache::decrement} decrements value of the item by {@link
123221     * value}. Similarly to {@link Memcache::increment}, current value of the
123222     * item is being converted to numerical and after that {@link value} is
123223     * subtracted. New item's value will not be less than zero. Do not use
123224     * {@link Memcache::decrement} with item, which was stored compressed,
123225     * because consequent call to {@link Memcache::get} will fail. {@link
123226     * Memcache::decrement} does not create an item if it didn't exist. Also
123227     * you can use {@link memcache_decrement} function.
123228     *
123229     * @param string $key Key of the item do decrement.
123230     * @param int $value Decrement the item by {@link value}.
123231     * @return int Returns item's new value on success.
123232     * @since PECL memcache >= 0.2.0
123233     **/
123234    function decrement($key, $value){}
123235
123236    /**
123237     * Delete item from the server
123238     *
123239     * {@link Memcache::delete} deletes an item with the {@link key}.
123240     *
123241     * @param string $key The key associated with the item to delete.
123242     * @param int $timeout This deprecated parameter is not supported, and
123243     *   defaults to 0 seconds. Do not use this parameter.
123244     * @return bool
123245     * @since PECL memcache >= 0.2.0
123246     **/
123247    function delete($key, $timeout){}
123248
123249    /**
123250     * Flush all existing items at the server
123251     *
123252     * {@link Memcache::flush} immediately invalidates all existing items.
123253     * {@link Memcache::flush} doesn't actually free any resources, it only
123254     * marks all the items as expired, so occupied memory will be overwritten
123255     * by new items. Also you can use {@link memcache_flush} function.
123256     *
123257     * @return bool
123258     * @since PECL memcache >= 1.0.0
123259     **/
123260    function flush(){}
123261
123262    /**
123263     * Retrieve item from the server
123264     *
123265     * {@link Memcache::get} returns previously stored data of an item, if
123266     * such {@link key} exists on the server at this moment.
123267     *
123268     * You can pass array of keys to {@link Memcache::get} to get array of
123269     * values. The result array will contain only found key-value pairs.
123270     *
123271     * @param string $key The key or array of keys to fetch.
123272     * @param int $flags If present, flags fetched along with the values
123273     *   will be written to this parameter. These flags are the same as the
123274     *   ones given to for example {@link Memcache::set}. The lowest byte of
123275     *   the int is reserved for pecl/memcache internal usage (e.g. to
123276     *   indicate compression and serialization status).
123277     * @return string Returns the value associated with the {@link key} or
123278     *   an array of found key-value pairs when {@link key} is an array.
123279     *   Returns FALSE on failure, {@link key} is not found or {@link key} is
123280     *   an empty array.
123281     * @since PECL memcache >= 0.2.0
123282     **/
123283    function get($key, &$flags){}
123284
123285    /**
123286     * Get statistics from all servers in pool
123287     *
123288     * {@link Memcache::getExtendedStats} returns a two-dimensional
123289     * associative array with server statistics. Array keys correspond to
123290     * host:port of server and values contain the individual server
123291     * statistics. A failed server will have its corresponding entry set to
123292     * FALSE. You can also use the {@link memcache_get_extended_stats}
123293     * function.
123294     *
123295     * @param string $type The type of statistics to fetch. Valid values
123296     *   are {reset, malloc, maps, cachedump, slabs, items, sizes}. According
123297     *   to the memcached protocol spec these additional arguments "are
123298     *   subject to change for the convenience of memcache developers".
123299     * @param int $slabid Used in conjunction with {@link type} set to
123300     *   cachedump to identify the slab to dump from. The cachedump command
123301     *   ties up the server and is strictly to be used for debugging
123302     *   purposes.
123303     * @param int $limit Used in conjunction with {@link type} set to
123304     *   cachedump to limit the number of entries to dump.
123305     * @return array Returns a two-dimensional associative array of server
123306     *   statistics or FALSE on failure.
123307     * @since PECL memcache >= 2.0.0
123308     **/
123309    function getExtendedStats($type, $slabid, $limit){}
123310
123311    /**
123312     * Returns server status
123313     *
123314     * {@link Memcache::getServerStatus} returns a the servers online/offline
123315     * status. You can also use {@link memcache_get_server_status} function.
123316     *
123317     * @param string $host Point to the host where memcached is listening
123318     *   for connections.
123319     * @param int $port Point to the port where memcached is listening for
123320     *   connections.
123321     * @return int Returns a the servers status. 0 if server is failed,
123322     *   non-zero otherwise
123323     * @since PECL memcache >= 2.1.0
123324     **/
123325    function getServerStatus($host, $port){}
123326
123327    /**
123328     * Get statistics of the server
123329     *
123330     * {@link Memcache::getStats} returns an associative array with server's
123331     * statistics. Array keys correspond to stats parameters and values to
123332     * parameter's values. Also you can use {@link memcache_get_stats}
123333     * function.
123334     *
123335     * @param string $type The type of statistics to fetch. Valid values
123336     *   are {reset, malloc, maps, cachedump, slabs, items, sizes}. According
123337     *   to the memcached protocol spec these additional arguments "are
123338     *   subject to change for the convenience of memcache developers".
123339     * @param int $slabid Used in conjunction with {@link type} set to
123340     *   cachedump to identify the slab to dump from. The cachedump command
123341     *   ties up the server and is strictly to be used for debugging
123342     *   purposes.
123343     * @param int $limit Used in conjunction with {@link type} set to
123344     *   cachedump to limit the number of entries to dump.
123345     * @return array Returns an associative array of server statistics.
123346     * @since PECL memcache >= 0.2.0
123347     **/
123348    function getStats($type, $slabid, $limit){}
123349
123350    /**
123351     * Return version of the server
123352     *
123353     * {@link Memcache::getVersion} returns a string with server's version
123354     * number. Also you can use {@link memcache_get_version} function.
123355     *
123356     * @return string Returns a string of server version number.
123357     * @since PECL memcache >= 0.2.0
123358     **/
123359    function getVersion(){}
123360
123361    /**
123362     * Increment item's value
123363     *
123364     * {@link Memcache::increment} increments value of an item by the
123365     * specified {@link value}. If item specified by {@link key} was not
123366     * numeric and cannot be converted to a number, it will change its value
123367     * to {@link value}. {@link Memcache::increment} does not create an item
123368     * if it doesn't already exist. Do not use {@link Memcache::increment}
123369     * with items that have been stored compressed because subsequent calls
123370     * to {@link Memcache::get} will fail. Also you can use {@link
123371     * memcache_increment} function.
123372     *
123373     * @param string $key Key of the item to increment.
123374     * @param int $value Increment the item by {@link value}.
123375     * @return int Returns new items value on success .
123376     * @since PECL memcache >= 0.2.0
123377     **/
123378    function increment($key, $value){}
123379
123380    /**
123381     * Open memcached server persistent connection
123382     *
123383     * {@link Memcache::pconnect} is similar to {@link Memcache::connect}
123384     * with the difference, that the connection it establishes is persistent.
123385     * This connection is not closed after the end of script execution and by
123386     * {@link Memcache::close} function. Also you can use {@link
123387     * memcache_pconnect} function.
123388     *
123389     * @param string $host Point to the host where memcached is listening
123390     *   for connections. This parameter may also specify other transports
123391     *   like unix:///path/to/memcached.sock to use UNIX domain sockets, in
123392     *   this case {@link port} must also be set to 0.
123393     * @param int $port Point to the port where memcached is listening for
123394     *   connections. Set this parameter to 0 when using UNIX domain sockets.
123395     * @param int $timeout Value in seconds which will be used for
123396     *   connecting to the daemon. Think twice before changing the default
123397     *   value of 1 second - you can lose all the advantages of caching if
123398     *   your connection is too slow.
123399     * @return mixed Returns a Memcache object.
123400     * @since PECL memcache >= 0.4.0
123401     **/
123402    function pconnect($host, $port, $timeout){}
123403
123404    /**
123405     * Replace value of the existing item
123406     *
123407     * {@link Memcache::replace} should be used to replace value of existing
123408     * item with {@link key}. In case if item with such key doesn't exists,
123409     * {@link Memcache::replace} returns FALSE. For the rest {@link
123410     * Memcache::replace} behaves similarly to {@link Memcache::set}. Also
123411     * you can use {@link memcache_replace} function.
123412     *
123413     * @param string $key The key that will be associated with the item.
123414     * @param mixed $var The variable to store. Strings and integers are
123415     *   stored as is, other types are stored serialized.
123416     * @param int $flag Use MEMCACHE_COMPRESSED to store the item
123417     *   compressed (uses zlib).
123418     * @param int $expire Expiration time of the item. If it's equal to
123419     *   zero, the item will never expire. You can also use Unix timestamp or
123420     *   a number of seconds starting from current time, but in the latter
123421     *   case the number of seconds may not exceed 2592000 (30 days).
123422     * @return bool
123423     * @since PECL memcache >= 0.2.0
123424     **/
123425    function replace($key, $var, $flag, $expire){}
123426
123427    /**
123428     * Store data at the server
123429     *
123430     * {@link Memcache::set} stores an item {@link var} with {@link key} on
123431     * the memcached server. Parameter {@link expire} is expiration time in
123432     * seconds. If it's 0, the item never expires (but memcached server
123433     * doesn't guarantee this item to be stored all the time, it could be
123434     * deleted from the cache to make place for other items). You can use
123435     * MEMCACHE_COMPRESSED constant as {@link flag} value if you want to use
123436     * on-the-fly compression (uses zlib). Remember that resource variables
123437     * (i.e. file and connection descriptors) cannot be stored in the cache,
123438     * because they cannot be adequately represented in serialized state.
123439     * Also you can use {@link memcache_set} function.
123440     *
123441     * @param string $key The key that will be associated with the item.
123442     * @param mixed $var The variable to store. Strings and integers are
123443     *   stored as is, other types are stored serialized.
123444     * @param int $flag Use MEMCACHE_COMPRESSED to store the item
123445     *   compressed (uses zlib).
123446     * @param int $expire Expiration time of the item. If it's equal to
123447     *   zero, the item will never expire. You can also use Unix timestamp or
123448     *   a number of seconds starting from current time, but in the latter
123449     *   case the number of seconds may not exceed 2592000 (30 days).
123450     * @return bool
123451     * @since PECL memcache >= 0.2.0
123452     **/
123453    function set($key, $var, $flag, $expire){}
123454
123455    /**
123456     * Enable automatic compression of large values
123457     *
123458     * {@link Memcache::setCompressThreshold} enables automatic compression
123459     * of large values. You can also use the {@link
123460     * memcache_set_compress_threshold} function.
123461     *
123462     * @param int $threshold Controls the minimum value length before
123463     *   attempting to compress automatically.
123464     * @param float $min_savings Specifies the minimum amount of savings to
123465     *   actually store the value compressed. The supplied value must be
123466     *   between 0 and 1. Default value is 0.2 giving a minimum 20%
123467     *   compression savings.
123468     * @return bool
123469     * @since PECL memcache >= 2.0.0
123470     **/
123471    function setCompressThreshold($threshold, $min_savings){}
123472
123473    /**
123474     * Changes server parameters and status at runtime
123475     *
123476     * {@link Memcache::setServerParams} changes server parameters at
123477     * runtime. You can also use the {@link memcache_set_server_params}
123478     * function.
123479     *
123480     * @param string $host Point to the host where memcached is listening
123481     *   for connections.
123482     * @param int $port Point to the port where memcached is listening for
123483     *   connections.
123484     * @param int $timeout Value in seconds which will be used for
123485     *   connecting to the daemon. Think twice before changing the default
123486     *   value of 1 second - you can lose all the advantages of caching if
123487     *   your connection is too slow.
123488     * @param int $retry_interval Controls how often a failed server will
123489     *   be retried, the default value is 15 seconds. Setting this parameter
123490     *   to -1 disables automatic retry. Neither this nor the {@link
123491     *   persistent} parameter has any effect when the extension is loaded
123492     *   dynamically via {@link dl}.
123493     * @param bool $status Controls if the server should be flagged as
123494     *   online. Setting this parameter to FALSE and {@link retry_interval}
123495     *   to -1 allows a failed server to be kept in the pool so as not to
123496     *   affect the key distribution algorithm. Requests for this server will
123497     *   then failover or fail immediately depending on the {@link
123498     *   memcache.allow_failover} setting. Default to TRUE, meaning the
123499     *   server should be considered online.
123500     * @param callable $failure_callback Allows the user to specify a
123501     *   callback function to run upon encountering an error. The callback is
123502     *   run before failover is attempted. The function takes two parameters,
123503     *   the hostname and port of the failed server.
123504     * @return bool
123505     * @since PECL memcache >= 2.1.0
123506     **/
123507    function setServerParams($host, $port, $timeout, $retry_interval, $status, $failure_callback){}
123508
123509}
123510/**
123511 * Represents a connection to a set of memcached servers.
123512 **/
123513class Memcached {
123514    const DISTRIBUTION_CONSISTENT = 0;
123515
123516    const DISTRIBUTION_MODULA = 0;
123517
123518    const GET_EXTENDED = 0;
123519
123520    const GET_PRESERVE_ORDER = 0;
123521
123522    const HASH_CRC = 0;
123523
123524    const HASH_DEFAULT = 0;
123525
123526    const HASH_FNV1A_32 = 0;
123527
123528    const HASH_FNV1A_64 = 0;
123529
123530    const HASH_FNV1_32 = 0;
123531
123532    const HASH_FNV1_64 = 0;
123533
123534    const HASH_HSIEH = 0;
123535
123536    const HASH_MD5 = 0;
123537
123538    const HASH_MURMUR = 0;
123539
123540    const HAVE_IGBINARY = 0;
123541
123542    const HAVE_JSON = 0;
123543
123544    const HAVE_MSGPACK = 0;
123545
123546    const HAVE_SASL = 0;
123547
123548    const HAVE_SESSION = 0;
123549
123550    const OPT_BINARY_PROTOCOL = 0;
123551
123552    const OPT_BUFFER_WRITES = 0;
123553
123554    const OPT_CACHE_LOOKUPS = 0;
123555
123556    const OPT_COMPRESSION = 0;
123557
123558    const OPT_CONNECT_TIMEOUT = 0;
123559
123560    const OPT_DISTRIBUTION = 0;
123561
123562    const OPT_HASH = 0;
123563
123564    const OPT_LIBKETAMA_COMPATIBLE = 0;
123565
123566    const OPT_NO_BLOCK = 0;
123567
123568    const OPT_POLL_TIMEOUT = 0;
123569
123570    const OPT_PREFIX_KEY = 0;
123571
123572    const OPT_RECV_TIMEOUT = 0;
123573
123574    const OPT_RETRY_TIMEOUT = 0;
123575
123576    const OPT_SEND_TIMEOUT = 0;
123577
123578    const OPT_SERIALIZER = 0;
123579
123580    const OPT_SERVER_FAILURE_LIMIT = 0;
123581
123582    const OPT_SOCKET_RECV_SIZE = 0;
123583
123584    const OPT_SOCKET_SEND_SIZE = 0;
123585
123586    const OPT_TCP_NODELAY = 0;
123587
123588    const RES_AUTH_CONTINUE = 0;
123589
123590    const RES_AUTH_FAILURE = 0;
123591
123592    const RES_AUTH_PROBLEM = 0;
123593
123594    const RES_BAD_KEY_PROVIDED = 0;
123595
123596    const RES_BUFFERED = 0;
123597
123598    const RES_CLIENT_ERROR = 0;
123599
123600    const RES_CONNECTION_SOCKET_CREATE_FAILURE = 0;
123601
123602    const RES_DATA_EXISTS = 0;
123603
123604    const RES_E2BIG = 0;
123605
123606    const RES_END = 0;
123607
123608    const RES_ERRNO = 0;
123609
123610    const RES_FAILURE = 0;
123611
123612    const RES_HOST_LOOKUP_FAILURE = 0;
123613
123614    const RES_KEY_TOO_BIG = 0;
123615
123616    const RES_NOTFOUND = 0;
123617
123618    const RES_NOTSTORED = 0;
123619
123620    const RES_NO_SERVERS = 0;
123621
123622    const RES_PARTIAL_READ = 0;
123623
123624    const RES_PAYLOAD_FAILURE = 0;
123625
123626    const RES_PROTOCOL_ERROR = 0;
123627
123628    const RES_SERVER_ERROR = 0;
123629
123630    const RES_SERVER_MEMORY_ALLOCATION_FAILURE = 0;
123631
123632    const RES_SERVER_TEMPORARILY_DISABLED = 0;
123633
123634    const RES_SOME_ERRORS = 0;
123635
123636    const RES_SUCCESS = 0;
123637
123638    const RES_TIMEOUT = 0;
123639
123640    const RES_UNKNOWN_READ_FAILURE = 0;
123641
123642    const RES_WRITE_FAILURE = 0;
123643
123644    const SERIALIZER_IGBINARY = 0;
123645
123646    const SERIALIZER_JSON = 0;
123647
123648    const SERIALIZER_PHP = 0;
123649
123650    /**
123651     * Add an item under a new key
123652     *
123653     * {@link Memcached::add} is similar to Memcached::set, but the operation
123654     * fails if the {@link key} already exists on the server.
123655     *
123656     * @param string $key
123657     * @param mixed $value
123658     * @param int $expiration
123659     * @return bool The Memcached::getResultCode will return
123660     *   Memcached::RES_NOTSTORED if the key already exists.
123661     * @since PECL memcached >= 0.1.0
123662     **/
123663    public function add($key, $value, $expiration){}
123664
123665    /**
123666     * Add an item under a new key on a specific server
123667     *
123668     * {@link Memcached::addByKey} is functionally equivalent to
123669     * Memcached::add, except that the free-form {@link server_key} can be
123670     * used to map the {@link key} to a specific server. This is useful if
123671     * you need to keep a bunch of related keys on a certain server.
123672     *
123673     * @param string $server_key
123674     * @param string $key
123675     * @param mixed $value
123676     * @param int $expiration
123677     * @return bool The Memcached::getResultCode will return
123678     *   Memcached::RES_NOTSTORED if the key already exists.
123679     * @since PECL memcached >= 0.1.0
123680     **/
123681    public function addByKey($server_key, $key, $value, $expiration){}
123682
123683    /**
123684     * Add a server to the server pool
123685     *
123686     * {@link Memcached::addServer} adds the specified server to the server
123687     * pool. No connection is established to the server at this time, but if
123688     * you are using consistent key distribution option (via
123689     * Memcached::DISTRIBUTION_CONSISTENT or
123690     * Memcached::OPT_LIBKETAMA_COMPATIBLE), some of the internal data
123691     * structures will have to be updated. Thus, if you need to add multiple
123692     * servers, it is better to use Memcached::addServers as the update then
123693     * happens only once.
123694     *
123695     * The same server may appear multiple times in the server pool, because
123696     * no duplication checks are made. This is not advisable; instead, use
123697     * the {@link weight} option to increase the selection weighting of this
123698     * server.
123699     *
123700     * @param string $host The hostname of the memcache server. If the
123701     *   hostname is invalid, data-related operations will set
123702     *   Memcached::RES_HOST_LOOKUP_FAILURE result code. As of version
123703     *   2.0.0b1, this parameter may also specify the path of a unix socket
123704     *   filepath ex. /path/to/memcached.sock to use UNIX domain sockets, in
123705     *   this case {@link port} must also be set to 0.
123706     * @param int $port The port on which memcache is running. Usually,
123707     *   this is 11211. As of version 2.0.0b1, set this parameter to 0 when
123708     *   using UNIX domain sockets.
123709     * @param int $weight The weight of the server relative to the total
123710     *   weight of all the servers in the pool. This controls the probability
123711     *   of the server being selected for operations. This is used only with
123712     *   consistent distribution option and usually corresponds to the amount
123713     *   of memory available to memcache on that server.
123714     * @return bool
123715     * @since PECL memcached >= 0.1.0
123716     **/
123717    public function addServer($host, $port, $weight){}
123718
123719    /**
123720     * Add multiple servers to the server pool
123721     *
123722     * {@link Memcached::addServers} adds {@link servers} to the server pool.
123723     * Each entry in {@link servers} is supposed to be an array containing
123724     * hostname, port, and, optionally, weight of the server. No connection
123725     * is established to the servers at this time.
123726     *
123727     * The same server may appear multiple times in the server pool, because
123728     * no duplication checks are made. This is not advisable; instead, use
123729     * the {@link weight} option to increase the selection weighting of this
123730     * server.
123731     *
123732     * @param array $servers Array of the servers to add to the pool.
123733     * @return bool
123734     * @since PECL memcached >= 0.1.1
123735     **/
123736    public function addServers($servers){}
123737
123738    /**
123739     * Append data to an existing item
123740     *
123741     * {@link Memcached::append} appends the given {@link value} string to
123742     * the value of an existing item. The reason that {@link value} is forced
123743     * to be a string is that appending mixed types is not well-defined.
123744     *
123745     * @param string $key
123746     * @param string $value The string to append.
123747     * @return bool The Memcached::getResultCode will return
123748     *   Memcached::RES_NOTSTORED if the key does not exist.
123749     * @since PECL memcached >= 0.1.0
123750     **/
123751    public function append($key, $value){}
123752
123753    /**
123754     * Append data to an existing item on a specific server
123755     *
123756     * {@link Memcached::appendByKey} is functionally equivalent to
123757     * Memcached::append, except that the free-form {@link server_key} can be
123758     * used to map the {@link key} to a specific server.
123759     *
123760     * @param string $server_key
123761     * @param string $key
123762     * @param string $value The string to append.
123763     * @return bool The Memcached::getResultCode will return
123764     *   Memcached::RES_NOTSTORED if the key does not exist.
123765     * @since PECL memcached >= 0.1.0
123766     **/
123767    public function appendByKey($server_key, $key, $value){}
123768
123769    /**
123770     * Compare and swap an item
123771     *
123772     * {@link Memcached::cas} performs a "check and set" operation, so that
123773     * the item will be stored only if no other client has updated it since
123774     * it was last fetched by this client. The check is done via the {@link
123775     * cas_token} parameter which is a unique 64-bit value assigned to the
123776     * existing item by memcache. See the documentation for Memcached::get*
123777     * methods for how to obtain this token. Note that the token is
123778     * represented as a double due to the limitations of PHP's integer space.
123779     *
123780     * @param float $cas_token Unique value associated with the existing
123781     *   item. Generated by memcache.
123782     * @param string $key
123783     * @param mixed $value
123784     * @param int $expiration
123785     * @return bool The Memcached::getResultCode will return
123786     *   Memcached::RES_DATA_EXISTS if the item you are trying to store has
123787     *   been modified since you last fetched it.
123788     * @since PECL memcached >= 0.1.0
123789     **/
123790    public function cas($cas_token, $key, $value, $expiration){}
123791
123792    /**
123793     * Compare and swap an item on a specific server
123794     *
123795     * {@link Memcached::casByKey} is functionally equivalent to
123796     * Memcached::cas, except that the free-form {@link server_key} can be
123797     * used to map the {@link key} to a specific server. This is useful if
123798     * you need to keep a bunch of related keys on a certain server.
123799     *
123800     * @param float $cas_token Unique value associated with the existing
123801     *   item. Generated by memcache.
123802     * @param string $server_key
123803     * @param string $key
123804     * @param mixed $value
123805     * @param int $expiration
123806     * @return bool The Memcached::getResultCode will return
123807     *   Memcached::RES_DATA_EXISTS if the item you are trying to store has
123808     *   been modified since you last fetched it.
123809     * @since PECL memcached >= 0.1.0
123810     **/
123811    public function casByKey($cas_token, $server_key, $key, $value, $expiration){}
123812
123813    /**
123814     * Decrement numeric item's value
123815     *
123816     * {@link Memcached::decrement} decrements a numeric item's value by the
123817     * specified {@link offset}. If the item's value is not numeric, an error
123818     * will result. If the operation would decrease the value below 0, the
123819     * new value will be 0. {@link Memcached::decrement} will set the item to
123820     * the {@link initial_value} parameter if the key doesn't exist.
123821     *
123822     * @param string $key The key of the item to decrement.
123823     * @param int $offset The amount by which to decrement the item's
123824     *   value.
123825     * @param int $initial_value The value to set the item to if it doesn't
123826     *   currently exist.
123827     * @param int $expiry The expiry time to set on the item.
123828     * @return int Returns item's new value on success.
123829     * @since PECL memcached >= 0.1.0
123830     **/
123831    public function decrement($key, $offset, $initial_value, $expiry){}
123832
123833    /**
123834     * Decrement numeric item's value, stored on a specific server
123835     *
123836     * {@link Memcached::decrementByKey} decrements a numeric item's value by
123837     * the specified {@link offset}. If the item's value is not numeric, an
123838     * error will result. If the operation would decrease the value below 0,
123839     * the new value will be 0. {@link Memcached::decrementByKey} will set
123840     * the item to the {@link initial_value} parameter if the key doesn't
123841     * exist.
123842     *
123843     * @param string $server_key
123844     * @param string $key The key of the item to decrement.
123845     * @param int $offset The amount by which to decrement the item's
123846     *   value.
123847     * @param int $initial_value The value to set the item to if it doesn't
123848     *   currently exist.
123849     * @param int $expiry The expiry time to set on the item.
123850     * @return int Returns item's new value on success.
123851     * @since PECL memcached >= 2.0.0
123852     **/
123853    public function decrementByKey($server_key, $key, $offset, $initial_value, $expiry){}
123854
123855    /**
123856     * Delete an item
123857     *
123858     * {@link Memcached::delete} deletes the {@link key} from the server. The
123859     * {@link time} parameter is the amount of time in seconds (or Unix time
123860     * until which) the client wishes the server to refuse add and replace
123861     * commands for this key. For this amount of time, the item is put into a
123862     * delete queue, which means that it won't possible to retrieve it by the
123863     * get command, but add and replace command with this key will also fail
123864     * (the set command will succeed, however). After the time passes, the
123865     * item is finally deleted from server memory. The parameter {@link time}
123866     * defaults to 0 (which means that the item will be deleted immediately
123867     * and further storage commands with this key will succeed).
123868     *
123869     * @param string $key The key to be deleted.
123870     * @param int $time The amount of time the server will wait to delete
123871     *   the item.
123872     * @return bool The Memcached::getResultCode will return
123873     *   Memcached::RES_NOTFOUND if the key does not exist.
123874     * @since PECL memcached >= 0.1.0
123875     **/
123876    public function delete($key, $time){}
123877
123878    /**
123879     * Delete an item from a specific server
123880     *
123881     * {@link Memcached::deleteByKey} is functionally equivalent to
123882     * Memcached::delete, except that the free-form {@link server_key} can be
123883     * used to map the {@link key} to a specific server.
123884     *
123885     * @param string $server_key
123886     * @param string $key The key to be deleted.
123887     * @param int $time The amount of time the server will wait to delete
123888     *   the item.
123889     * @return bool The Memcached::getResultCode will return
123890     *   Memcached::RES_NOTFOUND if the key does not exist.
123891     * @since PECL memcached >= 0.1.0
123892     **/
123893    public function deleteByKey($server_key, $key, $time){}
123894
123895    /**
123896     * Delete multiple items
123897     *
123898     * {@link Memcached::deleteMulti} deletes the array of {@link keys} from
123899     * the server. The {@link time} parameter is the amount of time in
123900     * seconds (or Unix time until which) the client wishes the server to
123901     * refuse add and replace commands for these keys. For this amount of
123902     * time, the item is put into a delete queue, which means that it won't
123903     * be possible to retrieve it by the get command, but add and replace
123904     * command with these keys will also fail (the set command will succeed,
123905     * however). After the time passes, the item is finally deleted from
123906     * server memory. The parameter {@link time} defaults to 0 (which means
123907     * that the item will be deleted immediately and further storage commands
123908     * with these keys will succeed).
123909     *
123910     * @param array $keys The keys to be deleted.
123911     * @param int $time The amount of time the server will wait to delete
123912     *   the items.
123913     * @return array Returns array indexed by {@link keys} and where values
123914     *   are indicating whether operation succeeded or not. The
123915     *   Memcached::getResultCode will return Memcached::RES_NOTFOUND if the
123916     *   key does not exist.
123917     * @since PECL memcached >= 2.0.0
123918     **/
123919    public function deleteMulti($keys, $time){}
123920
123921    /**
123922     * Delete multiple items from a specific server
123923     *
123924     * {@link Memcached::deleteMultiByKey} is functionally equivalent to
123925     * Memcached::deleteMulti, except that the free-form {@link server_key}
123926     * can be used to map the {@link keys} to a specific server.
123927     *
123928     * @param string $server_key
123929     * @param array $keys The keys to be deleted.
123930     * @param int $time The amount of time the server will wait to delete
123931     *   the items.
123932     * @return bool The Memcached::getResultCode will return
123933     *   Memcached::RES_NOTFOUND if the key does not exist.
123934     * @since PECL memcached >= 2.0.0
123935     **/
123936    public function deleteMultiByKey($server_key, $keys, $time){}
123937
123938    /**
123939     * Fetch the next result
123940     *
123941     * {@link Memcached::fetch} retrieves the next result from the last
123942     * request.
123943     *
123944     * @return array Returns the next result or FALSE otherwise. The
123945     *   Memcached::getResultCode will return Memcached::RES_END if result
123946     *   set is exhausted.
123947     * @since PECL memcached >= 0.1.0
123948     **/
123949    public function fetch(){}
123950
123951    /**
123952     * Fetch all the remaining results
123953     *
123954     * {@link Memcached::fetchAll} retrieves all the remaining results from
123955     * the last request.
123956     *
123957     * @return array Returns the results.
123958     * @since PECL memcached >= 0.1.0
123959     **/
123960    public function fetchAll(){}
123961
123962    /**
123963     * Invalidate all items in the cache
123964     *
123965     * {@link Memcached::flush} invalidates all existing cache items
123966     * immediately (by default) or after the {@link delay} specified. After
123967     * invalidation none of the items will be returned in response to a
123968     * retrieval command (unless it's stored again under the same key after
123969     * {@link Memcached::flush} has invalidated the items). The flush does
123970     * not actually free all the memory taken up by the existing items; that
123971     * will happen gradually as new items are stored.
123972     *
123973     * @param int $delay Number of seconds to wait before invalidating the
123974     *   items.
123975     * @return bool
123976     * @since PECL memcached >= 0.1.0
123977     **/
123978    public function flush($delay){}
123979
123980    /**
123981     * Retrieve an item
123982     *
123983     * {@link Memcached::get} returns the item that was previously stored
123984     * under the {@link key}. If the item is found and the {@link flags} is
123985     * given Memcached::GET_EXTENDED, it will also return the CAS token value
123986     * for the item. See Memcached::cas for how to use CAS tokens.
123987     * Read-through caching callback may be specified via {@link cache_cb}
123988     * parameter.
123989     *
123990     * @param string $key The key of the item to retrieve.
123991     * @param callable $cache_cb Read-through caching callback or NULL.
123992     * @param int $flags Flags to control the returned result. When
123993     *   Memcached::GET_EXTENDED is given, the function will also return the
123994     *   CAS token.
123995     * @return mixed Returns the value stored in the cache or FALSE
123996     *   otherwise. If the {@link flags} is set to Memcached::GET_EXTENDED,
123997     *   an array containing the value and the CAS token is returned instead
123998     *   of only the value. The Memcached::getResultCode will return
123999     *   Memcached::RES_NOTFOUND if the key does not exist.
124000     * @since PECL memcached >= 0.1.0
124001     **/
124002    public function get($key, $cache_cb, $flags){}
124003
124004    /**
124005     * Gets the keys stored on all the servers
124006     *
124007     * {@link Memcached::getAllKeys} queries each memcache server and
124008     * retrieves an array of all keys stored on them at that point in time.
124009     * This is not an atomic operation, so it isn't a truly consistent
124010     * snapshot of the keys at point in time. As memcache doesn't guarantee
124011     * to return all keys you also cannot assume that all keys have been
124012     * returned.
124013     *
124014     * @return array Returns the keys stored on all the servers on success.
124015     * @since PECL memcached >= 2.0.0
124016     **/
124017    public function getAllKeys(){}
124018
124019    /**
124020     * Retrieve an item from a specific server
124021     *
124022     * {@link Memcached::getByKey} is functionally equivalent to
124023     * Memcached::get, except that the free-form {@link server_key} can be
124024     * used to map the {@link key} to a specific server.
124025     *
124026     * @param string $server_key
124027     * @param string $key The key of the item to fetch.
124028     * @param callable $cache_cb Read-through caching callback or NULL
124029     * @param int $flags Flags to control the returned result. When value
124030     *   of Memcached::GET_EXTENDED is given will return the CAS token.
124031     * @return mixed Returns the value stored in the cache or FALSE
124032     *   otherwise. The Memcached::getResultCode will return
124033     *   Memcached::RES_NOTFOUND if the key does not exist.
124034     * @since PECL memcached >= 0.1.0
124035     **/
124036    public function getByKey($server_key, $key, $cache_cb, $flags){}
124037
124038    /**
124039     * Request multiple items
124040     *
124041     * {@link Memcached::getDelayed} issues a request to memcache for
124042     * multiple items the keys of which are specified in the {@link keys}
124043     * array. The method does not wait for response and returns right away.
124044     * When you are ready to collect the items, call either Memcached::fetch
124045     * or Memcached::fetchAll. If {@link with_cas} is true, the CAS token
124046     * values will also be requested.
124047     *
124048     * Instead of fetching the results explicitly, you can specify a result
124049     * callback via {@link value_cb} parameter.
124050     *
124051     * @param array $keys Array of keys to request.
124052     * @param bool $with_cas Whether to request CAS token values also.
124053     * @param callable $value_cb The result callback or NULL.
124054     * @return bool
124055     * @since PECL memcached >= 0.1.0
124056     **/
124057    public function getDelayed($keys, $with_cas, $value_cb){}
124058
124059    /**
124060     * Request multiple items from a specific server
124061     *
124062     * {@link Memcached::getDelayedByKey} is functionally equivalent to
124063     * Memcached::getDelayed, except that the free-form {@link server_key}
124064     * can be used to map the {@link keys} to a specific server.
124065     *
124066     * @param string $server_key
124067     * @param array $keys Array of keys to request.
124068     * @param bool $with_cas Whether to request CAS token values also.
124069     * @param callable $value_cb The result callback or NULL.
124070     * @return bool
124071     * @since PECL memcached >= 0.1.0
124072     **/
124073    public function getDelayedByKey($server_key, $keys, $with_cas, $value_cb){}
124074
124075    /**
124076     * Retrieve multiple items
124077     *
124078     * {@link Memcached::getMulti} is similar to Memcached::get, but instead
124079     * of a single key item, it retrieves multiple items the keys of which
124080     * are specified in the {@link keys} array. Before v3.0 a second argument
124081     * cas_tokens was in use. It was filled with the CAS token values for the
124082     * found items. The cas_tokens parameter was removed in v3.0 of the
124083     * extension. It was replaced with a new flag Memcached::GET_EXTENDED
124084     * that needs is to be used as the value for {@link flags}.
124085     *
124086     * The {@link flags} parameter can be used to specify additional options
124087     * for {@link Memcached::getMulti}. Memcached::GET_PRESERVE_ORDER ensures
124088     * that the keys are returned in the same order as they were requested
124089     * in. Memcached::GET_EXTENDED ensures that the CAS tokens will be
124090     * fetched too.
124091     *
124092     * @param array $keys Array of keys to retrieve.
124093     * @param int $flags The flags for the get operation.
124094     * @return mixed Returns the array of found items.
124095     * @since PECL memcached >= 0.1.0
124096     **/
124097    public function getMulti($keys, $flags){}
124098
124099    /**
124100     * Retrieve multiple items from a specific server
124101     *
124102     * {@link Memcached::getMultiByKey} is functionally equivalent to
124103     * Memcached::getMulti, except that the free-form {@link server_key} can
124104     * be used to map the {@link keys} to a specific server.
124105     *
124106     * @param string $server_key
124107     * @param array $keys Array of keys to retrieve.
124108     * @param int $flags The flags for the get operation.
124109     * @return array Returns the array of found items.
124110     * @since PECL memcached >= 0.1.0
124111     **/
124112    public function getMultiByKey($server_key, $keys, $flags){}
124113
124114    /**
124115     * Retrieve a Memcached option value
124116     *
124117     * This method returns the value of a Memcached {@link option}. Some
124118     * options correspond to the ones defined by libmemcached, and some are
124119     * specific to the extension. See Memcached Constants for more
124120     * information.
124121     *
124122     * @param int $option One of the Memcached::OPT_* constants.
124123     * @return mixed Returns the value of the requested option, or FALSE on
124124     *   error.
124125     * @since PECL memcached >= 0.1.0
124126     **/
124127    public function getOption($option){}
124128
124129    /**
124130     * Return the result code of the last operation
124131     *
124132     * {@link Memcached::getResultCode} returns one of the Memcached::RES_*
124133     * constants that is the result of the last executed Memcached method.
124134     *
124135     * @return int Result code of the last Memcached operation.
124136     * @since PECL memcached >= 0.1.0
124137     **/
124138    public function getResultCode(){}
124139
124140    /**
124141     * Return the message describing the result of the last operation
124142     *
124143     * {@link Memcached::getResultMessage} returns a string that describes
124144     * the result code of the last executed Memcached method.
124145     *
124146     * @return string Message describing the result of the last Memcached
124147     *   operation.
124148     * @since PECL memcached >= 1.0.0
124149     **/
124150    public function getResultMessage(){}
124151
124152    /**
124153     * Map a key to a server
124154     *
124155     * {@link Memcached::getServerByKey} returns the server that would be
124156     * selected by a particular {@link server_key} in all the {@link
124157     * Memcached::*ByKey} operations.
124158     *
124159     * @param string $server_key
124160     * @return array Returns an array containing three keys of host, port,
124161     *   and weight on success or FALSE on failure.
124162     * @since PECL memcached >= 0.1.0
124163     **/
124164    public function getServerByKey($server_key){}
124165
124166    /**
124167     * Get the list of the servers in the pool
124168     *
124169     * {@link Memcached::getServerList} returns the list of all servers that
124170     * are in its server pool.
124171     *
124172     * @return array The list of all servers in the server pool.
124173     * @since PECL memcached >= 0.1.0
124174     **/
124175    public function getServerList(){}
124176
124177    /**
124178     * Get server pool statistics
124179     *
124180     * {@link Memcached::getStats} returns an array containing the state of
124181     * all available memcache servers. See memcache protocol specification
124182     * for details on these statistics.
124183     *
124184     * @return array Array of server statistics, one entry per server.
124185     * @since PECL memcached >= 0.1.0
124186     **/
124187    public function getStats(){}
124188
124189    /**
124190     * Get server pool version info
124191     *
124192     * {@link Memcached::getVersion} returns an array containing the version
124193     * info for all available memcache servers.
124194     *
124195     * @return array Array of server versions, one entry per server.
124196     * @since PECL memcached >= 0.1.5
124197     **/
124198    public function getVersion(){}
124199
124200    /**
124201     * Increment numeric item's value
124202     *
124203     * {@link Memcached::increment} increments a numeric item's value by the
124204     * specified {@link offset}. If the item's value is not numeric, an error
124205     * will result. {@link Memcached::increment} will set the item to the
124206     * {@link initial_value} parameter if the key doesn't exist.
124207     *
124208     * @param string $key The key of the item to increment.
124209     * @param int $offset The amount by which to increment the item's
124210     *   value.
124211     * @param int $initial_value The value to set the item to if it doesn't
124212     *   currently exist.
124213     * @param int $expiry The expiry time to set on the item.
124214     * @return int Returns new item's value on success.
124215     * @since PECL memcached >= 0.1.0
124216     **/
124217    public function increment($key, $offset, $initial_value, $expiry){}
124218
124219    /**
124220     * Increment numeric item's value, stored on a specific server
124221     *
124222     * {@link Memcached::incrementByKey} increments a numeric item's value by
124223     * the specified {@link offset}. If the item's value is not numeric, an
124224     * error will result. {@link Memcached::incrementByKey} will set the item
124225     * to the {@link initial_value} parameter if the key doesn't exist.
124226     *
124227     * @param string $server_key
124228     * @param string $key The key of the item to increment.
124229     * @param int $offset The amount by which to increment the item's
124230     *   value.
124231     * @param int $initial_value The value to set the item to if it doesn't
124232     *   currently exist.
124233     * @param int $expiry The expiry time to set on the item.
124234     * @return int Returns new item's value on success.
124235     * @since PECL memcached >= 2.0.0
124236     **/
124237    public function incrementByKey($server_key, $key, $offset, $initial_value, $expiry){}
124238
124239    /**
124240     * Check if a persitent connection to memcache is being used
124241     *
124242     * {@link Memcached::isPersistent} checks if the connections to the
124243     * memcache servers are persistent connections.
124244     *
124245     * @return bool Returns true if Memcache instance uses a persistent
124246     *   connection, false otherwise.
124247     * @since PECL memcached >= 2.0.0
124248     **/
124249    public function isPersistent(){}
124250
124251    /**
124252     * Check if the instance was recently created
124253     *
124254     * {@link Memcached::isPristine} checks if the Memcache instance was
124255     * recently created.
124256     *
124257     * @return bool Returns the true if instance is recently created, false
124258     *   otherwise.
124259     * @since PECL memcached >= 2.0.0
124260     **/
124261    public function isPristine(){}
124262
124263    /**
124264     * Prepend data to an existing item
124265     *
124266     * {@link Memcached::prepend} prepends the given {@link value} string to
124267     * the value of an existing item. The reason that {@link value} is forced
124268     * to be a string is that prepending mixed types is not well-defined.
124269     *
124270     * @param string $key The key of the item to prepend the data to.
124271     * @param string $value The string to prepend.
124272     * @return bool The Memcached::getResultCode will return
124273     *   Memcached::RES_NOTSTORED if the key does not exist.
124274     * @since PECL memcached >= 0.1.0
124275     **/
124276    public function prepend($key, $value){}
124277
124278    /**
124279     * Prepend data to an existing item on a specific server
124280     *
124281     * {@link Memcached::prependByKey} is functionally equivalent to
124282     * Memcached::prepend, except that the free-form {@link server_key} can
124283     * be used to map the {@link key} to a specific server.
124284     *
124285     * @param string $server_key
124286     * @param string $key The key of the item to prepend the data to.
124287     * @param string $value The string to prepend.
124288     * @return bool The Memcached::getResultCode will return
124289     *   Memcached::RES_NOTSTORED if the key does not exist.
124290     * @since PECL memcached >= 0.1.0
124291     **/
124292    public function prependByKey($server_key, $key, $value){}
124293
124294    /**
124295     * Close any open connections
124296     *
124297     * {@link Memcached::quit} closes any open connections to the memcache
124298     * servers.
124299     *
124300     * @return bool
124301     * @since PECL memcached >= 2.0.0
124302     **/
124303    public function quit(){}
124304
124305    /**
124306     * Replace the item under an existing key
124307     *
124308     * {@link Memcached::replace} is similar to Memcached::set, but the
124309     * operation fails if the {@link key} does not exist on the server.
124310     *
124311     * @param string $key
124312     * @param mixed $value
124313     * @param int $expiration
124314     * @return bool The Memcached::getResultCode will return
124315     *   Memcached::RES_NOTSTORED if the key does not exist.
124316     * @since PECL memcached >= 0.1.0
124317     **/
124318    public function replace($key, $value, $expiration){}
124319
124320    /**
124321     * Replace the item under an existing key on a specific server
124322     *
124323     * {@link Memcached::replaceByKey} is functionally equivalent to
124324     * Memcached::replace, except that the free-form {@link server_key} can
124325     * be used to map the {@link key} to a specific server. This is useful if
124326     * you need to keep a bunch of related keys on a certain server.
124327     *
124328     * @param string $server_key
124329     * @param string $key
124330     * @param mixed $value
124331     * @param int $expiration
124332     * @return bool The Memcached::getResultCode will return
124333     *   Memcached::RES_NOTSTORED if the key does not exist.
124334     * @since PECL memcached >= 0.1.0
124335     **/
124336    public function replaceByKey($server_key, $key, $value, $expiration){}
124337
124338    /**
124339     * Clears all servers from the server list
124340     *
124341     * {@link Memcached::resetserverlist} removes all memcache servers from
124342     * the known server list, resetting it back to empty.
124343     *
124344     * @return bool
124345     * @since PECL memcached >= 2.0.0
124346     **/
124347    public function resetServerList(){}
124348
124349    /**
124350     * Store an item
124351     *
124352     * {@link Memcached::set} stores the {@link value} on a memcache server
124353     * under the specified {@link key}. The {@link expiration} parameter can
124354     * be used to control when the value is considered expired.
124355     *
124356     * The value can be any valid PHP type except for resources, because
124357     * those cannot be represented in a serialized form. If the
124358     * Memcached::OPT_COMPRESSION option is turned on, the serialized value
124359     * will also be compressed before storage.
124360     *
124361     * @param string $key
124362     * @param mixed $value
124363     * @param int $expiration
124364     * @return bool
124365     * @since PECL memcached >= 0.1.0
124366     **/
124367    public function set($key, $value, $expiration){}
124368
124369    /**
124370     * Store an item on a specific server
124371     *
124372     * {@link Memcached::setByKey} is functionally equivalent to
124373     * Memcached::set, except that the free-form {@link server_key} can be
124374     * used to map the {@link key} to a specific server. This is useful if
124375     * you need to keep a bunch of related keys on a certain server.
124376     *
124377     * @param string $server_key
124378     * @param string $key
124379     * @param mixed $value
124380     * @param int $expiration
124381     * @return bool
124382     * @since PECL memcached >= 0.1.0
124383     **/
124384    public function setByKey($server_key, $key, $value, $expiration){}
124385
124386    /**
124387     * Store multiple items
124388     *
124389     * {@link Memcached::setMulti} is similar to Memcached::set, but instead
124390     * of a single key/value item, it works on multiple items specified in
124391     * {@link items}. The {@link expiration} time applies to all the items at
124392     * once.
124393     *
124394     * @param array $items
124395     * @param int $expiration
124396     * @return bool
124397     * @since PECL memcached >= 0.1.0
124398     **/
124399    public function setMulti($items, $expiration){}
124400
124401    /**
124402     * Store multiple items on a specific server
124403     *
124404     * {@link Memcached::setMultiByKey} is functionally equivalent to
124405     * Memcached::setMulti, except that the free-form {@link server_key} can
124406     * be used to map the keys from {@link items} to a specific server. This
124407     * is useful if you need to keep a bunch of related keys on a certain
124408     * server.
124409     *
124410     * @param string $server_key
124411     * @param array $items
124412     * @param int $expiration
124413     * @return bool
124414     * @since PECL memcached >= 0.1.0
124415     **/
124416    public function setMultiByKey($server_key, $items, $expiration){}
124417
124418    /**
124419     * Set a Memcached option
124420     *
124421     * This method sets the value of a Memcached {@link option}. Some options
124422     * correspond to the ones defined by libmemcached, and some are specific
124423     * to the extension. See Memcached Constants for more information.
124424     *
124425     * The options listed below require values specified via constants.
124426     * Memcached::OPT_HASH requires Memcached::HASH_* values.
124427     * Memcached::OPT_DISTRIBUTION requires Memcached::DISTRIBUTION_* values.
124428     *
124429     * @param int $option
124430     * @param mixed $value
124431     * @return bool
124432     * @since PECL memcached >= 0.1.0
124433     **/
124434    public function setOption($option, $value){}
124435
124436    /**
124437     * Set Memcached options
124438     *
124439     * {@link Memcached::setOptions} is a variation of the
124440     * Memcached::setOption that takes an array of options to be set.
124441     *
124442     * @param array $options An associative array of options where the key
124443     *   is the option to set and the value is the new value for the option.
124444     * @return bool
124445     * @since PECL memcached >= 2.0.0
124446     **/
124447    public function setOptions($options){}
124448
124449    /**
124450     * Set the credentials to use for authentication
124451     *
124452     * {@link Memcached::setSaslAuthData} sets the username and password that
124453     * should be used for SASL authentication with the memcache servers.
124454     *
124455     * This method is only available when the memcached extension is built
124456     * with SASL support. Please refer to Memcached setup for how to do this.
124457     *
124458     * @param string $username The username to use for authentication.
124459     * @param string $password The password to use for authentication.
124460     * @return void
124461     * @since PECL memcached >= 2.0.0
124462     **/
124463    public function setSaslAuthData($username, $password){}
124464
124465    /**
124466     * Set a new expiration on an item
124467     *
124468     * {@link Memcached::touch} sets a new expiration value on the given key.
124469     *
124470     * @param string $key
124471     * @param int $expiration
124472     * @return bool
124473     * @since PECL memcached >= 2.0.0
124474     **/
124475    public function touch($key, $expiration){}
124476
124477    /**
124478     * Set a new expiration on an item on a specific server
124479     *
124480     * {@link Memcached::touchByKey} is functionally equivalent to
124481     * Memcached::touch, except that the free-form {@link server_key} can be
124482     * used to map the {@link key} to a specific server.
124483     *
124484     * @param string $server_key
124485     * @param string $key
124486     * @param int $expiration
124487     * @return bool
124488     * @since PECL memcached >= 2.0.0
124489     **/
124490    public function touchByKey($server_key, $key, $expiration){}
124491
124492}
124493class MemcachedException extends RuntimeException {
124494}
124495/**
124496 * ICU formatting documentation ICU message formatting description ICU
124497 * message formatters ICU choice formatters
124498 **/
124499class MessageFormatter {
124500    /**
124501     * Constructs a new Message Formatter
124502     *
124503     * (method)
124504     *
124505     * (constructor):
124506     *
124507     * @param string $locale The locale to use when formatting arguments
124508     * @param string $pattern The pattern string to stick arguments into.
124509     *   The pattern uses an 'apostrophe-friendly' syntax; it is run through
124510     *   umsg_autoQuoteApostrophe before being interpreted.
124511     * @return MessageFormatter The formatter object
124512     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
124513     **/
124514    public static function create($locale, $pattern){}
124515
124516    /**
124517     * Format the message
124518     *
124519     * Format the message by substituting the data into the format string
124520     * according to the locale rules
124521     *
124522     * @param array $args The message formatter
124523     * @return string The formatted string, or FALSE if an error occurred
124524     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
124525     **/
124526    public function format($args){}
124527
124528    /**
124529     * Quick format message
124530     *
124531     * Quick formatting function that formats the string without having to
124532     * explicitly create the formatter object. Use this function when the
124533     * format operation is done only once and does not need and parameters or
124534     * state to be kept.
124535     *
124536     * @param string $locale The locale to use for formatting
124537     *   locale-dependent parts
124538     * @param string $pattern The pattern string to insert things into. The
124539     *   pattern uses an 'apostrophe-friendly' syntax; it is run through
124540     *   umsg_autoQuoteApostrophe before being interpreted.
124541     * @param array $args The array of values to insert into the format
124542     *   string
124543     * @return string The formatted pattern string or FALSE if an error
124544     *   occurred
124545     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
124546     **/
124547    public static function formatMessage($locale, $pattern, $args){}
124548
124549    /**
124550     * Get the error code from last operation
124551     *
124552     * @return int The error code, one of UErrorCode values. Initial value
124553     *   is U_ZERO_ERROR.
124554     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
124555     **/
124556    public function getErrorCode(){}
124557
124558    /**
124559     * Get the error text from the last operation
124560     *
124561     * @return string Description of the last error.
124562     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
124563     **/
124564    public function getErrorMessage(){}
124565
124566    /**
124567     * Get the locale for which the formatter was created
124568     *
124569     * @return string The locale name
124570     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
124571     **/
124572    public function getLocale(){}
124573
124574    /**
124575     * Get the pattern used by the formatter
124576     *
124577     * @return string The pattern string for this message formatter
124578     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
124579     **/
124580    public function getPattern(){}
124581
124582    /**
124583     * Parse input string according to pattern
124584     *
124585     * Parses input string and return any extracted items as an array.
124586     *
124587     * @param string $value The message formatter
124588     * @return array An array containing the items extracted, or FALSE on
124589     *   error
124590     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
124591     **/
124592    public function parse($value){}
124593
124594    /**
124595     * Quick parse input string
124596     *
124597     * Parses input string without explicitly creating the formatter object.
124598     * Use this function when the format operation is done only once and does
124599     * not need and parameters or state to be kept.
124600     *
124601     * @param string $locale The locale to use for parsing locale-dependent
124602     *   parts
124603     * @param string $pattern The pattern with which to parse the {@link
124604     *   value}.
124605     * @param string $source The string to parse, conforming to the {@link
124606     *   pattern}.
124607     * @return array An array containing items extracted, or FALSE on error
124608     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
124609     **/
124610    public static function parseMessage($locale, $pattern, $source){}
124611
124612    /**
124613     * Set the pattern used by the formatter
124614     *
124615     * @param string $pattern The message formatter
124616     * @return bool
124617     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
124618     **/
124619    public function setPattern($pattern){}
124620
124621}
124622/**
124623 * A connection between PHP and MongoDB. This class extends MongoClient
124624 * and provides access to several deprecated methods. For backwards
124625 * compatibility, it also defaults the "w" option of its constructor
124626 * argument to 0, which does not require write operations to be
124627 * acknowledged by the server. See {@link MongoClient::__construct} for
124628 * more information.
124629 **/
124630class Mongo extends MongoClient {
124631    /**
124632     * Connects with a database server
124633     *
124634     * @return bool If the connection was successful.
124635     * @since PECL mongo >=0.9.0
124636     **/
124637    protected function connectUtil(){}
124638
124639    /**
124640     * Get pool size for connection pools
124641     *
124642     * @return int Returns the current pool size.
124643     * @since PECL mongo >=1.2.0
124644     **/
124645    public static function getPoolSize(){}
124646
124647    /**
124648     * Returns the address being used by this for slaveOkay reads
124649     *
124650     * This finds the address of the secondary currently being used for
124651     * reads. It is a read-only method: it does not change anything about the
124652     * internal state of the object.
124653     *
124654     * When you create a connection to the database, the driver will not
124655     * immediately decide on a secondary to use. Thus, after you connect,
124656     * this function will return NULL even if there are secondaries
124657     * available. When you first do a query with slaveOkay set, at that point
124658     * the driver will choose a secondary for this connection. At that point,
124659     * this function will return the chosen secondary.
124660     *
124661     * See the query section of this manual for information on distributing
124662     * reads to secondaries.
124663     *
124664     * @return string The address of the secondary this connection is using
124665     *   for reads.
124666     * @since PECL mongo >=1.1.0
124667     **/
124668    public function getSlave(){}
124669
124670    /**
124671     * Get slaveOkay setting for this connection
124672     *
124673     * See the query section of this manual for information on distributing
124674     * reads to secondaries.
124675     *
124676     * @return bool Returns the value of slaveOkay for this instance.
124677     * @since PECL mongo >=1.1.0
124678     **/
124679    public function getSlaveOkay(){}
124680
124681    /**
124682     * Returns information about all connection pools
124683     *
124684     * Returns an array of information about all connection pools.
124685     *
124686     * @return array Each connection pool has an identifier, which starts
124687     *   with the host. For each pool, this function shows the following
124688     *   fields: {@link in use} The number of connections currently being
124689     *   used by MongoClient instances. {@link in pool} The number of
124690     *   connections currently in the pool (not being used). {@link
124691     *   remaining} The number of connections that could be created by this
124692     *   pool. For example, suppose a pool had 5 connections remaining and 3
124693     *   connections in the pool. We could create 8 new instances of
124694     *   MongoClient before we exhausted this pool (assuming no instances of
124695     *   MongoClient went out of scope, returning their connections to the
124696     *   pool). A negative number means that this pool will spawn unlimited
124697     *   connections. Before a pool is created, you can change the max number
124698     *   of connections by calling {@link Mongo::setPoolSize}. Once a pool is
124699     *   showing up in the output of this function, its size cannot be
124700     *   changed. {@link timeout} The socket timeout for connections in this
124701     *   pool. This is how long connections in this pool will attempt to
124702     *   connect to a server before giving up.
124703     * @since PECL mongo >=1.2.0
124704     **/
124705    public function poolDebug(){}
124706
124707    /**
124708     * Set the size for future connection pools
124709     *
124710     * Sets the max number of connections new pools will be able to create.
124711     *
124712     * @param int $size The max number of connections future pools will be
124713     *   able to create. Negative numbers mean that the pool will spawn an
124714     *   infinite number of connections.
124715     * @return bool Returns the former value of pool size.
124716     * @since PECL mongo >=1.2.0
124717     **/
124718    public static function setPoolSize($size){}
124719
124720    /**
124721     * Change slaveOkay setting for this connection
124722     *
124723     * See the query section of this manual for information on distributing
124724     * reads to secondaries.
124725     *
124726     * @param bool $ok If reads should be sent to secondary members of a
124727     *   replica set for all possible queries using this MongoClient
124728     *   instance.
124729     * @return bool Returns the former value of slaveOkay for this
124730     *   instance.
124731     * @since PECL mongo >=1.1.0
124732     **/
124733    public function setSlaveOkay($ok){}
124734
124735    /**
124736     * Choose a new secondary for slaveOkay reads
124737     *
124738     * This choses a random secondary for a connection to read from. It is
124739     * called automatically by the driver and should not need to be used. It
124740     * calls {@link MongoClient::getHosts} (to refresh the status of hosts)
124741     * and {@link Mongo::getSlave} (to get the return value).
124742     *
124743     * See the query section of this manual for information on distributing
124744     * reads to secondaries.
124745     *
124746     * @return string The address of the secondary this connection is using
124747     *   for reads. This may be the same as the previous address as addresses
124748     *   are randomly chosen. It may return only one address if only one
124749     *   secondary (or only the primary) is available.
124750     * @since PECL mongo >=1.1.0
124751     **/
124752    public function switchSlave(){}
124753
124754}
124755/**
124756 * An object that can be used to store or retrieve binary data from the
124757 * database. The maximum size of a single object that can be inserted
124758 * into the database is 16MB. For data that is larger than this (movies,
124759 * music, Henry Kissinger's autobiography), use MongoGridFS. For data
124760 * that is smaller than 16MB, you may find it easier to embed it within
124761 * the document using MongoBinData. For example, to embed an image in a
124762 * document, one could write: This class contains a type field, which
124763 * currently gives no additional functionality in the PHP driver or the
124764 * database. There are seven predefined types, which are defined as class
124765 * constants below. For backwards compatibility, the PHP driver uses
124766 * MongoBinData::BYTE_ARRAY as the default; however, this may change to
124767 * MongoBinData::GENERIC in the future. Users are encouraged to specify a
124768 * type in {@link MongoBinData::__construct}.
124769 **/
124770class MongoBinData {
124771    /**
124772     * @var int
124773     **/
124774    const BYTE_ARRAY = 0;
124775
124776    /**
124777     * @var int
124778     **/
124779    const CUSTOM = 0;
124780
124781    /**
124782     * @var int
124783     **/
124784    const FUNC = 0;
124785
124786    /**
124787     * @var int
124788     **/
124789    const GENERIC = 0;
124790
124791    /**
124792     * @var int
124793     **/
124794    const MD5 = 0;
124795
124796    /**
124797     * @var int
124798     **/
124799    const UUID = 0;
124800
124801    /**
124802     * @var int
124803     **/
124804    const UUID_RFC4122 = 0;
124805
124806    /**
124807     * @var string
124808     **/
124809    public $bin;
124810
124811    /**
124812     * @var int
124813     **/
124814    public $type;
124815
124816    /**
124817     * Creates a new binary data object
124818     *
124819     * There are seven types of binary data currently recognized by the BSON
124820     * spec, which are defined as class constants. For backwards
124821     * compatibility, the PHP driver uses MongoBinData::BYTE_ARRAY as the
124822     * default; however, this may change to MongoBinData::GENERIC in the
124823     * future. Users are encouraged to specify a type instead of relying on
124824     * the default.
124825     *
124826     * @param string $data Binary data.
124827     * @param int $type Data type.
124828     * @since PECL mongo >= 0.8.1
124829     **/
124830    public function __construct($data, $type){}
124831
124832    /**
124833     * The string representation of this binary data object
124834     *
124835     * @return string Returns the string "<Mongo Binary Data>". To access
124836     *   the contents of a MongoBinData, use the bin field.
124837     * @since PECL mongo >= 0.8.1
124838     **/
124839    public function __toString(){}
124840
124841}
124842/**
124843 * A connection manager for PHP and MongoDB. This class is used to create
124844 * and manage connections. A typical use is: MongoClient basic usage
124845 *
124846 * See {@link MongoClient::__construct} and the section on connecting for
124847 * more information about creating connections.
124848 **/
124849class MongoClient {
124850    /**
124851     * @var string
124852     **/
124853    const DEFAULT_HOST = '';
124854
124855    /**
124856     * @var int
124857     **/
124858    const DEFAULT_PORT = 0;
124859
124860    /**
124861     * @var string
124862     **/
124863    const RP_NEAREST = '';
124864
124865    /**
124866     * @var string
124867     **/
124868    const RP_PRIMARY = '';
124869
124870    /**
124871     * @var string
124872     **/
124873    const RP_PRIMARY_PREFERRED = '';
124874
124875    /**
124876     * @var string
124877     **/
124878    const RP_SECONDARY = '';
124879
124880    /**
124881     * @var string
124882     **/
124883    const RP_SECONDARY_PREFERRED = '';
124884
124885    /**
124886     * @var string
124887     **/
124888    const VERSION = '';
124889
124890    /**
124891     * @var boolean
124892     **/
124893    public $connected;
124894
124895    /**
124896     * @var boolean
124897     **/
124898    protected $persistent;
124899
124900    /**
124901     * @var string
124902     **/
124903    protected $server;
124904
124905    /**
124906     * @var string
124907     **/
124908    public $status;
124909
124910    /**
124911     * Closes this connection
124912     *
124913     * The {@link MongoClient::close} method forcefully closes a connection
124914     * to the database, even if persistent connections are being used. You
124915     * should never have to do this under normal circumstances.
124916     *
124917     * @param boolean|string $connection If connection is not given, or
124918     *   FALSE then connection that would be selected for writes would be
124919     *   closed. In a single-node configuration, that is then the whole
124920     *   connection, but if you are connected to a replica set, close() will
124921     *   only close the connection to the primary server. If connection is
124922     *   TRUE then all connections as known by the connection manager will be
124923     *   closed. This can include connections that are not referenced in the
124924     *   connection string used to create the object that you are calling
124925     *   close on. If connection is a string argument, then it will only
124926     *   close the connection identified by this hash. Hashes are identifiers
124927     *   for a connection and can be obtained by calling {@link
124928     *   MongoClient::getConnections}.
124929     * @return bool Returns if the connection was successfully closed.
124930     * @since PECL mongo >=1.3.0
124931     **/
124932    public function close($connection){}
124933
124934    /**
124935     * Connects to a database server
124936     *
124937     * @return bool If the connection was successful.
124938     * @since PECL mongo >=1.3.0
124939     **/
124940    public function connect(){}
124941
124942    /**
124943     * Drops a database [deprecated]
124944     *
124945     * @param mixed $db The database to drop. Can be a MongoDB object or
124946     *   the name of the database.
124947     * @return array Returns the database response.
124948     * @since PECL mongo >=1.3.0
124949     **/
124950    public function dropDB($db){}
124951
124952    /**
124953     * Return info about all open connections
124954     *
124955     * Returns an array of all open connections, and information about each
124956     * of the servers
124957     *
124958     * @return array An array of open connections.
124959     * @since PECL mongo >=1.3.0
124960     **/
124961    public static function getConnections(){}
124962
124963    /**
124964     * Updates status for all associated hosts
124965     *
124966     * This method is only useful with a connection to a replica set. It
124967     * returns the status of all of the hosts in the set. Without a replica
124968     * set, it will just return an array with one element containing the host
124969     * that you are connected to.
124970     *
124971     * See the query section of this manual for information on distributing
124972     * reads to secondaries.
124973     *
124974     * @return array Returns an array of information about the hosts in the
124975     *   set. Includes each host's hostname, its health (1 is healthy), its
124976     *   state (1 is primary, 2 is secondary, 0 is anything else), the amount
124977     *   of time it took to ping the server, and when the last ping occurred.
124978     *   For example, on a three-member replica set, it might look something
124979     *   like:
124980     * @since PECL mongo >=1.3.0
124981     **/
124982    public function getHosts(){}
124983
124984    /**
124985     * Get the read preference for this connection
124986     *
124987     * @return array
124988     * @since PECL mongo >=1.3.0
124989     **/
124990    public function getReadPreference(){}
124991
124992    /**
124993     * Get the write concern for this connection
124994     *
124995     * @return array
124996     * @since PECL mongo >=1.5.0
124997     **/
124998    public function getWriteConcern(){}
124999
125000    /**
125001     * Kills a specific cursor on the server
125002     *
125003     * In certain situations it might be needed to kill a cursor on the
125004     * server. Usually cursors time out after 10 minutes of inactivity, but
125005     * it is possible to create an immortal cursor with MongoCursor::immortal
125006     * that never times out. In order to be able to kill such an immortal
125007     * cursor, you can call this method with the information supplied by
125008     * MongoCursor::info.
125009     *
125010     * @param string $server_hash The server hash that has the cursor. This
125011     *   can be obtained through MongoCursor::info.
125012     * @param int|MongoInt64 $id The ID of the cursor to kill. You can
125013     *   either supply an int containing the 64 bit cursor ID, or an object
125014     *   of the MongoInt64 class. The latter is necessary on 32 bit platforms
125015     *   (and Windows).
125016     * @return bool Returns TRUE if the method attempted to kill a cursor,
125017     *   and FALSE if there was something wrong with the arguments (such as a
125018     *   wrong {@link server_hash}). The return status does not reflect where
125019     *   the cursor was actually killed as the server does not provide that
125020     *   information.
125021     * @since PECL mongo >=1.5.0
125022     **/
125023    public function killCursor($server_hash, $id){}
125024
125025    /**
125026     * Lists all of the databases available
125027     *
125028     * @return array Returns an associative array containing three fields.
125029     *   The first field is databases, which in turn contains an array. Each
125030     *   element of the array is an associative array corresponding to a
125031     *   database, giving th database's name, size, and if it's empty. The
125032     *   other two fields are totalSize (in bytes) and ok, which is 1 if this
125033     *   method ran successfully.
125034     * @since PECL mongo >=1.3.0
125035     **/
125036    public function listDBs(){}
125037
125038    /**
125039     * Gets a database collection
125040     *
125041     * @param string $db The database name.
125042     * @param string $collection The collection name.
125043     * @return MongoCollection Returns a new collection object.
125044     * @since PECL mongo >=1.3.0
125045     **/
125046    public function selectCollection($db, $collection){}
125047
125048    /**
125049     * Gets a database
125050     *
125051     * @param string $name The database name.
125052     * @return MongoDB Returns a new database object.
125053     * @since PECL mongo >=1.3.0
125054     **/
125055    public function selectDB($name){}
125056
125057    /**
125058     * Set the read preference for this connection
125059     *
125060     * @param string $read_preference
125061     * @param array $tags
125062     * @return bool
125063     * @since PECL mongo >=1.3.0
125064     **/
125065    public function setReadPreference($read_preference, $tags){}
125066
125067    /**
125068     * Set the write concern for this connection
125069     *
125070     * @param mixed $w
125071     * @param int $wtimeout
125072     * @return bool
125073     * @since PECL mongo >=1.5.0
125074     **/
125075    public function setWriteConcern($w, $wtimeout){}
125076
125077    /**
125078     * Gets a database
125079     *
125080     * This is the cleanest way of getting a database. If the database name
125081     * has any special characters, {@link MongoClient::selectDB} will need to
125082     * be used; however, this should be sufficient for most cases.
125083     *
125084     * <?php
125085     *
125086     * $mongo = new MongoClient();
125087     *
125088     * // the following two lines are equivalent $db =
125089     * $mongo->selectDB("foo"); $db = $mongo->foo;
125090     *
125091     * ?>
125092     *
125093     * @param string $dbname The database name.
125094     * @return MongoDB Returns a new db object.
125095     * @since PECL mongo >=1.3.0
125096     **/
125097    public function __get($dbname){}
125098
125099    /**
125100     * String representation of this connection
125101     *
125102     * @return string Returns hostname and port for this connection.
125103     * @since PECL mongo >=1.3.0
125104     **/
125105    public function __toString(){}
125106
125107}
125108/**
125109 * Represents JavaScript code for the database. MongoCode objects are
125110 * composed of two parts: a string of code and an optional scope. The
125111 * string of code must be valid JavaScript. The scope is a associative
125112 * array of variable name/value pairs.
125113 **/
125114class MongoCode {
125115    /**
125116     * Creates a new code object
125117     *
125118     * @param string $code A string of code.
125119     * @param array $scope The scope to use for the code.
125120     * @since PECL mongo >= 0.8.3
125121     **/
125122    public function __construct($code, $scope){}
125123
125124    /**
125125     * Returns this code as a string
125126     *
125127     * @return string This code, the scope is not returned.
125128     * @since PECL mongo >= 0.8.3
125129     **/
125130    public function __toString(){}
125131
125132}
125133/**
125134 * Represents a MongoDB collection. Collection names can use any
125135 * character in the ASCII set. Some valid collection names are , ..., my
125136 * collection, and *&#@. User-defined collection names cannot contain the
125137 * $ symbol. There are certain system collections which use a $ in their
125138 * names (e.g., local.oplog.$main), but it is a reserved character. If
125139 * you attempt to create and use a collection with a $ in the name,
125140 * MongoDB will assert.
125141 **/
125142class MongoCollection extends MongoCollection {
125143    /**
125144     * @var int
125145     **/
125146    const ASCENDING = 0;
125147
125148    /**
125149     * @var int
125150     **/
125151    const DESCENDING = 0;
125152
125153    /**
125154     * @var MongoDB
125155     **/
125156    public $db;
125157
125158    /**
125159     * @var integer
125160     **/
125161    public $w;
125162
125163    /**
125164     * @var integer
125165     **/
125166    public $wtimeout;
125167
125168    /**
125169     * Perform an aggregation using the aggregation framework
125170     *
125171     * The MongoDB aggregation framework provides a means to calculate
125172     * aggregated values without having to use MapReduce. While MapReduce is
125173     * powerful, it is often more difficult than necessary for many simple
125174     * aggregation tasks, such as totaling or averaging field values.
125175     *
125176     * This method accepts either a variable amount of pipeline operators, or
125177     * a single array of operators constituting the pipeline.
125178     *
125179     * @param array $pipeline An array of pipeline operators.
125180     * @param array $options Options for the aggregation command. Valid
125181     *   options include:
125182     * @return array The result of the aggregation as an array. The ok will
125183     *   be set to 1 on success, 0 on failure.
125184     * @since PECL mongo >=1.3.0
125185     **/
125186    public function aggregate($pipeline, $options){}
125187
125188    /**
125189     * Execute an aggregation pipeline command and retrieve results through a
125190     * cursor
125191     *
125192     * With this method you can execute Aggregation Framework pipelines and
125193     * retrieve the results through a cursor, instead of getting just one
125194     * document back as you would with MongoCollection::aggregate. This
125195     * method returns a MongoCommandCursor object. This cursor object
125196     * implements the Iterator interface just like the MongoCursor objects
125197     * that are returned by the MongoCollection::find method.
125198     *
125199     * @param array $command The Aggregation Framework pipeline to execute.
125200     * @param array $options Options for the aggregation command. Valid
125201     *   options include:
125202     * @return MongoCommandCursor Returns a MongoCommandCursor object.
125203     *   Because this implements the Iterator interface you can iterate over
125204     *   each of the results as returned by the command query. The
125205     *   MongoCommandCursor also implements the MongoCursorInterface
125206     *   interface which adds the MongoCommandCursor::batchSize,
125207     *   MongoCommandCursor::dead, MongoCommandCursor::info methods.
125208     * @since PECL mongo >=1.5.0
125209     **/
125210    public function aggregateCursor($command, $options){}
125211
125212    /**
125213     * Inserts multiple documents into this collection
125214     *
125215     * @param array $a An array of arrays or objects. If any objects are
125216     *   used, they may not have protected or private properties.
125217     * @param array $options An array of options for the batch of insert
125218     *   operations. Currently available options include: "continueOnError"
125219     *   Boolean, defaults to FALSE. If set, the database will not stop
125220     *   processing a bulk insert if one fails (eg due to duplicate IDs).
125221     *   This makes bulk insert behave similarly to a series of single
125222     *   inserts, except that calling {@link MongoDB::lastError} will have an
125223     *   error set if any insert fails, not just the last one. If multiple
125224     *   errors occur, only the most recent will be reported by {@link
125225     *   MongoDB::lastError}. Please note that continueOnError affects errors
125226     *   on the database side only. If you try to insert a document that has
125227     *   errors (for example it contains a key with an empty name), then the
125228     *   document is not even transferred to the database as the driver
125229     *   detects this error and bails out. continueOnError has no effect on
125230     *   errors detected in the documents by the driver. The following
125231     *   options are deprecated and should no longer be used:
125232     * @return mixed If the w parameter is set to acknowledge the write,
125233     *   returns an associative array with the status of the inserts ("ok")
125234     *   and any error that may have occurred ("err"). Otherwise, returns
125235     *   TRUE if the batch insert was successfully sent, FALSE otherwise.
125236     * @since PECL mongo >=0.9.0
125237     **/
125238    public function batchInsert($a, $options){}
125239
125240    /**
125241     * Counts the number of documents in this collection
125242     *
125243     * @param array $query Associative array or object with fields to
125244     *   match.
125245     * @param array $options An array of options for the index creation.
125246     *   Currently available options include: hint mixed Index to use for the
125247     *   query. If a string is passed, it should correspond to an index name.
125248     *   If an array or object is passed, it should correspond to the
125249     *   specification used to create the index (i.e. the first argument to
125250     *   {@link MongoCollection::createIndex}). This option is only supported
125251     *   in MongoDB 2.6+. limit integer The maximum number of matching
125252     *   documents to return. maxTimeMS integer Specifies a cumulative time
125253     *   limit in milliseconds for processing the operation (does not include
125254     *   idle time). If the operation is not completed within the timeout
125255     *   period, a MongoExecutionTimeoutException will be thrown. This option
125256     *   is only supported in MongoDB 2.6+. skip integer The number of
125257     *   matching documents to skip before returning results.
125258     * @return int Returns the number of documents matching the query.
125259     * @since PECL mongo >=0.9.0
125260     **/
125261    public function count($query, $options){}
125262
125263    /**
125264     * Creates a database reference
125265     *
125266     * @param mixed $document_or_id If an array or object is given, its _id
125267     *   field will be used as the reference ID. If a MongoId or scalar is
125268     *   given, it will be used as the reference ID.
125269     * @return array Returns a database reference array.
125270     * @since PECL mongo >=0.9.0
125271     **/
125272    public function createDBRef($document_or_id){}
125273
125274    /**
125275     * Creates an index on the specified field(s) if it does not already
125276     * exist
125277     *
125278     * Creates an index on the specified field(s) if it does not already
125279     * exist. Fields may be indexed with a direction (e.g. ascending or
125280     * descending) or a special type (e.g. text, geospatial, hashed).
125281     *
125282     * @param array $keys An array specifying the index's fields as its
125283     *   keys. For each field, the value is either the index direction or
125284     *   index type. If specifying direction, specify 1 for ascending or -1
125285     *   for descending.
125286     * @param array $options An array of options for the index creation. We
125287     *   pass all given options straight to the server, but a non-exhaustive
125288     *   list of currently available options include: The following option
125289     *   may be used with MongoDB 2.6+: The following options may be used
125290     *   with MongoDB versions before 2.8: The following options may be used
125291     *   with MongoDB versions before 2.6: The following options are
125292     *   deprecated and should no longer be used:
125293     * @return bool Returns an array containing the status of the index
125294     *   creation. The array contains whether the operation succeeded ("ok"),
125295     *   the number of indexes before and after the operation
125296     *   ("numIndexesBefore" and "numIndexesAfter"), and whether the
125297     *   collection that the index belongs to has been created
125298     *   ("createdCollectionAutomatically"). If the index already existed and
125299     *   did not need to be created, a "note" field may be present in lieu of
125300     *   "numIndexesAfter".
125301     * @since PECL mongo >=1.5.0
125302     **/
125303    public function createIndex($keys, $options){}
125304
125305    /**
125306     * Deletes an index from this collection
125307     *
125308     * This method is identical to:
125309     *
125310     * Each index is given a unique name when it is created. This is often
125311     * generated by the driver based on the index key(s) and order/type, but
125312     * custom names may also be specified with {@link
125313     * MongoCollection::createIndex}'s "name" option).
125314     *
125315     * Unfortunately, {@link MongoCollection::deleteIndex} cannot delete
125316     * custom-named indexes due to a backwards compatibility issue. When a
125317     * string argument is provided, it is assumed to be the single field name
125318     * in an ascending index (e.g. the name "x_1" would be used for the
125319     * argument "x"). If an array or object is provided, an index name is
125320     * generated just as if that argument was passed to {@link
125321     * MongoCollection::createIndex}.
125322     *
125323     * In order to delete a custom-named index with the PHP driver, the
125324     * deleteIndexes database command must be used. For instance, an index
125325     * named "myIndex" could be deleted with the PHP driver by running:
125326     *
125327     * To determine the name of an index with the PHP driver, you can query
125328     * the system.indexes collection of a database and look for the "name"
125329     * field of each result. The "ns" field will indicate the collection to
125330     * which each index belongs.
125331     *
125332     * @param string|array $keys An array specifying the index's fields as
125333     *   its keys. For each field, the value is either the index direction or
125334     *   index type. If specifying direction, specify 1 for ascending or -1
125335     *   for descending. If a string is provided, it is assumed to be the
125336     *   single field name in an ascending index.
125337     * @return array Returns the database response.
125338     * @since PECL mongo >=0.9.0
125339     **/
125340    public function deleteIndex($keys){}
125341
125342    /**
125343     * Delete all indices for this collection
125344     *
125345     * @return array Returns the database response.
125346     * @since PECL mongo >=0.9.0
125347     **/
125348    public function deleteIndexes(){}
125349
125350    /**
125351     * Retrieve a list of distinct values for the given key across a
125352     * collection
125353     *
125354     * The distinct command returns a list of distinct values for the given
125355     * key across a collection.
125356     *
125357     * @param string $key The key to use.
125358     * @param array $query An optional query parameters
125359     * @return array Returns an array of distinct values,
125360     * @since PECL mongo >=1.2.11
125361     **/
125362    public function distinct($key, $query){}
125363
125364    /**
125365     * Drops this collection
125366     *
125367     * Drops this collection and deletes its indices.
125368     *
125369     * @return array Returns the database response.
125370     * @since PECL mongo >=0.9.0
125371     **/
125372    public function drop(){}
125373
125374    /**
125375     * Creates an index on the specified field(s) if it does not already
125376     * exist
125377     *
125378     * Creates an index on the specified field(s) if it does not already
125379     * exist. Fields may be indexed with a direction (e.g. ascending or
125380     * descending) or a special type (e.g. text, geospatial, hashed).
125381     *
125382     * @param string|array $key An array specifying the index's fields as
125383     *   its keys. For each field, the value is either the index direction or
125384     *   index type. If specifying direction, specify 1 for ascending or -1
125385     *   for descending.
125386     * @param array $options An array of options for the index creation.
125387     *   Currently available options include: The following option may be
125388     *   used with MongoDB 2.6+: The following options may be used with
125389     *   MongoDB versions before 2.8: The following options may be used with
125390     *   MongoDB versions before 2.6: The following options are deprecated
125391     *   and should no longer be used:
125392     * @return bool Returns an array containing the status of the index
125393     *   creation. The array contains whether the operation succeeded ("ok"),
125394     *   the number of indexes before and after the operation
125395     *   ("numIndexesBefore" and "numIndexesAfter"), and whether the
125396     *   collection that the index belongs to has been created
125397     *   ("createdCollectionAutomatically"). If the index already existed and
125398     *   did not need to be created, a "note" field may be present in lieu of
125399     *   "numIndexesAfter".
125400     * @since PECL mongo >=0.9.0
125401     **/
125402    public function ensureIndex($key, $options){}
125403
125404    /**
125405     * Queries this collection, returning a for the result set
125406     *
125407     * @param array $query The fields for which to search. MongoDB's query
125408     *   language is quite extensive. The PHP driver will in almost all cases
125409     *   pass the query straight through to the server, so reading the
125410     *   MongoDB core docs on find is a good idea.
125411     * @param array $fields Fields of the results to return. The array is
125412     *   in the format array('fieldname' => true, 'fieldname2' => true). The
125413     *   _id field is always returned.
125414     * @return MongoCursor Returns a cursor for the search results.
125415     * @since PECL mongo >=0.9.0
125416     **/
125417    public function find($query, $fields){}
125418
125419    /**
125420     * Update a document and return it
125421     *
125422     * The findAndModify command atomically modifies and returns a single
125423     * document. By default, the returned document does not include the
125424     * modifications made on the update. To return the document with the
125425     * modifications made on the update, use the new option.
125426     *
125427     * @param array $query The query criteria to search for.
125428     * @param array $update The update criteria.
125429     * @param array $fields Optionally only return these fields.
125430     * @param array $options An array of options to apply, such as remove
125431     *   the match document from the DB and return it. Option sort array
125432     *   Determines which document the operation will modify if the query
125433     *   selects multiple documents. findAndModify will modify the first
125434     *   document in the sort order specified by this argument. remove
125435     *   boolean Optional if update field exists. When TRUE, removes the
125436     *   selected document. The default is FALSE. update array Optional if
125437     *   remove field exists. Performs an update of the selected document.
125438     *   new boolean Optional. When TRUE, returns the modified document
125439     *   rather than the original. The findAndModify method ignores the new
125440     *   option for remove operations. The default is FALSE. upsert boolean
125441     *   Optional. Used in conjunction with the update field. When TRUE, the
125442     *   findAndModify command creates a new document if the query returns no
125443     *   documents. The default is false. In MongoDB 2.2, the findAndModify
125444     *   command returns NULL when upsert is TRUE.
125445     * @return array Returns the original document, or the modified
125446     *   document when new is set.
125447     * @since PECL mongo >=1.3.0
125448     **/
125449    public function findAndModify($query, $update, $fields, $options){}
125450
125451    /**
125452     * Queries this collection, returning a single element
125453     *
125454     * As opposed to {@link MongoCollection::find}, this method will return
125455     * only the first result from the result set, and not a MongoCursor that
125456     * can be iterated over.
125457     *
125458     * @param array $query The fields for which to search. MongoDB's query
125459     *   language is quite extensive. The PHP driver will in almost all cases
125460     *   pass the query straight through to the server, so reading the
125461     *   MongoDB core docs on find is a good idea.
125462     * @param array $fields Fields of the results to return. The array is
125463     *   in the format array('fieldname' => true, 'fieldname2' => true). The
125464     *   _id field is always returned.
125465     * @param array $options This parameter is an associative array of the
125466     *   form array("name" => <value>, ...). Currently supported options are:
125467     * @return array Returns record matching the search or NULL.
125468     * @since PECL mongo >=0.9.0
125469     **/
125470    public function findOne($query, $fields, $options){}
125471
125472    /**
125473     * Fetches the document pointed to by a database reference
125474     *
125475     * @param array $ref A database reference.
125476     * @return array Returns the database document pointed to by the
125477     *   reference.
125478     * @since PECL mongo >=0.9.0
125479     **/
125480    public function getDBRef($ref){}
125481
125482    /**
125483     * Returns information about indexes on this collection
125484     *
125485     * @return array This function returns an array in which each element
125486     *   describes an index. Elements will contain the values name for the
125487     *   name of the index, ns for the namespace (a combination of the
125488     *   database and collection name), and key for a list of all fields in
125489     *   the index and their ordering. Additional values may be present for
125490     *   special indexes, such as unique or sparse.
125491     * @since PECL mongo >=0.9.0
125492     **/
125493    public function getIndexInfo(){}
125494
125495    /**
125496     * Returns this collections name
125497     *
125498     * @return string Returns the name of this collection.
125499     * @since PECL mongo >=0.9.0
125500     **/
125501    public function getName(){}
125502
125503    /**
125504     * Get the read preference for this collection
125505     *
125506     * @return array
125507     * @since PECL mongo >=1.3.0
125508     **/
125509    public function getReadPreference(){}
125510
125511    /**
125512     * Get slaveOkay setting for this collection
125513     *
125514     * See the query section of this manual for information on distributing
125515     * reads to secondaries.
125516     *
125517     * @return bool Returns the value of slaveOkay for this instance.
125518     * @since PECL mongo >=1.1.0
125519     **/
125520    public function getSlaveOkay(){}
125521
125522    /**
125523     * Get the write concern for this collection
125524     *
125525     * @return array
125526     * @since PECL mongo >=1.5.0
125527     **/
125528    public function getWriteConcern(){}
125529
125530    /**
125531     * Performs an operation similar to SQL's GROUP BY command
125532     *
125533     * @param mixed $keys Fields to group by. If an array or non-code
125534     *   object is passed, it will be the key used to group results. 1.0.4+:
125535     *   If {@link keys} is an instance of MongoCode, {@link keys} will be
125536     *   treated as a function that returns the key to group by (see the
125537     *   "Passing a {@link keys} function" example below).
125538     * @param array $initial Initial value of the aggregation counter
125539     *   object.
125540     * @param MongoCode $reduce A function that takes two arguments (the
125541     *   current document and the aggregation to this point) and does the
125542     *   aggregation.
125543     * @param array $options Optional parameters to the group command.
125544     *   Valid options include:
125545     * @return array Returns an array containing the result.
125546     * @since PECL mongo >=0.9.2
125547     **/
125548    public function group($keys, $initial, $reduce, $options){}
125549
125550    /**
125551     * Inserts a document into the collection
125552     *
125553     * All strings sent to the database must be UTF-8. If a string is not
125554     * UTF-8, a MongoException will be thrown. To insert (or query for) a
125555     * non-UTF-8 string, use MongoBinData.
125556     *
125557     * @param array|object $document An array or object. If an object is
125558     *   used, it may not have protected or private properties.
125559     * @param array $options An array of options for the insert operation.
125560     *   Currently available options include: The following options are
125561     *   deprecated and should no longer be used:
125562     * @return bool|array Returns an array containing the status of the
125563     *   insertion if the "w" option is set. Otherwise, returns TRUE if the
125564     *   inserted array is not empty (a MongoException will be thrown if the
125565     *   inserted array is empty).
125566     * @since PECL mongo >=0.9.0
125567     **/
125568    public function insert($document, $options){}
125569
125570    /**
125571     * Returns an array of cursors to iterator over a full collection in
125572     * parallel
125573     *
125574     * This method returns an array of a maximum of num_cursors cursors. An
125575     * iteration over one of the returned cursors results in a partial set of
125576     * documents for a collection. Iteration over all the returned cursors
125577     * results in getting every document back from the collection.
125578     *
125579     * This method is a wrapper for the parallelCollectionScan MongoDB
125580     * command.
125581     *
125582     * @param int $num_cursors The number of cursors to request from the
125583     *   server. Please note, that the server can return less cursors than
125584     *   you requested.
125585     * @return array[MongoCommandCursor] Returns an array of
125586     *   MongoCommandCursor objects.
125587     * @since PECL mongo >=1.5.0
125588     **/
125589    public function parallelCollectionScan($num_cursors){}
125590
125591    /**
125592     * Remove records from this collection
125593     *
125594     * @param array $criteria Query criteria for the documents to delete.
125595     * @param array $options An array of options for the remove operation.
125596     *   Currently available options include: "justOne" Specify TRUE to limit
125597     *   deletion to just one document. If FALSE or omitted, all documents
125598     *   matching the criteria will be deleted. The following options are
125599     *   deprecated and should no longer be used:
125600     * @return bool|array Returns an array containing the status of the
125601     *   removal if the "w" option is set. Otherwise, returns TRUE.
125602     * @since PECL mongo >=0.9.0
125603     **/
125604    public function remove($criteria, $options){}
125605
125606    /**
125607     * Saves a document to this collection
125608     *
125609     * If the object is from the database, update the existing database
125610     * object, otherwise insert this object.
125611     *
125612     * @param array|object $document Array or object to save. If an object
125613     *   is used, it may not have protected or private properties.
125614     * @param array $options Options for the save.
125615     * @return mixed If {@link w} was set, returns an array containing the
125616     *   status of the save. Otherwise, returns a boolean representing if the
125617     *   array was not empty (an empty array will not be inserted).
125618     * @since PECL mongo >=0.9.0
125619     **/
125620    public function save($document, $options){}
125621
125622    /**
125623     * Set the read preference for this collection
125624     *
125625     * @param string $read_preference
125626     * @param array $tags
125627     * @return bool
125628     * @since PECL mongo >=1.3.0
125629     **/
125630    public function setReadPreference($read_preference, $tags){}
125631
125632    /**
125633     * Change slaveOkay setting for this collection
125634     *
125635     * See the query section of this manual for information on distributing
125636     * reads to secondaries.
125637     *
125638     * @param bool $ok If reads should be sent to secondary members of a
125639     *   replica set for all possible queries using this MongoCollection
125640     *   instance.
125641     * @return bool Returns the former value of slaveOkay for this
125642     *   instance.
125643     * @since PECL mongo >=1.1.0
125644     **/
125645    public function setSlaveOkay($ok){}
125646
125647    /**
125648     * Set the write concern for this database
125649     *
125650     * @param mixed $w
125651     * @param int $wtimeout
125652     * @return bool
125653     * @since PECL mongo >=1.5.0
125654     **/
125655    public function setWriteConcern($w, $wtimeout){}
125656
125657    /**
125658     * Converts keys specifying an index to its identifying string
125659     *
125660     * @param mixed $keys Field or fields to convert to the identifying
125661     *   string
125662     * @return string Returns a string that describes the index.
125663     * @since PECL mongo >=0.9.0
125664     **/
125665    static protected function toIndexString($keys){}
125666
125667    /**
125668     * Update records based on a given criteria
125669     *
125670     * @param array $criteria Query criteria for the documents to update.
125671     * @param array $new_object The object used to update the matched
125672     *   documents. This may either contain update operators (for modifying
125673     *   specific fields) or be a replacement document.
125674     * @param array $options An array of options for the update operation.
125675     *   Currently available options include: "upsert" If no document matches
125676     *   {@link $criteria}, a new document will be inserted. If a new
125677     *   document would be inserted and {@link $new_object} contains atomic
125678     *   modifiers (i.e. $ operators), those operations will be applied to
125679     *   the {@link $criteria} parameter to create the new document. If
125680     *   {@link $new_object} does not contain atomic modifiers, it will be
125681     *   used as-is for the inserted document. See the upsert examples below
125682     *   for more information. "multiple" All documents matching $criteria
125683     *   will be updated. {@link MongoCollection::update} has exactly the
125684     *   opposite behavior of {@link MongoCollection::remove}: it updates one
125685     *   document by default, not all matching documents. It is recommended
125686     *   that you always specify whether you want to update multiple
125687     *   documents or a single document, as the database may change its
125688     *   default behavior at some point in the future. The following options
125689     *   are deprecated and should no longer be used:
125690     * @return bool|array Returns an array containing the status of the
125691     *   update if the "w" option is set. Otherwise, returns TRUE.
125692     * @since PECL mongo >=0.9.0
125693     **/
125694    public function update($criteria, $new_object, $options){}
125695
125696    /**
125697     * Validates this collection
125698     *
125699     * @param bool $scan_data Only validate indices, not the base
125700     *   collection.
125701     * @return array Returns the databases evaluation of this object.
125702     * @since PECL mongo >=0.9.0
125703     **/
125704    public function validate($scan_data){}
125705
125706    /**
125707     * Creates a new collection
125708     *
125709     * @param MongoDB $db Parent database.
125710     * @param string $name Name for this collection.
125711     * @since PECL mongo >=0.9.0
125712     **/
125713    public function __construct($db, $name){}
125714
125715    /**
125716     * Gets a collection
125717     *
125718     * A concise syntax for getting a collection with a dot-separated name.
125719     * If a collection name contains strange characters, you may have to use
125720     * {@link MongoDB::selectCollection} instead.
125721     *
125722     * <?php
125723     *
125724     * $mongo = new MongoClient();
125725     *
125726     * // the following two lines are equivalent $collection =
125727     * $mongo->selectDB("foo")->selectCollection("bar.baz"); $collection =
125728     * $mongo->foo->bar->baz;
125729     *
125730     * ?>
125731     *
125732     * @param string $name The next string in the collection name.
125733     * @return MongoCollection Returns the collection.
125734     * @since PECL mongo >=1.0.2
125735     **/
125736    public function __get($name){}
125737
125738    /**
125739     * String representation of this collection
125740     *
125741     * @return string Returns the full name of this collection.
125742     * @since PECL mongo >=0.9.0
125743     **/
125744    public function __toString(){}
125745
125746}
125747/**
125748 * A command cursor is similar to a MongoCursor except that you use it
125749 * for iterating through the results of a database command instead of a
125750 * normal query. Command cursors are useful for iterating over large
125751 * result sets that might exceed the document size limit (currently 16MB)
125752 * of a single {@link MongoDB::command} response. While you can create
125753 * command cursors using {@link MongoCommandCursor::__construct} or the
125754 * {@link MongoCommandCursor::createFromDocument} factory method, you
125755 * will generally want to use command-specific helpers such as {@link
125756 * MongoCollection::aggregateCursor}. Note that the cursor does not
125757 * "contain" the database command's results; it just manages iteration
125758 * through them. Thus, if you print a cursor (f.e. with {@link var_dump}
125759 * or {@link print_r}), you will see the cursor object but not the result
125760 * documents.
125761 **/
125762class MongoCommandCursor implements MongoCursorInterface, Iterator {
125763    /**
125764     * Limits the number of elements returned in one batch
125765     *
125766     * A cursor typically fetches a batch of result objects and store them
125767     * locally. This method sets the batchSize value to configure the amount
125768     * of documents retrieved from the server in one round trip.
125769     *
125770     * @param int $batchSize The number of results to return per batch.
125771     *   Each batch requires a round-trip to the server. This cannot override
125772     *   MongoDB's limit on the amount of data it will return to the client
125773     *   (i.e., if you set batch size to 1,000,000,000, MongoDB will still
125774     *   only return 4-16MB of results per batch).
125775     * @return MongoCommandCursor Returns this cursor.
125776     * @since PECL mongo >=1.5.0
125777     **/
125778    public function batchSize($batchSize){}
125779
125780    /**
125781     * Create a new command cursor from an existing command response document
125782     *
125783     * Use this method if you have a raw command result with cursor
125784     * information in it. Note that cursors created with this method cannot
125785     * be iterated multiple times, as they will lack the original command
125786     * necessary for re-execution.
125787     *
125788     * @param MongoClient $connection Database connection.
125789     * @param string $hash The connection hash, as obtained through the
125790     *   third by-reference argument to MongoDB::command.
125791     * @param array $document Document with cursor information in it. This
125792     *   document needs to contain the id, ns and firstBatch fields. Such a
125793     *   document is obtained by calling the MongoDB::command with
125794     *   appropriate arguments to return a cursor, and not just an inline
125795     *   result. See the example below.
125796     * @return MongoCommandCursor Returns the new cursor.
125797     * @since PECL mongo >=1.5.0
125798     **/
125799    public static function createFromDocument($connection, $hash, $document){}
125800
125801    /**
125802     * Returns the current element
125803     *
125804     * This returns NULL until {@link MongoCommandCursor::rewind} is called.
125805     *
125806     * @return array The current result document as an associative array.
125807     *   NULL will be returned if there is no result.
125808     * @since PECL mongo >=1.5.0
125809     **/
125810    public function current(){}
125811
125812    /**
125813     * Checks if there are results that have not yet been sent from the
125814     * database
125815     *
125816     * This method checks whether the MongoCommandCursor cursor has been
125817     * exhausted and the database has no more results to send to the client.
125818     * A cursor being "dead" does not necessarily mean that there are no more
125819     * results available for iteration.
125820     *
125821     * @return bool Returns TRUE if there are more results that have not
125822     *   yet been sent to the client, and FALSE otherwise.
125823     * @since PECL mongo >=1.5.0
125824     **/
125825    public function dead(){}
125826
125827    /**
125828     * Get the read preference for this command
125829     *
125830     * @return array
125831     * @since PECL mongo >=1.6.0
125832     **/
125833    public function getReadPreference(){}
125834
125835    /**
125836     * Gets information about the cursor's creation and iteration
125837     *
125838     * This can be called before or after the cursor has started iterating.
125839     *
125840     * @return array Returns the namespace, batch size, limit, skip, flags,
125841     *   query, and projected fields for this cursor. If the cursor has
125842     *   started iterating, additional information about iteration and the
125843     *   connection will be included.
125844     * @since PECL mongo >=1.5.0
125845     **/
125846    public function info(){}
125847
125848    /**
125849     * Returns the current results index within the result set
125850     *
125851     * @return int The current results index within the result set.
125852     * @since PECL mongo >=1.5.0
125853     **/
125854    public function key(){}
125855
125856    /**
125857     * Advances the cursor to the next result
125858     *
125859     * @return void NULL.
125860     * @since PECL mongo >=1.5.0
125861     **/
125862    public function next(){}
125863
125864    /**
125865     * Executes the command and resets the cursor to the start of the result
125866     * set
125867     *
125868     * If the cursor has already started iteration, the command will be
125869     * re-executed.
125870     *
125871     * @return array The raw server result document.
125872     * @since PECL mongo >=1.5.0
125873     **/
125874    public function rewind(){}
125875
125876    /**
125877     * Set the read preference for this command
125878     *
125879     * @param string $read_preference
125880     * @param array $tags
125881     * @return MongoCommandCursor Returns this cursor.
125882     * @since PECL mongo >=1.6.0
125883     **/
125884    public function setReadPreference($read_preference, $tags){}
125885
125886    /**
125887     * Sets a client-side timeout for this command
125888     *
125889     * A timeout can be set at any time and will affect subsequent data
125890     * retrieval associated with this cursor, including fetching more results
125891     * from the database.
125892     *
125893     * @param int $ms The number of milliseconds for the cursor to wait for
125894     *   a response. Use -1 to wait forever. By default, the cursor will wait
125895     *   30000 milliseconds (30 seconds).
125896     * @return MongoCommandCursor This cursor.
125897     * @since PECL mongo >=1.6.0
125898     **/
125899    public function timeout($ms){}
125900
125901    /**
125902     * Checks if the cursor is reading a valid result
125903     *
125904     * @return bool TRUE if the current result is not null, and FALSE
125905     *   otherwise.
125906     * @since PECL mongo >=1.5.0
125907     **/
125908    public function valid(){}
125909
125910    /**
125911     * Create a new command cursor
125912     *
125913     * Generally, you should not have to construct a MongoCommandCursor
125914     * manually, as there are helper functions such as
125915     * MongoCollection::aggregateCursor and
125916     * MongoCollection::parallelCollectionScan; however, if the server
125917     * introduces new commands that can return cursors, this constructor will
125918     * be useful in the absence of specific helper methods. You may also
125919     * consider using MongoCommandCursor::createFromDocument.
125920     *
125921     * @param MongoClient $connection Database connection.
125922     * @param string $ns Full name of the database and collection (e.g.
125923     *   "test.foo")
125924     * @param array $command Database command.
125925     * @since PECL mongo >=1.5.0
125926     **/
125927    public function __construct($connection, $ns, $command){}
125928
125929}
125930/**
125931 * Thrown when the driver fails to connect to the database. There are a
125932 * number of possible error messages to help you diagnose the connection
125933 * problem. These are: If the error message is not listed above, it is
125934 * probably an error from the C socket, and you can search the web for
125935 * its usual cause.
125936 **/
125937class MongoConnectionException extends MongoException {
125938}
125939/**
125940 * A cursor is used to iterate through the results of a database query.
125941 * For example, to query the database and see all results, you could do:
125942 * MongoCursor basic usage
125943 *
125944 * You don't generally create cursors using the MongoCursor constructor,
125945 * you get a new cursor by calling {@link MongoCollection::find} (as
125946 * shown above). Suppose that, in the example above, $collection was a
125947 * 50GB collection. We certainly wouldn't want to load that into memory
125948 * all at once, which is what a cursor is for: allowing the client to
125949 * access the collection in dribs and drabs. If we have a large result
125950 * set, we can iterate through it, loading a few megabytes of results
125951 * into memory at a time. For example, we could do: Iterating over
125952 * MongoCursor
125953 *
125954 * This will go through each document in the collection, loading and
125955 * garbage collecting documents as needed. Note that this means that a
125956 * cursor does not "contain" the database results, it just manages them.
125957 * Thus, if you print a cursor (with, say, {@link var_dump} or {@link
125958 * print_r}), you'll just get the cursor object, not your documents. To
125959 * get the documents themselves, you can use one of the methods shown
125960 * above.
125961 **/
125962class MongoCursor extends MongoCursor implements MongoCursorInterface, Iterator {
125963    /**
125964     * Adds a top-level key/value pair to a query
125965     *
125966     * This is an advanced function and should not be used unless you know
125967     * what you're doing.
125968     *
125969     * A query can optionally be nested in a "query" field if other options,
125970     * such as a sort or hint, are given. For instance, adding a sort causes
125971     * the query to become a subfield of a bigger query object, like:
125972     *
125973     * <?php
125974     *
125975     * $query = array("query" => $query, "orderby" => $sort);
125976     *
125977     * ?>
125978     *
125979     * This method is for adding a top-level field to a query. It makes the
125980     * query a subobject (if it isn't already) and adds the key/value pair of
125981     * your chosing to the top level.
125982     *
125983     * @param string $key Fieldname to add.
125984     * @param mixed $value Value to add.
125985     * @return MongoCursor Returns this cursor.
125986     * @since PECL mongo >=1.0.4
125987     **/
125988    public function addOption($key, $value){}
125989
125990    /**
125991     * Sets whether this cursor will wait for a while for a tailable cursor
125992     * to return more data
125993     *
125994     * This method is to be used with tailable cursors. If we are at the end
125995     * of the data, block for a while rather than returning no data. After a
125996     * timeout period, we do return as normal.
125997     *
125998     * @param bool $wait If the cursor should wait for more data to become
125999     *   available.
126000     * @return MongoCursor Returns this cursor.
126001     * @since PECL mongo >=1.2.11
126002     **/
126003    public function awaitData($wait){}
126004
126005    /**
126006     * Limits the number of elements returned in one batch
126007     *
126008     * A cursor typically fetches a batch of result objects and store them
126009     * locally. This method sets the batchSize value to configure the amount
126010     * of documents retrieved from the server in one round trip. However, it
126011     * will never return more documents than fit in the max batch size limit
126012     * (usually 4MB).
126013     *
126014     * @param int $batchSize The number of results to return per batch.
126015     *   Each batch requires a round-trip to the server. If {@link batchSize}
126016     *   is 2 or more, it represents the size of each batch of objects
126017     *   retrieved. It can be adjusted to optimize performance and limit data
126018     *   transfer. If {@link batchSize} is 1 or negative, it will limit of
126019     *   number returned documents to the absolute value of batchSize, and
126020     *   the cursor will be closed. For example if batchSize is -10, then the
126021     *   server will return a maximum of 10 documents and as many as can fit
126022     *   in 4MB, then close the cursor. Note that this feature is different
126023     *   from {@link MongoCursor::limit} in that documents must fit within a
126024     *   maximum size, and it removes the need to send a request to close the
126025     *   cursor server-side. The batch size can be changed even after a
126026     *   cursor is iterated, in which case the setting will apply on the next
126027     *   batch retrieval. This cannot override MongoDB's limit on the amount
126028     *   of data it will return to the client (i.e., if you set batch size to
126029     *   1,000,000,000, MongoDB will still only return 4-16MB of results per
126030     *   batch). To ensure consistent behavior, the rules of {@link
126031     *   MongoCursor::batchSize} and {@link MongoCursor::limit} behave a
126032     *   little complex but work "as expected". The rules are: hard limits
126033     *   override soft limits with preference given to {@link
126034     *   MongoCursor::limit} over {@link MongoCursor::batchSize}. After that,
126035     *   whichever is set and lower than the other will take precedence. See
126036     *   below. section for some examples.
126037     * @return MongoCursor Returns this cursor.
126038     * @since PECL mongo >=1.0.11
126039     **/
126040    public function batchSize($batchSize){}
126041
126042    /**
126043     * Counts the number of results for this query
126044     *
126045     * This method does not affect the state of the cursor: if you haven't
126046     * queried yet, you can still apply limits, skips, etc. If you have
126047     * started iterating through results, it will not move the current
126048     * position of the cursor. If you have exhausted the cursor, it will not
126049     * reset it.
126050     *
126051     * @param bool $foundOnly Send cursor limit and skip information to the
126052     *   count function, if applicable.
126053     * @return int The number of documents returned by this cursor's query.
126054     * @since PECL mongo >=0.9.2
126055     **/
126056    public function count($foundOnly){}
126057
126058    /**
126059     * Returns the current element
126060     *
126061     * This returns NULL until {@link MongoCursor::next} is called.
126062     *
126063     * @return array The current result document as an associative array.
126064     *   NULL will be returned if there is no result.
126065     * @since PECL mongo >=0.9.0
126066     **/
126067    public function current(){}
126068
126069    /**
126070     * Checks if there are results that have not yet been sent from the
126071     * database
126072     *
126073     * The database sends responses in batches of documents, up to 4MB of
126074     * documents per response. This method checks if the database has more
126075     * batches or if the result set has been exhausted.
126076     *
126077     * A cursor being "dead" does not mean that {@link MongoCursor::hasNext}
126078     * will return FALSE, it only means that the database is done sending
126079     * results to the client. The client should continue iterating through
126080     * results until {@link MongoCursor::hasNext} is FALSE.
126081     *
126082     * @return bool Returns TRUE if there are more results that have not
126083     *   yet been sent to the client, and FALSE otherwise.
126084     * @since PECL mongo >=0.9.6
126085     **/
126086    public function dead(){}
126087
126088    /**
126089     * Execute the query
126090     *
126091     * This function actually queries the database. All queries and commands
126092     * go through this function. Thus, this function can be overridden to
126093     * provide custom query handling.
126094     *
126095     * This handles serializing your query, sending it to the database,
126096     * receiving a response, and deserializing it. Thus, if you are planning
126097     * to override this, your code should probably call out to the original
126098     * to use the existing functionality (see the example below).
126099     *
126100     * @return void NULL.
126101     * @since PECL mongo >=0.9.0
126102     **/
126103    protected function doQuery(){}
126104
126105    /**
126106     * Return an explanation of the query, often useful for optimization and
126107     * debugging
126108     *
126109     * @return array Returns an explanation of the query.
126110     * @since PECL mongo >=0.9.2
126111     **/
126112    public function explain(){}
126113
126114    /**
126115     * Sets the fields for a query
126116     *
126117     * Fields are specified by "fieldname" : bool. TRUE indicates that a
126118     * field should be returned, FALSE indicates that it should not be
126119     * returned. You can also use 1 and 0 instead of TRUE and FALSE.
126120     *
126121     * Thus, to return only the "summary" field, one could say:
126122     *
126123     * To return all fields except the "hidden" field:
126124     *
126125     * @param array $f Fields to return (or not return).
126126     * @return MongoCursor Returns this cursor.
126127     * @since PECL mongo >=1.0.6
126128     **/
126129    public function fields($f){}
126130
126131    /**
126132     * Advances the cursor to the next result, and returns that result
126133     *
126134     * @return array
126135     * @since PECL mongo >=0.9.0
126136     **/
126137    public function getNext(){}
126138
126139    /**
126140     * Get the read preference for this query
126141     *
126142     * @return array
126143     * @since PECL mongo >=1.3.3
126144     **/
126145    public function getReadPreference(){}
126146
126147    /**
126148     * Checks if there are any more elements in this cursor
126149     *
126150     * @return bool Returns if there is another element.
126151     * @since PECL mongo >=0.9.0
126152     **/
126153    public function hasNext(){}
126154
126155    /**
126156     * Gives the database a hint about the query
126157     *
126158     * @param mixed $index Index to use for the query. If a string is
126159     *   passed, it should correspond to an index name. If an array or object
126160     *   is passed, it should correspond to the specification used to create
126161     *   the index (i.e. the first argument to {@link
126162     *   MongoCollection::ensureIndex}).
126163     * @return MongoCursor Returns this cursor.
126164     * @since PECL mongo >=0.9.0
126165     **/
126166    public function hint($index){}
126167
126168    /**
126169     * Sets whether this cursor will timeout
126170     *
126171     * After remaining idle on the server for some amount of time, cursors,
126172     * by default, "die." This is generally the behavior one wants. The
126173     * database cleans up a cursor once all of its results have been sent to
126174     * the client, but if the client doesn't request all of the results, the
126175     * cursor will languish there, taking up resources. Thus, after a few
126176     * minutes, the cursor "times out" and the database assumes the client
126177     * has gotten everything it needs and cleans up its the cursor's
126178     * resources.
126179     *
126180     * If, for some reason, you need a cursor to hang around for a long time,
126181     * you can prevent the database from cleaning it up by using this method.
126182     * However, if you make a cursor immortal, you need to iterate through
126183     * all of its results (or at least until MongoCursor::dead returns TRUE)
126184     * or the cursor will hang around the database forever, taking up
126185     * resources.
126186     *
126187     * @param bool $liveForever If the cursor should be immortal.
126188     * @return MongoCursor Returns this cursor.
126189     * @since PECL mongo >=1.0.1
126190     **/
126191    public function immortal($liveForever){}
126192
126193    /**
126194     * Gets information about the cursor's creation and iteration
126195     *
126196     * This can be called before or after the cursor has started iterating.
126197     *
126198     * @return array Returns the namespace, batch size, limit, skip, flags,
126199     *   query, and projected fields for this cursor. If the cursor has
126200     *   started iterating, additional information about iteration and the
126201     *   connection will be included.
126202     * @since PECL mongo >=1.0.5
126203     **/
126204    public function info(){}
126205
126206    /**
126207     * Returns the current results _id, or its index within the result set
126208     *
126209     * @return string|int The current results _id as a string. If the
126210     *   result has no _id, its numeric index within the result set will be
126211     *   returned as an integer.
126212     * @since PECL mongo >=0.9.0
126213     **/
126214    public function key(){}
126215
126216    /**
126217     * Limits the number of results returned
126218     *
126219     * @param int $num The number of results to return.
126220     * @return MongoCursor Returns this cursor.
126221     * @since PECL mongo >=0.9.0
126222     **/
126223    public function limit($num){}
126224
126225    /**
126226     * Sets a server-side timeout for this query
126227     *
126228     * Specifies a cumulative time limit in milliseconds to be allowed by the
126229     * server for processing operations on the cursor.
126230     *
126231     * @param int $ms Specifies a cumulative time limit in milliseconds to
126232     *   be allowed by the server for processing operations on the cursor.
126233     * @return MongoCursor This cursor.
126234     * @since PECL mongo >=1.5.0
126235     **/
126236    public function maxTimeMS($ms){}
126237
126238    /**
126239     * Advances the cursor to the next result, and returns that result
126240     *
126241     * @return array Returns the next document.
126242     * @since PECL mongo >=0.9.0
126243     **/
126244    public function next(){}
126245
126246    /**
126247     * If this query should fetch partial results from if a shard is down
126248     *
126249     * This option allows mongos to send partial query results if a shard is
126250     * unreachable. This is only applicable when running a sharded MongoDB
126251     * cluster and connecting to a mongos.
126252     *
126253     * If a shard goes down and a query needs to be sent to that shard,
126254     * mongos will return the results (if any) from shards it already
126255     * contacted, then an error message that it could not reach the shard (a
126256     * MongoCursorException in PHP). If you would like to get whatever
126257     * results mongos can provide and no exception, you can use this method.
126258     * Note that this means that you won't have an indication that a shard is
126259     * down in your query response.
126260     *
126261     * This has no effect on the query if all shards are reachable. This flag
126262     * was implemented in MongoDB version 1.7.5, so will only work with that
126263     * version and higher.
126264     *
126265     * @param bool $okay If receiving partial results is okay.
126266     * @return MongoCursor Returns this cursor.
126267     * @since PECL mongo >=1.2.0
126268     **/
126269    public function partial($okay){}
126270
126271    /**
126272     * Clears the cursor
126273     *
126274     * @return void NULL.
126275     * @since PECL mongo >=0.9.0
126276     **/
126277    public function reset(){}
126278
126279    /**
126280     * Returns the cursor to the beginning of the result set
126281     *
126282     * This is identical to the function:
126283     *
126284     * @return void NULL.
126285     * @since PECL mongo >=0.9.0
126286     **/
126287    public function rewind(){}
126288
126289    /**
126290     * Sets arbitrary flags in case there is no method available the specific
126291     * flag
126292     *
126293     * The MongoCursor class has several methods for setting flags on the
126294     * query object. This method is available in case the MongoDB wire
126295     * protocol has acquired a new flag, and the driver has not been updated
126296     * with a method for this new flag. In all other cases, the method should
126297     * be used. See the "See also" section for available methods.
126298     *
126299     * @param int $flag Which flag to set. You can not set flag 6 (EXHAUST)
126300     *   as the driver does not know how to handle them. You will get a
126301     *   warning if you try to use this flag. For available flags, please
126302     *   refer to the wire protocol documentation.
126303     * @param bool $set Whether the flag should be set (TRUE) or unset
126304     *   (FALSE).
126305     * @return MongoCursor Returns this cursor.
126306     * @since PECL mongo >=1.2.11
126307     **/
126308    public function setFlag($flag, $set){}
126309
126310    /**
126311     * Set the read preference for this query
126312     *
126313     * @param string $read_preference
126314     * @param array $tags
126315     * @return MongoCursor Returns this cursor.
126316     * @since PECL mongo >=1.3.3
126317     **/
126318    public function setReadPreference($read_preference, $tags){}
126319
126320    /**
126321     * Skips a number of results
126322     *
126323     * @param int $num The number of results to skip.
126324     * @return MongoCursor Returns this cursor.
126325     * @since PECL mongo >=0.9.0
126326     **/
126327    public function skip($num){}
126328
126329    /**
126330     * Sets whether this query can be done on a secondary [deprecated]
126331     *
126332     * Calling this will make the driver route reads to secondaries if: You
126333     * are using a replica set, and You created a MongoClient instance using
126334     * the option "replicaSet" => "setName", and There is a healthy secondary
126335     * that can be reached by the driver. You can check which server was used
126336     * for this query by calling {@link MongoCursor::info} after running the
126337     * query. It's server field will show which server the query was sent to.
126338     *
126339     * Note that you should use this function even if you do not use the
126340     * automatic routing to secondaries. If you connect directly to a
126341     * secondary in a replica set, you still need to call this function,
126342     * which basically tells the database that you are aware that you might
126343     * be getting older data and you're okay with that. If you do not call
126344     * this, you'll get "not master" errors when you try to query.
126345     *
126346     * This method will override the static class variable
126347     * MongoCursor::$slaveOkay. It will also override {@link
126348     * Mongo::setSlaveOkay}, {@link MongoDB::setSlaveOkay} and {@link
126349     * MongoCollection::setSlaveOkay}.
126350     *
126351     * @param bool $okay If it is okay to query the secondary.
126352     * @return MongoCursor Returns this cursor.
126353     * @since PECL mongo >=0.9.4
126354     **/
126355    public function slaveOkay($okay){}
126356
126357    /**
126358     * Use snapshot mode for the query
126359     *
126360     * Use snapshot mode for the query. Snapshot mode ensures that a document
126361     * will not be returned more than once because an intervening write
126362     * operation results in a move of the document. Documents inserted or
126363     * deleted during the lifetime of the cursor may or may not be returned,
126364     * irrespective of snapshot mode.
126365     *
126366     * Queries with short responses (less than 1MB) are always effectively
126367     * snapshotted.
126368     *
126369     * Snapshot mode may not be used with sorting, explicit hints, or queries
126370     * on sharded collections.
126371     *
126372     * @return MongoCursor Returns this cursor.
126373     * @since PECL mongo >=0.9.4
126374     **/
126375    public function snapshot(){}
126376
126377    /**
126378     * Sorts the results by given fields
126379     *
126380     * @param array $fields An array of fields by which to sort. Each
126381     *   element in the array has as key the field name, and as value either
126382     *   1 for ascending sort, or -1 for descending sort. Each result is
126383     *   first sorted on the first field in the array, then (if it exists) on
126384     *   the second field in the array, etc. This means that the order of the
126385     *   fields in the {@link fields} array is important. See also the
126386     *   examples section.
126387     * @return MongoCursor Returns the same cursor that this method was
126388     *   called on.
126389     * @since PECL mongo >=0.9.0
126390     **/
126391    public function sort($fields){}
126392
126393    /**
126394     * Sets whether this cursor will be left open after fetching the last
126395     * results
126396     *
126397     * Mongo has a feature known as tailable cursors which are similar to the
126398     * Unix "tail -f" command.
126399     *
126400     * Tailable means cursor is not closed when the last data is retrieved.
126401     * Rather, the cursor marks the final object's position. you can resume
126402     * using the cursor later, from where it was located, if more data were
126403     * received.
126404     *
126405     * Like any "latent cursor", the cursor may become invalid at some point
126406     * -- for example if that final object it references were deleted. Thus,
126407     * you should be prepared to requery if the cursor is {@link
126408     * MongoCursor::dead}.
126409     *
126410     * @param bool $tail If the cursor should be tailable.
126411     * @return MongoCursor Returns this cursor.
126412     * @since PECL mongo >=0.9.4
126413     **/
126414    public function tailable($tail){}
126415
126416    /**
126417     * Sets a client-side timeout for this query
126418     *
126419     * A timeout can be set at any time and will affect subsequent queries on
126420     * the cursor, including fetching more results from the database.
126421     *
126422     * @param int $ms The number of milliseconds for the cursor to wait for
126423     *   a response. Use -1 to wait forever. By default, the cursor will wait
126424     *   30000 milliseconds (30 seconds).
126425     * @return MongoCursor This cursor.
126426     * @since PECL mongo >=1.0.3
126427     **/
126428    public function timeout($ms){}
126429
126430    /**
126431     * Checks if the cursor is reading a valid result
126432     *
126433     * @return bool TRUE if the current result is not null, and FALSE
126434     *   otherwise.
126435     * @since PECL mongo >=0.9.0
126436     **/
126437    public function valid(){}
126438
126439    /**
126440     * Create a new cursor
126441     *
126442     * @param MongoClient $connection Database connection.
126443     * @param string $ns Full name of database and collection.
126444     * @param array $query Database query.
126445     * @param array $fields Fields to return.
126446     * @since PECL mongo >=0.9.0
126447     **/
126448    public function __construct($connection, $ns, $query, $fields){}
126449
126450}
126451/**
126452 * Caused by accessing a cursor incorrectly or a error receiving a reply.
126453 * Note that this can be thrown by any database request that receives a
126454 * reply, not just queries. Writes, commands, and any other operation
126455 * that sends information to the database and waits for a response can
126456 * throw a MongoCursorException. The only exception is new MongoClient()
126457 * (creating a new connection), which will only throw
126458 * MongoConnectionExceptions. This returns a specific error message to
126459 * help diagnose the problem and a numeric error code associated with the
126460 * cause of the exception. For example, suppose you tried to insert two
126461 * documents with the same _id:
126462 *
126463 * This would produce output like:
126464 *
126465 * error message: E11000 duplicate key error index: foo.bar.$_id_ dup
126466 * key: { : 1 } error code: 11000
126467 *
126468 * Note that the MongoDB error code (11000) is used for the PHP error
126469 * code. The PHP driver uses the "native" error code wherever possible.
126470 * The following is a list of common errors, codes, and causes. Exact
126471 * errors are in italics, errors where the message can vary are described
126472 * in obliques.
126473 **/
126474class MongoCursorException extends MongoException {
126475    /**
126476     * The hostname of the server that encountered the error
126477     *
126478     * Returns the hostname of the server the query was sent too.
126479     *
126480     * @return string Returns the hostname, or NULL if the hostname is
126481     *   unknown.
126482     **/
126483    public function getHost(){}
126484
126485}
126486/**
126487 * Interface for cursors, which can be used to iterate through results of
126488 * a database query or command. This interface is implemented by the
126489 * MongoCursor and MongoCommandCursor classes.
126490 **/
126491interface MongoCursorInterface extends Iterator {
126492    /**
126493     * Limits the number of elements returned in one batch
126494     *
126495     * A cursor typically fetches a batch of result objects and stores them
126496     * locally. This method sets the batch size value to configure the amount
126497     * of documents retrieved from the server in one round trip.
126498     *
126499     * @param int $batchSize The number of results to return per batch.
126500     * @return MongoCursorInterface Returns this cursor.
126501     * @since PECL mongo >=1.5.0
126502     **/
126503    public function batchSize($batchSize);
126504
126505    /**
126506     * Checks if there are results that have not yet been sent from the
126507     * database
126508     *
126509     * This method checks whether the cursor has been exhausted and the
126510     * database has no more results to send to the client. A cursor being
126511     * "dead" does not necessarily mean that there are no more results
126512     * available for iteration.
126513     *
126514     * @return bool Returns TRUE if there are more results that have not
126515     *   yet been sent to the client, and FALSE otherwise.
126516     * @since PECL mongo >=1.5.0
126517     **/
126518    public function dead();
126519
126520    /**
126521     * Get the read preference for this query
126522     *
126523     * @return array
126524     * @since PECL mongo >=1.6.0
126525     **/
126526    public function getReadPreference();
126527
126528    /**
126529     * Gets information about the cursor's creation and iteration
126530     *
126531     * Returns information about the cursor's creation and iteration. This
126532     * can be called before or after the cursor has started iterating.
126533     *
126534     * @return array Returns the namespace, batch size, limit, skip, flags,
126535     *   query, and projected fields for this cursor. If the cursor has
126536     *   started iterating, additional information about iteration and the
126537     *   connection will be included.
126538     * @since PECL mongo >=1.5.0
126539     **/
126540    public function info();
126541
126542    /**
126543     * Set the read preference for this query
126544     *
126545     * @param string $read_preference
126546     * @param array $tags
126547     * @return MongoCursorInterface Returns this cursor.
126548     * @since PECL mongo >=1.6.0
126549     **/
126550    public function setReadPreference($read_preference, $tags);
126551
126552    /**
126553     * Sets a client-side timeout for this query
126554     *
126555     * A timeout can be set at any time and will affect subsequent data
126556     * retrieval associated with this cursor, including fetching more results
126557     * from the database.
126558     *
126559     * @param int $ms The number of milliseconds for the cursor to wait for
126560     *   a response. Use -1 to wait forever. By default, the cursor will wait
126561     *   30000 milliseconds (30 seconds).
126562     * @return MongoCursorInterface Returns this cursor.
126563     * @since PECL mongo >=1.5.0
126564     **/
126565    public function timeout($ms);
126566
126567}
126568/**
126569 * Caused by a query timing out. You can set the length of time to wait
126570 * before this exception is thrown by calling {@link
126571 * MongoCursor::timeout} on the cursor or setting MongoCursor::$timeout.
126572 * The static variable is useful for queries such as database commands
126573 * and {@link MongoCollection::findOne}, both of which implicitly use
126574 * cursors.
126575 **/
126576class MongoCursorTimeoutException extends MongoCursorException {
126577}
126578/**
126579 * Represent date objects for the database. This class should be used to
126580 * save dates to the database and to query for dates. For example:
126581 * MongoDB stores dates as milliseconds past the epoch. This means that
126582 * dates do not contain timezone information. Timezones must be stored in
126583 * a separate field if needed. Second, this means that any precision
126584 * beyond milliseconds will be lost when the document is sent to/from the
126585 * database.
126586 **/
126587class MongoDate {
126588    /**
126589     * @var int
126590     **/
126591    public $sec;
126592
126593    /**
126594     * @var int
126595     **/
126596    public $usec;
126597
126598    /**
126599     * Returns a DateTime object representing this date
126600     *
126601     * Returns the DateTime representation of this date. The returned
126602     * DateTime will use the UTC time zone.
126603     *
126604     * @return DateTime This date as a DateTime object.
126605     * @since PECL mongo >= 1.6.0
126606     **/
126607    public function toDateTime(){}
126608
126609    /**
126610     * Creates a new date
126611     *
126612     * Creates a new date. If no parameters are given, the current time is
126613     * used.
126614     *
126615     * @param int $sec Number of seconds since the epoch (i.e. 1 Jan 1970
126616     *   00:00:00.000 UTC).
126617     * @param int $usec Microseconds. Please be aware though that MongoDB's
126618     *   resolution is milliseconds and not microseconds, which means this
126619     *   value will be truncated to millisecond resolution.
126620     * @since PECL mongo >= 0.8.1
126621     **/
126622    public function __construct($sec, $usec){}
126623
126624    /**
126625     * Returns a string representation of this date
126626     *
126627     * Returns a string representation of this date, similar to the
126628     * representation returned by {@link microtime}.
126629     *
126630     * @return string This date.
126631     * @since PECL mongo >= 0.8.1
126632     **/
126633    public function __toString(){}
126634
126635}
126636/**
126637 * Instances of this class are used to interact with a database. To get a
126638 * database: Selecting a database
126639 *
126640 * Database names can use almost any character in the ASCII range.
126641 * However, they cannot contain , . or be the empty string. The name
126642 * "system" is also reserved. A few unusual, but valid, database names:
126643 * null, [x,y], 3, \, /. Unlike collection names, database names may
126644 * contain $.
126645 **/
126646class MongoDB {
126647    /**
126648     * @var int
126649     **/
126650    const PROFILING_OFF = 0;
126651
126652    /**
126653     * @var int
126654     **/
126655    const PROFILING_ON = 0;
126656
126657    /**
126658     * @var int
126659     **/
126660    const PROFILING_SLOW = 0;
126661
126662    /**
126663     * @var integer
126664     **/
126665    public $w;
126666
126667    /**
126668     * @var integer
126669     **/
126670    public $wtimeout;
126671
126672    /**
126673     * Log in to this database
126674     *
126675     * This method causes its connection to be authenticated. If
126676     * authentication is enabled for the database server (it's not, by
126677     * default), you need to log in before the database will allow you to do
126678     * anything.
126679     *
126680     * In general, you should use the authenticate built into {@link
126681     * MongoClient::__construct} in preference to this method. If you
126682     * authenticate on connection and the connection drops and reconnects
126683     * during your session, you'll be reauthenticated. If you manually
126684     * authenticated using this method and the connection drops, you'll have
126685     * to call this method again once you're reconnected.
126686     *
126687     * This method is identical to running:
126688     *
126689     * <?php
126690     *
126691     * $salted = "${username}:mongo:${password}"; $hash = md5($salted);
126692     *
126693     * $nonce = $db->command(array("getnonce" => 1));
126694     *
126695     * $saltedHash = md5($nonce["nonce"]."${username}${hash}");
126696     *
126697     * $result = $db->command(array("authenticate" => 1, "user" => $username,
126698     * "nonce" => $nonce["nonce"], "key" => $saltedHash ));
126699     *
126700     * ?>
126701     *
126702     * Once a connection has been authenticated, it can only be
126703     * un-authenticated by using the "logout" database command:
126704     *
126705     * <?php
126706     *
126707     * $db->command(array("logout" => 1));
126708     *
126709     * ?>
126710     *
126711     * @param string $username The username.
126712     * @param string $password The password (in plaintext).
126713     * @return array Returns database response. If the login was
126714     *   successful, it will return
126715     *
126716     *   <?php array("ok" => 1); ?>
126717     *
126718     *   If something went wrong, it will return
126719     *
126720     *   <?php array("ok" => 0, "errmsg" => "auth fails"); ?>
126721     *
126722     *   ("auth fails" could be another message, depending on database
126723     *   version and what when wrong).
126724     * @since PECL mongo >=1.0.1
126725     **/
126726    public function authenticate($username, $password){}
126727
126728    /**
126729     * Execute a database command
126730     *
126731     * Almost everything that is not a CRUD operation can be done with a
126732     * database command. Need to know the database version? There's a command
126733     * for that. Need to do aggregation? There's a command for that. Need to
126734     * turn up logging? You get the idea.
126735     *
126736     * This method is identical to:
126737     *
126738     * <?php
126739     *
126740     * public function command($data) { return
126741     * $this->selectCollection('$cmd')->findOne($data); }
126742     *
126743     * ?>
126744     *
126745     * @param array $command The query to send.
126746     * @param array $options An array of options for the index creation.
126747     *   Currently available options include: The following options are
126748     *   deprecated and should no longer be used:
126749     * @param string $hash Set to the connection hash of the server that
126750     *   executed the command. When the command result is suitable for
126751     *   creating a MongoCommandCursor, the hash is intended to be passed to
126752     *   {@link MongoCommandCursor::createFromDocument}. The hash will also
126753     *   correspond to a connection returned from {@link
126754     *   MongoClient::getConnections}.
126755     * @return array Returns database response. Every database response is
126756     *   always maximum one document, which means that the result of a
126757     *   database command can never exceed 16MB. The resulting document's
126758     *   structure depends on the command, but most results will have the ok
126759     *   field to indicate success or failure and results containing an array
126760     *   of each of the resulting documents.
126761     * @since PECL mongo >=0.9.2
126762     **/
126763    public function command($command, $options, &$hash){}
126764
126765    /**
126766     * Creates a collection
126767     *
126768     * This method is used to create capped collections and other collections
126769     * requiring special options. It is identical to running:
126770     *
126771     * <?php
126772     *
126773     * $collection = $db->command(array( "create" => $name, "capped" =>
126774     * $options["capped"], "size" => $options["size"], "max" =>
126775     * $options["max"], "autoIndexId" => $options["autoIndexId"], ));
126776     *
126777     * ?>
126778     *
126779     * See {@link MongoDB::command} for more information about database
126780     * commands.
126781     *
126782     * @param string $name The name of the collection.
126783     * @param array $options An array containing options for the
126784     *   collections. Each option is its own element in the options array,
126785     *   with the option name listed below being the key of the element. The
126786     *   supported options depend on the MongoDB server version and storage
126787     *   engine, and the driver passes any option that you give it straight
126788     *   to the server. A few of the supported options are, but you can find
126789     *   a full list in the MongoDB core docs on createCollection:
126790     *
126791     *   {@link capped} If the collection should be a fixed size. {@link
126792     *   size} If the collection is fixed size, its size in bytes. {@link
126793     *   max} If the collection is fixed size, the maximum number of elements
126794     *   to store in the collection. {@link autoIndexId} If capped is TRUE
126795     *   you can specify FALSE to disable the automatic index created on the
126796     *   _id field. Before MongoDB 2.2, the default value for autoIndexId was
126797     *   FALSE.
126798     * @return MongoCollection Returns a collection object representing the
126799     *   new collection.
126800     * @since PECL mongo >=0.9.0
126801     **/
126802    public function createCollection($name, $options){}
126803
126804    /**
126805     * Creates a database reference
126806     *
126807     * This method is a flexible interface for creating database refrences
126808     * (see MongoDBRef).
126809     *
126810     * @param string $collection The collection to which the database
126811     *   reference will point.
126812     * @param mixed $document_or_id If an array or object is given, its _id
126813     *   field will be used as the reference ID. If a MongoId or scalar is
126814     *   given, it will be used as the reference ID.
126815     * @return array Returns a database reference array.
126816     * @since PECL mongo >=0.9.0
126817     **/
126818    public function createDBRef($collection, $document_or_id){}
126819
126820    /**
126821     * Drops this database
126822     *
126823     * This drops the database currently being used.
126824     *
126825     * This is identical to running:
126826     *
126827     * <?php
126828     *
126829     * public function drop() { $this->command(array("dropDatabase" => 1)); }
126830     *
126831     * ?>
126832     *
126833     * @return array Returns the database response.
126834     * @since PECL mongo >=0.9.0
126835     **/
126836    public function drop(){}
126837
126838    /**
126839     * Drops a collection [deprecated]
126840     *
126841     * @param mixed $coll MongoCollection or name of collection to drop.
126842     * @return array Returns the database response.
126843     * @since PECL mongo >=0.9.0
126844     **/
126845    public function dropCollection($coll){}
126846
126847    /**
126848     * Runs JavaScript code on the database server [deprecated]
126849     *
126850     * The Mongo database server runs a JavaScript engine. This method allows
126851     * you to run arbitary JavaScript on the database. This can be useful if
126852     * you want touch a number of collections lightly, or process some
126853     * results on the database side to reduce the amount that has to be sent
126854     * to the client.
126855     *
126856     * Running JavaScript in the database takes a write lock, meaning it
126857     * blocks other operations. Make sure you consider this before running a
126858     * long script.
126859     *
126860     * This is a wrapper for the eval database command. This method is
126861     * basically:
126862     *
126863     * <?php
126864     *
126865     * public function execute($code, $args) { return
126866     * $this->command(array('eval' => $code, 'args' => $args)); }
126867     *
126868     * ?>
126869     *
126870     * MongoDB implies a return statement if you have a single statement on a
126871     * single line. This can cause some unintuitive behavior. For example,
126872     * this returns "foo":
126873     *
126874     * However, these return NULL:
126875     *
126876     * To avoid surprising behavior, it is best not to depend on MongoDB to
126877     * decide what to return, but to explicitly state a return value. In the
126878     * examples above, we can change them to:
126879     *
126880     * Now the first statement will return "foo" and the second statement
126881     * will return a count of the "foo" collection.
126882     *
126883     * @param mixed $code MongoCode or string to execute.
126884     * @param array $args Arguments to be passed to code.
126885     * @return array Returns the result of the evaluation.
126886     * @since PECL mongo >=0.9.3
126887     **/
126888    public function execute($code, $args){}
126889
126890    /**
126891     * Creates a database error
126892     *
126893     * This method is not very useful for normal MongoDB use. It forces a
126894     * database error to occur. This means that {@link MongoDB::lastError}
126895     * will return a generic database error after running this command.
126896     *
126897     * This command is identical to running:
126898     *
126899     * <?php
126900     *
126901     * public function forceError() { return
126902     * $this->command(array('forceerror' => 1)); }
126903     *
126904     * ?>
126905     *
126906     * @return bool Returns the database response.
126907     * @since PECL mongo >=0.9.5
126908     **/
126909    public function forceError(){}
126910
126911    /**
126912     * Returns information about collections in this database
126913     *
126914     * Gets a list of all collections in the database and returns them as an
126915     * array of documents, which contain their names and options.
126916     *
126917     * @param array $options An array of options for listing the
126918     *   collections. Currently available options include: The following
126919     *   option may be used with MongoDB 2.8+:
126920     * @return array This function returns an array where each element is
126921     *   an array describing a collection. Elements will contain a name key
126922     *   denoting the name of the collection, and optionally contain an
126923     *   options key denoting an array of objects used to create the
126924     *   collection. For example, capped collections will include capped and
126925     *   size options.
126926     * @since PECL mongo >=1.6.0
126927     **/
126928    public function getCollectionInfo($options){}
126929
126930    /**
126931     * Gets an array of names for all collections in this database
126932     *
126933     * Gets a list of all collections in the database and returns their names
126934     * as an array of strings.
126935     *
126936     * @param array $options An array of options for listing the
126937     *   collections. Currently available options include: The following
126938     *   option may be used with MongoDB 2.8+:
126939     * @return array Returns the collection names as an array of strings.
126940     * @since PECL mongo >=1.3.0
126941     **/
126942    public function getCollectionNames($options){}
126943
126944    /**
126945     * Fetches the document pointed to by a database reference
126946     *
126947     * @param array $ref A database reference.
126948     * @return array Returns the document pointed to by the reference.
126949     * @since PECL mongo >=0.9.0
126950     **/
126951    public function getDBRef($ref){}
126952
126953    /**
126954     * Fetches toolkit for dealing with files stored in this database
126955     *
126956     * @param string $prefix The prefix for the files and chunks
126957     *   collections.
126958     * @return MongoGridFS Returns a new gridfs object for this database.
126959     * @since PECL mongo >=0.9.0
126960     **/
126961    public function getGridFS($prefix){}
126962
126963    /**
126964     * Gets this databases profiling level
126965     *
126966     * This returns the current database profiling level.
126967     *
126968     * The database profiler tracks query execution times. If you turn it on
126969     * (say, using {@link MongoDB::setProfilingLevel} or the shell), you can
126970     * see how many queries took longer than a given number of milliseconds
126971     * or the timing for all queries.
126972     *
126973     * Note that profiling slows down queries, so it is better to use in
126974     * development or testing than in a time-sensitive application.
126975     *
126976     * This function is equivalent to running:
126977     *
126978     * <?php
126979     *
126980     * public function getProfilingLevel() { return
126981     * $this->command(array('profile' => -1)); }
126982     *
126983     * ?>
126984     *
126985     * @return int Returns the profiling level.
126986     * @since PECL mongo >=0.9.0
126987     **/
126988    public function getProfilingLevel(){}
126989
126990    /**
126991     * Get the read preference for this database
126992     *
126993     * @return array
126994     * @since PECL mongo >=1.3.0
126995     **/
126996    public function getReadPreference(){}
126997
126998    /**
126999     * Get slaveOkay setting for this database
127000     *
127001     * See the query section of this manual for information on distributing
127002     * reads to secondaries.
127003     *
127004     * @return bool Returns the value of slaveOkay for this instance.
127005     * @since PECL mongo >=1.1.0
127006     **/
127007    public function getSlaveOkay(){}
127008
127009    /**
127010     * Get the write concern for this database
127011     *
127012     * @return array
127013     * @since PECL mongo >=1.5.0
127014     **/
127015    public function getWriteConcern(){}
127016
127017    /**
127018     * Check if there was an error on the most recent db operation performed
127019     *
127020     * This method is equivalent to:
127021     *
127022     * <?php
127023     *
127024     * public function lastError() { return
127025     * $this->command(array('getlasterror' => 1)); }
127026     *
127027     * ?>
127028     *
127029     * @return array Returns the error, if there was one.
127030     * @since PECL mongo >=0.9.5
127031     **/
127032    public function lastError(){}
127033
127034    /**
127035     * Gets an array of MongoCollection objects for all collections in this
127036     * database
127037     *
127038     * Gets a list of all collections in the database and returns them as an
127039     * array of MongoCollection objects.
127040     *
127041     * @param array $options An array of options for listing the
127042     *   collections. Currently available options include: The following
127043     *   option may be used with MongoDB 2.8+:
127044     * @return array Returns an array of MongoCollection objects.
127045     * @since PECL mongo >=0.9.0
127046     **/
127047    public function listCollections($options){}
127048
127049    /**
127050     * Checks for the last error thrown during a database operation
127051     *
127052     * {@link MongoDB::lastError} is usually preferred to this. This method
127053     * returns the last database error that occurred and how many operations
127054     * ago it occurred. It is mostly deprecated.
127055     *
127056     * @return array Returns the error and the number of operations ago it
127057     *   occurred.
127058     * @since PECL mongo >=0.9.5
127059     **/
127060    public function prevError(){}
127061
127062    /**
127063     * Repairs and compacts this database
127064     *
127065     * This creates a fresh copy of all database data. It will remove any
127066     * corrupt data and compact and large stretches of free space it finds.
127067     * This is a very slow operation on a large database.
127068     *
127069     * This is usually run from the shell or the command line, not the
127070     * driver.
127071     *
127072     * It is equivalent to the function:
127073     *
127074     * <?php
127075     *
127076     * public function repair() { return
127077     * $this->command(array('repairDatabase' => 1)); }
127078     *
127079     * ?>
127080     *
127081     * @param bool $preserve_cloned_files If cloned files should be kept if
127082     *   the repair fails.
127083     * @param bool $backup_original_files If original files should be
127084     *   backed up.
127085     * @return array Returns db response.
127086     * @since PECL mongo >=0.9.0
127087     **/
127088    public function repair($preserve_cloned_files, $backup_original_files){}
127089
127090    /**
127091     * Clears any flagged errors on the database
127092     *
127093     * This method is not used in normal operations. It resets the database
127094     * error tracker (which can be incremented with {@link
127095     * MongoDB::forceError}, also not normally used).
127096     *
127097     * It is equivalent to running:
127098     *
127099     * <?php
127100     *
127101     * public function resetError() { return
127102     * $this->command(array('reseterror' => 1)); }
127103     *
127104     * ?>
127105     *
127106     * @return array Returns the database response.
127107     * @since PECL mongo >=0.9.5
127108     **/
127109    public function resetError(){}
127110
127111    /**
127112     * Gets a collection
127113     *
127114     * @param string $name The collection name.
127115     * @return MongoCollection Returns a new collection object.
127116     * @since PECL mongo >=0.9.0
127117     **/
127118    public function selectCollection($name){}
127119
127120    /**
127121     * Sets this databases profiling level
127122     *
127123     * This changes the current database profiling level.
127124     *
127125     * This function is equivalent to running:
127126     *
127127     * <?php
127128     *
127129     * public function setProfilingLevel($level) { return
127130     * $this->command(array('profile' => $level)); }
127131     *
127132     * ?>
127133     *
127134     * The options for level are 0 (off), 1 (queries > 100ms), and 2 (all
127135     * queries). If you would like to profile queries that take longer than
127136     * another time period, use the database command and pass it a second
127137     * option, the number of milliseconds. For example, to profile all
127138     * queries that take longer than one second, run:
127139     *
127140     * <?php
127141     *
127142     * $result = $this->command(array('profile' => 1, 'slowms' => 1000));
127143     *
127144     * ?>
127145     *
127146     * Profiled queries will appear in the system.profile collection of this
127147     * database.
127148     *
127149     * @param int $level Profiling level.
127150     * @return int Returns the previous profiling level.
127151     * @since PECL mongo >=0.9.0
127152     **/
127153    public function setProfilingLevel($level){}
127154
127155    /**
127156     * Set the read preference for this database
127157     *
127158     * @param string $read_preference
127159     * @param array $tags
127160     * @return bool
127161     * @since PECL mongo >=1.3.0
127162     **/
127163    public function setReadPreference($read_preference, $tags){}
127164
127165    /**
127166     * Change slaveOkay setting for this database
127167     *
127168     * See the query section of this manual for information on distributing
127169     * reads to secondaries.
127170     *
127171     * @param bool $ok If reads should be sent to secondary members of a
127172     *   replica set for all possible queries using this MongoDB instance.
127173     * @return bool Returns the former value of slaveOkay for this
127174     *   instance.
127175     * @since PECL mongo >=1.1.0
127176     **/
127177    public function setSlaveOkay($ok){}
127178
127179    /**
127180     * Set the write concern for this database
127181     *
127182     * @param mixed $w
127183     * @param int $wtimeout
127184     * @return bool
127185     * @since PECL mongo >=1.5.0
127186     **/
127187    public function setWriteConcern($w, $wtimeout){}
127188
127189    /**
127190     * Creates a new database
127191     *
127192     * This method is not meant to be called directly. The preferred way to
127193     * create an instance of MongoDB is through {@link MongoClient::__get} or
127194     * {@link MongoClient::selectDB}.
127195     *
127196     * If you're ignoring the previous paragraph and want to call it directly
127197     * you can do so:
127198     *
127199     * But don't. Isn't this much nicer:
127200     *
127201     * @param MongoClient $conn Database connection.
127202     * @param string $name Database name.
127203     * @since PECL mongo >=0.9.0
127204     **/
127205    public function __construct($conn, $name){}
127206
127207    /**
127208     * Gets a collection
127209     *
127210     * This is the easiest way of getting a collection from a database
127211     * object. If a collection name contains strange characters, you may have
127212     * to use {@link MongoDB::selectCollection} instead.
127213     *
127214     * <?php
127215     *
127216     * $mongo = new MongoClient();
127217     *
127218     * // the following two lines are equivalent $collection =
127219     * $mongo->selectDB("foo")->selectCollection("bar"); $collection =
127220     * $mongo->foo->bar;
127221     *
127222     * ?>
127223     *
127224     * @param string $name The name of the collection.
127225     * @return MongoCollection Returns the collection.
127226     * @since PECL mongo >=1.0.2
127227     **/
127228    public function __get($name){}
127229
127230    /**
127231     * The name of this database
127232     *
127233     * @return string Returns this databases name.
127234     * @since PECL mongo >=0.9.0
127235     **/
127236    public function __toString(){}
127237
127238}
127239/**
127240 * This class can be used to create lightweight links between objects in
127241 * different collections. Motivation: Suppose we need to refer to a
127242 * document in another collection. The easiest way is to create a field
127243 * in the current document. For example, if we had a "people" collection
127244 * and an "addresses" collection, we might want to create a link between
127245 * each person document and an address document: Linking documents
127246 *
127247 * Then, later on, we can find the person's address by querying the
127248 * "addresses" collection with the MongoId we saved in the "people"
127249 * collection. Suppose now that we have a more general case, where we
127250 * don't know which collection (or even which database) contains the
127251 * referenced document. MongoDBRef is a good choice for this case, as it
127252 * is a common format that all of the drivers and the database
127253 * understand. If each person had a list of things they liked which could
127254 * come from multiple collections, such as "hobbies", "sports", "books",
127255 * etc., we could use MongoDBRefs to keep track of what "like" went with
127256 * what collection: Creating MongoDBRef links
127257 **/
127258class MongoDBRef {
127259    /**
127260     * Creates a new database reference
127261     *
127262     * If no database is given, the current database is used.
127263     *
127264     * @param string $collection Collection name (without the database
127265     *   name).
127266     * @param mixed $id The _id field of the object to which to link.
127267     * @param string $database Database name.
127268     * @return array Returns the reference.
127269     * @since PECL mongo >= 0.9.0
127270     **/
127271    public static function create($collection, $id, $database){}
127272
127273    /**
127274     * Fetches the object pointed to by a reference
127275     *
127276     * @param MongoDB $db Database to use.
127277     * @param array $ref Reference to fetch.
127278     * @return array Returns the document to which the reference refers or
127279     *   NULL if the document does not exist (the reference is broken).
127280     * @since PECL mongo >= 0.9.0
127281     **/
127282    public static function get($db, $ref){}
127283
127284    /**
127285     * Checks if an array is a database reference
127286     *
127287     * This method does not actually follow the reference, so it does not
127288     * determine if it is broken or not. It merely checks that {@link ref} is
127289     * in valid database reference format (in that it is an object or array
127290     * with $ref and $id fields).
127291     *
127292     * @param mixed $ref Array or object to check.
127293     * @return bool
127294     * @since PECL mongo >= 0.9.0
127295     **/
127296    public static function isRef($ref){}
127297
127298}
127299namespace MongoDB\BSON {
127300class Binary implements MongoDB\BSON\BinaryInterface, MongoDB\BSON\Type, Serializable, JsonSerializable {
127301    /**
127302     * Returns the Binarys data
127303     *
127304     * @return string Returns the Binarys data.
127305     **/
127306    final public function getData(){}
127307
127308    /**
127309     * Returns the Binarys type
127310     *
127311     * @return int Returns the Binarys type.
127312     **/
127313    final public function getType(){}
127314
127315    /**
127316     * Returns a representation that can be converted to JSON
127317     *
127318     * @return mixed Returns data which can be serialized by {@link
127319     *   json_encode} to produce an extended JSON representation of the
127320     *   MongoDB\BSON\Binary.
127321     **/
127322    final public function jsonSerialize(){}
127323
127324    /**
127325     * Serialize a Binary
127326     *
127327     * @return string Returns the serialized representation of the
127328     *   MongoDB\BSON\Binary.
127329     **/
127330    final public function serialize(){}
127331
127332    /**
127333     * Unserialize a Binary
127334     *
127335     * @param string $serialized The serialized MongoDB\BSON\Binary.
127336     * @return void Returns the unserialized MongoDB\BSON\Binary.
127337     **/
127338    final public function unserialize($serialized){}
127339
127340    /**
127341     * Construct a new Binary
127342     *
127343     * @param string $data Binary data.
127344     * @param int $type Unsigned 8-bit integer denoting the datas type.
127345     **/
127346    final public function __construct($data, $type){}
127347
127348    /**
127349     * Returns the Binarys data
127350     *
127351     * MongoDB\BSON\Binary::getData.
127352     *
127353     * @return string Returns the Binarys data.
127354     **/
127355    final public function __toString(){}
127356
127357}
127358}
127359namespace MongoDB\BSON {
127360interface BinaryInterface {
127361    /**
127362     * Returns the BinaryInterfaces data
127363     *
127364     * @return string Returns the BinaryInterfaces data.
127365     **/
127366    public function getData();
127367
127368    /**
127369     * Returns the BinaryInterfaces type
127370     *
127371     * @return int Returns the BinaryInterfaces type.
127372     **/
127373    public function getType();
127374
127375    /**
127376     * Returns the BinaryInterfaces data
127377     *
127378     * MongoDB\BSON\BinaryInterface::getData.
127379     *
127380     * @return string Returns the BinaryInterfaces data.
127381     **/
127382    public function __toString();
127383
127384}
127385}
127386namespace MongoDB\BSON {
127387class DBPointer implements MongoDB\BSON\Type, Serializable, JsonSerializable {
127388    /**
127389     * Returns a representation that can be converted to JSON
127390     *
127391     * @return mixed Returns data which can be serialized by {@link
127392     *   json_encode} to produce an extended JSON representation of the
127393     *   MongoDB\BSON\DBPointer.
127394     **/
127395    final public function jsonSerialize(){}
127396
127397    /**
127398     * Serialize a DBPointer
127399     *
127400     * @return string Returns the serialized representation of the
127401     *   MongoDB\BSON\DBPointer.
127402     **/
127403    final public function serialize(){}
127404
127405    /**
127406     * Unserialize a DBPointer
127407     *
127408     * @param string $serialized The serialized MongoDB\BSON\DBPointer.
127409     * @return void Returns the unserialized MongoDB\BSON\DBPointer.
127410     **/
127411    final public function unserialize($serialized){}
127412
127413    /**
127414     * Construct a new DBPointer (unused)
127415     *
127416     * MongoDB\BSON\DBPointer objects are created through conversion from a
127417     * deprecated BSON type and cannot be constructed directly.
127418     **/
127419    final private function __construct(){}
127420
127421    /**
127422     * Returns an empty string
127423     *
127424     * @return string Returns an empty string.
127425     **/
127426    final public function __toString(){}
127427
127428}
127429}
127430namespace MongoDB\BSON {
127431class Decimal128 implements MongoDB\BSON\Decimal128Interface, MongoDB\BSON\Type, Serializable, JsonSerializable {
127432    /**
127433     * Returns a representation that can be converted to JSON
127434     *
127435     * @return mixed Returns data which can be serialized by {@link
127436     *   json_encode} to produce an extended JSON representation of the
127437     *   MongoDB\BSON\Decimal128.
127438     **/
127439    final public function jsonSerialize(){}
127440
127441    /**
127442     * Serialize a Decimal128
127443     *
127444     * @return string Returns the serialized representation of the
127445     *   MongoDB\BSON\Decimal128.
127446     **/
127447    final public function serialize(){}
127448
127449    /**
127450     * Unserialize a Decimal128
127451     *
127452     * @param string $serialized The serialized MongoDB\BSON\Decimal128.
127453     * @return void Returns the unserialized MongoDB\BSON\Decimal128.
127454     **/
127455    final public function unserialize($serialized){}
127456
127457    /**
127458     * Construct a new Decimal128
127459     *
127460     * @param string $value A decimal string.
127461     **/
127462    final public function __construct($value){}
127463
127464    /**
127465     * Returns the string representation of this Decimal128
127466     *
127467     * @return string Returns the string representation of this Decimal128.
127468     **/
127469    final public function __toString(){}
127470
127471}
127472}
127473namespace MongoDB\BSON {
127474interface Decimal128Interface {
127475    /**
127476     * Returns the string representation of this Decimal128Interface
127477     *
127478     * @return string Returns the string representation of this
127479     *   Decimal128Interface.
127480     **/
127481    public function __toString();
127482
127483}
127484}
127485namespace MongoDB\BSON {
127486class Int64 implements MongoDB\BSON\Type, Serializable, JsonSerializable {
127487    /**
127488     * Returns a representation that can be converted to JSON
127489     *
127490     * @return mixed Returns data which can be serialized by {@link
127491     *   json_encode} to produce an extended JSON representation of the
127492     *   MongoDB\BSON\Int64.
127493     **/
127494    final public function jsonSerialize(){}
127495
127496    /**
127497     * Serialize an Int64
127498     *
127499     * @return string Returns the serialized representation of the
127500     *   MongoDB\BSON\Int64.
127501     **/
127502    final public function serialize(){}
127503
127504    /**
127505     * Unserialize an Int64
127506     *
127507     * @param string $serialized The serialized MongoDB\BSON\Int64.
127508     * @return void Returns the unserialized MongoDB\BSON\Int64.
127509     **/
127510    final public function unserialize($serialized){}
127511
127512    /**
127513     * Construct a new Int64 (unused)
127514     *
127515     * MongoDB\BSON\Int64 objects are created through conversion from a
127516     * 64-bit integer BSON type on a 32-bit platform and cannot be
127517     * constructed directly.
127518     **/
127519    final private function __construct(){}
127520
127521    /**
127522     * Returns the string representation of this Int64
127523     *
127524     * @return string Returns the string representation of this Int64.
127525     **/
127526    final public function __toString(){}
127527
127528}
127529}
127530namespace MongoDB\BSON {
127531class Javascript implements MongoDB\BSON\JavascriptInterface, MongoDB\BSON\Type, Serializable, JsonSerializable {
127532    /**
127533     * Returns the Javascripts code
127534     *
127535     * @return string Returns the Javascripts code.
127536     **/
127537    final public function getCode(){}
127538
127539    /**
127540     * Returns the Javascripts scope document
127541     *
127542     * @return object|null Returns the Javascripts scope document, or NULL
127543     *   if the is no scope.
127544     **/
127545    final public function getScope(){}
127546
127547    /**
127548     * Returns a representation that can be converted to JSON
127549     *
127550     * @return mixed Returns data which can be serialized by {@link
127551     *   json_encode} to produce an extended JSON representation of the
127552     *   MongoDB\BSON\Javascript.
127553     **/
127554    final public function jsonSerialize(){}
127555
127556    /**
127557     * Serialize a Javascript
127558     *
127559     * @return string Returns the serialized representation of the
127560     *   MongoDB\BSON\Javascript.
127561     **/
127562    final public function serialize(){}
127563
127564    /**
127565     * Unserialize a Javascript
127566     *
127567     * @param string $serialized The serialized MongoDB\BSON\Javascript.
127568     * @return void Returns the unserialized MongoDB\BSON\Javascript.
127569     **/
127570    final public function unserialize($serialized){}
127571
127572    /**
127573     * Construct a new Javascript
127574     *
127575     * @param string $code Javascript code.
127576     * @param array|object $scope Javascript scope.
127577     **/
127578    final public function __construct($code, $scope){}
127579
127580    /**
127581     * Returns the Javascripts code
127582     *
127583     * MongoDB\BSON\Javascript::getCode.
127584     *
127585     * @return string Returns the Javascripts code.
127586     **/
127587    final public function __toString(){}
127588
127589}
127590}
127591namespace MongoDB\BSON {
127592interface JavascriptInterface {
127593    /**
127594     * Returns the JavascriptInterfaces code
127595     *
127596     * @return string Returns the JavascriptInterfaces code.
127597     **/
127598    public function getCode();
127599
127600    /**
127601     * Returns the JavascriptInterfaces scope document
127602     *
127603     * @return object|null Returns the JavascriptInterfaces scope document.
127604     **/
127605    public function getScope();
127606
127607    /**
127608     * Returns the JavascriptInterfaces code
127609     *
127610     * MongoDB\BSON\JavascriptInterface::getCode.
127611     *
127612     * @return string Returns the JavascriptInterfaces code.
127613     **/
127614    public function __toString();
127615
127616}
127617}
127618namespace MongoDB\BSON {
127619class MaxKey implements MongoDB\BSON\MaxKeyInterface, MongoDB\BSON\Type, Serializable, JsonSerializable {
127620    /**
127621     * Returns a representation that can be converted to JSON
127622     *
127623     * @return mixed Returns data which can be serialized by {@link
127624     *   json_encode} to produce an extended JSON representation of the
127625     *   MongoDB\BSON\MaxKey.
127626     **/
127627    final public function jsonSerialize(){}
127628
127629    /**
127630     * Serialize a MaxKey
127631     *
127632     * @return string Returns the serialized representation of the
127633     *   MongoDB\BSON\MaxKey.
127634     **/
127635    final public function serialize(){}
127636
127637    /**
127638     * Unserialize a MaxKey
127639     *
127640     * @param string $serialized The serialized MongoDB\BSON\MaxKey.
127641     * @return void Returns the unserialized MongoDB\BSON\MaxKey.
127642     **/
127643    final public function unserialize($serialized){}
127644
127645    /**
127646     * Construct a new MaxKey
127647     **/
127648    final public function __construct(){}
127649
127650}
127651}
127652namespace MongoDB\BSON {
127653interface MaxKeyInterface {
127654}
127655}
127656namespace MongoDB\BSON {
127657class MinKey implements MongoDB\BSON\MinKeyInterface, MongoDB\BSON\Type, Serializable, JsonSerializable {
127658    /**
127659     * Returns a representation that can be converted to JSON
127660     *
127661     * @return mixed Returns data which can be serialized by {@link
127662     *   json_encode} to produce an extended JSON representation of the
127663     *   MongoDB\BSON\MinKey.
127664     **/
127665    final public function jsonSerialize(){}
127666
127667    /**
127668     * Serialize a MinKey
127669     *
127670     * @return string Returns the serialized representation of the
127671     *   MongoDB\BSON\MinKey.
127672     **/
127673    final public function serialize(){}
127674
127675    /**
127676     * Unserialize a MinKey
127677     *
127678     * @param string $serialized The serialized MongoDB\BSON\MinKey.
127679     * @return void Returns the unserialized MongoDB\BSON\MinKey.
127680     **/
127681    final public function unserialize($serialized){}
127682
127683    /**
127684     * Construct a new MinKey
127685     **/
127686    final public function __construct(){}
127687
127688}
127689}
127690namespace MongoDB\BSON {
127691interface MinKeyInterface {
127692}
127693}
127694namespace MongoDB\BSON {
127695class ObjectId implements MongoDB\BSON\ObjectIdInterface, MongoDB\BSON\Type, Serializable, JsonSerializable {
127696    /**
127697     * Returns the timestamp component of this ObjectId
127698     *
127699     * The timestamp component of an ObjectId is its most significant 32
127700     * bits, which denotes the number of seconds since the Unix epoch. This
127701     * value is read as an unsigned 32-bit integer with big-endian byte
127702     * order.
127703     *
127704     * @return int Returns the timestamp component of this ObjectId.
127705     **/
127706    final public function getTimestamp(){}
127707
127708    /**
127709     * Returns a representation that can be converted to JSON
127710     *
127711     * @return mixed Returns data which can be serialized by {@link
127712     *   json_encode} to produce an extended JSON representation of the
127713     *   MongoDB\BSON\ObjectId.
127714     **/
127715    final public function jsonSerialize(){}
127716
127717    /**
127718     * Serialize an ObjectId
127719     *
127720     * @return string Returns the serialized representation of the
127721     *   MongoDB\BSON\ObjectId.
127722     **/
127723    final public function serialize(){}
127724
127725    /**
127726     * Unserialize an ObjectId
127727     *
127728     * @param string $serialized The serialized MongoDB\BSON\ObjectId.
127729     * @return void Returns the unserialized MongoDB\BSON\ObjectId.
127730     **/
127731    final public function unserialize($serialized){}
127732
127733    /**
127734     * Construct a new ObjectId
127735     *
127736     * @param string $id A 24-character hexadecimal string. If not
127737     *   provided, the driver will generate an ObjectId.
127738     **/
127739    final public function __construct($id){}
127740
127741    /**
127742     * Returns the hexidecimal representation of this ObjectId
127743     *
127744     * @return string Returns the hexidecimal representation of this
127745     *   ObjectId.
127746     **/
127747    final public function __toString(){}
127748
127749}
127750}
127751namespace MongoDB\BSON {
127752interface ObjectIdInterface {
127753    /**
127754     * Returns the timestamp component of this ObjectIdInterface
127755     *
127756     * @return int Returns the timestamp component of this
127757     *   ObjectIdInterface.
127758     **/
127759    public function getTimestamp();
127760
127761    /**
127762     * Returns the hexidecimal representation of this ObjectIdInterface
127763     *
127764     * @return string Returns the hexidecimal representation of this
127765     *   ObjectIdInterface.
127766     **/
127767    public function __toString();
127768
127769}
127770}
127771namespace MongoDB\BSON {
127772interface Persistable extends MongoDB\BSON\Unserializable, MongoDB\BSON\Serializable {
127773}
127774}
127775namespace MongoDB\BSON {
127776class Regex implements MongoDB\BSON\RegexInterface, MongoDB\BSON\Type, Serializable, JsonSerializable {
127777    /**
127778     * Returns the Regexs flags
127779     *
127780     * @return string Returns the Regexs flags.
127781     **/
127782    final public function getFlags(){}
127783
127784    /**
127785     * Returns the Regexs pattern
127786     *
127787     * @return string Returns the Regexs pattern.
127788     **/
127789    final public function getPattern(){}
127790
127791    /**
127792     * Returns a representation that can be converted to JSON
127793     *
127794     * @return mixed Returns data which can be serialized by {@link
127795     *   json_encode} to produce an extended JSON representation of the
127796     *   MongoDB\BSON\Regex.
127797     **/
127798    final public function jsonSerialize(){}
127799
127800    /**
127801     * Serialize a Regex
127802     *
127803     * @return string Returns the serialized representation of the
127804     *   MongoDB\BSON\Regex.
127805     **/
127806    final public function serialize(){}
127807
127808    /**
127809     * Unserialize a Regex
127810     *
127811     * @param string $serialized The serialized MongoDB\BSON\Regex.
127812     * @return void Returns the unserialized MongoDB\BSON\Regex.
127813     **/
127814    final public function unserialize($serialized){}
127815
127816    /**
127817     * Construct a new Regex
127818     *
127819     * @param string $pattern The regular expression pattern.
127820     * @param string $flags The regular expression flags. Characters in
127821     *   this argument will be sorted alphabetically.
127822     **/
127823    final public function __construct($pattern, $flags){}
127824
127825    /**
127826     * Returns the string representation of this Regex
127827     *
127828     * @return string Returns the string representation of this Regex.
127829     **/
127830    final public function __toString(){}
127831
127832}
127833}
127834namespace MongoDB\BSON {
127835interface RegexInterface {
127836    /**
127837     * Returns the RegexInterfaces flags
127838     *
127839     * @return string Returns the RegexInterfaces flags.
127840     **/
127841    public function getFlags();
127842
127843    /**
127844     * Returns the RegexInterfaces pattern
127845     *
127846     * @return string Returns the RegexInterfaces pattern.
127847     **/
127848    public function getPattern();
127849
127850    /**
127851     * Returns the string representation of this RegexInterface
127852     *
127853     * @return string Returns the string representation of this
127854     *   RegexInterface.
127855     **/
127856    public function __toString();
127857
127858}
127859}
127860namespace MongoDB\BSON {
127861interface Serializable extends MongoDB\BSON\Type {
127862    /**
127863     * Provides an array or document to serialize as BSON
127864     *
127865     * Called during serialization of the object to BSON. The method must
127866     * return an array or stdClass.
127867     *
127868     * Root documents (e.g. a MongoDB\BSON\Serializable passed to {@link
127869     * MongoDB\BSON\fromPHP}) will always be serialized as a BSON document.
127870     * For field values, associative arrays and stdClass instances will be
127871     * serialized as a BSON document and sequential arrays (i.e. sequential,
127872     * numeric indexes starting at 0) will be serialized as a BSON array.
127873     *
127874     * Users are encouraged to include an _id property (e.g. a
127875     * MongoDB\BSON\ObjectId initialized in your constructor) when returning
127876     * data for a BSON root document; otherwise, the driver or database will
127877     * need to generate a MongoDB\BSON\ObjectId when inserting or upserting
127878     * the document, respectively.
127879     *
127880     * @return array|object An array or stdClass to be serialized as a BSON
127881     *   array or document.
127882     **/
127883    public function bsonSerialize();
127884
127885}
127886}
127887namespace MongoDB\BSON {
127888class Symbol implements MongoDB\BSON\Type, Serializable, JsonSerializable {
127889    /**
127890     * Returns a representation that can be converted to JSON
127891     *
127892     * @return mixed Returns data which can be serialized by {@link
127893     *   json_encode} to produce an extended JSON representation of the
127894     *   MongoDB\BSON\Symbol.
127895     **/
127896    final public function jsonSerialize(){}
127897
127898    /**
127899     * Serialize a Symbol
127900     *
127901     * @return string Returns the serialized representation of the
127902     *   MongoDB\BSON\Symbol.
127903     **/
127904    final public function serialize(){}
127905
127906    /**
127907     * Unserialize a Symbol
127908     *
127909     * @param string $serialized The serialized MongoDB\BSON\Symbol.
127910     * @return void Returns the unserialized MongoDB\BSON\Symbol.
127911     **/
127912    final public function unserialize($serialized){}
127913
127914    /**
127915     * Construct a new Symbol (unused)
127916     *
127917     * MongoDB\BSON\Symbol objects are created through conversion from a
127918     * deprecated BSON type and cannot be constructed directly.
127919     **/
127920    final private function __construct(){}
127921
127922    /**
127923     * Returns the Symbol as a string
127924     *
127925     * @return string Returns the string representation of this Symbol.
127926     **/
127927    final public function __toString(){}
127928
127929}
127930}
127931namespace MongoDB\BSON {
127932class Timestamp implements MongoDB\BSON\TimestampInterface, MongoDB\BSON\Type, Serializable, JsonSerializable {
127933    /**
127934     * Returns the increment component of this Timestamp
127935     *
127936     * The increment component of a Timestamp is its least significant 32
127937     * bits, whichs denotes the incrementing ordinal for operations within a
127938     * given second. This value is read as an unsigned 32-bit integer with
127939     * big-endian byte order.
127940     *
127941     * @return int Returns the increment component of this Timestamp.
127942     **/
127943    final public function getIncrement(){}
127944
127945    /**
127946     * Returns the timestamp component of this Timestamp
127947     *
127948     * The timestamp component of a Timestamp is its most significant 32
127949     * bits, which denotes the number of seconds since the Unix epoch. This
127950     * value is read as an unsigned 32-bit integer with big-endian byte
127951     * order.
127952     *
127953     * @return int Returns the timestamp component of this Timestamp.
127954     **/
127955    final public function getTimestamp(){}
127956
127957    /**
127958     * Returns a representation that can be converted to JSON
127959     *
127960     * @return mixed Returns data which can be serialized by {@link
127961     *   json_encode} to produce an extended JSON representation of the
127962     *   MongoDB\BSON\Timestamp.
127963     **/
127964    final public function jsonSerialize(){}
127965
127966    /**
127967     * Serialize a Timestamp
127968     *
127969     * @return string Returns the serialized representation of the
127970     *   MongoDB\BSON\Timestamp.
127971     **/
127972    final public function serialize(){}
127973
127974    /**
127975     * Unserialize a Timestamp
127976     *
127977     * @param string $serialized The serialized MongoDB\BSON\Timestamp.
127978     * @return void Returns the unserialized MongoDB\BSON\Timestamp.
127979     **/
127980    final public function unserialize($serialized){}
127981
127982    /**
127983     * Construct a new Timestamp
127984     *
127985     * @param int $increment 32-bit integer denoting the incrementing
127986     *   ordinal for operations within a given second.
127987     * @param int $timestamp 32-bit integer denoting seconds since the Unix
127988     *   epoch.
127989     **/
127990    final public function __construct($increment, $timestamp){}
127991
127992    /**
127993     * Returns the string representation of this Timestamp
127994     *
127995     * @return string Returns the string representation of this Timestamp.
127996     **/
127997    final public function __toString(){}
127998
127999}
128000}
128001namespace MongoDB\BSON {
128002interface TimestampInterface {
128003    /**
128004     * Returns the increment component of this TimestampInterface
128005     *
128006     * @return int Returns the increment component of this
128007     *   TimestampInterface.
128008     **/
128009    public function getIncrement();
128010
128011    /**
128012     * Returns the timestamp component of this TimestampInterface
128013     *
128014     * @return int Returns the timestamp component of this
128015     *   TimestampInterface.
128016     **/
128017    public function getTimestamp();
128018
128019    /**
128020     * Returns the string representation of this TimestampInterface
128021     *
128022     * @return string Returns the string representation of this
128023     *   TimestampInterface.
128024     **/
128025    public function __toString();
128026
128027}
128028}
128029namespace MongoDB\BSON {
128030interface Type {
128031}
128032}
128033namespace MongoDB\BSON {
128034class Undefined implements MongoDB\BSON\Type, Serializable, JsonSerializable {
128035    /**
128036     * Returns a representation that can be converted to JSON
128037     *
128038     * @return mixed Returns data which can be serialized by {@link
128039     *   json_encode} to produce an extended JSON representation of the
128040     *   MongoDB\BSON\Undefined.
128041     **/
128042    final public function jsonSerialize(){}
128043
128044    /**
128045     * Serialize a Undefined
128046     *
128047     * @return string Returns the serialized representation of the
128048     *   MongoDB\BSON\Undefined.
128049     **/
128050    final public function serialize(){}
128051
128052    /**
128053     * Unserialize a Undefined
128054     *
128055     * @param string $serialized The serialized MongoDB\BSON\Undefined.
128056     * @return void Returns the unserialized MongoDB\BSON\Undefined.
128057     **/
128058    final public function unserialize($serialized){}
128059
128060    /**
128061     * Construct a new Undefined (unused)
128062     *
128063     * MongoDB\BSON\Undefined objects are created through conversion from a
128064     * deprecated BSON type and cannot be constructed directly.
128065     **/
128066    final private function __construct(){}
128067
128068    /**
128069     * Returns an empty string
128070     *
128071     * @return string Returns an empty string.
128072     **/
128073    final public function __toString(){}
128074
128075}
128076}
128077namespace MongoDB\BSON {
128078interface Unserializable {
128079    /**
128080     * Constructs the object from a BSON array or document
128081     *
128082     * Called during unserialization of the object from BSON. The properties
128083     * of the BSON array or document will be passed to the method as an
128084     * array.
128085     *
128086     * Remember to check for an _id property when handling data from a BSON
128087     * document.
128088     *
128089     * @param array $data Properties within the BSON array or document.
128090     * @return void The return value from this method is ignored.
128091     **/
128092    public function bsonUnserialize($data);
128093
128094}
128095}
128096namespace MongoDB\BSON {
128097class UTCDateTime implements MongoDB\BSON\UTCDateTimeInterface, MongoDB\BSON\Type, Serializable, JsonSerializable {
128098    /**
128099     * Returns a representation that can be converted to JSON
128100     *
128101     * @return mixed Returns data which can be serialized by {@link
128102     *   json_encode} to produce an extended JSON representation of the
128103     *   MongoDB\BSON\UTCDateTime.
128104     **/
128105    final public function jsonSerialize(){}
128106
128107    /**
128108     * Serialize a UTCDateTime
128109     *
128110     * @return string Returns the serialized representation of the
128111     *   MongoDB\BSON\UTCDateTime.
128112     **/
128113    final public function serialize(){}
128114
128115    /**
128116     * Returns the DateTime representation of this UTCDateTime
128117     *
128118     * @return DateTime Returns the DateTime representation of this
128119     *   UTCDateTime. The returned DateTime will use the UTC time zone.
128120     **/
128121    final public function toDateTime(){}
128122
128123    /**
128124     * Unserialize a UTCDateTime
128125     *
128126     * @param string $serialized The serialized MongoDB\BSON\UTCDateTime.
128127     * @return void Returns the unserialized MongoDB\BSON\UTCDateTime.
128128     **/
128129    final public function unserialize($serialized){}
128130
128131    /**
128132     * Construct a new UTCDateTime
128133     *
128134     * @param integer|float|string|DateTimeInterface $milliseconds Number
128135     *   of milliseconds since the Unix epoch (Jan 1, 1970). Negative values
128136     *   represent dates before 1970. This value may be provided as a 64-bit
128137     *   integer. For compatibility on 32-bit systems, this parameter may
128138     *   also be provided as a float or string. If the argument is a
128139     *   DateTimeInterface, the number of milliseconds since the Unix epoch
128140     *   will be derived from that value. Note that in versions of PHP
128141     *   versions before 7.1.0, DateTime and DateTimeImmutable objects
128142     *   constructed from the current time did not incorporate sub-second
128143     *   precision. If this argument is NULL, the current time will be used
128144     *   by default.
128145     **/
128146    final public function __construct($milliseconds){}
128147
128148    /**
128149     * Returns the string representation of this UTCDateTime
128150     *
128151     * @return string Returns the string representation of this
128152     *   UTCDateTime.
128153     **/
128154    final public function __toString(){}
128155
128156}
128157}
128158namespace MongoDB\BSON {
128159interface UTCDateTimeInterface {
128160    /**
128161     * Returns the DateTime representation of this UTCDateTimeInterface
128162     *
128163     * @return DateTime Returns the DateTime representation of this
128164     *   UTCDateTimeInterface. The returned DateTime should use the UTC time
128165     *   zone.
128166     **/
128167    public function toDateTime();
128168
128169    /**
128170     * Returns the string representation of this UTCDateTimeInterface
128171     *
128172     * @return string Returns the string representation of this
128173     *   UTCDateTimeInterface.
128174     **/
128175    public function __toString();
128176
128177}
128178}
128179namespace MongoDB\Driver {
128180class BulkWrite implements Countable {
128181    /**
128182     * Count number of write operations in the bulk
128183     *
128184     * Returns the number of write operations added to the
128185     * MongoDB\Driver\BulkWrite object.
128186     *
128187     * @return int Returns number of write operations added to the
128188     *   MongoDB\Driver\BulkWrite object.
128189     **/
128190    public function count(){}
128191
128192    /**
128193     * Add a delete operation to the bulk
128194     *
128195     * Adds a delete operation to the MongoDB\Driver\BulkWrite.
128196     *
128197     * @param array|object $filter deleteOptions Option Type Description
128198     *   Default hint string|array|object Index specification. Specify either
128199     *   the index name as a string or the index key pattern. If specified,
128200     *   then the query system will only consider plans using the hinted
128201     *   index. This option is available in MongoDB 4.4+ and will result in
128202     *   an exception at execution time if specified for an older server
128203     *   version. limit boolean Delete all matching documents (FALSE), or
128204     *   only the first matching document (TRUE) FALSE
128205     * @param array $deleteOptions
128206     * @return void
128207     **/
128208    public function delete($filter, $deleteOptions){}
128209
128210    /**
128211     * Add an insert operation to the bulk
128212     *
128213     * Adds an insert operation to the MongoDB\Driver\BulkWrite.
128214     *
128215     * @param array|object $document A document to insert.
128216     * @return mixed Returns the _id of the inserted document. If the
128217     *   {@link document} did not have an _id, the MongoDB\BSON\ObjectId
128218     *   generated for the insert will be returned.
128219     **/
128220    public function insert($document){}
128221
128222    /**
128223     * Add an update operation to the bulk
128224     *
128225     * Adds an update operation to the MongoDB\Driver\BulkWrite.
128226     *
128227     * @param array|object $filter A document containing either update
128228     *   operators (e.g. $set), a replacement document (i.e. only field:value
128229     *   expressions), or an aggregation pipeline.
128230     * @param array|object $newObj updateOptions Option Type Description
128231     *   Default arrayFilters array An array of filter documents that
128232     *   determines which array elements to modify for an update operation on
128233     *   an array field. See Specify arrayFilters for Array Update Operations
128234     *   in the MongoDB manual for more information. This option is available
128235     *   in MongoDB 3.6+ and will result in an exception at execution time if
128236     *   specified for an older server version. hint string|array|object
128237     *   Index specification. Specify either the index name as a string or
128238     *   the index key pattern. If specified, then the query system will only
128239     *   consider plans using the hinted index. This option is available in
128240     *   MongoDB 4.2+ and will result in an exception at execution time if
128241     *   specified for an older server version. multi boolean Update only the
128242     *   first matching document if FALSE, or all matching documents TRUE.
128243     *   This option cannot be TRUE if {@link newObj} is a replacement
128244     *   document. FALSE upsert boolean If {@link filter} does not match an
128245     *   existing document, insert a single document. The document will be
128246     *   created from {@link newObj} if it is a replacement document (i.e. no
128247     *   update operators); otherwise, the operators in {@link newObj} will
128248     *   be applied to {@link filter} to create the new document. FALSE
128249     * @param array $updateOptions
128250     * @return void
128251     **/
128252    public function update($filter, $newObj, $updateOptions){}
128253
128254    /**
128255     * Create a new BulkWrite
128256     *
128257     * Constructs a new MongoDB\Driver\BulkWrite, which is a mutable object
128258     * to which one or more write operations may be added. The write(s) may
128259     * then be executed with MongoDB\Driver\Manager::executeBulkWrite.
128260     *
128261     * @param array $options options Option Type Description Default
128262     *   bypassDocumentValidation boolean If TRUE, allows insert and update
128263     *   operations to circumvent document level validation. This option is
128264     *   available in MongoDB 3.2+ and is ignored for older server versions,
128265     *   which do not support document level validation. FALSE ordered
128266     *   boolean Ordered operations (TRUE) are executed serially on the
128267     *   MongoDB server, while unordered operations (FALSE) are sent to the
128268     *   server in an arbitrary order and may be executed in parallel. TRUE
128269     **/
128270    public function __construct($options){}
128271
128272}
128273}
128274namespace MongoDB\Driver {
128275class ClientEncryption {
128276    /**
128277     * Create a new encryption data key
128278     *
128279     * Creates a new key document and inserts it into the key vault
128280     * collection.
128281     *
128282     * @param string $kmsProvider The KMS provider ("local" or "aws") that
128283     *   will be used to encrypt the new encryption key.
128284     * @param array $options Data key options Option Type Description
128285     *   masterKey array The masterKey identifies a KMS-specific key used to
128286     *   encrypt the new data key. If the kmsProvider is aws it is required
128287     *   and has the following fields: AWS masterKey options Option Type
128288     *   Description region string Required. key string Required. The Amazon
128289     *   Resource Name (ARN) to the AWS customer master key (CMK). endpoint
128290     *   string Optional. An alternate host identifier to send KMS requests
128291     *   to. May include port number. keyAltNames array An optional list of
128292     *   string alternate names used to reference a key. If a key is created
128293     *   with alternate names, then encryption may refer to the key by the
128294     *   unique alternate name instead of by _id.
128295     * @return MongoDB\BSON\Binary Returns the identifier of the new key as
128296     *   a MongoDB\BSON\Binary object with subtype 4 (UUID).
128297     **/
128298    final public function createDataKey($kmsProvider, $options){}
128299
128300    /**
128301     * Decrypt a value
128302     *
128303     * Decrypts the value.
128304     *
128305     * @param MongoDB\BSON\Binary $value A MongoDB\BSON\Binary instance
128306     *   with subtype 6 containing the encrypted value.
128307     * @return mixed Returns the decrypted value as it was passed to {@link
128308     *   MongoDB\Driver\ClientEncryption::encrypt}.
128309     **/
128310    final public function decrypt($value){}
128311
128312    /**
128313     * Encrypt a value
128314     *
128315     * Encrypts the value.
128316     *
128317     * @param mixed $value The value to be encrypted. Any value that can be
128318     *   inserted into MongoDB can be encrypted using this method.
128319     * @param array $options Encryption options Option Type Description
128320     *   algorithm string The encryption algorithm to be used. Use the
128321     *   constants defined in MongoDB\Driver\ClientEncryption. keyAltName
128322     *   string Identifies a key vault collection document by keyAltName.
128323     *   keyId MongoDB\BSON\Binary Identifies a data key by _id. The value is
128324     *   a UUID (binary subtype 4).
128325     * @return MongoDB\BSON\Binary Returns the encrypted value as
128326     *   MongoDB\BSON\Binary object with subtype 6.
128327     **/
128328    final public function encrypt($value, $options){}
128329
128330}
128331}
128332namespace MongoDB\Driver {
128333class Command {
128334    /**
128335     * Create a new Command
128336     *
128337     * Constructs a new MongoDB\Driver\Command, which is an immutable value
128338     * object that represents a database command. The command may then be
128339     * executed with MongoDB\Driver\Manager::executeCommand.
128340     *
128341     * The complete command document, which includes the command name and its
128342     * options, should be expressed in the {@link document} parameter. The
128343     * {@link commandOptions} parameter is only used to specify options
128344     * related to the execution of the command and the resulting
128345     * MongoDB\Driver\Cursor.
128346     *
128347     * @param array|object $document The complete command document, which
128348     *   will be sent to the server.
128349     * @param array $commandOptions commandOptions Option Type Description
128350     *   maxAwaitTimeMS integer Positive integer denoting the time limit in
128351     *   milliseconds for the server to block a getMore operation if no data
128352     *   is available. This option should only be used in conjunction with
128353     *   commands that return a tailable cursor (e.g. Change Streams).
128354     **/
128355    final public function __construct($document, $commandOptions){}
128356
128357}
128358}
128359namespace MongoDB\Driver {
128360class Cursor implements MongoDB\Driver\CursorInterface {
128361    /**
128362     * Returns the ID for this cursor
128363     *
128364     * Returns the MongoDB\Driver\CursorId associated with this cursor. A
128365     * cursor ID uniquely identifies the cursor on the server.
128366     *
128367     * @return MongoDB\Driver\CursorId Returns the MongoDB\Driver\CursorId
128368     *   for this cursor.
128369     **/
128370    final public function getId(){}
128371
128372    /**
128373     * Returns the server associated with this cursor
128374     *
128375     * Returns the MongoDB\Driver\Server associated with this cursor. This is
128376     * the server that executed the MongoDB\Driver\Query or
128377     * MongoDB\Driver\Command.
128378     *
128379     * @return MongoDB\Driver\Server Returns the MongoDB\Driver\Server
128380     *   associated with this cursor.
128381     **/
128382    final public function getServer(){}
128383
128384    /**
128385     * Checks if the cursor is exhausted or may have additional results
128386     *
128387     * Checks whether there are definitely no additional results available on
128388     * the cursor. This method is similar to the cursor.isExhausted() method
128389     * in the MongoDB shell and is primarily useful when iterating tailable
128390     * cursors.
128391     *
128392     * A cursor has no additional results and is considered "dead" when one
128393     * of the following is true: The current batch has been fully iterated
128394     * and the cursor ID is zero (i.e. a getMore cannot be issued). An error
128395     * was encountered while iterating the cursor. The cursor reached its
128396     * configured limit.
128397     *
128398     * By design, it is not possible to always determine whether a cursor has
128399     * additional results. The cases where a cursor may have more data
128400     * available is as follows: There are additional documents in the current
128401     * batch, which are buffered on the client side. Iterating will fetch a
128402     * document from the local buffer. There are no additional documents in
128403     * the current batch (i.e. local buffer), but the cursor ID is non-zero.
128404     * Iterating will request more documents from the server via a getMore
128405     * operation, which may or may not return additional results and/or
128406     * indicate that the cursor has been closed on the server by returning
128407     * zero for its ID.
128408     *
128409     * @return bool Returns TRUE if there are definitely no additional
128410     *   results available on the cursor, and FALSE otherwise.
128411     **/
128412    final public function isDead(){}
128413
128414    /**
128415     * Sets a type map to use for BSON unserialization
128416     *
128417     * Sets the type map configuration to use when unserializing the BSON
128418     * results into PHP values.
128419     *
128420     * @param array $typemap
128421     * @return void
128422     **/
128423    final public function setTypeMap($typemap){}
128424
128425    /**
128426     * Returns an array containing all results for this cursor
128427     *
128428     * Iterates the cursor and returns its results in an array. {@link
128429     * MongoDB\Driver\Cursor::setTypeMap} may be used to control how
128430     * documents are unserialized into PHP values.
128431     *
128432     * @return array Returns an array containing all results for this
128433     *   cursor.
128434     **/
128435    final public function toArray(){}
128436
128437    /**
128438     * Create a new Cursor (not used)
128439     *
128440     * MongoDB\Driver\Cursor objects are returned as the result of an
128441     * executed command or query and cannot be constructed directly.
128442     **/
128443    final private function __construct(){}
128444
128445}
128446}
128447namespace MongoDB\Driver {
128448class CursorId implements Serializable {
128449    /**
128450     * Serialize a CursorId
128451     *
128452     * @return string Returns the serialized representation of the
128453     *   MongoDB\Driver\CursorId.
128454     **/
128455    final public function serialize(){}
128456
128457    /**
128458     * Unserialize a CursorId
128459     *
128460     * @param string $serialized The serialized MongoDB\Driver\CursorId.
128461     * @return void Returns the unserialized MongoDB\Driver\CursorId.
128462     **/
128463    final public function unserialize($serialized){}
128464
128465    /**
128466     * Create a new CursorId (not used)
128467     *
128468     * MongoDB\Driver\CursorId objects are returned from {@link
128469     * MongoDB\Driver\Cursor::getId} and cannot be constructed directly.
128470     **/
128471    final private function __construct(){}
128472
128473    /**
128474     * String representation of the cursor ID
128475     *
128476     * Returns the string representation of the cursor ID.
128477     *
128478     * @return string Returns the string representation of the cursor ID.
128479     **/
128480    final public function __toString(){}
128481
128482}
128483}
128484namespace MongoDB\Driver {
128485interface CursorInterface extends Traversable {
128486    /**
128487     * Returns the ID for this cursor
128488     *
128489     * Returns the MongoDB\Driver\CursorId associated with this cursor. A
128490     * cursor ID uniquely identifies the cursor on the server.
128491     *
128492     * @return MongoDB\Driver\CursorId Returns the MongoDB\Driver\CursorId
128493     *   for this cursor.
128494     **/
128495    public function getId();
128496
128497    /**
128498     * Returns the server associated with this cursor
128499     *
128500     * Returns the MongoDB\Driver\Server associated with this cursor. This is
128501     * the server that executed the MongoDB\Driver\Query or
128502     * MongoDB\Driver\Command.
128503     *
128504     * @return MongoDB\Driver\Server Returns the MongoDB\Driver\Server
128505     *   associated with this cursor.
128506     **/
128507    public function getServer();
128508
128509    /**
128510     * Checks if the cursor may have additional results
128511     *
128512     * Checks whether the cursor may have additional results available to
128513     * read. A cursor is initially "alive" but may become "dead" for any of
128514     * the following reasons: Advancing a non-tailable cursor did not return
128515     * a document The cursor encountered an error The cursor read its last
128516     * batch to completion The cursor reached its configured limit This is
128517     * primarily useful with tailable cursors.
128518     *
128519     * @return bool Returns TRUE if additional results are not available,
128520     *   and FALSE otherwise.
128521     **/
128522    public function isDead();
128523
128524    /**
128525     * Sets a type map to use for BSON unserialization
128526     *
128527     * Sets the type map configuration to use when unserializing the BSON
128528     * results into PHP values.
128529     *
128530     * @param array $typemap
128531     * @return void
128532     **/
128533    public function setTypeMap($typemap);
128534
128535    /**
128536     * Returns an array containing all results for this cursor
128537     *
128538     * Iterates the cursor and returns its results in an array. {@link
128539     * MongoDB\Driver\CursorInterface::setTypeMap} may be used to control how
128540     * documents are unserialized into PHP values.
128541     *
128542     * @return array Returns an array containing all results for this
128543     *   cursor.
128544     **/
128545    public function toArray();
128546
128547}
128548}
128549namespace MongoDB\Driver\Exception {
128550class AuthenticationException extends MongoDB\Driver\Exception\ConnectionException implements MongoDB\Driver\Exception\Exception {
128551}
128552}
128553namespace MongoDB\Driver\Exception {
128554class BulkWriteException extends MongoDB\Driver\Exception\WriteException implements MongoDB\Driver\Exception\Exception {
128555}
128556}
128557namespace MongoDB\Driver\Exception {
128558class CommandException extends MongoDB\Driver\Exception\ServerException implements MongoDB\Driver\Exception\Exception {
128559    /**
128560     * @var object
128561     **/
128562    protected $resultDocument;
128563
128564    /**
128565     * Returns the result document for the failed command
128566     *
128567     * @return object The result document for the failed command.
128568     **/
128569    final public function getResultDocument(){}
128570
128571}
128572}
128573namespace MongoDB\Driver\Exception {
128574class ConnectionException extends MongoDB\Driver\Exception\RuntimeException implements MongoDB\Driver\Exception\Exception {
128575}
128576}
128577namespace MongoDB\Driver\Exception {
128578class ConnectionTimeoutException extends MongoDB\Driver\Exception\ConnectionException implements MongoDB\Driver\Exception\Exception {
128579}
128580}
128581namespace MongoDB\Driver\Exception {
128582class EncryptionException extends MongoDB\Driver\Exception\RuntimeException implements MongoDB\Driver\Exception\Exception {
128583}
128584}
128585namespace MongoDB\Driver\Exception {
128586interface Exception {
128587}
128588}
128589namespace MongoDB\Driver\Exception {
128590class ExecutionTimeoutException extends MongoDB\Driver\Exception\ServerException implements MongoDB\Driver\Exception\Exception {
128591}
128592}
128593namespace MongoDB\Driver\Exception {
128594class InvalidArgumentException extends InvalidArgumentException implements MongoDB\Driver\Exception\Exception {
128595}
128596}
128597namespace MongoDB\Driver\Exception {
128598class LogicException extends LogicException implements MongoDB\Driver\Exception\Exception {
128599}
128600}
128601namespace MongoDB\Driver\Exception {
128602class RuntimeException extends RuntimeException implements MongoDB\Driver\Exception\Exception {
128603    /**
128604     * @var array|null
128605     **/
128606    protected $errorLabels;
128607
128608    /**
128609     * Returns whether an error label is associated with an exception
128610     *
128611     * Returns whether the {@link errorLabel} has been set for this
128612     * exception. Error labels are set by either the server or the driver to
128613     * indicated specific situations on which you might want to decide on how
128614     * you want to handle a specific exception. A common situation might be
128615     * to find out whether you can safely retry a transaction that failed due
128616     * to a transient error (like a networking issue, or a transaction
128617     * conflict). Examples of error labels are TransientTransactionError and
128618     * UnknownTransactionCommitResult.
128619     *
128620     * @param string $errorLabel The name of the errorLabel to test for.
128621     * @return bool Whether the given errorLabel is associated with this
128622     *   exception.
128623     **/
128624    final public function hasErrorLabel($errorLabel){}
128625
128626}
128627}
128628namespace MongoDB\Driver\Exception {
128629class ServerException extends MongoDB\Driver\Exception\RuntimeException implements MongoDB\Driver\Exception\Exception {
128630}
128631}
128632namespace MongoDB\Driver\Exception {
128633class SSLConnectionException extends MongoDB\Driver\Exception\ConnectionException implements MongoDB\Driver\Exception\Exception {
128634}
128635}
128636namespace MongoDB\Driver\Exception {
128637class UnexpectedValueException extends UnexpectedValueException implements MongoDB\Driver\Exception\Exception {
128638}
128639}
128640namespace MongoDB\Driver\Exception {
128641abstract class WriteException extends MongoDB\Driver\Exception\ServerException implements MongoDB\Driver\Exception\Exception {
128642    /**
128643     * @var MongoDB\Driver\WriteResult
128644     **/
128645    protected $writeResult;
128646
128647    /**
128648     * Returns the WriteResult for the failed write operation
128649     *
128650     * Returns the MongoDB\Driver\WriteResult for the failed write operation.
128651     * The {@link MongoDB\Driver\WriteResult::getWriteErrors} and {@link
128652     * MongoDB\Driver\WriteResult::getWriteConcernError} methods may be used
128653     * to get more details about the failure.
128654     *
128655     * @return MongoDB\Driver\WriteResult The MongoDB\Driver\WriteResult
128656     *   for the failed write operation.
128657     **/
128658    final public function getWriteResult(){}
128659
128660}
128661}
128662namespace MongoDB\Driver {
128663class Manager {
128664    /**
128665     * Create a new ClientEncryption object
128666     *
128667     * Constructs a new MongoDB\Driver\ClientEncryption object with the
128668     * specified options.
128669     *
128670     * @param array $options options Option Type Description
128671     * @return MongoDB\Driver\ClientEncryption Returns a new
128672     *   MongoDB\Driver\ClientEncryption instance.
128673     **/
128674    final public function createClientEncryption($options){}
128675
128676    /**
128677     * Execute one or more write operations
128678     *
128679     * Executes one or more write operations on the primary server.
128680     *
128681     * A MongoDB\Driver\BulkWrite can be constructed with one or more write
128682     * operations of varying types (e.g. updates, deletes, and inserts). The
128683     * driver will attempt to send operations of the same type to the server
128684     * in as few requests as possible to optimize round trips.
128685     *
128686     * @param string $namespace options Option Type Description
128687     * @param MongoDB\Driver\BulkWrite $bulk
128688     * @param array $options
128689     * @return MongoDB\Driver\WriteResult
128690     **/
128691    final public function executeBulkWrite($namespace, $bulk, $options){}
128692
128693    /**
128694     * Execute a database command
128695     *
128696     * Selects a server according to the "readPreference" option and executes
128697     * the command on that server. By default, the read preference from the
128698     * MongoDB Connection URI will be used.
128699     *
128700     * This method applies no special logic to the command. Although this
128701     * method accepts "readConcern" and "writeConcern" options, which will be
128702     * incorporated into the command document, those options will not default
128703     * to corresponding values from the MongoDB Connection URI nor will the
128704     * MongoDB server version be taken into account. Users are therefore
128705     * encouraged to use specific read and/or write command methods if
128706     * possible.
128707     *
128708     * @param string $db options Option Type Description
128709     * @param MongoDB\Driver\Command $command
128710     * @param array $options
128711     * @return MongoDB\Driver\Cursor
128712     **/
128713    final public function executeCommand($db, $command, $options){}
128714
128715    /**
128716     * Execute a database query
128717     *
128718     * Selects a server according to the "readPreference" option and executes
128719     * the query on that server. By default, the read preference from the
128720     * MongoDB Connection URI will be used.
128721     *
128722     * @param string $namespace options Option Type Description
128723     * @param MongoDB\Driver\Query $query
128724     * @param array $options
128725     * @return MongoDB\Driver\Cursor
128726     **/
128727    final public function executeQuery($namespace, $query, $options){}
128728
128729    /**
128730     * Execute a database command that reads
128731     *
128732     * Selects a server according to the "readPreference" option and executes
128733     * the command on that server. By default, the read preference from the
128734     * MongoDB Connection URI will be used.
128735     *
128736     * This method will apply logic that is specific to commands that read
128737     * (e.g. count) and take the MongoDB server version into account. The
128738     * "readConcern" option will default to the corresponding value from the
128739     * MongoDB Connection URI.
128740     *
128741     * @param string $db options Option Type Description
128742     * @param MongoDB\Driver\Command $command
128743     * @param array $options
128744     * @return MongoDB\Driver\Cursor
128745     **/
128746    final public function executeReadCommand($db, $command, $options){}
128747
128748    /**
128749     * Execute a database command that reads and writes
128750     *
128751     * Executes the command on the primary server.
128752     *
128753     * This method will apply logic that is specific to commands that read
128754     * and write (e.g. aggregate) and take the MongoDB server version into
128755     * account. The "readConcern" and "writeConcern" options will default to
128756     * the corresponding values from the MongoDB Connection URI.
128757     *
128758     * @param string $db options Option Type Description
128759     * @param MongoDB\Driver\Command $command
128760     * @param array $options
128761     * @return MongoDB\Driver\Cursor
128762     **/
128763    final public function executeReadWriteCommand($db, $command, $options){}
128764
128765    /**
128766     * Execute a database command that writes
128767     *
128768     * Executes the command on the primary server.
128769     *
128770     * This method will apply logic that is specific to commands that write
128771     * (e.g. drop) and take the MongoDB server version into account. The
128772     * "writeConcern" option will default to the corresponding value from the
128773     * MongoDB Connection URI.
128774     *
128775     * @param string $db options Option Type Description
128776     * @param MongoDB\Driver\Command $command
128777     * @param array $options
128778     * @return MongoDB\Driver\Cursor
128779     **/
128780    final public function executeWriteCommand($db, $command, $options){}
128781
128782    /**
128783     * Return the ReadConcern for the Manager
128784     *
128785     * Returns the MongoDB\Driver\ReadConcern for the Manager, which is
128786     * derived from its URI options. This is the default read concern for
128787     * queries and commands executed on the Manager.
128788     *
128789     * @return MongoDB\Driver\ReadConcern The MongoDB\Driver\ReadConcern
128790     *   for the Manager.
128791     **/
128792    final public function getReadConcern(){}
128793
128794    /**
128795     * Return the ReadPreference for the Manager
128796     *
128797     * Returns the MongoDB\Driver\ReadPreference for the Manager, which is
128798     * derived from its URI options. This is the default read preference for
128799     * queries and commands executed on the Manager.
128800     *
128801     * @return MongoDB\Driver\ReadPreference The
128802     *   MongoDB\Driver\ReadPreference for the Manager.
128803     **/
128804    final public function getReadPreference(){}
128805
128806    /**
128807     * Return the servers to which this manager is connected
128808     *
128809     * Returns an array of MongoDB\Driver\Server instances to which this
128810     * manager is connected.
128811     *
128812     * @return array Returns an array of MongoDB\Driver\Server instances to
128813     *   which this manager is connected.
128814     **/
128815    final public function getServers(){}
128816
128817    /**
128818     * Return the WriteConcern for the Manager
128819     *
128820     * Returns the MongoDB\Driver\WriteConcern for the Manager, which is
128821     * derived from its URI options. This is the default write concern for
128822     * writes and commands executed on the Manager.
128823     *
128824     * @return MongoDB\Driver\WriteConcern The MongoDB\Driver\WriteConcern
128825     *   for the Manager.
128826     **/
128827    final public function getWriteConcern(){}
128828
128829    /**
128830     * Select a server matching a read preference
128831     *
128832     * Selects a MongoDB\Driver\Server matching {@link readPreference}. This
128833     * may be used to preselect a server in order to perform version checking
128834     * before executing an operation.
128835     *
128836     * @param MongoDB\Driver\ReadPreference $readPreference The read
128837     *   preference to use for selecting a server.
128838     * @return MongoDB\Driver\Server Returns a MongoDB\Driver\Server
128839     *   matching the read preference.
128840     **/
128841    final public function selectServer($readPreference){}
128842
128843    /**
128844     * Start a new client session for use with this client
128845     *
128846     * Creates a MongoDB\Driver\Session for the given options. The session
128847     * may then be specified when executing commands, queries, and write
128848     * operations.
128849     *
128850     * @param array $options options Option Type Description Default
128851     *   causalConsistency boolean Configure causal consistency in a session.
128852     *   If TRUE, each operation in the session will be causally ordered
128853     *   after the previous read or write operation. Set to FALSE to disable
128854     *   causal consistency. See Casual Consistency in the MongoDB manual for
128855     *   more information. TRUE defaultTransactionOptions array Default
128856     *   options to apply to newly created transactions. These options are
128857     *   used unless they are overridden when a transaction is started with
128858     *   different value for each option. options Option Type Description
128859     *   This option is available in MongoDB 4.0+. []
128860     * @return MongoDB\Driver\Session Returns a MongoDB\Driver\Session.
128861     **/
128862    final public function startSession($options){}
128863
128864    /**
128865     * Create new MongoDB Manager
128866     *
128867     * Constructs a new MongoDB\Driver\Manager object with the specified
128868     * options.
128869     *
128870     * @param string $uri A mongodb:// connection URI:
128871     *
128872     *   mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[defaultAuthDb][?options]]
128873     *
128874     *   For details on supported URI options, see Connection String Options
128875     *   in the MongoDB manual. Connection pool options are not supported, as
128876     *   the PHP driver does not implement connection pools. The {@link uri}
128877     *   is a URL, hence any special characters in its components need to be
128878     *   URL encoded according to RFC 3986. This is particularly relevant to
128879     *   the username and password, which can often include special
128880     *   characters such as @, :, or %. When connecting via a Unix domain
128881     *   socket, the socket path may contain special characters such as
128882     *   slashes and must be encoded. The {@link rawurlencode} function may
128883     *   be used to encode constituent parts of the URI. The defaultAuthDb
128884     *   component may be used to specify the database name associated with
128885     *   the user's credentials; however the authSource URI option will take
128886     *   priority if specified. If neither defaultAuthDb nor authSource are
128887     *   specified, the admin database will be used by default. The
128888     *   defaultAuthDb component has no effect in the absence of user
128889     *   credentials.
128890     * @param array $uriOptions Additional connection string options, which
128891     *   will overwrite any options with the same name in the {@link uri}
128892     *   parameter.
128893     *
128894     *   uriOptions Option Type Description appname string MongoDB 3.4+ has
128895     *   the ability to annotate connections with metadata provided by the
128896     *   connecting client. This metadata is included in the server's logs
128897     *   upon establishing a connection and also recorded in slow query logs
128898     *   when database profiling is enabled. This option may be used to
128899     *   specify an application name, which will be included in the metadata.
128900     *   The value cannot exceed 128 characters in length. authMechanism
128901     *   string The authentication mechanism that MongoDB will use to
128902     *   authenticate the connection. For additional details and a list of
128903     *   supported values, see Authentication Options in the MongoDB manual.
128904     *   authMechanismProperties array Properties for the selected
128905     *   authentication mechanism. For additional details and a list of
128906     *   supported properties, see the Driver Authentication Specification.
128907     *   When not specified in the URI string, this option is expressed as an
128908     *   array of key/value pairs. The keys and values in this array should
128909     *   be strings. authSource string The database name associated with the
128910     *   user's credentials. Defaults to the database component of the
128911     *   connection URI, or the admin database if both are unspecified. For
128912     *   authentication mechanisms that delegate credential storage to other
128913     *   services (e.g. GSSAPI), this should be "$external".
128914     *   canonicalizeHostname boolean If TRUE, the driver will resolve the
128915     *   real hostname for the server IP address before authenticating via
128916     *   SASL. Some underlying GSSAPI layers already do this, but the
128917     *   functionality may be disabled in their config (e.g. krb.conf).
128918     *   Defaults to FALSE. This option is a deprecated alias for the
128919     *   "CANONICALIZE_HOST_NAME" property of the "authMechanismProperties"
128920     *   URI option. compressors string A prioritized, comma-delimited list
128921     *   of compressors that the client wants to use. Messages are only
128922     *   compressed if the client and server share any compressors in common,
128923     *   and the compressor used in each direction will depend on the
128924     *   individual configuration of the server or driver. See the Driver
128925     *   Compression Specification for more information. connectTimeoutMS
128926     *   integer The time in milliseconds to attempt a connection before
128927     *   timing out. Defaults to 10,000 milliseconds. directConnection
128928     *   boolean This option can be used to control replica set discovery
128929     *   behavior when only a single host is provided in the connection
128930     *   string. By default, providing a single member in the connection
128931     *   string will establish a direct connection or discover additional
128932     *   members depending on whether the "replicaSet" URI option is omitted
128933     *   or present, respectively. Specify FALSE to force discovery to occur
128934     *   (if "replicaSet" is omitted) or specify TRUE to force a direct
128935     *   connection (if "replicaSet" is present). gssapiServiceName string
128936     *   Set the Kerberos service name when connecting to Kerberized MongoDB
128937     *   instances. This value must match the service name set on MongoDB
128938     *   instances (i.e. saslServiceName server parameter). Defaults to
128939     *   "mongodb". This option is a deprecated alias for the "SERVICE_NAME"
128940     *   property of the "authMechanismProperties" URI option.
128941     *   heartbeatFrequencyMS integer Specifies the interval in milliseconds
128942     *   between the driver's checks of the MongoDB topology, counted from
128943     *   the end of the previous check until the beginning of the next one.
128944     *   Defaults to 60,000 milliseconds. Per the Server Discovery and
128945     *   Monitoring Specification, this value cannot be less than 500
128946     *   milliseconds. journal boolean Corresponds to the default write
128947     *   concern's {@link journal} parameter. If TRUE, writes will require
128948     *   acknowledgement from MongoDB that the operation has been written to
128949     *   the journal. For details, see MongoDB\Driver\WriteConcern.
128950     *   localThresholdMS integer The size in milliseconds of the latency
128951     *   window for selecting among multiple suitable MongoDB instances while
128952     *   resolving a read preference. Defaults to 15 milliseconds.
128953     *   maxStalenessSeconds integer Corresponds to the read preference's
128954     *   "maxStalenessSeconds". Specifies, in seconds, how stale a secondary
128955     *   can be before the client stops using it for read operations. By
128956     *   default, there is no maximum staleness and clients will not consider
128957     *   a secondary’s lag when choosing where to direct a read operation.
128958     *   For details, see MongoDB\Driver\ReadPreference. If specified, the
128959     *   max staleness must be a signed 32-bit integer greater than or equal
128960     *   to MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS
128961     *   (i.e. 90 seconds). password string The password for the user being
128962     *   authenticated. This option is useful if the password contains
128963     *   special characters, which would otherwise need to be URL encoded for
128964     *   the connection URI. readConcernLevel string Corresponds to the read
128965     *   concern's {@link level} parameter. Specifies the level of read
128966     *   isolation. For details, see MongoDB\Driver\ReadConcern.
128967     *   readPreference string Corresponds to the read preference's {@link
128968     *   mode} parameter. Defaults to "primary". For details, see
128969     *   MongoDB\Driver\ReadPreference. readPreferenceTags array Corresponds
128970     *   to the read preference's {@link tagSets} parameter. Tag sets allow
128971     *   you to target read operations to specific members of a replica set.
128972     *   For details, see MongoDB\Driver\ReadPreference. When not specified
128973     *   in the URI string, this option is expressed as an array consistent
128974     *   with the format expected by {@link
128975     *   MongoDB\Driver\ReadPreference::__construct}. replicaSet string
128976     *   Specifies the name of the replica set. retryReads boolean Specifies
128977     *   whether or not the driver should automatically retry certain read
128978     *   operations that fail due to transient network errors or replica set
128979     *   elections. This functionality requires MongoDB 3.6+. Defaults to
128980     *   TRUE. See the Retryable Reads Specification for more information.
128981     *   retryWrites boolean Specifies whether or not the driver should
128982     *   automatically retry certain write operations that fail due to
128983     *   transient network errors or replica set elections. This
128984     *   functionality requires MongoDB 3.6+. Defaults to TRUE. See Retryable
128985     *   Writes in the MongoDB manual for more information. safe boolean If
128986     *   TRUE, specifies 1 for the default write concern's {@link w}
128987     *   parameter. If FALSE, 0 is specified. For details, see
128988     *   MongoDB\Driver\WriteConcern. This option is deprecated and should
128989     *   not be used. serverSelectionTimeoutMS integer Specifies how long in
128990     *   milliseconds to block for server selection before throwing an
128991     *   exception. Defaults to 30,000 milliseconds. serverSelectionTryOnce
128992     *   boolean When TRUE, instructs the driver to scan the MongoDB
128993     *   deployment exactly once after server selection fails and then either
128994     *   select a server or raise an error. When FALSE, the driver blocks and
128995     *   searches for a server up to the "serverSelectionTimeoutMS" value.
128996     *   Defaults to TRUE. slaveOk boolean Specifies "secondaryPreferred" for
128997     *   the read preference mode if TRUE. For details, see
128998     *   MongoDB\Driver\ReadPreference. This option is deprecated and should
128999     *   not be used. socketCheckIntervalMS integer If a socket has not been
129000     *   used recently, the driver must check it via an isMaster command
129001     *   before using it for any operation. Defaults to 5,000 milliseconds.
129002     *   socketTimeoutMS integer The time in milliseconds to attempt a send
129003     *   or receive on a socket before timing out. Defaults to 300,000
129004     *   milliseconds (i.e. five minutes). ssl boolean Initiates the
129005     *   connection with TLS/SSL if TRUE. Defaults to FALSE. This option is a
129006     *   deprecated alias for the "tls" URI option. tls boolean Initiates the
129007     *   connection with TLS/SSL if TRUE. Defaults to FALSE.
129008     *   tlsAllowInvalidCertificates boolean Specifies whether or not the
129009     *   driver should error when the server's TLS certificate is invalid.
129010     *   Defaults to FALSE. Disabling certificate validation creates a
129011     *   vulnerability. tlsAllowInvalidHostnames boolean Specifies whether or
129012     *   not the driver should error when there is a mismatch between the
129013     *   server's hostname and the hostname specified by the TLS certificate.
129014     *   Defaults to FALSE. Disabling certificate validation creates a
129015     *   vulnerability. Allowing invalid hostnames may expose the driver to a
129016     *   man-in-the-middle attack. tlsCAFile string Path to file with either
129017     *   a single or bundle of certificate authorities to be considered
129018     *   trusted when making a TLS connection. The system certificate store
129019     *   will be used by default. tlsCertificateKeyFile string Path to the
129020     *   client certificate file or the client private key file; in the case
129021     *   that they both are needed, the files should be concatenated.
129022     *   tlsCertificateKeyFilePassword string Password to decrypt the client
129023     *   private key (i.e. "tlsCertificateKeyFile" URI option) to be used for
129024     *   TLS connections. tlsDisableCertificateRevocationCheck boolean If
129025     *   TRUE, the driver will not attempt to check certificate revocation
129026     *   status (e.g. OCSP, CRL). Defaults to FALSE.
129027     *   tlsDisableOCSPEndpointCheck boolean If TRUE, the driver will not
129028     *   attempt to contact an OCSP responder endpoint if needed (i.e. an
129029     *   OCSP response is not stapled). Defaults to FALSE. tlsInsecure
129030     *   boolean Relax TLS constraints as much as possible. Specifying TRUE
129031     *   for this option has the same effect as specifying TRUE for both the
129032     *   "tlsAllowInvalidCertificates" and "tlsAllowInvalidHostnames" URI
129033     *   options. Defaults to FALSE. Disabling certificate validation creates
129034     *   a vulnerability. Allowing invalid hostnames may expose the driver to
129035     *   a man-in-the-middle attack. username string The username for the
129036     *   user being authenticated. This option is useful if the username
129037     *   contains special characters, which would otherwise need to be URL
129038     *   encoded for the connection URI. w integer|string Corresponds to the
129039     *   default write concern's {@link w} parameter. For details, see
129040     *   MongoDB\Driver\WriteConcern. wTimeoutMS integer|string Corresponds
129041     *   to the default write concern's {@link wtimeout} parameter. Specifies
129042     *   a time limit, in milliseconds, for the write concern. For details,
129043     *   see MongoDB\Driver\WriteConcern. If specified, wTimeoutMS must be a
129044     *   signed 32-bit integer greater than or equal to zero.
129045     *   zlibCompressionLevel integer Specifies the compression level to use
129046     *   for the zlib compressor. This option has no effect if zlib is not
129047     *   included in the "compressors" URI option. See the Driver Compression
129048     *   Specification for more information.
129049     * @param array $driverOptions driverOptions Option Type Description
129050     *   allow_invalid_hostname boolean Disables hostname validation if TRUE.
129051     *   Defaults to FALSE. Allowing invalid hostnames may expose the driver
129052     *   to a man-in-the-middle attack. This option is a deprecated alias for
129053     *   the "tlsAllowInvalidHostnames" URI option. autoEncryption array
129054     *   Provides options to enable automatic client-side field level
129055     *   encryption. The following options are supported:
129056     *
129057     *   Options for automatic encryption Option Type Description schemaMap
129058     *   array Allows specifying a local JSON schema that is used to
129059     *   configure encryption. Supplying a schemaMap provides more security
129060     *   than relying on JSON schemas obtained from the server. It protects
129061     *   against a malicious server advertising a false JSON schema, which
129062     *   could trick the client into sending unencrypted data that should be
129063     *   encrypted. Schemas supplied in the schemaMap only apply to
129064     *   configuring automatic encryption for client side encryption. Other
129065     *   validation rules in the JSON schema will not be enforced by the
129066     *   driver and will result in an error. bypassAutoEncryption boolean
129067     *   With this option set to TRUE, mongocryptd will not be spawned
129068     *   automatically. This is used to disable automatic encryption.
129069     *   extraOptions array The extraOptions relate to the mongocryptd
129070     *   process. See the Client-Side Encryption Specification for more
129071     *   information.
129072     *
129073     *   Automatic encryption is an enterprise only feature that only applies
129074     *   to operations on a collection. Automatic encryption is not supported
129075     *   for operations on a database or view, and operations that are not
129076     *   bypassed will result in error. To bypass automatic encryption for
129077     *   all operations, set bypassAutoEncryption=true in autoEncryption. For
129078     *   more information on whitelisted operations, see the Client-Side
129079     *   Encryption Specification. ca_dir string Path to a correctly hashed
129080     *   certificate directory. The system certificate store will be used by
129081     *   default. ca_file string Path to file with either a single or bundle
129082     *   of certificate authorities to be considered trusted when making a
129083     *   TLS connection. The system certificate store will be used by
129084     *   default. This option is a deprecated alias for the "tlsCAFile" URI
129085     *   option. context resource SSL context options to be used as fallbacks
129086     *   if a driver option or its equivalent URI option, if any, is not
129087     *   specified. Note that the driver does not consult the default stream
129088     *   context (i.e. {@link stream_context_get_default}). The following
129089     *   context options are supported:
129090     *
129091     *   SSL context option fallbacks Driver option Context option (fallback)
129092     *   ca_dir capath ca_file cafile pem_file local_cert pem_pwd passphrase
129093     *   weak_cert_validation allow_self_signed This option is supported for
129094     *   backwards compatibility, but should be considered deprecated.
129095     *   crl_file string Path to a certificate revocation list file. driver
129096     *   array Allows custom drivers to append their own metadata to the
129097     *   server handshake. By default, the driver submits its own name,
129098     *   version, and platform (i.e. PHP version) in the handshake. Custom
129099     *   drivers can specify strings for the "name", "version", and
129100     *   "platform" keys of this array, which will be appended to the
129101     *   respective field(s) in the handshake document. Handshake information
129102     *   is limited to 512 bytes. The driver will truncate handshake data to
129103     *   fit within this 512-byte string. Drivers and ODMs are encouraged to
129104     *   keep their own metadata concise. pem_file string Path to a PEM
129105     *   encoded certificate to use for client authentication. This option is
129106     *   a deprecated alias for the "tlsCertificateKeyFile" URI option.
129107     *   pem_pwd string Passphrase for the PEM encoded certificate (if
129108     *   applicable). This option is a deprecated alias for the
129109     *   "tlsCertificateKeyFilePassword" URI option. weak_cert_validation
129110     *   boolean Disables certificate validation if TRUE. Defaults to FALSE
129111     *   This option is a deprecated alias for the "tlsAllowInvalidHostnames"
129112     *   URI option.
129113     **/
129114    final public function __construct($uri, $uriOptions, $driverOptions){}
129115
129116}
129117}
129118namespace MongoDB\Driver\Monitoring {
129119class CommandFailedEvent {
129120    /**
129121     * Returns the command name
129122     *
129123     * Returns the command name (e.g. "find", "aggregate").
129124     *
129125     * @return string Returns the command name.
129126     **/
129127    final public function getCommandName(){}
129128
129129    /**
129130     * Returns the command's duration in microseconds
129131     *
129132     * The command's duration is a calculated value that includes the time to
129133     * send the message and receive the reply from the server.
129134     *
129135     * @return int Returns the command's duration in microseconds.
129136     **/
129137    final public function getDurationMicros(){}
129138
129139    /**
129140     * Returns the Exception associated with the failed command
129141     *
129142     * @return Exception Returns the Exception associated with the failed
129143     *   command.
129144     **/
129145    final public function getError(){}
129146
129147    /**
129148     * Returns the command's operation ID
129149     *
129150     * The operation ID is generated by the driver and may be used to link
129151     * events together such as bulk write operations, which may have been
129152     * split across several commands at the protocol level.
129153     *
129154     * @return string Returns the command's operation ID.
129155     **/
129156    final public function getOperationId(){}
129157
129158    /**
129159     * Returns the command reply document
129160     *
129161     * The reply document will be converted from BSON to PHP using the
129162     * default deserialization rules (e.g. BSON documents will be converted
129163     * to stdClass).
129164     *
129165     * @return object Returns the command reply document as a stdClass
129166     *   object.
129167     **/
129168    final public function getReply(){}
129169
129170    /**
129171     * Returns the command's request ID
129172     *
129173     * The request ID is generated by the driver and may be used to associate
129174     * this MongoDB\Driver\Monitoring\CommandFailedEvent with a previous
129175     * MongoDB\Driver\Monitoring\CommandStartedEvent.
129176     *
129177     * @return string Returns the command's request ID.
129178     **/
129179    final public function getRequestId(){}
129180
129181    /**
129182     * Returns the Server on which the command was executed
129183     *
129184     * Returns the MongoDB\Driver\Server on which the command was executed.
129185     *
129186     * @return MongoDB\Driver\Server Returns the MongoDB\Driver\Server on
129187     *   which the command was executed.
129188     **/
129189    final public function getServer(){}
129190
129191}
129192}
129193namespace MongoDB\Driver\Monitoring {
129194class CommandStartedEvent {
129195    /**
129196     * Returns the command document
129197     *
129198     * The reply document will be converted from BSON to PHP using the
129199     * default deserialization rules (e.g. BSON documents will be converted
129200     * to stdClass).
129201     *
129202     * @return object Returns the command document as a stdClass object.
129203     **/
129204    final public function getCommand(){}
129205
129206    /**
129207     * Returns the command name
129208     *
129209     * Returns the command name (e.g. "find", "aggregate").
129210     *
129211     * @return string Returns the command name.
129212     **/
129213    final public function getCommandName(){}
129214
129215    /**
129216     * Returns the database on which the command was executed
129217     *
129218     * @return string Returns the database on which the command was
129219     *   executed.
129220     **/
129221    final public function getDatabaseName(){}
129222
129223    /**
129224     * Returns the command's operation ID
129225     *
129226     * The operation ID is generated by the driver and may be used to link
129227     * events together such as bulk write operations, which may have been
129228     * split across several commands at the protocol level.
129229     *
129230     * @return string Returns the command's operation ID.
129231     **/
129232    final public function getOperationId(){}
129233
129234    /**
129235     * Returns the command's request ID
129236     *
129237     * The request ID is generated by the driver and may be used to associate
129238     * this MongoDB\Driver\Monitoring\CommandStartedEvent with a later
129239     * MongoDB\Driver\Monitoring\CommandFailedEvent or
129240     * MongoDB\Driver\Monitoring\CommandSucceededEvent.
129241     *
129242     * @return string Returns the command's request ID.
129243     **/
129244    final public function getRequestId(){}
129245
129246    /**
129247     * Returns the Server on which the command was executed
129248     *
129249     * Returns the MongoDB\Driver\Server on which the command was executed.
129250     *
129251     * @return MongoDB\Driver\Server Returns the MongoDB\Driver\Server on
129252     *   which the command was executed.
129253     **/
129254    final public function getServer(){}
129255
129256}
129257}
129258namespace MongoDB\Driver\Monitoring {
129259interface CommandSubscriber extends MongoDB\Driver\Monitoring\Subscriber {
129260    /**
129261     * Notification method for a failed command
129262     *
129263     * If the subscriber has been registered with {@link
129264     * MongoDB\Driver\Monitoring\addSubscriber}, the driver will call this
129265     * method when a command has failed.
129266     *
129267     * @param MongoDB\Driver\Monitoring\CommandFailedEvent $event An event
129268     *   object encapsulating information about the failed command.
129269     * @return void
129270     **/
129271    public function commandFailed($event);
129272
129273    /**
129274     * Notification method for a started command
129275     *
129276     * If the subscriber has been registered with {@link
129277     * MongoDB\Driver\Monitoring\addSubscriber}, the driver will call this
129278     * method when a command has started.
129279     *
129280     * @param MongoDB\Driver\Monitoring\CommandStartedEvent $event An event
129281     *   object encapsulating information about the started command.
129282     * @return void
129283     **/
129284    public function commandStarted($event);
129285
129286    /**
129287     * Notification method for a successful command
129288     *
129289     * If the subscriber has been registered with {@link
129290     * MongoDB\Driver\Monitoring\addSubscriber}, the driver will call this
129291     * method when a command has succeeded.
129292     *
129293     * @param MongoDB\Driver\Monitoring\CommandSucceededEvent $event An
129294     *   event object encapsulating information about the successful command.
129295     * @return void
129296     **/
129297    public function commandSucceeded($event);
129298
129299}
129300}
129301namespace MongoDB\Driver\Monitoring {
129302class CommandSucceededEvent {
129303    /**
129304     * Returns the command name
129305     *
129306     * Returns the command name (e.g. "find", "aggregate").
129307     *
129308     * @return string Returns the command name.
129309     **/
129310    final public function getCommandName(){}
129311
129312    /**
129313     * Returns the command's duration in microseconds
129314     *
129315     * The command's duration is a calculated value that includes the time to
129316     * send the message and receive the reply from the server.
129317     *
129318     * @return int Returns the command's duration in microseconds.
129319     **/
129320    final public function getDurationMicros(){}
129321
129322    /**
129323     * Returns the command's operation ID
129324     *
129325     * The operation ID is generated by the driver and may be used to link
129326     * events together such as bulk write operations, which may have been
129327     * split across several commands at the protocol level.
129328     *
129329     * @return string Returns the command's operation ID.
129330     **/
129331    final public function getOperationId(){}
129332
129333    /**
129334     * Returns the command reply document
129335     *
129336     * The reply document will be converted from BSON to PHP using the
129337     * default deserialization rules (e.g. BSON documents will be converted
129338     * to stdClass).
129339     *
129340     * @return object Returns the command reply document as a stdClass
129341     *   object.
129342     **/
129343    final public function getReply(){}
129344
129345    /**
129346     * Returns the command's request ID
129347     *
129348     * The request ID is generated by the driver and may be used to associate
129349     * this MongoDB\Driver\Monitoring\CommandSucceededEvent with a previous
129350     * MongoDB\Driver\Monitoring\CommandStartedEvent.
129351     *
129352     * @return string Returns the command's request ID.
129353     **/
129354    final public function getRequestId(){}
129355
129356    /**
129357     * Returns the Server on which the command was executed
129358     *
129359     * Returns the MongoDB\Driver\Server on which the command was executed.
129360     *
129361     * @return MongoDB\Driver\Server Returns the MongoDB\Driver\Server on
129362     *   which the command was executed.
129363     **/
129364    final public function getServer(){}
129365
129366}
129367}
129368namespace MongoDB\Driver\Monitoring {
129369interface Subscriber {
129370}
129371}
129372namespace MongoDB\Driver {
129373class Query {
129374    /**
129375     * Create a new Query
129376     *
129377     * Constructs a new MongoDB\Driver\Query, which is an immutable value
129378     * object that represents a database query. The query may then be
129379     * executed with MongoDB\Driver\Manager::executeQuery.
129380     *
129381     * @param array|object $filter queryOptions Option Type Description
129382     *   allowDiskUse boolean Allows MongoDB to use temporary disk files to
129383     *   store data exceeding the 100 megabyte system memory limit while
129384     *   processing a blocking sort operation. allowPartialResults boolean
129385     *   For queries against a sharded collection, returns partial results
129386     *   from the mongos if some shards are unavailable instead of throwing
129387     *   an error. Falls back to the deprecated "partial" option if not
129388     *   specified. awaitData boolean Use in conjunction with the "tailable"
129389     *   option to block a getMore operation on the cursor temporarily if at
129390     *   the end of data rather than returning no data. After a timeout
129391     *   period, the query returns as normal. batchSize integer The number of
129392     *   documents to return in the first batch. Defaults to 101. A batch
129393     *   size of 0 means that the cursor will be established, but no
129394     *   documents will be returned in the first batch. In versions of
129395     *   MongoDB before 3.2, where queries use the legacy wire protocol
129396     *   OP_QUERY, a batch size of 1 will close the cursor irrespective of
129397     *   the number of matched documents. comment string A comment to attach
129398     *   to the query to help interpret and trace query profile data. Falls
129399     *   back to the deprecated "$comment" modifier if not specified. exhaust
129400     *   boolean Stream the data down full blast in multiple "more" packages,
129401     *   on the assumption that the client will fully read all data queried.
129402     *   Faster when you are pulling a lot of data and know you want to pull
129403     *   it all down. Note: the client is not allowed to not read all the
129404     *   data unless it closes the connection. This option is not supported
129405     *   by the find command in MongoDB 3.2+ and will force the driver to use
129406     *   the legacy wire protocol version (i.e. OP_QUERY). explain boolean If
129407     *   TRUE, the returned MongoDB\Driver\Cursor will contain a single
129408     *   document that describes the process and indexes used to return the
129409     *   query. Falls back to the deprecated "$explain" modifier if not
129410     *   specified. This option is not supported by the find command in
129411     *   MongoDB 3.2+ and will only be respected when using the legacy wire
129412     *   protocol version (i.e. OP_QUERY). The explain command should be used
129413     *   on MongoDB 3.0+. hint string|array|object Index specification.
129414     *   Specify either the index name as a string or the index key pattern.
129415     *   If specified, then the query system will only consider plans using
129416     *   the hinted index. Falls back to the deprecated "hint" option if not
129417     *   specified. limit integer The maximum number of documents to return.
129418     *   If unspecified, then defaults to no limit. A limit of 0 is
129419     *   equivalent to setting no limit. A negative limit is will be
129420     *   interpreted as a positive limit with the "singleBatch" option set to
129421     *   TRUE. This behavior is supported for backwards compatibility, but
129422     *   should be considered deprecated. max array|object The exclusive
129423     *   upper bound for a specific index. Falls back to the deprecated
129424     *   "$max" modifier if not specified. maxAwaitTimeMS integer Positive
129425     *   integer denoting the time limit in milliseconds for the server to
129426     *   block a getMore operation if no data is available. This option
129427     *   should only be used in conjunction with the "tailable" and
129428     *   "awaitData" options. maxScan integer This option is deprecated and
129429     *   should not be used. Positive integer denoting the maximum number of
129430     *   documents or index keys to scan when executing the query. Falls back
129431     *   to the deprecated "$maxScan" modifier if not specified. maxTimeMS
129432     *   integer The cumulative time limit in milliseconds for processing
129433     *   operations on the cursor. MongoDB aborts the operation at the
129434     *   earliest following interrupt point. Falls back to the deprecated
129435     *   "$maxTimeMS" modifier if not specified. min array|object The
129436     *   inclusive lower bound for a specific index. Falls back to the
129437     *   deprecated "$min" modifier if not specified. modifiers array Meta
129438     *   operators modifying the output or behavior of a query. Use of these
129439     *   operators is deprecated in favor of named options. noCursorTimeout
129440     *   boolean Prevents the server from timing out idle cursors after an
129441     *   inactivity period (10 minutes). oplogReplay boolean Internal use for
129442     *   replica sets. To use oplogReplay, you must include the following
129443     *   condition in the filter:
129444     *
129445     *   [ 'ts' => [ '$gte' => <timestamp> ] ]
129446     *
129447     *   This option is deprecated as of the 1.8.0 release. projection
129448     *   array|object The projection specification to determine which fields
129449     *   to include in the returned documents. If you are using the ODM
129450     *   functionality to deserialise documents as their original PHP class,
129451     *   make sure that you include the __pclass field in the projection.
129452     *   This is required for the deserialization to work and without it, the
129453     *   driver will return (by default) a stdClass object instead.
129454     *   readConcern MongoDB\Driver\ReadConcern A read concern to apply to
129455     *   the operation. By default, the read concern from the MongoDB
129456     *   Connection URI will be used. This option is available in MongoDB
129457     *   3.2+ and will result in an exception at execution time if specified
129458     *   for an older server version. returnKey boolean If TRUE, returns only
129459     *   the index keys in the resulting documents. Default value is FALSE.
129460     *   If TRUE and the find command does not use an index, the returned
129461     *   documents will be empty. Falls back to the deprecated "$returnKey"
129462     *   modifier if not specified. showRecordId boolean Determines whether
129463     *   to return the record identifier for each document. If TRUE, adds a
129464     *   top-level "$recordId" field to the returned documents. Falls back to
129465     *   the deprecated "$showDiskLoc" modifier if not specified. singleBatch
129466     *   boolean Determines whether to close the cursor after the first
129467     *   batch. Defaults to FALSE. skip integer Number of documents to skip.
129468     *   Defaults to 0. slaveOk boolean Allow query of replica set
129469     *   secondaries snapshot boolean This option is deprecated and should
129470     *   not be used. Prevents the cursor from returning a document more than
129471     *   once because of an intervening write operation. Falls back to the
129472     *   deprecated "$snapshot" modifier if not specified. sort array|object
129473     *   The sort specification for the ordering of the results. Falls back
129474     *   to the deprecated "$orderby" modifier if not specified. tailable
129475     *   boolean Returns a tailable cursor for a capped collection.
129476     * @param array $queryOptions
129477     **/
129478    final public function __construct($filter, $queryOptions){}
129479
129480}
129481}
129482namespace MongoDB\Driver {
129483class ReadConcern implements MongoDB\BSON\Serializable, Serializable {
129484    /**
129485     * Returns an object for BSON serialization
129486     *
129487     * @return object Returns an object for serializing the ReadConcern as
129488     *   BSON.
129489     **/
129490    final public function bsonSerialize(){}
129491
129492    /**
129493     * Returns the ReadConcerns "level" option
129494     *
129495     * @return string|null Returns the ReadConcerns "level" option.
129496     **/
129497    final public function getLevel(){}
129498
129499    /**
129500     * Checks if this is the default read concern
129501     *
129502     * Returns whether this is the default read concern (i.e. no options are
129503     * specified). This method is primarily intended to be used in
129504     * conjunction with MongoDB\Driver\Manager::getReadConcern to determine
129505     * whether the Manager has been constructed without any read concern
129506     * options.
129507     *
129508     * The driver will not include a default read concern in its read
129509     * operations (e.g. MongoDB\Driver\Manager::executeQuery) in order order
129510     * to allow the server to apply its own default. Libraries that access
129511     * the Manager's read concern to include it in their own read commands
129512     * should use this method to ensure that default read concerns are left
129513     * unset.
129514     *
129515     * @return bool Returns TRUE if this is the default read concern and
129516     *   FALSE otherwise.
129517     **/
129518    final public function isDefault(){}
129519
129520    /**
129521     * Serialize a ReadConcern
129522     *
129523     * @return string Returns the serialized representation of the
129524     *   MongoDB\Driver\ReadConcern.
129525     **/
129526    final public function serialize(){}
129527
129528    /**
129529     * Unserialize a ReadConcern
129530     *
129531     * @param string $serialized The serialized MongoDB\Driver\ReadConcern.
129532     * @return void Returns the unserialized MongoDB\Driver\ReadConcern.
129533     **/
129534    final public function unserialize($serialized){}
129535
129536    /**
129537     * Create a new ReadConcern
129538     *
129539     * Constructs a new MongoDB\Driver\ReadConcern, which is an immutable
129540     * value object.
129541     *
129542     * @param string $level The read concern level. You may use, but are
129543     *   not limited to, one of the class constants.
129544     **/
129545    final public function __construct($level){}
129546
129547}
129548}
129549namespace MongoDB\Driver {
129550class ReadPreference implements MongoDB\BSON\Serializable, Serializable {
129551    /**
129552     * Returns an object for BSON serialization
129553     *
129554     * @return object Returns an object for serializing the ReadPreference
129555     *   as BSON.
129556     **/
129557    final public function bsonSerialize(){}
129558
129559    /**
129560     * Returns the ReadPreferences "hedge" option
129561     *
129562     * @return object|null Returns the ReadPreferences "hedge" option.
129563     **/
129564    final public function getHedge(){}
129565
129566    /**
129567     * Returns the ReadPreferences "maxStalenessSeconds" option
129568     *
129569     * @return int Returns the ReadPreferences "maxStalenessSeconds"
129570     *   option. If no max staleness has been specified,
129571     *   MongoDB\Driver\ReadPreference::NO_MAX_STALENESS will be returned.
129572     **/
129573    final public function getMaxStalenessSeconds(){}
129574
129575    /**
129576     * Returns the ReadPreferences "mode" option
129577     *
129578     * @return int Returns the ReadPreferences "mode" option.
129579     **/
129580    final public function getMode(){}
129581
129582    /**
129583     * Returns the ReadPreferences "mode" option as a string
129584     *
129585     * @return string Returns the ReadPreferences "mode" option as a
129586     *   string.
129587     **/
129588    final public function getModeString(){}
129589
129590    /**
129591     * Returns the ReadPreferences "tagSets" option
129592     *
129593     * @return array Returns the ReadPreferences "tagSets" option.
129594     **/
129595    final public function getTagSets(){}
129596
129597    /**
129598     * Serialize a ReadPreference
129599     *
129600     * @return string Returns the serialized representation of the
129601     *   MongoDB\Driver\ReadPreference.
129602     **/
129603    final public function serialize(){}
129604
129605    /**
129606     * Unserialize a ReadPreference
129607     *
129608     * @param string $serialized The serialized
129609     *   MongoDB\Driver\ReadPreference.
129610     * @return void Returns the unserialized MongoDB\Driver\ReadPreference.
129611     **/
129612    final public function unserialize($serialized){}
129613
129614    /**
129615     * Create a new ReadPreference
129616     *
129617     * Constructs a new MongoDB\Driver\ReadPreference, which is an immutable
129618     * value object.
129619     *
129620     * @param string|integer $mode Read preference mode Value Description
129621     *   MongoDB\Driver\ReadPreference::RP_PRIMARY or "primary" All
129622     *   operations read from the current replica set primary. This is the
129623     *   default read preference for MongoDB.
129624     *   MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED or
129625     *   "primaryPreferred" In most situations, operations read from the
129626     *   primary but if it is unavailable, operations read from secondary
129627     *   members. MongoDB\Driver\ReadPreference::RP_SECONDARY or "secondary"
129628     *   All operations read from the secondary members of the replica set.
129629     *   MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED or
129630     *   "secondaryPreferred" In most situations, operations read from
129631     *   secondary members but if no secondary members are available,
129632     *   operations read from the primary.
129633     *   MongoDB\Driver\ReadPreference::RP_NEAREST or "nearest" Operations
129634     *   read from member of the replica set with the least network latency,
129635     *   irrespective of the members type.
129636     * @param array $tagSets Tag sets allow you to target read operations
129637     *   to specific members of a replica set. This parameter should be an
129638     *   array of associative arrays, each of which contain zero or more
129639     *   key/value pairs. When selecting a server for a read operation, the
129640     *   driver attempt to select a node having all tags in a set (i.e. the
129641     *   associative array of key/value pairs). If selection fails, the
129642     *   driver will attempt subsequent sets. An empty tag set (array()) will
129643     *   match any node and may be used as a fallback. Tags are not
129644     *   compatible with the MongoDB\Driver\ReadPreference::RP_PRIMARY mode
129645     *   and, in general, only apply when selecting a secondary member of a
129646     *   set for a read operation. However, the
129647     *   MongoDB\Driver\ReadPreference::RP_NEAREST mode, when combined with a
129648     *   tag set, selects the matching member with the lowest network
129649     *   latency. This member may be a primary or secondary.
129650     * @param array $options options Option Type Description hedge
129651     *   object|array Specifies whether to use hedged reads, which are
129652     *   supported by MongoDB 4.4+ for sharded queries. Server hedged reads
129653     *   are available for all non-primary read preferences and are enabled
129654     *   by default when using the "nearest" mode. This option allows
129655     *   explicitly enabling server hedged reads for non-primary read
129656     *   preferences by specifying ['enabled' => true], or explicitly
129657     *   disabling server hedged reads for the "nearest" read preference by
129658     *   specifying ['enabled' => false]. maxStalenessSeconds integer
129659     *   Specifies a maximum replication lag, or "staleness", for reads from
129660     *   secondaries. When a secondarys estimated staleness exceeds this
129661     *   value, the driver stops using it for read operations. If specified,
129662     *   the max staleness must be a signed 32-bit integer greater than or
129663     *   equal to
129664     *   MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS.
129665     *   Defaults to MongoDB\Driver\ReadPreference::NO_MAX_STALENESS, which
129666     *   means that the driver will not consider a secondarys lag when
129667     *   choosing where to direct a read operation. This option is not
129668     *   compatible with the MongoDB\Driver\ReadPreference::RP_PRIMARY mode.
129669     *   Specifying a max staleness also requires all MongoDB instances in
129670     *   the deployment to be using MongoDB 3.4+. An exception will be thrown
129671     *   at execution time if any MongoDB instances in the deployment are of
129672     *   an older server version.
129673     **/
129674    final public function __construct($mode, $tagSets, $options){}
129675
129676}
129677}
129678namespace MongoDB\Driver {
129679class Server {
129680    /**
129681     * Execute one or more write operations on this server
129682     *
129683     * Executes one or more write operations on this server.
129684     *
129685     * A MongoDB\Driver\BulkWrite can be constructed with one or more write
129686     * operations of varying types (e.g. updates, deletes, and inserts). The
129687     * driver will attempt to send operations of the same type to the server
129688     * in as few requests as possible to optimize round trips.
129689     *
129690     * @param string $namespace options Option Type Description
129691     * @param MongoDB\Driver\BulkWrite $bulk
129692     * @param array $options
129693     * @return MongoDB\Driver\WriteResult
129694     **/
129695    final public function executeBulkWrite($namespace, $bulk, $options){}
129696
129697    /**
129698     * Execute a database command on this server
129699     *
129700     * Executes the command on this server.
129701     *
129702     * This method applies no special logic to the command. Although this
129703     * method accepts "readConcern" and "writeConcern" options, which will be
129704     * incorporated into the command document, those options will not default
129705     * to corresponding values from the MongoDB Connection URI nor will the
129706     * MongoDB server version be taken into account. Users are therefore
129707     * encouraged to use specific read and/or write command methods if
129708     * possible.
129709     *
129710     * @param string $db options Option Type Description
129711     * @param MongoDB\Driver\Command $command
129712     * @param array $options
129713     * @return MongoDB\Driver\Cursor
129714     **/
129715    final public function executeCommand($db, $command, $options){}
129716
129717    /**
129718     * Execute a database query on this server
129719     *
129720     * Executes the query on this server.
129721     *
129722     * @param string $namespace options Option Type Description
129723     * @param MongoDB\Driver\Query $query
129724     * @param array $options
129725     * @return MongoDB\Driver\Cursor
129726     **/
129727    final public function executeQuery($namespace, $query, $options){}
129728
129729    /**
129730     * Execute a database command that reads on this server
129731     *
129732     * Executes the command on this server.
129733     *
129734     * This method will apply logic that is specific to commands that read
129735     * (e.g. count) and take the MongoDB server version into account. The
129736     * "readConcern" option will default to the corresponding value from the
129737     * MongoDB Connection URI.
129738     *
129739     * @param string $db options Option Type Description
129740     * @param MongoDB\Driver\Command $command
129741     * @param array $options
129742     * @return MongoDB\Driver\Cursor
129743     **/
129744    final public function executeReadCommand($db, $command, $options){}
129745
129746    /**
129747     * Execute a database command that reads and writes on this server
129748     *
129749     * Executes the command on this server.
129750     *
129751     * This method will apply logic that is specific to commands that read
129752     * and write (e.g. aggregate) and take the MongoDB server version into
129753     * account. The "readConcern" and "writeConcern" options will default to
129754     * the corresponding values from the MongoDB Connection URI.
129755     *
129756     * @param string $db options Option Type Description
129757     * @param MongoDB\Driver\Command $command
129758     * @param array $options
129759     * @return MongoDB\Driver\Cursor
129760     **/
129761    final public function executeReadWriteCommand($db, $command, $options){}
129762
129763    /**
129764     * Execute a database command that writes on this server
129765     *
129766     * Executes the command on this server.
129767     *
129768     * This method will apply logic that is specific to commands that write
129769     * (e.g. drop) and take the MongoDB server version into account. The
129770     * "writeConcern" option will default to the corresponding value from the
129771     * MongoDB Connection URI.
129772     *
129773     * @param string $db options Option Type Description
129774     * @param MongoDB\Driver\Command $command
129775     * @param array $options
129776     * @return MongoDB\Driver\Cursor
129777     **/
129778    final public function executeWriteCommand($db, $command, $options){}
129779
129780    /**
129781     * Returns the hostname of this server
129782     *
129783     * @return string Returns the hostname of this server.
129784     **/
129785    final public function getHost(){}
129786
129787    /**
129788     * Returns an array of information about this server
129789     *
129790     * @return array Returns an array of information about this server.
129791     **/
129792    final public function getInfo(){}
129793
129794    /**
129795     * Returns the latency of this server
129796     *
129797     * Returns the latency of this server (i.e. the clients measured round
129798     * trip time of an ismaster command).
129799     *
129800     * @return string Returns the latency of this server.
129801     **/
129802    final public function getLatency(){}
129803
129804    /**
129805     * Returns the port on which this server is listening
129806     *
129807     * @return int Returns the port on which this server is listening.
129808     **/
129809    final public function getPort(){}
129810
129811    /**
129812     * Returns an array of tags describing this server in a replica set
129813     *
129814     * Returns an array of tags used to describe this server in a replica
129815     * set. The array will contain zero or more string key and value pairs.
129816     *
129817     * @return array Returns an array of tags used to describe this server
129818     *   in a replica set.
129819     **/
129820    final public function getTags(){}
129821
129822    /**
129823     * Returns an integer denoting the type of this server
129824     *
129825     * Returns an integer denoting the type of this server. The value will
129826     * correlate with a MongoDB\Driver\Server constant.
129827     *
129828     * @return int Returns an integer denoting the type of this server.
129829     **/
129830    final public function getType(){}
129831
129832    /**
129833     * Checks if this server is an arbiter member of a replica set
129834     *
129835     * Returns whether this server is an arbiter member of a replica set.
129836     *
129837     * @return bool Returns TRUE if this server is an arbiter member of a
129838     *   replica set, and FALSE otherwise.
129839     **/
129840    final public function isArbiter(){}
129841
129842    /**
129843     * Checks if this server is a hidden member of a replica set
129844     *
129845     * Returns whether this server is a hidden member of a replica set.
129846     *
129847     * @return bool Returns TRUE if this server is a hidden member of a
129848     *   replica set, and FALSE otherwise.
129849     **/
129850    final public function isHidden(){}
129851
129852    /**
129853     * Checks if this server is a passive member of a replica set
129854     *
129855     * Returns whether this server is a passive member of a replica set (i.e.
129856     * its priority is 0).
129857     *
129858     * @return bool Returns TRUE if this server is a passive member of a
129859     *   replica set, and FALSE otherwise.
129860     **/
129861    final public function isPassive(){}
129862
129863    /**
129864     * Checks if this server is a primary member of a replica set
129865     *
129866     * Returns whether this server is a primary member of a replica set.
129867     *
129868     * @return bool Returns TRUE if this server is a primary member of a
129869     *   replica set, and FALSE otherwise.
129870     **/
129871    final public function isPrimary(){}
129872
129873    /**
129874     * Checks if this server is a secondary member of a replica set
129875     *
129876     * Returns whether this server is a secondary member of a replica set.
129877     *
129878     * @return bool Returns TRUE if this server is a secondary member of a
129879     *   replica set, and FALSE otherwise.
129880     **/
129881    final public function isSecondary(){}
129882
129883    /**
129884     * Create a new Server (not used)
129885     *
129886     * MongoDB\Driver\Server objects are created internally by
129887     * MongoDB\Driver\Manager when a database connection is established and
129888     * may be returned by {@link MongoDB\Driver\Manager::getServers} and
129889     * {@link MongoDB\Driver\Manager::selectServer}.
129890     **/
129891    final private function __construct(){}
129892
129893}
129894}
129895namespace MongoDB\Driver {
129896class Session {
129897    /**
129898     * Aborts a transaction
129899     *
129900     * Terminates the multi-document transaction and rolls back any data
129901     * changes made by the operations within the transaction. That is, the
129902     * transaction ends without saving any of the changes made by the
129903     * operations in the transaction.
129904     *
129905     * @return void
129906     **/
129907    final public function abortTransaction(){}
129908
129909    /**
129910     * Advances the cluster time for this session
129911     *
129912     * Advances the cluster time for this session. If the cluster time is
129913     * less than or equal to the session's current cluster time, this
129914     * function is a no-op.
129915     *
129916     * By using this method in conjunction with
129917     * MongoDB\Driver\Session::advanceOperationTime to copy the cluster and
129918     * operation times from another session, you can ensure that operations
129919     * in this session are causally consistent with the last operation in the
129920     * other session.
129921     *
129922     * @param array|object $clusterTime The cluster time is a document
129923     *   containing a logical timestamp and server signature. Typically, this
129924     *   value will be obtained by calling
129925     *   MongoDB\Driver\Session::getClusterTime on another session object.
129926     * @return void
129927     **/
129928    final public function advanceClusterTime($clusterTime){}
129929
129930    /**
129931     * Advances the operation time for this session
129932     *
129933     * Advances the operation time for this session. If the operation time is
129934     * less than or equal to the session's current operation time, this
129935     * function is a no-op.
129936     *
129937     * By using this method in conjunction with
129938     * MongoDB\Driver\Session::advanceClusterTime to copy the operation and
129939     * cluster times from another session, you can ensure that operations in
129940     * this session are causally consistent with the last operation in the
129941     * other session.
129942     *
129943     * @param MongoDB\BSON\TimestampInterface $operationTime The operation
129944     *   time is a logical timestamp. Typically, this value will be obtained
129945     *   by calling MongoDB\Driver\Session::getOperationTime on another
129946     *   session object.
129947     * @return void
129948     **/
129949    final public function advanceOperationTime($operationTime){}
129950
129951    /**
129952     * Commits a transaction
129953     *
129954     * Saves the changes made by the operations in the multi-document
129955     * transaction and ends the transaction. Until the commit, none of the
129956     * data changes made from within the transaction are visible outside the
129957     * transaction.
129958     *
129959     * @return void
129960     **/
129961    final public function commitTransaction(){}
129962
129963    /**
129964     * Terminates a session
129965     *
129966     * This method closes an existing session. If a transaction was
129967     * associated with this session, the transaction will be aborted. After
129968     * calling this method, applications should not invoke other methods on
129969     * the session.
129970     *
129971     * @return void
129972     **/
129973    final public function endSession(){}
129974
129975    /**
129976     * Returns the cluster time for this session
129977     *
129978     * Returns the cluster time for this session. If the session has not been
129979     * used for any operation and MongoDB\Driver\Session::advanceClusterTime
129980     * has not been called, the cluster time will be NULL.
129981     *
129982     * @return object|null Returns the cluster time for this session, or
129983     *   NULL if the session has no cluster time.
129984     **/
129985    final public function getClusterTime(){}
129986
129987    /**
129988     * Returns the logical session ID for this session
129989     *
129990     * Returns the logical session ID for this session, which may be used to
129991     * identify this session's operations on the server.
129992     *
129993     * @return object Returns the logical session ID for this session.
129994     **/
129995    final public function getLogicalSessionId(){}
129996
129997    /**
129998     * Returns the operation time for this session
129999     *
130000     * Returns the operation time for this session. If the session has not
130001     * been used for any operation and
130002     * MongoDB\Driver\Session::advanceOperationTime has not been called, the
130003     * operation time will be NULL
130004     *
130005     * @return MongoDB\BSON\Timestamp|null Returns the operation time for
130006     *   this session, or NULL if the session has no operation time.
130007     **/
130008    final public function getOperationTime(){}
130009
130010    /**
130011     * Returns the server to which this session is pinned
130012     *
130013     * Returns the MongoDB\Driver\Server to which this session is pinned. If
130014     * the session is not pinned to a server, NULL will be returned.
130015     *
130016     * Session pinning is primarily used for sharded transactions, as all
130017     * commands within a sharded transaction must be sent to the same mongos
130018     * instance. This method is intended to be used by libraries built atop
130019     * the extension to allow use of a pinned server instead of invoking
130020     * server selection.
130021     *
130022     * @return MongoDB\Driver\Server|null Returns the MongoDB\Driver\Server
130023     *   to which this session is pinned, or NULL if the session is not
130024     *   pinned to any server.
130025     **/
130026    final public function getServer(){}
130027
130028    /**
130029     * Returns options for the currently running transaction
130030     *
130031     * @return array|null Returns a array containing current transaction
130032     *   options, or NULL if no transaction is running.
130033     **/
130034    final public function getTransactionOptions(){}
130035
130036    /**
130037     * Returns the current transaction state for this session
130038     *
130039     * Returns the transaction state for this session.
130040     *
130041     * @return string Returns the current transaction state for this
130042     *   session.
130043     **/
130044    final public function getTransactionState(){}
130045
130046    /**
130047     * Returns whether a multi-document transaction is in progress
130048     *
130049     * Returns whether a multi-document transaction is currently in progress
130050     * for this session. A transaction is considered "in progress" if it has
130051     * been started but has not been committed or aborted.
130052     *
130053     * @return boolean Returns TRUE if a transaction is currently in
130054     *   progress for this session, and FALSE otherwise.
130055     **/
130056    final public function isInTransaction(){}
130057
130058    /**
130059     * Starts a transaction
130060     *
130061     * Starts a multi-document transaction associated with the session. At
130062     * any given time, you can have at most one open transaction for a
130063     * session. After starting a transaction, the session object must be
130064     * passed to each operation via the "session" option (e.g.
130065     * MongoDB\Driver\Manager::executeBulkWrite) in order to associate that
130066     * operation with the transaction.
130067     *
130068     * Transactions can be committed through
130069     * MongoDB\Driver\Session::commitTransaction, and aborted with
130070     * MongoDB\Driver\Session::abortTransaction. Transactions are also
130071     * automatically aborted when the session is closed from garbage
130072     * collection or by explicitly calling
130073     * MongoDB\Driver\Session::endSession.
130074     *
130075     * @param array $options Options can be passed as argument to this
130076     *   method. Each element in this options array overrides the
130077     *   corresponding option from the "defaultTransactionOptions" option, if
130078     *   set when starting the session with
130079     *   MongoDB\Driver\Manager::startSession.
130080     *
130081     *   options Option Type Description
130082     * @return void
130083     **/
130084    final public function startTransaction($options){}
130085
130086    /**
130087     * Create a new Session (not used)
130088     *
130089     * MongoDB\Driver\Session objects are returned by
130090     * MongoDB\Driver\Manager::startSession and cannot be constructed
130091     * directly.
130092     **/
130093    final private function __construct(){}
130094
130095}
130096}
130097namespace MongoDB\Driver {
130098class WriteConcern implements MongoDB\BSON\Serializable, Serializable {
130099    /**
130100     * Returns an object for BSON serialization
130101     *
130102     * @return object Returns an object for serializing the WriteConcern as
130103     *   BSON.
130104     **/
130105    final public function bsonSerialize(){}
130106
130107    /**
130108     * Returns the WriteConcerns "journal" option
130109     *
130110     * @return boolean|null Returns the WriteConcerns "journal" option.
130111     **/
130112    final public function getJournal(){}
130113
130114    /**
130115     * Returns the WriteConcerns "w" option
130116     *
130117     * @return string|integer|null Returns the WriteConcerns "w" option.
130118     **/
130119    final public function getW(){}
130120
130121    /**
130122     * Returns the WriteConcerns "wtimeout" option
130123     *
130124     * @return int|MongoDB\BSON\Int64 Returns the WriteConcerns "wtimeout"
130125     *   option.
130126     **/
130127    final public function getWtimeout(){}
130128
130129    /**
130130     * Checks if this is the default write concern
130131     *
130132     * Returns whether this is the default write concern (i.e. no options are
130133     * specified). This method is primarily intended to be used in
130134     * conjunction with MongoDB\Driver\Manager::getWriteConcern to determine
130135     * whether the Manager has been constructed without any write concern
130136     * options.
130137     *
130138     * The driver will not include a default write concern in its write
130139     * operations (e.g. MongoDB\Driver\Manager::executeBulkWrite) in order to
130140     * allow the server to apply its own default, which may have been
130141     * modified. Libraries that access the Manager's write concern to include
130142     * it in their own write commands should use this method to ensure that
130143     * default write concerns are left unset.
130144     *
130145     * @return bool Returns TRUE if this is the default write concern and
130146     *   FALSE otherwise.
130147     **/
130148    final public function isDefault(){}
130149
130150    /**
130151     * Serialize a WriteConcern
130152     *
130153     * @return string Returns the serialized representation of the
130154     *   MongoDB\Driver\WriteConcern.
130155     **/
130156    final public function serialize(){}
130157
130158    /**
130159     * Unserialize a WriteConcern
130160     *
130161     * @param string $serialized The serialized
130162     *   MongoDB\Driver\WriteConcern.
130163     * @return void Returns the unserialized MongoDB\Driver\WriteConcern.
130164     **/
130165    final public function unserialize($serialized){}
130166
130167    /**
130168     * Create a new WriteConcern
130169     *
130170     * Constructs a new MongoDB\Driver\WriteConcern, which is an immutable
130171     * value object.
130172     *
130173     * @param string|integer $w Write concern Value Description 1 Requests
130174     *   acknowledgement that the write operation has propagated to the
130175     *   standalone mongod or the primary in a replica set. This is the
130176     *   default write concern for MongoDB. 0 Requests no acknowledgment of
130177     *   the write operation. However, this may return information about
130178     *   socket exceptions and networking errors to the application. <integer
130179     *   greater than 1> Numbers greater than 1 are valid only for replica
130180     *   sets to request acknowledgement from specified number of members,
130181     *   including the primary. MongoDB\Driver\WriteConcern::MAJORITY
130182     *   Requests acknowledgment that write operations have propagated to the
130183     *   majority of voting nodes, including the primary, and have been
130184     *   written to the on-disk journal for these nodes. Prior to MongoDB
130185     *   3.0, this refers to the majority of replica set members (not just
130186     *   voting nodes). string A string value is interpereted as a tag set.
130187     *   Requests acknowledgement that the write operations have propagated
130188     *   to a replica set member with the specified tag.
130189     * @param int $wtimeout How long to wait (in milliseconds) for
130190     *   secondaries before failing. wtimeout causes write operations to
130191     *   return with an error (WriteConcernError) after the specified limit,
130192     *   even if the required write concern will eventually succeed. When
130193     *   these write operations return, MongoDB does not undo successful data
130194     *   modifications performed before the write concern exceeded the
130195     *   wtimeout time limit. If specified, wtimeout must be a signed 64-bit
130196     *   integer greater than or equal to zero.
130197     *
130198     *   Write concern timeout Value Description 0 Block indefinitely. This
130199     *   is the default. <integer greater than 0> Milliseconds to wait until
130200     *   returning.
130201     * @param bool $journal Wait until mongod has applied the write to the
130202     *   journal.
130203     **/
130204    final public function __construct($w, $wtimeout, $journal){}
130205
130206}
130207}
130208namespace MongoDB\Driver {
130209class WriteConcernError {
130210    /**
130211     * Returns the WriteConcernErrors error code
130212     *
130213     * @return int Returns the WriteConcernErrors error code.
130214     **/
130215    final public function getCode(){}
130216
130217    /**
130218     * Returns metadata document for the WriteConcernError
130219     *
130220     * @return object|null Returns the metadata document for the
130221     *   WriteConcernError, or NULL if no metadata is available.
130222     **/
130223    final public function getInfo(){}
130224
130225    /**
130226     * Returns the WriteConcernErrors error message
130227     *
130228     * @return string Returns the WriteConcernErrors error message.
130229     **/
130230    final public function getMessage(){}
130231
130232}
130233}
130234namespace MongoDB\Driver {
130235class WriteError {
130236    /**
130237     * Returns the WriteErrors error code
130238     *
130239     * @return int Returns the WriteErrors error code.
130240     **/
130241    final public function getCode(){}
130242
130243    /**
130244     * Returns the index of the write operation corresponding to this
130245     * WriteError
130246     *
130247     * @return int Returns the index of the write operation (from
130248     *   MongoDB\Driver\BulkWrite) corresponding to this WriteError.
130249     **/
130250    final public function getIndex(){}
130251
130252    /**
130253     * Returns metadata document for the WriteError
130254     *
130255     * @return object|null Returns the metadata document for the
130256     *   WriteError, or NULL if no metadata is available.
130257     **/
130258    final public function getInfo(){}
130259
130260    /**
130261     * Returns the WriteErrors error message
130262     *
130263     * @return string Returns the WriteErrors error message.
130264     **/
130265    final public function getMessage(){}
130266
130267}
130268}
130269namespace MongoDB\Driver {
130270class WriteResult {
130271    /**
130272     * Returns the number of documents deleted
130273     *
130274     * @return integer|null Returns the number of documents deleted, or
130275     *   NULL if the write was not acknowledged.
130276     **/
130277    final public function getDeletedCount(){}
130278
130279    /**
130280     * Returns the number of documents inserted (excluding upserts)
130281     *
130282     * @return integer|null Returns the number of documents inserted
130283     *   (excluding upserts), or NULL if the write was not acknowledged.
130284     **/
130285    final public function getInsertedCount(){}
130286
130287    /**
130288     * Returns the number of documents selected for update
130289     *
130290     * If the update operation results in no change to the document (e.g.
130291     * setting the value of a field to its current value), the matched count
130292     * may be greater than the value returned by
130293     * MongoDB\Driver\WriteResult::getModifiedCount.
130294     *
130295     * @return integer|null Returns the number of documents selected for
130296     *   update, or NULL if the write was not acknowledged.
130297     **/
130298    final public function getMatchedCount(){}
130299
130300    /**
130301     * Returns the number of existing documents updated
130302     *
130303     * If the update operation results in no change to the document (e.g.
130304     * setting the value of a field to its current value), the modified count
130305     * may be less than the value returned by
130306     * MongoDB\Driver\WriteResult::getMatchedCount.
130307     *
130308     * @return integer|null Returns the number of existing documents
130309     *   updated, or NULL if the write was not acknowledged.
130310     **/
130311    final public function getModifiedCount(){}
130312
130313    /**
130314     * Returns the server associated with this write result
130315     *
130316     * Returns the MongoDB\Driver\Server associated with this write result.
130317     * This is the server that executed the MongoDB\Driver\BulkWrite.
130318     *
130319     * @return MongoDB\Driver\Server Returns the MongoDB\Driver\Server
130320     *   associated with this write result.
130321     **/
130322    final public function getServer(){}
130323
130324    /**
130325     * Returns the number of documents inserted by an upsert
130326     *
130327     * @return integer|null Returns the number of documents inserted by an
130328     *   upsert.
130329     **/
130330    final public function getUpsertedCount(){}
130331
130332    /**
130333     * Returns an array of identifiers for upserted documents
130334     *
130335     * @return array Returns an array of identifiers (i.e. "_id" field
130336     *   values) for upserted documents. The array keys will correspond to
130337     *   the index of the write operation (from MongoDB\Driver\BulkWrite)
130338     *   responsible for the upsert.
130339     **/
130340    final public function getUpsertedIds(){}
130341
130342    /**
130343     * Returns any write concern error that occurred
130344     *
130345     * @return MongoDB\Driver\WriteConcernError|null Returns a
130346     *   MongoDB\Driver\WriteConcernError if a write concern error was
130347     *   encountered during the write operation, and NULL otherwise.
130348     **/
130349    final public function getWriteConcernError(){}
130350
130351    /**
130352     * Returns any write errors that occurred
130353     *
130354     * @return array Returns an array of MongoDB\Driver\WriteError objects
130355     *   for any write errors encountered during the write operation. The
130356     *   array will be empty if no write errors occurred.
130357     **/
130358    final public function getWriteErrors(){}
130359
130360    /**
130361     * Returns whether the write was acknowledged
130362     *
130363     * If the write is acknowledged, other count fields will be available on
130364     * the MongoDB\Driver\WriteResult object.
130365     *
130366     * @return bool Returns TRUE if the write was acknowledged, and FALSE
130367     *   otherwise.
130368     **/
130369    final public function isAcknowledged(){}
130370
130371}
130372}
130373/**
130374 * Constructs a batch of DELETE operations. See MongoWriteBatch.
130375 **/
130376class MongoDeleteBatch extends MongoWriteBatch {
130377    /**
130378     * Constructs a batch of DELETE operations. See MongoWriteBatch.
130379     *
130380     * @param MongoCollection $collection
130381     * @param array $write_options
130382     * @since PECL mongo >= 1.5.0
130383     **/
130384    public function __construct($collection, $write_options){}
130385
130386}
130387/**
130388 * Thrown when attempting to insert a document into a collection which
130389 * already contains the same values for the unique keys.
130390 **/
130391class MongoDuplicateKeyException extends MongoWriteConcernException {
130392}
130393/**
130394 * Default Mongo exception. This covers a bunch of different error
130395 * conditions that may eventually be moved to more specific exceptions,
130396 * but will always extend MongoException.
130397 **/
130398class MongoException extends Exception {
130399}
130400/**
130401 * Thrown when a operation times out server side (i.e. in MongoDB). To
130402 * configure the operation timeout threshold, use MongoCursor::maxTimeMS
130403 * or the "maxTimeMS" command option.
130404 **/
130405class MongoExecutionTimeoutException extends MongoException {
130406}
130407class MongoGridFS {
130408    /**
130409     * Remove a file and its chunks from the database
130410     *
130411     * @param mixed $id _id of the file to remove.
130412     * @return bool|array Returns an array containing the status of the
130413     *   removal (with respect to the files collection) if a write concern is
130414     *   applied. Otherwise, returns TRUE.
130415     * @since PECL mongo >=1.0.8
130416     **/
130417    public function delete($id){}
130418
130419    /**
130420     * Drops the files and chunks collections
130421     *
130422     * @return array The database response.
130423     * @since PECL mongo >=0.9.0
130424     **/
130425    public function drop(){}
130426
130427    /**
130428     * Queries for files
130429     *
130430     * @param array $query The query.
130431     * @param array $fields Fields to return.
130432     * @return MongoGridFSCursor A MongoGridFSCursor.
130433     * @since PECL mongo >=0.9.0
130434     **/
130435    public function find($query, $fields){}
130436
130437    /**
130438     * Returns a single file matching the criteria
130439     *
130440     * @param mixed $query The filename or criteria for which to search.
130441     * @param mixed $fields
130442     * @return MongoGridFSFile Returns a MongoGridFSFile or NULL.
130443     * @since PECL mongo >=0.9.0
130444     **/
130445    public function findOne($query, $fields){}
130446
130447    /**
130448     * Retrieve a file from the database
130449     *
130450     * @param mixed $id _id of the file to find.
130451     * @return MongoGridFSFile Returns the file, if found, or NULL.
130452     * @since PECL mongo >=1.0.8
130453     **/
130454    public function get($id){}
130455
130456    /**
130457     * Stores a file in the database
130458     *
130459     * @param string $filename Name of the file to store.
130460     * @param array $metadata Other metadata fields to include in the file
130461     *   document.
130462     * @param array $options An array of options for the insert operations
130463     *   executed against the chunks and files collections. See {@link
130464     *   MongoCollection::insert} for documentation on these these options.
130465     * @return mixed
130466     * @since PECL mongo >=1.0.8
130467     **/
130468    public function put($filename, $metadata, $options){}
130469
130470    /**
130471     * Remove files and their chunks from the database
130472     *
130473     * @param array $criteria The filename or criteria for which to search.
130474     * @param array $options An array of options for the remove operations
130475     *   executed against the chunks and files collections. See {@link
130476     *   MongoCollection::remove} for documentation on these options.
130477     * @return bool|array Returns an array containing the status of the
130478     *   removal (with respect to the files collection) if the "w" option is
130479     *   set. Otherwise, returns TRUE.
130480     * @since PECL mongo >=0.9.0
130481     **/
130482    public function remove($criteria, $options){}
130483
130484    /**
130485     * Stores a string of bytes in the database
130486     *
130487     * @param string $bytes String of bytes to store.
130488     * @param array $metadata Other metadata fields to include in the file
130489     *   document.
130490     * @param array $options An array of options for the insert operations
130491     *   executed against the chunks and files collections. See {@link
130492     *   MongoCollection::insert} for documentation on these these options.
130493     * @return mixed
130494     * @since PECL mongo >=0.9.2
130495     **/
130496    public function storeBytes($bytes, $metadata, $options){}
130497
130498    /**
130499     * Stores a file in the database
130500     *
130501     * @param string|resource $filename Name of the file or a readable
130502     *   stream to store.
130503     * @param array $metadata Other metadata fields to include in the file
130504     *   document.
130505     * @param array $options An array of options for the insert operations
130506     *   executed against the chunks and files collections. See {@link
130507     *   MongoCollection::insert} for documentation on these these options.
130508     * @return mixed
130509     * @since PECL mongo >=0.9.0
130510     **/
130511    public function storeFile($filename, $metadata, $options){}
130512
130513    /**
130514     * Stores an uploaded file in the database
130515     *
130516     * @param string $name The name of the uploaded file(s) to store. This
130517     *   should correspond to the file field's name attribute in the HTML
130518     *   form.
130519     * @param array $metadata Other metadata fields to include in the file
130520     *   document.
130521     * @return mixed If multiple files are uploaded using the same field
130522     *   name, this method will not return anything; however, the files
130523     *   themselves will still be processed.
130524     * @since PECL mongo >=0.9.0
130525     **/
130526    public function storeUpload($name, $metadata){}
130527
130528    /**
130529     * Creates new file collections
130530     *
130531     * Files as stored across two collections, the first containing file meta
130532     * information, the second containing chunks of the actual file. By
130533     * default, fs.files and fs.chunks are the collection names used.
130534     *
130535     * Use one argument to specify a prefix other than "fs":
130536     *
130537     * $fs = new MongoGridFS($db, "myfiles");
130538     *
130539     * uses myfiles.files and myfiles.chunks collections.
130540     *
130541     * @param MongoDB $db Database.
130542     * @param string $prefix Optional collection name prefix.
130543     * @param mixed $chunks
130544     * @since PECL mongo >=0.9.0
130545     **/
130546    public function __construct($db, $prefix, $chunks){}
130547
130548}
130549class MongoGridFSCursor {
130550    /**
130551     * @var MongoGridFS
130552     **/
130553    protected $gridfs;
130554
130555    /**
130556     * Returns the current file
130557     *
130558     * @return MongoGridFSFile The current file.
130559     * @since PECL mongo >=0.9.0
130560     **/
130561    public function current(){}
130562
130563    /**
130564     * Return the next file to which this cursor points, and advance the
130565     * cursor
130566     *
130567     * @return MongoGridFSFile Returns the next file.
130568     * @since PECL mongo >=0.9.0
130569     **/
130570    public function getNext(){}
130571
130572    /**
130573     * Returns the current results filename
130574     *
130575     * @return string The current results _id as a string.
130576     * @since PECL mongo >=0.9.0
130577     **/
130578    public function key(){}
130579
130580    /**
130581     * Create a new cursor
130582     *
130583     * @param MongoGridFS $gridfs Related GridFS collection.
130584     * @param resource $connection Database connection.
130585     * @param string $ns Full name of database and collection.
130586     * @param array $query Database query.
130587     * @param array $fields Fields to return.
130588     * @since PECL mongo >=0.9.0
130589     **/
130590    public function __construct($gridfs, $connection, $ns, $query, $fields){}
130591
130592}
130593/**
130594 * Thrown when there are errors reading or writing files to or from the
130595 * database. MongoGridFSException error codes Code Message Reason 3 Could
130596 * not open file $filename Attempting to store an invalid file, such as
130597 * directory 4 File $filename is too large: $filesize bytes Maximum
130598 * filesize in GridFS is 4GB 5 could not find filehandle Resource doesn't
130599 * have a filehandle 6 no file is associate with this filehandle Resource
130600 * isn't a file resource 7 error setting up file: $filenames Could not
130601 * open file for reading 9 error reading file $filenames Failed reading
130602 * file 10 error reading filehandle Failed reading from a resource 11
130603 * could not find uploaded file %s Filename doesn't seem to be uploaded
130604 * file 12 Couldn't find tmp_name in the $_FILES array. Are you sure the
130605 * upload worked? Uploaded filename probably failed 13 tmp_name was not a
130606 * string or an array Invalid filename given 14 couldn't find file size
130607 * The length property is missing 15 Cannot find filename No filename
130608 * provided, and no filename property set 16 could not open destination
130609 * file %s Destination filename not writable 17 error reading chunk of
130610 * file Chunk corruption 18 couldn't create a php_stream Couldn't create
130611 * a stream resource 19 couldn't find property Chunk corruption 20 chunk
130612 * number has wrong size (size) when the max is maxchunksize Chunk larger
130613 * then expected 21 chunk has wrong format Chunk corruption
130614 **/
130615class MongoGridFSException extends MongoException {
130616}
130617/**
130618 * A database file object.
130619 **/
130620class MongoGridFSFile {
130621    /**
130622     * @var array
130623     **/
130624    public $file;
130625
130626    /**
130627     * @var MongoGridFS
130628     **/
130629    protected $gridfs;
130630
130631    /**
130632     * Returns this files contents as a string of bytes
130633     *
130634     * Warning: this will load the file into memory. If the file is bigger
130635     * than your memory, this will cause problems!
130636     *
130637     * @return string Returns a string of the bytes in the file.
130638     * @since PECL mongo >=0.9.0
130639     **/
130640    public function getBytes(){}
130641
130642    /**
130643     * Returns this files filename
130644     *
130645     * @return string Returns the filename.
130646     * @since PECL mongo >=0.9.0
130647     **/
130648    public function getFilename(){}
130649
130650    /**
130651     * Returns a resource that can be used to read the stored file
130652     *
130653     * This method returns a stream resource that can be used with all file
130654     * functions in PHP that deal with reading files. The contents of the
130655     * file are pulled out of MongoDB on the fly, so that the whole file does
130656     * not have to be loaded into memory first.
130657     *
130658     * At most two GridFSFile chunks will be loaded in memory.
130659     *
130660     * @return resource Returns a resource that can be used to read the
130661     *   file with
130662     * @since PECL mongo >=1.3.0
130663     **/
130664    public function getResource(){}
130665
130666    /**
130667     * Returns this files size
130668     *
130669     * @return int Returns this file's size
130670     * @since PECL mongo >=0.9.0
130671     **/
130672    public function getSize(){}
130673
130674    /**
130675     * Writes this file to the filesystem
130676     *
130677     * @param string $filename The location to which to write the file. If
130678     *   none is given, the stored filename will be used.
130679     * @return int Returns the number of bytes written.
130680     * @since PECL mongo >=0.9.0
130681     **/
130682    public function write($filename){}
130683
130684    /**
130685     * Create a new GridFS file
130686     *
130687     * @param MongoGridFS $gridfs The parent MongoGridFS instance.
130688     * @param array $file A file from the database.
130689     * @since PECL mongo >=0.9.0
130690     **/
130691    public function __construct($gridfs, $file){}
130692
130693}
130694/**
130695 * A unique identifier created for database objects. If an object is
130696 * inserted into the database without an _id field, an _id field will be
130697 * added to it with a MongoId instance as its value. If the data has a
130698 * naturally occuring unique field (e.g. username or timestamp) it is
130699 * fine to use this as the _id field instead, and it will not be replaced
130700 * with a MongoId. Instances of the MongoId class fulfill the role that
130701 * autoincrementing does in a relational database: to provide a unique
130702 * key if the data does not naturally have one. Autoincrementing does not
130703 * work well with a sharded database, as it is difficult to determine the
130704 * next number in the sequence. This class fulfills the constraints of
130705 * quickly generating a value that is unique across shards. Each MongoId
130706 * is 12 bytes (making its string form 24 hexadecimal characters). The
130707 * first four bytes are a timestamp, the next three are a hash of the
130708 * client machine's hostname, the next two are the two least significant
130709 * bytes of the process id running the script, and the last three bytes
130710 * are an incrementing value. MongoIds are serializable/unserializable.
130711 * Their serialized form is similar to their string form:
130712 *
130713 * C:7:"MongoId":24:{4af9f23d8ead0e1d32000000}
130714 **/
130715class MongoId {
130716    /**
130717     * @var string
130718     **/
130719    public $$id;
130720
130721    /**
130722     * Gets the hostname being used for this machine's ids
130723     *
130724     * This returns the hostname MongoId is using to generate unique ids.
130725     * This should be the same value {@link gethostname} returns.
130726     *
130727     * It is identical to the function:
130728     *
130729     * @return string Returns the hostname.
130730     * @since PECL mongo >= 1.0.8
130731     **/
130732    public static function getHostname(){}
130733
130734    /**
130735     * Gets the incremented value to create this id
130736     *
130737     * @return int Returns the incremented value used to create this
130738     *   MongoId.
130739     * @since PECL mongo >= 1.0.11
130740     **/
130741    public function getInc(){}
130742
130743    /**
130744     * Gets the process ID
130745     *
130746     * Extracts the pid from the Mongo ID
130747     *
130748     * @return int Returns the PID of the MongoId.
130749     * @since PECL mongo >= 1.0.11
130750     **/
130751    public function getPID(){}
130752
130753    /**
130754     * Gets the number of seconds since the epoch that this id was created
130755     *
130756     * This returns the same thing as running {@link time} when the id is
130757     * created.
130758     *
130759     * @return int Returns the number of seconds since the epoch that this
130760     *   id was created. There are only four bytes of timestamp stored, so
130761     *   MongoDate is a better choice for storing exact or wide-ranging
130762     *   times.
130763     * @since PECL mongo >= 1.0.1
130764     **/
130765    public function getTimestamp(){}
130766
130767    /**
130768     * Check if a value is a valid ObjectId
130769     *
130770     * This method may be used to check a variable before passing it as an
130771     * argument to {@link MongoId::__construct}.
130772     *
130773     * @param mixed $value The value to check for validity.
130774     * @return bool Returns TRUE if {@link value} is a MongoId instance or
130775     *   a string consisting of exactly 24 hexadecimal characters; otherwise,
130776     *   FALSE is returned.
130777     * @since PECL mongo >= 1.5.0
130778     **/
130779    public static function isValid($value){}
130780
130781    /**
130782     * Creates a new id
130783     *
130784     * @param string|MongoId $id A string (must be 24 hexadecimal
130785     *   characters) or a MongoId instance.
130786     * @since PECL mongo >= 0.8.0
130787     **/
130788    public function __construct($id){}
130789
130790    /**
130791     * Create a dummy MongoId
130792     *
130793     * This function is only used by PHP internally, it shouldn't need to
130794     * ever be called by the user.
130795     *
130796     * It is identical to the function:
130797     *
130798     * @param array $props Theoretically, an array of properties used to
130799     *   create the new id. However, as MongoId instances have no properties,
130800     *   this is not used.
130801     * @return MongoId A new id with the value "000000000000000000000000".
130802     * @since PECL mongo >= 1.0.8
130803     **/
130804    public static function __set_state($props){}
130805
130806    /**
130807     * Returns a hexidecimal representation of this id
130808     *
130809     * @return string This id.
130810     * @since PECL mongo >= 0.8.0
130811     **/
130812    public function __toString(){}
130813
130814}
130815/**
130816 * Constructs a batch of INSERT operations. See MongoWriteBatch.
130817 **/
130818class MongoInsertBatch extends MongoWriteBatch {
130819    /**
130820     * Constructs a batch of INSERT operations. See MongoWriteBatch.
130821     *
130822     * @param MongoCollection $collection
130823     * @param array $write_options
130824     * @since PECL mongo >= 1.5.0
130825     **/
130826    public function __construct($collection, $write_options){}
130827
130828}
130829/**
130830 * The class can be used to save 32-bit integers to the database on a
130831 * 64-bit system.
130832 **/
130833class MongoInt32 {
130834    /**
130835     * @var string
130836     **/
130837    public $value;
130838
130839    /**
130840     * Creates a new 32-bit integer
130841     *
130842     * Creates a new 32-bit number with the given value.
130843     *
130844     * @param string $value A number.
130845     * @since PECL mongo >= 1.0.9
130846     **/
130847    public function __construct($value){}
130848
130849    /**
130850     * Returns the string representation of this 32-bit integer
130851     *
130852     * @return string Returns the string representation of this integer.
130853     * @since PECL mongo >= 1.0.9
130854     **/
130855    public function __toString(){}
130856
130857}
130858/**
130859 * The class can be used to save 64-bit integers to the database on a
130860 * 32-bit system.
130861 **/
130862class MongoInt64 {
130863    /**
130864     * @var string
130865     **/
130866    public $value;
130867
130868    /**
130869     * Creates a new 64-bit integer
130870     *
130871     * Creates a new 64-bit number with the given value.
130872     *
130873     * @param string $value A number.
130874     * @since PECL mongo >= 1.0.9
130875     **/
130876    public function __construct($value){}
130877
130878    /**
130879     * Returns the string representation of this 64-bit integer
130880     *
130881     * @return string Returns the string representation of this integer.
130882     * @since PECL mongo >= 1.0.9
130883     **/
130884    public function __toString(){}
130885
130886}
130887/**
130888 * Logging can be used to get detailed information about what the driver
130889 * is doing. Logging is disabled by default, but this class allows you to
130890 * activate specific levels of logging for various parts of the driver.
130891 * Some examples: These constants can be used by both {@link
130892 * MongoLog::setLevel} and {@link MongoLog::setModule}. These constants
130893 * can be used by {@link MongoLog::setLevel}. These constants can be used
130894 * by {@link MongoLog::setModule}.
130895 **/
130896class MongoLog {
130897    /**
130898     * @var int
130899     **/
130900    const ALL = 0;
130901
130902    /**
130903     * @var int
130904     **/
130905    const CON = 0;
130906
130907    /**
130908     * @var int
130909     **/
130910    const FINE = 0;
130911
130912    /**
130913     * @var int
130914     **/
130915    const INFO = 0;
130916
130917    /**
130918     * @var int
130919     **/
130920    const IO = 0;
130921
130922    /**
130923     * @var int
130924     **/
130925    const NONE = 0;
130926
130927    /**
130928     * @var int
130929     **/
130930    const PARSE = 0;
130931
130932    /**
130933     * @var int
130934     **/
130935    const POOL = 0;
130936
130937    /**
130938     * @var int
130939     **/
130940    const RS = 0;
130941
130942    /**
130943     * @var int
130944     **/
130945    const SERVER = 0;
130946
130947    /**
130948     * @var int
130949     **/
130950    const WARNING = 0;
130951
130952    /**
130953     * @var int
130954     **/
130955    private static $callback;
130956
130957    /**
130958     * @var int
130959     **/
130960    private static $level;
130961
130962    /**
130963     * @var int
130964     **/
130965    private static $module;
130966
130967    /**
130968     * Gets the previously set callback function
130969     *
130970     * Retrieves the callback function.
130971     *
130972     * @return callable Returns the callback function, or FALSE if not set
130973     *   yet.
130974     * @since PECL mongo >= 1.3.0
130975     **/
130976    public static function getCallback(){}
130977
130978    /**
130979     * Gets the level(s) currently being logged
130980     *
130981     * This function can be used to see which log levels are currently
130982     * enabled. The returned integer may be compared with the MongoLog level
130983     * constants using bitwise operators to check for specific log levels.
130984     *
130985     * @return int Returns the level(s) currently being logged.
130986     * @since PECL mongo >= 1.2.3
130987     **/
130988    public static function getLevel(){}
130989
130990    /**
130991     * Gets the module(s) currently being logged
130992     *
130993     * This function can be used to see which driver modules are currently
130994     * being logged. The returned integer may be compared with the MongoLog
130995     * module constants using bitwise operators to check if specific modules
130996     * are being logged.
130997     *
130998     * @return int Returns the module(s) currently being logged.
130999     * @since PECL mongo >= 1.2.3
131000     **/
131001    public static function getModule(){}
131002
131003    /**
131004     * Sets a callback function to be invoked for events
131005     *
131006     * This function will set a callback function to be invoked for events in
131007     * lieu of emitting of PHP notice.
131008     *
131009     * @param callable $log_function The callback function to be invoked on
131010     *   events. It should have the following prototype:
131011     *
131012     *   log_function int{@link module} int{@link level} string{@link
131013     *   message} {@link module} One of the MongoLog module constants. {@link
131014     *   level} One of the MongoLog level constants. {@link message} The log
131015     *   message itself.
131016     * @return void
131017     * @since PECL mongo >= 1.3.0
131018     **/
131019    public static function setCallback($log_function){}
131020
131021    /**
131022     * Sets the level(s) to be logged
131023     *
131024     * This function can be used to control logging verbosity and the types
131025     * of activities that should be logged. The MongoLog level constants may
131026     * be used with bitwise operators to specify multiple levels.
131027     *
131028     * Note that you must also call {@link MongoLog::setModule} to specify
131029     * which modules(s) of the driver should log.
131030     *
131031     * @param int $level The level(s) you would like to log.
131032     * @return void
131033     * @since PECL mongo >= 1.2.3
131034     **/
131035    public static function setLevel($level){}
131036
131037    /**
131038     * Sets the module(s) to be logged
131039     *
131040     * This function can be used to set which driver modules should be
131041     * logged. The MongoLog module constants may be used with bitwise
131042     * operators to specify multiple modules.
131043     *
131044     * Note that you must also call {@link MongoLog::setLevel} to enable
131045     * logging.
131046     *
131047     * @param int $module The module(s) you would like to log.
131048     * @return void
131049     * @since PECL mongo >= 1.2.3
131050     **/
131051    public static function setModule($module){}
131052
131053}
131054/**
131055 * MongoMaxKey is an special type used by the database that compares
131056 * greater than all other possible BSON values. Thus, if a query is
131057 * sorted by a given field in ascending order, any document with a
131058 * MongoMaxKey as its value will be returned last. MongoMaxKey has no
131059 * associated fields, methods, or constants. It is merely the "greatest"
131060 * value that can be represented in the database. The cursor will return
131061 * the staff meeting document followed by the dishes document. The dishes
131062 * document will always be returned last, regardless of what else is
131063 * added to the collection (unless other documents are added with
131064 * MongoMaxKey in their "doBy" field).
131065 **/
131066class MongoMaxKey {
131067}
131068/**
131069 * MongoMinKey is an special type used by the database that compares less
131070 * than all other possible BSON values. Thus, if a query is sorted by a
131071 * given field in ascending order, any document with a MongoMinKey as its
131072 * value will be returned first. MongoMinKey has no associated fields,
131073 * methods, or constants. It is merely the "smallest" value that can be
131074 * represented in the database. The cursor will return the lunch document
131075 * followed by the staff meeting document. The lunch document will always
131076 * be returned first, regardless of what else is added to the collection
131077 * (unless other documents are added with MongoMinKey in their "doBy"
131078 * field).
131079 **/
131080class MongoMinKey {
131081}
131082class MongoPool {
131083    /**
131084     * Get pool size for connection pools
131085     *
131086     * @return int Returns the current pool size.
131087     * @since PECL mongo >= 1.2.3
131088     **/
131089    public static function getSize(){}
131090
131091    /**
131092     * Returns information about all connection pools
131093     *
131094     * Returns an array of information about all connection pools.
131095     *
131096     * @return array Each connection pool has an identifier, which starts
131097     *   with the host. For each pool, this function shows the following
131098     *   fields: {@link in use} The number of connections currently being
131099     *   used by Mongo instances. {@link in pool} The number of connections
131100     *   currently in the pool (not being used). {@link remaining} The number
131101     *   of connections that could be created by this pool. For example,
131102     *   suppose a pool had 5 connections remaining and 3 connections in the
131103     *   pool. We could create 8 new instances of MongoClient before we
131104     *   exhausted this pool (assuming no instances of MongoClient went out
131105     *   of scope, returning their connections to the pool). A negative
131106     *   number means that this pool will spawn unlimited connections. Before
131107     *   a pool is created, you can change the max number of connections by
131108     *   calling {@link Mongo::setPoolSize}. Once a pool is showing up in the
131109     *   output of this function, its size cannot be changed. {@link total}
131110     *   The total number of connections allowed for this pool. This should
131111     *   be greater than or equal to "in use" + "in pool" (or -1). {@link
131112     *   timeout} The socket timeout for connections in this pool. This is
131113     *   how long connections in this pool will attempt to connect to a
131114     *   server before giving up. {@link waiting} If you have capped the pool
131115     *   size, workers requesting connections from the pool may block until
131116     *   other workers return their connections. This field shows how many
131117     *   milliseconds workers have blocked for connections to be released. If
131118     *   this number keeps increasing, you may want to use {@link
131119     *   MongoPool::setSize} to add more connections to your pool.
131120     * @since PECL mongo >= 1.2.3
131121     **/
131122    public function info(){}
131123
131124    /**
131125     * Set the size for future connection pools
131126     *
131127     * Sets the max number of connections new pools will be able to create.
131128     *
131129     * @param int $size The max number of connections future pools will be
131130     *   able to create. Negative numbers mean that the pool will spawn an
131131     *   infinite number of connections.
131132     * @return bool Returns the former value of pool size.
131133     * @since PECL mongo >= 1.2.3
131134     **/
131135    public static function setSize($size){}
131136
131137}
131138/**
131139 * When talking to MongoDB 2.6.0, and later, certain operations (such as
131140 * writes) may throw MongoProtocolException when the response from the
131141 * server did not make sense - for example during network failure (we
131142 * could read the entire response) or data corruption. This exception is
131143 * also thrown when attempting to talk newer protocols then the server
131144 * supports, for example using the MongoWriteBatch when talking to a
131145 * MongoDB server prior to 2.6.0.
131146 **/
131147class MongoProtocolException extends MongoException {
131148}
131149/**
131150 * This class can be used to create regular expressions. Typically, these
131151 * expressions will be used to query the database and find matching
131152 * strings. More unusually, they can be saved to the database and
131153 * retrieved. Regular expressions consist of four parts. First a / as
131154 * starting delimiter, then the pattern, another / and finally a string
131155 * containing flags. Regular expression pattern
131156 *
131157 * /pattern/flags MongoDB recognizes six regular expression flags:
131158 **/
131159class MongoRegex {
131160    /**
131161     * @var string
131162     **/
131163    public $flags;
131164
131165    /**
131166     * @var string
131167     **/
131168    public $regex;
131169
131170    /**
131171     * Creates a new regular expression
131172     *
131173     * @param string $regex Regular expression string of the form
131174     *   /expr/flags.
131175     * @since PECL mongo >= 0.8.1
131176     **/
131177    public function __construct($regex){}
131178
131179    /**
131180     * A string representation of this regular expression
131181     *
131182     * Returns a string representation of this regular expression.
131183     *
131184     * @return string This regular expression in the form "/expr/flags".
131185     * @since PECL mongo >= 0.8.1
131186     **/
131187    public function __toString(){}
131188
131189}
131190/**
131191 * The MongoResultException is thrown by several command helpers (such as
131192 * MongoCollection::findAndModify) in the event of failure. The original
131193 * result document is available through
131194 * MongoResultException::getDocument.
131195 **/
131196class MongoResultException extends MongoException {
131197    /**
131198     * The raw result document as an array.
131199     *
131200     * @var mixed
131201     **/
131202    public $document;
131203
131204    /**
131205     * Retrieve the full result document
131206     *
131207     * Retrieves the full error result document.
131208     *
131209     * @return array The full result document as an array, including
131210     *   partial data if available and additional keys.
131211     * @since PECL mongo >=1.3.0
131212     **/
131213    public function getDocument(){}
131214
131215}
131216/**
131217 * MongoTimestamp is an internal type used by MongoDB for replication and
131218 * sharding. It consists of a 4-byte timestamp (i.e. seconds since the
131219 * epoch) and a 4-byte increment. This type is not intended for storing
131220 * time or date values (e.g. a "createdAt" field on a document).
131221 **/
131222class MongoTimestamp {
131223    /**
131224     * @var int
131225     **/
131226    public $inc;
131227
131228    /**
131229     * @var int
131230     **/
131231    public $sec;
131232
131233    /**
131234     * Creates a new timestamp
131235     *
131236     * Creates a new timestamp. If no parameters are given, the current time
131237     * is used and the increment is automatically provided. The increment is
131238     * set to 0 when the module is loaded and is incremented every time this
131239     * constructor is called (without the $inc parameter passed in).
131240     *
131241     * @param int $sec Number of seconds since the epoch (i.e. 1 Jan 1970
131242     *   00:00:00.000 UTC).
131243     * @param int $inc Increment.
131244     * @since PECL mongo >= 1.0.1
131245     **/
131246    public function __construct($sec, $inc){}
131247
131248    /**
131249     * Returns a string representation of this timestamp
131250     *
131251     * Returns the "sec" field of this timestamp.
131252     *
131253     * @return string The seconds since epoch represented by this
131254     *   timestamp.
131255     * @since PECL mongo >= 1.0.1
131256     **/
131257    public function __toString(){}
131258
131259}
131260/**
131261 * Constructs a batch of UPDATE operations. See MongoWriteBatch.
131262 **/
131263class MongoUpdateBatch extends MongoWriteBatch {
131264    /**
131265     * Constructs a batch of UPDATE operations. See MongoWriteBatch.
131266     *
131267     * @param MongoCollection $collection
131268     * @param array $write_options
131269     * @since PECL mongo >= 1.5.0
131270     **/
131271    public function __construct($collection, $write_options){}
131272
131273}
131274/**
131275 * MongoWriteBatch is the base class for the MongoInsertBatch,
131276 * MongoUpdateBatch and MongoDeleteBatch classes. MongoWriteBatch allows
131277 * you to "batch up" multiple operations (of same type) and shipping them
131278 * all to MongoDB at the same time. This can be especially useful when
131279 * operating on many documents at the same time to reduce roundtrips.
131280 * Prior to version 1.5.0 of the driver it was possible to use
131281 * MongoCollection::batchInsert, however, as of 1.5.0 that method is now
131282 * discouraged. Note: This class is only available when talking to
131283 * MongoDB 2.6.0 (and later) servers. It will throw
131284 * MongoProtocolException if attempting to use it on older MongoDB
131285 * servers. When executing a batch by calling MongoWriteBatch::execute,
131286 * MongoWriteBatch will send up to maxWriteBatchSize (defaults to 1000)
131287 * documents or maxBsonObjectSize (defaults to 16777216 bytes), whichever
131288 * comes first.
131289 **/
131290class MongoWriteBatch {
131291    /**
131292     * Raw delete operation. Required keys are: "q" and "limit", which
131293     * correspond to the {@link $criteria} parameter and "justOne" option of
131294     * {@link MongoCollection::remove}, respectively. The "limit" option is
131295     * an integer; however, MongoDB only supports 0 (i.e. remove all matching
131296     * documents) and 1 (i.e. remove at most one matching document) at this
131297     * time.
131298     *
131299     * @var mixed
131300     **/
131301    const COMMAND_DELETE = 0;
131302
131303    /**
131304     * The document to add.
131305     *
131306     * @var mixed
131307     **/
131308    const COMMAND_INSERT = 0;
131309
131310    /**
131311     * Raw update operation. Required keys are "q" and "u", which correspond
131312     * to the {@link $criteria} and {@link $new_object} parameters of {@link
131313     * MongoCollection::update}, respectively. Optional keys are "multi" and
131314     * "upsert", which correspond to the "multiple" and "upsert" options for
131315     * {@link MongoCollection::update}, respectively. If unspecified, both
131316     * options default to FALSE.
131317     *
131318     * @var mixed
131319     **/
131320    const COMMAND_UPDATE = 0;
131321
131322    /**
131323     * Adds a write operation to a batch
131324     *
131325     * Adds a write operation to the batch.
131326     *
131327     * If {@link $item} causes the batch to exceed the maxWriteBatchSize or
131328     * maxBsonObjectSize limits, the driver will internally split the batches
131329     * into multiple write commands upon calling MongoWriteBatch::execute.
131330     *
131331     * @param array $item An array that describes a write operation. The
131332     *   structure of this value depends on the batch's operation type. Batch
131333     *   type Argument expectation MongoWriteBatch::COMMAND_INSERT The
131334     *   document to add. MongoWriteBatch::COMMAND_UPDATE Raw update
131335     *   operation. Required keys are "q" and "u", which correspond to the
131336     *   {@link $criteria} and {@link $new_object} parameters of {@link
131337     *   MongoCollection::update}, respectively. Optional keys are "multi"
131338     *   and "upsert", which correspond to the "multiple" and "upsert"
131339     *   options for {@link MongoCollection::update}, respectively. If
131340     *   unspecified, both options default to FALSE.
131341     *   MongoWriteBatch::COMMAND_DELETE Raw delete operation. Required keys
131342     *   are: "q" and "limit", which correspond to the {@link $criteria}
131343     *   parameter and "justOne" option of {@link MongoCollection::remove},
131344     *   respectively. The "limit" option is an integer; however, MongoDB
131345     *   only supports 0 (i.e. remove all matching documents) and 1 (i.e.
131346     *   remove at most one matching document) at this time.
131347     * @return bool Returns TRUE on success and throws an exception on
131348     *   failure.
131349     * @since PECL mongo >= 1.5.0
131350     **/
131351    public function add($item){}
131352
131353    /**
131354     * Executes a batch of write operations
131355     *
131356     * Executes the batch of write operations.
131357     *
131358     * @param array $write_options See MongoWriteBatch::__construct.
131359     * @return array Returns an array containing statistical information
131360     *   for the full batch. If the batch had to be split into multiple
131361     *   batches, the return value will aggregate the values from individual
131362     *   batches and return only the totals.
131363     * @since PECL mongo >= 1.5.0
131364     **/
131365    final public function execute($write_options){}
131366
131367}
131368/**
131369 * MongoWriteConcernException is thrown when a write fails. See for how
131370 * to set failure thresholds. Prior to MongoDB 2.6.0, the getLastError
131371 * command would determine whether a write failed.
131372 **/
131373class MongoWriteConcernException extends MongoCursorException {
131374    /**
131375     * Get the error document
131376     *
131377     * Returns the actual response from the server that was interperated as
131378     * an error.
131379     *
131380     * @return array A MongoDB document, if available, as an array.
131381     * @since PECL mongo >= 1.5.0
131382     **/
131383    public function getDocument(){}
131384
131385}
131386/**
131387 * An Iterator that sequentially iterates over all attached iterators
131388 **/
131389class MultipleIterator implements Iterator {
131390    /**
131391     * @var integer
131392     **/
131393    const MIT_KEYS_ASSOC = 0;
131394
131395    /**
131396     * @var integer
131397     **/
131398    const MIT_KEYS_NUMERIC = 0;
131399
131400    /**
131401     * @var integer
131402     **/
131403    const MIT_NEED_ALL = 0;
131404
131405    /**
131406     * @var integer
131407     **/
131408    const MIT_NEED_ANY = 0;
131409
131410    /**
131411     * Attaches iterator information
131412     *
131413     * @param Iterator $iterator The new iterator to attach.
131414     * @param string $infos The associative information for the Iterator,
131415     *   which must be an integer, a string, or NULL.
131416     * @return void Description...
131417     * @since PHP 5 >= 5.3.0, PHP 7
131418     **/
131419    public function attachIterator($iterator, $infos){}
131420
131421    /**
131422     * Checks if an iterator is attached
131423     *
131424     * Checks if an iterator is attached or not.
131425     *
131426     * @param Iterator $iterator The iterator to check.
131427     * @return bool
131428     * @since PHP 5 >= 5.3.0, PHP 7
131429     **/
131430    public function containsIterator($iterator){}
131431
131432    /**
131433     * Gets the number of attached iterator instances
131434     *
131435     * @return int The number of attached iterator instances (as an
131436     *   integer).
131437     * @since PHP 5 >= 5.3.0, PHP 7
131438     **/
131439    public function countIterators(){}
131440
131441    /**
131442     * Gets the registered iterator instances
131443     *
131444     * Get the registered iterator instances current() result.
131445     *
131446     * @return array An array containing the current values of each
131447     *   attached iterator, or FALSE if no iterators are attached.
131448     * @since PHP 5 >= 5.3.0, PHP 7
131449     **/
131450    public function current(){}
131451
131452    /**
131453     * Detaches an iterator
131454     *
131455     * @param Iterator $iterator The iterator to detach.
131456     * @return void
131457     * @since PHP 5 >= 5.3.0, PHP 7
131458     **/
131459    public function detachIterator($iterator){}
131460
131461    /**
131462     * Gets the flag information
131463     *
131464     * Gets information about the flags.
131465     *
131466     * @return int Information about the flags, as an integer.
131467     * @since PHP 5 >= 5.3.0, PHP 7
131468     **/
131469    public function getFlags(){}
131470
131471    /**
131472     * Gets the registered iterator instances
131473     *
131474     * Get the registered iterator instances key() result.
131475     *
131476     * @return array An array of all registered iterator instances, or
131477     *   FALSE if no sub iterator is attached.
131478     * @since PHP 5 >= 5.3.0, PHP 7
131479     **/
131480    public function key(){}
131481
131482    /**
131483     * Moves all attached iterator instances forward
131484     *
131485     * @return void
131486     * @since PHP 5 >= 5.3.0, PHP 7
131487     **/
131488    public function next(){}
131489
131490    /**
131491     * Rewinds all attached iterator instances
131492     *
131493     * @return void
131494     * @since PHP 5 >= 5.3.0, PHP 7
131495     **/
131496    public function rewind(){}
131497
131498    /**
131499     * Sets flags
131500     *
131501     * @param int $flags The flags to set, according to the Flag Constants
131502     * @return void
131503     * @since PHP 5 >= 5.3.0, PHP 7
131504     **/
131505    public function setFlags($flags){}
131506
131507    /**
131508     * Checks the validity of sub iterators
131509     *
131510     * @return bool Returns TRUE if one or all sub iterators are valid
131511     *   depending on flags, otherwise FALSE
131512     * @since PHP 5 >= 5.3.0, PHP 7
131513     **/
131514    public function valid(){}
131515
131516}
131517/**
131518 * The static methods contained in the Mutex class provide direct access
131519 * to Posix Mutex functionality.
131520 **/
131521class Mutex {
131522    /**
131523     * Create a Mutex
131524     *
131525     * Create, and optionally lock a new Mutex for the caller
131526     *
131527     * @param bool $lock Setting lock to true will lock the Mutex for the
131528     *   caller before returning the handle
131529     * @return int A newly created and optionally locked Mutex handle
131530     * @since PECL pthreads < 3.0.0
131531     **/
131532    final public static function create($lock){}
131533
131534    /**
131535     * Destroy Mutex
131536     *
131537     * Destroying Mutex handles must be carried out explicitly by the
131538     * programmer when they are finished with the Mutex handle.
131539     *
131540     * @param int $mutex A handle returned by a previous call to {@link
131541     *   Mutex::create}. The handle should not be locked by any Thread when
131542     *   {@link Mutex::destroy} is called.
131543     * @return bool A boolean indication of success
131544     * @since PECL pthreads < 3.0.0
131545     **/
131546    final public static function destroy($mutex){}
131547
131548    /**
131549     * Acquire Mutex
131550     *
131551     * Attempt to lock the Mutex for the caller.
131552     *
131553     * An attempt to lock a Mutex owned (locked) by another Thread will
131554     * result in blocking.
131555     *
131556     * @param int $mutex A handle returned by a previous call to {@link
131557     *   Mutex::create}.
131558     * @return bool A boolean indication of success.
131559     * @since PECL pthreads < 3.0.0
131560     **/
131561    final public static function lock($mutex){}
131562
131563    /**
131564     * Attempt to Acquire Mutex
131565     *
131566     * Attempt to lock the Mutex for the caller without blocking if the Mutex
131567     * is owned (locked) by another Thread.
131568     *
131569     * @param int $mutex A handle returned by a previous call to {@link
131570     *   Mutex::create}.
131571     * @return bool A boolean indication of success.
131572     * @since PECL pthreads < 3.0.0
131573     **/
131574    final public static function trylock($mutex){}
131575
131576    /**
131577     * Release Mutex
131578     *
131579     * Attempts to unlock the Mutex for the caller, optionally destroying the
131580     * Mutex handle. The calling thread should own the Mutex at the time of
131581     * the call.
131582     *
131583     * @param int $mutex A handle returned by a previous call to {@link
131584     *   Mutex::create}.
131585     * @param bool $destroy When true pthreads will destroy the Mutex after
131586     *   a successful unlock.
131587     * @return bool A boolean indication of success.
131588     * @since PECL pthreads < 3.0.0
131589     **/
131590    final public static function unlock($mutex, $destroy){}
131591
131592}
131593/**
131594 * Represents a connection between PHP and a MySQL database.
131595 **/
131596class mysqli {
131597    /**
131598     * Gets the number of affected rows in a previous MySQL operation
131599     *
131600     * Returns the number of rows affected by the last INSERT, UPDATE,
131601     * REPLACE or DELETE query.
131602     *
131603     * For SELECT statements {@link mysqli_affected_rows} works like {@link
131604     * mysqli_num_rows}.
131605     *
131606     * @var int
131607     **/
131608    public $affected_rows;
131609
131610    /**
131611     * Get MySQL client info
131612     *
131613     * Returns a string that represents the MySQL client library version.
131614     *
131615     * @var string
131616     **/
131617    public $client_info;
131618
131619    /**
131620     * Returns the MySQL client version as an integer
131621     *
131622     * Returns client version number as an integer.
131623     *
131624     * @var int
131625     **/
131626    public $client_version;
131627
131628    /**
131629     * Returns the error code from last connect call
131630     *
131631     * Returns the last error code number from the last call to {@link
131632     * mysqli_connect}.
131633     *
131634     * @var int
131635     **/
131636    public $connect_errno;
131637
131638    /**
131639     * Returns a string description of the last connect error
131640     *
131641     * Returns the last error message string from the last call to {@link
131642     * mysqli_connect}.
131643     *
131644     * @var string
131645     **/
131646    public $connect_error;
131647
131648    /**
131649     * Returns the error code for the most recent function call
131650     *
131651     * Returns the last error code for the most recent MySQLi function call
131652     * that can succeed or fail.
131653     *
131654     * Client error message numbers are listed in the MySQL errmsg.h header
131655     * file, server error message numbers are listed in mysqld_error.h. In
131656     * the MySQL source distribution you can find a complete list of error
131657     * messages and error numbers in the file Docs/mysqld_error.txt.
131658     *
131659     * @var int
131660     **/
131661    public $errno;
131662
131663    /**
131664     * Returns a string description of the last error
131665     *
131666     * Returns the last error message for the most recent MySQLi function
131667     * call that can succeed or fail.
131668     *
131669     * @var string
131670     **/
131671    public $error;
131672
131673    /**
131674     * Returns a list of errors from the last command executed
131675     *
131676     * Returns a array of errors for the most recent MySQLi function call
131677     * that can succeed or fail.
131678     *
131679     * @var array
131680     **/
131681    public $error_list;
131682
131683    /**
131684     * Returns the number of columns for the most recent query
131685     *
131686     * Returns the number of columns for the most recent query on the
131687     * connection represented by the {@link link} parameter. This function
131688     * can be useful when using the {@link mysqli_store_result} function to
131689     * determine if the query should have produced a non-empty result set or
131690     * not without knowing the nature of the query.
131691     *
131692     * @var int
131693     **/
131694    public $field_count;
131695
131696    /**
131697     * Returns a string representing the type of connection used
131698     *
131699     * Returns a string describing the connection represented by the {@link
131700     * link} parameter (including the server host name).
131701     *
131702     * @var string
131703     **/
131704    public $host_info;
131705
131706    /**
131707     * Retrieves information about the most recently executed query
131708     *
131709     * The {@link mysqli_info} function returns a string providing
131710     * information about the last query executed. The nature of this string
131711     * is provided below:
131712     *
131713     * Possible mysqli_info return values Query type Example result string
131714     * INSERT INTO...SELECT... Records: 100 Duplicates: 0 Warnings: 0 INSERT
131715     * INTO...VALUES (...),(...),(...) Records: 3 Duplicates: 0 Warnings: 0
131716     * LOAD DATA INFILE ... Records: 1 Deleted: 0 Skipped: 0 Warnings: 0
131717     * ALTER TABLE ... Records: 3 Duplicates: 0 Warnings: 0 UPDATE ... Rows
131718     * matched: 40 Changed: 40 Warnings: 0
131719     *
131720     * @var string
131721     **/
131722    public $info;
131723
131724    /**
131725     * Returns the auto generated id used in the latest query
131726     *
131727     * The {@link mysqli_insert_id} function returns the ID generated by a
131728     * query (usually INSERT) on a table with a column having the
131729     * AUTO_INCREMENT attribute. If no INSERT or UPDATE statements were sent
131730     * via this connection, or if the modified table does not have a column
131731     * with the AUTO_INCREMENT attribute, this function will return zero.
131732     *
131733     * @var mixed
131734     **/
131735    public $insert_id;
131736
131737    /**
131738     * Returns the version of the MySQL protocol used
131739     *
131740     * Returns an integer representing the MySQL protocol version used by the
131741     * connection represented by the {@link link} parameter.
131742     *
131743     * @var string
131744     **/
131745    public $protocol_version;
131746
131747    /**
131748     * Returns the version of the MySQL server
131749     *
131750     * Returns a string representing the version of the MySQL server that the
131751     * MySQLi extension is connected to.
131752     *
131753     * @var string
131754     **/
131755    public $server_info;
131756
131757    /**
131758     * Returns the version of the MySQL server as an integer
131759     *
131760     * The {@link mysqli_get_server_version} function returns the version of
131761     * the server connected to (represented by the {@link link} parameter) as
131762     * an integer.
131763     *
131764     * @var int
131765     **/
131766    public $server_version;
131767
131768    /**
131769     * Returns the SQLSTATE error from previous MySQL operation
131770     *
131771     * Returns a string containing the SQLSTATE error code for the last
131772     * error. The error code consists of five characters. '00000' means no
131773     * error. The values are specified by ANSI SQL and ODBC. For a list of
131774     * possible values, see .
131775     *
131776     * @var string
131777     **/
131778    public $sqlstate;
131779
131780    /**
131781     * Returns the thread ID for the current connection
131782     *
131783     * The {@link mysqli_thread_id} function returns the thread ID for the
131784     * current connection which can then be killed using the {@link
131785     * mysqli_kill} function. If the connection is lost and you reconnect
131786     * with {@link mysqli_ping}, the thread ID will be other. Therefore you
131787     * should get the thread ID only when you need it.
131788     *
131789     * @var int
131790     **/
131791    public $thread_id;
131792
131793    /**
131794     * Returns the number of warnings from the last query for the given link
131795     *
131796     * Returns the number of warnings from the last query in the connection.
131797     *
131798     * @var int
131799     **/
131800    public $warning_count;
131801
131802    /**
131803     * Turns on or off auto-committing database modifications
131804     *
131805     * Turns on or off auto-commit mode on queries for the database
131806     * connection.
131807     *
131808     * To determine the current state of autocommit use the SQL command
131809     * SELECT @@autocommit.
131810     *
131811     * @param bool $mode Whether to turn on auto-commit or not.
131812     * @return bool
131813     * @since PHP 5, PHP 7
131814     **/
131815    public function autocommit($mode){}
131816
131817    /**
131818     * Starts a transaction
131819     *
131820     * Begins a transaction. Requires the InnoDB engine (it is enabled by
131821     * default). For additional details about how MySQL transactions work,
131822     * see .
131823     *
131824     * @param int $flags Valid flags are:
131825     * @param string $name Savepoint name for the transaction.
131826     * @return bool
131827     * @since PHP 5 >= 5.5.0, PHP 7
131828     **/
131829    public function begin_transaction($flags, $name){}
131830
131831    /**
131832     * Changes the user of the specified database connection
131833     *
131834     * Changes the user of the specified database connection and sets the
131835     * current database.
131836     *
131837     * In order to successfully change users a valid {@link username} and
131838     * {@link password} parameters must be provided and that user must have
131839     * sufficient permissions to access the desired database. If for any
131840     * reason authorization fails, the current user authentication will
131841     * remain.
131842     *
131843     * @param string $user The MySQL user name.
131844     * @param string $password The MySQL password.
131845     * @param string $database The database to change to. If desired, the
131846     *   NULL value may be passed resulting in only changing the user and not
131847     *   selecting a database. To select a database in this case use the
131848     *   {@link mysqli_select_db} function.
131849     * @return bool
131850     * @since PHP 5, PHP 7
131851     **/
131852    public function change_user($user, $password, $database){}
131853
131854    /**
131855     * Returns the default character set for the database connection
131856     *
131857     * Returns the current character set for the database connection.
131858     *
131859     * @return string The default character set for the current connection
131860     * @since PHP 5, PHP 7
131861     **/
131862    public function character_set_name(){}
131863
131864    /**
131865     * Closes a previously opened database connection
131866     *
131867     * @return bool
131868     * @since PHP 5, PHP 7
131869     **/
131870    public function close(){}
131871
131872    /**
131873     * Commits the current transaction
131874     *
131875     * Commits the current transaction for the database connection.
131876     *
131877     * @param int $flags A bitmask of MYSQLI_TRANS_COR_* constants.
131878     * @param string $name If provided then COMMIT/*name* / is executed.
131879     * @return bool
131880     * @since PHP 5, PHP 7
131881     **/
131882    public function commit($flags, $name){}
131883
131884    /**
131885     * Open a new connection to the MySQL server
131886     *
131887     * Opens a connection to the MySQL Server.
131888     *
131889     * @param string $host Can be either a host name or an IP address.
131890     *   Passing the NULL value or the string "localhost" to this parameter,
131891     *   the local host is assumed. When possible, pipes will be used instead
131892     *   of the TCP/IP protocol. Prepending host by p: opens a persistent
131893     *   connection. {@link mysqli_change_user} is automatically called on
131894     *   connections opened from the connection pool.
131895     * @param string $username The MySQL user name.
131896     * @param string $passwd If not provided or NULL, the MySQL server will
131897     *   attempt to authenticate the user against those user records which
131898     *   have no password only. This allows one username to be used with
131899     *   different permissions (depending on if a password is provided or
131900     *   not).
131901     * @param string $dbname If provided will specify the default database
131902     *   to be used when performing queries.
131903     * @param int $port Specifies the port number to attempt to connect to
131904     *   the MySQL server.
131905     * @param string $socket Specifies the socket or named pipe that should
131906     *   be used.
131907     * @return void Returns an object which represents the connection to a
131908     *   MySQL Server, .
131909     * @since PHP 5, PHP 7
131910     **/
131911    public function connect($host, $username, $passwd, $dbname, $port, $socket){}
131912
131913    /**
131914     * Performs debugging operations
131915     *
131916     * Performs debugging operations using the Fred Fish debugging library.
131917     *
131918     * @param string $message A string representing the debugging operation
131919     *   to perform
131920     * @return bool Returns TRUE.
131921     * @since PHP 5, PHP 7
131922     **/
131923    public function debug($message){}
131924
131925    /**
131926     * Disable reads from master
131927     *
131928     * @return void
131929     * @since PHP 5 < 5.3.0
131930     **/
131931    function disable_reads_from_master(){}
131932
131933    /**
131934     * Dump debugging information into the log
131935     *
131936     * This function is designed to be executed by an user with the SUPER
131937     * privilege and is used to dump debugging information into the log for
131938     * the MySQL Server relating to the connection.
131939     *
131940     * @return bool
131941     * @since PHP 5, PHP 7
131942     **/
131943    public function dump_debug_info(){}
131944
131945    /**
131946     * Escapes special characters in a string for use in an SQL statement,
131947     * taking into account the current charset of the connection
131948     *
131949     * This function is used to create a legal SQL string that you can use in
131950     * an SQL statement. The given string is encoded to an escaped SQL
131951     * string, taking into account the current character set of the
131952     * connection.
131953     *
131954     * @param string $escapestr The string to be escaped. Characters
131955     *   encoded are NUL (ASCII 0), \n, \r, \, ', ", and Control-Z.
131956     * @return string Returns an escaped string.
131957     * @since PHP 5, PHP 7
131958     **/
131959    public function escape_string($escapestr){}
131960
131961    /**
131962     * Returns a character set object
131963     *
131964     * Returns a character set object providing several properties of the
131965     * current active character set.
131966     *
131967     * @return object The function returns a character set object with the
131968     *   following properties: {@link charset} Character set name {@link
131969     *   collation} Collation name {@link dir} Directory the charset
131970     *   description was fetched from (?) or "" for built-in character sets
131971     *   {@link min_length} Minimum character length in bytes {@link
131972     *   max_length} Maximum character length in bytes {@link number}
131973     *   Internal character set number {@link state} Character set status (?)
131974     * @since PHP 5 >= 5.1.0, PHP 7
131975     **/
131976    public function get_charset(){}
131977
131978    /**
131979     * Get MySQL client info
131980     *
131981     * Returns a string that represents the MySQL client library version.
131982     *
131983     * @return string A string that represents the MySQL client library
131984     *   version
131985     * @since PHP 5, PHP 7
131986     **/
131987    public function get_client_info(){}
131988
131989    /**
131990     * Returns statistics about the client connection
131991     *
131992     * @return bool Returns an array with connection stats if success,
131993     *   FALSE otherwise.
131994     * @since PHP 5 >= 5.3.0, PHP 7
131995     **/
131996    public function get_connection_stats(){}
131997
131998    /**
131999     * Returns the version of the MySQL server
132000     *
132001     * Returns a string representing the version of the MySQL server that the
132002     * MySQLi extension is connected to.
132003     *
132004     * @return string A character string representing the server version.
132005     * @since PHP 5, PHP 7
132006     **/
132007    public function get_server_info(){}
132008
132009    /**
132010     * Get result of SHOW WARNINGS
132011     *
132012     * @return mysqli_warning
132013     * @since PHP 5 >= 5.1.0, PHP 7
132014     **/
132015    public function get_warnings(){}
132016
132017    /**
132018     * Initializes MySQLi and returns a resource for use with
132019     * mysqli_real_connect()
132020     *
132021     * Allocates or initializes a MYSQL object suitable for {@link
132022     * mysqli_options} and {@link mysqli_real_connect}.
132023     *
132024     * @return mysqli Returns an object.
132025     * @since PHP 5, PHP 7
132026     **/
132027    public function init(){}
132028
132029    /**
132030     * Asks the server to kill a MySQL thread
132031     *
132032     * This function is used to ask the server to kill a MySQL thread
132033     * specified by the {@link processid} parameter. This value must be
132034     * retrieved by calling the {@link mysqli_thread_id} function.
132035     *
132036     * To stop a running query you should use the SQL command KILL QUERY
132037     * processid.
132038     *
132039     * @param int $processid
132040     * @return bool
132041     * @since PHP 5, PHP 7
132042     **/
132043    public function kill($processid){}
132044
132045    /**
132046     * Check if there are any more query results from a multi query
132047     *
132048     * Indicates if one or more result sets are available from a previous
132049     * call to {@link mysqli_multi_query}.
132050     *
132051     * @return bool Returns TRUE if one or more result sets (including
132052     *   errors) are available from a previous call to {@link
132053     *   mysqli_multi_query}, otherwise FALSE.
132054     * @since PHP 5, PHP 7
132055     **/
132056    public function more_results(){}
132057
132058    /**
132059     * Performs a query on the database
132060     *
132061     * Executes one or multiple queries which are concatenated by a
132062     * semicolon.
132063     *
132064     * To retrieve the resultset from the first query you can use {@link
132065     * mysqli_use_result} or {@link mysqli_store_result}. All subsequent
132066     * query results can be processed using {@link mysqli_more_results} and
132067     * {@link mysqli_next_result}.
132068     *
132069     * @param string $query The query, as a string. Data inside the query
132070     *   should be properly escaped.
132071     * @return bool Returns FALSE if the first statement failed. To
132072     *   retrieve subsequent errors from other statements you have to call
132073     *   {@link mysqli_next_result} first.
132074     * @since PHP 5, PHP 7
132075     **/
132076    public function multi_query($query){}
132077
132078    /**
132079     * Prepare next result from multi_query
132080     *
132081     * Prepares next result set from a previous call to {@link
132082     * mysqli_multi_query} which can be retrieved by {@link
132083     * mysqli_store_result} or {@link mysqli_use_result}.
132084     *
132085     * @return bool Also returns FALSE if the next statement resulted in an
132086     *   error, unlike mysqli_more_results.
132087     * @since PHP 5, PHP 7
132088     **/
132089    public function next_result(){}
132090
132091    /**
132092     * Set options
132093     *
132094     * Used to set extra connect options and affect behavior for a
132095     * connection.
132096     *
132097     * This function may be called multiple times to set several options.
132098     *
132099     * {@link mysqli_options} should be called after {@link mysqli_init} and
132100     * before {@link mysqli_real_connect}.
132101     *
132102     * @param int $option The option that you want to set. It can be one of
132103     *   the following values: Valid options Name Description
132104     *   MYSQLI_OPT_CONNECT_TIMEOUT connection timeout in seconds (supported
132105     *   on Windows with TCP/IP since PHP 5.3.1) MYSQLI_OPT_LOCAL_INFILE
132106     *   enable/disable use of LOAD LOCAL INFILE MYSQLI_INIT_COMMAND command
132107     *   to execute after when connecting to MySQL server
132108     *   MYSQLI_READ_DEFAULT_FILE Read options from named option file instead
132109     *   of my.cnf MYSQLI_READ_DEFAULT_GROUP Read options from the named
132110     *   group from my.cnf or the file specified with
132111     *   MYSQL_READ_DEFAULT_FILE. MYSQLI_SERVER_PUBLIC_KEY RSA public key
132112     *   file used with the SHA-256 based authentication. Available since PHP
132113     *   5.5.0. MYSQLI_OPT_NET_CMD_BUFFER_SIZE The size of the internal
132114     *   command/network buffer. Only valid for mysqlnd. Available since PHP
132115     *   5.3.0. MYSQLI_OPT_NET_READ_BUFFER_SIZE Maximum read chunk size in
132116     *   bytes when reading the body of a MySQL command packet. Only valid
132117     *   for mysqlnd. Available since PHP 5.3.0.
132118     *   MYSQLI_OPT_INT_AND_FLOAT_NATIVE Convert integer and float columns
132119     *   back to PHP numbers. Only valid for mysqlnd. Available since PHP
132120     *   5.3.0. MYSQLI_OPT_SSL_VERIFY_SERVER_CERT Available since PHP 5.3.0.
132121     * @param mixed $value The value for the option.
132122     * @return bool
132123     * @since PHP 5, PHP 7
132124     **/
132125    public function options($option, $value){}
132126
132127    /**
132128     * Pings a server connection, or tries to reconnect if the connection has
132129     * gone down
132130     *
132131     * Checks whether the connection to the server is working. If it has gone
132132     * down and global option mysqli.reconnect is enabled, an automatic
132133     * reconnection is attempted.
132134     *
132135     * This function can be used by clients that remain idle for a long
132136     * while, to check whether the server has closed the connection and
132137     * reconnect if necessary.
132138     *
132139     * @return bool
132140     * @since PHP 5, PHP 7
132141     **/
132142    public function ping(){}
132143
132144    /**
132145     * Poll connections
132146     *
132147     * Poll connections. The method can be used as static.
132148     *
132149     * @param array $read List of connections to check for outstanding
132150     *   results that can be read.
132151     * @param array $error List of connections on which an error occurred,
132152     *   for example, query failure or lost connection.
132153     * @param array $reject List of connections rejected because no
132154     *   asynchronous query has been run on for which the function could poll
132155     *   results.
132156     * @param int $sec Maximum number of seconds to wait, must be
132157     *   non-negative.
132158     * @param int $usec Maximum number of microseconds to wait, must be
132159     *   non-negative.
132160     * @return int Returns number of ready connections upon success, FALSE
132161     *   otherwise.
132162     * @since PHP 5 >= 5.3.0, PHP 7
132163     **/
132164    public static function poll(&$read, &$error, &$reject, $sec, $usec){}
132165
132166    /**
132167     * Prepare an SQL statement for execution
132168     *
132169     * Prepares the SQL query, and returns a statement handle to be used for
132170     * further operations on the statement. The query must consist of a
132171     * single SQL statement.
132172     *
132173     * The parameter markers must be bound to application variables using
132174     * {@link mysqli_stmt_bind_param} and/or {@link mysqli_stmt_bind_result}
132175     * before executing the statement or fetching rows.
132176     *
132177     * @param string $query The query, as a string. This parameter can
132178     *   include one or more parameter markers in the SQL statement by
132179     *   embedding question mark (?) characters at the appropriate positions.
132180     * @return mysqli_stmt {@link mysqli_prepare} returns a statement
132181     *   object or FALSE if an error occurred.
132182     * @since PHP 5, PHP 7
132183     **/
132184    public function prepare($query){}
132185
132186    /**
132187     * Performs a query on the database
132188     *
132189     * Performs a {@link query} against the database.
132190     *
132191     * For non-DML queries (not INSERT, UPDATE or DELETE), this function is
132192     * similar to calling {@link mysqli_real_query} followed by either {@link
132193     * mysqli_use_result} or {@link mysqli_store_result}.
132194     *
132195     * @param string $query The query string. Data inside the query should
132196     *   be properly escaped.
132197     * @param int $resultmode Either the constant MYSQLI_USE_RESULT or
132198     *   MYSQLI_STORE_RESULT depending on the desired behavior. By default,
132199     *   MYSQLI_STORE_RESULT is used. If you use MYSQLI_USE_RESULT all
132200     *   subsequent calls will return error Commands out of sync unless you
132201     *   call {@link mysqli_free_result} With MYSQLI_ASYNC (available with
132202     *   mysqlnd), it is possible to perform query asynchronously. {@link
132203     *   mysqli_poll} is then used to get results from such queries.
132204     * @return mixed Returns FALSE on failure. For successful SELECT, SHOW,
132205     *   DESCRIBE or EXPLAIN queries {@link mysqli_query} will return a
132206     *   mysqli_result object. For other successful queries {@link
132207     *   mysqli_query} will return TRUE.
132208     * @since PHP 5, PHP 7
132209     **/
132210    public function query($query, $resultmode){}
132211
132212    /**
132213     * Opens a connection to a mysql server
132214     *
132215     * Establish a connection to a MySQL database engine.
132216     *
132217     * This function differs from {@link mysqli_connect}:
132218     *
132219     * @param string $host Can be either a host name or an IP address.
132220     *   Passing the NULL value or the string "localhost" to this parameter,
132221     *   the local host is assumed. When possible, pipes will be used instead
132222     *   of the TCP/IP protocol.
132223     * @param string $username The MySQL user name.
132224     * @param string $passwd If provided or NULL, the MySQL server will
132225     *   attempt to authenticate the user against those user records which
132226     *   have no password only. This allows one username to be used with
132227     *   different permissions (depending on if a password as provided or
132228     *   not).
132229     * @param string $dbname If provided will specify the default database
132230     *   to be used when performing queries.
132231     * @param int $port Specifies the port number to attempt to connect to
132232     *   the MySQL server.
132233     * @param string $socket Specifies the socket or named pipe that should
132234     *   be used.
132235     * @param int $flags With the parameter {@link flags} you can set
132236     *   different connection options:
132237     * @return bool
132238     * @since PHP 5, PHP 7
132239     **/
132240    public function real_connect($host, $username, $passwd, $dbname, $port, $socket, $flags){}
132241
132242    /**
132243     * Escapes special characters in a string for use in an SQL statement,
132244     * taking into account the current charset of the connection
132245     *
132246     * This function is used to create a legal SQL string that you can use in
132247     * an SQL statement. The given string is encoded to an escaped SQL
132248     * string, taking into account the current character set of the
132249     * connection.
132250     *
132251     * @param string $escapestr The string to be escaped. Characters
132252     *   encoded are NUL (ASCII 0), \n, \r, \, ', ", and Control-Z.
132253     * @return string Returns an escaped string.
132254     * @since PHP 5, PHP 7
132255     **/
132256    function real_escape_string($escapestr){}
132257
132258    /**
132259     * Execute an SQL query
132260     *
132261     * Executes a single query against the database whose result can then be
132262     * retrieved or stored using the {@link mysqli_store_result} or {@link
132263     * mysqli_use_result} functions.
132264     *
132265     * In order to determine if a given query should return a result set or
132266     * not, see {@link mysqli_field_count}.
132267     *
132268     * @param string $query The query, as a string. Data inside the query
132269     *   should be properly escaped.
132270     * @return bool
132271     * @since PHP 5, PHP 7
132272     **/
132273    public function real_query($query){}
132274
132275    /**
132276     * Get result from async query
132277     *
132278     * @return mysqli_result Returns mysqli_result in success, FALSE
132279     *   otherwise.
132280     * @since PHP 5 >= 5.3.0, PHP 7
132281     **/
132282    public function reap_async_query(){}
132283
132284    /**
132285     * Refreshes
132286     *
132287     * Flushes tables or caches, or resets the replication server
132288     * information.
132289     *
132290     * @param int $options The options to refresh, using the
132291     *   MYSQLI_REFRESH_* constants as documented within the MySQLi constants
132292     *   documentation. See also the official MySQL Refresh documentation.
132293     * @return bool TRUE if the refresh was a success, otherwise FALSE
132294     * @since PHP 5 >= 5.3.0, PHP 7
132295     **/
132296    public function refresh($options){}
132297
132298    /**
132299     * Removes the named savepoint from the set of savepoints of the current
132300     * transaction
132301     *
132302     * @param string $name
132303     * @return bool
132304     * @since PHP 5 >= 5.5.0, PHP 7
132305     **/
132306    public function release_savepoint($name){}
132307
132308    /**
132309     * Rolls back current transaction
132310     *
132311     * Rollbacks the current transaction for the database.
132312     *
132313     * @param int $flags A bitmask of MYSQLI_TRANS_COR_* constants.
132314     * @param string $name If provided then ROLLBACK/*name* / is executed.
132315     * @return bool
132316     * @since PHP 5, PHP 7
132317     **/
132318    public function rollback($flags, $name){}
132319
132320    /**
132321     * Returns RPL query type
132322     *
132323     * Returns MYSQLI_RPL_MASTER, MYSQLI_RPL_SLAVE or MYSQLI_RPL_ADMIN
132324     * depending on a query type. INSERT, UPDATE and similar are master
132325     * queries, SELECT is slave, and FLUSH, REPAIR and similar are admin.
132326     *
132327     * @param string $query
132328     * @return int
132329     * @since PHP 5, PHP 7
132330     **/
132331    public function rpl_query_type($query){}
132332
132333    /**
132334     * Set a named transaction savepoint
132335     *
132336     * @param string $name
132337     * @return bool
132338     * @since PHP 5 >= 5.5.0, PHP 7
132339     **/
132340    public function savepoint($name){}
132341
132342    /**
132343     * Selects the default database for database queries
132344     *
132345     * Selects the default database to be used when performing queries
132346     * against the database connection.
132347     *
132348     * @param string $dbname The database name.
132349     * @return bool
132350     * @since PHP 5, PHP 7
132351     **/
132352    public function select_db($dbname){}
132353
132354    /**
132355     * Send the query and return
132356     *
132357     * @param string $query
132358     * @return bool
132359     * @since PHP 5, PHP 7
132360     **/
132361    public function send_query($query){}
132362
132363    /**
132364     * Sets the default client character set
132365     *
132366     * Sets the default character set to be used when sending data from and
132367     * to the database server.
132368     *
132369     * @param string $charset The charset to be set as default.
132370     * @return bool
132371     * @since PHP 5 >= 5.0.5, PHP 7
132372     **/
132373    public function set_charset($charset){}
132374
132375    /**
132376     * Unsets user defined handler for load local infile command
132377     *
132378     * Deactivates a LOAD DATA INFILE LOCAL handler previously set with
132379     * {@link mysqli_set_local_infile_handler}.
132380     *
132381     * @return void
132382     * @since PHP 5 < 5.4.0
132383     **/
132384    public function set_local_infile_default(){}
132385
132386    /**
132387     * Set callback function for LOAD DATA LOCAL INFILE command
132388     *
132389     * The callbacks task is to read input from the file specified in the
132390     * LOAD DATA LOCAL INFILE and to reformat it into the format understood
132391     * by LOAD DATA INFILE.
132392     *
132393     * The returned data needs to match the format specified in the LOAD DATA
132394     *
132395     * @param callable $read_func A callback function or object method
132396     *   taking the following parameters:
132397     * @return bool
132398     * @since PHP 5, PHP 7
132399     **/
132400    public function set_local_infile_handler($read_func){}
132401
132402    /**
132403     * Set set_opt
132404     *
132405     * Used to set extra connect set_opt and affect behavior for a
132406     * connection.
132407     *
132408     * This function may be called multiple times to set several set_opt.
132409     *
132410     * {@link mysqli_set_opt} should be called after {@link mysqli_init} and
132411     * before {@link mysqli_real_connect}.
132412     *
132413     * @param int $option The option that you want to set. It can be one of
132414     *   the following values: Valid options Name Description
132415     *   MYSQLI_OPT_CONNECT_TIMEOUT connection timeout in seconds (supported
132416     *   on Windows with TCP/IP since PHP 5.3.1) MYSQLI_OPT_LOCAL_INFILE
132417     *   enable/disable use of LOAD LOCAL INFILE MYSQLI_INIT_COMMAND command
132418     *   to execute after when connecting to MySQL server
132419     *   MYSQLI_READ_DEFAULT_FILE Read options from named option file instead
132420     *   of my.cnf MYSQLI_READ_DEFAULT_GROUP Read options from the named
132421     *   group from my.cnf or the file specified with
132422     *   MYSQL_READ_DEFAULT_FILE. MYSQLI_SERVER_PUBLIC_KEY RSA public key
132423     *   file used with the SHA-256 based authentication. Available since PHP
132424     *   5.5.0. MYSQLI_OPT_NET_CMD_BUFFER_SIZE The size of the internal
132425     *   command/network buffer. Only valid for mysqlnd. Available since PHP
132426     *   5.3.0. MYSQLI_OPT_NET_READ_BUFFER_SIZE Maximum read chunk size in
132427     *   bytes when reading the body of a MySQL command packet. Only valid
132428     *   for mysqlnd. Available since PHP 5.3.0.
132429     *   MYSQLI_OPT_INT_AND_FLOAT_NATIVE Convert integer and float columns
132430     *   back to PHP numbers. Only valid for mysqlnd. Available since PHP
132431     *   5.3.0. MYSQLI_OPT_SSL_VERIFY_SERVER_CERT Available since PHP 5.3.0.
132432     * @param mixed $value The value for the option.
132433     * @return bool
132434     * @since PHP 5, PHP 7
132435     **/
132436    public function set_opt($option, $value){}
132437
132438    /**
132439     * Used for establishing secure connections using SSL
132440     *
132441     * Used for establishing secure connections using SSL. It must be called
132442     * before {@link mysqli_real_connect}. This function does nothing unless
132443     * OpenSSL support is enabled.
132444     *
132445     * Note that MySQL Native Driver does not support SSL before PHP 5.3.3,
132446     * so calling this function when using MySQL Native Driver will result in
132447     * an error. MySQL Native Driver is enabled by default on Microsoft
132448     * Windows from PHP version 5.3 onwards.
132449     *
132450     * @param string $key The path name to the key file.
132451     * @param string $cert The path name to the certificate file.
132452     * @param string $ca The path name to the certificate authority file.
132453     * @param string $capath The pathname to a directory that contains
132454     *   trusted SSL CA certificates in PEM format.
132455     * @param string $cipher A list of allowable ciphers to use for SSL
132456     *   encryption.
132457     * @return bool This function always returns TRUE value. If SSL setup
132458     *   is incorrect {@link mysqli_real_connect} will return an error when
132459     *   you attempt to connect.
132460     * @since PHP 5, PHP 7
132461     **/
132462    public function ssl_set($key, $cert, $ca, $capath, $cipher){}
132463
132464    /**
132465     * Gets the current system status
132466     *
132467     * {@link mysqli_stat} returns a string containing information similar to
132468     * that provided by the 'mysqladmin status' command. This includes uptime
132469     * in seconds and the number of running threads, questions, reloads, and
132470     * open tables.
132471     *
132472     * @return string A string describing the server status. FALSE if an
132473     *   error occurred.
132474     * @since PHP 5, PHP 7
132475     **/
132476    public function stat(){}
132477
132478    /**
132479     * Initializes a statement and returns an object for use with
132480     * mysqli_stmt_prepare
132481     *
132482     * Allocates and initializes a statement object suitable for {@link
132483     * mysqli_stmt_prepare}.
132484     *
132485     * @return mysqli_stmt Returns an object.
132486     * @since PHP 5, PHP 7
132487     **/
132488    public function stmt_init(){}
132489
132490    /**
132491     * Transfers a result set from the last query
132492     *
132493     * Transfers the result set from the last query on the database
132494     * connection represented by the {@link link} parameter to be used with
132495     * the {@link mysqli_data_seek} function.
132496     *
132497     * @param int $option The option that you want to set. It can be one of
132498     *   the following values: Valid options Name Description
132499     *   MYSQLI_STORE_RESULT_COPY_DATA Copy results from the internal mysqlnd
132500     *   buffer into the PHP variables fetched. By default, mysqlnd will use
132501     *   a reference logic to avoid copying and duplicating results held in
132502     *   memory. For certain result sets, for example, result sets with many
132503     *   small rows, the copy approach can reduce the overall memory usage
132504     *   because PHP variables holding results may be released earlier
132505     *   (available with mysqlnd only, since PHP 5.6.0)
132506     * @return mysqli_result Returns a buffered result object or FALSE if
132507     *   an error occurred.
132508     * @since PHP 5, PHP 7
132509     **/
132510    public function store_result($option){}
132511
132512    /**
132513     * Returns whether thread safety is given or not
132514     *
132515     * Tells whether the client library is compiled as thread-safe.
132516     *
132517     * @return void TRUE if the client library is thread-safe, otherwise
132518     *   FALSE.
132519     * @since PHP 5, PHP 7
132520     **/
132521    public function thread_safe(){}
132522
132523    /**
132524     * Initiate a result set retrieval
132525     *
132526     * Used to initiate the retrieval of a result set from the last query
132527     * executed using the {@link mysqli_real_query} function on the database
132528     * connection.
132529     *
132530     * Either this or the {@link mysqli_store_result} function must be called
132531     * before the results of a query can be retrieved, and one or the other
132532     * must be called to prevent the next query on that database connection
132533     * from failing.
132534     *
132535     * @return mysqli_result Returns an unbuffered result object or FALSE
132536     *   if an error occurred.
132537     * @since PHP 5, PHP 7
132538     **/
132539    public function use_result(){}
132540
132541}
132542/**
132543 * The mysqli_driver class is an instance of the monostate pattern, i.e.
132544 * there is only one driver which can be accessed though an arbitrary
132545 * amount of mysqli_driver instances.
132546 **/
132547class mysqli_driver {
132548    /**
132549     * @var string
132550     **/
132551    public $client_info;
132552
132553    /**
132554     * @var string
132555     **/
132556    public $client_version;
132557
132558    /**
132559     * @var string
132560     **/
132561    public $driver_version;
132562
132563    /**
132564     * @var string
132565     **/
132566    public $embedded;
132567
132568    /**
132569     * @var bool
132570     **/
132571    public $reconnect;
132572
132573    /**
132574     * @var int
132575     **/
132576    public $report_mode;
132577
132578    /**
132579     * Stop embedded server
132580     *
132581     * @return void
132582     * @since PHP 5 >= 5.1.0, PHP 7 < 7.4.0
132583     **/
132584    public function embedded_server_end(){}
132585
132586    /**
132587     * Initialize and start embedded server
132588     *
132589     * @param int $start
132590     * @param array $arguments
132591     * @param array $groups
132592     * @return bool
132593     * @since PHP 5 >= 5.1.0, PHP 7 < 7.4.0
132594     **/
132595    public function embedded_server_start($start, $arguments, $groups){}
132596
132597}
132598/**
132599 * Represents the result set obtained from a query against the database.
132600 **/
132601class mysqli_result implements Traversable {
132602    /**
132603     * Get current field offset of a result pointer
132604     *
132605     * Returns the position of the field cursor used for the last {@link
132606     * mysqli_fetch_field} call. This value can be used as an argument to
132607     * {@link mysqli_field_seek}.
132608     *
132609     * @var int
132610     **/
132611    public $current_field;
132612
132613    /**
132614     * Get the number of fields in a result
132615     *
132616     * Returns the number of fields from specified result set.
132617     *
132618     * @var int
132619     **/
132620    public $field_count;
132621
132622    /**
132623     * Returns the lengths of the columns of the current row in the result
132624     * set
132625     *
132626     * The {@link mysqli_fetch_lengths} function returns an array containing
132627     * the lengths of every column of the current row within the result set.
132628     *
132629     * @var array
132630     **/
132631    public $lengths;
132632
132633    /**
132634     * Gets the number of rows in a result
132635     *
132636     * Returns the number of rows in the result set.
132637     *
132638     * The behaviour of {@link mysqli_num_rows} depends on whether buffered
132639     * or unbuffered result sets are being used. For unbuffered result sets,
132640     * {@link mysqli_num_rows} will not return the correct number of rows
132641     * until all the rows in the result have been retrieved.
132642     *
132643     * @var int
132644     **/
132645    public $num_rows;
132646
132647    /**
132648     * Frees the memory associated with a result
132649     *
132650     * Frees the memory associated with the result.
132651     *
132652     * @return void
132653     * @since PHP 5, PHP 7
132654     **/
132655    public function close(){}
132656
132657    /**
132658     * Adjusts the result pointer to an arbitrary row in the result
132659     *
132660     * The {@link mysqli_data_seek} function seeks to an arbitrary result
132661     * pointer specified by the {@link offset} in the result set.
132662     *
132663     * @param int $offset The field offset. Must be between zero and the
132664     *   total number of rows minus one (0..{@link mysqli_num_rows} - 1).
132665     * @return bool
132666     * @since PHP 5, PHP 7
132667     **/
132668    public function data_seek($offset){}
132669
132670    /**
132671     * Fetches all result rows as an associative array, a numeric array, or
132672     * both
132673     *
132674     * {@link mysqli_fetch_all} fetches all result rows and returns the
132675     * result set as an associative array, a numeric array, or both.
132676     *
132677     * @param int $resulttype This optional parameter is a constant
132678     *   indicating what type of array should be produced from the current
132679     *   row data. The possible values for this parameter are the constants
132680     *   MYSQLI_ASSOC, MYSQLI_NUM, or MYSQLI_BOTH.
132681     * @return mixed Returns an array of associative or numeric arrays
132682     *   holding result rows.
132683     * @since PHP 5 >= 5.3.0, PHP 7
132684     **/
132685    public function fetch_all($resulttype){}
132686
132687    /**
132688     * Fetch a result row as an associative, a numeric array, or both
132689     *
132690     * Returns an array that corresponds to the fetched row or NULL if there
132691     * are no more rows for the resultset represented by the {@link result}
132692     * parameter.
132693     *
132694     * {@link mysqli_fetch_array} is an extended version of the {@link
132695     * mysqli_fetch_row} function. In addition to storing the data in the
132696     * numeric indices of the result array, the {@link mysqli_fetch_array}
132697     * function can also store the data in associative indices, using the
132698     * field names of the result set as keys.
132699     *
132700     * If two or more columns of the result have the same field names, the
132701     * last column will take precedence and overwrite the earlier data. In
132702     * order to access multiple columns with the same name, the numerically
132703     * indexed version of the row must be used.
132704     *
132705     * @param int $resulttype This optional parameter is a constant
132706     *   indicating what type of array should be produced from the current
132707     *   row data. The possible values for this parameter are the constants
132708     *   MYSQLI_ASSOC, MYSQLI_NUM, or MYSQLI_BOTH. By using the MYSQLI_ASSOC
132709     *   constant this function will behave identically to the {@link
132710     *   mysqli_fetch_assoc}, while MYSQLI_NUM will behave identically to the
132711     *   {@link mysqli_fetch_row} function. The final option MYSQLI_BOTH will
132712     *   create a single array with the attributes of both.
132713     * @return mixed Returns an array of strings that corresponds to the
132714     *   fetched row or NULL if there are no more rows in resultset.
132715     * @since PHP 5, PHP 7
132716     **/
132717    public function fetch_array($resulttype){}
132718
132719    /**
132720     * Fetch a result row as an associative array
132721     *
132722     * Returns an associative array that corresponds to the fetched row or
132723     * NULL if there are no more rows.
132724     *
132725     * @return array Returns an associative array of strings representing
132726     *   the fetched row in the result set, where each key in the array
132727     *   represents the name of one of the result set's columns or NULL if
132728     *   there are no more rows in resultset.
132729     * @since PHP 5, PHP 7
132730     **/
132731    public function fetch_assoc(){}
132732
132733    /**
132734     * Returns the next field in the result set
132735     *
132736     * Returns the definition of one column of a result set as an object.
132737     * Call this function repeatedly to retrieve information about all
132738     * columns in the result set.
132739     *
132740     * @return object Returns an object which contains field definition
132741     *   information or FALSE if no field information is available.
132742     * @since PHP 5, PHP 7
132743     **/
132744    public function fetch_field(){}
132745
132746    /**
132747     * Returns an array of objects representing the fields in a result set
132748     *
132749     * This function serves an identical purpose to the {@link
132750     * mysqli_fetch_field} function with the single difference that, instead
132751     * of returning one object at a time for each field, the columns are
132752     * returned as an array of objects.
132753     *
132754     * @return array Returns an array of objects which contains field
132755     *   definition information or FALSE if no field information is
132756     *   available.
132757     * @since PHP 5, PHP 7
132758     **/
132759    public function fetch_fields(){}
132760
132761    /**
132762     * Fetch meta-data for a single field
132763     *
132764     * Returns an object which contains field definition information from the
132765     * specified result set.
132766     *
132767     * @param int $fieldnr The field number. This value must be in the
132768     *   range from 0 to number of fields - 1.
132769     * @return object Returns an object which contains field definition
132770     *   information or FALSE if no field information for specified fieldnr
132771     *   is available.
132772     * @since PHP 5, PHP 7
132773     **/
132774    public function fetch_field_direct($fieldnr){}
132775
132776    /**
132777     * Returns the current row of a result set as an object
132778     *
132779     * The {@link mysqli_fetch_object} will return the current row result set
132780     * as an object where the attributes of the object represent the names of
132781     * the fields found within the result set.
132782     *
132783     * Note that {@link mysqli_fetch_object} sets the properties of the
132784     * object before calling the object constructor.
132785     *
132786     * @param string $class_name The name of the class to instantiate, set
132787     *   the properties of and return. If not specified, a stdClass object is
132788     *   returned.
132789     * @param array $params An optional array of parameters to pass to the
132790     *   constructor for {@link class_name} objects.
132791     * @return object Returns an object with string properties that
132792     *   corresponds to the fetched row or NULL if there are no more rows in
132793     *   resultset.
132794     * @since PHP 5, PHP 7
132795     **/
132796    public function fetch_object($class_name, $params){}
132797
132798    /**
132799     * Get a result row as an enumerated array
132800     *
132801     * Fetches one row of data from the result set and returns it as an
132802     * enumerated array, where each column is stored in an array offset
132803     * starting from 0 (zero). Each subsequent call to this function will
132804     * return the next row within the result set, or NULL if there are no
132805     * more rows.
132806     *
132807     * @return mixed {@link mysqli_fetch_row} returns an array of strings
132808     *   that corresponds to the fetched row or NULL if there are no more
132809     *   rows in result set.
132810     * @since PHP 5, PHP 7
132811     **/
132812    public function fetch_row(){}
132813
132814    /**
132815     * Set result pointer to a specified field offset
132816     *
132817     * Sets the field cursor to the given offset. The next call to {@link
132818     * mysqli_fetch_field} will retrieve the field definition of the column
132819     * associated with that offset.
132820     *
132821     * @param int $fieldnr The field number. This value must be in the
132822     *   range from 0 to number of fields - 1.
132823     * @return bool
132824     * @since PHP 5, PHP 7
132825     **/
132826    public function field_seek($fieldnr){}
132827
132828    /**
132829     * Frees the memory associated with a result
132830     *
132831     * Frees the memory associated with the result.
132832     *
132833     * @return void
132834     * @since PHP 5, PHP 7
132835     **/
132836    public function free(){}
132837
132838    /**
132839     * Frees the memory associated with a result
132840     *
132841     * Frees the memory associated with the result.
132842     *
132843     * @return void
132844     * @since PHP 5, PHP 7
132845     **/
132846    public function free_result(){}
132847
132848}
132849/**
132850 * The mysqli exception handling class.
132851 **/
132852class mysqli_sql_exception extends RuntimeException {
132853    /**
132854     * @var string
132855     **/
132856    protected $sqlstate;
132857
132858}
132859/**
132860 * Represents a prepared statement.
132861 **/
132862class mysqli_stmt {
132863    /**
132864     * Returns the total number of rows changed, deleted, or inserted by the
132865     * last executed statement
132866     *
132867     * Returns the number of rows affected by INSERT, UPDATE, or DELETE
132868     * query.
132869     *
132870     * This function only works with queries which update a table. In order
132871     * to get the number of rows from a SELECT query, use {@link
132872     * mysqli_stmt_num_rows} instead.
132873     *
132874     * @var int
132875     **/
132876    public $affected_rows;
132877
132878    /**
132879     * Returns the error code for the most recent statement call
132880     *
132881     * Returns the error code for the most recently invoked statement
132882     * function that can succeed or fail.
132883     *
132884     * Client error message numbers are listed in the MySQL errmsg.h header
132885     * file, server error message numbers are listed in mysqld_error.h. In
132886     * the MySQL source distribution you can find a complete list of error
132887     * messages and error numbers in the file Docs/mysqld_error.txt.
132888     *
132889     * @var int
132890     **/
132891    public $errno;
132892
132893    /**
132894     * Returns a string description for last statement error
132895     *
132896     * Returns a string containing the error message for the most recently
132897     * invoked statement function that can succeed or fail.
132898     *
132899     * @var string
132900     **/
132901    public $error;
132902
132903    /**
132904     * Returns a list of errors from the last statement executed
132905     *
132906     * Returns an array of errors for the most recently invoked statement
132907     * function that can succeed or fail.
132908     *
132909     * @var array
132910     **/
132911    public $error_list;
132912
132913    /**
132914     * Returns the number of field in the given statement
132915     *
132916     * @var int
132917     **/
132918    public $field_count;
132919
132920    /**
132921     * Get the ID generated from the previous INSERT operation
132922     *
132923     * @var int
132924     **/
132925    public $insert_id;
132926
132927    /**
132928     * Return the number of rows in statements result set
132929     *
132930     * Returns the number of rows in the result set. The use of {@link
132931     * mysqli_stmt_num_rows} depends on whether or not you used {@link
132932     * mysqli_stmt_store_result} to buffer the entire result set in the
132933     * statement handle.
132934     *
132935     * If you use {@link mysqli_stmt_store_result}, {@link
132936     * mysqli_stmt_num_rows} may be called immediately.
132937     *
132938     * @var int
132939     **/
132940    public $num_rows;
132941
132942    /**
132943     * Returns the number of parameter for the given statement
132944     *
132945     * Returns the number of parameter markers present in the prepared
132946     * statement.
132947     *
132948     * @var int
132949     **/
132950    public $param_count;
132951
132952    /**
132953     * Returns SQLSTATE error from previous statement operation
132954     *
132955     * Returns a string containing the SQLSTATE error code for the most
132956     * recently invoked prepared statement function that can succeed or fail.
132957     * The error code consists of five characters. '00000' means no error.
132958     * The values are specified by ANSI SQL and ODBC. For a list of possible
132959     * values, see .
132960     *
132961     * @var string
132962     **/
132963    public $sqlstate;
132964
132965    /**
132966     * Used to get the current value of a statement attribute
132967     *
132968     * Gets the current value of a statement attribute.
132969     *
132970     * @param int $attr The attribute that you want to get.
132971     * @return int Returns FALSE if the attribute is not found, otherwise
132972     *   returns the value of the attribute.
132973     * @since PHP 5, PHP 7
132974     **/
132975    public function attr_get($attr){}
132976
132977    /**
132978     * Used to modify the behavior of a prepared statement
132979     *
132980     * Used to modify the behavior of a prepared statement. This function may
132981     * be called multiple times to set several attributes.
132982     *
132983     * @param int $attr The attribute that you want to set. It can have one
132984     *   of the following values: Attribute values Character Description
132985     *   MYSQLI_STMT_ATTR_UPDATE_MAX_LENGTH Setting to TRUE causes {@link
132986     *   mysqli_stmt_store_result} to update the metadata
132987     *   MYSQL_FIELD->max_length value. MYSQLI_STMT_ATTR_CURSOR_TYPE Type of
132988     *   cursor to open for statement when {@link mysqli_stmt_execute} is
132989     *   invoked. {@link mode} can be MYSQLI_CURSOR_TYPE_NO_CURSOR (the
132990     *   default) or MYSQLI_CURSOR_TYPE_READ_ONLY.
132991     *   MYSQLI_STMT_ATTR_PREFETCH_ROWS Number of rows to fetch from server
132992     *   at a time when using a cursor. {@link mode} can be in the range from
132993     *   1 to the maximum value of unsigned long. The default is 1. If you
132994     *   use the MYSQLI_STMT_ATTR_CURSOR_TYPE option with
132995     *   MYSQLI_CURSOR_TYPE_READ_ONLY, a cursor is opened for the statement
132996     *   when you invoke {@link mysqli_stmt_execute}. If there is already an
132997     *   open cursor from a previous {@link mysqli_stmt_execute} call, it
132998     *   closes the cursor before opening a new one. {@link
132999     *   mysqli_stmt_reset} also closes any open cursor before preparing the
133000     *   statement for re-execution. {@link mysqli_stmt_free_result} closes
133001     *   any open cursor. If you open a cursor for a prepared statement,
133002     *   {@link mysqli_stmt_store_result} is unnecessary.
133003     * @param int $mode The value to assign to the attribute.
133004     * @return bool
133005     * @since PHP 5, PHP 7
133006     **/
133007    public function attr_set($attr, $mode){}
133008
133009    /**
133010     * Binds variables to a prepared statement as parameters
133011     *
133012     * Bind variables for the parameter markers in the SQL statement that was
133013     * passed to {@link mysqli_prepare}.
133014     *
133015     * @param string $types A string that contains one or more characters
133016     *   which specify the types for the corresponding bind variables: Type
133017     *   specification chars Character Description i corresponding variable
133018     *   has type integer d corresponding variable has type double s
133019     *   corresponding variable has type string b corresponding variable is a
133020     *   blob and will be sent in packets
133021     * @param mixed $var1 The number of variables and length of string
133022     *   {@link types} must match the parameters in the statement.
133023     * @param mixed ...$vararg
133024     * @return bool
133025     * @since PHP 5, PHP 7
133026     **/
133027    public function bind_param($types, &$var1, &...$vararg){}
133028
133029    /**
133030     * Binds variables to a prepared statement for result storage
133031     *
133032     * Binds columns in the result set to variables.
133033     *
133034     * When {@link mysqli_stmt_fetch} is called to fetch data, the MySQL
133035     * client/server protocol places the data for the bound columns into the
133036     * specified variables {@link var1, ...}.
133037     *
133038     * @param mixed $var1 The variable to be bound.
133039     * @param mixed ...$vararg
133040     * @return bool
133041     * @since PHP 5, PHP 7
133042     **/
133043    public function bind_result(&$var1, &...$vararg){}
133044
133045    /**
133046     * Closes a prepared statement
133047     *
133048     * Closes a prepared statement. {@link mysqli_stmt_close} also
133049     * deallocates the statement handle. If the current statement has pending
133050     * or unread results, this function cancels them so that the next query
133051     * can be executed.
133052     *
133053     * @return bool
133054     * @since PHP 5, PHP 7
133055     **/
133056    public function close(){}
133057
133058    /**
133059     * Seeks to an arbitrary row in statement result set
133060     *
133061     * Seeks to an arbitrary result pointer in the statement result set.
133062     *
133063     * {@link mysqli_stmt_store_result} must be called prior to {@link
133064     * mysqli_stmt_data_seek}.
133065     *
133066     * @param int $offset Must be between zero and the total number of rows
133067     *   minus one (0.. {@link mysqli_stmt_num_rows} - 1).
133068     * @return void
133069     * @since PHP 5, PHP 7
133070     **/
133071    public function data_seek($offset){}
133072
133073    /**
133074     * Executes a prepared Query
133075     *
133076     * Executes a query that has been previously prepared using the {@link
133077     * mysqli_prepare} function. When executed any parameter markers which
133078     * exist will automatically be replaced with the appropriate data.
133079     *
133080     * If the statement is UPDATE, DELETE, or INSERT, the total number of
133081     * affected rows can be determined by using the {@link
133082     * mysqli_stmt_affected_rows} function. Likewise, if the query yields a
133083     * result set the {@link mysqli_stmt_fetch} function is used.
133084     *
133085     * @return bool
133086     * @since PHP 5, PHP 7
133087     **/
133088    public function execute(){}
133089
133090    /**
133091     * Fetch results from a prepared statement into the bound variables
133092     *
133093     * Fetch the result from a prepared statement into the variables bound by
133094     * {@link mysqli_stmt_bind_result}.
133095     *
133096     * @return bool
133097     * @since PHP 5, PHP 7
133098     **/
133099    public function fetch(){}
133100
133101    /**
133102     * Frees stored result memory for the given statement handle
133103     *
133104     * Frees the result memory associated with the statement, which was
133105     * allocated by {@link mysqli_stmt_store_result}.
133106     *
133107     * @return void
133108     * @since PHP 5, PHP 7
133109     **/
133110    public function free_result(){}
133111
133112    /**
133113     * Gets a result set from a prepared statement
133114     *
133115     * Call to return a result set from a prepared statement query.
133116     *
133117     * @return mysqli_result Returns a resultset for successful SELECT
133118     *   queries, or FALSE for other DML queries or on failure. The {@link
133119     *   mysqli_errno} function can be used to distinguish between the two
133120     *   types of failure.
133121     * @since PHP 5 >= 5.3.0, PHP 7
133122     **/
133123    public function get_result(){}
133124
133125    /**
133126     * Get result of SHOW WARNINGS
133127     *
133128     * @return object
133129     * @since PHP 5 >= 5.1.0, PHP 7
133130     **/
133131    public function get_warnings(){}
133132
133133    /**
133134     * Check if there are more query results from a multiple query
133135     *
133136     * Checks if there are more query results from a multiple query.
133137     *
133138     * @return bool Returns TRUE if more results exist, otherwise FALSE.
133139     * @since PHP 5 >= 5.3.0, PHP 7
133140     **/
133141    public function more_results(){}
133142
133143    /**
133144     * Reads the next result from a multiple query
133145     *
133146     * @return bool
133147     * @since PHP 5 >= 5.3.0, PHP 7
133148     **/
133149    public function next_result(){}
133150
133151    /**
133152     * Return the number of rows in statements result set
133153     *
133154     * Returns the number of rows in the result set. The use of {@link
133155     * mysqli_stmt_num_rows} depends on whether or not you used {@link
133156     * mysqli_stmt_store_result} to buffer the entire result set in the
133157     * statement handle.
133158     *
133159     * If you use {@link mysqli_stmt_store_result}, {@link
133160     * mysqli_stmt_num_rows} may be called immediately.
133161     *
133162     * @return int An integer representing the number of rows in result
133163     *   set.
133164     * @since PHP 5, PHP 7
133165     **/
133166    public function num_rows(){}
133167
133168    /**
133169     * Prepare an SQL statement for execution
133170     *
133171     * Prepares the SQL query pointed to by the null-terminated string query.
133172     *
133173     * The parameter markers must be bound to application variables using
133174     * {@link mysqli_stmt_bind_param} and/or {@link mysqli_stmt_bind_result}
133175     * before executing the statement or fetching rows.
133176     *
133177     * @param string $query The query, as a string. It must consist of a
133178     *   single SQL statement. You can include one or more parameter markers
133179     *   in the SQL statement by embedding question mark (?) characters at
133180     *   the appropriate positions.
133181     * @return mixed
133182     * @since PHP 5, PHP 7
133183     **/
133184    public function prepare($query){}
133185
133186    /**
133187     * Resets a prepared statement
133188     *
133189     * Resets a prepared statement on client and server to state after
133190     * prepare.
133191     *
133192     * It resets the statement on the server, data sent using {@link
133193     * mysqli_stmt_send_long_data}, unbuffered result sets and current
133194     * errors. It does not clear bindings or stored result sets. Stored
133195     * result sets will be cleared when executing the prepared statement (or
133196     * closing it).
133197     *
133198     * To prepare a statement with another query use function {@link
133199     * mysqli_stmt_prepare}.
133200     *
133201     * @return bool
133202     * @since PHP 5, PHP 7
133203     **/
133204    public function reset(){}
133205
133206    /**
133207     * Returns result set metadata from a prepared statement
133208     *
133209     * If a statement passed to {@link mysqli_prepare} is one that produces a
133210     * result set, {@link mysqli_stmt_result_metadata} returns the result
133211     * object that can be used to process the meta information such as total
133212     * number of fields and individual field information.
133213     *
133214     * The result set structure should be freed when you are done with it,
133215     * which you can do by passing it to {@link mysqli_free_result}
133216     *
133217     * @return mysqli_result Returns a result object or FALSE if an error
133218     *   occurred.
133219     * @since PHP 5, PHP 7
133220     **/
133221    public function result_metadata(){}
133222
133223    /**
133224     * Send data in blocks
133225     *
133226     * Allows to send parameter data to the server in pieces (or chunks),
133227     * e.g. if the size of a blob exceeds the size of max_allowed_packet.
133228     * This function can be called multiple times to send the parts of a
133229     * character or binary data value for a column, which must be one of the
133230     * TEXT or BLOB datatypes.
133231     *
133232     * @param int $param_nr Indicates which parameter to associate the data
133233     *   with. Parameters are numbered beginning with 0.
133234     * @param string $data A string containing data to be sent.
133235     * @return bool
133236     * @since PHP 5, PHP 7
133237     **/
133238    public function send_long_data($param_nr, $data){}
133239
133240    /**
133241     * Transfers a result set from a prepared statement
133242     *
133243     * You must call {@link mysqli_stmt_store_result} for every query that
133244     * successfully produces a result set (SELECT, SHOW, DESCRIBE, EXPLAIN),
133245     * if and only if you want to buffer the complete result set by the
133246     * client, so that the subsequent {@link mysqli_stmt_fetch} call returns
133247     * buffered data.
133248     *
133249     * @return bool
133250     * @since PHP 5, PHP 7
133251     **/
133252    public function store_result(){}
133253
133254}
133255/**
133256 * Represents a MySQL warning.
133257 **/
133258class mysqli_warning {
133259    /**
133260     * @var mixed
133261     **/
133262    public $errno;
133263
133264    /**
133265     * @var mixed
133266     **/
133267    public $message;
133268
133269    /**
133270     * @var mixed
133271     **/
133272    public $sqlstate;
133273
133274    /**
133275     * Fetch next warning
133276     *
133277     * Change warning information to the next warning if possible.
133278     *
133279     * Once the warning has been set to the next warning, new values of
133280     * properties message, sqlstate and errno of mysqli_warning are
133281     * available.
133282     *
133283     * @return bool Returns TRUE if next warning was fetched successfully.
133284     *   If there are no more warnings, it will return FALSE
133285     * @since PHP 5, PHP 7
133286     **/
133287    public function next(){}
133288
133289    /**
133290     * The __construct purpose
133291     *
133292     * @since PHP 5, PHP 7
133293     **/
133294    protected function __construct(){}
133295
133296}
133297class MysqlndUhConnection {
133298    /**
133299     * Changes the user of the specified mysqlnd database connection
133300     *
133301     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133302     *   not modify!
133303     * @param string $user The MySQL user name.
133304     * @param string $password The MySQL password.
133305     * @param string $database The MySQL database to change to.
133306     * @param bool $silent Controls if mysqlnd is allowed to emit errors or
133307     *   not.
133308     * @param int $passwd_len Length of the MySQL password.
133309     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133310     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133311     **/
133312    public function changeUser($connection, $user, $password, $database, $silent, $passwd_len){}
133313
133314    /**
133315     * Returns the default character set for the database connection
133316     *
133317     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133318     *   not modify!
133319     * @return string The default character set.
133320     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133321     **/
133322    public function charsetName($connection){}
133323
133324    /**
133325     * Closes a previously opened database connection
133326     *
133327     * @param mysqlnd_connection $connection The connection to be closed.
133328     *   Do not modify!
133329     * @param int $close_type Why the connection is to be closed. The value
133330     *   of {@link close_type} is one of MYSQLND_UH_MYSQLND_CLOSE_EXPLICIT,
133331     *   MYSQLND_UH_MYSQLND_CLOSE_IMPLICIT,
133332     *   MYSQLND_UH_MYSQLND_CLOSE_DISCONNECTED or
133333     *   MYSQLND_UH_MYSQLND_CLOSE_LAST. The latter should never be seen,
133334     *   unless the default behaviour of the mysqlnd library has been changed
133335     *   by a plugin.
133336     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133337     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133338     **/
133339    public function close($connection, $close_type){}
133340
133341    /**
133342     * Open a new connection to the MySQL server
133343     *
133344     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133345     *   not modify!
133346     * @param string $host Can be either a host name or an IP address.
133347     *   Passing the NULL value or the string localhost to this parameter,
133348     *   the local host is assumed. When possible, pipes will be used instead
133349     *   of the TCP/IP protocol.
133350     * @param string $use" The MySQL user name.
133351     * @param string $password If not provided or NULL, the MySQL server
133352     *   will attempt to authenticate the user against those user records
133353     *   which have no password only. This allows one username to be used
133354     *   with different permissions (depending on if a password as provided
133355     *   or not).
133356     * @param string $database If provided will specify the default
133357     *   database to be used when performing queries.
133358     * @param int $port Specifies the port number to attempt to connect to
133359     *   the MySQL server.
133360     * @param string $socket Specifies the socket or named pipe that should
133361     *   be used. If NULL, mysqlnd will default to /tmp/mysql.sock.
133362     * @param int $mysql_flags Connection options.
133363     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133364     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133365     **/
133366    public function connect($connection, $host, $use, $password, $database, $port, $socket, $mysql_flags){}
133367
133368    /**
133369     * End a persistent connection
133370     *
133371     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133372     *   not modify!
133373     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133374     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133375     **/
133376    public function endPSession($connection){}
133377
133378    /**
133379     * Escapes special characters in a string for use in an SQL statement,
133380     * taking into account the current charset of the connection
133381     *
133382     * Escapes special characters in a string for use in an SQL statement,
133383     * taking into account the current charset of the connection.
133384     *
133385     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133386     *   not modify!
133387     * @param string $escape_string The string to be escaped.
133388     * @return string The escaped string.
133389     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133390     **/
133391    public function escapeString($connection, $escape_string){}
133392
133393    /**
133394     * Gets the number of affected rows in a previous MySQL operation
133395     *
133396     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133397     *   not modify!
133398     * @return int Number of affected rows.
133399     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133400     **/
133401    public function getAffectedRows($connection){}
133402
133403    /**
133404     * Returns the error code for the most recent function call
133405     *
133406     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133407     *   not modify!
133408     * @return int Error code for the most recent function call.
133409     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133410     **/
133411    public function getErrorNumber($connection){}
133412
133413    /**
133414     * Returns a string description of the last error
133415     *
133416     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133417     *   not modify!
133418     * @return string Error string for the most recent function call.
133419     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133420     **/
133421    public function getErrorString($connection){}
133422
133423    /**
133424     * Returns the number of columns for the most recent query
133425     *
133426     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133427     *   not modify!
133428     * @return int Number of columns.
133429     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133430     **/
133431    public function getFieldCount($connection){}
133432
133433    /**
133434     * Returns a string representing the type of connection used
133435     *
133436     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133437     *   not modify!
133438     * @return string Connection description.
133439     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133440     **/
133441    public function getHostInformation($connection){}
133442
133443    /**
133444     * Returns the auto generated id used in the last query
133445     *
133446     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133447     *   not modify!
133448     * @return int Last insert id.
133449     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133450     **/
133451    public function getLastInsertId($connection){}
133452
133453    /**
133454     * Retrieves information about the most recently executed query
133455     *
133456     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133457     *   not modify!
133458     * @return void Last message. Trying to return a string longer than 511
133459     *   bytes will cause an error of the type E_WARNING and result in the
133460     *   string being truncated.
133461     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133462     **/
133463    public function getLastMessage($connection){}
133464
133465    /**
133466     * Returns the version of the MySQL protocol used
133467     *
133468     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133469     *   not modify!
133470     * @return string The protocol version.
133471     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133472     **/
133473    public function getProtocolInformation($connection){}
133474
133475    /**
133476     * Returns the version of the MySQL server
133477     *
133478     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133479     *   not modify!
133480     * @return string The server version.
133481     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133482     **/
133483    public function getServerInformation($connection){}
133484
133485    /**
133486     * Gets the current system status
133487     *
133488     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133489     *   not modify!
133490     * @return string The system status message.
133491     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133492     **/
133493    public function getServerStatistics($connection){}
133494
133495    /**
133496     * Returns the version of the MySQL server as an integer
133497     *
133498     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133499     *   not modify!
133500     * @return int The MySQL version.
133501     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133502     **/
133503    public function getServerVersion($connection){}
133504
133505    /**
133506     * Returns the SQLSTATE error from previous MySQL operation
133507     *
133508     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133509     *   not modify!
133510     * @return string The SQLSTATE code.
133511     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133512     **/
133513    public function getSqlstate($connection){}
133514
133515    /**
133516     * Returns statistics about the client connection
133517     *
133518     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133519     *   not modify!
133520     * @return array Connection statistics collected by mysqlnd.
133521     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133522     **/
133523    public function getStatistics($connection){}
133524
133525    /**
133526     * Returns the thread ID for the current connection
133527     *
133528     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133529     *   not modify!
133530     * @return int Connection thread id.
133531     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133532     **/
133533    public function getThreadId($connection){}
133534
133535    /**
133536     * Returns the number of warnings from the last query for the given link
133537     *
133538     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133539     *   not modify!
133540     * @return int Number of warnings.
133541     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133542     **/
133543    public function getWarningCount($connection){}
133544
133545    /**
133546     * Initialize mysqlnd connection
133547     *
133548     * Initialize mysqlnd connection. This is an mysqlnd internal call to
133549     * initialize the connection object.
133550     *
133551     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133552     *   not modify!
133553     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133554     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133555     **/
133556    public function init($connection){}
133557
133558    /**
133559     * Asks the server to kill a MySQL thread
133560     *
133561     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133562     *   not modify!
133563     * @param int $pid Thread Id of the connection to be killed.
133564     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133565     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133566     **/
133567    public function killConnection($connection, $pid){}
133568
133569    /**
133570     * List MySQL table fields
133571     *
133572     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133573     *   not modify!
133574     * @param string $table The name of the table that's being queried.
133575     * @param string $achtung_wild Name pattern.
133576     * @return array
133577     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133578     **/
133579    public function listFields($connection, $table, $achtung_wild){}
133580
133581    /**
133582     * Wrapper for assorted list commands
133583     *
133584     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133585     *   not modify!
133586     * @param string $query SHOW command to be executed.
133587     * @param string $achtung_wild
133588     * @param string $par1
133589     * @return void
133590     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133591     **/
133592    public function listMethod($connection, $query, $achtung_wild, $par1){}
133593
133594    /**
133595     * Check if there are any more query results from a multi query
133596     *
133597     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133598     *   not modify!
133599     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133600     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133601     **/
133602    public function moreResults($connection){}
133603
133604    /**
133605     * Prepare next result from multi_query
133606     *
133607     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133608     *   not modify!
133609     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133610     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133611     **/
133612    public function nextResult($connection){}
133613
133614    /**
133615     * Pings a server connection, or tries to reconnect if the connection has
133616     * gone down
133617     *
133618     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133619     *   not modify!
133620     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133621     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133622     **/
133623    public function ping($connection){}
133624
133625    /**
133626     * Performs a query on the database
133627     *
133628     * Performs a query on the database (COM_QUERY).
133629     *
133630     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133631     *   not modify!
133632     * @param string $query The query string.
133633     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133634     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133635     **/
133636    public function query($connection, $query){}
133637
133638    /**
133639     * Read a result set header
133640     *
133641     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133642     *   not modify!
133643     * @param mysqlnd_statement $mysqlnd_stmt Mysqlnd statement handle. Do
133644     *   not modify! Set to NULL, if function is not used in the context of a
133645     *   prepared statement.
133646     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133647     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133648     **/
133649    public function queryReadResultsetHeader($connection, $mysqlnd_stmt){}
133650
133651    /**
133652     * Get result from async query
133653     *
133654     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133655     *   not modify!
133656     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133657     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133658     **/
133659    public function reapQuery($connection){}
133660
133661    /**
133662     * Flush or reset tables and caches
133663     *
133664     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133665     *   not modify!
133666     * @param int $options What to refresh.
133667     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133668     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133669     **/
133670    public function refreshServer($connection, $options){}
133671
133672    /**
133673     * Restart a persistent mysqlnd connection
133674     *
133675     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133676     *   not modify!
133677     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133678     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133679     **/
133680    public function restartPSession($connection){}
133681
133682    /**
133683     * Selects the default database for database queries
133684     *
133685     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133686     *   not modify!
133687     * @param string $database The database name.
133688     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133689     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133690     **/
133691    public function selectDb($connection, $database){}
133692
133693    /**
133694     * Sends a close command to MySQL
133695     *
133696     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133697     *   not modify!
133698     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133699     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133700     **/
133701    public function sendClose($connection){}
133702
133703    /**
133704     * Sends a query to MySQL
133705     *
133706     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133707     *   not modify!
133708     * @param string $query The query string.
133709     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133710     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133711     **/
133712    public function sendQuery($connection, $query){}
133713
133714    /**
133715     * Dump debugging information into the log for the MySQL server
133716     *
133717     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133718     *   not modify!
133719     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133720     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133721     **/
133722    public function serverDumpDebugInformation($connection){}
133723
133724    /**
133725     * Turns on or off auto-committing database modifications
133726     *
133727     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133728     *   not modify!
133729     * @param int $mode Whether to turn on auto-commit or not.
133730     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133731     * @since PECL mysqlnd-uh >= 1.0.1-alpha
133732     **/
133733    public function setAutocommit($connection, $mode){}
133734
133735    /**
133736     * Sets the default client character set
133737     *
133738     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133739     *   not modify!
133740     * @param string $charset The charset to be set as default.
133741     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133742     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133743     **/
133744    public function setCharset($connection, $charset){}
133745
133746    /**
133747     * Sets a client option
133748     *
133749     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133750     *   not modify!
133751     * @param int $option The option to be set.
133752     * @param int $value Optional option value, if required.
133753     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133754     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133755     **/
133756    public function setClientOption($connection, $option, $value){}
133757
133758    /**
133759     * Sets a server option
133760     *
133761     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133762     *   not modify!
133763     * @param int $option The option to be set.
133764     * @return void Returns TRUE on success. Otherwise, returns FALSE
133765     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133766     **/
133767    public function setServerOption($connection, $option){}
133768
133769    /**
133770     * The shutdownServer purpose
133771     *
133772     * @param string $MYSQLND_UH_RES_MYSQLND_NAME
133773     * @param string $level
133774     * @return void
133775     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133776     **/
133777    public function shutdownServer($MYSQLND_UH_RES_MYSQLND_NAME, $level){}
133778
133779    /**
133780     * Sends a basic COM_* command
133781     *
133782     * Sends a basic COM_* command to MySQL.
133783     *
133784     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133785     *   not modify!
133786     * @param int $command The COM command to be send.
133787     * @param string $arg Optional COM command arguments.
133788     * @param int $ok_packet The OK packet type.
133789     * @param bool $silent Whether mysqlnd may emit errors.
133790     * @param bool $ignore_upsert_status Whether to ignore UPDATE/INSERT
133791     *   status.
133792     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133793     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133794     **/
133795    public function simpleCommand($connection, $command, $arg, $ok_packet, $silent, $ignore_upsert_status){}
133796
133797    /**
133798     * Process a response for a basic COM_* command send to the client
133799     *
133800     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133801     *   not modify!
133802     * @param int $ok_packet The OK packet type.
133803     * @param bool $silent Whether mysqlnd may emit errors.
133804     * @param int $command The COM command to process results from.
133805     * @param bool $ignore_upsert_status Whether to ignore UPDATE/INSERT
133806     *   status.
133807     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133808     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133809     **/
133810    public function simpleCommandHandleResponse($connection, $ok_packet, $silent, $command, $ignore_upsert_status){}
133811
133812    /**
133813     * Used for establishing secure connections using SSL
133814     *
133815     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133816     *   not modify!
133817     * @param string $key The path name to the key file.
133818     * @param string $cert The path name to the certificate file.
133819     * @param string $ca The path name to the certificate authority file.
133820     * @param string $capath The pathname to a directory that contains
133821     *   trusted SSL CA certificates in PEM format.
133822     * @param string $cipher A list of allowable ciphers to use for SSL
133823     *   encryption.
133824     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133825     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133826     **/
133827    public function sslSet($connection, $key, $cert, $ca, $capath, $cipher){}
133828
133829    /**
133830     * Initializes a statement and returns a resource for use with
133831     * mysqli_statement::prepare
133832     *
133833     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133834     *   not modify!
133835     * @return resource Resource of type Mysqlnd Prepared Statement
133836     *   (internal only - you must not modify it!). The documentation may
133837     *   also refer to such resources using the alias name
133838     *   mysqlnd_prepared_statement.
133839     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133840     **/
133841    public function stmtInit($connection){}
133842
133843    /**
133844     * Transfers a result set from the last query
133845     *
133846     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133847     *   not modify!
133848     * @return resource Resource of type Mysqlnd Resultset (internal only -
133849     *   you must not modify it!). The documentation may also refer to such
133850     *   resources using the alias name mysqlnd_resultset.
133851     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133852     **/
133853    public function storeResult($connection){}
133854
133855    /**
133856     * Commits the current transaction
133857     *
133858     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133859     *   not modify!
133860     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133861     * @since PECL mysqlnd-uh >= 1.0.1-alpha
133862     **/
133863    public function txCommit($connection){}
133864
133865    /**
133866     * Rolls back current transaction
133867     *
133868     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133869     *   not modify!
133870     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133871     * @since PECL mysqlnd-uh >= 1.0.1-alpha
133872     **/
133873    public function txRollback($connection){}
133874
133875    /**
133876     * Initiate a result set retrieval
133877     *
133878     * @param mysqlnd_connection $connection Mysqlnd connection handle. Do
133879     *   not modify!
133880     * @return resource Resource of type Mysqlnd Resultset (internal only -
133881     *   you must not modify it!). The documentation may also refer to such
133882     *   resources using the alias name mysqlnd_resultset.
133883     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133884     **/
133885    public function useResult($connection){}
133886
133887    /**
133888     * The __construct purpose
133889     *
133890     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133891     **/
133892    public function __construct(){}
133893
133894}
133895class MysqlndUhPreparedStatement {
133896    /**
133897     * Executes a prepared Query
133898     *
133899     * @param mysqlnd_prepared_statement $statement Mysqlnd prepared
133900     *   statement handle. Do not modify! Resource of type Mysqlnd Prepared
133901     *   Statement (internal only - you must not modify it!).
133902     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133903     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133904     **/
133905    public function execute($statement){}
133906
133907    /**
133908     * Prepare an SQL statement for execution
133909     *
133910     * @param mysqlnd_prepared_statement $statement Mysqlnd prepared
133911     *   statement handle. Do not modify! Resource of type Mysqlnd Prepared
133912     *   Statement (internal only - you must not modify it!).
133913     * @param string $query The query to be prepared.
133914     * @return bool Returns TRUE on success. Otherwise, returns FALSE
133915     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133916     **/
133917    public function prepare($statement, $query){}
133918
133919    /**
133920     * The __construct purpose
133921     *
133922     * @since PECL mysqlnd-uh >= 1.0.0-alpha
133923     **/
133924    public function __construct(){}
133925
133926}
133927namespace mysql_xdevapi {
133928interface BaseResult {
133929    /**
133930     * Fetch warnings from last operation
133931     *
133932     * Fetches warnings generated by MySQL server's last operation.
133933     *
133934     * @return array An array of Warning objects from the last operation.
133935     *   Each object defines an error 'message', error 'level', and error
133936     *   'code'. An empty array is returned if no errors are present.
133937     **/
133938    public function getWarnings();
133939
133940    /**
133941     * Fetch warning count from last operation
133942     *
133943     * Returns the number of warnings raised by the last operation.
133944     * Specifically, these warnings are raised by the MySQL server.
133945     *
133946     * @return integer The number of warnings from the last operation.
133947     **/
133948    public function getWarningsCount();
133949
133950}
133951}
133952namespace mysql_xdevapi {
133953class Client {
133954    /**
133955     * Close client
133956     *
133957     * Close all client connections with the server.
133958     *
133959     * @return bool TRUE if connections are closed.
133960     **/
133961    public function close(){}
133962
133963    /**
133964     * Get client session
133965     *
133966     * Get session associated with the client.
133967     *
133968     * @return mysql_xdevapi\Session A Session object.
133969     **/
133970    public function getSession(){}
133971
133972}
133973}
133974namespace mysql_xdevapi {
133975class Collection implements mysql_xdevapi\SchemaObject {
133976    /**
133977     * @var mixed
133978     **/
133979    public $name;
133980
133981    /**
133982     * Add collection document
133983     *
133984     * Triggers the insertion of the given document(s) into the collection,
133985     * and multiple variants of this method are supported. Options include:
133986     *
133987     * @param mixed $document One or multiple documents, and this can be
133988     *   either JSON or an array of fields with their associated values. This
133989     *   cannot be an empty array. The MySQL server automatically generates
133990     *   unique _id values for each document (recommended), although this can
133991     *   be manually added as well. This value must be unique as otherwise
133992     *   the add operation will fail.
133993     * @return mysql_xdevapi\CollectionAdd A CollectionAdd object. Use
133994     *   execute() to return a Result that can be used to query the number of
133995     *   affected items, the number warnings generated by the operation, or
133996     *   to fetch a list of generated IDs for the inserted documents.
133997     **/
133998    public function add($document){}
133999
134000    /**
134001     * Add or replace collection document
134002     *
134003     * Add a new document, or replace a document if it already exists.
134004     *
134005     * Here are several scenarios for this method:
134006     *
134007     * @param string $id This is the filter id. If this id or any other
134008     *   field that has a unique index already exists in the collection, then
134009     *   it will update the matching document instead. By default, this id is
134010     *   automatically generated by MySQL Server when the record was added,
134011     *   and is referenced as a field named '_id'.
134012     * @param string $doc This is the document to add or replace, which is
134013     *   a JSON string.
134014     * @return mysql_xdevapi\Result A Result object.
134015     **/
134016    public function addOrReplaceOne($id, $doc){}
134017
134018    /**
134019     * Get document count
134020     *
134021     * This functionality is similar to a SELECT COUNT(*) SQL operation
134022     * against the MySQL server for the current schema and collection. In
134023     * other words, it counts the number of documents in the collection.
134024     *
134025     * @return integer The number of documents in the collection.
134026     **/
134027    public function count(){}
134028
134029    /**
134030     * Create collection index
134031     *
134032     * Creates an index on the collection.
134033     *
134034     * An exception is thrown if an index with the same name already exists,
134035     * or if index definition is not correctly formed.
134036     *
134037     * @param string $index_name The name of the index that to create. This
134038     *   name must be a valid index name as accepted by the CREATE INDEX SQL
134039     *   query.
134040     * @param string $index_desc_json Definition of the index to create. It
134041     *   contains an array of IndexField objects, and each object describes a
134042     *   single document member to include in the index, and an optional
134043     *   string for the type of index that might be INDEX (default) or
134044     *   SPATIAL. A single IndexField description consists of the following
134045     *   fields: It is an error to include other fields not described above
134046     *   in IndexDefinition or IndexField documents.
134047     * @return void
134048     **/
134049    public function createIndex($index_name, $index_desc_json){}
134050
134051    /**
134052     * Drop collection index
134053     *
134054     * Drop a collection index.
134055     *
134056     * This operation does not yield an error if the index does not exist,
134057     * but FALSE is returned in that case.
134058     *
134059     * @param string $index_name Name of collection index to drop.
134060     * @return bool TRUE if the DROP INDEX operation succeeded, otherwise
134061     *   FALSE.
134062     **/
134063    public function dropIndex($index_name){}
134064
134065    /**
134066     * Check if collection exists in database
134067     *
134068     * Checks if the Collection object refers to a collection in the database
134069     * (schema).
134070     *
134071     * @return bool Returns TRUE if collection exists in the database, else
134072     *   FALSE if it does not.
134073     **/
134074    public function existsInDatabase(){}
134075
134076    /**
134077     * Search for document
134078     *
134079     * Search a database collection for a document or set of documents. The
134080     * found documents are returned as a CollectionFind object is to further
134081     * modify or fetch results from.
134082     *
134083     * @param string $search_condition Although optional, normally a
134084     *   condition is defined to limit the results to a subset of documents.
134085     *   Multiple elements might build the condition and the syntax supports
134086     *   parameter binding. The expression used as search condition must be a
134087     *   valid SQL expression. If no search condition is provided (field
134088     *   empty) then find('true') is assumed.
134089     * @return mysql_xdevapi\CollectionFind A CollectionFind object to
134090     *   verify the operation, or fetch the found documents.
134091     **/
134092    public function find($search_condition){}
134093
134094    /**
134095     * Get collection name
134096     *
134097     * Retrieve the collection's name.
134098     *
134099     * @return string The collection name, as a string.
134100     **/
134101    public function getName(){}
134102
134103    /**
134104     * Get one document
134105     *
134106     * Fetches one document from the collection.
134107     *
134108     * This is a shortcut for: Collection.find("_id = :id").bind("id",
134109     * id).execute().fetchOne();
134110     *
134111     * @param string $id The document _id in the collection.
134112     * @return Document The collection object, or NULL if the _id does not
134113     *   match a document.
134114     **/
134115    public function getOne($id){}
134116
134117    /**
134118     * Get schema object
134119     *
134120     * Retrieve the schema object that contains the collection.
134121     *
134122     * @return Schema Object The schema object on success, or NULL if the
134123     *   object cannot be retrieved for the given collection.
134124     **/
134125    public function getSchema(){}
134126
134127    /**
134128     * Get session object
134129     *
134130     * Get a new Session object from the Collection object.
134131     *
134132     * @return Session A Session object.
134133     **/
134134    public function getSession(){}
134135
134136    /**
134137     * Modify collection documents
134138     *
134139     * Modify collections that meet specific search conditions. Multiple
134140     * operations are allowed, and parameter binding is supported.
134141     *
134142     * @param string $search_condition Must be a valid SQL expression used
134143     *   to match the documents to modify. This expression might be as simple
134144     *   as TRUE, which matches all documents, or it might use functions and
134145     *   operators such as 'CAST(_id AS SIGNED) >= 10', 'age MOD 2 = 0 OR age
134146     *   MOD 3 = 0', or '_id IN ["2","5","7","10"]'.
134147     * @return mysql_xdevapi\CollectionModify If the operation is not
134148     *   executed, then the function will return a Modify object that can be
134149     *   used to add additional modify operations.
134150     **/
134151    public function modify($search_condition){}
134152
134153    /**
134154     * Remove collection documents
134155     *
134156     * Remove collections that meet specific search conditions. Multiple
134157     * operations are allowed, and parameter binding is supported.
134158     *
134159     * @param string $search_condition Must be a valid SQL expression used
134160     *   to match the documents to modify. This expression might be as simple
134161     *   as TRUE, which matches all documents, or it might use functions and
134162     *   operators such as 'CAST(_id AS SIGNED) >= 10', 'age MOD 2 = 0 OR age
134163     *   MOD 3 = 0', or '_id IN ["2","5","7","10"]'.
134164     * @return mysql_xdevapi\CollectionRemove If the operation is not
134165     *   executed, then the function will return a Remove object that can be
134166     *   used to add additional remove operations.
134167     **/
134168    public function remove($search_condition){}
134169
134170    /**
134171     * Remove one collection document
134172     *
134173     * Remove one document from the collection with the correspending ID.
134174     * This is a shortcut for Collection.remove("_id = :id").bind("id",
134175     * id).execute().
134176     *
134177     * @param string $id The ID of the collection document to remove.
134178     *   Typically this is the _id that was generated by MySQL Server when
134179     *   the record was added.
134180     * @return mysql_xdevapi\Result A Result object that can be used to
134181     *   query the number of affected items or the number warnings generated
134182     *   by the operation.
134183     **/
134184    public function removeOne($id){}
134185
134186    /**
134187     * Replace one collection document
134188     *
134189     * Updates (or replaces) the document identified by ID, if it exists.
134190     *
134191     * @param string $id ID of the document to replace or update. Typically
134192     *   this is the _id that was generated by MySQL Server when the record
134193     *   was added.
134194     * @param string $doc Collection document to update or replace the
134195     *   document matching the id parameter. This document can be either a
134196     *   document object or a valid JSON string describing the new document.
134197     * @return mysql_xdevapi\Result A Result object that can be used to
134198     *   query the number of affected items and the number warnings generated
134199     *   by the operation.
134200     **/
134201    public function replaceOne($id, $doc){}
134202
134203}
134204}
134205namespace mysql_xdevapi {
134206class CollectionAdd implements mysql_xdevapi\Executable {
134207    /**
134208     * Execute the statement
134209     *
134210     * The execute method is required to send the CRUD operation request to
134211     * the MySQL server.
134212     *
134213     * @return mysql_xdevapi\Result A Result object that can be used to
134214     *   verify the status of the operation, such as the number of affected
134215     *   rows.
134216     **/
134217    public function execute(){}
134218
134219}
134220}
134221namespace mysql_xdevapi {
134222class CollectionFind implements mysql_xdevapi\Executable, mysql_xdevapi\CrudOperationBindable, mysql_xdevapi\CrudOperationLimitable, mysql_xdevapi\CrudOperationSortable {
134223    /**
134224     * Bind value to query placeholder
134225     *
134226     * It allows the user to bind a parameter to the placeholder in the
134227     * search condition of the find operation. The placeholder has the form
134228     * of :NAME where ':' is a common prefix that must always exists before
134229     * any NAME, NAME is the actual name of the placeholder. The bind
134230     * function accepts a list of placeholders if multiple entities have to
134231     * be substituted in the search condition.
134232     *
134233     * @param array $placeholder_values Values to substitute in the search
134234     *   condition; multiple values are allowed and are passed as an array
134235     *   where "PLACEHOLDER_NAME => PLACEHOLDER_VALUE".
134236     * @return mysql_xdevapi\CollectionFind A CollectionFind object, or
134237     *   chain with execute() to return a Result object.
134238     **/
134239    public function bind($placeholder_values){}
134240
134241    /**
134242     * Execute the statement
134243     *
134244     * Execute the find operation; this functionality allows for method
134245     * chaining.
134246     *
134247     * @return mysql_xdevapi\DocResult A DocResult object that to either
134248     *   fetch results from, or to query the status of the operation.
134249     **/
134250    public function execute(){}
134251
134252    /**
134253     * Set document field filter
134254     *
134255     * Defined the columns for the query to return. If not defined then all
134256     * columns are used.
134257     *
134258     * @param string $projection Can either be a single string or an array
134259     *   of string, those strings are identifying the columns that have to be
134260     *   returned for each document that match the search condition.
134261     * @return mysql_xdevapi\CollectionFind A CollectionFind object that
134262     *   can be used for further processing.
134263     **/
134264    public function fields($projection){}
134265
134266    /**
134267     * Set grouping criteria
134268     *
134269     * This function can be used to group the result-set by one more columns,
134270     * frequently this is used with aggregate functions like
134271     * COUNT,MAX,MIN,SUM etc.
134272     *
134273     * @param string $sort_expr The columns or columns that have to be used
134274     *   for the group operation, this can either be a single string or an
134275     *   array of string arguments, one for each column.
134276     * @return mysql_xdevapi\CollectionFind A CollectionFind that can be
134277     *   used for further processing
134278     **/
134279    public function groupBy($sort_expr){}
134280
134281    /**
134282     * Set condition for aggregate functions
134283     *
134284     * This function can be used after the 'field' operation in order to make
134285     * a selection on the documents to extract.
134286     *
134287     * @param string $sort_expr This must be a valid SQL expression, the
134288     *   use of aggreate functions is allowed
134289     * @return mysql_xdevapi\CollectionFind CollectionFind object that can
134290     *   be used for further processing
134291     **/
134292    public function having($sort_expr){}
134293
134294    /**
134295     * Limit number of returned documents
134296     *
134297     * Set the maximum number of documents to return.
134298     *
134299     * @param integer $rows Maximum number of documents.
134300     * @return mysql_xdevapi\CollectionFind A CollectionFind object that
134301     *   can be used for additional processing; chain with the execute()
134302     *   method to return a DocResult object.
134303     **/
134304    public function limit($rows){}
134305
134306    /**
134307     * Execute operation with EXCLUSIVE LOCK
134308     *
134309     * Lock exclusively the document, other transactions are blocked from
134310     * updating the document until the document is locked While the document
134311     * is locked, other transactions are blocked from updating those docs,
134312     * from doing SELECT ... LOCK IN SHARE MODE, or from reading the data in
134313     * certain transaction isolation levels. Consistent reads ignore any
134314     * locks set on the records that exist in the read view.
134315     *
134316     * This feature is directly useful with the modify() command, to avoid
134317     * concurrency problems. Basically, it serializes access to a row through
134318     * row locking
134319     *
134320     * @param integer $lock_waiting_option Optional waiting option. By
134321     *   default it is MYSQLX_LOCK_DEFAULT. Valid values are these constants:
134322     * @return mysql_xdevapi\CollectionFind Returns a CollectionFind object
134323     *   that can be used for further processing
134324     **/
134325    public function lockExclusive($lock_waiting_option){}
134326
134327    /**
134328     * Execute operation with SHARED LOCK
134329     *
134330     * Allows to share the documents between multiple transactions which are
134331     * locking in shared mode.
134332     *
134333     * Other sessions can read the rows, but cannot modify them until your
134334     * transaction commits.
134335     *
134336     * If any of these rows were changed by another transaction that has not
134337     * yet committed,
134338     *
134339     * your query waits until that transaction ends and then uses the latest
134340     * values.
134341     *
134342     * @param integer $lock_waiting_option Optional waiting option. By
134343     *   default it is MYSQLX_LOCK_DEFAULT. Valid values are these constants:
134344     * @return mysql_xdevapi\CollectionFind A CollectionFind object that
134345     *   can be used for further processing
134346     **/
134347    public function lockShared($lock_waiting_option){}
134348
134349    /**
134350     * Skip given number of elements to be returned
134351     *
134352     * Skip (offset) these number of elements that otherwise would be
134353     * returned by the find operation. Use with the limit() method.
134354     *
134355     * Defining an offset larger than the result set size results in an empty
134356     * set.
134357     *
134358     * @param integer $position Number of elements to skip for the limit()
134359     *   operation.
134360     * @return mysql_xdevapi\CollectionFind A CollectionFind object that
134361     *   can be used for additional processing.
134362     **/
134363    public function offset($position){}
134364
134365    /**
134366     * Set the sorting criteria
134367     *
134368     * Sort the result set by the field selected in the sort_expr argument.
134369     * The allowed orders are ASC (Ascending) or DESC (Descending). This
134370     * operation is equivalent to the 'ORDER BY' SQL operation and it follows
134371     * the same set of rules.
134372     *
134373     * @param string $sort_expr One or more sorting expressions can be
134374     *   provided. The evaluation is from left to right, and each expression
134375     *   is separated by a comma.
134376     * @return mysql_xdevapi\CollectionFind A CollectionFind object that
134377     *   can be used to execute the command, or to add additional operations.
134378     **/
134379    public function sort($sort_expr){}
134380
134381}
134382}
134383namespace mysql_xdevapi {
134384class CollectionModify implements mysql_xdevapi\Executable, mysql_xdevapi\CrudOperationBindable, mysql_xdevapi\CrudOperationLimitable, mysql_xdevapi\CrudOperationSkippable, mysql_xdevapi\CrudOperationSortable {
134385    /**
134386     * Append element to an array field
134387     *
134388     * Add an element to a document's field, as multiple elements of a field
134389     * are represented as an array. Unlike arrayInsert(), arrayAppend()
134390     * always appends the new element at the end of the array, whereas
134391     * arrayInsert() can define the location.
134392     *
134393     * @param string $collection_field The identifier of the field where
134394     *   the new element is inserted.
134395     * @param string $expression_or_literal The new element to insert at
134396     *   the end of the document field array.
134397     * @return mysql_xdevapi\CollectionModify A CollectionModify object
134398     *   that can be used to execute the command, or to add additional
134399     *   operations.
134400     **/
134401    public function arrayAppend($collection_field, $expression_or_literal){}
134402
134403    /**
134404     * Insert element into an array field
134405     *
134406     * Add an element to a document's field, as multiple elements of a field
134407     * are represented as an array. Unlike arrayAppend(), arrayInsert()
134408     * allows you to specify where the new element is inserted by defining
134409     * which item it is after, whereas arrayAppend() always appends the new
134410     * element at the end of the array.
134411     *
134412     * @param string $collection_field Identify the item in the array that
134413     *   the new element is inserted after. The format of this parameter is
134414     *   FIELD_NAME[ INDEX ] where FIELD_NAME is the name of the document
134415     *   field to remove the element from, and INDEX is the INDEX of the
134416     *   element within the field. The INDEX field is zero based, so the
134417     *   leftmost item from the array has an index of 0.
134418     * @param string $expression_or_literal The new element to insert after
134419     *   FIELD_NAME[ INDEX ]
134420     * @return mysql_xdevapi\CollectionModify A CollectionModify object
134421     *   that can be used to execute the command, or to add additional
134422     *   operations
134423     **/
134424    public function arrayInsert($collection_field, $expression_or_literal){}
134425
134426    /**
134427     * Bind value to query placeholder
134428     *
134429     * Bind a parameter to the placeholder in the search condition of the
134430     * modify operation.
134431     *
134432     * The placeholder has the form of :NAME where ':' is a common prefix
134433     * that must always exists before any NAME where NAME is the name of the
134434     * placeholder. The bind method accepts a list of placeholders if
134435     * multiple entities have to be substituted in the search condition of
134436     * the modify operation.
134437     *
134438     * @param array $placeholder_values Placeholder values to substitute in
134439     *   the search condition. Multiple values are allowed and have to be
134440     *   passed as an array of mappings PLACEHOLDER_NAME->PLACEHOLDER_VALUE.
134441     * @return mysql_xdevapi\CollectionModify A CollectionModify object
134442     *   that can be used to execute the command, or to add additional
134443     *   operations.
134444     **/
134445    public function bind($placeholder_values){}
134446
134447    /**
134448     * Execute modify operation
134449     *
134450     * The execute method is required to send the CRUD operation request to
134451     * the MySQL server.
134452     *
134453     * @return mysql_xdevapi\Result A Result object that can be used to
134454     *   verify the status of the operation, such as the number of affected
134455     *   rows.
134456     **/
134457    public function execute(){}
134458
134459    /**
134460     * Limit number of modified documents
134461     *
134462     * Limit the number of documents modified by this operation. Optionally
134463     * combine with skip() to define an offset value.
134464     *
134465     * @param integer $rows The maximum number of documents to modify.
134466     * @return mysql_xdevapi\CollectionModify A CollectionModify object.
134467     **/
134468    public function limit($rows){}
134469
134470    /**
134471     * Patch document
134472     *
134473     * Takes a patch object and applies it on one or more documents, and can
134474     * update multiple document properties.
134475     *
134476     * @param string $document A document with the properties to apply to
134477     *   the matching documents.
134478     * @return mysql_xdevapi\CollectionModify A CollectionModify object.
134479     **/
134480    public function patch($document){}
134481
134482    /**
134483     * Replace document field
134484     *
134485     * Replace (update) a given field value with a new one.
134486     *
134487     * @param string $collection_field The document path of the item to
134488     *   set.
134489     * @param string $expression_or_literal The value to set on the
134490     *   specified attribute.
134491     * @return mysql_xdevapi\CollectionModify A CollectionModify object.
134492     **/
134493    public function replace($collection_field, $expression_or_literal){}
134494
134495    /**
134496     * Set document attribute
134497     *
134498     * Sets or updates attributes on documents in a collection.
134499     *
134500     * @param string $collection_field The document path (name) of the item
134501     *   to set.
134502     * @param string $expression_or_literal The value to set it to.
134503     * @return mysql_xdevapi\CollectionModify A CollectionModify object.
134504     **/
134505    public function set($collection_field, $expression_or_literal){}
134506
134507    /**
134508     * Skip elements
134509     *
134510     * Skip the first N elements that would otherwise be returned by a find
134511     * operation. If the number of elements skipped is larger than the size
134512     * of the result set, then the find operation returns an empty set.
134513     *
134514     * @param integer $position Number of elements to skip.
134515     * @return mysql_xdevapi\CollectionModify A CollectionModify object to
134516     *   use for further processing.
134517     **/
134518    public function skip($position){}
134519
134520    /**
134521     * Set the sorting criteria
134522     *
134523     * Sort the result set by the field selected in the sort_expr argument.
134524     * The allowed orders are ASC (Ascending) or DESC (Descending). This
134525     * operation is equivalent to the 'ORDER BY' SQL operation and it follows
134526     * the same set of rules.
134527     *
134528     * @param string $sort_expr One or more sorting expression can be
134529     *   provided, the evaluation of these will be from the leftmost to the
134530     *   rightmost, each expression must be separated by a comma.
134531     * @return mysql_xdevapi\CollectionModify CollectionModify object that
134532     *   can be used for further processing.
134533     **/
134534    public function sort($sort_expr){}
134535
134536    /**
134537     * Unset the value of document fields
134538     *
134539     * Removes attributes from documents in a collection.
134540     *
134541     * @param array $fields The attributes to remove from documents in a
134542     *   collection.
134543     * @return mysql_xdevapi\CollectionModify CollectionModify object that
134544     *   can be used for further processing.
134545     **/
134546    public function unset($fields){}
134547
134548}
134549}
134550namespace mysql_xdevapi {
134551class CollectionRemove implements mysql_xdevapi\Executable, mysql_xdevapi\CrudOperationBindable, mysql_xdevapi\CrudOperationLimitable, mysql_xdevapi\CrudOperationSortable {
134552    /**
134553     * Bind value to placeholder
134554     *
134555     * Bind a parameter to the placeholder in the search condition of the
134556     * remove operation.
134557     *
134558     * The placeholder has the form of :NAME where ':' is a common prefix
134559     * that must always exists before any NAME where NAME is the name of the
134560     * placeholder. The bind method accepts a list of placeholders if
134561     * multiple entities have to be substituted in the search condition of
134562     * the remove operation.
134563     *
134564     * @param array $placeholder_values Placeholder values to substitute in
134565     *   the search condition. Multiple values are allowed and have to be
134566     *   passed as an array of mappings PLACEHOLDER_NAME->PLACEHOLDER_VALUE.
134567     * @return mysql_xdevapi\CollectionRemove A CollectionRemove object
134568     *   that can be used to execute the command, or to add additional
134569     *   operations.
134570     **/
134571    public function bind($placeholder_values){}
134572
134573    /**
134574     * Execute remove operation
134575     *
134576     * The execute function needs to be invoked in order to trigger the
134577     * client to send the CRUD operation request to the server.
134578     *
134579     * @return mysql_xdevapi\Result Result object.
134580     **/
134581    public function execute(){}
134582
134583    /**
134584     * Limit number of documents to remove
134585     *
134586     * Sets the maximum number of documents to remove.
134587     *
134588     * @param integer $rows The maximum number of documents to remove.
134589     * @return mysql_xdevapi\CollectionRemove Returns a CollectionRemove
134590     *   object that can be used to execute the command, or to add additional
134591     *   operations.
134592     **/
134593    public function limit($rows){}
134594
134595    /**
134596     * Set the sorting criteria
134597     *
134598     * Sort the result set by the field selected in the sort_expr argument.
134599     * The allowed orders are ASC (Ascending) or DESC (Descending). This
134600     * operation is equivalent to the 'ORDER BY' SQL operation and it follows
134601     * the same set of rules.
134602     *
134603     * @param string $sort_expr One or more sorting expressions can be
134604     *   provided. The evaluation is from left to right, and each expression
134605     *   is separated by a comma.
134606     * @return mysql_xdevapi\CollectionRemove A CollectionRemove object
134607     *   that can be used to execute the command, or to add additional
134608     *   operations.
134609     **/
134610    public function sort($sort_expr){}
134611
134612}
134613}
134614namespace mysql_xdevapi {
134615class ColumnResult {
134616    /**
134617     * Get character set
134618     *
134619     * @return string
134620     **/
134621    public function getCharacterSetName(){}
134622
134623    /**
134624     * Get collation name
134625     *
134626     * @return string
134627     **/
134628    public function getCollationName(){}
134629
134630    /**
134631     * Get column label
134632     *
134633     * @return string
134634     **/
134635    public function getColumnLabel(){}
134636
134637    /**
134638     * Get column name
134639     *
134640     * @return string
134641     **/
134642    public function getColumnName(){}
134643
134644    /**
134645     * Get fractional digit length
134646     *
134647     * Fetch the number of fractional digits for column.
134648     *
134649     * @return integer
134650     **/
134651    public function getFractionalDigits(){}
134652
134653    /**
134654     * Get column field length
134655     *
134656     * @return integer
134657     **/
134658    public function getLength(){}
134659
134660    /**
134661     * Get schema name
134662     *
134663     * Fetch the schema name where the column is stored.
134664     *
134665     * @return string
134666     **/
134667    public function getSchemaName(){}
134668
134669    /**
134670     * Get table label
134671     *
134672     * @return string
134673     **/
134674    public function getTableLabel(){}
134675
134676    /**
134677     * Get table name
134678     *
134679     * @return string Name of the table for the column.
134680     **/
134681    public function getTableName(){}
134682
134683    /**
134684     * Get column type
134685     *
134686     * @return integer
134687     **/
134688    public function getType(){}
134689
134690    /**
134691     * Check if signed type
134692     *
134693     * Retrieve a table's column information, and is instantiated by the
134694     * RowResult::getColumns() method.
134695     *
134696     * @return integer TRUE if a given column as a signed type.
134697     **/
134698    public function isNumberSigned(){}
134699
134700    /**
134701     * Check if padded
134702     *
134703     * @return integer TRUE if a given column is padded.
134704     **/
134705    public function isPadded(){}
134706
134707}
134708}
134709namespace mysql_xdevapi {
134710interface CrudOperationBindable {
134711    /**
134712     * Bind value to placeholder
134713     *
134714     * Binds a value to a specific placeholder.
134715     *
134716     * @param array $placeholder_values The name of the placeholders and
134717     *   the values to bind.
134718     * @return mysql_xdevapi\CrudOperationBindable A CrudOperationBindable
134719     *   object.
134720     **/
134721    public function bind($placeholder_values);
134722
134723}
134724}
134725namespace mysql_xdevapi {
134726interface CrudOperationLimitable {
134727    /**
134728     * Set result limit
134729     *
134730     * Sets the maximum number of records or documents to return.
134731     *
134732     * @param integer $rows The maximum number of records or documents.
134733     * @return mysql_xdevapi\CrudOperationLimitable A
134734     *   CrudOperationLimitable object.
134735     **/
134736    public function limit($rows);
134737
134738}
134739}
134740namespace mysql_xdevapi {
134741interface CrudOperationSkippable {
134742    /**
134743     * Number of operations to skip
134744     *
134745     * Skip this number of records in the returned operation.
134746     *
134747     * @param integer $skip Number of elements to skip.
134748     * @return mysql_xdevapi\CrudOperationSkippable A
134749     *   CrudOperationSkippable object.
134750     **/
134751    public function skip($skip);
134752
134753}
134754}
134755namespace mysql_xdevapi {
134756interface CrudOperationSortable {
134757    /**
134758     * Sort results
134759     *
134760     * Sort the result set by the field selected in the sort_expr argument.
134761     * The allowed orders are ASC (Ascending) or DESC (Descending). This
134762     * operation is equivalent to the 'ORDER BY' SQL operation and it follows
134763     * the same set of rules.
134764     *
134765     * @param string $sort_expr One or more sorting expressions can be
134766     *   provided. The evaluation is from left to right, and each expression
134767     *   is separated by a comma.
134768     * @return mysql_xdevapi\CrudOperationSortable A CrudOperationSortable
134769     *   object.
134770     **/
134771    public function sort($sort_expr);
134772
134773}
134774}
134775namespace mysql_xdevapi {
134776interface DatabaseObject {
134777    /**
134778     * Check if object exists in database
134779     *
134780     * Verifies if the database object refers to an object that exists in the
134781     * database.
134782     *
134783     * @return bool Returns TRUE if object exists in the database, else
134784     *   FALSE if it does not.
134785     **/
134786    public function existsInDatabase();
134787
134788    /**
134789     * Get object name
134790     *
134791     * Fetch name of this database object.
134792     *
134793     * @return string The name of this database object.
134794     **/
134795    public function getName();
134796
134797    /**
134798     * Get session name
134799     *
134800     * Fetch session associated to the database object.
134801     *
134802     * @return mysql_xdevapi\Session The Session object.
134803     **/
134804    public function getSession();
134805
134806}
134807}
134808namespace mysql_xdevapi {
134809class DocResult implements mysql_xdevapi\BaseResult, Traversable {
134810    /**
134811     * Get all rows
134812     *
134813     * Fetch all results from a result set.
134814     *
134815     * @return array A numerical array with all results from the query;
134816     *   each result is an associative array. An empty array is returned if
134817     *   no rows are present.
134818     **/
134819    public function fetchAll(){}
134820
134821    /**
134822     * Get one row
134823     *
134824     * Fetch one result from a result set.
134825     *
134826     * @return array The result, as an associative array or NULL if no
134827     *   results are present.
134828     **/
134829    public function fetchOne(){}
134830
134831    /**
134832     * Get warnings from last operation
134833     *
134834     * Fetches warnings generated by MySQL server's last operation.
134835     *
134836     * @return Array An array of Warning objects from the last operation.
134837     *   Each object defines an error 'message', error 'level', and error
134838     *   'code'. An empty array is returned if no errors are present.
134839     **/
134840    public function getWarnings(){}
134841
134842    /**
134843     * Get warning count from last operation
134844     *
134845     * Returns the number of warnings raised by the last operation.
134846     * Specifically, these warnings are raised by the MySQL server.
134847     *
134848     * @return integer The number of warnings from the last operation.
134849     **/
134850    public function getWarningsCount(){}
134851
134852}
134853}
134854namespace mysql_xdevapi {
134855class Driver {
134856}
134857}
134858namespace mysql_xdevapi {
134859class Exception extends RuntimeException implements Throwable {
134860}
134861}
134862namespace mysql_xdevapi {
134863interface Executable {
134864    /**
134865     * Execute statement
134866     *
134867     * Execute the statement from either a collection operation or a table
134868     * query; this functionality allows for method chaining.
134869     *
134870     * @return mysql_xdevapi\Result One of the Result objects, such as
134871     *   Result or SqlStatementResult.
134872     **/
134873    public function execute();
134874
134875}
134876}
134877namespace mysql_xdevapi {
134878class ExecutionStatus {
134879    /**
134880     * @var mixed
134881     **/
134882    public $affectedItems;
134883
134884    /**
134885     * @var mixed
134886     **/
134887    public $foundItems;
134888
134889    /**
134890     * @var mixed
134891     **/
134892    public $lastDocumentId;
134893
134894    /**
134895     * @var mixed
134896     **/
134897    public $lastInsertId;
134898
134899    /**
134900     * @var mixed
134901     **/
134902    public $matchedItems;
134903
134904}
134905}
134906namespace mysql_xdevapi {
134907class Expression {
134908    /**
134909     * @var mixed
134910     **/
134911    public $name;
134912
134913}
134914}
134915namespace mysql_xdevapi {
134916class FieldMetadata {
134917    /**
134918     * @var mixed
134919     **/
134920    public $catalog;
134921
134922    /**
134923     * @var mixed
134924     **/
134925    public $collation;
134926
134927    /**
134928     * @var mixed
134929     **/
134930    public $content_type;
134931
134932    /**
134933     * @var mixed
134934     **/
134935    public $flags;
134936
134937    /**
134938     * @var mixed
134939     **/
134940    public $fractional_digits;
134941
134942    /**
134943     * @var mixed
134944     **/
134945    public $length;
134946
134947    /**
134948     * @var mixed
134949     **/
134950    public $name;
134951
134952    /**
134953     * @var mixed
134954     **/
134955    public $original_name;
134956
134957    /**
134958     * @var mixed
134959     **/
134960    public $original_table;
134961
134962    /**
134963     * @var mixed
134964     **/
134965    public $schema;
134966
134967    /**
134968     * @var mixed
134969     **/
134970    public $table;
134971
134972    /**
134973     * @var mixed
134974     **/
134975    public $type;
134976
134977    /**
134978     * @var mixed
134979     **/
134980    public $type_name;
134981
134982}
134983}
134984namespace mysql_xdevapi {
134985class Result implements mysql_xdevapi\BaseResult, Traversable {
134986    /**
134987     * Get affected row count
134988     *
134989     * Get the number of affected rows by the previous operation.
134990     *
134991     * @return int The number (as an integer) of affected rows.
134992     **/
134993    public function getAffectedItemsCount(){}
134994
134995    /**
134996     * Get autoincremented value
134997     *
134998     * Get the last AUTO_INCREMENT value (last insert id).
134999     *
135000     * @return int The last AUTO_INCREMENT value.
135001     **/
135002    public function getAutoIncrementValue(){}
135003
135004    /**
135005     * Get generated ids
135006     *
135007     * Fetch the generated _id values from the last operation. The unique _id
135008     * field is generated by the MySQL server.
135009     *
135010     * @return array An array of generated _id's from the last operation,
135011     *   or an empty array if there are none.
135012     **/
135013    public function getGeneratedIds(){}
135014
135015    /**
135016     * Get warnings from last operation
135017     *
135018     * Retrieve warnings from the last Result operation.
135019     *
135020     * @return array An array of Warning objects from the last operation.
135021     *   Each object defines an error 'message', error 'level', and error
135022     *   'code'. An empty array is returned if no errors are present.
135023     **/
135024    public function getWarnings(){}
135025
135026    /**
135027     * Get warning count from last operation
135028     *
135029     * Retrieve the number of warnings from the last Result operation.
135030     *
135031     * @return integer The number of warnings generated by the last
135032     *   operation.
135033     **/
135034    public function getWarningsCount(){}
135035
135036}
135037}
135038namespace mysql_xdevapi {
135039class RowResult implements mysql_xdevapi\BaseResult, Traversable {
135040    /**
135041     * Get all rows from result
135042     *
135043     * Fetch all the rows from the result set.
135044     *
135045     * @return array A numerical array with all results from the query;
135046     *   each result is an associative array. An empty array is returned if
135047     *   no rows are present.
135048     **/
135049    public function fetchAll(){}
135050
135051    /**
135052     * Get row from result
135053     *
135054     * Fetch one result from the result set.
135055     *
135056     * @return array The result, as an associative array or NULL if no
135057     *   results are present.
135058     **/
135059    public function fetchOne(){}
135060
135061    /**
135062     * Get all column names
135063     *
135064     * Retrieve column names for columns present in the result set.
135065     *
135066     * @return array A numerical array of table columns names, or an empty
135067     *   array if the result set is empty.
135068     **/
135069    public function getColumnNames(){}
135070
135071    /**
135072     * Get column metadata
135073     *
135074     * Retrieve column metadata for columns present in the result set.
135075     *
135076     * @return array An array of FieldMetadata objects representing the
135077     *   columns in the result, or an empty array if the result set is empty.
135078     **/
135079    public function getColumns(){}
135080
135081    /**
135082     * Get column count
135083     *
135084     * Retrieve the column count for columns present in the result set.
135085     *
135086     * @return integer The number of columns; 0 if there are none.
135087     **/
135088    public function getColumnsCount(){}
135089
135090    /**
135091     * Get warnings from last operation
135092     *
135093     * Retrieve warnings from the last RowResult operation.
135094     *
135095     * @return array An array of Warning objects from the last operation.
135096     *   Each object defines an error 'message', error 'level', and error
135097     *   'code'. An empty array is returned if no errors are present.
135098     **/
135099    public function getWarnings(){}
135100
135101    /**
135102     * Get warning count from last operation
135103     *
135104     * Retrieve the number of warnings from the last RowResult operation.
135105     *
135106     * @return integer The number of warnings generated by the last
135107     *   operation.
135108     **/
135109    public function getWarningsCount(){}
135110
135111}
135112}
135113namespace mysql_xdevapi {
135114class Schema implements mysql_xdevapi\DatabaseObject {
135115    /**
135116     * @var mixed
135117     **/
135118    public $name;
135119
135120    /**
135121     * Add collection to schema
135122     *
135123     * Create a collection within the schema.
135124     *
135125     * @param string $name
135126     * @return mysql_xdevapi\Collection
135127     **/
135128    public function createCollection($name){}
135129
135130    /**
135131     * Drop collection from schema
135132     *
135133     * @param string $collection_name
135134     * @return bool
135135     **/
135136    public function dropCollection($collection_name){}
135137
135138    /**
135139     * Check if exists in database
135140     *
135141     * Checks if the current object (schema, table, collection, or view)
135142     * exists in the schema object.
135143     *
135144     * @return bool TRUE if the schema, table, collection, or view still
135145     *   exists in the schema, else FALSE.
135146     **/
135147    public function existsInDatabase(){}
135148
135149    /**
135150     * Get collection from schema
135151     *
135152     * Get a collection from the schema.
135153     *
135154     * @param string $name Collection name to retrieve.
135155     * @return mysql_xdevapi\Collection The Collection object for the
135156     *   selected collection.
135157     **/
135158    public function getCollection($name){}
135159
135160    /**
135161     * Get collection table object
135162     *
135163     * Get a collection, but as a Table object instead of a Collection
135164     * object.
135165     *
135166     * @param string $name Name of the collection to instantiate a Table
135167     *   object from.
135168     * @return mysql_xdevapi\Table A table object for the collection.
135169     **/
135170    public function getCollectionAsTable($name){}
135171
135172    /**
135173     * Get all schema collections
135174     *
135175     * Fetch a list of collections for this schema.
135176     *
135177     * @return array Array of all collections in this schema, where each
135178     *   array element value is a Collection object with the collection name
135179     *   as the key.
135180     **/
135181    public function getCollections(){}
135182
135183    /**
135184     * Get schema name
135185     *
135186     * Get the name of the schema.
135187     *
135188     * @return string The name of the schema connected to the schema
135189     *   object, as a string.
135190     **/
135191    public function getName(){}
135192
135193    /**
135194     * Get schema session
135195     *
135196     * Get a new Session object from the Schema object.
135197     *
135198     * @return mysql_xdevapi\Session A Session object.
135199     **/
135200    public function getSession(){}
135201
135202    /**
135203     * Get schema table
135204     *
135205     * Fetch a Table object for the provided table in the schema.
135206     *
135207     * @param string $name Name of the table.
135208     * @return mysql_xdevapi\Table A Table object.
135209     **/
135210    public function getTable($name){}
135211
135212    /**
135213     * Get schema tables
135214     *
135215     * @return array Array of all tables in this schema, where each array
135216     *   element value is a Table object with the table name as the key.
135217     **/
135218    public function getTables(){}
135219
135220}
135221}
135222namespace mysql_xdevapi {
135223interface SchemaObject extends mysql_xdevapi\DatabaseObject {
135224    /**
135225     * Get schema object
135226     *
135227     * Used by other objects to retrieve a schema object.
135228     *
135229     * @return mysql_xdevapi\Schema The current Schema object.
135230     **/
135231    function getSchema();
135232
135233}
135234}
135235namespace mysql_xdevapi {
135236class Session {
135237    /**
135238     * Close session
135239     *
135240     * Close the session with the server.
135241     *
135242     * @return bool TRUE if the session closed.
135243     **/
135244    public function close(){}
135245
135246    /**
135247     * Commit transaction
135248     *
135249     * Commit the transaction.
135250     *
135251     * @return Object An SqlStatementResult object.
135252     **/
135253    public function commit(){}
135254
135255    /**
135256     * Create new schema
135257     *
135258     * Creates a new schema.
135259     *
135260     * @param string $schema_name Name of the schema to create.
135261     * @return mysql_xdevapi\Schema A Schema object on success, and emits
135262     *   an exception on failure.
135263     **/
135264    public function createSchema($schema_name){}
135265
135266    /**
135267     * Drop a schema
135268     *
135269     * Drop a schema (database).
135270     *
135271     * @param string $schema_name Name of the schema to drop.
135272     * @return bool TRUE if the schema is dropped, or FALSE if it does not
135273     *   exist or can't be dropped.
135274     **/
135275    public function dropSchema($schema_name){}
135276
135277    /**
135278     * Get new UUID
135279     *
135280     * Generate a Universal Unique IDentifier (UUID) generated according to
135281     * RFC 4122.
135282     *
135283     * @return string The UUID; a string with a length of 32.
135284     **/
135285    public function generateUUID(){}
135286
135287    /**
135288     * Get default schema name
135289     *
135290     * Retrieve name of the default schema that's typically set in the
135291     * connection URI.
135292     *
135293     * @return string Name of the default schema defined by the connection,
135294     *   or NULL if one was not set.
135295     **/
135296    public function getDefaultSchema(){}
135297
135298    /**
135299     * Get a new schema object
135300     *
135301     * A new Schema object for the provided schema name.
135302     *
135303     * @param string $schema_name Name of the schema (database) to fetch a
135304     *   Schema object for.
135305     * @return mysql_xdevapi\Schema A Schema object.
135306     **/
135307    public function getSchema($schema_name){}
135308
135309    /**
135310     * Get the schemas
135311     *
135312     * Get schema objects for all schemas available to the session.
135313     *
135314     * @return array An array containing objects that represent all of the
135315     *   schemas available to the session.
135316     **/
135317    public function getSchemas(){}
135318
135319    /**
135320     * Get server version
135321     *
135322     * Retrieve the MySQL server version for the session.
135323     *
135324     * @return integer The MySQL server version for the session, as an
135325     *   integer such as "80012".
135326     **/
135327    public function getServerVersion(){}
135328
135329    /**
135330     * Get client list
135331     *
135332     * Get a list of client connections to the session's MySQL server.
135333     *
135334     * @return array An array containing the currently logged clients. The
135335     *   array elements are "client_id", "user", "host", and "sql_session".
135336     **/
135337    public function listClients(){}
135338
135339    /**
135340     * Add quotes
135341     *
135342     * A quoting function to escape SQL names and identifiers. It escapes the
135343     * identifier given in accordance to the settings of the current
135344     * connection. This escape function should not be used to escape values.
135345     *
135346     * @param string $name The string to quote.
135347     * @return string The quoted string.
135348     **/
135349    public function quoteName($name){}
135350
135351    /**
135352     * Release set savepoint
135353     *
135354     * Release a previously set savepoint.
135355     *
135356     * @param string $name Name of the savepoint to release.
135357     * @return void An SqlStatementResult object.
135358     **/
135359    public function releaseSavepoint($name){}
135360
135361    /**
135362     * Rollback transaction
135363     *
135364     * Rollback the transaction.
135365     *
135366     * @return void An SqlStatementResult object.
135367     **/
135368    public function rollback(){}
135369
135370    /**
135371     * Rollback transaction to savepoint
135372     *
135373     * Rollback the transaction back to the savepoint.
135374     *
135375     * @param string $name Name of the savepoint to rollback to;
135376     *   case-insensitive.
135377     * @return void An SqlStatementResult object.
135378     **/
135379    public function rollbackTo($name){}
135380
135381    /**
135382     * Create savepoint
135383     *
135384     * Create a new savepoint for the transaction.
135385     *
135386     * @param string $name The name of the savepoint. The name is
135387     *   auto-generated if the optional name parameter is not defined as
135388     *   'SAVEPOINT1', 'SAVEPOINT2', and so on.
135389     * @return string The name of the save point.
135390     **/
135391    public function setSavepoint($name){}
135392
135393    /**
135394     * Execute SQL query
135395     *
135396     * Create a native SQL statement. Placeholders are supported using the
135397     * native "?" syntax. Use the execute method to execute the SQL
135398     * statement.
135399     *
135400     * @param string $query SQL statement to execute.
135401     * @return mysql_xdevapi\SqlStatement An SqlStatement object.
135402     **/
135403    public function sql($query){}
135404
135405    /**
135406     * Start transaction
135407     *
135408     * Start a new transaction.
135409     *
135410     * @return void An SqlStatementResult object.
135411     **/
135412    public function startTransaction(){}
135413
135414}
135415}
135416namespace mysql_xdevapi {
135417class SqlStatement {
135418    /**
135419     * @var mixed
135420     **/
135421    public $statement;
135422
135423    /**
135424     * Bind statement parameters
135425     *
135426     * @param string $param
135427     * @return mysql_xdevapi\SqlStatement
135428     **/
135429    public function bind($param){}
135430
135431    /**
135432     * Execute the operation
135433     *
135434     * @return mysql_xdevapi\Result
135435     **/
135436    public function execute(){}
135437
135438    /**
135439     * Get next result
135440     *
135441     * @return mysql_xdevapi\Result
135442     **/
135443    public function getNextResult(){}
135444
135445    /**
135446     * Get result
135447     *
135448     * @return mysql_xdevapi\Result
135449     **/
135450    public function getResult(){}
135451
135452    /**
135453     * Check for more results
135454     *
135455     * @return bool TRUE if the result set has more objects to fetch.
135456     **/
135457    public function hasMoreResults(){}
135458
135459}
135460}
135461namespace mysql_xdevapi {
135462class SqlStatementResult implements mysql_xdevapi\BaseResult, Traversable {
135463    /**
135464     * Get all rows from result
135465     *
135466     * Fetch all the rows from the result set.
135467     *
135468     * @return array A numerical array with all results from the query;
135469     *   each result is an associative array. An empty array is returned if
135470     *   no rows are present.
135471     **/
135472    public function fetchAll(){}
135473
135474    /**
135475     * Get single row
135476     *
135477     * Fetch one row from the result set.
135478     *
135479     * @return array The result, as an associative array. In case there is
135480     *   not any result, null will be returned.
135481     **/
135482    public function fetchOne(){}
135483
135484    /**
135485     * Get affected row count
135486     *
135487     * @return integer
135488     **/
135489    public function getAffectedItemsCount(){}
135490
135491    /**
135492     * Get column names
135493     *
135494     * @return array
135495     **/
135496    public function getColumnNames(){}
135497
135498    /**
135499     * Get columns
135500     *
135501     * @return Array
135502     **/
135503    public function getColumns(){}
135504
135505    /**
135506     * Get column count
135507     *
135508     * @return integer The number of columns; 0 if there are none.
135509     **/
135510    public function getColumnsCount(){}
135511
135512    /**
135513     * Get generated ids
135514     *
135515     * @return array An array of generated _id's from the last operation,
135516     *   or an empty array if there are none.
135517     **/
135518    public function getGeneratedIds(){}
135519
135520    /**
135521     * Get last insert id
135522     *
135523     * @return String The ID for the last insert operation.
135524     **/
135525    public function getLastInsertId(){}
135526
135527    /**
135528     * Get warning count from last operation
135529     *
135530     * @return integer The number of warnings raised during the last CRUD
135531     *   operation.
135532     **/
135533    public function getWarningCounts(){}
135534
135535    /**
135536     * Get warnings from last operation
135537     *
135538     * @return array An array of Warning objects from the last operation.
135539     *   Each object defines an error 'message', error 'level', and error
135540     *   'code'. An empty array is returned if no errors are present.
135541     **/
135542    public function getWarnings(){}
135543
135544    /**
135545     * Check if result has data
135546     *
135547     * @return bool TRUE if the result set has data.
135548     **/
135549    public function hasData(){}
135550
135551    /**
135552     * Get next result
135553     *
135554     * @return mysql_xdevapi\Result The next Result object from the result
135555     *   set.
135556     **/
135557    public function nextResult(){}
135558
135559}
135560}
135561namespace mysql_xdevapi {
135562class Statement {
135563    /**
135564     * Get next result
135565     *
135566     * @return mysql_xdevapi\Result
135567     **/
135568    public function getNextResult(){}
135569
135570    /**
135571     * Get result
135572     *
135573     * @return mysql_xdevapi\Result
135574     **/
135575    public function getResult(){}
135576
135577    /**
135578     * Check if more results
135579     *
135580     * @return bool
135581     **/
135582    public function hasMoreResults(){}
135583
135584}
135585}
135586namespace mysql_xdevapi {
135587class Table implements mysql_xdevapi\SchemaObject {
135588    /**
135589     * @var mixed
135590     **/
135591    public $name;
135592
135593    /**
135594     * Get row count
135595     *
135596     * Fetch the number of rows in the table.
135597     *
135598     * @return integer The total number of rows in the table.
135599     **/
135600    public function count(){}
135601
135602    /**
135603     * Delete rows from table
135604     *
135605     * Deletes rows from a table.
135606     *
135607     * @return mysql_xdevapi\TableDelete A TableDelete object; use the
135608     *   execute() method to execute the delete query.
135609     **/
135610    public function delete(){}
135611
135612    /**
135613     * Check if table exists in database
135614     *
135615     * Verifies if this table exists in the database.
135616     *
135617     * @return bool Returns TRUE if table exists in the database, else
135618     *   FALSE if it does not.
135619     **/
135620    public function existsInDatabase(){}
135621
135622    /**
135623     * Get table name
135624     *
135625     * Returns the name of this database object.
135626     *
135627     * @return string The name of this database object.
135628     **/
135629    public function getName(){}
135630
135631    /**
135632     * Get table schema
135633     *
135634     * Fetch the schema associated with the table.
135635     *
135636     * @return mysql_xdevapi\Schema A Schema object.
135637     **/
135638    public function getSchema(){}
135639
135640    /**
135641     * Get table session
135642     *
135643     * Get session associated with the table.
135644     *
135645     * @return mysql_xdevapi\Session A Session object.
135646     **/
135647    public function getSession(){}
135648
135649    /**
135650     * Insert table rows
135651     *
135652     * Inserts rows into a table.
135653     *
135654     * @param mixed $columns The columns to insert data into. Can be an
135655     *   array with one or more values, or a string.
135656     * @param mixed ...$vararg Additional columns definitions.
135657     * @return mysql_xdevapi\TableInsert A TableInsert object; use the
135658     *   execute() method to execute the insert statement.
135659     **/
135660    public function insert($columns, ...$vararg){}
135661
135662    /**
135663     * Check if table is view
135664     *
135665     * Determine if the underlying object is a view or not.
135666     *
135667     * @return bool TRUE if the underlying object is a view, otherwise
135668     *   FALSE.
135669     **/
135670    public function isView(){}
135671
135672    /**
135673     * Select rows from table
135674     *
135675     * Fetches data from a table.
135676     *
135677     * @param mixed $columns The columns to select data from. Can be an
135678     *   array with one or more values, or a string.
135679     * @param mixed ...$vararg Additional columns parameter definitions.
135680     * @return mysql_xdevapi\TableSelect A TableSelect object; use the
135681     *   execute() method to execute the select and return a RowResult
135682     *   object.
135683     **/
135684    public function select($columns, ...$vararg){}
135685
135686    /**
135687     * Update rows in table
135688     *
135689     * Updates columns in a table.
135690     *
135691     * @return mysql_xdevapi\TableUpdate A TableUpdate object; use the
135692     *   execute() method to execute the update statement.
135693     **/
135694    public function update(){}
135695
135696}
135697}
135698namespace mysql_xdevapi {
135699class TableDelete implements mysql_xdevapi\Executable {
135700    /**
135701     * Bind delete query parameters
135702     *
135703     * Binds a value to a specific placeholder.
135704     *
135705     * @param array $placeholder_values The name of the placeholder and the
135706     *   value to bind.
135707     * @return mysql_xdevapi\TableDelete A TableDelete object.
135708     **/
135709    public function bind($placeholder_values){}
135710
135711    /**
135712     * Execute delete query
135713     *
135714     * Execute the delete query.
135715     *
135716     * @return mysql_xdevapi\Result A Result object.
135717     **/
135718    public function execute(){}
135719
135720    /**
135721     * Limit deleted rows
135722     *
135723     * Sets the maximum number of records or documents to delete.
135724     *
135725     * @param integer $rows The maximum number of records or documents to
135726     *   delete.
135727     * @return mysql_xdevapi\TableDelete TableDelete object.
135728     **/
135729    public function limit($rows){}
135730
135731    /**
135732     * Set delete sort criteria
135733     *
135734     * Set the order options for a result set.
135735     *
135736     * @param string $orderby_expr The sort definition.
135737     * @return mysql_xdevapi\TableDelete A TableDelete object.
135738     **/
135739    public function orderby($orderby_expr){}
135740
135741    /**
135742     * Set delete search condition
135743     *
135744     * Sets the search condition to filter.
135745     *
135746     * @param string $where_expr Define the search condition to filter
135747     *   documents or records.
135748     * @return mysql_xdevapi\TableDelete TableDelete object.
135749     **/
135750    public function where($where_expr){}
135751
135752}
135753}
135754namespace mysql_xdevapi {
135755class TableInsert implements mysql_xdevapi\Executable {
135756    /**
135757     * Execute insert query
135758     *
135759     * Execute the statement.
135760     *
135761     * @return mysql_xdevapi\Result A Result object.
135762     **/
135763    public function execute(){}
135764
135765    /**
135766     * Add insert row values
135767     *
135768     * Set the values to be inserted.
135769     *
135770     * @param array $row_values Values (an array) of columns to insert.
135771     * @return mysql_xdevapi\TableInsert A TableInsert object.
135772     **/
135773    public function values($row_values){}
135774
135775}
135776}
135777namespace mysql_xdevapi {
135778class TableSelect implements mysql_xdevapi\Executable {
135779    /**
135780     * Bind select query parameters
135781     *
135782     * Binds a value to a specific placeholder.
135783     *
135784     * @param array $placeholder_values The name of the placeholder, and
135785     *   the value to bind.
135786     * @return mysql_xdevapi\TableSelect A TableSelect object.
135787     **/
135788    public function bind($placeholder_values){}
135789
135790    /**
135791     * Execute select statement
135792     *
135793     * Execute the select statement by chaining it with the execute() method.
135794     *
135795     * @return mysql_xdevapi\RowResult A RowResult object.
135796     **/
135797    public function execute(){}
135798
135799    /**
135800     * Set select grouping criteria
135801     *
135802     * Sets a grouping criteria for the result set.
135803     *
135804     * @param mixed $sort_expr The grouping criteria.
135805     * @return mysql_xdevapi\TableSelect A TableSelect object.
135806     **/
135807    public function groupBy($sort_expr){}
135808
135809    /**
135810     * Set select having condition
135811     *
135812     * Sets a condition for records to consider in aggregate function
135813     * operations.
135814     *
135815     * @param string $sort_expr A condition on the aggregate functions used
135816     *   on the grouping criteria.
135817     * @return mysql_xdevapi\TableSelect A TableSelect object.
135818     **/
135819    public function having($sort_expr){}
135820
135821    /**
135822     * Limit selected rows
135823     *
135824     * Sets the maximum number of records or documents to return.
135825     *
135826     * @param integer $rows The maximum number of records or documents.
135827     * @return mysql_xdevapi\TableSelect A TableSelect object.
135828     **/
135829    public function limit($rows){}
135830
135831    /**
135832     * Execute EXCLUSIVE LOCK
135833     *
135834     * Execute a read operation with EXCLUSIVE LOCK. Only one lock can be
135835     * active at a time.
135836     *
135837     * @param integer $lock_waiting_option The optional waiting option that
135838     *   defaults to MYSQLX_LOCK_DEFAULT. Valid values are:
135839     * @return mysql_xdevapi\TableSelect TableSelect object.
135840     **/
135841    public function lockExclusive($lock_waiting_option){}
135842
135843    /**
135844     * Execute SHARED LOCK
135845     *
135846     * Execute a read operation with SHARED LOCK. Only one lock can be active
135847     * at a time.
135848     *
135849     * @param integer $lock_waiting_option The optional waiting option that
135850     *   defaults to MYSQLX_LOCK_DEFAULT. Valid values are:
135851     * @return mysql_xdevapi\TableSelect A TableSelect object.
135852     **/
135853    public function lockShared($lock_waiting_option){}
135854
135855    /**
135856     * Set limit offset
135857     *
135858     * Skip given number of rows in result.
135859     *
135860     * @param integer $position The limit offset.
135861     * @return mysql_xdevapi\TableSelect A TableSelect object.
135862     **/
135863    public function offset($position){}
135864
135865    /**
135866     * Set select sort criteria
135867     *
135868     * Sets the order by criteria.
135869     *
135870     * @param mixed $sort_expr The expressions that define the order by
135871     *   criteria. Can be an array with one or more expressions, or a string.
135872     * @param mixed ...$vararg Additional sort_expr parameters.
135873     * @return mysql_xdevapi\TableSelect A TableSelect object.
135874     **/
135875    public function orderby($sort_expr, ...$vararg){}
135876
135877    /**
135878     * Set select search condition
135879     *
135880     * Sets the search condition to filter.
135881     *
135882     * @param string $where_expr Define the search condition to filter
135883     *   documents or records.
135884     * @return mysql_xdevapi\TableSelect A TableSelect object.
135885     **/
135886    public function where($where_expr){}
135887
135888}
135889}
135890namespace mysql_xdevapi {
135891class TableUpdate implements mysql_xdevapi\Executable {
135892    /**
135893     * Bind update query parameters
135894     *
135895     * Binds a value to a specific placeholder.
135896     *
135897     * @param array $placeholder_values The name of the placeholder, and
135898     *   the value to bind, defined as a JSON array.
135899     * @return mysql_xdevapi\TableUpdate A TableUpdate object.
135900     **/
135901    public function bind($placeholder_values){}
135902
135903    /**
135904     * Execute update query
135905     *
135906     * Executes the update statement.
135907     *
135908     * @return mysql_xdevapi\TableUpdate A TableUpdate object.
135909     **/
135910    public function execute(){}
135911
135912    /**
135913     * Limit update row count
135914     *
135915     * Set the maximum number of records or documents update.
135916     *
135917     * @param integer $rows The maximum number of records or documents to
135918     *   update.
135919     * @return mysql_xdevapi\TableUpdate A TableUpdate object.
135920     **/
135921    public function limit($rows){}
135922
135923    /**
135924     * Set sorting criteria
135925     *
135926     * Sets the sorting criteria.
135927     *
135928     * @param mixed $orderby_expr The expressions that define the order by
135929     *   criteria. Can be an array with one or more expressions, or a string.
135930     * @param mixed ...$vararg Additional sort_expr parameters.
135931     * @return mysql_xdevapi\TableUpdate TableUpdate object.
135932     **/
135933    public function orderby($orderby_expr, ...$vararg){}
135934
135935    /**
135936     * Add field to be updated
135937     *
135938     * Updates the column value on records in a table.
135939     *
135940     * @param string $table_field The column name to be updated.
135941     * @param string $expression_or_literal The value to be set on the
135942     *   specified column.
135943     * @return mysql_xdevapi\TableUpdate TableUpdate object.
135944     **/
135945    public function set($table_field, $expression_or_literal){}
135946
135947    /**
135948     * Set search filter
135949     *
135950     * Set the search condition to filter.
135951     *
135952     * @param string $where_expr The search condition to filter documents
135953     *   or records.
135954     * @return mysql_xdevapi\TableUpdate A TableUpdate object.
135955     **/
135956    public function where($where_expr){}
135957
135958}
135959}
135960namespace mysql_xdevapi {
135961class Warning {
135962    /**
135963     * @var mixed
135964     **/
135965    public $code;
135966
135967    /**
135968     * @var mixed
135969     **/
135970    public $level;
135971
135972    /**
135973     * @var mixed
135974     **/
135975    public $message;
135976
135977}
135978}
135979/**
135980 * This iterator ignores rewind operations. This allows processing an
135981 * iterator in multiple partial foreach loops.
135982 **/
135983class NoRewindIterator extends IteratorIterator {
135984    /**
135985     * Get the current value
135986     *
135987     * Gets the current value.
135988     *
135989     * @return mixed The current value.
135990     * @since PHP 5 >= 5.1.0, PHP 7
135991     **/
135992    public function current(){}
135993
135994    /**
135995     * Get the inner iterator
135996     *
135997     * Gets the inner iterator, that was passed in to NoRewindIterator.
135998     *
135999     * @return iterator The inner iterator, as passed to
136000     *   NoRewindIterator::__construct.
136001     * @since PHP 5 >= 5.1.0, PHP 7
136002     **/
136003    public function getInnerIterator(){}
136004
136005    /**
136006     * Get the current key
136007     *
136008     * Gets the current key.
136009     *
136010     * @return mixed The current key.
136011     * @since PHP 5 >= 5.1.0, PHP 7
136012     **/
136013    public function key(){}
136014
136015    /**
136016     * Forward to the next element
136017     *
136018     * Forwards to the next element.
136019     *
136020     * @return void
136021     * @since PHP 5 >= 5.1.0, PHP 7
136022     **/
136023    public function next(){}
136024
136025    /**
136026     * Prevents the rewind operation on the inner iterator
136027     *
136028     * @return void
136029     * @since PHP 5 >= 5.1.0, PHP 7
136030     **/
136031    public function rewind(){}
136032
136033    /**
136034     * Validates the iterator
136035     *
136036     * Checks whether the iterator is valid.
136037     *
136038     * @return bool
136039     * @since PHP 5 >= 5.1.0, PHP 7
136040     **/
136041    public function valid(){}
136042
136043    /**
136044     * Construct a NoRewindIterator
136045     *
136046     * Constructs a NoRewindIterator.
136047     *
136048     * @param Iterator $iterator The iterator being used.
136049     * @since PHP 5 >= 5.1.0, PHP 7
136050     **/
136051    public function __construct($iterator){}
136052
136053}
136054/**
136055 * The Unicode Consortium has defined a number of normalization forms
136056 * reflecting the various needs of applications: Normalization Form D
136057 * (NFD) - Canonical Decomposition Normalization Form C (NFC) - Canonical
136058 * Decomposition followed by Canonical Composition Normalization Form KD
136059 * (NFKD) - Compatibility Decomposition Normalization Form KC (NFKC) -
136060 * Compatibility Decomposition followed by Canonical Composition The
136061 * different forms are defined in terms of a set of transformations on
136062 * the text, transformations that are expressed by both an algorithm and
136063 * a set of data files. Unicode Normalization Unicode Normalization FAQ
136064 * ICU User Guide - Normalization ICU API Reference - Normalization
136065 **/
136066class Normalizer {
136067    /**
136068     * Gets the Decomposition_Mapping property for the given UTF-8 encoded
136069     * code point
136070     *
136071     * Gets the Decomposition_Mapping property, as specified in the Unicode
136072     * Character Database (UCD), for the given UTF-8 encoded code point.
136073     *
136074     * @param string $input The input string, which should be a single,
136075     *   UTF-8 encoded, code point.
136076     * @return string Returns a string containing the Decomposition_Mapping
136077     *   property, if present in the UCD.
136078     * @since PHP 7 >= 7.3
136079     **/
136080    public static function getRawDecomposition($input){}
136081
136082    /**
136083     * Checks if the provided string is already in the specified
136084     * normalization form
136085     *
136086     * Checks if the provided string is already in the specified
136087     * normalization form.
136088     *
136089     * @param string $input The input string to normalize
136090     * @param int $form One of the normalization forms.
136091     * @return bool TRUE if normalized, FALSE otherwise or if there an
136092     *   error
136093     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
136094     **/
136095    public static function isNormalized($input, $form){}
136096
136097    /**
136098     * Normalizes the input provided and returns the normalized string
136099     *
136100     * Normalizes the input provided and returns the normalized string
136101     *
136102     * @param string $input The input string to normalize
136103     * @param int $form One of the normalization forms.
136104     * @return string The normalized string or FALSE if an error occurred.
136105     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
136106     **/
136107    public static function normalize($input, $form){}
136108
136109}
136110/**
136111 * For currencies you can use currency format type to create a formatter
136112 * that returns a string with the formatted number and the appropriate
136113 * currency sign. Of course, the NumberFormatter class is unaware of
136114 * exchange rates so, the number output is the same regardless of the
136115 * specified currency. This means that the same number has different
136116 * monetary values depending on the currency locale. If the number is
136117 * 9988776.65 the results will be: 9 988 776,65 € in France
136118 * 9.988.776,65 € in Germany $9,988,776.65 in the United States ICU
136119 * formatting documentation ICU number formatters ICU decimal formatters
136120 * ICU rule-based number formatters
136121 **/
136122class NumberFormatter {
136123    /**
136124     * Create a number formatter
136125     *
136126     * (method)
136127     *
136128     * (constructor):
136129     *
136130     * Creates a number formatter.
136131     *
136132     * @param string $locale Locale in which the number would be formatted
136133     *   (locale name, e.g. en_CA).
136134     * @param int $style Style of the formatting, one of the format style
136135     *   constants. If NumberFormatter::PATTERN_DECIMAL or
136136     *   NumberFormatter::PATTERN_RULEBASED is passed then the number format
136137     *   is opened using the given pattern, which must conform to the syntax
136138     *   described in ICU DecimalFormat documentation or ICU
136139     *   RuleBasedNumberFormat documentation, respectively.
136140     * @param string $pattern Pattern string if the chosen style requires a
136141     *   pattern.
136142     * @return NumberFormatter Returns NumberFormatter object or FALSE on
136143     *   error.
136144     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
136145     **/
136146    public static function create($locale, $style, $pattern){}
136147
136148    /**
136149     * Format a number
136150     *
136151     * Format a numeric value according to the formatter rules.
136152     *
136153     * @param number $value NumberFormatter object.
136154     * @param int $type The value to format. Can be integer or float, other
136155     *   values will be converted to a numeric value.
136156     * @return string Returns the string containing formatted value, or
136157     *   FALSE on error.
136158     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
136159     **/
136160    public function format($value, $type){}
136161
136162    /**
136163     * Format a currency value
136164     *
136165     * Format the currency value according to the formatter rules.
136166     *
136167     * @param float $value NumberFormatter object.
136168     * @param string $currency The numeric currency value.
136169     * @return string String representing the formatted currency value, .
136170     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
136171     **/
136172    public function formatCurrency($value, $currency){}
136173
136174    /**
136175     * Get an attribute
136176     *
136177     * Get a numeric attribute associated with the formatter. An example of a
136178     * numeric attribute is the number of integer digits the formatter will
136179     * produce.
136180     *
136181     * @param int $attr NumberFormatter object.
136182     * @return int Return attribute value on success, or FALSE on error.
136183     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
136184     **/
136185    public function getAttribute($attr){}
136186
136187    /**
136188     * Get formatter's last error code
136189     *
136190     * Get error code from the last function performed by the formatter.
136191     *
136192     * @return int Returns error code from last formatter call.
136193     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
136194     **/
136195    public function getErrorCode(){}
136196
136197    /**
136198     * Get formatter's last error message
136199     *
136200     * Get error message from the last function performed by the formatter.
136201     *
136202     * @return string Returns error message from last formatter call.
136203     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
136204     **/
136205    public function getErrorMessage(){}
136206
136207    /**
136208     * Get formatter locale
136209     *
136210     * Get formatter locale name.
136211     *
136212     * @param int $type NumberFormatter object.
136213     * @return string The locale name used to create the formatter.
136214     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
136215     **/
136216    public function getLocale($type){}
136217
136218    /**
136219     * Get formatter pattern
136220     *
136221     * Extract pattern used by the formatter.
136222     *
136223     * @return string Pattern string that is used by the formatter, or
136224     *   FALSE if an error happens.
136225     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
136226     **/
136227    public function getPattern(){}
136228
136229    /**
136230     * Get a symbol value
136231     *
136232     * Get a symbol associated with the formatter. The formatter uses symbols
136233     * to represent the special locale-dependent characters in a number, for
136234     * example the percent sign. This API is not supported for rule-based
136235     * formatters.
136236     *
136237     * @param int $attr NumberFormatter object.
136238     * @return string The symbol string or FALSE on error.
136239     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
136240     **/
136241    public function getSymbol($attr){}
136242
136243    /**
136244     * Get a text attribute
136245     *
136246     * Get a text attribute associated with the formatter. An example of a
136247     * text attribute is the suffix for positive numbers. If the formatter
136248     * does not understand the attribute, U_UNSUPPORTED_ERROR error is
136249     * produced. Rule-based formatters only understand
136250     * NumberFormatter::DEFAULT_RULESET and NumberFormatter::PUBLIC_RULESETS.
136251     *
136252     * @param int $attr NumberFormatter object.
136253     * @return string Return attribute value on success, or FALSE on error.
136254     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
136255     **/
136256    public function getTextAttribute($attr){}
136257
136258    /**
136259     * Parse a number
136260     *
136261     * Parse a string into a number using the current formatter rules.
136262     *
136263     * @param string $value NumberFormatter object.
136264     * @param int $type The formatting type to use. By default,
136265     *   NumberFormatter::TYPE_DOUBLE is used.
136266     * @param int $position Offset in the string at which to begin parsing.
136267     *   On return, this value will hold the offset at which parsing ended.
136268     * @return mixed The value of the parsed number or FALSE on error.
136269     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
136270     **/
136271    public function parse($value, $type, &$position){}
136272
136273    /**
136274     * Parse a currency number
136275     *
136276     * Parse a string into a double and a currency using the current
136277     * formatter.
136278     *
136279     * @param string $value NumberFormatter object.
136280     * @param string $currency Parameter to receive the currency name
136281     *   (3-letter ISO 4217 currency code).
136282     * @param int $position Offset in the string at which to begin parsing.
136283     *   On return, this value will hold the offset at which parsing ended.
136284     * @return float The parsed numeric value or FALSE on error.
136285     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
136286     **/
136287    public function parseCurrency($value, &$currency, &$position){}
136288
136289    /**
136290     * Set an attribute
136291     *
136292     * Set a numeric attribute associated with the formatter. An example of a
136293     * numeric attribute is the number of integer digits the formatter will
136294     * produce.
136295     *
136296     * @param int $attr NumberFormatter object.
136297     * @param int $value Attribute specifier - one of the numeric attribute
136298     *   constants.
136299     * @return bool
136300     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
136301     **/
136302    public function setAttribute($attr, $value){}
136303
136304    /**
136305     * Set formatter pattern
136306     *
136307     * Set the pattern used by the formatter. Can not be used on a rule-based
136308     * formatter.
136309     *
136310     * @param string $pattern NumberFormatter object.
136311     * @return bool
136312     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
136313     **/
136314    public function setPattern($pattern){}
136315
136316    /**
136317     * Set a symbol value
136318     *
136319     * Set a symbol associated with the formatter. The formatter uses symbols
136320     * to represent the special locale-dependent characters in a number, for
136321     * example the percent sign. This API is not supported for rule-based
136322     * formatters.
136323     *
136324     * @param int $attr NumberFormatter object.
136325     * @param string $value Symbol specifier, one of the format symbol
136326     *   constants.
136327     * @return bool
136328     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
136329     **/
136330    public function setSymbol($attr, $value){}
136331
136332    /**
136333     * Set a text attribute
136334     *
136335     * Set a text attribute associated with the formatter. An example of a
136336     * text attribute is the suffix for positive numbers. If the formatter
136337     * does not understand the attribute, U_UNSUPPORTED_ERROR error is
136338     * produced. Rule-based formatters only understand
136339     * NumberFormatter::DEFAULT_RULESET and NumberFormatter::PUBLIC_RULESETS.
136340     *
136341     * @param int $attr NumberFormatter object.
136342     * @param string $value Attribute specifier - one of the text attribute
136343     *   constants.
136344     * @return bool
136345     * @since PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0
136346     **/
136347    public function setTextAttribute($attr, $value){}
136348
136349}
136350/**
136351 * The OAuth extension provides a simple interface to interact with data
136352 * providers using the OAuth HTTP specification to protect private
136353 * resources.
136354 **/
136355class OAuth {
136356    /**
136357     * @var mixed
136358     **/
136359    public $debug;
136360
136361    /**
136362     * @var mixed
136363     **/
136364    public $debugInfo;
136365
136366    /**
136367     * @var mixed
136368     **/
136369    public $sslChecks;
136370
136371    /**
136372     * Turn off verbose debugging
136373     *
136374     * Turns off verbose request information (off by default). Alternatively,
136375     * the debug property can be set to a FALSE value to turn debug off.
136376     *
136377     * @return bool TRUE
136378     * @since PECL OAuth >= 0.99.3
136379     **/
136380    public function disableDebug(){}
136381
136382    /**
136383     * Turn off redirects
136384     *
136385     * Disable redirects from being followed automatically, thus allowing the
136386     * request to be manually redirected.
136387     *
136388     * @return bool TRUE
136389     * @since PECL OAuth >= 0.99.9
136390     **/
136391    public function disableRedirects(){}
136392
136393    /**
136394     * Turn off SSL checks
136395     *
136396     * Turns off the usual SSL peer certificate and host checks, this is not
136397     * for production environments. Alternatively, the {@link sslChecks}
136398     * member can be set to FALSE to turn SSL checks off.
136399     *
136400     * @return bool TRUE
136401     * @since PECL OAuth >= 0.99.5
136402     **/
136403    public function disableSSLChecks(){}
136404
136405    /**
136406     * Turn on verbose debugging
136407     *
136408     * Turns on verbose request information useful for debugging, the debug
136409     * information is stored in the {@link debugInfo} member. Alternatively,
136410     * the {@link debug} member can be set to a non-FALSE value to turn debug
136411     * on.
136412     *
136413     * @return bool TRUE
136414     * @since PECL OAuth >= 0.99.3
136415     **/
136416    public function enableDebug(){}
136417
136418    /**
136419     * Turn on redirects
136420     *
136421     * Follow and sign redirects automatically, which is enabled by default.
136422     *
136423     * @return bool TRUE
136424     * @since PECL OAuth >= 0.99.9
136425     **/
136426    public function enableRedirects(){}
136427
136428    /**
136429     * Turn on SSL checks
136430     *
136431     * Turns on the usual SSL peer certificate and host checks (enabled by
136432     * default). Alternatively, the {@link sslChecks} member can be set to a
136433     * non-FALSE value to turn SSL checks off.
136434     *
136435     * @return bool TRUE
136436     * @since PECL OAuth >= 0.99.5
136437     **/
136438    public function enableSSLChecks(){}
136439
136440    /**
136441     * Fetch an OAuth protected resource
136442     *
136443     * Fetch a resource.
136444     *
136445     * @param string $protected_resource_url URL to the OAuth protected
136446     *   resource.
136447     * @param array $extra_parameters Extra parameters to send with the
136448     *   request for the resource.
136449     * @param string $http_method One of the OAUTH_HTTP_METHOD_* OAUTH
136450     *   constants, which includes GET, POST, PUT, HEAD, or DELETE. HEAD
136451     *   (OAUTH_HTTP_METHOD_HEAD) can be useful for discovering information
136452     *   prior to the request (if OAuth credentials are in the Authorization
136453     *   header).
136454     * @param array $http_headers HTTP client headers (such as User-Agent,
136455     *   Accept, etc.)
136456     * @return mixed
136457     * @since PECL OAuth >= 0.99.1
136458     **/
136459    public function fetch($protected_resource_url, $extra_parameters, $http_method, $http_headers){}
136460
136461    /**
136462     * Generate a signature
136463     *
136464     * Generate a signature based on the final HTTP method, URL and a
136465     * string/array of parameters.
136466     *
136467     * @param string $http_method HTTP method for request
136468     * @param string $url URL for request
136469     * @param mixed $extra_parameters String or array of additional
136470     *   parameters.
136471     * @return string A string containing the generated signature
136472     **/
136473    public function generateSignature($http_method, $url, $extra_parameters){}
136474
136475    /**
136476     * Fetch an access token
136477     *
136478     * Fetch an access token, secret and any additional response parameters
136479     * from the service provider.
136480     *
136481     * @param string $access_token_url URL to the access token API.
136482     * @param string $auth_session_handle Authorization session handle,
136483     *   this parameter does not have any citation in the core OAuth 1.0
136484     *   specification but may be implemented by large providers. See
136485     *   ScalableOAuth for more information.
136486     * @param string $verifier_token For service providers which support
136487     *   1.0a, a {@link verifier_token} must be passed while exchanging the
136488     *   request token for the access token. If the {@link verifier_token} is
136489     *   present in {@link $_GET} or {@link $_POST} it is passed
136490     *   automatically and the caller does not need to specify a {@link
136491     *   verifier_token} (usually if the access token is exchanged at the
136492     *   oauth_callback URL). See ScalableOAuth for more information.
136493     * @param string $http_method HTTP method to use, e.g. GET or POST.
136494     * @return array Returns an array containing the parsed OAuth response
136495     *   on success or FALSE on failure.
136496     * @since PECL OAuth >= 0.99.1
136497     **/
136498    public function getAccessToken($access_token_url, $auth_session_handle, $verifier_token, $http_method){}
136499
136500    /**
136501     * Gets CA information
136502     *
136503     * Gets the Certificate Authority information, which includes the ca_path
136504     * and ca_info set by OAuth::setCaPath.
136505     *
136506     * @return array An array of Certificate Authority information,
136507     *   specifically as ca_path and ca_info keys within the returned
136508     *   associative array.
136509     * @since PECL OAuth >= 0.99.8
136510     **/
136511    public function getCAPath(){}
136512
136513    /**
136514     * Get the last response
136515     *
136516     * Get the raw response of the most recent request.
136517     *
136518     * @return string Returns a string containing the last response.
136519     * @since PECL OAuth >= 0.99.1
136520     **/
136521    public function getLastResponse(){}
136522
136523    /**
136524     * Get headers for last response
136525     *
136526     * @return string A string containing the last response's headers
136527     **/
136528    public function getLastResponseHeaders(){}
136529
136530    /**
136531     * Get HTTP information about the last response
136532     *
136533     * @return array Returns an array containing the response information
136534     *   for the last request. Constants from {@link curl_getinfo} may be
136535     *   used.
136536     * @since PECL OAuth >= 0.99.1
136537     **/
136538    public function getLastResponseInfo(){}
136539
136540    /**
136541     * Generate OAuth header string signature
136542     *
136543     * Generate OAuth header string signature based on the final HTTP method,
136544     * URL and a string/array of parameters
136545     *
136546     * @param string $http_method HTTP method for request.
136547     * @param string $url URL for request.
136548     * @param mixed $extra_parameters String or array of additional
136549     *   parameters.
136550     * @return string A string containing the generated request header
136551     **/
136552    public function getRequestHeader($http_method, $url, $extra_parameters){}
136553
136554    /**
136555     * Fetch a request token
136556     *
136557     * Fetch a request token, secret and any additional response parameters
136558     * from the service provider.
136559     *
136560     * @param string $request_token_url URL to the request token API.
136561     * @param string $callback_url OAuth callback URL. If {@link
136562     *   callback_url} is passed and is an empty value, it is set to "oob" to
136563     *   address the OAuth 2009.1 advisory.
136564     * @param string $http_method HTTP method to use, e.g. GET or POST.
136565     * @return array Returns an array containing the parsed OAuth response
136566     *   on success or FALSE on failure.
136567     * @since PECL OAuth >= 0.99.1
136568     **/
136569    public function getRequestToken($request_token_url, $callback_url, $http_method){}
136570
136571    /**
136572     * Set authorization type
136573     *
136574     * Set where the OAuth parameters should be passed.
136575     *
136576     * @param int $auth_type {@link auth_type} can be one of the following
136577     *   flags (in order of decreasing preference as per OAuth 1.0 section
136578     *   5.2): OAUTH_AUTH_TYPE_AUTHORIZATION Pass the OAuth parameters in the
136579     *   HTTP Authorization header. OAUTH_AUTH_TYPE_FORM Append the OAuth
136580     *   parameters to the HTTP POST request body. OAUTH_AUTH_TYPE_URI Append
136581     *   the OAuth parameters to the request URI. OAUTH_AUTH_TYPE_NONE None.
136582     * @return bool Returns TRUE if a parameter is correctly set, otherwise
136583     *   FALSE (e.g., if an invalid {@link auth_type} is passed in.)
136584     * @since PECL OAuth >= 0.99.1
136585     **/
136586    public function setAuthType($auth_type){}
136587
136588    /**
136589     * Set CA path and info
136590     *
136591     * Sets the Certificate Authority (CA), both for path and info.
136592     *
136593     * @param string $ca_path The CA Path being set.
136594     * @param string $ca_info The CA Info being set.
136595     * @return mixed Returns TRUE on success, or FALSE if either {@link
136596     *   ca_path} or {@link ca_info} are considered invalid.
136597     * @since PECL OAuth >= 0.99.8
136598     **/
136599    public function setCAPath($ca_path, $ca_info){}
136600
136601    /**
136602     * Set the nonce for subsequent requests
136603     *
136604     * Sets the nonce for all subsequent requests.
136605     *
136606     * @param string $nonce The value for oauth_nonce.
136607     * @return mixed Returns TRUE on success, or FALSE if the {@link nonce}
136608     *   is considered invalid.
136609     * @since PECL OAuth >= 0.99.1
136610     **/
136611    public function setNonce($nonce){}
136612
136613    /**
136614     * The setRequestEngine purpose
136615     *
136616     * Sets the Request Engine, that will be sending the HTTP requests.
136617     *
136618     * @param int $reqengine The desired request engine. Set to
136619     *   OAUTH_REQENGINE_STREAMS to use PHP Streams, or OAUTH_REQENGINE_CURL
136620     *   to use Curl.
136621     * @return void
136622     * @since PECL OAuth >= 1.0.0
136623     **/
136624    public function setRequestEngine($reqengine){}
136625
136626    /**
136627     * Set the RSA certificate
136628     *
136629     * Sets the RSA certificate.
136630     *
136631     * @param string $cert The RSA certificate.
136632     * @return mixed Returns TRUE on success, or FALSE on failure (e.g.,
136633     *   the RSA certificate cannot be parsed.)
136634     * @since PECL OAuth >= 1.0.0
136635     **/
136636    public function setRSACertificate($cert){}
136637
136638    /**
136639     * Tweak specific SSL checks for requests
136640     *
136641     * @param int $sslcheck
136642     * @return bool
136643     **/
136644    public function setSSLChecks($sslcheck){}
136645
136646    /**
136647     * Set the timestamp
136648     *
136649     * Sets the OAuth timestamp for subsequent requests.
136650     *
136651     * @param string $timestamp The timestamp.
136652     * @return mixed Returns TRUE, unless the {@link timestamp} is invalid,
136653     *   in which case FALSE is returned.
136654     * @since PECL OAuth >= 1.0.0
136655     **/
136656    public function setTimestamp($timestamp){}
136657
136658    /**
136659     * Sets the token and secret
136660     *
136661     * Set the token and secret for subsequent requests.
136662     *
136663     * @param string $token The OAuth token.
136664     * @param string $token_secret The OAuth token secret.
136665     * @return bool TRUE
136666     * @since PECL OAuth >= 0.99.1
136667     **/
136668    public function setToken($token, $token_secret){}
136669
136670    /**
136671     * Set the OAuth version
136672     *
136673     * Sets the OAuth version for subsequent requests
136674     *
136675     * @param string $version OAuth version, default value is always "1.0"
136676     * @return bool
136677     * @since PECL OAuth >= 0.99.1
136678     **/
136679    public function setVersion($version){}
136680
136681    /**
136682     * Create a new OAuth object
136683     *
136684     * Creates a new OAuth object
136685     *
136686     * @param string $consumer_key The consumer key provided by the service
136687     *   provider.
136688     * @param string $consumer_secret The consumer secret provided by the
136689     *   service provider.
136690     * @param string $signature_method This optional parameter defines
136691     *   which signature method to use, by default it is
136692     *   OAUTH_SIG_METHOD_HMACSHA1 (HMAC-SHA1).
136693     * @param int $auth_type This optional parameter defines how to pass
136694     *   the OAuth parameters to a consumer, by default it is
136695     *   OAUTH_AUTH_TYPE_AUTHORIZATION (in the Authorization header).
136696     * @since PECL OAuth >= 0.99.1
136697     **/
136698    public function __construct($consumer_key, $consumer_secret, $signature_method, $auth_type){}
136699
136700    /**
136701     * The destructor
136702     *
136703     * @return void
136704     * @since PECL OAuth >= 0.99.9
136705     **/
136706    public function __destruct(){}
136707
136708}
136709/**
136710 * This exception is thrown when exceptional errors occur while using the
136711 * OAuth extension and contains useful debugging information.
136712 **/
136713class OAuthException extends Exception {
136714    /**
136715     * @var mixed
136716     **/
136717    public $debugInfo;
136718
136719    /**
136720     * @var mixed
136721     **/
136722    public $lastResponse;
136723
136724}
136725/**
136726 * Manages an OAuth provider class. See also an external in-depth
136727 * tutorial titled Writing an OAuth Provider Service, which takes a
136728 * hands-on approach to providing this service. There are also OAuth
136729 * provider examples within the OAuth extensions sources.
136730 **/
136731class OAuthProvider {
136732    /**
136733     * Add required parameters
136734     *
136735     * Add required oauth provider parameters.
136736     *
136737     * @param string $req_params The required parameters.
136738     * @return bool
136739     * @since PECL OAuth >= 1.0.0
136740     **/
136741    final public function addRequiredParameter($req_params){}
136742
136743    /**
136744     * Calls the consumerNonceHandler callback
136745     *
136746     * Calls the registered consumer handler callback function, which is set
136747     * with OAuthProvider::consumerHandler.
136748     *
136749     * @return void
136750     **/
136751    public function callconsumerHandler(){}
136752
136753    /**
136754     * Calls the timestampNonceHandler callback
136755     *
136756     * Calls the registered timestamp handler callback function, which is set
136757     * with OAuthProvider::timestampNonceHandler.
136758     *
136759     * @return void
136760     * @since PECL OAuth >= 1.0.0
136761     **/
136762    public function callTimestampNonceHandler(){}
136763
136764    /**
136765     * Calls the tokenNonceHandler callback
136766     *
136767     * Calls the registered token handler callback function, which is set
136768     * with OAuthProvider::tokenHandler.
136769     *
136770     * @return void
136771     * @since PECL OAuth >= 1.0.0
136772     **/
136773    public function calltokenHandler(){}
136774
136775    /**
136776     * Check an oauth request
136777     *
136778     * Checks an OAuth request.
136779     *
136780     * @param string $uri The optional URI, or endpoint.
136781     * @param string $method The HTTP method. Optionally pass in one of the
136782     *   OAUTH_HTTP_METHOD_* OAuth constants.
136783     * @return void
136784     * @since PECL OAuth >= 1.0.0
136785     **/
136786    public function checkOAuthRequest($uri, $method){}
136787
136788    /**
136789     * Set the consumerHandler handler callback
136790     *
136791     * Sets the consumer handler callback, which will later be called with
136792     * OAuthProvider::callConsumerHandler.
136793     *
136794     * @param callable $callback_function The callable functions name.
136795     * @return void
136796     * @since PECL OAuth >= 1.0.0
136797     **/
136798    public function consumerHandler($callback_function){}
136799
136800    /**
136801     * Generate a random token
136802     *
136803     * Generates a string of pseudo-random bytes.
136804     *
136805     * @param int $size The desired token length, in terms of bytes.
136806     * @param bool $strong Setting to TRUE means /dev/random will be used
136807     *   for entropy, as otherwise the non-blocking /dev/urandom is used.
136808     *   This parameter is ignored on Windows.
136809     * @return string The generated token, as a string of bytes.
136810     * @since PECL OAuth >= 1.0.0
136811     **/
136812    final public static function generateToken($size, $strong){}
136813
136814    /**
136815     * is2LeggedEndpoint
136816     *
136817     * The 2-legged flow, or request signing. It does not require a token.
136818     *
136819     * @param mixed $params_array
136820     * @return void An OAuthProvider object.
136821     * @since PECL OAuth >= 1.0.0
136822     **/
136823    public function is2LeggedEndpoint($params_array){}
136824
136825    /**
136826     * Sets isRequestTokenEndpoint
136827     *
136828     * @param bool $will_issue_request_token Sets whether or not it will
136829     *   issue a request token, thus determining if
136830     *   OAuthProvider::tokenHandler needs to be called.
136831     * @return void
136832     * @since PECL OAuth >= 1.0.0
136833     **/
136834    public function isRequestTokenEndpoint($will_issue_request_token){}
136835
136836    /**
136837     * Remove a required parameter
136838     *
136839     * Removes a required parameter.
136840     *
136841     * @param string $req_params The required parameter to be removed.
136842     * @return bool
136843     * @since PECL OAuth >= 1.0.0
136844     **/
136845    final public function removeRequiredParameter($req_params){}
136846
136847    /**
136848     * Report a problem
136849     *
136850     * Pass in a problem as an OAuthException, with possible problems listed
136851     * in the OAuth constants section.
136852     *
136853     * @param string $oauthexception The OAuthException.
136854     * @param bool $send_headers
136855     * @return string
136856     * @since PECL OAuth >= 1.0.0
136857     **/
136858    final public static function reportProblem($oauthexception, $send_headers){}
136859
136860    /**
136861     * Set a parameter
136862     *
136863     * Sets a parameter.
136864     *
136865     * @param string $param_key The parameter key.
136866     * @param mixed $param_val The optional parameter value. To exclude a
136867     *   parameter from signature verification, set its value to NULL.
136868     * @return bool
136869     * @since PECL OAuth >= 1.0.0
136870     **/
136871    final public function setParam($param_key, $param_val){}
136872
136873    /**
136874     * Set request token path
136875     *
136876     * Sets the request tokens path.
136877     *
136878     * @param string $path The path.
136879     * @return bool TRUE
136880     * @since PECL OAuth >= 1.0.0
136881     **/
136882    final public function setRequestTokenPath($path){}
136883
136884    /**
136885     * Set the timestampNonceHandler handler callback
136886     *
136887     * Sets the timestamp nonce handler callback, which will later be called
136888     * with OAuthProvider::callTimestampNonceHandler. Errors related to
136889     * timestamp/nonce are thrown to this callback.
136890     *
136891     * @param callable $callback_function The callable functions name.
136892     * @return void
136893     * @since PECL OAuth >= 1.0.0
136894     **/
136895    public function timestampNonceHandler($callback_function){}
136896
136897    /**
136898     * Set the tokenHandler handler callback
136899     *
136900     * Sets the token handler callback, which will later be called with
136901     * OAuthProvider::callTokenHandler.
136902     *
136903     * @param callable $callback_function The callable functions name.
136904     * @return void
136905     * @since PECL OAuth >= 1.0.0
136906     **/
136907    public function tokenHandler($callback_function){}
136908
136909    /**
136910     * Constructs a new OAuthProvider object
136911     *
136912     * Initiates a new OAuthProvider object.
136913     *
136914     * @param array $params_array Setting these optional parameters is
136915     *   limited to the CLI SAPI.
136916     * @since PECL OAuth >= 1.0.0
136917     **/
136918    public function __construct($params_array){}
136919
136920}
136921class OCICollection {
136922}
136923class OCILob {
136924}
136925/**
136926 * Classes implementing OuterIterator can be used to iterate over
136927 * iterators.
136928 **/
136929interface OuterIterator extends Iterator {
136930    /**
136931     * Returns the inner iterator for the current entry
136932     *
136933     * Returns the inner iterator for the current iterator entry.
136934     *
136935     * @return Iterator The inner iterator for the current entry.
136936     * @since PHP 5 >= 5.1.0, PHP 7
136937     **/
136938    public function getInnerIterator();
136939
136940}
136941/**
136942 * Exception thrown if a value is not a valid key. This represents errors
136943 * that cannot be detected at compile time.
136944 **/
136945class OutOfBoundsException extends RuntimeException {
136946}
136947/**
136948 * Exception thrown when an illegal index was requested. This represents
136949 * errors that should be detected at compile time.
136950 **/
136951class OutOfRangeException extends LogicException {
136952}
136953/**
136954 * Exception thrown when adding an element to a full container.
136955 **/
136956class OverflowException extends RuntimeException {
136957}
136958namespace parallel {
136959final class Channel {
136960    /**
136961     * Closing
136962     *
136963     * Shall close this channel
136964     *
136965     * @return void
136966     **/
136967    public function close(){}
136968
136969    /**
136970     * Access
136971     *
136972     * Shall make an unbuffered channel with the given name
136973     *
136974     * Shall make a buffered channel with the given name and capacity
136975     *
136976     * @param string $name The name of the channel.
136977     * @return Channel
136978     **/
136979    public function make($name){}
136980
136981    /**
136982     * Access
136983     *
136984     * Shall open the channel with the given name
136985     *
136986     * @param string $name
136987     * @return Channel
136988     **/
136989    public function open($name){}
136990
136991    /**
136992     * Sharing
136993     *
136994     * Shall recv a value from this channel
136995     *
136996     * @return mixed
136997     **/
136998    public function recv(){}
136999
137000    /**
137001     * Sharing
137002     *
137003     * Shall send the given value on this channel
137004     *
137005     * @param mixed $value
137006     * @return void
137007     **/
137008    public function send($value){}
137009
137010    /**
137011     * Channel Construction
137012     *
137013     * Shall make an anonymous unbuffered channel
137014     *
137015     * Shall make an anonymous buffered channel with the given capacity
137016     **/
137017    public function __construct(){}
137018
137019}
137020}
137021namespace parallel {
137022final class Events implements Countable, Traversable {
137023    /**
137024     * Targets
137025     *
137026     * Shall watch for events on the given {@link channel}
137027     *
137028     * @param parallel\Channel $channel
137029     * @return void
137030     **/
137031    public function addChannel($channel){}
137032
137033    /**
137034     * Targets
137035     *
137036     * Shall watch for events on the given {@link future}
137037     *
137038     * @param string $name
137039     * @param parallel\Future $future
137040     * @return void
137041     **/
137042    public function addFuture($name, $future){}
137043
137044    /**
137045     * Polling
137046     *
137047     * Shall poll for the next event
137048     *
137049     * @return ?Event Should there be no targets remaining, null shall be
137050     *   returned
137051     **/
137052    public function poll(){}
137053
137054    /**
137055     * Targets
137056     *
137057     * Shall remove the given {@link target}
137058     *
137059     * @param string $target
137060     * @return void
137061     **/
137062    public function remove($target){}
137063
137064    /**
137065     * Behaviour
137066     *
137067     * By default when events are polled for, blocking will occur (at the PHP
137068     * level) until the first event can be returned: Setting blocking mode to
137069     * false will cause poll to return control if the first target polled is
137070     * not ready.
137071     *
137072     * This differs from setting a timeout of 0 with
137073     * parallel\Events::setTimeout, since a timeout of 0, while allowed, will
137074     * cause an exception to be raised, which may be extremely slow or
137075     * wasteful if what is really desired is non-blocking behaviour.
137076     *
137077     * A non-blocking loop effects the return value of parallel\Events::poll,
137078     * such that it may be null before all events have been processed.
137079     *
137080     * Shall set blocking mode
137081     *
137082     * @param bool $blocking
137083     * @return void
137084     **/
137085    public function setBlocking($blocking){}
137086
137087    /**
137088     * Input
137089     *
137090     * Shall set {@link input} for this event loop
137091     *
137092     * @param Input $input
137093     * @return void
137094     **/
137095    public function setInput($input){}
137096
137097    /**
137098     * Behaviour
137099     *
137100     * By default when events are polled for, blocking will occur (at the PHP
137101     * level) until the first event can be returned: Setting the timeout
137102     * causes an exception to be thrown when the timeout is reached.
137103     *
137104     * This differs from setting blocking mode to false with
137105     * parallel\Events::setBlocking, which will not cause an exception to be
137106     * thrown.
137107     *
137108     * Shall set the timeout in microseconds
137109     *
137110     * @param int $timeout
137111     * @return void
137112     **/
137113    public function setTimeout($timeout){}
137114
137115}
137116}
137117namespace parallel\Events {
137118final class Event {
137119    /**
137120     * @var object
137121     **/
137122    public $object;
137123
137124    /**
137125     * @var string
137126     **/
137127    public $source;
137128
137129    /**
137130     * @var int
137131     **/
137132    public $type;
137133
137134    /**
137135     * @var mixed
137136     **/
137137    public $value;
137138
137139}
137140}
137141namespace parallel\Events\Event {
137142final class Type {
137143}
137144}
137145namespace parallel\Events {
137146final class Input {
137147    /**
137148     * Inputs
137149     *
137150     * Shall set input for the given target
137151     *
137152     * @param string $target
137153     * @param mixed $value
137154     * @return void
137155     **/
137156    public function add($target, $value){}
137157
137158    /**
137159     * Inputs
137160     *
137161     * Shall remove input for all targets
137162     *
137163     * @return void
137164     **/
137165    public function clear(){}
137166
137167    /**
137168     * Inputs
137169     *
137170     * Shall remove input for the given target
137171     *
137172     * @param string $target
137173     * @return void
137174     **/
137175    public function remove($target){}
137176
137177}
137178}
137179namespace parallel {
137180final class Future {
137181    /**
137182     * Cancellation
137183     *
137184     * Shall try to cancel the task
137185     *
137186     * @return bool
137187     **/
137188    public function cancel(){}
137189
137190    /**
137191     * State Detection
137192     *
137193     * Shall indicate if the task was cancelled
137194     *
137195     * @return bool
137196     **/
137197    public function cancelled(){}
137198
137199    /**
137200     * State Detection
137201     *
137202     * Shall indicate if the task is completed
137203     *
137204     * @return bool
137205     **/
137206    public function done(){}
137207
137208    /**
137209     * Resolution
137210     *
137211     * Shall return (and if necessary wait for) return from task
137212     *
137213     * @return mixed
137214     **/
137215    public function value(){}
137216
137217}
137218}
137219namespace parallel {
137220final class Runtime {
137221    /**
137222     * Runtime Graceful Join
137223     *
137224     * Shall request that the runtime shutsdown.
137225     *
137226     * @return void
137227     **/
137228    public function close(){}
137229
137230    /**
137231     * Runtime Join
137232     *
137233     * Shall attempt to force the runtime to shutdown.
137234     *
137235     * @return void
137236     **/
137237    public function kill(){}
137238
137239    /**
137240     * Execution
137241     *
137242     * Shall schedule {@link task} for execution in parallel.
137243     *
137244     * Shall schedule {@link task} for execution in parallel, passing {@link
137245     * argv} at execution time.
137246     *
137247     * @param Closure $task A Closure with specific characteristics.
137248     * @return ?Future The return \parallel\Future must not be ignored when
137249     *   the task contains a return or throw statement.
137250     **/
137251    public function run($task){}
137252
137253}
137254}
137255namespace parallel {
137256final class Sync {
137257    /**
137258     * Access
137259     *
137260     * Shall atomically return the syncrhonization objects value
137261     *
137262     * @return scalar
137263     **/
137264    public function get(){}
137265
137266    /**
137267     * Synchronization
137268     *
137269     * Shall notify one (by default) or all threads waiting on the
137270     * synchronization object
137271     *
137272     * @param bool $all
137273     **/
137274    public function notify($all){}
137275
137276    /**
137277     * Access
137278     *
137279     * Shall atomically set the value of the synchronization object
137280     *
137281     * @param scalar $value
137282     **/
137283    public function set($value){}
137284
137285    /**
137286     * Synchronization
137287     *
137288     * Shall wait for notification on this synchronization object
137289     **/
137290    public function wait(){}
137291
137292    /**
137293     * Construction
137294     *
137295     * Shall construct a new synchronization object with no value
137296     *
137297     * Shall construct a new synchronization object containing the given
137298     * scalar value
137299     **/
137300    public function __construct(){}
137301
137302    /**
137303     * Synchronization
137304     *
137305     * Shall exclusively enter into the critical code
137306     *
137307     * @param callable $critical
137308     **/
137309    public function __invoke($critical){}
137310
137311}
137312}
137313/**
137314 * This extended FilterIterator allows a recursive iteration using
137315 * RecursiveIteratorIterator that only shows those elements which have
137316 * children.
137317 **/
137318class ParentIterator extends RecursiveFilterIterator implements RecursiveIterator, OuterIterator {
137319    /**
137320     * Determines acceptability
137321     *
137322     * Determines if the current element has children.
137323     *
137324     * @return bool TRUE if the current element is acceptable, otherwise
137325     *   FALSE.
137326     * @since PHP 5 >= 5.1.0, PHP 7
137327     **/
137328    public function accept(){}
137329
137330    /**
137331     * Return the inner iterator's children contained in a ParentIterator
137332     *
137333     * Get the inner iterator's children contained in a ParentIterator.
137334     *
137335     * @return ParentIterator An object.
137336     * @since PHP 5 >= 5.1.0, PHP 7
137337     **/
137338    public function getChildren(){}
137339
137340    /**
137341     * Check whether the inner iterator's current element has children
137342     *
137343     * @return bool
137344     * @since PHP 5 >= 5.1.0, PHP 7
137345     **/
137346    public function hasChildren(){}
137347
137348    /**
137349     * Move the iterator forward
137350     *
137351     * Moves the iterator forward.
137352     *
137353     * @return void
137354     * @since PHP 5 >= 5.1.0, PHP 7
137355     **/
137356    public function next(){}
137357
137358    /**
137359     * Rewind the iterator
137360     *
137361     * Rewinds the iterator.
137362     *
137363     * @return void
137364     * @since PHP 5 >= 5.1.0, PHP 7
137365     **/
137366    public function rewind(){}
137367
137368    /**
137369     * Constructs a ParentIterator
137370     *
137371     * Constructs a ParentIterator on an iterator.
137372     *
137373     * @param RecursiveIterator $iterator The iterator being constructed
137374     *   upon.
137375     * @since PHP 5 >= 5.1.0, PHP 7
137376     **/
137377    public function __construct($iterator){}
137378
137379}
137380namespace Parle {
137381class ErrorInfo {
137382    /**
137383     * @var integer
137384     **/
137385    public $id;
137386
137387    /**
137388     * @var integer
137389     **/
137390    public $position;
137391
137392    /**
137393     * @var mixed
137394     **/
137395    public $token;
137396
137397}
137398}
137399namespace Parle {
137400class Lexer {
137401    /**
137402     * @var boolean
137403     **/
137404    public $bol;
137405
137406    /**
137407     * @var integer
137408     **/
137409    public $cursor;
137410
137411    /**
137412     * @var integer
137413     **/
137414    public $flags;
137415
137416    /**
137417     * @var integer
137418     **/
137419    public $marker;
137420
137421    /**
137422     * @var integer
137423     **/
137424    public $state;
137425
137426    /**
137427     * Process next lexer rule
137428     *
137429     * Processes the next rule and prepares the resulting token data.
137430     *
137431     * @return void
137432     **/
137433    public function advance(){}
137434
137435    /**
137436     * Finalize the lexer rule set
137437     *
137438     * Rules, previously added with Parle\Lexer::push are finalized. This
137439     * method call has to be done after all the necessary rules was pushed.
137440     * The rule set becomes read only. The lexing can begin.
137441     *
137442     * @return void
137443     **/
137444    public function build(){}
137445
137446    /**
137447     * Define token callback
137448     *
137449     * Define a callback to be invoked once lexer encounters a particular
137450     * token.
137451     *
137452     * @param int $id Token id.
137453     * @param callable $callback Callable to be invoked. The callable
137454     *   doesn't receive any arguments and its return value is ignored.
137455     * @return void
137456     **/
137457    public function callout($id, $callback){}
137458
137459    /**
137460     * Pass the data for processing
137461     *
137462     * Consume the data for lexing.
137463     *
137464     * @param string $data Data to be lexed.
137465     * @return void
137466     **/
137467    public function consume($data){}
137468
137469    /**
137470     * Dump the state machine
137471     *
137472     * Dump the current state machine to stdout.
137473     *
137474     * @return void
137475     **/
137476    public function dump(){}
137477
137478    /**
137479     * Retrieve the current token
137480     *
137481     * @return Parle\Token Returns an instance of Parle\Token.
137482     **/
137483    public function getToken(){}
137484
137485    /**
137486     * Insert regex macro
137487     *
137488     * Insert a regex macro, that can be later used as a shortcut and
137489     * included in other regular expressions.
137490     *
137491     * @param string $name Name of the macros.
137492     * @param string $regex Regular expression.
137493     * @return void
137494     **/
137495    public function insertMacro($name, $regex){}
137496
137497    /**
137498     * Add a lexer rule
137499     *
137500     * Push a pattern for lexeme recognition.
137501     *
137502     * @param string $regex Regular expression used for token matching.
137503     * @param int $id Token id. If the lexer instance is meant to be used
137504     *   standalone, this can be an arbitrary number. If the lexer instance
137505     *   is going to be passed to the parser, it has to be an id returned by
137506     *   Parle\Parser::tokenid.
137507     * @return void
137508     **/
137509    public function push($regex, $id){}
137510
137511    /**
137512     * Reset lexer
137513     *
137514     * Reset lexing optionally supplying the desired offset.
137515     *
137516     * @param int $pos Reset position.
137517     * @return void
137518     **/
137519    public function reset($pos){}
137520
137521}
137522}
137523namespace Parle {
137524class LexerException extends Exception implements Throwable {
137525}
137526}
137527namespace Parle {
137528class Parser {
137529    /**
137530     * @var integer
137531     **/
137532    public $action;
137533
137534    /**
137535     * @var integer
137536     **/
137537    public $reduceId;
137538
137539    /**
137540     * Process next parser rule
137541     *
137542     * @return void
137543     **/
137544    public function advance(){}
137545
137546    /**
137547     * Finalize the grammar rules
137548     *
137549     * Any tokens and grammar rules previously added are finalized. The rule
137550     * set becomes readonly and the parser is ready to start.
137551     *
137552     * @return void
137553     **/
137554    public function build(){}
137555
137556    /**
137557     * Consume the data for processing
137558     *
137559     * Consume the data for parsing.
137560     *
137561     * @param string $data Data to be parsed.
137562     * @param Parle\Lexer $lexer A lexer object containing the lexing rules
137563     *   prepared for the particular grammar.
137564     * @return void
137565     **/
137566    public function consume($data, $lexer){}
137567
137568    /**
137569     * Dump the grammar
137570     *
137571     * Dump the current grammar to stdout.
137572     *
137573     * @return void
137574     **/
137575    public function dump(){}
137576
137577    /**
137578     * Retrieve the error information
137579     *
137580     * Retrieve the error information in case Parle\Parser::action returned
137581     * the error action.
137582     *
137583     * @return Parle\ErrorInfo Returns an instance of Parle\ErrorInfo.
137584     **/
137585    public function errorInfo(){}
137586
137587    /**
137588     * Declare a token with left-associativity
137589     *
137590     * Declare a terminal with left associativity.
137591     *
137592     * @param string $tok Token name.
137593     * @return void
137594     **/
137595    public function left($tok){}
137596
137597    /**
137598     * Declare a token with no associativity
137599     *
137600     * Declare a terminal, that cannot appear more than once in the row.
137601     *
137602     * @param string $tok Token name.
137603     * @return void
137604     **/
137605    public function nonassoc($tok){}
137606
137607    /**
137608     * Declare a precedence rule
137609     *
137610     * Declares a precedence rule for a fictitious terminal symbol. This rule
137611     * can be later used in the specific grammar rules.
137612     *
137613     * @param string $tok Token name.
137614     * @return void
137615     **/
137616    public function precedence($tok){}
137617
137618    /**
137619     * Add a grammar rule
137620     *
137621     * Push a grammar rule. The production id returned can be used later in
137622     * the parsing process to identify the rule matched.
137623     *
137624     * @param string $name Rule name.
137625     * @param string $rule The rule to be added. The syntax is Bison
137626     *   compatible.
137627     * @return int Returns representing the rule index.
137628     **/
137629    public function push($name, $rule){}
137630
137631    /**
137632     * Reset parser state
137633     *
137634     * Reset parser state using the given token id.
137635     *
137636     * @param int $tokenId Token id.
137637     * @return void
137638     **/
137639    public function reset($tokenId){}
137640
137641    /**
137642     * Declare a token with right-associativity
137643     *
137644     * Declare a terminal with right associativity.
137645     *
137646     * @param string $tok Token name.
137647     * @return void
137648     **/
137649    public function right($tok){}
137650
137651    /**
137652     * Retrieve a matching part of a rule
137653     *
137654     * Retrieve a part of the match by a rule. This method is equivalent to
137655     * the pseudo variable functionality in Bison.
137656     *
137657     * @param int $idx Match index, zero based.
137658     * @return string Returns a with the matched part.
137659     **/
137660    public function sigil($idx){}
137661
137662    /**
137663     * Declare a token
137664     *
137665     * Declare a terminal to be used in the grammar.
137666     *
137667     * @param string $tok Token name.
137668     * @return void
137669     **/
137670    public function token($tok){}
137671
137672    /**
137673     * Get token id
137674     *
137675     * Retrieve the id of the named token.
137676     *
137677     * @param string $tok Name of the token as used in Parle\Parser::token.
137678     * @return int Returns representing the token id.
137679     **/
137680    public function tokenId($tok){}
137681
137682    /**
137683     * Trace the parser operation
137684     *
137685     * Retrieve the current parser operation description. This can be
137686     * especially useful for studying the parser and to optimize the grammar.
137687     *
137688     * @return string Returns a with the trace information.
137689     **/
137690    public function trace(){}
137691
137692    /**
137693     * Validate input
137694     *
137695     * Validate an input string. The string is parsed internally, thus this
137696     * method is useful for the quick input validation.
137697     *
137698     * @param string $data String to be validated.
137699     * @param Parle\Lexer $lexer A lexer object containing the lexing rules
137700     *   prepared for the particular grammar.
137701     * @return bool Returns witnessing whether the input chimes or not with
137702     *   the defined rules.
137703     **/
137704    public function validate($data, $lexer){}
137705
137706}
137707}
137708namespace Parle {
137709class ParserException extends Exception implements Throwable {
137710}
137711}
137712namespace Parle {
137713class RLexer {
137714    /**
137715     * @var boolean
137716     **/
137717    public $bol;
137718
137719    /**
137720     * @var integer
137721     **/
137722    public $cursor;
137723
137724    /**
137725     * @var integer
137726     **/
137727    public $flags;
137728
137729    /**
137730     * @var integer
137731     **/
137732    public $marker;
137733
137734    /**
137735     * @var integer
137736     **/
137737    public $state;
137738
137739    /**
137740     * Process next lexer rule
137741     *
137742     * Processes the next rule and prepares the resulting token data.
137743     *
137744     * @return void
137745     **/
137746    public function advance(){}
137747
137748    /**
137749     * Finalize the lexer rule set
137750     *
137751     * Rules, previously added with Parle\RLexer::push are finalized. This
137752     * method call has to be done after all the necessary rules was pushed.
137753     * The rule set becomes read only. The lexing can begin.
137754     *
137755     * @return void
137756     **/
137757    public function build(){}
137758
137759    /**
137760     * Define token callback
137761     *
137762     * Define a callback to be invoked once lexer encounters a particular
137763     * token.
137764     *
137765     * @param int $id Token id.
137766     * @param callable $callback Callable to be invoked. The callable
137767     *   doesn't receive any arguments and its return value is ignored.
137768     * @return void
137769     **/
137770    public function callout($id, $callback){}
137771
137772    /**
137773     * Pass the data for processing
137774     *
137775     * Consume the data for lexing.
137776     *
137777     * @param string $data Data to be lexed.
137778     * @return void
137779     **/
137780    public function consume($data){}
137781
137782    /**
137783     * Dump the state machine
137784     *
137785     * Dump the current state machine to stdout.
137786     *
137787     * @return void
137788     **/
137789    public function dump(){}
137790
137791    /**
137792     * Retrieve the current token
137793     *
137794     * Retrive the current token.
137795     *
137796     * @return Parle\Token Returns an instance of Parle\Token.
137797     **/
137798    public function getToken(){}
137799
137800    /**
137801     * Insert regex macro
137802     *
137803     * Insert a regex macro, that can be later used as a shortcut and
137804     * included in other regular expressions.
137805     *
137806     * @param string $name Name of the macros.
137807     * @param string $regex Regular expression.
137808     * @return void
137809     **/
137810    public function insertMacro($name, $regex){}
137811
137812    /**
137813     * Add a lexer rule
137814     *
137815     * Push a pattern for lexeme recognition.
137816     *
137817     * A 'start state' and 'exit state' can be specified by using a suitable
137818     * signature.
137819     *
137820     * @param string $regex Regular expression used for token matching.
137821     * @param int $id Token id. If the lexer instance is meant to be used
137822     *   standalone, this can be an arbitrary number. If the lexer instance
137823     *   is going to be passed to the parser, it has to be an id returned by
137824     *   Parle\RParser::tokenid.
137825     * @return void
137826     **/
137827    public function push($regex, $id){}
137828
137829    /**
137830     * Push a new start state
137831     *
137832     * This lexer type can have more than one state machine. This allows you
137833     * to lex different tokens depending on context, thus allowing simple
137834     * parsing to take place. Once a state pushed, it can be used with a
137835     * suitable Parle\RLexer::push signature variant.
137836     *
137837     * @param string $state Name of the state.
137838     * @return int
137839     **/
137840    public function pushState($state){}
137841
137842    /**
137843     * Reset lexer
137844     *
137845     * Reset lexing optionally supplying the desired offset.
137846     *
137847     * @param int $pos Reset position.
137848     * @return void
137849     **/
137850    public function reset($pos){}
137851
137852}
137853}
137854namespace Parle {
137855class RParser {
137856    /**
137857     * @var integer
137858     **/
137859    public $action;
137860
137861    /**
137862     * @var integer
137863     **/
137864    public $reduceId;
137865
137866    /**
137867     * Process next parser rule
137868     *
137869     * Prosess next parser rule.
137870     *
137871     * @return void
137872     **/
137873    public function advance(){}
137874
137875    /**
137876     * Finalize the grammar rules
137877     *
137878     * Any tokens and grammar rules previously added are finalized. The rule
137879     * set becomes readonly and the parser is ready to start.
137880     *
137881     * @return void
137882     **/
137883    public function build(){}
137884
137885    /**
137886     * Consume the data for processing
137887     *
137888     * Consume the data for parsing.
137889     *
137890     * @param string $data Data to be parsed.
137891     * @param Parle\RLexer $rlexer A lexer object containing the lexing
137892     *   rules prepared for the particular grammar.
137893     * @return void
137894     **/
137895    public function consume($data, $rlexer){}
137896
137897    /**
137898     * Dump the grammar
137899     *
137900     * Dump the current grammar to stdout.
137901     *
137902     * @return void
137903     **/
137904    public function dump(){}
137905
137906    /**
137907     * Retrieve the error information
137908     *
137909     * Retrieve the error information in case Parle\RParser::action returned
137910     * the error action.
137911     *
137912     * @return Parle\ErrorInfo Returns an instance of Parle\ErrorInfo.
137913     **/
137914    public function errorInfo(){}
137915
137916    /**
137917     * Declare a token with left-associativity
137918     *
137919     * Declare a terminal with left associativity.
137920     *
137921     * @param string $tok Token name.
137922     * @return void
137923     **/
137924    public function left($tok){}
137925
137926    /**
137927     * Declare a token with no associativity
137928     *
137929     * Declare a terminal, that cannot appear more than once in the row.
137930     *
137931     * @param string $tok Token name.
137932     * @return void
137933     **/
137934    public function nonassoc($tok){}
137935
137936    /**
137937     * Declare a precedence rule
137938     *
137939     * Declares a precedence rule for a fictious terminal symbol. This rule
137940     * can be later used in the specific grammar rules.
137941     *
137942     * @param string $tok Token name.
137943     * @return void
137944     **/
137945    public function precedence($tok){}
137946
137947    /**
137948     * Add a grammar rule
137949     *
137950     * Push a grammar rule. The production id returned can be used later in
137951     * the parsing process to identify the rule matched.
137952     *
137953     * @param string $name Rule name.
137954     * @param string $rule The rule to be added. The syntax is Bison
137955     *   compatible.
137956     * @return int Returns representing the rule index.
137957     **/
137958    public function push($name, $rule){}
137959
137960    /**
137961     * Reset parser state
137962     *
137963     * Reset parser state using the given token id.
137964     *
137965     * @param int $tokenId Token id.
137966     * @return void
137967     **/
137968    public function reset($tokenId){}
137969
137970    /**
137971     * Declare a token with right-associativity
137972     *
137973     * Declare a terminal with right associativity.
137974     *
137975     * @param string $tok Token name.
137976     * @return void
137977     **/
137978    public function right($tok){}
137979
137980    /**
137981     * Retrieve a matching part of a rule
137982     *
137983     * Retrieve a part of the match by a rule. This method is equivalent to
137984     * the pseudo variable functionality in Bison.
137985     *
137986     * @param int $idx Match index, zero based.
137987     * @return string Returns a with the matched part.
137988     **/
137989    public function sigil($idx){}
137990
137991    /**
137992     * Declare a token
137993     *
137994     * Declare a terminal to be used in the grammar.
137995     *
137996     * @param string $tok Token name.
137997     * @return void
137998     **/
137999    public function token($tok){}
138000
138001    /**
138002     * Get token id
138003     *
138004     * Retrieve the id of the named token.
138005     *
138006     * @param string $tok Name of the token as used in
138007     *   Parle\RParser::token.
138008     * @return int Returns representing the token id.
138009     **/
138010    public function tokenId($tok){}
138011
138012    /**
138013     * Trace the parser operation
138014     *
138015     * Retrieve the current parser operation description. This can be
138016     * especially useful to study the parser and to optimize the grammar.
138017     *
138018     * @return string Returns a with the trace information.
138019     **/
138020    public function trace(){}
138021
138022    /**
138023     * Validate input
138024     *
138025     * Validate an input string. The string is parsed internally, thus this
138026     * method is useful for the quick input validation.
138027     *
138028     * @param string $data String to be validated.
138029     * @param Parle\RLexer $lexer A lexer object containing the lexing
138030     *   rules prepared for the particular grammar.
138031     * @return bool Returns whitnessing whether the input chimes or not
138032     *   with the defined rules.
138033     **/
138034    public function validate($data, $lexer){}
138035
138036}
138037}
138038namespace Parle {
138039class Stack {
138040    /**
138041     * @var boolean
138042     **/
138043    public $empty;
138044
138045    /**
138046     * @var integer
138047     **/
138048    public $size;
138049
138050    /**
138051     * @var mixed
138052     **/
138053    public $top;
138054
138055    /**
138056     * Pop an item from the stack
138057     *
138058     * @return void
138059     **/
138060    public function pop(){}
138061
138062    /**
138063     * Push an item into the stack
138064     *
138065     * @param mixed $item Variable to be pushed.
138066     * @return void
138067     **/
138068    public function push($item){}
138069
138070}
138071}
138072namespace Parle {
138073class Token {
138074    /**
138075     * @var integer
138076     **/
138077    public $id;
138078
138079    /**
138080     * @var string
138081     **/
138082    public $value;
138083
138084}
138085}
138086/**
138087 * ParseError is thrown when an error occurs while parsing PHP code, such
138088 * as when {@link eval} is called.
138089 **/
138090class ParseError extends CompileError {
138091}
138092/**
138093 * Represents a connection between PHP and a database server.
138094 **/
138095class PDO {
138096    const ATTR_AUTOCOMMIT = 0;
138097
138098    const ATTR_CASE = 0;
138099
138100    const ATTR_CLIENT_VERSION = 0;
138101
138102    const ATTR_CONNECTION_STATUS = 0;
138103
138104    const ATTR_CURSOR = 0;
138105
138106    const ATTR_CURSOR_NAME = 0;
138107
138108    const ATTR_DEFAULT_FETCH_MODE = 0;
138109
138110    const ATTR_DEFAULT_STR_PARAM = 0;
138111
138112    const ATTR_DRIVER_NAME = '';
138113
138114    const ATTR_EMULATE_PREPARES = 0;
138115
138116    const ATTR_ERRMODE = 0;
138117
138118    const ATTR_FETCH_CATALOG_NAMES = 0;
138119
138120    const ATTR_FETCH_TABLE_NAMES = 0;
138121
138122    const ATTR_MAX_COLUMN_LEN = 0;
138123
138124    const ATTR_ORACLE_NULLS = 0;
138125
138126    const ATTR_PERSISTENT = 0;
138127
138128    const ATTR_PREFETCH = 0;
138129
138130    const ATTR_SERVER_INFO = 0;
138131
138132    const ATTR_SERVER_VERSION = 0;
138133
138134    const ATTR_STATEMENT_CLASS = 0;
138135
138136    const ATTR_STRINGIFY_FETCHES = 0;
138137
138138    const ATTR_TIMEOUT = 0;
138139
138140    const CASE_LOWER = 0;
138141
138142    const CASE_NATURAL = 0;
138143
138144    const CASE_UPPER = 0;
138145
138146    const CURSOR_FWDONLY = 0;
138147
138148    const CURSOR_SCROLL = 0;
138149
138150    const ERRMODE_EXCEPTION = 0;
138151
138152    const ERRMODE_SILENT = 0;
138153
138154    const ERRMODE_WARNING = 0;
138155
138156    const ERR_NONE = '';
138157
138158    const FB_ATTR_DATE_FORMAT = 0;
138159
138160    const FB_ATTR_TIMESTAMP_FORMAT = 0;
138161
138162    const FB_ATTR_TIME_FORMAT = 0;
138163
138164    const FETCH_ASSOC = 0;
138165
138166    const FETCH_BOTH = 0;
138167
138168    const FETCH_BOUND = 0;
138169
138170    const FETCH_CLASS = 0;
138171
138172    const FETCH_CLASSTYPE = 0;
138173
138174    const FETCH_COLUMN = 0;
138175
138176    const FETCH_FUNC = 0;
138177
138178    const FETCH_GROUP = 0;
138179
138180    const FETCH_INTO = 0;
138181
138182    const FETCH_KEY_PAIR = 0;
138183
138184    const FETCH_LAZY = 0;
138185
138186    const FETCH_NAMED = 0;
138187
138188    const FETCH_NUM = 0;
138189
138190    const FETCH_OBJ = 0;
138191
138192    const FETCH_ORI_ABS = 0;
138193
138194    const FETCH_ORI_FIRST = 0;
138195
138196    const FETCH_ORI_LAST = 0;
138197
138198    const FETCH_ORI_NEXT = 0;
138199
138200    const FETCH_ORI_PRIOR = 0;
138201
138202    const FETCH_ORI_REL = 0;
138203
138204    const FETCH_PROPS_LATE = 0;
138205
138206    const FETCH_SERIALIZE = 0;
138207
138208    const FETCH_UNIQUE = 0;
138209
138210    const MYSQL_ATTR_COMPRESS = 0;
138211
138212    const MYSQL_ATTR_DIRECT_QUERY = 0;
138213
138214    const MYSQL_ATTR_FOUND_ROWS = 0;
138215
138216    const MYSQL_ATTR_IGNORE_SPACE = 0;
138217
138218    const MYSQL_ATTR_INIT_COMMAND = 0;
138219
138220    const MYSQL_ATTR_LOCAL_INFILE = 0;
138221
138222    const MYSQL_ATTR_MAX_BUFFER_SIZE = 0;
138223
138224    const MYSQL_ATTR_MULTI_STATEMENTS = 0;
138225
138226    const MYSQL_ATTR_READ_DEFAULT_FILE = 0;
138227
138228    const MYSQL_ATTR_READ_DEFAULT_GROUP = 0;
138229
138230    const MYSQL_ATTR_SSL_CA = 0;
138231
138232    const MYSQL_ATTR_SSL_CAPATH = 0;
138233
138234    const MYSQL_ATTR_SSL_CERT = 0;
138235
138236    const MYSQL_ATTR_SSL_CIPHER = 0;
138237
138238    const MYSQL_ATTR_SSL_KEY = 0;
138239
138240    const MYSQL_ATTR_SSL_VERIFY_SERVER_CERT = 0;
138241
138242    const MYSQL_ATTR_USE_BUFFERED_QUERY = 0;
138243
138244    const NULL_EMPTY_STRING = 0;
138245
138246    const NULL_NATURAL = 0;
138247
138248    const NULL_TO_STRING = 0;
138249
138250    const OCI_ATTR_ACTION = 0;
138251
138252    const OCI_ATTR_CLIENT_IDENTIFIER = 0;
138253
138254    const OCI_ATTR_CLIENT_INFO = 0;
138255
138256    const OCI_ATTR_MODULE = 0;
138257
138258    const PARAM_BOOL = 0;
138259
138260    const PARAM_EVT_ALLOC = 0;
138261
138262    const PARAM_EVT_EXEC_POST = 0;
138263
138264    const PARAM_EVT_EXEC_PRE = 0;
138265
138266    const PARAM_EVT_FETCH_POST = 0;
138267
138268    const PARAM_EVT_FETCH_PRE = 0;
138269
138270    const PARAM_EVT_FREE = 0;
138271
138272    const PARAM_EVT_NORMALIZE = 0;
138273
138274    const PARAM_INPUT_OUTPUT = 0;
138275
138276    const PARAM_INT = 0;
138277
138278    const PARAM_LOB = 0;
138279
138280    const PARAM_NULL = 0;
138281
138282    const PARAM_STMT = 0;
138283
138284    const PARAM_STR = 0;
138285
138286    const PARAM_STR_CHAR = 0;
138287
138288    const PARAM_STR_NATL = 0;
138289
138290    const SQLITE_DETERMINISTIC = 0;
138291
138292    const SQLSRV_ATTR_DIRECT_QUERY = 0;
138293
138294    const SQLSRV_ATTR_QUERY_TIMEOUT = 0;
138295
138296    const SQLSRV_ENCODING_BINARY = 0;
138297
138298    const SQLSRV_ENCODING_DEFAULT = 0;
138299
138300    const SQLSRV_ENCODING_SYSTEM = 0;
138301
138302    const SQLSRV_ENCODING_UTF8 = 0;
138303
138304    const SQLSRV_TXN_READ_COMMITTED = 0;
138305
138306    const SQLSRV_TXN_READ_UNCOMMITTED = 0;
138307
138308    const SQLSRV_TXN_REPEATABLE_READ = 0;
138309
138310    const SQLSRV_TXN_SERIALIZABLE = 0;
138311
138312    const SQLSRV_TXN_SNAPSHOT = 0;
138313
138314    /**
138315     * Initiates a transaction
138316     *
138317     * Turns off autocommit mode. While autocommit mode is turned off,
138318     * changes made to the database via the PDO object instance are not
138319     * committed until you end the transaction by calling {@link
138320     * PDO::commit}. Calling {@link PDO::rollBack} will roll back all changes
138321     * to the database and return the connection to autocommit mode.
138322     *
138323     * Some databases, including MySQL, automatically issue an implicit
138324     * COMMIT when a database definition language (DDL) statement such as
138325     * DROP TABLE or CREATE TABLE is issued within a transaction. The
138326     * implicit COMMIT will prevent you from rolling back any other changes
138327     * within the transaction boundary.
138328     *
138329     * @return bool
138330     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0
138331     **/
138332    public function beginTransaction(){}
138333
138334    /**
138335     * Commits a transaction
138336     *
138337     * Commits a transaction, returning the database connection to autocommit
138338     * mode until the next call to {@link PDO::beginTransaction} starts a new
138339     * transaction.
138340     *
138341     * @return bool
138342     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0
138343     **/
138344    public function commit(){}
138345
138346    /**
138347     * Get the requested schema information
138348     *
138349     * This function is used to get the requested schema information from
138350     * database. You have to designate {@link table_name}, if you want to get
138351     * information on certain table, {@link col_name}, if you want to get
138352     * information on certain column (can be used only with
138353     * PDO::CUBRID_SCH_COL_PRIVILEGE).
138354     *
138355     * The result of this function is returned as a two-dimensional array
138356     * (column (associative array) * row (numeric array)). The following
138357     * tables shows types of schema and the column structure of the result
138358     * array to be returned based on the schema type.
138359     *
138360     * Result Composition of Each Type Schema Column Number Column Name Value
138361     * PDO::CUBRID_SCH_TABLE 1 NAME 2 TYPE 0:system table 1:view 2:table
138362     *
138363     * PDO::CUBRID_SCH_VIEW 1 NAME 2 TYPE 1:view
138364     *
138365     * PDO::CUBRID_SCH_QUERY_SPEC 1 QUERY_SPEC
138366     *
138367     * PDO::CUBRID_SCH_ATTRIBUTE / PDO::CUBRID_SCH_TABLE_ATTRIBUTE 1
138368     * ATTR_NAME 2 DOMAIN 3 SCALE 4 PRECISION 5 INDEXED 1:indexed 6 NOT NULL
138369     * 1:not null 7 SHARED 1:shared 8 UNIQUE 1:unique 9 DEFAULT 10 ATTR_ORDER
138370     * base:1 11 CLASS_NAME 12 SOURCE_CLASS 13 IS_KEY 1:key
138371     *
138372     * PDO::CUBRID_SCH_METHOD / PDO::CUBRID_SCH_TABLE_METHOD 1 NAME 2
138373     * RET_DOMAIN 3 ARG_DOMAIN
138374     *
138375     * PDO::CUBRID_SCH_METHOD_FILE 1 METHOD_FILE
138376     *
138377     * PDO::CUBRID_SCH_SUPER_TABLE / PDO::CUBRID_SCH_DIRECT_SUPER_TABLE /
138378     * PDO::CUBRID_SCH_SUB_TABLE 1 CLASS_NAME 2 TYPE 0:system table 1:view
138379     * 2:table
138380     *
138381     * PDO::CUBRID_SCH_CONSTRAINT 1 TYPE 0:unique 1:index 2:reverse unique
138382     * 3:reverse index 2 NAME 3 ATTR_NAME 4 NUM_PAGES 5 NUM_KEYS 6
138383     * PRIMARY_KEY 1:primary key 7 KEY_ORDER base:1
138384     *
138385     * PDO::CUBRID_SCH_TRIGGER 1 NAME 2 STATUS 3 EVENT 4 TARGET_CLASS 5
138386     * TARGET_ATTR 6 ACTION_TIME 7 ACTION 8 PRIORITY 9 CONDITION_TIME 10
138387     * CONDITION
138388     *
138389     * PDO::CUBRID_SCH_TABLE_PRIVILEGE / PDO::CUBRID_SCH_COL_PRIVILEGE 1
138390     * CLASS_NAME / ATTR_NAME 2 PRIVILEGE 3 GRANTABLE
138391     *
138392     * PDO::CUBRID_SCH_PRIMARY_KEY 1 CLASS_NAME 2 ATTR_NAME 3 KEY_SEQ base:1
138393     * 4 KEY_NAME
138394     *
138395     * PDO::CUBRID_SCH_IMPORTED_KEYS / PDO::CUBRID_SCH_EXPORTED_KEYS /
138396     * PDO::CUBRID_SCH_CROSS_REFERENCE 1 PKTABLE_NAME 2 PKCOLUMN_NAME 3
138397     * FKTABLE_NAME base:1 4 FKCOLUMN_NAME 5 KEY_SEQ base:1 6 UPDATE_ACTION
138398     * 0:cascade 1:restrict 2:no action 3:set null 7 DELETE_ACTION 0:cascade
138399     * 1:restrict 2:no action 3:set null 8 FK_NAME 9 PK_NAME
138400     *
138401     * @param int $schema_type Schema type that you want to know.
138402     * @param string $table_name Table you want to know the schema of.
138403     * @param string $col_name Column you want to know the schema of.
138404     * @return array Array containing the schema information, when process
138405     *   is successful;
138406     **/
138407    public function cubrid_schema($schema_type, $table_name, $col_name){}
138408
138409    /**
138410     * Fetch the SQLSTATE associated with the last operation on the database
138411     * handle
138412     *
138413     * @return string Returns an SQLSTATE, a five characters alphanumeric
138414     *   identifier defined in the ANSI SQL-92 standard. Briefly, an SQLSTATE
138415     *   consists of a two characters class value followed by a three
138416     *   characters subclass value. A class value of 01 indicates a warning
138417     *   and is accompanied by a return code of SQL_SUCCESS_WITH_INFO. Class
138418     *   values other than '01', except for the class 'IM', indicate an
138419     *   error. The class 'IM' is specific to warnings and errors that derive
138420     *   from the implementation of PDO (or perhaps ODBC, if you're using the
138421     *   ODBC driver) itself. The subclass value '000' in any class indicates
138422     *   that there is no subclass for that SQLSTATE.
138423     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0
138424     **/
138425    public function errorCode(){}
138426
138427    /**
138428     * Fetch extended error information associated with the last operation on
138429     * the database handle
138430     *
138431     * @return array {@link PDO::errorInfo} returns an array of error
138432     *   information about the last operation performed by this database
138433     *   handle. The array consists of at least the following fields: Element
138434     *   Information 0 SQLSTATE error code (a five characters alphanumeric
138435     *   identifier defined in the ANSI SQL standard). 1 Driver-specific
138436     *   error code. 2 Driver-specific error message.
138437     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0
138438     **/
138439    public function errorInfo(){}
138440
138441    /**
138442     * Execute an SQL statement and return the number of affected rows
138443     *
138444     * {@link PDO::exec} executes an SQL statement in a single function call,
138445     * returning the number of rows affected by the statement.
138446     *
138447     * {@link PDO::exec} does not return results from a SELECT statement. For
138448     * a SELECT statement that you only need to issue once during your
138449     * program, consider issuing {@link PDO::query}. For a statement that you
138450     * need to issue multiple times, prepare a PDOStatement object with
138451     * {@link PDO::prepare} and issue the statement with {@link
138452     * PDOStatement::execute}.
138453     *
138454     * @param string $statement The SQL statement to prepare and execute.
138455     *   Data inside the query should be properly escaped.
138456     * @return int {@link PDO::exec} returns the number of rows that were
138457     *   modified or deleted by the SQL statement you issued. If no rows were
138458     *   affected, {@link PDO::exec} returns 0.
138459     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0
138460     **/
138461    public function exec($statement){}
138462
138463    /**
138464     * Retrieve a database connection attribute
138465     *
138466     * This function returns the value of a database connection attribute. To
138467     * retrieve PDOStatement attributes, refer to {@link
138468     * PDOStatement::getAttribute}.
138469     *
138470     * Note that some database/driver combinations may not support all of the
138471     * database connection attributes.
138472     *
138473     * @param int $attribute One of the PDO::ATTR_* constants. The
138474     *   constants that apply to database connections are as follows:
138475     *   PDO::ATTR_AUTOCOMMIT PDO::ATTR_CASE PDO::ATTR_CLIENT_VERSION
138476     *   PDO::ATTR_CONNECTION_STATUS PDO::ATTR_DRIVER_NAME PDO::ATTR_ERRMODE
138477     *   PDO::ATTR_ORACLE_NULLS PDO::ATTR_PERSISTENT PDO::ATTR_PREFETCH
138478     *   PDO::ATTR_SERVER_INFO PDO::ATTR_SERVER_VERSION PDO::ATTR_TIMEOUT
138479     * @return mixed A successful call returns the value of the requested
138480     *   PDO attribute. An unsuccessful call returns null.
138481     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0
138482     **/
138483    public function getAttribute($attribute){}
138484
138485    /**
138486     * Return an array of available PDO drivers
138487     *
138488     * This function returns all currently available PDO drivers which can be
138489     * used in {@link DSN} parameter of {@link PDO::__construct}.
138490     *
138491     * @return array {@link PDO::getAvailableDrivers} returns an array of
138492     *   PDO driver names. If no drivers are available, it returns an empty
138493     *   array.
138494     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 1.0.3
138495     **/
138496    public static function getAvailableDrivers(){}
138497
138498    /**
138499     * Checks if inside a transaction
138500     *
138501     * Checks if a transaction is currently active within the driver. This
138502     * method only works for database drivers that support transactions.
138503     *
138504     * @return bool Returns TRUE if a transaction is currently active, and
138505     *   FALSE if not.
138506     * @since PHP 5 >= 5.3.3, Bundled pdo_pgsql, PHP 7
138507     **/
138508    public function inTransaction(){}
138509
138510    /**
138511     * Returns the ID of the last inserted row or sequence value
138512     *
138513     * Returns the ID of the last inserted row, or the last value from a
138514     * sequence object, depending on the underlying driver. For example,
138515     * PDO_PGSQL requires you to specify the name of a sequence object for
138516     * the {@link name} parameter.
138517     *
138518     * @param string $name Name of the sequence object from which the ID
138519     *   should be returned.
138520     * @return string If a sequence name was not specified for the {@link
138521     *   name} parameter, {@link PDO::lastInsertId} returns a string
138522     *   representing the row ID of the last row that was inserted into the
138523     *   database.
138524     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0
138525     **/
138526    public function lastInsertId($name){}
138527
138528    /**
138529     * Copy data from PHP array into table
138530     *
138531     * Copies data from {@link rows} array to table {@link table_name} using
138532     * {@link delimiter} as fields delimiter and {@link fields} list
138533     *
138534     * @param string $table_name String containing table name
138535     * @param array $rows Array of strings with fields separated by {@link
138536     *   delimiter}
138537     * @param string $delimiter Delimiter used in {@link rows} array
138538     * @param string $null_as How to interpret null values
138539     * @param string $fields List of fields to insert
138540     * @return bool Returns TRUE on success,.
138541     * @since PHP 5 >= 5.3.3, PHP 7
138542     **/
138543    public function pgsqlCopyFromArray($table_name, $rows, $delimiter, $null_as, $fields){}
138544
138545    /**
138546     * Copy data from file into table
138547     *
138548     * Copies data from file specified by {@link filename} into table {@link
138549     * table_name} using {@link delimiter} as fields delimiter and {@link
138550     * fields} list
138551     *
138552     * @param string $table_name String containing table name
138553     * @param string $filename Filename containing data to import
138554     * @param string $delimiter Delimiter used in file specified by {@link
138555     *   filename}
138556     * @param string $null_as How to interpret null values
138557     * @param string $fields List of fields to insert
138558     * @return bool Returns TRUE on success,.
138559     * @since PHP 5 >= 5.3.3, PHP 7
138560     **/
138561    public function pgsqlCopyFromFile($table_name, $filename, $delimiter, $null_as, $fields){}
138562
138563    /**
138564     * Copy data from database table into PHP array
138565     *
138566     * Copies data from {@link table} into array using {@link delimiter} as
138567     * fields delimiter and {@link fields} list
138568     *
138569     * @param string $table_name String containing table name
138570     * @param string $delimiter Delimiter used in rows
138571     * @param string $null_as How to interpret null values
138572     * @param string $fields List of fields to export
138573     * @return array Returns an array of rows,.
138574     * @since PHP 5 >= 5.3.3, PHP 7
138575     **/
138576    public function pgsqlCopyToArray($table_name, $delimiter, $null_as, $fields){}
138577
138578    /**
138579     * Copy data from table into file
138580     *
138581     * Copies data from table into file specified by {@link filename} using
138582     * {@link delimiter} as fields delimiter and {@link fields} list
138583     *
138584     * @param string $table_name String containing table name
138585     * @param string $filename Filename to export data
138586     * @param string $delimiter Delimiter used in file specified by {@link
138587     *   filename}
138588     * @param string $null_as How to interpret null values
138589     * @param string $fields List of fields to insert
138590     * @return bool Returns TRUE on success,.
138591     * @since PHP 5 >= 5.3.3, PHP 7
138592     **/
138593    public function pgsqlCopyToFile($table_name, $filename, $delimiter, $null_as, $fields){}
138594
138595    /**
138596     * Get asynchronous notification
138597     *
138598     * Returns a result set representing a pending asynchronous notification.
138599     *
138600     * @param int $result_type The format the result set should be returned
138601     *   as, represented as a PDO::FETCH_* constant.
138602     * @param int $ms_timeout The length of time to wait for a response, in
138603     *   milliseconds.
138604     * @return array If one or more notifications is pending, returns a
138605     *   single row, with fields message and pid, otherwise returns FALSE.
138606     * @since PHP 5 >= 5.6.0, PHP 7
138607     **/
138608    public function pgsqlGetNotify($result_type, $ms_timeout){}
138609
138610    /**
138611     * Get the server PID
138612     *
138613     * Returns the server's PID.
138614     *
138615     * @return int The server's PID.
138616     * @since PHP 5 >= 5.6.0, PHP 7
138617     **/
138618    public function pgsqlGetPid(){}
138619
138620    /**
138621     * Creates a new large object
138622     *
138623     * {@link PDO::pgsqlLOBCreate} creates a large object and returns the OID
138624     * of that object. You may then open a stream on the object using {@link
138625     * PDO::pgsqlLOBOpen} to read or write data to it. The OID can be stored
138626     * in columns of type OID and be used to reference the large object,
138627     * without causing the row to grow arbitrarily large. The large object
138628     * will continue to live in the database until it is removed by calling
138629     * {@link PDO::pgsqlLOBUnlink}.
138630     *
138631     * Large objects can be up to 2GB in size, but are cumbersome to use; you
138632     * need to ensure that {@link PDO::pgsqlLOBUnlink} is called prior to
138633     * deleting the last row that references its OID from your database. In
138634     * addition, large objects have no access controls. As an alternative,
138635     * try the bytea column type; recent versions of PostgreSQL allow bytea
138636     * columns of up to 1GB in size and transparently manage the storage for
138637     * optimal row size.
138638     *
138639     * @return string Returns the OID of the newly created large object on
138640     *   success, or FALSE on failure.
138641     * @since PHP 5 >= 5.1.2, PHP 7, PECL pdo_pgsql >= 1.0.2
138642     **/
138643    public function pgsqlLOBCreate(){}
138644
138645    /**
138646     * Opens an existing large object stream
138647     *
138648     * {@link PDO::pgsqlLOBOpen} opens a stream to access the data referenced
138649     * by {@link oid}. If {@link mode} is r, the stream is opened for
138650     * reading, if {@link mode} is w, then the stream will be opened for
138651     * writing. You can use all the usual filesystem functions, such as
138652     * {@link fread}, {@link fwrite} and {@link fgets} to manipulate the
138653     * contents of the stream.
138654     *
138655     * @param string $oid A large object identifier.
138656     * @param string $mode If mode is r, open the stream for reading. If
138657     *   mode is w, open the stream for writing.
138658     * @return resource Returns a stream resource on success.
138659     * @since PHP 5 >= 5.1.2, PHP 7, PECL pdo_pgsql >= 1.0.2
138660     **/
138661    public function pgsqlLOBOpen($oid, $mode){}
138662
138663    /**
138664     * Deletes the large object
138665     *
138666     * Deletes a large object from the database identified by OID.
138667     *
138668     * @param string $oid A large object identifier
138669     * @return bool
138670     * @since PHP 5 >= 5.1.2, PHP 7, PECL pdo_pgsql >= 1.0.2
138671     **/
138672    public function pgsqlLOBUnlink($oid){}
138673
138674    /**
138675     * Prepares a statement for execution and returns a statement object
138676     *
138677     * Prepares an SQL statement to be executed by the {@link
138678     * PDOStatement::execute} method. The statement template can contain zero
138679     * or more named (:name) or question mark (?) parameter markers for which
138680     * real values will be substituted when the statement is executed. Both
138681     * named and question mark parameter markers cannot be used within the
138682     * same statement template; only one or the other parameter style. Use
138683     * these parameters to bind any user-input, do not include the user-input
138684     * directly in the query.
138685     *
138686     * You must include a unique parameter marker for each value you wish to
138687     * pass in to the statement when you call {@link PDOStatement::execute}.
138688     * You cannot use a named parameter marker of the same name more than
138689     * once in a prepared statement, unless emulation mode is on.
138690     *
138691     * Calling {@link PDO::prepare} and {@link PDOStatement::execute} for
138692     * statements that will be issued multiple times with different parameter
138693     * values optimizes the performance of your application by allowing the
138694     * driver to negotiate client and/or server side caching of the query
138695     * plan and meta information. Also, calling {@link PDO::prepare} and
138696     * {@link PDOStatement::execute} helps to prevent SQL injection attacks
138697     * by eliminating the need to manually quote and escape the parameters.
138698     *
138699     * PDO will emulate prepared statements/bound parameters for drivers that
138700     * do not natively support them, and can also rewrite named or question
138701     * mark style parameter markers to something more appropriate, if the
138702     * driver supports one style but not the other.
138703     *
138704     * @param string $statement This must be a valid SQL statement template
138705     *   for the target database server.
138706     * @param array $driver_options This array holds one or more key=>value
138707     *   pairs to set attribute values for the PDOStatement object that this
138708     *   method returns. You would most commonly use this to set the
138709     *   PDO::ATTR_CURSOR value to PDO::CURSOR_SCROLL to request a scrollable
138710     *   cursor. Some drivers have driver-specific options that may be set at
138711     *   prepare-time.
138712     * @return PDOStatement If the database server successfully prepares
138713     *   the statement, {@link PDO::prepare} returns a PDOStatement object.
138714     *   If the database server cannot successfully prepare the statement,
138715     *   {@link PDO::prepare} returns FALSE or emits PDOException (depending
138716     *   on error handling).
138717     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0
138718     **/
138719    public function prepare($statement, $driver_options){}
138720
138721    /**
138722     * Executes an SQL statement, returning a result set as a PDOStatement
138723     * object
138724     *
138725     * {@link PDO::query} executes an SQL statement in a single function
138726     * call, returning the result set (if any) returned by the statement as a
138727     * PDOStatement object.
138728     *
138729     * For a query that you need to issue multiple times, you will realize
138730     * better performance if you prepare a PDOStatement object using {@link
138731     * PDO::prepare} and issue the statement with multiple calls to {@link
138732     * PDOStatement::execute}.
138733     *
138734     * If you do not fetch all of the data in a result set before issuing
138735     * your next call to {@link PDO::query}, your call may fail. Call {@link
138736     * PDOStatement::closeCursor} to release the database resources
138737     * associated with the PDOStatement object before issuing your next call
138738     * to {@link PDO::query}.
138739     *
138740     * @param string $statement The SQL statement to prepare and execute.
138741     *   Data inside the query should be properly escaped.
138742     * @return PDOStatement {@link PDO::query} returns a PDOStatement
138743     *   object, or FALSE on failure.
138744     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0
138745     **/
138746    public function query($statement){}
138747
138748    /**
138749     * Quotes a string for use in a query
138750     *
138751     * {@link PDO::quote} places quotes around the input string (if required)
138752     * and escapes special characters within the input string, using a
138753     * quoting style appropriate to the underlying driver.
138754     *
138755     * If you are using this function to build SQL statements, you are
138756     * strongly recommended to use {@link PDO::prepare} to prepare SQL
138757     * statements with bound parameters instead of using {@link PDO::quote}
138758     * to interpolate user input into an SQL statement. Prepared statements
138759     * with bound parameters are not only more portable, more convenient,
138760     * immune to SQL injection, but are often much faster to execute than
138761     * interpolated queries, as both the server and client side can cache a
138762     * compiled form of the query.
138763     *
138764     * Not all PDO drivers implement this method (notably PDO_ODBC). Consider
138765     * using prepared statements instead.
138766     *
138767     * @param string $string The string to be quoted.
138768     * @param int $parameter_type Provides a data type hint for drivers
138769     *   that have alternate quoting styles.
138770     * @return string Returns a quoted string that is theoretically safe to
138771     *   pass into an SQL statement. Returns FALSE if the driver does not
138772     *   support quoting in this way.
138773     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.1
138774     **/
138775    public function quote($string, $parameter_type){}
138776
138777    /**
138778     * Rolls back a transaction
138779     *
138780     * Rolls back the current transaction, as initiated by {@link
138781     * PDO::beginTransaction}.
138782     *
138783     * If the database was set to autocommit mode, this function will restore
138784     * autocommit mode after it has rolled back the transaction.
138785     *
138786     * Some databases, including MySQL, automatically issue an implicit
138787     * COMMIT when a database definition language (DDL) statement such as
138788     * DROP TABLE or CREATE TABLE is issued within a transaction. The
138789     * implicit COMMIT will prevent you from rolling back any other changes
138790     * within the transaction boundary.
138791     *
138792     * @return bool
138793     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0
138794     **/
138795    public function rollBack(){}
138796
138797    /**
138798     * Set an attribute
138799     *
138800     * Sets an attribute on the database handle. Some of the available
138801     * generic attributes are listed below; some drivers may make use of
138802     * additional driver specific attributes. PDO::ATTR_CASE: Force column
138803     * names to a specific case. PDO::CASE_LOWER: Force column names to lower
138804     * case. PDO::CASE_NATURAL: Leave column names as returned by the
138805     * database driver. PDO::CASE_UPPER: Force column names to upper case.
138806     * PDO::ATTR_ERRMODE: Error reporting. PDO::ERRMODE_SILENT: Just set
138807     * error codes. PDO::ERRMODE_WARNING: Raise E_WARNING.
138808     * PDO::ERRMODE_EXCEPTION: Throw exceptions. PDO::ATTR_ORACLE_NULLS
138809     * (available with all drivers, not just Oracle): Conversion of NULL and
138810     * empty strings. PDO::NULL_NATURAL: No conversion.
138811     * PDO::NULL_EMPTY_STRING: Empty string is converted to NULL.
138812     * PDO::NULL_TO_STRING: NULL is converted to an empty string.
138813     * PDO::ATTR_STRINGIFY_FETCHES: Convert numeric values to strings when
138814     * fetching. Requires bool. PDO::ATTR_STATEMENT_CLASS: Set user-supplied
138815     * statement class derived from PDOStatement. Cannot be used with
138816     * persistent PDO instances. Requires array(string classname, array(mixed
138817     * constructor_args)). PDO::ATTR_TIMEOUT: Specifies the timeout duration
138818     * in seconds. Not all drivers support this option, and its meaning may
138819     * differ from driver to driver. For example, sqlite will wait for up to
138820     * this time value before giving up on obtaining an writable lock, but
138821     * other drivers may interpret this as a connect or a read timeout
138822     * interval. Requires int. PDO::ATTR_AUTOCOMMIT (available in OCI,
138823     * Firebird and MySQL): Whether to autocommit every single statement.
138824     * PDO::ATTR_EMULATE_PREPARES Enables or disables emulation of prepared
138825     * statements. Some drivers do not support native prepared statements or
138826     * have limited support for them. Use this setting to force PDO to either
138827     * always emulate prepared statements (if TRUE and emulated prepares are
138828     * supported by the driver), or to try to use native prepared statements
138829     * (if FALSE). It will always fall back to emulating the prepared
138830     * statement if the driver cannot successfully prepare the current query.
138831     * Requires bool. PDO::MYSQL_ATTR_USE_BUFFERED_QUERY (available in
138832     * MySQL): Use buffered queries. PDO::ATTR_DEFAULT_FETCH_MODE: Set
138833     * default fetch mode. Description of modes is available in {@link
138834     * PDOStatement::fetch} documentation.
138835     *
138836     * @param int $attribute
138837     * @param mixed $value
138838     * @return bool
138839     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0
138840     **/
138841    public function setAttribute($attribute, $value){}
138842
138843    /**
138844     * Registers an aggregating User Defined Function for use in SQL
138845     * statements
138846     *
138847     * This method is similar to except that it registers functions that can
138848     * be used to calculate a result aggregated across all the rows of a
138849     * query.
138850     *
138851     * The key difference between this method and is that two functions are
138852     * required to manage the aggregate.
138853     *
138854     * @param string $function_name The name of the function used in SQL
138855     *   statements.
138856     * @param callable $step_func Callback function called for each row of
138857     *   the result set. Your PHP function should accumulate the result and
138858     *   store it in the aggregation context. This function need to be
138859     *   defined as: mixedstep mixed{@link context} int{@link rownumber}
138860     *   mixed{@link value1} mixed{@link ...} {@link context} NULL for the
138861     *   first row; on subsequent rows it will have the value that was
138862     *   previously returned from the step function; you should use this to
138863     *   maintain the aggregate state. {@link rownumber} The current row
138864     *   number. {@link value1} The first argument passed to the aggregate.
138865     *   {@link ...} Further arguments passed to the aggregate. The return
138866     *   value of this function will be used as the {@link context} argument
138867     *   in the next call of the step or finalize functions.
138868     * @param callable $finalize_func NULL for the first row; on subsequent
138869     *   rows it will have the value that was previously returned from the
138870     *   step function; you should use this to maintain the aggregate state.
138871     * @param int $num_args The current row number.
138872     * @return bool
138873     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo_sqlite >= 1.0.0
138874     **/
138875    public function sqliteCreateAggregate($function_name, $step_func, $finalize_func, $num_args){}
138876
138877    /**
138878     * Registers a User Defined Function for use as a collating function in
138879     * SQL statements
138880     *
138881     * @param string $name Name of the SQL collating function to be created
138882     *   or redefined.
138883     * @param callable $callback The name of a PHP function or user-defined
138884     *   function to apply as a callback, defining the behavior of the
138885     *   collation. It should accept two strings and return as strcmp() does,
138886     *   i.e. it should return -1, 1, or 0 if the first string sorts before,
138887     *   sorts after, or is equal to the second. This function need to be
138888     *   defined as: intcollation string{@link string1} string{@link string2}
138889     * @return bool
138890     * @since PHP 5 >= 5.3.11, PHP 7
138891     **/
138892    public function sqliteCreateCollation($name, $callback){}
138893
138894    /**
138895     * Registers a User Defined Function for use in SQL statements
138896     *
138897     * This method allows you to register a PHP function with SQLite as an
138898     * UDF (User Defined Function), so that it can be called from within your
138899     * SQL statements.
138900     *
138901     * The UDF can be used in any SQL statement that can call functions, such
138902     * as SELECT and UPDATE statements and also in triggers.
138903     *
138904     * @param string $function_name The name of the function used in SQL
138905     *   statements.
138906     * @param callable $callback Callback function to handle the defined
138907     *   SQL function. This function need to be defined as: mixedcallback
138908     *   mixed{@link value1} mixed{@link ...} {@link value1} The first
138909     *   argument passed to the SQL function. {@link ...} Further arguments
138910     *   passed to the SQL function.
138911     * @param int $num_args The first argument passed to the SQL function.
138912     * @param int $flags Further arguments passed to the SQL function.
138913     * @return bool
138914     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo_sqlite >= 1.0.0
138915     **/
138916    public function sqliteCreateFunction($function_name, $callback, $num_args, $flags){}
138917
138918}
138919/**
138920 * Represents an error raised by PDO. You should not throw a PDOException
138921 * from your own code. See Exceptions for more information about
138922 * Exceptions in PHP.
138923 **/
138924class PDOException extends RuntimeException {
138925    /**
138926     * SQLSTATE error code. Use {@link Exception::getCode} to access it.
138927     *
138928     * @var string
138929     **/
138930    protected $code;
138931
138932    /**
138933     * @var array
138934     **/
138935    public $errorInfo;
138936
138937}
138938/**
138939 * Represents a prepared statement and, after the statement is executed,
138940 * an associated result set.
138941 **/
138942class PDOStatement implements Traversable {
138943    /**
138944     * @var string
138945     **/
138946    public $queryString;
138947
138948    /**
138949     * Bind a column to a PHP variable
138950     *
138951     * {@link PDOStatement::bindColumn} arranges to have a particular
138952     * variable bound to a given column in the result-set from a query. Each
138953     * call to {@link PDOStatement::fetch} or {@link PDOStatement::fetchAll}
138954     * will update all the variables that are bound to columns.
138955     *
138956     * @param mixed $column Number of the column (1-indexed) or name of the
138957     *   column in the result set. If using the column name, be aware that
138958     *   the name should match the case of the column, as returned by the
138959     *   driver.
138960     * @param mixed $param Name of the PHP variable to which the column
138961     *   will be bound.
138962     * @param int $type Data type of the parameter, specified by the
138963     *   PDO::PARAM_* constants.
138964     * @param int $maxlen A hint for pre-allocation.
138965     * @param mixed $driverdata Optional parameter(s) for the driver.
138966     * @return bool
138967     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0
138968     **/
138969    public function bindColumn($column, &$param, $type, $maxlen, $driverdata){}
138970
138971    /**
138972     * Binds a parameter to the specified variable name
138973     *
138974     * Binds a PHP variable to a corresponding named or question mark
138975     * placeholder in the SQL statement that was used to prepare the
138976     * statement. Unlike {@link PDOStatement::bindValue}, the variable is
138977     * bound as a reference and will only be evaluated at the time that
138978     * {@link PDOStatement::execute} is called.
138979     *
138980     * Most parameters are input parameters, that is, parameters that are
138981     * used in a read-only fashion to build up the query (but may nonetheless
138982     * be cast according to {@link data_type}). Some drivers support the
138983     * invocation of stored procedures that return data as output parameters,
138984     * and some also as input/output parameters that both send in data and
138985     * are updated to receive it.
138986     *
138987     * @param mixed $parameter Parameter identifier. For a prepared
138988     *   statement using named placeholders, this will be a parameter name of
138989     *   the form :name. For a prepared statement using question mark
138990     *   placeholders, this will be the 1-indexed position of the parameter.
138991     * @param mixed $variable Name of the PHP variable to bind to the SQL
138992     *   statement parameter.
138993     * @param int $data_type Explicit data type for the parameter using the
138994     *   PDO::PARAM_* constants. To return an INOUT parameter from a stored
138995     *   procedure, use the bitwise OR operator to set the
138996     *   PDO::PARAM_INPUT_OUTPUT bits for the {@link data_type} parameter.
138997     * @param int $length Length of the data type. To indicate that a
138998     *   parameter is an OUT parameter from a stored procedure, you must
138999     *   explicitly set the length.
139000     * @param mixed $driver_options
139001     * @return bool
139002     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0
139003     **/
139004    public function bindParam($parameter, &$variable, $data_type, $length, $driver_options){}
139005
139006    /**
139007     * Binds a value to a parameter
139008     *
139009     * Binds a value to a corresponding named or question mark placeholder in
139010     * the SQL statement that was used to prepare the statement.
139011     *
139012     * @param mixed $parameter Parameter identifier. For a prepared
139013     *   statement using named placeholders, this will be a parameter name of
139014     *   the form :name. For a prepared statement using question mark
139015     *   placeholders, this will be the 1-indexed position of the parameter.
139016     * @param mixed $value The value to bind to the parameter.
139017     * @param int $data_type Explicit data type for the parameter using the
139018     *   PDO::PARAM_* constants.
139019     * @return bool
139020     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 1.0.0
139021     **/
139022    public function bindValue($parameter, $value, $data_type){}
139023
139024    /**
139025     * Closes the cursor, enabling the statement to be executed again
139026     *
139027     * {@link PDOStatement::closeCursor} frees up the connection to the
139028     * server so that other SQL statements may be issued, but leaves the
139029     * statement in a state that enables it to be executed again.
139030     *
139031     * This method is useful for database drivers that do not support
139032     * executing a PDOStatement object when a previously executed
139033     * PDOStatement object still has unfetched rows. If your database driver
139034     * suffers from this limitation, the problem may manifest itself in an
139035     * out-of-sequence error.
139036     *
139037     * {@link PDOStatement::closeCursor} is implemented either as an optional
139038     * driver specific method (allowing for maximum efficiency), or as the
139039     * generic PDO fallback if no driver specific function is installed. The
139040     * PDO generic fallback is semantically the same as writing the following
139041     * code in your PHP script:
139042     *
139043     * <?php do { while ($stmt->fetch()) ; if (!$stmt->nextRowset()) break; }
139044     * while (true); ?>
139045     *
139046     * @return bool
139047     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.9.0
139048     **/
139049    public function closeCursor(){}
139050
139051    /**
139052     * Returns the number of columns in the result set
139053     *
139054     * Use {@link PDOStatement::columnCount} to return the number of columns
139055     * in the result set represented by the PDOStatement object.
139056     *
139057     * If the PDOStatement object was returned from {@link PDO::query}, the
139058     * column count is immediately available.
139059     *
139060     * If the PDOStatement object was returned from {@link PDO::prepare}, an
139061     * accurate column count will not be available until you invoke {@link
139062     * PDOStatement::execute}.
139063     *
139064     * @return int Returns the number of columns in the result set
139065     *   represented by the PDOStatement object, even if the result set is
139066     *   empty. If there is no result set, {@link PDOStatement::columnCount}
139067     *   returns 0.
139068     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0
139069     **/
139070    public function columnCount(){}
139071
139072    /**
139073     * Dump an SQL prepared command
139074     *
139075     * Dumps the information contained by a prepared statement directly on
139076     * the output. It will provide the SQL query in use, the number of
139077     * parameters used (Params), the list of parameters with their key name
139078     * or position, their name, their position in the query (if this is
139079     * supported by the PDO driver, otherwise, it will be -1), type
139080     * (param_type) as an integer, and a boolean value is_param.
139081     *
139082     * This is a debug function, which dumps the data directly to the normal
139083     * output.
139084     *
139085     * This will only dump the parameters in the statement at the moment of
139086     * the dump. Extra parameters are not stored in the statement, and not
139087     * displayed.
139088     *
139089     * @return void
139090     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.9.0
139091     **/
139092    public function debugDumpParams(){}
139093
139094    /**
139095     * Fetch the SQLSTATE associated with the last operation on the statement
139096     * handle
139097     *
139098     * @return string Identical to {@link PDO::errorCode}, except that
139099     *   {@link PDOStatement::errorCode} only retrieves error codes for
139100     *   operations performed with PDOStatement objects.
139101     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0
139102     **/
139103    public function errorCode(){}
139104
139105    /**
139106     * Fetch extended error information associated with the last operation on
139107     * the statement handle
139108     *
139109     * @return array {@link PDOStatement::errorInfo} returns an array of
139110     *   error information about the last operation performed by this
139111     *   statement handle. The array consists of at least the following
139112     *   fields: Element Information 0 SQLSTATE error code (a five characters
139113     *   alphanumeric identifier defined in the ANSI SQL standard). 1 Driver
139114     *   specific error code. 2 Driver specific error message.
139115     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0
139116     **/
139117    public function errorInfo(){}
139118
139119    /**
139120     * Executes a prepared statement
139121     *
139122     * Execute the prepared statement. If the prepared statement included
139123     * parameter markers, either: {@link PDOStatement::bindParam} and/or
139124     * {@link PDOStatement::bindValue} has to be called to bind either
139125     * variables or values (respectively) to the parameter markers. Bound
139126     * variables pass their value as input and receive the output value, if
139127     * any, of their associated parameter markers or an array of input-only
139128     * parameter values has to be passed
139129     *
139130     * @param array $input_parameters An array of values with as many
139131     *   elements as there are bound parameters in the SQL statement being
139132     *   executed. All values are treated as PDO::PARAM_STR. Multiple values
139133     *   cannot be bound to a single parameter; for example, it is not
139134     *   allowed to bind two values to a single named parameter in an IN()
139135     *   clause. Binding more values than specified is not possible; if more
139136     *   keys exist in {@link input_parameters} than in the SQL specified in
139137     *   the PDO::prepare, then the statement will fail and an error is
139138     *   emitted.
139139     * @return bool
139140     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0
139141     **/
139142    public function execute($input_parameters){}
139143
139144    /**
139145     * Fetches the next row from a result set
139146     *
139147     * Fetches a row from a result set associated with a PDOStatement object.
139148     * The {@link fetch_style} parameter determines how PDO returns the row.
139149     *
139150     * @param int $fetch_style Controls how the next row will be returned
139151     *   to the caller. This value must be one of the PDO::FETCH_* constants,
139152     *   defaulting to value of PDO::ATTR_DEFAULT_FETCH_MODE (which defaults
139153     *   to PDO::FETCH_BOTH). PDO::FETCH_ASSOC: returns an array indexed by
139154     *   column name as returned in your result set PDO::FETCH_BOTH
139155     *   (default): returns an array indexed by both column name and
139156     *   0-indexed column number as returned in your result set
139157     *   PDO::FETCH_BOUND: returns TRUE and assigns the values of the columns
139158     *   in your result set to the PHP variables to which they were bound
139159     *   with the {@link PDOStatement::bindColumn} method PDO::FETCH_CLASS:
139160     *   returns a new instance of the requested class, mapping the columns
139161     *   of the result set to named properties in the class, and calling the
139162     *   constructor afterwards, unless PDO::FETCH_PROPS_LATE is also given.
139163     *   If {@link fetch_style} includes PDO::FETCH_CLASSTYPE (e.g.
139164     *   PDO::FETCH_CLASS | PDO::FETCH_CLASSTYPE) then the name of the class
139165     *   is determined from a value of the first column. PDO::FETCH_INTO:
139166     *   updates an existing instance of the requested class, mapping the
139167     *   columns of the result set to named properties in the class
139168     *   PDO::FETCH_LAZY: combines PDO::FETCH_BOTH and PDO::FETCH_OBJ,
139169     *   creating the object variable names as they are accessed
139170     *   PDO::FETCH_NAMED: returns an array with the same form as
139171     *   PDO::FETCH_ASSOC, except that if there are multiple columns with the
139172     *   same name, the value referred to by that key will be an array of all
139173     *   the values in the row that had that column name PDO::FETCH_NUM:
139174     *   returns an array indexed by column number as returned in your result
139175     *   set, starting at column 0 PDO::FETCH_OBJ: returns an anonymous
139176     *   object with property names that correspond to the column names
139177     *   returned in your result set PDO::FETCH_PROPS_LATE: when used with
139178     *   PDO::FETCH_CLASS, the constructor of the class is called before the
139179     *   properties are assigned from the respective column values.
139180     * @param int $cursor_orientation For a PDOStatement object
139181     *   representing a scrollable cursor, this value determines which row
139182     *   will be returned to the caller. This value must be one of the
139183     *   PDO::FETCH_ORI_* constants, defaulting to PDO::FETCH_ORI_NEXT. To
139184     *   request a scrollable cursor for your PDOStatement object, you must
139185     *   set the PDO::ATTR_CURSOR attribute to PDO::CURSOR_SCROLL when you
139186     *   prepare the SQL statement with {@link PDO::prepare}.
139187     * @param int $cursor_offset For a PDOStatement object representing a
139188     *   scrollable cursor for which the cursor_orientation parameter is set
139189     *   to PDO::FETCH_ORI_ABS, this value specifies the absolute number of
139190     *   the row in the result set that shall be fetched. For a PDOStatement
139191     *   object representing a scrollable cursor for which the
139192     *   cursor_orientation parameter is set to PDO::FETCH_ORI_REL, this
139193     *   value specifies the row to fetch relative to the cursor position
139194     *   before {@link PDOStatement::fetch} was called.
139195     * @return mixed The return value of this function on success depends
139196     *   on the fetch type. In all cases, FALSE is returned on failure.
139197     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0
139198     **/
139199    public function fetch($fetch_style, $cursor_orientation, $cursor_offset){}
139200
139201    /**
139202     * Returns an array containing all of the result set rows
139203     *
139204     * @param int $fetch_style Controls the contents of the returned array
139205     *   as documented in {@link PDOStatement::fetch}. Defaults to value of
139206     *   PDO::ATTR_DEFAULT_FETCH_MODE (which defaults to PDO::FETCH_BOTH) To
139207     *   return an array consisting of all values of a single column from the
139208     *   result set, specify PDO::FETCH_COLUMN. You can specify which column
139209     *   you want with the {@link fetch_argument} parameter. To fetch only
139210     *   the unique values of a single column from the result set, bitwise-OR
139211     *   PDO::FETCH_COLUMN with PDO::FETCH_UNIQUE. To return an associative
139212     *   array grouped by the values of a specified column, bitwise-OR
139213     *   PDO::FETCH_COLUMN with PDO::FETCH_GROUP.
139214     * @param mixed $fetch_argument This argument has a different meaning
139215     *   depending on the value of the {@link fetch_style} parameter:
139216     *   PDO::FETCH_COLUMN: Returns the indicated 0-indexed column.
139217     *   PDO::FETCH_CLASS: Returns instances of the specified class, mapping
139218     *   the columns of each row to named properties in the class.
139219     *   PDO::FETCH_FUNC: Returns the results of calling the specified
139220     *   function, using each row's columns as parameters in the call.
139221     * @param array $ctor_args Arguments of custom class constructor when
139222     *   the {@link fetch_style} parameter is PDO::FETCH_CLASS.
139223     * @return array {@link PDOStatement::fetchAll} returns an array
139224     *   containing all of the remaining rows in the result set. The array
139225     *   represents each row as either an array of column values or an object
139226     *   with properties corresponding to each column name. An empty array is
139227     *   returned if there are zero results to fetch, or FALSE on failure.
139228     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0
139229     **/
139230    public function fetchAll($fetch_style, $fetch_argument, $ctor_args){}
139231
139232    /**
139233     * Returns a single column from the next row of a result set
139234     *
139235     * Returns a single column from the next row of a result set or FALSE if
139236     * there are no more rows.
139237     *
139238     * @param int $column_number 0-indexed number of the column you wish to
139239     *   retrieve from the row. If no value is supplied, {@link
139240     *   PDOStatement::fetchColumn} fetches the first column.
139241     * @return mixed {@link PDOStatement::fetchColumn} returns a single
139242     *   column from the next row of a result set or FALSE if there are no
139243     *   more rows.
139244     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.9.0
139245     **/
139246    public function fetchColumn($column_number){}
139247
139248    /**
139249     * Fetches the next row and returns it as an object
139250     *
139251     * Fetches the next row and returns it as an object. This function is an
139252     * alternative to {@link PDOStatement::fetch} with PDO::FETCH_CLASS or
139253     * PDO::FETCH_OBJ style.
139254     *
139255     * When an object is fetched, its properties are assigned from respective
139256     * column values, and afterwards its constructor is invoked.
139257     *
139258     * @param string $class_name Name of the created class.
139259     * @param array $ctor_args Elements of this array are passed to the
139260     *   constructor.
139261     * @return mixed Returns an instance of the required class with
139262     *   property names that correspond to the column names .
139263     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.4
139264     **/
139265    public function fetchObject($class_name, $ctor_args){}
139266
139267    /**
139268     * Retrieve a statement attribute
139269     *
139270     * Gets an attribute of the statement. Currently, no generic attributes
139271     * exist but only driver specific: PDO::ATTR_CURSOR_NAME (Firebird and
139272     * ODBC specific): Get the name of cursor for UPDATE ... WHERE CURRENT
139273     * OF.
139274     *
139275     * @param int $attribute
139276     * @return mixed Returns the attribute value.
139277     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0
139278     **/
139279    public function getAttribute($attribute){}
139280
139281    /**
139282     * Returns metadata for a column in a result set
139283     *
139284     * Retrieves the metadata for a 0-indexed column in a result set as an
139285     * associative array.
139286     *
139287     * The following drivers support this method:
139288     *
139289     * @param int $column The 0-indexed column in the result set.
139290     * @return array Returns an associative array containing the following
139291     *   values representing the metadata for a single column:
139292     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0
139293     **/
139294    public function getColumnMeta($column){}
139295
139296    /**
139297     * Advances to the next rowset in a multi-rowset statement handle
139298     *
139299     * Some database servers support stored procedures that return more than
139300     * one rowset (also known as a result set). {@link
139301     * PDOStatement::nextRowset} enables you to access the second and
139302     * subsequent rowsets associated with a PDOStatement object. Each rowset
139303     * can have a different set of columns from the preceding rowset.
139304     *
139305     * @return bool
139306     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0
139307     **/
139308    public function nextRowset(){}
139309
139310    /**
139311     * Returns the number of rows affected by the last SQL statement
139312     *
139313     * {@link PDOStatement::rowCount} returns the number of rows affected by
139314     * the last DELETE, INSERT, or UPDATE statement executed by the
139315     * corresponding PDOStatement object.
139316     *
139317     * If the last SQL statement executed by the associated PDOStatement was
139318     * a SELECT statement, some databases may return the number of rows
139319     * returned by that statement. However, this behaviour is not guaranteed
139320     * for all databases and should not be relied on for portable
139321     * applications.
139322     *
139323     * @return int Returns the number of rows.
139324     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0
139325     **/
139326    public function rowCount(){}
139327
139328    /**
139329     * Set a statement attribute
139330     *
139331     * Sets an attribute on the statement. Currently, no generic attributes
139332     * are set but only driver specific: PDO::ATTR_CURSOR_NAME (Firebird and
139333     * ODBC specific): Set the name of cursor for UPDATE ... WHERE CURRENT
139334     * OF.
139335     *
139336     * @param int $attribute
139337     * @param mixed $value
139338     * @return bool
139339     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0
139340     **/
139341    public function setAttribute($attribute, $value){}
139342
139343    /**
139344     * Set the default fetch mode for this statement
139345     *
139346     * @param int $mode The fetch mode must be one of the PDO::FETCH_*
139347     *   constants.
139348     * @return bool
139349     * @since PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0
139350     **/
139351    public function setFetchMode($mode){}
139352
139353}
139354/**
139355 * The Phar class provides a high-level interface to accessing and
139356 * creating phar archives.
139357 **/
139358class Phar extends RecursiveDirectoryIterator implements Countable, ArrayAccess {
139359    /**
139360     * bzip2 compression
139361     *
139362     * @var integer
139363     **/
139364    const BZ2 = 0;
139365
139366    /**
139367     * bitmask that can be used with file flags to determine if any
139368     * compression is present
139369     *
139370     * @var integer
139371     **/
139372    const COMPRESSED = 0;
139373
139374    /**
139375     * zlib (gzip) compression
139376     *
139377     * @var integer
139378     **/
139379    const GZ = 0;
139380
139381    /**
139382     * signature with md5 hash algorithm
139383     *
139384     * @var integer
139385     **/
139386    const MD5 = 0;
139387
139388    /**
139389     * no compression
139390     *
139391     * @var integer
139392     **/
139393    const NONE = 0;
139394
139395    /**
139396     * signature with OpenSSL public/private key pair. This is a true,
139397     * asymmetric key signature.
139398     *
139399     * @var integer
139400     **/
139401    const OPENSSL = 0;
139402
139403    /**
139404     * phar file format
139405     *
139406     * @var integer
139407     **/
139408    const PHAR = 0;
139409
139410    const PHP = 0;
139411
139412    const PHPS = 0;
139413
139414    /**
139415     * signature with sha1 hash algorithm
139416     *
139417     * @var integer
139418     **/
139419    const SHA1 = 0;
139420
139421    /**
139422     * signature with sha256 hash algorithm (requires hash extension)
139423     *
139424     * @var integer
139425     **/
139426    const SHA256 = 0;
139427
139428    /**
139429     * signature with sha512 hash algorithm (requires hash extension)
139430     *
139431     * @var integer
139432     **/
139433    const SHA512 = 0;
139434
139435    /**
139436     * tar file format
139437     *
139438     * @var integer
139439     **/
139440    const TAR = 0;
139441
139442    /**
139443     * zip file format
139444     *
139445     * @var integer
139446     **/
139447    const ZIP = 0;
139448
139449    /**
139450     * Add an empty directory to the phar archive
139451     *
139452     * With this method, an empty directory is created with path dirname.
139453     * This method is similar to {@link ZipArchive::addEmptyDir}.
139454     *
139455     * @param string $dirname The name of the empty directory to create in
139456     *   the phar archive
139457     * @return void no return value, exception is thrown on failure.
139458     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
139459     **/
139460    public function addEmptyDir($dirname){}
139461
139462    /**
139463     * Add a file from the filesystem to the tar/zip archive
139464     *
139465     * With this method, any file or URL can be added to the tar/zip archive.
139466     * If the optional second parameter localname is specified, the file will
139467     * be stored in the archive with that name, otherwise the file parameter
139468     * is used as the path to store within the archive. URLs must have a
139469     * localname or an exception is thrown. This method is similar to {@link
139470     * ZipArchive::addFile}.
139471     *
139472     * @param string $file Full or relative path to a file on disk to be
139473     *   added to the phar archive.
139474     * @param string $localname Path that the file will be stored in the
139475     *   archive.
139476     * @return void no return value, exception is thrown on failure.
139477     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
139478     **/
139479    public function addFile($file, $localname){}
139480
139481    /**
139482     * Add a file from a string to the phar archive
139483     *
139484     * With this method, any string can be added to the phar archive. The
139485     * file will be stored in the archive with localname as its path. This
139486     * method is similar to {@link ZipArchive::addFromString}.
139487     *
139488     * @param string $localname Path that the file will be stored in the
139489     *   archive.
139490     * @param string $contents The file contents to store
139491     * @return void no return value, exception is thrown on failure.
139492     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
139493     **/
139494    public function addFromString($localname, $contents){}
139495
139496    /**
139497     * Returns the api version
139498     *
139499     * Return the API version of the phar file format that will be used when
139500     * creating phars. The Phar extension supports reading API version 1.0.0
139501     * or newer. API version 1.1.0 is required for SHA-256 and SHA-512 hash,
139502     * and API version 1.1.1 is required to store empty directories.
139503     *
139504     * @return string The API version string as in 1.0.0.
139505     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
139506     **/
139507    final public static function apiVersion(){}
139508
139509    /**
139510     * Construct a tar/zip archive from the files within a directory
139511     *
139512     * Populate a tar/zip archive from directory contents. The optional
139513     * second parameter is a regular expression (pcre) that is used to
139514     * exclude files. Any filename that matches the regular expression will
139515     * be included, all others will be excluded. For more fine-grained
139516     * control, use {@link PharData::buildFromIterator}.
139517     *
139518     * @param string $base_dir The full or relative path to the directory
139519     *   that contains all files to add to the archive.
139520     * @param string $regex An optional pcre regular expression that is
139521     *   used to filter the list of files. Only file paths matching the
139522     *   regular expression will be included in the archive.
139523     * @return array {@link Phar::buildFromDirectory} returns an
139524     *   associative array mapping internal path of file to the full path of
139525     *   the file on the filesystem.
139526     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
139527     **/
139528    public function buildFromDirectory($base_dir, $regex){}
139529
139530    /**
139531     * Construct a phar archive from an iterator
139532     *
139533     * Populate a phar archive from an iterator. Two styles of iterators are
139534     * supported, iterators that map the filename within the phar to the name
139535     * of a file on disk, and iterators like DirectoryIterator that return
139536     * SplFileInfo objects. For iterators that return SplFileInfo objects,
139537     * the second parameter is required.
139538     *
139539     * @param Iterator $iter Any iterator that either associatively maps
139540     *   phar file to location or returns SplFileInfo objects
139541     * @param string $base_directory For iterators that return SplFileInfo
139542     *   objects, the portion of each file's full path to remove when adding
139543     *   to the phar archive
139544     * @return array {@link Phar::buildFromIterator} returns an associative
139545     *   array mapping internal path of file to the full path of the file on
139546     *   the filesystem.
139547     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
139548     **/
139549    public function buildFromIterator($iter, $base_directory){}
139550
139551    /**
139552     * Returns whether phar extension supports compression using either zlib
139553     * or bzip2
139554     *
139555     * This should be used to test whether compression is possible prior to
139556     * loading a phar archive containing compressed files.
139557     *
139558     * @param int $type Either Phar::GZ or Phar::BZ2 can be used to test
139559     *   whether compression is possible with a specific compression
139560     *   algorithm (zlib or bzip2).
139561     * @return bool TRUE if compression/decompression is available, FALSE
139562     *   if not.
139563     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
139564     **/
139565    final public static function canCompress($type){}
139566
139567    /**
139568     * Returns whether phar extension supports writing and creating phars
139569     *
139570     * This static method determines whether write access has been disabled
139571     * in the system php.ini via the phar.readonly ini variable.
139572     *
139573     * @return bool TRUE if write access is enabled, FALSE if it is
139574     *   disabled.
139575     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
139576     **/
139577    final public static function canWrite(){}
139578
139579    /**
139580     * Compresses the entire Phar archive using Gzip or Bzip2 compression
139581     *
139582     * For tar-based and phar-based phar archives, this method compresses the
139583     * entire archive using gzip compression or bzip2 compression. The
139584     * resulting file can be processed with the gunzip command/bunzip
139585     * command, or accessed directly and transparently with the Phar
139586     * extension.
139587     *
139588     * For Zip-based phar archives, this method fails with an exception. The
139589     * zlib extension must be enabled to compress with gzip compression, the
139590     * bzip2 extension must be enabled in order to compress with bzip2
139591     * compression. As with all functionality that modifies the contents of a
139592     * phar, the phar.readonly INI variable must be off in order to succeed.
139593     *
139594     * In addition, this method automatically renames the archive, appending
139595     * .gz, .bz2 or removing the extension if passed Phar::NONE to remove
139596     * compression. Alternatively, a file extension may be specified with the
139597     * second parameter.
139598     *
139599     * @param int $compression Compression must be one of Phar::GZ,
139600     *   Phar::BZ2 to add compression, or Phar::NONE to remove compression.
139601     * @param string $extension By default, the extension is .phar.gz or
139602     *   .phar.bz2 for compressing phar archives, and .phar.tar.gz or
139603     *   .phar.tar.bz2 for compressing tar archives. For decompressing, the
139604     *   default file extensions are .phar and .phar.tar.
139605     * @return Phar Returns a Phar object.
139606     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
139607     **/
139608    public function compress($compression, $extension){}
139609
139610    /**
139611     * Compresses all files in the current Phar archive using Bzip2
139612     * compression
139613     *
139614     * This method compresses all files in the Phar archive using bzip2
139615     * compression. The bzip2 extension must be enabled to take advantage of
139616     * this feature. In addition, if any files are already compressed using
139617     * gzip compression, the zlib extension must be enabled in order to
139618     * decompress the files prior to re-compressing with bzip2 compression.
139619     * As with all functionality that modifies the contents of a phar, the
139620     * phar.readonly INI variable must be off in order to succeed.
139621     *
139622     * @return bool
139623     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
139624     **/
139625    public function compressAllFilesBZIP2(){}
139626
139627    /**
139628     * Compresses all files in the current Phar archive using Gzip
139629     * compression
139630     *
139631     * For tar-based phar archives, this method compresses the entire archive
139632     * using gzip compression. The resulting file can be processed with the
139633     * gunzip command, or accessed directly and transparently with the Phar
139634     * extension.
139635     *
139636     * For Zip-based and phar-based phar archives, this method compresses all
139637     * files in the Phar archive using gzip compression. The zlib extension
139638     * must be enabled to take advantage of this feature. In addition, if any
139639     * files are already compressed using bzip2 compression, the bzip2
139640     * extension must be enabled in order to decompress the files prior to
139641     * re-compressing with gzip compression. As with all functionality that
139642     * modifies the contents of a phar, the phar.readonly INI variable must
139643     * be off in order to succeed.
139644     *
139645     * @return bool
139646     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
139647     **/
139648    public function compressAllFilesGZ(){}
139649
139650    /**
139651     * Compresses all files in the current Phar archive
139652     *
139653     * For tar-based phar archives, this method throws a
139654     * BadMethodCallException, as compression of individual files within a
139655     * tar archive is not supported by the file format. Use {@link
139656     * Phar::compress} to compress an entire tar-based phar archive.
139657     *
139658     * For Zip-based and phar-based phar archives, this method compresses all
139659     * files in the Phar archive using the specified compression. The zlib or
139660     * bzip2 extensions must be enabled to take advantage of this feature. In
139661     * addition, if any files are already compressed using bzip2/zlib
139662     * compression, the respective extension must be enabled in order to
139663     * decompress the files prior to re-compressing. As with all
139664     * functionality that modifies the contents of a phar, the phar.readonly
139665     * INI variable must be off in order to succeed.
139666     *
139667     * @param int $compression Compression must be one of Phar::GZ,
139668     *   Phar::BZ2 to add compression, or Phar::NONE to remove compression.
139669     * @return void
139670     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
139671     **/
139672    public function compressFiles($compression){}
139673
139674    /**
139675     * Convert a phar archive to a non-executable tar or zip file
139676     *
139677     * This method is used to convert an executable phar archive to either a
139678     * tar or zip file. To make the tar or zip non-executable, the phar stub
139679     * and phar alias files are removed from the newly created archive.
139680     *
139681     * If no changes are specified, this method throws a
139682     * BadMethodCallException if the archive is in phar file format. For
139683     * archives in tar or zip file format, this method converts the archive
139684     * to a non-executable archive.
139685     *
139686     * If successful, the method creates a new archive on disk and returns a
139687     * PharData object. The old archive is not removed from disk, and should
139688     * be done manually after the process has finished.
139689     *
139690     * @param int $format This should be one of Phar::TAR or Phar::ZIP. If
139691     *   set to NULL, the existing file format will be preserved.
139692     * @param int $compression This should be one of Phar::NONE for no
139693     *   whole-archive compression, Phar::GZ for zlib-based compression, and
139694     *   Phar::BZ2 for bzip-based compression.
139695     * @param string $extension This parameter is used to override the
139696     *   default file extension for a converted archive. Note that .phar
139697     *   cannot be used anywhere in the filename for a non-executable tar or
139698     *   zip archive. If converting to a tar-based phar archive, the default
139699     *   extensions are .tar, .tar.gz, and .tar.bz2 depending on specified
139700     *   compression. For zip-based archives, the default extension is .zip.
139701     * @return PharData The method returns a PharData object on success and
139702     *   throws an exception on failure.
139703     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
139704     **/
139705    public function convertToData($format, $compression, $extension){}
139706
139707    /**
139708     * Convert a phar archive to another executable phar archive file format
139709     *
139710     * This method is used to convert a phar archive to another file format.
139711     * For instance, it can be used to create a tar-based executable phar
139712     * archive from a zip-based executable phar archive, or from an
139713     * executable phar archive in the phar file format. In addition, it can
139714     * be used to apply whole-archive compression to a tar or phar-based
139715     * archive.
139716     *
139717     * If no changes are specified, this method throws a
139718     * BadMethodCallException.
139719     *
139720     * If successful, the method creates a new archive on disk and returns a
139721     * Phar object. The old archive is not removed from disk, and should be
139722     * done manually after the process has finished.
139723     *
139724     * @param int $format This should be one of Phar::PHAR, Phar::TAR, or
139725     *   Phar::ZIP. If set to NULL, the existing file format will be
139726     *   preserved.
139727     * @param int $compression This should be one of Phar::NONE for no
139728     *   whole-archive compression, Phar::GZ for zlib-based compression, and
139729     *   Phar::BZ2 for bzip-based compression.
139730     * @param string $extension This parameter is used to override the
139731     *   default file extension for a converted archive. Note that all zip-
139732     *   and tar-based phar archives must contain .phar in their file
139733     *   extension in order to be processed as a phar archive. If converting
139734     *   to a phar-based archive, the default extensions are .phar, .phar.gz,
139735     *   or .phar.bz2 depending on the specified compression. For tar-based
139736     *   phar archives, the default extensions are .phar.tar, .phar.tar.gz,
139737     *   and .phar.tar.bz2. For zip-based phar archives, the default
139738     *   extension is .phar.zip.
139739     * @return Phar The method returns a Phar object on success and throws
139740     *   an exception on failure.
139741     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
139742     **/
139743    public function convertToExecutable($format, $compression, $extension){}
139744
139745    /**
139746     * Copy a file internal to the phar archive to another new file within
139747     * the phar
139748     *
139749     * Copy a file internal to the phar archive to another new file within
139750     * the phar. This is an object-oriented alternative to using {@link copy}
139751     * with the phar stream wrapper.
139752     *
139753     * @param string $oldfile
139754     * @param string $newfile
139755     * @return bool returns TRUE on success, but it is safer to encase
139756     *   method call in a try/catch block and assume success if no exception
139757     *   is thrown.
139758     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
139759     **/
139760    public function copy($oldfile, $newfile){}
139761
139762    /**
139763     * Returns the number of entries (files) in the Phar archive
139764     *
139765     * @return int The number of files contained within this phar, or 0
139766     *   (the number zero) if none.
139767     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
139768     **/
139769    public function count(){}
139770
139771    /**
139772     * Create a phar-file format specific stub
139773     *
139774     * This method is intended for creation of phar-file format-specific
139775     * stubs, and is not intended for use with tar- or zip-based phar
139776     * archives.
139777     *
139778     * Phar archives contain a bootstrap loader, or stub written in PHP that
139779     * is executed when the archive is executed in PHP either via include:
139780     * <?php include 'myphar.phar'; ?> or by simple execution: php
139781     * myphar.phar
139782     *
139783     * This method provides a simple and easy method to create a stub that
139784     * will run a startup file from the phar archive. In addition, different
139785     * files can be specified for running the phar archive from the command
139786     * line versus through a web server. The loader stub also calls {@link
139787     * Phar::interceptFileFuncs} to allow easy bundling of a PHP application
139788     * that accesses the file system. If the phar extension is not present,
139789     * the loader stub will extract the phar archive to a temporary directory
139790     * and then operate on the files. A shutdown function erases the
139791     * temporary files on exit.
139792     *
139793     * @param string $indexfile
139794     * @param string $webindexfile
139795     * @return string Returns a string containing the contents of a
139796     *   customized bootstrap loader (stub) that allows the created Phar
139797     *   archive to work with or without the Phar extension enabled.
139798     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
139799     **/
139800    final public static function createDefaultStub($indexfile, $webindexfile){}
139801
139802    /**
139803     * Decompresses the entire Phar archive
139804     *
139805     * For tar-based and phar-based phar archives, this method decompresses
139806     * the entire archive.
139807     *
139808     * For Zip-based phar archives, this method fails with an exception. The
139809     * zlib extension must be enabled to decompress an archive compressed
139810     * with gzip compression, and the bzip2 extension must be enabled in
139811     * order to decompress an archive compressed with bzip2 compression. As
139812     * with all functionality that modifies the contents of a phar, the
139813     * phar.readonly INI variable must be off in order to succeed.
139814     *
139815     * In addition, this method automatically changes the file extension of
139816     * the archive, .phar by default for phar archives, or .phar.tar for
139817     * tar-based phar archives. Alternatively, a file extension may be
139818     * specified with the second parameter.
139819     *
139820     * @param string $extension For decompressing, the default file
139821     *   extensions are .phar and .phar.tar. Use this parameter to specify
139822     *   another file extension. Be aware that all executable phar archives
139823     *   must contain .phar in their filename.
139824     * @return Phar A Phar object is returned.
139825     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
139826     **/
139827    public function decompress($extension){}
139828
139829    /**
139830     * Decompresses all files in the current Phar archive
139831     *
139832     * For tar-based phar archives, this method throws a
139833     * BadMethodCallException, as compression of individual files within a
139834     * tar archive is not supported by the file format. Use {@link
139835     * Phar::compress} to compress an entire tar-based phar archive.
139836     *
139837     * For Zip-based and phar-based phar archives, this method decompresses
139838     * all files in the Phar archive. The zlib or bzip2 extensions must be
139839     * enabled to take advantage of this feature if any files are compressed
139840     * using bzip2/zlib compression. As with all functionality that modifies
139841     * the contents of a phar, the phar.readonly INI variable must be off in
139842     * order to succeed.
139843     *
139844     * @return bool
139845     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
139846     **/
139847    public function decompressFiles(){}
139848
139849    /**
139850     * Delete a file within a phar archive
139851     *
139852     * Delete a file within an archive. This is the functional equivalent of
139853     * calling {@link unlink} on the stream wrapper equivalent, as shown in
139854     * the example below.
139855     *
139856     * @param string $entry Path within an archive to the file to delete.
139857     * @return bool returns TRUE on success, but it is better to check for
139858     *   thrown exception, and assume success if none is thrown.
139859     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
139860     **/
139861    public function delete($entry){}
139862
139863    /**
139864     * Deletes the global metadata of the phar
139865     *
139866     * @return bool returns TRUE on success, but it is better to check for
139867     *   thrown exception, and assume success if none is thrown.
139868     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.2.0
139869     **/
139870    public function delMetadata(){}
139871
139872    /**
139873     * Extract the contents of a phar archive to a directory
139874     *
139875     * Extract all files within a phar archive to disk. Extracted files and
139876     * directories preserve permissions as stored in the archive. The
139877     * optional parameters allow optional control over which files are
139878     * extracted, and whether existing files on disk can be overwritten. The
139879     * second parameter {@link files} can be either the name of a file or
139880     * directory to extract, or an array of names of files and directories to
139881     * extract. By default, this method will not overwrite existing files,
139882     * the third parameter can be set to true to enable overwriting of files.
139883     * This method is similar to {@link ZipArchive::extractTo}.
139884     *
139885     * @param string $pathto Path to extract the given {@link files} to
139886     * @param string|array $files The name of a file or directory to
139887     *   extract, or an array of files/directories to extract, NULL to skip
139888     *   this param
139889     * @param bool $overwrite Set to TRUE to enable overwriting existing
139890     *   files
139891     * @return bool returns TRUE on success, but it is better to check for
139892     *   thrown exception, and assume success if none is thrown.
139893     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
139894     **/
139895    public function extractTo($pathto, $files, $overwrite){}
139896
139897    /**
139898     * Get the alias for Phar
139899     *
139900     * @return string Returns the alias or NULL if there's no alias.
139901     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.2.1
139902     **/
139903    public function getAlias(){}
139904
139905    /**
139906     * Returns phar archive meta-data
139907     *
139908     * Retrieve archive meta-data. Meta-data can be any PHP variable that can
139909     * be serialized.
139910     *
139911     * @return mixed any PHP variable that can be serialized and is stored
139912     *   as meta-data for the Phar archive, or NULL if no meta-data is
139913     *   stored.
139914     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
139915     **/
139916    public function getMetadata(){}
139917
139918    /**
139919     * Return whether phar was modified
139920     *
139921     * This method can be used to determine whether a phar has either had an
139922     * internal file deleted, or contents of a file changed in some way.
139923     *
139924     * @return bool TRUE if the phar has been modified since opened, FALSE
139925     *   if not.
139926     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
139927     **/
139928    public function getModified(){}
139929
139930    /**
139931     * Get the real path to the Phar archive on disk
139932     *
139933     * @return string
139934     * @since PHP 5 >= 5.3.0, PHP 7
139935     **/
139936    public function getPath(){}
139937
139938    /**
139939     * Return MD5/SHA1/SHA256/SHA512/OpenSSL signature of a Phar archive
139940     *
139941     * Returns the verification signature of a phar archive in a hexadecimal
139942     * string.
139943     *
139944     * @return array Array with the opened archive's signature in hash key
139945     *   and MD5, SHA-1, SHA-256, SHA-512, or OpenSSL in hash_type. This
139946     *   signature is a hash calculated on the entire phar's contents, and
139947     *   may be used to verify the integrity of the archive. A valid
139948     *   signature is absolutely required of all executable phar archives if
139949     *   the phar.require_hash INI variable is set to true.
139950     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
139951     **/
139952    public function getSignature(){}
139953
139954    /**
139955     * Return the PHP loader or bootstrap stub of a Phar archive
139956     *
139957     * Phar archives contain a bootstrap loader, or stub written in PHP that
139958     * is executed when the archive is executed in PHP either via include:
139959     * <?php include 'myphar.phar'; ?> or by simple execution: php
139960     * myphar.phar
139961     *
139962     * @return string Returns a string containing the contents of the
139963     *   bootstrap loader (stub) of the current Phar archive.
139964     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
139965     **/
139966    public function getStub(){}
139967
139968    /**
139969     * Return array of supported compression algorithms
139970     *
139971     * @return array Returns an array containing any of Phar::GZ or
139972     *   Phar::BZ2, depending on the availability of the zlib extension or
139973     *   the bz2 extension.
139974     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.2.0
139975     **/
139976    final public static function getSupportedCompression(){}
139977
139978    /**
139979     * Return array of supported signature types
139980     *
139981     * @return array Returns an array containing any of MD5, SHA-1,
139982     *   SHA-256, SHA-512, or OpenSSL.
139983     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.1.0
139984     **/
139985    final public static function getSupportedSignatures(){}
139986
139987    /**
139988     * Return version info of Phar archive
139989     *
139990     * Returns the API version of an opened Phar archive.
139991     *
139992     * @return string The opened archive's API version. This is not to be
139993     *   confused with the API version that the loaded phar extension will
139994     *   use to create new phars. Each Phar archive has the API version
139995     *   hard-coded into its manifest. See Phar file format documentation for
139996     *   more information.
139997     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
139998     **/
139999    public function getVersion(){}
140000
140001    /**
140002     * Returns whether phar has global meta-data
140003     *
140004     * Returns whether phar has global meta-data set.
140005     *
140006     * @return bool Returns TRUE if meta-data has been set, and FALSE if
140007     *   not.
140008     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.2.0
140009     **/
140010    public function hasMetadata(){}
140011
140012    /**
140013     * Instructs phar to intercept fopen, file_get_contents, opendir, and all
140014     * of the stat-related functions
140015     *
140016     * instructs phar to intercept {@link fopen}, {@link readfile}, {@link
140017     * file_get_contents}, {@link opendir}, and all of the stat-related
140018     * functions. If any of these functions is called from within a phar
140019     * archive with a relative path, the call is modified to access a file
140020     * within the phar archive. Absolute paths are assumed to be attempts to
140021     * load external files from the filesystem.
140022     *
140023     * This function makes it possible to run PHP applications designed to
140024     * run off of a hard disk as a phar application.
140025     *
140026     * @return void
140027     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140028     **/
140029    final public static function interceptFileFuncs(){}
140030
140031    /**
140032     * Used to determine whether Phar write operations are being buffered, or
140033     * are flushing directly to disk
140034     *
140035     * This method can be used to determine whether a Phar will save changes
140036     * to disk immediately, or whether a call to {@link Phar::stopBuffering}
140037     * is needed to enable saving changes.
140038     *
140039     * Phar write buffering is per-archive, buffering active for the foo.phar
140040     * Phar archive does not affect changes to the bar.phar Phar archive.
140041     *
140042     * @return bool Returns TRUE if the write operations are being buffer,
140043     *   FALSE otherwise.
140044     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
140045     **/
140046    public function isBuffering(){}
140047
140048    /**
140049     * Returns Phar::GZ or PHAR::BZ2 if the entire phar archive is compressed
140050     * (.tar.gz/tar.bz and so on)
140051     *
140052     * Returns Phar::GZ or PHAR::BZ2 if the entire phar archive is compressed
140053     * (.tar.gz/tar.bz and so on). Zip-based phar archives cannot be
140054     * compressed as a file, and so this method will always return FALSE if a
140055     * zip-based phar archive is queried.
140056     *
140057     * @return mixed Phar::GZ, Phar::BZ2 or FALSE
140058     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140059     **/
140060    public function isCompressed(){}
140061
140062    /**
140063     * Returns true if the phar archive is based on the tar/phar/zip file
140064     * format depending on the parameter
140065     *
140066     * @param int $format Either Phar::PHAR, Phar::TAR, or Phar::ZIP to
140067     *   test for the format of the archive.
140068     * @return bool Returns TRUE if the phar archive matches the file
140069     *   format requested by the parameter
140070     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140071     **/
140072    public function isFileFormat($format){}
140073
140074    /**
140075     * Returns whether the given filename is a valid phar filename
140076     *
140077     * Returns whether the given filename is a valid phar filename that will
140078     * be recognized as a phar archive by the phar extension. This can be
140079     * used to test a name without having to instantiate a phar archive and
140080     * catch the inevitable Exception that will be thrown if an invalid name
140081     * is specified.
140082     *
140083     * @param string $filename The name or full path to a phar archive not
140084     *   yet created
140085     * @param bool $executable This parameter determines whether the
140086     *   filename should be treated as a phar executable archive, or a data
140087     *   non-executable archive
140088     * @return bool Returns TRUE if the filename is valid, FALSE if not.
140089     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.2.0
140090     **/
140091    final public static function isValidPharFilename($filename, $executable){}
140092
140093    /**
140094     * Returns true if the phar archive can be modified
140095     *
140096     * This method returns TRUE if phar.readonly is 0, and the actual phar
140097     * archive on disk is not read-only.
140098     *
140099     * @return bool Returns TRUE if the phar archive can be modified
140100     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140101     **/
140102    public function isWritable(){}
140103
140104    /**
140105     * Loads any phar archive with an alias
140106     *
140107     * This can be used to read the contents of an external Phar archive.
140108     * This is most useful for assigning an alias to a phar so that
140109     * subsequent references to the phar can use the shorter alias, or for
140110     * loading Phar archives that only contain data and are not intended for
140111     * execution/inclusion in PHP scripts.
140112     *
140113     * @param string $filename the full or relative path to the phar
140114     *   archive to open
140115     * @param string $alias The alias that may be used to refer to the phar
140116     *   archive. Note that many phar archives specify an explicit alias
140117     *   inside the phar archive, and a PharException will be thrown if a new
140118     *   alias is specified in this case.
140119     * @return bool
140120     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
140121     **/
140122    final public static function loadPhar($filename, $alias){}
140123
140124    /**
140125     * Reads the currently executed file (a phar) and registers its manifest
140126     *
140127     * This static method can only be used inside a Phar archive's loader
140128     * stub in order to initialize the phar when it is directly executed, or
140129     * when it is included in another script.
140130     *
140131     * @param string $alias The alias that can be used in phar:// URLs to
140132     *   refer to this archive, rather than its full path.
140133     * @param int $dataoffset Unused variable, here for compatibility with
140134     *   PEAR's PHP_Archive.
140135     * @return bool
140136     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
140137     **/
140138    final public static function mapPhar($alias, $dataoffset){}
140139
140140    /**
140141     * Mount an external path or file to a virtual location within the phar
140142     * archive
140143     *
140144     * Much like the unix file system concept of mounting external devices to
140145     * paths within the directory tree, {@link Phar::mount} allows referring
140146     * to external files and directories as if they were inside of an
140147     * archive. This allows powerful abstraction such as referring to
140148     * external configuration files as if they were inside the archive.
140149     *
140150     * @param string $pharpath The internal path within the phar archive to
140151     *   use as the mounted path location. This must be a relative path
140152     *   within the phar archive, and must not already exist.
140153     * @param string $externalpath A path or URL to an external file or
140154     *   directory to mount within the phar archive
140155     * @return void No return. PharException is thrown on failure.
140156     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140157     **/
140158    final public static function mount($pharpath, $externalpath){}
140159
140160    /**
140161     * Defines a list of up to 4 $_SERVER variables that should be modified
140162     * for execution
140163     *
140164     * {@link Phar::mungServer} should only be called within the stub of a
140165     * phar archive.
140166     *
140167     * Defines a list of up to 4 $_SERVER variables that should be modified
140168     * for execution. Variables that can be modified to remove traces of phar
140169     * execution are REQUEST_URI, PHP_SELF, SCRIPT_NAME and SCRIPT_FILENAME.
140170     *
140171     * On its own, this method does nothing. Only when combined with {@link
140172     * Phar::webPhar} does it take effect, and only when the requested file
140173     * is a PHP file to be parsed. Note that the PATH_INFO and
140174     * PATH_TRANSLATED variables are always modified.
140175     *
140176     * The original values of variables that are modified are stored in the
140177     * SERVER array with PHAR_ prepended, so for instance SCRIPT_NAME would
140178     * be saved as PHAR_SCRIPT_NAME.
140179     *
140180     * @param array $munglist an array containing as string indices any of
140181     *   REQUEST_URI, PHP_SELF, SCRIPT_NAME and SCRIPT_FILENAME. Other values
140182     *   trigger an exception, and {@link Phar::mungServer} is
140183     *   case-sensitive.
140184     * @return void No return.
140185     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140186     **/
140187    final public static function mungServer($munglist){}
140188
140189    /**
140190     * Determines whether a file exists in the phar
140191     *
140192     * This is an implementation of the ArrayAccess interface allowing direct
140193     * manipulation of the contents of a Phar archive using array access
140194     * brackets.
140195     *
140196     * offsetExists() is called whenever {@link isset} is called.
140197     *
140198     * @param string $offset The filename (relative path) to look for in a
140199     *   Phar.
140200     * @return bool Returns TRUE if the file exists within the phar, or
140201     *   FALSE if not.
140202     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
140203     **/
140204    public function offsetExists($offset){}
140205
140206    /**
140207     * Gets a object for a specific file
140208     *
140209     * This is an implementation of the ArrayAccess interface allowing direct
140210     * manipulation of the contents of a Phar archive using array access
140211     * brackets. Phar::offsetGet is used for retrieving files from a Phar
140212     * archive.
140213     *
140214     * @param string $offset The filename (relative path) to look for in a
140215     *   Phar.
140216     * @return PharFileInfo A PharFileInfo object is returned that can be
140217     *   used to iterate over a file's contents or to retrieve information
140218     *   about the current file.
140219     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
140220     **/
140221    public function offsetGet($offset){}
140222
140223    /**
140224     * Set the contents of an internal file to those of an external file
140225     *
140226     * This is an implementation of the ArrayAccess interface allowing direct
140227     * manipulation of the contents of a Phar archive using array access
140228     * brackets. offsetSet is used for modifying an existing file, or adding
140229     * a new file to a Phar archive.
140230     *
140231     * @param string $offset The filename (relative path) to modify in a
140232     *   Phar.
140233     * @param string $value Content of the file.
140234     * @return void No return values.
140235     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
140236     **/
140237    public function offsetSet($offset, $value){}
140238
140239    /**
140240     * Remove a file from a phar
140241     *
140242     * This is an implementation of the ArrayAccess interface allowing direct
140243     * manipulation of the contents of a Phar archive using array access
140244     * brackets. offsetUnset is used for deleting an existing file, and is
140245     * called by the {@link unset} language construct.
140246     *
140247     * @param string $offset The filename (relative path) to modify in a
140248     *   Phar.
140249     * @return bool
140250     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
140251     **/
140252    public function offsetUnset($offset){}
140253
140254    /**
140255     * Returns the full path on disk or full phar URL to the currently
140256     * executing Phar archive
140257     *
140258     * Returns the full path to the running phar archive. This is intended
140259     * for use much like the __FILE__ magic constant, and only has effect
140260     * inside an executing phar archive.
140261     *
140262     * Inside the stub of an archive, {@link Phar::running} returns . Simply
140263     * use __FILE__ to access the current running phar inside a stub.
140264     *
140265     * @param bool $retphar If FALSE, the full path on disk to the phar
140266     *   archive is returned. If TRUE, a full phar URL is returned.
140267     * @return string Returns the filename if valid, empty string
140268     *   otherwise.
140269     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140270     **/
140271    final public static function running($retphar){}
140272
140273    /**
140274     * Set the alias for the Phar archive
140275     *
140276     * Set the alias for the Phar archive, and write it as the permanent
140277     * alias for this phar archive. An alias can be used internally to a phar
140278     * archive to ensure that use of the phar stream wrapper to access
140279     * internal files always works regardless of the location of the phar
140280     * archive on the filesystem. Another alternative is to rely upon Phar's
140281     * interception of {@link include} or to use {@link
140282     * Phar::interceptFileFuncs} and use relative paths.
140283     *
140284     * @param string $alias A shorthand string that this archive can be
140285     *   referred to in phar stream wrapper access.
140286     * @return bool
140287     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.2.1
140288     **/
140289    public function setAlias($alias){}
140290
140291    /**
140292     * Used to set the PHP loader or bootstrap stub of a Phar archive to the
140293     * default loader
140294     *
140295     * This method is a convenience method that combines the functionality of
140296     * {@link Phar::createDefaultStub} and {@link Phar::setStub}.
140297     *
140298     * @param string $index Relative path within the phar archive to run if
140299     *   accessed on the command-line
140300     * @param string $webindex Relative path within the phar archive to run
140301     *   if accessed through a web browser
140302     * @return bool
140303     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140304     **/
140305    public function setDefaultStub($index, $webindex){}
140306
140307    /**
140308     * Sets phar archive meta-data
140309     *
140310     * {@link Phar::setMetadata} should be used to store customized data that
140311     * describes something about the phar archive as a complete entity.
140312     * {@link PharFileInfo::setMetadata} should be used for file-specific
140313     * meta-data. Meta-data can slow down the performance of loading a phar
140314     * archive if the data is large.
140315     *
140316     * Some possible uses for meta-data include specifying which file within
140317     * the archive should be used to bootstrap the archive, or the location
140318     * of a file manifest like PEAR's package.xml file. However, any useful
140319     * data that describes the phar archive may be stored.
140320     *
140321     * @param mixed $metadata Any PHP variable containing information to
140322     *   store that describes the phar archive
140323     * @return void
140324     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
140325     **/
140326    public function setMetadata($metadata){}
140327
140328    /**
140329     * Set the signature algorithm for a phar and apply it
140330     *
140331     * Set the signature algorithm for a phar and apply it. The signature
140332     * algorithm must be one of Phar::MD5, Phar::SHA1, Phar::SHA256,
140333     * Phar::SHA512, or Phar::PGP (pgp not yet supported and falls back to
140334     * SHA-1).
140335     *
140336     * @param int $sigtype One of Phar::MD5, Phar::SHA1, Phar::SHA256,
140337     *   Phar::SHA512, or Phar::PGP
140338     * @return void
140339     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.1.0
140340     **/
140341    public function setSignatureAlgorithm($sigtype){}
140342
140343    /**
140344     * Used to set the PHP loader or bootstrap stub of a Phar archive
140345     *
140346     * This method is used to add a PHP bootstrap loader stub to a new Phar
140347     * archive, or to replace the loader stub in an existing Phar archive.
140348     *
140349     * The loader stub for a Phar archive is used whenever an archive is
140350     * included directly as in this example:
140351     *
140352     * The loader is not accessed when including a file through the phar
140353     * stream wrapper like so:
140354     *
140355     * @param string $stub A string or an open stream handle to use as the
140356     *   executable stub for this phar archive.
140357     * @param int $len
140358     * @return bool
140359     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
140360     **/
140361    public function setStub($stub, $len){}
140362
140363    /**
140364     * Start buffering Phar write operations, do not modify the Phar object
140365     * on disk
140366     *
140367     * Although technically unnecessary, the {@link Phar::startBuffering}
140368     * method can provide a significant performance boost when creating or
140369     * modifying a Phar archive with a large number of files. Ordinarily,
140370     * every time a file within a Phar archive is created or modified in any
140371     * way, the entire Phar archive will be recreated with the changes. In
140372     * this way, the archive will be up-to-date with the activity performed
140373     * on it.
140374     *
140375     * However, this can be unnecessary when simply creating a new Phar
140376     * archive, when it would make more sense to write the entire archive out
140377     * at once. Similarly, it is often necessary to make a series of changes
140378     * and to ensure that they all are possible before making any changes on
140379     * disk, similar to the relational database concept of transactions. the
140380     * {@link Phar::startBuffering}/{@link Phar::stopBuffering} pair of
140381     * methods is provided for this purpose.
140382     *
140383     * Phar write buffering is per-archive, buffering active for the foo.phar
140384     * Phar archive does not affect changes to the bar.phar Phar archive.
140385     *
140386     * @return void
140387     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
140388     **/
140389    public function startBuffering(){}
140390
140391    /**
140392     * Stop buffering write requests to the Phar archive, and save changes to
140393     * disk
140394     *
140395     * {@link Phar::stopBuffering} is used in conjunction with the {@link
140396     * Phar::startBuffering} method. {@link Phar::startBuffering} can provide
140397     * a significant performance boost when creating or modifying a Phar
140398     * archive with a large number of files. Ordinarily, every time a file
140399     * within a Phar archive is created or modified in any way, the entire
140400     * Phar archive will be recreated with the changes. In this way, the
140401     * archive will be up-to-date with the activity performed on it.
140402     *
140403     * However, this can be unnecessary when simply creating a new Phar
140404     * archive, when it would make more sense to write the entire archive out
140405     * at once. Similarly, it is often necessary to make a series of changes
140406     * and to ensure that they all are possible before making any changes on
140407     * disk, similar to the relational database concept of transactions. The
140408     * {@link Phar::startBuffering}/{@link Phar::stopBuffering} pair of
140409     * methods is provided for this purpose.
140410     *
140411     * Phar write buffering is per-archive, buffering active for the foo.phar
140412     * Phar archive does not affect changes to the bar.phar Phar archive.
140413     *
140414     * @return void
140415     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
140416     **/
140417    public function stopBuffering(){}
140418
140419    /**
140420     * Uncompresses all files in the current Phar archive
140421     *
140422     * This method decompresses all files in the Phar archive. If any files
140423     * are already compressed using gzip compression, the zlib extension must
140424     * be enabled in order to decompress the files, and any files compressed
140425     * using bzip2 compression require the bzip2 extension to decompress the
140426     * files. As with all functionality that modifies the contents of a phar,
140427     * the phar.readonly INI variable must be off in order to succeed.
140428     *
140429     * @return bool
140430     * @since PECL phar < 2.0.0
140431     **/
140432    public function uncompressAllFiles(){}
140433
140434    /**
140435     * Completely remove a phar archive from disk and from memory
140436     *
140437     * Removes a phar archive from disk and memory.
140438     *
140439     * @param string $archive The path on disk to the phar archive.
140440     * @return bool
140441     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140442     **/
140443    final public static function unlinkArchive($archive){}
140444
140445    /**
140446     * mapPhar for web-based phars. front controller for web applications
140447     *
140448     * {@link Phar::mapPhar} for web-based phars. This method parses
140449     * $_SERVER['REQUEST_URI'] and routes a request from a web browser to an
140450     * internal file within the phar archive. In essence, it simulates a web
140451     * server, routing requests to the correct file, echoing the correct
140452     * headers and parsing PHP files as needed. This powerful method is part
140453     * of what makes it easy to convert an existing PHP application into a
140454     * phar archive. Combined with {@link Phar::mungServer} and {@link
140455     * Phar::interceptFileFuncs}, any web application can be used unmodified
140456     * from a phar archive.
140457     *
140458     * {@link Phar::webPhar} should only be called from the stub of a phar
140459     * archive (see here for more information on what a stub is).
140460     *
140461     * @param string $alias The alias that can be used in phar:// URLs to
140462     *   refer to this archive, rather than its full path.
140463     * @param string $index The location within the phar of the directory
140464     *   index.
140465     * @param string $f404 The location of the script to run when a file is
140466     *   not found. This script should output the proper HTTP 404 headers.
140467     * @param array $mimetypes An array mapping additional file extensions
140468     *   to MIME type. If the default mapping is sufficient, pass an empty
140469     *   array. By default, these extensions are mapped to these MIME types:
140470     *   <?php $mimes = array( 'phps' => Phar::PHPS, // pass to
140471     *   highlight_file() 'c' => 'text/plain', 'cc' => 'text/plain', 'cpp' =>
140472     *   'text/plain', 'c++' => 'text/plain', 'dtd' => 'text/plain', 'h' =>
140473     *   'text/plain', 'log' => 'text/plain', 'rng' => 'text/plain', 'txt' =>
140474     *   'text/plain', 'xsd' => 'text/plain', 'php' => Phar::PHP, // parse as
140475     *   PHP 'inc' => Phar::PHP, // parse as PHP 'avi' => 'video/avi', 'bmp'
140476     *   => 'image/bmp', 'css' => 'text/css', 'gif' => 'image/gif', 'htm' =>
140477     *   'text/html', 'html' => 'text/html', 'htmls' => 'text/html', 'ico' =>
140478     *   'image/x-ico', 'jpe' => 'image/jpeg', 'jpg' => 'image/jpeg', 'jpeg'
140479     *   => 'image/jpeg', 'js' => 'application/x-javascript', 'midi' =>
140480     *   'audio/midi', 'mid' => 'audio/midi', 'mod' => 'audio/mod', 'mov' =>
140481     *   'movie/quicktime', 'mp3' => 'audio/mp3', 'mpg' => 'video/mpeg',
140482     *   'mpeg' => 'video/mpeg', 'pdf' => 'application/pdf', 'png' =>
140483     *   'image/png', 'swf' => 'application/shockwave-flash', 'tif' =>
140484     *   'image/tiff', 'tiff' => 'image/tiff', 'wav' => 'audio/wav', 'xbm' =>
140485     *   'image/xbm', 'xml' => 'text/xml', ); ?>
140486     * @param callable $rewrites The rewrites function is passed a string
140487     *   as its only parameter and must return a string or FALSE. If you are
140488     *   using fast-cgi or cgi then the parameter passed to the function is
140489     *   the value of the $_SERVER['PATH_INFO'] variable. Otherwise, the
140490     *   parameter passed to the function is the value of the
140491     *   $_SERVER['REQUEST_URI'] variable. If a string is returned it is used
140492     *   as the internal file path. If FALSE is returned then webPhar() will
140493     *   send a HTTP 403 Denied Code.
140494     * @return void
140495     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140496     **/
140497    final public static function webPhar($alias, $index, $f404, $mimetypes, $rewrites){}
140498
140499    /**
140500     * Construct a Phar archive object
140501     *
140502     * @param string $fname Path to an existing Phar archive or
140503     *   to-be-created archive. The file name's extension must contain .phar.
140504     * @param int $flags Flags to pass to parent class
140505     *   RecursiveDirectoryIterator.
140506     * @param string $alias Alias with which this Phar archive should be
140507     *   referred to in calls to stream functionality.
140508     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
140509     **/
140510    public function __construct($fname, $flags, $alias){}
140511
140512}
140513/**
140514 * The PharData class provides a high-level interface to accessing and
140515 * creating non-executable tar and zip archives. Because these archives
140516 * do not contain a stub and cannot be executed by the phar extension, it
140517 * is possible to create and manipulate regular zip and tar files using
140518 * the PharData class even if phar.readonly php.ini setting is 1.
140519 **/
140520class PharData extends RecursiveDirectoryIterator {
140521    /**
140522     * Add an empty directory to the tar/zip archive
140523     *
140524     * With this method, an empty directory is created with path dirname.
140525     * This method is similar to {@link ZipArchive::addEmptyDir}.
140526     *
140527     * @param string $dirname The name of the empty directory to create in
140528     *   the phar archive
140529     * @return void no return value, exception is thrown on failure.
140530     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140531     **/
140532    function addEmptyDir($dirname){}
140533
140534    /**
140535     * Add a file from the filesystem to the tar/zip archive
140536     *
140537     * With this method, any string can be added to the tar/zip archive. The
140538     * file will be stored in the archive with localname as its path. This
140539     * method is similar to {@link ZipArchive::addFromString}.
140540     *
140541     * @param string $localname Path that the file will be stored in the
140542     *   archive.
140543     * @param string $contents The file contents to store
140544     * @return void no return value, exception is thrown on failure.
140545     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140546     **/
140547    function addFromString($localname, $contents){}
140548
140549    /**
140550     * Construct a tar or zip archive from an iterator
140551     *
140552     * Populate a tar or zip archive from an iterator. Two styles of
140553     * iterators are supported, iterators that map the filename within the
140554     * tar/zip to the name of a file on disk, and iterators like
140555     * DirectoryIterator that return SplFileInfo objects. For iterators that
140556     * return SplFileInfo objects, the second parameter is required.
140557     *
140558     * @param Iterator $iter Any iterator that either associatively maps
140559     *   tar/zip file to location or returns SplFileInfo objects
140560     * @param string $base_directory For iterators that return SplFileInfo
140561     *   objects, the portion of each file's full path to remove when adding
140562     *   to the tar/zip archive
140563     * @return array {@link PharData::buildFromIterator} returns an
140564     *   associative array mapping internal path of file to the full path of
140565     *   the file on the filesystem.
140566     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140567     **/
140568    function buildFromIterator($iter, $base_directory){}
140569
140570    /**
140571     * Compresses the entire tar/zip archive using Gzip or Bzip2 compression
140572     *
140573     * For tar archives, this method compresses the entire archive using gzip
140574     * compression or bzip2 compression. The resulting file can be processed
140575     * with the gunzip command/bunzip command, or accessed directly and
140576     * transparently with the Phar extension.
140577     *
140578     * For zip archives, this method fails with an exception. The zlib
140579     * extension must be enabled to compress with gzip compression, the bzip2
140580     * extension must be enabled in order to compress with bzip2 compression.
140581     *
140582     * In addition, this method automatically renames the archive, appending
140583     * .gz, .bz2 or removing the extension if passed Phar::NONE to remove
140584     * compression. Alternatively, a file extension may be specified with the
140585     * second parameter.
140586     *
140587     * @param int $compression Compression must be one of Phar::GZ,
140588     *   Phar::BZ2 to add compression, or Phar::NONE to remove compression.
140589     * @param string $extension By default, the extension is .tar.gz or
140590     *   .tar.bz2 for compressing a tar, and .tar for decompressing.
140591     * @return PharData A PharData object is returned.
140592     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140593     **/
140594    function compress($compression, $extension){}
140595
140596    /**
140597     * Compresses all files in the current tar/zip archive
140598     *
140599     * For tar-based archives, this method throws a BadMethodCallException,
140600     * as compression of individual files within a tar archive is not
140601     * supported by the file format. Use {@link PharData::compress} to
140602     * compress an entire tar-based archive.
140603     *
140604     * For Zip-based archives, this method compresses all files in the
140605     * archive using the specified compression. The zlib or bzip2 extensions
140606     * must be enabled to take advantage of this feature. In addition, if any
140607     * files are already compressed using bzip2/zlib compression, the
140608     * respective extension must be enabled in order to decompress the files
140609     * prior to re-compressing.
140610     *
140611     * @param int $compression Compression must be one of Phar::GZ,
140612     *   Phar::BZ2 to add compression, or Phar::NONE to remove compression.
140613     * @return void
140614     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140615     **/
140616    function compressFiles($compression){}
140617
140618    /**
140619     * Convert a phar archive to a non-executable tar or zip file
140620     *
140621     * This method is used to convert a non-executable tar or zip archive to
140622     * another non-executable format.
140623     *
140624     * If no changes are specified, this method throws a
140625     * BadMethodCallException. This method should be used to convert a tar
140626     * archive to zip format or vice-versa. Although it is possible to simply
140627     * change the compression of a tar archive using this method, it is
140628     * better to use the {@link PharData::compress} method for logical
140629     * consistency.
140630     *
140631     * If successful, the method creates a new archive on disk and returns a
140632     * PharData object. The old archive is not removed from disk, and should
140633     * be done manually after the process has finished.
140634     *
140635     * @param int $format This should be one of Phar::TAR or Phar::ZIP. If
140636     *   set to NULL, the existing file format will be preserved.
140637     * @param int $compression This should be one of Phar::NONE for no
140638     *   whole-archive compression, Phar::GZ for zlib-based compression, and
140639     *   Phar::BZ2 for bzip-based compression.
140640     * @param string $extension This parameter is used to override the
140641     *   default file extension for a converted archive. Note that .phar
140642     *   cannot be used anywhere in the filename for a non-executable tar or
140643     *   zip archive. If converting to a tar-based phar archive, the default
140644     *   extensions are .tar, .tar.gz, and .tar.bz2 depending on specified
140645     *   compression. For zip-based archives, the default extension is .zip.
140646     * @return PharData The method returns a PharData object on success and
140647     *   throws an exception on failure.
140648     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140649     **/
140650    function convertToData($format, $compression, $extension){}
140651
140652    /**
140653     * Convert a non-executable tar/zip archive to an executable phar archive
140654     *
140655     * This method is used to convert a non-executable tar or zip archive to
140656     * an executable phar archive. Any of the three executable file formats
140657     * (phar, tar or zip) can be used, and whole-archive compression can also
140658     * be performed.
140659     *
140660     * If no changes are specified, this method throws a
140661     * BadMethodCallException.
140662     *
140663     * If successful, the method creates a new archive on disk and returns a
140664     * Phar object. The old archive is not removed from disk, and should be
140665     * done manually after the process has finished.
140666     *
140667     * @param int $format This should be one of Phar::PHAR, Phar::TAR, or
140668     *   Phar::ZIP. If set to NULL, the existing file format will be
140669     *   preserved.
140670     * @param int $compression This should be one of Phar::NONE for no
140671     *   whole-archive compression, Phar::GZ for zlib-based compression, and
140672     *   Phar::BZ2 for bzip-based compression.
140673     * @param string $extension This parameter is used to override the
140674     *   default file extension for a converted archive. Note that all zip-
140675     *   and tar-based phar archives must contain .phar in their file
140676     *   extension in order to be processed as a phar archive. If converting
140677     *   to a phar-based archive, the default extensions are .phar, .phar.gz,
140678     *   or .phar.bz2 depending on the specified compression. For tar-based
140679     *   phar archives, the default extensions are .phar.tar, .phar.tar.gz,
140680     *   and .phar.tar.bz2. For zip-based phar archives, the default
140681     *   extension is .phar.zip.
140682     * @return Phar The method returns a Phar object on success and throws
140683     *   an exception on failure.
140684     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140685     **/
140686    function convertToExecutable($format, $compression, $extension){}
140687
140688    /**
140689     * Copy a file internal to the phar archive to another new file within
140690     * the phar
140691     *
140692     * Copy a file internal to the tar/zip archive to another new file within
140693     * the same archive. This is an object-oriented alternative to using
140694     * {@link copy} with the phar stream wrapper.
140695     *
140696     * @param string $oldfile
140697     * @param string $newfile
140698     * @return bool returns TRUE on success, but it is safer to encase
140699     *   method call in a try/catch block and assume success if no exception
140700     *   is thrown.
140701     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140702     **/
140703    function copy($oldfile, $newfile){}
140704
140705    /**
140706     * Decompresses the entire Phar archive
140707     *
140708     * For tar-based archives, this method decompresses the entire archive.
140709     *
140710     * For Zip-based archives, this method fails with an exception. The zlib
140711     * extension must be enabled to decompress an archive compressed with
140712     * gzip compression, and the bzip2 extension must be enabled in order to
140713     * decompress an archive compressed with bzip2 compression.
140714     *
140715     * In addition, this method automatically renames the file extension of
140716     * the archive, .tar by default. Alternatively, a file extension may be
140717     * specified with the {@link extension} parameter.
140718     *
140719     * @param string $extension For decompressing, the default file
140720     *   extension is .tar. Use this parameter to specify another file
140721     *   extension. Be aware that only executable archives can contain .phar
140722     *   in their filename.
140723     * @return PharData A PharData object is returned.
140724     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140725     **/
140726    function decompress($extension){}
140727
140728    /**
140729     * Decompresses all files in the current zip archive
140730     *
140731     * For tar-based archives, this method throws a BadMethodCallException,
140732     * as compression of individual files within a tar archive is not
140733     * supported by the file format. Use {@link PharData::compress} to
140734     * compress an entire tar-based archive.
140735     *
140736     * For Zip-based archives, this method decompresses all files in the
140737     * archive. The zlib or bzip2 extensions must be enabled to take
140738     * advantage of this feature if any files are compressed using bzip2/zlib
140739     * compression.
140740     *
140741     * @return bool
140742     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140743     **/
140744    function decompressFiles(){}
140745
140746    /**
140747     * Delete a file within a tar/zip archive
140748     *
140749     * Delete a file within an archive. This is the functional equivalent of
140750     * calling {@link unlink} on the stream wrapper equivalent, as shown in
140751     * the example below.
140752     *
140753     * @param string $entry Path within an archive to the file to delete.
140754     * @return bool returns TRUE on success, but it is better to check for
140755     *   thrown exception, and assume success if none is thrown.
140756     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140757     **/
140758    function delete($entry){}
140759
140760    /**
140761     * Deletes the global metadata of a zip archive
140762     *
140763     * Deletes the global metadata of the zip archive
140764     *
140765     * @return bool returns TRUE on success, but it is better to check for
140766     *   thrown exception, and assume success if none is thrown.
140767     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140768     **/
140769    function delMetadata(){}
140770
140771    /**
140772     * Extract the contents of a tar/zip archive to a directory
140773     *
140774     * Extract all files within a tar/zip archive to disk. Extracted files
140775     * and directories preserve permissions as stored in the archive. The
140776     * optional parameters allow optional control over which files are
140777     * extracted, and whether existing files on disk can be overwritten. The
140778     * second parameter files can be either the name of a file or directory
140779     * to extract, or an array of names of files and directories to extract.
140780     * By default, this method will not overwrite existing files, the third
140781     * parameter can be set to true to enable overwriting of files. This
140782     * method is similar to {@link ZipArchive::extractTo}.
140783     *
140784     * @param string $pathto Path to extract the given files to
140785     * @param string|array $files The name of a file or directory to
140786     *   extract, or an array of files/directories to extract
140787     * @param bool $overwrite Set to TRUE to enable overwriting existing
140788     *   files
140789     * @return bool returns TRUE on success, but it is better to check for
140790     *   thrown exception, and assume success if none is thrown.
140791     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140792     **/
140793    function extractTo($pathto, $files, $overwrite){}
140794
140795    /**
140796     * Returns true if the tar/zip archive can be modified
140797     *
140798     * This method returns TRUE if the tar/zip archive on disk is not
140799     * read-only. Unlike {@link Phar::isWritable}, data-only tar/zip archives
140800     * can be modified even if phar.readonly is set to 1.
140801     *
140802     * @return bool Returns TRUE if the tar/zip archive can be modified
140803     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140804     **/
140805    function isWritable(){}
140806
140807    /**
140808     * Set the contents of a file within the tar/zip to those of an external
140809     * file or string
140810     *
140811     * This is an implementation of the ArrayAccess interface allowing direct
140812     * manipulation of the contents of a tar/zip archive using array access
140813     * brackets. offsetSet is used for modifying an existing file, or adding
140814     * a new file to a tar/zip archive.
140815     *
140816     * @param string $offset The filename (relative path) to modify in a
140817     *   tar or zip archive.
140818     * @param string $value Content of the file.
140819     * @return void No return values.
140820     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140821     **/
140822    function offsetSet($offset, $value){}
140823
140824    /**
140825     * Remove a file from a tar/zip archive
140826     *
140827     * This is an implementation of the ArrayAccess interface allowing direct
140828     * manipulation of the contents of a tar/zip archive using array access
140829     * brackets. offsetUnset is used for deleting an existing file, and is
140830     * called by the {@link unset} language construct.
140831     *
140832     * @param string $offset The filename (relative path) to modify in the
140833     *   tar/zip archive.
140834     * @return bool
140835     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140836     **/
140837    function offsetUnset($offset){}
140838
140839    /**
140840     * Dummy function (Phar::setAlias is not valid for PharData)
140841     *
140842     * Non-executable tar/zip archives cannot have an alias, so this method
140843     * simply throws an exception.
140844     *
140845     * @param string $alias A shorthand string that this archive can be
140846     *   referred to in phar stream wrapper access. This parameter is
140847     *   ignored.
140848     * @return bool
140849     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140850     **/
140851    function setAlias($alias){}
140852
140853    /**
140854     * Dummy function (Phar::setDefaultStub is not valid for PharData)
140855     *
140856     * Non-executable tar/zip archives cannot have a stub, so this method
140857     * simply throws an exception.
140858     *
140859     * @param string $index Relative path within the phar archive to run if
140860     *   accessed on the command-line
140861     * @param string $webindex Relative path within the phar archive to run
140862     *   if accessed through a web browser
140863     * @return bool
140864     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140865     **/
140866    function setDefaultStub($index, $webindex){}
140867
140868    /**
140869     * Dummy function (Phar::setStub is not valid for PharData)
140870     *
140871     * Non-executable tar/zip archives cannot have a stub, so this method
140872     * simply throws an exception.
140873     *
140874     * @param string $stub A string or an open stream handle to use as the
140875     *   executable stub for this phar archive. This parameter is ignored.
140876     * @param int $len
140877     * @return bool
140878     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0
140879     **/
140880    function setStub($stub, $len){}
140881
140882    /**
140883     * Construct a non-executable tar or zip archive object
140884     *
140885     * @param string $fname Path to an existing tar/zip archive or
140886     *   to-be-created archive
140887     * @param int $flags Flags to pass to Phar parent class
140888     *   RecursiveDirectoryIterator.
140889     * @param string $alias Alias with which this Phar archive should be
140890     *   referred to in calls to stream functionality.
140891     * @param int $format One of the file format constants available within
140892     *   the Phar class.
140893     **/
140894    function __construct($fname, $flags, $alias, $format){}
140895
140896}
140897/**
140898 * The PharException class provides a phar-specific exception class for
140899 * try/catch blocks.
140900 **/
140901class PharException extends Exception {
140902}
140903/**
140904 * The PharFileInfo class provides a high-level interface to the contents
140905 * and attributes of a single file within a phar archive.
140906 **/
140907class PharFileInfo extends SplFileInfo {
140908    /**
140909     * Sets file-specific permission bits
140910     *
140911     * {@link PharFileInfo::chmod} allows setting of the executable file
140912     * permissions bit, as well as read-only bits. Writeable bits are
140913     * ignored, and set at runtime based on the phar.readonly INI variable.
140914     * As with all functionality that modifies the contents of a phar, the
140915     * phar.readonly INI variable must be off in order to succeed if the file
140916     * is within a Phar archive. Files within PharData archives do not have
140917     * this restriction.
140918     *
140919     * @param int $permissions permissions (see {@link chmod})
140920     * @return void
140921     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
140922     **/
140923    public function chmod($permissions){}
140924
140925    /**
140926     * Compresses the current Phar entry with either zlib or bzip2
140927     * compression
140928     *
140929     * This method compresses the file inside the Phar archive using either
140930     * bzip2 compression or zlib compression. The bzip2 or zlib extension
140931     * must be enabled to take advantage of this feature. In addition, if the
140932     * file is already compressed, the respective extension must be enabled
140933     * in order to decompress the file. As with all functionality that
140934     * modifies the contents of a phar, the phar.readonly INI variable must
140935     * be off in order to succeed if the file is within a Phar archive. Files
140936     * within PharData archives do not have this restriction.
140937     *
140938     * @param int $compression
140939     * @return bool
140940     **/
140941    public function compress($compression){}
140942
140943    /**
140944     * Decompresses the current Phar entry within the phar
140945     *
140946     * This method decompresses the file inside the Phar archive. Depending
140947     * on how the file is compressed, the bzip2 or zlib extensions must be
140948     * enabled to take advantage of this feature. As with all functionality
140949     * that modifies the contents of a phar, the phar.readonly INI variable
140950     * must be off in order to succeed if the file is within a Phar archive.
140951     * Files within PharData archives do not have this restriction.
140952     *
140953     * @return bool
140954     **/
140955    public function decompress(){}
140956
140957    /**
140958     * Deletes the metadata of the entry
140959     *
140960     * Deletes the metadata of the entry, if any.
140961     *
140962     * @return bool Returns TRUE if successful, FALSE if the entry had no
140963     *   metadata. As with all functionality that modifies the contents of a
140964     *   phar, the phar.readonly INI variable must be off in order to succeed
140965     *   if the file is within a Phar archive. Files within PharData archives
140966     *   do not have this restriction.
140967     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.2.0
140968     **/
140969    public function delMetadata(){}
140970
140971    /**
140972     * Returns the actual size of the file (with compression) inside the Phar
140973     * archive
140974     *
140975     * This returns the size of the file within the Phar archive.
140976     * Uncompressed files will return the same value for getCompressedSize as
140977     * they will with {@link filesize}
140978     *
140979     * @return int The size in bytes of the file within the Phar archive on
140980     *   disk.
140981     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
140982     **/
140983    public function getCompressedSize(){}
140984
140985    /**
140986     * Get the complete file contents of the entry
140987     *
140988     * This function behaves like {@link file_get_contents} but for Phar.
140989     *
140990     * @return string Returns the file contents.
140991     * @since PHP 5 >= 5.3.0, PHP 7
140992     **/
140993    public function getContent(){}
140994
140995    /**
140996     * Returns CRC32 code or throws an exception if CRC has not been verified
140997     *
140998     * This returns the {@link crc32} checksum of the file within the Phar
140999     * archive.
141000     *
141001     * @return int The {@link crc32} checksum of the file within the Phar
141002     *   archive.
141003     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
141004     **/
141005    public function getCRC32(){}
141006
141007    /**
141008     * Returns file-specific meta-data saved with a file
141009     *
141010     * Return meta-data that was saved in the Phar archive's manifest for
141011     * this file.
141012     *
141013     * @return mixed any PHP variable that can be serialized and is stored
141014     *   as meta-data for the file, or NULL if no meta-data is stored.
141015     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
141016     **/
141017    public function getMetadata(){}
141018
141019    /**
141020     * Returns the Phar file entry flags
141021     *
141022     * This returns the flags set in the manifest for a Phar. This will
141023     * always return 0 in the current implementation.
141024     *
141025     * @return int The Phar flags (always 0 in the current implementation)
141026     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
141027     **/
141028    public function getPharFlags(){}
141029
141030    /**
141031     * Returns the metadata of the entry
141032     *
141033     * Returns the metadata of a file within a phar archive.
141034     *
141035     * @return bool Returns FALSE if no metadata is set or is NULL, TRUE if
141036     *   metadata is not NULL
141037     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.2.0
141038     **/
141039    public function hasMetadata(){}
141040
141041    /**
141042     * Returns whether the entry is compressed
141043     *
141044     * This returns whether a file is compressed within a Phar archive with
141045     * either Gzip or Bzip2 compression.
141046     *
141047     * @param int $compression_type One of Phar::GZ or Phar::BZ2, defaults
141048     *   to any compression.
141049     * @return bool TRUE if the file is compressed within the Phar archive,
141050     *   FALSE if not.
141051     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
141052     **/
141053    public function isCompressed($compression_type){}
141054
141055    /**
141056     * Returns whether the entry is compressed using bzip2
141057     *
141058     * This returns whether a file is compressed within a Phar archive with
141059     * Bzip2 compression.
141060     *
141061     * @return bool TRUE if the file is compressed within the Phar archive
141062     *   using Bzip2, FALSE if not.
141063     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
141064     **/
141065    public function isCompressedBZIP2(){}
141066
141067    /**
141068     * Returns whether the entry is compressed using gz
141069     *
141070     * This returns whether a file is compressed within a Phar archive with
141071     * Gzip compression.
141072     *
141073     * @return bool TRUE if the file is compressed within the Phar archive
141074     *   using Gzip, FALSE if not.
141075     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
141076     **/
141077    public function isCompressedGZ(){}
141078
141079    /**
141080     * Returns whether file entry has had its CRC verified
141081     *
141082     * This returns whether a file within a Phar archive has had its CRC
141083     * verified.
141084     *
141085     * @return bool TRUE if the file has had its CRC verified, FALSE if
141086     *   not.
141087     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
141088     **/
141089    public function isCRCChecked(){}
141090
141091    /**
141092     * Compresses the current Phar entry within the phar using Bzip2
141093     * compression
141094     *
141095     * This method compresses the file inside the Phar archive using bzip2
141096     * compression. The bzip2 extension must be enabled to take advantage of
141097     * this feature. In addition, if the file is already compressed using
141098     * gzip compression, the zlib extension must be enabled in order to
141099     * decompress the file. As with all functionality that modifies the
141100     * contents of a phar, the phar.readonly INI variable must be off in
141101     * order to succeed.
141102     *
141103     * @return bool
141104     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
141105     **/
141106    public function setCompressedBZIP2(){}
141107
141108    /**
141109     * Compresses the current Phar entry within the phar using gz compression
141110     *
141111     * This method compresses the file inside the Phar archive using gzip
141112     * compression. The zlib extension must be enabled to take advantage of
141113     * this feature. In addition, if the file is already compressed using
141114     * bzip2 compression, the bzip2 extension must be enabled in order to
141115     * decompress the file. As with all functionality that modifies the
141116     * contents of a phar, the phar.readonly INI variable must be off in
141117     * order to succeed.
141118     *
141119     * @return bool
141120     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
141121     **/
141122    public function setCompressedGZ(){}
141123
141124    /**
141125     * Sets file-specific meta-data saved with a file
141126     *
141127     * {@link PharFileInfo::setMetadata} should only be used to store
141128     * customized data in a file that cannot be represented with existing
141129     * information stored with a file. Meta-data can significantly slow down
141130     * the performance of loading a phar archive if the data is large, or if
141131     * there are many files containing meta-data. It is important to note
141132     * that file permissions are natively supported inside a phar; it is
141133     * possible to set them with the {@link PharFileInfo::chmod} method. As
141134     * with all functionality that modifies the contents of a phar, the
141135     * phar.readonly INI variable must be off in order to succeed if the file
141136     * is within a Phar archive. Files within PharData archives do not have
141137     * this restriction.
141138     *
141139     * Some possible uses for meta-data include passing a user/group that
141140     * should be set when a file is extracted from the phar to disk. Other
141141     * uses could include explicitly specifying a MIME type to return.
141142     * However, any useful data that describes a file, but should not be
141143     * contained inside of it may be stored.
141144     *
141145     * @param mixed $metadata Any PHP variable containing information to
141146     *   store alongside a file
141147     * @return void
141148     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
141149     **/
141150    public function setMetadata($metadata){}
141151
141152    /**
141153     * Uncompresses the current Phar entry within the phar, if it is
141154     * compressed
141155     *
141156     * This method decompresses the file inside the Phar archive. Depending
141157     * on how the file is compressed, the bzip2 or zlib extensions must be
141158     * enabled to take advantage of this feature. As with all functionality
141159     * that modifies the contents of a phar, the phar.readonly INI variable
141160     * must be off in order to succeed.
141161     *
141162     * @return bool
141163     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
141164     **/
141165    public function setUncompressed(){}
141166
141167    /**
141168     * Construct a Phar entry object
141169     *
141170     * This should not be called directly. Instead, a PharFileInfo object is
141171     * initialized by calling {@link Phar::offsetGet} through array access.
141172     *
141173     * @param string $entry The full url to retrieve a file. If you wish to
141174     *   retrieve the information for the file my/file.php from the phar
141175     *   boo.phar, the entry should be phar://boo.phar/my/file.php.
141176     * @since PHP 5 >= 5.3.0, PHP 7, PECL phar >= 1.0.0
141177     **/
141178    public function __construct($entry){}
141179
141180}
141181class phdfs {
141182    /**
141183     * @var mixed
141184     **/
141185    static $host;
141186
141187    /**
141188     * @var mixed
141189     **/
141190    static $port;
141191
141192    /**
141193     * @return bool
141194     * @since phdfs >= 0.1.0
141195     **/
141196    public function connect(){}
141197
141198    /**
141199     * @param string $source_file
141200     * @param string $destination_file
141201     * @return bool
141202     * @since phdfs >= 0.1.0
141203     **/
141204    public function copy($source_file, $destination_file){}
141205
141206    /**
141207     * @param string $path
141208     * @return bool
141209     * @since phdfs >= 0.1.0
141210     **/
141211    public function create_directory($path){}
141212
141213    /**
141214     * @param string $path
141215     * @return bool
141216     * @since phdfs >= 0.1.0
141217     **/
141218    public function delete($path){}
141219
141220    /**
141221     * @return bool
141222     * @since phdfs >= 0.1.0
141223     **/
141224    public function disconnect(){}
141225
141226    /**
141227     * @param string $path
141228     * @return bool
141229     * @since phdfs>= 0.1.0
141230     **/
141231    public function exists($path){}
141232
141233    /**
141234     * @param string $path
141235     * @return array Returns array on success.
141236     * @since phdfs >= 0.1.0
141237     **/
141238    public function file_info($path){}
141239
141240    /**
141241     * @param string $path
141242     * @param int $level
141243     * @return array Returns array on success.
141244     * @since phdfs >= 0.1.0
141245     **/
141246    public function list_directory($path, $level){}
141247
141248    /**
141249     * @param string $path
141250     * @param int $length
141251     * @return string
141252     * @since phdfs >= 0.1.0
141253     **/
141254    public function read($path, $length){}
141255
141256    /**
141257     * @param string $old_path
141258     * @param string $new_path
141259     * @return bool
141260     * @since phdfs >= 0.1.0
141261     **/
141262    public function rename($old_path, $new_path){}
141263
141264    /**
141265     * @param string $path
141266     * @param int $read_length
141267     * @return int
141268     * @since phdfs >= 0.1.0
141269     **/
141270    public function tell($path, $read_length){}
141271
141272    /**
141273     * @param string $path
141274     * @param string $buffer
141275     * @param int $mode
141276     * @return bool
141277     * @since phdfs >= 0.1.0
141278     **/
141279    public function write($path, $buffer, $mode){}
141280
141281    /**
141282     * @param string $ip
141283     * @param string $port
141284     * @since phdfs >= 0.1.0
141285     **/
141286    public function __construct($ip, $port){}
141287
141288    /**
141289     * @return void
141290     * @since phdfs >= 0.1.0
141291     **/
141292    public function __destruct(){}
141293
141294}
141295namespace pht {
141296class AtomicInteger implements pht\Threaded {
141297    /**
141298     * Decrements the atomic integer's value by one
141299     *
141300     * This method will decrement the atomic integer's value by one.
141301     * Internally, the mutex lock of the atomic integer will be acquired, and
141302     * so there is no need to manually acquire it (unless this operation
141303     * needs to be grouped with other operations on the same atomic integer -
141304     * see the example in pht\AtomicInteger::lock for a demonstration of
141305     * this).
141306     *
141307     * @return void No return value.
141308     **/
141309    public function dec(){}
141310
141311    /**
141312     * Gets the atomic integer's value
141313     *
141314     * This method will fetch the current value of the atomic integer.
141315     * Internally, the mutex lock of the atomic integer will be acquired, and
141316     * so there is no need to manually acquire it (unless this operation
141317     * needs to be grouped with other operations on the same atomic integer -
141318     * see the example in pht\AtomicInteger::lock for a demonstration of
141319     * this).
141320     *
141321     * @return int The current integer value of the atomic integer.
141322     **/
141323    public function get(){}
141324
141325    /**
141326     * Increments the atomic integer's value by one
141327     *
141328     * This method will increment the atomic integer's value by one.
141329     * Internally, the mutex lock of the atomic integer will be acquired, and
141330     * so there is no need to manually acquire it (unless this operation
141331     * needs to be grouped with other operations on the same atomic integer -
141332     * see the example in pht\AtomicInteger::lock for a demonstration of
141333     * this).
141334     *
141335     * @return void No return value.
141336     **/
141337    public function inc(){}
141338
141339    /**
141340     * Acquires the atomic integer's mutex lock
141341     *
141342     * This method will acquire the mutex lock associated with the atomic
141343     * integer. The mutex lock only needs to be acquired when needing to
141344     * group together multiple operations.
141345     *
141346     * The mutex locks of the atomic values are reentrant safe. It is
141347     * therefore valid for the same thread to reacquire a mutex lock that it
141348     * has already acquired.
141349     *
141350     * @return void No return value.
141351     **/
141352    public function lock(){}
141353
141354    /**
141355     * Sets the atomic integer's value
141356     *
141357     * This method will set the value of the atomic integer. Internally, the
141358     * mutex lock of the atomic integer will be acquired, and so there is no
141359     * need to manually acquire it (unless this operation needs to be grouped
141360     * with other operations on the same atomic integer - see the example in
141361     * pht\AtomicInteger::lock for a demonstration of this).
141362     *
141363     * @param int $value The value to set the atomic integer to.
141364     * @return void No return value.
141365     **/
141366    public function set($value){}
141367
141368    /**
141369     * Releases the atomic integer's mutex lock
141370     *
141371     * This method will release the mutex lock associated with the atomic
141372     * integer.
141373     *
141374     * @return void No return value.
141375     **/
141376    public function unlock(){}
141377
141378    /**
141379     * AtomicInteger creation
141380     *
141381     * Handles the creation of a new atomic integer.
141382     *
141383     * @param int $value The value to initialise the atomic integer to.
141384     * @return AtomicInteger No return value.
141385     **/
141386    public function __construct($value){}
141387
141388}
141389}
141390namespace pht {
141391class HashTable implements pht\Threaded {
141392    /**
141393     * Acquires the hash table's mutex lock
141394     *
141395     * This method will acquire the mutex lock associated with the hash
141396     * table. The mutex lock should always be acquired when manipulating the
141397     * hash table if it is being used by multiple threads.
141398     *
141399     * The mutex locks of the Inter-Thread Communication (ITC) data
141400     * structures are not reentrant. Attempting to reacquire an
141401     * already-acquired mutex lock by the same thread will therefore cause a
141402     * deadlock.
141403     *
141404     * @return void No return value.
141405     **/
141406    public function lock(){}
141407
141408    /**
141409     * Gets the size of the hash table
141410     *
141411     * Returns the current size of the hash table. This operation requires a
141412     * pht\HashTable's mutex lock to be held if it is being used by multiple
141413     * threads.
141414     *
141415     * @return int The size of the hash table.
141416     **/
141417    public function size(){}
141418
141419    /**
141420     * Releases the hash table's mutex lock
141421     *
141422     * This method will release the mutex lock associated with the hash
141423     * table.
141424     *
141425     * @return void No return value.
141426     **/
141427    public function unlock(){}
141428
141429}
141430}
141431namespace pht {
141432class Queue implements pht\Threaded {
141433    /**
141434     * Returns the first value from a queue
141435     *
141436     * This method will remove a value from the front of the queue (in
141437     * constant time). Attempting to return the front value from an empty
141438     * queue will result in an Error exception.
141439     *
141440     * @return mixed The value on the front of the queue.
141441     **/
141442    public function front(){}
141443
141444    /**
141445     * Acquires the queue's mutex lock
141446     *
141447     * This method will acquire the mutex lock associated with the queue. The
141448     * mutex lock should always be acquired when manipulating the queue if it
141449     * is being used by multiple threads.
141450     *
141451     * The mutex locks of the Inter-Thread Communication (ITC) data
141452     * structures are not reentrant. Attempting to reacquire an
141453     * already-acquired mutex lock by the same thread will therefore cause a
141454     * deadlock.
141455     *
141456     * @return void No return value.
141457     **/
141458    public function lock(){}
141459
141460    /**
141461     * Pops a value off of the front of a queue
141462     *
141463     * This method will remove a value from the front of the queue (in
141464     * constant time). Attempting to pop a value from an empty queue will
141465     * result in an Error exception.
141466     *
141467     * @return mixed The value removed from the queue.
141468     **/
141469    public function pop(){}
141470
141471    /**
141472     * Pushes a value to the end of a queue
141473     *
141474     * This method will add a value onto the queue.
141475     *
141476     * @param mixed $value The value to be added to a pht\Queue. This value
141477     *   will be serialised (since it may be passed around between threads).
141478     * @return void No return value.
141479     **/
141480    public function push($value){}
141481
141482    /**
141483     * Gets the size of the queue
141484     *
141485     * Returns the current size of the queue. This operation requires a
141486     * pht\Queue's mutex lock to be held if it is being used by multiple
141487     * threads.
141488     *
141489     * @return int The size of the queue.
141490     **/
141491    public function size(){}
141492
141493    /**
141494     * Releases the queue's mutex lock
141495     *
141496     * This method will release the mutex lock associated with the queue.
141497     *
141498     * @return void No return value.
141499     **/
141500    public function unlock(){}
141501
141502}
141503}
141504namespace pht {
141505interface Runnable {
141506    /**
141507     * The entry point of a threaded class
141508     *
141509     * This method acts as the entry point of execution for a threaded class.
141510     * It must be defined by all classes that will be threaded.
141511     *
141512     * @return void No return value.
141513     **/
141514    public function run();
141515
141516}
141517}
141518namespace pht {
141519class Thread {
141520    /**
141521     * Class threading
141522     *
141523     * Adds a new class task to a pht\Threads internal task queue.
141524     *
141525     * @param string $className The name of the class to be threaded. This
141526     *   class must implement the pht\Runnable interface.
141527     * @param mixed ...$ctorArgs An optional list of arguments for the
141528     *   threaded class' constructor. These arguments will be serialised
141529     *   (since they are being passed to another thread).
141530     * @return void No return value.
141531     **/
141532    public function addClassTask($className, ...$ctorArgs){}
141533
141534    /**
141535     * File threading
141536     *
141537     * Adds a new file task to a pht\Threads internal task queue.
141538     *
141539     * @param string $fileName The name of the file to be threaded.
141540     * @param mixed ...$globals An optional list of arguments for the file.
141541     *   These arguments will be placed into a $_THREAD superglobal, which
141542     *   will be made available inside of the threaded file. All arguments
141543     *   will be serialised (since they are being passed to another thread).
141544     * @return void No return value.
141545     **/
141546    public function addFileTask($fileName, ...$globals){}
141547
141548    /**
141549     * Function threading
141550     *
141551     * Adds a new function task to a pht\Threads internal task queue.
141552     *
141553     * @param callable $func The function to be threaded. If it is bound to
141554     *   an instance, then $this will become NULL.
141555     * @param mixed ...$funcArgs An optional list of arguments for the
141556     *   function. These arguments will be serialised (since they are being
141557     *   passed to another thread).
141558     * @return void No return value.
141559     **/
141560    public function addFunctionTask($func, ...$funcArgs){}
141561
141562    /**
141563     * Joins a thread
141564     *
141565     * This method will join the spawned thread (though it will first wait
141566     * for that thread's internal task queue to finish). As a matter of good
141567     * practice, threads should always be joined. Not joining a thread may
141568     * lead to undefined behaviour.
141569     *
141570     * @return void No return value.
141571     * @since PECL pthreads >= 2.0.0
141572     **/
141573    public function join(){}
141574
141575    /**
141576     * Starts the new thread
141577     *
141578     * This will cause a new thread to be spawned for the associated
141579     * pht\Thread object, where its internal task queue will begin to be
141580     * processed.
141581     *
141582     * @return void No return value.
141583     * @since PECL pthreads >= 2.0.0
141584     **/
141585    public function start(){}
141586
141587    /**
141588     * Gets a thread's task count
141589     *
141590     * Retrieves the current task count of a pht\Thread.
141591     *
141592     * @return int The number of tasks remaining to be processed.
141593     **/
141594    public function taskCount(){}
141595
141596}
141597}
141598namespace pht {
141599interface Threaded {
141600    /**
141601     * Acquires the mutex lock
141602     *
141603     * This method will acquire the mutex lock associated with the given
141604     * class (either a pht\HashTable, pht\Queue, pht\Vector, or
141605     * pht\AtomicInteger).
141606     *
141607     * @return void No return value.
141608     * @since PECL pthreads < 3.0.0
141609     **/
141610    public function lock();
141611
141612    /**
141613     * Releases the mutex lock
141614     *
141615     * This method will unlock the mutex lock associated with the given class
141616     * (either a pht\HashTable, pht\Queue, pht\Vector, or pht\AtomicInteger).
141617     *
141618     * @return void No return value.
141619     * @since PECL pthreads < 3.0.0
141620     **/
141621    public function unlock();
141622
141623}
141624}
141625namespace pht {
141626class Vector implements pht\Threaded {
141627    /**
141628     * Deletes a value in the vector
141629     *
141630     * This method deletes a value at the specified offset in the vector (in
141631     * linear time).
141632     *
141633     * Since the pht\Vector class supports array access, deleting values can
141634     * also be performed using the array subset notation ([]) in combination
141635     * with the {@link unset} function.
141636     *
141637     * @param int $offset The offset at which the value will be deleted at.
141638     *   This offset must be within the 0..(N-1) range (inclusive), where N
141639     *   is the size of the vector. Attempting to delete at offsets outside
141640     *   of this range will result in an Error exception.
141641     * @return void No return value.
141642     **/
141643    public function deleteAt($offset){}
141644
141645    /**
141646     * Inserts a value into the vector
141647     *
141648     * This method inserts a value at the specified offset into the vector
141649     * (in linear time). The vector will automatically be resized if it is
141650     * not large enough.
141651     *
141652     * @param mixed $value The value to be inserted into the vector. This
141653     *   value will be serialised (since it may be passed around between
141654     *   threads).
141655     * @param int $offset The offset at which the value will be inserted
141656     *   at. This offset must be within the 0..N range (inclusive), where N
141657     *   is the size of the vector. Inserting at position N is the equivalent
141658     *   of using pht\Vector::push, and inserting at position 0 is the
141659     *   equivalent of using pht\Vector::unshift. Attempting to insert at
141660     *   offsets outside of this range will result in an Error exception.
141661     * @return void No return value.
141662     **/
141663    public function insertAt($value, $offset){}
141664
141665    /**
141666     * Acquires the vector's mutex lock
141667     *
141668     * This method will acquire the mutex lock associated with the vector.
141669     * The mutex lock should always be acquired when manipulating the vector
141670     * if it is being used by multiple threads.
141671     *
141672     * The mutex locks of the Inter-Thread Communication (ITC) data
141673     * structures are not reentrant. Attempting to reacquire an
141674     * already-acquired mutex lock by the same thread will therefore cause a
141675     * deadlock.
141676     *
141677     * @return void No return value.
141678     **/
141679    public function lock(){}
141680
141681    /**
141682     * Pops a value to the vector
141683     *
141684     * This method pops a value from the end of a vector (in constant time).
141685     * Popping a value from an empty vector will result in an Error
141686     * exception.
141687     *
141688     * @return mixed The value from the end of the vector.
141689     **/
141690    public function pop(){}
141691
141692    /**
141693     * Pushes a value to the vector
141694     *
141695     * This method pushes a value onto the end of a vector (in constant
141696     * time). The vector will automatically be resized if it is not large
141697     * enough.
141698     *
141699     * Since the pht\Vector class supports array access, new values can also
141700     * be pushed onto the vector using the empty subset notation ([]).
141701     *
141702     * @param mixed $value The value to be pushed onto the end of the
141703     *   vector. This value will be serialised (since it may be passed around
141704     *   between threads).
141705     * @return void No return value.
141706     **/
141707    public function push($value){}
141708
141709    /**
141710     * Resizes a vector
141711     *
141712     * Resizes the vector. If it is enlarged, then the {@link value}
141713     * parameter will be used to fill in the new slots. If it is made
141714     * smaller, then the end values will be truncated.
141715     *
141716     * @param int $size The new size of the vector.
141717     * @param mixed $value The value to initialise the empty vector slots
141718     *   to (only used if the vector is enlarged).
141719     * @return void No return value.
141720     **/
141721    public function resize($size, $value){}
141722
141723    /**
141724     * Shifts a value from the vector
141725     *
141726     * This method shifts a value from the front of a vector (in linear
141727     * time). Shifting a value from an empty vector will result in an Error
141728     * exception.
141729     *
141730     * @return mixed The value from the front of the vector.
141731     **/
141732    public function shift(){}
141733
141734    /**
141735     * Gets the size of the vector
141736     *
141737     * Returns the current size of the vector. This operation requires a
141738     * pht\Vector's mutex lock to be held if it is being used by multiple
141739     * threads.
141740     *
141741     * @return int The size of the vector.
141742     **/
141743    public function size(){}
141744
141745    /**
141746     * Releases the vector's mutex lock
141747     *
141748     * This method will release the mutex lock associated with the vector.
141749     *
141750     * @return void No return value.
141751     **/
141752    public function unlock(){}
141753
141754    /**
141755     * Unshifts a value to the vector front
141756     *
141757     * This method unshifts a value to the front of a vector (in linear
141758     * time). The vector will automatically be resized if it is not large
141759     * enough.
141760     *
141761     * @param mixed $value The value to be pushed onto the beginning of the
141762     *   vector. This value will be serialised (since it may be passed around
141763     *   between threads).
141764     * @return void No return value.
141765     **/
141766    public function unshift($value){}
141767
141768    /**
141769     * Updates a value in the vector
141770     *
141771     * This method updates a value at the specified offset in the vector (in
141772     * linear time). The vector will automatically be resized if it is not
141773     * large enough.
141774     *
141775     * Since the pht\Vector class supports array access, updating values can
141776     * also be performed using the array subset notation ([]).
141777     *
141778     * @param mixed $value The value to be inserted into the vector. This
141779     *   value will be serialised (since it may be passed around between
141780     *   threads).
141781     * @param int $offset The offset at which the value will be updated at.
141782     *   This offset must be within the 0..(N-1) range (inclusive), where N
141783     *   is the size of the vector. Attempting to update at offsets outside
141784     *   of this range will result in an Error exception.
141785     * @return void No return value.
141786     **/
141787    public function updateAt($value, $offset){}
141788
141789    /**
141790     * Vector creation
141791     *
141792     * Handles the creation of a new vector.
141793     *
141794     * @param int $size The size of the vector that will be created.
141795     * @param mixed $value The value to initialise the empty slots in the
141796     *   vector to.
141797     * @return Vector No return value.
141798     **/
141799    public function __construct($size, $value){}
141800
141801}
141802}
141803/**
141804 * A Pool is a container for, and controller of, an adjustable number of
141805 * Workers. Pooling provides a higher level abstraction of the Worker
141806 * functionality, including the management of references in the way
141807 * required by pthreads.
141808 **/
141809class Pool {
141810    /**
141811     * the class of the Worker
141812     *
141813     * @var mixed
141814     **/
141815    protected $class;
141816
141817    /**
141818     * the arguments for constructor of new Workers
141819     *
141820     * @var mixed
141821     **/
141822    protected $ctor;
141823
141824    /**
141825     * offset in workers of the last Worker used
141826     *
141827     * @var mixed
141828     **/
141829    protected $last;
141830
141831    /**
141832     * maximum number of Workers this Pool can use
141833     *
141834     * @var mixed
141835     **/
141836    protected $size;
141837
141838    /**
141839     * references to Workers
141840     *
141841     * @var mixed
141842     **/
141843    protected $workers;
141844
141845    /**
141846     * Collect references to completed tasks
141847     *
141848     * Allows the pool to collect references determined to be garbage by the
141849     * optionally given collector.
141850     *
141851     * @param Callable $collector A Callable collector that returns a
141852     *   boolean on whether the task can be collected or not. Only in rare
141853     *   cases should a custom collector need to be used.
141854     * @return int The number of remaining tasks in the pool to be
141855     *   collected.
141856     * @since PECL pthreads >= 2.0.0
141857     **/
141858    public function collect($collector){}
141859
141860    /**
141861     * Resize the Pool
141862     *
141863     * @param int $size The maximum number of Workers this Pool can create
141864     * @return void void
141865     * @since PECL pthreads >= 2.0.0
141866     **/
141867    public function resize($size){}
141868
141869    /**
141870     * Shutdown all workers
141871     *
141872     * Shuts down all of the workers in the pool. This will block until all
141873     * submitted tasks have been executed.
141874     *
141875     * @return void No value is returned.
141876     * @since PECL pthreads >= 2.0.0
141877     **/
141878    public function shutdown(){}
141879
141880    /**
141881     * Submits an object for execution
141882     *
141883     * Submit the task to the next Worker in the Pool
141884     *
141885     * @param Threaded $task The task for execution
141886     * @return int the identifier of the Worker executing the object
141887     * @since PECL pthreads >= 2.0.0
141888     **/
141889    public function submit($task){}
141890
141891    /**
141892     * Submits a task to a specific worker for execution
141893     *
141894     * Submit a task to the specified worker in the pool. The workers are
141895     * indexed from 0, and will only exist if the pool has needed to create
141896     * them (since threads are lazily spawned).
141897     *
141898     * @param int $worker The worker to stack the task onto, indexed from
141899     *   0.
141900     * @param Threaded $task The task for execution.
141901     * @return int The identifier of the worker that accepted the task.
141902     * @since PECL pthreads >= 2.0.0
141903     **/
141904    public function submitTo($worker, $task){}
141905
141906    /**
141907     * Creates a new Pool of Workers
141908     *
141909     * Construct a new pool of workers. Pools lazily create their threads,
141910     * which means new threads will only be spawned when they are required to
141911     * execute tasks.
141912     *
141913     * @param int $size The maximum number of workers for this pool to
141914     *   create
141915     * @param string $class The class for new Workers. If no class is
141916     *   given, then it defaults to the Worker class.
141917     * @param array $ctor An array of arguments to be passed to new
141918     *   workers' constructors
141919     * @return Pool The new pool
141920     * @since PECL pthreads >= 2.0.0
141921     **/
141922    public function __construct($size, $class, $ctor){}
141923
141924}
141925/**
141926 * This class wraps around a hash containing integer numbers, where the
141927 * values are also integer numbers. Hashes are also available as
141928 * implementation of the ArrayAccess interface. Hashes can also be
141929 * iterated over with foreach as the Iterator interface is implemented as
141930 * well. The order of which elements are returned in is not guaranteed.
141931 **/
141932class QuickHashIntHash {
141933    /**
141934     * @var integer
141935     **/
141936    const CHECK_FOR_DUPES = 0;
141937
141938    /**
141939     * @var integer
141940     **/
141941    const DO_NOT_USE_ZEND_ALLOC = 0;
141942
141943    /**
141944     * @var integer
141945     **/
141946    const HASHER_JENKINS1 = 0;
141947
141948    /**
141949     * @var integer
141950     **/
141951    const HASHER_JENKINS2 = 0;
141952
141953    /**
141954     * @var integer
141955     **/
141956    const HASHER_NO_HASH = 0;
141957
141958    /**
141959     * This method adds a new entry to the hash
141960     *
141961     * This method adds a new entry to the hash, and returns whether the
141962     * entry was added. Entries are by default always added unless
141963     * QuickHashIntHash::CHECK_FOR_DUPES has been passed when the hash was
141964     * created.
141965     *
141966     * @param int $key The key of the entry to add.
141967     * @param int $value The optional value of the entry to add. If no
141968     *   value is specified, 1 will be used.
141969     * @return bool TRUE when the entry was added, and FALSE if the entry
141970     *   was not added.
141971     * @since PECL quickhash >= Unknown
141972     **/
141973    public function add($key, $value){}
141974
141975    /**
141976     * This method deletes am entry from the hash
141977     *
141978     * This method deletes an entry from the hash, and returns whether the
141979     * entry was deleted or not. Associated memory structures will not be
141980     * freed immediately, but rather when the hash itself is freed.
141981     *
141982     * Elements can not be deleted when the hash is used in an iterator. The
141983     * method will not throw an exception, but simply return FALSE like would
141984     * happen with any other deletion failure.
141985     *
141986     * @param int $key The key of the entry to delete.
141987     * @return bool TRUE when the entry was deleted, and FALSE if the entry
141988     *   was not deleted.
141989     * @since PECL quickhash >= Unknown
141990     **/
141991    public function delete($key){}
141992
141993    /**
141994     * This method checks whether a key is part of the hash
141995     *
141996     * This method checks whether an entry with the provided key exists in
141997     * the hash.
141998     *
141999     * @param int $key The key of the entry to check for whether it exists
142000     *   in the hash.
142001     * @return bool Returns TRUE when the entry was found, or FALSE when
142002     *   the entry is not found.
142003     * @since PECL quickhash >= Unknown
142004     **/
142005    public function exists($key){}
142006
142007    /**
142008     * This method retrieves a value from the hash by its key
142009     *
142010     * @param int $key The key of the entry to add.
142011     * @return int The value if the key exists, or NULL if the key wasn't
142012     *   part of the hash.
142013     * @since PECL quickhash >= Unknown
142014     **/
142015    public function get($key){}
142016
142017    /**
142018     * Returns the number of elements in the hash
142019     *
142020     * @return int The number of elements in the hash.
142021     * @since PECL quickhash >= Unknown
142022     **/
142023    public function getSize(){}
142024
142025    /**
142026     * This factory method creates a hash from a file
142027     *
142028     * This factory method creates a new hash from a definition file on disk.
142029     * The file format consists of a signature 'QH\0x11\0', the number of
142030     * elements as a 32 bit signed integer in system Endianness, followed by
142031     * 32 bit signed integers packed together in the Endianness that the
142032     * system that the code runs on uses. For each hash element there are two
142033     * 32 bit signed integers stored. The first of each element is the key,
142034     * and the second is the value belonging to the key. An example could be:
142035     *
142036     * QuickHash IntHash file format 00000000 51 48 11 00 02 00 00 00 01 00
142037     * 00 00 01 00 00 00 |QH..............| 00000010 03 00 00 00 09 00 00 00
142038     * |........| 00000018
142039     *
142040     * QuickHash IntHash file format header signature ('QH'; key type: 1;
142041     * value type: 1; filler: \0x00) 00000000 51 48 11 00
142042     *
142043     * number of elements: 00000004 02 00 00 00
142044     *
142045     * data string: 00000000 01 00 00 00 01 00 00 00 03 00 00 00 09 00 00 00
142046     *
142047     * key/value 1 (key = 1, value = 1) 01 00 00 00 01 00 00 00
142048     *
142049     * key/value 2 (key = 3, value = 9) 03 00 00 00 09 00 00 00
142050     *
142051     * @param string $filename The filename of the file to read the hash
142052     *   from.
142053     * @param int $options The same options that the class' constructor
142054     *   takes; except that the size option is ignored. It is automatically
142055     *   calculated to be the same as the number of entries in the hash,
142056     *   rounded up to the nearest power of two with a maximum limit of
142057     *   4194304.
142058     * @return QuickHashIntHash Returns a new QuickHashIntHash.
142059     * @since PECL quickhash >= Unknown
142060     **/
142061    public static function loadFromFile($filename, $options){}
142062
142063    /**
142064     * This factory method creates a hash from a string
142065     *
142066     * This factory method creates a new hash from a definition in a string.
142067     * The file format consists of 32 bit signed integers packed together in
142068     * the Endianness that the system that the code runs on uses. For each
142069     * element there are two 32 bit signed integers stored. The first of each
142070     * element is the key, and the second is the value belonging to the key.
142071     *
142072     * @param string $contents The string containing a serialized format of
142073     *   the hash.
142074     * @param int $options The same options that the class' constructor
142075     *   takes; except that the size option is ignored. It is automatically
142076     *   calculated to be the same as the number of entries in the hash,
142077     *   rounded up to the nearest power of two with a maximum limit of
142078     *   4194304.
142079     * @return QuickHashIntHash Returns a new QuickHashIntHash.
142080     * @since PECL quickhash >= Unknown
142081     **/
142082    public static function loadFromString($contents, $options){}
142083
142084    /**
142085     * This method stores an in-memory hash to disk
142086     *
142087     * This method stores an existing hash to a file on disk, in the same
142088     * format that loadFromFile() can read.
142089     *
142090     * @param string $filename The filename of the file to store the hash
142091     *   in.
142092     * @return void
142093     * @since PECL quickhash >= Unknown
142094     **/
142095    public function saveToFile($filename){}
142096
142097    /**
142098     * This method returns a serialized version of the hash
142099     *
142100     * This method returns a serialized version of the hash in the same
142101     * format that loadFromString() can read.
142102     *
142103     * @return string This method returns a string containing a serialized
142104     *   format of the hash. Each element is stored as a four byte value in
142105     *   the Endianness that the current system uses.
142106     * @since PECL quickhash >= Unknown
142107     **/
142108    public function saveToString(){}
142109
142110    /**
142111     * This method updates an entry in the hash with a new value, or adds a
142112     * new one if the entry doesn't exist
142113     *
142114     * This method tries to update an entry with a new value. In case the
142115     * entry did not yet exist, it will instead add a new entry. It returns
142116     * whether the entry was added or update. If there are duplicate keys,
142117     * only the first found element will get an updated value. Use
142118     * QuickHashIntHash::CHECK_FOR_DUPES during hash creation to prevent
142119     * duplicate keys from being part of the hash.
142120     *
142121     * @param int $key The key of the entry to add or update.
142122     * @param int $value The new value to set the entry with.
142123     * @return bool 2 if the entry was found and updated, 1 if the entry
142124     *   was newly added or 0 if there was an error.
142125     * @since PECL quickhash >= Unknown
142126     **/
142127    public function set($key, $value){}
142128
142129    /**
142130     * This method updates an entry in the hash with a new value
142131     *
142132     * This method updates an entry with a new value, and returns whether the
142133     * entry was update. If there are duplicate keys, only the first found
142134     * element will get an updated value. Use
142135     * QuickHashIntHash::CHECK_FOR_DUPES during hash creation to prevent
142136     * duplicate keys from being part of the hash.
142137     *
142138     * @param int $key The key of the entry to add.
142139     * @param int $value The new value to update the entry with.
142140     * @return bool TRUE when the entry was found and updated, and FALSE if
142141     *   the entry was not part of the hash already.
142142     * @since PECL quickhash >= Unknown
142143     **/
142144    public function update($key, $value){}
142145
142146    /**
142147     * Creates a new QuickHashIntHash object
142148     *
142149     * This constructor creates a new QuickHashIntHash. The size is the
142150     * amount of bucket lists to create. The more lists there are, the less
142151     * collisions you will have. Options are also supported.
142152     *
142153     * @param int $size The amount of bucket lists to configure. The number
142154     *   you pass in will be automatically rounded up to the next power of
142155     *   two. It is also automatically limited from 64 to 4194304.
142156     * @param int $options The options that you can pass in are:
142157     *   QuickHashIntHash::CHECK_FOR_DUPES, which makes sure no duplicate
142158     *   entries are added to the hash;
142159     *   QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC to not use PHP's internal
142160     *   memory manager as well as one of QuickHashIntHash::HASHER_NO_HASH,
142161     *   QuickHashIntHash::HASHER_JENKINS1 or
142162     *   QuickHashIntHash::HASHER_JENKINS2. These last three configure which
142163     *   hashing algorithm to use. All options can be combined using
142164     *   bitmasks.
142165     * @since PECL quickhash >= Unknown
142166     **/
142167    public function __construct($size, $options){}
142168
142169}
142170/**
142171 * This class wraps around a set containing integer numbers. Sets can
142172 * also be iterated over with foreach as the Iterator interface is
142173 * implemented as well. The order of which elements are returned in is
142174 * not guaranteed.
142175 **/
142176class QuickHashIntSet {
142177    /**
142178     * @var integer
142179     **/
142180    const CHECK_FOR_DUPES = 0;
142181
142182    /**
142183     * @var integer
142184     **/
142185    const DO_NOT_USE_ZEND_ALLOC = 0;
142186
142187    /**
142188     * @var integer
142189     **/
142190    const HASHER_JENKINS1 = 0;
142191
142192    /**
142193     * @var integer
142194     **/
142195    const HASHER_JENKINS2 = 0;
142196
142197    /**
142198     * @var integer
142199     **/
142200    const HASHER_NO_HASH = 0;
142201
142202    /**
142203     * This method adds a new entry to the set
142204     *
142205     * This method adds a new entry to the set, and returns whether the entry
142206     * was added. Entries are by default always added unless
142207     * QuickHashIntSet::CHECK_FOR_DUPES has been passed when the set was
142208     * created.
142209     *
142210     * @param int $key The key of the entry to add.
142211     * @return bool TRUE when the entry was added, and FALSE if the entry
142212     *   was not added.
142213     * @since PECL quickhash >= Unknown
142214     **/
142215    public function add($key){}
142216
142217    /**
142218     * This method deletes an entry from the set
142219     *
142220     * This method deletes an entry from the set, and returns whether the
142221     * entry was deleted or not. Associated memory structures will not be
142222     * freed immediately, but rather when the set itself is freed.
142223     *
142224     * @param int $key The key of the entry to delete.
142225     * @return bool TRUE when the entry was deleted, and FALSE if the entry
142226     *   was not deleted.
142227     * @since PECL quickhash >= Unknown
142228     **/
142229    public function delete($key){}
142230
142231    /**
142232     * This method checks whether a key is part of the set
142233     *
142234     * This method checks whether an entry with the provided key exists in
142235     * the set.
142236     *
142237     * @param int $key The key of the entry to check for whether it exists
142238     *   in the set.
142239     * @return bool Returns TRUE when the entry was found, or FALSE when
142240     *   the entry is not found.
142241     * @since PECL quickhash >= Unknown
142242     **/
142243    public function exists($key){}
142244
142245    /**
142246     * Returns the number of elements in the set
142247     *
142248     * @return int The number of elements in the set.
142249     * @since PECL quickhash >= Unknown
142250     **/
142251    public function getSize(){}
142252
142253    /**
142254     * This factory method creates a set from a file
142255     *
142256     * This factory method creates a new set from a definition file on disk.
142257     * The file format consists of 32 bit signed integers packed together in
142258     * the Endianness that the system that the code runs on uses.
142259     *
142260     * @param string $filename The filename of the file to read the set
142261     *   from.
142262     * @param int $size The amount of bucket lists to configure. The number
142263     *   you pass in will be automatically rounded up to the next power of
142264     *   two. It is also automatically limited from 4 to 4194304.
142265     * @param int $options The same options that the class' constructor
142266     *   takes; except that the size option is ignored. It is automatically
142267     *   calculated to be the same as the number of entries in the set,
142268     *   rounded up to the nearest power of two with a maximum limit of
142269     *   4194304.
142270     * @return QuickHashIntSet Returns a new QuickHashIntSet.
142271     * @since PECL quickhash >= Unknown
142272     **/
142273    public static function loadFromFile($filename, $size, $options){}
142274
142275    /**
142276     * This factory method creates a set from a string
142277     *
142278     * This factory method creates a new set from a definition in a string.
142279     * The file format consists of 32 bit signed integers packed together in
142280     * the Endianness that the system that the code runs on uses.
142281     *
142282     * @param string $contents The string containing a serialized format of
142283     *   the set.
142284     * @param int $size The amount of bucket lists to configure. The number
142285     *   you pass in will be automatically rounded up to the next power of
142286     *   two. It is also automatically limited from 4 to 4194304.
142287     * @param int $options The same options that the class' constructor
142288     *   takes; except that the size option is ignored. It is automatically
142289     *   calculated to be the same as the number of entries in the set,
142290     *   rounded up to the nearest power of two automatically limited from 64
142291     *   to 4194304.
142292     * @return QuickHashIntSet Returns a new QuickHashIntSet.
142293     * @since PECL quickhash >= Unknown
142294     **/
142295    public static function loadFromString($contents, $size, $options){}
142296
142297    /**
142298     * This method stores an in-memory set to disk
142299     *
142300     * This method stores an existing set to a file on disk, in the same
142301     * format that loadFromFile() can read.
142302     *
142303     * @param string $filename The filename of the file to store the hash
142304     *   in.
142305     * @return void
142306     * @since PECL quickhash >= Unknown
142307     **/
142308    public function saveToFile($filename){}
142309
142310    /**
142311     * This method returns a serialized version of the set
142312     *
142313     * This method returns a serialized version of the set in the same format
142314     * that loadFromString() can read.
142315     *
142316     * @return string This method returns a string containing a serialized
142317     *   format of the set. Each element is stored as a four byte value in
142318     *   the Endianness that the current system uses.
142319     * @since PECL quickhash >= Unknown
142320     **/
142321    public function saveToString(){}
142322
142323    /**
142324     * Creates a new QuickHashIntSet object
142325     *
142326     * This constructor creates a new QuickHashIntSet. The size is the amount
142327     * of bucket lists to create. The more lists there are, the less
142328     * collisions you will have. Options are also supported.
142329     *
142330     * @param int $size The amount of bucket lists to configure. The number
142331     *   you pass in will be automatically rounded up to the next power of
142332     *   two. It is also automatically limited from 4 to 4194304.
142333     * @param int $options The options that you can pass in are:
142334     *   QuickHashIntSet::CHECK_FOR_DUPES, which makes sure no duplicate
142335     *   entries are added to the set; QuickHashIntSet::DO_NOT_USE_ZEND_ALLOC
142336     *   to not use PHP's internal memory manager as well as one of
142337     *   QuickHashIntSet::HASHER_NO_HASH, QuickHashIntSet::HASHER_JENKINS1 or
142338     *   QuickHashIntSet::HASHER_JENKINS2. These last three configure which
142339     *   hashing algorithm to use. All options can be combined using
142340     *   bitmasks.
142341     * @since PECL quickhash >= Unknown
142342     **/
142343    public function __construct($size, $options){}
142344
142345}
142346/**
142347 * This class wraps around a hash containing integer numbers, where the
142348 * values are strings. Hashes are also available as implementation of the
142349 * ArrayAccess interface. Hashes can also be iterated over with foreach
142350 * as the Iterator interface is implemented as well. The order of which
142351 * elements are returned in is not guaranteed.
142352 **/
142353class QuickHashIntStringHash {
142354    /**
142355     * @var integer
142356     **/
142357    const CHECK_FOR_DUPES = 0;
142358
142359    /**
142360     * @var integer
142361     **/
142362    const DO_NOT_USE_ZEND_ALLOC = 0;
142363
142364    /**
142365     * @var integer
142366     **/
142367    const HASHER_JENKINS1 = 0;
142368
142369    /**
142370     * @var integer
142371     **/
142372    const HASHER_JENKINS2 = 0;
142373
142374    /**
142375     * @var integer
142376     **/
142377    const HASHER_NO_HASH = 0;
142378
142379    /**
142380     * This method adds a new entry to the hash
142381     *
142382     * This method adds a new entry to the hash, and returns whether the
142383     * entry was added. Entries are by default always added unless
142384     * QuickHashIntStringHash::CHECK_FOR_DUPES has been passed when the hash
142385     * was created.
142386     *
142387     * @param int $key The key of the entry to add.
142388     * @param string $value The value of the entry to add. If a non-string
142389     *   is passed, it will be converted to a string automatically if
142390     *   possible.
142391     * @return bool TRUE when the entry was added, and FALSE if the entry
142392     *   was not added.
142393     * @since PECL quickhash >= Unknown
142394     **/
142395    public function add($key, $value){}
142396
142397    /**
142398     * This method deletes am entry from the hash
142399     *
142400     * This method deletes an entry from the hash, and returns whether the
142401     * entry was deleted or not. Associated memory structures will not be
142402     * freed immediately, but rather when the hash itself is freed.
142403     *
142404     * Elements can not be deleted when the hash is used in an iterator. The
142405     * method will not throw an exception, but simply return FALSE like would
142406     * happen with any other deletion failure.
142407     *
142408     * @param int $key The key of the entry to delete.
142409     * @return bool TRUE when the entry was deleted, and FALSE if the entry
142410     *   was not deleted.
142411     * @since PECL quickhash >= Unknown
142412     **/
142413    public function delete($key){}
142414
142415    /**
142416     * This method checks whether a key is part of the hash
142417     *
142418     * This method checks whether an entry with the provided key exists in
142419     * the hash.
142420     *
142421     * @param int $key The key of the entry to check for whether it exists
142422     *   in the hash.
142423     * @return bool Returns TRUE when the entry was found, or FALSE when
142424     *   the entry is not found.
142425     * @since PECL quickhash >= Unknown
142426     **/
142427    public function exists($key){}
142428
142429    /**
142430     * This method retrieves a value from the hash by its key
142431     *
142432     * @param int $key The key of the entry to add.
142433     * @return mixed The value if the key exists, or NULL if the key wasn't
142434     *   part of the hash.
142435     * @since PECL quickhash >= Unknown
142436     **/
142437    public function get($key){}
142438
142439    /**
142440     * Returns the number of elements in the hash
142441     *
142442     * @return int The number of elements in the hash.
142443     * @since PECL quickhash >= Unknown
142444     **/
142445    public function getSize(){}
142446
142447    /**
142448     * This factory method creates a hash from a file
142449     *
142450     * This factory method creates a new hash from a definition file on disk.
142451     * The file format consists of a signature 'QH\0x12\0', the number of
142452     * elements as a 32 bit signed integer in system Endianness, an unsigned
142453     * 32 bit integer containing the number of element data to follow in
142454     * characters. This element data contains all the strings. After the
142455     * header and the strings, the elements follow in pairs of two unsigned
142456     * 32 bit integers where the first one is the key, and the second one the
142457     * index in the element data string. An example could be:
142458     *
142459     * QuickHash IntString file format 00000000 51 48 12 00 02 00 00 00 09 00
142460     * 00 00 4f 4e 45 00 |QH..........ONE.| 00000010 4e 49 4e 45 00 01 00 00
142461     * 00 00 00 00 00 03 00 00 |NINE............| 00000020 00 04 00 00 00
142462     * |.....| 00000025
142463     *
142464     * QuickHash IntString file format header signature ('QH'; key type: 1;
142465     * value type: 2; filler: \0x00) 00000000 51 48 12 00
142466     *
142467     * number of elements: 00000004 02 00 00 00
142468     *
142469     * length of string values (9 characters): 00000008 09 00 00 00
142470     *
142471     * string values: 0000000C 4f 4e 45 00 4e 49 4e 45 00
142472     *
142473     * data string: 00000015 01 00 00 00 00 00 00 00 03 00 00 00 04 00 00 00
142474     *
142475     * key/value 1 (key = 1, string index = 0 ("ONE")): 01 00 00 00 00 00 00
142476     * 00
142477     *
142478     * key/value 2 (key = 3, string index = 4 ("NINE")): 03 00 00 00 04 00 00
142479     * 00
142480     *
142481     * @param string $filename The filename of the file to read the hash
142482     *   from.
142483     * @param int $size The amount of bucket lists to configure. The number
142484     *   you pass in will be automatically rounded up to the next power of
142485     *   two. It is also automatically limited from 4 to 4194304.
142486     * @param int $options The same options that the class' constructor
142487     *   takes; except that the size option is ignored. It is automatically
142488     *   calculated to be the same as the number of entries in the hash,
142489     *   rounded up to the nearest power of two with a maximum limit of
142490     *   4194304.
142491     * @return QuickHashIntStringHash Returns a new QuickHashIntStringHash.
142492     * @since PECL quickhash >= Unknown
142493     **/
142494    public static function loadFromFile($filename, $size, $options){}
142495
142496    /**
142497     * This factory method creates a hash from a string
142498     *
142499     * This factory method creates a new hash from a definition in a string.
142500     * The format is the same as the one used in "loadFromFile".
142501     *
142502     * @param string $contents The string containing a serialized format of
142503     *   the hash.
142504     * @param int $size The amount of bucket lists to configure. The number
142505     *   you pass in will be automatically rounded up to the next power of
142506     *   two. It is also automatically limited from 4 to 4194304.
142507     * @param int $options The same options that the class' constructor
142508     *   takes; except that the size option is ignored. It is automatically
142509     *   calculated to be the same as the number of entries in the hash,
142510     *   rounded up to the nearest power of two with a maximum limit of
142511     *   4194304.
142512     * @return QuickHashIntStringHash Returns a new QuickHashIntStringHash.
142513     * @since PECL quickhash >= Unknown
142514     **/
142515    public static function loadFromString($contents, $size, $options){}
142516
142517    /**
142518     * This method stores an in-memory hash to disk
142519     *
142520     * This method stores an existing hash to a file on disk, in the same
142521     * format that loadFromFile() can read.
142522     *
142523     * @param string $filename The filename of the file to store the hash
142524     *   in.
142525     * @return void
142526     * @since PECL quickhash >= Unknown
142527     **/
142528    public function saveToFile($filename){}
142529
142530    /**
142531     * This method returns a serialized version of the hash
142532     *
142533     * This method returns a serialized version of the hash in the same
142534     * format that loadFromString() can read.
142535     *
142536     * @return string This method returns a string containing a serialized
142537     *   format of the hash. Each element is stored as a four byte value in
142538     *   the Endianness that the current system uses.
142539     * @since PECL quickhash >= Unknown
142540     **/
142541    public function saveToString(){}
142542
142543    /**
142544     * This method updates an entry in the hash with a new value, or adds a
142545     * new one if the entry doesn't exist
142546     *
142547     * This method tries to update an entry with a new value. In case the
142548     * entry did not yet exist, it will instead add a new entry. It returns
142549     * whether the entry was added or update. If there are duplicate keys,
142550     * only the first found element will get an updated value. Use
142551     * QuickHashIntStringHash::CHECK_FOR_DUPES during hash creation to
142552     * prevent duplicate keys from being part of the hash.
142553     *
142554     * @param int $key The key of the entry to add or update.
142555     * @param string $value The value of the entry to add. If a non-string
142556     *   is passed, it will be converted to a string automatically if
142557     *   possible.
142558     * @return int 2 if the entry was found and updated, 1 if the entry was
142559     *   newly added or 0 if there was an error.
142560     * @since PECL quickhash >= Unknown
142561     **/
142562    public function set($key, $value){}
142563
142564    /**
142565     * This method updates an entry in the hash with a new value
142566     *
142567     * This method updates an entry with a new value, and returns whether the
142568     * entry was update. If there are duplicate keys, only the first found
142569     * element will get an updated value. Use
142570     * QuickHashIntStringHash::CHECK_FOR_DUPES during hash creation to
142571     * prevent duplicate keys from being part of the hash.
142572     *
142573     * @param int $key The key of the entry to add.
142574     * @param string $value The new value for the entry. If a non-string is
142575     *   passed, it will be converted to a string automatically if possible.
142576     * @return bool TRUE when the entry was found and updated, and FALSE if
142577     *   the entry was not part of the hash already.
142578     * @since PECL quickhash >= Unknown
142579     **/
142580    public function update($key, $value){}
142581
142582    /**
142583     * Creates a new QuickHashIntStringHash object
142584     *
142585     * This constructor creates a new QuickHashIntStringHash. The size is the
142586     * amount of bucket lists to create. The more lists there are, the less
142587     * collisions you will have. Options are also supported.
142588     *
142589     * @param int $size The amount of bucket lists to configure. The number
142590     *   you pass in will be automatically rounded up to the next power of
142591     *   two. It is also automatically limited from 64 to 4194304.
142592     * @param int $options The options that you can pass in are:
142593     *   QuickHashIntStringHash::CHECK_FOR_DUPES, which makes sure no
142594     *   duplicate entries are added to the hash;
142595     *   QuickHashIntStringHash::DO_NOT_USE_ZEND_ALLOC to not use PHP's
142596     *   internal memory manager as well as one of
142597     *   QuickHashIntStringHash::HASHER_NO_HASH,
142598     *   QuickHashIntStringHash::HASHER_JENKINS1 or
142599     *   QuickHashIntStringHash::HASHER_JENKINS2. These last three configure
142600     *   which hashing algorithm to use. All options can be combined using
142601     *   bitmasks.
142602     * @since PECL quickhash >= Unknown
142603     **/
142604    public function __construct($size, $options){}
142605
142606}
142607/**
142608 * This class wraps around a hash containing strings, where the values
142609 * are integer numbers. Hashes are also available as implementation of
142610 * the ArrayAccess interface. Hashes can also be iterated over with
142611 * foreach as the Iterator interface is implemented as well. The order of
142612 * which elements are returned in is not guaranteed.
142613 **/
142614class QuickHashStringIntHash {
142615    /**
142616     * @var integer
142617     **/
142618    const CHECK_FOR_DUPES = 0;
142619
142620    /**
142621     * @var integer
142622     **/
142623    const DO_NOT_USE_ZEND_ALLOC = 0;
142624
142625    /**
142626     * This method adds a new entry to the hash
142627     *
142628     * This method adds a new entry to the hash, and returns whether the
142629     * entry was added. Entries are by default always added unless
142630     * QuickHashStringIntHash::CHECK_FOR_DUPES has been passed when the hash
142631     * was created.
142632     *
142633     * @param string $key The key of the entry to add.
142634     * @param int $value The value of the entry to add.
142635     * @return bool TRUE when the entry was added, and FALSE if the entry
142636     *   was not added.
142637     **/
142638    public function add($key, $value){}
142639
142640    /**
142641     * This method deletes am entry from the hash
142642     *
142643     * This method deletes an entry from the hash, and returns whether the
142644     * entry was deleted or not. Associated memory structures will not be
142645     * freed immediately, but rather when the hash itself is freed.
142646     *
142647     * Elements can not be deleted when the hash is used in an iterator. The
142648     * method will not throw an exception, but simply return FALSE like would
142649     * happen with any other deletion failure.
142650     *
142651     * @param string $key The key of the entry to delete.
142652     * @return bool TRUE when the entry was deleted, and FALSE if the entry
142653     *   was not deleted.
142654     **/
142655    public function delete($key){}
142656
142657    /**
142658     * This method checks whether a key is part of the hash
142659     *
142660     * This method checks whether an entry with the provided key exists in
142661     * the hash.
142662     *
142663     * @param string $key The key of the entry to check for whether it
142664     *   exists in the hash.
142665     * @return bool Returns TRUE when the entry was found, or FALSE when
142666     *   the entry is not found.
142667     **/
142668    public function exists($key){}
142669
142670    /**
142671     * This method retrieves a value from the hash by its key
142672     *
142673     * @param string $key The key of the entry to add.
142674     * @return mixed The value if the key exists, or NULL if the key wasn't
142675     *   part of the hash.
142676     **/
142677    public function get($key){}
142678
142679    /**
142680     * Returns the number of elements in the hash
142681     *
142682     * @return int The number of elements in the hash.
142683     **/
142684    public function getSize(){}
142685
142686    /**
142687     * This factory method creates a hash from a file
142688     *
142689     * This factory method creates a new hash from a definition file on disk.
142690     * The file format consists of a signature 'QH\0x21\0', the number of
142691     * elements as a 32 bit signed integer in system Endianness, an unsigned
142692     * 32 bit integer containing the number of element data to follow in
142693     * characters. This element data contains all the strings. The follows
142694     * another signed 32 bit integer containing the number of bucket lists.
142695     * After the header and the strings, the elements follow. They are
142696     * ordered by bucket list so that the keys don't have to be hashed in
142697     * order to restore the hash. For each bucket list, the following
142698     * information is stored (all as 32 bit integers): the bucket list index,
142699     * the number of elements in that list, and then in pairs of two unsigned
142700     * 32 bit integers the elements, where the first one is the index into
142701     * the string list containing the keys, and the second one the value. An
142702     * example could be:
142703     *
142704     * QuickHash StringIntHash file format 00000000 51 48 21 00 02 00 00 00
142705     * 09 00 00 00 40 00 00 00 |QH!.........@...| 00000010 4f 4e 45 00 4e 49
142706     * 4e 45 00 07 00 00 00 01 00 00 |ONE.NINE........| 00000020 00 00 00 00
142707     * 00 01 00 00 00 2f 00 00 00 01 00 00 |........./......| 00000030 00 04
142708     * 00 00 00 03 00 00 00 |.........| 00000039
142709     *
142710     * QuickHash IntHash file format header signature ('QH'; key type: 2;
142711     * value type: 1; filler: \0x00) 00000000 51 48 21 00
142712     *
142713     * number of elements: 00000004 02 00 00 00
142714     *
142715     * length of string values (9 characters): 00000008 09 00 00 00
142716     *
142717     * number of hash bucket lists (this is configured for hashes as argument
142718     * to the constructor normally, 64 in this case): 0000000C 40 00 00 00
142719     *
142720     * string values: 00000010 4f 4e 45 00 4e 49 4e 45 00
142721     *
142722     * bucket lists: bucket list 1 (with key 7, and 1 element): header: 07 00
142723     * 00 00 01 00 00 00 elements (key index: 0 ('ONE'), value = 0): 00 00 00
142724     * 00 01 00 00 00 bucket list 2 (with key 0x2f, and 1 element): header:
142725     * 2f 00 00 00 01 00 00 00 elements (key index: 4 ('NINE'), value = 3):
142726     * 04 00 00 00 03 00 00 00
142727     *
142728     * @param string $filename The filename of the file to read the hash
142729     *   from.
142730     * @param int $size The amount of bucket lists to configure. The number
142731     *   you pass in will be automatically rounded up to the next power of
142732     *   two. It is also automatically limited from 4 to 4194304.
142733     * @param int $options The same options that the class' constructor
142734     *   takes; except that the size option is ignored. It is read from the
142735     *   file format (unlike the QuickHashIntHash and QuickHashIntStringHash
142736     *   classes, where it is automatically calculated from the number of
142737     *   entries in the hash.)
142738     * @return QuickHashStringIntHash Returns a new QuickHashStringIntHash.
142739     **/
142740    public static function loadFromFile($filename, $size, $options){}
142741
142742    /**
142743     * This factory method creates a hash from a string
142744     *
142745     * This factory method creates a new hash from a definition in a string.
142746     * The format is the same as the one used in "loadFromFile".
142747     *
142748     * @param string $contents The string containing a serialized format of
142749     *   the hash.
142750     * @param int $size The amount of bucket lists to configure. The number
142751     *   you pass in will be automatically rounded up to the next power of
142752     *   two. It is also automatically limited from 4 to 4194304.
142753     * @param int $options The same options that the class' constructor
142754     *   takes; except that the size option is ignored. It is automatically
142755     *   calculated to be the same as the number of entries in the hash,
142756     *   rounded up to the nearest power of two with a maximum limit of
142757     *   4194304.
142758     * @return QuickHashStringIntHash Returns a new QuickHashStringIntHash.
142759     **/
142760    public static function loadFromString($contents, $size, $options){}
142761
142762    /**
142763     * This method stores an in-memory hash to disk
142764     *
142765     * This method stores an existing hash to a file on disk, in the same
142766     * format that loadFromFile() can read.
142767     *
142768     * @param string $filename The filename of the file to store the hash
142769     *   in.
142770     * @return void
142771     **/
142772    public function saveToFile($filename){}
142773
142774    /**
142775     * This method returns a serialized version of the hash
142776     *
142777     * This method returns a serialized version of the hash in the same
142778     * format that loadFromString() can read.
142779     *
142780     * @return string This method returns a serialized format of an
142781     *   existing hash, in the same format that loadFromString() can read.
142782     **/
142783    public function saveToString(){}
142784
142785    /**
142786     * This method updates an entry in the hash with a new value, or adds a
142787     * new one if the entry doesn't exist
142788     *
142789     * This method tries to update an entry with a new value. In case the
142790     * entry did not yet exist, it will instead add a new entry. It returns
142791     * whether the entry was added or update. If there are duplicate keys,
142792     * only the first found element will get an updated value. Use
142793     * QuickHashStringIntHash::CHECK_FOR_DUPES during hash creation to
142794     * prevent duplicate keys from being part of the hash.
142795     *
142796     * @param string $key The key of the entry to add or update.
142797     * @param int $value The value of the entry to add. If a non-string is
142798     *   passed, it will be converted to a string automatically if possible.
142799     * @return int 2 if the entry was found and updated, 1 if the entry was
142800     *   newly added or 0 if there was an error.
142801     **/
142802    public function set($key, $value){}
142803
142804    /**
142805     * This method updates an entry in the hash with a new value
142806     *
142807     * This method updates an entry with a new value, and returns whether the
142808     * entry was update. If there are duplicate keys, only the first found
142809     * element will get an updated value. Use
142810     * QuickHashStringIntHash::CHECK_FOR_DUPES during hash creation to
142811     * prevent duplicate keys from being part of the hash.
142812     *
142813     * @param string $key The key of the entry to add.
142814     * @param int $value The new value for the entry. If a non-string is
142815     *   passed, it will be converted to a string automatically if possible.
142816     * @return bool TRUE when the entry was found and updated, and FALSE if
142817     *   the entry was not part of the hash already.
142818     **/
142819    public function update($key, $value){}
142820
142821    /**
142822     * Creates a new QuickHashStringIntHash object
142823     *
142824     * This constructor creates a new QuickHashStringIntHash. The size is the
142825     * amount of bucket lists to create. The more lists there are, the less
142826     * collisions you will have. Options are also supported.
142827     *
142828     * @param int $size The amount of bucket lists to configure. The number
142829     *   you pass in will be automatically rounded up to the next power of
142830     *   two. It is also automatically limited from 64 to 4194304.
142831     * @param int $options The options that you can pass in are:
142832     *   QuickHashStringIntHash::CHECK_FOR_DUPES, which makes sure no
142833     *   duplicate entries are added to the hash and
142834     *   QuickHashStringIntHash::DO_NOT_USE_ZEND_ALLOC to not use PHP's
142835     *   internal memory manager.
142836     **/
142837    public function __construct($size, $options){}
142838
142839}
142840/**
142841 * Exception thrown to indicate range errors during program execution.
142842 * Normally this means there was an arithmetic error other than
142843 * under/overflow. This is the runtime version of DomainException.
142844 **/
142845class RangeException extends RuntimeException {
142846}
142847/**
142848 * This class represents a RAR archive, which may be formed by several
142849 * volumes (parts) and which contains a number of RAR entries (i.e.,
142850 * files, directories and other special objects such as symbolic links).
142851 * Objects of this class can be traversed, yielding the entries stored in
142852 * the respective RAR archive. Those entries can also be obtained through
142853 * RarArchive::getEntry and RarArchive::getEntries.
142854 **/
142855final class RarArchive implements Traversable {
142856    /**
142857     * Close RAR archive and free all resources
142858     *
142859     * Close RAR archive and free all allocated resources.
142860     *
142861     * @return bool
142862     * @since PECL rar >= 2.0.0
142863     **/
142864    public function close(){}
142865
142866    /**
142867     * Get comment text from the RAR archive
142868     *
142869     * Get the (global) comment stored in the RAR archive. It may be up to 64
142870     * KiB long.
142871     *
142872     * @return string Returns the comment or NULL if there is none.
142873     * @since PECL rar >= 2.0.0
142874     **/
142875    public function getComment(){}
142876
142877    /**
142878     * Get full list of entries from the RAR archive
142879     *
142880     * Get entries list (files and directories) from the RAR archive.
142881     *
142882     * @return array {@link rar_list} returns array of RarEntry objects .
142883     * @since PECL rar >= 2.0.0
142884     **/
142885    public function getEntries(){}
142886
142887    /**
142888     * Get entry object from the RAR archive
142889     *
142890     * Get entry object (file or directory) from the RAR archive.
142891     *
142892     * @param string $entryname A RarArchive object, opened with {@link
142893     *   rar_open}.
142894     * @return RarEntry Returns the matching RarEntry object .
142895     * @since PECL rar >= 2.0.0
142896     **/
142897    public function getEntry($entryname){}
142898
142899    /**
142900     * Test whether an archive is broken (incomplete)
142901     *
142902     * This function determines whether an archive is incomplete, i.e., if a
142903     * volume is missing or a volume is truncated.
142904     *
142905     * @return bool Returns TRUE if the archive is broken, FALSE otherwise.
142906     *   This function may also return FALSE if the passed file has already
142907     *   been closed. The only way to tell the two cases apart is to enable
142908     *   exceptions with RarException::setUsingExceptions; however, this
142909     *   should be unnecessary as a program should not operate on closed
142910     *   files.
142911     * @since PECL rar >= 3.0.0
142912     **/
142913    public function isBroken(){}
142914
142915    /**
142916     * Check whether the RAR archive is solid
142917     *
142918     * Check whether the RAR archive is solid. Individual file extraction is
142919     * slower on solid archives.
142920     *
142921     * @return bool Returns TRUE if the archive is solid, FALSE otherwise.
142922     * @since PECL rar >= 2.0.0
142923     **/
142924    public function isSolid(){}
142925
142926    /**
142927     * Open RAR archive
142928     *
142929     * Open specified RAR archive and return RarArchive instance representing
142930     * it.
142931     *
142932     * @param string $filename Path to the Rar archive.
142933     * @param string $password A plain password, if needed to decrypt the
142934     *   headers. It will also be used by default if encrypted files are
142935     *   found. Note that the files may have different passwords in respect
142936     *   to the headers and among them.
142937     * @param callable $volume_callback A function that receives one
142938     *   parameter – the path of the volume that was not found – and
142939     *   returns a string with the correct path for such volume or NULL if
142940     *   such volume does not exist or is not known. The programmer should
142941     *   ensure the passed function doesn't cause loops as this function is
142942     *   called repeatedly if the path returned in a previous call did not
142943     *   correspond to the needed volume. Specifying this parameter omits the
142944     *   notice that would otherwise be emitted whenever a volume is not
142945     *   found; an implementation that only returns NULL can therefore be
142946     *   used to merely omit such notices.
142947     * @return RarArchive Returns the requested RarArchive instance .
142948     * @since PECL rar >= 2.0.0
142949     **/
142950    public static function open($filename, $password, $volume_callback){}
142951
142952    /**
142953     * Whether opening broken archives is allowed
142954     *
142955     * This method defines whether broken archives can be read or all the
142956     * operations that attempt to extract the archive entries will fail.
142957     * Broken archives are archives for which no error is detected when the
142958     * file is opened but an error occurs when reading the entries.
142959     *
142960     * @param bool $allow_broken A RarArchive object, opened with {@link
142961     *   rar_open}.
142962     * @return bool Returns TRUE . It will only fail if the file has
142963     *   already been closed.
142964     * @since PECL rar >= 3.0.0
142965     **/
142966    public function setAllowBroken($allow_broken){}
142967
142968    /**
142969     * Get text representation
142970     *
142971     * Provides a string representation for this RarArchive object. It
142972     * currently shows the full path name of the archive volume that was
142973     * opened and whether the resource is valid or was already closed through
142974     * a call to RarArchive::close.
142975     *
142976     * This method may be used only for debugging purposes, as there are no
142977     * guarantees as to which information the result contains or how it is
142978     * formatted.
142979     *
142980     * @return string A textual representation of this RarArchive object.
142981     *   The content of this representation is unspecified.
142982     * @since PECL rar >= 2.0.0
142983     **/
142984    public function __toString(){}
142985
142986}
142987/**
142988 * A RAR entry, representing a directory or a compressed file inside a
142989 * RAR archive.
142990 **/
142991final class RarEntry {
142992    /**
142993     * @var integer
142994     **/
142995    const ATTRIBUTE_UNIX_BLOCK_DEV = 0;
142996
142997    /**
142998     * @var integer
142999     **/
143000    const ATTRIBUTE_UNIX_CHAR_DEV = 0;
143001
143002    /**
143003     * @var integer
143004     **/
143005    const ATTRIBUTE_UNIX_DIRECTORY = 0;
143006
143007    /**
143008     * @var integer
143009     **/
143010    const ATTRIBUTE_UNIX_FIFO = 0;
143011
143012    /**
143013     * @var integer
143014     **/
143015    const ATTRIBUTE_UNIX_FINAL_QUARTET = 0;
143016
143017    /**
143018     * @var integer
143019     **/
143020    const ATTRIBUTE_UNIX_GROUP_EXECUTE = 0;
143021
143022    /**
143023     * @var integer
143024     **/
143025    const ATTRIBUTE_UNIX_GROUP_READ = 0;
143026
143027    /**
143028     * @var integer
143029     **/
143030    const ATTRIBUTE_UNIX_GROUP_WRITE = 0;
143031
143032    /**
143033     * @var integer
143034     **/
143035    const ATTRIBUTE_UNIX_OWNER_EXECUTE = 0;
143036
143037    /**
143038     * @var integer
143039     **/
143040    const ATTRIBUTE_UNIX_OWNER_READ = 0;
143041
143042    /**
143043     * @var integer
143044     **/
143045    const ATTRIBUTE_UNIX_OWNER_WRITE = 0;
143046
143047    /**
143048     * @var integer
143049     **/
143050    const ATTRIBUTE_UNIX_REGULAR_FILE = 0;
143051
143052    /**
143053     * @var integer
143054     **/
143055    const ATTRIBUTE_UNIX_SETGID = 0;
143056
143057    /**
143058     * @var integer
143059     **/
143060    const ATTRIBUTE_UNIX_SETUID = 0;
143061
143062    /**
143063     * @var integer
143064     **/
143065    const ATTRIBUTE_UNIX_SOCKET = 0;
143066
143067    /**
143068     * @var integer
143069     **/
143070    const ATTRIBUTE_UNIX_STICKY = 0;
143071
143072    /**
143073     * @var integer
143074     **/
143075    const ATTRIBUTE_UNIX_SYM_LINK = 0;
143076
143077    /**
143078     * @var integer
143079     **/
143080    const ATTRIBUTE_UNIX_WORLD_EXECUTE = 0;
143081
143082    /**
143083     * @var integer
143084     **/
143085    const ATTRIBUTE_UNIX_WORLD_READ = 0;
143086
143087    /**
143088     * @var integer
143089     **/
143090    const ATTRIBUTE_UNIX_WORLD_WRITE = 0;
143091
143092    /**
143093     * @var integer
143094     **/
143095    const ATTRIBUTE_WIN_ARCHIVE = 0;
143096
143097    /**
143098     * @var integer
143099     **/
143100    const ATTRIBUTE_WIN_COMPRESSED = 0;
143101
143102    /**
143103     * @var integer
143104     **/
143105    const ATTRIBUTE_WIN_DEVICE = 0;
143106
143107    /**
143108     * @var integer
143109     **/
143110    const ATTRIBUTE_WIN_DIRECTORY = 0;
143111
143112    /**
143113     * @var integer
143114     **/
143115    const ATTRIBUTE_WIN_ENCRYPTED = 0;
143116
143117    /**
143118     * @var integer
143119     **/
143120    const ATTRIBUTE_WIN_HIDDEN = 0;
143121
143122    /**
143123     * @var integer
143124     **/
143125    const ATTRIBUTE_WIN_NORMAL = 0;
143126
143127    /**
143128     * @var integer
143129     **/
143130    const ATTRIBUTE_WIN_NOT_CONTENT_INDEXED = 0;
143131
143132    /**
143133     * @var integer
143134     **/
143135    const ATTRIBUTE_WIN_OFFLINE = 0;
143136
143137    /**
143138     * @var integer
143139     **/
143140    const ATTRIBUTE_WIN_READONLY = 0;
143141
143142    /**
143143     * @var integer
143144     **/
143145    const ATTRIBUTE_WIN_REPARSE_POINT = 0;
143146
143147    /**
143148     * @var integer
143149     **/
143150    const ATTRIBUTE_WIN_SPARSE_FILE = 0;
143151
143152    /**
143153     * @var integer
143154     **/
143155    const ATTRIBUTE_WIN_SYSTEM = 0;
143156
143157    /**
143158     * @var integer
143159     **/
143160    const ATTRIBUTE_WIN_TEMPORARY = 0;
143161
143162    /**
143163     * @var integer
143164     **/
143165    const ATTRIBUTE_WIN_VIRTUAL = 0;
143166
143167    /**
143168     * @var integer
143169     **/
143170    const HOST_BEOS = 0;
143171
143172    /**
143173     * @var integer
143174     **/
143175    const HOST_MACOS = 0;
143176
143177    /**
143178     * @var integer
143179     **/
143180    const HOST_MSDOS = 0;
143181
143182    /**
143183     * @var integer
143184     **/
143185    const HOST_OS2 = 0;
143186
143187    /**
143188     * @var integer
143189     **/
143190    const HOST_UNIX = 0;
143191
143192    /**
143193     * @var integer
143194     **/
143195    const HOST_WIN32 = 0;
143196
143197    /**
143198     * Extract entry from the archive
143199     *
143200     * RarEntry::extract extracts the entry's data. It will create new file
143201     * in the specified {@link dir} with the name identical to the entry's
143202     * name, unless the second argument is specified. See below for more
143203     * information.
143204     *
143205     * @param string $dir Path to the directory where files should be
143206     *   extracted. This parameter is considered if and only if {@link
143207     *   filepath} is not. If both parameters are empty an extraction to the
143208     *   current directory will be attempted.
143209     * @param string $filepath Path (relative or absolute) containing the
143210     *   directory and filename of the extracted file. This parameter
143211     *   overrides both the parameter {@link dir} and the original file name.
143212     * @param string $password The password used to encrypt this entry. If
143213     *   the entry is not encrypted, this value will not be used and can be
143214     *   omitted. If this parameter is omitted and the entry is encrypted,
143215     *   the password given to {@link rar_open}, if any, will be used. If a
143216     *   wrong password is given, either explicitly or implicitly via {@link
143217     *   rar_open}, CRC checking will fail and this method will fail and
143218     *   return FALSE. If no password is given and one is required, this
143219     *   method will fail and return FALSE. You can check whether an entry is
143220     *   encrypted with RarEntry::isEncrypted.
143221     * @param bool $extended_data If TRUE, extended information such as
143222     *   NTFS ACLs and Unix owner information will be set in the extract
143223     *   files, as long as it's present in the archive.
143224     * @return bool
143225     * @since PECL rar >= 0.1
143226     **/
143227    public function extract($dir, $filepath, $password, $extended_data){}
143228
143229    /**
143230     * Get attributes of the entry
143231     *
143232     * Returns the OS-dependent attributes of the archive entry.
143233     *
143234     * @return int Returns the attributes or FALSE on error.
143235     * @since PECL rar >= 0.1
143236     **/
143237    public function getAttr(){}
143238
143239    /**
143240     * Get CRC of the entry
143241     *
143242     * Returns an hexadecimal string representation of the CRC of the archive
143243     * entry.
143244     *
143245     * @return string Returns the CRC of the archive entry or FALSE on
143246     *   error.
143247     * @since PECL rar >= 0.1
143248     **/
143249    public function getCrc(){}
143250
143251    /**
143252     * Get entry last modification time
143253     *
143254     * Gets entry last modification time.
143255     *
143256     * @return string Returns entry last modification time as string in
143257     *   format YYYY-MM-DD HH:II:SS, or FALSE on error.
143258     * @since PECL rar >= 0.1
143259     **/
143260    public function getFileTime(){}
143261
143262    /**
143263     * Get entry host OS
143264     *
143265     * Returns the code of the host OS of the archive entry.
143266     *
143267     * @return int Returns the code of the host OS, or FALSE on error.
143268     * @since PECL rar >= 0.1
143269     **/
143270    public function getHostOs(){}
143271
143272    /**
143273     * Get pack method of the entry
143274     *
143275     * RarEntry::getMethod returns number of the method used when adding
143276     * current archive entry.
143277     *
143278     * @return int Returns the method number or FALSE on error.
143279     * @since PECL rar >= 0.1
143280     **/
143281    public function getMethod(){}
143282
143283    /**
143284     * Get name of the entry
143285     *
143286     * Returns the name (with path) of the archive entry.
143287     *
143288     * @return string Returns the entry name as a string, or FALSE on
143289     *   error.
143290     * @since PECL rar >= 0.1
143291     **/
143292    public function getName(){}
143293
143294    /**
143295     * Get packed size of the entry
143296     *
143297     * Get packed size of the archive entry.
143298     *
143299     * @return int Returns the packed size, or FALSE on error.
143300     * @since PECL rar >= 0.1
143301     **/
143302    public function getPackedSize(){}
143303
143304    /**
143305     * Get file handler for entry
143306     *
143307     * Returns a file handler that supports read operations. This handler
143308     * provides on-the-fly decompression for this entry.
143309     *
143310     * The handler is not invalidated by calling {@link rar_close}.
143311     *
143312     * @param string $password The password used to encrypt this entry. If
143313     *   the entry is not encrypted, this value will not be used and can be
143314     *   omitted. If this parameter is omitted and the entry is encrypted,
143315     *   the password given to {@link rar_open}, if any, will be used. If a
143316     *   wrong password is given, either explicitly or implicitly via {@link
143317     *   rar_open}, this method's resulting stream will produce wrong output.
143318     *   If no password is given and one is required, this method will fail
143319     *   and return FALSE. You can check whether an entry is encrypted with
143320     *   RarEntry::isEncrypted.
143321     * @return resource The file handler .
143322     * @since PECL rar >= 2.0.0
143323     **/
143324    public function getStream($password){}
143325
143326    /**
143327     * Get unpacked size of the entry
143328     *
143329     * Get unpacked size of the archive entry.
143330     *
143331     * @return int Returns the unpacked size, or FALSE on error.
143332     * @since PECL rar >= 0.1
143333     **/
143334    public function getUnpackedSize(){}
143335
143336    /**
143337     * Get minimum version of RAR program required to unpack the entry
143338     *
143339     * Returns minimum version of RAR program (e.g. WinRAR) required to
143340     * unpack the entry. It is encoded as 10 * major version + minor version.
143341     *
143342     * @return int Returns the version or FALSE on error.
143343     * @since PECL rar >= 0.1
143344     **/
143345    public function getVersion(){}
143346
143347    /**
143348     * Test whether an entry represents a directory
143349     *
143350     * Tests whether the current entry is a directory.
143351     *
143352     * @return bool Returns TRUE if this entry is a directory and FALSE
143353     *   otherwise.
143354     * @since PECL rar >= 2.0.0
143355     **/
143356    public function isDirectory(){}
143357
143358    /**
143359     * Test whether an entry is encrypted
143360     *
143361     * Tests whether the current entry contents are encrypted.
143362     *
143363     * @return bool Returns TRUE if the current entry is encrypted and
143364     *   FALSE otherwise.
143365     * @since PECL rar >= 2.0.0
143366     **/
143367    public function isEncrypted(){}
143368
143369    /**
143370     * Get text representation of entry
143371     *
143372     * RarEntry::__toString returns a textual representation for this entry.
143373     * It includes whether the entry is a file or a directory (symbolic links
143374     * and other special objects will be treated as files), the UTF-8 name of
143375     * the entry and its CRC. The form and content of this representation may
143376     * be changed in the future, so they cannot be relied upon.
143377     *
143378     * @return string A textual representation for the entry.
143379     * @since PECL rar >= 2.0.0
143380     **/
143381    public function __toString(){}
143382
143383}
143384/**
143385 * This class serves two purposes: it is the type of the exceptions
143386 * thrown by the RAR extension functions and methods and it allows,
143387 * through static methods to query and define the error behaviour of the
143388 * extension, i.e., whether exceptions are thrown or only warnings are
143389 * emitted. The following error codes are used:
143390 **/
143391final class RarException extends Exception {
143392    /**
143393     * Check whether error handling with exceptions is in use
143394     *
143395     * Checks whether the RAR functions will emit warnings and return error
143396     * values or whether they will throw exceptions in most of the
143397     * circumstances (does not include some programmatic errors such as
143398     * passing the wrong type of arguments).
143399     *
143400     * @return bool Returns TRUE if exceptions are being used, FALSE
143401     *   otherwise.
143402     * @since PECL rar >= 2.0.0
143403     **/
143404    public static function isUsingExceptions(){}
143405
143406    /**
143407     * Activate and deactivate error handling with exceptions
143408     *
143409     * If and only if the argument is TRUE, then, instead of emitting
143410     * warnings and returning a special value indicating error when the UnRAR
143411     * library encounters an error, an exception of type RarException will be
143412     * thrown.
143413     *
143414     * Exceptions will also be thrown for the following errors, which occur
143415     * outside the library (their error code will be -1):
143416     *
143417     * @param bool $using_exceptions Should be TRUE to activate exception
143418     *   throwing, FALSE to deactivate (the default).
143419     * @return void
143420     * @since PECL rar >= 2.0.0
143421     **/
143422    public static function setUsingExceptions($using_exceptions){}
143423
143424}
143425/**
143426 * This iterator allows to unset and modify values and keys while
143427 * iterating over Arrays and Objects in the same way as the
143428 * ArrayIterator. Additionally it is possible to iterate over the current
143429 * iterator entry.
143430 **/
143431class RecursiveArrayIterator extends ArrayIterator implements RecursiveIterator {
143432    /**
143433     * Treat only arrays (not objects) as having children for recursive
143434     * iteration.
143435     *
143436     * @var mixed
143437     **/
143438    const CHILD_ARRAYS_ONLY = 0;
143439
143440    /**
143441     * Returns an iterator for the current entry if it is an or an
143442     *
143443     * Returns an iterator for the current iterator entry.
143444     *
143445     * @return RecursiveArrayIterator An iterator for the current entry, if
143446     *   it is an array or object.
143447     * @since PHP 5 >= 5.1.0, PHP 7
143448     **/
143449    public function getChildren(){}
143450
143451    /**
143452     * Returns whether current entry is an array or an object
143453     *
143454     * Returns whether current entry is an array or an object for which an
143455     * iterator can be obtained via RecursiveArrayIterator::getChildren.
143456     *
143457     * @return bool Returns TRUE if the current entry is an array or an
143458     *   object, otherwise FALSE is returned.
143459     * @since PHP 5 >= 5.1.0, PHP 7
143460     **/
143461    public function hasChildren(){}
143462
143463}
143464/**
143465 * ...
143466 **/
143467class RecursiveCachingIterator extends CachingIterator implements Countable, ArrayAccess, OuterIterator, RecursiveIterator {
143468    /**
143469     * Return the inner iterator's children as a RecursiveCachingIterator
143470     *
143471     * @return RecursiveCachingIterator The inner iterator's children, as a
143472     *   RecursiveCachingIterator.
143473     * @since PHP 5 >= 5.1.0, PHP 7
143474     **/
143475    public function getChildren(){}
143476
143477    /**
143478     * Check whether the current element of the inner iterator has children
143479     *
143480     * @return bool TRUE if the inner iterator has children, otherwise
143481     *   FALSE
143482     * @since PHP 5 >= 5.1.0, PHP 7
143483     **/
143484    public function hasChildren(){}
143485
143486    /**
143487     * Construct
143488     *
143489     * Constructs a new RecursiveCachingIterator, which consists of a passed
143490     * in {@link iterator}.
143491     *
143492     * @param Iterator $iterator The iterator being used.
143493     * @param int $flags The flags. Use CALL_TOSTRING to call
143494     *   RecursiveCachingIterator::__toString for every element (the
143495     *   default), and/or CATCH_GET_CHILD to catch exceptions when trying to
143496     *   get children.
143497     * @since PHP 5 >= 5.1.0, PHP 7
143498     **/
143499    public function __construct($iterator, $flags){}
143500
143501}
143502/**
143503 * The callback should accept up to three arguments: the current item,
143504 * the current key and the iterator, respectively. Filtering a recursive
143505 * iterator generally involves two conditions. The first is that, to
143506 * allow recursion, the callback function should return TRUE if the
143507 * current iterator item has children. The second is the normal filter
143508 * condition, such as a file size or extension check as in the example
143509 * below.
143510 **/
143511class RecursiveCallbackFilterIterator extends CallbackFilterIterator implements OuterIterator, RecursiveIterator {
143512    /**
143513     * Return the inner iterator's children contained in a
143514     * RecursiveCallbackFilterIterator
143515     *
143516     * Fetches the filtered children of the inner iterator.
143517     *
143518     * RecursiveCallbackFilterIterator::hasChildren should be used to
143519     * determine if there are children to be fetched.
143520     *
143521     * @return RecursiveCallbackFilterIterator Returns a
143522     *   RecursiveCallbackFilterIterator containing the children.
143523     * @since PHP 5 >= 5.4.0, PHP 7
143524     **/
143525    public function getChildren(){}
143526
143527    /**
143528     * Check whether the inner iterator's current element has children
143529     *
143530     * Returns TRUE if the current element has children, FALSE otherwise.
143531     *
143532     * @return bool Returns TRUE if the current element has children, FALSE
143533     *   otherwise.
143534     * @since PHP 5 >= 5.4.0, PHP 7
143535     **/
143536    public function hasChildren(){}
143537
143538}
143539/**
143540 * The RecursiveDirectoryIterator provides an interface for iterating
143541 * recursively over filesystem directories.
143542 **/
143543class RecursiveDirectoryIterator extends FilesystemIterator implements SeekableIterator, RecursiveIterator {
143544    /**
143545     * Returns an iterator for the current entry if it is a directory
143546     *
143547     * @return mixed The filename, file information, or $this depending on
143548     *   the set flags. See the FilesystemIterator constants.
143549     * @since PHP 5 >= 5.1.0, PHP 7
143550     **/
143551    public function getChildren(){}
143552
143553    /**
143554     * Get sub path
143555     *
143556     * Returns the sub path relative to the directory given in the
143557     * constructor.
143558     *
143559     * @return string The sub path.
143560     * @since PHP 5 >= 5.1.0, PHP 7
143561     **/
143562    public function getSubPath(){}
143563
143564    /**
143565     * Get sub path and name
143566     *
143567     * Gets the sub path and filename.
143568     *
143569     * @return string The sub path (sub directory) and filename.
143570     * @since PHP 5 >= 5.1.0, PHP 7
143571     **/
143572    public function getSubPathname(){}
143573
143574    /**
143575     * Returns whether current entry is a directory and not '.' or '..'
143576     *
143577     * @param bool $allow_links
143578     * @return bool Returns whether the current entry is a directory, but
143579     *   not '.' or '..'
143580     * @since PHP 5, PHP 7
143581     **/
143582    public function hasChildren($allow_links){}
143583
143584    /**
143585     * Return path and filename of current dir entry
143586     *
143587     * @return string The path and filename of the current dir entry.
143588     * @since PHP 5, PHP 7
143589     **/
143590    public function key(){}
143591
143592    /**
143593     * Move to next entry
143594     *
143595     * @return void
143596     * @since PHP 5, PHP 7
143597     **/
143598    public function next(){}
143599
143600    /**
143601     * Rewind dir back to the start
143602     *
143603     * @return void
143604     * @since PHP 5, PHP 7
143605     **/
143606    public function rewind(){}
143607
143608    /**
143609     * Constructs a RecursiveDirectoryIterator
143610     *
143611     * Constructs a RecursiveDirectoryIterator for the provided {@link path}.
143612     *
143613     * @param string $path The path of the directory to be iterated over.
143614     * @param int $flags Flags may be provided which will affect the
143615     *   behavior of some methods. A list of the flags can found under
143616     *   FilesystemIterator predefined constants. They can also be set later
143617     *   with FilesystemIterator::setFlags.
143618     * @since PHP 5 >= 5.1.2, PHP 7
143619     **/
143620    public function __construct($path, $flags){}
143621
143622}
143623/**
143624 * This abstract iterator filters out unwanted values for a
143625 * RecursiveIterator. This class should be extended to implement custom
143626 * filters. The RecursiveFilterIterator::accept must be implemented in
143627 * the subclass.
143628 **/
143629abstract class RecursiveFilterIterator extends FilterIterator implements OuterIterator, RecursiveIterator {
143630    /**
143631     * Return the inner iterator's children contained in a
143632     * RecursiveFilterIterator
143633     *
143634     * Return the inner iterator's children contained in a
143635     * RecursiveFilterIterator.
143636     *
143637     * @return RecursiveFilterIterator Returns a RecursiveFilterIterator
143638     *   containing the inner iterator's children.
143639     * @since PHP 5 >= 5.1.0, PHP 7
143640     **/
143641    public function getChildren(){}
143642
143643    /**
143644     * Check whether the inner iterator's current element has children
143645     *
143646     * @return bool TRUE if the inner iterator has children, otherwise
143647     *   FALSE
143648     * @since PHP 5 >= 5.1.0, PHP 7
143649     **/
143650    public function hasChildren(){}
143651
143652    /**
143653     * Create a RecursiveFilterIterator from a RecursiveIterator
143654     *
143655     * Create a RecursiveFilterIterator from a RecursiveIterator.
143656     *
143657     * @param RecursiveIterator $iterator The RecursiveIterator to be
143658     *   filtered.
143659     * @since PHP 5 >= 5.1.0, PHP 7
143660     **/
143661    public function __construct($iterator){}
143662
143663}
143664/**
143665 * Classes implementing RecursiveIterator can be used to iterate over
143666 * iterators recursively.
143667 **/
143668interface RecursiveIterator extends Iterator {
143669    /**
143670     * Returns an iterator for the current entry
143671     *
143672     * Returns an iterator for the current iterator entry.
143673     *
143674     * @return RecursiveIterator An iterator for the current entry.
143675     * @since PHP 5 >= 5.1.0, PHP 7
143676     **/
143677    public function getChildren();
143678
143679    /**
143680     * Returns if an iterator can be created for the current entry
143681     *
143682     * Returns if an iterator can be created for the current entry.
143683     * RecursiveIterator::getChildren.
143684     *
143685     * @return bool Returns TRUE if the current entry can be iterated over,
143686     *   otherwise returns FALSE.
143687     * @since PHP 5 >= 5.1.0, PHP 7
143688     **/
143689    public function hasChildren();
143690
143691}
143692/**
143693 * Can be used to iterate through recursive iterators.
143694 **/
143695class RecursiveIteratorIterator implements OuterIterator {
143696    /**
143697     * @var integer
143698     **/
143699    const CATCH_GET_CHILD = 0;
143700
143701    /**
143702     * @var integer
143703     **/
143704    const CHILD_FIRST = 0;
143705
143706    /**
143707     * @var integer
143708     **/
143709    const LEAVES_ONLY = 0;
143710
143711    /**
143712     * @var integer
143713     **/
143714    const SELF_FIRST = 0;
143715
143716    /**
143717     * Begin children
143718     *
143719     * Is called after calling RecursiveIteratorIterator::getChildren, and
143720     * its associated RecursiveIteratorIterator::rewind.
143721     *
143722     * @return void
143723     * @since PHP 5 >= 5.1.0, PHP 7
143724     **/
143725    public function beginChildren(){}
143726
143727    /**
143728     * Begin Iteration
143729     *
143730     * Called when iteration begins (after the first
143731     * RecursiveIteratorIterator::rewind call.
143732     *
143733     * @return void
143734     * @since PHP 5 >= 5.1.0, PHP 7
143735     **/
143736    public function beginIteration(){}
143737
143738    /**
143739     * Get children
143740     *
143741     * Get children of the current element.
143742     *
143743     * @return RecursiveIterator A RecursiveIterator.
143744     * @since PHP 5 >= 5.1.0, PHP 7
143745     **/
143746    public function callGetChildren(){}
143747
143748    /**
143749     * Has children
143750     *
143751     * Called for each element to test whether it has children.
143752     *
143753     * @return bool TRUE if the element has children, otherwise FALSE
143754     * @since PHP 5 >= 5.1.0, PHP 7
143755     **/
143756    public function callHasChildren(){}
143757
143758    /**
143759     * Access the current element value
143760     *
143761     * @return mixed The current elements value.
143762     * @since PHP 5, PHP 7
143763     **/
143764    public function current(){}
143765
143766    /**
143767     * End children
143768     *
143769     * Called when end recursing one level.
143770     *
143771     * @return void
143772     * @since PHP 5 >= 5.1.0, PHP 7
143773     **/
143774    public function endChildren(){}
143775
143776    /**
143777     * End Iteration
143778     *
143779     * Called when the iteration ends (when RecursiveIteratorIterator::valid
143780     * first returns FALSE.
143781     *
143782     * @return void
143783     * @since PHP 5 >= 5.1.0, PHP 7
143784     **/
143785    public function endIteration(){}
143786
143787    /**
143788     * Get the current depth of the recursive iteration
143789     *
143790     * @return int The current depth of the recursive iteration.
143791     * @since PHP 5, PHP 7
143792     **/
143793    public function getDepth(){}
143794
143795    /**
143796     * Get inner iterator
143797     *
143798     * Gets the current active sub iterator.
143799     *
143800     * @return iterator The current active sub iterator.
143801     * @since PHP 5 >= 5.1.0, PHP 7
143802     **/
143803    public function getInnerIterator(){}
143804
143805    /**
143806     * Get max depth
143807     *
143808     * Gets the maximum allowable depth.
143809     *
143810     * @return mixed The maximum accepted depth, or FALSE if any depth is
143811     *   allowed.
143812     * @since PHP 5 >= 5.1.0, PHP 7
143813     **/
143814    public function getMaxDepth(){}
143815
143816    /**
143817     * The current active sub iterator
143818     *
143819     * @param int $level
143820     * @return RecursiveIterator The current active sub iterator.
143821     * @since PHP 5, PHP 7
143822     **/
143823    public function getSubIterator($level){}
143824
143825    /**
143826     * Access the current key
143827     *
143828     * @return mixed The current key.
143829     * @since PHP 5, PHP 7
143830     **/
143831    public function key(){}
143832
143833    /**
143834     * Move forward to the next element
143835     *
143836     * @return void
143837     * @since PHP 5, PHP 7
143838     **/
143839    public function next(){}
143840
143841    /**
143842     * Next element
143843     *
143844     * Called when the next element is available.
143845     *
143846     * @return void
143847     * @since PHP 5 >= 5.1.0, PHP 7
143848     **/
143849    public function nextElement(){}
143850
143851    /**
143852     * Rewind the iterator to the first element of the top level inner
143853     * iterator
143854     *
143855     * @return void
143856     * @since PHP 5, PHP 7
143857     **/
143858    public function rewind(){}
143859
143860    /**
143861     * Set max depth
143862     *
143863     * Set the maximum allowed depth.
143864     *
143865     * @param int $max_depth The maximum allowed depth. -1 is used for any
143866     *   depth.
143867     * @return void
143868     * @since PHP 5 >= 5.1.0, PHP 7
143869     **/
143870    public function setMaxDepth($max_depth){}
143871
143872    /**
143873     * Check whether the current position is valid
143874     *
143875     * @return bool TRUE if the current position is valid, otherwise FALSE
143876     * @since PHP 5, PHP 7
143877     **/
143878    public function valid(){}
143879
143880    /**
143881     * Construct a RecursiveIteratorIterator
143882     *
143883     * Creates a RecursiveIteratorIterator from a RecursiveIterator.
143884     *
143885     * @param Traversable $iterator The iterator being constructed from.
143886     *   Either a RecursiveIterator or IteratorAggregate.
143887     * @param int $mode Optional mode. Possible values are
143888     *   RecursiveIteratorIterator::LEAVES_ONLY - The default. Lists only
143889     *   leaves in iteration. RecursiveIteratorIterator::SELF_FIRST - Lists
143890     *   leaves and parents in iteration with parents coming first.
143891     *   RecursiveIteratorIterator::CHILD_FIRST - Lists leaves and parents in
143892     *   iteration with leaves coming first.
143893     * @param int $flags Optional flag. Possible values are
143894     *   RecursiveIteratorIterator::CATCH_GET_CHILD which will then ignore
143895     *   exceptions thrown in calls to
143896     *   RecursiveIteratorIterator::getChildren.
143897     * @since PHP 5 >= 5.1.3, PHP 7
143898     **/
143899    public function __construct($iterator, $mode, $flags){}
143900
143901}
143902/**
143903 * This recursive iterator can filter another recursive iterator via a
143904 * regular expression.
143905 **/
143906class RecursiveRegexIterator extends RegexIterator implements RecursiveIterator {
143907    /**
143908     * Returns an iterator for the current entry
143909     *
143910     * Returns an iterator for the current iterator entry.
143911     *
143912     * @return RecursiveRegexIterator An iterator for the current entry, if
143913     *   it can be iterated over by the inner iterator.
143914     * @since PHP 5 >= 5.2.0, PHP 7
143915     **/
143916    public function getChildren(){}
143917
143918    /**
143919     * Returns whether an iterator can be obtained for the current entry
143920     *
143921     * Returns whether an iterator can be obtained for the current entry.
143922     * This iterator can be obtained via RecursiveRegexIterator::getChildren.
143923     *
143924     * @return bool Returns TRUE if an iterator can be obtained for the
143925     *   current entry, otherwise returns FALSE.
143926     * @since PHP 5 >= 5.2.0, PHP 7
143927     **/
143928    public function hasChildren(){}
143929
143930}
143931/**
143932 * Allows iterating over a RecursiveIterator to generate an ASCII graphic
143933 * tree.
143934 **/
143935class RecursiveTreeIterator extends RecursiveIteratorIterator implements OuterIterator {
143936    /**
143937     * @var integer
143938     **/
143939    const BYPASS_CURRENT = 0;
143940
143941    /**
143942     * @var integer
143943     **/
143944    const BYPASS_KEY = 0;
143945
143946    /**
143947     * @var integer
143948     **/
143949    const PREFIX_END_HAS_NEXT = 0;
143950
143951    /**
143952     * @var integer
143953     **/
143954    const PREFIX_END_LAST = 0;
143955
143956    /**
143957     * @var integer
143958     **/
143959    const PREFIX_LEFT = 0;
143960
143961    /**
143962     * @var integer
143963     **/
143964    const PREFIX_MID_HAS_NEXT = 0;
143965
143966    /**
143967     * @var integer
143968     **/
143969    const PREFIX_MID_LAST = 0;
143970
143971    /**
143972     * @var integer
143973     **/
143974    const PREFIX_RIGHT = 0;
143975
143976    /**
143977     * Begin children
143978     *
143979     * Called when recursing one level down.
143980     *
143981     * @return void
143982     * @since PHP 5 >= 5.3.0, PHP 7
143983     **/
143984    public function beginChildren(){}
143985
143986    /**
143987     * Begin iteration
143988     *
143989     * Called when iteration begins (after the first
143990     * RecursiveTreeIterator::rewind call).
143991     *
143992     * @return RecursiveIterator A RecursiveIterator.
143993     * @since PHP 5 >= 5.3.0, PHP 7
143994     **/
143995    public function beginIteration(){}
143996
143997    /**
143998     * Get children
143999     *
144000     * Gets children of the current element.
144001     *
144002     * @return RecursiveIterator A RecursiveIterator.
144003     * @since PHP 5 >= 5.3.0, PHP 7
144004     **/
144005    public function callGetChildren(){}
144006
144007    /**
144008     * Has children
144009     *
144010     * Called for each element to test whether it has children.
144011     *
144012     * @return bool TRUE if there are children, otherwise FALSE
144013     * @since PHP 5 >= 5.3.0, PHP 7
144014     **/
144015    public function callHasChildren(){}
144016
144017    /**
144018     * Get current element
144019     *
144020     * Gets the current element prefixed and postfixed.
144021     *
144022     * @return string Returns the current element prefixed and postfixed.
144023     * @since PHP 5 >= 5.3.0, PHP 7
144024     **/
144025    public function current(){}
144026
144027    /**
144028     * End children
144029     *
144030     * Called when end recursing one level.
144031     *
144032     * @return void
144033     * @since PHP 5 >= 5.3.0, PHP 7
144034     **/
144035    public function endChildren(){}
144036
144037    /**
144038     * End iteration
144039     *
144040     * Called when the iteration ends (when RecursiveTreeIterator::valid
144041     * first returns FALSE)
144042     *
144043     * @return void
144044     * @since PHP 5 >= 5.3.0, PHP 7
144045     **/
144046    public function endIteration(){}
144047
144048    /**
144049     * Get current entry
144050     *
144051     * Gets the part of the tree built for the current element.
144052     *
144053     * @return string Returns the part of the tree built for the current
144054     *   element.
144055     * @since PHP 5 >= 5.3.0, PHP 7
144056     **/
144057    public function getEntry(){}
144058
144059    /**
144060     * Get the postfix
144061     *
144062     * Gets the string to place after the current element.
144063     *
144064     * @return string Returns the string to place after the current
144065     *   element.
144066     * @since PHP 5 >= 5.3.0, PHP 7
144067     **/
144068    public function getPostfix(){}
144069
144070    /**
144071     * Get the prefix
144072     *
144073     * Gets the string to place in front of current element
144074     *
144075     * @return string Returns the string to place in front of current
144076     *   element
144077     * @since PHP 5 >= 5.3.0, PHP 7
144078     **/
144079    public function getPrefix(){}
144080
144081    /**
144082     * Get the key of the current element
144083     *
144084     * Gets the current key prefixed and postfixed.
144085     *
144086     * @return string Returns the current key prefixed and postfixed.
144087     * @since PHP 5 >= 5.3.0, PHP 7
144088     **/
144089    public function key(){}
144090
144091    /**
144092     * Move to next element
144093     *
144094     * Moves forward to the next element.
144095     *
144096     * @return void
144097     * @since PHP 5 >= 5.3.0, PHP 7
144098     **/
144099    public function next(){}
144100
144101    /**
144102     * Next element
144103     *
144104     * Called when the next element is available.
144105     *
144106     * @return void
144107     * @since PHP 5 >= 5.3.0, PHP 7
144108     **/
144109    public function nextElement(){}
144110
144111    /**
144112     * Rewind iterator
144113     *
144114     * Rewinds the iterator to the first element of the top level inner
144115     * iterator.
144116     *
144117     * @return void
144118     * @since PHP 5 >= 5.3.0, PHP 7
144119     **/
144120    public function rewind(){}
144121
144122    /**
144123     * Set postfix
144124     *
144125     * Sets postfix as used in RecursiveTreeIterator::getPostfix.
144126     *
144127     * @param string $postfix
144128     * @return void
144129     * @since PHP 5 >= 5.5.3, PHP 7
144130     **/
144131    public function setPostfix($postfix){}
144132
144133    /**
144134     * Set a part of the prefix
144135     *
144136     * Sets a part of the prefix used in the graphic tree.
144137     *
144138     * @param int $part One of the RecursiveTreeIterator::PREFIX_*
144139     *   constants.
144140     * @param string $value The value to assign to the part of the prefix
144141     *   specified in {@link part}.
144142     * @return void
144143     * @since PHP 5 >= 5.3.0, PHP 7
144144     **/
144145    public function setPrefixPart($part, $value){}
144146
144147    /**
144148     * Check validity
144149     *
144150     * Check whether the current position is valid.
144151     *
144152     * @return bool TRUE if the current position is valid, otherwise FALSE
144153     * @since PHP 5 >= 5.3.0, PHP 7
144154     **/
144155    public function valid(){}
144156
144157    /**
144158     * Construct a RecursiveTreeIterator
144159     *
144160     * Constructs a new RecursiveTreeIterator from the supplied recursive
144161     * iterator.
144162     *
144163     * @param RecursiveIterator|IteratorAggregate $it The RecursiveIterator
144164     *   or IteratorAggregate to iterate over.
144165     * @param int $flags Flags may be provided which will affect the
144166     *   behavior of some methods. A list of the flags can found under
144167     *   RecursiveTreeIterator predefined constants.
144168     * @param int $cit_flags Flags to affect the behavior of the
144169     *   RecursiveCachingIterator used internally.
144170     * @param int $mode Flags to affect the behavior of the
144171     *   RecursiveIteratorIterator used internally.
144172     * @since PHP 5 >= 5.3.0, PHP 7
144173     **/
144174    public function __construct($it, $flags, $cit_flags, $mode){}
144175
144176}
144177/**
144178 * The reflection class.
144179 **/
144180class Reflection {
144181    /**
144182     * Exports
144183     *
144184     * Exports a reflection.
144185     *
144186     * @param Reflector $reflector
144187     * @param bool $return
144188     * @return string
144189     * @since PHP 5, PHP 7
144190     **/
144191    public static function export($reflector, $return){}
144192
144193    /**
144194     * Gets modifier names
144195     *
144196     * @param int $modifiers Bitfield of the modifiers to get.
144197     * @return array An array of modifier names.
144198     * @since PHP 5, PHP 7
144199     **/
144200    public static function getModifierNames($modifiers){}
144201
144202}
144203/**
144204 * The ReflectionClass class reports information about a class.
144205 **/
144206class ReflectionClass implements Reflector {
144207    /**
144208     * @var integer
144209     **/
144210    const IS_EXPLICIT_ABSTRACT = 0;
144211
144212    /**
144213     * @var integer
144214     **/
144215    const IS_FINAL = 0;
144216
144217    /**
144218     * @var integer
144219     **/
144220    const IS_IMPLICIT_ABSTRACT = 0;
144221
144222    /**
144223     * Name of the class. Read-only, throws ReflectionException in attempt to
144224     * write.
144225     *
144226     * @var mixed
144227     **/
144228    public $name;
144229
144230    /**
144231     * Exports a class
144232     *
144233     * Exports a reflected class.
144234     *
144235     * @param mixed $argument
144236     * @param bool $return
144237     * @return string
144238     * @since PHP 5, PHP 7
144239     **/
144240    public static function export($argument, $return){}
144241
144242    /**
144243     * Gets defined constant
144244     *
144245     * Gets the defined constant.
144246     *
144247     * @param string $name The name of the class constant to get.
144248     * @return mixed Value of the constant with the name {@link name}.
144249     *   Returns FALSE if the constant was not found in the class.
144250     * @since PHP 5, PHP 7
144251     **/
144252    public function getConstant($name){}
144253
144254    /**
144255     * Gets constants
144256     *
144257     * Gets all defined constants from a class, regardless of their
144258     * visibility.
144259     *
144260     * @return array An array of constants, where the keys hold the name
144261     *   and the values the value of the constants.
144262     * @since PHP 5, PHP 7
144263     **/
144264    public function getConstants(){}
144265
144266    /**
144267     * Gets the constructor of the class
144268     *
144269     * Gets the constructor of the reflected class.
144270     *
144271     * @return ReflectionMethod A ReflectionMethod object reflecting the
144272     *   class' constructor, or NULL if the class has no constructor.
144273     * @since PHP 5, PHP 7
144274     **/
144275    public function getConstructor(){}
144276
144277    /**
144278     * Gets default properties
144279     *
144280     * Gets default properties from a class (including inherited properties).
144281     *
144282     * @return array An array of default properties, with the key being the
144283     *   name of the property and the value being the default value of the
144284     *   property or NULL if the property doesn't have a default value. The
144285     *   function does not distinguish between static and non static
144286     *   properties and does not take visibility modifiers into account.
144287     * @since PHP 5, PHP 7
144288     **/
144289    public function getDefaultProperties(){}
144290
144291    /**
144292     * Gets doc comments
144293     *
144294     * Gets doc comments from a class. Doc comments start with /**. If there
144295     * are multiple doc comments above the class definition, the one closest
144296     * to the class will be taken.
144297     *
144298     * @return string The doc comment if it exists, otherwise FALSE
144299     * @since PHP 5, PHP 7
144300     **/
144301    public function getDocComment(){}
144302
144303    /**
144304     * Gets end line
144305     *
144306     * Gets end line number from a user-defined class definition.
144307     *
144308     * @return int The ending line number of the user defined class, or
144309     *   FALSE if unknown.
144310     * @since PHP 5, PHP 7
144311     **/
144312    public function getEndLine(){}
144313
144314    /**
144315     * Gets a object for the extension which defined the class
144316     *
144317     * Gets a ReflectionExtension object for the extension which defined the
144318     * class.
144319     *
144320     * @return ReflectionExtension A ReflectionExtension object
144321     *   representing the extension which defined the class, or NULL for
144322     *   user-defined classes.
144323     * @since PHP 5, PHP 7
144324     **/
144325    public function getExtension(){}
144326
144327    /**
144328     * Gets the name of the extension which defined the class
144329     *
144330     * @return string The name of the extension which defined the class, or
144331     *   FALSE for user-defined classes.
144332     * @since PHP 5, PHP 7
144333     **/
144334    public function getExtensionName(){}
144335
144336    /**
144337     * Gets the filename of the file in which the class has been defined
144338     *
144339     * @return string Returns the filename of the file in which the class
144340     *   has been defined. If the class is defined in the PHP core or in a
144341     *   PHP extension, FALSE is returned.
144342     * @since PHP 5, PHP 7
144343     **/
144344    public function getFileName(){}
144345
144346    /**
144347     * Gets the interface names
144348     *
144349     * Get the interface names.
144350     *
144351     * @return array A numerical array with interface names as the values.
144352     * @since PHP 5 >= 5.2.0, PHP 7
144353     **/
144354    public function getInterfaceNames(){}
144355
144356    /**
144357     * Gets the interfaces
144358     *
144359     * @return array An associative array of interfaces, with keys as
144360     *   interface names and the array values as ReflectionClass objects.
144361     * @since PHP 5, PHP 7
144362     **/
144363    public function getInterfaces(){}
144364
144365    /**
144366     * Gets a for a class method
144367     *
144368     * Gets a ReflectionMethod for a class method.
144369     *
144370     * @param string $name The method name to reflect.
144371     * @return ReflectionMethod A ReflectionMethod.
144372     * @since PHP 5, PHP 7
144373     **/
144374    public function getMethod($name){}
144375
144376    /**
144377     * Gets an array of methods
144378     *
144379     * Gets an array of methods for the class.
144380     *
144381     * @param int $filter Filter the results to include only methods with
144382     *   certain attributes. Defaults to no filtering. Any bitwise
144383     *   disjunction of ReflectionMethod::IS_STATIC,
144384     *   ReflectionMethod::IS_PUBLIC, ReflectionMethod::IS_PROTECTED,
144385     *   ReflectionMethod::IS_PRIVATE, ReflectionMethod::IS_ABSTRACT,
144386     *   ReflectionMethod::IS_FINAL, so that all methods with any of the
144387     *   given attributes will be returned.
144388     * @return array An array of ReflectionMethod objects reflecting each
144389     *   method.
144390     * @since PHP 5, PHP 7
144391     **/
144392    public function getMethods($filter){}
144393
144394    /**
144395     * Gets the class modifiers
144396     *
144397     * Returns a bitfield of the access modifiers for this class.
144398     *
144399     * @return int Returns bitmask of modifier constants.
144400     * @since PHP 5, PHP 7
144401     **/
144402    public function getModifiers(){}
144403
144404    /**
144405     * Gets class name
144406     *
144407     * Gets the class name.
144408     *
144409     * @return string The class name.
144410     * @since PHP 5, PHP 7
144411     **/
144412    public function getName(){}
144413
144414    /**
144415     * Gets namespace name
144416     *
144417     * Gets the namespace name.
144418     *
144419     * @return string The namespace name.
144420     * @since PHP 5 >= 5.3.0, PHP 7
144421     **/
144422    public function getNamespaceName(){}
144423
144424    /**
144425     * Gets parent class
144426     *
144427     * @return ReflectionClass A ReflectionClass or FALSE if there's no
144428     *   parent.
144429     * @since PHP 5, PHP 7
144430     **/
144431    public function getParentClass(){}
144432
144433    /**
144434     * Gets properties
144435     *
144436     * Retrieves reflected properties.
144437     *
144438     * @param int $filter The optional filter, for filtering desired
144439     *   property types. It's configured using the ReflectionProperty
144440     *   constants, and defaults to all property types.
144441     * @return array An array of ReflectionProperty objects.
144442     * @since PHP 5, PHP 7
144443     **/
144444    public function getProperties($filter){}
144445
144446    /**
144447     * Gets a for a class's property
144448     *
144449     * Gets a ReflectionProperty for a class's property.
144450     *
144451     * @param string $name The property name.
144452     * @return ReflectionProperty A ReflectionProperty.
144453     * @since PHP 5, PHP 7
144454     **/
144455    public function getProperty($name){}
144456
144457    /**
144458     * Gets a for a class's constant
144459     *
144460     * Gets a ReflectionClassConstant for a class's property.
144461     *
144462     * @param string $name The class constant name.
144463     * @return ReflectionClassConstant A ReflectionClassConstant.
144464     * @since PHP 7 >= 7.1.0
144465     **/
144466    public function getReflectionConstant($name){}
144467
144468    /**
144469     * Gets class constants
144470     *
144471     * Retrieves reflected constants.
144472     *
144473     * @return array An array of ReflectionClassConstant objects.
144474     * @since PHP 7 >= 7.1.0
144475     **/
144476    public function getReflectionConstants(){}
144477
144478    /**
144479     * Gets short name
144480     *
144481     * Gets the short name of the class, the part without the namespace.
144482     *
144483     * @return string The class short name.
144484     * @since PHP 5 >= 5.3.0, PHP 7
144485     **/
144486    public function getShortName(){}
144487
144488    /**
144489     * Gets starting line number
144490     *
144491     * Get the starting line number.
144492     *
144493     * @return int The starting line number, as an integer.
144494     * @since PHP 5, PHP 7
144495     **/
144496    public function getStartLine(){}
144497
144498    /**
144499     * Gets static properties
144500     *
144501     * Get the static properties.
144502     *
144503     * @return array The static properties, as an array.
144504     * @since PHP 5, PHP 7
144505     **/
144506    public function getStaticProperties(){}
144507
144508    /**
144509     * Gets static property value
144510     *
144511     * Gets the value of a static property on this class.
144512     *
144513     * @param string $name The name of the static property for which to
144514     *   return a value.
144515     * @param mixed $def_value A default value to return in case the class
144516     *   does not declare a static property with the given {@link name}. If
144517     *   the property does not exist and this argument is omitted, a
144518     *   ReflectionException is thrown.
144519     * @return mixed The value of the static property.
144520     * @since PHP 5 >= 5.1.2, PHP 7
144521     **/
144522    public function getStaticPropertyValue($name, &$def_value){}
144523
144524    /**
144525     * Returns an array of trait aliases
144526     *
144527     * @return array Returns an array with new method names in keys and
144528     *   original names (in the format "TraitName::original") in values.
144529     *   Returns NULL in case of an error.
144530     * @since PHP 5 >= 5.4.0, PHP 7
144531     **/
144532    public function getTraitAliases(){}
144533
144534    /**
144535     * Returns an array of names of traits used by this class
144536     *
144537     * @return array Returns an array with trait names in values. Returns
144538     *   NULL in case of an error.
144539     * @since PHP 5 >= 5.4.0, PHP 7
144540     **/
144541    public function getTraitNames(){}
144542
144543    /**
144544     * Returns an array of traits used by this class
144545     *
144546     * @return array Returns an array with trait names in keys and
144547     *   instances of trait's ReflectionClass in values. Returns NULL in case
144548     *   of an error.
144549     * @since PHP 5 >= 5.4.0, PHP 7
144550     **/
144551    public function getTraits(){}
144552
144553    /**
144554     * Checks if constant is defined
144555     *
144556     * Checks whether the class has a specific constant defined or not.
144557     *
144558     * @param string $name The name of the constant being checked for.
144559     * @return bool TRUE if the constant is defined, otherwise FALSE.
144560     * @since PHP 5 >= 5.1.2, PHP 7
144561     **/
144562    public function hasConstant($name){}
144563
144564    /**
144565     * Checks if method is defined
144566     *
144567     * Checks whether a specific method is defined in a class.
144568     *
144569     * @param string $name Name of the method being checked for.
144570     * @return bool TRUE if it has the method, otherwise FALSE
144571     * @since PHP 5 >= 5.1.2, PHP 7
144572     **/
144573    public function hasMethod($name){}
144574
144575    /**
144576     * Checks if property is defined
144577     *
144578     * Checks whether the specified property is defined.
144579     *
144580     * @param string $name Name of the property being checked for.
144581     * @return bool TRUE if it has the property, otherwise FALSE
144582     * @since PHP 5 >= 5.1.2, PHP 7
144583     **/
144584    public function hasProperty($name){}
144585
144586    /**
144587     * Implements interface
144588     *
144589     * Checks whether it implements an interface.
144590     *
144591     * @param string $interface The interface name.
144592     * @return bool
144593     * @since PHP 5, PHP 7
144594     **/
144595    public function implementsInterface($interface){}
144596
144597    /**
144598     * Checks if in namespace
144599     *
144600     * Checks if this class is defined in a namespace.
144601     *
144602     * @return bool
144603     * @since PHP 5 >= 5.3.0, PHP 7
144604     **/
144605    public function inNamespace(){}
144606
144607    /**
144608     * Checks if class is abstract
144609     *
144610     * Checks if the class is abstract.
144611     *
144612     * @return bool
144613     * @since PHP 5, PHP 7
144614     **/
144615    public function isAbstract(){}
144616
144617    /**
144618     * Checks if class is anonymous
144619     *
144620     * Checks if a class is an anonymous class.
144621     *
144622     * @return bool
144623     * @since PHP 7
144624     **/
144625    public function isAnonymous(){}
144626
144627    /**
144628     * Returns whether this class is cloneable
144629     *
144630     * @return bool Returns TRUE if the class is cloneable, FALSE
144631     *   otherwise.
144632     * @since PHP 5 >= 5.4.0, PHP 7
144633     **/
144634    public function isCloneable(){}
144635
144636    /**
144637     * Checks if class is final
144638     *
144639     * Checks if a class is final.
144640     *
144641     * @return bool
144642     * @since PHP 5, PHP 7
144643     **/
144644    public function isFinal(){}
144645
144646    /**
144647     * Checks class for instance
144648     *
144649     * Checks if an object is an instance of a class.
144650     *
144651     * @param object $object The object being compared to.
144652     * @return bool
144653     * @since PHP 5, PHP 7
144654     **/
144655    public function isInstance($object){}
144656
144657    /**
144658     * Checks if the class is instantiable
144659     *
144660     * @return bool
144661     * @since PHP 5, PHP 7
144662     **/
144663    public function isInstantiable(){}
144664
144665    /**
144666     * Checks if the class is an interface
144667     *
144668     * Checks whether the class is an interface.
144669     *
144670     * @return bool
144671     * @since PHP 5, PHP 7
144672     **/
144673    public function isInterface(){}
144674
144675    /**
144676     * Checks if class is defined internally by an extension, or the core
144677     *
144678     * Checks if the class is defined internally by an extension, or the
144679     * core, as opposed to user-defined.
144680     *
144681     * @return bool
144682     * @since PHP 5, PHP 7
144683     **/
144684    public function isInternal(){}
144685
144686    /**
144687     * Check whether this class is iterable
144688     *
144689     * Check whether this class is iterable (i.e. can be used inside ).
144690     *
144691     * @return bool
144692     * @since PHP 7 >= 7.2.0
144693     **/
144694    public function isIterable(){}
144695
144696    /**
144697     * Checks if a subclass
144698     *
144699     * Checks if the class is a subclass of a specified class or implements a
144700     * specified interface.
144701     *
144702     * @param mixed $class Either the name of the class as string or a
144703     *   ReflectionClass object of the class to check against.
144704     * @return bool
144705     * @since PHP 5, PHP 7
144706     **/
144707    public function isSubclassOf($class){}
144708
144709    /**
144710     * Returns whether this is a trait
144711     *
144712     * @return bool Returns TRUE if this is a trait, FALSE otherwise.
144713     *   Returns NULL in case of an error.
144714     * @since PHP 5 >= 5.4.0, PHP 7
144715     **/
144716    public function isTrait(){}
144717
144718    /**
144719     * Checks if user defined
144720     *
144721     * Checks whether the class is user-defined, as opposed to internal.
144722     *
144723     * @return bool
144724     * @since PHP 5, PHP 7
144725     **/
144726    public function isUserDefined(){}
144727
144728    /**
144729     * Creates a new class instance from given arguments
144730     *
144731     * Creates a new instance of the class. The given arguments are passed to
144732     * the class constructor.
144733     *
144734     * @param mixed ...$vararg Accepts a variable number of arguments which
144735     *   are passed to the class constructor, much like {@link
144736     *   call_user_func}.
144737     * @return object
144738     * @since PHP 5, PHP 7
144739     **/
144740    public function newInstance(...$vararg){}
144741
144742    /**
144743     * Creates a new class instance from given arguments
144744     *
144745     * Creates a new instance of the class, the given arguments are passed to
144746     * the class constructor.
144747     *
144748     * @param array $args The parameters to be passed to the class
144749     *   constructor as an array.
144750     * @return object Returns a new instance of the class.
144751     * @since PHP 5 >= 5.1.3, PHP 7
144752     **/
144753    public function newInstanceArgs($args){}
144754
144755    /**
144756     * Creates a new class instance without invoking the constructor
144757     *
144758     * Creates a new instance of the class without invoking the constructor.
144759     *
144760     * @return object
144761     * @since PHP 5 >= 5.4.0, PHP 7
144762     **/
144763    public function newInstanceWithoutConstructor(){}
144764
144765    /**
144766     * Sets static property value
144767     *
144768     * @param string $name Property name.
144769     * @param mixed $value New property value.
144770     * @return void
144771     * @since PHP 5 >= 5.1.2, PHP 7
144772     **/
144773    public function setStaticPropertyValue($name, $value){}
144774
144775    /**
144776     * Constructs a ReflectionClass
144777     *
144778     * Constructs a new ReflectionClass object.
144779     *
144780     * @param mixed $argument Either a string containing the name of the
144781     *   class to reflect, or an object.
144782     * @since PHP 5, PHP 7
144783     **/
144784    public function __construct($argument){}
144785
144786    /**
144787     * Returns the string representation of the ReflectionClass object
144788     *
144789     * @return string A string representation of this ReflectionClass
144790     *   instance.
144791     * @since PHP 5, PHP 7
144792     **/
144793    public function __toString(){}
144794
144795}
144796/**
144797 * The ReflectionClassConstant class reports information about a class
144798 * constant.
144799 **/
144800class ReflectionClassConstant implements Reflector {
144801    /**
144802     * Name of the class where the class constant is defined. Read-only,
144803     * throws ReflectionException in attempt to write.
144804     *
144805     * @var mixed
144806     **/
144807    public $class;
144808
144809    /**
144810     * Name of the class constant. Read-only, throws ReflectionException in
144811     * attempt to write.
144812     *
144813     * @var mixed
144814     **/
144815    public $name;
144816
144817    /**
144818     * Export
144819     *
144820     * Exports a reflection.
144821     *
144822     * @param mixed $class
144823     * @param string $name The class constant name.
144824     * @param bool $return
144825     * @return string
144826     * @since PHP 7 >= 7.1.0
144827     **/
144828    public static function export($class, $name, $return){}
144829
144830    /**
144831     * Gets declaring class
144832     *
144833     * Gets the declaring class.
144834     *
144835     * @return ReflectionClass A ReflectionClass object.
144836     * @since PHP 7 >= 7.1.0
144837     **/
144838    public function getDeclaringClass(){}
144839
144840    /**
144841     * Gets doc comments
144842     *
144843     * Gets doc comments from a class constant.
144844     *
144845     * @return string The doc comment if it exists, otherwise FALSE
144846     * @since PHP 7 >= 7.1.0
144847     **/
144848    public function getDocComment(){}
144849
144850    /**
144851     * Gets the class constant modifiers
144852     *
144853     * Returns a bitfield of the access modifiers for this class constant.
144854     *
144855     * @return int A numeric representation of the modifiers. The actual
144856     *   meanings of these modifiers are described in the predefined
144857     *   constants.
144858     * @since PHP 7 >= 7.1.0
144859     **/
144860    public function getModifiers(){}
144861
144862    /**
144863     * Get name of the constant
144864     *
144865     * @return string Returns the constant's name.
144866     * @since PHP 7 >= 7.1.0
144867     **/
144868    public function getName(){}
144869
144870    /**
144871     * Gets value
144872     *
144873     * Gets the class constant's value.
144874     *
144875     * @return mixed The value of the class constant.
144876     * @since PHP 7 >= 7.1.0
144877     **/
144878    public function getValue(){}
144879
144880    /**
144881     * Checks if class constant is private
144882     *
144883     * Checks if the class constant is private.
144884     *
144885     * @return bool TRUE if the class constant is private, otherwise FALSE
144886     * @since PHP 7 >= 7.1.0
144887     **/
144888    public function isPrivate(){}
144889
144890    /**
144891     * Checks if class constant is protected
144892     *
144893     * Checks if the class constant is protected.
144894     *
144895     * @return bool TRUE if the class constant is protected, otherwise
144896     *   FALSE
144897     * @since PHP 7 >= 7.1.0
144898     **/
144899    public function isProtected(){}
144900
144901    /**
144902     * Checks if class constant is public
144903     *
144904     * Checks if the class constant is public.
144905     *
144906     * @return bool TRUE if the class constant is public, otherwise FALSE
144907     * @since PHP 7 >= 7.1.0
144908     **/
144909    public function isPublic(){}
144910
144911    /**
144912     * Constructs a ReflectionClassConstant
144913     *
144914     * Constructs a new ReflectionClassConstant object.
144915     *
144916     * @param mixed $class Either a string containing the name of the class
144917     *   to reflect, or an object.
144918     * @param string $name The name of the class constant.
144919     * @since PHP 7 >= 7.1.0
144920     **/
144921    public function __construct($class, $name){}
144922
144923    /**
144924     * Returns the string representation of the ReflectionClassConstant
144925     * object
144926     *
144927     * @return string A string representation of this
144928     *   ReflectionClassConstant instance.
144929     * @since PHP 7 >= 7.1.0
144930     **/
144931    public function __toString(){}
144932
144933}
144934/**
144935 * The ReflectionException class.
144936 **/
144937class ReflectionException extends Exception {
144938}
144939/**
144940 * The ReflectionExtension class reports information about an extension.
144941 **/
144942class ReflectionExtension implements Reflector {
144943    /**
144944     * Name of the extension, same as calling the
144945     * ReflectionExtension::getName method.
144946     *
144947     * @var mixed
144948     **/
144949    public $name;
144950
144951    /**
144952     * Export
144953     *
144954     * Exports a reflected extension. The output format of this function is
144955     * the same as the CLI argument --re [extension].
144956     *
144957     * @param string $name
144958     * @param string $return
144959     * @return string
144960     * @since PHP 5, PHP 7
144961     **/
144962    public static function export($name, $return){}
144963
144964    /**
144965     * Gets classes
144966     *
144967     * Gets a list of classes from an extension.
144968     *
144969     * @return array An array of ReflectionClass objects, one for each
144970     *   class within the extension. If no classes are defined, an empty
144971     *   array is returned.
144972     * @since PHP 5, PHP 7
144973     **/
144974    public function getClasses(){}
144975
144976    /**
144977     * Gets class names
144978     *
144979     * Gets a listing of class names as defined in the extension.
144980     *
144981     * @return array An array of class names, as defined in the extension.
144982     *   If no classes are defined, an empty array is returned.
144983     * @since PHP 5, PHP 7
144984     **/
144985    public function getClassNames(){}
144986
144987    /**
144988     * Gets constants
144989     *
144990     * Get defined constants from an extension.
144991     *
144992     * @return array An associative array with constant names as keys.
144993     * @since PHP 5, PHP 7
144994     **/
144995    public function getConstants(){}
144996
144997    /**
144998     * Gets dependencies
144999     *
145000     * Gets dependencies, by listing both required and conflicting
145001     * dependencies.
145002     *
145003     * @return array An associative array with dependencies as keys and
145004     *   either Required, Optional or Conflicts as the values.
145005     * @since PHP 5 >= 5.1.3, PHP 7
145006     **/
145007    public function getDependencies(){}
145008
145009    /**
145010     * Gets extension functions
145011     *
145012     * Get defined functions from an extension.
145013     *
145014     * @return array An associative array of ReflectionFunction objects,
145015     *   for each function defined in the extension with the keys being the
145016     *   function names. If no function are defined, an empty array is
145017     *   returned.
145018     * @since PHP 5, PHP 7
145019     **/
145020    public function getFunctions(){}
145021
145022    /**
145023     * Gets extension ini entries
145024     *
145025     * Get the ini entries for an extension.
145026     *
145027     * @return array An associative array with the ini entries as keys,
145028     *   with their defined values as values.
145029     * @since PHP 5, PHP 7
145030     **/
145031    public function getINIEntries(){}
145032
145033    /**
145034     * Gets extension name
145035     *
145036     * Gets the extensions name.
145037     *
145038     * @return string The extensions name.
145039     * @since PHP 5, PHP 7
145040     **/
145041    public function getName(){}
145042
145043    /**
145044     * Gets extension version
145045     *
145046     * Gets the version of the extension.
145047     *
145048     * @return string The version of the extension.
145049     * @since PHP 5, PHP 7
145050     **/
145051    public function getVersion(){}
145052
145053    /**
145054     * Print extension info
145055     *
145056     * Prints out the "{@link phpinfo}" snippet for the given extension.
145057     *
145058     * @return void Information about the extension.
145059     * @since PHP 5 >= 5.2.4, PHP 7
145060     **/
145061    public function info(){}
145062
145063    /**
145064     * Returns whether this extension is persistent
145065     *
145066     * @return void Returns TRUE for extensions loaded by extension, FALSE
145067     *   otherwise.
145068     * @since PHP 5 >= 5.4.0, PHP 7
145069     **/
145070    public function isPersistent(){}
145071
145072    /**
145073     * Returns whether this extension is temporary
145074     *
145075     * @return void Returns TRUE for extensions loaded by {@link dl}, FALSE
145076     *   otherwise.
145077     * @since PHP 5 >= 5.4.0, PHP 7
145078     **/
145079    public function isTemporary(){}
145080
145081    /**
145082     * Clones
145083     *
145084     * The clone method prevents an object from being cloned. Reflection
145085     * objects cannot be cloned.
145086     *
145087     * @return void No value is returned, if called a fatal error will
145088     *   occur.
145089     * @since PHP 5, PHP 7
145090     **/
145091    final private function __clone(){}
145092
145093    /**
145094     * Constructs a ReflectionExtension
145095     *
145096     * Construct a ReflectionExtension object.
145097     *
145098     * @param string $name Name of the extension.
145099     * @since PHP 5, PHP 7
145100     **/
145101    public function __construct($name){}
145102
145103    /**
145104     * To string
145105     *
145106     * Exports a reflected extension and returns it as a string. This is the
145107     * same as the ReflectionExtension::export with the {@link return} set to
145108     * TRUE.
145109     *
145110     * @return string Returns the exported extension as a string, in the
145111     *   same way as the ReflectionExtension::export.
145112     * @since PHP 5, PHP 7
145113     **/
145114    public function __toString(){}
145115
145116}
145117/**
145118 * The ReflectionFunction class reports information about a function.
145119 **/
145120class ReflectionFunction extends ReflectionFunctionAbstract implements Reflector {
145121    /**
145122     * @var integer
145123     **/
145124    const IS_DEPRECATED = 0;
145125
145126    /**
145127     * Name of the function. Read-only, throws ReflectionException in attempt
145128     * to write.
145129     *
145130     * @var mixed
145131     **/
145132    public $name;
145133
145134    /**
145135     * Exports function
145136     *
145137     * Exports a Reflected function.
145138     *
145139     * @param string $name
145140     * @param string $return
145141     * @return string
145142     * @since PHP 5, PHP 7
145143     **/
145144    public static function export($name, $return){}
145145
145146    /**
145147     * Returns a dynamically created closure for the function
145148     *
145149     * @return Closure Returns Closure. Returns NULL in case of an error.
145150     * @since PHP 5 >= 5.4.0, PHP 7
145151     **/
145152    public function getClosure(){}
145153
145154    /**
145155     * Invokes function
145156     *
145157     * Invokes a reflected function.
145158     *
145159     * @param mixed ...$vararg The passed in argument list. It accepts a
145160     *   variable number of arguments which are passed to the function much
145161     *   like {@link call_user_func} is.
145162     * @return mixed Returns the result of the invoked function call.
145163     * @since PHP 5, PHP 7
145164     **/
145165    public function invoke(...$vararg){}
145166
145167    /**
145168     * Invokes function args
145169     *
145170     * Invokes the function and pass its arguments as array.
145171     *
145172     * @param array $args The passed arguments to the function as an array,
145173     *   much like {@link call_user_func_array} works.
145174     * @return mixed Returns the result of the invoked function
145175     * @since PHP 5 >= 5.1.2, PHP 7
145176     **/
145177    public function invokeArgs($args){}
145178
145179    /**
145180     * Checks if function is disabled
145181     *
145182     * Checks if the function is disabled, via the disable_functions
145183     * directive.
145184     *
145185     * @return bool TRUE if it's disable, otherwise FALSE
145186     * @since PHP 5 >= 5.2.0, PHP 7
145187     **/
145188    public function isDisabled(){}
145189
145190    /**
145191     * Constructs a ReflectionFunction object
145192     *
145193     * Constructs a ReflectionFunction object.
145194     *
145195     * @param mixed $name The name of the function to reflect or a closure.
145196     * @since PHP 5, PHP 7
145197     **/
145198    public function __construct($name){}
145199
145200    /**
145201     * To string
145202     *
145203     * @return string Returns ReflectionFunction::export-like output for
145204     *   the function.
145205     * @since PHP 5, PHP 7
145206     **/
145207    public function __toString(){}
145208
145209}
145210/**
145211 * A parent class to ReflectionFunction, read its description for
145212 * details.
145213 **/
145214abstract class ReflectionFunctionAbstract implements Reflector {
145215    /**
145216     * Name of the function. Read-only, throws ReflectionException in attempt
145217     * to write.
145218     *
145219     * @var mixed
145220     **/
145221    public $name;
145222
145223    /**
145224     * Returns the scope associated to the closure
145225     *
145226     * @return ReflectionClass Returns the class on success or NULL on
145227     *   failure.
145228     * @since PHP 5 >= 5.4.0, PHP 7
145229     **/
145230    public function getClosureScopeClass(){}
145231
145232    /**
145233     * Returns this pointer bound to closure
145234     *
145235     * @return object Returns $this pointer. Returns NULL in case of an
145236     *   error.
145237     * @since PHP 5 >= 5.4.0, PHP 7
145238     **/
145239    public function getClosureThis(){}
145240
145241    /**
145242     * Gets doc comment
145243     *
145244     * Get a Doc comment from a function.
145245     *
145246     * @return string The doc comment if it exists, otherwise FALSE
145247     * @since PHP 5 >= 5.1.0, PHP 7
145248     **/
145249    public function getDocComment(){}
145250
145251    /**
145252     * Gets end line number
145253     *
145254     * Get the ending line number.
145255     *
145256     * @return int The ending line number of the user defined function, or
145257     *   FALSE if unknown.
145258     * @since PHP 5 >= 5.2.0, PHP 7
145259     **/
145260    public function getEndLine(){}
145261
145262    /**
145263     * Gets extension info
145264     *
145265     * Get the extension information of a function.
145266     *
145267     * @return ReflectionExtension The extension information, as a
145268     *   ReflectionExtension object.
145269     * @since PHP 5 >= 5.2.0, PHP 7
145270     **/
145271    public function getExtension(){}
145272
145273    /**
145274     * Gets extension name
145275     *
145276     * Get the extensions name.
145277     *
145278     * @return string The extensions name.
145279     * @since PHP 5 >= 5.2.0, PHP 7
145280     **/
145281    public function getExtensionName(){}
145282
145283    /**
145284     * Gets file name
145285     *
145286     * Gets the file name from a user-defined function.
145287     *
145288     * @return string The file name.
145289     * @since PHP 5 >= 5.2.0, PHP 7
145290     **/
145291    public function getFileName(){}
145292
145293    /**
145294     * Gets function name
145295     *
145296     * Get the name of the function.
145297     *
145298     * @return string The name of the function.
145299     * @since PHP 5 >= 5.2.0, PHP 7
145300     **/
145301    public function getName(){}
145302
145303    /**
145304     * Gets namespace name
145305     *
145306     * Get the namespace name where the class is defined.
145307     *
145308     * @return string The namespace name.
145309     * @since PHP 5 >= 5.3.0, PHP 7
145310     **/
145311    public function getNamespaceName(){}
145312
145313    /**
145314     * Gets number of parameters
145315     *
145316     * Get the number of parameters that a function defines, both optional
145317     * and required.
145318     *
145319     * @return int The number of parameters.
145320     * @since PHP 5 >= 5.3.0, PHP 7
145321     **/
145322    public function getNumberOfParameters(){}
145323
145324    /**
145325     * Gets number of required parameters
145326     *
145327     * Get the number of required parameters that a function defines.
145328     *
145329     * @return int The number of required parameters.
145330     * @since PHP 5 >= 5.3.0, PHP 7
145331     **/
145332    public function getNumberOfRequiredParameters(){}
145333
145334    /**
145335     * Gets parameters
145336     *
145337     * Get the parameters as an array of ReflectionParameter.
145338     *
145339     * @return array The parameters, as a ReflectionParameter object.
145340     * @since PHP 5 >= 5.2.0, PHP 7
145341     **/
145342    public function getParameters(){}
145343
145344    /**
145345     * Gets the specified return type of a function
145346     *
145347     * Gets the specified return type of a reflected function.
145348     *
145349     * @return ReflectionType Returns a ReflectionType object if a return
145350     *   type is specified, NULL otherwise.
145351     * @since PHP 7
145352     **/
145353    public function getReturnType(){}
145354
145355    /**
145356     * Gets function short name
145357     *
145358     * Get the short name of the function (without the namespace part).
145359     *
145360     * @return string The short name of the function.
145361     * @since PHP 5 >= 5.3.0, PHP 7
145362     **/
145363    public function getShortName(){}
145364
145365    /**
145366     * Gets starting line number
145367     *
145368     * Gets the starting line number of the function.
145369     *
145370     * @return int The starting line number.
145371     * @since PHP 5 >= 5.2.0, PHP 7
145372     **/
145373    public function getStartLine(){}
145374
145375    /**
145376     * Gets static variables
145377     *
145378     * Get the static variables.
145379     *
145380     * @return array An array of static variables.
145381     * @since PHP 5 >= 5.2.0, PHP 7
145382     **/
145383    public function getStaticVariables(){}
145384
145385    /**
145386     * Checks if the function has a specified return type
145387     *
145388     * Checks whether the reflected function has a return type specified.
145389     *
145390     * @return bool Returns TRUE if the function is a specified return
145391     *   type, otherwise FALSE.
145392     * @since PHP 7
145393     **/
145394    public function hasReturnType(){}
145395
145396    /**
145397     * Checks if function in namespace
145398     *
145399     * Checks whether a function is defined in a namespace.
145400     *
145401     * @return bool TRUE if it's in a namespace, otherwise FALSE
145402     * @since PHP 5 >= 5.3.0, PHP 7
145403     **/
145404    public function inNamespace(){}
145405
145406    /**
145407     * Checks if closure
145408     *
145409     * Checks whether the reflected function is a Closure.
145410     *
145411     * @return bool Returns TRUE if the function is a Closure, otherwise
145412     *   FALSE.
145413     * @since PHP 5 >= 5.3.0, PHP 7
145414     **/
145415    public function isClosure(){}
145416
145417    /**
145418     * Checks if deprecated
145419     *
145420     * Checks whether the function is deprecated.
145421     *
145422     * @return bool TRUE if it's deprecated, otherwise FALSE
145423     * @since PHP 5 >= 5.2.0, PHP 7
145424     **/
145425    public function isDeprecated(){}
145426
145427    /**
145428     * Returns whether this function is a generator
145429     *
145430     * @return bool Returns TRUE if the function is generator, FALSE if it
145431     *   is not or NULL on failure.
145432     * @since PHP 5 >= 5.5.0, PHP 7
145433     **/
145434    public function isGenerator(){}
145435
145436    /**
145437     * Checks if is internal
145438     *
145439     * Checks whether the function is internal, as opposed to user-defined.
145440     *
145441     * @return bool TRUE if it's internal, otherwise FALSE
145442     * @since PHP 5 >= 5.2.0, PHP 7
145443     **/
145444    public function isInternal(){}
145445
145446    /**
145447     * Checks if user defined
145448     *
145449     * Checks whether the function is user-defined, as opposed to internal.
145450     *
145451     * @return bool TRUE if it's user-defined, otherwise false;
145452     * @since PHP 5 >= 5.2.0, PHP 7
145453     **/
145454    public function isUserDefined(){}
145455
145456    /**
145457     * Checks if the function is variadic
145458     *
145459     * Checks if the function is variadic.
145460     *
145461     * @return bool Returns TRUE if the function is variadic, otherwise
145462     *   FALSE.
145463     * @since PHP 5 >= 5.6.0, PHP 7
145464     **/
145465    public function isVariadic(){}
145466
145467    /**
145468     * Checks if returns reference
145469     *
145470     * Checks whether the function returns a reference.
145471     *
145472     * @return bool TRUE if it returns a reference, otherwise FALSE
145473     * @since PHP 5 >= 5.2.0, PHP 7
145474     **/
145475    public function returnsReference(){}
145476
145477    /**
145478     * Clones function
145479     *
145480     * Clones a function.
145481     *
145482     * @return void
145483     * @since PHP 5 >= 5.2.0, PHP 7
145484     **/
145485    final private function __clone(){}
145486
145487    /**
145488     * To string
145489     *
145490     * @return void The string.
145491     * @since PHP 5 >= 5.2.0, PHP 7
145492     **/
145493    abstract public function __toString();
145494
145495}
145496/**
145497 * The ReflectionGenerator class reports information about a generator.
145498 **/
145499class ReflectionGenerator {
145500    /**
145501     * Gets the file name of the currently executing generator
145502     *
145503     * Get the full path and file name of the currently executing generator.
145504     *
145505     * @return string Returns the full path and file name of the currently
145506     *   executing generator.
145507     * @since PHP 7
145508     **/
145509    public function getExecutingFile(){}
145510
145511    /**
145512     * Gets the executing object
145513     *
145514     * Get the executing Generator object
145515     *
145516     * @return Generator Returns the currently executing Generator object.
145517     * @since PHP 7
145518     **/
145519    public function getExecutingGenerator(){}
145520
145521    /**
145522     * Gets the currently executing line of the generator
145523     *
145524     * Get the currently executing line number of the generator.
145525     *
145526     * @return int Returns the line number of the currently executing
145527     *   statement in the generator.
145528     * @since PHP 7
145529     **/
145530    public function getExecutingLine(){}
145531
145532    /**
145533     * Gets the function name of the generator
145534     *
145535     * Enables the function name of the generator to be obtained by returning
145536     * a class derived from ReflectionFunctionAbstract.
145537     *
145538     * @return ReflectionFunctionAbstract Returns a
145539     *   ReflectionFunctionAbstract class. This will be ReflectionFunction
145540     *   for functions, or ReflectionMethod for methods.
145541     * @since PHP 7
145542     **/
145543    public function getFunction(){}
145544
145545    /**
145546     * Gets the value of the generator
145547     *
145548     * Get the $this value that the generator has access to.
145549     *
145550     * @return object Returns the $this value, or NULL if the generator was
145551     *   not created in a class context.
145552     * @since PHP 7
145553     **/
145554    public function getThis(){}
145555
145556    /**
145557     * Gets the trace of the executing generator
145558     *
145559     * Get the trace of the currently executing generator.
145560     *
145561     * @param int $options The value of {@link options} can be any of the
145562     *   following flags.
145563     *
145564     *   Available options Option Description DEBUG_BACKTRACE_PROVIDE_OBJECT
145565     *   Default. DEBUG_BACKTRACE_IGNORE_ARGS Don't include the argument
145566     *   information for functions in the stack trace.
145567     * @return array Returns the trace of the currently executing
145568     *   generator.
145569     * @since PHP 7
145570     **/
145571    public function getTrace($options){}
145572
145573    /**
145574     * Constructs a ReflectionGenerator object
145575     *
145576     * Constructs a ReflectionGenerator object.
145577     *
145578     * @param Generator $generator A generator object.
145579     * @since PHP 7
145580     **/
145581    public function __construct($generator){}
145582
145583}
145584/**
145585 * The ReflectionMethod class reports information about a method.
145586 **/
145587class ReflectionMethod extends ReflectionFunctionAbstract implements Reflector {
145588    /**
145589     * @var integer
145590     **/
145591    const IS_ABSTRACT = 0;
145592
145593    /**
145594     * @var integer
145595     **/
145596    const IS_FINAL = 0;
145597
145598    /**
145599     * @var integer
145600     **/
145601    const IS_PRIVATE = 0;
145602
145603    /**
145604     * @var integer
145605     **/
145606    const IS_PROTECTED = 0;
145607
145608    /**
145609     * @var integer
145610     **/
145611    const IS_PUBLIC = 0;
145612
145613    /**
145614     * @var integer
145615     **/
145616    const IS_STATIC = 0;
145617
145618    /**
145619     * Class name
145620     *
145621     * @var mixed
145622     **/
145623    public $class;
145624
145625    /**
145626     * Method name
145627     *
145628     * @var mixed
145629     **/
145630    public $name;
145631
145632    /**
145633     * Export a reflection method
145634     *
145635     * Exports a ReflectionMethod.
145636     *
145637     * @param string $class The class name.
145638     * @param string $name The name of the method.
145639     * @param bool $return
145640     * @return string
145641     * @since PHP 5, PHP 7
145642     **/
145643    public static function export($class, $name, $return){}
145644
145645    /**
145646     * Returns a dynamically created closure for the method
145647     *
145648     * @param object $object Forbidden for static methods, required for
145649     *   other methods.
145650     * @return Closure Returns Closure. Returns NULL in case of an error.
145651     * @since PHP 5 >= 5.4.0, PHP 7
145652     **/
145653    public function getClosure($object){}
145654
145655    /**
145656     * Gets declaring class for the reflected method
145657     *
145658     * Gets the declaring class for the reflected method.
145659     *
145660     * @return ReflectionClass A ReflectionClass object of the class that
145661     *   the reflected method is part of.
145662     * @since PHP 5, PHP 7
145663     **/
145664    public function getDeclaringClass(){}
145665
145666    /**
145667     * Gets the method modifiers
145668     *
145669     * Returns a bitfield of the access modifiers for this method.
145670     *
145671     * @return int A numeric representation of the modifiers. The modifiers
145672     *   are listed below. The actual meanings of these modifiers are
145673     *   described in the predefined constants.
145674     * @since PHP 5, PHP 7
145675     **/
145676    public function getModifiers(){}
145677
145678    /**
145679     * Gets the method prototype (if there is one)
145680     *
145681     * Returns the methods prototype.
145682     *
145683     * @return ReflectionMethod A ReflectionMethod instance of the method
145684     *   prototype.
145685     * @since PHP 5 >= 5.1.2, PHP 7
145686     **/
145687    public function getPrototype(){}
145688
145689    /**
145690     * Invoke
145691     *
145692     * Invokes a reflected method.
145693     *
145694     * @param object $object The object to invoke the method on. For static
145695     *   methods, pass null to this parameter.
145696     * @param mixed ...$vararg Zero or more parameters to be passed to the
145697     *   method. It accepts a variable number of parameters which are passed
145698     *   to the method.
145699     * @return mixed Returns the method result.
145700     * @since PHP 5, PHP 7
145701     **/
145702    public function invoke($object, ...$vararg){}
145703
145704    /**
145705     * Invoke args
145706     *
145707     * Invokes the reflected method and pass its arguments as array.
145708     *
145709     * @param object $object The object to invoke the method on. In case of
145710     *   static methods, you can pass null to this parameter.
145711     * @param array $args The parameters to be passed to the function, as
145712     *   an array.
145713     * @return mixed Returns the method result.
145714     * @since PHP 5 >= 5.1.2, PHP 7
145715     **/
145716    public function invokeArgs($object, $args){}
145717
145718    /**
145719     * Checks if method is abstract
145720     *
145721     * Checks if the method is abstract.
145722     *
145723     * @return bool TRUE if the method is abstract, otherwise FALSE
145724     * @since PHP 5, PHP 7
145725     **/
145726    public function isAbstract(){}
145727
145728    /**
145729     * Checks if method is a constructor
145730     *
145731     * Checks if the method is a constructor.
145732     *
145733     * @return bool TRUE if the method is a constructor, otherwise FALSE
145734     * @since PHP 5, PHP 7
145735     **/
145736    public function isConstructor(){}
145737
145738    /**
145739     * Checks if method is a destructor
145740     *
145741     * Checks if the method is a destructor.
145742     *
145743     * @return bool TRUE if the method is a destructor, otherwise FALSE
145744     * @since PHP 5, PHP 7
145745     **/
145746    public function isDestructor(){}
145747
145748    /**
145749     * Checks if method is final
145750     *
145751     * Checks if the method is final.
145752     *
145753     * @return bool TRUE if the method is final, otherwise FALSE
145754     * @since PHP 5, PHP 7
145755     **/
145756    public function isFinal(){}
145757
145758    /**
145759     * Checks if method is private
145760     *
145761     * Checks if the method is private.
145762     *
145763     * @return bool TRUE if the method is private, otherwise FALSE
145764     * @since PHP 5, PHP 7
145765     **/
145766    public function isPrivate(){}
145767
145768    /**
145769     * Checks if method is protected
145770     *
145771     * Checks if the method is protected.
145772     *
145773     * @return bool TRUE if the method is protected, otherwise FALSE
145774     * @since PHP 5, PHP 7
145775     **/
145776    public function isProtected(){}
145777
145778    /**
145779     * Checks if method is public
145780     *
145781     * Checks if the method is public.
145782     *
145783     * @return bool TRUE if the method is public, otherwise FALSE
145784     * @since PHP 5, PHP 7
145785     **/
145786    public function isPublic(){}
145787
145788    /**
145789     * Checks if method is static
145790     *
145791     * Checks if the method is static.
145792     *
145793     * @return bool TRUE if the method is static, otherwise FALSE
145794     * @since PHP 5, PHP 7
145795     **/
145796    public function isStatic(){}
145797
145798    /**
145799     * Set method accessibility
145800     *
145801     * Sets a method to be accessible. For example, it may allow protected
145802     * and private methods to be invoked.
145803     *
145804     * @param bool $accessible TRUE to allow accessibility, or FALSE.
145805     * @return void
145806     * @since PHP 5 >= 5.3.2, PHP 7
145807     **/
145808    public function setAccessible($accessible){}
145809
145810    /**
145811     * Constructs a ReflectionMethod
145812     *
145813     * Constructs a new ReflectionMethod.
145814     *
145815     * @param mixed $class Classname or object (instance of the class) that
145816     *   contains the method.
145817     * @param string $name Name of the method.
145818     * @since PHP 5, PHP 7
145819     **/
145820    public function __construct($class, $name){}
145821
145822    /**
145823     * Returns the string representation of the Reflection method object
145824     *
145825     * @return string A string representation of this ReflectionMethod
145826     *   instance.
145827     * @since PHP 5, PHP 7
145828     **/
145829    public function __toString(){}
145830
145831}
145832class ReflectionNamedType extends ReflectionType {
145833    /**
145834     * Get the text of the type hint
145835     *
145836     * @return string Returns the text of the type hint.
145837     * @since PHP 7 >= 7.1.0
145838     **/
145839    public function getName(){}
145840
145841}
145842/**
145843 * The ReflectionObject class reports information about an object.
145844 **/
145845class ReflectionObject extends ReflectionClass implements Reflector {
145846    /**
145847     * Name of the object's class. Read-only, throws ReflectionException in
145848     * attempt to write.
145849     *
145850     * @var mixed
145851     **/
145852    public $name;
145853
145854    /**
145855     * Export
145856     *
145857     * Exports a reflection.
145858     *
145859     * @param string $argument
145860     * @param bool $return
145861     * @return string
145862     * @since PHP 5, PHP 7
145863     **/
145864    public static function export($argument, $return){}
145865
145866    /**
145867     * Constructs a ReflectionObject
145868     *
145869     * Constructs a ReflectionObject.
145870     *
145871     * @param object $argument An object instance.
145872     * @since PHP 5, PHP 7
145873     **/
145874    public function __construct($argument){}
145875
145876}
145877/**
145878 * The ReflectionParameter class retrieves information about function's
145879 * or method's parameters. To introspect function parameters, first
145880 * create an instance of the ReflectionFunction or ReflectionMethod
145881 * classes and then use their ReflectionFunctionAbstract::getParameters
145882 * method to retrieve an array of parameters.
145883 **/
145884class ReflectionParameter implements Reflector {
145885    /**
145886     * Name of the parameter. Read-only, throws ReflectionException in
145887     * attempt to write.
145888     *
145889     * @var mixed
145890     **/
145891    public $name;
145892
145893    /**
145894     * Checks if null is allowed
145895     *
145896     * Checks whether the parameter allows NULL.
145897     *
145898     * @return bool TRUE if NULL is allowed, otherwise FALSE
145899     * @since PHP 5, PHP 7
145900     **/
145901    public function allowsNull(){}
145902
145903    /**
145904     * Returns whether this parameter can be passed by value
145905     *
145906     * @return bool Returns TRUE if the parameter can be passed by value,
145907     *   FALSE otherwise. Returns NULL in case of an error.
145908     * @since PHP 5 >= 5.4.0, PHP 7
145909     **/
145910    public function canBePassedByValue(){}
145911
145912    /**
145913     * Exports
145914     *
145915     * @param string $function The function name.
145916     * @param string $parameter The parameter name.
145917     * @param bool $return
145918     * @return string The exported reflection.
145919     * @since PHP 5, PHP 7
145920     **/
145921    public static function export($function, $parameter, $return){}
145922
145923    /**
145924     * Get the type hinted class
145925     *
145926     * Gets the class type hinted for the parameter as a ReflectionClass
145927     * object.
145928     *
145929     * @return ReflectionClass A ReflectionClass object.
145930     * @since PHP 5, PHP 7
145931     **/
145932    public function getClass(){}
145933
145934    /**
145935     * Gets declaring class
145936     *
145937     * Gets the declaring class.
145938     *
145939     * @return ReflectionClass A ReflectionClass object or NULL if called
145940     *   on function.
145941     * @since PHP 5 >= 5.1.3, PHP 7
145942     **/
145943    public function getDeclaringClass(){}
145944
145945    /**
145946     * Gets declaring function
145947     *
145948     * Gets the declaring function.
145949     *
145950     * @return ReflectionFunctionAbstract A ReflectionFunction object.
145951     * @since PHP 5 >= 5.1.3, PHP 7
145952     **/
145953    public function getDeclaringFunction(){}
145954
145955    /**
145956     * Gets default parameter value
145957     *
145958     * Gets the default value of the parameter for a user-defined function or
145959     * method. If the parameter is not optional a ReflectionException will be
145960     * thrown.
145961     *
145962     * @return mixed The parameters default value.
145963     * @since PHP 5 >= 5.0.3, PHP 7
145964     **/
145965    public function getDefaultValue(){}
145966
145967    /**
145968     * Returns the default value's constant name if default value is constant
145969     * or null
145970     *
145971     * Returns the default value's constant name of the parameter of a
145972     * user-defined function or method, if default value is constant or null.
145973     * If the parameter is not optional a ReflectionException will be thrown.
145974     *
145975     * @return string Returns string on success or NULL on failure.
145976     * @since PHP 5 >= 5.4.6, PHP 7
145977     **/
145978    public function getDefaultValueConstantName(){}
145979
145980    /**
145981     * Gets parameter name
145982     *
145983     * Gets the name of the parameter.
145984     *
145985     * @return string The name of the reflected parameter.
145986     * @since PHP 5, PHP 7
145987     **/
145988    public function getName(){}
145989
145990    /**
145991     * Gets parameter position
145992     *
145993     * Gets the position of the parameter.
145994     *
145995     * @return int The position of the parameter, left to right, starting
145996     *   at position #0.
145997     * @since PHP 5 >= 5.1.3, PHP 7
145998     **/
145999    public function getPosition(){}
146000
146001    /**
146002     * Gets a parameter's type
146003     *
146004     * Gets the associated type of a parameter.
146005     *
146006     * @return ReflectionType Returns a ReflectionType object if a
146007     *   parameter type is specified, NULL otherwise.
146008     * @since PHP 7
146009     **/
146010    public function getType(){}
146011
146012    /**
146013     * Checks if parameter has a type
146014     *
146015     * Checks if the parameter has a type associated with it.
146016     *
146017     * @return bool TRUE if a type is specified, FALSE otherwise.
146018     * @since PHP 7
146019     **/
146020    public function hasType(){}
146021
146022    /**
146023     * Checks if parameter expects an array
146024     *
146025     * Checks if the parameter expects an array.
146026     *
146027     * @return bool TRUE if an array is expected, FALSE otherwise.
146028     * @since PHP 5 >= 5.1.2, PHP 7
146029     **/
146030    public function isArray(){}
146031
146032    /**
146033     * Returns whether parameter MUST be callable
146034     *
146035     * @return bool Returns TRUE if the parameter is callable, FALSE if it
146036     *   is not or NULL on failure.
146037     * @since PHP 5 >= 5.4.0, PHP 7
146038     **/
146039    public function isCallable(){}
146040
146041    /**
146042     * Checks if a default value is available
146043     *
146044     * Checks if a default value for the parameter is available.
146045     *
146046     * @return bool TRUE if a default value is available, otherwise FALSE
146047     * @since PHP 5 >= 5.0.3, PHP 7
146048     **/
146049    public function isDefaultValueAvailable(){}
146050
146051    /**
146052     * Returns whether the default value of this parameter is a constant
146053     *
146054     * @return bool Returns TRUE if the default value is constant, and
146055     *   FALSE otherwise.
146056     * @since PHP 5 >= 5.4.6, PHP 7
146057     **/
146058    public function isDefaultValueConstant(){}
146059
146060    /**
146061     * Checks if optional
146062     *
146063     * Checks if the parameter is optional.
146064     *
146065     * @return bool TRUE if the parameter is optional, otherwise FALSE
146066     * @since PHP 5 >= 5.0.3, PHP 7
146067     **/
146068    public function isOptional(){}
146069
146070    /**
146071     * Checks if passed by reference
146072     *
146073     * Checks if the parameter is passed in by reference.
146074     *
146075     * @return bool TRUE if the parameter is passed in by reference,
146076     *   otherwise FALSE
146077     * @since PHP 5, PHP 7
146078     **/
146079    public function isPassedByReference(){}
146080
146081    /**
146082     * Checks if the parameter is variadic
146083     *
146084     * Checks if the parameter was declared as a variadic parameter.
146085     *
146086     * @return bool Returns TRUE if the parameter is variadic, otherwise
146087     *   FALSE.
146088     * @since PHP 5 >= 5.6.0, PHP 7
146089     **/
146090    public function isVariadic(){}
146091
146092    /**
146093     * Clone
146094     *
146095     * Clones.
146096     *
146097     * @return void
146098     * @since PHP 5, PHP 7
146099     **/
146100    final private function __clone(){}
146101
146102    /**
146103     * Construct
146104     *
146105     * Constructs a ReflectionParameter instance.
146106     *
146107     * @param callable $function The function to reflect parameters from.
146108     * @param mixed $parameter Either an specifying the position of the
146109     *   parameter (starting with zero), or a the parameter name as .
146110     * @since PHP 5, PHP 7
146111     **/
146112    public function __construct($function, $parameter){}
146113
146114    /**
146115     * To string
146116     *
146117     * @return string
146118     * @since PHP 5, PHP 7
146119     **/
146120    public function __toString(){}
146121
146122}
146123/**
146124 * The ReflectionProperty class reports information about classes
146125 * properties.
146126 **/
146127class ReflectionProperty implements Reflector {
146128    /**
146129     * @var integer
146130     **/
146131    const IS_PRIVATE = 0;
146132
146133    /**
146134     * @var integer
146135     **/
146136    const IS_PROTECTED = 0;
146137
146138    /**
146139     * @var integer
146140     **/
146141    const IS_PUBLIC = 0;
146142
146143    /**
146144     * @var integer
146145     **/
146146    const IS_STATIC = 0;
146147
146148    /**
146149     * Name of the class where the property is defined. Read-only, throws
146150     * ReflectionException in attempt to write.
146151     *
146152     * @var mixed
146153     **/
146154    public $class;
146155
146156    /**
146157     * Name of the property. Read-only, throws ReflectionException in attempt
146158     * to write.
146159     *
146160     * @var mixed
146161     **/
146162    public $name;
146163
146164    /**
146165     * Export
146166     *
146167     * Exports a reflection.
146168     *
146169     * @param mixed $class
146170     * @param string $name The property name.
146171     * @param bool $return
146172     * @return string
146173     * @since PHP 5, PHP 7
146174     **/
146175    public static function export($class, $name, $return){}
146176
146177    /**
146178     * Gets declaring class
146179     *
146180     * Gets the declaring class.
146181     *
146182     * @return ReflectionClass A ReflectionClass object.
146183     * @since PHP 5, PHP 7
146184     **/
146185    public function getDeclaringClass(){}
146186
146187    /**
146188     * Gets the property doc comment
146189     *
146190     * Gets the doc comment for a property.
146191     *
146192     * @return string The property doc comment.
146193     * @since PHP 5 >= 5.1.0, PHP 7
146194     **/
146195    public function getDocComment(){}
146196
146197    /**
146198     * Gets the property modifiers
146199     *
146200     * Gets the modifiers.
146201     *
146202     * @return int A numeric representation of the modifiers.
146203     * @since PHP 5, PHP 7
146204     **/
146205    public function getModifiers(){}
146206
146207    /**
146208     * Gets property name
146209     *
146210     * Gets the properties name.
146211     *
146212     * @return string The name of the reflected property.
146213     * @since PHP 5, PHP 7
146214     **/
146215    public function getName(){}
146216
146217    /**
146218     * Gets a property's type
146219     *
146220     * Gets the associated type of a property.
146221     *
146222     * @return ?ReflectionType Returns a ReflectionType if the property has
146223     *   a type, and NULL otherwise.
146224     * @since PHP 7 >= 7.4.0
146225     **/
146226    public function getType(){}
146227
146228    /**
146229     * Gets value
146230     *
146231     * Gets the property's value.
146232     *
146233     * @param object $object If the property is non-static an object must
146234     *   be provided to fetch the property from. If you want to fetch the
146235     *   default property without providing an object use
146236     *   ReflectionClass::getDefaultProperties instead.
146237     * @return mixed The current value of the property.
146238     * @since PHP 5, PHP 7
146239     **/
146240    public function getValue($object){}
146241
146242    /**
146243     * Checks if property has a type
146244     *
146245     * Checks if the property has a type associated with it.
146246     *
146247     * @return bool TRUE if a type is specified, FALSE otherwise.
146248     * @since PHP 7 >= 7.4.0
146249     **/
146250    public function hasType(){}
146251
146252    /**
146253     * Checks if property is a default property
146254     *
146255     * Checks whether the property was declared at compile-time, or whether
146256     * the property was dynamically declared at run-time.
146257     *
146258     * @return bool TRUE if the property was declared at compile-time, or
146259     *   FALSE if it was created at run-time.
146260     * @since PHP 5, PHP 7
146261     **/
146262    public function isDefault(){}
146263
146264    /**
146265     * Checks whether a property is initialized
146266     *
146267     * @param object $object If the property is non-static an object must
146268     *   be provided to fetch the property from.
146269     * @return bool Returns FALSE for typed properties prior to
146270     *   initialization, and for properties that have been explicitly {@link
146271     *   unset}. For all other properties TRUE will be returned.
146272     * @since PHP 7 >= 7.4.0
146273     **/
146274    public function isInitialized($object){}
146275
146276    /**
146277     * Checks if property is private
146278     *
146279     * Checks whether the property is private.
146280     *
146281     * @return bool TRUE if the property is private, FALSE otherwise.
146282     * @since PHP 5, PHP 7
146283     **/
146284    public function isPrivate(){}
146285
146286    /**
146287     * Checks if property is protected
146288     *
146289     * Checks whether the property is protected.
146290     *
146291     * @return bool TRUE if the property is protected, FALSE otherwise.
146292     * @since PHP 5, PHP 7
146293     **/
146294    public function isProtected(){}
146295
146296    /**
146297     * Checks if property is public
146298     *
146299     * Checks whether the property is public.
146300     *
146301     * @return bool TRUE if the property is public, FALSE otherwise.
146302     * @since PHP 5, PHP 7
146303     **/
146304    public function isPublic(){}
146305
146306    /**
146307     * Checks if property is static
146308     *
146309     * Checks whether the property is static.
146310     *
146311     * @return bool TRUE if the property is static, FALSE otherwise.
146312     * @since PHP 5, PHP 7
146313     **/
146314    public function isStatic(){}
146315
146316    /**
146317     * Set property accessibility
146318     *
146319     * Sets a property to be accessible. For example, it may allow protected
146320     * and private properties to be accessed.
146321     *
146322     * @param bool $accessible TRUE to allow accessibility, or FALSE.
146323     * @return void
146324     * @since PHP 5 >= 5.3.0, PHP 7
146325     **/
146326    public function setAccessible($accessible){}
146327
146328    /**
146329     * Set property value
146330     *
146331     * Sets (changes) the property's value.
146332     *
146333     * @param object $object If the property is non-static an object must
146334     *   be provided to change the property on. If the property is static
146335     *   this parameter is left out and only {@link value} needs to be
146336     *   provided.
146337     * @param mixed $value The new value.
146338     * @return void
146339     * @since PHP 5, PHP 7
146340     **/
146341    public function setValue($object, $value){}
146342
146343    /**
146344     * Clone
146345     *
146346     * Clones.
146347     *
146348     * @return void
146349     * @since PHP 5, PHP 7
146350     **/
146351    final private function __clone(){}
146352
146353    /**
146354     * Construct a ReflectionProperty object
146355     *
146356     * @param mixed $class The class name, that contains the property.
146357     * @param string $name The name of the property being reflected.
146358     * @since PHP 5, PHP 7
146359     **/
146360    public function __construct($class, $name){}
146361
146362    /**
146363     * To string
146364     *
146365     * @return string
146366     * @since PHP 5, PHP 7
146367     **/
146368    public function __toString(){}
146369
146370}
146371/**
146372 * The ReflectionReference class provides information about a reference.
146373 **/
146374final class ReflectionReference {
146375    /**
146376     * Create a ReflectionReference from an array element
146377     *
146378     * Creates a ReflectionReference from an array element.
146379     *
146380     * @param array $array The which contains the potential reference.
146381     * @param mixed $key The key; either an or a .
146382     * @return ReflectionReference Returns a ReflectionReference instance
146383     *   if $array[$key] is a reference, or NULL otherwise.
146384     * @since PHP 7 >= 7.4.0
146385     **/
146386    public static function fromArrayElement($array, $key){}
146387
146388    /**
146389     * Get unique ID of a reference
146390     *
146391     * Returns an ID which is unique for the reference for the lifetime of
146392     * that reference. This ID can be used to compare references for
146393     * equality, or to maintain a map of known references.
146394     *
146395     * @return mixed Returns an or of unspecified format.
146396     * @since PHP 7 >= 7.4.0
146397     **/
146398    public function getId(){}
146399
146400}
146401/**
146402 * The ReflectionType class reports information about a function's return
146403 * type.
146404 **/
146405class ReflectionType {
146406    /**
146407     * Checks if null is allowed
146408     *
146409     * Checks whether the parameter allows NULL.
146410     *
146411     * @return bool TRUE if NULL is allowed, otherwise FALSE
146412     * @since PHP 7
146413     **/
146414    public function allowsNull(){}
146415
146416    /**
146417     * Checks if it is a built-in type
146418     *
146419     * Checks if the type is a built-in type in PHP.
146420     *
146421     * @return bool TRUE if it's a built-in type, otherwise FALSE
146422     * @since PHP 7
146423     **/
146424    public function isBuiltin(){}
146425
146426    /**
146427     * To string
146428     *
146429     * Gets the parameter type name.
146430     *
146431     * @return string Returns the type of the parameter.
146432     * @since PHP 7
146433     **/
146434    public function __toString(){}
146435
146436}
146437class ReflectionZendExtension implements Reflector {
146438    /**
146439     * Name of the extension. Read-only, throws ReflectionException in
146440     * attempt to write.
146441     *
146442     * @var mixed
146443     **/
146444    public $name;
146445
146446    /**
146447     * Export
146448     *
146449     * @param string $name
146450     * @param bool $return
146451     * @return string
146452     * @since PHP 5 >= 5.4.0, PHP 7
146453     **/
146454    public static function export($name, $return){}
146455
146456    /**
146457     * Gets author
146458     *
146459     * @return string
146460     * @since PHP 5 >= 5.4.0, PHP 7
146461     **/
146462    public function getAuthor(){}
146463
146464    /**
146465     * Gets copyright
146466     *
146467     * @return string
146468     * @since PHP 5 >= 5.4.0, PHP 7
146469     **/
146470    public function getCopyright(){}
146471
146472    /**
146473     * Gets name
146474     *
146475     * @return string
146476     * @since PHP 5 >= 5.4.0, PHP 7
146477     **/
146478    public function getName(){}
146479
146480    /**
146481     * Gets URL
146482     *
146483     * @return string
146484     * @since PHP 5 >= 5.4.0, PHP 7
146485     **/
146486    public function getURL(){}
146487
146488    /**
146489     * Gets version
146490     *
146491     * @return string
146492     * @since PHP 5 >= 5.4.0, PHP 7
146493     **/
146494    public function getVersion(){}
146495
146496    /**
146497     * Clone handler
146498     *
146499     * @return void
146500     * @since PHP 5 >= 5.4.0, PHP 7
146501     **/
146502    final private function __clone(){}
146503
146504    /**
146505     * Constructor
146506     *
146507     * @param string $name
146508     * @since PHP 5 >= 5.4.0, PHP 7
146509     **/
146510    public function __construct($name){}
146511
146512    /**
146513     * To string handler
146514     *
146515     * @return string
146516     * @since PHP 5 >= 5.4.0, PHP 7
146517     **/
146518    public function __toString(){}
146519
146520}
146521/**
146522 * Reflector is an interface implemented by all exportable Reflection
146523 * classes.
146524 **/
146525interface Reflector {
146526    /**
146527     * Exports
146528     *
146529     * @return string
146530     * @since PHP 5, PHP 7
146531     **/
146532    public static function export();
146533
146534    /**
146535     * To string
146536     *
146537     * @return string
146538     * @since PHP 5, PHP 7
146539     **/
146540    public function __toString();
146541
146542}
146543/**
146544 * This iterator can be used to filter another iterator based on a
146545 * regular expression.
146546 **/
146547class RegexIterator extends FilterIterator {
146548    /**
146549     * Return all matches for the current entry (see {@link preg_match_all}).
146550     *
146551     * @var mixed
146552     **/
146553    const ALL_MATCHES = 0;
146554
146555    /**
146556     * Return the first match for the current entry (see {@link preg_match}).
146557     *
146558     * @var mixed
146559     **/
146560    const GET_MATCH = 0;
146561
146562    /**
146563     * Only execute match (filter) for the current entry (see {@link
146564     * preg_match}).
146565     *
146566     * @var mixed
146567     **/
146568    const MATCH = 0;
146569
146570    /**
146571     * Replace the current entry (see {@link preg_replace}; Not fully
146572     * implemented yet)
146573     *
146574     * @var mixed
146575     **/
146576    const REPLACE = 0;
146577
146578    /**
146579     * Returns the split values for the current entry (see {@link
146580     * preg_split}).
146581     *
146582     * @var mixed
146583     **/
146584    const SPLIT = 0;
146585
146586    /**
146587     * Special flag: Match the entry key instead of the entry value.
146588     *
146589     * @var mixed
146590     **/
146591    const USE_KEY = 0;
146592
146593    /**
146594     * Get accept status
146595     *
146596     * Matches (string) RegexIterator::current (or RegexIterator::key if the
146597     * RegexIterator::USE_KEY flag is set) against the regular expression.
146598     *
146599     * @return bool TRUE if a match, FALSE otherwise.
146600     * @since PHP 5 >= 5.2.0, PHP 7
146601     **/
146602    public function accept(){}
146603
146604    /**
146605     * Get flags
146606     *
146607     * Returns the flags, see RegexIterator::setFlags for a list of available
146608     * flags.
146609     *
146610     * @return int Returns the set flags.
146611     * @since PHP 5 >= 5.2.0, PHP 7
146612     **/
146613    public function getFlags(){}
146614
146615    /**
146616     * Returns operation mode
146617     *
146618     * Returns the operation mode, see RegexIterator::setMode for the list of
146619     * operation modes.
146620     *
146621     * @return int Returns the operation mode.
146622     * @since PHP 5 >= 5.2.0, PHP 7
146623     **/
146624    public function getMode(){}
146625
146626    /**
146627     * Returns the regular expression flags
146628     *
146629     * Returns the regular expression flags, see RegexIterator::__construct
146630     * for the list of flags.
146631     *
146632     * @return int Returns a bitmask of the regular expression flags.
146633     * @since PHP 5 >= 5.2.0, PHP 7
146634     **/
146635    public function getPregFlags(){}
146636
146637    /**
146638     * Returns current regular expression
146639     *
146640     * @return string
146641     * @since PHP 5 >= 5.4.0, PHP 7
146642     **/
146643    public function getRegex(){}
146644
146645    /**
146646     * Sets the flags
146647     *
146648     * @param int $flags The flags to set, a bitmask of class constants.
146649     *   The available flags are listed below. The actual meanings of these
146650     *   flags are described in the predefined constants. RegexIterator flags
146651     *   value constant 1 RegexIterator::USE_KEY
146652     * @return void
146653     * @since PHP 5 >= 5.2.0, PHP 7
146654     **/
146655    public function setFlags($flags){}
146656
146657    /**
146658     * Sets the operation mode
146659     *
146660     * @param int $mode The operation mode. The available modes are listed
146661     *   below. The actual meanings of these modes are described in the
146662     *   predefined constants. RegexIterator modes value constant 0
146663     *   RegexIterator::MATCH 1 RegexIterator::GET_MATCH 2
146664     *   RegexIterator::ALL_MATCHES 3 RegexIterator::SPLIT 4
146665     *   RegexIterator::REPLACE
146666     * @return void
146667     * @since PHP 5 >= 5.2.0, PHP 7
146668     **/
146669    public function setMode($mode){}
146670
146671    /**
146672     * Sets the regular expression flags
146673     *
146674     * @param int $preg_flags The regular expression flags. See
146675     *   RegexIterator::__construct for an overview of available flags.
146676     * @return void
146677     * @since PHP 5 >= 5.2.0, PHP 7
146678     **/
146679    public function setPregFlags($preg_flags){}
146680
146681}
146682/**
146683 * ICU Resource Management ICU Data
146684 **/
146685class ResourceBundle {
146686    /**
146687     * Get number of elements in the bundle
146688     *
146689     * Get the number of elements in the bundle.
146690     *
146691     * @return int Returns number of elements in the bundle.
146692     **/
146693    public function count(){}
146694
146695    /**
146696     * Create a resource bundle
146697     *
146698     * (method)
146699     *
146700     * (constructor):
146701     *
146702     * Creates a resource bundle.
146703     *
146704     * @param string $locale Locale for which the resources should be
146705     *   loaded (locale name, e.g. en_CA).
146706     * @param string $bundlename The directory where the data is stored or
146707     *   the name of the .dat file.
146708     * @param bool $fallback Whether locale should match exactly or
146709     *   fallback to parent locale is allowed.
146710     * @return ResourceBundle Returns ResourceBundle object or NULL on
146711     *   error.
146712     **/
146713    public static function create($locale, $bundlename, $fallback){}
146714
146715    /**
146716     * Get data from the bundle
146717     *
146718     * Get the data from the bundle by index or string key.
146719     *
146720     * @param string|int $index ResourceBundle object.
146721     * @param bool $fallback Data index, must be string or integer.
146722     * @return mixed Returns the data located at the index or NULL on
146723     *   error. Strings, integers and binary data strings are returned as
146724     *   corresponding PHP types, integer array is returned as PHP array.
146725     *   Complex types are returned as ResourceBundle object.
146726     **/
146727    public function get($index, $fallback){}
146728
146729    /**
146730     * Get bundle's last error code
146731     *
146732     * Get error code from the last function performed by the bundle object.
146733     *
146734     * @return int Returns error code from last bundle object call.
146735     **/
146736    public function getErrorCode(){}
146737
146738    /**
146739     * Get bundle's last error message
146740     *
146741     * Get error message from the last function performed by the bundle
146742     * object.
146743     *
146744     * @return string Returns error message from last bundle object's call.
146745     **/
146746    public function getErrorMessage(){}
146747
146748    /**
146749     * Get supported locales
146750     *
146751     * Get available locales from ResourceBundle name.
146752     *
146753     * @param string $bundlename Path of ResourceBundle for which to get
146754     *   available locales, or empty string for default locales list.
146755     * @return array Returns the list of locales supported by the bundle.
146756     **/
146757    public function getLocales($bundlename){}
146758
146759}
146760/**
146761 * Class for creation of RRD database file.
146762 **/
146763class RRDCreator {
146764    /**
146765     * Adds RRA - archive of data values for each data source
146766     *
146767     * Adds RRA definition by description of archive. Archive consists of a
146768     * number of data values or statistics for each of the defined
146769     * data-sources (DS). Data sources are defined by method
146770     * RRDCreator::addDataSource. You need call this method for each
146771     * requested archive.
146772     *
146773     * @param string $description Definition of archive - RRA. This has
146774     *   same format as RRA definition in rrd create command. See man page of
146775     *   rrd create for more details.
146776     * @return void
146777     * @since PECL rrd >= 0.9.0
146778     **/
146779    public function addArchive($description){}
146780
146781    /**
146782     * Adds data source definition for RRD database
146783     *
146784     * RRD can accept input from several data sources (DS), e.g incoming and
146785     * outgoing traffic. This method adds data source by description. You
146786     * need call this method for each data source.
146787     *
146788     * @param string $description Definition of data source - DS. This has
146789     *   same format as DS definition in rrd create command. See man page of
146790     *   rrd create for more details.
146791     * @return void
146792     * @since PECL rrd >= 0.9.0
146793     **/
146794    public function addDataSource($description){}
146795
146796    /**
146797     * Saves the RRD database to a file
146798     *
146799     * Saves the RRD database into file, which name is defined by
146800     * RRDCreator::__construct.
146801     *
146802     * @return bool
146803     * @since PECL rrd >= 0.9.0
146804     **/
146805    public function save(){}
146806
146807    /**
146808     * Creates new instance
146809     *
146810     * Creates new RRDCreator instance.
146811     *
146812     * @param string $path Path for newly created RRD database file.
146813     * @param string $startTime Time for the first value in RRD database.
146814     *   Parameter supports all formats which are supported by rrd create
146815     *   call.
146816     * @param int $step Base interval in seconds with which data will be
146817     *   fed into the RRD database.
146818     * @since PECL rrd >= 0.9.0
146819     **/
146820    public function __construct($path, $startTime, $step){}
146821
146822}
146823/**
146824 * Class for exporting data from RRD database to image file.
146825 **/
146826class RRDGraph {
146827    /**
146828     * Saves the result of query into image
146829     *
146830     * Saves the result of RRD database query into image defined by
146831     * RRDGraph::__construct.
146832     *
146833     * @return array Array with information about generated image is
146834     *   returned, FALSE if error occurs.
146835     * @since PECL rrd >= 0.9.0
146836     **/
146837    public function save(){}
146838
146839    /**
146840     * Saves the RRD database query into image and returns the verbose
146841     * information about generated graph
146842     *
146843     * Saves the RRD database query into image file defined by method
146844     * RRDGraph::__construct and returns the verbose information about
146845     * generated graph, if "-" is used as image filename, image data are also
146846     * returned in result array.
146847     *
146848     * @return array Array with detailed information about generated image
146849     *   is returned, optionally with image data, FALSE if error occurs.
146850     * @since PECL rrd >= 0.9.0
146851     **/
146852    public function saveVerbose(){}
146853
146854    /**
146855     * Sets the options for rrd graph export
146856     *
146857     * @param array $options List of options for the image generation from
146858     *   the RRD database file. It can be list of strings or list of strings
146859     *   with keys for better readability. Read the rrd graph man pages for
146860     *   list of available options.
146861     * @return void
146862     * @since PECL rrd >= 0.9.0
146863     **/
146864    public function setOptions($options){}
146865
146866    /**
146867     * Creates new instance
146868     *
146869     * Creates new RRDGraph instance. This instance is responsible for
146870     * rendering the result of RRD database query into image.
146871     *
146872     * @param string $path Full path for the newly created image.
146873     * @since PECL rrd >= 0.9.0
146874     **/
146875    public function __construct($path){}
146876
146877}
146878/**
146879 * Class for updating RDD database file.
146880 **/
146881class RRDUpdater {
146882    /**
146883     * Update the RRD database file
146884     *
146885     * Updates the RRD file defined via RRDUpdater::__construct. The file is
146886     * updated with a specific values.
146887     *
146888     * @param array $values Data for update. Key is data source name.
146889     * @param string $time Time value for updating the RRD with a
146890     *   particulat data. Default value is current time.
146891     * @return bool
146892     * @since PECL rrd >= 0.9.0
146893     **/
146894    public function update($values, $time){}
146895
146896    /**
146897     * Creates new instance
146898     *
146899     * Creates new RRDUpdater instance. This instance is responsible for
146900     * updating the RRD database file.
146901     *
146902     * @param string $path Filesystem path for RRD database file, which
146903     *   will be updated.
146904     * @since PECL rrd >= 0.9.0
146905     **/
146906    public function __construct($path){}
146907
146908}
146909class Runkit_Sandbox_Parent {
146910    /**
146911     * Runkit Anti-Sandbox Class
146912     *
146913     * Instantiating the Runkit_Sandbox_Parent class from within a sandbox
146914     * environment created from the Runkit_Sandbox class provides some
146915     * (controlled) means for a sandbox child to access its parent.
146916     *
146917     * In order for any of the Runkit_Sandbox_Parent features to function.
146918     * Support must be enabled on a per-sandbox basis by enabling the
146919     * parent_access flag from the parent's context.
146920     *
146921     * @return void
146922     **/
146923    function __construct(){}
146924
146925}
146926/**
146927 * Exception thrown if an error which can only be found on runtime
146928 * occurs.
146929 **/
146930class RuntimeException extends Exception {
146931}
146932class SAMConnection {
146933    /**
146934     * Contains the unique numeric error code of the last executed SAM
146935     * operation
146936     *
146937     * Contains the numeric error code of the last executed SAM operation on
146938     * this connection. If the last operation completed successfully this
146939     * property contains 0.
146940     *
146941     * @var int
146942     **/
146943    public $errno;
146944
146945    /**
146946     * Contains the text description of the last failed SAM operation
146947     *
146948     * Contains the text description of the last failed SAM operation on this
146949     * connection. If the last operation completed successfully this property
146950     * contains an empty string.
146951     *
146952     * @var string
146953     **/
146954    public $error;
146955
146956    /**
146957     * Commits (completes) the current unit of work
146958     *
146959     * Calling the "commit" method on a Connection object commits (completes)
146960     * all in-flight transactions that are part of the current unit of work.
146961     *
146962     * @return bool This method returns FALSE if an error occurs.
146963     * @since PECL sam >= 0.1.0
146964     **/
146965    function commit(){}
146966
146967    /**
146968     * Establishes a connection to a Messaging Server
146969     *
146970     * Calling the "connect" method on a SAMConnection object connects the
146971     * PHP script to a messaging server. No messages can be sent or received
146972     * until a connection is made.
146973     *
146974     * @param string $protocol
146975     * @param array $properties
146976     * @return bool This method returns FALSE if an error occurs.
146977     * @since PECL sam >= 0.1.0
146978     **/
146979    function connect($protocol, $properties){}
146980
146981    /**
146982     * Disconnects from a Messaging Server
146983     *
146984     * Calling the "disconnect" method on a SAMConnection object disconnects
146985     * the PHP script from a messaging server. No messages can be sent or
146986     * received after a connection has been disconnected.
146987     *
146988     * @return bool
146989     * @since PECL sam >= 0.1.0
146990     **/
146991    function disconnect(){}
146992
146993    /**
146994     * Queries whether a connection is established to a Messaging Server
146995     *
146996     * Calling the "isConnected" method on a Connection object will check
146997     * whether the PHP script is connected to a messaging server. No messages
146998     * can be sent or received unless a connection has been established with
146999     * a Messaging server.
147000     *
147001     * @return bool This method returns TRUE if the SAMConnection object is
147002     *   successfully connected to a Messaging server or FALSE otherwise.
147003     * @since PECL sam >= 0.1.0
147004     **/
147005    function isConnected(){}
147006
147007    /**
147008     * Read a message from a queue without removing it from the queue
147009     *
147010     * @param string $target The identity of the queue from which to peek
147011     *   the message.
147012     * @param array $properties An optional associative array of properties
147013     *   describing other parameters to control the peek operation. Property
147014     *   name Possible values SAM_CORRELID This is the target correlation id
147015     *   string of the message. This would typically have been returned by a
147016     *   "send" request. SAM_MESSAGEID This is the message id string of the
147017     *   message which is to be peeked.
147018     * @return SAMMessage This method returns a SAMMessage object or FALSE
147019     *   if an error occurs.
147020     * @since PECL sam >= 0.1.0
147021     **/
147022    function peek($target, $properties){}
147023
147024    /**
147025     * Read one or more messages from a queue without removing it from the
147026     * queue
147027     *
147028     * @param string $target The identity of the queue from which messages
147029     *   should be peeked.
147030     * @param array $properties An optional associative array of properties
147031     *   describing other parameters to control the peek operation. Property
147032     *   name Possible values SAM_CORRELID This is the target correlation id
147033     *   string of messages to be peeked. This would typically have been
147034     *   returned by a "send" request. SAM_MESSAGEID This is the message id
147035     *   string of a message which is to be peeked.
147036     * @return array This method returns an array of SAMMessage objects or
147037     *   FALSE if an error occurs.
147038     * @since PECL sam >= 0.2.0
147039     **/
147040    function peekAll($target, $properties){}
147041
147042    /**
147043     * Receive a message from a queue or subscription
147044     *
147045     * @param string $target The identity of the queue, topic or
147046     *   subscription from which to receive the message.
147047     * @param array $properties An optional associative array of properties
147048     *   describing other parameters to control the receive operation.
147049     *   Property name Possible values SAM_CORRELID Used to request selection
147050     *   of the message to receive based upon the correlation id string of
147051     *   the message. SAM_MESSAGEID Used to request selection of the message
147052     *   to receive based upon the message id string of the message. SAM_WAIT
147053     *   Timeout value in milliseconds to control how long the request should
147054     *   block waiting to receive a message before returning with a failure
147055     *   if no message is available on the queue or topic. The default value
147056     *   is 0 meaning wait indefinitely and should be used with caution as
147057     *   the request may wait until the overall PHP script processing time
147058     *   limit has expired if no message becomes available.
147059     * @return SAMMessage This method returns a SAMMessage object or FALSE
147060     *   if an error occurs.
147061     * @since PECL sam >= 0.1.0
147062     **/
147063    function receive($target, $properties){}
147064
147065    /**
147066     * Remove a message from a queue
147067     *
147068     * Removes a message from a queue.
147069     *
147070     * @param string $target The identity of the queue from which to remove
147071     *   the message.
147072     * @param array $properties An optional associative array of properties
147073     *   describing other parameters to control the remove operation.
147074     *   Property name Possible values SAM_CORRELID This is the target
147075     *   correlation id string of the message. This would typically have been
147076     *   returned by a "send" request. SAM_MESSAGEID This is the message id
147077     *   string of the message which is to be removed.
147078     * @return SAMMessage This method returns FALSE if an error occurs.
147079     * @since PECL sam >= 0.1.0
147080     **/
147081    function remove($target, $properties){}
147082
147083    /**
147084     * Cancels (rolls back) an in-flight unit of work
147085     *
147086     * Rolls back an in-flight unit of work.
147087     *
147088     * @return bool This method returns FALSE if an error occurs.
147089     * @since PECL sam >= 0.1.0
147090     **/
147091    function rollback(){}
147092
147093    /**
147094     * Send a message to a queue or publish an item to a topic
147095     *
147096     * The "send" method is used to send a message to a specific queue or to
147097     * publish to a specific topic. The method returns a correlation id that
147098     * can be used as a selector to identify reply or response messages when
147099     * these are requested.
147100     *
147101     * @param string $target If sending a message, the identity of the
147102     *   queue (queue://queuename) or if publishing to a topic the identity
147103     *   of the topic (topic://topicname) to which the message is to be
147104     *   delivered.
147105     * @param SAMMessage $msg The message to be sent or published.
147106     * @param array $properties An optional associative array of properties
147107     *   describing other parameters to control the receive operation.
147108     *   Property name Possible values SAM_DELIVERYMODE Indicates whether the
147109     *   messaging server should ensure delivery or whether it is acceptable
147110     *   for messages to be lost in the case of system failures. The value of
147111     *   this property may be set to either SAM_PERSISTENT, to indicate that
147112     *   message loss is not acceptable, or SAM_NON_PERSISTENT, if message
147113     *   loss is acceptable. The resulting behaviour of the send will vary
147114     *   depending on the capabilities of the messaging server the PHP script
147115     *   is currently connected to. If the server does not support persistent
147116     *   messages and SAM_PERSISTENT is specified the send request will fail
147117     *   with an error indication showing the capability is not available.
147118     *   SAM_PRIORITY A numeric value between 0 and 9 indicating the desired
147119     *   message delivery priority. A priority value of 0 indicates the
147120     *   lowest priority while 9 indicates highest priority. If no priority
147121     *   is specified a default will be assigned which is dependent on the
147122     *   messaging server being used. SAM_CORRELID A string to be assigned as
147123     *   a correlation id for this message. If no value is given the
147124     *   messaging server may assign a value automatically. SAM_TIMETOLIVE A
147125     *   time in milliseconds indicating how long the messaging server should
147126     *   retain the message on a queue before discarding it. The default
147127     *   value is 0 indicating the message should be retained indefinitely.
147128     *   SAM_WMQ_TARGET_CLIENT This property is only valid when using
147129     *   WebSphere MQ and indicates whether or not an RFH2 header should be
147130     *   included with the message. This option may be set to either 'jms' or
147131     *   'mq'. The default is 'jms' which means that an RFH2 header is
147132     *   included. If the value 'mq' is specified then no RFH2 is included
147133     *   with the message.
147134     * @return string A correlation id string that can be used in a
147135     *   subsequent receive call as a selector to obtain any reply or
147136     *   response that has been requested or FALSE if an error occurred.
147137     * @since PECL sam >= 0.1.0
147138     **/
147139    function send($target, $msg, $properties){}
147140
147141    /**
147142     * Turn on or off additional debugging output
147143     *
147144     * The "setdebug" method is used to turn on or off additional debugging
147145     * output. The SAM framework will provide method/function entry and exit
147146     * trace data plus additional information. Protocol specific
147147     * implementations also provide extra output.
147148     *
147149     * @param bool $switch If this parameter is set to TRUE additional
147150     *   debugging output will be provided. If the value is set to FALSE
147151     *   output of additional information will be stopped.
147152     * @return void
147153     * @since PECL sam >= 1.1.0
147154     **/
147155    function setDebug($switch){}
147156
147157    /**
147158     * Create a subscription to a specified topic
147159     *
147160     * The "subscribe" method is used to create a new subscription to a
147161     * specified topic.
147162     *
147163     * @param string $targetTopic The identity of the topic
147164     *   (topic://topicname) to subscribe to.
147165     * @return string A subscription identifier that can be used in a
147166     *   subsequent receive call as a selector to obtain any topic data or
147167     *   FALSE if an error occurred. The subscription identifier should be
147168     *   used in the receive call in place of the simple topic name.
147169     * @since PECL sam >= 0.1.0
147170     **/
147171    function subscribe($targetTopic){}
147172
147173    /**
147174     * Cancel a subscription to a specified topic
147175     *
147176     * The "unsubscribe" method is used to delete an existing subscription to
147177     * a specified topic.
147178     *
147179     * @param string $subscriptionId The identifier of an existing
147180     *   subscription as returned by a call to the subscribe method.
147181     * @param string $targetTopic
147182     * @return bool This method returns FALSE if an error occurs.
147183     * @since PECL sam >= 0.1.0
147184     **/
147185    function unsubscribe($subscriptionId, $targetTopic){}
147186
147187}
147188class SAMMessage {
147189    /**
147190     * The body of the message
147191     *
147192     * The "body" property contains the actual body of the message. It may
147193     * not always be set.
147194     *
147195     * @var string
147196     **/
147197    public $body;
147198
147199    /**
147200     * The header properties of the message
147201     *
147202     * The header property is a container for any system or user properties
147203     * that area associated with the message.
147204     *
147205     * Properties may be assigned by the sender of a message to control the
147206     * way the messaging systems handles it or may be assigned by the
147207     * messaging system itself to tell the recipient extra information about
147208     * the message or the way in which it has been handled.
147209     *
147210     * Some properties are understood by SAM in which case constants have
147211     * been defined for them. The majority of properties however are ignored
147212     * by the SAM implementation and simply passed through to the underlying
147213     * messaging systems allowing the application to use messaging specific
147214     * property names or to define its own "user" properties.
147215     *
147216     * The SAM defined properties are as follows: Property name Possible
147217     * values SAM_MESSAGEID When a message is received this field contains
147218     * the unique identifier of the message as allocated by the underlying
147219     * messaging system. When sending a message this field is ignored.
147220     * SAM_REPLY_TO A string providing the identity of the queue on to which
147221     * responses to this message should be posted. SAM_TYPE An indication of
147222     * the type of message to be sent. The value may be SAM_TEXT indicating
147223     * the contents of the message body is a text string, or SAM_BYTES
147224     * indicating the contents of the message body are some application
147225     * defined format. The way in which this property is used may depend on
147226     * the underlying messaging server. For instance a messaging server that
147227     * supports the JMS (Java Message Service) specification may interpret
147228     * this value and send messages of type "jms_text" and "jms_bytes". In
147229     * addition, if the SAM_TYPE property is set to SAM_TEXT the data
147230     * provided for the message body is expected to be a UTF8 encoded string.
147231     *
147232     * When setting the values of properties it is often useful to give a
147233     * hint as to the format in which the property should be delivered to the
147234     * messaging system. By default property values are delivered as text and
147235     * the following simple syntax may be used to set a value:
147236     *
147237     * Setting a text format property using the default syntax
147238     *
147239     * <?php $msg = new SAMMessage();
147240     *
147241     * $msg->header->myPropertyName = 'textData'; ?>
147242     *
147243     * If it is desired to pass type information an alternative syntax may be
147244     * used where the value and the type hint are passed in an associative
147245     * array:
147246     *
147247     * Setting a text format property using a type hint
147248     *
147249     * <?php $msg = new SAMMessage();
147250     *
147251     * $msg->header->myPropertyName = array('textData', SAM_STRING); ?>
147252     *
147253     * When passing a type hint the type entry should be one of the SAM
147254     * defined constant values as defined by the following table: Constant
147255     * Type description SAM_BOOLEAN Any value passed will be interpreted as
147256     * logical true or false. If the value cannot be interpreted as a PHP
147257     * boolean value the value passed to the messaging system is undefined.
147258     * SAM_BYTE An 8-bit signed integer value. SAM will attempt to convert
147259     * the property value specified into a single byte value to pass to the
147260     * messaging system. If a string value is passed an attempt will be made
147261     * to interpret the string as a numeric value. If the numeric value
147262     * cannot be expressed as an 8-bit signed binary value data may be lost
147263     * in the conversion. SAM_DOUBLE A long floating point value. SAM will
147264     * attempt to convert the property value specified into a floating point
147265     * value with 15 digits of precision. If a string value is passed an
147266     * attempt will be made to interpret the string as a numeric value. If
147267     * the passed value cannot be expressed as a 15 digit floating point
147268     * value data may be lost in the conversion. SAM_FLOAT A short floating
147269     * point value. SAM will attempt to convert the property value specified
147270     * into a floating point value with 7 digits of precision. If a string
147271     * value is passed an attempt will be made to interpret the string as a
147272     * numeric value. If the passed value cannot be expressed as a 7 digit
147273     * floating point value data may be lost in the conversion. SAM_INT An
147274     * 32-bit signed integer value. SAM will attempt to convert the property
147275     * value specified into a 32-bit value to pass to the messaging system.
147276     * If a string value is passed an attempt will be made to interpret the
147277     * string as a numeric value. If the numeric value cannot be expressed as
147278     * an 32-bit signed binary value data may be lost in the conversion.
147279     * SAM_LONG An 64-bit signed integer value. SAM will attempt to convert
147280     * the property value specified into a 64-bit value to pass to the
147281     * messaging system. If a string value is passed an attempt will be made
147282     * to interpret the string as a numeric value. If the numeric value
147283     * cannot be expressed as an 64-bit signed binary value data may be lost
147284     * in the conversion. SAM_STRING SAM will interpret the property value
147285     * specified as a string and pass it to the messaging system accordingly.
147286     *
147287     * @var object
147288     **/
147289    public $header;
147290
147291}
147292class SCA {
147293    /**
147294     * Create an SDO
147295     *
147296     * This method is used inside an SCA component that needs to create an
147297     * SDO to return. The parameters are the desired SDO's namespace URI and
147298     * type name. The namespace and type must be defined in one of the schema
147299     * files which are specified on the @types annotation within the
147300     * component.
147301     *
147302     * @param string $type_namespace_uri The namespace of the type.
147303     * @param string $type_name The name of the type.
147304     * @return SDO_DataObject Returns the newly created SDO_DataObject.
147305     * @since PECL SDO >= 0.5.0
147306     **/
147307    function createDataObject($type_namespace_uri, $type_name){}
147308
147309    /**
147310     * Obtain a proxy for a service
147311     *
147312     * Examine the target and initialize and return a proxy of the
147313     * appropriate sort. If the target is for a local PHP component the
147314     * returned proxy will be an SCA_LocalProxy. If the target is for a WSDL
147315     * file, the returned proxy will be a SCA_SoapProxy.
147316     *
147317     * @param string $target An absolute or relative path to the target
147318     *   service or service description (e.g. a URL to a json-rpc service
147319     *   description, a PHP component, a WSDL file, and so on.). A relative
147320     *   path, if specified, is resolved relative to the location of the
147321     *   script issuing the {@link getService} call, and not against the
147322     *   include_path or current working directory.
147323     * @param string $binding The binding (i.e. protocol) to use to
147324     *   communicate with the service (e.g binding.jsonrpc for a json-rpc
147325     *   service). Note, some service types can be deduced from the target
147326     *   parameter (e.g. if the target parameter ends in .wsdl then SCA will
147327     *   assume binding.soap). Any binding which can be specified in an
147328     *   annotation can be specified here. For example 'binding.soap' is
147329     *   equivalent to the '@binding.soap' annotation.
147330     * @param array $config Any additional configuration properties for the
147331     *   binding (e.g. array('location' => 'http://example.org')). Any
147332     *   binding configuration which can be specified in an annotation can be
147333     *   specified here. For example, 'location' is equivalent to the
147334     *   '@location' annotation to configure the location of a target soap
147335     *   service.
147336     * @return mixed The SCA_LocalProxy or SCA_SoapProxy.
147337     * @since PECL SDO >= 0.5.0
147338     **/
147339    function getService($target, $binding, $config){}
147340
147341}
147342class SCA_LocalProxy {
147343    /**
147344     * Create an SDO
147345     *
147346     * This method is used inside either an ordinary PHP script or an SCA
147347     * component that needs to create an SDO to pass to a local service. The
147348     * parameters are the desired SDO's namespace URI and type name. The
147349     * namespace and type must be defined in the interface of the component
147350     * that is to be called, so the namespace and type must be defined in one
147351     * of the schema files which are specified on the @types annotation
147352     * within the component for which the SCA_LocalProxy object is a proxy.
147353     *
147354     * @param string $type_namespace_uri The namespace of the type.
147355     * @param string $type_name The name of the type.
147356     * @return SDO_DataObject Returns the newly created SDO_DataObject.
147357     * @since PECL SDO >= 0.5.0
147358     **/
147359    function createDataObject($type_namespace_uri, $type_name){}
147360
147361}
147362class SCA_SoapProxy {
147363    /**
147364     * Create an SDO
147365     *
147366     * This method is used inside either an ordinary PHP script or an SCA
147367     * component that needs to create an SDO to pass to a web service. The
147368     * parameters are the desired SDO's namespace URI and type name. The
147369     * namespace and type must be defined in the interface of the component
147370     * that is to be called, so the namespace and type must be defined within
147371     * the WSDL for the web service. If the web service is also an SCA
147372     * component then the types will have been defined within one of the
147373     * schema files which are specified on the @types annotation within the
147374     * component for which the SCA_SoapProxy object is a proxy.
147375     *
147376     * @param string $type_namespace_uri The namespace of the type.
147377     * @param string $type_name The name of the type.
147378     * @return SDO_DataObject Returns the newly created SDO_DataObject.
147379     * @since PECL SDO >= 0.5.0
147380     **/
147381    function createDataObject($type_namespace_uri, $type_name){}
147382
147383}
147384class SDO_DAS_ChangeSummary {
147385    const ADDITION = 0;
147386
147387    const DELETION = 0;
147388
147389    const MODIFICATION = 0;
147390
147391    const NONE = 0;
147392
147393    /**
147394     * Begin change logging
147395     *
147396     * Begin logging changes made to the SDO_DataObject.
147397     *
147398     * @return void None.
147399     * @since ^
147400     **/
147401    function beginLogging(){}
147402
147403    /**
147404     * End change logging
147405     *
147406     * End logging changes made to an SDO_DataObject.
147407     *
147408     * @return void None.
147409     * @since ^
147410     **/
147411    function endLogging(){}
147412
147413    /**
147414     * Get the changed data objects from a change summary
147415     *
147416     * Get an SDO_List of the SDO_DataObjects which have been changed. These
147417     * data objects can then be used to identify the types of change made to
147418     * each, along with the old values.
147419     *
147420     * @return SDO_List Returns an SDO_List of SDO_DataObjects.
147421     * @since ^
147422     **/
147423    function getChangedDataObjects(){}
147424
147425    /**
147426     * Get the type of change made to an SDO_DataObject
147427     *
147428     * Get the type of change which has been made to the supplied
147429     * SDO_DataObject.
147430     *
147431     * @param SDO_DataObject $dataObject The SDO_DataObject which has been
147432     *   changed.
147433     * @return int The type of change which has been made. The change type
147434     *   is expressed as an enumeration and will be one of the following four
147435     *   values: SDO_DAS_ChangeSummary::NONE
147436     *   SDO_DAS_ChangeSummary::MODIFICATION SDO_DAS_ChangeSummary::ADDITION
147437     *   SDO_DAS_ChangeSummary::DELETION
147438     * @since ^
147439     **/
147440    function getChangeType($dataObject){}
147441
147442    /**
147443     * Get the old container for a deleted SDO_DataObject
147444     *
147445     * Get the old container (SDO_DataObject) for a deleted SDO_DataObject.
147446     *
147447     * @param SDO_DataObject $data_object The SDO_DataObject which has been
147448     *   deleted and whose container we wish to identify.
147449     * @return SDO_DataObject The old containing data object of the deleted
147450     *   SDO_DataObject.
147451     * @since ^
147452     **/
147453    function getOldContainer($data_object){}
147454
147455    /**
147456     * Get the old values for a given changed SDO_DataObject
147457     *
147458     * Get a list of the old values for a given changed SDO_DataObject.
147459     * Returns a list of SDO_DAS_Settings describing the old values for the
147460     * changed properties of the SDO_DataObject.
147461     *
147462     * @param SDO_DataObject $data_object The data object which has been
147463     *   changed.
147464     * @return SDO_List A list of SDO_DAS_Settings describing the old
147465     *   values for the changed properties of the SDO_DataObject. If the
147466     *   change type is SDO_DAS_ChangeSummary::ADDITION, this list is empty.
147467     * @since ^
147468     **/
147469    function getOldValues($data_object){}
147470
147471    /**
147472     * Test to see whether change logging is switched on
147473     *
147474     * Test to see whether change logging is switched on.
147475     *
147476     * @return bool Returns TRUE if change logging is on, otherwise returns
147477     *   FALSE.
147478     * @since ^
147479     **/
147480    function isLogging(){}
147481
147482}
147483class SDO_DAS_DataFactory {
147484    /**
147485     * Adds a property to a type
147486     *
147487     * Adds a property to a type. The type must already be known to the
147488     * SDO_DAS_DataFactory (i.e. have been added using addType()). The
147489     * property becomes a property of the type. This is how the graph model
147490     * for the structure of an SDO_DataObject is built.
147491     *
147492     * @param string $parent_type_namespace_uri The namespace URI for the
147493     *   parent type.
147494     * @param string $parent_type_name The type name for the parent type.
147495     * @param string $property_name The name by which the property will be
147496     *   known in the parent type.
147497     * @param string $type_namespace_uri The namespace URI for the type of
147498     *   the property.
147499     * @param string $type_name The type name for the type of the property
147500     * @param array $options This array holds one or more key=>value pairs
147501     *   to set attribute values for the property. The optional keywords are:
147502     * @return void None.
147503     * @since ^
147504     **/
147505    function addPropertyToType($parent_type_namespace_uri, $parent_type_name, $property_name, $type_namespace_uri, $type_name, $options){}
147506
147507    /**
147508     * Add a new type to a model
147509     *
147510     * Add a new type to the SDO_DAS_DataFactory, defined by its namespace
147511     * and type name. The type becomes part of the model of data objects that
147512     * the data factory can create.
147513     *
147514     * @param string $type_namespace_uri The namespace of the type.
147515     * @param string $type_name The name of the type.
147516     * @param array $options This array holds one or more key=>value pairs
147517     *   to set attribute values for the type. The optional keywords are:
147518     * @return void None.
147519     * @since ^
147520     **/
147521    function addType($type_namespace_uri, $type_name, $options){}
147522
147523    /**
147524     * Get a data factory instance
147525     *
147526     * Static method to get an instance of an SDO_DAS_DataFactory. This
147527     * instance is initially only configured with the basic SDO types. A Data
147528     * Access Service is responsible for populating the data factory model
147529     * and then allowing PHP applications to create SDOs based on the model
147530     * through the SDO_DataFactory interface. PHP applications should always
147531     * obtain a data factory from a configured Data Access Service, not
147532     * through this interface.
147533     *
147534     * @return SDO_DAS_DataFactory Returns an SDO_DAS_DataFactory.
147535     * @since ^
147536     **/
147537    function getDataFactory(){}
147538
147539}
147540class SDO_DAS_DataObject {
147541    /**
147542     * Get a data object's change summary
147543     *
147544     * Get the SDO_DAS_ChangeSummary for an SDO_DAS_DataObject, or NULL if it
147545     * does not have one.
147546     *
147547     * @return SDO_DAS_ChangeSummary Returns the SDO_DAS_ChangeSummary for
147548     *   an SDO_DAS_DataObject, or NULL if it does not have one.
147549     * @since ^
147550     **/
147551    function getChangeSummary(){}
147552
147553}
147554class SDO_DAS_Relational {
147555    /**
147556     * Applies the changes made to a data graph back to the database
147557     *
147558     * Given a PDO database handle and the special root object of a data
147559     * graph, examine the change summary in the datagraph and applies the
147560     * changes to the database. The changes that it can apply can be
147561     * creations of data objects, deletes of data objects, and modifications
147562     * to properties of data objects.
147563     *
147564     * @param PDO $database_handle Constructed using the PDO extension. A
147565     *   typical line to construct a PDO database handle might look like
147566     *   this:
147567     *
147568     *   $dbh = new
147569     *   PDO("mysql:dbname=COMPANYDB;host=localhost",DATABASE_USER,DATABASE_PASSWORD);
147570     * @param SDODataObject $root_data_object The special root object which
147571     *   is at the top of every SDO data graph.
147572     * @return void None. Note however that the datagraph that was passed
147573     *   is still intact and usable. Furthermore, if data objects were
147574     *   created and written back to a table with autogenerated primary keys,
147575     *   then those primary keys will now be set in the data objects. If the
147576     *   changes were successfully written, then the change summary
147577     *   associated with the datagraph will have been cleared, so that it is
147578     *   possible to now make further changes to the data graph and apply
147579     *   those changes in turn. In this way it is possible to work with the
147580     *   same data graph and apply changes repeatedly.
147581     * @since ^
147582     **/
147583    function applyChanges($database_handle, $root_data_object){}
147584
147585    /**
147586     * Returns the special root object in an otherwise empty data graph. Used
147587     * when creating a data graph from scratch
147588     *
147589     * Returns the special root object at the top of an otherwise empty data
147590     * graph. This call is used when the application wants to create a data
147591     * graph from scratch, without having called {@link executeQuery} to
147592     * create a data graph.
147593     *
147594     * The special root object has one multi-valued containment property,
147595     * with a name of the application root type that was passed when the
147596     * Relational DAS was constructed. The property can take values of only
147597     * that type. The only thing that the application can usefully do with
147598     * the root type is to call {@link createDataObject} on it, passing the
147599     * name of the application root type, in order to create a data object of
147600     * their own application type.
147601     *
147602     * @return SDODataObject The root object.
147603     * @since ^
147604     **/
147605    function createRootDataObject(){}
147606
147607    /**
147608     * Executes an SQL query passed as a prepared statement, with a list of
147609     * values to substitute for placeholders, and return the results as a
147610     * normalised data graph
147611     *
147612     * Executes a given query against the relational database, using the
147613     * supplied PDO database handle. Differs from the simpler {@link
147614     * executeQuery} in that it takes a prepared statement and a list of
147615     * values. This is the appropriate call to use either when the statement
147616     * is to executed a number of times with different arguments, and there
147617     * is therefore a performance benefit to be had from preparing the
147618     * statement only once, or when the SQL statement is to contain varying
147619     * values taken from a source that cannot be completely trusted. In this
147620     * latter case it may be unsafe to construct the SQL statement by simply
147621     * concatenating the parts of the statement together, since the values
147622     * may contain pieces of SQL. To guard against this, a so-called SQL
147623     * injection attack, it is safer to prepare the SQL statement with
147624     * placeholders (also known as parameter markers, denoted by '?') and
147625     * supply a list of the values to be substituted as a separate argument.
147626     * Otherwise this function is the same as {@link executeQuery} in that it
147627     * uses the model that it built from the metadata to interpret the result
147628     * set and returns a data graph.
147629     *
147630     * @param PDO $database_handle Constructed using the PDO extension. A
147631     *   typical line to construct a PDO database handle might look like
147632     *   this:
147633     *
147634     *   $dbh = new
147635     *   PDO("mysql:dbname=COMPANYDB;host=localhost",DATABASE_USER,DATABASE_PASSWORD);
147636     * @param PDOStatement $prepared_statement A prepared SQL statement to
147637     *   be executed against the database. This will have been prepared by
147638     *   PDO's {@link prepare} method.
147639     * @param array $value_list An array of the values to be substituted
147640     *   into the SQL statement in place of the placeholders. In the event
147641     *   that there are no placeholders or parameter markers in the SQL
147642     *   statement then this argument can be specified as NULL or as an empty
147643     *   array;
147644     * @param array $column_specifier The Relational DAS needs to examine
147645     *   the result set and for every column, know which table and which
147646     *   column of that table it came from. In some circumstances it can find
147647     *   this information for itself, but sometimes it cannot. In these cases
147648     *   a column specifier is needed, which is an array that identifies the
147649     *   columns. Each entry in the array is simply a string in the form
147650     *   table-name.column_name. The column specifier is needed when there
147651     *   are duplicate column names in the database metadata, For example, in
147652     *   the database used within the examples, all the tables have both a id
147653     *   and a name column. When the Relational DAS fetches the result set
147654     *   from PDO it can do so with the PDO_FETCH_ASSOC attribute, which will
147655     *   cause the columns in the results set to be labelled with the column
147656     *   name, but will not distinguish duplicates. So this will only work
147657     *   when there are no duplicates possible in the results set. To
147658     *   summarise, specify a column specifier array whenever there is any
147659     *   uncertainty about which column could be from which table and only
147660     *   omit it when every column name in the database metadata is unique.
147661     *   All of the examples in the Examples use a column specifier. There is
147662     *   one example in the Scenarios directory of the installation that does
147663     *   not: that which works with just the employee table, and because it
147664     *   works with just one table, there can not exist duplicate column
147665     *   names.
147666     * @return SDODataObject Returns a data graph. Specifically, it returns
147667     *   a root object of a special type. Under this root object will be the
147668     *   data from the result set. The root object will have a multi-valued
147669     *   containment property with the same name as the application root type
147670     *   specified on the constructor, and that property will contain one or
147671     *   more data objects of the application root type.
147672     * @since ^
147673     **/
147674    function executePreparedQuery($database_handle, $prepared_statement, $value_list, $column_specifier){}
147675
147676    /**
147677     * Executes a given SQL query against a relational database and returns
147678     * the results as a normalised data graph
147679     *
147680     * Executes a given query against the relational database, using the
147681     * supplied PDO database handle. Uses the model that it built from the
147682     * metadata to interpret the result set. Returns a data graph.
147683     *
147684     * @param PDO $database_handle Constructed using the PDO extension. A
147685     *   typical line to construct a PDO database handle might look like
147686     *   this:
147687     *
147688     *   $dbh = new
147689     *   PDO("mysql:dbname=COMPANYDB;host=localhost",DATABASE_USER,DATABASE_PASSWORD);
147690     * @param string $SQL_statement The SQL statement to be executed
147691     *   against the database.
147692     * @param array $column_specifier The Relational DAS needs to examine
147693     *   the result set and for every column, know which table and which
147694     *   column of that table it came from. In some circumstances it can find
147695     *   this information for itself, but sometimes it cannot. In these cases
147696     *   a column specifier is needed, which is an array that identifies the
147697     *   columns. Each entry in the array is simply a string in the form
147698     *   table-name.column_name. The column specifier is needed when there
147699     *   are duplicate column names in the database metadata. For example, in
147700     *   the database used within the examples, all the tables have both a id
147701     *   and a name column. When the Relational DAS fetches the result set
147702     *   from PDO it can do so with the PDO_FETCH_ASSOC attribute, which will
147703     *   cause the columns in the results set to be labelled with the column
147704     *   name, but will not distinguish duplicates. So this will only work
147705     *   when there are no duplicates possible in the results set. To
147706     *   summarise, specify a column specifier array whenever there is any
147707     *   uncertainty about which column could be from which table and only
147708     *   omit it when every column name in the database metadata is unique.
147709     *   All of the examples in the Examples use a column specifier. There is
147710     *   one example in the Scenarios directory of the installation that does
147711     *   not: that which works with just the employee table, and because it
147712     *   works with just one table, there can not exist duplicate column
147713     *   names.
147714     * @return SDODataObject Returns a data graph. Specifically, it returns
147715     *   a root object of a special type. Under this root object will be the
147716     *   data from the result set. The root object will have a multi-valued
147717     *   containment property with the same name as the application root type
147718     *   specified on the constructor, and that property will contain one or
147719     *   more data objects of the application root type.
147720     * @since ^
147721     **/
147722    function executeQuery($database_handle, $SQL_statement, $column_specifier){}
147723
147724    /**
147725     * Creates an instance of a Relational Data Access Service
147726     *
147727     * Constructs an instance of a Relational Data Access Service from the
147728     * passed metadata.
147729     *
147730     * @param array $database_metadata An array containing one or more
147731     *   table definitions, each of which is an associative array containing
147732     *   the keys name, columns, PK, and optionally, FK. For a full
147733     *   discussion of the metadata, see the metadata section in the general
147734     *   information about the Relational DAS.
147735     * @param string $application_root_type The root of each data graph is
147736     *   an object of a special root type and the application data objects
147737     *   come below that. Of the various application types in the SDO model,
147738     *   one has to be the application type immediately below the root of the
147739     *   data graph. If there is only one table in the database metadata, so
147740     *   the application root type can be inferred, this argument can be
147741     *   omitted.
147742     * @param array $SDO_containment_references_metadata An array
147743     *   containing one or more definitions of a containment relation, each
147744     *   of which is an associative array containing the keys parent and
147745     *   child. The containment relations describe how the types in the model
147746     *   are connected to form a tree. The type specified as the application
147747     *   root type must be present as one of the parent types in the
147748     *   containment references. If the application only needs to work with
147749     *   one table at a time, and there are no containment relations in the
147750     *   model, this argument can be omitted. For a full discussion of the
147751     *   metadata, see the metadata section in the general information about
147752     *   the Relational DAS.
147753     * @since ^
147754     **/
147755    function __construct($database_metadata, $application_root_type, $SDO_containment_references_metadata){}
147756
147757}
147758class SDO_DAS_Setting {
147759    /**
147760     * Get the list index for a changed many-valued property
147761     *
147762     * Get the list index for a modification made to an element of a
147763     * many-valued property. For example, if we modified the third element of
147764     * a many-valued property we could obtain an SDO_DAS_Setting from the
147765     * change summary corresponding to that modification. A call to {@link
147766     * getListIndex} on that setting would return the value 2 (lists are
147767     * indexed from zero).
147768     *
147769     * @return int The list index for the element of the many-valued
147770     *   property which has been changed.
147771     * @since ^
147772     **/
147773    function getListIndex(){}
147774
147775    /**
147776     * Get the property index for a changed property
147777     *
147778     * Returns the property index for the changed property. This index
147779     * identifies the property which was modified in data object.
147780     *
147781     * @return int The property index for a changed property.
147782     * @since ^
147783     **/
147784    function getPropertyIndex(){}
147785
147786    /**
147787     * Get the property name for a changed property
147788     *
147789     * Returns the property name for the changed property. This name
147790     * identifies the property which was modified in data object.
147791     *
147792     * @return string The property name for a changed property.
147793     * @since ^
147794     **/
147795    function getPropertyName(){}
147796
147797    /**
147798     * Get the old value for the changed property
147799     *
147800     * Returns the old value for the changed property. This can be used by a
147801     * Data Access Service when writing updates to a data source. The DAS
147802     * uses the old value to detect conflicts by comparing it with the
147803     * current value in the data source. If they do not match, then the data
147804     * source has been updated since the data object was originally
147805     * populated, and therefore writing any new updates risks compromising
147806     * the integrity of the data.
147807     *
147808     * @return mixed Returns the old value of the changed property.
147809     * @since ^
147810     **/
147811    function getValue(){}
147812
147813}
147814class SDO_DAS_XML {
147815    /**
147816     * To load a second or subsequent schema file to a SDO_DAS_XML object
147817     *
147818     * Load a second or subsequent schema file to an XML DAS that has already
147819     * been created with the static method {@link create}. Although the file
147820     * may be any valid schema file, a likely reason for using this method is
147821     * to add a schema file containing definitions of extra complex types,
147822     * hence the name. See Example 4 of the parent document for an example.
147823     *
147824     * @param string $xsd_file Path to XSD Schema file.
147825     * @return void None if successful, otherwise throws an exception as
147826     *   described below.
147827     * @since ^
147828     **/
147829    function addTypes($xsd_file){}
147830
147831    /**
147832     * To create SDO_DAS_XML object for a given schema file
147833     *
147834     * This is the only static method of SDO_DAS_XML class. Used to
147835     * instantiate SDO_DAS_XML object.
147836     *
147837     * @param mixed $xsd_file Path to XSD Schema file. This is optional. If
147838     *   omitted a DAS will be created that only has the SDO base types
147839     *   defined. Schema files can then be loaded with the {@link addTypes}
147840     *   method. Can be string or array of values.
147841     * @param string $key
147842     * @return SDO_DAS_XML Returns SDO_DAS_XML object on success otherwise
147843     *   throws an exception as described below.
147844     * @since ^
147845     **/
147846    function create($xsd_file, $key){}
147847
147848    /**
147849     * Creates SDO_DataObject for a given namespace URI and type name
147850     *
147851     * Creates SDO_DataObject for a given namespace URI and type name. The
147852     * type should be defined in the underlying model otherwise
147853     * SDO_TypeNotFoundException will be thrown.
147854     *
147855     * @param string $namespace_uri Namespace URI of the type name.
147856     * @param string $type_name Type Name.
147857     * @return SDO_DataObject Returns SDO_DataObject on success.
147858     * @since ^
147859     **/
147860    function createDataObject($namespace_uri, $type_name){}
147861
147862    /**
147863     * Creates an XML Document object from scratch, without the need to load
147864     * a document from a file or string
147865     *
147866     * Creates an XML Document object. This will contain just one empty root
147867     * element on which none of the properties will have been set. The
147868     * purpose of this call is to allow an application to create an XML
147869     * document from scratch without the need to load a document from a file
147870     * or string. The document that is created will be as if a document had
147871     * been loaded that contained just a single empty document element with
147872     * no attributes set or elements within it.
147873     *
147874     * {@link createDocument} may need to be told what the document element
147875     * is. This will not be necessary in simple cases. When there is no
147876     * ambiguity then no parameter need be passed to the method. However it
147877     * is possible to load more than one schema file into the same XML DAS
147878     * and in this case there may be more than one possible document element
147879     * defined: furthermore it is even possible that there are two possible
147880     * document elements that differ only in the namespace. To cope with
147881     * these cases it is possible to specify either the document element
147882     * name, or both the document element name and namespace to the method.
147883     *
147884     * @param string $document_element_name The name of the document
147885     *   element. Only needed if there is more than one possibility.
147886     * @return SDO_DAS_XML_Document Returns an SDO_XML_DAS_Document object
147887     *   on success.
147888     * @since ^
147889     **/
147890    function createDocument($document_element_name){}
147891
147892    /**
147893     * Returns SDO_DAS_XML_Document object for a given path to xml instance
147894     * document
147895     *
147896     * Constructs the tree of SDO_DataObjects from the given address to xml
147897     * instance document. Returns SDO_DAS_XML_Document Object. Use
147898     * SDO_DAS_XML_Document::getRootDataObject method to get root data
147899     * object.
147900     *
147901     * @param string $xml_file Path to Instance document. This can be a
147902     *   path to a local file or it can be a URL.
147903     * @return SDO_XMLDocument Returns SDO_DAS_XML_Document object on
147904     *   Success or throws exception as described.
147905     * @since ^
147906     **/
147907    function loadFile($xml_file){}
147908
147909    /**
147910     * Returns SDO_DAS_XML_Document for a given xml instance string
147911     *
147912     * Constructs the tree of SDO_DataObjects from the given xml instance
147913     * string. Returns SDO_DAS_XML_Document Object. Use
147914     * SDO_DAS_XML_Document::getRootDataObject method to get root data
147915     * object.
147916     *
147917     * @param string $xml_string xml string.
147918     * @return SDO_DAS_XML_Document Returns SDO_DAS_XML_Document object on
147919     *   Success or throws exception as described.
147920     * @since ^
147921     **/
147922    function loadString($xml_string){}
147923
147924    /**
147925     * Saves the SDO_DAS_XML_Document object to a file
147926     *
147927     * Saves the SDO_DAS_XML_Document object to a file.
147928     *
147929     * @param SDO_XMLDocument $xdoc SDO_DAS_XML_Document object.
147930     * @param string $xml_file xml file.
147931     * @param int $indent Optional argument to specify that the xml should
147932     *   be formatted. A non-negative integer is the amount to indent each
147933     *   level of the xml. So, the integer 2, for example, will indent the
147934     *   xml so that each contained element is two spaces further to the
147935     *   right than its containing element. The integer 0 will cause the xml
147936     *   to be completely left-aligned. The integer -1 means no formatting -
147937     *   the xml will come out on one long line.
147938     * @return void None.
147939     * @since ^
147940     **/
147941    function saveFile($xdoc, $xml_file, $indent){}
147942
147943    /**
147944     * Saves the SDO_DAS_XML_Document object to a string
147945     *
147946     * Saves the SDO_DAS_XML_Document object to string.
147947     *
147948     * @param SDO_XMLDocument $xdoc SDO_DAS_XML_Document object.
147949     * @param int $indent Optional argument to specify that the xml should
147950     *   be formatted. A non-negative integer is the amount to indent each
147951     *   level of the xml. So, the integer 2, for example, will indent the
147952     *   xml so that each contained element is two spaces further to the
147953     *   right than its containing element. The integer 0 will cause the xml
147954     *   to be completely left-aligned. The integer -1 means no formatting -
147955     *   the xml will come out on one long line.
147956     * @return string xml string.
147957     * @since ^
147958     **/
147959    function saveString($xdoc, $indent){}
147960
147961}
147962class SDO_DAS_XML_Document {
147963    /**
147964     * Returns the root SDO_DataObject
147965     *
147966     * Returns the root SDO_DataObject.
147967     *
147968     * @return SDO_DataObject Returns the root SDO_DataObject.
147969     * @since ^
147970     **/
147971    function getRootDataObject(){}
147972
147973    /**
147974     * Returns root element's name
147975     *
147976     * Returns root element's name.
147977     *
147978     * @return string Returns root element's name.
147979     * @since ^
147980     **/
147981    function getRootElementName(){}
147982
147983    /**
147984     * Returns root element's URI string
147985     *
147986     * Returns root element's URI string.
147987     *
147988     * @return string Returns root element's URI string.
147989     * @since ^
147990     **/
147991    function getRootElementURI(){}
147992
147993    /**
147994     * Sets the given string as encoding
147995     *
147996     * Sets the given string as encoding.
147997     *
147998     * @param string $encoding Encoding string.
147999     * @return void None.
148000     * @since ^
148001     **/
148002    function setEncoding($encoding){}
148003
148004    /**
148005     * Sets the xml declaration
148006     *
148007     * Controls whether an XML declaration will be generated at the start of
148008     * the XML document. Set to TRUE to generate the XML declaration, or
148009     * FALSE to suppress it.
148010     *
148011     * @param bool $xmlDeclatation Boolean value to set the XML
148012     *   declaration.
148013     * @return void None.
148014     * @since ^
148015     **/
148016    function setXMLDeclaration($xmlDeclatation){}
148017
148018    /**
148019     * Sets the given string as xml version
148020     *
148021     * Sets the given string as xml version.
148022     *
148023     * @param string $xmlVersion xml version string.
148024     * @return void None.
148025     * @since ^
148026     **/
148027    function setXMLVersion($xmlVersion){}
148028
148029}
148030class SDO_DataFactory {
148031    /**
148032     * Create an SDO_DataObject
148033     *
148034     * Create a new SDO_DataObject given the data object's namespace URI and
148035     * type name.
148036     *
148037     * @param string $type_namespace_uri The namespace of the type.
148038     * @param string $type_name The name of the type.
148039     * @return void Returns the newly created SDO_DataObject.
148040     * @since ^
148041     **/
148042    function create($type_namespace_uri, $type_name){}
148043
148044}
148045class SDO_DataObject {
148046    /**
148047     * Clear an SDO_DataObject's properties
148048     *
148049     * Clear an SDO_DataObject's properties. Read-only properties are
148050     * unaffected. Subsequent calls to isset() for the data object will
148051     * return FALSE.
148052     *
148053     * @return void No return values.
148054     * @since ^
148055     **/
148056    function clear(){}
148057
148058    /**
148059     * Create a child SDO_DataObject
148060     *
148061     * Create a child SDO_DataObject of the default type for the property
148062     * identified. The data object is automatically inserted into the tree
148063     * and a reference to it is returned.
148064     *
148065     * @param mixed $identifier Identifies the property for the data object
148066     *   type to be created. Can be either a property name (string), a
148067     *   property index (int), or an SDO_Model_Property.
148068     * @return SDO_DataObject Returns the newly created SDO_DataObject.
148069     * @since ^
148070     **/
148071    function createDataObject($identifier){}
148072
148073    /**
148074     * Get a data object's container
148075     *
148076     * Get the data object which contains this data object.
148077     *
148078     * @return SDO_DataObject Returns the SDO_DataObject which contains
148079     *   this SDO_DataObject, or returns NULL if this is a root
148080     *   SDO_DataObject (i.e. it has no container).
148081     * @since ^
148082     **/
148083    function getContainer(){}
148084
148085    /**
148086     * Get the sequence for a data object
148087     *
148088     * Return the SDO_Sequence for this SDO_DataObject. Accessing the
148089     * SDO_DataObject through the SDO_Sequence interface acts on the same
148090     * SDO_DataObject instance data, but preserves ordering across
148091     * properties.
148092     *
148093     * @return SDO_Sequence The SDO_Sequence for this SDO_DataObject, or
148094     *   returns NULL if the SDO_DataObject is not of a type which can have a
148095     *   sequence.
148096     * @since ^
148097     **/
148098    function getSequence(){}
148099
148100    /**
148101     * Return the name of the type for a data object
148102     *
148103     * Return the name of the type for a data object. A convenience method
148104     * corresponding to SDO_Model_ReflectionDataObject::getType().getName().
148105     *
148106     * @return string The name of the type for the data object.
148107     * @since ^
148108     **/
148109    function getTypeName(){}
148110
148111    /**
148112     * Return the namespace URI of the type for a data object
148113     *
148114     * Return the namespace URI of the type for a data object. A convenience
148115     * method corresponding to
148116     * SDO_Model_ReflectionDataObject::getType().getNamespaceURI().
148117     *
148118     * @return string The namespace URI of the type for the data object.
148119     * @since ^
148120     **/
148121    function getTypeNamespaceURI(){}
148122
148123}
148124class SDO_Exception {
148125    /**
148126     * Get the cause of the exception
148127     *
148128     * Returns the cause of this exception or NULL if the cause is
148129     * nonexistent or unknown. Typically the cause will be an
148130     * SDO_CPPException object, which may be used to obtain additional
148131     * diagnostic information.
148132     *
148133     * @return mixed Returns the cause of this exception or NULL if the
148134     *   cause is nonexistent or unknown.
148135     * @since ^
148136     **/
148137    function getCause(){}
148138
148139}
148140class SDO_List {
148141    /**
148142     * Insert into a list
148143     *
148144     * Insert a new element at a specified position in the list. All
148145     * subsequent list items are moved up.
148146     *
148147     * @param mixed $value The new value to be inserted. This can be either
148148     *   a primitive or an SDO_DataObject.
148149     * @param int $index The position at which to insert the new element.
148150     *   If this argument is not specified then the new value will be
148151     *   appended.
148152     * @return void None.
148153     * @since ^
148154     **/
148155    function insert($value, $index){}
148156
148157}
148158class SDO_Model_Property {
148159    /**
148160     * Get the SDO_Model_Type which contains this property
148161     *
148162     * Returns the SDO_Model_Type which contains this property.
148163     *
148164     * @return SDO_Model_Type Returns the SDO_Model_Type which contains
148165     *   this property.
148166     * @since ^
148167     **/
148168    function getContainingType(){}
148169
148170    /**
148171     * Get the default value for the property
148172     *
148173     * Returns the default value for the property. Only primitive data type
148174     * properties can have default values.
148175     *
148176     * @return mixed Returns the default value for the property.
148177     * @since ^
148178     **/
148179    function getDefault(){}
148180
148181    /**
148182     * Get the name of the SDO_Model_Property
148183     *
148184     * Returns the name of the SDO_Model_Property.
148185     *
148186     * @return string Returns the name of the SDO_Model_Property.
148187     * @since ^
148188     **/
148189    function getName(){}
148190
148191    /**
148192     * Get the SDO_Model_Type of the property
148193     *
148194     * Get the SDO_Model_Type of the property. The SDO_Model_Type describes
148195     * the type information for the property, such as its type name,
148196     * namespace URI, whether it is a primitive data type, and so on.
148197     *
148198     * @return SDO_Model_Type Returns the SDO_Model_Type describing the
148199     *   property's type information.
148200     * @since ^
148201     **/
148202    function getType(){}
148203
148204    /**
148205     * Test to see if the property defines a containment relationship
148206     *
148207     * Test to see if the property corresponds to a containment relationship.
148208     * Returns TRUE if the property defines a containment relationship, or
148209     * FALSE if it is reference.
148210     *
148211     * @return bool Returns TRUE if the property defines a containment
148212     *   relationship, or FALSE if it is reference.
148213     * @since ^
148214     **/
148215    function isContainment(){}
148216
148217    /**
148218     * Test to see if the property is many-valued
148219     *
148220     * Test to see if the property is many-valued. Returns TRUE if this is a
148221     * many-valued property, otherwise returns FALSE.
148222     *
148223     * @return bool Returns TRUE if this is a many-valued property,
148224     *   otherwise returns FALSE.
148225     * @since ^
148226     **/
148227    function isMany(){}
148228
148229}
148230class SDO_Model_ReflectionDataObject {
148231    /**
148232     * Get a string describing the SDO_DataObject
148233     *
148234     * Get a string describing the SDO_DataObject. The default behaviour is
148235     * to print the output, but if TRUE is specified for return, it is
148236     * returned as a string.
148237     *
148238     * @param SDO_Model_ReflectionDataObject $rdo An
148239     *   SDO_Model_ReflectionDataObject.
148240     * @param bool $return If TRUE, return the output as a string,
148241     *   otherwise print it.
148242     * @return mixed Returns the output if TRUE is specified for return,
148243     *   otherwise NULL.
148244     * @since ^
148245     **/
148246    function export($rdo, $return){}
148247
148248    /**
148249     * Get the property which defines the containment relationship to the
148250     * data object
148251     *
148252     * Get the SDO_Model_Property that contains the SDO_DataObject. This
148253     * method is used to navigate up to the parent's property which contains
148254     * the data object which has been reflected upon.
148255     *
148256     * @return SDO_Model_Property Returns the container's
148257     *   SDO_Model_Property which references the SDO_DataObject, or NULL if
148258     *   it is a root SDO_DataObject.
148259     * @since ^
148260     **/
148261    function getContainmentProperty(){}
148262
148263    /**
148264     * Get the instance properties of the SDO_DataObject
148265     *
148266     * Get the instance properties for the SDO_DataObject. The instance
148267     * properties consist of all the properties defined on the data object's
148268     * type, plus any instance properties from open content (if the data
148269     * object is an open type).
148270     *
148271     * @return array An array of SDO_Model_Property objects.
148272     * @since ^
148273     **/
148274    function getInstanceProperties(){}
148275
148276    /**
148277     * Get the SDO_Model_Type for the SDO_DataObject
148278     *
148279     * Returns the SDO_Model_Type for the SDO_DataObject. The SDO_Model_Type
148280     * holds all the information about the data object's type, such as
148281     * namespace URI, type name, whether it is a primitive data type, and so
148282     * on.
148283     *
148284     * @return SDO_Model_Type Returns the SDO_Model_Type for the
148285     *   SDO_DataObject.
148286     * @since ^
148287     **/
148288    function getType(){}
148289
148290    /**
148291     * Construct an SDO_Model_ReflectionDataObject
148292     *
148293     * Construct an SDO_Model_ReflectionDataObject to reflect on an
148294     * SDO_DataObject. Reflecting on an SDO_DataObject gives access to
148295     * information about its model. The model contains information such as
148296     * the data object's type, and whether that type is sequenced (preserves
148297     * ordering across properties) or open (each instance can have its model
148298     * extended). The model also holds information about the data object's
148299     * properties, any default values they may have, and so on.
148300     *
148301     * @param SDO_DataObject $data_object The SDO_DataObject being
148302     *   reflected upon.
148303     * @since ^
148304     **/
148305    function __construct($data_object){}
148306
148307}
148308class SDO_Model_Type {
148309    /**
148310     * Get the base type for this type
148311     *
148312     * Get the base type for this type. Returns the SDO_Model_Type for the
148313     * base type if this type inherits from another, otherwise returns NULL.
148314     * An example of when base types occur is when a type defined in XML
148315     * schema inherits from another type by using <extension base="..."> .
148316     *
148317     * @return SDO_Model_Type Returns the SDO_Model_Type for the base type
148318     *   if this type inherits from another, otherwise returns NULL.
148319     * @since ^
148320     **/
148321    function getBaseType(){}
148322
148323    /**
148324     * Get the name of the type
148325     *
148326     * Returns the name of the type. The combination of type name and
148327     * namespace URI is used to uniquely identify the type.
148328     *
148329     * @return string Returns the name of the type.
148330     * @since ^
148331     **/
148332    function getName(){}
148333
148334    /**
148335     * Get the namespace URI of the type
148336     *
148337     * Returns the namespace URI of the type. The combination of namespace
148338     * URI and type name is used to uniquely identify the type.
148339     *
148340     * @return string Returns the namespace URI of the type.
148341     * @since ^
148342     **/
148343    function getNamespaceURI(){}
148344
148345    /**
148346     * Get the SDO_Model_Property objects defined for the type
148347     *
148348     * Get an array of SDO_Model_Property objects describing the properties
148349     * defined for the SDO_Model_Type. Each SDO_Model_Property holds
148350     * information such as the property name, default value, and so on.
148351     *
148352     * @return array Returns an array of SDO_Model_Property objects.
148353     * @since ^
148354     **/
148355    function getProperties(){}
148356
148357    /**
148358     * Get an SDO_Model_Property of the type
148359     *
148360     * Get an SDO_Model_Property of the type, identified by its property
148361     * index or property name.
148362     *
148363     * @param mixed $identifier The property index or property name.
148364     * @return SDO_Model_Property Returns the SDO_Model_Property.
148365     * @since ^
148366     **/
148367    function getProperty($identifier){}
148368
148369    /**
148370     * Test to see if this SDO_Model_Type is an abstract data type
148371     *
148372     * Test to see if this SDO_Model_Type is an abstract data type. Returns
148373     * TRUE if this type is abstract, that is, no SDO_DataObject of this type
148374     * can be instantiated, though other types may inherit from it.
148375     *
148376     * @return bool Returns TRUE if this type is an abstract data type,
148377     *   otherwise returns FALSE.
148378     * @since ^
148379     **/
148380    function isAbstractType(){}
148381
148382    /**
148383     * Test to see if this SDO_Model_Type is a primitive data type
148384     *
148385     * Test to see if this SDO_Model_Type is a primitive data type. Returns
148386     * TRUE if this type is a primitive data type, otherwise returns FALSE.
148387     *
148388     * @return bool Returns TRUE if this type is a primitive data type,
148389     *   otherwise returns FALSE.
148390     * @since ^
148391     **/
148392    function isDataType(){}
148393
148394    /**
148395     * Test for an SDO_DataObject being an instance of this SDO_Model_Type
148396     *
148397     * Test for an SDO_DataObject being an instance of this SDO_Model_Type.
148398     * Returns TRUE if the SDO_DataObject provided is an instance of this
148399     * SDO_Model_Type, or a derived type, otherwise returns FALSE.
148400     *
148401     * @param SDO_DataObject $data_object The SDO_DataObject to be tested.
148402     * @return bool Returns TRUE if the SDO_DataObject provided is an
148403     *   instance of this SDO_Model_Type, or a derived type, otherwise
148404     *   returns FALSE.
148405     * @since ^
148406     **/
148407    function isInstance($data_object){}
148408
148409    /**
148410     * Test to see if this type is an open type
148411     *
148412     * Test to see if this type is open. Returns TRUE if this type is open,
148413     * otherwise returns FALSE. An SDO_DataObject whose type is open can have
148414     * properties added to them which are not described by the type. This
148415     * capability is used to support working with XML documents whose schema
148416     * support open content, such as that defined by an <xsd:any> element.
148417     *
148418     * @return bool Returns TRUE if this type is open, otherwise returns
148419     *   FALSE.
148420     * @since ^
148421     **/
148422    function isOpenType(){}
148423
148424    /**
148425     * Test to see if this is a sequenced type
148426     *
148427     * Test to see if this is a sequenced type. Returns TRUE if this type is
148428     * sequence, otherwise returns FALSE. Sequenced types can have the
148429     * ordering across properties preserved and can contain unstructured
148430     * text. For more information on sequenced types see the section on
148431     * Working with Sequenced Data Objects.
148432     *
148433     * @return bool Returns TRUE if this type is sequence, otherwise return
148434     *   FALSE.
148435     * @since ^
148436     **/
148437    function isSequencedType(){}
148438
148439}
148440class SDO_Sequence {
148441    /**
148442     * Return the property for the specified sequence index
148443     *
148444     * Return the property for the specified sequence index.
148445     *
148446     * @param int $sequence_index The position of the element in the
148447     *   sequence.
148448     * @return SDO_Model_Property An SDO_Model_Property. A return value of
148449     *   NULL means the sequence element does not belong to a property and
148450     *   must therefore be unstructured text.
148451     * @since ^
148452     **/
148453    function getProperty($sequence_index){}
148454
148455    /**
148456     * Insert into a sequence
148457     *
148458     * Insert a new element at a specified position in the sequence. All
148459     * subsequent sequence items are moved up.
148460     *
148461     * @param mixed $value The new value to be inserted. This can be either
148462     *   a primitive or an SDO_DataObject.
148463     * @param int $sequenceIndex The position at which to insert the new
148464     *   element. Default is NULL, which results in the new value being
148465     *   appended to the sequence.
148466     * @param mixed $propertyIdentifier Either a property index, a property
148467     *   name, or an SDO_Model_Property, used to identify a property in the
148468     *   sequence's corresponding SDO_DataObject. A value of NULL signifies
148469     *   unstructured text.
148470     * @return void None.
148471     * @since ^
148472     **/
148473    function insert($value, $sequenceIndex, $propertyIdentifier){}
148474
148475    /**
148476     * Move an item to another sequence position
148477     *
148478     * Modify the position of the item in the sequence, without altering the
148479     * value of the property in the SDO_DataObject.
148480     *
148481     * @param int $toIndex The destination sequence index. If this index is
148482     *   less than zero or greater than the size of the sequence then the
148483     *   value is appended.
148484     * @param int $fromIndex The source sequence index.
148485     * @return void None.
148486     * @since ^
148487     **/
148488    function move($toIndex, $fromIndex){}
148489
148490}
148491class SeasLog {
148492    /**
148493     * Record alert log information
148494     *
148495     * Record alert log information. "ALERT" - Action must be taken
148496     * immediately. Immediate attention should be given to relevant personnel
148497     * for emergency repairs.
148498     *
148499     * @param string $message The log message.
148500     * @param array $content The `message` contain placeholders which
148501     *   implementors replace with values from content array. Sush as
148502     *   `message` is `log info from {NAME}` and `content` is `array('NAME'
148503     *   => neeke)`, the log information will `log info from neeke`.
148504     * @param string $logger The `logger` cased by the third param would be
148505     *   used right this right now, like a temp logger, when the function
148506     *   SeasLog::setLogger() called in pre content. If `logger` NULL or "",
148507     *   SeasLog will use lastest logger setted by SeasLog::setLogger.
148508     * @return bool Return TRUE on record log information success, FALSE on
148509     *   failure.
148510     * @since PECL seaslog >=1.0.0
148511     **/
148512    public static function alert($message, $content, $logger){}
148513
148514    /**
148515     * Get log count by level, log_path and key_word
148516     *
148517     * `SeasLog` get count value of `grep -ai '{level}' | grep -aic
148518     * '{key_word}'` use system pipe and return to PHP (array or int).
148519     *
148520     * @param string $level String. The log information level.
148521     * @param string $log_path String. The log information path.
148522     * @param string $key_word String. The search key word for log
148523     *   information.
148524     * @return mixed If `level` is SEASLOG_ALL or Empty, return all levels
148525     *   count as `array`. If `level` is SEASLOG_INFO or the other level,
148526     *   return count as `int`.
148527     * @since PECL seaslog >=1.1.6
148528     **/
148529    public static function analyzerCount($level, $log_path, $key_word){}
148530
148531    /**
148532     * Get log detail by level, log_path, key_word, start, limit, order
148533     *
148534     * `SeasLog` get results of `grep -ai '{level}' | grep -ai '{key_word}' |
148535     * sed -n '{start},{limit}'p` use system pipe and return array to PHP.
148536     *
148537     * @param string $level String. The log information level.
148538     * @param string $log_path String. The log information path.
148539     * @param string $key_word String. The search key word for log
148540     *   information.
148541     * @param int $start Int. Default is `1`.
148542     * @param int $limit Int. Default is `20`.
148543     * @param int $order Int. Default is SEASLOG_DETAIL_ORDER_ASC. See
148544     *   also: SEASLOG_DETAIL_ORDER_ASC SEASLOG_DETAIL_ORDER_DESC
148545     * @return mixed Return results as array. When `start`,`limit` is not
148546     *   NULL and in Windows, SeasLog will threw exception with message
148547     *   'Param start and limit don't support Windows'.
148548     * @since PECL seaslog >=1.1.6
148549     **/
148550    public static function analyzerDetail($level, $log_path, $key_word, $start, $limit, $order){}
148551
148552    /**
148553     * Manually release stream flow from logger
148554     *
148555     * Manually release stream flow from logger. SeasLog caches the stream
148556     * handle opened by the log logger to save the overhead of creating a
148557     * stream. The handle will be automatically released at the end of the
148558     * request. If in CLI mode, the process will also automatically release
148559     * when it exits. Or you can use the following functions to manually
148560     * release(manually release function needs to update SeasLog 1.8.6 or
148561     * updated version).
148562     *
148563     * @param int $model Constant int. SEASLOG_CLOSE_LOGGER_STREAM_MOD_ALL
148564     *   SEASLOG_CLOSE_LOGGER_STREAM_MOD_ASSIGN
148565     * @param string $logger The logger name.
148566     * @return bool Return TRUE on released stream flow success, FALSE on
148567     *   failure.
148568     * @since PECL seaslog >=1.8.6
148569     **/
148570    public static function closeLoggerStream($model, $logger){}
148571
148572    /**
148573     * Record critical log information
148574     *
148575     * Record critical log information. "CRITICAL" - Critical conditions.Need
148576     * to be repaired immediately, and the program component is unavailable.
148577     *
148578     * @param string $message The log message.
148579     * @param array $content The `message` contain placeholders which
148580     *   implementors replace with values from content array. Sush as
148581     *   `message` is `log info from {NAME}` and `content` is `array('NAME'
148582     *   => neeke)`, the log information will `log info from neeke`.
148583     * @param string $logger The `logger` cased by the third param would be
148584     *   used right this right now, like a temp logger, when the function
148585     *   SeasLog::setLogger() called in pre content. If `logger` NULL or "",
148586     *   SeasLog will use lastest logger setted by SeasLog::setLogger.
148587     * @return bool Return TRUE on record log information success, FALSE on
148588     *   failure.
148589     * @since PECL seaslog >=1.0.0
148590     **/
148591    public static function critical($message, $content, $logger){}
148592
148593    /**
148594     * Record debug log information
148595     *
148596     * Record debug log information. "DEBUG" - Detailed debug
148597     * information.Fine-grained information events.
148598     *
148599     * @param string $message The log message.
148600     * @param array $content The `message` contain placeholders which
148601     *   implementors replace with values from content array. Sush as
148602     *   `message` is `log info from {NAME}` and `content` is `array('NAME'
148603     *   => neeke)`, the log information will `log info from neeke`.
148604     * @param string $logger The `logger` cased by the third param would be
148605     *   used right this right now, like a temp logger, when the function
148606     *   SeasLog::setLogger() called in pre content. If `logger` NULL or "",
148607     *   SeasLog will use lastest logger setted by SeasLog::setLogger.
148608     * @return bool Return TRUE on record log information success, FALSE on
148609     *   failure.
148610     * @since PECL seaslog >=1.0.0
148611     **/
148612    public static function debug($message, $content, $logger){}
148613
148614    /**
148615     * Record emergency log information
148616     *
148617     * Record emergency log information. "EMERGENCY" - System is unusable.
148618     *
148619     * @param string $message The log message.
148620     * @param array $content The `message` contain placeholders which
148621     *   implementors replace with values from content array. Sush as
148622     *   `message` is `log info from {NAME}` and `content` is `array('NAME'
148623     *   => neeke)`, the log information will `log info from neeke`.
148624     * @param string $logger The `logger` cased by the third param would be
148625     *   used right this right now, like a temp logger, when the function
148626     *   SeasLog::setLogger() called in pre content. If `logger` NULL or "",
148627     *   SeasLog will use lastest logger setted by SeasLog::setLogger.
148628     * @return bool Return TRUE on record log information success, FALSE on
148629     *   failure.
148630     * @since PECL seaslog >=1.0.0
148631     **/
148632    public static function emergency($message, $content, $logger){}
148633
148634    /**
148635     * Record error log information
148636     *
148637     * Record error log information. "ERROR" - Runtime errors that do not
148638     * require immediate action but should typically.
148639     *
148640     * @param string $message The log message.
148641     * @param array $content The `message` contain placeholders which
148642     *   implementors replace with values from content array. Sush as
148643     *   `message` is `log info from {NAME}` and `content` is `array('NAME'
148644     *   => neeke)`, the log information will `log info from neeke`.
148645     * @param string $logger The `logger` cased by the third param would be
148646     *   used right this right now, like a temp logger, when the function
148647     *   SeasLog::setLogger() called in pre content. If `logger` NULL or "",
148648     *   SeasLog will use lastest logger setted by SeasLog::setLogger.
148649     * @return bool Return TRUE on record log information success, FALSE on
148650     *   failure.
148651     * @since PECL seaslog >=1.0.0
148652     **/
148653    public static function error($message, $content, $logger){}
148654
148655    /**
148656     * Flush logs buffer, dump to appender file, or send to remote api with
148657     * tcp/udp
148658     *
148659     * Flush logs buffer by seaslog.appender: dump to file, or send to remote
148660     * api with tcp/udp. See also: seaslog.appender_retry seaslog.remote_host
148661     * seaslog.remote_port
148662     *
148663     * @return bool Return TRUE on flush buffer success, FALSE on failure.
148664     * @since PECL seaslog >=1.0.0
148665     **/
148666    public static function flushBuffer(){}
148667
148668    /**
148669     * Get SeasLog base path.
148670     *
148671     * Use the Function SeasLog::getBasePath will get the value of
148672     * seaslog.default_basepath what configured in php.ini(seaslog.ini).
148673     *
148674     * If you use Seaslog::setBasePath, will change the result.
148675     *
148676     * @return string Return seaslog.default_basepath as string.
148677     * @since PECL seaslog >=1.0.0
148678     **/
148679    public static function getBasePath(){}
148680
148681    /**
148682     * Get the logs buffer in memory as array
148683     *
148684     * @return array Return an array from logs buffer in memory.
148685     * @since PECL seaslog >=1.0.0
148686     **/
148687    public static function getBuffer(){}
148688
148689    /**
148690     * Determin if buffer enabled
148691     *
148692     * Result join seaslog.use_buffer and seaslog.buffer_disabled_in_cli.
148693     *
148694     * @return bool Return TRUE on seaslog.use_buffer is true. If switch
148695     *   seaslog.buffer_disabled_in_cli on, and running in cli,
148696     *   seaslog.use_buffer setting will be discarded, Seaslog write to the
148697     *   Data Store IMMEDIATELY.
148698     * @since PECL seaslog >=1.0.0
148699     **/
148700    public static function getBufferEnabled(){}
148701
148702    /**
148703     * Get SeasLog datetime format style
148704     *
148705     * Get SeasLog datetime format style. Use the Function
148706     * SeasLog::getDatetimeFormat will get the value of
148707     * seaslog.default_datetime_format what configured in
148708     * php.ini(seaslog.ini).
148709     *
148710     * @return string Get SeasLog datetime format style of
148711     *   seaslog.default_datetime_format. Use the Function
148712     *   SeasLog::setDatetimeFormat will change this value.
148713     * @since PECL seaslog >=1.0.0
148714     **/
148715    public static function getDatetimeFormat(){}
148716
148717    /**
148718     * Get SeasLog last logger path
148719     *
148720     * Use the Function SeasLog::getLastLogger will get the value of
148721     * seaslog.default_logger what configured in php.ini(seaslog.ini).
148722     *
148723     * @return string Use the Function SeasLog::setLogger will change the
148724     *   value of function SeasLog::getLastLogger.
148725     * @since PECL seaslog >=1.0.0
148726     **/
148727    public static function getLastLogger(){}
148728
148729    /**
148730     * Get SeasLog request_id differentiated requests
148731     *
148732     * To distinguish a single request, such as not invoking the
148733     * SeasLog::setRequestId function, the unique value generated by the
148734     * built-in `static char *get_uniqid ()` function is used when the
148735     * request is initialized.
148736     *
148737     * @return string Return string generated by the built-in `static char
148738     *   *get_uniqid ()` function, or setted by SeasLog::setRequestId
148739     *   function.
148740     * @since PECL seaslog >=1.0.0
148741     **/
148742    public static function getRequestID(){}
148743
148744    /**
148745     * Get SeasLog request variable
148746     *
148747     * @param int $key Constant int. SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT
148748     *   SEASLOG_REQUEST_VARIABLE_REQUEST_URI
148749     *   SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD
148750     *   SEASLOG_REQUEST_VARIABLE_CLIENT_IP
148751     * @return bool Return request variable value on set success.
148752     * @since PECL seaslog >=1.9.0
148753     **/
148754    public static function getRequestVariable($key){}
148755
148756    /**
148757     * Record info log information
148758     *
148759     * Record info log information. "INFO" - Interesting events.Emphasizes
148760     * the running process of the application.
148761     *
148762     * @param string $message The log message.
148763     * @param array $content The `message` contain placeholders which
148764     *   implementors replace with values from content array. Sush as
148765     *   `message` is `log info from {NAME}` and `content` is `array('NAME'
148766     *   => neeke)`, the log information will `log info from neeke`.
148767     * @param string $logger The `logger` cased by the third param would be
148768     *   used right this right now, like a temp logger, when the function
148769     *   SeasLog::setLogger() called in pre content. If `logger` NULL or "",
148770     *   SeasLog will use lastest logger setted by SeasLog::setLogger.
148771     * @return bool Return TRUE on record log information success, FALSE on
148772     *   failure.
148773     * @since PECL seaslog >=1.0.0
148774     **/
148775    public static function info($message, $content, $logger){}
148776
148777    /**
148778     * The Common Record Log Function
148779     *
148780     * @param string $level Can use level in: SEASLOG_DEBUG SEASLOG_INFO
148781     *   SEASLOG_NOTICE SEASLOG_WARNING SEASLOG_ERROR SEASLOG_CRITICAL
148782     *   SEASLOG_ALERT SEASLOG_EMERGENCY Or you can create a new level
148783     *   self-help.
148784     * @param string $message The log message.
148785     * @param array $content The `message` contain placeholders which
148786     *   implementors replace with values from content array. Sush as
148787     *   `message` is `log info from {NAME}` and `content` is `array('NAME'
148788     *   => neeke)`, the log information will `log info from neeke`.
148789     * @param string $logger The `logger` cased by the third param would be
148790     *   used right this right now, like a temp logger, when the function
148791     *   SeasLog::setLogger() called in pre content. If `logger` NULL or "",
148792     *   SeasLog will use lastest logger setted by SeasLog::setLogger.
148793     * @return bool Return TRUE on record log information success, FALSE on
148794     *   failure.
148795     * @since PECL seaslog >=1.0.0
148796     **/
148797    public static function log($level, $message, $content, $logger){}
148798
148799    /**
148800     * Record notice log information
148801     *
148802     * Record notice log information. "NOTICE" - Normal but significant
148803     * events.Information that is more important than the INFO level during
148804     * execution.
148805     *
148806     * @param string $message The log message.
148807     * @param array $content The `message` contain placeholders which
148808     *   implementors replace with values from content array. Sush as
148809     *   `message` is `log info from {NAME}` and `content` is `array('NAME'
148810     *   => neeke)`, the log information will `log info from neeke`.
148811     * @param string $logger The `logger` cased by the third param would be
148812     *   used right this right now, like a temp logger, when the function
148813     *   SeasLog::setLogger() called in pre content. If `logger` NULL or "",
148814     *   SeasLog will use lastest logger setted by SeasLog::setLogger.
148815     * @return bool Return TRUE on record log information success, FALSE on
148816     *   failure.
148817     * @since PECL seaslog >=1.0.0
148818     **/
148819    public static function notice($message, $content, $logger){}
148820
148821    /**
148822     * Set SeasLog base path
148823     *
148824     * @param string $base_path String.
148825     * @return bool Return TRUE on setted base path success, FALSE on
148826     *   failure.
148827     * @since PECL seaslog >=1.0.0
148828     **/
148829    public static function setBasePath($base_path){}
148830
148831    /**
148832     * Set SeasLog datetime format style
148833     *
148834     * @param string $format String. Such as `Y-m-d H:i:s` or `Ymd His`.
148835     *   See also first param `format` at {@link date}.
148836     * @return bool Return TRUE on setted datetime format success, FALSE on
148837     *   failure.
148838     * @since PECL seaslog >=1.0.0
148839     **/
148840    public static function setDatetimeFormat($format){}
148841
148842    /**
148843     * Set SeasLog logger name
148844     *
148845     * Use the Function SeasLog::setLogger will change the value of function
148846     * SeasLog::getLastLogger. Than's mean, SeasLog will record loginfo into
148847     * the logger directory.
148848     *
148849     * @param string $logger Logger name.
148850     * @return bool Return TRUE on created logger disectory success, FALSE
148851     *   on failure.
148852     * @since PECL seaslog >=1.0.0
148853     **/
148854    public static function setLogger($logger){}
148855
148856    /**
148857     * Set SeasLog request_id differentiated requests
148858     *
148859     * To distinguish a single request, such as not invoking the
148860     * SeasLog::setRequestId function, the unique value generated by the
148861     * built-in `static char *get_uniqid ()` function is used when the
148862     * request is initialized.
148863     *
148864     * @param string $request_id String.
148865     * @return bool Return TRUE on set request_id success, FALSE on
148866     *   failure.
148867     * @since PECL seaslog >=1.0.0
148868     **/
148869    public static function setRequestID($request_id){}
148870
148871    /**
148872     * Manually set SeasLog request variable
148873     *
148874     * @param int $key Constant int. SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT
148875     *   SEASLOG_REQUEST_VARIABLE_REQUEST_URI
148876     *   SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD
148877     *   SEASLOG_REQUEST_VARIABLE_CLIENT_IP
148878     * @param string $value The request variable value.
148879     * @return bool Return TRUE on set success, FALSE on failure.
148880     * @since PECL seaslog >=1.9.0
148881     **/
148882    public static function setRequestVariable($key, $value){}
148883
148884    /**
148885     * Record warning log information
148886     *
148887     * Record warning log information. "WARNING" - Exceptional occurrences
148888     * that are not errors. Potentially aberrant information that needs
148889     * attention and needs to be repaired.
148890     *
148891     * @param string $message The log message.
148892     * @param array $content The `message` contain placeholders which
148893     *   implementors replace with values from content array. Sush as
148894     *   `message` is `log info from {NAME}` and `content` is `array('NAME'
148895     *   => neeke)`, the log information will `log info from neeke`.
148896     * @param string $logger The `logger` cased by the third param would be
148897     *   used right this right now, like a temp logger, when the function
148898     *   SeasLog::setLogger() called in pre content. If `logger` NULL or "",
148899     *   SeasLog will use lastest logger setted by SeasLog::setLogger.
148900     * @return bool Return TRUE on record log information success, FALSE on
148901     *   failure.
148902     * @since PECL seaslog >=1.0.0
148903     **/
148904    public static function warning($message, $content, $logger){}
148905
148906    /**
148907     * @since PECL seaslog >=1.0.0
148908     **/
148909    public function __destruct(){}
148910
148911}
148912/**
148913 * The Seekable iterator.
148914 **/
148915interface SeekableIterator extends Iterator {
148916    /**
148917     * Seeks to a position
148918     *
148919     * Seeks to a given position in the iterator.
148920     *
148921     * @param int $position The position to seek to.
148922     * @return void
148923     * @since PHP 5 >= 5.1.0, PHP 7
148924     **/
148925    public function seek($position);
148926
148927}
148928/**
148929 * Interface for customized serializing. Classes that implement this
148930 * interface no longer support __sleep() and __wakeup(). The method
148931 * serialize is called whenever an instance needs to be serialized. This
148932 * does not invoke __destruct() or have any other side effect unless
148933 * programmed inside the method. When the data is unserialized the class
148934 * is known and the appropriate unserialize() method is called as a
148935 * constructor instead of calling __construct(). If you need to execute
148936 * the standard constructor you may do so in the method.
148937 **/
148938interface Serializable {
148939    /**
148940     * String representation of object
148941     *
148942     * Should return the string representation of the object.
148943     *
148944     * @return string Returns the string representation of the object or
148945     *   NULL
148946     * @since PHP 5 >= 5.1.0, PHP 7
148947     **/
148948    public function serialize();
148949
148950    /**
148951     * Constructs the object
148952     *
148953     * Called during unserialization of the object.
148954     *
148955     * @param string $serialized The string representation of the object.
148956     * @return void The return value from this method is ignored.
148957     * @since PHP 5 >= 5.1.0, PHP 7
148958     **/
148959    public function unserialize($serialized);
148960
148961}
148962/**
148963 * SessionHandler is a special class that can be used to expose the
148964 * current internal PHP session save handler by inheritance. There are
148965 * seven methods which wrap the seven internal session save handler
148966 * callbacks ({@link open}, {@link close}, {@link read}, {@link write},
148967 * {@link destroy}, {@link gc} and {@link create_sid}). By default, this
148968 * class will wrap whatever internal save handler is set as defined by
148969 * the session.save_handler configuration directive which is usually
148970 * {@link files} by default. Other internal session save handlers are
148971 * provided by PHP extensions such as SQLite (as {@link sqlite}),
148972 * Memcache (as {@link memcache}), and Memcached (as {@link memcached}).
148973 * When a plain instance of SessionHandler is set as the save handler
148974 * using {@link session_set_save_handler} it will wrap the current save
148975 * handlers. A class extending from SessionHandler allows you to override
148976 * the methods or intercept or filter them by calls the parent class
148977 * methods which ultimately wrap the internal PHP session handlers. This
148978 * allows you, for example, to intercept the {@link read} and {@link
148979 * write} methods to encrypt/decrypt the session data and then pass the
148980 * result to and from the parent class. Alternatively one might chose to
148981 * entirely override a method like the garbage collection callback {@link
148982 * gc}. Because the SessionHandler wraps the current internal save
148983 * handler methods, the above example of encryption can be applied to any
148984 * internal save handler without having to know the internals of the
148985 * handlers. To use this class, first set the save handler you wish to
148986 * expose using session.save_handler and then pass an instance of
148987 * SessionHandler or one extending it to {@link
148988 * session_set_save_handler}. Please note the callback methods of this
148989 * class are designed to be called internally by PHP and are not meant to
148990 * be called from user-space code. The return values are equally
148991 * processed internally by PHP. For more information on the session
148992 * workflow, please refer {@link session_set_save_handler}. 5.5.1 Added
148993 * {@link SessionHandler::create_sid}.
148994 **/
148995class SessionHandler implements SessionHandlerInterface, SessionIdInterface {
148996    /**
148997     * Close the session
148998     *
148999     * Closes the current session. This method is automatically executed
149000     * internally by PHP when closing the session, or explicitly via {@link
149001     * session_write_close} (which first calls the {@link
149002     * SessionHandler::write}).
149003     *
149004     * This method wraps the internal PHP save handler defined in the
149005     * session.save_handler ini setting that was set before this handler was
149006     * activated by {@link session_set_save_handler}.
149007     *
149008     * If this class is extended by inheritiance, calling the parent {@link
149009     * close} method will invoke the wrapper for this method and therefore
149010     * invoke the associated internal callback. This allows the method to be
149011     * overridden and or intercepted.
149012     *
149013     * For more information on what this method is expected to do, please
149014     * refer to the documentation at {@link SessionHandlerInterface::close}.
149015     *
149016     * @return bool
149017     * @since PHP 5 >= 5.4.0, PHP 7
149018     **/
149019    public function close(){}
149020
149021    /**
149022     * Return a new session ID
149023     *
149024     * Generates and returns a new session ID.
149025     *
149026     * @return string A session ID valid for the default session handler.
149027     * @since PHP 5 >= 5.5.1, PHP 7
149028     **/
149029    public function create_sid(){}
149030
149031    /**
149032     * Destroy a session
149033     *
149034     * Destroys a session. Called internally by PHP with {@link
149035     * session_regenerate_id} (assuming the {@link $destroy} is set to TRUE,
149036     * by {@link session_destroy} or when {@link session_decode} fails.
149037     *
149038     * This method wraps the internal PHP save handler defined in the
149039     * session.save_handler ini setting that was set before this handler was
149040     * set by {@link session_set_save_handler}.
149041     *
149042     * If this class is extended by inheritiance, calling the parent {@link
149043     * destroy} method will invoke the wrapper for this method and therefore
149044     * invoke the associated internal callback. This allows this method to be
149045     * overridden and or intercepted and filtered.
149046     *
149047     * For more information on what this method is expected to do, please
149048     * refer to the documentation at {@link
149049     * SessionHandlerInterface::destroy}.
149050     *
149051     * @param string $session_id The session ID being destroyed.
149052     * @return bool
149053     * @since PHP 5 >= 5.4.0, PHP 7
149054     **/
149055    public function destroy($session_id){}
149056
149057    /**
149058     * Cleanup old sessions
149059     *
149060     * Cleans up expired sessions. Called randomly by PHP internally when a
149061     * session starts or when {@link session_start} is invoked. The frequency
149062     * this is called is based on the session.gc_divisor and
149063     * session.gc_probability configuration directives.
149064     *
149065     * This method wraps the internal PHP save handler defined in the
149066     * session.save_handler ini setting that was set before this handler was
149067     * set by {@link session_set_save_handler}.
149068     *
149069     * If this class is extended by inheritiance, calling the parent {@link
149070     * gc} method will invoke the wrapper for this method and therefore
149071     * invoke the associated internal callback. This allows this method to be
149072     * overridden and or intercepted and filtered.
149073     *
149074     * For more information on what this method is expected to do, please
149075     * refer to the documentation at {@link SessionHandlerInterface::gc}.
149076     *
149077     * @param int $maxlifetime Sessions that have not updated for the last
149078     *   {@link maxlifetime} seconds will be removed.
149079     * @return int
149080     * @since PHP 5 >= 5.4.0, PHP 7
149081     **/
149082    public function gc($maxlifetime){}
149083
149084    /**
149085     * Initialize session
149086     *
149087     * Create new session, or re-initialize existing session. Called
149088     * internally by PHP when a session starts either automatically or when
149089     * {@link session_start} is invoked.
149090     *
149091     * This method wraps the internal PHP save handler defined in the
149092     * session.save_handler ini setting that was set before this handler was
149093     * set by {@link session_set_save_handler}.
149094     *
149095     * If this class is extended by inheritiance, calling the parent {@link
149096     * open} method will invoke the wrapper for this method and therefore
149097     * invoke the associated internal callback. This allows this method to be
149098     * overridden and or intercepted and filtered.
149099     *
149100     * For more information on what this method is expected to do, please
149101     * refer to the documentation at {@link SessionHandlerInterface::open}.
149102     *
149103     * @param string $save_path The path where to store/retrieve the
149104     *   session.
149105     * @param string $session_name The session name.
149106     * @return bool
149107     * @since PHP 5 >= 5.4.0, PHP 7
149108     **/
149109    public function open($save_path, $session_name){}
149110
149111    /**
149112     * Read session data
149113     *
149114     * Reads the session data from the session storage, and returns the
149115     * result back to PHP for internal processing. This method is called
149116     * automatically by PHP when a session is started (either automatically
149117     * or explicitly with {@link session_start} and is preceded by an
149118     * internal call to the {@link SessionHandler::open}.
149119     *
149120     * This method wraps the internal PHP save handler defined in the
149121     * session.save_handler ini setting that was set before this handler was
149122     * set by {@link session_set_save_handler}.
149123     *
149124     * If this class is extended by inheritance, calling the parent {@link
149125     * read} method will invoke the wrapper for this method and therefore
149126     * invoke the associated internal callback. This allows the method to be
149127     * overridden and or intercepted and filtered (for example, decrypting
149128     * {@link $data} value returned by the parent {@link read} method).
149129     *
149130     * For more information on what this method is expected to do, please
149131     * refer to the documentation at {@link SessionHandlerInterface::read}.
149132     *
149133     * @param string $session_id The session id to read data for.
149134     * @return string Returns an encoded string of the read data. If
149135     *   nothing was read, it must return an empty string. Note this value is
149136     *   returned internally to PHP for processing.
149137     * @since PHP 5 >= 5.4.0, PHP 7
149138     **/
149139    public function read($session_id){}
149140
149141    /**
149142     * Write session data
149143     *
149144     * Writes the session data to the session storage. Called by normal PHP
149145     * shutdown, by {@link session_write_close}, or when {@link
149146     * session_register_shutdown} fails. PHP will call {@link
149147     * SessionHandler::close} immediately after this method returns.
149148     *
149149     * This method wraps the internal PHP save handler defined in the
149150     * session.save_handler ini setting that was set before this handler was
149151     * set by {@link session_set_save_handler}.
149152     *
149153     * If this class is extended by inheritiance, calling the parent {@link
149154     * write} method will invoke the wrapper for this method and therefore
149155     * invoke the associated internal callback. This allows this method to be
149156     * overridden and or intercepted and filtered (for example, encrypting
149157     * the {@link $data} value before sending it to the parent {@link write}
149158     * method).
149159     *
149160     * For more information on what this method is expected to do, please
149161     * refer to the documentation at {@link SessionHandlerInterface::write}.
149162     *
149163     * @param string $session_id The session id.
149164     * @param string $session_data The encoded session data. This data is
149165     *   the result of the PHP internally encoding the $_SESSION superglobal
149166     *   to a serialized string and passing it as this parameter. Please note
149167     *   sessions use an alternative serialization method.
149168     * @return bool
149169     * @since PHP 5 >= 5.4.0, PHP 7
149170     **/
149171    public function write($session_id, $session_data){}
149172
149173}
149174/**
149175 * SessionHandlerInterface is an interface which defines the minimal
149176 * prototype for creating a custom session handler. In order to pass a
149177 * custom session handler to {@link session_set_save_handler} using its
149178 * OOP invocation, the class can implement this interface. Please note
149179 * the callback methods of this class are designed to be called
149180 * internally by PHP and are not meant to be called from user-space code.
149181 **/
149182interface SessionHandlerInterface {
149183    /**
149184     * Close the session
149185     *
149186     * Closes the current session. This function is automatically executed
149187     * when closing the session, or explicitly via {@link
149188     * session_write_close}.
149189     *
149190     * @return bool
149191     * @since PHP 5 >= 5.4.0, PHP 7
149192     **/
149193    public function close();
149194
149195    /**
149196     * Destroy a session
149197     *
149198     * Destroys a session. Called by {@link session_regenerate_id} (with
149199     * $destroy = TRUE), {@link session_destroy} and when {@link
149200     * session_decode} fails.
149201     *
149202     * @param string $session_id The session ID being destroyed.
149203     * @return bool
149204     * @since PHP 5 >= 5.4.0, PHP 7
149205     **/
149206    public function destroy($session_id);
149207
149208    /**
149209     * Cleanup old sessions
149210     *
149211     * Cleans up expired sessions. Called by {@link session_start}, based on
149212     * session.gc_divisor, session.gc_probability and session.gc_maxlifetime
149213     * settings.
149214     *
149215     * @param int $maxlifetime Sessions that have not updated for the last
149216     *   {@link maxlifetime} seconds will be removed.
149217     * @return int
149218     * @since PHP 5 >= 5.4.0, PHP 7
149219     **/
149220    public function gc($maxlifetime);
149221
149222    /**
149223     * Initialize session
149224     *
149225     * Re-initialize existing session, or creates a new one. Called when a
149226     * session starts or when {@link session_start} is invoked.
149227     *
149228     * @param string $save_path The path where to store/retrieve the
149229     *   session.
149230     * @param string $session_name The session name.
149231     * @return bool
149232     * @since PHP 5 >= 5.4.0, PHP 7
149233     **/
149234    public function open($save_path, $session_name);
149235
149236    /**
149237     * Read session data
149238     *
149239     * Reads the session data from the session storage, and returns the
149240     * results. Called right after the session starts or when {@link
149241     * session_start} is called. Please note that before this method is
149242     * called {@link SessionHandlerInterface::open} is invoked.
149243     *
149244     * This method is called by PHP itself when the session is started. This
149245     * method should retrieve the session data from storage by the session ID
149246     * provided. The string returned by this method must be in the same
149247     * serialized format as when originally passed to the {@link
149248     * SessionHandlerInterface::write} If the record was not found, return an
149249     * empty string.
149250     *
149251     * The data returned by this method will be decoded internally by PHP
149252     * using the unserialization method specified in
149253     * session.serialize_handler. The resulting data will be used to populate
149254     * the $_SESSION superglobal.
149255     *
149256     * Note that the serialization scheme is not the same as {@link
149257     * unserialize} and can be accessed by {@link session_decode}.
149258     *
149259     * @param string $session_id The session id.
149260     * @return string Returns an encoded string of the read data. If
149261     *   nothing was read, it must return an empty string. Note this value is
149262     *   returned internally to PHP for processing.
149263     * @since PHP 5 >= 5.4.0, PHP 7
149264     **/
149265    public function read($session_id);
149266
149267    /**
149268     * Write session data
149269     *
149270     * Writes the session data to the session storage. Called by {@link
149271     * session_write_close}, when {@link session_register_shutdown} fails, or
149272     * during a normal shutdown. Note: {@link SessionHandlerInterface::close}
149273     * is called immediately after this function.
149274     *
149275     * PHP will call this method when the session is ready to be saved and
149276     * closed. It encodes the session data from the $_SESSION superglobal to
149277     * a serialized string and passes this along with the session ID to this
149278     * method for storage. The serialization method used is specified in the
149279     * session.serialize_handler setting.
149280     *
149281     * Note this method is normally called by PHP after the output buffers
149282     * have been closed unless explicitly called by {@link
149283     * session_write_close}
149284     *
149285     * @param string $session_id The session id.
149286     * @param string $session_data The encoded session data. This data is
149287     *   the result of the PHP internally encoding the $_SESSION superglobal
149288     *   to a serialized string and passing it as this parameter. Please note
149289     *   sessions use an alternative serialization method.
149290     * @return bool
149291     * @since PHP 5 >= 5.4.0, PHP 7
149292     **/
149293    public function write($session_id, $session_data);
149294
149295}
149296/**
149297 * SessionIdInterface is an interface which defines optional methods for
149298 * creating a custom session handler. In order to pass a custom session
149299 * handler to {@link session_set_save_handler} using its OOP invocation,
149300 * the class can implement this interface. Note that the callback methods
149301 * of classes implementing this interface are designed to be called
149302 * internally by PHP and are not meant to be called from user-space code.
149303 **/
149304interface SessionIdInterface {
149305    /**
149306     * Create session ID
149307     *
149308     * Creates a new session ID.This function is automatically executed when
149309     * a new session ID needs to be created.
149310     *
149311     * @return string The new session ID. Note that this value is returned
149312     *   internally to PHP for processing.
149313     * @since PHP 5 >= 5.5.1, PHP 7
149314     **/
149315    public function create_sid();
149316
149317}
149318/**
149319 * SessionUpdateTimestampHandlerInterface is an interface which defines
149320 * optional methods for creating a custom session handler. In order to
149321 * pass a custom session handler to {@link session_set_save_handler}
149322 * using its OOP invocation, the class can implement this interface. Note
149323 * that the callback methods of classes implementing this interface are
149324 * designed to be called internally by PHP and are not meant to be called
149325 * from user-space code.
149326 **/
149327interface SessionUpdateTimestampHandlerInterface {
149328    /**
149329     * Update timestamp
149330     *
149331     * Updates the last modification timestamp of the session. This function
149332     * is automatically executed when a session is updated.
149333     *
149334     * @param string $key The session ID.
149335     * @param string $val The session data.
149336     * @return bool Returns TRUE if the timestamp was updated, FALSE
149337     *   otherwise. Note that this value is returned internally to PHP for
149338     *   processing.
149339     * @since PHP 7
149340     **/
149341    public function updateTimestamp($key, $val);
149342
149343    /**
149344     * Validate ID
149345     *
149346     * Validates a given session ID. A session ID is valid, if a session with
149347     * that ID already exists. This function is automatically executed when a
149348     * session is to be started, a session ID is supplied and
149349     * session.use_strict_mode is enabled.
149350     *
149351     * @param string $key The session ID.
149352     * @return bool Returns TRUE for valid ID, FALSE otherwise. Note that
149353     *   this value is returned internally to PHP for processing.
149354     * @since PHP 7
149355     **/
149356    public function validateId($key);
149357
149358}
149359/**
149360 * Represents an element in an XML document.
149361 **/
149362class SimpleXMLElement implements Traversable {
149363    /**
149364     * Adds an attribute to the SimpleXML element
149365     *
149366     * Adds an attribute to the SimpleXML element.
149367     *
149368     * @param string $name The name of the attribute to add.
149369     * @param string $value The value of the attribute.
149370     * @param string $namespace If specified, the namespace to which the
149371     *   attribute belongs.
149372     * @return void
149373     * @since PHP 5 >= 5.1.3, PHP 7
149374     **/
149375    public function addAttribute($name, $value, $namespace){}
149376
149377    /**
149378     * Adds a child element to the XML node
149379     *
149380     * Adds a child element to the node and returns a SimpleXMLElement of the
149381     * child.
149382     *
149383     * @param string $name The name of the child element to add.
149384     * @param string $value If specified, the value of the child element.
149385     * @param string $namespace If specified, the namespace to which the
149386     *   child element belongs.
149387     * @return SimpleXMLElement The addChild method returns a
149388     *   SimpleXMLElement object representing the child added to the XML
149389     *   node.
149390     * @since PHP 5 >= 5.1.3, PHP 7
149391     **/
149392    public function addChild($name, $value, $namespace){}
149393
149394    /**
149395     * Return a well-formed XML string based on SimpleXML element
149396     *
149397     * The asXML method formats the parent object's data in XML version 1.0.
149398     *
149399     * @param string $filename If specified, the function writes the data
149400     *   to the file rather than returning it.
149401     * @return mixed If the {@link filename} isn't specified, this function
149402     *   returns a string on success and FALSE on error. If the parameter is
149403     *   specified, it returns TRUE if the file was written successfully and
149404     *   FALSE otherwise.
149405     * @since PHP 5, PHP 7
149406     **/
149407    public function asXML($filename){}
149408
149409    /**
149410     * Identifies an element's attributes
149411     *
149412     * This function provides the attributes and values defined within an xml
149413     * tag.
149414     *
149415     * @param string $ns An optional namespace for the retrieved attributes
149416     * @param bool $is_prefix Default to FALSE
149417     * @return SimpleXMLElement Returns a SimpleXMLElement object that can
149418     *   be iterated over to loop through the attributes on the tag.
149419     * @since PHP 5, PHP 7
149420     **/
149421    public function attributes($ns, $is_prefix){}
149422
149423    /**
149424     * Finds children of given node
149425     *
149426     * This method finds the children of an element. The result follows
149427     * normal iteration rules.
149428     *
149429     * @param string $ns An XML namespace.
149430     * @param bool $is_prefix If {@link is_prefix} is TRUE, {@link ns} will
149431     *   be regarded as a prefix. If FALSE, {@link ns} will be regarded as a
149432     *   namespace URL.
149433     * @return SimpleXMLElement Returns a SimpleXMLElement element, whether
149434     *   the node has children or not.
149435     * @since PHP 5, PHP 7
149436     **/
149437    public function children($ns, $is_prefix){}
149438
149439    /**
149440     * Counts the children of an element
149441     *
149442     * This method counts the number of children of an element.
149443     *
149444     * @return int Returns the number of elements of an element.
149445     * @since PHP 5 >= 5.3.0, PHP 7
149446     **/
149447    public function count(){}
149448
149449    /**
149450     * Returns namespaces declared in document
149451     *
149452     * Returns namespaces declared in document
149453     *
149454     * @param bool $recursive If specified, returns all namespaces declared
149455     *   in parent and child nodes. Otherwise, returns only namespaces
149456     *   declared in root node.
149457     * @param bool $from_root Allows you to recursively check namespaces
149458     *   under a child node instead of from the root of the XML doc.
149459     * @return array The getDocNamespaces method returns an array of
149460     *   namespace names with their associated URIs.
149461     * @since PHP 5 >= 5.1.2, PHP 7
149462     **/
149463    public function getDocNamespaces($recursive, $from_root){}
149464
149465    /**
149466     * Gets the name of the XML element
149467     *
149468     * @return string The getName method returns as a string the name of
149469     *   the XML tag referenced by the SimpleXMLElement object.
149470     * @since PHP 5 >= 5.1.3, PHP 7
149471     **/
149472    public function getName(){}
149473
149474    /**
149475     * Returns namespaces used in document
149476     *
149477     * Returns namespaces used in document
149478     *
149479     * @param bool $recursive If specified, returns all namespaces used in
149480     *   parent and child nodes. Otherwise, returns only namespaces used in
149481     *   root node.
149482     * @return array The getNamespaces method returns an array of namespace
149483     *   names with their associated URIs.
149484     * @since PHP 5 >= 5.1.2, PHP 7
149485     **/
149486    public function getNamespaces($recursive){}
149487
149488    /**
149489     * Creates a prefix/ns context for the next XPath query
149490     *
149491     * Creates a prefix/ns context for the next XPath query. In particular,
149492     * this is helpful if the provider of the given XML document alters the
149493     * namespace prefixes. registerXPathNamespace will create a prefix for
149494     * the associated namespace, allowing one to access nodes in that
149495     * namespace without the need to change code to allow for the new
149496     * prefixes dictated by the provider.
149497     *
149498     * @param string $prefix The namespace prefix to use in the XPath query
149499     *   for the namespace given in {@link ns}.
149500     * @param string $ns The namespace to use for the XPath query. This
149501     *   must match a namespace in use by the XML document or the XPath query
149502     *   using {@link prefix} will not return any results.
149503     * @return bool
149504     * @since PHP 5 >= 5.1.0, PHP 7
149505     **/
149506    public function registerXPathNamespace($prefix, $ns){}
149507
149508    /**
149509     * Runs XPath query on XML data
149510     *
149511     * The xpath method searches the SimpleXML node for children matching the
149512     * XPath {@link path}.
149513     *
149514     * @param string $path An XPath path
149515     * @return array Returns an array of SimpleXMLElement objects or FALSE
149516     *   in case of an error.
149517     * @since PHP 5, PHP 7
149518     **/
149519    public function xpath($path){}
149520
149521    /**
149522     * Returns the string content
149523     *
149524     * Returns text content that is directly in this element. Does not return
149525     * text content that is inside this element's children.
149526     *
149527     * @return string Returns the string content on success or an empty
149528     *   string on failure.
149529     * @since PHP 5 >= 5.3.0, PHP 7
149530     **/
149531    public function __toString(){}
149532
149533}
149534/**
149535 * The SimpleXMLIterator provides recursive iteration over all nodes of a
149536 * SimpleXMLElement object.
149537 **/
149538class SimpleXMLIterator extends SimpleXMLElement implements RecursiveIterator, Countable {
149539    /**
149540     * Returns the current element
149541     *
149542     * This method returns the current element as a SimpleXMLIterator object
149543     * or NULL.
149544     *
149545     * @return mixed Returns the current element as a SimpleXMLIterator
149546     *   object or NULL on failure.
149547     * @since PHP 5, PHP 7
149548     **/
149549    public function current(){}
149550
149551    /**
149552     * Returns the sub-elements of the current element
149553     *
149554     * This method returns a SimpleXMLIterator object containing sub-elements
149555     * of the current SimpleXMLIterator element.
149556     *
149557     * @return SimpleXMLIterator Returns a SimpleXMLIterator object
149558     *   containing the sub-elements of the current element.
149559     * @since PHP 5, PHP 7
149560     **/
149561    public function getChildren(){}
149562
149563    /**
149564     * Checks whether the current element has sub elements
149565     *
149566     * This method checks whether the current SimpleXMLIterator element has
149567     * sub-elements.
149568     *
149569     * @return bool TRUE if the current element has sub-elements, otherwise
149570     *   FALSE
149571     * @since PHP 5, PHP 7
149572     **/
149573    public function hasChildren(){}
149574
149575    /**
149576     * Return current key
149577     *
149578     * This method gets the XML tag name of the current element.
149579     *
149580     * @return mixed Returns the XML tag name of the element referenced by
149581     *   the current SimpleXMLIterator object or FALSE
149582     * @since PHP 5, PHP 7
149583     **/
149584    public function key(){}
149585
149586    /**
149587     * Move to next element
149588     *
149589     * This method moves the SimpleXMLIterator to the next element.
149590     *
149591     * @return void
149592     * @since PHP 5, PHP 7
149593     **/
149594    public function next(){}
149595
149596    /**
149597     * Rewind to the first element
149598     *
149599     * This method rewinds the SimpleXMLIterator to the first element.
149600     *
149601     * @return void
149602     * @since PHP 5, PHP 7
149603     **/
149604    public function rewind(){}
149605
149606    /**
149607     * Check whether the current element is valid
149608     *
149609     * This method checks if the current element is valid after calls to
149610     * SimpleXMLIterator::rewind or SimpleXMLIterator::next.
149611     *
149612     * @return bool Returns TRUE if the current element is valid, otherwise
149613     *   FALSE
149614     * @since PHP 5, PHP 7
149615     **/
149616    public function valid(){}
149617
149618}
149619/**
149620 * Represents SNMP session.
149621 **/
149622class SNMP {
149623    /**
149624     * @var integer
149625     **/
149626    const ERRNO_ANY = 0;
149627
149628    /**
149629     * @var integer
149630     **/
149631    const ERRNO_ERROR_IN_REPLY = 0;
149632
149633    /**
149634     * @var integer
149635     **/
149636    const ERRNO_GENERIC = 0;
149637
149638    /**
149639     * @var integer
149640     **/
149641    const ERRNO_MULTIPLE_SET_QUERIES = 0;
149642
149643    /**
149644     * @var integer
149645     **/
149646    const ERRNO_NOERROR = 0;
149647
149648    /**
149649     * @var integer
149650     **/
149651    const ERRNO_OID_NOT_INCREASING = 0;
149652
149653    /**
149654     * @var integer
149655     **/
149656    const ERRNO_OID_PARSING_ERROR = 0;
149657
149658    /**
149659     * @var integer
149660     **/
149661    const ERRNO_TIMEOUT = 0;
149662
149663    /**
149664     * @var integer
149665     **/
149666    const VERSION_1 = 0;
149667
149668    /**
149669     * @var integer
149670     **/
149671    const VERSION_2c = 0;
149672
149673    /**
149674     * @var integer
149675     **/
149676    const VERSION_2C = 0;
149677
149678    /**
149679     * @var integer
149680     **/
149681    const VERSION_3 = 0;
149682
149683    /**
149684     * @var bool
149685     **/
149686    public $enum_print;
149687
149688    /**
149689     * @var int
149690     **/
149691    public $exceptions_enabled;
149692
149693    /**
149694     * Read-only property with remote agent configuration: hostname, port,
149695     * default timeout, default retries count
149696     *
149697     * @var array
149698     **/
149699    public $info;
149700
149701    /**
149702     * @var int
149703     **/
149704    public $max_oids;
149705
149706    /**
149707     * @var bool
149708     **/
149709    public $oid_increasing_check;
149710
149711    /**
149712     * @var int
149713     **/
149714    public $oid_output_format;
149715
149716    /**
149717     * @var bool
149718     **/
149719    public $quick_print;
149720
149721    /**
149722     * Controls the method how the SNMP values will be returned
149723     *
149724     * @var int
149725     **/
149726    public $valueretrieval;
149727
149728    /**
149729     * Close session
149730     *
149731     * Frees previously allocated SNMP session object.
149732     *
149733     * @return bool
149734     * @since PHP 5 >= 5.4.0, PHP 7
149735     **/
149736    public function close(){}
149737
149738    /**
149739     * Fetch an object
149740     *
149741     * Fetch an SNMP object specified in {@link object_id} using GET query.
149742     *
149743     * @param mixed $object_id The SNMP object (OID) or objects
149744     * @param bool $preserve_keys When {@link object_id} is a array and
149745     *   {@link preserve_keys} set to TRUE keys in results will be taken
149746     *   exactly as in {@link object_id}, otherwise SNMP::oid_output_format
149747     *   property is used to determinate the form of keys.
149748     * @return mixed Returns SNMP objects requested as string or array
149749     *   depending on {@link object_id} type or FALSE on error.
149750     * @since PHP 5 >= 5.4.0, PHP 7
149751     **/
149752    public function get($object_id, $preserve_keys){}
149753
149754    /**
149755     * Get last error code
149756     *
149757     * Returns error code from last SNMP request.
149758     *
149759     * @return int Returns one of SNMP error code values described in
149760     *   constants chapter.
149761     * @since PHP 5 >= 5.4.0, PHP 7
149762     **/
149763    public function getErrno(){}
149764
149765    /**
149766     * Get last error message
149767     *
149768     * Returns string with error from last SNMP request.
149769     *
149770     * @return string String describing error from last SNMP request.
149771     * @since PHP 5 >= 5.4.0, PHP 7
149772     **/
149773    public function getError(){}
149774
149775    /**
149776     * Fetch an object which follows the given object id
149777     *
149778     * Fetch an SNMP object that follows specified {@link object_id}.
149779     *
149780     * @param mixed $object_id The SNMP object (OID) or objects
149781     * @return mixed Returns SNMP objects requested as string or array
149782     *   depending on {@link object_id} type or FALSE on error.
149783     * @since PHP 5 >= 5.4.0, PHP 7
149784     **/
149785    public function getnext($object_id){}
149786
149787    /**
149788     * Set the value of an SNMP object
149789     *
149790     * Requests remote SNMP agent setting the value of one or more SNMP
149791     * objects specified by the {@link object_id}.
149792     *
149793     * @param mixed $object_id The SNMP object id When count of OIDs in
149794     *   object_id array is greater than max_oids object property set method
149795     *   will have to use multiple queries to perform requested value
149796     *   updates. In this case type and value checks are made per-chunk so
149797     *   second or subsequent requests may fail due to wrong type or value
149798     *   for OID requested. To mark this a warning is raised when count of
149799     *   OIDs in object_id array is greater than max_oids.
149800     * @param mixed $type
149801     * @param mixed $value The new value.
149802     * @return bool
149803     * @since PHP 5 >= 5.4.0, PHP 7
149804     **/
149805    public function set($object_id, $type, $value){}
149806
149807    /**
149808     * Configures security-related v3 session parameters
149809     *
149810     * setSecurity configures security-related session parameters used in
149811     * SNMP protocol version 3
149812     *
149813     * @param string $sec_level the security level
149814     *   (noAuthNoPriv|authNoPriv|authPriv)
149815     * @param string $auth_protocol the authentication protocol (MD5 or
149816     *   SHA)
149817     * @param string $auth_passphrase the authentication pass phrase
149818     * @param string $priv_protocol the privacy protocol (DES or AES)
149819     * @param string $priv_passphrase the privacy pass phrase
149820     * @param string $contextName the context name
149821     * @param string $contextEngineID the context EngineID
149822     * @return bool
149823     * @since PHP 5 >= 5.4.0, PHP 7
149824     **/
149825    public function setSecurity($sec_level, $auth_protocol, $auth_passphrase, $priv_protocol, $priv_passphrase, $contextName, $contextEngineID){}
149826
149827    /**
149828     * Fetch object subtree
149829     *
149830     * SNMP::walk is used to read SNMP subtree rooted at specified {@link
149831     * object_id}.
149832     *
149833     * @param string $object_id Root of subtree to be fetched
149834     * @param bool $suffix_as_key By default full OID notation is used for
149835     *   keys in output array. If set to TRUE subtree prefix will be removed
149836     *   from keys leaving only suffix of object_id.
149837     * @param int $max_repetitions This specifies the number of supplied
149838     *   variables that should not be iterated over. The default is to use
149839     *   this value from SNMP object.
149840     * @param int $non_repeaters This specifies the maximum number of
149841     *   iterations over the repeating variables. The default is to use this
149842     *   value from SNMP object.
149843     * @return array Returns an associative array of the SNMP object ids
149844     *   and their values on success or FALSE on error. When a SNMP error
149845     *   occures SNMP::getErrno and SNMP::getError can be used for retrieving
149846     *   error number (specific to SNMP extension, see class constants) and
149847     *   error message respectively.
149848     * @since PHP 5 >= 5.4.0, PHP 7
149849     **/
149850    public function walk($object_id, $suffix_as_key, $max_repetitions, $non_repeaters){}
149851
149852}
149853/**
149854 * Represents an error raised by SNMP. You should not throw a
149855 * SNMPException from your own code. See Exceptions for more information
149856 * about Exceptions in PHP.
149857 **/
149858class SNMPException extends RuntimeException {
149859    /**
149860     * SNMPlibrary error code. Use {@link Exception::getCode} to access it.
149861     *
149862     * @var string
149863     **/
149864    protected $code;
149865
149866}
149867/**
149868 * The SoapClient class provides a client for SOAP 1.1, SOAP 1.2 servers.
149869 * It can be used in WSDL or non-WSDL mode.
149870 **/
149871class SoapClient {
149872    /**
149873     * SoapClient constructor
149874     *
149875     * This constructor creates SoapClient objects in WSDL or non-WSDL mode.
149876     *
149877     * @param mixed $wsdl URI of the WSDL file or NULL if working in
149878     *   non-WSDL mode.
149879     * @param array $options An array of options. If working in WSDL mode,
149880     *   this parameter is optional. If working in non-WSDL mode, the
149881     *   location and uri options must be set, where location is the URL of
149882     *   the SOAP server to send the request to, and uri is the target
149883     *   namespace of the SOAP service. The style and use options only work
149884     *   in non-WSDL mode. In WSDL mode, they come from the WSDL file. The
149885     *   soap_version option should be one of either SOAP_1_1 or SOAP_1_2 to
149886     *   select SOAP 1.1 or 1.2, respectively. If omitted, 1.1 is used. For
149887     *   HTTP authentication, the login and password options can be used to
149888     *   supply credentials. For making an HTTP connection through a proxy
149889     *   server, the options proxy_host, proxy_port, proxy_login and
149890     *   proxy_password are also available. For HTTPS client certificate
149891     *   authentication use local_cert and passphrase options. An
149892     *   authentication may be supplied in the authentication option. The
149893     *   authentication method may be either SOAP_AUTHENTICATION_BASIC
149894     *   (default) or SOAP_AUTHENTICATION_DIGEST. The compression option
149895     *   allows to use compression of HTTP SOAP requests and responses. The
149896     *   encoding option defines internal character encoding. This option
149897     *   does not change the encoding of SOAP requests (it is always utf-8),
149898     *   but converts strings into it. The trace option enables tracing of
149899     *   request so faults can be backtraced. This defaults to FALSE The
149900     *   classmap option can be used to map some WSDL types to PHP classes.
149901     *   This option must be an array with WSDL types as keys and names of
149902     *   PHP classes as values. Setting the boolean trace option enables use
149903     *   of the methods SoapClient->__getLastRequest,
149904     *   SoapClient->__getLastRequestHeaders, SoapClient->__getLastResponse
149905     *   and SoapClient->__getLastResponseHeaders. The exceptions option is a
149906     *   boolean value defining whether soap errors throw exceptions of type
149907     *   SoapFault. The connection_timeout option defines a timeout in
149908     *   seconds for the connection to the SOAP service. This option does not
149909     *   define a timeout for services with slow responses. To limit the time
149910     *   to wait for calls to finish the default_socket_timeout setting is
149911     *   available. The typemap option is an array of type mappings. Type
149912     *   mapping is an array with keys type_name, type_ns (namespace URI),
149913     *   from_xml (callback accepting one string parameter) and to_xml
149914     *   (callback accepting one object parameter). The cache_wsdl option is
149915     *   one of WSDL_CACHE_NONE, WSDL_CACHE_DISK, WSDL_CACHE_MEMORY or
149916     *   WSDL_CACHE_BOTH. The user_agent option specifies string to use in
149917     *   User-Agent header. The stream_context option is a resource for
149918     *   context. The features option is a bitmask of
149919     *   SOAP_SINGLE_ELEMENT_ARRAYS, SOAP_USE_XSI_ARRAY_TYPE,
149920     *   SOAP_WAIT_ONE_WAY_CALLS. The keep_alive option is a boolean value
149921     *   defining whether to send the Connection: Keep-Alive header or
149922     *   Connection: close. The ssl_method option is one of
149923     *   SOAP_SSL_METHOD_TLS, SOAP_SSL_METHOD_SSLv2, SOAP_SSL_METHOD_SSLv3 or
149924     *   SOAP_SSL_METHOD_SSLv23.
149925     * @since PHP 5, PHP 7
149926     **/
149927    public function SoapClient($wsdl, $options){}
149928
149929    /**
149930     * Calls a SOAP function (deprecated)
149931     *
149932     * Calling this method directly is deprecated. Usually, SOAP functions
149933     * can be called as methods of the SoapClient object; in situations where
149934     * this is not possible or additional options are needed, use {@link
149935     * SoapClient::__soapCall}.
149936     *
149937     * @param string $function_name
149938     * @param array $arguments
149939     * @return mixed
149940     * @since PHP 5, PHP 7
149941     **/
149942    public function __call($function_name, $arguments){}
149943
149944    /**
149945     * SoapClient constructor
149946     *
149947     * SoapClient::SoapClient
149948     *
149949     * @param mixed $wsdl
149950     * @param array $options
149951     * @since PHP 5, PHP 7
149952     **/
149953    public function __construct($wsdl, $options){}
149954
149955    /**
149956     * Performs a SOAP request
149957     *
149958     * Performs SOAP request over HTTP.
149959     *
149960     * This method can be overridden in subclasses to implement different
149961     * transport layers, perform additional XML processing or other purpose.
149962     *
149963     * @param string $request The XML SOAP request.
149964     * @param string $location The URL to request.
149965     * @param string $action The SOAP action.
149966     * @param int $version The SOAP version.
149967     * @param int $one_way If one_way is set to 1, this method returns
149968     *   nothing. Use this where a response is not expected.
149969     * @return string The XML SOAP response.
149970     * @since PHP 5, PHP 7
149971     **/
149972    public function __doRequest($request, $location, $action, $version, $one_way){}
149973
149974    /**
149975     * Get list of cookies
149976     *
149977     * @return array
149978     * @since PHP 5 >= 5.4.30, PHP 7
149979     **/
149980    public function __getCookies(){}
149981
149982    /**
149983     * Returns list of available SOAP functions
149984     *
149985     * Returns an array of functions described in the WSDL for the Web
149986     * service.
149987     *
149988     * @return array The array of SOAP function prototypes, detailing the
149989     *   return type, the function name and type-hinted parameters.
149990     * @since PHP 5, PHP 7
149991     **/
149992    public function __getFunctions(){}
149993
149994    /**
149995     * Returns last SOAP request
149996     *
149997     * Returns the XML sent in the last SOAP request.
149998     *
149999     * @return string The last SOAP request, as an XML string.
150000     * @since PHP 5, PHP 7
150001     **/
150002    public function __getLastRequest(){}
150003
150004    /**
150005     * Returns the SOAP headers from the last request
150006     *
150007     * @return string The last SOAP request headers.
150008     * @since PHP 5, PHP 7
150009     **/
150010    public function __getLastRequestHeaders(){}
150011
150012    /**
150013     * Returns last SOAP response
150014     *
150015     * Returns the XML received in the last SOAP response.
150016     *
150017     * @return string The last SOAP response, as an XML string.
150018     * @since PHP 5, PHP 7
150019     **/
150020    public function __getLastResponse(){}
150021
150022    /**
150023     * Returns the SOAP headers from the last response
150024     *
150025     * @return string The last SOAP response headers.
150026     * @since PHP 5, PHP 7
150027     **/
150028    public function __getLastResponseHeaders(){}
150029
150030    /**
150031     * Returns a list of SOAP types
150032     *
150033     * Returns an array of types described in the WSDL for the Web service.
150034     *
150035     * @return array The array of SOAP types, detailing all structures and
150036     *   types.
150037     * @since PHP 5, PHP 7
150038     **/
150039    public function __getTypes(){}
150040
150041    /**
150042     * The __setCookie purpose
150043     *
150044     * Defines a cookie to be sent along with the SOAP requests.
150045     *
150046     * @param string $name The name of the cookie.
150047     * @param string $value The value of the cookie. If not specified, the
150048     *   cookie will be deleted.
150049     * @return void
150050     * @since PHP 5 >= 5.0.4, PHP 7
150051     **/
150052    public function __setCookie($name, $value){}
150053
150054    /**
150055     * Sets the location of the Web service to use
150056     *
150057     * Sets the endpoint URL that will be touched by following SOAP requests.
150058     * This is equivalent to specifying the location option when constructing
150059     * the SoapClient.
150060     *
150061     * @param string $new_location The new endpoint URL.
150062     * @return string The old endpoint URL.
150063     * @since PHP 5 >= 5.0.4, PHP 7
150064     **/
150065    public function __setLocation($new_location){}
150066
150067    /**
150068     * Sets SOAP headers for subsequent calls
150069     *
150070     * Defines headers to be sent along with the SOAP requests.
150071     *
150072     * @param mixed $soapheaders The headers to be set. It could be
150073     *   SoapHeader object or array of SoapHeader objects. If not specified
150074     *   or set to NULL, the headers will be deleted.
150075     * @return bool
150076     * @since PHP 5 >= 5.0.5, PHP 7
150077     **/
150078    public function __setSoapHeaders($soapheaders){}
150079
150080    /**
150081     * Calls a SOAP function
150082     *
150083     * This is a low level API function that is used to make a SOAP call.
150084     * Usually, in WSDL mode, SOAP functions can be called as methods of the
150085     * SoapClient object. This method is useful in non-WSDL mode when
150086     * soapaction is unknown, uri differs from the default or when sending
150087     * and/or receiving SOAP Headers.
150088     *
150089     * On error, a call to a SOAP function can cause PHP to throw exceptions
150090     * or return a SoapFault object if exceptions are disabled. To check if
150091     * the function call failed to catch the SoapFault exceptions, check the
150092     * result with {@link is_soap_fault}.
150093     *
150094     * @param string $function_name The name of the SOAP function to call.
150095     * @param array $arguments An array of the arguments to pass to the
150096     *   function. This can be either an ordered or an associative array.
150097     *   Note that most SOAP servers require parameter names to be provided,
150098     *   in which case this must be an associative array.
150099     * @param array $options An associative array of options to pass to the
150100     *   client. The location option is the URL of the remote Web service.
150101     *   The uri option is the target namespace of the SOAP service. The
150102     *   soapaction option is the action to call.
150103     * @param mixed $input_headers An array of headers to be sent along
150104     *   with the SOAP request.
150105     * @param array $output_headers If supplied, this array will be filled
150106     *   with the headers from the SOAP response.
150107     * @return mixed SOAP functions may return one, or multiple values. If
150108     *   only one value is returned by the SOAP function, the return value of
150109     *   __soapCall will be a simple value (e.g. an integer, a string, etc).
150110     *   If multiple values are returned, __soapCall will return an
150111     *   associative array of named output parameters.
150112     * @since PHP 5, PHP 7
150113     **/
150114    public function __soapCall($function_name, $arguments, $options, $input_headers, &$output_headers){}
150115
150116}
150117/**
150118 * Represents a SOAP fault.
150119 **/
150120class SoapFault extends Exception {
150121    /**
150122     * SoapFault constructor
150123     *
150124     * This class is used to send SOAP fault responses from the PHP handler.
150125     * {@link faultcode}, {@link faultstring}, {@link faultactor} and {@link
150126     * detail} are standard elements of a SOAP Fault.
150127     *
150128     * @param string $faultcode The error code of the SoapFault.
150129     * @param string $faultstring The error message of the SoapFault.
150130     * @param string $faultactor A string identifying the actor that caused
150131     *   the error.
150132     * @param string $detail More details about the cause of the error.
150133     * @param string $faultname Can be used to select the proper fault
150134     *   encoding from WSDL.
150135     * @param string $headerfault Can be used during SOAP header handling
150136     *   to report an error in the response header.
150137     * @since PHP 5, PHP 7
150138     **/
150139    function SoapFault($faultcode, $faultstring, $faultactor, $detail, $faultname, $headerfault){}
150140
150141    /**
150142     * SoapFault constructor
150143     *
150144     * SoapFault::SoapFault
150145     *
150146     * @param string $faultcode
150147     * @param string $faultstring
150148     * @param string $faultactor
150149     * @param string $detail
150150     * @param string $faultname
150151     * @param string $headerfault
150152     * @since PHP 5, PHP 7
150153     **/
150154    function __construct($faultcode, $faultstring, $faultactor, $detail, $faultname, $headerfault){}
150155
150156    /**
150157     * Obtain a string representation of a SoapFault
150158     *
150159     * Returns a string representation of the SoapFault.
150160     *
150161     * @return string A string describing the SoapFault.
150162     * @since PHP 5, PHP 7
150163     **/
150164    public function __toString(){}
150165
150166}
150167/**
150168 * Represents a SOAP header.
150169 **/
150170class SoapHeader {
150171    /**
150172     * SoapHeader constructor
150173     *
150174     * Constructs a new SoapHeader object.
150175     *
150176     * @param string $namespace The namespace of the SOAP header element.
150177     * @param string $name The name of the SoapHeader object.
150178     * @param mixed $data A SOAP header's content. It can be a PHP value or
150179     *   a SoapVar object.
150180     * @param bool $mustunderstand Value of the mustUnderstand attribute of
150181     *   the SOAP header element.
150182     * @param string $actor Value of the actor attribute of the SOAP header
150183     *   element.
150184     * @since PHP 5, PHP 7
150185     **/
150186    function SoapHeader($namespace, $name, $data, $mustunderstand, $actor){}
150187
150188    /**
150189     * SoapHeader constructor
150190     *
150191     * SoapHeader::SoapHeader
150192     *
150193     * @param string $namespace
150194     * @param string $name
150195     * @param mixed $data
150196     * @param bool $mustunderstand
150197     * @param string $actor
150198     * @since PHP 5, PHP 7
150199     **/
150200    function __construct($namespace, $name, $data, $mustunderstand, $actor){}
150201
150202}
150203/**
150204 * Represents parameter to a SOAP call.
150205 **/
150206class SoapParam {
150207    /**
150208     * SoapParam constructor
150209     *
150210     * Constructs a new SoapParam object.
150211     *
150212     * @param mixed $data The data to pass or return. This parameter can be
150213     *   passed directly as PHP value, but in this case it will be named as
150214     *   paramN and the SOAP service may not understand it.
150215     * @param string $name The parameter name.
150216     * @since PHP 5, PHP 7
150217     **/
150218    function SoapParam($data, $name){}
150219
150220    /**
150221     * SoapParam constructor
150222     *
150223     * SoapParam::SoapParam
150224     *
150225     * @param mixed $data
150226     * @param string $name
150227     * @since PHP 5, PHP 7
150228     **/
150229    function __construct($data, $name){}
150230
150231}
150232/**
150233 * The SoapServer class provides a server for the SOAP 1.1 and SOAP 1.2
150234 * protocols. It can be used with or without a WSDL service description.
150235 **/
150236class SoapServer {
150237    /**
150238     * Adds one or more functions to handle SOAP requests
150239     *
150240     * Exports one or more functions for remote clients
150241     *
150242     * @param mixed $functions To export one function, pass the function
150243     *   name into this parameter as a string. To export several functions,
150244     *   pass an array of function names. To export all the functions, pass a
150245     *   special constant SOAP_FUNCTIONS_ALL.
150246     * @return void
150247     * @since PHP 5, PHP 7
150248     **/
150249    public function addFunction($functions){}
150250
150251    /**
150252     * Add a SOAP header to the response
150253     *
150254     * Adds a SOAP header to be returned with the response to the current
150255     * request.
150256     *
150257     * @param SoapHeader $object The header to be returned.
150258     * @return void
150259     * @since PHP 5 >= 5.1.3, PHP 7
150260     **/
150261    public function addSoapHeader($object){}
150262
150263    /**
150264     * Issue SoapServer fault indicating an error
150265     *
150266     * Sends a response to the client of the current request indicating an
150267     * error.
150268     *
150269     * @param string $code The error code to return
150270     * @param string $string A brief description of the error
150271     * @param string $actor A string identifying the actor that caused the
150272     *   fault.
150273     * @param string $details More details of the fault
150274     * @param string $name The name of the fault. This can be used to
150275     *   select a name from a WSDL file.
150276     * @return void
150277     * @since PHP 5, PHP 7
150278     **/
150279    public function fault($code, $string, $actor, $details, $name){}
150280
150281    /**
150282     * Returns list of defined functions
150283     *
150284     * Returns a list of the defined functions in the SoapServer object. This
150285     * method returns the list of all functions added by
150286     * SoapServer::addFunction or SoapServer::setClass.
150287     *
150288     * @return array An array of the defined functions.
150289     * @since PHP 5, PHP 7
150290     **/
150291    public function getFunctions(){}
150292
150293    /**
150294     * Handles a SOAP request
150295     *
150296     * Processes a SOAP request, calls necessary functions, and sends a
150297     * response back.
150298     *
150299     * @param string $soap_request The SOAP request. If this argument is
150300     *   omitted, the request is assumed to be in the raw POST data of the
150301     *   HTTP request.
150302     * @return void
150303     * @since PHP 5, PHP 7
150304     **/
150305    public function handle($soap_request){}
150306
150307    /**
150308     * Sets the class which handles SOAP requests
150309     *
150310     * Exports all methods from specified class.
150311     *
150312     * The object can be made persistent across request for a given PHP
150313     * session with the SoapServer::setPersistence method.
150314     *
150315     * @param string $class_name The name of the exported class.
150316     * @param mixed ...$vararg These optional parameters will be passed to
150317     *   the default class constructor during object creation.
150318     * @return void
150319     * @since PHP 5, PHP 7
150320     **/
150321    public function setClass($class_name, ...$vararg){}
150322
150323    /**
150324     * Sets the object which will be used to handle SOAP requests
150325     *
150326     * This sets a specific object as the handler for SOAP requests, rather
150327     * than just a class as in SoapServer::setClass.
150328     *
150329     * @param object $object The object to handle the requests.
150330     * @return void
150331     * @since PHP 5 >= 5.2.0, PHP 7
150332     **/
150333    public function setObject($object){}
150334
150335    /**
150336     * Sets SoapServer persistence mode
150337     *
150338     * This function allows changing the persistence state of a SoapServer
150339     * object between requests. This function allows saving data between
150340     * requests utilizing PHP sessions. This method only has an affect on a
150341     * SoapServer after it has exported functions utilizing
150342     * SoapServer::setClass.
150343     *
150344     * @param int $mode One of the SOAP_PERSISTENCE_XXX constants.
150345     *   SOAP_PERSISTENCE_REQUEST - SoapServer data does not persist between
150346     *   requests. This is the default behavior of any SoapServer object
150347     *   after setClass is called. SOAP_PERSISTENCE_SESSION - SoapServer data
150348     *   persists between requests. This is accomplished by serializing the
150349     *   SoapServer class data into $_SESSION['_bogus_session_name'], because
150350     *   of this {@link session_start} must be called before this persistence
150351     *   mode is set.
150352     * @return void
150353     * @since PHP 5, PHP 7
150354     **/
150355    public function setPersistence($mode){}
150356
150357    /**
150358     * SoapServer constructor
150359     *
150360     * This constructor allows the creation of SoapServer objects in WSDL or
150361     * non-WSDL mode.
150362     *
150363     * @param mixed $wsdl To use the SoapServer in WSDL mode, pass the URI
150364     *   of a WSDL file. Otherwise, pass NULL and set the uri option to the
150365     *   target namespace for the server.
150366     * @param array $options Allow setting a default SOAP version
150367     *   (soap_version), internal character encoding (encoding), and actor
150368     *   URI (actor). The classmap option can be used to map some WSDL types
150369     *   to PHP classes. This option must be an array with WSDL types as keys
150370     *   and names of PHP classes as values. The typemap option is an array
150371     *   of type mappings. Type mapping is an array with keys type_name,
150372     *   type_ns (namespace URI), from_xml (callback accepting one string
150373     *   parameter) and to_xml (callback accepting one object parameter). The
150374     *   cache_wsdl option is one of WSDL_CACHE_NONE, WSDL_CACHE_DISK,
150375     *   WSDL_CACHE_MEMORY or WSDL_CACHE_BOTH. There is also a features
150376     *   option which can be set to SOAP_WAIT_ONE_WAY_CALLS,
150377     *   SOAP_SINGLE_ELEMENT_ARRAYS, SOAP_USE_XSI_ARRAY_TYPE. The send_errors
150378     *   option can be set to FALSE to sent a generic error message
150379     *   ("Internal error") instead of the specific error message sent
150380     *   otherwise.
150381     * @since PHP 5, PHP 7
150382     **/
150383    public function SoapServer($wsdl, $options){}
150384
150385    /**
150386     * SoapServer constructor
150387     *
150388     * SoapServer::SoapServer
150389     *
150390     * @param mixed $wsdl
150391     * @param array $options
150392     * @since PHP 5, PHP 7
150393     **/
150394    public function __construct($wsdl, $options){}
150395
150396}
150397/**
150398 * A class representing a variable or object for use with SOAP services.
150399 **/
150400class SoapVar {
150401    /**
150402     * SoapVar constructor
150403     *
150404     * Constructs a new SoapVar object.
150405     *
150406     * @param mixed $data The data to pass or return.
150407     * @param string $encoding The encoding ID, one of the XSD_...
150408     *   constants.
150409     * @param string $type_name The type name.
150410     * @param string $type_namespace The type namespace.
150411     * @param string $node_name The XML node name.
150412     * @param string $node_namespace The XML node namespace.
150413     * @since PHP 5, PHP 7
150414     **/
150415    function SoapVar($data, $encoding, $type_name, $type_namespace, $node_name, $node_namespace){}
150416
150417    /**
150418     * SoapVar constructor
150419     *
150420     * SoapVar::SoapVar
150421     *
150422     * @param mixed $data
150423     * @param string $encoding
150424     * @param string $type_name
150425     * @param string $type_namespace
150426     * @param string $node_name
150427     * @param string $node_namespace
150428     * @since PHP 5, PHP 7
150429     **/
150430    function __construct($data, $encoding, $type_name, $type_namespace, $node_name, $node_namespace){}
150431
150432}
150433class SodiumException extends Exception implements Throwable {
150434}
150435/**
150436 * Used to send requests to a Solr server. Currently, cloning and
150437 * serialization of SolrClient instances is not supported.
150438 **/
150439final class SolrClient {
150440    /**
150441     * @var string
150442     **/
150443    const DEFAULT_PING_SERVLET = '';
150444
150445    /**
150446     * @var string
150447     **/
150448    const DEFAULT_SEARCH_SERVLET = '';
150449
150450    /**
150451     * @var string
150452     **/
150453    const DEFAULT_SYSTEM_SERVLET = '';
150454
150455    /**
150456     * @var string
150457     **/
150458    const DEFAULT_TERMS_SERVLET = '';
150459
150460    /**
150461     * @var string
150462     **/
150463    const DEFAULT_THREADS_SERVLET = '';
150464
150465    /**
150466     * @var string
150467     **/
150468    const DEFAULT_UPDATE_SERVLET = '';
150469
150470    /**
150471     * @var integer
150472     **/
150473    const PING_SERVLET_TYPE = 0;
150474
150475    /**
150476     * @var integer
150477     **/
150478    const SEARCH_SERVLET_TYPE = 0;
150479
150480    /**
150481     * @var integer
150482     **/
150483    const SYSTEM_SERVLET_TYPE = 0;
150484
150485    /**
150486     * @var integer
150487     **/
150488    const TERMS_SERVLET_TYPE = 0;
150489
150490    /**
150491     * @var integer
150492     **/
150493    const THREADS_SERVLET_TYPE = 0;
150494
150495    /**
150496     * @var integer
150497     **/
150498    const UPDATE_SERVLET_TYPE = 0;
150499
150500    /**
150501     * Adds a document to the index
150502     *
150503     * This method adds a document to the index.
150504     *
150505     * @param SolrInputDocument $doc The SolrInputDocument instance.
150506     * @param bool $overwrite Whether to overwrite existing document or
150507     *   not. If FALSE there will be duplicates (several documents with the
150508     *   same ID).
150509     * @param int $commitWithin Number of milliseconds within which to auto
150510     *   commit this document. Available since Solr 1.4 . Default (0) means
150511     *   disabled. When this value specified, it leaves the control of when
150512     *   to do the commit to Solr itself, optimizing number of commits to a
150513     *   minimum while still fulfilling the update latency requirements, and
150514     *   Solr will automatically do a commit when the oldest add in the
150515     *   buffer is due.
150516     * @return SolrUpdateResponse Returns a SolrUpdateResponse object or
150517     *   throws an Exception on failure.
150518     * @since PECL solr >= 0.9.2
150519     **/
150520    public function addDocument($doc, $overwrite, $commitWithin){}
150521
150522    /**
150523     * Adds a collection of SolrInputDocument instances to the index
150524     *
150525     * Adds a collection of documents to the index.
150526     *
150527     * @param array $docs An array containing the collection of
150528     *   SolrInputDocument instances. This array must be an actual variable.
150529     * @param bool $overwrite Whether to overwrite existing documents or
150530     *   not. If FALSE there will be duplicates (several documents with the
150531     *   same ID).
150532     * @param int $commitWithin Number of milliseconds within which to auto
150533     *   commit this document. Available since Solr 1.4 . Default (0) means
150534     *   disabled. When this value specified, it leaves the control of when
150535     *   to do the commit to Solr itself, optimizing number of commits to a
150536     *   minimum while still fulfilling the update latency requirements, and
150537     *   Solr will automatically do a commit when the oldest add in the
150538     *   buffer is due.
150539     * @return void Returns a SolrUpdateResponse object or throws an
150540     *   exception on failure.
150541     * @since PECL solr >= 0.9.2
150542     **/
150543    public function addDocuments($docs, $overwrite, $commitWithin){}
150544
150545    /**
150546     * Finalizes all add/deletes made to the index
150547     *
150548     * This method finalizes all add/deletes made to the index.
150549     *
150550     * @param bool $softCommit This will refresh the 'view' of the index in
150551     *   a more performant manner, but without "on-disk" guarantees.
150552     *   (Solr4.0+) A soft commit is much faster since it only makes index
150553     *   changes visible and does not fsync index files or write a new index
150554     *   descriptor. If the JVM crashes or there is a loss of power, changes
150555     *   that occurred after the last hard commit will be lost. Search
150556     *   collections that have near-real-time requirements (that want index
150557     *   changes to be quickly visible to searches) will want to soft commit
150558     *   often but hard commit less frequently.
150559     * @param bool $waitSearcher block until a new searcher is opened and
150560     *   registered as the main query searcher, making the changes visible.
150561     * @param bool $expungeDeletes Merge segments with deletes away.
150562     *   (Solr1.4+)
150563     * @return SolrUpdateResponse Returns a SolrUpdateResponse object on
150564     *   success or throws an exception on failure.
150565     * @since PECL solr >= 0.9.2
150566     **/
150567    public function commit($softCommit, $waitSearcher, $expungeDeletes){}
150568
150569    /**
150570     * Delete by Id
150571     *
150572     * Deletes the document with the specified ID. Where ID is the value of
150573     * the uniqueKey field declared in the schema
150574     *
150575     * @param string $id The value of the uniqueKey field declared in the
150576     *   schema
150577     * @return SolrUpdateResponse Returns a SolrUpdateResponse on success
150578     *   and throws an exception on failure.
150579     * @since PECL solr >= 0.9.2
150580     **/
150581    public function deleteById($id){}
150582
150583    /**
150584     * Deletes by Ids
150585     *
150586     * Deletes a collection of documents with the specified set of ids.
150587     *
150588     * @param array $ids An array of IDs representing the uniqueKey field
150589     *   declared in the schema for each document to be deleted. This must be
150590     *   an actual php variable.
150591     * @return SolrUpdateResponse Returns a SolrUpdateResponse on success
150592     *   and throws an exception on failure.
150593     * @since PECL solr >= 0.9.2
150594     **/
150595    public function deleteByIds($ids){}
150596
150597    /**
150598     * Removes all documents matching any of the queries
150599     *
150600     * @param array $queries The array of queries. This must be an actual
150601     *   php variable.
150602     * @return SolrUpdateResponse Returns a SolrUpdateResponse on success
150603     *   and throws a SolrClientException on failure.
150604     * @since PECL solr >= 0.9.2
150605     **/
150606    public function deleteByQueries($queries){}
150607
150608    /**
150609     * Deletes all documents matching the given query
150610     *
150611     * @param string $query The query
150612     * @return SolrUpdateResponse Returns a SolrUpdateResponse on success
150613     *   and throws an exception on failure.
150614     * @since PECL solr >= 0.9.2
150615     **/
150616    public function deleteByQuery($query){}
150617
150618    /**
150619     * Get Document By Id. Utilizes Solr Realtime Get (RTG)
150620     *
150621     * @param string $id Document ID
150622     * @return SolrQueryResponse SolrQueryResponse
150623     * @since PECL solr >= 2.2.0
150624     **/
150625    public function getById($id){}
150626
150627    /**
150628     * Get Documents by their Ids. Utilizes Solr Realtime Get (RTG)
150629     *
150630     * @param array $ids Document ids
150631     * @return SolrQueryResponse SolrQueryResponse
150632     * @since PECL solr >= 2.2.0
150633     **/
150634    public function getByIds($ids){}
150635
150636    /**
150637     * Returns the debug data for the last connection attempt
150638     *
150639     * @return string Returns a string on success and null if there is
150640     *   nothing to return.
150641     * @since PECL solr >= 0.9.7
150642     **/
150643    public function getDebug(){}
150644
150645    /**
150646     * Returns the client options set internally
150647     *
150648     * Returns the client options set internally. Very useful for debugging.
150649     * The values returned are readonly and can only be set when the object
150650     * is instantiated.
150651     *
150652     * @return array Returns an array containing all the options for the
150653     *   SolrClient object set internally.
150654     * @since PECL solr >= 0.9.6
150655     **/
150656    public function getOptions(){}
150657
150658    /**
150659     * Defragments the index
150660     *
150661     * Defragments the index for faster search performance.
150662     *
150663     * @param int $maxSegments Optimizes down to at most this number of
150664     *   segments. Since Solr 1.3
150665     * @param bool $softCommit This will refresh the 'view' of the index in
150666     *   a more performant manner, but without "on-disk" guarantees.
150667     *   (Solr4.0+)
150668     * @param bool $waitSearcher Block until a new searcher is opened and
150669     *   registered as the main query searcher, making the changes visible.
150670     * @return SolrUpdateResponse Returns a SolrUpdateResponse on success
150671     *   or throws an exception on failure.
150672     * @since PECL solr >= 0.9.2
150673     **/
150674    public function optimize($maxSegments, $softCommit, $waitSearcher){}
150675
150676    /**
150677     * Checks if Solr server is still up
150678     *
150679     * Checks if the Solr server is still alive. Sends a HEAD request to the
150680     * Apache Solr server.
150681     *
150682     * @return SolrPingResponse Returns a SolrPingResponse object on
150683     *   success and throws an exception on failure.
150684     * @since PECL solr >= 0.9.2
150685     **/
150686    public function ping(){}
150687
150688    /**
150689     * Sends a query to the server
150690     *
150691     * @param SolrParams $query A SolrParams object. It is recommended to
150692     *   use SolrQuery for advanced queries.
150693     * @return SolrQueryResponse Returns a SolrQueryResponse object on
150694     *   success and throws an exception on failure.
150695     * @since PECL solr >= 0.9.2
150696     **/
150697    public function query($query){}
150698
150699    /**
150700     * Sends a raw update request
150701     *
150702     * Sends a raw XML update request to the server
150703     *
150704     * @param string $raw_request An XML string with the raw request to the
150705     *   server.
150706     * @return SolrUpdateResponse Returns a SolrUpdateResponse on success.
150707     *   Throws an exception on failure.
150708     * @since PECL solr >= 0.9.2
150709     **/
150710    public function request($raw_request){}
150711
150712    /**
150713     * Rollbacks all add/deletes made to the index since the last commit
150714     *
150715     * Rollbacks all add/deletes made to the index since the last commit. It
150716     * neither calls any event listeners nor creates a new searcher.
150717     *
150718     * @return SolrUpdateResponse Returns a SolrUpdateResponse on success
150719     *   or throws a SolrClientException on failure.
150720     * @since PECL solr >= 0.9.2
150721     **/
150722    public function rollback(){}
150723
150724    /**
150725     * Sets the response writer used to prepare the response from Solr
150726     *
150727     * @param string $responseWriter One of the following:
150728     * @return void
150729     * @since PECL solr >= 0.9.11
150730     **/
150731    public function setResponseWriter($responseWriter){}
150732
150733    /**
150734     * Changes the specified servlet type to a new value
150735     *
150736     * @param int $type One of the following : -
150737     *   SolrClient::SEARCH_SERVLET_TYPE - SolrClient::UPDATE_SERVLET_TYPE -
150738     *   SolrClient::THREADS_SERVLET_TYPE - SolrClient::PING_SERVLET_TYPE -
150739     *   SolrClient::TERMS_SERVLET_TYPE
150740     * @param string $value The new value for the servlet
150741     * @return bool
150742     * @since PECL solr >= 0.9.2
150743     **/
150744    public function setServlet($type, $value){}
150745
150746    /**
150747     * Retrieve Solr Server information
150748     *
150749     * @return void Returns a SolrGenericResponse object on success.
150750     * @since PECL solr >= 2.0.0
150751     **/
150752    public function system(){}
150753
150754    /**
150755     * Checks the threads status
150756     *
150757     * @return void Returns a SolrGenericResponse object.
150758     * @since PECL solr >= 0.9.2
150759     **/
150760    public function threads(){}
150761
150762    /**
150763     * Constructor for the SolrClient object
150764     *
150765     * @param array $clientOptions This is an array containing one of the
150766     *   following keys : - secure (Boolean value indicating whether or not
150767     *   to connect in secure mode) - hostname (The hostname for the Solr
150768     *   server) - port (The port number) - path (The path to solr) - wt (The
150769     *   name of the response writer e.g. xml, json) - login (The username
150770     *   used for HTTP Authentication, if any) - password (The HTTP
150771     *   Authentication password) - proxy_host (The hostname for the proxy
150772     *   server, if any) - proxy_port (The proxy port) - proxy_login (The
150773     *   proxy username) - proxy_password (The proxy password) - timeout
150774     *   (This is maximum time in seconds allowed for the http data transfer
150775     *   operation. Default is 30 seconds) - ssl_cert (File name to a
150776     *   PEM-formatted file containing the private key + private certificate
150777     *   (concatenated in that order) ) - ssl_key (File name to a
150778     *   PEM-formatted private key file only) - ssl_keypassword (Password for
150779     *   private key) - ssl_cainfo (Name of file holding one or more CA
150780     *   certificates to verify peer with) - ssl_capath (Name of directory
150781     *   holding multiple CA certificates to verify peer with ) Please note
150782     *   the if the ssl_cert file only contains the private certificate, you
150783     *   have to specify a separate ssl_key file The ssl_keypassword option
150784     *   is required if the ssl_cert or ssl_key options are set.
150785     * @since PECL solr >= 0.9.2
150786     **/
150787    public function __construct($clientOptions){}
150788
150789    /**
150790     * Destructor for SolrClient
150791     *
150792     * Destructor
150793     *
150794     * @return void Destructor for SolrClient
150795     * @since PECL solr >= 0.9.2
150796     **/
150797    public function __destruct(){}
150798
150799}
150800/**
150801 * An exception thrown when there is an error while making a request to
150802 * the server from the client.
150803 **/
150804class SolrClientException extends SolrException {
150805    /**
150806     * Returns internal information where the Exception was thrown
150807     *
150808     * @return array Returns an array containing internal information where
150809     *   the error was thrown. Used only for debugging by extension
150810     *   developers.
150811     * @since PECL solr >= 0.9.2
150812     **/
150813    public function getInternalInfo(){}
150814
150815}
150816class SolrCollapseFunction {
150817    /**
150818     * @var string
150819     **/
150820    const NULLPOLICY_COLLAPSE = '';
150821
150822    /**
150823     * @var string
150824     **/
150825    const NULLPOLICY_EXPAND = '';
150826
150827    /**
150828     * @var string
150829     **/
150830    const NULLPOLICY_IGNORE = '';
150831
150832    /**
150833     * Returns the field that is being collapsed on
150834     *
150835     * @return string
150836     * @since PECL solr >= 2.2.0
150837     **/
150838    public function getField(){}
150839
150840    /**
150841     * Returns collapse hint
150842     *
150843     * @return string
150844     * @since PECL solr >= 2.2.0
150845     **/
150846    public function getHint(){}
150847
150848    /**
150849     * Returns max parameter
150850     *
150851     * @return string
150852     * @since PECL solr >= 2.2.0
150853     **/
150854    public function getMax(){}
150855
150856    /**
150857     * Returns min parameter
150858     *
150859     * @return string
150860     * @since PECL solr >= 2.2.0
150861     **/
150862    public function getMin(){}
150863
150864    /**
150865     * Returns null policy
150866     *
150867     * Returns null policy used or null
150868     *
150869     * @return string
150870     * @since PECL solr >= 2.2.0
150871     **/
150872    public function getNullPolicy(){}
150873
150874    /**
150875     * Returns size parameter
150876     *
150877     * Gets the initial size of the collapse data structures when collapsing
150878     * on a numeric field only
150879     *
150880     * @return int
150881     * @since PECL solr >= 2.2.0
150882     **/
150883    public function getSize(){}
150884
150885    /**
150886     * Sets the field to collapse on
150887     *
150888     * The field name to collapse on. In order to collapse a result. The
150889     * field type must be a single valued String, Int or Float.
150890     *
150891     * @param string $fieldName
150892     * @return SolrCollapseFunction SolrCollapseFunction
150893     * @since PECL solr >= 2.2.0
150894     **/
150895    public function setField($fieldName){}
150896
150897    /**
150898     * Sets collapse hint
150899     *
150900     * @param string $hint Currently there is only one hint available
150901     *   "top_fc", which stands for top level FieldCache
150902     * @return SolrCollapseFunction SolrCollapseFunction
150903     * @since PECL solr >= 2.2.0
150904     **/
150905    public function setHint($hint){}
150906
150907    /**
150908     * Selects the group heads by the max value of a numeric field or
150909     * function query
150910     *
150911     * @param string $max
150912     * @return SolrCollapseFunction SolrCollapseFunction
150913     * @since PECL solr >= 2.2.0
150914     **/
150915    public function setMax($max){}
150916
150917    /**
150918     * Sets the initial size of the collapse data structures when collapsing
150919     * on a numeric field only
150920     *
150921     * @param string $min
150922     * @return SolrCollapseFunction SolrCollapseFunction
150923     * @since PECL solr >= 2.2.0
150924     **/
150925    public function setMin($min){}
150926
150927    /**
150928     * Sets the NULL Policy
150929     *
150930     * Sets the NULL Policy. One of the 3 policies defined as class constants
150931     * shall be passed. Accepts ignore, expand, or collapse policies.
150932     *
150933     * @param string $nullPolicy
150934     * @return SolrCollapseFunction SolrCollapseFunction
150935     * @since PECL solr >= 2.2.0
150936     **/
150937    public function setNullPolicy($nullPolicy){}
150938
150939    /**
150940     * Sets the initial size of the collapse data structures when collapsing
150941     * on a numeric field only
150942     *
150943     * @param int $size
150944     * @return SolrCollapseFunction SolrCollapseFunction
150945     * @since PECL solr >= 2.2.0
150946     **/
150947    public function setSize($size){}
150948
150949    /**
150950     * Returns a string representing the constructed collapse function
150951     *
150952     * @return string
150953     * @since PECL solr >= 2.2.0
150954     **/
150955    public function __toString(){}
150956
150957}
150958class SolrDisMaxQuery extends SolrQuery implements Serializable {
150959    /**
150960     * Used to specify that the facet should sort by count (Duplicated for
150961     * easier migration)
150962     *
150963     * @var mixed
150964     **/
150965    const FACET_SORT_COUNT = 0;
150966
150967    /**
150968     * Used to specify that the facet should sort by index (Duplicated for
150969     * easier migration)
150970     *
150971     * @var mixed
150972     **/
150973    const FACET_SORT_INDEX = 0;
150974
150975    /**
150976     * Used to specify that the sorting should be in acending order
150977     * (Duplicated for easier migration)
150978     *
150979     * @var mixed
150980     **/
150981    const ORDER_ASC = 0;
150982
150983    /**
150984     * Used to specify that the sorting should be in descending order
150985     * (Duplicated for easier migration)
150986     *
150987     * @var mixed
150988     **/
150989    const ORDER_DESC = 0;
150990
150991    /**
150992     * Used in the TermsComponent (Duplicated for easier migration)
150993     *
150994     * @var mixed
150995     **/
150996    const TERMS_SORT_COUNT = 0;
150997
150998    /**
150999     * Used in the TermsComponent (Duplicated for easier migration)
151000     *
151001     * @var mixed
151002     **/
151003    const TERMS_SORT_INDEX = 0;
151004
151005    /**
151006     * Adds a Phrase Bigram Field (pf2 parameter)
151007     *
151008     * Adds a Phrase Bigram Field (pf2 parameter) output format:
151009     * field~slop^boost OR field^boost Slop is optional
151010     *
151011     * @param string $field
151012     * @param string $boost
151013     * @param string $slop
151014     * @return SolrDisMaxQuery SolrDisMaxQuery
151015     **/
151016    public function addBigramPhraseField($field, $boost, $slop){}
151017
151018    /**
151019     * Adds a boost query field with value and optional boost (bq parameter)
151020     *
151021     * Adds a Boost Query field with value [and boost] (bq parameter)
151022     *
151023     * @param string $field
151024     * @param string $value
151025     * @param string $boost
151026     * @return SolrDisMaxQuery SolrDisMaxQuery
151027     **/
151028    public function addBoostQuery($field, $value, $boost){}
151029
151030    /**
151031     * Adds a Phrase Field (pf parameter)
151032     *
151033     * @param string $field field name
151034     * @param string $boost
151035     * @param string $slop
151036     * @return SolrDisMaxQuery SolrDisMaxQuery
151037     **/
151038    public function addPhraseField($field, $boost, $slop){}
151039
151040    /**
151041     * Add a query field with optional boost (qf parameter)
151042     *
151043     * @param string $field field name
151044     * @param string $boost Boost value. Boosts documents with matching
151045     *   terms.
151046     * @return SolrDisMaxQuery SolrDisMaxQuery
151047     **/
151048    public function addQueryField($field, $boost){}
151049
151050    /**
151051     * Adds a Trigram Phrase Field (pf3 parameter)
151052     *
151053     * @param string $field Field Name
151054     * @param string $boost Field Boost
151055     * @param string $slop Field Slop
151056     * @return SolrDisMaxQuery SolrDisMaxQuery
151057     **/
151058    public function addTrigramPhraseField($field, $boost, $slop){}
151059
151060    /**
151061     * Adds a field to User Fields Parameter (uf)
151062     *
151063     * Adds a field to The User Fields Parameter (uf)
151064     *
151065     * @param string $field Field Name
151066     * @return SolrDisMaxQuery SolrDisMaxQuery
151067     **/
151068    public function addUserField($field){}
151069
151070    /**
151071     * Removes phrase bigram field (pf2 parameter)
151072     *
151073     * Removes a Bigram Phrase Field (pf2 parameter) that was previously
151074     * added using SolrDisMaxQuery::addBigramPhraseField
151075     *
151076     * @param string $field The Field Name
151077     * @return SolrDisMaxQuery SolrDisMaxQuery
151078     **/
151079    public function removeBigramPhraseField($field){}
151080
151081    /**
151082     * Removes a boost query partial by field name (bq)
151083     *
151084     * Removes a boost query partial from the existing query, only if
151085     * SolrDisMaxQuery::addBoostQuery was used.
151086     *
151087     * @param string $field Field Name
151088     * @return SolrDisMaxQuery SolrDisMaxQuery
151089     **/
151090    public function removeBoostQuery($field){}
151091
151092    /**
151093     * Removes a Phrase Field (pf parameter)
151094     *
151095     * Removes a Phrase Field (pf parameter) that was previously added using
151096     * SolrDisMaxQuery::addPhraseField
151097     *
151098     * @param string $field Field Name
151099     * @return SolrDisMaxQuery SolrDisMaxQuery
151100     **/
151101    public function removePhraseField($field){}
151102
151103    /**
151104     * Removes a Query Field (qf parameter)
151105     *
151106     * Removes a Query Field (qf parameter) from the field list added by
151107     * SolrDisMaxQuery::addQueryField
151108     *
151109     * qf: When building DisjunctionMaxQueries from the user's query it
151110     * specifies the fields to search in, and boosts for those fields.
151111     *
151112     * @param string $field Field Name
151113     * @return SolrDisMaxQuery SolrDisMaxQuery
151114     **/
151115    public function removeQueryField($field){}
151116
151117    /**
151118     * Removes a Trigram Phrase Field (pf3 parameter)
151119     *
151120     * @param string $field Field Name
151121     * @return SolrDisMaxQuery SolrDisMaxQuery
151122     **/
151123    public function removeTrigramPhraseField($field){}
151124
151125    /**
151126     * Removes a field from The User Fields Parameter (uf)
151127     *
151128     * @param string $field Field Name
151129     * @return SolrDisMaxQuery SolrDisMaxQuery
151130     **/
151131    public function removeUserField($field){}
151132
151133    /**
151134     * Sets Bigram Phrase Fields and their boosts (and slops) using pf2
151135     * parameter
151136     *
151137     * Sets Bigram Phrase Fields (pf2) and their boosts (and slops)
151138     *
151139     * @param string $fields Fields boosts (slops)
151140     * @return SolrDisMaxQuery SolrDisMaxQuery
151141     **/
151142    public function setBigramPhraseFields($fields){}
151143
151144    /**
151145     * Sets Bigram Phrase Slop (ps2 parameter)
151146     *
151147     * Sets Bigram Phrase Slop (ps2 parameter). A default slop for Bigram
151148     * phrase fields.
151149     *
151150     * @param string $slop
151151     * @return SolrDisMaxQuery SolrDisMaxQuery
151152     **/
151153    public function setBigramPhraseSlop($slop){}
151154
151155    /**
151156     * Sets a Boost Function (bf parameter)
151157     *
151158     * Sets Boost Function (bf parameter).
151159     *
151160     * Functions (with optional boosts) that will be included in the user's
151161     * query to influence the score. Any function supported natively by Solr
151162     * can be used, along with a boost value. e.g.:
151163     *
151164     * recip(rord(myfield),1,2,3)^1.5
151165     *
151166     * @param string $function
151167     * @return SolrDisMaxQuery SolrDisMaxQuery
151168     **/
151169    public function setBoostFunction($function){}
151170
151171    /**
151172     * Directly Sets Boost Query Parameter (bq)
151173     *
151174     * Sets Boost Query Parameter (bq)
151175     *
151176     * @param string $q query
151177     * @return SolrDisMaxQuery SolrDisMaxQuery
151178     **/
151179    public function setBoostQuery($q){}
151180
151181    /**
151182     * Set Minimum "Should" Match (mm)
151183     *
151184     * Set Minimum "Should" Match parameter (mm). If the default query
151185     * operator is AND then mm=100%, if the default query operator (q.op) is
151186     * OR, then mm=0%.
151187     *
151188     * @param string $value Minimum match value/expression
151189     * @return SolrDisMaxQuery SolrDisMaxQuery
151190     **/
151191    public function setMinimumMatch($value){}
151192
151193    /**
151194     * Sets Phrase Fields and their boosts (and slops) using pf2 parameter
151195     *
151196     * Sets Phrase Fields (pf) and their boosts (and slops)
151197     *
151198     * @param string $fields Fields, boosts [, slops]
151199     * @return SolrDisMaxQuery SolrDisMaxQuery
151200     **/
151201    public function setPhraseFields($fields){}
151202
151203    /**
151204     * Sets the default slop on phrase queries (ps parameter)
151205     *
151206     * Sets the default amount of slop on phrase queries built with "pf",
151207     * "pf2" and/or "pf3" fields (affects boosting). "ps" parameter
151208     *
151209     * @param string $slop
151210     * @return SolrDisMaxQuery SolrDisMaxQuery
151211     **/
151212    public function setPhraseSlop($slop){}
151213
151214    /**
151215     * Set Query Alternate (q.alt parameter)
151216     *
151217     * When the main q parameter is not specified or is blank. The q.alt
151218     * parameter is used
151219     *
151220     * @param string $q Query String
151221     * @return SolrDisMaxQuery SolrDisMaxQuery
151222     **/
151223    public function setQueryAlt($q){}
151224
151225    /**
151226     * Specifies the amount of slop permitted on phrase queries explicitly
151227     * included in the user's query string (qf parameter)
151228     *
151229     * The Query Phrase Slop is the amount of slop permitted on phrase
151230     * queries explicitly included in the user's query string with the qf
151231     * parameter.
151232     *
151233     * slop refers to the number of positions one token needs to be moved in
151234     * relation to another token in order to match a phrase specified in a
151235     * query.
151236     *
151237     * @param string $slop Amount of slop
151238     * @return SolrDisMaxQuery SolrDisMaxQuery
151239     **/
151240    public function setQueryPhraseSlop($slop){}
151241
151242    /**
151243     * Sets Tie Breaker parameter (tie parameter)
151244     *
151245     * @param string $tieBreaker The tie parameter specifies a float value
151246     *   (which should be something much less than 1) to use as tiebreaker in
151247     *   DisMax queries.
151248     * @return SolrDisMaxQuery SolrDisMaxQuery
151249     **/
151250    public function setTieBreaker($tieBreaker){}
151251
151252    /**
151253     * Directly Sets Trigram Phrase Fields (pf3 parameter)
151254     *
151255     * @param string $fields Trigram Phrase Fields
151256     * @return SolrDisMaxQuery SolrDisMaxQuery
151257     **/
151258    public function setTrigramPhraseFields($fields){}
151259
151260    /**
151261     * Sets Trigram Phrase Slop (ps3 parameter)
151262     *
151263     * @param string $slop Phrase slop
151264     * @return SolrDisMaxQuery SolrDisMaxQuery
151265     **/
151266    public function setTrigramPhraseSlop($slop){}
151267
151268    /**
151269     * Sets User Fields parameter (uf)
151270     *
151271     * User Fields: Specifies which schema fields the end user shall be
151272     * allowed to query.
151273     *
151274     * @param string $fields Fields names separated by space This parameter
151275     *   supports wildcards.
151276     * @return SolrDisMaxQuery SolrDisMaxQuery
151277     **/
151278    public function setUserFields($fields){}
151279
151280    /**
151281     * Switch QueryParser to be DisMax Query Parser
151282     *
151283     * @return SolrDisMaxQuery SolrDisMaxQuery
151284     **/
151285    public function useDisMaxQueryParser(){}
151286
151287    /**
151288     * Switch QueryParser to be EDisMax
151289     *
151290     * Switch QueryParser to be EDisMax. By default the query builder uses
151291     * edismax, if it was switched using
151292     * SolrDisMaxQuery::useDisMaxQueryParser, it can be switched back using
151293     * this method.
151294     *
151295     * @return SolrDisMaxQuery SolrDisMaxQuery
151296     **/
151297    public function useEDisMaxQueryParser(){}
151298
151299    /**
151300     * Class Constructor
151301     *
151302     * Class constructor initializes the object and sets the q parameter if
151303     * passed
151304     *
151305     * @param string $q Search Query (q parameter)
151306     **/
151307    public function __construct($q){}
151308
151309}
151310/**
151311 * Represents a Solr document retrieved from a query response.
151312 **/
151313final class SolrDocument implements ArrayAccess, Iterator, Serializable {
151314    /**
151315     * @var integer
151316     **/
151317    const SORT_ASC = 0;
151318
151319    /**
151320     * @var integer
151321     **/
151322    const SORT_DEFAULT = 0;
151323
151324    /**
151325     * @var integer
151326     **/
151327    const SORT_DESC = 0;
151328
151329    /**
151330     * @var integer
151331     **/
151332    const SORT_FIELD_BOOST_VALUE = 0;
151333
151334    /**
151335     * @var integer
151336     **/
151337    const SORT_FIELD_NAME = 0;
151338
151339    /**
151340     * @var integer
151341     **/
151342    const SORT_FIELD_VALUE_COUNT = 0;
151343
151344    /**
151345     * Adds a field to the document
151346     *
151347     * This method adds a field to the SolrDocument instance.
151348     *
151349     * @param string $fieldName The name of the field
151350     * @param string $fieldValue The value of the field.
151351     * @return bool
151352     * @since PECL solr >= 0.9.2
151353     **/
151354    public function addField($fieldName, $fieldValue){}
151355
151356    /**
151357     * Drops all the fields in the document
151358     *
151359     * Resets the current object. Discards all the fields and resets the
151360     * document boost to zero.
151361     *
151362     * @return bool
151363     * @since PECL solr >= 0.9.2
151364     **/
151365    public function clear(){}
151366
151367    /**
151368     * Retrieves the current field
151369     *
151370     * @return SolrDocumentField Returns the field
151371     * @since PECL solr >= 0.9.2
151372     **/
151373    public function current(){}
151374
151375    /**
151376     * Removes a field from the document
151377     *
151378     * @param string $fieldName Name of the field
151379     * @return bool
151380     * @since PECL solr >= 0.9.2
151381     **/
151382    public function deleteField($fieldName){}
151383
151384    /**
151385     * Checks if a field exists in the document
151386     *
151387     * Checks if the requested field as a valid fieldname in the document.
151388     *
151389     * @param string $fieldName The name of the field.
151390     * @return bool Returns TRUE if the field is present and FALSE if it
151391     *   does not.
151392     * @since PECL solr >= 0.9.2
151393     **/
151394    public function fieldExists($fieldName){}
151395
151396    /**
151397     * Returns an array of child documents (SolrDocument)
151398     *
151399     * @return array
151400     * @since PECL solr >= 2.3.0
151401     **/
151402    public function getChildDocuments(){}
151403
151404    /**
151405     * Returns the number of child documents
151406     *
151407     * @return int
151408     * @since PECL solr >= 2.3.0
151409     **/
151410    public function getChildDocumentsCount(){}
151411
151412    /**
151413     * Retrieves a field by name
151414     *
151415     * @param string $fieldName Name of the field.
151416     * @return SolrDocumentField Returns a SolrDocumentField on success and
151417     *   FALSE on failure.
151418     * @since PECL solr >= 0.9.2
151419     **/
151420    public function getField($fieldName){}
151421
151422    /**
151423     * Returns the number of fields in this document
151424     *
151425     * Returns the number of fields in this document. Multi-value fields are
151426     * only counted once.
151427     *
151428     * @return int Returns an integer on success and FALSE on failure.
151429     * @since PECL solr >= 0.9.2
151430     **/
151431    public function getFieldCount(){}
151432
151433    /**
151434     * Returns an array of fields names in the document
151435     *
151436     * @return array Returns an array containing the names of the fields in
151437     *   this document.
151438     * @since PECL solr >= 0.9.2
151439     **/
151440    public function getFieldNames(){}
151441
151442    /**
151443     * Returns a SolrInputDocument equivalent of the object
151444     *
151445     * Returns a SolrInputDocument equivalent of the object. This is useful
151446     * if one wishes to resubmit/update a document retrieved from a query.
151447     *
151448     * @return SolrInputDocument Returns a SolrInputDocument on success and
151449     *   NULL on failure.
151450     * @since PECL solr >= 0.9.2
151451     **/
151452    public function getInputDocument(){}
151453
151454    /**
151455     * Checks whether the document has any child documents
151456     *
151457     * @return bool
151458     * @since PECL solr >= 2.3.0
151459     **/
151460    public function hasChildDocuments(){}
151461
151462    /**
151463     * Retrieves the current key
151464     *
151465     * @return string Returns the current key.
151466     * @since PECL solr >= 0.9.2
151467     **/
151468    public function key(){}
151469
151470    /**
151471     * Merges source to the current SolrDocument
151472     *
151473     * @param SolrDocument $sourceDoc The source document.
151474     * @param bool $overwrite If this is TRUE then fields with the same
151475     *   name in the destination document will be overwritten.
151476     * @return bool
151477     * @since PECL solr >= 0.9.2
151478     **/
151479    public function merge($sourceDoc, $overwrite){}
151480
151481    /**
151482     * Moves the internal pointer to the next field
151483     *
151484     * @return void This method has no return value.
151485     * @since PECL solr >= 0.9.2
151486     **/
151487    public function next(){}
151488
151489    /**
151490     * Checks if a particular field exists
151491     *
151492     * Checks if a particular field exists. This is used when the object is
151493     * treated as an array.
151494     *
151495     * @param string $fieldName The name of the field.
151496     * @return bool
151497     * @since PECL solr >= 0.9.2
151498     **/
151499    public function offsetExists($fieldName){}
151500
151501    /**
151502     * Retrieves a field
151503     *
151504     * This is used to retrieve the field when the object is treated as an
151505     * array.
151506     *
151507     * @param string $fieldName The name of the field.
151508     * @return SolrDocumentField Returns a SolrDocumentField object.
151509     * @since PECL solr >= 0.9.2
151510     **/
151511    public function offsetGet($fieldName){}
151512
151513    /**
151514     * Adds a field to the document
151515     *
151516     * Used when the object is treated as an array to add a field to the
151517     * document.
151518     *
151519     * @param string $fieldName The name of the field.
151520     * @param string $fieldValue The value for this field.
151521     * @return void
151522     * @since PECL solr >= 0.9.2
151523     **/
151524    public function offsetSet($fieldName, $fieldValue){}
151525
151526    /**
151527     * Removes a field
151528     *
151529     * Removes a field from the document.
151530     *
151531     * @param string $fieldName The name of the field.
151532     * @return void No return value.
151533     * @since PECL solr >= 0.9.2
151534     **/
151535    public function offsetUnset($fieldName){}
151536
151537    /**
151538     * This is an alias to SolrDocument::clear()
151539     *
151540     * @return bool
151541     * @since PECL solr >= 0.9.2
151542     **/
151543    public function reset(){}
151544
151545    /**
151546     * Resets the internal pointer to the beginning
151547     *
151548     * @return void This method has no return value.
151549     * @since PECL solr >= 0.9.2
151550     **/
151551    public function rewind(){}
151552
151553    /**
151554     * Used for custom serialization
151555     *
151556     * @return string Returns a string representing the serialized Solr
151557     *   document.
151558     * @since PECL solr >= 0.9.2
151559     **/
151560    public function serialize(){}
151561
151562    /**
151563     * Sorts the fields in the document
151564     *
151565     * The fields are rearranged according to the specified criteria and sort
151566     * direction Fields can be sorted by boost values, field names and number
151567     * of values. The sortOrderBy parameter must be one of : *
151568     * SolrDocument::SORT_FIELD_NAME * SolrDocument::SORT_FIELD_BOOST_VALUE *
151569     * SolrDocument::SORT_FIELD_VALUE_COUNT The sortDirection can be one of :
151570     * * SolrDocument::SORT_DEFAULT * SolrDocument::SORT_ASC *
151571     * SolrDocument::SORT_DESC The default way is to sort in ascending order.
151572     *
151573     * @param int $sortOrderBy The sort criteria.
151574     * @param int $sortDirection The sort direction.
151575     * @return bool
151576     * @since PECL solr >= 0.9.2
151577     **/
151578    public function sort($sortOrderBy, $sortDirection){}
151579
151580    /**
151581     * Returns an array representation of the document
151582     *
151583     * @return array Returns an array representation of the document.
151584     * @since PECL solr >= 0.9.2
151585     **/
151586    public function toArray(){}
151587
151588    /**
151589     * Custom serialization of SolrDocument objects
151590     *
151591     * @param string $serialized An XML representation of the document.
151592     * @return void None.
151593     * @since PECL solr >= 0.9.2
151594     **/
151595    public function unserialize($serialized){}
151596
151597    /**
151598     * Checks if the current position internally is still valid
151599     *
151600     * Checks if the current position internally is still valid. It is used
151601     * during foreach operations.
151602     *
151603     * @return bool Returns TRUE on success and FALSE if the current
151604     *   position is no longer valid.
151605     * @since PECL solr >= 0.9.2
151606     **/
151607    public function valid(){}
151608
151609    /**
151610     * Creates a copy of a SolrDocument object
151611     *
151612     * Creates a copy of a SolrDocument object. Not to be called directly.
151613     *
151614     * @return void None.
151615     * @since PECL solr >= 0.9.2
151616     **/
151617    public function __clone(){}
151618
151619    /**
151620     * Constructor
151621     *
151622     * Constructor for SolrDocument
151623     *
151624     * @since PECL solr >= 0.9.2
151625     **/
151626    public function __construct(){}
151627
151628    /**
151629     * Destructor
151630     *
151631     * Destructor for SolrDocument.
151632     *
151633     * @return void
151634     * @since PECL solr >= 0.9.2
151635     **/
151636    public function __destruct(){}
151637
151638    /**
151639     * Access the field as a property
151640     *
151641     * Magic method for accessing the field as a property.
151642     *
151643     * @param string $fieldName The name of the field.
151644     * @return SolrDocumentField Returns a SolrDocumentField instance.
151645     * @since PECL solr >= 0.9.2
151646     **/
151647    public function __get($fieldName){}
151648
151649    /**
151650     * Checks if a field exists
151651     *
151652     * @param string $fieldName Name of the field.
151653     * @return bool
151654     * @since PECL solr >= 0.9.2
151655     **/
151656    public function __isset($fieldName){}
151657
151658    /**
151659     * Adds another field to the document
151660     *
151661     * Adds another field to the document. Used to set the fields as new
151662     * properties.
151663     *
151664     * @param string $fieldName Name of the field.
151665     * @param string $fieldValue Field value.
151666     * @return bool
151667     * @since PECL solr >= 0.9.2
151668     **/
151669    public function __set($fieldName, $fieldValue){}
151670
151671    /**
151672     * Removes a field from the document
151673     *
151674     * Removes a field from the document when the field is access as an
151675     * object property.
151676     *
151677     * @param string $fieldName The name of the field.
151678     * @return bool
151679     * @since PECL solr >= 0.9.2
151680     **/
151681    public function __unset($fieldName){}
151682
151683}
151684/**
151685 * This represents a field in a Solr document. All its properties are
151686 * read-only.
151687 **/
151688final class SolrDocumentField {
151689    /**
151690     * The boost value for the field
151691     *
151692     * @var float
151693     **/
151694    public $boost;
151695
151696    /**
151697     * The name of the field.
151698     *
151699     * @var string
151700     **/
151701    public $name;
151702
151703    /**
151704     * An array of values for this field
151705     *
151706     * @var array
151707     **/
151708    public $values;
151709
151710    /**
151711     * Constructor
151712     *
151713     * @since PECL solr >= 0.9.2
151714     **/
151715    public function __construct(){}
151716
151717    /**
151718     * Destructor
151719     *
151720     * @return void None.
151721     * @since PECL solr >= 0.9.2
151722     **/
151723    public function __destruct(){}
151724
151725}
151726/**
151727 * This is the base class for all exception thrown by the Solr extension
151728 * classes.
151729 **/
151730class SolrException extends Exception {
151731    /**
151732     * The c-space source file where exception was generated
151733     *
151734     * @var string
151735     **/
151736    protected $sourcefile;
151737
151738    /**
151739     * The line in c-space source file where exception was generated
151740     *
151741     * @var integer
151742     **/
151743    protected $sourceline;
151744
151745    /**
151746     * @var string
151747     **/
151748    protected $zif_name;
151749
151750    /**
151751     * Returns internal information where the Exception was thrown
151752     *
151753     * @return array Returns an array containing internal information where
151754     *   the error was thrown. Used only for debugging by extension
151755     *   developers.
151756     * @since PECL solr >= 0.9.2
151757     **/
151758    public function getInternalInfo(){}
151759
151760}
151761/**
151762 * Represents a response from the solr server.
151763 **/
151764final class SolrGenericResponse extends SolrResponse {
151765    /**
151766     * @var integer
151767     **/
151768    const PARSE_SOLR_DOC = 0;
151769
151770    /**
151771     * @var integer
151772     **/
151773    const PARSE_SOLR_OBJ = 0;
151774
151775    /**
151776     * Constructor
151777     *
151778     * @since PECL solr >= 0.9.2
151779     **/
151780    public function __construct(){}
151781
151782    /**
151783     * Destructor
151784     *
151785     * @return void None
151786     * @since PECL solr >= 0.9.2
151787     **/
151788    public function __destruct(){}
151789
151790}
151791/**
151792 * This object is thrown when an illegal or invalid argument is passed to
151793 * a method.
151794 **/
151795class SolrIllegalArgumentException extends SolrException {
151796    /**
151797     * Returns internal information where the Exception was thrown
151798     *
151799     * @return array Returns an array containing internal information where
151800     *   the error was thrown. Used only for debugging by extension
151801     *   developers.
151802     * @since PECL solr >= 0.9.2
151803     **/
151804    public function getInternalInfo(){}
151805
151806}
151807/**
151808 * This object is thrown when an illegal or unsupported operation is
151809 * performed on an object.
151810 **/
151811class SolrIllegalOperationException extends SolrException {
151812    /**
151813     * Returns internal information where the Exception was thrown
151814     *
151815     * @return array Returns an array containing internal information where
151816     *   the error was thrown. Used only for debugging by extension
151817     *   developers.
151818     * @since PECL solr >= 0.9.2
151819     **/
151820    public function getInternalInfo(){}
151821
151822}
151823/**
151824 * This class represents a Solr document that is about to be submitted to
151825 * the Solr index.
151826 **/
151827final class SolrInputDocument {
151828    /**
151829     * @var integer
151830     **/
151831    const SORT_ASC = 0;
151832
151833    /**
151834     * @var integer
151835     **/
151836    const SORT_DEFAULT = 0;
151837
151838    /**
151839     * @var integer
151840     **/
151841    const SORT_DESC = 0;
151842
151843    /**
151844     * @var integer
151845     **/
151846    const SORT_FIELD_BOOST_VALUE = 0;
151847
151848    /**
151849     * @var integer
151850     **/
151851    const SORT_FIELD_NAME = 0;
151852
151853    /**
151854     * @var integer
151855     **/
151856    const SORT_FIELD_VALUE_COUNT = 0;
151857
151858    /**
151859     * Adds a child document for block indexing
151860     *
151861     * Adds a child document to construct a document block with nested
151862     * documents.
151863     *
151864     * @param SolrInputDocument $child A SolrInputDocument object.
151865     * @return void
151866     * @since PECL solr >= 2.3.0
151867     **/
151868    public function addChildDocument($child){}
151869
151870    /**
151871     * Adds an array of child documents
151872     *
151873     * Adds an array of child documents to the current input document.
151874     *
151875     * @param array $docs An array of SolrInputDocument objects.
151876     * @return void
151877     * @since PECL solr >= 2.3.0
151878     **/
151879    public function addChildDocuments(&$docs){}
151880
151881    /**
151882     * Adds a field to the document
151883     *
151884     * For multi-value fields, if a valid boost value is specified, the
151885     * specified value will be multiplied by the current boost value for this
151886     * field.
151887     *
151888     * @param string $fieldName The name of the field
151889     * @param string $fieldValue The value for the field.
151890     * @param float $fieldBoostValue The index time boost for the field.
151891     *   Though this cannot be negative, you can still pass values less than
151892     *   1.0 but they must be greater than zero.
151893     * @return bool
151894     * @since PECL solr >= 0.9.2
151895     **/
151896    public function addField($fieldName, $fieldValue, $fieldBoostValue){}
151897
151898    /**
151899     * Resets the input document
151900     *
151901     * Resets the document by dropping all the fields and resets the document
151902     * boost to zero.
151903     *
151904     * @return bool
151905     * @since PECL solr >= 0.9.2
151906     **/
151907    public function clear(){}
151908
151909    /**
151910     * Removes a field from the document
151911     *
151912     * @param string $fieldName The name of the field.
151913     * @return bool
151914     * @since PECL solr >= 0.9.2
151915     **/
151916    public function deleteField($fieldName){}
151917
151918    /**
151919     * Checks if a field exists
151920     *
151921     * @param string $fieldName Name of the field.
151922     * @return bool Returns TRUE if the field was found and FALSE if it was
151923     *   not found.
151924     * @since PECL solr >= 0.9.2
151925     **/
151926    public function fieldExists($fieldName){}
151927
151928    /**
151929     * Retrieves the current boost value for the document
151930     *
151931     * @return float Returns the boost value on success and FALSE on
151932     *   failure.
151933     * @since PECL solr >= 0.9.2
151934     **/
151935    public function getBoost(){}
151936
151937    /**
151938     * Returns an array of child documents (SolrInputDocument)
151939     *
151940     * @return array
151941     * @since PECL solr >= 2.3.0
151942     **/
151943    public function getChildDocuments(){}
151944
151945    /**
151946     * Returns the number of child documents
151947     *
151948     * @return int
151949     * @since PECL solr >= 2.3.0
151950     **/
151951    public function getChildDocumentsCount(){}
151952
151953    /**
151954     * Retrieves a field by name
151955     *
151956     * Retrieves a field in the document.
151957     *
151958     * @param string $fieldName The name of the field.
151959     * @return SolrDocumentField Returns a SolrDocumentField object on
151960     *   success and FALSE on failure.
151961     * @since PECL solr >= 0.9.2
151962     **/
151963    public function getField($fieldName){}
151964
151965    /**
151966     * Retrieves the boost value for a particular field
151967     *
151968     * @param string $fieldName The name of the field.
151969     * @return float Returns the boost value for the field or FALSE if
151970     *   there was an error.
151971     * @since PECL solr >= 0.9.2
151972     **/
151973    public function getFieldBoost($fieldName){}
151974
151975    /**
151976     * Returns the number of fields in the document
151977     *
151978     * @return int Returns an integer on success.
151979     * @since PECL solr >= 0.9.2
151980     **/
151981    public function getFieldCount(){}
151982
151983    /**
151984     * Returns an array containing all the fields in the document
151985     *
151986     * @return array Returns an array on success and FALSE on failure.
151987     * @since PECL solr >= 0.9.2
151988     **/
151989    public function getFieldNames(){}
151990
151991    /**
151992     * Returns true if the document has any child documents
151993     *
151994     * Checks whether the document has any child documents
151995     *
151996     * @return bool
151997     * @since PECL solr >= 2.3.0
151998     **/
151999    public function hasChildDocuments(){}
152000
152001    /**
152002     * Merges one input document into another
152003     *
152004     * @param SolrInputDocument $sourceDoc The source document.
152005     * @param bool $overwrite If this is TRUE it will replace matching
152006     *   fields in the destination document.
152007     * @return bool In the future, this will be modified to return the
152008     *   number of fields in the new document.
152009     * @since PECL solr >= 0.9.2
152010     **/
152011    public function merge($sourceDoc, $overwrite){}
152012
152013    /**
152014     * This is an alias of SolrInputDocument::clear
152015     *
152016     * @return bool
152017     * @since PECL solr >= 0.9.2
152018     **/
152019    public function reset(){}
152020
152021    /**
152022     * Sets the boost value for this document
152023     *
152024     * @param float $documentBoostValue The index-time boost value for this
152025     *   document.
152026     * @return bool
152027     * @since PECL solr >= 0.9.2
152028     **/
152029    public function setBoost($documentBoostValue){}
152030
152031    /**
152032     * Sets the index-time boost value for a field
152033     *
152034     * Sets the index-time boost value for a field. This replaces the current
152035     * boost value for this field.
152036     *
152037     * @param string $fieldName The name of the field.
152038     * @param float $fieldBoostValue The index time boost value.
152039     * @return bool
152040     * @since PECL solr >= 0.9.2
152041     **/
152042    public function setFieldBoost($fieldName, $fieldBoostValue){}
152043
152044    /**
152045     * Sorts the fields within the document
152046     *
152047     * The fields are rearranged according to the specified criteria and sort
152048     * direction Fields can be sorted by boost values, field names and number
152049     * of values. The $order_by parameter must be one of : *
152050     * SolrInputDocument::SORT_FIELD_NAME *
152051     * SolrInputDocument::SORT_FIELD_BOOST_VALUE *
152052     * SolrInputDocument::SORT_FIELD_VALUE_COUNT The sort direction can be
152053     * one of : * SolrInputDocument::SORT_DEFAULT *
152054     * SolrInputDocument::SORT_ASC * SolrInputDocument::SORT_DESC
152055     *
152056     * @param int $sortOrderBy The sort criteria
152057     * @param int $sortDirection The sort direction
152058     * @return bool
152059     * @since PECL solr >= 0.9.2
152060     **/
152061    public function sort($sortOrderBy, $sortDirection){}
152062
152063    /**
152064     * Returns an array representation of the input document
152065     *
152066     * @return array Returns an array containing the fields. It returns
152067     *   FALSE on failure.
152068     * @since PECL solr >= 0.9.2
152069     **/
152070    public function toArray(){}
152071
152072    /**
152073     * Creates a copy of a SolrDocument
152074     *
152075     * Should not be called directly. It is used to create a deep copy of a
152076     * SolrInputDocument.
152077     *
152078     * @return void Creates a new SolrInputDocument instance.
152079     * @since PECL solr >= 0.9.2
152080     **/
152081    public function __clone(){}
152082
152083    /**
152084     * Constructor
152085     *
152086     * @since PECL solr >= 0.9.2
152087     **/
152088    public function __construct(){}
152089
152090    /**
152091     * Destructor
152092     *
152093     * @return void None.
152094     * @since PECL solr >= 0.9.2
152095     **/
152096    public function __destruct(){}
152097
152098}
152099class SolrMissingMandatoryParameterException extends SolrException {
152100}
152101/**
152102 * Represents a collection of name-value pairs sent to the Solr server
152103 * during a request.
152104 **/
152105class SolrModifiableParams extends SolrParams implements Serializable {
152106    /**
152107     * Constructor
152108     *
152109     * @since PECL solr >= 0.9.2
152110     **/
152111    public function __construct(){}
152112
152113    /**
152114     * Destructor
152115     *
152116     * @return void None
152117     * @since PECL solr >= 0.9.2
152118     **/
152119    public function __destruct(){}
152120
152121}
152122/**
152123 * This is an object whose properties can also by accessed using the
152124 * array syntax. All its properties are read-only.
152125 **/
152126final class SolrObject implements ArrayAccess {
152127    /**
152128     * Returns an array of all the names of the properties
152129     *
152130     * @return array Returns an array.
152131     * @since PECL solr >= 0.9.2
152132     **/
152133    public function getPropertyNames(){}
152134
152135    /**
152136     * Checks if the property exists
152137     *
152138     * Checks if the property exists. This is used when the object is treated
152139     * as an array.
152140     *
152141     * @param string $property_name The name of the property.
152142     * @return bool
152143     * @since PECL solr >= 0.9.2
152144     **/
152145    public function offsetExists($property_name){}
152146
152147    /**
152148     * Used to retrieve a property
152149     *
152150     * Used to get the value of a property. This is used when the object is
152151     * treated as an array.
152152     *
152153     * @param string $property_name Name of the property.
152154     * @return mixed Returns the property value.
152155     * @since PECL solr >= 0.9.2
152156     **/
152157    public function offsetGet($property_name){}
152158
152159    /**
152160     * Sets the value for a property
152161     *
152162     * Sets the value for a property. This is used when the object is treated
152163     * as an array. This object is read-only. This should never be attempted.
152164     *
152165     * @param string $property_name The name of the property.
152166     * @param string $property_value The new value.
152167     * @return void None.
152168     * @since PECL solr >= 0.9.2
152169     **/
152170    public function offsetSet($property_name, $property_value){}
152171
152172    /**
152173     * Unsets the value for the property
152174     *
152175     * Unsets the value for the property. This is used when the object is
152176     * treated as an array. This object is read-only. This should never be
152177     * attempted.
152178     *
152179     * @param string $property_name The name of the property.
152180     * @return void
152181     * @since PECL solr >= 0.9.2
152182     **/
152183    public function offsetUnset($property_name){}
152184
152185    /**
152186     * Creates Solr object
152187     *
152188     * @since PECL solr >= 0.9.2
152189     **/
152190    public function __construct(){}
152191
152192    /**
152193     * Destructor
152194     *
152195     * The destructor
152196     *
152197     * @return void None.
152198     * @since PECL solr >= 0.9.2
152199     **/
152200    public function __destruct(){}
152201
152202}
152203/**
152204 * Represents a collection of name-value pairs sent to the Solr server
152205 * during a request.
152206 **/
152207abstract class SolrParams implements Serializable {
152208    /**
152209     * This is an alias for SolrParams::addParam
152210     *
152211     * @param string $name The name of the parameter
152212     * @param string $value The value of the parameter
152213     * @return SolrParams Returns a SolrParams instance on success
152214     * @since PECL solr >= 0.9.2
152215     **/
152216    final public function add($name, $value){}
152217
152218    /**
152219     * Adds a parameter to the object
152220     *
152221     * Adds a parameter to the object. This is used for parameters that can
152222     * be specified multiple times.
152223     *
152224     * @param string $name Name of parameter
152225     * @param string $value Value of parameter
152226     * @return SolrParams Returns a SolrParam object on success and FALSE
152227     *   on failure.
152228     * @since PECL solr >= 0.9.2
152229     **/
152230    public function addParam($name, $value){}
152231
152232    /**
152233     * This is an alias for SolrParams::getParam
152234     *
152235     * @param string $param_name Then name of the parameter
152236     * @return mixed Returns an array or string depending on the type of
152237     *   parameter
152238     * @since PECL solr >= 0.9.2
152239     **/
152240    final public function get($param_name){}
152241
152242    /**
152243     * Returns a parameter value
152244     *
152245     * Returns a parameter with name param_name
152246     *
152247     * @param string $param_name The name of the parameter
152248     * @return mixed Returns a string or an array depending on the type of
152249     *   the parameter
152250     * @since PECL solr >= 0.9.2
152251     **/
152252    final public function getParam($param_name){}
152253
152254    /**
152255     * Returns an array of non URL-encoded parameters
152256     *
152257     * @return array Returns an array of non URL-encoded parameters
152258     * @since PECL solr >= 0.9.2
152259     **/
152260    final public function getParams(){}
152261
152262    /**
152263     * Returns an array of URL-encoded parameters
152264     *
152265     * Returns an array on URL-encoded parameters
152266     *
152267     * @return array Returns an array on URL-encoded parameters
152268     * @since PECL solr >= 0.9.2
152269     **/
152270    final public function getPreparedParams(){}
152271
152272    /**
152273     * Used for custom serialization
152274     *
152275     * @return string Used for custom serialization
152276     * @since PECL solr >= 0.9.2
152277     **/
152278    final public function serialize(){}
152279
152280    /**
152281     * An alias of SolrParams::setParam
152282     *
152283     * @param string $name Then name of the parameter
152284     * @param string $value The parameter value
152285     * @return void Returns an instance of the SolrParams object on success
152286     * @since PECL solr >= 0.9.2
152287     **/
152288    final public function set($name, $value){}
152289
152290    /**
152291     * Sets the parameter to the specified value
152292     *
152293     * Sets the query parameter to the specified value. This is used for
152294     * parameters that can only be specified once. Subsequent calls with the
152295     * same parameter name will override the existing value
152296     *
152297     * @param string $name Name of the parameter
152298     * @param string $value Value of the parameter
152299     * @return SolrParams Returns a SolrParam object on success and FALSE
152300     *   on value.
152301     * @since PECL solr >= 0.9.2
152302     **/
152303    public function setParam($name, $value){}
152304
152305    /**
152306     * Returns all the name-value pair parameters in the object
152307     *
152308     * @param bool $url_encode Whether to return URL-encoded values
152309     * @return string Returns a string on success and FALSE on failure.
152310     * @since PECL solr >= 0.9.2
152311     **/
152312    final public function toString($url_encode){}
152313
152314    /**
152315     * Used for custom serialization
152316     *
152317     * @param string $serialized The serialized representation of the
152318     *   object
152319     * @return void None
152320     * @since PECL solr >= 0.9.2
152321     **/
152322    final public function unserialize($serialized){}
152323
152324}
152325/**
152326 * Represents a response to a ping request to the server
152327 **/
152328final class SolrPingResponse extends SolrResponse {
152329    /**
152330     * @var integer
152331     **/
152332    const PARSE_SOLR_DOC = 0;
152333
152334    /**
152335     * @var integer
152336     **/
152337    const PARSE_SOLR_OBJ = 0;
152338
152339    /**
152340     * Returns the response from the server
152341     *
152342     * Returns the response from the server. This should be empty because the
152343     * request as a HEAD request.
152344     *
152345     * @return string Returns an empty string.
152346     * @since PECL solr >= 0.9.2
152347     **/
152348    public function getResponse(){}
152349
152350    /**
152351     * Constructor
152352     *
152353     * @since PECL solr >= 0.9.2
152354     **/
152355    public function __construct(){}
152356
152357    /**
152358     * Destructor
152359     *
152360     * @return void None
152361     * @since PECL solr >= 0.9.2
152362     **/
152363    public function __destruct(){}
152364
152365}
152366/**
152367 * Represents a collection of name-value pairs sent to the Solr server
152368 * during a request.
152369 **/
152370class SolrQuery extends SolrModifiableParams implements Serializable {
152371    /**
152372     * @var integer
152373     **/
152374    const FACET_SORT_COUNT = 0;
152375
152376    /**
152377     * @var integer
152378     **/
152379    const FACET_SORT_INDEX = 0;
152380
152381    /**
152382     * @var integer
152383     **/
152384    const ORDER_ASC = 0;
152385
152386    /**
152387     * @var integer
152388     **/
152389    const ORDER_DESC = 0;
152390
152391    /**
152392     * @var integer
152393     **/
152394    const TERMS_SORT_COUNT = 0;
152395
152396    /**
152397     * @var integer
152398     **/
152399    const TERMS_SORT_INDEX = 0;
152400
152401    /**
152402     * Overrides main filter query, determines which documents to include in
152403     * the main group
152404     *
152405     * @param string $fq
152406     * @return SolrQuery SolrQuery
152407     * @since PECL solr >= 2.2.0
152408     **/
152409    public function addExpandFilterQuery($fq){}
152410
152411    /**
152412     * Orders the documents within the expanded groups (expand.sort
152413     * parameter)
152414     *
152415     * @param string $field field name
152416     * @param string $order Order ASC/DESC, utilizes SolrQuery::ORDER_*
152417     *   constants. Default: SolrQuery::ORDER_DESC
152418     * @return SolrQuery SolrQuery
152419     * @since PECL solr >= 2.2.0
152420     **/
152421    public function addExpandSortField($field, $order){}
152422
152423    /**
152424     * Maps to facet.date
152425     *
152426     * This method allows you to specify a field which should be treated as a
152427     * facet.
152428     *
152429     * It can be used multiple times with different field names to indicate
152430     * multiple facet fields
152431     *
152432     * @param string $dateField The name of the date field.
152433     * @return SolrQuery Returns a SolrQuery object.
152434     * @since PECL solr >= 0.9.2
152435     **/
152436    public function addFacetDateField($dateField){}
152437
152438    /**
152439     * Adds another facet.date.other parameter
152440     *
152441     * Sets the facet.date.other parameter. Accepts an optional field
152442     * override
152443     *
152444     * @param string $value The value to use.
152445     * @param string $field_override The field name for the override.
152446     * @return SolrQuery Returns the current SolrQuery object, if the
152447     *   return value is used.
152448     * @since PECL solr >= 0.9.2
152449     **/
152450    public function addFacetDateOther($value, $field_override){}
152451
152452    /**
152453     * Adds another field to the facet
152454     *
152455     * @param string $field The name of the field
152456     * @return SolrQuery Returns the current SolrQuery object, if the
152457     *   return value is used.
152458     * @since PECL solr >= 0.9.2
152459     **/
152460    public function addFacetField($field){}
152461
152462    /**
152463     * Adds a facet query
152464     *
152465     * @param string $facetQuery The facet query
152466     * @return SolrQuery Returns the current SolrQuery object, if the
152467     *   return value is used.
152468     * @since PECL solr >= 0.9.2
152469     **/
152470    public function addFacetQuery($facetQuery){}
152471
152472    /**
152473     * Specifies which fields to return in the result
152474     *
152475     * This method is used to used to specify a set of fields to return,
152476     * thereby restricting the amount of data returned in the response.
152477     *
152478     * It should be called multiple time, once for each field name.
152479     *
152480     * @param string $field The name of the field
152481     * @return SolrQuery Returns the current SolrQuery object
152482     * @since PECL solr >= 0.9.2
152483     **/
152484    public function addField($field){}
152485
152486    /**
152487     * Specifies a filter query
152488     *
152489     * @param string $fq The filter query
152490     * @return SolrQuery Returns the current SolrQuery object.
152491     * @since PECL solr >= 0.9.2
152492     **/
152493    public function addFilterQuery($fq){}
152494
152495    /**
152496     * Add a field to be used to group results
152497     *
152498     * The name of the field by which to group results. The field must be
152499     * single-valued, and either be indexed or a field type that has a value
152500     * source and works in a function query, such as ExternalFileField. It
152501     * must also be a string-based field, such as StrField or TextField Uses
152502     * group.field parameter
152503     *
152504     * @param string $value
152505     * @return SolrQuery
152506     * @since PECL solr >= 2.2.0
152507     **/
152508    public function addGroupField($value){}
152509
152510    /**
152511     * Allows grouping results based on the unique values of a function query
152512     * (group.func parameter)
152513     *
152514     * Adds a group function (group.func parameter) Allows grouping results
152515     * based on the unique values of a function query.
152516     *
152517     * @param string $value
152518     * @return SolrQuery SolrQuery
152519     * @since PECL solr >= 2.2.0
152520     **/
152521    public function addGroupFunction($value){}
152522
152523    /**
152524     * Allows grouping of documents that match the given query
152525     *
152526     * Allows grouping of documents that match the given query. Adds query to
152527     * the group.query parameter
152528     *
152529     * @param string $value
152530     * @return SolrQuery SolrQuery
152531     * @since PECL solr >= 2.2.0
152532     **/
152533    public function addGroupQuery($value){}
152534
152535    /**
152536     * Add a group sort field (group.sort parameter)
152537     *
152538     * Allow sorting group documents, using group sort field (group.sort
152539     * parameter).
152540     *
152541     * @param string $field Field name
152542     * @param int $order Order ASC/DESC, utilizes SolrQuery::ORDER_*
152543     *   constants
152544     * @return SolrQuery
152545     * @since PECL solr >= 2.2.0
152546     **/
152547    public function addGroupSortField($field, $order){}
152548
152549    /**
152550     * Maps to hl.fl
152551     *
152552     * Maps to hl.fl. This is used to specify that highlighted snippets
152553     * should be generated for a particular field
152554     *
152555     * @param string $field Name of the field
152556     * @return SolrQuery Returns the current SolrQuery object, if the
152557     *   return value is used.
152558     * @since PECL solr >= 0.9.2
152559     **/
152560    public function addHighlightField($field){}
152561
152562    /**
152563     * Sets a field to use for similarity
152564     *
152565     * Maps to mlt.fl. It specifies that a field should be used for
152566     * similarity.
152567     *
152568     * @param string $field The name of the field
152569     * @return SolrQuery Returns the current SolrQuery object, if the
152570     *   return value is used.
152571     * @since PECL solr >= 0.9.2
152572     **/
152573    public function addMltField($field){}
152574
152575    /**
152576     * Maps to mlt.qf
152577     *
152578     * Maps to mlt.qf. It is used to specify query fields and their boosts
152579     *
152580     * @param string $field The name of the field
152581     * @param float $boost Its boost value
152582     * @return SolrQuery Returns the current SolrQuery object, if the
152583     *   return value is used.
152584     * @since PECL solr >= 0.9.2
152585     **/
152586    public function addMltQueryField($field, $boost){}
152587
152588    /**
152589     * Used to control how the results should be sorted
152590     *
152591     * @param string $field The name of the field
152592     * @param int $order The sort direction. This should be either
152593     *   SolrQuery::ORDER_ASC or SolrQuery::ORDER_DESC.
152594     * @return SolrQuery Returns the current SolrQuery object.
152595     * @since PECL solr >= 0.9.2
152596     **/
152597    public function addSortField($field, $order){}
152598
152599    /**
152600     * Requests a return of sub results for values within the given facet
152601     *
152602     * Requests a return of sub results for values within the given facet.
152603     * Maps to the stats.facet field
152604     *
152605     * @param string $field The name of the field
152606     * @return SolrQuery Returns the current SolrQuery object, if the
152607     *   return value is used.
152608     * @since PECL solr >= 0.9.2
152609     **/
152610    public function addStatsFacet($field){}
152611
152612    /**
152613     * Maps to stats.field parameter
152614     *
152615     * Maps to stats.field parameter This methods adds another stats.field
152616     * parameter.
152617     *
152618     * @param string $field The name of the field
152619     * @return SolrQuery Returns the current SolrQuery object, if the
152620     *   return value is used.
152621     * @since PECL solr >= 0.9.2
152622     **/
152623    public function addStatsField($field){}
152624
152625    /**
152626     * Collapses the result set to a single document per group
152627     *
152628     * Collapses the result set to a single document per group before it
152629     * forwards the result set to the rest of the search components.
152630     *
152631     * So all downstream components (faceting, highlighting, etc...) will
152632     * work with the collapsed result set.
152633     *
152634     * @param SolrCollapseFunction $collapseFunction
152635     * @return SolrQuery Returns the current SolrQuery object
152636     **/
152637    public function collapse($collapseFunction){}
152638
152639    /**
152640     * Returns true if group expanding is enabled
152641     *
152642     * Returns TRUE if group expanding is enabled
152643     *
152644     * @return bool
152645     * @since PECL solr >= 2.2.0
152646     **/
152647    public function getExpand(){}
152648
152649    /**
152650     * Returns the expand filter queries
152651     *
152652     * @return array
152653     * @since PECL solr >= 2.2.0
152654     **/
152655    public function getExpandFilterQueries(){}
152656
152657    /**
152658     * Returns the expand query expand.q parameter
152659     *
152660     * @return array
152661     * @since PECL solr >= 2.2.0
152662     **/
152663    public function getExpandQuery(){}
152664
152665    /**
152666     * Returns The number of rows to display in each group (expand.rows)
152667     *
152668     * @return int
152669     * @since PECL solr >= 2.2.0
152670     **/
152671    public function getExpandRows(){}
152672
152673    /**
152674     * Returns an array of fields
152675     *
152676     * @return array
152677     * @since PECL solr >= 2.2.0
152678     **/
152679    public function getExpandSortFields(){}
152680
152681    /**
152682     * Returns the value of the facet parameter
152683     *
152684     * @return bool Returns a boolean on success and NULL if not set
152685     * @since PECL solr >= 0.9.2
152686     **/
152687    public function getFacet(){}
152688
152689    /**
152690     * Returns the value for the facet.date.end parameter
152691     *
152692     * Returns the value for the facet.date.end parameter. This method
152693     * accepts an optional field override
152694     *
152695     * @param string $field_override The name of the field
152696     * @return string Returns a string on success and NULL if not set
152697     * @since PECL solr >= 0.9.2
152698     **/
152699    public function getFacetDateEnd($field_override){}
152700
152701    /**
152702     * Returns all the facet.date fields
152703     *
152704     * @return array Returns all the facet.date fields as an array or NULL
152705     *   if none was set
152706     * @since PECL solr >= 0.9.2
152707     **/
152708    public function getFacetDateFields(){}
152709
152710    /**
152711     * Returns the value of the facet.date.gap parameter
152712     *
152713     * Returns the value of the facet.date.gap parameter. It accepts an
152714     * optional field override
152715     *
152716     * @param string $field_override The name of the field
152717     * @return string Returns a string on success and NULL if not set
152718     * @since PECL solr >= 0.9.2
152719     **/
152720    public function getFacetDateGap($field_override){}
152721
152722    /**
152723     * Returns the value of the facet.date.hardend parameter
152724     *
152725     * Returns the value of the facet.date.hardend parameter. Accepts an
152726     * optional field override
152727     *
152728     * @param string $field_override The name of the field
152729     * @return string Returns a string on success and NULL if not set
152730     * @since PECL solr >= 0.9.2
152731     **/
152732    public function getFacetDateHardEnd($field_override){}
152733
152734    /**
152735     * Returns the value for the facet.date.other parameter
152736     *
152737     * Returns the value for the facet.date.other parameter. This method
152738     * accepts an optional field override.
152739     *
152740     * @param string $field_override The name of the field
152741     * @return array Returns an on success and NULL if not set.
152742     * @since PECL solr >= 0.9.2
152743     **/
152744    public function getFacetDateOther($field_override){}
152745
152746    /**
152747     * Returns the lower bound for the first date range for all date faceting
152748     * on this field
152749     *
152750     * Returns the lower bound for the first date range for all date faceting
152751     * on this field. Accepts an optional field override
152752     *
152753     * @param string $field_override The name of the field
152754     * @return string Returns a string on success and NULL if not set
152755     * @since PECL solr >= 0.9.2
152756     **/
152757    public function getFacetDateStart($field_override){}
152758
152759    /**
152760     * Returns all the facet fields
152761     *
152762     * @return array Returns an array of all the fields and NULL if none
152763     *   was set
152764     * @since PECL solr >= 0.9.2
152765     **/
152766    public function getFacetFields(){}
152767
152768    /**
152769     * Returns the maximum number of constraint counts that should be
152770     * returned for the facet fields
152771     *
152772     * Returns the maximum number of constraint counts that should be
152773     * returned for the facet fields. This method accepts an optional field
152774     * override
152775     *
152776     * @param string $field_override The name of the field to override for
152777     * @return int Returns an integer on success and NULL if not set
152778     * @since PECL solr >= 0.9.2
152779     **/
152780    public function getFacetLimit($field_override){}
152781
152782    /**
152783     * Returns the value of the facet.method parameter
152784     *
152785     * Returns the value of the facet.method parameter. This accepts an
152786     * optional field override.
152787     *
152788     * @param string $field_override The name of the field
152789     * @return string Returns a string on success and NULL if not set
152790     * @since PECL solr >= 0.9.2
152791     **/
152792    public function getFacetMethod($field_override){}
152793
152794    /**
152795     * Returns the minimum counts for facet fields should be included in the
152796     * response
152797     *
152798     * Returns the minimum counts for facet fields should be included in the
152799     * response. It accepts an optional field override
152800     *
152801     * @param string $field_override The name of the field
152802     * @return int Returns an integer on success and NULL if not set
152803     * @since PECL solr >= 0.9.2
152804     **/
152805    public function getFacetMinCount($field_override){}
152806
152807    /**
152808     * Returns the current state of the facet.missing parameter
152809     *
152810     * Returns the current state of the facet.missing parameter. This accepts
152811     * an optional field override
152812     *
152813     * @param string $field_override The name of the field
152814     * @return bool Returns a boolean on success and NULL if not set
152815     * @since PECL solr >= 0.9.2
152816     **/
152817    public function getFacetMissing($field_override){}
152818
152819    /**
152820     * Returns an offset into the list of constraints to be used for
152821     * pagination
152822     *
152823     * Returns an offset into the list of constraints to be used for
152824     * pagination. Accepts an optional field override
152825     *
152826     * @param string $field_override The name of the field to override for.
152827     * @return int Returns an integer on success and NULL if not set
152828     * @since PECL solr >= 0.9.2
152829     **/
152830    public function getFacetOffset($field_override){}
152831
152832    /**
152833     * Returns the facet prefix
152834     *
152835     * @param string $field_override The name of the field
152836     * @return string Returns a string on success and NULL if not set.
152837     * @since PECL solr >= 0.9.2
152838     **/
152839    public function getFacetPrefix($field_override){}
152840
152841    /**
152842     * Returns all the facet queries
152843     *
152844     * @return array Returns an array on success and NULL if not set.
152845     * @since PECL solr >= 0.9.2
152846     **/
152847    public function getFacetQueries(){}
152848
152849    /**
152850     * Returns the facet sort type
152851     *
152852     * Returns an integer (SolrQuery::FACET_SORT_INDEX or
152853     * SolrQuery::FACET_SORT_COUNT)
152854     *
152855     * @param string $field_override The name of the field
152856     * @return int Returns an integer (SolrQuery::FACET_SORT_INDEX or
152857     *   SolrQuery::FACET_SORT_COUNT) on success or NULL if not set.
152858     * @since PECL solr >= 0.9.2
152859     **/
152860    public function getFacetSort($field_override){}
152861
152862    /**
152863     * Returns the list of fields that will be returned in the response
152864     *
152865     * @return array Returns an array on success and NULL if not set.
152866     * @since PECL solr >= 0.9.2
152867     **/
152868    public function getFields(){}
152869
152870    /**
152871     * Returns an array of filter queries
152872     *
152873     * Returns an array of filter queries. These are queries that can be used
152874     * to restrict the super set of documents that can be returned, without
152875     * influencing score
152876     *
152877     * @return array Returns an array on success and NULL if not set.
152878     * @since PECL solr >= 0.9.2
152879     **/
152880    public function getFilterQueries(){}
152881
152882    /**
152883     * Returns true if grouping is enabled
152884     *
152885     * @return bool
152886     * @since PECL solr >= 2.2.0
152887     **/
152888    public function getGroup(){}
152889
152890    /**
152891     * Returns group cache percent value
152892     *
152893     * @return int
152894     * @since PECL solr >= 2.2.0
152895     **/
152896    public function getGroupCachePercent(){}
152897
152898    /**
152899     * Returns the group.facet parameter value
152900     *
152901     * @return bool
152902     * @since PECL solr >= 2.2.0
152903     **/
152904    public function getGroupFacet(){}
152905
152906    /**
152907     * Returns group fields (group.field parameter values)
152908     *
152909     * @return array
152910     * @since PECL solr >= 2.2.0
152911     **/
152912    public function getGroupFields(){}
152913
152914    /**
152915     * Returns the group.format value
152916     *
152917     * @return string
152918     * @since PECL solr >= 2.2.0
152919     **/
152920    public function getGroupFormat(){}
152921
152922    /**
152923     * Returns group functions (group.func parameter values)
152924     *
152925     * @return array
152926     * @since PECL solr >= 2.2.0
152927     **/
152928    public function getGroupFunctions(){}
152929
152930    /**
152931     * Returns the group.limit value
152932     *
152933     * @return int
152934     * @since PECL solr >= 2.2.0
152935     **/
152936    public function getGroupLimit(){}
152937
152938    /**
152939     * Returns the group.main value
152940     *
152941     * @return bool
152942     * @since PECL solr >= 2.2.0
152943     **/
152944    public function getGroupMain(){}
152945
152946    /**
152947     * Returns the group.ngroups value
152948     *
152949     * @return bool
152950     * @since PECL solr >= 2.2.0
152951     **/
152952    public function getGroupNGroups(){}
152953
152954    /**
152955     * Returns the group.offset value
152956     *
152957     * @return int
152958     * @since PECL solr >= 2.2.0
152959     **/
152960    public function getGroupOffset(){}
152961
152962    /**
152963     * Returns all the group.query parameter values
152964     *
152965     * @return array array
152966     * @since PECL solr >= 2.2.0
152967     **/
152968    public function getGroupQueries(){}
152969
152970    /**
152971     * Returns the group.sort value
152972     *
152973     * @return array
152974     * @since PECL solr >= 2.2.0
152975     **/
152976    public function getGroupSortFields(){}
152977
152978    /**
152979     * Returns the group.truncate value
152980     *
152981     * @return bool
152982     * @since PECL solr >= 2.2.0
152983     **/
152984    public function getGroupTruncate(){}
152985
152986    /**
152987     * Returns the state of the hl parameter
152988     *
152989     * Returns a boolean indicating whether or not to enable highlighted
152990     * snippets to be generated in the query response.
152991     *
152992     * @return bool Returns a boolean on success and NULL if not set.
152993     * @since PECL solr >= 0.9.2
152994     **/
152995    public function getHighlight(){}
152996
152997    /**
152998     * Returns the highlight field to use as backup or default
152999     *
153000     * Returns the highlight field to use as backup or default. It accepts an
153001     * optional override.
153002     *
153003     * @param string $field_override The name of the field
153004     * @return string Returns a string on success and NULL if not set.
153005     * @since PECL solr >= 0.9.2
153006     **/
153007    public function getHighlightAlternateField($field_override){}
153008
153009    /**
153010     * Returns all the fields that Solr should generate highlighted snippets
153011     * for
153012     *
153013     * @return array Returns an array on success and NULL if not set.
153014     * @since PECL solr >= 0.9.2
153015     **/
153016    public function getHighlightFields(){}
153017
153018    /**
153019     * Returns the formatter for the highlighted output
153020     *
153021     * @param string $field_override The name of the field
153022     * @return string Returns a string on success and NULL if not set.
153023     * @since PECL solr >= 0.9.2
153024     **/
153025    public function getHighlightFormatter($field_override){}
153026
153027    /**
153028     * Returns the text snippet generator for highlighted text
153029     *
153030     * Returns the text snippet generator for highlighted text. Accepts an
153031     * optional field override.
153032     *
153033     * @param string $field_override The name of the field
153034     * @return string Returns a string on success and NULL if not set.
153035     * @since PECL solr >= 0.9.2
153036     **/
153037    public function getHighlightFragmenter($field_override){}
153038
153039    /**
153040     * Returns the number of characters of fragments to consider for
153041     * highlighting
153042     *
153043     * Returns the number of characters of fragments to consider for
153044     * highlighting. Zero implies no fragmenting. The entire field should be
153045     * used.
153046     *
153047     * @param string $field_override The name of the field
153048     * @return int Returns an integer on success or NULL if not set.
153049     * @since PECL solr >= 0.9.2
153050     **/
153051    public function getHighlightFragsize($field_override){}
153052
153053    /**
153054     * Returns whether or not to enable highlighting for
153055     * range/wildcard/fuzzy/prefix queries
153056     *
153057     * @return bool Returns a boolean on success and NULL if not set.
153058     * @since PECL solr >= 0.9.2
153059     **/
153060    public function getHighlightHighlightMultiTerm(){}
153061
153062    /**
153063     * Returns the maximum number of characters of the field to return
153064     *
153065     * @param string $field_override The name of the field
153066     * @return int Returns an integer on success and NULL if not set.
153067     * @since PECL solr >= 0.9.2
153068     **/
153069    public function getHighlightMaxAlternateFieldLength($field_override){}
153070
153071    /**
153072     * Returns the maximum number of characters into a document to look for
153073     * suitable snippets
153074     *
153075     * @return int Returns an integer on success and NULL if not set.
153076     * @since PECL solr >= 0.9.2
153077     **/
153078    public function getHighlightMaxAnalyzedChars(){}
153079
153080    /**
153081     * Returns whether or not the collapse contiguous fragments into a single
153082     * fragment
153083     *
153084     * Returns whether or not the collapse contiguous fragments into a single
153085     * fragment. Accepts an optional field override.
153086     *
153087     * @param string $field_override The name of the field
153088     * @return bool Returns a boolean on success and NULL if not set.
153089     * @since PECL solr >= 0.9.2
153090     **/
153091    public function getHighlightMergeContiguous($field_override){}
153092
153093    /**
153094     * Returns the maximum number of characters from a field when using the
153095     * regex fragmenter
153096     *
153097     * @return int Returns an integer on success and NULL if not set.
153098     * @since PECL solr >= 0.9.2
153099     **/
153100    public function getHighlightRegexMaxAnalyzedChars(){}
153101
153102    /**
153103     * Returns the regular expression for fragmenting
153104     *
153105     * Returns the regular expression used for fragmenting
153106     *
153107     * @return string Returns a string on success and NULL if not set.
153108     * @since PECL solr >= 0.9.2
153109     **/
153110    public function getHighlightRegexPattern(){}
153111
153112    /**
153113     * Returns the deviation factor from the ideal fragment size
153114     *
153115     * Returns the factor by which the regex fragmenter can deviate from the
153116     * ideal fragment size to accomodate the regular expression
153117     *
153118     * @return float Returns a double on success and NULL if not set.
153119     * @since PECL solr >= 0.9.2
153120     **/
153121    public function getHighlightRegexSlop(){}
153122
153123    /**
153124     * Returns if a field will only be highlighted if the query matched in
153125     * this particular field
153126     *
153127     * @return bool Returns a boolean on success and NULL if not set.
153128     * @since PECL solr >= 0.9.2
153129     **/
153130    public function getHighlightRequireFieldMatch(){}
153131
153132    /**
153133     * Returns the text which appears after a highlighted term
153134     *
153135     * Returns the text which appears after a highlighted term. Accepts an
153136     * optional field override
153137     *
153138     * @param string $field_override The name of the field
153139     * @return string Returns a string on success and NULL if not set.
153140     * @since PECL solr >= 0.9.2
153141     **/
153142    public function getHighlightSimplePost($field_override){}
153143
153144    /**
153145     * Returns the text which appears before a highlighted term
153146     *
153147     * Returns the text which appears before a highlighted term. Accepts an
153148     * optional field override
153149     *
153150     * @param string $field_override The name of the field
153151     * @return string Returns a string on success and NULL if not set.
153152     * @since PECL solr >= 0.9.2
153153     **/
153154    public function getHighlightSimplePre($field_override){}
153155
153156    /**
153157     * Returns the maximum number of highlighted snippets to generate per
153158     * field
153159     *
153160     * Returns the maximum number of highlighted snippets to generate per
153161     * field. Accepts an optional field override
153162     *
153163     * @param string $field_override The name of the field
153164     * @return int Returns an integer on success and NULL if not set.
153165     * @since PECL solr >= 0.9.2
153166     **/
153167    public function getHighlightSnippets($field_override){}
153168
153169    /**
153170     * Returns the state of the hl.usePhraseHighlighter parameter
153171     *
153172     * Returns whether or not to use SpanScorer to highlight phrase terms
153173     * only when they appear within the query phrase in the document.
153174     *
153175     * @return bool Returns a boolean on success and NULL if not set.
153176     * @since PECL solr >= 0.9.2
153177     **/
153178    public function getHighlightUsePhraseHighlighter(){}
153179
153180    /**
153181     * Returns whether or not MoreLikeThis results should be enabled
153182     *
153183     * @return bool Returns a boolean on success and NULL if not set.
153184     * @since PECL solr >= 0.9.2
153185     **/
153186    public function getMlt(){}
153187
153188    /**
153189     * Returns whether or not the query will be boosted by the interesting
153190     * term relevance
153191     *
153192     * @return bool Returns a boolean on success and NULL if not set.
153193     * @since PECL solr >= 0.9.2
153194     **/
153195    public function getMltBoost(){}
153196
153197    /**
153198     * Returns the number of similar documents to return for each result
153199     *
153200     * @return int Returns an integer on success and NULL if not set.
153201     * @since PECL solr >= 0.9.2
153202     **/
153203    public function getMltCount(){}
153204
153205    /**
153206     * Returns all the fields to use for similarity
153207     *
153208     * @return array Returns an array on success and NULL if not set.
153209     * @since PECL solr >= 0.9.2
153210     **/
153211    public function getMltFields(){}
153212
153213    /**
153214     * Returns the maximum number of query terms that will be included in any
153215     * generated query
153216     *
153217     * @return int Returns an integer on success and NULL if not set.
153218     * @since PECL solr >= 0.9.2
153219     **/
153220    public function getMltMaxNumQueryTerms(){}
153221
153222    /**
153223     * Returns the maximum number of tokens to parse in each document field
153224     * that is not stored with TermVector support
153225     *
153226     * @return int Returns an integer on success and NULL if not set.
153227     * @since PECL solr >= 0.9.2
153228     **/
153229    public function getMltMaxNumTokens(){}
153230
153231    /**
153232     * Returns the maximum word length above which words will be ignored
153233     *
153234     * Returns the maximum word length above which words will be ignored
153235     *
153236     * @return int Returns an integer on success and NULL if not set.
153237     * @since PECL solr >= 0.9.2
153238     **/
153239    public function getMltMaxWordLength(){}
153240
153241    /**
153242     * Returns the treshold frequency at which words will be ignored which do
153243     * not occur in at least this many docs
153244     *
153245     * @return int Returns an integer on success and NULL if not set.
153246     * @since PECL solr >= 0.9.2
153247     **/
153248    public function getMltMinDocFrequency(){}
153249
153250    /**
153251     * Returns the frequency below which terms will be ignored in the source
153252     * document
153253     *
153254     * @return int Returns an integer on success and NULL if not set.
153255     * @since PECL solr >= 0.9.2
153256     **/
153257    public function getMltMinTermFrequency(){}
153258
153259    /**
153260     * Returns the minimum word length below which words will be ignored
153261     *
153262     * @return int Returns an integer on success and NULL if not set.
153263     * @since PECL solr >= 0.9.2
153264     **/
153265    public function getMltMinWordLength(){}
153266
153267    /**
153268     * Returns the query fields and their boosts
153269     *
153270     * @return array Returns an array on success and NULL if not set.
153271     * @since PECL solr >= 0.9.2
153272     **/
153273    public function getMltQueryFields(){}
153274
153275    /**
153276     * Returns the main query
153277     *
153278     * Returns the main search query
153279     *
153280     * @return string Returns a string on success and NULL if not set.
153281     * @since PECL solr >= 0.9.2
153282     **/
153283    public function getQuery(){}
153284
153285    /**
153286     * Returns the maximum number of documents
153287     *
153288     * Returns the maximum number of documents from the complete result set
153289     * to return to the client for every request
153290     *
153291     * @return int Returns an integer on success and NULL if not set.
153292     * @since PECL solr >= 0.9.2
153293     **/
153294    public function getRows(){}
153295
153296    /**
153297     * Returns all the sort fields
153298     *
153299     * @return array Returns an array on success and NULL if none of the
153300     *   parameters was set.
153301     * @since PECL solr >= 0.9.2
153302     **/
153303    public function getSortFields(){}
153304
153305    /**
153306     * Returns the offset in the complete result set
153307     *
153308     * Returns the offset in the complete result set for the queries where
153309     * the set of returned documents should begin.
153310     *
153311     * @return int Returns an integer on success and NULL if not set.
153312     * @since PECL solr >= 0.9.2
153313     **/
153314    public function getStart(){}
153315
153316    /**
153317     * Returns whether or not stats is enabled
153318     *
153319     * @return bool Returns a boolean on success and NULL if not set.
153320     * @since PECL solr >= 0.9.2
153321     **/
153322    public function getStats(){}
153323
153324    /**
153325     * Returns all the stats facets that were set
153326     *
153327     * @return array Returns an array on success and NULL if not set.
153328     * @since PECL solr >= 0.9.2
153329     **/
153330    public function getStatsFacets(){}
153331
153332    /**
153333     * Returns all the statistics fields
153334     *
153335     * @return array Returns an array on success and NULL if not set.
153336     * @since PECL solr >= 0.9.2
153337     **/
153338    public function getStatsFields(){}
153339
153340    /**
153341     * Returns whether or not the TermsComponent is enabled
153342     *
153343     * @return bool Returns a boolean on success and NULL if not set.
153344     * @since PECL solr >= 0.9.2
153345     **/
153346    public function getTerms(){}
153347
153348    /**
153349     * Returns the field from which the terms are retrieved
153350     *
153351     * @return string Returns a string on success and NULL if not set.
153352     * @since PECL solr >= 0.9.2
153353     **/
153354    public function getTermsField(){}
153355
153356    /**
153357     * Returns whether or not to include the lower bound in the result set
153358     *
153359     * @return bool Returns a boolean on success and NULL if not set.
153360     * @since PECL solr >= 0.9.2
153361     **/
153362    public function getTermsIncludeLowerBound(){}
153363
153364    /**
153365     * Returns whether or not to include the upper bound term in the result
153366     * set
153367     *
153368     * @return bool Returns a boolean on success and NULL if not set.
153369     * @since PECL solr >= 0.9.2
153370     **/
153371    public function getTermsIncludeUpperBound(){}
153372
153373    /**
153374     * Returns the maximum number of terms Solr should return
153375     *
153376     * @return int Returns an integer on success and NULL if not set.
153377     * @since PECL solr >= 0.9.2
153378     **/
153379    public function getTermsLimit(){}
153380
153381    /**
153382     * Returns the term to start at
153383     *
153384     * @return string Returns a string on success and NULL if not set.
153385     * @since PECL solr >= 0.9.2
153386     **/
153387    public function getTermsLowerBound(){}
153388
153389    /**
153390     * Returns the maximum document frequency
153391     *
153392     * @return int Returns an integer on success and NULL if not set.
153393     * @since PECL solr >= 0.9.2
153394     **/
153395    public function getTermsMaxCount(){}
153396
153397    /**
153398     * Returns the minimum document frequency to return in order to be
153399     * included
153400     *
153401     * @return int Returns an integer on success and NULL if not set.
153402     * @since PECL solr >= 0.9.2
153403     **/
153404    public function getTermsMinCount(){}
153405
153406    /**
153407     * Returns the term prefix
153408     *
153409     * Returns the prefix to which matching terms must be restricted. This
153410     * will restrict matches to only terms that start with the prefix
153411     *
153412     * @return string Returns a string on success and NULL if not set.
153413     * @since PECL solr >= 0.9.2
153414     **/
153415    public function getTermsPrefix(){}
153416
153417    /**
153418     * Whether or not to return raw characters
153419     *
153420     * Returns a boolean indicating whether or not to return the raw
153421     * characters of the indexed term, regardless of if it is human readable
153422     *
153423     * @return bool Returns a boolean on success and NULL if not set.
153424     * @since PECL solr >= 0.9.2
153425     **/
153426    public function getTermsReturnRaw(){}
153427
153428    /**
153429     * Returns an integer indicating how terms are sorted
153430     *
153431     * SolrQuery::TERMS_SORT_INDEX indicates that the terms are returned by
153432     * index order. SolrQuery::TERMS_SORT_COUNT implies that the terms are
153433     * sorted by term frequency (highest count first)
153434     *
153435     * @return int Returns an integer on success and NULL if not set.
153436     * @since PECL solr >= 0.9.2
153437     **/
153438    public function getTermsSort(){}
153439
153440    /**
153441     * Returns the term to stop at
153442     *
153443     * @return string Returns a string on success and NULL if not set.
153444     * @since PECL solr >= 0.9.2
153445     **/
153446    public function getTermsUpperBound(){}
153447
153448    /**
153449     * Returns the time in milliseconds allowed for the query to finish
153450     *
153451     * @return int Returns and integer on success and NULL if it is not
153452     *   set.
153453     * @since PECL solr >= 0.9.2
153454     **/
153455    public function getTimeAllowed(){}
153456
153457    /**
153458     * Removes an expand filter query
153459     *
153460     * @param string $fq
153461     * @return SolrQuery SolrQuery
153462     * @since PECL solr >= 2.2.0
153463     **/
153464    public function removeExpandFilterQuery($fq){}
153465
153466    /**
153467     * Removes an expand sort field from the expand.sort parameter
153468     *
153469     * @param string $field field name
153470     * @return SolrQuery SolrQuery
153471     * @since PECL solr >= 2.2.0
153472     **/
153473    public function removeExpandSortField($field){}
153474
153475    /**
153476     * Removes one of the facet date fields
153477     *
153478     * The name of the field
153479     *
153480     * @param string $field The name of the date field to remove
153481     * @return SolrQuery Returns the current SolrQuery object, if the
153482     *   return value is used.
153483     * @since PECL solr >= 0.9.2
153484     **/
153485    public function removeFacetDateField($field){}
153486
153487    /**
153488     * Removes one of the facet.date.other parameters
153489     *
153490     * @param string $value The value
153491     * @param string $field_override The name of the field.
153492     * @return SolrQuery Returns the current SolrQuery object, if the
153493     *   return value is used.
153494     * @since PECL solr >= 0.9.2
153495     **/
153496    public function removeFacetDateOther($value, $field_override){}
153497
153498    /**
153499     * Removes one of the facet.date parameters
153500     *
153501     * @param string $field The name of the field
153502     * @return SolrQuery Returns the current SolrQuery object, if the
153503     *   return value is used.
153504     * @since PECL solr >= 0.9.2
153505     **/
153506    public function removeFacetField($field){}
153507
153508    /**
153509     * Removes one of the facet.query parameters
153510     *
153511     * @param string $value The value
153512     * @return SolrQuery Returns the current SolrQuery object, if the
153513     *   return value is used.
153514     * @since PECL solr >= 0.9.2
153515     **/
153516    public function removeFacetQuery($value){}
153517
153518    /**
153519     * Removes a field from the list of fields
153520     *
153521     * @param string $field Name of the field.
153522     * @return SolrQuery Returns the current SolrQuery object, if the
153523     *   return value is used.
153524     * @since PECL solr >= 0.9.2
153525     **/
153526    public function removeField($field){}
153527
153528    /**
153529     * Removes a filter query
153530     *
153531     * @param string $fq The filter query to remove
153532     * @return SolrQuery Returns the current SolrQuery object, if the
153533     *   return value is used.
153534     * @since PECL solr >= 0.9.2
153535     **/
153536    public function removeFilterQuery($fq){}
153537
153538    /**
153539     * Removes one of the fields used for highlighting
153540     *
153541     * @param string $field The name of the field
153542     * @return SolrQuery Returns the current SolrQuery object, if the
153543     *   return value is used.
153544     * @since PECL solr >= 0.9.2
153545     **/
153546    public function removeHighlightField($field){}
153547
153548    /**
153549     * Removes one of the moreLikeThis fields
153550     *
153551     * @param string $field Name of the field
153552     * @return SolrQuery Returns the current SolrQuery object, if the
153553     *   return value is used.
153554     * @since PECL solr >= 0.9.2
153555     **/
153556    public function removeMltField($field){}
153557
153558    /**
153559     * Removes one of the moreLikeThis query fields
153560     *
153561     * @param string $queryField The query field
153562     * @return SolrQuery Returns the current SolrQuery object, if the
153563     *   return value is used.
153564     * @since PECL solr >= 0.9.2
153565     **/
153566    public function removeMltQueryField($queryField){}
153567
153568    /**
153569     * Removes one of the sort fields
153570     *
153571     * @param string $field The name of the field
153572     * @return SolrQuery Returns the current SolrQuery object, if the
153573     *   return value is used.
153574     * @since PECL solr >= 0.9.2
153575     **/
153576    public function removeSortField($field){}
153577
153578    /**
153579     * Removes one of the stats.facet parameters
153580     *
153581     * @param string $value The value
153582     * @return SolrQuery Returns the current SolrQuery object, if the
153583     *   return value is used.
153584     * @since PECL solr >= 0.9.2
153585     **/
153586    public function removeStatsFacet($value){}
153587
153588    /**
153589     * Removes one of the stats.field parameters
153590     *
153591     * @param string $field The name of the field.
153592     * @return SolrQuery Returns the current SolrQuery object, if the
153593     *   return value is used.
153594     * @since PECL solr >= 0.9.2
153595     **/
153596    public function removeStatsField($field){}
153597
153598    /**
153599     * Toggles the echoHandler parameter
153600     *
153601     * If set to true, Solr places the name of the handle used in the
153602     * response to the client for debugging purposes.
153603     *
153604     * @param bool $flag TRUE or FALSE
153605     * @return SolrQuery Returns the current SolrQuery object, if the
153606     *   return value is used.
153607     * @since PECL solr >= 0.9.2
153608     **/
153609    public function setEchoHandler($flag){}
153610
153611    /**
153612     * Determines what kind of parameters to include in the response
153613     *
153614     * Instructs Solr what kinds of Request parameters should be included in
153615     * the response for debugging purposes, legal values include:
153616     *
153617     * - none - don't include any request parameters for debugging - explicit
153618     * - include the parameters explicitly specified by the client in the
153619     * request - all - include all parameters involved in this request,
153620     * either specified explicitly by the client, or implicit because of the
153621     * request handler configuration.
153622     *
153623     * @param string $type The type of parameters to include
153624     * @return SolrQuery Returns the current SolrQuery object, if the
153625     *   return value is used.
153626     * @since PECL solr >= 0.9.2
153627     **/
153628    public function setEchoParams($type){}
153629
153630    /**
153631     * Enables/Disables the Expand Component
153632     *
153633     * @param bool $value Bool flag
153634     * @return SolrQuery SolrQuery
153635     * @since PECL solr >= 2.2.0
153636     **/
153637    public function setExpand($value){}
153638
153639    /**
153640     * Sets the expand.q parameter
153641     *
153642     * Overrides the main q parameter, determines which documents to include
153643     * in the main group.
153644     *
153645     * @param string $q
153646     * @return SolrQuery SolrQuery
153647     * @since PECL solr >= 2.2.0
153648     **/
153649    public function setExpandQuery($q){}
153650
153651    /**
153652     * Sets the number of rows to display in each group (expand.rows). Server
153653     * Default 5
153654     *
153655     * @param int $value
153656     * @return SolrQuery SolrQuery
153657     * @since PECL solr >= 2.2.0
153658     **/
153659    public function setExpandRows($value){}
153660
153661    /**
153662     * Sets the explainOther common query parameter
153663     *
153664     * @param string $query The Lucene query to identify a set of documents
153665     * @return SolrQuery Returns the current SolrQuery object, if the
153666     *   return value is used.
153667     * @since PECL solr >= 0.9.2
153668     **/
153669    public function setExplainOther($query){}
153670
153671    /**
153672     * Maps to the facet parameter. Enables or disables facetting
153673     *
153674     * Enables or disables faceting.
153675     *
153676     * @param bool $flag TRUE enables faceting and FALSE disables it.
153677     * @return SolrQuery Returns the current SolrQuery object, if the
153678     *   return value is used.
153679     * @since PECL solr >= 0.9.2
153680     **/
153681    public function setFacet($flag){}
153682
153683    /**
153684     * Maps to facet.date.end
153685     *
153686     * @param string $value See facet.date.end
153687     * @param string $field_override Name of the field
153688     * @return SolrQuery Returns the current SolrQuery object, if the
153689     *   return value is used.
153690     * @since PECL solr >= 0.9.2
153691     **/
153692    public function setFacetDateEnd($value, $field_override){}
153693
153694    /**
153695     * Maps to facet.date.gap
153696     *
153697     * @param string $value See facet.date.gap
153698     * @param string $field_override The name of the field
153699     * @return SolrQuery Returns the current SolrQuery object, if the
153700     *   return value is used.
153701     * @since PECL solr >= 0.9.2
153702     **/
153703    public function setFacetDateGap($value, $field_override){}
153704
153705    /**
153706     * Maps to facet.date.hardend
153707     *
153708     * @param bool $value See facet.date.hardend
153709     * @param string $field_override The name of the field
153710     * @return SolrQuery Returns the current SolrQuery object, if the
153711     *   return value is used.
153712     * @since PECL solr >= 0.9.2
153713     **/
153714    public function setFacetDateHardEnd($value, $field_override){}
153715
153716    /**
153717     * Maps to facet.date.start
153718     *
153719     * @param string $value See facet.date.start
153720     * @param string $field_override The name of the field.
153721     * @return SolrQuery Returns the current SolrQuery object, if the
153722     *   return value is used.
153723     * @since PECL solr >= 0.9.2
153724     **/
153725    public function setFacetDateStart($value, $field_override){}
153726
153727    /**
153728     * Sets the minimum document frequency used for determining term count
153729     *
153730     * @param int $frequency The minimum frequency
153731     * @param string $field_override The name of the field.
153732     * @return SolrQuery Returns the current SolrQuery object, if the
153733     *   return value is used.
153734     * @since PECL solr >= 0.9.2
153735     **/
153736    public function setFacetEnumCacheMinDefaultFrequency($frequency, $field_override){}
153737
153738    /**
153739     * Maps to facet.limit
153740     *
153741     * Maps to facet.limit. Sets the maximum number of constraint counts that
153742     * should be returned for the facet fields.
153743     *
153744     * @param int $limit The maximum number of constraint counts
153745     * @param string $field_override The name of the field.
153746     * @return SolrQuery Returns the current SolrQuery object, if the
153747     *   return value is used.
153748     * @since PECL solr >= 0.9.2
153749     **/
153750    public function setFacetLimit($limit, $field_override){}
153751
153752    /**
153753     * Specifies the type of algorithm to use when faceting a field
153754     *
153755     * Specifies the type of algorithm to use when faceting a field. This
153756     * method accepts optional field override.
153757     *
153758     * @param string $method The method to use.
153759     * @param string $field_override The name of the field.
153760     * @return SolrQuery Returns the current SolrQuery object, if the
153761     *   return value is used.
153762     * @since PECL solr >= 0.9.2
153763     **/
153764    public function setFacetMethod($method, $field_override){}
153765
153766    /**
153767     * Maps to facet.mincount
153768     *
153769     * Sets the minimum counts for facet fields that should be included in
153770     * the response
153771     *
153772     * @param int $mincount The minimum count
153773     * @param string $field_override The name of the field.
153774     * @return SolrQuery Returns the current SolrQuery object, if the
153775     *   return value is used.
153776     * @since PECL solr >= 0.9.2
153777     **/
153778    public function setFacetMinCount($mincount, $field_override){}
153779
153780    /**
153781     * Maps to facet.missing
153782     *
153783     * Used to indicate that in addition to the Term-based constraints of a
153784     * facet field, a count of all matching results which have no value for
153785     * the field should be computed
153786     *
153787     * @param bool $flag TRUE turns this feature on. FALSE disables it.
153788     * @param string $field_override The name of the field.
153789     * @return SolrQuery Returns the current SolrQuery object, if the
153790     *   return value is used.
153791     * @since PECL solr >= 0.9.2
153792     **/
153793    public function setFacetMissing($flag, $field_override){}
153794
153795    /**
153796     * Sets the offset into the list of constraints to allow for pagination
153797     *
153798     * @param int $offset The offset
153799     * @param string $field_override The name of the field.
153800     * @return SolrQuery Returns the current SolrQuery object, if the
153801     *   return value is used.
153802     * @since PECL solr >= 0.9.2
153803     **/
153804    public function setFacetOffset($offset, $field_override){}
153805
153806    /**
153807     * Specifies a string prefix with which to limits the terms on which to
153808     * facet
153809     *
153810     * @param string $prefix The prefix string
153811     * @param string $field_override The name of the field.
153812     * @return SolrQuery Returns the current SolrQuery object, if the
153813     *   return value is used.
153814     * @since PECL solr >= 0.9.2
153815     **/
153816    public function setFacetPrefix($prefix, $field_override){}
153817
153818    /**
153819     * Determines the ordering of the facet field constraints
153820     *
153821     * @param int $facetSort Use SolrQuery::FACET_SORT_INDEX for sorting by
153822     *   index order or SolrQuery::FACET_SORT_COUNT for sorting by count.
153823     * @param string $field_override The name of the field.
153824     * @return SolrQuery Returns the current SolrQuery object, if the
153825     *   return value is used.
153826     * @since PECL solr >= 0.9.2
153827     **/
153828    public function setFacetSort($facetSort, $field_override){}
153829
153830    /**
153831     * Enable/Disable result grouping (group parameter)
153832     *
153833     * @param bool $value
153834     * @return SolrQuery
153835     * @since PECL solr >= 2.2.0
153836     **/
153837    public function setGroup($value){}
153838
153839    /**
153840     * Enables caching for result grouping
153841     *
153842     * Setting this parameter to a number greater than 0 enables caching for
153843     * result grouping. Result Grouping executes two searches; this option
153844     * caches the second search. The server default value is 0. Testing has
153845     * shown that group caching only improves search time with Boolean,
153846     * wildcard, and fuzzy queries. For simple queries like term or "match
153847     * all" queries, group caching degrades performance. group.cache.percent
153848     * parameter
153849     *
153850     * @param int $percent
153851     * @return SolrQuery
153852     * @since PECL solr >= 2.2.0
153853     **/
153854    public function setGroupCachePercent($percent){}
153855
153856    /**
153857     * Sets group.facet parameter
153858     *
153859     * Determines whether to compute grouped facets for the field facets
153860     * specified in facet.field parameters. Grouped facets are computed based
153861     * on the first specified group.
153862     *
153863     * @param bool $value
153864     * @return SolrQuery
153865     * @since PECL solr >= 2.2.0
153866     **/
153867    public function setGroupFacet($value){}
153868
153869    /**
153870     * Sets the group format, result structure (group.format parameter)
153871     *
153872     * Sets the group.format parameter. If this parameter is set to simple,
153873     * the grouped documents are presented in a single flat list, and the
153874     * start and rows parameters affect the numbers of documents instead of
153875     * groups. Accepts: grouped/simple
153876     *
153877     * @param string $value
153878     * @return SolrQuery
153879     * @since PECL solr >= 2.2.0
153880     **/
153881    public function setGroupFormat($value){}
153882
153883    /**
153884     * Specifies the number of results to return for each group. The server
153885     * default value is 1
153886     *
153887     * @param int $value
153888     * @return SolrQuery
153889     * @since PECL solr >= 2.2.0
153890     **/
153891    public function setGroupLimit($value){}
153892
153893    /**
153894     * If true, the result of the first field grouping command is used as the
153895     * main result list in the response, using group.format=simple
153896     *
153897     * @param string $value
153898     * @return SolrQuery
153899     * @since PECL solr >= 2.2.0
153900     **/
153901    public function setGroupMain($value){}
153902
153903    /**
153904     * If true, Solr includes the number of groups that have matched the
153905     * query in the results
153906     *
153907     * @param bool $value
153908     * @return SolrQuery
153909     * @since PECL solr >= 2.2.0
153910     **/
153911    public function setGroupNGroups($value){}
153912
153913    /**
153914     * Sets the group.offset parameter
153915     *
153916     * @param int $value
153917     * @return SolrQuery
153918     * @since PECL solr >= 2.2.0
153919     **/
153920    public function setGroupOffset($value){}
153921
153922    /**
153923     * If true, facet counts are based on the most relevant document of each
153924     * group matching the query
153925     *
153926     * If true, facet counts are based on the most relevant document of each
153927     * group matching the query. The server default value is false.
153928     * group.truncate parameter
153929     *
153930     * @param bool $value
153931     * @return SolrQuery
153932     * @since PECL solr >= 2.2.0
153933     **/
153934    public function setGroupTruncate($value){}
153935
153936    /**
153937     * Enables or disables highlighting
153938     *
153939     * Setting it to TRUE enables highlighted snippets to be generated in the
153940     * query response.
153941     *
153942     * Setting it to FALSE disables highlighting
153943     *
153944     * @param bool $flag Enable or disable highlighting
153945     * @return SolrQuery Returns the current SolrQuery object, if the
153946     *   return value is used.
153947     * @since PECL solr >= 0.9.2
153948     **/
153949    public function setHighlight($flag){}
153950
153951    /**
153952     * Specifies the backup field to use
153953     *
153954     * If a snippet cannot be generated because there were no matching terms,
153955     * one can specify a field to use as the backup or default summary
153956     *
153957     * @param string $field The name of the backup field
153958     * @param string $field_override The name of the field we are
153959     *   overriding this setting for.
153960     * @return SolrQuery Returns the current SolrQuery object, if the
153961     *   return value is used.
153962     * @since PECL solr >= 0.9.2
153963     **/
153964    public function setHighlightAlternateField($field, $field_override){}
153965
153966    /**
153967     * Specify a formatter for the highlight output
153968     *
153969     * @param string $formatter Currently the only legal value is "simple"
153970     * @param string $field_override The name of the field.
153971     * @return SolrQuery
153972     * @since PECL solr >= 0.9.2
153973     **/
153974    public function setHighlightFormatter($formatter, $field_override){}
153975
153976    /**
153977     * Sets a text snippet generator for highlighted text
153978     *
153979     * Specify a text snippet generator for highlighted text.
153980     *
153981     * @param string $fragmenter The standard fragmenter is gap. Another
153982     *   option is regex, which tries to create fragments that resembles a
153983     *   certain regular expression
153984     * @param string $field_override The name of the field.
153985     * @return SolrQuery Returns the current SolrQuery object, if the
153986     *   return value is used.
153987     * @since PECL solr >= 0.9.2
153988     **/
153989    public function setHighlightFragmenter($fragmenter, $field_override){}
153990
153991    /**
153992     * The size of fragments to consider for highlighting
153993     *
153994     * Sets the size, in characters, of fragments to consider for
153995     * highlighting. "0" indicates that the whole field value should be used
153996     * (no fragmenting).
153997     *
153998     * @param int $size The size, in characters, of fragments to consider
153999     *   for highlighting
154000     * @param string $field_override The name of the field.
154001     * @return SolrQuery Returns the current SolrQuery object, if the
154002     *   return value is used.
154003     * @since PECL solr >= 0.9.2
154004     **/
154005    public function setHighlightFragsize($size, $field_override){}
154006
154007    /**
154008     * Use SpanScorer to highlight phrase terms
154009     *
154010     * Use SpanScorer to highlight phrase terms only when they appear within
154011     * the query phrase in the document.
154012     *
154013     * @param bool $flag Whether or not to use SpanScorer to highlight
154014     *   phrase terms only when they appear within the query phrase in the
154015     *   document.
154016     * @return SolrQuery Returns the current SolrQuery object, if the
154017     *   return value is used.
154018     * @since PECL solr >= 0.9.2
154019     **/
154020    public function setHighlightHighlightMultiTerm($flag){}
154021
154022    /**
154023     * Sets the maximum number of characters of the field to return
154024     *
154025     * If SolrQuery::setHighlightAlternateField() was passed the value TRUE,
154026     * this parameter specifies the maximum number of characters of the field
154027     * to return
154028     *
154029     * Any value less than or equal to 0 means unlimited.
154030     *
154031     * @param int $fieldLength The length of the field
154032     * @param string $field_override The name of the field.
154033     * @return SolrQuery Returns the current SolrQuery object, if the
154034     *   return value is used.
154035     * @since PECL solr >= 0.9.2
154036     **/
154037    public function setHighlightMaxAlternateFieldLength($fieldLength, $field_override){}
154038
154039    /**
154040     * Specifies the number of characters into a document to look for
154041     * suitable snippets
154042     *
154043     * @param int $value The number of characters into a document to look
154044     *   for suitable snippets
154045     * @return SolrQuery Returns the current SolrQuery object, if the
154046     *   return value is used.
154047     * @since PECL solr >= 0.9.2
154048     **/
154049    public function setHighlightMaxAnalyzedChars($value){}
154050
154051    /**
154052     * Whether or not to collapse contiguous fragments into a single fragment
154053     *
154054     * @param bool $flag Whether or not to collapse contiguous fragments
154055     *   into a single fragment
154056     * @param string $field_override The name of the field.
154057     * @return SolrQuery Returns the current SolrQuery object, if the
154058     *   return value is used.
154059     * @since PECL solr >= 0.9.2
154060     **/
154061    public function setHighlightMergeContiguous($flag, $field_override){}
154062
154063    /**
154064     * Specify the maximum number of characters to analyze
154065     *
154066     * Specify the maximum number of characters to analyze from a field when
154067     * using the regex fragmenter
154068     *
154069     * @param int $maxAnalyzedChars The maximum number of characters to
154070     *   analyze from a field when using the regex fragmenter
154071     * @return SolrQuery Returns the current SolrQuery object, if the
154072     *   return value is used.
154073     * @since PECL solr >= 0.9.2
154074     **/
154075    public function setHighlightRegexMaxAnalyzedChars($maxAnalyzedChars){}
154076
154077    /**
154078     * Specify the regular expression for fragmenting
154079     *
154080     * Specifies the regular expression for fragmenting. This could be used
154081     * to extract sentences
154082     *
154083     * @param string $value The regular expression for fragmenting. This
154084     *   could be used to extract sentences
154085     * @return SolrQuery Returns the current SolrQuery object, if the
154086     *   return value is used.
154087     * @since PECL solr >= 0.9.2
154088     **/
154089    public function setHighlightRegexPattern($value){}
154090
154091    /**
154092     * Sets the factor by which the regex fragmenter can stray from the ideal
154093     * fragment size
154094     *
154095     * The factor by which the regex fragmenter can stray from the ideal
154096     * fragment size ( specfied by SolrQuery::setHighlightFragsize )to
154097     * accommodate the regular expression
154098     *
154099     * @param float $factor The factor by which the regex fragmenter can
154100     *   stray from the ideal fragment size
154101     * @return SolrQuery Returns the current SolrQuery object, if the
154102     *   return value is used.
154103     * @since PECL solr >= 0.9.2
154104     **/
154105    public function setHighlightRegexSlop($factor){}
154106
154107    /**
154108     * Require field matching during highlighting
154109     *
154110     * If TRUE, then a field will only be highlighted if the query matched in
154111     * this particular field.
154112     *
154113     * This will only work if SolrQuery::setHighlightUsePhraseHighlighter()
154114     * was set to TRUE
154115     *
154116     * @param bool $flag TRUE or FALSE
154117     * @return SolrQuery Returns the current SolrQuery object, if the
154118     *   return value is used.
154119     * @since PECL solr >= 0.9.2
154120     **/
154121    public function setHighlightRequireFieldMatch($flag){}
154122
154123    /**
154124     * Sets the text which appears after a highlighted term
154125     *
154126     * Sets the text which appears before a highlighted term
154127     *
154128     * @param string $simplePost Sets the text which appears after a
154129     *   highlighted term The default is </em>
154130     * @param string $field_override The name of the field.
154131     * @return SolrQuery
154132     * @since PECL solr >= 0.9.2
154133     **/
154134    public function setHighlightSimplePost($simplePost, $field_override){}
154135
154136    /**
154137     * Sets the text which appears before a highlighted term
154138     *
154139     * The default is <em>
154140     *
154141     * @param string $simplePre The text which appears before a highlighted
154142     *   term
154143     * @param string $field_override The name of the field.
154144     * @return SolrQuery Returns the current SolrQuery object, if the
154145     *   return value is used.
154146     * @since PECL solr >= 0.9.2
154147     **/
154148    public function setHighlightSimplePre($simplePre, $field_override){}
154149
154150    /**
154151     * Sets the maximum number of highlighted snippets to generate per field
154152     *
154153     * @param int $value The maximum number of highlighted snippets to
154154     *   generate per field
154155     * @param string $field_override The name of the field.
154156     * @return SolrQuery Returns the current SolrQuery object, if the
154157     *   return value is used.
154158     * @since PECL solr >= 0.9.2
154159     **/
154160    public function setHighlightSnippets($value, $field_override){}
154161
154162    /**
154163     * Whether to highlight phrase terms only when they appear within the
154164     * query phrase
154165     *
154166     * Sets whether or not to use SpanScorer to highlight phrase terms only
154167     * when they appear within the query phrase in the document
154168     *
154169     * @param bool $flag Whether or not to use SpanScorer to highlight
154170     *   phrase terms only when they appear within the query phrase in the
154171     *   document
154172     * @return SolrQuery Returns the current SolrQuery object, if the
154173     *   return value is used.
154174     * @since PECL solr >= 0.9.2
154175     **/
154176    public function setHighlightUsePhraseHighlighter($flag){}
154177
154178    /**
154179     * Enables or disables moreLikeThis
154180     *
154181     * @param bool $flag TRUE enables it and FALSE turns it off.
154182     * @return SolrQuery Returns the current SolrQuery object, if the
154183     *   return value is used.
154184     * @since PECL solr >= 0.9.2
154185     **/
154186    public function setMlt($flag){}
154187
154188    /**
154189     * Set if the query will be boosted by the interesting term relevance
154190     *
154191     * @param bool $flag Sets to TRUE or FALSE
154192     * @return SolrQuery Returns the current SolrQuery object, if the
154193     *   return value is used.
154194     * @since PECL solr >= 0.9.2
154195     **/
154196    public function setMltBoost($flag){}
154197
154198    /**
154199     * Set the number of similar documents to return for each result
154200     *
154201     * @param int $count The number of similar documents to return for each
154202     *   result
154203     * @return SolrQuery Returns the current SolrQuery object, if the
154204     *   return value is used.
154205     * @since PECL solr >= 0.9.2
154206     **/
154207    public function setMltCount($count){}
154208
154209    /**
154210     * Sets the maximum number of query terms included
154211     *
154212     * Sets the maximum number of query terms that will be included in any
154213     * generated query.
154214     *
154215     * @param int $value The maximum number of query terms that will be
154216     *   included in any generated query
154217     * @return SolrQuery Returns the current SolrQuery object, if the
154218     *   return value is used.
154219     * @since PECL solr >= 0.9.2
154220     **/
154221    public function setMltMaxNumQueryTerms($value){}
154222
154223    /**
154224     * Specifies the maximum number of tokens to parse
154225     *
154226     * Specifies the maximum number of tokens to parse in each example doc
154227     * field that is not stored with TermVector support.
154228     *
154229     * @param int $value The maximum number of tokens to parse
154230     * @return SolrQuery Returns the current SolrQuery object, if the
154231     *   return value is used.
154232     * @since PECL solr >= 0.9.2
154233     **/
154234    public function setMltMaxNumTokens($value){}
154235
154236    /**
154237     * Sets the maximum word length
154238     *
154239     * Sets the maximum word length above which words will be ignored.
154240     *
154241     * @param int $maxWordLength The maximum word length above which words
154242     *   will be ignored
154243     * @return SolrQuery Returns the current SolrQuery object, if the
154244     *   return value is used.
154245     * @since PECL solr >= 0.9.2
154246     **/
154247    public function setMltMaxWordLength($maxWordLength){}
154248
154249    /**
154250     * Sets the mltMinDoc frequency
154251     *
154252     * The frequency at which words will be ignored which do not occur in at
154253     * least this many docs.
154254     *
154255     * @param int $minDocFrequency Sets the frequency at which words will
154256     *   be ignored which do not occur in at least this many docs.
154257     * @return SolrQuery Returns the current SolrQuery object, if the
154258     *   return value is used.
154259     * @since PECL solr >= 0.9.2
154260     **/
154261    public function setMltMinDocFrequency($minDocFrequency){}
154262
154263    /**
154264     * Sets the frequency below which terms will be ignored in the source
154265     * docs
154266     *
154267     * @param int $minTermFrequency The frequency below which terms will be
154268     *   ignored in the source docs
154269     * @return SolrQuery Returns the current SolrQuery object, if the
154270     *   return value is used.
154271     * @since PECL solr >= 0.9.2
154272     **/
154273    public function setMltMinTermFrequency($minTermFrequency){}
154274
154275    /**
154276     * Sets the minimum word length
154277     *
154278     * Sets the minimum word length below which words will be ignored.
154279     *
154280     * @param int $minWordLength The minimum word length below which words
154281     *   will be ignored
154282     * @return SolrQuery Returns the current SolrQuery object, if the
154283     *   return value is used.
154284     * @since PECL solr >= 0.9.2
154285     **/
154286    public function setMltMinWordLength($minWordLength){}
154287
154288    /**
154289     * Exclude the header from the returned results
154290     *
154291     * @param bool $flag TRUE excludes the header from the result.
154292     * @return SolrQuery Returns the current SolrQuery object, if the
154293     *   return value is used.
154294     * @since PECL solr >= 0.9.2
154295     **/
154296    public function setOmitHeader($flag){}
154297
154298    /**
154299     * Sets the search query
154300     *
154301     * @param string $query The search query
154302     * @return SolrQuery Returns the current SolrQuery object
154303     * @since PECL solr >= 0.9.2
154304     **/
154305    public function setQuery($query){}
154306
154307    /**
154308     * Specifies the maximum number of rows to return in the result
154309     *
154310     * @param int $rows The maximum number of rows to return
154311     * @return SolrQuery Returns the current SolrQuery object.
154312     * @since PECL solr >= 0.9.2
154313     **/
154314    public function setRows($rows){}
154315
154316    /**
154317     * Flag to show debug information
154318     *
154319     * Whether to show debug info
154320     *
154321     * @param bool $flag Whether to show debug info. TRUE or FALSE
154322     * @return SolrQuery Returns the current SolrQuery object, if the
154323     *   return value is used.
154324     * @since PECL solr >= 0.9.2
154325     **/
154326    public function setShowDebugInfo($flag){}
154327
154328    /**
154329     * Specifies the number of rows to skip
154330     *
154331     * Specifies the number of rows to skip. Useful in pagination of results.
154332     *
154333     * @param int $start The number of rows to skip.
154334     * @return SolrQuery Returns the current SolrQuery object.
154335     * @since PECL solr >= 0.9.2
154336     **/
154337    public function setStart($start){}
154338
154339    /**
154340     * Enables or disables the Stats component
154341     *
154342     * @param bool $flag TRUE turns on the stats component and FALSE
154343     *   disables it.
154344     * @return SolrQuery Returns the current SolrQuery object, if the
154345     *   return value is used.
154346     * @since PECL solr >= 0.9.2
154347     **/
154348    public function setStats($flag){}
154349
154350    /**
154351     * Enables or disables the TermsComponent
154352     *
154353     * @param bool $flag TRUE enables it. FALSE turns it off
154354     * @return SolrQuery Returns the current SolrQuery object, if the
154355     *   return value is used.
154356     * @since PECL solr >= 0.9.2
154357     **/
154358    public function setTerms($flag){}
154359
154360    /**
154361     * Sets the name of the field to get the Terms from
154362     *
154363     * Sets the name of the field to get the terms from
154364     *
154365     * @param string $fieldname The field name
154366     * @return SolrQuery Returns the current SolrQuery object, if the
154367     *   return value is used.
154368     * @since PECL solr >= 0.9.2
154369     **/
154370    public function setTermsField($fieldname){}
154371
154372    /**
154373     * Include the lower bound term in the result set
154374     *
154375     * @param bool $flag Include the lower bound term in the result set
154376     * @return SolrQuery Returns the current SolrQuery object, if the
154377     *   return value is used.
154378     * @since PECL solr >= 0.9.2
154379     **/
154380    public function setTermsIncludeLowerBound($flag){}
154381
154382    /**
154383     * Include the upper bound term in the result set
154384     *
154385     * @param bool $flag TRUE or FALSE
154386     * @return SolrQuery Returns the current SolrQuery object, if the
154387     *   return value is used.
154388     * @since PECL solr >= 0.9.2
154389     **/
154390    public function setTermsIncludeUpperBound($flag){}
154391
154392    /**
154393     * Sets the maximum number of terms to return
154394     *
154395     * @param int $limit The maximum number of terms to return. All the
154396     *   terms will be returned if the limit is negative.
154397     * @return SolrQuery Returns the current SolrQuery object, if the
154398     *   return value is used.
154399     * @since PECL solr >= 0.9.2
154400     **/
154401    public function setTermsLimit($limit){}
154402
154403    /**
154404     * Specifies the Term to start from
154405     *
154406     * @param string $lowerBound The lower bound Term
154407     * @return SolrQuery Returns the current SolrQuery object, if the
154408     *   return value is used.
154409     * @since PECL solr >= 0.9.2
154410     **/
154411    public function setTermsLowerBound($lowerBound){}
154412
154413    /**
154414     * Sets the maximum document frequency
154415     *
154416     * @param int $frequency The maximum document frequency.
154417     * @return SolrQuery Returns the current SolrQuery object, if the
154418     *   return value is used.
154419     * @since PECL solr >= 0.9.2
154420     **/
154421    public function setTermsMaxCount($frequency){}
154422
154423    /**
154424     * Sets the minimum document frequency
154425     *
154426     * Sets the minimum doc frequency to return in order to be included
154427     *
154428     * @param int $frequency The minimum frequency
154429     * @return SolrQuery Returns the current SolrQuery object, if the
154430     *   return value is used.
154431     * @since PECL solr >= 0.9.2
154432     **/
154433    public function setTermsMinCount($frequency){}
154434
154435    /**
154436     * Restrict matches to terms that start with the prefix
154437     *
154438     * @param string $prefix Restrict matches to terms that start with the
154439     *   prefix
154440     * @return SolrQuery Returns the current SolrQuery object, if the
154441     *   return value is used.
154442     * @since PECL solr >= 0.9.2
154443     **/
154444    public function setTermsPrefix($prefix){}
154445
154446    /**
154447     * Return the raw characters of the indexed term
154448     *
154449     * If true, return the raw characters of the indexed term, regardless of
154450     * if it is human readable
154451     *
154452     * @param bool $flag TRUE or FALSE
154453     * @return SolrQuery Returns the current SolrQuery object, if the
154454     *   return value is used.
154455     * @since PECL solr >= 0.9.2
154456     **/
154457    public function setTermsReturnRaw($flag){}
154458
154459    /**
154460     * Specifies how to sort the returned terms
154461     *
154462     * If SolrQuery::TERMS_SORT_COUNT, sorts the terms by the term frequency
154463     * (highest count first). If SolrQuery::TERMS_SORT_INDEX, returns the
154464     * terms in index order
154465     *
154466     * @param int $sortType SolrQuery::TERMS_SORT_INDEX or
154467     *   SolrQuery::TERMS_SORT_COUNT
154468     * @return SolrQuery Returns the current SolrQuery object, if the
154469     *   return value is used.
154470     * @since PECL solr >= 0.9.2
154471     **/
154472    public function setTermsSort($sortType){}
154473
154474    /**
154475     * Sets the term to stop at
154476     *
154477     * @param string $upperBound The term to stop at
154478     * @return SolrQuery Returns the current SolrQuery object, if the
154479     *   return value is used.
154480     * @since PECL solr >= 0.9.2
154481     **/
154482    public function setTermsUpperBound($upperBound){}
154483
154484    /**
154485     * The time allowed for search to finish
154486     *
154487     * The time allowed for a search to finish. This value only applies to
154488     * the search and not to requests in general. Time is in milliseconds.
154489     * Values less than or equal to zero implies no time restriction. Partial
154490     * results may be returned, if there are any.
154491     *
154492     * @param int $timeAllowed The time allowed for a search to finish.
154493     * @return SolrQuery Returns the current SolrQuery object, if the
154494     *   return value is used.
154495     * @since PECL solr >= 0.9.2
154496     **/
154497    public function setTimeAllowed($timeAllowed){}
154498
154499    /**
154500     * Constructor
154501     *
154502     * @param string $q Optional search query
154503     * @since PECL solr >= 0.9.2
154504     **/
154505    public function __construct($q){}
154506
154507    /**
154508     * Destructor
154509     *
154510     * @return void None.
154511     * @since PECL solr >= 0.9.2
154512     **/
154513    public function __destruct(){}
154514
154515}
154516/**
154517 * Represents a response to a query request.
154518 **/
154519final class SolrQueryResponse extends SolrResponse {
154520    /**
154521     * @var integer
154522     **/
154523    const PARSE_SOLR_DOC = 0;
154524
154525    /**
154526     * @var integer
154527     **/
154528    const PARSE_SOLR_OBJ = 0;
154529
154530    /**
154531     * Constructor
154532     *
154533     * @since PECL solr >= 0.9.2
154534     **/
154535    public function __construct(){}
154536
154537    /**
154538     * Destructor
154539     *
154540     * @return void None
154541     * @since PECL solr >= 0.9.2
154542     **/
154543    public function __destruct(){}
154544
154545}
154546/**
154547 * Represents a response from the Solr server.
154548 **/
154549abstract class SolrResponse {
154550    /**
154551     * @var integer
154552     **/
154553    const PARSE_SOLR_DOC = 0;
154554
154555    /**
154556     * @var integer
154557     **/
154558    const PARSE_SOLR_OBJ = 0;
154559
154560    /**
154561     * @var string
154562     **/
154563    protected $http_digested_response;
154564
154565    /**
154566     * @var string
154567     **/
154568    protected $http_raw_request;
154569
154570    /**
154571     * @var string
154572     **/
154573    protected $http_raw_request_headers;
154574
154575    /**
154576     * @var string
154577     **/
154578    protected $http_raw_response;
154579
154580    /**
154581     * @var string
154582     **/
154583    protected $http_raw_response_headers;
154584
154585    /**
154586     * @var string
154587     **/
154588    protected $http_request_url;
154589
154590    /**
154591     * @var integer
154592     **/
154593    protected $http_status;
154594
154595    /**
154596     * @var string
154597     **/
154598    protected $http_status_message;
154599
154600    /**
154601     * @var integer
154602     **/
154603    protected $parser_mode;
154604
154605    /**
154606     * Was there an error during the request
154607     *
154608     * @var bool
154609     **/
154610    protected $success;
154611
154612    /**
154613     * Returns the XML response as serialized PHP data
154614     *
154615     * @return string Returns the XML response as serialized PHP data
154616     * @since PECL solr >= 0.9.2
154617     **/
154618    public function getDigestedResponse(){}
154619
154620    /**
154621     * Returns the HTTP status of the response
154622     *
154623     * @return int Returns the HTTP status of the response.
154624     * @since PECL solr >= 0.9.2
154625     **/
154626    public function getHttpStatus(){}
154627
154628    /**
154629     * Returns more details on the HTTP status
154630     *
154631     * @return string Returns more details on the HTTP status
154632     * @since PECL solr >= 0.9.2
154633     **/
154634    public function getHttpStatusMessage(){}
154635
154636    /**
154637     * Returns the raw request sent to the Solr server
154638     *
154639     * @return string Returns the raw request sent to the Solr server
154640     * @since PECL solr >= 0.9.2
154641     **/
154642    public function getRawRequest(){}
154643
154644    /**
154645     * Returns the raw request headers sent to the Solr server
154646     *
154647     * @return string Returns the raw request headers sent to the Solr
154648     *   server
154649     * @since PECL solr >= 0.9.2
154650     **/
154651    public function getRawRequestHeaders(){}
154652
154653    /**
154654     * Returns the raw response from the server
154655     *
154656     * @return string Returns the raw response from the server.
154657     * @since PECL solr >= 0.9.2
154658     **/
154659    public function getRawResponse(){}
154660
154661    /**
154662     * Returns the raw response headers from the server
154663     *
154664     * @return string Returns the raw response headers from the server.
154665     * @since PECL solr >= 0.9.2
154666     **/
154667    public function getRawResponseHeaders(){}
154668
154669    /**
154670     * Returns the full URL the request was sent to
154671     *
154672     * @return string Returns the full URL the request was sent to
154673     * @since PECL solr >= 0.9.2
154674     **/
154675    public function getRequestUrl(){}
154676
154677    /**
154678     * Returns a SolrObject representing the XML response from the server
154679     *
154680     * @return SolrObject Returns a SolrObject representing the XML
154681     *   response from the server
154682     * @since PECL solr >= 0.9.2
154683     **/
154684    public function getResponse(){}
154685
154686    /**
154687     * Sets the parse mode
154688     *
154689     * @param int $parser_mode SolrResponse::PARSE_SOLR_DOC parses
154690     *   documents in SolrDocument instances. SolrResponse::PARSE_SOLR_OBJ
154691     *   parses document into SolrObjects.
154692     * @return bool
154693     * @since PECL solr >= 0.9.2
154694     **/
154695    public function setParseMode($parser_mode){}
154696
154697    /**
154698     * Was the request a success
154699     *
154700     * Used to check if the request to the server was successful.
154701     *
154702     * @return bool Returns TRUE if it was successful and FALSE if it was
154703     *   not.
154704     * @since PECL solr >= 0.9.2
154705     **/
154706    public function success(){}
154707
154708}
154709/**
154710 * An exception thrown when there is an error produced by the Solr Server
154711 * itself.
154712 **/
154713class SolrServerException extends SolrException {
154714    /**
154715     * Returns internal information where the Exception was thrown
154716     *
154717     * @return array Returns an array containing internal information where
154718     *   the error was thrown. Used only for debugging by extension
154719     *   developers.
154720     * @since PECL solr >= 1.1.0, >=2.0.0
154721     **/
154722    public function getInternalInfo(){}
154723
154724}
154725/**
154726 * Represents a response to an update request.
154727 **/
154728final class SolrUpdateResponse extends SolrResponse {
154729    /**
154730     * @var integer
154731     **/
154732    const PARSE_SOLR_DOC = 0;
154733
154734    /**
154735     * @var integer
154736     **/
154737    const PARSE_SOLR_OBJ = 0;
154738
154739    /**
154740     * Constructor
154741     *
154742     * @since PECL solr >= 0.9.2
154743     **/
154744    public function __construct(){}
154745
154746    /**
154747     * Destructor
154748     *
154749     * @return void None
154750     * @since PECL solr >= 0.9.2
154751     **/
154752    public function __destruct(){}
154753
154754}
154755/**
154756 * Contains utility methods for retrieving the current extension version
154757 * and preparing query phrases. Also contains method for escaping query
154758 * strings and parsing XML responses.
154759 **/
154760abstract class SolrUtils {
154761    /**
154762     * Parses an response XML string into a SolrObject
154763     *
154764     * This method parses an response XML string from the Apache Solr server
154765     * into a SolrObject. It throws a SolrException if there was an error.
154766     *
154767     * @param string $xmlresponse The XML response string from the Solr
154768     *   server.
154769     * @param int $parse_mode Use SolrResponse::PARSE_SOLR_OBJ or
154770     *   SolrResponse::PARSE_SOLR_DOC
154771     * @return SolrObject Returns the SolrObject representing the XML
154772     *   response.
154773     * @since PECL solr >= 0.9.2
154774     **/
154775    public static function digestXmlResponse($xmlresponse, $parse_mode){}
154776
154777    /**
154778     * Escapes a lucene query string
154779     *
154780     * Lucene supports escaping special characters that are part of the query
154781     * syntax.
154782     *
154783     * The current list special characters are:
154784     *
154785     * + - && || ! ( ) { } [ ] ^ " ~ * ? : \ /
154786     *
154787     * These characters are part of the query syntax and must be escaped
154788     *
154789     * @param string $str This is the query string to be escaped.
154790     * @return string Returns the escaped string.
154791     * @since PECL solr >= 0.9.2
154792     **/
154793    public static function escapeQueryChars($str){}
154794
154795    /**
154796     * Returns the current version of the Solr extension
154797     *
154798     * Returns the current Solr version.
154799     *
154800     * @return string The current version of the Apache Solr extension.
154801     * @since PECL solr >= 0.9.2
154802     **/
154803    public static function getSolrVersion(){}
154804
154805    /**
154806     * Prepares a phrase from an unescaped lucene string
154807     *
154808     * @param string $str The lucene phrase.
154809     * @return string Returns the phrase contained in double quotes.
154810     * @since PECL solr >= 0.9.2
154811     **/
154812    public static function queryPhrase($str){}
154813
154814}
154815/**
154816 * The SphinxClient class provides object-oriented interface to Sphinx.
154817 **/
154818class SphinxClient {
154819    /**
154820     * Add query to multi-query batch
154821     *
154822     * Adds query with the current settings to multi-query batch. This method
154823     * doesn't affect current settings (sorting, filtering, grouping etc.) in
154824     * any way.
154825     *
154826     * @param string $query Query string.
154827     * @param string $index An index name (or names).
154828     * @param string $comment
154829     * @return int Returns an index in an array of results that will be
154830     *   returned by call or false on error.
154831     * @since PECL sphinx >= 0.1.0
154832     **/
154833    public function addQuery($query, $index, $comment){}
154834
154835    /**
154836     * Build text snippets
154837     *
154838     * Connects to searchd, requests it to generate excerpts (snippets) from
154839     * the given documents, and returns the results.
154840     *
154841     * @param array $docs Array of strings with documents' contents.
154842     * @param string $index Index name.
154843     * @param string $words Keywords to highlight.
154844     * @param array $opts Associative array of additional highlighting
154845     *   options (see below).
154846     * @return array Returns array of snippets on success.
154847     * @since PECL sphinx >= 0.1.0
154848     **/
154849    public function buildExcerpts($docs, $index, $words, $opts){}
154850
154851    /**
154852     * Extract keywords from query
154853     *
154854     * Extracts keywords from {@link query} using tokenizer settings for the
154855     * given {@link index}, optionally with per-keyword occurrence
154856     * statistics.
154857     *
154858     * @param string $query A query to extract keywords from.
154859     * @param string $index An index to get tokenizing settings and keyword
154860     *   occurrence statistics from.
154861     * @param bool $hits A boolean flag to enable/disable keyword
154862     *   statistics generation.
154863     * @return array Returns an array of associative arrays with
154864     *   per-keyword information.
154865     * @since PECL sphinx >= 0.1.0
154866     **/
154867    public function buildKeywords($query, $index, $hits){}
154868
154869    /**
154870     * Closes previously opened persistent connection
154871     *
154872     * @return bool
154873     * @since PECL sphinx >= 1.0.3
154874     **/
154875    public function close(){}
154876
154877    /**
154878     * Escape special characters
154879     *
154880     * Escapes characters that are treated as special operators by the query
154881     * language parser.
154882     *
154883     * @param string $string String to escape.
154884     * @return string Returns escaped string.
154885     * @since PECL sphinx >= 0.1.0
154886     **/
154887    public function escapeString($string){}
154888
154889    /**
154890     * Get the last error message
154891     *
154892     * Returns string with the last error message. If there were no errors
154893     * during the previous API call, empty string is returned. This method
154894     * doesn't reset the error message, so you can safely call it several
154895     * times.
154896     *
154897     * @return string Returns the last error message or an empty string if
154898     *   there were no errors.
154899     * @since PECL sphinx >= 0.1.0
154900     **/
154901    public function getLastError(){}
154902
154903    /**
154904     * Get the last warning
154905     *
154906     * Returns last warning message. If there were no warnings during the
154907     * previous API call, empty string is returned. This method doesn't reset
154908     * the warning, so you can safely call it several times.
154909     *
154910     * @return string Returns the last warning message or an empty string
154911     *   if there were no warnings.
154912     * @since PECL sphinx >= 0.1.0
154913     **/
154914    public function getLastWarning(){}
154915
154916    /**
154917     * Opens persistent connection to the server
154918     *
154919     * @return bool
154920     * @since PECL sphinx >= 1.0.3
154921     **/
154922    public function open(){}
154923
154924    /**
154925     * Execute search query
154926     *
154927     * Connects to searchd server, runs the given search query with the
154928     * current settings, obtains and returns the result set.
154929     *
154930     * @param string $query Query string.
154931     * @param string $index An index name (or names).
154932     * @param string $comment
154933     * @return array On success, {@link SphinxClient::query} returns a list
154934     *   of found matches and additional per-query statistics. The result set
154935     *   is a hash utilize other structures instead of hash) with the
154936     *   following keys and values: Result set structure Key Value
154937     *   description "matches" An array with found document IDs as keys and
154938     *   their weight and attributes values as values "total" Total number of
154939     *   matches found and retrieved (depends on your settings) "total_found"
154940     *   Total number of found documents matching the query "words" An array
154941     *   with words (case-folded and stemmed) as keys and per-word statistics
154942     *   as values "error" Query error message reported by searchd "warning"
154943     *   Query warning reported by searchd
154944     * @since PECL sphinx >= 0.1.0
154945     **/
154946    public function query($query, $index, $comment){}
154947
154948    /**
154949     * Clear all filters
154950     *
154951     * Clears all currently set filters. This call is normally required when
154952     * using multi-queries. You might want to set different filters for
154953     * different queries in the batch. To do that, you should call {@link
154954     * SphinxClient::resetFilters} and add new filters using the respective
154955     * calls.
154956     *
154957     * @return void
154958     * @since PECL sphinx >= 0.1.0
154959     **/
154960    public function resetFilters(){}
154961
154962    /**
154963     * Clear all group-by settings
154964     *
154965     * Clears all currently group-by settings, and disables group-by. This
154966     * call is normally required only when using multi-queries.
154967     *
154968     * @return void
154969     * @since PECL sphinx >= 0.1.0
154970     **/
154971    public function resetGroupBy(){}
154972
154973    /**
154974     * Run a batch of search queries
154975     *
154976     * Connects to searchd, runs a batch of all queries added using , obtains
154977     * and returns the result sets.
154978     *
154979     * @return array Returns FALSE on failure and array of result sets on
154980     *   success.
154981     * @since PECL sphinx >= 0.1.0
154982     **/
154983    public function runQueries(){}
154984
154985    /**
154986     * Change the format of result set array
154987     *
154988     * Controls the format of search results set arrays (whether matches
154989     * should be returned as an array or a hash).
154990     *
154991     * @param bool $array_result If {@link array_result} is FALSE, matches
154992     *   are returned as a hash with document IDs as keys, and other
154993     *   information (weight, attributes) as values. If {@link array_result}
154994     *   is TRUE, matches are returned as a plain array with complete
154995     *   per-match information including document IDs.
154996     * @return bool Always returns TRUE.
154997     * @since PECL sphinx >= 0.1.0
154998     **/
154999    public function setArrayResult($array_result){}
155000
155001    /**
155002     * Set connection timeout
155003     *
155004     * Sets connection timeout (in seconds) for searchd connection.
155005     *
155006     * @param float $timeout Timeout in seconds.
155007     * @return bool
155008     * @since PECL sphinx >= 0.1.0
155009     **/
155010    public function setConnectTimeout($timeout){}
155011
155012    /**
155013     * Set field weights
155014     *
155015     * Binds per-field weights by name.
155016     *
155017     * Match ranking can be affected by per-field weights. See Sphinx
155018     * documentation for an explanation on how phrase proximity ranking is
155019     * affected. This call lets you specify non-default weights for full-text
155020     * fields.
155021     *
155022     * The weights must be positive 32-bit integers, so be careful not to hit
155023     * 32-bit integer maximum. The final weight is a 32-bit integer too.
155024     * Default weight value is 1. Unknown field names are silently ignored.
155025     *
155026     * @param array $weights Associative array of field names and field
155027     *   weights.
155028     * @return bool
155029     * @since PECL sphinx >= 0.1.0
155030     **/
155031    public function setFieldWeights($weights){}
155032
155033    /**
155034     * Add new integer values set filter
155035     *
155036     * Adds new integer values set filter to the existing list of filters.
155037     *
155038     * @param string $attribute An attribute name.
155039     * @param array $values Plain array of integer values.
155040     * @param bool $exclude If set to TRUE, matching documents are excluded
155041     *   from the result set.
155042     * @return bool
155043     * @since PECL sphinx >= 0.1.0
155044     **/
155045    public function setFilter($attribute, $values, $exclude){}
155046
155047    /**
155048     * Add new float range filter
155049     *
155050     * Adds new float range filter to the existing list of filters. Only
155051     * those documents which have {@link attribute} value stored in the index
155052     * between {@link min} and {@link max} (including values that are exactly
155053     * equal to {@link min} or {@link max}) will be matched (or rejected, if
155054     * {@link exclude} is TRUE).
155055     *
155056     * @param string $attribute An attribute name.
155057     * @param float $min Minimum value.
155058     * @param float $max Maximum value.
155059     * @param bool $exclude If set to TRUE, matching documents are excluded
155060     *   from the result set.
155061     * @return bool
155062     * @since PECL sphinx >= 0.1.0
155063     **/
155064    public function setFilterFloatRange($attribute, $min, $max, $exclude){}
155065
155066    /**
155067     * Add new integer range filter
155068     *
155069     * Adds new integer range filter to the existing list of filters. Only
155070     * those documents which have {@link attribute} value stored in the index
155071     * between {@link min} and {@link max} (including values that are exactly
155072     * equal to {@link min} or {@link max}) will be matched (or rejected, if
155073     * {@link exclude} is TRUE).
155074     *
155075     * @param string $attribute An attribute name.
155076     * @param int $min Minimum value.
155077     * @param int $max Maximum value.
155078     * @param bool $exclude If set to TRUE, matching documents are excluded
155079     *   from the result set.
155080     * @return bool
155081     * @since PECL sphinx >= 0.1.0
155082     **/
155083    public function setFilterRange($attribute, $min, $max, $exclude){}
155084
155085    /**
155086     * Set anchor point for a geosphere distance calculations
155087     *
155088     * Sets anchor point for a geosphere distance (geodistance) calculations
155089     * and enables them.
155090     *
155091     * Once an anchor point is set, you can use magic "@geodist" attribute
155092     * name in your filters and/or sorting expressions.
155093     *
155094     * @param string $attrlat Name of a latitude attribute.
155095     * @param string $attrlong Name of a longitude attribute.
155096     * @param float $latitude Anchor latitude in radians.
155097     * @param float $longitude Anchor longitude in radians.
155098     * @return bool
155099     * @since PECL sphinx >= 0.1.0
155100     **/
155101    public function setGeoAnchor($attrlat, $attrlong, $latitude, $longitude){}
155102
155103    /**
155104     * Set grouping attribute
155105     *
155106     * Sets grouping attribute, function, and group sorting mode, and enables
155107     * grouping.
155108     *
155109     * Grouping feature is very similar to GROUP BY clause in SQL. Results
155110     * produced by this function call are going to be the same as produced by
155111     * the following pseudo code: SELECT ... GROUP BY $func($attribute) ORDER
155112     * BY $groupsort.
155113     *
155114     * @param string $attribute A string containing group-by attribute
155115     *   name.
155116     * @param int $func Constant, which sets a function applied to the
155117     *   attribute value in order to compute group-by key.
155118     * @param string $groupsort An optional clause controlling how the
155119     *   groups are sorted.
155120     * @return bool
155121     * @since PECL sphinx >= 0.1.0
155122     **/
155123    public function setGroupBy($attribute, $func, $groupsort){}
155124
155125    /**
155126     * Set attribute name for per-group distinct values count calculations
155127     *
155128     * Sets attribute name for per-group distinct values count calculations.
155129     * Only available for grouping queries. For each group, all values of
155130     * {@link attribute} will be stored, then the amount of distinct values
155131     * will be calculated and returned to the client. This feature is similar
155132     * to COUNT(DISTINCT) clause in SQL.
155133     *
155134     * @param string $attribute A string containing group-by attribute
155135     *   name.
155136     * @return bool
155137     * @since PECL sphinx >= 0.1.0
155138     **/
155139    public function setGroupDistinct($attribute){}
155140
155141    /**
155142     * Set a range of accepted document IDs
155143     *
155144     * Sets an accepted range of document IDs. Default range is from 0 to 0,
155145     * i.e. no limit. Only those records that have document ID between {@link
155146     * min} and {@link max} (including IDs exactly equal to {@link min} or
155147     * {@link max}) will be matched.
155148     *
155149     * @param int $min Minimum ID value.
155150     * @param int $max Maximum ID value.
155151     * @return bool
155152     * @since PECL sphinx >= 0.1.0
155153     **/
155154    public function setIDRange($min, $max){}
155155
155156    /**
155157     * Set per-index weights
155158     *
155159     * Sets per-index weights and enables weighted summing of match weights
155160     * across different indexes.
155161     *
155162     * @param array $weights An associative array mapping string index
155163     *   names to integer weights. Default is empty array, i.e. weighting
155164     *   summing is disabled.
155165     * @return bool
155166     * @since PECL sphinx >= 0.1.0
155167     **/
155168    public function setIndexWeights($weights){}
155169
155170    /**
155171     * Set offset and limit of the result set
155172     *
155173     * Sets {@link offset} into server-side result set and amount of matches
155174     * to return to client starting from that offset ({@link limit}). Can
155175     * additionally control maximum server-side result set size for current
155176     * query ({@link max_matches}) and the threshold amount of matches to
155177     * stop searching at ({@link cutoff}).
155178     *
155179     * @param int $offset Result set offset.
155180     * @param int $limit Amount of matches to return.
155181     * @param int $max_matches Controls how much matches searchd will keep
155182     *   in RAM while searching.
155183     * @param int $cutoff Used for advanced performance control. It tells
155184     *   searchd to forcibly stop search query once {@link cutoff} matches
155185     *   have been found and processed.
155186     * @return bool
155187     * @since PECL sphinx >= 0.1.0
155188     **/
155189    public function setLimits($offset, $limit, $max_matches, $cutoff){}
155190
155191    /**
155192     * Set full-text query matching mode
155193     *
155194     * Sets full-text query matching mode. {@link mode} is one of the
155195     * constants listed below. Match modes Constant Description SPH_MATCH_ALL
155196     * Match all query words (default mode). SPH_MATCH_ANY Match any of query
155197     * words. SPH_MATCH_PHRASE Match query as a phrase, requiring perfect
155198     * match. SPH_MATCH_BOOLEAN Match query as a boolean expression.
155199     * SPH_MATCH_EXTENDED Match query as an expression in Sphinx internal
155200     * query language. SPH_MATCH_FULLSCAN Enables fullscan.
155201     * SPH_MATCH_EXTENDED2 The same as SPH_MATCH_EXTENDED plus ranking and
155202     * quorum searching support.
155203     *
155204     * @param int $mode Matching mode.
155205     * @return bool
155206     * @since PECL sphinx >= 0.1.0
155207     **/
155208    public function setMatchMode($mode){}
155209
155210    /**
155211     * Set maximum query time
155212     *
155213     * Sets maximum search query time.
155214     *
155215     * @param int $qtime Maximum query time, in milliseconds. It must be a
155216     *   non-negative integer. Default value is 0, i.e. no limit.
155217     * @return bool
155218     * @since PECL sphinx >= 0.1.0
155219     **/
155220    public function setMaxQueryTime($qtime){}
155221
155222    /**
155223     * Sets temporary per-document attribute value overrides
155224     *
155225     * Sets temporary (per-query) per-document attribute value overrides.
155226     * Override feature lets you "temporary" update attribute values for some
155227     * documents within a single query, leaving all other queries unaffected.
155228     * This might be useful for personalized data
155229     *
155230     * @param string $attribute An attribute name.
155231     * @param int $type An attribute type. Only supports scalar attributes.
155232     * @param array $values Array of attribute values that maps document
155233     *   IDs to overridden attribute values.
155234     * @return bool
155235     * @since PECL sphinx >= 1.0.3
155236     **/
155237    public function setOverride($attribute, $type, $values){}
155238
155239    /**
155240     * Set ranking mode
155241     *
155242     * Sets ranking mode. Only available in SPH_MATCH_EXTENDED2 matching
155243     * mode. Ranking modes Constant Description SPH_RANK_PROXIMITY_BM25
155244     * Default ranking mode which uses both proximity and BM25 ranking.
155245     * SPH_RANK_BM25 Statistical ranking mode which uses BM25 ranking only
155246     * (similar to most of other full-text engines). This mode is faster, but
155247     * may result in worse quality on queries which contain more than 1
155248     * keyword. SPH_RANK_NONE Disables ranking. This mode is the fastest. It
155249     * is essentially equivalent to boolean searching, a weight of 1 is
155250     * assigned to all matches.
155251     *
155252     * @param int $ranker Ranking mode.
155253     * @return bool
155254     * @since PECL sphinx >= 0.1.0
155255     **/
155256    public function setRankingMode($ranker){}
155257
155258    /**
155259     * Set retry count and delay
155260     *
155261     * Sets distributed retry count and delay.
155262     *
155263     * On temporary failures searchd will attempt up to {@link count} retries
155264     * per agent. {@link delay} is the delay between the retries, in
155265     * milliseconds. Retries are disabled by default. Note that this call
155266     * will not make the API itself retry on temporary failure; it only tells
155267     * searchd to do so.
155268     *
155269     * @param int $count Number of retries.
155270     * @param int $delay Delay between retries, in milliseconds.
155271     * @return bool
155272     * @since PECL sphinx >= 0.1.0
155273     **/
155274    public function setRetries($count, $delay){}
155275
155276    /**
155277     * Set select clause
155278     *
155279     * Sets the select clause, listing specific attributes to fetch, and
155280     * expressions to compute and fetch.
155281     *
155282     * @param string $clause SQL-like clause.
155283     * @return bool
155284     * @since PECL sphinx >= 1.0.1
155285     **/
155286    public function setSelect($clause){}
155287
155288    /**
155289     * Set searchd host and port
155290     *
155291     * Sets searchd host name and TCP port. All subsequent requests will use
155292     * the new host and port settings. Default host and port are 'localhost'
155293     * and 3312, respectively.
155294     *
155295     * @param string $server IP or hostname.
155296     * @param int $port Port number.
155297     * @return bool
155298     * @since PECL sphinx >= 0.1.0
155299     **/
155300    public function setServer($server, $port){}
155301
155302    /**
155303     * Set matches sorting mode
155304     *
155305     * Sets matches sorting mode. See available modes below. Sorting modes
155306     * Constant Description SPH_SORT_RELEVANCE Sort by relevance in
155307     * descending order (best matches first). SPH_SORT_ATTR_DESC Sort by an
155308     * attribute in descending order (bigger attribute values first).
155309     * SPH_SORT_ATTR_ASC Sort by an attribute in ascending order (smaller
155310     * attribute values first). SPH_SORT_TIME_SEGMENTS Sort by time segments
155311     * (last hour/day/week/month) in descending order, and then by relevance
155312     * in descending order. SPH_SORT_EXTENDED Sort by SQL-like combination of
155313     * columns in ASC/DESC order. SPH_SORT_EXPR Sort by an arithmetic
155314     * expression.
155315     *
155316     * @param int $mode Sorting mode.
155317     * @param string $sortby
155318     * @return bool
155319     * @since PECL sphinx >= 0.1.0
155320     **/
155321    public function setSortMode($mode, $sortby){}
155322
155323    /**
155324     * Queries searchd status
155325     *
155326     * Queries searchd status, and returns an array of status variable name
155327     * and value pairs.
155328     *
155329     * @return array Returns an associative array of search server
155330     *   statistics.
155331     * @since PECL sphinx >= 1.0.3
155332     **/
155333    public function status(){}
155334
155335    /**
155336     * Update document attributes
155337     *
155338     * Instantly updates given attribute values in given documents.
155339     *
155340     * @param string $index Name of the index (or indexes) to be updated.
155341     * @param array $attributes Array of attribute names, listing
155342     *   attributes that are updated.
155343     * @param array $values Associative array containing document IDs as
155344     *   keys and array of attribute values as values.
155345     * @param bool $mva
155346     * @return int Returns number of actually updated documents (0 or more)
155347     *   on success, or FALSE on failure.
155348     * @since PECL sphinx >= 0.1.0
155349     **/
155350    public function updateAttributes($index, $attributes, $values, $mva){}
155351
155352    /**
155353     * Create a new SphinxClient object
155354     *
155355     * Creates a new SphinxClient object.
155356     *
155357     * @since PECL sphinx >= 0.1.0
155358     **/
155359    public function __construct(){}
155360
155361}
155362/**
155363 * The SplBool class is used to enforce strong typing of the bool type.
155364 * SplBool usage example
155365 *
155366 * TRUE
155367 **/
155368class SplBool extends SplEnum {
155369    /**
155370     * @var boolean
155371     **/
155372    const false = 0;
155373
155374    /**
155375     * @var boolean
155376     **/
155377    const true = 0;
155378
155379    /**
155380     * @var boolean
155381     **/
155382    const __default = 0;
155383
155384}
155385/**
155386 * The SplDoublyLinkedList class provides the main functionalities of a
155387 * doubly linked list.
155388 **/
155389class SplDoublyLinkedList implements Iterator, ArrayAccess, Countable, Serializable {
155390    /**
155391     * @var integer
155392     **/
155393    const IT_MODE_DELETE = 0;
155394
155395    /**
155396     * @var integer
155397     **/
155398    const IT_MODE_FIFO = 0;
155399
155400    /**
155401     * @var integer
155402     **/
155403    const IT_MODE_KEEP = 0;
155404
155405    /**
155406     * @var integer
155407     **/
155408    const IT_MODE_LIFO = 0;
155409
155410    /**
155411     * Add/insert a new value at the specified index
155412     *
155413     * Insert the value {@link newval} at the specified {@link index},
155414     * shuffling the previous value at that index (and all subsequent values)
155415     * up through the list.
155416     *
155417     * @param mixed $index The index where the new value is to be inserted.
155418     * @param mixed $newval The new value for the {@link index}.
155419     * @return void
155420     * @since PHP 5 >= 5.5.0, PHP 7
155421     **/
155422    public function add($index, $newval){}
155423
155424    /**
155425     * Peeks at the node from the beginning of the doubly linked list
155426     *
155427     * @return mixed The value of the first node.
155428     * @since PHP 5 >= 5.3.0, PHP 7
155429     **/
155430    public function bottom(){}
155431
155432    /**
155433     * Counts the number of elements in the doubly linked list
155434     *
155435     * @return int Returns the number of elements in the doubly linked
155436     *   list.
155437     * @since PHP 5 >= 5.3.0, PHP 7
155438     **/
155439    public function count(){}
155440
155441    /**
155442     * Return current array entry
155443     *
155444     * Get the current doubly linked list node.
155445     *
155446     * @return mixed The current node value.
155447     * @since PHP 5 >= 5.3.0, PHP 7
155448     **/
155449    public function current(){}
155450
155451    /**
155452     * Returns the mode of iteration
155453     *
155454     * @return int Returns the different modes and flags that affect the
155455     *   iteration.
155456     * @since PHP 5 >= 5.3.0, PHP 7
155457     **/
155458    public function getIteratorMode(){}
155459
155460    /**
155461     * Checks whether the doubly linked list is empty
155462     *
155463     * @return bool Returns whether the doubly linked list is empty.
155464     * @since PHP 5 >= 5.3.0, PHP 7
155465     **/
155466    public function isEmpty(){}
155467
155468    /**
155469     * Return current node index
155470     *
155471     * This function returns the current node index
155472     *
155473     * @return mixed The current node index.
155474     * @since PHP 5 >= 5.3.0, PHP 7
155475     **/
155476    public function key(){}
155477
155478    /**
155479     * Move to next entry
155480     *
155481     * Move the iterator to the next node.
155482     *
155483     * @return void
155484     * @since PHP 5 >= 5.3.0, PHP 7
155485     **/
155486    public function next(){}
155487
155488    /**
155489     * Returns whether the requested $index exists
155490     *
155491     * @param mixed $index The index being checked.
155492     * @return bool TRUE if the requested {@link index} exists, otherwise
155493     *   FALSE
155494     * @since PHP 5 >= 5.3.0, PHP 7
155495     **/
155496    public function offsetExists($index){}
155497
155498    /**
155499     * Returns the value at the specified $index
155500     *
155501     * @param mixed $index The index with the value.
155502     * @return mixed The value at the specified {@link index}.
155503     * @since PHP 5 >= 5.3.0, PHP 7
155504     **/
155505    public function offsetGet($index){}
155506
155507    /**
155508     * Sets the value at the specified $index to $newval
155509     *
155510     * Sets the value at the specified {@link index} to {@link newval}.
155511     *
155512     * @param mixed $index The index being set.
155513     * @param mixed $newval The new value for the {@link index}.
155514     * @return void
155515     * @since PHP 5 >= 5.3.0, PHP 7
155516     **/
155517    public function offsetSet($index, $newval){}
155518
155519    /**
155520     * Unsets the value at the specified $index
155521     *
155522     * Unsets the value at the specified index.
155523     *
155524     * @param mixed $index The index being unset.
155525     * @return void
155526     * @since PHP 5 >= 5.3.0, PHP 7
155527     **/
155528    public function offsetUnset($index){}
155529
155530    /**
155531     * Pops a node from the end of the doubly linked list
155532     *
155533     * @return mixed The value of the popped node.
155534     * @since PHP 5 >= 5.3.0, PHP 7
155535     **/
155536    public function pop(){}
155537
155538    /**
155539     * Move to previous entry
155540     *
155541     * Move the iterator to the previous node.
155542     *
155543     * @return void
155544     * @since PHP 5 >= 5.3.0, PHP 7
155545     **/
155546    public function prev(){}
155547
155548    /**
155549     * Pushes an element at the end of the doubly linked list
155550     *
155551     * Pushes {@link value} at the end of the doubly linked list.
155552     *
155553     * @param mixed $value The value to push.
155554     * @return void
155555     * @since PHP 5 >= 5.3.0, PHP 7
155556     **/
155557    public function push($value){}
155558
155559    /**
155560     * Rewind iterator back to the start
155561     *
155562     * This rewinds the iterator to the beginning.
155563     *
155564     * @return void
155565     * @since PHP 5 >= 5.3.0, PHP 7
155566     **/
155567    public function rewind(){}
155568
155569    /**
155570     * Serializes the storage
155571     *
155572     * @return string The serialized string.
155573     * @since PHP 5 >= 5.4.0, PHP 7
155574     **/
155575    public function serialize(){}
155576
155577    /**
155578     * Sets the mode of iteration
155579     *
155580     * @param int $mode There are two orthogonal sets of modes that can be
155581     *   set: The default mode is: SplDoublyLinkedList::IT_MODE_FIFO |
155582     *   SplDoublyLinkedList::IT_MODE_KEEP
155583     * @return void
155584     * @since PHP 5 >= 5.3.0, PHP 7
155585     **/
155586    public function setIteratorMode($mode){}
155587
155588    /**
155589     * Shifts a node from the beginning of the doubly linked list
155590     *
155591     * @return mixed The value of the shifted node.
155592     * @since PHP 5 >= 5.3.0, PHP 7
155593     **/
155594    public function shift(){}
155595
155596    /**
155597     * Peeks at the node from the end of the doubly linked list
155598     *
155599     * @return mixed The value of the last node.
155600     * @since PHP 5 >= 5.3.0, PHP 7
155601     **/
155602    public function top(){}
155603
155604    /**
155605     * Unserializes the storage
155606     *
155607     * Unserializes the storage, from SplDoublyLinkedList::serialize.
155608     *
155609     * @param string $serialized The serialized string.
155610     * @return void
155611     * @since PHP 5 >= 5.4.0, PHP 7
155612     **/
155613    public function unserialize($serialized){}
155614
155615    /**
155616     * Prepends the doubly linked list with an element
155617     *
155618     * Prepends {@link value} at the beginning of the doubly linked list.
155619     *
155620     * @param mixed $value The value to unshift.
155621     * @return void
155622     * @since PHP 5 >= 5.3.0, PHP 7
155623     **/
155624    public function unshift($value){}
155625
155626    /**
155627     * Check whether the doubly linked list contains more nodes
155628     *
155629     * Checks if the doubly linked list contains any more nodes.
155630     *
155631     * @return bool Returns TRUE if the doubly linked list contains any
155632     *   more nodes, FALSE otherwise.
155633     * @since PHP 5 >= 5.3.0, PHP 7
155634     **/
155635    public function valid(){}
155636
155637}
155638/**
155639 * SplEnum gives the ability to emulate and create enumeration objects
155640 * natively in PHP. SplEnum usage example
155641 *
155642 * 6 Value not a const in enum Month
155643 **/
155644class SplEnum extends SplType {
155645    /**
155646     * @var NULL
155647     **/
155648    const __default = 0;
155649
155650    /**
155651     * Returns all consts (possible values) as an array
155652     *
155653     * @param bool $include_default Whether to include __default property.
155654     * @return array
155655     * @since PECL spl_types >= 0.1.0
155656     **/
155657    public function getConstList($include_default){}
155658
155659}
155660/**
155661 * The SplFileInfo class offers a high-level object oriented interface to
155662 * information for an individual file.
155663 **/
155664class SplFileInfo {
155665    /**
155666     * Gets last access time of the file
155667     *
155668     * Gets the last access time for the file.
155669     *
155670     * @return int Returns the time the file was last accessed.
155671     * @since PHP 5 >= 5.1.2, PHP 7
155672     **/
155673    public function getATime(){}
155674
155675    /**
155676     * Gets the base name of the file
155677     *
155678     * This method returns the base name of the file, directory, or link
155679     * without path info.
155680     *
155681     * @param string $suffix Optional suffix to omit from the base name
155682     *   returned.
155683     * @return string Returns the base name without path information.
155684     * @since PHP 5 >= 5.2.2, PHP 7
155685     **/
155686    public function getBasename($suffix){}
155687
155688    /**
155689     * Gets the inode change time
155690     *
155691     * Returns the inode change time for the file. The time returned is a
155692     * Unix timestamp.
155693     *
155694     * @return int The last change time, in a Unix timestamp.
155695     * @since PHP 5 >= 5.1.2, PHP 7
155696     **/
155697    public function getCTime(){}
155698
155699    /**
155700     * Gets the file extension
155701     *
155702     * Retrieves the file extension.
155703     *
155704     * @return string Returns a string containing the file extension, or an
155705     *   empty string if the file has no extension.
155706     * @since PHP 5 >= 5.3.6, PHP 7
155707     **/
155708    public function getExtension(){}
155709
155710    /**
155711     * Gets an SplFileInfo object for the file
155712     *
155713     * This method gets an SplFileInfo object for the referenced file.
155714     *
155715     * @param string $class_name Name of an SplFileInfo derived class to
155716     *   use.
155717     * @return SplFileInfo An SplFileInfo object created for the file.
155718     * @since PHP 5 >= 5.1.2, PHP 7
155719     **/
155720    public function getFileInfo($class_name){}
155721
155722    /**
155723     * Gets the filename
155724     *
155725     * Gets the filename without any path information.
155726     *
155727     * @return string The filename.
155728     * @since PHP 5 >= 5.1.2, PHP 7
155729     **/
155730    public function getFilename(){}
155731
155732    /**
155733     * Gets the file group
155734     *
155735     * Gets the file group. The group ID is returned in numerical format.
155736     *
155737     * @return int The group id in numerical format.
155738     * @since PHP 5 >= 5.1.2, PHP 7
155739     **/
155740    public function getGroup(){}
155741
155742    /**
155743     * Gets the inode for the file
155744     *
155745     * Gets the inode number for the filesystem object.
155746     *
155747     * @return int Returns the inode number for the filesystem object.
155748     * @since PHP 5 >= 5.1.2, PHP 7
155749     **/
155750    public function getInode(){}
155751
155752    /**
155753     * Gets the target of a link
155754     *
155755     * Gets the target of a filesystem link.
155756     *
155757     * @return string Returns the target of the filesystem link.
155758     * @since PHP 5 >= 5.2.2, PHP 7
155759     **/
155760    public function getLinkTarget(){}
155761
155762    /**
155763     * Gets the last modified time
155764     *
155765     * Returns the time when the contents of the file were changed. The time
155766     * returned is a Unix timestamp.
155767     *
155768     * @return int Returns the last modified time for the file, in a Unix
155769     *   timestamp.
155770     * @since PHP 5 >= 5.1.2, PHP 7
155771     **/
155772    public function getMTime(){}
155773
155774    /**
155775     * Gets the owner of the file
155776     *
155777     * Gets the file owner. The owner ID is returned in numerical format.
155778     *
155779     * @return int The owner id in numerical format.
155780     * @since PHP 5 >= 5.1.2, PHP 7
155781     **/
155782    public function getOwner(){}
155783
155784    /**
155785     * Gets the path without filename
155786     *
155787     * Returns the path to the file, omitting the filename and any trailing
155788     * slash.
155789     *
155790     * @return string Returns the path to the file.
155791     * @since PHP 5 >= 5.1.2, PHP 7
155792     **/
155793    public function getPath(){}
155794
155795    /**
155796     * Gets an SplFileInfo object for the path
155797     *
155798     * Gets an SplFileInfo object for the parent of the current file.
155799     *
155800     * @param string $class_name Name of an SplFileInfo derived class to
155801     *   use.
155802     * @return SplFileInfo Returns an SplFileInfo object for the parent
155803     *   path of the file.
155804     * @since PHP 5 >= 5.1.2, PHP 7
155805     **/
155806    public function getPathInfo($class_name){}
155807
155808    /**
155809     * Gets the path to the file
155810     *
155811     * Returns the path to the file.
155812     *
155813     * @return string The path to the file.
155814     * @since PHP 5 >= 5.1.2, PHP 7
155815     **/
155816    public function getPathname(){}
155817
155818    /**
155819     * Gets file permissions
155820     *
155821     * Gets the file permissions for the file.
155822     *
155823     * @return int Returns the file permissions.
155824     * @since PHP 5 >= 5.1.2, PHP 7
155825     **/
155826    public function getPerms(){}
155827
155828    /**
155829     * Gets absolute path to file
155830     *
155831     * This method expands all symbolic links, resolves relative references
155832     * and returns the real path to the file.
155833     *
155834     * @return string Returns the path to the file, or FALSE if the file
155835     *   does not exist.
155836     * @since PHP 5 >= 5.2.2, PHP 7
155837     **/
155838    public function getRealPath(){}
155839
155840    /**
155841     * Gets file size
155842     *
155843     * Returns the filesize in bytes for the file referenced.
155844     *
155845     * @return int The filesize in bytes.
155846     * @since PHP 5 >= 5.1.2, PHP 7
155847     **/
155848    public function getSize(){}
155849
155850    /**
155851     * Gets file type
155852     *
155853     * Returns the type of the file referenced.
155854     *
155855     * @return string A string representing the type of the entry. May be
155856     *   one of file, link, or dir
155857     * @since PHP 5 >= 5.1.2, PHP 7
155858     **/
155859    public function getType(){}
155860
155861    /**
155862     * Tells if the file is a directory
155863     *
155864     * This method can be used to determine if the file is a directory.
155865     *
155866     * @return bool Returns TRUE if a directory, FALSE otherwise.
155867     * @since PHP 5 >= 5.1.2, PHP 7
155868     **/
155869    public function isDir(){}
155870
155871    /**
155872     * Tells if the file is executable
155873     *
155874     * Checks if the file is executable.
155875     *
155876     * @return bool Returns TRUE if executable, FALSE otherwise.
155877     * @since PHP 5 >= 5.1.2, PHP 7
155878     **/
155879    public function isExecutable(){}
155880
155881    /**
155882     * Tells if the object references a regular file
155883     *
155884     * Checks if the file referenced by this SplFileInfo object exists and is
155885     * a regular file.
155886     *
155887     * @return bool Returns TRUE if the file exists and is a regular file
155888     *   (not a link), FALSE otherwise.
155889     * @since PHP 5 >= 5.1.2, PHP 7
155890     **/
155891    public function isFile(){}
155892
155893    /**
155894     * Tells if the file is a link
155895     *
155896     * Use this method to check if the file referenced by the SplFileInfo
155897     * object is a link.
155898     *
155899     * @return bool Returns TRUE if the file is a link, FALSE otherwise.
155900     * @since PHP 5 >= 5.1.2, PHP 7
155901     **/
155902    public function isLink(){}
155903
155904    /**
155905     * Tells if file is readable
155906     *
155907     * Check if the file is readable.
155908     *
155909     * @return bool Returns TRUE if readable, FALSE otherwise.
155910     * @since PHP 5 >= 5.1.2, PHP 7
155911     **/
155912    public function isReadable(){}
155913
155914    /**
155915     * Tells if the entry is writable
155916     *
155917     * Checks if the current entry is writable.
155918     *
155919     * @return bool Returns TRUE if writable, FALSE otherwise;
155920     * @since PHP 5 >= 5.1.2, PHP 7
155921     **/
155922    public function isWritable(){}
155923
155924    /**
155925     * Gets an SplFileObject object for the file
155926     *
155927     * Creates an SplFileObject object of the file. This is useful because
155928     * SplFileObject contains additional methods for manipulating the file
155929     * whereas SplFileInfo is only useful for gaining information, like
155930     * whether the file is writable.
155931     *
155932     * @param string $open_mode The mode for opening the file. See the
155933     *   {@link fopen} documentation for descriptions of possible modes. The
155934     *   default is read only.
155935     * @param bool $use_include_path
155936     * @param resource $context
155937     * @return SplFileObject The opened file as an SplFileObject object.
155938     * @since PHP 5 >= 5.1.2, PHP 7
155939     **/
155940    public function openFile($open_mode, $use_include_path, $context){}
155941
155942    /**
155943     * Sets the class used with
155944     *
155945     * Use this method to set a custom class which will be used when
155946     * SplFileInfo::openFile is called. The class name passed to this method
155947     * must be SplFileObject or a class derived from SplFileObject.
155948     *
155949     * @param string $class_name The class name to use when
155950     *   SplFileInfo::openFile is called.
155951     * @return void
155952     * @since PHP 5 >= 5.1.2, PHP 7
155953     **/
155954    public function setFileClass($class_name){}
155955
155956    /**
155957     * Sets the class used with and
155958     *
155959     * Use this method to set a custom class which will be used when
155960     * SplFileInfo::getFileInfo and SplFileInfo::getPathInfo are called. The
155961     * class name passed to this method must be SplFileInfo or a class
155962     * derived from SplFileInfo.
155963     *
155964     * @param string $class_name The class name to use when
155965     *   SplFileInfo::getFileInfo and SplFileInfo::getPathInfo are called.
155966     * @return void
155967     * @since PHP 5 >= 5.1.2, PHP 7
155968     **/
155969    public function setInfoClass($class_name){}
155970
155971    /**
155972     * Returns the path to the file as a string
155973     *
155974     * This method will return the file name of the referenced file.
155975     *
155976     * @return string Returns the path to the file.
155977     * @since PHP 5 >= 5.1.2, PHP 7
155978     **/
155979    public function __toString(){}
155980
155981}
155982/**
155983 * The SplFileObject class offers an object oriented interface for a
155984 * file.
155985 **/
155986class SplFileObject extends SplFileInfo implements RecursiveIterator, SeekableIterator {
155987    /**
155988     * @var integer
155989     **/
155990    const DROP_NEW_LINE = 0;
155991
155992    /**
155993     * @var integer
155994     **/
155995    const READ_AHEAD = 0;
155996
155997    /**
155998     * @var integer
155999     **/
156000    const READ_CSV = 0;
156001
156002    /**
156003     * @var integer
156004     **/
156005    const SKIP_EMPTY = 0;
156006
156007    /**
156008     * Retrieve current line of file
156009     *
156010     * Retrieves the current line of the file.
156011     *
156012     * @return string|array Retrieves the current line of the file. If the
156013     *   SplFileObject::READ_CSV flag is set, this method returns an array
156014     *   containing the current line parsed as CSV data.
156015     * @since PHP 5 >= 5.1.0, PHP 7
156016     **/
156017    public function current(){}
156018
156019    /**
156020     * Reached end of file
156021     *
156022     * Determine whether the end of file has been reached
156023     *
156024     * @return bool Returns TRUE if file is at EOF, FALSE otherwise.
156025     * @since PHP 5 >= 5.1.0, PHP 7
156026     **/
156027    public function eof(){}
156028
156029    /**
156030     * Flushes the output to the file
156031     *
156032     * Forces a write of all buffered output to the file.
156033     *
156034     * @return bool
156035     * @since PHP 5 >= 5.1.0, PHP 7
156036     **/
156037    public function fflush(){}
156038
156039    /**
156040     * Gets character from file
156041     *
156042     * Gets a character from the file.
156043     *
156044     * @return string Returns a string containing a single character read
156045     *   from the file or FALSE on EOF.
156046     * @since PHP 5 >= 5.1.0, PHP 7
156047     **/
156048    public function fgetc(){}
156049
156050    /**
156051     * Gets line from file and parse as CSV fields
156052     *
156053     * Gets a line from the file which is in CSV format and returns an array
156054     * containing the fields read.
156055     *
156056     * @param string $delimiter The field delimiter (one character only).
156057     *   Defaults as a comma or the value set using
156058     *   SplFileObject::setCsvControl.
156059     * @param string $enclosure The field enclosure character (one
156060     *   character only). Defaults as a double quotation mark or the value
156061     *   set using SplFileObject::setCsvControl.
156062     * @param string $escape The escape character (at most one character).
156063     *   Defaults as a backslash (\) or the value set using
156064     *   SplFileObject::setCsvControl. An empty string ("") disables the
156065     *   proprietary escape mechanism.
156066     * @return array Returns an indexed array containing the fields read,
156067     *   or FALSE on error.
156068     * @since PHP 5 >= 5.1.0, PHP 7
156069     **/
156070    public function fgetcsv($delimiter, $enclosure, $escape){}
156071
156072    /**
156073     * Gets line from file
156074     *
156075     * Gets a line from the file.
156076     *
156077     * @return string Returns a string containing the next line from the
156078     *   file, or FALSE on error.
156079     * @since PHP 5 >= 5.1.0, PHP 7
156080     **/
156081    public function fgets(){}
156082
156083    /**
156084     * Gets line from file and strip HTML tags
156085     *
156086     * Identical to SplFileObject::fgets, except that SplFileObject::fgetss
156087     * attempts to strip any HTML and PHP tags from the text it reads. The
156088     * function retains the parsing state from call to call, and as such is
156089     * not equivalent to calling {@link strip_tags} on the return value of
156090     * SplFileObject::fgets.
156091     *
156092     * @param string $allowable_tags Optional parameter to specify tags
156093     *   which should not be stripped.
156094     * @return string Returns a string containing the next line of the file
156095     *   with HTML and PHP code stripped, or FALSE on error.
156096     * @since PHP 5 >= 5.1.0, PHP 7
156097     **/
156098    public function fgetss($allowable_tags){}
156099
156100    /**
156101     * Portable file locking
156102     *
156103     * Locks or unlocks the file in the same portable way as {@link flock}.
156104     *
156105     * @param int $operation {@link operation} is one of the following:
156106     *   LOCK_SH to acquire a shared lock (reader). LOCK_EX to acquire an
156107     *   exclusive lock (writer). LOCK_UN to release a lock (shared or
156108     *   exclusive). LOCK_NB to not block while locking.
156109     * @param int $wouldblock Set to TRUE if the lock would block
156110     *   (EWOULDBLOCK errno condition).
156111     * @return bool
156112     * @since PHP 5 >= 5.1.0, PHP 7
156113     **/
156114    public function flock($operation, &$wouldblock){}
156115
156116    /**
156117     * Output all remaining data on a file pointer
156118     *
156119     * Reads to EOF on the given file pointer from the current position and
156120     * writes the results to the output buffer.
156121     *
156122     * You may need to call SplFileObject::rewind to reset the file pointer
156123     * to the beginning of the file if you have already written data to the
156124     * file.
156125     *
156126     * @return int Returns the number of characters read from {@link
156127     *   handle} and passed through to the output.
156128     * @since PHP 5 >= 5.1.0, PHP 7
156129     **/
156130    public function fpassthru(){}
156131
156132    /**
156133     * Write a field array as a CSV line
156134     *
156135     * Writes the {@link fields} array to the file as a CSV line.
156136     *
156137     * @param array $fields An array of values.
156138     * @param string $delimiter The optional {@link delimiter} parameter
156139     *   sets the field delimiter (one character only).
156140     * @param string $enclosure The optional {@link enclosure} parameter
156141     *   sets the field enclosure (one character only).
156142     * @param string $escape The optional {@link escape} parameter sets the
156143     *   escape character (at most one character). An empty string ("")
156144     *   disables the proprietary escape mechanism.
156145     * @return int Returns the length of the written string.
156146     * @since PHP 5 >= 5.4.0, PHP 7
156147     **/
156148    public function fputcsv($fields, $delimiter, $enclosure, $escape){}
156149
156150    /**
156151     * Read from file
156152     *
156153     * Reads the given number of bytes from the file.
156154     *
156155     * @param int $length The number of bytes to read.
156156     * @return string Returns the string read from the file .
156157     * @since PHP 5 >= 5.5.11, PHP 7
156158     **/
156159    public function fread($length){}
156160
156161    /**
156162     * Parses input from file according to a format
156163     *
156164     * Reads a line from the file and interprets it according to the
156165     * specified {@link format}, which is described in the documentation for
156166     * {@link sprintf}.
156167     *
156168     * Any whitespace in the {@link format} string matches any whitespace in
156169     * the line from the file. This means that even a tab \t in the format
156170     * string can match a single space character in the input stream.
156171     *
156172     * @param string $format The optional assigned values.
156173     * @param mixed ...$vararg
156174     * @return mixed If only one parameter is passed to this method, the
156175     *   values parsed will be returned as an array. Otherwise, if optional
156176     *   parameters are passed, the function will return the number of
156177     *   assigned values. The optional parameters must be passed by
156178     *   reference.
156179     * @since PHP 5 >= 5.1.0, PHP 7
156180     **/
156181    public function fscanf($format, &...$vararg){}
156182
156183    /**
156184     * Seek to a position
156185     *
156186     * Seek to a position in the file measured in bytes from the beginning of
156187     * the file, obtained by adding {@link offset} to the position specified
156188     * by {@link whence}.
156189     *
156190     * @param int $offset The offset. A negative value can be used to move
156191     *   backwards through the file which is useful when SEEK_END is used as
156192     *   the {@link whence} value.
156193     * @param int $whence {@link whence} values are: SEEK_SET - Set
156194     *   position equal to {@link offset} bytes. SEEK_CUR - Set position to
156195     *   current location plus {@link offset}. SEEK_END - Set position to
156196     *   end-of-file plus {@link offset}. If {@link whence} is not specified,
156197     *   it is assumed to be SEEK_SET.
156198     * @return int Returns 0 if the seek was successful, -1 otherwise. Note
156199     *   that seeking past EOF is not considered an error.
156200     * @since PHP 5 >= 5.1.0, PHP 7
156201     **/
156202    public function fseek($offset, $whence){}
156203
156204    /**
156205     * Gets information about the file
156206     *
156207     * Gathers the statistics of the file. Behaves identically to {@link
156208     * fstat}.
156209     *
156210     * @return array Returns an array with the statistics of the file; the
156211     *   format of the array is described in detail on the {@link stat}
156212     *   manual page.
156213     * @since PHP 5 >= 5.1.0, PHP 7
156214     **/
156215    public function fstat(){}
156216
156217    /**
156218     * Return current file position
156219     *
156220     * Returns the position of the file pointer which represents the current
156221     * offset in the file stream.
156222     *
156223     * @return int Returns the position of the file pointer as an integer,
156224     *   or FALSE on error.
156225     * @since PHP 5 >= 5.1.0, PHP 7
156226     **/
156227    public function ftell(){}
156228
156229    /**
156230     * Truncates the file to a given length
156231     *
156232     * Truncates the file to {@link size} bytes.
156233     *
156234     * @param int $size The size to truncate to.
156235     * @return bool
156236     * @since PHP 5 >= 5.1.0, PHP 7
156237     **/
156238    public function ftruncate($size){}
156239
156240    /**
156241     * Write to file
156242     *
156243     * Writes the contents of {@link string} to the file
156244     *
156245     * @param string $str The string to be written to the file.
156246     * @param int $length If the {@link length} argument is given, writing
156247     *   will stop after {@link length} bytes have been written or the end of
156248     *   {@link string} is reached, whichever comes first.
156249     * @return int Returns the number of bytes written, or FALSE on error.
156250     * @since PHP 5 >= 5.1.0, PHP 7
156251     **/
156252    public function fwrite($str, $length){}
156253
156254    /**
156255     * No purpose
156256     *
156257     * An SplFileObject does not have children so this method returns NULL.
156258     *
156259     * @return void
156260     * @since PHP 5 >= 5.1.0, PHP 7
156261     **/
156262    public function getChildren(){}
156263
156264    /**
156265     * Get the delimiter, enclosure and escape character for CSV
156266     *
156267     * Gets the delimiter, enclosure and escape character used for parsing
156268     * CSV fields.
156269     *
156270     * @return array Returns an indexed array containing the delimiter,
156271     *   enclosure and escape character.
156272     * @since PHP 5 >= 5.2.0, PHP 7
156273     **/
156274    public function getCsvControl(){}
156275
156276    /**
156277     * Gets flags for the SplFileObject
156278     *
156279     * Gets the flags set for an instance of SplFileObject as an integer.
156280     *
156281     * @return int Returns an integer representing the flags.
156282     * @since PHP 5 >= 5.1.0, PHP 7
156283     **/
156284    public function getFlags(){}
156285
156286    /**
156287     * Get maximum line length
156288     *
156289     * Gets the maximum line length as set by SplFileObject::setMaxLineLen.
156290     *
156291     * @return int Returns the maximum line length if one has been set with
156292     *   SplFileObject::setMaxLineLen, default is 0.
156293     * @since PHP 5 >= 5.1.0, PHP 7
156294     **/
156295    public function getMaxLineLen(){}
156296
156297    /**
156298     * SplFileObject does not have children
156299     *
156300     * An SplFileObject does not have children so this method always return
156301     * FALSE.
156302     *
156303     * @return bool Returns FALSE
156304     * @since PHP 5 >= 5.1.2, PHP 7
156305     **/
156306    public function hasChildren(){}
156307
156308    /**
156309     * Get line number
156310     *
156311     * Gets the current line number.
156312     *
156313     * @return int Returns the current line number.
156314     * @since PHP 5 >= 5.1.0, PHP 7
156315     **/
156316    public function key(){}
156317
156318    /**
156319     * Read next line
156320     *
156321     * Moves ahead to the next line in the file.
156322     *
156323     * @return void
156324     * @since PHP 5 >= 5.1.0, PHP 7
156325     **/
156326    public function next(){}
156327
156328    /**
156329     * Rewind the file to the first line
156330     *
156331     * Rewinds the file back to the first line.
156332     *
156333     * @return void
156334     * @since PHP 5 >= 5.1.0, PHP 7
156335     **/
156336    public function rewind(){}
156337
156338    /**
156339     * Seek to specified line
156340     *
156341     * Seek to specified line in the file.
156342     *
156343     * @param int $line_pos The zero-based line number to seek to.
156344     * @return void
156345     * @since PHP 5 >= 5.1.0, PHP 7
156346     **/
156347    public function seek($line_pos){}
156348
156349    /**
156350     * Set the delimiter, enclosure and escape character for CSV
156351     *
156352     * Sets the delimiter, enclosure and escape character for parsing CSV
156353     * fields.
156354     *
156355     * @param string $delimiter The field delimiter (one character only).
156356     * @param string $enclosure The field enclosure character (one
156357     *   character only).
156358     * @param string $escape The field escape character (at most one
156359     *   character). An empty string ("") disables the proprietary escape
156360     *   mechanism.
156361     * @return void
156362     * @since PHP 5 >= 5.2.0, PHP 7
156363     **/
156364    public function setCsvControl($delimiter, $enclosure, $escape){}
156365
156366    /**
156367     * Sets flags for the SplFileObject
156368     *
156369     * Sets the flags to be used by the SplFileObject.
156370     *
156371     * @param int $flags Bit mask of the flags to set. See SplFileObject
156372     *   constants for the available flags.
156373     * @return void
156374     * @since PHP 5 >= 5.1.0, PHP 7
156375     **/
156376    public function setFlags($flags){}
156377
156378    /**
156379     * Set maximum line length
156380     *
156381     * Sets the maximum length of a line to be read.
156382     *
156383     * @param int $max_len The maximum length of a line.
156384     * @return void
156385     * @since PHP 5 >= 5.1.0, PHP 7
156386     **/
156387    public function setMaxLineLen($max_len){}
156388
156389    /**
156390     * Not at EOF
156391     *
156392     * Check whether EOF has been reached.
156393     *
156394     * @return bool Returns TRUE if not reached EOF, FALSE otherwise.
156395     * @since PHP 5 >= 5.1.0, PHP 7
156396     **/
156397    public function valid(){}
156398
156399}
156400/**
156401 * The SplFixedArray class provides the main functionalities of array.
156402 * The main differences between a SplFixedArray and a normal PHP array is
156403 * that the SplFixedArray is of fixed length and allows only integers
156404 * within the range as indexes. The advantage is that it uses less memory
156405 * than a standard array. SplFixedArray usage example
156406 *
156407 * NULL int(2) string(3) "foo" RuntimeException: Index invalid or out of
156408 * range RuntimeException: Index invalid or out of range
156409 * RuntimeException: Index invalid or out of range
156410 **/
156411class SplFixedArray implements Iterator, ArrayAccess, Countable {
156412    /**
156413     * Returns the size of the array
156414     *
156415     * @return int Returns the size of the array.
156416     * @since PHP 5 >= 5.3.0, PHP 7
156417     **/
156418    public function count(){}
156419
156420    /**
156421     * Return current array entry
156422     *
156423     * Get the current array element.
156424     *
156425     * @return mixed The current element value.
156426     * @since PHP 5 >= 5.3.0, PHP 7
156427     **/
156428    public function current(){}
156429
156430    /**
156431     * Import a PHP array in a instance
156432     *
156433     * Import the PHP array {@link array} in a new SplFixedArray instance
156434     *
156435     * @param array $array The array to import.
156436     * @param bool $save_indexes Try to save the numeric indexes used in
156437     *   the original array.
156438     * @return SplFixedArray Returns an instance of SplFixedArray
156439     *   containing the array content.
156440     * @since PHP 5 >= 5.3.0, PHP 7
156441     **/
156442    public static function fromArray($array, $save_indexes){}
156443
156444    /**
156445     * Gets the size of the array
156446     *
156447     * @return int Returns the size of the array, as an integer.
156448     * @since PHP 5 >= 5.3.0, PHP 7
156449     **/
156450    public function getSize(){}
156451
156452    /**
156453     * Return current array index
156454     *
156455     * Returns the current array index.
156456     *
156457     * @return int The current array index.
156458     * @since PHP 5 >= 5.3.0, PHP 7
156459     **/
156460    public function key(){}
156461
156462    /**
156463     * Move to next entry
156464     *
156465     * Move the iterator to the next array entry.
156466     *
156467     * @return void
156468     * @since PHP 5 >= 5.3.0, PHP 7
156469     **/
156470    public function next(){}
156471
156472    /**
156473     * Returns whether the requested index exists
156474     *
156475     * Checks whether the requested index {@link index} exists.
156476     *
156477     * @param int $index The index being checked.
156478     * @return bool TRUE if the requested {@link index} exists, otherwise
156479     *   FALSE
156480     * @since PHP 5 >= 5.3.0, PHP 7
156481     **/
156482    public function offsetExists($index){}
156483
156484    /**
156485     * Returns the value at the specified index
156486     *
156487     * Returns the value at the index {@link index}.
156488     *
156489     * @param int $index The index with the value.
156490     * @return mixed The value at the specified {@link index}.
156491     * @since PHP 5 >= 5.3.0, PHP 7
156492     **/
156493    public function offsetGet($index){}
156494
156495    /**
156496     * Sets a new value at a specified index
156497     *
156498     * Sets the value at the specified {@link index} to {@link newval}.
156499     *
156500     * @param int $index The index being set.
156501     * @param mixed $newval The new value for the {@link index}.
156502     * @return void
156503     * @since PHP 5 >= 5.3.0, PHP 7
156504     **/
156505    public function offsetSet($index, $newval){}
156506
156507    /**
156508     * Unsets the value at the specified $index
156509     *
156510     * Unsets the value at the specified index.
156511     *
156512     * @param int $index The index being unset.
156513     * @return void
156514     * @since PHP 5 >= 5.3.0, PHP 7
156515     **/
156516    public function offsetUnset($index){}
156517
156518    /**
156519     * Rewind iterator back to the start
156520     *
156521     * Rewinds the iterator to the beginning.
156522     *
156523     * @return void
156524     * @since PHP 5 >= 5.3.0, PHP 7
156525     **/
156526    public function rewind(){}
156527
156528    /**
156529     * Change the size of an array
156530     *
156531     * Change the size of an array to the new size of {@link size}. If {@link
156532     * size} is less than the current array size, any values after the new
156533     * size will be discarded. If {@link size} is greater than the current
156534     * array size, the array will be padded with NULL values.
156535     *
156536     * @param int $size The new array size. This should be a value between
156537     *   0 and PHP_INT_MAX.
156538     * @return bool
156539     * @since PHP 5 >= 5.3.0, PHP 7
156540     **/
156541    public function setSize($size){}
156542
156543    /**
156544     * Returns a PHP array from the fixed array
156545     *
156546     * @return array Returns a PHP array, similar to the fixed array.
156547     * @since PHP 5 >= 5.3.0, PHP 7
156548     **/
156549    public function toArray(){}
156550
156551    /**
156552     * Check whether the array contains more elements
156553     *
156554     * Checks if the array contains any more elements.
156555     *
156556     * @return bool Returns TRUE if the array contains any more elements,
156557     *   FALSE otherwise.
156558     * @since PHP 5 >= 5.3.0, PHP 7
156559     **/
156560    public function valid(){}
156561
156562    /**
156563     * Reinitialises the array after being unserialised
156564     *
156565     * @return void
156566     * @since PHP 5 >= 5.5.0, PHP 7
156567     **/
156568    public function __wakeup(){}
156569
156570}
156571/**
156572 * The SplFloat class is used to enforce strong typing of the float type.
156573 * SplFloat usage example
156574 *
156575 * Value not a float 3.154 3
156576 **/
156577class SplFloat extends SplType {
156578    /**
156579     * @var float
156580     **/
156581    const __default = 0.0;
156582
156583}
156584/**
156585 * The SplHeap class provides the main functionalities of a Heap.
156586 **/
156587abstract class SplHeap implements Iterator, Countable {
156588    /**
156589     * Compare elements in order to place them correctly in the heap while
156590     * sifting up
156591     *
156592     * Compare {@link value1} with {@link value2}.
156593     *
156594     * @param mixed $value1 The value of the first node being compared.
156595     * @param mixed $value2 The value of the second node being compared.
156596     * @return int Result of the comparison, positive integer if {@link
156597     *   value1} is greater than {@link value2}, 0 if they are equal,
156598     *   negative integer otherwise.
156599     * @since PHP 5 >= 5.3.0, PHP 7
156600     **/
156601    abstract protected function compare($value1, $value2);
156602
156603    /**
156604     * Counts the number of elements in the heap
156605     *
156606     * @return int Returns the number of elements in the heap.
156607     * @since PHP 5 >= 5.3.0, PHP 7
156608     **/
156609    public function count(){}
156610
156611    /**
156612     * Return current node pointed by the iterator
156613     *
156614     * Get the current datastructure node.
156615     *
156616     * @return mixed The current node value.
156617     * @since PHP 5 >= 5.3.0, PHP 7
156618     **/
156619    public function current(){}
156620
156621    /**
156622     * Extracts a node from top of the heap and sift up
156623     *
156624     * @return mixed The value of the extracted node.
156625     * @since PHP 5 >= 5.3.0, PHP 7
156626     **/
156627    public function extract(){}
156628
156629    /**
156630     * Inserts an element in the heap by sifting it up
156631     *
156632     * Insert {@link value} in the heap.
156633     *
156634     * @param mixed $value The value to insert.
156635     * @return void
156636     * @since PHP 5 >= 5.3.0, PHP 7
156637     **/
156638    public function insert($value){}
156639
156640    /**
156641     * Tells if the heap is in a corrupted state
156642     *
156643     * @return bool Returns TRUE if the heap is corrupted, FALSE otherwise.
156644     * @since PHP 7
156645     **/
156646    public function isCorrupted(){}
156647
156648    /**
156649     * Checks whether the heap is empty
156650     *
156651     * @return bool Returns whether the heap is empty.
156652     * @since PHP 5 >= 5.3.0, PHP 7
156653     **/
156654    public function isEmpty(){}
156655
156656    /**
156657     * Return current node index
156658     *
156659     * This function returns the current node index
156660     *
156661     * @return mixed The current node index.
156662     * @since PHP 5 >= 5.3.0, PHP 7
156663     **/
156664    public function key(){}
156665
156666    /**
156667     * Move to the next node
156668     *
156669     * Move to the next node. This will delete the top node of the heap.
156670     *
156671     * @return void
156672     * @since PHP 5 >= 5.3.0, PHP 7
156673     **/
156674    public function next(){}
156675
156676    /**
156677     * Recover from the corrupted state and allow further actions on the heap
156678     *
156679     * @return void
156680     * @since PHP 5 >= 5.3.0, PHP 7
156681     **/
156682    public function recoverFromCorruption(){}
156683
156684    /**
156685     * Rewind iterator back to the start (no-op)
156686     *
156687     * This rewinds the iterator to the beginning. This is a no-op for heaps
156688     * as the iterator is virtual and in fact never moves from the top of the
156689     * heap.
156690     *
156691     * @return void
156692     * @since PHP 5 >= 5.3.0, PHP 7
156693     **/
156694    public function rewind(){}
156695
156696    /**
156697     * Peeks at the node from the top of the heap
156698     *
156699     * @return mixed The value of the node on the top.
156700     * @since PHP 5 >= 5.3.0, PHP 7
156701     **/
156702    public function top(){}
156703
156704    /**
156705     * Check whether the heap contains more nodes
156706     *
156707     * Checks if the heap contains any more nodes.
156708     *
156709     * @return bool Returns TRUE if the heap contains any more nodes, FALSE
156710     *   otherwise.
156711     * @since PHP 5 >= 5.3.0, PHP 7
156712     **/
156713    public function valid(){}
156714
156715}
156716/**
156717 * The SplInt class is used to enforce strong typing of the integer type.
156718 * SplInt usage example
156719 *
156720 * Value not an integer 94
156721 **/
156722class SplInt extends SplType {
156723    /**
156724     * @var integer
156725     **/
156726    const __default = 0;
156727
156728}
156729/**
156730 * The SplMaxHeap class provides the main functionalities of a heap,
156731 * keeping the maximum on the top.
156732 **/
156733class SplMaxHeap extends SplHeap implements Iterator, Countable {
156734    /**
156735     * Compare elements in order to place them correctly in the heap while
156736     * sifting up
156737     *
156738     * Compare {@link value1} with {@link value2}.
156739     *
156740     * @param mixed $value1 The value of the first node being compared.
156741     * @param mixed $value2 The value of the second node being compared.
156742     * @return int Result of the comparison, positive integer if {@link
156743     *   value1} is greater than {@link value2}, 0 if they are equal,
156744     *   negative integer otherwise.
156745     * @since PHP 5 >= 5.3.0, PHP 7
156746     **/
156747    protected function compare($value1, $value2){}
156748
156749}
156750/**
156751 * The SplMinHeap class provides the main functionalities of a heap,
156752 * keeping the minimum on the top.
156753 **/
156754class SplMinHeap extends SplHeap implements Iterator, Countable {
156755    /**
156756     * Compare elements in order to place them correctly in the heap while
156757     * sifting up
156758     *
156759     * Compare {@link value1} with {@link value2}.
156760     *
156761     * @param mixed $value1 The value of the first node being compared.
156762     * @param mixed $value2 The value of the second node being compared.
156763     * @return int Result of the comparison, positive integer if {@link
156764     *   value1} is lower than {@link value2}, 0 if they are equal, negative
156765     *   integer otherwise.
156766     * @since PHP 5 >= 5.3.0, PHP 7
156767     **/
156768    protected function compare($value1, $value2){}
156769
156770}
156771/**
156772 * The SplObjectStorage class provides a map from objects to data or, by
156773 * ignoring data, an object set. This dual purpose can be useful in many
156774 * cases involving the need to uniquely identify objects.
156775 * SplObjectStorage as a set
156776 *
156777 * bool(true) bool(true) bool(false) bool(true) bool(false) bool(false)
156778 *
156779 * SplObjectStorage as a map
156780 *
156781 * array(3) { [0]=> int(1) [1]=> int(2) [2]=> int(3) }
156782 **/
156783class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess {
156784    /**
156785     * Adds all objects from another storage
156786     *
156787     * Adds all objects-data pairs from a different storage in the current
156788     * storage.
156789     *
156790     * @param SplObjectStorage $storage The storage you want to import.
156791     * @return void
156792     * @since PHP 5 >= 5.3.0, PHP 7
156793     **/
156794    public function addAll($storage){}
156795
156796    /**
156797     * Adds an object in the storage
156798     *
156799     * Adds an object inside the storage, and optionally associate it to some
156800     * data.
156801     *
156802     * @param object $object The object to add.
156803     * @param mixed $data The data to associate with the object.
156804     * @return void
156805     * @since PHP 5 >= 5.1.0, PHP 7
156806     **/
156807    public function attach($object, $data){}
156808
156809    /**
156810     * Checks if the storage contains a specific object
156811     *
156812     * Checks if the storage contains the object provided.
156813     *
156814     * @param object $object The object to look for.
156815     * @return bool Returns TRUE if the object is in the storage, FALSE
156816     *   otherwise.
156817     * @since PHP 5 >= 5.1.0, PHP 7
156818     **/
156819    public function contains($object){}
156820
156821    /**
156822     * Returns the number of objects in the storage
156823     *
156824     * Counts the number of objects in the storage.
156825     *
156826     * @return int The number of objects in the storage.
156827     * @since PHP 5 >= 5.1.0, PHP 7
156828     **/
156829    public function count(){}
156830
156831    /**
156832     * Returns the current storage entry
156833     *
156834     * @return object The object at the current iterator position.
156835     * @since PHP 5 >= 5.1.0, PHP 7
156836     **/
156837    public function current(){}
156838
156839    /**
156840     * Removes an from the storage
156841     *
156842     * Removes the object from the storage.
156843     *
156844     * @param object $object The object to remove.
156845     * @return void
156846     * @since PHP 5 >= 5.1.0, PHP 7
156847     **/
156848    public function detach($object){}
156849
156850    /**
156851     * Calculate a unique identifier for the contained objects
156852     *
156853     * This method calculates an identifier for the objects added to an
156854     * SplObjectStorage object.
156855     *
156856     * The implementation in SplObjectStorage returns the same value as
156857     * {@link spl_object_hash}.
156858     *
156859     * The storage object will never contain more than one object with the
156860     * same identifier. As such, it can be used to implement a set (a
156861     * collection of unique values) where the quality of an object being
156862     * unique is determined by the value returned by this function being
156863     * unique.
156864     *
156865     * @param object $object The object whose identifier is to be
156866     *   calculated.
156867     * @return string A string with the calculated identifier.
156868     * @since PHP 5 >= 5.4.0, PHP 7
156869     **/
156870    public function getHash($object){}
156871
156872    /**
156873     * Returns the data associated with the current iterator entry
156874     *
156875     * Returns the data, or info, associated with the object pointed by the
156876     * current iterator position.
156877     *
156878     * @return mixed The data associated with the current iterator
156879     *   position.
156880     * @since PHP 5 >= 5.3.0, PHP 7
156881     **/
156882    public function getInfo(){}
156883
156884    /**
156885     * Returns the index at which the iterator currently is
156886     *
156887     * @return int The index corresponding to the position of the iterator.
156888     * @since PHP 5 >= 5.1.0, PHP 7
156889     **/
156890    public function key(){}
156891
156892    /**
156893     * Move to the next entry
156894     *
156895     * Moves the iterator to the next object in the storage.
156896     *
156897     * @return void
156898     * @since PHP 5 >= 5.1.0, PHP 7
156899     **/
156900    public function next(){}
156901
156902    /**
156903     * Checks whether an object exists in the storage
156904     *
156905     * Checks whether an object exists in the storage.
156906     *
156907     * @param object $object The object to look for.
156908     * @return bool Returns TRUE if the object exists in the storage, and
156909     *   FALSE otherwise.
156910     * @since PHP 5 >= 5.3.0, PHP 7
156911     **/
156912    public function offsetExists($object){}
156913
156914    /**
156915     * Returns the data associated with an
156916     *
156917     * Returns the data associated with an object in the storage.
156918     *
156919     * @param object $object The object to look for.
156920     * @return mixed The data previously associated with the object in the
156921     *   storage.
156922     * @since PHP 5 >= 5.3.0, PHP 7
156923     **/
156924    public function offsetGet($object){}
156925
156926    /**
156927     * Associates data to an object in the storage
156928     *
156929     * Associate data to an object in the storage.
156930     *
156931     * @param object $object The object to associate data with.
156932     * @param mixed $data The data to associate with the object.
156933     * @return void
156934     * @since PHP 5 >= 5.3.0, PHP 7
156935     **/
156936    public function offsetSet($object, $data){}
156937
156938    /**
156939     * Removes an object from the storage
156940     *
156941     * Removes an object from the storage.
156942     *
156943     * @param object $object The object to remove.
156944     * @return void
156945     * @since PHP 5 >= 5.3.0, PHP 7
156946     **/
156947    public function offsetUnset($object){}
156948
156949    /**
156950     * Removes objects contained in another storage from the current storage
156951     *
156952     * @param SplObjectStorage $storage The storage containing the elements
156953     *   to remove.
156954     * @return void
156955     * @since PHP 5 >= 5.3.0, PHP 7
156956     **/
156957    public function removeAll($storage){}
156958
156959    /**
156960     * Removes all objects except for those contained in another storage from
156961     * the current storage
156962     *
156963     * @param SplObjectStorage $storage The storage containing the elements
156964     *   to retain in the current storage.
156965     * @return void
156966     * @since PHP 5 >= 5.3.6, PHP 7
156967     **/
156968    public function removeAllExcept($storage){}
156969
156970    /**
156971     * Rewind the iterator to the first storage element
156972     *
156973     * @return void
156974     * @since PHP 5 >= 5.1.0, PHP 7
156975     **/
156976    public function rewind(){}
156977
156978    /**
156979     * Serializes the storage
156980     *
156981     * Returns a string representation of the storage.
156982     *
156983     * @return string A string representing the storage.
156984     * @since PHP 5 >= 5.2.2, PHP 7
156985     **/
156986    public function serialize(){}
156987
156988    /**
156989     * Sets the data associated with the current iterator entry
156990     *
156991     * Associates data, or info, with the object currently pointed to by the
156992     * iterator.
156993     *
156994     * @param mixed $data The data to associate with the current iterator
156995     *   entry.
156996     * @return void
156997     * @since PHP 5 >= 5.3.0, PHP 7
156998     **/
156999    public function setInfo($data){}
157000
157001    /**
157002     * Unserializes a storage from its string representation
157003     *
157004     * Unserializes storage entries and attach them to the current storage.
157005     *
157006     * @param string $serialized The serialized representation of a
157007     *   storage.
157008     * @return void
157009     * @since PHP 5 >= 5.2.2, PHP 7
157010     **/
157011    public function unserialize($serialized){}
157012
157013    /**
157014     * Returns if the current iterator entry is valid
157015     *
157016     * @return bool Returns TRUE if the iterator entry is valid, FALSE
157017     *   otherwise.
157018     * @since PHP 5 >= 5.1.0, PHP 7
157019     **/
157020    public function valid(){}
157021
157022}
157023/**
157024 * The SplObserver interface is used alongside SplSubject to implement
157025 * the Observer Design Pattern.
157026 **/
157027interface SplObserver {
157028    /**
157029     * Receive update from subject
157030     *
157031     * This method is called when any SplSubject to which the observer is
157032     * attached calls SplSubject::notify.
157033     *
157034     * @param SplSubject $subject The SplSubject notifying the observer of
157035     *   an update.
157036     * @return void
157037     * @since PHP 5 >= 5.1.0, PHP 7
157038     **/
157039    public function update($subject);
157040
157041}
157042/**
157043 * The SplPriorityQueue class provides the main functionalities of a
157044 * prioritized queue, implemented using a max heap.
157045 **/
157046class SplPriorityQueue implements Iterator, Countable {
157047    /**
157048     * Compare priorities in order to place elements correctly in the heap
157049     * while sifting up
157050     *
157051     * Compare {@link priority1} with {@link priority2}.
157052     *
157053     * @param mixed $priority1 The priority of the first node being
157054     *   compared.
157055     * @param mixed $priority2 The priority of the second node being
157056     *   compared.
157057     * @return int Result of the comparison, positive integer if {@link
157058     *   priority1} is greater than {@link priority2}, 0 if they are equal,
157059     *   negative integer otherwise.
157060     * @since PHP 5 >= 5.3.0, PHP 7
157061     **/
157062    public function compare($priority1, $priority2){}
157063
157064    /**
157065     * Counts the number of elements in the queue
157066     *
157067     * @return int Returns the number of elements in the queue.
157068     * @since PHP 5 >= 5.3.0, PHP 7
157069     **/
157070    public function count(){}
157071
157072    /**
157073     * Return current node pointed by the iterator
157074     *
157075     * Get the current datastructure node.
157076     *
157077     * @return mixed The value or priority (or both) of the current node,
157078     *   depending on the extract flag.
157079     * @since PHP 5 >= 5.3.0, PHP 7
157080     **/
157081    public function current(){}
157082
157083    /**
157084     * Extracts a node from top of the heap and sift up
157085     *
157086     * @return mixed The value or priority (or both) of the extracted node,
157087     *   depending on the extract flag.
157088     * @since PHP 5 >= 5.3.0, PHP 7
157089     **/
157090    public function extract(){}
157091
157092    /**
157093     * Get the flags of extraction
157094     *
157095     * @return int
157096     * @since PHP 7
157097     **/
157098    public function getExtractFlags(){}
157099
157100    /**
157101     * Inserts an element in the queue by sifting it up
157102     *
157103     * Insert {@link value} with the priority {@link priority} in the queue.
157104     *
157105     * @param mixed $value The value to insert.
157106     * @param mixed $priority The associated priority.
157107     * @return bool Returns TRUE.
157108     * @since PHP 5 >= 5.3.0, PHP 7
157109     **/
157110    public function insert($value, $priority){}
157111
157112    /**
157113     * Tells if the priority queue is in a corrupted state
157114     *
157115     * @return bool Returns TRUE if the priority queue is corrupted, FALSE
157116     *   otherwise.
157117     * @since PHP 5 >= 5.3.0, PHP 7
157118     **/
157119    public function isCorrupted(){}
157120
157121    /**
157122     * Checks whether the queue is empty
157123     *
157124     * @return bool Returns whether the queue is empty.
157125     * @since PHP 5 >= 5.3.0, PHP 7
157126     **/
157127    public function isEmpty(){}
157128
157129    /**
157130     * Return current node index
157131     *
157132     * This function returns the current node index
157133     *
157134     * @return mixed The current node index.
157135     * @since PHP 5 >= 5.3.0, PHP 7
157136     **/
157137    public function key(){}
157138
157139    /**
157140     * Move to the next node
157141     *
157142     * Extracts the top node from the queue.
157143     *
157144     * @return void
157145     * @since PHP 5 >= 5.3.0, PHP 7
157146     **/
157147    public function next(){}
157148
157149    /**
157150     * Recover from the corrupted state and allow further actions on the
157151     * queue
157152     *
157153     * @return void
157154     * @since PHP 5 >= 5.3.0, PHP 7
157155     **/
157156    public function recoverFromCorruption(){}
157157
157158    /**
157159     * Rewind iterator back to the start (no-op)
157160     *
157161     * This rewinds the iterator to the beginning. This is a no-op for heaps
157162     * as the iterator is virtual and in fact never moves from the top of the
157163     * heap.
157164     *
157165     * @return void
157166     * @since PHP 5 >= 5.3.0, PHP 7
157167     **/
157168    public function rewind(){}
157169
157170    /**
157171     * Sets the mode of extraction
157172     *
157173     * @param int $flags Defines what is extracted by
157174     *   SplPriorityQueue::current, SplPriorityQueue::top and
157175     *   SplPriorityQueue::extract. The default mode is
157176     *   SplPriorityQueue::EXTR_DATA.
157177     * @return void
157178     * @since PHP 5 >= 5.3.0, PHP 7
157179     **/
157180    public function setExtractFlags($flags){}
157181
157182    /**
157183     * Peeks at the node from the top of the queue
157184     *
157185     * @return mixed The value or priority (or both) of the top node,
157186     *   depending on the extract flag.
157187     * @since PHP 5 >= 5.3.0, PHP 7
157188     **/
157189    public function top(){}
157190
157191    /**
157192     * Check whether the queue contains more nodes
157193     *
157194     * Checks if the queue contains any more nodes.
157195     *
157196     * @return bool Returns TRUE if the queue contains any more nodes,
157197     *   FALSE otherwise.
157198     * @since PHP 5 >= 5.3.0, PHP 7
157199     **/
157200    public function valid(){}
157201
157202}
157203/**
157204 * The SplQueue class provides the main functionalities of a queue
157205 * implemented using a doubly linked list.
157206 **/
157207class SplQueue extends SplDoublyLinkedList implements Iterator, ArrayAccess, Countable {
157208    /**
157209     * Dequeues a node from the queue
157210     *
157211     * Dequeues {@link value} from the top of the queue.
157212     *
157213     * @return mixed The value of the dequeued node.
157214     * @since PHP 5 >= 5.3.0, PHP 7
157215     **/
157216    function dequeue(){}
157217
157218    /**
157219     * Adds an element to the queue
157220     *
157221     * Enqueues {@link value} at the end of the queue.
157222     *
157223     * @param mixed $value The value to enqueue.
157224     * @return void
157225     * @since PHP 5 >= 5.3.0, PHP 7
157226     **/
157227    function enqueue($value){}
157228
157229    /**
157230     * Sets the mode of iteration
157231     *
157232     * @param int $mode There is only one iteration parameter you can
157233     *   modify. The default mode is: SplDoublyLinkedList::IT_MODE_FIFO |
157234     *   SplDoublyLinkedList::IT_MODE_KEEP
157235     * @return void
157236     * @since PHP 5 >= 5.3.0, PHP 7
157237     **/
157238    function setIteratorMode($mode){}
157239
157240}
157241/**
157242 * The SplStack class provides the main functionalities of a stack
157243 * implemented using a doubly linked list.
157244 **/
157245class SplStack extends SplDoublyLinkedList implements Iterator, ArrayAccess, Countable {
157246    /**
157247     * Sets the mode of iteration
157248     *
157249     * @param int $mode There is only one iteration parameter you can
157250     *   modify. The default mode is 0x2 : SplDoublyLinkedList::IT_MODE_LIFO
157251     *   | SplDoublyLinkedList::IT_MODE_KEEP
157252     * @return void
157253     * @since PHP 5 >= 5.3.0, PHP 7
157254     **/
157255    function setIteratorMode($mode){}
157256
157257}
157258/**
157259 * The SplString class is used to enforce strong typing of the string
157260 * type. SplString usage example
157261 *
157262 * Value not a string object(SplString)#1 (1) { ["__default"]=> string(7)
157263 * "Testing" } Testing
157264 **/
157265class SplString extends SplType {
157266    /**
157267     * @var string
157268     **/
157269    const __default = '';
157270
157271}
157272/**
157273 * The SplSubject interface is used alongside SplObserver to implement
157274 * the Observer Design Pattern.
157275 **/
157276interface SplSubject {
157277    /**
157278     * Attach an SplObserver
157279     *
157280     * Attaches an SplObserver so that it can be notified of updates.
157281     *
157282     * @param SplObserver $observer The SplObserver to attach.
157283     * @return void
157284     * @since PHP 5 >= 5.1.0, PHP 7
157285     **/
157286    public function attach($observer);
157287
157288    /**
157289     * Detach an observer
157290     *
157291     * Detaches an observer from the subject to no longer notify it of
157292     * updates.
157293     *
157294     * @param SplObserver $observer The SplObserver to detach.
157295     * @return void
157296     * @since PHP 5 >= 5.1.0, PHP 7
157297     **/
157298    public function detach($observer);
157299
157300    /**
157301     * Notify an observer
157302     *
157303     * Notifies all attached observers.
157304     *
157305     * @return void
157306     * @since PHP 5 >= 5.1.0, PHP 7
157307     **/
157308    public function notify();
157309
157310}
157311/**
157312 * The SplTempFileObject class offers an object oriented interface for a
157313 * temporary file.
157314 **/
157315class SplTempFileObject extends SplFileObject implements SeekableIterator, RecursiveIterator {
157316}
157317/**
157318 * Parent class for all SPL types.
157319 **/
157320abstract class SplType {
157321    /**
157322     * @var NULL
157323     **/
157324    const __default = 0;
157325
157326    /**
157327     * Creates a new value of some type
157328     *
157329     * @param mixed $initial_value Type and default value depends on the
157330     *   extension class.
157331     * @param bool $strict Whether to set the object's strictness.
157332     * @since PECL spl_types >= 0.1.0
157333     **/
157334    function __construct($initial_value, $strict){}
157335
157336}
157337/**
157338 * This class is provided because Unicode contains large number of
157339 * characters and incorporates the varied writing systems of the world
157340 * and their incorrect usage can expose programs or systems to possible
157341 * security attacks using characters similarity. Provided methods allow
157342 * to check whether an individual string is likely an attempt at
157343 * confusing the reader (spoof detection), such as "pаypаl" spelled
157344 * with Cyrillic 'а' characters.
157345 **/
157346class Spoofchecker {
157347    /**
157348     * @var integer
157349     **/
157350    const ANY_CASE = 0;
157351
157352    /**
157353     * @var number
157354     **/
157355    const ASCII = 0;
157356
157357    /**
157358     * @var integer
157359     **/
157360    const CHAR_LIMIT = 0;
157361
157362    /**
157363     * @var number
157364     **/
157365    const HIGHLY_RESTRICTIVE = 0;
157366
157367    /**
157368     * @var integer
157369     **/
157370    const INVISIBLE = 0;
157371
157372    /**
157373     * @var number
157374     **/
157375    const MINIMALLY_RESTRICTIVE = 0;
157376
157377    /**
157378     * @var integer
157379     **/
157380    const MIXED_SCRIPT_CONFUSABLE = 0;
157381
157382    /**
157383     * @var number
157384     **/
157385    const MODERATELY_RESTRICTIVE = 0;
157386
157387    /**
157388     * @var integer
157389     **/
157390    const SINGLE_SCRIPT = 0;
157391
157392    /**
157393     * @var integer
157394     **/
157395    const SINGLE_SCRIPT_CONFUSABLE = 0;
157396
157397    /**
157398     * @var number
157399     **/
157400    const SINGLE_SCRIPT_RESTRICTIVE = 0;
157401
157402    /**
157403     * @var number
157404     **/
157405    const UNRESTRICTIVE = 0;
157406
157407    /**
157408     * @var integer
157409     **/
157410    const WHOLE_SCRIPT_CONFUSABLE = 0;
157411
157412    /**
157413     * Checks if given strings can be confused
157414     *
157415     * Checks whether two given strings can easily be mistaken.
157416     *
157417     * @param string $str1 First string to check.
157418     * @param string $str2 Second string to check.
157419     * @param string $error This variable is set by-reference to string
157420     *   containing an error, if there were any.
157421     * @return bool Returns TRUE if two given strings can be confused,
157422     *   FALSE otherwise.
157423     **/
157424    public function areConfusable($str1, $str2, &$error){}
157425
157426    /**
157427     * Checks if a given text contains any suspicious characters
157428     *
157429     * Checks if given string contains any suspicious characters like letters
157430     * which are almost identical visually, but are Unicode characters from
157431     * different sets.
157432     *
157433     * @param string $text String to test.
157434     * @param string $error This variable is set by-reference to string
157435     *   containing an error, if there were any.
157436     * @return bool Returns TRUE if there are suspicious characters, FALSE
157437     *   otherwise.
157438     **/
157439    public function isSuspicious($text, &$error){}
157440
157441    /**
157442     * Locales to use when running checks
157443     *
157444     * @param string $locale_list
157445     * @return void
157446     **/
157447    public function setAllowedLocales($locale_list){}
157448
157449    /**
157450     * Set the checks to run
157451     *
157452     * @param int $checks
157453     * @return void
157454     **/
157455    public function setChecks($checks){}
157456
157457    /**
157458     * Constructor
157459     *
157460     * Creates new instance of Spoofchecker.
157461     **/
157462    public function __construct(){}
157463
157464}
157465/**
157466 * A class that interfaces SQLite 3 databases.
157467 **/
157468class SQLite3 {
157469    /**
157470     * Sets the busy connection handler
157471     *
157472     * Sets a busy handler that will sleep until the database is not locked
157473     * or the timeout is reached.
157474     *
157475     * @param int $msecs The milliseconds to sleep. Setting this value to a
157476     *   value less than or equal to zero, will turn off an already set
157477     *   timeout handler.
157478     * @return bool Returns TRUE on success, .
157479     * @since PHP 5 >= 5.3.3, PHP 7
157480     **/
157481    public function busyTimeout($msecs){}
157482
157483    /**
157484     * Returns the number of database rows that were changed (or inserted or
157485     * deleted) by the most recent SQL statement
157486     *
157487     * Returns the number of database rows that were changed (or inserted or
157488     * deleted) by the most recent SQL statement.
157489     *
157490     * @return int Returns an integer value corresponding to the number of
157491     *   database rows changed (or inserted or deleted) by the most recent
157492     *   SQL statement.
157493     * @since PHP 5 >= 5.3.0, PHP 7
157494     **/
157495    public function changes(){}
157496
157497    /**
157498     * Closes the database connection
157499     *
157500     * @return bool
157501     * @since PHP 5 >= 5.3.0, PHP 7
157502     **/
157503    public function close(){}
157504
157505    /**
157506     * Registers a PHP function for use as an SQL aggregate function
157507     *
157508     * Registers a PHP function or user-defined function for use as an SQL
157509     * aggregate function for use within SQL statements.
157510     *
157511     * @param string $name Name of the SQL aggregate to be created or
157512     *   redefined.
157513     * @param mixed $step_callback Callback function called for each row of
157514     *   the result set. Your PHP function should accumulate the result and
157515     *   store it in the aggregation context. This function need to be
157516     *   defined as: mixedstep mixed{@link context} int{@link rownumber}
157517     *   mixed{@link value1} mixed{@link ...} {@link context} NULL for the
157518     *   first row; on subsequent rows it will have the value that was
157519     *   previously returned from the step function; you should use this to
157520     *   maintain the aggregate state. {@link rownumber} The current row
157521     *   number. {@link value1} The first argument passed to the aggregate.
157522     *   {@link ...} Further arguments passed to the aggregate. The return
157523     *   value of this function will be used as the {@link context} argument
157524     *   in the next call of the step or finalize functions.
157525     * @param mixed $final_callback NULL for the first row; on subsequent
157526     *   rows it will have the value that was previously returned from the
157527     *   step function; you should use this to maintain the aggregate state.
157528     * @param int $argument_count The current row number.
157529     * @return bool Returns TRUE upon successful creation of the aggregate,
157530     *   .
157531     * @since PHP 5 >= 5.3.0, PHP 7
157532     **/
157533    public function createAggregate($name, $step_callback, $final_callback, $argument_count){}
157534
157535    /**
157536     * Registers a PHP function for use as an SQL collating function
157537     *
157538     * Registers a PHP function or user-defined function for use as a
157539     * collating function within SQL statements.
157540     *
157541     * @param string $name Name of the SQL collating function to be created
157542     *   or redefined
157543     * @param callable $callback The name of a PHP function or user-defined
157544     *   function to apply as a callback, defining the behavior of the
157545     *   collation. It should accept two values and return as {@link strcmp}
157546     *   does, i.e. it should return -1, 1, or 0 if the first string sorts
157547     *   before, sorts after, or is equal to the second. This function need
157548     *   to be defined as: intcollation mixed{@link value1} mixed{@link
157549     *   value2}
157550     * @return bool
157551     * @since PHP 5 >= 5.3.11, PHP 7
157552     **/
157553    public function createCollation($name, $callback){}
157554
157555    /**
157556     * Registers a PHP function for use as an SQL scalar function
157557     *
157558     * Registers a PHP function or user-defined function for use as an SQL
157559     * scalar function for use within SQL statements.
157560     *
157561     * @param string $name Name of the SQL function to be created or
157562     *   redefined.
157563     * @param mixed $callback The name of a PHP function or user-defined
157564     *   function to apply as a callback, defining the behavior of the SQL
157565     *   function. This function need to be defined as: mixedcallback
157566     *   mixed{@link value1} mixed{@link ...} {@link value1} The first
157567     *   argument passed to the SQL function. {@link ...} Further arguments
157568     *   passed to the SQL function.
157569     * @param int $argument_count The first argument passed to the SQL
157570     *   function.
157571     * @param int $flags Further arguments passed to the SQL function.
157572     * @return bool Returns TRUE upon successful creation of the function,
157573     *   FALSE on failure.
157574     * @since PHP 5 >= 5.3.0, PHP 7
157575     **/
157576    public function createFunction($name, $callback, $argument_count, $flags){}
157577
157578    /**
157579     * Enable throwing exceptions
157580     *
157581     * Controls whether the SQLite3 instance will throw exceptions or
157582     * warnings on error.
157583     *
157584     * @param bool $enableExceptions When TRUE, the SQLite3 instance, and
157585     *   SQLite3Stmt and SQLite3Result instances derived from it, will throw
157586     *   exceptions on error. When FALSE, the SQLite3 instance, and
157587     *   SQLite3Stmt and SQLite3Result instances derived from it, will raise
157588     *   warnings on error. For either mode, the error code and message, if
157589     *   any, will be available via SQLite3::lastErrorCode and
157590     *   SQLite3::lastErrorMsg respectively.
157591     * @return bool Returns the old value; TRUE if exceptions were enabled,
157592     *   FALSE otherwise.
157593     * @since PHP 5 >= 5.3.0, PHP 7
157594     **/
157595    function enableExceptions($enableExceptions){}
157596
157597    /**
157598     * Returns a string that has been properly escaped
157599     *
157600     * Returns a string that has been properly escaped for safe inclusion in
157601     * an SQL statement.
157602     *
157603     * To properly handle BLOB fields which may contain NUL characters, use
157604     * {@link SQLite3Stmt::bindParam} instead.
157605     *
157606     * @param string $value The string to be escaped.
157607     * @return string Returns a properly escaped string that may be used
157608     *   safely in an SQL statement.
157609     * @since PHP 5 >= 5.3.0, PHP 7
157610     **/
157611    public static function escapeString($value){}
157612
157613    /**
157614     * Executes a result-less query against a given database
157615     *
157616     * @param string $query The SQL query to execute (typically an INSERT,
157617     *   UPDATE, or DELETE query).
157618     * @return bool Returns TRUE if the query succeeded, FALSE on failure.
157619     * @since PHP 5 >= 5.3.0, PHP 7
157620     **/
157621    public function exec($query){}
157622
157623    /**
157624     * Returns the numeric result code of the most recent failed SQLite
157625     * request
157626     *
157627     * Returns the numeric result code of the most recent failed SQLite
157628     * request.
157629     *
157630     * @return int Returns an integer value representing the numeric result
157631     *   code of the most recent failed SQLite request.
157632     * @since PHP 5 >= 5.3.0, PHP 7
157633     **/
157634    public function lastErrorCode(){}
157635
157636    /**
157637     * Returns English text describing the most recent failed SQLite request
157638     *
157639     * Returns English text describing the most recent failed SQLite request.
157640     *
157641     * @return string Returns an English string describing the most recent
157642     *   failed SQLite request.
157643     * @since PHP 5 >= 5.3.0, PHP 7
157644     **/
157645    public function lastErrorMsg(){}
157646
157647    /**
157648     * Returns the row ID of the most recent INSERT into the database
157649     *
157650     * @return int Returns the row ID of the most recent INSERT into the
157651     *   database
157652     * @since PHP 5 >= 5.3.0, PHP 7
157653     **/
157654    public function lastInsertRowID(){}
157655
157656    /**
157657     * Attempts to load an SQLite extension library
157658     *
157659     * @param string $shared_library The name of the library to load. The
157660     *   library must be located in the directory specified in the configure
157661     *   option sqlite3.extension_dir.
157662     * @return bool Returns TRUE if the extension is successfully loaded,
157663     *   FALSE on failure.
157664     * @since PHP 5 >= 5.3.0, PHP 7
157665     **/
157666    public function loadExtension($shared_library){}
157667
157668    /**
157669     * Opens an SQLite database
157670     *
157671     * Opens an SQLite 3 Database. If the build includes encryption, then it
157672     * will attempt to use the key.
157673     *
157674     * @param string $filename Path to the SQLite database, or :memory: to
157675     *   use in-memory database.
157676     * @param int $flags Optional flags used to determine how to open the
157677     *   SQLite database. By default, open uses SQLITE3_OPEN_READWRITE |
157678     *   SQLITE3_OPEN_CREATE. SQLITE3_OPEN_READONLY: Open the database for
157679     *   reading only. SQLITE3_OPEN_READWRITE: Open the database for reading
157680     *   and writing. SQLITE3_OPEN_CREATE: Create the database if it does not
157681     *   exist.
157682     * @param string $encryption_key An optional encryption key used when
157683     *   encrypting and decrypting an SQLite database. If the SQLite
157684     *   encryption module is not installed, this parameter will have no
157685     *   effect.
157686     * @return void
157687     * @since PHP 5 >= 5.3.0, PHP 7
157688     **/
157689    public function open($filename, $flags, $encryption_key){}
157690
157691    /**
157692     * Opens a stream resource to read a BLOB
157693     *
157694     * Opens a stream resource to read or write a BLOB, which would be
157695     * selected by:
157696     *
157697     * SELECT {@link column} FROM {@link dbname}.{@link table} WHERE rowid =
157698     * {@link rowid}
157699     *
157700     * @param string $table The table name.
157701     * @param string $column The column name.
157702     * @param int $rowid The row ID.
157703     * @param string $dbname The symbolic name of the DB
157704     * @param int $flags Either SQLITE3_OPEN_READONLY or
157705     *   SQLITE3_OPEN_READWRITE to open the stream for reading only, or for
157706     *   reading and writing, respectively.
157707     * @return resource Returns a stream resource, .
157708     * @since PHP 5 >= 5.3.0, PHP 7
157709     **/
157710    public function openBlob($table, $column, $rowid, $dbname, $flags){}
157711
157712    /**
157713     * Prepares an SQL statement for execution
157714     *
157715     * Prepares an SQL statement for execution and returns an SQLite3Stmt
157716     * object.
157717     *
157718     * @param string $query The SQL query to prepare.
157719     * @return SQLite3Stmt Returns an SQLite3Stmt object on success.
157720     * @since PHP 5 >= 5.3.0, PHP 7
157721     **/
157722    public function prepare($query){}
157723
157724    /**
157725     * Executes an SQL query
157726     *
157727     * Executes an SQL query, returning an SQLite3Result object. If the query
157728     * does not yield a result (such as DML statements) the returned
157729     * SQLite3Result object is not really usable. Use SQLite3::exec for such
157730     * queries instead.
157731     *
157732     * @param string $query The SQL query to execute.
157733     * @return SQLite3Result Returns an SQLite3Result object, .
157734     * @since PHP 5 >= 5.3.0, PHP 7
157735     **/
157736    public function query($query){}
157737
157738    /**
157739     * Executes a query and returns a single result
157740     *
157741     * @param string $query The SQL query to execute.
157742     * @param bool $entire_row By default, {@link querySingle} returns the
157743     *   value of the first column returned by the query. If {@link
157744     *   entire_row} is TRUE, then it returns an array of the entire first
157745     *   row.
157746     * @return mixed Returns the value of the first column of results or an
157747     *   array of the entire first row (if {@link entire_row} is TRUE).
157748     * @since PHP 5 >= 5.3.0, PHP 7
157749     **/
157750    public function querySingle($query, $entire_row){}
157751
157752    /**
157753     * Returns the SQLite3 library version as a string constant and as a
157754     * number
157755     *
157756     * Returns the SQLite3 library version as a string constant and as a
157757     * number.
157758     *
157759     * @return array Returns an associative array with the keys
157760     *   "versionString" and "versionNumber".
157761     * @since PHP 5 >= 5.3.0, PHP 7
157762     **/
157763    public static function version(){}
157764
157765    /**
157766     * Instantiates an SQLite3 object and opens an SQLite 3 database
157767     *
157768     * Instantiates an SQLite3 object and opens a connection to an SQLite 3
157769     * database. If the build includes encryption, then it will attempt to
157770     * use the key.
157771     *
157772     * @param string $filename Path to the SQLite database, or :memory: to
157773     *   use in-memory database. If {@link filename} is an empty string, then
157774     *   a private, temporary on-disk database will be created. This private
157775     *   database will be automatically deleted as soon as the database
157776     *   connection is closed.
157777     * @param int $flags Optional flags used to determine how to open the
157778     *   SQLite database. By default, open uses SQLITE3_OPEN_READWRITE |
157779     *   SQLITE3_OPEN_CREATE. SQLITE3_OPEN_READONLY: Open the database for
157780     *   reading only. SQLITE3_OPEN_READWRITE: Open the database for reading
157781     *   and writing. SQLITE3_OPEN_CREATE: Create the database if it does not
157782     *   exist.
157783     * @param string $encryption_key An optional encryption key used when
157784     *   encrypting and decrypting an SQLite database. If the SQLite
157785     *   encryption module is not installed, this parameter will have no
157786     *   effect.
157787     * @since PHP 5 >= 5.3.0, PHP 7
157788     **/
157789    public function __construct($filename, $flags, $encryption_key){}
157790
157791}
157792/**
157793 * A class that handles result sets for the SQLite 3 extension.
157794 **/
157795class SQLite3Result {
157796    /**
157797     * Returns the name of the nth column
157798     *
157799     * Returns the name of the column specified by the {@link column_number}.
157800     * Note that the name of a result column is the value of the AS clause
157801     * for that column, if there is an AS clause. If there is no AS clause
157802     * then the name of the column is unspecified and may change from one
157803     * release of libsqlite3 to the next.
157804     *
157805     * @param int $column_number The numeric zero-based index of the
157806     *   column.
157807     * @return string Returns the string name of the column identified by
157808     *   {@link column_number}.
157809     * @since PHP 5 >= 5.3.0, PHP 7
157810     **/
157811    public function columnName($column_number){}
157812
157813    /**
157814     * Returns the type of the nth column
157815     *
157816     * Returns the type of the column identified by {@link column_number}.
157817     *
157818     * @param int $column_number The numeric zero-based index of the
157819     *   column.
157820     * @return int Returns the data type index of the column identified by
157821     *   {@link column_number} (one of SQLITE3_INTEGER, SQLITE3_FLOAT,
157822     *   SQLITE3_TEXT, SQLITE3_BLOB, or SQLITE3_NULL).
157823     * @since PHP 5 >= 5.3.0, PHP 7
157824     **/
157825    public function columnType($column_number){}
157826
157827    /**
157828     * Fetches a result row as an associative or numerically indexed array or
157829     * both
157830     *
157831     * Fetches a result row as an associative or numerically indexed array or
157832     * both. By default, fetches as both.
157833     *
157834     * @param int $mode Controls how the next row will be returned to the
157835     *   caller. This value must be one of either SQLITE3_ASSOC, SQLITE3_NUM,
157836     *   or SQLITE3_BOTH. SQLITE3_ASSOC: returns an array indexed by column
157837     *   name as returned in the corresponding result set SQLITE3_NUM:
157838     *   returns an array indexed by column number as returned in the
157839     *   corresponding result set, starting at column 0 SQLITE3_BOTH: returns
157840     *   an array indexed by both column name and number as returned in the
157841     *   corresponding result set, starting at column 0
157842     * @return array Returns a result row as an associatively or
157843     *   numerically indexed array or both. Alternately will return FALSE if
157844     *   there are no more rows.
157845     * @since PHP 5 >= 5.3.0, PHP 7
157846     **/
157847    public function fetchArray($mode){}
157848
157849    /**
157850     * Closes the result set
157851     *
157852     * @return bool Returns TRUE.
157853     * @since PHP 5 >= 5.3.0, PHP 7
157854     **/
157855    public function finalize(){}
157856
157857    /**
157858     * Returns the number of columns in the result set
157859     *
157860     * @return int Returns the number of columns in the result set.
157861     * @since PHP 5 >= 5.3.0, PHP 7
157862     **/
157863    public function numColumns(){}
157864
157865    /**
157866     * Resets the result set back to the first row
157867     *
157868     * @return bool Returns TRUE if the result set is successfully reset
157869     *   back to the first row, FALSE on failure.
157870     * @since PHP 5 >= 5.3.0, PHP 7
157871     **/
157872    public function reset(){}
157873
157874}
157875/**
157876 * A class that handles prepared statements for the SQLite 3 extension.
157877 **/
157878class SQLite3Stmt {
157879    /**
157880     * Binds a parameter to a statement variable
157881     *
157882     * @param mixed $sql_param Either a string (for named parameters) or an
157883     *   int (for positional parameters) identifying the statement variable
157884     *   to which the value should be bound. If a named parameter does not
157885     *   start with a colon (:) or an at sign (@), a colon (:) is
157886     *   automatically preprended. Positional parameters start with 1.
157887     * @param mixed $param The parameter to bind to a statement variable.
157888     * @param int $type The data type of the parameter to bind.
157889     *   SQLITE3_INTEGER: The value is a signed integer, stored in 1, 2, 3,
157890     *   4, 6, or 8 bytes depending on the magnitude of the value.
157891     *   SQLITE3_FLOAT: The value is a floating point value, stored as an
157892     *   8-byte IEEE floating point number. SQLITE3_TEXT: The value is a text
157893     *   string, stored using the database encoding (UTF-8, UTF-16BE or
157894     *   UTF-16-LE). SQLITE3_BLOB: The value is a blob of data, stored
157895     *   exactly as it was input. SQLITE3_NULL: The value is a NULL value. As
157896     *   of PHP 7.0.7, if {@link type} is omitted, it is automatically
157897     *   detected from the type of the {@link param}: boolean and integer are
157898     *   treated as SQLITE3_INTEGER, float as SQLITE3_FLOAT, null as
157899     *   SQLITE3_NULL and all others as SQLITE3_TEXT. Formerly, if {@link
157900     *   type} has been omitted, it has defaulted to SQLITE3_TEXT.
157901     * @return bool Returns TRUE if the parameter is bound to the statement
157902     *   variable, FALSE on failure.
157903     * @since PHP 5 >= 5.3.0, PHP 7
157904     **/
157905    public function bindParam($sql_param, &$param, $type){}
157906
157907    /**
157908     * Binds the value of a parameter to a statement variable
157909     *
157910     * @param mixed $sql_param Either a string (for named parameters) or an
157911     *   int (for positional parameters) identifying the statement variable
157912     *   to which the value should be bound. If a named parameter does not
157913     *   start with a colon (:) or an at sign (@), a colon (:) is
157914     *   automatically preprended. Positional parameters start with 1.
157915     * @param mixed $value The value to bind to a statement variable.
157916     * @param int $type The data type of the value to bind.
157917     *   SQLITE3_INTEGER: The value is a signed integer, stored in 1, 2, 3,
157918     *   4, 6, or 8 bytes depending on the magnitude of the value.
157919     *   SQLITE3_FLOAT: The value is a floating point value, stored as an
157920     *   8-byte IEEE floating point number. SQLITE3_TEXT: The value is a text
157921     *   string, stored using the database encoding (UTF-8, UTF-16BE or
157922     *   UTF-16-LE). SQLITE3_BLOB: The value is a blob of data, stored
157923     *   exactly as it was input. SQLITE3_NULL: The value is a NULL value. As
157924     *   of PHP 7.0.7, if {@link type} is omitted, it is automatically
157925     *   detected from the type of the {@link value}: boolean and integer are
157926     *   treated as SQLITE3_INTEGER, float as SQLITE3_FLOAT, null as
157927     *   SQLITE3_NULL and all others as SQLITE3_TEXT. Formerly, if {@link
157928     *   type} has been omitted, it has defaulted to SQLITE3_TEXT.
157929     * @return bool Returns TRUE if the value is bound to the statement
157930     *   variable, .
157931     * @since PHP 5 >= 5.3.0, PHP 7
157932     **/
157933    public function bindValue($sql_param, $value, $type){}
157934
157935    /**
157936     * Clears all current bound parameters
157937     *
157938     * Clears all current bound parameters (sets them to NULL).
157939     *
157940     * @return bool Returns TRUE on successful clearing of bound
157941     *   parameters, FALSE on failure.
157942     * @since PHP 5 >= 5.3.0, PHP 7
157943     **/
157944    public function clear(){}
157945
157946    /**
157947     * Closes the prepared statement
157948     *
157949     * @return bool Returns TRUE
157950     * @since PHP 5 >= 5.3.0, PHP 7
157951     **/
157952    public function close(){}
157953
157954    /**
157955     * Executes a prepared statement and returns a result set object
157956     *
157957     * @return SQLite3Result Returns an SQLite3Result object on successful
157958     *   execution of the prepared statement, FALSE on failure.
157959     * @since PHP 5 >= 5.3.0, PHP 7
157960     **/
157961    public function execute(){}
157962
157963    /**
157964     * Get the SQL of the statement
157965     *
157966     * Retrieves the SQL of the prepared statement. If {@link expanded} is
157967     * FALSE, the unmodified SQL is retrieved. If {@link expanded} is TRUE,
157968     * all query parameters are replaced with their bound values, or with an
157969     * SQL NULL, if not already bound.
157970     *
157971     * @param bool $expanded Whether to retrieve the expanded SQL. Passing
157972     *   TRUE is only supported as of libsqlite 3.14.
157973     * @return string Returns the SQL of the prepared statement, .
157974     * @since PHP 7 >= 7.4.0
157975     **/
157976    public function getSQL($expanded){}
157977
157978    /**
157979     * Returns the number of parameters within the prepared statement
157980     *
157981     * @return int Returns the number of parameters within the prepared
157982     *   statement.
157983     * @since PHP 5 >= 5.3.0, PHP 7
157984     **/
157985    public function paramCount(){}
157986
157987    /**
157988     * Returns whether a statement is definitely read only
157989     *
157990     * Returns whether a statement is definitely read only. A statement is
157991     * considered read only, if it makes no direct changes to the content of
157992     * the database file. Note that user defined SQL functions might change
157993     * the database indirectly as a side effect.
157994     *
157995     * @return bool Returns TRUE if a statement is definitely read only,
157996     *   FALSE otherwise.
157997     * @since PHP 5 >= 5.3.6, PHP 7
157998     **/
157999    public function readOnly(){}
158000
158001    /**
158002     * Resets the prepared statement
158003     *
158004     * Resets the prepared statement to its state prior to execution. All
158005     * bindings remain intact after reset.
158006     *
158007     * @return bool Returns TRUE if the statement is successfully reset, .
158008     * @since PHP 5 >= 5.3.0, PHP 7
158009     **/
158010    public function reset(){}
158011
158012}
158013class SQLiteDatabase {
158014    /**
158015     * Execute a query against a given database and returns an array
158016     *
158017     * {@link sqlite_array_query} executes the given query and returns an
158018     * array of the entire result set. It is similar to calling {@link
158019     * sqlite_query} and then {@link sqlite_fetch_array} for each row in the
158020     * result set. {@link sqlite_array_query} is significantly faster than
158021     * the aforementioned.
158022     *
158023     * @param string $query The query to be executed. Data inside the query
158024     *   should be properly escaped.
158025     * @param int $result_type The SQLite Database resource; returned from
158026     *   {@link sqlite_open} when used procedurally. This parameter is not
158027     *   required when using the object-oriented method.
158028     * @param bool $decode_binary
158029     * @return array Returns an array of the entire result set; FALSE
158030     *   otherwise.
158031     **/
158032    public function arrayQuery($query, $result_type, $decode_binary){}
158033
158034    /**
158035     * Set busy timeout duration, or disable busy handlers
158036     *
158037     * Set the maximum time, in milliseconds, that SQLite will wait for a
158038     * {@link dbhandle} to become ready for use.
158039     *
158040     * @param int $milliseconds The SQLite Database resource; returned from
158041     *   {@link sqlite_open} when used procedurally. This parameter is not
158042     *   required when using the object-oriented method.
158043     * @return void
158044     **/
158045    public function busyTimeout($milliseconds){}
158046
158047    /**
158048     * Returns the number of rows that were changed by the most recent SQL
158049     * statement
158050     *
158051     * Returns the numbers of rows that were changed by the most recent SQL
158052     * statement executed against the {@link dbhandle} database handle.
158053     *
158054     * @return int Returns the number of changed rows.
158055     **/
158056    public function changes(){}
158057
158058    /**
158059     * Register an aggregating UDF for use in SQL statements
158060     *
158061     * {@link sqlite_create_aggregate} is similar to {@link
158062     * sqlite_create_function} except that it registers functions that can be
158063     * used to calculate a result aggregated across all the rows of a query.
158064     *
158065     * The key difference between this function and {@link
158066     * sqlite_create_function} is that two functions are required to manage
158067     * the aggregate; {@link step_func} is called for each row of the result
158068     * set. Your PHP function should accumulate the result and store it into
158069     * the aggregation context. Once all the rows have been processed, {@link
158070     * finalize_func} will be called and it should then take the data from
158071     * the aggregation context and return the result. Callback functions
158072     * should return a type understood by SQLite (i.e. scalar type).
158073     *
158074     * @param string $function_name The SQLite Database resource; returned
158075     *   from {@link sqlite_open} when used procedurally. This parameter is
158076     *   not required when using the object-oriented method.
158077     * @param callable $step_func The name of the function used in SQL
158078     *   statements.
158079     * @param callable $finalize_func Callback function called for each row
158080     *   of the result set. Function parameters are &$context, $value, ....
158081     * @param int $num_args Callback function to aggregate the "stepped"
158082     *   data from each row. Function parameter is &$context and the function
158083     *   should return the final result of aggregation.
158084     * @return void
158085     **/
158086    public function createAggregate($function_name, $step_func, $finalize_func, $num_args){}
158087
158088    /**
158089     * Registers a "regular" User Defined Function for use in SQL statements
158090     *
158091     * {@link sqlite_create_function} allows you to register a PHP function
158092     * with SQLite as an UDF (User Defined Function), so that it can be
158093     * called from within your SQL statements.
158094     *
158095     * The UDF can be used in any SQL statement that can call functions, such
158096     * as SELECT and UPDATE statements and also in triggers.
158097     *
158098     * @param string $function_name The SQLite Database resource; returned
158099     *   from {@link sqlite_open} when used procedurally. This parameter is
158100     *   not required when using the object-oriented method.
158101     * @param callable $callback The name of the function used in SQL
158102     *   statements.
158103     * @param int $num_args Callback function to handle the defined SQL
158104     *   function.
158105     * @return void
158106     **/
158107    public function createFunction($function_name, $callback, $num_args){}
158108
158109    /**
158110     * Return an array of column types from a particular table
158111     *
158112     * {@link sqlite_fetch_column_types} returns an array of column data
158113     * types from the specified {@link table_name} table.
158114     *
158115     * @param string $table_name The table name to query.
158116     * @param int $result_type The SQLite Database resource; returned from
158117     *   {@link sqlite_open} when used procedurally. This parameter is not
158118     *   required when using the object-oriented method.
158119     * @return array Returns an array of column data types; FALSE on error.
158120     **/
158121    public function fetchColumnTypes($table_name, $result_type){}
158122
158123    /**
158124     * Returns the error code of the last error for a database
158125     *
158126     * Returns the error code from the last operation performed on {@link
158127     * dbhandle} (the database handle), or 0 when no error occurred. A human
158128     * readable description of the error code can be retrieved using {@link
158129     * sqlite_error_string}.
158130     *
158131     * @return int Returns an error code, or 0 if no error occurred.
158132     **/
158133    public function lastError(){}
158134
158135    /**
158136     * Returns the rowid of the most recently inserted row
158137     *
158138     * Returns the rowid of the row that was most recently inserted into the
158139     * database {@link dbhandle}, if it was created as an auto-increment
158140     * field.
158141     *
158142     * @return int Returns the row id, as an integer.
158143     **/
158144    public function lastInsertRowid(){}
158145
158146    /**
158147     * Executes a query against a given database and returns a result handle
158148     *
158149     * Executes an SQL statement given by the {@link query} against a given
158150     * database handle.
158151     *
158152     * @param string $query The SQLite Database resource; returned from
158153     *   {@link sqlite_open} when used procedurally. This parameter is not
158154     *   required when using the object-oriented method.
158155     * @param int $result_type The query to be executed. Data inside the
158156     *   query should be properly escaped.
158157     * @param string $error_msg
158158     * @return SQLiteResult This function will return a result handle. For
158159     *   queries that return rows, the result handle can then be used with
158160     *   functions such as {@link sqlite_fetch_array} and {@link
158161     *   sqlite_seek}.
158162     **/
158163    public function query($query, $result_type, &$error_msg){}
158164
158165    /**
158166     * Executes a result-less query against a given database
158167     *
158168     * Executes an SQL statement given by the {@link query} against a given
158169     * database handle (specified by the {@link dbhandle} parameter).
158170     *
158171     * @param string $query The SQLite Database resource; returned from
158172     *   {@link sqlite_open} when used procedurally. This parameter is not
158173     *   required when using the object-oriented method.
158174     * @param string $error_msg The query to be executed. Data inside the
158175     *   query should be properly escaped.
158176     * @return bool This function will return a boolean result; TRUE for
158177     *   success or FALSE for failure. If you need to run a query that
158178     *   returns rows, see {@link sqlite_query}.
158179     **/
158180    public function queryExec($query, &$error_msg){}
158181
158182    /**
158183     * Executes a query and returns either an array for one single column or
158184     * the value of the first row
158185     *
158186     * @param string $query
158187     * @param bool $first_row_only
158188     * @param bool $decode_binary
158189     * @return array
158190     **/
158191    public function singleQuery($query, $first_row_only, $decode_binary){}
158192
158193    /**
158194     * Execute a query that does not prefetch and buffer all data
158195     *
158196     * {@link sqlite_unbuffered_query} is identical to {@link sqlite_query}
158197     * except that the result that is returned is a sequential forward-only
158198     * result set that can only be used to read each row, one after the
158199     * other.
158200     *
158201     * This function is ideal for generating things such as HTML tables where
158202     * you only need to process one row at a time and don't need to randomly
158203     * access the row data.
158204     *
158205     * @param string $query The SQLite Database resource; returned from
158206     *   {@link sqlite_open} when used procedurally. This parameter is not
158207     *   required when using the object-oriented method.
158208     * @param int $result_type The query to be executed. Data inside the
158209     *   query should be properly escaped.
158210     * @param string $error_msg
158211     * @return SQLiteUnbuffered Returns a result handle.
158212     **/
158213    public function unbufferedQuery($query, $result_type, &$error_msg){}
158214
158215}
158216class SQLiteResult {
158217    /**
158218     * Fetches a column from the current row of a result set
158219     *
158220     * Fetches the value of a column named {@link index_or_name} (if it is a
158221     * string), or of the ordinal column numbered {@link index_or_name} (if
158222     * it is an integer) from the current row of the query result handle
158223     * {@link result}.
158224     *
158225     * @param mixed $index_or_name The SQLite result resource. This
158226     *   parameter is not required when using the object-oriented method.
158227     * @param bool $decode_binary The column index or name to fetch.
158228     * @return mixed Returns the column value.
158229     **/
158230    function column($index_or_name, $decode_binary){}
158231
158232    /**
158233     * Fetches the current row from a result set as an array
158234     *
158235     * {@link sqlite_current} is identical to {@link sqlite_fetch_array}
158236     * except that it does not advance to the next row prior to returning the
158237     * data; it returns the data from the current position only.
158238     *
158239     * @param int $result_type The SQLite result resource. This parameter
158240     *   is not required when using the object-oriented method.
158241     * @param bool $decode_binary
158242     * @return array Returns an array of the current row from a result set;
158243     *   FALSE if the current position is beyond the final row.
158244     **/
158245    function current($result_type, $decode_binary){}
158246
158247    /**
158248     * Fetches the next row from a result set as an array
158249     *
158250     * Fetches the next row from the given {@link result} handle. If there
158251     * are no more rows, returns FALSE, otherwise returns an associative
158252     * array representing the row data.
158253     *
158254     * @param int $result_type The SQLite result resource. This parameter
158255     *   is not required when using the object-oriented method.
158256     * @param bool $decode_binary
158257     * @return array Returns an array of the next row from a result set;
158258     *   FALSE if the next position is beyond the final row.
158259     **/
158260    function fetch($result_type, $decode_binary){}
158261
158262    /**
158263     * Fetches all rows from a result set as an array of arrays
158264     *
158265     * {@link sqlite_fetch_all} returns an array of the entire result set
158266     * from the {@link result} resource. It is similar to calling {@link
158267     * sqlite_query} (or {@link sqlite_unbuffered_query}) and then {@link
158268     * sqlite_fetch_array} for each row in the result set.
158269     *
158270     * @param int $result_type The SQLite result resource. This parameter
158271     *   is not required when using the object-oriented method.
158272     * @param bool $decode_binary
158273     * @return array Returns an array of the remaining rows in a result
158274     *   set. If called right after {@link sqlite_query}, it returns all
158275     *   rows. If called after {@link sqlite_fetch_array}, it returns the
158276     *   rest. If there are no rows in a result set, it returns an empty
158277     *   array.
158278     **/
158279    function fetchAll($result_type, $decode_binary){}
158280
158281    /**
158282     * Fetches the next row from a result set as an object
158283     *
158284     * @param string $class_name
158285     * @param array $ctor_params
158286     * @param bool $decode_binary
158287     * @return object
158288     **/
158289    function fetchObject($class_name, $ctor_params, $decode_binary){}
158290
158291    /**
158292     * Fetches the first column of a result set as a string
158293     *
158294     * {@link sqlite_fetch_single} is identical to {@link sqlite_fetch_array}
158295     * except that it returns the value of the first column of the rowset.
158296     *
158297     * This is the most optimal way to retrieve data when you are only
158298     * interested in the values from a single column of data.
158299     *
158300     * @param bool $decode_binary The SQLite result resource. This
158301     *   parameter is not required when using the object-oriented method.
158302     * @return string Returns the first column value, as a string.
158303     **/
158304    function fetchSingle($decode_binary){}
158305
158306    /**
158307     * Returns the name of a particular field
158308     *
158309     * Given the ordinal column number, {@link field_index}, {@link
158310     * sqlite_field_name} returns the name of that field in the result set
158311     * {@link result}.
158312     *
158313     * @param int $field_index The SQLite result resource. This parameter
158314     *   is not required when using the object-oriented method.
158315     * @return string Returns the name of a field in an SQLite result set,
158316     *   given the ordinal column number; FALSE on error.
158317     **/
158318    function fieldName($field_index){}
158319
158320    /**
158321     * Returns whether or not a previous row is available
158322     *
158323     * Find whether there are more previous rows from the given result
158324     * handle.
158325     *
158326     * @return bool Returns TRUE if there are more previous rows available
158327     *   from the {@link result} handle, or FALSE otherwise.
158328     **/
158329    function hasPrev(){}
158330
158331    /**
158332     * Returns the current row index
158333     *
158334     * SQLiteResult::key returns the current row index of the buffered result
158335     * set {@link result}.
158336     *
158337     * Unlike all other SQLite functions, this function does not have a
158338     * procedural version, and can only be called as a method on a
158339     * SQLiteResult object.
158340     *
158341     * @return int Returns the current row index of the buffered result set
158342     *   {@link result}.
158343     **/
158344    function key(){}
158345
158346    /**
158347     * Seek to the next row number
158348     *
158349     * {@link sqlite_next} advances the result handle {@link result} to the
158350     * next row.
158351     *
158352     * @return bool Returns TRUE on success, or FALSE if there are no more
158353     *   rows.
158354     **/
158355    function next(){}
158356
158357    /**
158358     * Returns the number of fields in a result set
158359     *
158360     * Returns the number of fields in the {@link result} set.
158361     *
158362     * @return int Returns the number of fields, as an integer.
158363     **/
158364    function numFields(){}
158365
158366    /**
158367     * Returns the number of rows in a buffered result set
158368     *
158369     * Returns the number of rows in the buffered {@link result} set.
158370     *
158371     * @return int Returns the number of rows, as an integer.
158372     **/
158373    function numRows(){}
158374
158375    /**
158376     * Seek to the previous row number of a result set
158377     *
158378     * {@link sqlite_prev} seeks back the {@link result} handle to the
158379     * previous row.
158380     *
158381     * @return bool Returns TRUE on success, or FALSE if there are no more
158382     *   previous rows.
158383     **/
158384    function prev(){}
158385
158386    /**
158387     * Seek to the first row number
158388     *
158389     * {@link sqlite_rewind} seeks back to the first row in the given result
158390     * set.
158391     *
158392     * @return bool Returns FALSE if there are no rows in the result set,
158393     *   TRUE otherwise.
158394     **/
158395    function rewind(){}
158396
158397    /**
158398     * Seek to a particular row number of a buffered result set
158399     *
158400     * {@link sqlite_seek} seeks to the row given by the parameter {@link
158401     * rownum}.
158402     *
158403     * @param int $rownum The SQLite result resource. This parameter is not
158404     *   required when using the object-oriented method.
158405     * @return bool Returns FALSE if the row does not exist, TRUE
158406     *   otherwise.
158407     **/
158408    function seek($rownum){}
158409
158410    /**
158411     * Fetches the first column of a result set as a string
158412     *
158413     * {@link sqlite_fetch_single} is identical to {@link sqlite_fetch_array}
158414     * except that it returns the value of the first column of the rowset.
158415     *
158416     * This is the most optimal way to retrieve data when you are only
158417     * interested in the values from a single column of data.
158418     *
158419     * @param bool $decode_binary The SQLite result resource. This
158420     *   parameter is not required when using the object-oriented method.
158421     * @return string Returns the first column value, as a string.
158422     **/
158423    function sqlite_fetch_string($decode_binary){}
158424
158425    /**
158426     * Returns whether more rows are available
158427     *
158428     * Finds whether more rows are available from the given result handle.
158429     *
158430     * @return bool Returns TRUE if there are more rows available from the
158431     *   {@link result} handle, or FALSE otherwise.
158432     **/
158433    function valid(){}
158434
158435}
158436class SQLiteUnbuffered {
158437    /**
158438     * Fetches a column from the current row of a result set
158439     *
158440     * Fetches the value of a column named {@link index_or_name} (if it is a
158441     * string), or of the ordinal column numbered {@link index_or_name} (if
158442     * it is an integer) from the current row of the query result handle
158443     * {@link result}.
158444     *
158445     * @param mixed $index_or_name The SQLite result resource. This
158446     *   parameter is not required when using the object-oriented method.
158447     * @param bool $decode_binary The column index or name to fetch.
158448     * @return mixed Returns the column value.
158449     **/
158450    function column($index_or_name, $decode_binary){}
158451
158452    /**
158453     * Fetches the current row from a result set as an array
158454     *
158455     * {@link sqlite_current} is identical to {@link sqlite_fetch_array}
158456     * except that it does not advance to the next row prior to returning the
158457     * data; it returns the data from the current position only.
158458     *
158459     * @param int $result_type The SQLite result resource. This parameter
158460     *   is not required when using the object-oriented method.
158461     * @param bool $decode_binary
158462     * @return array Returns an array of the current row from a result set;
158463     *   FALSE if the current position is beyond the final row.
158464     **/
158465    function current($result_type, $decode_binary){}
158466
158467    /**
158468     * Fetches the next row from a result set as an array
158469     *
158470     * Fetches the next row from the given {@link result} handle. If there
158471     * are no more rows, returns FALSE, otherwise returns an associative
158472     * array representing the row data.
158473     *
158474     * @param int $result_type The SQLite result resource. This parameter
158475     *   is not required when using the object-oriented method.
158476     * @param bool $decode_binary
158477     * @return array Returns an array of the next row from a result set;
158478     *   FALSE if the next position is beyond the final row.
158479     **/
158480    function fetch($result_type, $decode_binary){}
158481
158482    /**
158483     * Fetches all rows from a result set as an array of arrays
158484     *
158485     * {@link sqlite_fetch_all} returns an array of the entire result set
158486     * from the {@link result} resource. It is similar to calling {@link
158487     * sqlite_query} (or {@link sqlite_unbuffered_query}) and then {@link
158488     * sqlite_fetch_array} for each row in the result set.
158489     *
158490     * @param int $result_type The SQLite result resource. This parameter
158491     *   is not required when using the object-oriented method.
158492     * @param bool $decode_binary
158493     * @return array Returns an array of the remaining rows in a result
158494     *   set. If called right after {@link sqlite_query}, it returns all
158495     *   rows. If called after {@link sqlite_fetch_array}, it returns the
158496     *   rest. If there are no rows in a result set, it returns an empty
158497     *   array.
158498     **/
158499    function fetchAll($result_type, $decode_binary){}
158500
158501    /**
158502     * Fetches the next row from a result set as an object
158503     *
158504     * @param string $class_name
158505     * @param array $ctor_params
158506     * @param bool $decode_binary
158507     * @return object
158508     **/
158509    function fetchObject($class_name, $ctor_params, $decode_binary){}
158510
158511    /**
158512     * Fetches the first column of a result set as a string
158513     *
158514     * {@link sqlite_fetch_single} is identical to {@link sqlite_fetch_array}
158515     * except that it returns the value of the first column of the rowset.
158516     *
158517     * This is the most optimal way to retrieve data when you are only
158518     * interested in the values from a single column of data.
158519     *
158520     * @param bool $decode_binary The SQLite result resource. This
158521     *   parameter is not required when using the object-oriented method.
158522     * @return string Returns the first column value, as a string.
158523     **/
158524    function fetchSingle($decode_binary){}
158525
158526    /**
158527     * Returns the name of a particular field
158528     *
158529     * Given the ordinal column number, {@link field_index}, {@link
158530     * sqlite_field_name} returns the name of that field in the result set
158531     * {@link result}.
158532     *
158533     * @param int $field_index The SQLite result resource. This parameter
158534     *   is not required when using the object-oriented method.
158535     * @return string Returns the name of a field in an SQLite result set,
158536     *   given the ordinal column number; FALSE on error.
158537     **/
158538    function fieldName($field_index){}
158539
158540    /**
158541     * Seek to the next row number
158542     *
158543     * {@link sqlite_next} advances the result handle {@link result} to the
158544     * next row.
158545     *
158546     * @return bool Returns TRUE on success, or FALSE if there are no more
158547     *   rows.
158548     **/
158549    function next(){}
158550
158551    /**
158552     * Returns the number of fields in a result set
158553     *
158554     * Returns the number of fields in the {@link result} set.
158555     *
158556     * @return int Returns the number of fields, as an integer.
158557     **/
158558    function numFields(){}
158559
158560    /**
158561     * Fetches the first column of a result set as a string
158562     *
158563     * {@link sqlite_fetch_single} is identical to {@link sqlite_fetch_array}
158564     * except that it returns the value of the first column of the rowset.
158565     *
158566     * This is the most optimal way to retrieve data when you are only
158567     * interested in the values from a single column of data.
158568     *
158569     * @param bool $decode_binary The SQLite result resource. This
158570     *   parameter is not required when using the object-oriented method.
158571     * @return string Returns the first column value, as a string.
158572     **/
158573    function sqlite_fetch_string($decode_binary){}
158574
158575    /**
158576     * Returns whether more rows are available
158577     *
158578     * Finds whether more rows are available from the given result handle.
158579     *
158580     * @return bool Returns TRUE if there are more rows available from the
158581     *   {@link result} handle, or FALSE otherwise.
158582     **/
158583    function valid(){}
158584
158585}
158586/**
158587 * Created by typecasting to object.
158588 **/
158589class stdClass {
158590}
158591/**
158592 * Represents a connection between PHP and a Stomp compliant Message
158593 * Broker.
158594 **/
158595class Stomp {
158596    /**
158597     * Rolls back a transaction in progress
158598     *
158599     * @param string $transaction_id The transaction to abort.
158600     * @param array $headers
158601     * @return bool
158602     * @since PECL stomp >= 0.1.0
158603     **/
158604    public function abort($transaction_id, $headers){}
158605
158606    /**
158607     * Acknowledges consumption of a message
158608     *
158609     * Acknowledges consumption of a message from a subscription using client
158610     * acknowledgment.
158611     *
158612     * @param mixed $msg The message/messageId to be acknowledged.
158613     * @param array $headers
158614     * @return bool
158615     * @since PECL stomp >= 0.1.0
158616     **/
158617    public function ack($msg, $headers){}
158618
158619    /**
158620     * Starts a transaction
158621     *
158622     * @param string $transaction_id The transaction id.
158623     * @param array $headers
158624     * @return bool
158625     * @since PECL stomp >= 0.1.0
158626     **/
158627    public function begin($transaction_id, $headers){}
158628
158629    /**
158630     * Commits a transaction in progress
158631     *
158632     * @param string $transaction_id The transaction id.
158633     * @param array $headers
158634     * @return bool
158635     * @since PECL stomp >= 0.1.0
158636     **/
158637    public function commit($transaction_id, $headers){}
158638
158639    /**
158640     * Gets the last stomp error
158641     *
158642     * @return string Returns an error string or FALSE if no error
158643     *   occurred.
158644     * @since PECL stomp >= 0.1.0
158645     **/
158646    public function error(){}
158647
158648    /**
158649     * Gets read timeout
158650     *
158651     * @return array Returns an array with 2 elements: sec and usec.
158652     * @since PECL stomp >= 0.3.0
158653     **/
158654    public function getReadTimeout(){}
158655
158656    /**
158657     * Gets the current stomp session ID
158658     *
158659     * @return string session id on success.
158660     * @since PECL stomp >= 0.1.0
158661     **/
158662    public function getSessionId(){}
158663
158664    /**
158665     * Indicates whether or not there is a frame ready to read
158666     *
158667     * @return bool Returns TRUE if a frame is ready to read, or FALSE
158668     *   otherwise.
158669     * @since PECL stomp >= 0.1.0
158670     **/
158671    public function hasFrame(){}
158672
158673    /**
158674     * Reads the next frame
158675     *
158676     * Reads the next frame. It is possible to instantiate an object of a
158677     * specific class, and pass parameters to that class's constructor.
158678     *
158679     * @param string $class_name The name of the class to instantiate. If
158680     *   not specified, a stompFrame object is returned.
158681     * @return stompframe
158682     * @since PECL stomp >= 0.1.0
158683     **/
158684    public function readFrame($class_name){}
158685
158686    /**
158687     * Sends a message
158688     *
158689     * Sends a message to the Message Broker.
158690     *
158691     * @param string $destination Where to send the message
158692     * @param mixed $msg Message to send.
158693     * @param array $headers
158694     * @return bool
158695     * @since PECL stomp >= 0.1.0
158696     **/
158697    public function send($destination, $msg, $headers){}
158698
158699    /**
158700     * Sets read timeout
158701     *
158702     * @param int $seconds The seconds part of the timeout to be set.
158703     * @param int $microseconds The microseconds part of the timeout to be
158704     *   set.
158705     * @return void
158706     * @since PECL stomp >= 0.3.0
158707     **/
158708    public function setReadTimeout($seconds, $microseconds){}
158709
158710    /**
158711     * Registers to listen to a given destination
158712     *
158713     * @param string $destination Destination to subscribe to.
158714     * @param array $headers
158715     * @return bool
158716     * @since PECL stomp >= 0.1.0
158717     **/
158718    public function subscribe($destination, $headers){}
158719
158720    /**
158721     * Removes an existing subscription
158722     *
158723     * @param string $destination Subscription to remove.
158724     * @param array $headers
158725     * @return bool
158726     * @since PECL stomp >= 0.1.0
158727     **/
158728    public function unsubscribe($destination, $headers){}
158729
158730    /**
158731     * Opens a connection
158732     *
158733     * (constructor):
158734     *
158735     * Opens a connection to a stomp compliant Message Broker.
158736     *
158737     * @param string $broker The broker URI
158738     * @param string $username The username.
158739     * @param string $password The password.
158740     * @param array $headers
158741     * @since PECL stomp >= 0.1.0
158742     **/
158743    public function __construct($broker, $username, $password, $headers){}
158744
158745    /**
158746     * Closes stomp connection
158747     *
158748     * (destructor):
158749     *
158750     * Closes a previously opened connection.
158751     *
158752     * @return bool
158753     * @since PECL stomp >= 0.1.0
158754     **/
158755    public function __destruct(){}
158756
158757}
158758/**
158759 * Represents an error raised by the stomp extension. See Exceptions for
158760 * more information about Exceptions in PHP.
158761 **/
158762class StompException extends Exception {
158763    /**
158764     * Get exception details
158765     *
158766     * @return string containing the error details.
158767     * @since PECL stomp >= 0.1.0
158768     **/
158769    public function getDetails(){}
158770
158771}
158772/**
158773 * Represents a message which was sent or received from a Stomp compliant
158774 * Message Broker.
158775 **/
158776class StompFrame {
158777    /**
158778     * Frame body.
158779     *
158780     * @var mixed
158781     **/
158782    public $body;
158783
158784    /**
158785     * Frame command.
158786     *
158787     * @var mixed
158788     **/
158789    public $command;
158790
158791    /**
158792     * Frame headers ().
158793     *
158794     * @var mixed
158795     **/
158796    public $headers;
158797
158798    /**
158799     * Constructor
158800     *
158801     * @param string $command Frame command
158802     * @param array $headers Frame headers ().
158803     * @param string $body Frame body.
158804     * @since PECL stomp >= 0.1.0
158805     **/
158806    function __construct($command, $headers, $body){}
158807
158808}
158809class streamWrapper {
158810    /**
158811     * The current context, or NULL if no context was passed to the caller
158812     * function.
158813     *
158814     * Use the {@link stream_context_get_options} to parse the context.
158815     *
158816     * @var resource
158817     **/
158818    public $context;
158819
158820    /**
158821     * Close directory handle
158822     *
158823     * This method is called in response to {@link closedir}.
158824     *
158825     * Any resources which were locked, or allocated, during opening and use
158826     * of the directory stream should be released.
158827     *
158828     * @return bool
158829     * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
158830     **/
158831    public function dir_closedir(){}
158832
158833    /**
158834     * Open directory handle
158835     *
158836     * This method is called in response to {@link opendir}.
158837     *
158838     * @param string $path Specifies the URL that was passed to {@link
158839     *   opendir}.
158840     * @param int $options Whether or not to enforce safe_mode (0x04).
158841     * @return bool
158842     * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
158843     **/
158844    public function dir_opendir($path, $options){}
158845
158846    /**
158847     * Read entry from directory handle
158848     *
158849     * This method is called in response to {@link readdir}.
158850     *
158851     * @return string Should return string representing the next filename,
158852     *   or FALSE if there is no next file.
158853     * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
158854     **/
158855    public function dir_readdir(){}
158856
158857    /**
158858     * Rewind directory handle
158859     *
158860     * This method is called in response to {@link rewinddir}.
158861     *
158862     * Should reset the output generated by streamWrapper::dir_readdir. i.e.:
158863     * The next call to streamWrapper::dir_readdir should return the first
158864     * entry in the location returned by streamWrapper::dir_opendir.
158865     *
158866     * @return bool
158867     * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
158868     **/
158869    public function dir_rewinddir(){}
158870
158871    /**
158872     * Create a directory
158873     *
158874     * This method is called in response to {@link mkdir}.
158875     *
158876     * @param string $path Directory which should be created.
158877     * @param int $mode The value passed to {@link mkdir}.
158878     * @param int $options A bitwise mask of values, such as
158879     *   STREAM_MKDIR_RECURSIVE.
158880     * @return bool
158881     * @since PHP 5, PHP 7
158882     **/
158883    public function mkdir($path, $mode, $options){}
158884
158885    /**
158886     * Renames a file or directory
158887     *
158888     * This method is called in response to {@link rename}.
158889     *
158890     * Should attempt to rename {@link path_from} to {@link path_to}
158891     *
158892     * @param string $path_from The URL to the current file.
158893     * @param string $path_to The URL which the {@link path_from} should be
158894     *   renamed to.
158895     * @return bool
158896     * @since PHP 5, PHP 7
158897     **/
158898    public function rename($path_from, $path_to){}
158899
158900    /**
158901     * Removes a directory
158902     *
158903     * This method is called in response to {@link rmdir}.
158904     *
158905     * @param string $path The directory URL which should be removed.
158906     * @param int $options A bitwise mask of values, such as
158907     *   STREAM_MKDIR_RECURSIVE.
158908     * @return bool
158909     * @since PHP 5, PHP 7
158910     **/
158911    public function rmdir($path, $options){}
158912
158913    /**
158914     * Retrieve the underlaying resource
158915     *
158916     * This method is called in response to {@link stream_select}.
158917     *
158918     * @param int $cast_as Can be STREAM_CAST_FOR_SELECT when {@link
158919     *   stream_select} is calling {@link stream_cast} or
158920     *   STREAM_CAST_AS_STREAM when {@link stream_cast} is called for other
158921     *   uses.
158922     * @return resource Should return the underlying stream resource used
158923     *   by the wrapper, or FALSE.
158924     * @since PHP 5 >= 5.3.0, PHP 7
158925     **/
158926    public function stream_cast($cast_as){}
158927
158928    /**
158929     * Close a resource
158930     *
158931     * This method is called in response to {@link fclose}.
158932     *
158933     * All resources that were locked, or allocated, by the wrapper should be
158934     * released.
158935     *
158936     * @return void
158937     * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
158938     **/
158939    public function stream_close(){}
158940
158941    /**
158942     * Tests for end-of-file on a file pointer
158943     *
158944     * This method is called in response to {@link feof}.
158945     *
158946     * @return bool Should return TRUE if the read/write position is at the
158947     *   end of the stream and if no more data is available to be read, or
158948     *   FALSE otherwise.
158949     * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
158950     **/
158951    public function stream_eof(){}
158952
158953    /**
158954     * Flushes the output
158955     *
158956     * This method is called in response to {@link fflush} and when the
158957     * stream is being closed while any unflushed data has been written to it
158958     * before.
158959     *
158960     * If you have cached data in your stream but not yet stored it into the
158961     * underlying storage, you should do so now.
158962     *
158963     * @return bool Should return TRUE if the cached data was successfully
158964     *   stored (or if there was no data to store), or FALSE if the data
158965     *   could not be stored.
158966     * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
158967     **/
158968    public function stream_flush(){}
158969
158970    /**
158971     * Advisory file locking
158972     *
158973     * This method is called in response to {@link flock}, when {@link
158974     * file_put_contents} (when {@link flags} contains LOCK_EX), {@link
158975     * stream_set_blocking} and when closing the stream (LOCK_UN).
158976     *
158977     * @param int $operation {@link operation} is one of the following:
158978     *   LOCK_SH to acquire a shared lock (reader). LOCK_EX to acquire an
158979     *   exclusive lock (writer). LOCK_UN to release a lock (shared or
158980     *   exclusive). LOCK_NB if you don't want {@link flock} to block while
158981     *   locking. (not supported on Windows)
158982     * @return bool
158983     * @since PHP 5, PHP 7
158984     **/
158985    public function stream_lock($operation){}
158986
158987    /**
158988     * Change stream metadata
158989     *
158990     * This method is called to set metadata on the stream. It is called when
158991     * one of the following functions is called on a stream URL: {@link
158992     * touch} {@link chmod} {@link chown} {@link chgrp} Please note that some
158993     * of these operations may not be available on your system.
158994     *
158995     * @param string $path The file path or URL to set metadata. Note that
158996     *   in the case of a URL, it must be a :// delimited URL. Other URL
158997     *   forms are not supported.
158998     * @param int $option One of: STREAM_META_TOUCH (The method was called
158999     *   in response to {@link touch}) STREAM_META_OWNER_NAME (The method was
159000     *   called in response to {@link chown} with string parameter)
159001     *   STREAM_META_OWNER (The method was called in response to {@link
159002     *   chown}) STREAM_META_GROUP_NAME (The method was called in response to
159003     *   {@link chgrp}) STREAM_META_GROUP (The method was called in response
159004     *   to {@link chgrp}) STREAM_META_ACCESS (The method was called in
159005     *   response to {@link chmod})
159006     * @param mixed $value If {@link option} is STREAM_META_TOUCH: Array
159007     *   consisting of two arguments of the {@link touch} function.
159008     *   STREAM_META_OWNER_NAME or STREAM_META_GROUP_NAME: The name of the
159009     *   owner user/group as string. STREAM_META_OWNER or STREAM_META_GROUP:
159010     *   The value owner user/group argument as integer. STREAM_META_ACCESS:
159011     *   The argument of the {@link chmod} as integer.
159012     * @return bool If {@link option} is not implemented, FALSE should be
159013     *   returned.
159014     * @since PHP 5 >= 5.4.0, PHP 7
159015     **/
159016    public function stream_metadata($path, $option, $value){}
159017
159018    /**
159019     * Opens file or URL
159020     *
159021     * This method is called immediately after the wrapper is initialized
159022     * (f.e. by {@link fopen} and {@link file_get_contents}).
159023     *
159024     * @param string $path Specifies the URL that was passed to the
159025     *   original function.
159026     * @param string $mode The mode used to open the file, as detailed for
159027     *   {@link fopen}.
159028     * @param int $options Holds additional flags set by the streams API.
159029     *   It can hold one or more of the following values OR'd together. Flag
159030     *   Description STREAM_USE_PATH If {@link path} is relative, search for
159031     *   the resource using the include_path. STREAM_REPORT_ERRORS If this
159032     *   flag is set, you are responsible for raising errors using {@link
159033     *   trigger_error} during opening of the stream. If this flag is not
159034     *   set, you should not raise any errors.
159035     * @param string $opened_path If the {@link path} is opened
159036     *   successfully, and STREAM_USE_PATH is set in {@link options}, {@link
159037     *   opened_path} should be set to the full path of the file/resource
159038     *   that was actually opened.
159039     * @return bool
159040     * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
159041     **/
159042    public function stream_open($path, $mode, $options, &$opened_path){}
159043
159044    /**
159045     * Read from stream
159046     *
159047     * This method is called in response to {@link fread} and {@link fgets}.
159048     *
159049     * @param int $count How many bytes of data from the current position
159050     *   should be returned.
159051     * @return string If there are less than {@link count} bytes available,
159052     *   return as many as are available. If no more data is available,
159053     *   return either FALSE or an empty string.
159054     * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
159055     **/
159056    public function stream_read($count){}
159057
159058    /**
159059     * Seeks to specific location in a stream
159060     *
159061     * This method is called in response to {@link fseek}.
159062     *
159063     * The read/write position of the stream should be updated according to
159064     * the {@link offset} and {@link whence}.
159065     *
159066     * @param int $offset The stream offset to seek to.
159067     * @param int $whence Possible values: SEEK_SET - Set position equal to
159068     *   {@link offset} bytes. SEEK_CUR - Set position to current location
159069     *   plus {@link offset}. SEEK_END - Set position to end-of-file plus
159070     *   {@link offset}.
159071     * @return bool Return TRUE if the position was updated, FALSE
159072     *   otherwise.
159073     * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
159074     **/
159075    public function stream_seek($offset, $whence){}
159076
159077    /**
159078     * Change stream options
159079     *
159080     * This method is called to set options on the stream.
159081     *
159082     * @param int $option One of: STREAM_OPTION_BLOCKING (The method was
159083     *   called in response to {@link stream_set_blocking})
159084     *   STREAM_OPTION_READ_TIMEOUT (The method was called in response to
159085     *   {@link stream_set_timeout}) STREAM_OPTION_WRITE_BUFFER (The method
159086     *   was called in response to {@link stream_set_write_buffer})
159087     * @param int $arg1 If {@link option} is STREAM_OPTION_BLOCKING:
159088     *   requested blocking mode (1 meaning block 0 not blocking).
159089     *   STREAM_OPTION_READ_TIMEOUT: the timeout in seconds.
159090     *   STREAM_OPTION_WRITE_BUFFER: buffer mode (STREAM_BUFFER_NONE or
159091     *   STREAM_BUFFER_FULL).
159092     * @param int $arg2 If {@link option} is STREAM_OPTION_BLOCKING: This
159093     *   option is not set. STREAM_OPTION_READ_TIMEOUT: the timeout in
159094     *   microseconds. STREAM_OPTION_WRITE_BUFFER: the requested buffer size.
159095     * @return bool If {@link option} is not implemented, FALSE should be
159096     *   returned.
159097     * @since PHP 5 >= 5.3.0, PHP 7
159098     **/
159099    public function stream_set_option($option, $arg1, $arg2){}
159100
159101    /**
159102     * Retrieve information about a file resource
159103     *
159104     * This method is called in response to {@link fstat}.
159105     *
159106     * @return array See {@link stat}.
159107     * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
159108     **/
159109    public function stream_stat(){}
159110
159111    /**
159112     * Retrieve the current position of a stream
159113     *
159114     * This method is called in response to {@link fseek} to determine the
159115     * current position.
159116     *
159117     * @return int Should return the current position of the stream.
159118     * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
159119     **/
159120    public function stream_tell(){}
159121
159122    /**
159123     * Truncate stream
159124     *
159125     * Will respond to truncation, e.g., through {@link ftruncate}.
159126     *
159127     * @param int $new_size The new size.
159128     * @return bool
159129     * @since PHP 5 >= 5.4.0, PHP 7
159130     **/
159131    public function stream_truncate($new_size){}
159132
159133    /**
159134     * Write to stream
159135     *
159136     * This method is called in response to {@link fwrite}.
159137     *
159138     * @param string $data Should be stored into the underlying stream.
159139     * @return int Should return the number of bytes that were successfully
159140     *   stored, or 0 if none could be stored.
159141     * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
159142     **/
159143    public function stream_write($data){}
159144
159145    /**
159146     * Delete a file
159147     *
159148     * This method is called in response to {@link unlink}.
159149     *
159150     * @param string $path The file URL which should be deleted.
159151     * @return bool
159152     * @since PHP 5, PHP 7
159153     **/
159154    public function unlink($path){}
159155
159156    /**
159157     * Retrieve information about a file
159158     *
159159     * This method is called in response to all {@link stat} related
159160     * functions, such as: {@link chmod} (only when safe_mode is enabled)
159161     * {@link copy} {@link fileperms} {@link fileinode} {@link filesize}
159162     * {@link fileowner} {@link filegroup} {@link fileatime} {@link
159163     * filemtime} {@link filectime} {@link filetype} {@link is_writable}
159164     * {@link is_readable} {@link is_executable} {@link is_file} {@link
159165     * is_dir} {@link is_link} {@link file_exists} {@link lstat} {@link stat}
159166     * SplFileInfo::getPerms SplFileInfo::getInode SplFileInfo::getSize
159167     * SplFileInfo::getOwner SplFileInfo::getGroup SplFileInfo::getATime
159168     * SplFileInfo::getMTime SplFileInfo::getCTime SplFileInfo::getType
159169     * SplFileInfo::isWritable SplFileInfo::isReadable
159170     * SplFileInfo::isExecutable SplFileInfo::isFile SplFileInfo::isDir
159171     * SplFileInfo::isLink RecursiveDirectoryIterator::hasChildren
159172     *
159173     * @param string $path The file path or URL to stat. Note that in the
159174     *   case of a URL, it must be a :// delimited URL. Other URL forms are
159175     *   not supported.
159176     * @param int $flags Holds additional flags set by the streams API. It
159177     *   can hold one or more of the following values OR'd together. Flag
159178     *   Description STREAM_URL_STAT_LINK For resources with the ability to
159179     *   link to other resource (such as an HTTP Location: forward, or a
159180     *   filesystem symlink). This flag specified that only information about
159181     *   the link itself should be returned, not the resource pointed to by
159182     *   the link. This flag is set in response to calls to {@link lstat},
159183     *   {@link is_link}, or {@link filetype}. STREAM_URL_STAT_QUIET If this
159184     *   flag is set, your wrapper should not raise any errors. If this flag
159185     *   is not set, you are responsible for reporting errors using the
159186     *   {@link trigger_error} function during stating of the path.
159187     * @return array Should return as many elements as {@link stat} does.
159188     *   Unknown or unavailable values should be set to a rational value
159189     *   (usually 0). Pay special attention to mode as documented under
159190     *   {@link stat}.
159191     * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
159192     **/
159193    public function url_stat($path, $flags){}
159194
159195    /**
159196     * Constructs a new stream wrapper
159197     *
159198     * Called when opening the stream wrapper, right before
159199     * streamWrapper::stream_open.
159200     *
159201     * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
159202     **/
159203    function __construct(){}
159204
159205    /**
159206     * Destructs an existing stream wrapper
159207     *
159208     * Called when closing the stream wrapper, right before
159209     * streamWrapper::stream_flush.
159210     *
159211     * @since PHP 4 >= 4.3.2, PHP 5, PHP 7
159212     **/
159213    function __destruct(){}
159214
159215}
159216class SVM {
159217    /**
159218     * @var integer
159219     **/
159220    const C_SVC = 0;
159221
159222    /**
159223     * @var integer
159224     **/
159225    const EPSILON_SVR = 0;
159226
159227    /**
159228     * @var integer
159229     **/
159230    const KERNEL_LINEAR = 0;
159231
159232    /**
159233     * @var integer
159234     **/
159235    const KERNEL_POLY = 0;
159236
159237    /**
159238     * @var integer
159239     **/
159240    const KERNEL_PRECOMPUTED = 0;
159241
159242    /**
159243     * @var integer
159244     **/
159245    const KERNEL_RBF = 0;
159246
159247    /**
159248     * @var integer
159249     **/
159250    const KERNEL_SIGMOID = 0;
159251
159252    /**
159253     * @var integer
159254     **/
159255    const NU_SVC = 0;
159256
159257    /**
159258     * @var integer
159259     **/
159260    const NU_SVR = 0;
159261
159262    /**
159263     * @var integer
159264     **/
159265    const ONE_CLASS = 0;
159266
159267    /**
159268     * @var integer
159269     **/
159270    const OPT_C = 0;
159271
159272    /**
159273     * @var integer
159274     **/
159275    const OPT_CACHE_SIZE = 0;
159276
159277    /**
159278     * @var integer
159279     **/
159280    const OPT_COEF_ZERO = 0;
159281
159282    /**
159283     * @var integer
159284     **/
159285    const OPT_DEGREE = 0;
159286
159287    /**
159288     * @var integer
159289     **/
159290    const OPT_EPS = 0;
159291
159292    /**
159293     * @var integer
159294     **/
159295    const OPT_GAMMA = 0;
159296
159297    /**
159298     * @var integer
159299     **/
159300    const OPT_KERNEL_TYPE = 0;
159301
159302    /**
159303     * @var integer
159304     **/
159305    const OPT_NU = 0;
159306
159307    /**
159308     * @var integer
159309     **/
159310    const OPT_P = 0;
159311
159312    /**
159313     * Training parameter, boolean, for whether to collect and use
159314     * probability estimates
159315     *
159316     * @var mixed
159317     **/
159318    const OPT_PROBABILITY = 0;
159319
159320    /**
159321     * @var integer
159322     **/
159323    const OPT_PROPABILITY = 0;
159324
159325    /**
159326     * @var integer
159327     **/
159328    const OPT_SHRINKING = 0;
159329
159330    /**
159331     * @var integer
159332     **/
159333    const OPT_TYPE = 0;
159334
159335    /**
159336     * Test training params on subsets of the training data
159337     *
159338     * Crossvalidate can be used to test the effectiveness of the current
159339     * parameter set on a subset of the training data. Given a problem set
159340     * and a n "folds", it separates the problem set into n subsets, and the
159341     * repeatedly trains on one subset and tests on another. While the
159342     * accuracy will generally be lower than a SVM trained on the enter data
159343     * set, the accuracy score returned should be relatively useful, so it
159344     * can be used to test different training parameters.
159345     *
159346     * @param array $problem The problem data. This can either be in the
159347     *   form of an array, the URL of an SVMLight formatted file, or a stream
159348     *   to an opened SVMLight formatted datasource.
159349     * @param int $number_of_folds The number of sets the data should be
159350     *   divided into and cross tested. A higher number means smaller
159351     *   training sets and less reliability. 5 is a good number to start
159352     *   with.
159353     * @return float The correct percentage, expressed as a floating point
159354     *   number from 0-1. In the case of NU_SVC or EPSILON_SVR kernels the
159355     *   mean squared error will returned instead.
159356     * @since PECL svm >= 0.1.0
159357     **/
159358    public function crossvalidate($problem, $number_of_folds){}
159359
159360    /**
159361     * Return the current training parameters
159362     *
159363     * Retrieve an array containing the training parameters. The parameters
159364     * will be keyed on the predefined SVM constants.
159365     *
159366     * @return array Returns an array of configuration settings.
159367     * @since PECL svm >= 0.1.0
159368     **/
159369    public function getOptions(){}
159370
159371    /**
159372     * Set training parameters
159373     *
159374     * Set one or more training parameters.
159375     *
159376     * @param array $params An array of training parameters, keyed on the
159377     *   SVM constants.
159378     * @return bool Return true on success, throws SVMException on error.
159379     * @since PECL svm >= 0.1.0
159380     **/
159381    public function setOptions($params){}
159382
159383    /**
159384     * Create a SVMModel based on training data
159385     *
159386     * Train a support vector machine based on the supplied training data.
159387     *
159388     * @param array $problem The problem can be provided in three different
159389     *   ways. An array, where the data should start with the class label
159390     *   (usually 1 or -1) then followed by a sparse data set of dimension =>
159391     *   data pairs. A URL to a file containing a SVM Light formatted
159392     *   problem, with the each line being a new training example, the start
159393     *   of each line containing the class (1, -1) then a series of tab
159394     *   separated data values shows as key:value. A opened stream pointing
159395     *   to a data source formatted as in the file above.
159396     * @param array $weights Weights are an optional set of weighting
159397     *   parameters for the different classes, to help account for unbalanced
159398     *   training sets. For example, if the classes were 1 and -1, and -1 had
159399     *   significantly more example than one, the weight for -1 could be 0.5.
159400     *   Weights should be in the range 0-1.
159401     * @return SVMModel Returns an SVMModel that can be used to classify
159402     *   previously unseen data. Throws SVMException on error
159403     * @since PECL svm >= 0.1.0
159404     **/
159405    public function train($problem, $weights){}
159406
159407    /**
159408     * Construct a new SVM object
159409     *
159410     * Constructs a new SVM object ready to accept training data.
159411     *
159412     * @since PECL svm >= 0.1.0
159413     **/
159414    public function __construct(){}
159415
159416}
159417/**
159418 * The exception object thrown on errors from the SVM and SVMModel
159419 * classes.
159420 **/
159421class SVMException extends Exception {
159422}
159423/**
159424 * The SVMModel is the end result of the training process. It can be used
159425 * to classify previously unseen data.
159426 **/
159427class SVMModel {
159428    /**
159429     * Returns true if the model has probability information
159430     *
159431     * Returns true if the model contains probability information.
159432     *
159433     * @return bool Return a boolean value
159434     * @since PECL svm >= 0.1.5
159435     **/
159436    public function checkProbabilityModel(){}
159437
159438    /**
159439     * Get the labels the model was trained on
159440     *
159441     * Return an array of labels that the model was trained on. For
159442     * regression and one class models an empty array is returned.
159443     *
159444     * @return array Return an array of labels
159445     * @since PECL svm >= 0.1.5
159446     **/
159447    public function getLabels(){}
159448
159449    /**
159450     * Returns the number of classes the model was trained with
159451     *
159452     * Returns the number of classes the model was trained with, will return
159453     * 2 for one class and regression models.
159454     *
159455     * @return int Return an integer number of classes
159456     * @since PECL svm >= 0.1.5
159457     **/
159458    public function getNrClass(){}
159459
159460    /**
159461     * Get the SVM type the model was trained with
159462     *
159463     * Returns an integer value representing the type of the SVM model used,
159464     * e.g SVM::C_SVC.
159465     *
159466     * @return int Return an integer SVM type
159467     * @since PECL svm >= 0.1.5
159468     **/
159469    public function getSvmType(){}
159470
159471    /**
159472     * Get the sigma value for regression types
159473     *
159474     * For regression models, returns a sigma value. If there is no
159475     * probability information or the model is not SVR, 0 is returned.
159476     *
159477     * @return float Returns a sigma value
159478     * @since PECL svm >= 0.1.5
159479     **/
159480    public function getSvrProbability(){}
159481
159482    /**
159483     * Load a saved SVM Model
159484     *
159485     * Load a model file ready for classification or regression.
159486     *
159487     * @param string $filename The filename of the model.
159488     * @return bool Throws SVMException on error. Returns true on success.
159489     * @since PECL svm >= 0.1.00.1.0
159490     **/
159491    public function load($filename){}
159492
159493    /**
159494     * Predict a value for previously unseen data
159495     *
159496     * This function accepts an array of data and attempts to predict the
159497     * class or regression value based on the model extracted from previously
159498     * trained data.
159499     *
159500     * @param array $data The array to be classified. This should be a
159501     *   series of key => value pairs in increasing key order, but not
159502     *   necessarily continuous.
159503     * @return float Float the predicted value. This will be a class label
159504     *   in the case of classification, a real value in the case of
159505     *   regression. Throws SVMException on error
159506     * @since PECL svm >= 0.1.0
159507     **/
159508    public function predict($data){}
159509
159510    /**
159511     * Return class probabilities for previous unseen data
159512     *
159513     * This function accepts an array of data and attempts to predict the
159514     * class, as with the predict function. Additionally, however, this
159515     * function returns an array of probabilities, one per class in the
159516     * model, which represent the estimated chance of the data supplied being
159517     * a member of that class. Requires that the model to be used has been
159518     * trained with the probability parameter set to true.
159519     *
159520     * @param array $data The array to be classified. This should be a
159521     *   series of key => value pairs in increasing key order, but not
159522     *   necessarily continuous.
159523     * @return float Float the predicted value. This will be a class label
159524     *   in the case of classification, a real value in the case of
159525     *   regression. Throws SVMException on error
159526     * @since PECL svm >= 0.1.4
159527     **/
159528    public function predict_probability($data){}
159529
159530    /**
159531     * Save a model to a file
159532     *
159533     * Save the model data to a file, for later use.
159534     *
159535     * @param string $filename The file to save the model to.
159536     * @return bool Throws SVMException on error. Returns true on success.
159537     * @since PECL svm >= 0.1.0
159538     **/
159539    public function save($filename){}
159540
159541    /**
159542     * Construct a new SVMModel
159543     *
159544     * Build a new SVMModel. Models will usually be created from the
159545     * SVM::train function, but then saved models may be restored directly.
159546     *
159547     * @param string $filename The filename for the saved model file this
159548     *   model should load.
159549     * @since PECL svm >= 0.1.0
159550     **/
159551    public function __construct($filename){}
159552
159553}
159554/**
159555 * SWFAction.
159556 **/
159557class SWFAction {
159558    /**
159559     * Creates a new SWFAction
159560     *
159561     * Creates a new SWFAction and compiles the given {@link script} in it.
159562     *
159563     * @param string $script An ActionScript snippet to associate with the
159564     *   SWFAction. See for more details.
159565     * @since PHP 5 < 5.3.0, PECL ming SVN
159566     **/
159567    function __construct($script){}
159568
159569}
159570/**
159571 * SWFBitmap.
159572 **/
159573class SWFBitmap {
159574    /**
159575     * Returns the bitmap's height
159576     *
159577     * @return float Returns the bitmap height in pixels.
159578     * @since PHP 5 < 5.3.0, PECL ming SVN
159579     **/
159580    function getHeight(){}
159581
159582    /**
159583     * Returns the bitmap's width
159584     *
159585     * @return float Returns the bitmap width in pixels.
159586     * @since PHP 5 < 5.3.0, PECL ming SVN
159587     **/
159588    function getWidth(){}
159589
159590    /**
159591     * Loads Bitmap object
159592     *
159593     * Creates the new SWFBitmap object from the given {@link file}.
159594     *
159595     * @param mixed $file You can't import png images directly, though-
159596     *   have to use the png2dbl utility to make a dbl ("define bits
159597     *   lossless") file from the png. The reason for this is that I don't
159598     *   want a dependency on the png library in ming- autoconf should solve
159599     *   this, but that's not set up yet.
159600     * @param mixed $alphafile An MSK file to be used as an alpha mask for
159601     *   a JPEG image.
159602     * @since PHP 5 < 5.3.0, PECL ming SVN
159603     **/
159604    function __construct($file, $alphafile){}
159605
159606}
159607/**
159608 * SWFButton.
159609 **/
159610class SWFButton {
159611    /**
159612     * Adds an action
159613     *
159614     * Adds the given {@link action} to the button for the given conditions.
159615     *
159616     * @param SWFAction $action An SWFAction, returned by {@link
159617     *   SWFAction::__construct}.
159618     * @param int $flags The following {@link flags} are valid:
159619     *   SWFBUTTON_MOUSEOVER, SWFBUTTON_MOUSEOUT, SWFBUTTON_MOUSEUP,
159620     *   SWFBUTTON_MOUSEUPOUTSIDE, SWFBUTTON_MOUSEDOWN, SWFBUTTON_DRAGOUT and
159621     *   SWFBUTTON_DRAGOVER.
159622     * @return void
159623     * @since PHP 5 < 5.3.0, PECL ming SVN
159624     **/
159625    function addAction($action, $flags){}
159626
159627    /**
159628     * Associates a sound with a button transition
159629     *
159630     * @param SWFSound $sound
159631     * @param int $flags
159632     * @return SWFSoundInstance
159633     * @since PHP 5 < 5.3.0, PECL ming SVN
159634     **/
159635    function addASound($sound, $flags){}
159636
159637    /**
159638     * Adds a shape to a button
159639     *
159640     * Adds the given {@link shape} to the button.
159641     *
159642     * @param SWFShape $shape An SWFShape instance
159643     * @param int $flags The following {@link flags} are valid:
159644     *   SWFBUTTON_UP, SWFBUTTON_OVER, SWFBUTTON_DOWN and SWFBUTTON_HIT.
159645     *   SWFBUTTON_HIT isn't ever displayed, it defines the hit region for
159646     *   the button. That is, everywhere the hit shape would be drawn is
159647     *   considered a "touchable" part of the button.
159648     * @return void
159649     * @since PHP 5 < 5.3.0, PECL ming SVN
159650     **/
159651    function addShape($shape, $flags){}
159652
159653    /**
159654     * Sets the action
159655     *
159656     * Sets the action to be performed when the button is clicked.
159657     *
159658     * This is a shortcut for {@link SWFButton::addAction} called with the
159659     * SWFBUTTON_MOUSEUP flag.
159660     *
159661     * @param SWFAction $action An SWFAction, returned by {@link
159662     *   SWFAction::__construct}.
159663     * @return void
159664     * @since PHP 5 < 5.3.0, PECL ming SVN
159665     **/
159666    function setAction($action){}
159667
159668    /**
159669     * Alias for addShape(shape, SWFBUTTON_DOWN)
159670     *
159671     * {@link swfbutton::setdown} alias for addShape(shape, SWFBUTTON_DOWN).
159672     *
159673     * @param SWFShape $shape
159674     * @return void
159675     * @since PHP 5 < 5.3.0, PECL ming SVN
159676     **/
159677    function setDown($shape){}
159678
159679    /**
159680     * Alias for addShape(shape, SWFBUTTON_HIT)
159681     *
159682     * {@link swfbutton::sethit} alias for addShape(shape, SWFBUTTON_HIT).
159683     *
159684     * @param SWFShape $shape
159685     * @return void
159686     * @since PHP 5 < 5.3.0, PECL ming SVN
159687     **/
159688    function setHit($shape){}
159689
159690    /**
159691     * Enable track as menu button behaviour
159692     *
159693     * @param int $flag This parameter can be used for a slight different
159694     *   behavior of buttons. You can set it to 0 (off) or 1 (on).
159695     * @return void
159696     * @since PHP 5 < 5.3.0, PECL ming SVN
159697     **/
159698    function setMenu($flag){}
159699
159700    /**
159701     * Alias for addShape(shape, SWFBUTTON_OVER)
159702     *
159703     * {@link swfbutton::setover} alias for addShape(shape, SWFBUTTON_OVER).
159704     *
159705     * @param SWFShape $shape
159706     * @return void
159707     * @since PHP 5 < 5.3.0, PECL ming SVN
159708     **/
159709    function setOver($shape){}
159710
159711    /**
159712     * Alias for addShape(shape, SWFBUTTON_UP)
159713     *
159714     * {@link swfbutton::setup} alias for addShape(shape, SWFBUTTON_UP).
159715     *
159716     * @param SWFShape $shape
159717     * @return void
159718     * @since PHP 5 < 5.3.0, PECL ming SVN
159719     **/
159720    function setUp($shape){}
159721
159722    /**
159723     * Creates a new Button
159724     *
159725     * @since PHP 5 < 5.3.0, PECL ming SVN
159726     **/
159727    function __construct(){}
159728
159729}
159730/**
159731 * SWFDisplayItem.
159732 **/
159733class SWFDisplayItem {
159734    /**
159735     * Adds this SWFAction to the given SWFSprite instance
159736     *
159737     * @param SWFAction $action An SWFAction, returned by {@link
159738     *   SWFAction::__construct}.
159739     * @param int $flags
159740     * @return void
159741     * @since PHP 5 < 5.3.0, PECL ming SVN
159742     **/
159743    function addAction($action, $flags){}
159744
159745    /**
159746     * Adds the given color to this item's color transform
159747     *
159748     * {@link swfdisplayitem::addcolor} adds the color to this item's color
159749     * transform. The color is given in its RGB form.
159750     *
159751     * @param int $red
159752     * @param int $green
159753     * @param int $blue
159754     * @param int $a
159755     * @return void
159756     * @since PHP 5 < 5.3.0, PECL ming SVN
159757     **/
159758    function addColor($red, $green, $blue, $a){}
159759
159760    /**
159761     * Another way of defining a MASK layer
159762     *
159763     * @return void
159764     * @since PHP 5 < 5.3.0, PECL ming SVN
159765     **/
159766    function endMask(){}
159767
159768    /**
159769     * @return float
159770     * @since PHP 5 < 5.3.0, PECL ming SVN
159771     **/
159772    function getRot(){}
159773
159774    /**
159775     * @return float
159776     * @since PHP 5 < 5.3.0, PECL ming SVN
159777     **/
159778    function getX(){}
159779
159780    /**
159781     * @return float
159782     * @since PHP 5 < 5.3.0, PECL ming SVN
159783     **/
159784    function getXScale(){}
159785
159786    /**
159787     * @return float
159788     * @since PHP 5 < 5.3.0, PECL ming SVN
159789     **/
159790    function getXSkew(){}
159791
159792    /**
159793     * @return float
159794     * @since PHP 5 < 5.3.0, PECL ming SVN
159795     **/
159796    function getY(){}
159797
159798    /**
159799     * @return float
159800     * @since PHP 5 < 5.3.0, PECL ming SVN
159801     **/
159802    function getYScale(){}
159803
159804    /**
159805     * @return float
159806     * @since PHP 5 < 5.3.0, PECL ming SVN
159807     **/
159808    function getYSkew(){}
159809
159810    /**
159811     * Moves object in relative coordinates
159812     *
159813     * {@link swfdisplayitem::move} moves the current object by ({@link
159814     * dx},{@link dy}) from its current position.
159815     *
159816     * @param float $dx
159817     * @param float $dy
159818     * @return void
159819     * @since PHP 5 < 5.3.0, PECL ming SVN
159820     **/
159821    function move($dx, $dy){}
159822
159823    /**
159824     * Moves object in global coordinates
159825     *
159826     * {@link swfdisplayitem::moveto} moves the current object to ({@link
159827     * x},{@link y}) in global coordinates.
159828     *
159829     * @param float $x
159830     * @param float $y
159831     * @return void
159832     * @since PHP 5 < 5.3.0, PECL ming SVN
159833     **/
159834    function moveTo($x, $y){}
159835
159836    /**
159837     * Multiplies the item's color transform
159838     *
159839     * {@link swfdisplayitem::multcolor} multiplies the item's color
159840     * transform by the given values.
159841     *
159842     * @param float $red Value of red component
159843     * @param float $green Value of green component
159844     * @param float $blue Value of blue component
159845     * @param float $a Value of alpha component
159846     * @return void
159847     * @since PHP 5 < 5.3.0, PECL ming SVN
159848     **/
159849    function multColor($red, $green, $blue, $a){}
159850
159851    /**
159852     * Removes the object from the movie
159853     *
159854     * {@link swfdisplayitem::remove} removes this object from the movie's
159855     * display list.
159856     *
159857     * @return void
159858     * @since PHP 5 < 5.3.0, PECL ming SVN
159859     **/
159860    function remove(){}
159861
159862    /**
159863     * Rotates in relative coordinates
159864     *
159865     * {@link swfdisplayitem::rotate} rotates the current object by {@link
159866     * angle} degrees from its current rotation.
159867     *
159868     * @param float $angle
159869     * @return void
159870     * @since PHP 5 < 5.3.0, PECL ming SVN
159871     **/
159872    function rotate($angle){}
159873
159874    /**
159875     * Rotates the object in global coordinates
159876     *
159877     * {@link swfdisplayitem::rotateto} set the current object rotation to
159878     * {@link angle} degrees in global coordinates.
159879     *
159880     * @param float $angle
159881     * @return void
159882     * @since PHP 5 < 5.3.0, PECL ming SVN
159883     **/
159884    function rotateTo($angle){}
159885
159886    /**
159887     * Scales the object in relative coordinates
159888     *
159889     * {@link swfdisplayitem::scale} scales the current object by ({@link
159890     * dx},{@link dy}) from its current size.
159891     *
159892     * @param float $dx
159893     * @param float $dy
159894     * @return void
159895     * @since PHP 5 < 5.3.0, PECL ming SVN
159896     **/
159897    function scale($dx, $dy){}
159898
159899    /**
159900     * Scales the object in global coordinates
159901     *
159902     * {@link swfdisplayitem::scaleto} scales the current object to ({@link
159903     * x},{@link y}) in global coordinates.
159904     *
159905     * @param float $x
159906     * @param float $y
159907     * @return void
159908     * @since PHP 5 < 5.3.0, PECL ming SVN
159909     **/
159910    function scaleTo($x, $y){}
159911
159912    /**
159913     * Sets z-order
159914     *
159915     * {@link swfdisplayitem::setdepth} sets the object's z-order to {@link
159916     * depth}. Depth defaults to the order in which instances are created (by
159917     * adding a shape/text to a movie)- newer ones are on top of older ones.
159918     * If two objects are given the same depth, only the later-defined one
159919     * can be moved.
159920     *
159921     * @param int $depth
159922     * @return void
159923     * @since PHP 5 < 5.3.0, PECL ming SVN
159924     **/
159925    function setDepth($depth){}
159926
159927    /**
159928     * Defines a MASK layer at level
159929     *
159930     * @param int $level
159931     * @return void
159932     * @since PHP 5 < 5.3.0, PECL ming SVN
159933     **/
159934    function setMaskLevel($level){}
159935
159936    /**
159937     * Sets the item's transform matrix
159938     *
159939     * @param float $a
159940     * @param float $b
159941     * @param float $c
159942     * @param float $d
159943     * @param float $x
159944     * @param float $y
159945     * @return void
159946     * @since PHP 5 < 5.3.0, PECL ming SVN
159947     **/
159948    function setMatrix($a, $b, $c, $d, $x, $y){}
159949
159950    /**
159951     * Sets the object's name
159952     *
159953     * {@link swfdisplayitem::setname} sets the object's name to {@link
159954     * name}, for targetting with action script. Only useful on sprites.
159955     *
159956     * @param string $name
159957     * @return void
159958     * @since PHP 5 < 5.3.0, PECL ming SVN
159959     **/
159960    function setName($name){}
159961
159962    /**
159963     * Sets the object's ratio
159964     *
159965     * {@link swfdisplayitem::setratio} sets the object's ratio to {@link
159966     * ratio}. Obviously only useful for morphs.
159967     *
159968     * @param float $ratio
159969     * @return void
159970     * @since PHP 5 < 5.3.0, PECL ming SVN
159971     **/
159972    function setRatio($ratio){}
159973
159974    /**
159975     * Sets the X-skew
159976     *
159977     * {@link swfdisplayitem::skewx} adds {@link ddegrees} to current x-skew.
159978     *
159979     * @param float $ddegrees
159980     * @return void
159981     * @since PHP 5 < 5.3.0, PECL ming SVN
159982     **/
159983    function skewX($ddegrees){}
159984
159985    /**
159986     * Sets the X-skew
159987     *
159988     * {@link swfdisplayitem::skewxto} sets the x-skew to {@link degrees}.
159989     * For {@link degrees} is 1.0, it means a 45-degree forward slant. More
159990     * is more forward, less is more backward.
159991     *
159992     * @param float $degrees
159993     * @return void
159994     * @since PHP 5 < 5.3.0, PECL ming SVN
159995     **/
159996    function skewXTo($degrees){}
159997
159998    /**
159999     * Sets the Y-skew
160000     *
160001     * {@link swfdisplayitem::skewy} adds {@link ddegrees} to current y-skew.
160002     *
160003     * @param float $ddegrees
160004     * @return void
160005     * @since PHP 5 < 5.3.0, PECL ming SVN
160006     **/
160007    function skewY($ddegrees){}
160008
160009    /**
160010     * Sets the Y-skew
160011     *
160012     * {@link swfdisplayitem::skewyto} sets the y-skew to {@link degrees}.
160013     * For {@link degrees} is 1.0, it means a 45-degree forward slant. More
160014     * is more upward, less is more downward.
160015     *
160016     * @param float $degrees
160017     * @return void
160018     * @since PHP 5 < 5.3.0, PECL ming SVN
160019     **/
160020    function skewYTo($degrees){}
160021
160022}
160023/**
160024 * The SWFFill object allows you to transform (scale, skew, rotate)
160025 * bitmap and gradient fills. swffill objects are created by the {@link
160026 * SWFShape::addFill} method.
160027 **/
160028class SWFFill {
160029    /**
160030     * Moves fill origin
160031     *
160032     * Moves the fill origin to the given global coordinates.
160033     *
160034     * @param float $x X-coordinate
160035     * @param float $y Y-coordinate
160036     * @return void
160037     * @since PHP 5 < 5.3.0, PECL ming SVN
160038     **/
160039    function moveTo($x, $y){}
160040
160041    /**
160042     * Sets fill's rotation
160043     *
160044     * Sets the fill rotation to the given {@link angle}.
160045     *
160046     * @param float $angle The rotation angle, in degrees.
160047     * @return void
160048     * @since PHP 5 < 5.3.0, PECL ming SVN
160049     **/
160050    function rotateTo($angle){}
160051
160052    /**
160053     * Sets fill's scale
160054     *
160055     * Sets the fill scale to the given coordinates.
160056     *
160057     * @param float $x X-coordinate
160058     * @param float $y Y-coordinate
160059     * @return void
160060     * @since PHP 5 < 5.3.0, PECL ming SVN
160061     **/
160062    function scaleTo($x, $y){}
160063
160064    /**
160065     * Sets fill x-skew
160066     *
160067     * Sets the fill x-skew to {@link x}.
160068     *
160069     * @param float $x When {@link x} is 1.0, it is a 45-degree forward
160070     *   slant. More is more forward, less is more backward.
160071     * @return void
160072     * @since PHP 5 < 5.3.0, PECL ming SVN
160073     **/
160074    function skewXTo($x){}
160075
160076    /**
160077     * Sets fill y-skew
160078     *
160079     * Sets the fill y-skew to {@link y}.
160080     *
160081     * @param float $y When {@link y} is 1.0, it is a 45-degree upward
160082     *   slant. More is more upward, less is more downward.
160083     * @return void
160084     * @since PHP 5 < 5.3.0, PECL ming SVN
160085     **/
160086    function skewYTo($y){}
160087
160088}
160089/**
160090 * The SWFFont object represent a reference to the font definition, for
160091 * us with {@link SWFText::setFont} and {@link SWFTextField::setFont}.
160092 **/
160093class SWFFont {
160094    /**
160095     * Returns the ascent of the font, or 0 if not available
160096     *
160097     * @return float
160098     * @since PHP 5 < 5.3.0, PECL ming SVN
160099     **/
160100    function getAscent(){}
160101
160102    /**
160103     * Returns the descent of the font, or 0 if not available
160104     *
160105     * @return float
160106     * @since PHP 5 < 5.3.0, PECL ming SVN
160107     **/
160108    function getDescent(){}
160109
160110    /**
160111     * Returns the leading of the font, or 0 if not available
160112     *
160113     * @return float
160114     * @since PHP 5 < 5.3.0, PECL ming SVN
160115     **/
160116    function getLeading(){}
160117
160118    /**
160119     * Returns the glyph shape of a char as a text string
160120     *
160121     * @param int $code
160122     * @return string
160123     * @since PHP 5 < 5.3.0, PECL ming SVN
160124     **/
160125    function getShape($code){}
160126
160127    /**
160128     * Calculates the width of the given string in this font at full height
160129     *
160130     * @param string $string
160131     * @return float
160132     * @since PHP 5 < 5.3.0, PECL ming SVN
160133     **/
160134    function getUTF8Width($string){}
160135
160136    /**
160137     * Returns the string's width
160138     *
160139     * {@link swffont::getwidth} returns the string {@link string}'s width,
160140     * using font's default scaling. You'll probably want to use the {@link
160141     * swftext} version of this method which uses the text object's scale.
160142     *
160143     * @param string $string
160144     * @return float
160145     * @since PHP 5 < 5.3.0, PECL ming SVN
160146     **/
160147    function getWidth($string){}
160148
160149    /**
160150     * Loads a font definition
160151     *
160152     * If {@link filename} is the name of an FDB file (i.e., it ends in
160153     * ".fdb"), load the font definition found in said file. Otherwise,
160154     * create a browser-defined font reference.
160155     *
160156     * FDB ("font definition block") is a very simple wrapper for the SWF
160157     * DefineFont2 block which contains a full description of a font. One may
160158     * create FDB files from SWT Generator template files with the included
160159     * makefdb utility- look in the util directory off the main ming
160160     * distribution directory.
160161     *
160162     * Browser-defined fonts don't contain any information about the font
160163     * other than its name. It is assumed that the font definition will be
160164     * provided by the movie player. The fonts _serif, _sans, and _typewriter
160165     * should always be available. For example:
160166     *
160167     * <?php $f = newSWFFont("_sans"); ?>
160168     *
160169     * will give you the standard sans-serif font, probably the same as what
160170     * you'd get with <font name="sans-serif"> in HTML.
160171     *
160172     * @param string $filename
160173     * @since PHP 5 < 5.3.0, PECL ming SVN
160174     **/
160175    function __construct($filename){}
160176
160177}
160178/**
160179 * SWFFontChar.
160180 **/
160181class SWFFontChar {
160182    /**
160183     * Adds characters to a font for exporting font
160184     *
160185     * @param string $char
160186     * @return void
160187     * @since PHP 5 < 5.3.0, PECL ming SVN
160188     **/
160189    function addChars($char){}
160190
160191    /**
160192     * Adds characters to a font for exporting font
160193     *
160194     * @param string $char
160195     * @return void
160196     * @since PHP 5 < 5.3.0, PECL ming SVN
160197     **/
160198    function addUTF8Chars($char){}
160199
160200}
160201/**
160202 * SWFGradient.
160203 **/
160204class SWFGradient {
160205    /**
160206     * Adds an entry to the gradient list
160207     *
160208     * {@link swfgradient::addentry} adds an entry to the gradient list.
160209     * {@link ratio} is a number between 0 and 1 indicating where in the
160210     * gradient this color appears. Thou shalt add entries in order of
160211     * increasing ratio.
160212     *
160213     * {@link red}, {@link green}, {@link blue} is a color (RGB mode).
160214     *
160215     * @param float $ratio
160216     * @param int $red
160217     * @param int $green
160218     * @param int $blue
160219     * @param int $alpha
160220     * @return void
160221     * @since PHP 5 < 5.3.0, PECL ming SVN
160222     **/
160223    function addEntry($ratio, $red, $green, $blue, $alpha){}
160224
160225    /**
160226     * Creates a gradient object
160227     *
160228     * {@link swfgradient} creates a new SWFGradient object.
160229     *
160230     * This simple example will draw a big black-to-white gradient as
160231     * background, and a reddish disc in its center. {@link swfgradient}
160232     * example
160233     *
160234     * <?php
160235     *
160236     * $m = new SWFMovie(); $m->setDimension(320, 240);
160237     *
160238     * $s = new SWFShape();
160239     *
160240     * // first gradient- black to white $g = new SWFGradient();
160241     * $g->addEntry(0.0, 0, 0, 0); $g->addEntry(1.0, 0xff, 0xff, 0xff);
160242     *
160243     * $f = $s->addFill($g, SWFFILL_LINEAR_GRADIENT); $f->scaleTo(0.01);
160244     * $f->moveTo(160, 120); $s->setRightFill($f); $s->drawLine(320, 0);
160245     * $s->drawLine(0, 240); $s->drawLine(-320, 0); $s->drawLine(0, -240);
160246     *
160247     * $m->add($s);
160248     *
160249     * $s = new SWFShape();
160250     *
160251     * // second gradient- radial gradient from red to transparent $g = new
160252     * SWFGradient(); $g->addEntry(0.0, 0xff, 0, 0, 0xff); $g->addEntry(1.0,
160253     * 0xff, 0, 0, 0);
160254     *
160255     * $f = $s->addFill($g, SWFFILL_RADIAL_GRADIENT); $f->scaleTo(0.005);
160256     * $f->moveTo(160, 120); $s->setRightFill($f); $s->drawLine(320, 0);
160257     * $s->drawLine(0, 240); $s->drawLine(-320, 0); $s->drawLine(0, -240);
160258     *
160259     * $m->add($s);
160260     *
160261     * header('Content-type: application/x-shockwave-flash'); $m->output();
160262     * ?>
160263     *
160264     * @since PHP 5 < 5.3.0, PECL ming SVN
160265     **/
160266    function __construct(){}
160267
160268}
160269/**
160270 * The methods here are sort of weird. It would make more sense to just
160271 * have newSWFMorph(shape1, shape2);, but as things are now, shape2 needs
160272 * to know that it's the second part of a morph. (This, because it starts
160273 * writing its output as soon as it gets drawing commands- if it kept its
160274 * own description of its shapes and wrote on completion this and some
160275 * other things would be much easier.)
160276 **/
160277class SWFMorph {
160278    /**
160279     * Gets a handle to the starting shape
160280     *
160281     * Gets the morph's starting shape.
160282     *
160283     * @return SWFShape Returns a object.
160284     * @since PHP 5 < 5.3.0, PECL ming SVN
160285     **/
160286    function getShape1(){}
160287
160288    /**
160289     * Gets a handle to the ending shape
160290     *
160291     * Gets the morph's ending shape.
160292     *
160293     * @return SWFShape Returns a object.
160294     * @since PHP 5 < 5.3.0, PECL ming SVN
160295     **/
160296    function getShape2(){}
160297
160298    /**
160299     * Creates a new SWFMorph object
160300     *
160301     * Creates a new SWFMorph object.
160302     *
160303     * Also called a "shape tween". This thing lets you make those tacky
160304     * twisting things that make your computer choke. Oh, joy!
160305     *
160306     * @since PHP 5 < 5.3.0, PECL ming SVN
160307     **/
160308    function __construct(){}
160309
160310}
160311/**
160312 * SWFMovie is a movie object representing an SWF movie.
160313 **/
160314class SWFMovie {
160315    /**
160316     * Adds any type of data to a movie
160317     *
160318     * Adds an SWF object {@link instance} to the current movie.
160319     *
160320     * @param object $instance Any type of object instance, like , , .
160321     * @return mixed For displayable types (shape, text, button, sprite),
160322     *   this returns an , a handle to the object in a display list. Thus,
160323     *   you can add the same shape to a movie multiple times and get
160324     *   separate handles back for each separate instance.
160325     * @since PHP 5 < 5.3.0, PECL ming SVN
160326     **/
160327    function add($instance){}
160328
160329    /**
160330     * @param SWFCharacter $char
160331     * @param string $name
160332     * @return void
160333     * @since PHP 5 < 5.3.0, PECL ming SVN
160334     **/
160335    function addExport($char, $name){}
160336
160337    /**
160338     * @param SWFFont $font
160339     * @return mixed
160340     * @since PHP 5 < 5.3.0, PECL ming SVN
160341     **/
160342    function addFont($font){}
160343
160344    /**
160345     * @param string $libswf
160346     * @param string $name
160347     * @return SWFSprite
160348     * @since PHP 5 < 5.3.0, PECL ming SVN
160349     **/
160350    function importChar($libswf, $name){}
160351
160352    /**
160353     * @param string $libswf
160354     * @param string $name
160355     * @return SWFFontChar
160356     * @since PHP 5 < 5.3.0, PECL ming SVN
160357     **/
160358    function importFont($libswf, $name){}
160359
160360    /**
160361     * Labels a frame
160362     *
160363     * @param string $label
160364     * @return void
160365     * @since PHP 5 < 5.3.0, PECL ming SVN
160366     **/
160367    function labelFrame($label){}
160368
160369    /**
160370     * Moves to the next frame of the animation
160371     *
160372     * @return void
160373     * @since PHP 5 < 5.3.0, PECL ming SVN
160374     **/
160375    function nextFrame(){}
160376
160377    /**
160378     * Dumps your lovingly prepared movie out
160379     *
160380     * Dumps the SWFMovie.
160381     *
160382     * Don't forget to send the Content-Type HTTP header file before using
160383     * this function, in order to display the movie in a browser.
160384     *
160385     * @param int $compression The compression level can be a value between
160386     *   0 and 9, defining the SWF compression similar to gzip compression.
160387     *   This parameter is only available as of Flash MX (6).
160388     * @return int Return the number of bytes written or FALSE on error.
160389     * @since PHP 5 < 5.3.0, PECL ming SVN
160390     **/
160391    function output($compression){}
160392
160393    /**
160394     * Removes the object instance from the display list
160395     *
160396     * Removes the given object {@link instance} from the display list.
160397     *
160398     * @param object $instance
160399     * @return void
160400     * @since PHP 5.2.1-5.3.0, PECL ming SVN
160401     **/
160402    function remove($instance){}
160403
160404    /**
160405     * Saves the SWF movie in a file
160406     *
160407     * Saves the SWF movie to the specified {@link filename}.
160408     *
160409     * @param string $filename The path to the saved SWF document.
160410     * @param int $compression The compression level can be a value between
160411     *   0 and 9, defining the SWF compression similar to gzip compression.
160412     *   This parameter is only available as of Flash MX (6).
160413     * @return int Return the number of bytes written or FALSE on error.
160414     * @since PHP 5 < 5.3.0, PECL ming SVN
160415     **/
160416    function save($filename, $compression){}
160417
160418    /**
160419     * @param resource $x
160420     * @param int $compression The compression level can be a value between
160421     *   0 and 9, defining the SWF compression similar to gzip compression.
160422     *   This parameter is only available as of Flash MX (6).
160423     * @return int Return the number of bytes written or FALSE on error.
160424     * @since PHP 5 < 5.3.0, PECL ming SVN
160425     **/
160426    function saveToFile($x, $compression){}
160427
160428    /**
160429     * Sets the background color
160430     *
160431     * Why is there no rgba version? Think about it, you might want to let
160432     * the HTML background show through. There's a way to do that, but it
160433     * only works on IE4. Search the site for details.
160434     *
160435     * @param int $red Value of red component
160436     * @param int $green Value of green component
160437     * @param int $blue Value of blue component
160438     * @return void
160439     * @since PHP 5 < 5.3.0, PECL ming SVN
160440     **/
160441    function setbackground($red, $green, $blue){}
160442
160443    /**
160444     * Sets the movie's width and height
160445     *
160446     * Sets the movie's dimension to the specified {@link width} and {@link
160447     * height}.
160448     *
160449     * @param float $width The movie width.
160450     * @param float $height The movie height.
160451     * @return void
160452     * @since PHP 5 < 5.3.0, PECL ming SVN
160453     **/
160454    function setDimension($width, $height){}
160455
160456    /**
160457     * Sets the total number of frames in the animation
160458     *
160459     * Sets the total number of frames in the animation to the given {@link
160460     * number}.
160461     *
160462     * @param int $number The number of frames.
160463     * @return void
160464     * @since PHP 5 < 5.3.0, PECL ming SVN
160465     **/
160466    function setFrames($number){}
160467
160468    /**
160469     * Sets the animation's frame rate
160470     *
160471     * Sets the frame rate to the specified {@link rate}.
160472     *
160473     * Animation will slow down if the player can't render frames fast
160474     * enough- unless there's a streaming sound, in which case display frames
160475     * are sacrificed to keep sound from skipping.
160476     *
160477     * @param float $rate The frame rate, in frame per seconds.
160478     * @return void
160479     * @since PHP 5 < 5.3.0, PECL ming SVN
160480     **/
160481    function setRate($rate){}
160482
160483    /**
160484     * @param SWFSound $sound
160485     * @return SWFSoundInstance
160486     * @since PHP 5 < 5.3.0, PECL ming SVN
160487     **/
160488    function startSound($sound){}
160489
160490    /**
160491     * @param SWFSound $sound
160492     * @return void
160493     * @since PHP 5 < 5.3.0, PECL ming SVN
160494     **/
160495    function stopSound($sound){}
160496
160497    /**
160498     * Streams a MP3 file
160499     *
160500     * Streams the given MP3 file {@link mp3file}.
160501     *
160502     * This method is not very robust in dealing with oddities (can skip over
160503     * an initial ID3 tag, but that's about it).
160504     *
160505     * Note that the movie isn't smart enough to put enough frames in to
160506     * contain the entire mp3 stream- you'll have to add (length of song *
160507     * frames per second) frames to get the entire stream in.
160508     *
160509     * @param mixed $mp3file Can be a file pointer returned by {@link
160510     *   fopen} or the MP3 data, as a binary string.
160511     * @param float $skip Number of seconds to skip.
160512     * @return int Return number of frames.
160513     * @since PHP 5 < 5.3.0, PECL ming SVN
160514     **/
160515    function streamMP3($mp3file, $skip){}
160516
160517    /**
160518     * @return void
160519     * @since PHP 5 < 5.3.0, PECL ming SVN
160520     **/
160521    function writeExports(){}
160522
160523    /**
160524     * Creates a new movie object, representing an SWF version 4 movie
160525     *
160526     * Creates a new movie object, representing an SWF movie.
160527     *
160528     * @param int $version The desired SWF version. Default is 4.
160529     * @since PHP 5 < 5.3.0, PECL ming SVN
160530     **/
160531    function __construct($version){}
160532
160533}
160534/**
160535 * SWFPrebuiltClip.
160536 **/
160537class SWFPrebuiltClip {
160538    /**
160539     * Returns a SWFPrebuiltClip object
160540     *
160541     * @param mixed $file
160542     * @since PHP 5.0.5-5.3.0, PECL ming SVN
160543     **/
160544    function __construct($file){}
160545
160546}
160547/**
160548 * SWFShape.
160549 **/
160550class SWFShape {
160551    /**
160552     * Adds a solid fill to the shape
160553     *
160554     * {@link SWFShape::addFill} adds a solid fill to the shape's list of
160555     * fill styles. {@link SWFShape::addFill} accepts three different types
160556     * of arguments.
160557     *
160558     * {@link red}, {@link green}, {@link blue} is a color (RGB mode).
160559     *
160560     * The {@link bitmap} argument is an {@link SWFBitmap} object. The {@link
160561     * flags} argument can be one of the following values:
160562     * SWFFILL_CLIPPED_BITMAP, SWFFILL_TILED_BITMAP, SWFFILL_LINEAR_GRADIENT
160563     * or SWFFILL_RADIAL_GRADIENT. Default is SWFFILL_TILED_BITMAP for
160564     * SWFBitmap and SWFFILL_LINEAR_GRADIENT for SWFGradient.
160565     *
160566     * The {@link gradient} argument is an {@link SWFGradient} object. The
160567     * flags argument can be one of the following values :
160568     * SWFFILL_RADIAL_GRADIENT or SWFFILL_LINEAR_GRADIENT. Default is
160569     * SWFFILL_LINEAR_GRADIENT. I'm sure about this one. Really.
160570     *
160571     * {@link SWFShape::addFill} returns an {@link SWFFill} object for use
160572     * with the {@link SWFShape::setLeftFill} and {@link
160573     * SWFShape::setRightFill} functions described below.
160574     *
160575     * @param int $red
160576     * @param int $green
160577     * @param int $blue
160578     * @param int $alpha
160579     * @return SWFFill
160580     * @since PHP 5 < 5.3.0, PECL ming SVN
160581     **/
160582    function addFill($red, $green, $blue, $alpha){}
160583
160584    /**
160585     * Draws an arc of radius r centered at the current location, from angle
160586     * startAngle to angle endAngle measured clockwise from 12 o'clock
160587     *
160588     * @param float $r
160589     * @param float $startAngle
160590     * @param float $endAngle
160591     * @return void
160592     * @since PHP 5 < 5.3.0, PECL ming SVN
160593     **/
160594    function drawArc($r, $startAngle, $endAngle){}
160595
160596    /**
160597     * Draws a circle of radius r centered at the current location, in a
160598     * counter-clockwise fashion
160599     *
160600     * @param float $r
160601     * @return void
160602     * @since PHP 5 < 5.3.0, PECL ming SVN
160603     **/
160604    function drawCircle($r){}
160605
160606    /**
160607     * Draws a cubic bezier curve using the current position and the three
160608     * given points as control points
160609     *
160610     * @param float $bx
160611     * @param float $by
160612     * @param float $cx
160613     * @param float $cy
160614     * @param float $dx
160615     * @param float $dy
160616     * @return int
160617     * @since PHP 5 < 5.3.0, PECL ming SVN
160618     **/
160619    function drawCubic($bx, $by, $cx, $cy, $dx, $dy){}
160620
160621    /**
160622     * Draws a cubic bezier curve using the current position and the three
160623     * given points as control points
160624     *
160625     * @param float $bx
160626     * @param float $by
160627     * @param float $cx
160628     * @param float $cy
160629     * @param float $dx
160630     * @param float $dy
160631     * @return int
160632     * @since PHP 5 < 5.3.0, PECL ming SVN
160633     **/
160634    function drawCubicTo($bx, $by, $cx, $cy, $dx, $dy){}
160635
160636    /**
160637     * Draws a curve (relative)
160638     *
160639     * @param float $controldx
160640     * @param float $controldy
160641     * @param float $anchordx
160642     * @param float $anchordy
160643     * @param float $targetdx
160644     * @param float $targetdy
160645     * @return int
160646     * @since PHP 5 < 5.3.0, PECL ming SVN
160647     **/
160648    function drawCurve($controldx, $controldy, $anchordx, $anchordy, $targetdx, $targetdy){}
160649
160650    /**
160651     * Draws a curve
160652     *
160653     * @param float $controlx
160654     * @param float $controly
160655     * @param float $anchorx
160656     * @param float $anchory
160657     * @param float $targetx
160658     * @param float $targety
160659     * @return int
160660     * @since PHP 5 < 5.3.0, PECL ming SVN
160661     **/
160662    function drawCurveTo($controlx, $controly, $anchorx, $anchory, $targetx, $targety){}
160663
160664    /**
160665     * Draws the first character in the given string into the shape using the
160666     * glyph definition from the given font
160667     *
160668     * @param SWFFont $font
160669     * @param string $character
160670     * @param int $size
160671     * @return void
160672     * @since PHP 5 < 5.3.0, PECL ming SVN
160673     **/
160674    function drawGlyph($font, $character, $size){}
160675
160676    /**
160677     * Draws a line (relative)
160678     *
160679     * @param float $dx
160680     * @param float $dy
160681     * @return void
160682     * @since PHP 5 < 5.3.0, PECL ming SVN
160683     **/
160684    function drawLine($dx, $dy){}
160685
160686    /**
160687     * Draws a line
160688     *
160689     * @param float $x
160690     * @param float $y
160691     * @return void
160692     * @since PHP 5 < 5.3.0, PECL ming SVN
160693     **/
160694    function drawLineTo($x, $y){}
160695
160696    /**
160697     * Moves the shape's pen (relative)
160698     *
160699     * @param float $dx
160700     * @param float $dy
160701     * @return void
160702     * @since PHP 5 < 5.3.0, PECL ming SVN
160703     **/
160704    function movePen($dx, $dy){}
160705
160706    /**
160707     * Moves the shape's pen
160708     *
160709     * @param float $x
160710     * @param float $y
160711     * @return void
160712     * @since PHP 5 < 5.3.0, PECL ming SVN
160713     **/
160714    function movePenTo($x, $y){}
160715
160716    /**
160717     * Sets left rasterizing color
160718     *
160719     * What this nonsense is about is, every edge segment borders at most two
160720     * fills. When rasterizing the object, it's pretty handy to know what
160721     * those fills are ahead of time, so the swf format requires these to be
160722     * specified.
160723     *
160724     * {@link swfshape::setleftfill} sets the fill on the left side of the
160725     * edge- that is, on the interior if you're defining the outline of the
160726     * shape in a counter-clockwise fashion. The fill object is an SWFFill
160727     * object returned from one of the addFill functions above.
160728     *
160729     * This seems to be reversed when you're defining a shape in a morph,
160730     * though. If your browser crashes, just try setting the fill on the
160731     * other side.
160732     *
160733     * @param SWFGradient $fill
160734     * @return void
160735     * @since PHP 5 < 5.3.0, PECL ming SVN
160736     **/
160737    function setLeftFill($fill){}
160738
160739    /**
160740     * Sets the shape's line style
160741     *
160742     * {@link swfshape::setline} sets the shape's line style. {@link width}
160743     * is the line's width. If {@link width} is 0, the line's style is
160744     * removed (then, all other arguments are ignored). If {@link width} > 0,
160745     * then line's color is set to {@link red}, {@link green}, {@link blue}.
160746     * Last parameter {@link a} is optional.
160747     *
160748     * You must declare all line styles before you use them (see example).
160749     *
160750     * @param SWFShape $shape
160751     * @return void
160752     * @since PHP 5 < 5.3.0, PECL ming SVN
160753     **/
160754    function setLine($shape){}
160755
160756    /**
160757     * Sets right rasterizing color
160758     *
160759     * @param SWFGradient $fill
160760     * @return void
160761     * @since PHP 5 < 5.3.0, PECL ming SVN
160762     **/
160763    function setRightFill($fill){}
160764
160765    /**
160766     * Creates a new shape object
160767     *
160768     * Created a new SWFShape object.
160769     *
160770     * @since PHP 5 < 5.3.0, PECL ming SVN
160771     **/
160772    function __construct(){}
160773
160774}
160775/**
160776 * SWFSound.
160777 **/
160778class SWFSound {
160779    /**
160780     * Returns a new SWFSound object from given file
160781     *
160782     * @param string $filename
160783     * @param int $flags
160784     * @since PHP 5 < 5.3.0, PECL ming SVN
160785     **/
160786    function __construct($filename, $flags){}
160787
160788}
160789/**
160790 * SWFSoundInstance objects are returned by the {@link
160791 * SWFSprite::startSound} and {@link SWFMovie::startSound} methods.
160792 **/
160793class SWFSoundInstance {
160794    /**
160795     * @param int $point
160796     * @return void
160797     * @since PHP 5 < 5.3.0, PECL ming SVN
160798     **/
160799    function loopCount($point){}
160800
160801    /**
160802     * @param int $point
160803     * @return void
160804     * @since PHP 5 < 5.3.0, PECL ming SVN
160805     **/
160806    function loopInPoint($point){}
160807
160808    /**
160809     * @param int $point
160810     * @return void
160811     * @since PHP 5 < 5.3.0, PECL ming SVN
160812     **/
160813    function loopOutPoint($point){}
160814
160815    /**
160816     * @return void
160817     * @since PHP 5 < 5.3.0, PECL ming SVN
160818     **/
160819    function noMultiple(){}
160820
160821}
160822/**
160823 * An SWFSprite is also known as a "movie clip", this allows one to
160824 * create objects which are animated in their own timelines. Hence, the
160825 * sprite has most of the same methods as the movie.
160826 **/
160827class SWFSprite {
160828    /**
160829     * Adds an object to a sprite
160830     *
160831     * {@link swfsprite::add} adds a {@link swfshape}, a {@link swfbutton}, a
160832     * {@link swftext}, a {@link swfaction} or a {@link swfsprite} object.
160833     *
160834     * For displayable types ({@link swfshape}, {@link swfbutton}, {@link
160835     * swftext}, {@link swfaction} or {@link swfsprite}), this returns a
160836     * handle to the object in a display list.
160837     *
160838     * @param object $object
160839     * @return void
160840     * @since PHP 5 < 5.3.0, PECL ming SVN
160841     **/
160842    function add($object){}
160843
160844    /**
160845     * Labels frame
160846     *
160847     * @param string $label
160848     * @return void
160849     * @since PHP 5 < 5.3.0, PECL ming SVN
160850     **/
160851    function labelFrame($label){}
160852
160853    /**
160854     * Moves to the next frame of the animation
160855     *
160856     * {@link swfsprite::setframes} moves to the next frame of the animation.
160857     *
160858     * @return void
160859     * @since PHP 5 < 5.3.0, PECL ming SVN
160860     **/
160861    function nextFrame(){}
160862
160863    /**
160864     * Removes an object to a sprite
160865     *
160866     * {@link swfsprite::remove} remove a {@link swfshape}, a {@link
160867     * swfbutton}, a {@link swftext}, a {@link swfaction} or a {@link
160868     * swfsprite} object from the sprite.
160869     *
160870     * @param object $object
160871     * @return void
160872     * @since PHP 5 < 5.3.0, PECL ming SVN
160873     **/
160874    function remove($object){}
160875
160876    /**
160877     * Sets the total number of frames in the animation
160878     *
160879     * {@link swfsprite::setframes} sets the total number of frames in the
160880     * animation to {@link numberofframes}.
160881     *
160882     * @param int $number
160883     * @return void
160884     * @since PHP 5 < 5.3.0, PECL ming SVN
160885     **/
160886    function setFrames($number){}
160887
160888    /**
160889     * @param SWFSound $sount
160890     * @return SWFSoundInstance
160891     * @since PHP 5 < 5.3.0, PECL ming SVN
160892     **/
160893    function startSound($sount){}
160894
160895    /**
160896     * @param SWFSound $sount
160897     * @return void
160898     * @since PHP 5 < 5.3.0, PECL ming SVN
160899     **/
160900    function stopSound($sount){}
160901
160902    /**
160903     * Creates a movie clip (a sprite)
160904     *
160905     * Creates a new SWFSprite object.
160906     *
160907     * @since PHP 5 < 5.3.0, PECL ming SVN
160908     **/
160909    function __construct(){}
160910
160911}
160912/**
160913 * SWFText.
160914 **/
160915class SWFText {
160916    /**
160917     * Draws a string
160918     *
160919     * {@link swftext::addstring} draws the string {@link string} at the
160920     * current pen (cursor) location. Pen is at the baseline of the text;
160921     * i.e., ascending text is in the -y direction.
160922     *
160923     * @param string $string
160924     * @return void
160925     * @since PHP 5 < 5.3.0, PECL ming SVN
160926     **/
160927    function addString($string){}
160928
160929    /**
160930     * Writes the given text into this SWFText object at the current pen
160931     * position, using the current font, height, spacing, and color
160932     *
160933     * @param string $text
160934     * @return void
160935     * @since PHP 5 < 5.3.0, PECL ming SVN
160936     **/
160937    function addUTF8String($text){}
160938
160939    /**
160940     * Returns the ascent of the current font at its current size, or 0 if
160941     * not available
160942     *
160943     * @return float
160944     * @since PHP 5 < 5.3.0, PECL ming SVN
160945     **/
160946    function getAscent(){}
160947
160948    /**
160949     * Returns the descent of the current font at its current size, or 0 if
160950     * not available
160951     *
160952     * @return float
160953     * @since PHP 5 < 5.3.0, PECL ming SVN
160954     **/
160955    function getDescent(){}
160956
160957    /**
160958     * Returns the leading of the current font at its current size, or 0 if
160959     * not available
160960     *
160961     * @return float
160962     * @since PHP 5 < 5.3.0, PECL ming SVN
160963     **/
160964    function getLeading(){}
160965
160966    /**
160967     * Calculates the width of the given string in this text objects current
160968     * font and size
160969     *
160970     * @param string $string
160971     * @return float
160972     * @since PHP 5 < 5.3.0, PECL ming SVN
160973     **/
160974    function getUTF8Width($string){}
160975
160976    /**
160977     * Computes string's width
160978     *
160979     * Returns the rendered width of the {@link string} at the text object's
160980     * current font, scale, and spacing settings.
160981     *
160982     * @param string $string
160983     * @return float
160984     * @since PHP 5 < 5.3.0, PECL ming SVN
160985     **/
160986    function getWidth($string){}
160987
160988    /**
160989     * Moves the pen
160990     *
160991     * {@link swftext::moveto} moves the pen (or cursor, if that makes more
160992     * sense) to ({@link x},{@link y}) in text object's coordinate space. If
160993     * either is zero, though, value in that dimension stays the same.
160994     * Annoying, should be fixed.
160995     *
160996     * @param float $x
160997     * @param float $y
160998     * @return void
160999     * @since PHP 5 < 5.3.0, PECL ming SVN
161000     **/
161001    function moveTo($x, $y){}
161002
161003    /**
161004     * Sets the current text color
161005     *
161006     * Changes the current text color.
161007     *
161008     * @param int $red Value of red component
161009     * @param int $green Value of green component
161010     * @param int $blue Value of blue component
161011     * @param int $a Value of alpha component
161012     * @return void
161013     * @since PHP 5 < 5.3.0, PECL ming SVN
161014     **/
161015    function setColor($red, $green, $blue, $a){}
161016
161017    /**
161018     * Sets the current font
161019     *
161020     * {@link swftext::setfont} sets the current font to {@link font}.
161021     *
161022     * @param SWFFont $font
161023     * @return void
161024     * @since PHP 5 < 5.3.0, PECL ming SVN
161025     **/
161026    function setFont($font){}
161027
161028    /**
161029     * Sets the current font height
161030     *
161031     * {@link swftext::setheight} sets the current font height to {@link
161032     * height}. Default is 240.
161033     *
161034     * @param float $height
161035     * @return void
161036     * @since PHP 5 < 5.3.0, PECL ming SVN
161037     **/
161038    function setHeight($height){}
161039
161040    /**
161041     * Sets the current font spacing
161042     *
161043     * {@link swftext::setspacing} sets the current font spacing to {@link
161044     * spacing}. Default is 1.0. 0 is all of the letters written at the same
161045     * point. This doesn't really work that well because it inflates the
161046     * advance across the letter, doesn't add the same amount of spacing
161047     * between the letters. I should try and explain that better, prolly. Or
161048     * just fix the damn thing to do constant spacing. This was really just a
161049     * way to figure out how letter advances work, anyway.. So nyah.
161050     *
161051     * @param float $spacing
161052     * @return void
161053     * @since PHP 5 < 5.3.0, PECL ming SVN
161054     **/
161055    function setSpacing($spacing){}
161056
161057    /**
161058     * Creates a new SWFText object
161059     *
161060     * Creates a new SWFText object, fresh for manipulating.
161061     *
161062     * @since PHP 5 < 5.3.0, PECL ming SVN
161063     **/
161064    function __construct(){}
161065
161066}
161067/**
161068 * SWFTextField.
161069 **/
161070class SWFTextField {
161071    /**
161072     * Adds characters to a font that will be available within a textfield
161073     *
161074     * @param string $chars
161075     * @return void
161076     * @since PHP 5 < 5.3.0, PECL ming SVN
161077     **/
161078    function addChars($chars){}
161079
161080    /**
161081     * Concatenates the given string to the text field
161082     *
161083     * {@link swftextfield::setname} concatenates the string {@link string}
161084     * to the text field.
161085     *
161086     * @param string $string
161087     * @return void
161088     * @since PHP 5 < 5.3.0, PECL ming SVN
161089     **/
161090    function addString($string){}
161091
161092    /**
161093     * Sets the text field alignment
161094     *
161095     * {@link swftextfield::align} sets the text field alignment to {@link
161096     * alignement}. Valid values for {@link alignement} are :
161097     * SWFTEXTFIELD_ALIGN_LEFT, SWFTEXTFIELD_ALIGN_RIGHT,
161098     * SWFTEXTFIELD_ALIGN_CENTER and SWFTEXTFIELD_ALIGN_JUSTIFY.
161099     *
161100     * @param int $alignement
161101     * @return void
161102     * @since PHP 5 < 5.3.0, PECL ming SVN
161103     **/
161104    function align($alignement){}
161105
161106    /**
161107     * Sets the text field width and height
161108     *
161109     * {@link swftextfield::setbounds} sets the text field width to {@link
161110     * width} and height to {@link height}. If you don't set the bounds
161111     * yourself, Ming makes a poor guess at what the bounds are.
161112     *
161113     * @param float $width
161114     * @param float $height
161115     * @return void
161116     * @since PHP 5 < 5.3.0, PECL ming SVN
161117     **/
161118    function setBounds($width, $height){}
161119
161120    /**
161121     * Sets the color of the text field
161122     *
161123     * {@link swftextfield::setcolor} sets the color of the text field.
161124     * Default is fully opaque black. Color is represented using RGB system.
161125     *
161126     * @param int $red Value of red component
161127     * @param int $green Value of green component
161128     * @param int $blue Value of blue component
161129     * @param int $a Value of alpha component
161130     * @return void
161131     * @since PHP 5 < 5.3.0, PECL ming SVN
161132     **/
161133    function setColor($red, $green, $blue, $a){}
161134
161135    /**
161136     * Sets the text field font
161137     *
161138     * {@link swftextfield::setfont} sets the text field font to the
161139     * [browser-defined?] {@link font} font.
161140     *
161141     * @param SWFFont $font
161142     * @return void
161143     * @since PHP 5 < 5.3.0, PECL ming SVN
161144     **/
161145    function setFont($font){}
161146
161147    /**
161148     * Sets the font height of this text field font
161149     *
161150     * {@link swftextfield::setheight} sets the font height of this text
161151     * field font to the given height {@link height}. Default is 240.
161152     *
161153     * @param float $height
161154     * @return void
161155     * @since PHP 5 < 5.3.0, PECL ming SVN
161156     **/
161157    function setHeight($height){}
161158
161159    /**
161160     * Sets the indentation of the first line
161161     *
161162     * {@link swftextfield::setindentation} sets the indentation of the first
161163     * line in the text field, to {@link width}.
161164     *
161165     * @param float $width
161166     * @return void
161167     * @since PHP 5 < 5.3.0, PECL ming SVN
161168     **/
161169    function setIndentation($width){}
161170
161171    /**
161172     * Sets the left margin width of the text field
161173     *
161174     * {@link swftextfield::setleftmargin} sets the left margin width of the
161175     * text field to {@link width}. Default is 0.
161176     *
161177     * @param float $width
161178     * @return void
161179     * @since PHP 5 < 5.3.0, PECL ming SVN
161180     **/
161181    function setLeftMargin($width){}
161182
161183    /**
161184     * Sets the line spacing of the text field
161185     *
161186     * {@link swftextfield::setlinespacing} sets the line spacing of the text
161187     * field to the height of {@link height}. Default is 40.
161188     *
161189     * @param float $height
161190     * @return void
161191     * @since PHP 5 < 5.3.0, PECL ming SVN
161192     **/
161193    function setLineSpacing($height){}
161194
161195    /**
161196     * Sets the margins width of the text field
161197     *
161198     * {@link swftextfield::setmargins} set both margins at once, for the man
161199     * on the go.
161200     *
161201     * @param float $left
161202     * @param float $right
161203     * @return void
161204     * @since PHP 5 < 5.3.0, PECL ming SVN
161205     **/
161206    function setMargins($left, $right){}
161207
161208    /**
161209     * Sets the variable name
161210     *
161211     * {@link swftextfield::setname} sets the variable name of this text
161212     * field to {@link name}, for form posting and action scripting purposes.
161213     *
161214     * @param string $name
161215     * @return void
161216     * @since PHP 5 < 5.3.0, PECL ming SVN
161217     **/
161218    function setName($name){}
161219
161220    /**
161221     * Sets the padding of this textfield
161222     *
161223     * @param float $padding
161224     * @return void
161225     * @since PHP 5 < 5.3.0, PECL ming SVN
161226     **/
161227    function setPadding($padding){}
161228
161229    /**
161230     * Sets the right margin width of the text field
161231     *
161232     * {@link swftextfield::setrightmargin} sets the right margin width of
161233     * the text field to {@link width}. Default is 0.
161234     *
161235     * @param float $width
161236     * @return void
161237     * @since PHP 5 < 5.3.0, PECL ming SVN
161238     **/
161239    function setRightMargin($width){}
161240
161241    /**
161242     * Creates a text field object
161243     *
161244     * {@link swftextfield} creates a new text field object. Text Fields are
161245     * less flexible than {@link swftext} objects- they can't be rotated,
161246     * scaled non-proportionally, or skewed, but they can be used as form
161247     * entries, and they can use browser-defined fonts.
161248     *
161249     * The optional flags change the text field's behavior. It has the
161250     * following possibles values : SWFTEXTFIELD_DRAWBOX draws the outline of
161251     * the textfield SWFTEXTFIELD_HASLENGTH SWFTEXTFIELD_HTML allows text
161252     * markup using HTML-tags SWFTEXTFIELD_MULTILINE allows multiple lines
161253     * SWFTEXTFIELD_NOEDIT indicates that the field shouldn't be
161254     * user-editable SWFTEXTFIELD_NOSELECT makes the field non-selectable
161255     * SWFTEXTFIELD_PASSWORD obscures the data entry SWFTEXTFIELD_WORDWRAP
161256     * allows text to wrap Flags are combined with the bitwise OR operation.
161257     * For example,
161258     *
161259     * <?php $t = newSWFTextField(SWFTEXTFIELD_PASSWORD |
161260     * SWFTEXTFIELD_NOEDIT); ?>
161261     *
161262     * creates a totally useless non-editable password field.
161263     *
161264     * @param int $flags
161265     * @since PHP 5 < 5.3.0, PECL ming SVN
161266     **/
161267    function __construct($flags){}
161268
161269}
161270/**
161271 * SWFVideoStream.
161272 **/
161273class SWFVideoStream {
161274    /**
161275     * Returns the number of frames in the video
161276     *
161277     * This function returns the number of video-frames of a SWFVideoStream.
161278     *
161279     * @return int Returns the number of frames, as an integer
161280     * @since PHP 5.0.5-5.3.0, PECL ming SVN
161281     **/
161282    function getNumFrames(){}
161283
161284    /**
161285     * Sets video dimension
161286     *
161287     * Sets the width and height for streamed videos.
161288     *
161289     * @param int $x Width in pixels.
161290     * @param int $y Height in pixels.
161291     * @return void
161292     * @since PHP 5.0.5-5.3.0, PECL ming SVN
161293     **/
161294    function setDimension($x, $y){}
161295
161296    /**
161297     * Returns a SWFVideoStream object
161298     *
161299     * @param string $file
161300     * @since PHP 5.0.5-5.3.0, PECL ming SVN
161301     **/
161302    function __construct($file){}
161303
161304}
161305class Swish {
161306    const IN_ALL = 0;
161307
161308    const IN_BODY = 0;
161309
161310    const IN_BODY_BIT = 0;
161311
161312    const IN_COMMENTS = 0;
161313
161314    const IN_COMMENTS_BIT = 0;
161315
161316    const IN_EMPHASIZED = 0;
161317
161318    const IN_EMPHASIZED_BIT = 0;
161319
161320    const IN_FILE = 0;
161321
161322    const IN_FILE_BIT = 0;
161323
161324    const IN_HEAD = 0;
161325
161326    const IN_HEADER = 0;
161327
161328    const IN_HEADER_BIT = 0;
161329
161330    const IN_HEAD_BIT = 0;
161331
161332    const IN_META = 0;
161333
161334    const IN_META_BIT = 0;
161335
161336    const IN_TITLE = 0;
161337
161338    const IN_TITLE_BIT = 0;
161339
161340    const META_TYPE_DATE = 0;
161341
161342    const META_TYPE_STRING = 0;
161343
161344    const META_TYPE_ULONG = 0;
161345
161346    const META_TYPE_UNDEF = 0;
161347
161348    /**
161349     * Get the list of meta entries for the index
161350     *
161351     * @param string $index_name The name of the index file.
161352     * @return array Returns an array of meta entries for the given index.
161353     * @since PECL swish >= 0.1.0
161354     **/
161355    function getMetaList($index_name){}
161356
161357    /**
161358     * Get the list of properties for the index
161359     *
161360     * @param string $index_name The name of the index file.
161361     * @return array Returns an array of properties for the given index.
161362     * @since PECL swish >= 0.1.0
161363     **/
161364    function getPropertyList($index_name){}
161365
161366    /**
161367     * Prepare a search query
161368     *
161369     * Prepare and return a search object, which you can later use for
161370     * unlimited number of queries.
161371     *
161372     * @param string $query Optional query string. The query can be also
161373     *   set using {@link SwishSearch::execute} method.
161374     * @return object Returns SwishSearch object.
161375     * @since PECL swish >= 0.1.0
161376     **/
161377    function prepare($query){}
161378
161379    /**
161380     * Execute a query and return results object
161381     *
161382     * A quick method to execute a search with default parameters.
161383     *
161384     * @param string $query Query string.
161385     * @return object Returns SwishResults object.
161386     * @since PECL swish >= 0.1.0
161387     **/
161388    function query($query){}
161389
161390    /**
161391     * Construct a Swish object
161392     *
161393     * @param string $index_names The list of index files separated by
161394     *   spaces.
161395     * @return void
161396     * @since PECL swish >= 0.1.0
161397     **/
161398    function __construct($index_names){}
161399
161400}
161401class SwishResult {
161402    /**
161403     * Get a list of meta entries
161404     *
161405     * @return array Returns the same array as {@link swish::getmetalist},
161406     *   but uses the index file from the result handle.
161407     * @since PECL swish >= 0.1.0
161408     **/
161409    function getMetaList(){}
161410
161411    /**
161412     * Stems the given word
161413     *
161414     * Stems the word based on the fuzzy mode used during indexing. Each
161415     * result object is linked with its index, so the results are based on
161416     * this index.
161417     *
161418     * @param string $word The word to stem.
161419     * @return array Returns array containing the stemmed word variants
161420     *   (usually just one).
161421     * @since PECL swish >= 0.1.0
161422     **/
161423    function stem($word){}
161424
161425}
161426class SwishResults {
161427    /**
161428     * Get an array of parsed words
161429     *
161430     * @param string $index_name The name of the index used to initialize
161431     *   Swish object.
161432     * @return array An array of parsed words with stopwords removed. The
161433     *   list of parsed words may be useful for highlighting search terms in
161434     *   the results.
161435     * @since PECL swish >= 0.1.0
161436     **/
161437    function getParsedWords($index_name){}
161438
161439    /**
161440     * Get an array of stopwords removed from the query
161441     *
161442     * @param string $index_name The name of the index used to initialize
161443     *   Swish object.
161444     * @return array Returns array of stopwords removed from the query.
161445     * @since PECL swish >= 0.1.0
161446     **/
161447    function getRemovedStopwords($index_name){}
161448
161449    /**
161450     * Get the next search result
161451     *
161452     * @return object Returns the next SwishResult object in the result set
161453     *   or FALSE if there are no more results available.
161454     * @since PECL swish >= 0.1.0
161455     **/
161456    function nextResult(){}
161457
161458    /**
161459     * Set current seek pointer to the given position
161460     *
161461     * @param int $position Zero-based position number. Cannot be less than
161462     *   zero.
161463     * @return int Returns new position value on success.
161464     * @since PECL swish >= 0.1.0
161465     **/
161466    function seekResult($position){}
161467
161468}
161469class SwishSearch {
161470    /**
161471     * Execute the search and get the results
161472     *
161473     * Searches the index file(s) based on the parameters set in the search
161474     * object.
161475     *
161476     * @param string $query The query string is an optional parameter, it
161477     *   can be also set using {@link Swish::prepare} method. The query
161478     *   string is preserved between executions, so you can set it once, but
161479     *   execute the search multiple times.
161480     * @return object Returns SwishResults object.
161481     * @since PECL swish >= 0.1.0
161482     **/
161483    function execute($query){}
161484
161485    /**
161486     * Reset the search limits
161487     *
161488     * Reset the search limits previous set by .
161489     *
161490     * @return void
161491     * @since PECL swish >= 0.1.0
161492     **/
161493    function resetLimit(){}
161494
161495    /**
161496     * Set the search limits
161497     *
161498     * @param string $property Search result property name.
161499     * @param string $low The lowest value of the property.
161500     * @param string $high The highest value of the property.
161501     * @return void
161502     * @since PECL swish >= 0.1.0
161503     **/
161504    function setLimit($property, $low, $high){}
161505
161506    /**
161507     * Set the phrase delimiter
161508     *
161509     * @param string $delimiter Phrase delimiter character. The default
161510     *   delimiter is double-quotes.
161511     * @return void
161512     * @since PECL swish >= 0.1.0
161513     **/
161514    function setPhraseDelimiter($delimiter){}
161515
161516    /**
161517     * Set the sort order
161518     *
161519     * @param string $sort Sort order of the results is a string containing
161520     *   name of a result property combined with sort direction ("asc" or
161521     *   "desc"). Examples: "swishrank desc", "swishdocpath asc", "swishtitle
161522     *   asc", "swishdocsize desc", "swishlastmodified desc" etc.
161523     * @return void
161524     * @since PECL swish >= 0.1.0
161525     **/
161526    function setSort($sort){}
161527
161528    /**
161529     * Set the structure flag in the search object
161530     *
161531     * @param int $structure The structure flag a bitmask is used to limit
161532     *   search to certain parts of HTML documents (like title, meta, body
161533     *   etc.). Its possible values are listed below. To combine several
161534     *   values use bitwise OR operator, see example below.
161535     * @return void
161536     * @since PECL swish >= 0.1.0
161537     **/
161538    function setStructure($structure){}
161539
161540}
161541namespace Swoole {
161542class Async {
161543    /**
161544     * Async and non-blocking hostname to IP lookup.
161545     *
161546     * @param string $hostname The host name.
161547     * @param callable $callback
161548     * @return void
161549     **/
161550    public static function dnsLookup($hostname, $callback){}
161551
161552    /**
161553     * Read file stream asynchronously.
161554     *
161555     * @param string $filename The name of the file.
161556     * @param callable $callback
161557     * @param integer $chunk_size The name of the file.
161558     * @param integer $offset The content readed from the file stream.
161559     * @return bool Whether the read is succeed.
161560     **/
161561    public static function read($filename, $callback, $chunk_size, $offset){}
161562
161563    /**
161564     * Read a file asynchronously.
161565     *
161566     * @param string $filename The filename of the file being read.
161567     * @param callable $callback
161568     * @return void
161569     **/
161570    public static function readFile($filename, $callback){}
161571
161572    /**
161573     * Update the async I/O options.
161574     *
161575     * @param array $settings
161576     * @return void
161577     **/
161578    public static function set($settings){}
161579
161580    /**
161581     * Write data to a file stream asynchronously.
161582     *
161583     * @param string $filename The filename being written.
161584     * @param string $content The content writing to the file.
161585     * @param integer $offset The offset.
161586     * @param callable $callback
161587     * @return void
161588     **/
161589    public static function write($filename, $content, $offset, $callback){}
161590
161591    /**
161592     * @param string $filename The filename being written.
161593     * @param string $content The content writing to the file.
161594     * @param callable $callback
161595     * @param string $flags
161596     * @return void
161597     **/
161598    public static function writeFile($filename, $content, $callback, $flags){}
161599
161600}
161601}
161602namespace Swoole {
161603class Atomic {
161604    /**
161605     * Add a number to the value to the atomic object.
161606     *
161607     * @param integer $add_value The value which will be added to the
161608     *   current value.
161609     * @return integer The new value of the atomic object.
161610     **/
161611    public function add($add_value){}
161612
161613    /**
161614     * Compare and set the value of the atomic object.
161615     *
161616     * @param integer $cmp_value The value to compare with the current
161617     *   value of the atomic object.
161618     * @param integer $new_value The value to set to the atomic object if
161619     *   the cmp_value is the same as the current value of the atomic object.
161620     * @return integer The new value of the atomic object.
161621     **/
161622    public function cmpset($cmp_value, $new_value){}
161623
161624    /**
161625     * Get the current value of the atomic object.
161626     *
161627     * @return integer The current value of the atomic object.
161628     **/
161629    public function get(){}
161630
161631    /**
161632     * Set a new value to the atomic object.
161633     *
161634     * @param integer $value The value to set to the atomic object.
161635     * @return integer The current value of the atomic object.
161636     **/
161637    public function set($value){}
161638
161639    /**
161640     * Subtract a number to the value of the atomic object.
161641     *
161642     * @param integer $sub_value The value which will be subtracted to the
161643     *   current value.
161644     * @return integer The current value of the atomic object.
161645     **/
161646    public function sub($sub_value){}
161647
161648}
161649}
161650namespace Swoole {
161651class Buffer {
161652    /**
161653     * Append the string or binary data at the end of the memory buffer and
161654     * return the new size of memory allocated.
161655     *
161656     * @param string $data The string or binary data to append at the end
161657     *   of the memory buffer.
161658     * @return integer The new size of the memory buffer.
161659     **/
161660    public function append($data){}
161661
161662    /**
161663     * Reset the memory buffer.
161664     *
161665     * @return void
161666     **/
161667    public function clear(){}
161668
161669    /**
161670     * Expand the size of memory buffer.
161671     *
161672     * @param integer $size The new size of the memory buffer.
161673     * @return integer The new size of the memory buffer.
161674     **/
161675    public function expand($size){}
161676
161677    /**
161678     * Read data from the memory buffer based on offset and length.
161679     *
161680     * @param integer $offset The offset.
161681     * @param integer $length The length.
161682     * @return string The data readed from the memory buffer.
161683     **/
161684    public function read($offset, $length){}
161685
161686    /**
161687     * Release the memory to OS which is not used by the memory buffer.
161688     *
161689     * @return void
161690     **/
161691    public function recycle(){}
161692
161693    /**
161694     * Read data from the memory buffer based on offset and length. Or remove
161695     * data from the memory buffer.
161696     *
161697     * If $remove is set to be true and $offset is set to be 0, the data will
161698     * be removed from the buffer. The memory for storing the data will be
161699     * released when the buffer object is deconstructed.
161700     *
161701     * @param integer $offset The offset.
161702     * @param integer $length The length.
161703     * @param bool $remove Whether to remove the data from the memory
161704     *   buffer.
161705     * @return string The data or string readed from the memory buffer.
161706     **/
161707    public function substr($offset, $length, $remove){}
161708
161709    /**
161710     * Write data to the memory buffer. The memory allocated for the buffer
161711     * will not be changed.
161712     *
161713     * @param integer $offset The offset.
161714     * @param string $data The data to write to the memory buffer.
161715     * @return void
161716     **/
161717    public function write($offset, $data){}
161718
161719    /**
161720     * Destruct the Swoole memory buffer.
161721     *
161722     * @return void
161723     **/
161724    public function __destruct(){}
161725
161726    /**
161727     * Get the string value of the memory buffer.
161728     *
161729     * @return string The string value of the memory buffer.
161730     **/
161731    public function __toString(){}
161732
161733}
161734}
161735namespace Swoole {
161736class Channel {
161737    /**
161738     * Read and pop data from swoole channel.
161739     *
161740     * @return mixed If the channel is empty, the function will return
161741     *   false, or return the unserialized data.
161742     **/
161743    public function pop(){}
161744
161745    /**
161746     * Write and push data into Swoole channel.
161747     *
161748     * Data can be any non-empty PHP variable, the variable will be
161749     * serialized if it is not string type.
161750     *
161751     * If size of the data is more than 8KB, swoole channel will use temp
161752     * files storage.
161753     *
161754     * The function will return true if the write operation is succeeded, or
161755     * return false if there is not enough space.
161756     *
161757     * @param string $data The data to push into the Swoole channel.
161758     * @return bool Wheter the data is pushed into he Swoole channel.
161759     **/
161760    public function push($data){}
161761
161762    /**
161763     * Get stats of swoole channel.
161764     *
161765     * Get the numbers of queued elements and total size of the memory used
161766     * by the queue.
161767     *
161768     * @return array The stats of the Swoole channel.
161769     **/
161770    public function stats(){}
161771
161772    /**
161773     * Destruct a Swoole channel.
161774     *
161775     * @return void
161776     **/
161777    public function __destruct(){}
161778
161779}
161780}
161781namespace Swoole {
161782class Client {
161783    /**
161784     * @var mixed
161785     **/
161786    public $errCode;
161787
161788    /**
161789     * @var mixed
161790     **/
161791    public $reuse;
161792
161793    /**
161794     * @var mixed
161795     **/
161796    public $reuseCount;
161797
161798    /**
161799     * @var mixed
161800     **/
161801    public $sock;
161802
161803    /**
161804     * Close the connection established.
161805     *
161806     * @param bool $force Whether force to close the connection.
161807     * @return bool Whether the connection is closed.
161808     **/
161809    public function close($force){}
161810
161811    /**
161812     * Connect to the remote TCP or UDP port.
161813     *
161814     * @param string $host The host name of the remote address.
161815     * @param integer $port The port number of the remote address.
161816     * @param integer $timeout The timeout(second) of connect/send/recv,
161817     *   the dafault value is 0.1s
161818     * @param integer $flag If the type of client is UDP, the $flag means
161819     *   if to enable the configuration udp_connect. If the configuration
161820     *   udp_connect is enabled, the client will only receive the data from
161821     *   specified ip:port. If the type of client is TCP and the $flag is set
161822     *   to 1, it must use swoole_client_select to check the connection
161823     *   status before send/recv.
161824     * @return bool Whether the connection is established.
161825     **/
161826    public function connect($host, $port, $timeout, $flag){}
161827
161828    /**
161829     * Get the remote socket name of the connection.
161830     *
161831     * @return array The host and port of the remote socket.
161832     **/
161833    public function getpeername(){}
161834
161835    /**
161836     * Get the local socket name of the connection.
161837     *
161838     * @return array The host and port of the local socket.
161839     **/
161840    public function getsockname(){}
161841
161842    /**
161843     * Check if the connection is established.
161844     *
161845     * This method returns the connection status of application layer.
161846     *
161847     * @return bool Whether the connection is established.
161848     **/
161849    public function isConnected(){}
161850
161851    /**
161852     * Add callback functions triggered by events.
161853     *
161854     * @param string $event
161855     * @param callable $callback
161856     * @return void
161857     **/
161858    public function on($event, $callback){}
161859
161860    /**
161861     * Pause receiving data.
161862     *
161863     * @return void
161864     **/
161865    public function pause(){}
161866
161867    /**
161868     * Redirect the data to another file descriptor.
161869     *
161870     * @param string $socket
161871     * @return void
161872     **/
161873    public function pipe($socket){}
161874
161875    /**
161876     * Receive data from the remote socket.
161877     *
161878     * @param string $size
161879     * @param string $flag
161880     * @return void
161881     **/
161882    public function recv($size, $flag){}
161883
161884    /**
161885     * Resume receiving data.
161886     *
161887     * @return void
161888     **/
161889    public function resume(){}
161890
161891    /**
161892     * Send data to the remote TCP socket.
161893     *
161894     * @param string $data The data to send which can be string or binary
161895     * @param string $flag
161896     * @return integer If the client sends data successfully, it returns
161897     *   the length of data sent. Or it returns false and sets
161898     *   $swoole_client->errCode. For sync client, there is no limit for the
161899     *   data to send. For async client, The limit for the data to send is
161900     *   socket_buffer_size.
161901     **/
161902    public function send($data, $flag){}
161903
161904    /**
161905     * Send file to the remote TCP socket.
161906     *
161907     * This is a wrapper of the Linux sendfile system call.
161908     *
161909     * @param string $filename File path of the file to send.
161910     * @param int $offset Offset of the file to send
161911     * @return boolean
161912     **/
161913    public function sendfile($filename, $offset){}
161914
161915    /**
161916     * Send data to the remote UDP address.
161917     *
161918     * The swoole client should be type of SWOOLE_SOCK_UDP or
161919     * SWOOLE_SOCK_UDP6.
161920     *
161921     * @param string $ip The IP address of remote host, IPv4 or IPv6.
161922     * @param integer $port The port number of remote host.
161923     * @param string $data The data to send which should be less-than 64K.
161924     * @return boolean
161925     **/
161926    public function sendto($ip, $port, $data){}
161927
161928    /**
161929     * Set the Swoole client parameters before the connection is established.
161930     *
161931     * @param array $settings
161932     * @return void
161933     **/
161934    public function set($settings){}
161935
161936    /**
161937     * Remove the TCP client from system event loop.
161938     *
161939     * @return void
161940     **/
161941    public function sleep(){}
161942
161943    /**
161944     * Add the TCP client back into the system event loop.
161945     *
161946     * @return void
161947     **/
161948    public function wakeup(){}
161949
161950    /**
161951     * Destruct the Swoole client.
161952     *
161953     * @return void
161954     **/
161955    public function __destruct(){}
161956
161957}
161958}
161959namespace Swoole\Connection {
161960class Iterator implements Iterator, Countable, ArrayAccess {
161961    /**
161962     * Count connections.
161963     *
161964     * Gets the number of connections.
161965     *
161966     * @return int The number of connections.
161967     **/
161968    public function count(){}
161969
161970    /**
161971     * Return current connection entry.
161972     *
161973     * Get current connection entry.
161974     *
161975     * @return Connection The current connection entry.
161976     * @since PHP 5, PHP 7
161977     **/
161978    public function current(){}
161979
161980    /**
161981     * Return key of the current connection.
161982     *
161983     * This function returns key of the current connection.
161984     *
161985     * @return int Key of the current connection.
161986     * @since PHP 5, PHP 7
161987     **/
161988    public function key(){}
161989
161990    /**
161991     * Move to the next connection.
161992     *
161993     * The iterator to the next connection.
161994     *
161995     * @return Connection
161996     * @since PHP 5, PHP 7
161997     **/
161998    public function next(){}
161999
162000    /**
162001     * Check if offet exists.
162002     *
162003     * Check if offset exists.
162004     *
162005     * @param int $index The offset being checked.
162006     * @return boolean Returns TRUE if the offset exists, otherwise FALSE.
162007     **/
162008    public function offsetExists($index){}
162009
162010    /**
162011     * Offset to retrieve.
162012     *
162013     * Return the connection at specified offset.
162014     *
162015     * @param string $index The offset to retrieve.
162016     * @return Connection
162017     **/
162018    public function offsetGet($index){}
162019
162020    /**
162021     * Assign a Connection to the specified offset.
162022     *
162023     * @param int $offset The offset to assign the Connection to.
162024     * @param mixed $connection The connection to set.
162025     * @return void
162026     **/
162027    public function offsetSet($offset, $connection){}
162028
162029    /**
162030     * Unset an offset.
162031     *
162032     * Unsets an offset.
162033     *
162034     * @param int $offset The offset to unset.
162035     * @return void
162036     **/
162037    public function offsetUnset($offset){}
162038
162039    /**
162040     * Rewinds iterator
162041     *
162042     * @return void
162043     * @since PHP 5, PHP 7
162044     **/
162045    public function rewind(){}
162046
162047    /**
162048     * Check if current position is valid.
162049     *
162050     * Checks if the current position is valid.
162051     *
162052     * @return boolean Returns TRUE if the current iterator position is
162053     *   valid, otherwise FALSE.
162054     * @since PHP 5, PHP 7
162055     **/
162056    public function valid(){}
162057
162058}
162059}
162060namespace Swoole {
162061class Coroutine {
162062    /**
162063     * Call a callback given by the first parameter
162064     *
162065     * Calls the {@link callback} given by the first parameter and passes the
162066     * remaining parameters as arguments.
162067     *
162068     * @param callable $callback The callable to be called.
162069     * @param mixed ...$vararg Zero or more parameters to be passed to the
162070     *   callback.
162071     * @return mixed
162072     **/
162073    public static function call_user_func($callback, ...$vararg){}
162074
162075    /**
162076     * Call a callback with an array of parameters
162077     *
162078     * Calls the callback given by the first parameter with the parameters in
162079     * param_array.
162080     *
162081     * @param callable $callback The callable to be called.
162082     * @param array $param_array Zero or more parameters in the array to be
162083     *   passed to the callback.
162084     * @return mixed
162085     **/
162086    public static function call_user_func_array($callback, $param_array){}
162087
162088    /**
162089     * @return ReturnType
162090     **/
162091    public static function cli_wait(){}
162092
162093    /**
162094     * @return ReturnType
162095     **/
162096    public static function create(){}
162097
162098    /**
162099     * @return ReturnType
162100     **/
162101    public static function getuid(){}
162102
162103    /**
162104     * @return ReturnType
162105     **/
162106    public static function resume(){}
162107
162108    /**
162109     * @return ReturnType
162110     **/
162111    public static function suspend(){}
162112
162113}
162114}
162115namespace Swoole\Coroutine {
162116class Client {
162117    /**
162118     * @var mixed
162119     **/
162120    public $errCode;
162121
162122    /**
162123     * @var mixed
162124     **/
162125    public $sock;
162126
162127    /**
162128     * @return ReturnType
162129     **/
162130    public function close(){}
162131
162132    /**
162133     * @return ReturnType
162134     **/
162135    public function connect(){}
162136
162137    /**
162138     * @return ReturnType
162139     **/
162140    public function getpeername(){}
162141
162142    /**
162143     * @return ReturnType
162144     **/
162145    public function getsockname(){}
162146
162147    /**
162148     * @return ReturnType
162149     **/
162150    public function isConnected(){}
162151
162152    /**
162153     * @return ReturnType
162154     **/
162155    public function recv(){}
162156
162157    /**
162158     * @return ReturnType
162159     **/
162160    public function send(){}
162161
162162    /**
162163     * @return ReturnType
162164     **/
162165    public function sendfile(){}
162166
162167    /**
162168     * @return ReturnType
162169     **/
162170    public function sendto(){}
162171
162172    /**
162173     * @return ReturnType
162174     **/
162175    public function set(){}
162176
162177    /**
162178     * @return ReturnType
162179     **/
162180    public function __destruct(){}
162181
162182}
162183}
162184namespace Swoole\Coroutine\Http {
162185class Client {
162186    /**
162187     * @var mixed
162188     **/
162189    public $errCode;
162190
162191    /**
162192     * @var mixed
162193     **/
162194    public $sock;
162195
162196    /**
162197     * @return ReturnType
162198     **/
162199    public function addFile(){}
162200
162201    /**
162202     * @return ReturnType
162203     **/
162204    public function close(){}
162205
162206    /**
162207     * @return ReturnType
162208     **/
162209    public function execute(){}
162210
162211    /**
162212     * @return ReturnType
162213     **/
162214    public function get(){}
162215
162216    /**
162217     * @return ReturnType
162218     **/
162219    public function getDefer(){}
162220
162221    /**
162222     * @return ReturnType
162223     **/
162224    public function isConnected(){}
162225
162226    /**
162227     * @return ReturnType
162228     **/
162229    public function post(){}
162230
162231    /**
162232     * @return ReturnType
162233     **/
162234    public function recv(){}
162235
162236    /**
162237     * @return ReturnType
162238     **/
162239    public function set(){}
162240
162241    /**
162242     * @return ReturnType
162243     **/
162244    public function setCookies(){}
162245
162246    /**
162247     * @return ReturnType
162248     **/
162249    public function setData(){}
162250
162251    /**
162252     * @return ReturnType
162253     **/
162254    public function setDefer(){}
162255
162256    /**
162257     * @return ReturnType
162258     **/
162259    public function setHeaders(){}
162260
162261    /**
162262     * @return ReturnType
162263     **/
162264    public function setMethod(){}
162265
162266    /**
162267     * @return ReturnType
162268     **/
162269    public function __destruct(){}
162270
162271}
162272}
162273namespace Swoole\Coroutine {
162274class MySQL {
162275    /**
162276     * @var mixed
162277     **/
162278    public $affected_rows;
162279
162280    /**
162281     * @var mixed
162282     **/
162283    public $connected;
162284
162285    /**
162286     * @var mixed
162287     **/
162288    public $connect_errno;
162289
162290    /**
162291     * @var mixed
162292     **/
162293    public $connect_error;
162294
162295    /**
162296     * @var mixed
162297     **/
162298    public $errno;
162299
162300    /**
162301     * @var mixed
162302     **/
162303    public $error;
162304
162305    /**
162306     * @var mixed
162307     **/
162308    public $insert_id;
162309
162310    /**
162311     * @var mixed
162312     **/
162313    public $sock;
162314
162315    /**
162316     * @return ReturnType
162317     **/
162318    public function close(){}
162319
162320    /**
162321     * @return ReturnType
162322     **/
162323    public function connect(){}
162324
162325    /**
162326     * @return ReturnType
162327     **/
162328    public function getDefer(){}
162329
162330    /**
162331     * @return ReturnType
162332     **/
162333    public function query(){}
162334
162335    /**
162336     * @return ReturnType
162337     **/
162338    public function recv(){}
162339
162340    /**
162341     * @return ReturnType
162342     **/
162343    public function setDefer(){}
162344
162345    /**
162346     * @return ReturnType
162347     **/
162348    public function __destruct(){}
162349
162350}
162351}
162352namespace Swoole\Coroutine\MySQL {
162353class Exception extends Exception implements Throwable {
162354}
162355}
162356namespace Swoole {
162357class Event {
162358    /**
162359     * Add new callback functions of a socket into the EventLoop.
162360     *
162361     * @param int $fd
162362     * @param callable $read_callback
162363     * @param callable $write_callback
162364     * @param string $events
162365     * @return boolean
162366     * @since PECL event >= 1.2.6-beta
162367     **/
162368    public static function add($fd, $read_callback, $write_callback, $events){}
162369
162370    /**
162371     * Add a callback function to the next event loop.
162372     *
162373     * @param mixed $callback
162374     * @return void
162375     **/
162376    public static function defer($callback){}
162377
162378    /**
162379     * Remove all event callback functions of a socket.
162380     *
162381     * @param string $fd
162382     * @return boolean
162383     * @since PECL event >= 1.2.6-beta
162384     **/
162385    public static function del($fd){}
162386
162387    /**
162388     * Exit the eventloop, only available at client side.
162389     *
162390     * @return void
162391     **/
162392    public static function exit(){}
162393
162394    /**
162395     * Update the event callback functions of a socket.
162396     *
162397     * @param int $fd
162398     * @param string $read_callback
162399     * @param string $write_callback
162400     * @param string $events
162401     * @return boolean
162402     * @since PECL event >= 1.2.6-beta
162403     **/
162404    public static function set($fd, $read_callback, $write_callback, $events){}
162405
162406    /**
162407     * @return void
162408     **/
162409    public static function wait(){}
162410
162411    /**
162412     * Write data to the socket.
162413     *
162414     * @param string $fd
162415     * @param string $data
162416     * @return void
162417     **/
162418    public static function write($fd, $data){}
162419
162420}
162421}
162422namespace Swoole {
162423class Exception extends Exception implements Throwable {
162424}
162425}
162426namespace Swoole\Http {
162427class Client {
162428    /**
162429     * @var mixed
162430     **/
162431    public $errCode;
162432
162433    /**
162434     * @var mixed
162435     **/
162436    public $sock;
162437
162438    /**
162439     * Add a file to the post form.
162440     *
162441     * @param string $path
162442     * @param string $name
162443     * @param string $type
162444     * @param string $filename
162445     * @param string $offset
162446     * @return void
162447     **/
162448    public function addFile($path, $name, $type, $filename, $offset){}
162449
162450    /**
162451     * Close the http connection.
162452     *
162453     * @return void
162454     **/
162455    public function close(){}
162456
162457    /**
162458     * Download a file from the remote server.
162459     *
162460     * @param string $path
162461     * @param string $file
162462     * @param callable $callback
162463     * @param integer $offset
162464     * @return void
162465     **/
162466    public function download($path, $file, $callback, $offset){}
162467
162468    /**
162469     * Send the HTTP request after setting the parameters.
162470     *
162471     * @param string $path
162472     * @param string $callback
162473     * @return void
162474     **/
162475    public function execute($path, $callback){}
162476
162477    /**
162478     * Send GET http request to the remote server.
162479     *
162480     * @param string $path
162481     * @param callable $callback
162482     * @return void
162483     **/
162484    public function get($path, $callback){}
162485
162486    /**
162487     * Check if the HTTP connection is connected.
162488     *
162489     * @return boolean
162490     **/
162491    public function isConnected(){}
162492
162493    /**
162494     * Register callback function by event name.
162495     *
162496     * @param string $event_name
162497     * @param callable $callback
162498     * @return void
162499     **/
162500    public function on($event_name, $callback){}
162501
162502    /**
162503     * Send POST http request to the remote server.
162504     *
162505     * @param string $path
162506     * @param string $data
162507     * @param callable $callback
162508     * @return void
162509     **/
162510    public function post($path, $data, $callback){}
162511
162512    /**
162513     * Push data to websocket client.
162514     *
162515     * @param string $data
162516     * @param string $opcode
162517     * @param string $finish
162518     * @return void
162519     **/
162520    public function push($data, $opcode, $finish){}
162521
162522    /**
162523     * Update the HTTP client paramters.
162524     *
162525     * @param array $settings
162526     * @return void
162527     **/
162528    public function set($settings){}
162529
162530    /**
162531     * Set the http request cookies.
162532     *
162533     * @param array $cookies
162534     * @return void
162535     **/
162536    public function setCookies($cookies){}
162537
162538    /**
162539     * Set the HTTP request body data.
162540     *
162541     * The HTTP method will be changed to be POST.
162542     *
162543     * @param string $data
162544     * @return ReturnType
162545     **/
162546    public function setData($data){}
162547
162548    /**
162549     * Set the HTTP request headers.
162550     *
162551     * @param array $headers
162552     * @return void
162553     **/
162554    public function setHeaders($headers){}
162555
162556    /**
162557     * Set the HTTP request method.
162558     *
162559     * @param string $method
162560     * @return void
162561     **/
162562    public function setMethod($method){}
162563
162564    /**
162565     * Upgrade to websocket protocol.
162566     *
162567     * @param string $path
162568     * @param string $callback
162569     * @return void
162570     **/
162571    public function upgrade($path, $callback){}
162572
162573    /**
162574     * Destruct the HTTP client.
162575     *
162576     * @return void
162577     **/
162578    public function __destruct(){}
162579
162580}
162581}
162582namespace Swoole\Http {
162583class Request {
162584    /**
162585     * Get the raw HTTP POST body.
162586     *
162587     * This method is used for the POST data which isn't in the form of
162588     * `application/x-www-form-urlencoded`.
162589     *
162590     * @return string
162591     **/
162592    public function rawcontent(){}
162593
162594    /**
162595     * Destruct the HTTP request.
162596     *
162597     * @return void
162598     **/
162599    public function __destruct(){}
162600
162601}
162602}
162603namespace Swoole\Http {
162604class Response {
162605    /**
162606     * Set the cookies of the HTTP response.
162607     *
162608     * @param string $name
162609     * @param string $value
162610     * @param string $expires
162611     * @param string $path
162612     * @param string $domain
162613     * @param string $secure
162614     * @param string $httponly
162615     * @return string
162616     **/
162617    public function cookie($name, $value, $expires, $path, $domain, $secure, $httponly){}
162618
162619    /**
162620     * Send data for the HTTP request and finish the response.
162621     *
162622     * @param string $content
162623     * @return void
162624     **/
162625    public function end($content){}
162626
162627    /**
162628     * Enable the gzip of response content.
162629     *
162630     * The header about Content-Encoding will be added automatically.
162631     *
162632     * @param string $compress_level
162633     * @return ReturnType
162634     **/
162635    public function gzip($compress_level){}
162636
162637    /**
162638     * Set the HTTP response headers.
162639     *
162640     * @param string $key
162641     * @param string $value
162642     * @param string $ucwords
162643     * @return void
162644     **/
162645    public function header($key, $value, $ucwords){}
162646
162647    /**
162648     * Init the HTTP response header.
162649     *
162650     * @return ReturnType
162651     **/
162652    public function initHeader(){}
162653
162654    /**
162655     * Set the raw cookies to the HTTP response.
162656     *
162657     * @param string $name
162658     * @param string $value
162659     * @param string $expires
162660     * @param string $path
162661     * @param string $domain
162662     * @param string $secure
162663     * @param string $httponly
162664     * @return ReturnType
162665     **/
162666    public function rawcookie($name, $value, $expires, $path, $domain, $secure, $httponly){}
162667
162668    /**
162669     * Send file through the HTTP response.
162670     *
162671     * @param string $filename
162672     * @param int $offset
162673     * @return ReturnType
162674     **/
162675    public function sendfile($filename, $offset){}
162676
162677    /**
162678     * Set the status code of the HTTP response.
162679     *
162680     * @param string $http_code
162681     * @return ReturnType
162682     **/
162683    public function status($http_code){}
162684
162685    /**
162686     * Append HTTP body content to the HTTP response.
162687     *
162688     * @param string $content
162689     * @return void
162690     **/
162691    public function write($content){}
162692
162693    /**
162694     * Destruct the HTTP response.
162695     *
162696     * @return void
162697     **/
162698    public function __destruct(){}
162699
162700}
162701}
162702namespace Swoole\Http {
162703class Server extends Swoole\Server {
162704    /**
162705     * Bind callback function to HTTP server by event name.
162706     *
162707     * @param string $event_name
162708     * @param callable $callback
162709     * @return void
162710     **/
162711    public function on($event_name, $callback){}
162712
162713    /**
162714     * Start the swoole http server.
162715     *
162716     * @return void
162717     **/
162718    public function start(){}
162719
162720}
162721}
162722namespace Swoole {
162723class Lock {
162724    /**
162725     * Try to acquire the lock. It will block if the lock is not available.
162726     *
162727     * @return void
162728     **/
162729    public function lock(){}
162730
162731    /**
162732     * Lock a read-write lock for reading.
162733     *
162734     * @return void
162735     **/
162736    public function lock_read(){}
162737
162738    /**
162739     * Try to acquire the lock and return straight away even the lock is not
162740     * available.
162741     *
162742     * @return void
162743     **/
162744    public function trylock(){}
162745
162746    /**
162747     * Try to lock a read-write lock for reading and return straight away
162748     * even the lock is not available.
162749     *
162750     * @return void
162751     **/
162752    public function trylock_read(){}
162753
162754    /**
162755     * Release the lock.
162756     *
162757     * @return void
162758     **/
162759    public function unlock(){}
162760
162761    /**
162762     * Destory a Swoole memory lock.
162763     *
162764     * @return void
162765     **/
162766    public function __destruct(){}
162767
162768}
162769}
162770namespace Swoole {
162771class Mmap {
162772    /**
162773     * Map a file into memory and return the stream resource which can be
162774     * used by PHP stream operations.
162775     *
162776     * @param string $filename
162777     * @param string $size
162778     * @param string $offset
162779     * @return ReturnType
162780     **/
162781    public static function open($filename, $size, $offset){}
162782
162783}
162784}
162785namespace Swoole {
162786class Module {
162787}
162788}
162789namespace Swoole {
162790class MySQL {
162791    /**
162792     * Close the async MySQL connection.
162793     *
162794     * @return void
162795     **/
162796    public function close(){}
162797
162798    /**
162799     * Connect to the remote MySQL server.
162800     *
162801     * @param array $server_config
162802     * @param callable $callback
162803     * @return void
162804     **/
162805    public function connect($server_config, $callback){}
162806
162807    /**
162808     * @return ReturnType
162809     **/
162810    public function getBuffer(){}
162811
162812    /**
162813     * Register callback function based on event name.
162814     *
162815     * Register callback function based on event name, current only 'close'
162816     * event is supported.
162817     *
162818     * @param string $event_name
162819     * @param callable $callback
162820     * @return void
162821     **/
162822    public function on($event_name, $callback){}
162823
162824    /**
162825     * Run the SQL query.
162826     *
162827     * @param string $sql
162828     * @param callable $callback
162829     * @return ReturnType
162830     **/
162831    public function query($sql, $callback){}
162832
162833    /**
162834     * Destory the async MySQL client.
162835     *
162836     * @return void
162837     **/
162838    public function __destruct(){}
162839
162840}
162841}
162842namespace Swoole\MySQL {
162843class Exception extends Exception implements Throwable {
162844}
162845}
162846namespace Swoole {
162847class Process {
162848    /**
162849     * High precision timer which triggers signal with fixed interval.
162850     *
162851     * @param integer $interval_usec
162852     * @return void
162853     **/
162854    public static function alarm($interval_usec){}
162855
162856    /**
162857     * Close the pipe to the child process.
162858     *
162859     * @return void
162860     **/
162861    public function close(){}
162862
162863    /**
162864     * Change the process to be a daemon process.
162865     *
162866     * @param boolean $nochdir
162867     * @param boolean $noclose
162868     * @return void
162869     **/
162870    public static function daemon($nochdir, $noclose){}
162871
162872    /**
162873     * Execute system commands.
162874     *
162875     * The process will be replaced to be the system command process, but the
162876     * pipe to the parent process will be kept.
162877     *
162878     * @param string $exec_file
162879     * @param string $args
162880     * @return ReturnType
162881     **/
162882    public function exec($exec_file, $args){}
162883
162884    /**
162885     * Stop the child processes.
162886     *
162887     * @param string $exit_code
162888     * @return void
162889     **/
162890    public function exit($exit_code){}
162891
162892    /**
162893     * Destroy the message queue created by swoole_process::useQueue.
162894     *
162895     * @return void
162896     **/
162897    public function freeQueue(){}
162898
162899    /**
162900     * Send signal to the child process.
162901     *
162902     * @param integer $pid
162903     * @param string $signal_no
162904     * @return void
162905     **/
162906    public static function kill($pid, $signal_no){}
162907
162908    /**
162909     * Set name of the process.
162910     *
162911     * @param string $process_name
162912     * @return void
162913     **/
162914    public function name($process_name){}
162915
162916    /**
162917     * Read and pop data from the message queue.
162918     *
162919     * @param integer $maxsize
162920     * @return mixed
162921     **/
162922    public function pop($maxsize){}
162923
162924    /**
162925     * Write and push data into the message queue.
162926     *
162927     * @param string $data
162928     * @return boolean
162929     **/
162930    public function push($data){}
162931
162932    /**
162933     * Read data sending to the process.
162934     *
162935     * @param integer $maxsize
162936     * @return string
162937     **/
162938    public function read($maxsize){}
162939
162940    /**
162941     * Send signal to the child processes.
162942     *
162943     * @param string $signal_no
162944     * @param callable $callback
162945     * @return void If signal sent successfully, it returns TRUE, otherwise
162946     *   it returns FALSE.
162947     **/
162948    public static function signal($signal_no, $callback){}
162949
162950    /**
162951     * Start the process.
162952     *
162953     * @return void
162954     **/
162955    public function start(){}
162956
162957    /**
162958     * Get the stats of the message queue used as the communication method
162959     * between processes.
162960     *
162961     * @return array The array of status of the message queue.
162962     **/
162963    public function statQueue(){}
162964
162965    /**
162966     * Create a message queue as the communication method between the parent
162967     * process and child processes.
162968     *
162969     * @param integer $key
162970     * @param integer $mode
162971     * @return boolean
162972     **/
162973    public function useQueue($key, $mode){}
162974
162975    /**
162976     * Wait for the events of child processes.
162977     *
162978     * @param boolean $blocking
162979     * @return array
162980     **/
162981    public static function wait($blocking){}
162982
162983    /**
162984     * Write data into the pipe and communicate with the parent process or
162985     * child processes.
162986     *
162987     * @param string $data
162988     * @return integer
162989     **/
162990    public function write($data){}
162991
162992    /**
162993     * Destory the process.
162994     *
162995     * @return void
162996     **/
162997    public function __destruct(){}
162998
162999}
163000}
163001namespace Swoole\Redis {
163002class Server extends Swoole\Server {
163003    /**
163004     * @param string $type
163005     * @param string $value
163006     * @return ReturnType
163007     **/
163008    public static function format($type, $value){}
163009
163010    /**
163011     * @param string $command
163012     * @param string $callback
163013     * @param string $number_of_string_param
163014     * @param string $type_of_array_param
163015     * @return ReturnType
163016     **/
163017    public function setHandler($command, $callback, $number_of_string_param, $type_of_array_param){}
163018
163019    /**
163020     * @return ReturnType
163021     **/
163022    public function start(){}
163023
163024}
163025}
163026namespace Swoole {
163027class Serialize {
163028    /**
163029     * Serialize the data.
163030     *
163031     * Swoole provides a fast and high performance serialization module.
163032     *
163033     * @param string $data
163034     * @param int $is_fast
163035     * @return ReturnType
163036     **/
163037    public static function pack($data, $is_fast){}
163038
163039    /**
163040     * Unserialize the data.
163041     *
163042     * @param string $data
163043     * @param string $args
163044     * @return ReturnType
163045     **/
163046    public static function unpack($data, $args){}
163047
163048}
163049}
163050namespace Swoole {
163051class Server {
163052    /**
163053     * Add a new listener to the server.
163054     *
163055     * @param string $host
163056     * @param integer $port
163057     * @param string $socket_type
163058     * @return void
163059     **/
163060    public function addlistener($host, $port, $socket_type){}
163061
163062    /**
163063     * Add a user defined swoole_process to the server.
163064     *
163065     * @param swoole_process $process
163066     * @return boolean
163067     **/
163068    public function addProcess($process){}
163069
163070    /**
163071     * Trigger a callback function after a period of time.
163072     *
163073     * @param integer $after_time_ms
163074     * @param callable $callback
163075     * @param string $param
163076     * @return ReturnType
163077     **/
163078    public function after($after_time_ms, $callback, $param){}
163079
163080    /**
163081     * Bind the connection to a user defined user ID.
163082     *
163083     * @param integer $fd
163084     * @param integer $uid
163085     * @return boolean
163086     **/
163087    public function bind($fd, $uid){}
163088
163089    /**
163090     * Stop and destory a timer.
163091     *
163092     * Stop and destory a timer
163093     *
163094     * @param integer $timer_id
163095     * @return void
163096     **/
163097    public function clearTimer($timer_id){}
163098
163099    /**
163100     * Close a connection to the client.
163101     *
163102     * @param integer $fd
163103     * @param boolean $reset
163104     * @return boolean
163105     **/
163106    public function close($fd, $reset){}
163107
163108    /**
163109     * Check status of the connection.
163110     *
163111     * @param integer $fd
163112     * @return boolean
163113     **/
163114    public function confirm($fd){}
163115
163116    /**
163117     * Get the connection info by file description.
163118     *
163119     * @param integer $fd
163120     * @param integer $reactor_id
163121     * @return array
163122     **/
163123    public function connection_info($fd, $reactor_id){}
163124
163125    /**
163126     * Get all of the established connections.
163127     *
163128     * @param integer $start_fd
163129     * @param integer $pagesize
163130     * @return array
163131     **/
163132    public function connection_list($start_fd, $pagesize){}
163133
163134    /**
163135     * Delay execution of the callback function at the end of current
163136     * EventLoop.
163137     *
163138     * @param callable $callback
163139     * @return void
163140     **/
163141    public function defer($callback){}
163142
163143    /**
163144     * Check if the connection is existed.
163145     *
163146     * @param integer $fd
163147     * @return boolean
163148     **/
163149    public function exist($fd){}
163150
163151    /**
163152     * Used in task process for sending result to the worker process when the
163153     * task is finished.
163154     *
163155     * @param string $data
163156     * @return void
163157     **/
163158    public function finish($data){}
163159
163160    /**
163161     * Get the connection info by file description.
163162     *
163163     * @param integer $fd
163164     * @param integer $reactor_id
163165     * @return ReturnType
163166     **/
163167    public function getClientInfo($fd, $reactor_id){}
163168
163169    /**
163170     * Get all of the established connections.
163171     *
163172     * @param integer $start_fd
163173     * @param integer $pagesize
163174     * @return array
163175     **/
163176    public function getClientList($start_fd, $pagesize){}
163177
163178    /**
163179     * Get the error code of the most recent error.
163180     *
163181     * @return integer
163182     **/
163183    public function getLastError(){}
163184
163185    /**
163186     * Check all the connections on the server.
163187     *
163188     * @param boolean $if_close_connection
163189     * @return mixed
163190     **/
163191    public function heartbeat($if_close_connection){}
163192
163193    /**
163194     * Listen on the given IP and port, socket type.
163195     *
163196     * @param string $host
163197     * @param integer $port
163198     * @param string $socket_type
163199     * @return boolean
163200     **/
163201    public function listen($host, $port, $socket_type){}
163202
163203    /**
163204     * Register a callback function by event name.
163205     *
163206     * @param string $event_name
163207     * @param callable $callback
163208     * @return void
163209     **/
163210    public function on($event_name, $callback){}
163211
163212    /**
163213     * Stop receiving data from the connection.
163214     *
163215     * @param integer $fd
163216     * @return void
163217     **/
163218    public function pause($fd){}
163219
163220    /**
163221     * Set the connection to be protected mode.
163222     *
163223     * @param integer $fd
163224     * @param boolean $is_protected
163225     * @return void
163226     **/
163227    public function protect($fd, $is_protected){}
163228
163229    /**
163230     * Restart all the worker process.
163231     *
163232     * @return boolean
163233     **/
163234    public function reload(){}
163235
163236    /**
163237     * Start receving data from the connection.
163238     *
163239     * @param integer $fd
163240     * @return void
163241     **/
163242    public function resume($fd){}
163243
163244    /**
163245     * Send data to the client.
163246     *
163247     * @param integer $fd
163248     * @param string $data
163249     * @param integer $reactor_id
163250     * @return boolean
163251     **/
163252    public function send($fd, $data, $reactor_id){}
163253
163254    /**
163255     * Send file to the connection.
163256     *
163257     * @param integer $fd
163258     * @param string $filename
163259     * @param integer $offset
163260     * @return boolean
163261     **/
163262    public function sendfile($fd, $filename, $offset){}
163263
163264    /**
163265     * Send message to worker processes by ID.
163266     *
163267     * @param integer $worker_id
163268     * @param string $data
163269     * @return boolean
163270     **/
163271    public function sendMessage($worker_id, $data){}
163272
163273    /**
163274     * Send data to the remote UDP address.
163275     *
163276     * @param string $ip
163277     * @param integer $port
163278     * @param string $data
163279     * @param string $server_socket
163280     * @return boolean
163281     **/
163282    public function sendto($ip, $port, $data, $server_socket){}
163283
163284    /**
163285     * Send data to the remote socket in the blocking way.
163286     *
163287     * @param integer $fd
163288     * @param string $data
163289     * @return boolean
163290     **/
163291    public function sendwait($fd, $data){}
163292
163293    /**
163294     * Set the runtime settings of the swoole server.
163295     *
163296     * Set the runtime settings of the swoole server. The settings can be
163297     * accessed by $server->setting when the swoole server has started.
163298     *
163299     * @param array $settings
163300     * @return ReturnType
163301     **/
163302    public function set($settings){}
163303
163304    /**
163305     * Shutdown the master server process, this function can be called in
163306     * worker processes.
163307     *
163308     * @return void
163309     **/
163310    public function shutdown(){}
163311
163312    /**
163313     * Start the Swoole server.
163314     *
163315     * @return void
163316     **/
163317    public function start(){}
163318
163319    /**
163320     * Get the stats of the Swoole server.
163321     *
163322     * @return array
163323     **/
163324    public function stats(){}
163325
163326    /**
163327     * Stop the Swoole server.
163328     *
163329     * @param integer $worker_id
163330     * @return boolean
163331     **/
163332    public function stop($worker_id){}
163333
163334    /**
163335     * Send data to the task worker processes.
163336     *
163337     * @param string $data
163338     * @param integer $dst_worker_id
163339     * @param callable $callback
163340     * @return mixed
163341     **/
163342    public function task($data, $dst_worker_id, $callback){}
163343
163344    /**
163345     * Send data to the task worker processes in blocking way.
163346     *
163347     * @param string $data
163348     * @param float $timeout
163349     * @param integer $worker_id
163350     * @return void
163351     **/
163352    public function taskwait($data, $timeout, $worker_id){}
163353
163354    /**
163355     * Execute multiple tasks concurrently.
163356     *
163357     * @param array $tasks
163358     * @param double $timeout_ms
163359     * @return void
163360     **/
163361    public function taskWaitMulti($tasks, $timeout_ms){}
163362
163363    /**
163364     * Repeats a given function at every given time-interval.
163365     *
163366     * @param integer $interval_ms
163367     * @param callable $callback
163368     * @return void
163369     **/
163370    public function tick($interval_ms, $callback){}
163371
163372}
163373}
163374namespace Swoole\Server {
163375class Port {
163376    /**
163377     * Register callback functions by event.
163378     *
163379     * @param string $event_name
163380     * @param callable $callback
163381     * @return ReturnType
163382     **/
163383    public function on($event_name, $callback){}
163384
163385    /**
163386     * Set protocol of the server port.
163387     *
163388     * @param array $settings
163389     * @return void
163390     **/
163391    public function set($settings){}
163392
163393    /**
163394     * Destory server port
163395     *
163396     * @return void
163397     **/
163398    public function __destruct(){}
163399
163400}
163401}
163402namespace Swoole {
163403class Table implements Iterator, Countable {
163404    /**
163405     * Set the data type and size of the columns.
163406     *
163407     * @param string $name
163408     * @param string $type
163409     * @param integer $size
163410     * @return ReturnType
163411     **/
163412    public function column($name, $type, $size){}
163413
163414    /**
163415     * Count the rows in the table, or count all the elements in the table if
163416     * $mode = 1.
163417     *
163418     * @return integer
163419     **/
163420    public function count(){}
163421
163422    /**
163423     * Create the swoole memory table.
163424     *
163425     * @return void
163426     **/
163427    public function create(){}
163428
163429    /**
163430     * Get the current row.
163431     *
163432     * @return array
163433     **/
163434    public function current(){}
163435
163436    /**
163437     * Decrement the value in the Swoole table by $row_key and $column_key.
163438     *
163439     * @param string $key
163440     * @param string $column
163441     * @param integer $decrby
163442     * @return ReturnType
163443     **/
163444    public function decr($key, $column, $decrby){}
163445
163446    /**
163447     * Delete a row in the Swoole table by $row_key.
163448     *
163449     * @param string $key
163450     * @return void
163451     **/
163452    public function del($key){}
163453
163454    /**
163455     * Destroy the Swoole table.
163456     *
163457     * @return void
163458     **/
163459    public function destroy(){}
163460
163461    /**
163462     * Check if a row is existed by $row_key.
163463     *
163464     * @param string $key
163465     * @return boolean
163466     **/
163467    public function exist($key){}
163468
163469    /**
163470     * Get the value in the Swoole table by $row_key and $column_key.
163471     *
163472     * @param string $row_key
163473     * @param string $column_key
163474     * @return integer
163475     **/
163476    public function get($row_key, $column_key){}
163477
163478    /**
163479     * Increment the value by $row_key and $column_key.
163480     *
163481     * @param string $key
163482     * @param string $column
163483     * @param integer $incrby
163484     * @return void
163485     **/
163486    public function incr($key, $column, $incrby){}
163487
163488    /**
163489     * Get the key of current row.
163490     *
163491     * @return string
163492     **/
163493    public function key(){}
163494
163495    /**
163496     * Iterator the next row.
163497     *
163498     * @return ReturnType
163499     **/
163500    public function next(){}
163501
163502    /**
163503     * Rewind the iterator.
163504     *
163505     * @return void
163506     **/
163507    public function rewind(){}
163508
163509    /**
163510     * Update a row of the table by $row_key.
163511     *
163512     * @param string $key
163513     * @param array $value
163514     * @return VOID
163515     **/
163516    public function set($key, $value){}
163517
163518    /**
163519     * Check current if the current row is valid.
163520     *
163521     * @return boolean
163522     **/
163523    public function valid(){}
163524
163525}
163526}
163527namespace Swoole {
163528class Timer {
163529    /**
163530     * Trigger a callback function after a period of time.
163531     *
163532     * @param int $after_time_ms
163533     * @param callable $callback
163534     * @return void
163535     **/
163536    public static function after($after_time_ms, $callback){}
163537
163538    /**
163539     * Delete a timer by timer ID.
163540     *
163541     * @param integer $timer_id
163542     * @return void
163543     **/
163544    public static function clear($timer_id){}
163545
163546    /**
163547     * Check if a timer is existed.
163548     *
163549     * @param integer $timer_id
163550     * @return boolean
163551     **/
163552    public static function exists($timer_id){}
163553
163554    /**
163555     * Repeats a given function at every given time-interval.
163556     *
163557     * @param integer $interval_ms
163558     * @param callable $callback
163559     * @param string $param
163560     * @return void
163561     **/
163562    public static function tick($interval_ms, $callback, $param){}
163563
163564}
163565}
163566namespace Swoole\WebSocket {
163567class Frame {
163568}
163569}
163570namespace Swoole\WebSocket {
163571class Server extends Swoole\Http\Server {
163572    /**
163573     * Check if the file descriptor exists.
163574     *
163575     * @param integer $fd
163576     * @return boolean
163577     **/
163578    public function exist($fd){}
163579
163580    /**
163581     * Register event callback function
163582     *
163583     * @param string $event_name
163584     * @param callable $callback
163585     * @return ReturnType
163586     **/
163587    public function on($event_name, $callback){}
163588
163589    /**
163590     * Get a pack of binary data to send in a single frame.
163591     *
163592     * @param string $data
163593     * @param string $opcode
163594     * @param string $finish
163595     * @param string $mask
163596     * @return binary
163597     **/
163598    public static function pack($data, $opcode, $finish, $mask){}
163599
163600    /**
163601     * Push data to the remote client.
163602     *
163603     * @param string $fd
163604     * @param string $data
163605     * @param string $opcode
163606     * @param string $finish
163607     * @return void
163608     **/
163609    public function push($fd, $data, $opcode, $finish){}
163610
163611    /**
163612     * Unpack the binary data received from the client.
163613     *
163614     * @param binary $data
163615     * @return string
163616     **/
163617    public static function unpack($data){}
163618
163619}
163620}
163621/**
163622 * A cross-platform, native implementation of named and unnamed event
163623 * objects. Both automatic and manual event objects are supported. An
163624 * event object waits, without polling, for the object to be fired/set.
163625 * One instance waits on the event object while another instance
163626 * fires/sets the event. Event objects are useful wherever a long-running
163627 * process would otherwise poll a resource (e.g. checking to see if
163628 * uploaded data needs to be processed).
163629 **/
163630class SyncEvent {
163631    /**
163632     * Fires/sets the event
163633     *
163634     * Fires/sets a SyncEvent object. Lets multiple threads through that are
163635     * waiting if the event object was created with a manual value of TRUE.
163636     *
163637     * @return bool A boolean of TRUE if the event was fired, FALSE
163638     *   otherwise.
163639     * @since PECL sync >= 1.0.0
163640     **/
163641    public function fire(){}
163642
163643    /**
163644     * Resets a manual event
163645     *
163646     * Resets a SyncEvent object that has been fired/set. Only valid for
163647     * manual event objects.
163648     *
163649     * @return bool A boolean value of TRUE if the object was successfully
163650     *   reset, FALSE otherwise.
163651     * @since PECL sync >= 1.0.0
163652     **/
163653    public function reset(){}
163654
163655    /**
163656     * Waits for the event to be fired/set
163657     *
163658     * Waits for the SyncEvent object to be fired.
163659     *
163660     * @param int $wait The number of milliseconds to wait for the event to
163661     *   be fired. A value of -1 is infinite.
163662     * @return bool A boolean of TRUE if the event was fired, FALSE
163663     *   otherwise.
163664     * @since PECL sync >= 1.0.0
163665     **/
163666    public function wait($wait){}
163667
163668    /**
163669     * Constructs a new SyncEvent object
163670     *
163671     * Constructs a named or unnamed event object.
163672     *
163673     * @param string $name The name of the event if this is a named event
163674     *   object.
163675     * @param bool $manual Specifies whether or not the event object must
163676     *   be reset manually.
163677     * @param bool $prefire Specifies whether or not to prefire (signal)
163678     *   the event object.
163679     * @since PECL sync >= 1.0.0
163680     **/
163681    public function __construct($name, $manual, $prefire){}
163682
163683}
163684/**
163685 * A cross-platform, native implementation of named and unnamed countable
163686 * mutex objects. A mutex is a mutual exclusion object that restricts
163687 * access to a shared resource (e.g. a file) to a single instance.
163688 * Countable mutexes acquire the mutex a single time and internally track
163689 * the number of times the mutex is locked. The mutex is unlocked as soon
163690 * as it goes out of scope or is unlocked the same number of times that
163691 * it was locked.
163692 **/
163693class SyncMutex {
163694    /**
163695     * Waits for an exclusive lock
163696     *
163697     * Obtains an exclusive lock on a SyncMutex object. If the lock is
163698     * already acquired, then this increments an internal counter.
163699     *
163700     * @param int $wait The number of milliseconds to wait for the
163701     *   exclusive lock. A value of -1 is infinite.
163702     * @return bool A boolean of TRUE if the lock was obtained, FALSE
163703     *   otherwise.
163704     * @since PECL sync >= 1.0.0
163705     **/
163706    public function lock($wait){}
163707
163708    /**
163709     * Unlocks the mutex
163710     *
163711     * Decreases the internal counter of a SyncMutex object. When the
163712     * internal counter reaches zero, the actual lock on the object is
163713     * released.
163714     *
163715     * @param bool $all Specifies whether or not to set the internal
163716     *   counter to zero and therefore release the lock.
163717     * @return bool A boolean of TRUE if the unlock operation was
163718     *   successful, FALSE otherwise.
163719     * @since PECL sync >= 1.0.0
163720     **/
163721    public function unlock($all){}
163722
163723    /**
163724     * Constructs a new SyncMutex object
163725     *
163726     * Constructs a named or unnamed countable mutex.
163727     *
163728     * @param string $name The name of the mutex if this is a named mutex
163729     *   object.
163730     * @since PECL sync >= 1.0.0
163731     **/
163732    public function __construct($name){}
163733
163734}
163735/**
163736 * A cross-platform, native implementation of named and unnamed
163737 * reader-writer objects. A reader-writer object allows many readers or
163738 * one writer to access a resource. This is an efficient solution for
163739 * managing resources where access will primarily be read-only but
163740 * exclusive write access is occasionally necessary.
163741 **/
163742class SyncReaderWriter {
163743    /**
163744     * Waits for a read lock
163745     *
163746     * Obtains a read lock on a SyncReaderWriter object.
163747     *
163748     * @param int $wait The number of milliseconds to wait for a lock. A
163749     *   value of -1 is infinite.
163750     * @return bool A boolean of TRUE if the lock was obtained, FALSE
163751     *   otherwise.
163752     * @since PECL sync >= 1.0.0
163753     **/
163754    public function readlock($wait){}
163755
163756    /**
163757     * Releases a read lock
163758     *
163759     * Releases a read lock on a SyncReaderWriter object.
163760     *
163761     * @return bool A boolean of TRUE if the unlock operation was
163762     *   successful, FALSE otherwise.
163763     * @since PECL sync >= 1.0.0
163764     **/
163765    public function readunlock(){}
163766
163767    /**
163768     * Waits for an exclusive write lock
163769     *
163770     * Obtains an exclusive write lock on a SyncReaderWriter object.
163771     *
163772     * @param int $wait The number of milliseconds to wait for a lock. A
163773     *   value of -1 is infinite.
163774     * @return bool A boolean of TRUE if the lock was obtained, FALSE
163775     *   otherwise.
163776     * @since PECL sync >= 1.0.0
163777     **/
163778    public function writelock($wait){}
163779
163780    /**
163781     * Releases a write lock
163782     *
163783     * Releases a write lock on a SyncReaderWriter object.
163784     *
163785     * @return bool A boolean of TRUE if the unlock operation was
163786     *   successful, FALSE otherwise.
163787     * @since PECL sync >= 1.0.0
163788     **/
163789    public function writeunlock(){}
163790
163791    /**
163792     * Constructs a new SyncReaderWriter object
163793     *
163794     * Constructs a named or unnamed reader-writer object.
163795     *
163796     * @param string $name The name of the reader-writer if this is a named
163797     *   reader-writer object.
163798     * @param bool $autounlock Specifies whether or not to automatically
163799     *   unlock the reader-writer at the conclusion of the PHP script.
163800     * @since PECL sync >= 1.0.0
163801     **/
163802    public function __construct($name, $autounlock){}
163803
163804}
163805/**
163806 * A cross-platform, native implementation of named and unnamed semaphore
163807 * objects. A semaphore restricts access to a limited resource to a
163808 * limited number of instances. Semaphores differ from mutexes in that
163809 * they can allow more than one instance to access a resource at one time
163810 * while a mutex only allows one instance at a time.
163811 **/
163812class SyncSemaphore {
163813    /**
163814     * Decreases the count of the semaphore or waits
163815     *
163816     * Decreases the count of a SyncSemaphore object or waits until the
163817     * semaphore becomes non-zero.
163818     *
163819     * @param int $wait The number of milliseconds to wait for the
163820     *   semaphore. A value of -1 is infinite.
163821     * @return bool A boolean of TRUE if the lock operation was successful,
163822     *   FALSE otherwise.
163823     * @since PECL sync >= 1.0.0
163824     **/
163825    public function lock($wait){}
163826
163827    /**
163828     * Increases the count of the semaphore
163829     *
163830     * Increases the count of a SyncSemaphore object.
163831     *
163832     * @param int $prevcount Returns the previous count of the semaphore.
163833     * @return bool A boolean of TRUE if the unlock operation was
163834     *   successful, FALSE otherwise.
163835     * @since PECL sync >= 1.0.0
163836     **/
163837    public function unlock(&$prevcount){}
163838
163839    /**
163840     * Constructs a new SyncSemaphore object
163841     *
163842     * Constructs a named or unnamed semaphore.
163843     *
163844     * @param string $name The name of the semaphore if this is a named
163845     *   semaphore object.
163846     * @param int $initialval The initial value of the semaphore. This is
163847     *   the number of locks that may be obtained.
163848     * @param bool $autounlock Specifies whether or not to automatically
163849     *   unlock the semaphore at the conclusion of the PHP script.
163850     * @since PECL sync >= 1.0.0
163851     **/
163852    public function __construct($name, $initialval, $autounlock){}
163853
163854}
163855/**
163856 * A cross-platform, native, consistent implementation of named shared
163857 * memory objects. Shared memory lets two separate processes communicate
163858 * without the need for complex pipes or sockets. There are several
163859 * integer-based shared memory implementations for PHP. Named shared
163860 * memory is an alternative. Synchronization objects (e.g. SyncMutex) are
163861 * still required to protect most uses of shared memory.
163862 **/
163863class SyncSharedMemory {
163864    /**
163865     * Check to see if the object is the first instance system-wide of named
163866     * shared memory
163867     *
163868     * Retrieves the system-wide first instance status of a SyncSharedMemory
163869     * object.
163870     *
163871     * @return bool A boolean of TRUE if the object is the first instance
163872     *   system-wide, FALSE otherwise.
163873     * @since PECL sync >= 1.1.0
163874     **/
163875    public function first(){}
163876
163877    /**
163878     * Copy data from named shared memory
163879     *
163880     * Copies data from named shared memory.
163881     *
163882     * @param int $start The start/offset, in bytes, to begin reading.
163883     * @param int $length The number of bytes to read.
163884     * @since PECL sync >= 1.1.0
163885     **/
163886    public function read($start, $length){}
163887
163888    /**
163889     * Returns the size of the named shared memory
163890     *
163891     * Retrieves the shared memory size of a SyncSharedMemory object.
163892     *
163893     * @return bool An integer containing the size of the shared memory.
163894     *   This will be the same size that was passed to the constructor.
163895     * @since PECL sync >= 1.1.0
163896     **/
163897    public function size(){}
163898
163899    /**
163900     * Copy data to named shared memory
163901     *
163902     * Copies data to named shared memory.
163903     *
163904     * @param string $string The data to write to shared memoy.
163905     * @param int $start The start/offset, in bytes, to begin writing.
163906     * @since PECL sync >= 1.1.0
163907     **/
163908    public function write($string, $start){}
163909
163910    /**
163911     * Constructs a new SyncSharedMemory object
163912     *
163913     * Constructs a named shared memory object.
163914     *
163915     * @param string $name The name of the shared memory object.
163916     * @param int $size The size, in bytes, of shared memory to reserve.
163917     * @since PECL sync >= 1.1.0
163918     **/
163919    public function __construct($name, $size){}
163920
163921}
163922/**
163923 * When the start method of a Thread is invoked, the run method code will
163924 * be executed in separate Thread, in parallel. After the run method is
163925 * executed the Thread will exit immediately, it will be joined with the
163926 * creating Thread at the appropriate time.
163927 **/
163928class Thread extends Threaded implements Countable, Traversable, ArrayAccess {
163929    /**
163930     * Execution
163931     *
163932     * Detaches the referenced Thread from the calling context, dangerous!
163933     *
163934     * @return void
163935     * @since PECL pthreads < 3.0.0
163936     **/
163937    public function detach(){}
163938
163939    /**
163940     * Identification
163941     *
163942     * Will return the identity of the Thread that created the referenced
163943     * Thread
163944     *
163945     * @return int A numeric identity
163946     * @since PECL pthreads >= 2.0.0
163947     **/
163948    public function getCreatorId(){}
163949
163950    /**
163951     * Identification
163952     *
163953     * Return a reference to the currently executing Thread
163954     *
163955     * @return Thread An object representing the currently executing Thread
163956     * @since PECL pthreads >= 2.0.0
163957     **/
163958    public static function getCurrentThread(){}
163959
163960    /**
163961     * Identification
163962     *
163963     * Will return the identity of the currently executing Thread
163964     *
163965     * @return int A numeric identity
163966     * @since PECL pthreads >= 2.0.0
163967     **/
163968    public static function getCurrentThreadId(){}
163969
163970    /**
163971     * Identification
163972     *
163973     * Will return the identity of the referenced Thread
163974     *
163975     * @return int A numeric identity
163976     * @since PECL pthreads >= 2.0.0
163977     **/
163978    public function getThreadId(){}
163979
163980    /**
163981     * Execution
163982     *
163983     * Will execute a Callable in the global scope
163984     *
163985     * @return mixed The return value of the Callable
163986     * @since PECL pthreads < 3.0.0
163987     **/
163988    public static function globally(){}
163989
163990    /**
163991     * State Detection
163992     *
163993     * Tell if the referenced Thread has been joined
163994     *
163995     * @return bool A boolean indication of state
163996     * @since PECL pthreads >= 2.0.0
163997     **/
163998    public function isJoined(){}
163999
164000    /**
164001     * State Detection
164002     *
164003     * Tell if the referenced Thread was started
164004     *
164005     * @return bool boolean indication of state
164006     * @since PECL pthreads >= 2.0.0
164007     **/
164008    public function isStarted(){}
164009
164010    /**
164011     * Synchronization
164012     *
164013     * Causes the calling context to wait for the referenced Thread to finish
164014     * executing
164015     *
164016     * @return bool A boolean indication of success
164017     * @since PECL pthreads >= 2.0.0
164018     **/
164019    public function join(){}
164020
164021    /**
164022     * Execution
164023     *
164024     * Forces the referenced Thread to terminate
164025     *
164026     * @return void A boolean indication of success
164027     * @since PECL pthreads < 3.0.0
164028     **/
164029    public function kill(){}
164030
164031    /**
164032     * Execution
164033     *
164034     * Will start a new Thread to execute the implemented run method
164035     *
164036     * @param int $options An optional mask of inheritance constants, by
164037     *   default PTHREADS_INHERIT_ALL
164038     * @return bool A boolean indication of success
164039     * @since PECL pthreads >= 2.0.0
164040     **/
164041    public function start($options){}
164042
164043}
164044/**
164045 * Threaded objects form the basis of pthreads ability to execute user
164046 * code in parallel; they expose synchronization methods and various
164047 * useful interfaces. Threaded objects, most importantly, provide
164048 * implicit safety for the programmer; all operations on the object scope
164049 * are safe.
164050 **/
164051class Threaded implements Collectable, Traversable, Countable, ArrayAccess {
164052    /**
164053     * Manipulation
164054     *
164055     * Fetches a chunk of the objects property table of the given size,
164056     * optionally preserving keys
164057     *
164058     * @param int $size The number of items to fetch
164059     * @param bool $preserve Preserve the keys of members, by default false
164060     * @return array An array of items from the objects property table
164061     * @since PECL pthreads >= 2.0.0
164062     **/
164063    public function chunk($size, $preserve){}
164064
164065    /**
164066     * Manipulation
164067     *
164068     * Returns the number of properties for this object
164069     *
164070     * @return int
164071     * @since PECL pthreads >= 2.0.0
164072     **/
164073    public function count(){}
164074
164075    /**
164076     * Runtime Manipulation
164077     *
164078     * Makes thread safe standard class at runtime
164079     *
164080     * @param string $class The class to extend
164081     * @return bool A boolean indication of success
164082     * @since PECL pthreads >= 2.0.8
164083     **/
164084    public function extend($class){}
164085
164086    /**
164087     * Creation
164088     *
164089     * Creates an anonymous Threaded object from closures
164090     *
164091     * @param Closure $run The closure to use for ::run
164092     * @param Closure $construct The constructor to use for anonymous
164093     *   object
164094     * @param array $args The arguments to pass to constructor
164095     * @return Threaded A new anonymous Threaded object
164096     * @since PECL pthreads >= 2.0.9
164097     **/
164098    public function from($run, $construct, $args){}
164099
164100    /**
164101     * Error Detection
164102     *
164103     * Retrieves terminal error information from the referenced object
164104     *
164105     * @return array array containing the termination conditions of the
164106     *   referenced object
164107     * @since PECL pthreads < 3.0.0
164108     **/
164109    public function getTerminationInfo(){}
164110
164111    /**
164112     * State Detection
164113     *
164114     * Tell if the referenced object is executing
164115     *
164116     * @return bool A boolean indication of state A object is considered
164117     *   running while executing the run method
164118     * @since PECL pthreads >= 2.0.0
164119     **/
164120    public function isRunning(){}
164121
164122    /**
164123     * State Detection
164124     *
164125     * Tell if the referenced object was terminated during execution;
164126     * suffered fatal errors, or threw uncaught exceptions
164127     *
164128     * @return bool A boolean indication of state
164129     * @since PECL pthreads >= 2.0.0
164130     **/
164131    public function isTerminated(){}
164132
164133    /**
164134     * State Detection
164135     *
164136     * Tell if the referenced object is waiting for notification
164137     *
164138     * @return bool A boolean indication of state
164139     * @since PECL pthreads < 3.0.0
164140     **/
164141    public function isWaiting(){}
164142
164143    /**
164144     * Synchronization
164145     *
164146     * Lock the referenced objects property table
164147     *
164148     * @return bool A boolean indication of success
164149     * @since PECL pthreads < 3.0.0
164150     **/
164151    public function lock(){}
164152
164153    /**
164154     * Manipulation
164155     *
164156     * Merges data into the current object
164157     *
164158     * @param mixed $from The data to merge
164159     * @param bool $overwrite Overwrite existing keys, by default true
164160     * @return bool A boolean indication of success
164161     * @since PECL pthreads >= 2.0.0
164162     **/
164163    public function merge($from, $overwrite){}
164164
164165    /**
164166     * Synchronization
164167     *
164168     * Send notification to the referenced object
164169     *
164170     * @return bool A boolean indication of success
164171     * @since PECL pthreads >= 2.0.0
164172     **/
164173    public function notify(){}
164174
164175    /**
164176     * Synchronization
164177     *
164178     * Send notification to the referenced object. This unblocks at least one
164179     * of the blocked threads (as opposed to unblocking all of them, as seen
164180     * with Threaded::notify).
164181     *
164182     * @return bool A boolean indication of success
164183     * @since PECL pthreads >= 3.0.0
164184     **/
164185    public function notifyOne(){}
164186
164187    /**
164188     * Manipulation
164189     *
164190     * Pops an item from the objects property table
164191     *
164192     * @return bool The last item from the objects property table
164193     * @since PECL pthreads >= 2.0.0
164194     **/
164195    public function pop(){}
164196
164197    /**
164198     * Execution
164199     *
164200     * The programmer should always implement the run method for objects that
164201     * are intended for execution.
164202     *
164203     * @return void The methods return value, if used, will be ignored
164204     * @since PECL pthreads >= 2.0.0
164205     **/
164206    public function run(){}
164207
164208    /**
164209     * Manipulation
164210     *
164211     * Shifts an item from the objects property table
164212     *
164213     * @return mixed The first item from the objects property table
164214     * @since PECL pthreads >= 2.0.0
164215     **/
164216    public function shift(){}
164217
164218    /**
164219     * Synchronization
164220     *
164221     * Executes the block while retaining the referenced objects
164222     * synchronization lock for the calling context
164223     *
164224     * @param Closure $block The block of code to execute
164225     * @param mixed ...$vararg Variable length list of arguments to use as
164226     *   function arguments to the block
164227     * @return mixed The return value from the block
164228     * @since PECL pthreads >= 2.0.0
164229     **/
164230    public function synchronized($block, ...$vararg){}
164231
164232    /**
164233     * Synchronization
164234     *
164235     * Unlock the referenced objects storage for the calling context
164236     *
164237     * @return bool A boolean indication of success
164238     * @since PECL pthreads < 3.0.0
164239     **/
164240    public function unlock(){}
164241
164242    /**
164243     * Synchronization
164244     *
164245     * Will cause the calling context to wait for notification from the
164246     * referenced object
164247     *
164248     * @param int $timeout An optional timeout in microseconds
164249     * @return bool A boolean indication of success
164250     * @since PECL pthreads >= 2.0.0
164251     **/
164252    public function wait($timeout){}
164253
164254}
164255/**
164256 * An HTML node in an HTML file, as detected by tidy.
164257 **/
164258class tidy {
164259    /**
164260     * Return warnings and errors which occurred parsing the specified
164261     * document
164262     *
164263     * (property):
164264     *
164265     * Returns warnings and errors which occurred parsing the specified
164266     * document.
164267     *
164268     * @var string
164269     **/
164270    public $errorBuffer;
164271
164272    /**
164273     * Returns a object starting from the tag of the tidy parse tree
164274     *
164275     * Returns a tidyNode object starting from the <body> tag of the tidy
164276     * parse tree.
164277     *
164278     * @return tidyNode Returns a tidyNode object starting from the <body>
164279     *   tag of the tidy parse tree.
164280     **/
164281    public function body(){}
164282
164283    /**
164284     * Execute configured cleanup and repair operations on parsed markup
164285     *
164286     * This function cleans and repairs the given tidy {@link object}.
164287     *
164288     * @return bool
164289     **/
164290    public function cleanRepair(){}
164291
164292    /**
164293     * Run configured diagnostics on parsed and repaired markup
164294     *
164295     * Runs diagnostic tests on the given tidy {@link object}, adding some
164296     * more information about the document in the error buffer.
164297     *
164298     * @return bool
164299     **/
164300    public function diagnose(){}
164301
164302    /**
164303     * Get current Tidy configuration
164304     *
164305     * Gets the list of the configuration options in use by the given tidy
164306     * {@link object}.
164307     *
164308     * @return array Returns an array of configuration options.
164309     **/
164310    public function getConfig(){}
164311
164312    /**
164313     * Get the Detected HTML version for the specified document
164314     *
164315     * Returns the detected HTML version for the specified tidy {@link
164316     * object}.
164317     *
164318     * @return int Returns the detected HTML version.
164319     **/
164320    public function getHtmlVer(){}
164321
164322    /**
164323     * Returns the value of the specified configuration option for the tidy
164324     * document
164325     *
164326     * Returns the value of the specified {@link option} for the specified
164327     * tidy {@link object}.
164328     *
164329     * @param string $option
164330     * @return mixed Returns the value of the specified {@link option}. The
164331     *   return type depends on the type of the specified one.
164332     **/
164333    public function getOpt($option){}
164334
164335    /**
164336     * Returns the documentation for the given option name
164337     *
164338     * {@link tidy_get_opt_doc} returns the documentation for the given
164339     * option name.
164340     *
164341     * @param string $optname
164342     * @return string Returns a string if the option exists and has
164343     *   documentation available, or FALSE otherwise.
164344     **/
164345    public function getOptDoc($optname){}
164346
164347    /**
164348     * Get release date (version) for Tidy library
164349     *
164350     * Gets the release date of the Tidy library.
164351     *
164352     * @return string Returns a string with the release date of the Tidy
164353     *   library, which may be 'unknown'.
164354     **/
164355    public function getRelease(){}
164356
164357    /**
164358     * Get status of specified document
164359     *
164360     * Returns the status for the specified tidy {@link object}.
164361     *
164362     * @return int Returns 0 if no error/warning was raised, 1 for warnings
164363     *   or accessibility errors, or 2 for errors.
164364     **/
164365    public function getStatus(){}
164366
164367    /**
164368     * Returns a object starting from the tag of the tidy parse tree
164369     *
164370     * Returns a tidyNode object starting from the <head> tag of the tidy
164371     * parse tree.
164372     *
164373     * @return tidyNode Returns the tidyNode object.
164374     **/
164375    public function head(){}
164376
164377    /**
164378     * Returns a object starting from the tag of the tidy parse tree
164379     *
164380     * Returns a tidyNode object starting from the <html> tag of the tidy
164381     * parse tree.
164382     *
164383     * @return tidyNode Returns the tidyNode object.
164384     **/
164385    public function html(){}
164386
164387    /**
164388     * Indicates if the document is a XHTML document
164389     *
164390     * Tells if the document is a XHTML document.
164391     *
164392     * @return bool This function returns TRUE if the specified tidy {@link
164393     *   object} is a XHTML document, or FALSE otherwise.
164394     **/
164395    public function isXhtml(){}
164396
164397    /**
164398     * Indicates if the document is a generic (non HTML/XHTML) XML document
164399     *
164400     * Tells if the document is a generic (non HTML/XHTML) XML document.
164401     *
164402     * @return bool This function returns TRUE if the specified tidy {@link
164403     *   object} is a generic XML document (non HTML/XHTML), or FALSE
164404     *   otherwise.
164405     **/
164406    public function isXml(){}
164407
164408    /**
164409     * Parse markup in file or URI
164410     *
164411     * Parses the given file.
164412     *
164413     * @param string $filename If the {@link filename} parameter is given,
164414     *   this function will also read that file and initialize the object
164415     *   with the file, acting like {@link tidy_parse_file}.
164416     * @param mixed $config The config {@link config} can be passed either
164417     *   as an array or as a string. If a string is passed, it is interpreted
164418     *   as the name of the configuration file, otherwise, it is interpreted
164419     *   as the options themselves. For an explanation about each option, see
164420     *   .
164421     * @param string $encoding The {@link encoding} parameter sets the
164422     *   encoding for input/output documents. The possible values for
164423     *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
164424     *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
164425     * @param bool $use_include_path Search for the file in the
164426     *   include_path.
164427     * @return bool
164428     **/
164429    public function parseFile($filename, $config, $encoding, $use_include_path){}
164430
164431    /**
164432     * Parse a document stored in a string
164433     *
164434     * Parses a document stored in a string.
164435     *
164436     * @param string $input The data to be parsed.
164437     * @param mixed $config The config {@link config} can be passed either
164438     *   as an array or as a string. If a string is passed, it is interpreted
164439     *   as the name of the configuration file, otherwise, it is interpreted
164440     *   as the options themselves. For an explanation about each option,
164441     *   visit .
164442     * @param string $encoding The {@link encoding} parameter sets the
164443     *   encoding for input/output documents. The possible values for
164444     *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
164445     *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
164446     * @return bool Returns a new tidy instance.
164447     **/
164448    public function parseString($input, $config, $encoding){}
164449
164450    /**
164451     * Repair a file and return it as a string
164452     *
164453     * Repairs the given file and returns it as a string.
164454     *
164455     * @param string $filename The file to be repaired.
164456     * @param mixed $config The config {@link config} can be passed either
164457     *   as an array or as a string. If a string is passed, it is interpreted
164458     *   as the name of the configuration file, otherwise, it is interpreted
164459     *   as the options themselves. Check
164460     *   http://tidy.sourceforge.net/docs/quickref.html for an explanation
164461     *   about each option.
164462     * @param string $encoding The {@link encoding} parameter sets the
164463     *   encoding for input/output documents. The possible values for
164464     *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
164465     *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
164466     * @param bool $use_include_path Search for the file in the
164467     *   include_path.
164468     * @return string Returns the repaired contents as a string.
164469     **/
164470    public function repairFile($filename, $config, $encoding, $use_include_path){}
164471
164472    /**
164473     * Repair a string using an optionally provided configuration file
164474     *
164475     * Repairs the given string.
164476     *
164477     * @param string $data The data to be repaired.
164478     * @param mixed $config The config {@link config} can be passed either
164479     *   as an array or as a string. If a string is passed, it is interpreted
164480     *   as the name of the configuration file, otherwise, it is interpreted
164481     *   as the options themselves. Check for an explanation about each
164482     *   option.
164483     * @param string $encoding The {@link encoding} parameter sets the
164484     *   encoding for input/output documents. The possible values for
164485     *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
164486     *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
164487     * @return string Returns the repaired string.
164488     **/
164489    public function repairString($data, $config, $encoding){}
164490
164491    /**
164492     * Returns a object representing the root of the tidy parse tree
164493     *
164494     * Returns a tidyNode object representing the root of the tidy parse
164495     * tree.
164496     *
164497     * @return tidyNode Returns the tidyNode object.
164498     **/
164499    public function root(){}
164500
164501    /**
164502     * Constructs a new object
164503     *
164504     * Constructs a new tidy object.
164505     *
164506     * @param string $filename If the {@link filename} parameter is given,
164507     *   this function will also read that file and initialize the object
164508     *   with the file, acting like {@link tidy_parse_file}.
164509     * @param mixed $config The config {@link config} can be passed either
164510     *   as an array or as a string. If a string is passed, it is interpreted
164511     *   as the name of the configuration file, otherwise, it is interpreted
164512     *   as the options themselves. For an explanation about each option,
164513     *   visit .
164514     * @param string $encoding The {@link encoding} parameter sets the
164515     *   encoding for input/output documents. The possible values for
164516     *   encoding are: ascii, latin0, latin1, raw, utf8, iso2022, mac,
164517     *   win1252, ibm858, utf16, utf16le, utf16be, big5, and shiftjis.
164518     * @param bool $use_include_path Search for the file in the
164519     *   include_path.
164520     * @since PHP 5, PHP 7, PECL tidy >= 0.5.2
164521     **/
164522    public function __construct($filename, $config, $encoding, $use_include_path){}
164523
164524}
164525/**
164526 * An HTML node in an HTML file, as detected by tidy. 5.1.0 line, column
164527 * and proprietary were added
164528 **/
164529class tidyNode {
164530    /**
164531     * An array of string, representing the attributes names (as keys) of the
164532     * current node.
164533     *
164534     * @var array
164535     **/
164536    public $attribute;
164537
164538    /**
164539     * An array of tidyNode, representing the children of the current node.
164540     *
164541     * @var array
164542     **/
164543    public $child;
164544
164545    /**
164546     * The column number at which the tags is located in the file
164547     *
164548     * @var int
164549     **/
164550    public $column;
164551
164552    /**
164553     * The ID of the node (one of the tag constants, e.g. TIDY_TAG_FRAME)
164554     *
164555     * @var int
164556     **/
164557    public $id;
164558
164559    /**
164560     * The line number at which the tags is located in the file
164561     *
164562     * @var int
164563     **/
164564    public $line;
164565
164566    /**
164567     * The name of the HTML node
164568     *
164569     * @var string
164570     **/
164571    public $name;
164572
164573    /**
164574     * Indicates if the node is a proprietary tag
164575     *
164576     * @var bool
164577     **/
164578    public $proprietary;
164579
164580    /**
164581     * The type of the node (one of the nodetype constants, e.g.
164582     * TIDY_NODETYPE_PHP)
164583     *
164584     * @var int
164585     **/
164586    public $type;
164587
164588    /**
164589     * The HTML representation of the node, including the surrounding tags.
164590     *
164591     * @var string
164592     **/
164593    public $value;
164594
164595    /**
164596     * Returns the parent node of the current node
164597     *
164598     * @return tidyNode Returns a tidyNode if the node has a parent, or
164599     *   NULL otherwise.
164600     * @since PHP 5 >= 5.2.2, PHP 7
164601     **/
164602    public function getParent(){}
164603
164604    /**
164605     * Checks if a node has children
164606     *
164607     * Tells if the node has children.
164608     *
164609     * @return bool Returns TRUE if the node has children, FALSE otherwise.
164610     * @since PHP 5, PHP 7
164611     **/
164612    public function hasChildren(){}
164613
164614    /**
164615     * Checks if a node has siblings
164616     *
164617     * Tells if the node has siblings.
164618     *
164619     * @return bool Returns TRUE if the node has siblings, FALSE otherwise.
164620     * @since PHP 5, PHP 7
164621     **/
164622    public function hasSiblings(){}
164623
164624    /**
164625     * Checks if this node is ASP
164626     *
164627     * Tells whether the current node is ASP.
164628     *
164629     * @return bool Returns TRUE if the node is ASP, FALSE otherwise.
164630     * @since PHP 5, PHP 7
164631     **/
164632    public function isAsp(){}
164633
164634    /**
164635     * Checks if a node represents a comment
164636     *
164637     * Tells if the node is a comment.
164638     *
164639     * @return bool Returns TRUE if the node is a comment, FALSE otherwise.
164640     * @since PHP 5, PHP 7
164641     **/
164642    public function isComment(){}
164643
164644    /**
164645     * Checks if a node is part of a HTML document
164646     *
164647     * Tells if the node is part of HTML document.
164648     *
164649     * @return bool Returns TRUE if the node is part of a HTML document,
164650     *   FALSE otherwise.
164651     * @since PHP 5, PHP 7
164652     **/
164653    public function isHtml(){}
164654
164655    /**
164656     * Checks if this node is JSTE
164657     *
164658     * Tells if the node is JSTE.
164659     *
164660     * @return bool Returns TRUE if the node is JSTE, FALSE otherwise.
164661     * @since PHP 5, PHP 7
164662     **/
164663    public function isJste(){}
164664
164665    /**
164666     * Checks if a node is PHP
164667     *
164668     * Tells if the node is PHP.
164669     *
164670     * @return bool Returns TRUE if the current node is PHP code, FALSE
164671     *   otherwise.
164672     * @since PHP 5, PHP 7
164673     **/
164674    public function isPhp(){}
164675
164676    /**
164677     * Checks if a node represents text (no markup)
164678     *
164679     * Tells if the node represents a text (without any markup).
164680     *
164681     * @return bool Returns TRUE if the node represent a text, FALSE
164682     *   otherwise.
164683     * @since PHP 5, PHP 7
164684     **/
164685    public function isText(){}
164686
164687}
164688/**
164689 * The main Tokyo Tyrant class
164690 **/
164691class TokyoTyrant {
164692    /**
164693     * @var integer
164694     **/
164695    const RDBDEF_PORT = 0;
164696
164697    /**
164698     * @var integer
164699     **/
164700    const RDBIT_DECIMAL = 0;
164701
164702    /**
164703     * @var integer
164704     **/
164705    const RDBIT_KEEP = 0;
164706
164707    /**
164708     * @var integer
164709     **/
164710    const RDBIT_LEXICAL = 0;
164711
164712    /**
164713     * @var integer
164714     **/
164715    const RDBIT_OPT = 0;
164716
164717    /**
164718     * @var integer
164719     **/
164720    const RDBIT_QGRAM = 0;
164721
164722    /**
164723     * @var integer
164724     **/
164725    const RDBIT_TOKEN = 0;
164726
164727    /**
164728     * @var integer
164729     **/
164730    const RDBIT_VOID = 0;
164731
164732    /**
164733     * @var integer
164734     **/
164735    const RDBMS_DIFF = 0;
164736
164737    /**
164738     * @var integer
164739     **/
164740    const RDBMS_ISECT = 0;
164741
164742    /**
164743     * @var integer
164744     **/
164745    const RDBMS_UNION = 0;
164746
164747    /**
164748     * @var integer
164749     **/
164750    const RDBQCFTS_AND = 0;
164751
164752    /**
164753     * @var integer
164754     **/
164755    const RDBQCFTS_EX = 0;
164756
164757    /**
164758     * @var integer
164759     **/
164760    const RDBQCFTS_OR = 0;
164761
164762    /**
164763     * @var integer
164764     **/
164765    const RDBQCFTS_PH = 0;
164766
164767    /**
164768     * @var integer
164769     **/
164770    const RDBQC_NEGATE = 0;
164771
164772    /**
164773     * @var integer
164774     **/
164775    const RDBQC_NOIDX = 0;
164776
164777    /**
164778     * @var integer
164779     **/
164780    const RDBQC_NUMBT = 0;
164781
164782    /**
164783     * @var integer
164784     **/
164785    const RDBQC_NUMEQ = 0;
164786
164787    /**
164788     * @var integer
164789     **/
164790    const RDBQC_NUMGE = 0;
164791
164792    /**
164793     * @var integer
164794     **/
164795    const RDBQC_NUMGT = 0;
164796
164797    /**
164798     * @var integer
164799     **/
164800    const RDBQC_NUMLE = 0;
164801
164802    /**
164803     * @var integer
164804     **/
164805    const RDBQC_NUMLT = 0;
164806
164807    /**
164808     * @var integer
164809     **/
164810    const RDBQC_NUMOREQ = 0;
164811
164812    /**
164813     * @var integer
164814     **/
164815    const RDBQC_STRAND = 0;
164816
164817    /**
164818     * @var integer
164819     **/
164820    const RDBQC_STRBW = 0;
164821
164822    /**
164823     * @var integer
164824     **/
164825    const RDBQC_STREQ = 0;
164826
164827    /**
164828     * @var integer
164829     **/
164830    const RDBQC_STREW = 0;
164831
164832    /**
164833     * @var integer
164834     **/
164835    const RDBQC_STRINC = 0;
164836
164837    /**
164838     * @var integer
164839     **/
164840    const RDBQC_STROR = 0;
164841
164842    /**
164843     * @var integer
164844     **/
164845    const RDBQC_STROREQ = 0;
164846
164847    /**
164848     * @var integer
164849     **/
164850    const RDBQC_STRRX = 0;
164851
164852    /**
164853     * @var integer
164854     **/
164855    const RDBQO_NUMASC = 0;
164856
164857    /**
164858     * @var integer
164859     **/
164860    const RDBQO_NUMDESC = 0;
164861
164862    /**
164863     * @var integer
164864     **/
164865    const RDBQO_STRASC = 0;
164866
164867    /**
164868     * @var integer
164869     **/
164870    const RDBQO_STRDESC = 0;
164871
164872    /**
164873     * @var integer
164874     **/
164875    const RDBREC_DBL = 0;
164876
164877    /**
164878     * @var integer
164879     **/
164880    const RDBREC_INT = 0;
164881
164882    /**
164883     * @var integer
164884     **/
164885    const RDBT_RECON = 0;
164886
164887    /**
164888     * @var integer
164889     **/
164890    const RDBXOLCK_GLB = 0;
164891
164892    /**
164893     * record locking
164894     *
164895     * @var mixed
164896     **/
164897    const RDBXOLCK_REC = 0;
164898
164899    /**
164900     * @var integer
164901     **/
164902    const RDBXO_LCKREC = 0;
164903
164904    /**
164905     * invalid operation
164906     *
164907     * @var mixed
164908     **/
164909    const TTE_INVALID = 0;
164910
164911    /**
164912     * record exist
164913     *
164914     * @var mixed
164915     **/
164916    const TTE_KEEP = 0;
164917
164918    /**
164919     * miscellaneous error
164920     *
164921     * @var mixed
164922     **/
164923    const TTE_MISC = 0;
164924
164925    /**
164926     * host not found
164927     *
164928     * @var mixed
164929     **/
164930    const TTE_NOHOST = 0;
164931
164932    /**
164933     * no record found
164934     *
164935     * @var mixed
164936     **/
164937    const TTE_NOREC = 0;
164938
164939    /**
164940     * recv error
164941     *
164942     * @var mixed
164943     **/
164944    const TTE_RECV = 0;
164945
164946    /**
164947     * connection refused
164948     *
164949     * @var mixed
164950     **/
164951    const TTE_REFUSED = 0;
164952
164953    /**
164954     * send error
164955     *
164956     * @var mixed
164957     **/
164958    const TTE_SEND = 0;
164959
164960    /**
164961     * success
164962     *
164963     * @var mixed
164964     **/
164965    const TTE_SUCCESS = 0;
164966
164967    /**
164968     * Adds to a numeric key
164969     *
164970     * Adds to an int or double value. This increments the value by the given
164971     * amount and returns the new value. If the key does not exist a new key
164972     * is created with initial value of the increment parameter.
164973     *
164974     * @param string $key The string key
164975     * @param number $increment The amount to increment
164976     * @param int $type TokyoTyrant::RDBREC_INT or TokyoTyrant::RDBREC_DBL
164977     *   constant. If this parameter is omitted the type is guessed from the
164978     *   {@link increment} parameters type.
164979     * @return number Returns the new value on success
164980     * @since PECL tokyo_tyrant >= 0.1.0
164981     **/
164982    public function add($key, $increment, $type){}
164983
164984    /**
164985     * Connect to a database
164986     *
164987     * Connects to a remote database
164988     *
164989     * @param string $host The hostname
164990     * @param int $port The port. Default: 1978
164991     * @param array $options Connection options: timeout (default: 5.0),
164992     *   reconnect (default: TRUE) and persistent (default: TRUE)
164993     * @return TokyoTyrant This method returns the current object and
164994     *   throws TokyoTyrantException on failure.
164995     * @since PECL tokyo_tyrant >= 0.1.0
164996     **/
164997    public function connect($host, $port, $options){}
164998
164999    /**
165000     * Connects to a database
165001     *
165002     * Connects to a database using an uri
165003     *
165004     * @param string $uri An URI to the database. For example
165005     *   tcp://localhost:1979/
165006     * @return TokyoTyrant This method returns the current object and
165007     *   throws TokyoTyrantException on failure.
165008     * @since PECL tokyo_tyrant >= 0.1.0
165009     **/
165010    public function connectUri($uri){}
165011
165012    /**
165013     * Copies the database
165014     *
165015     * Makes a copy of the current database
165016     *
165017     * @param string $path Path to where to copy the database. The user
165018     *   running the remote database must have a write access to the
165019     *   directory.
165020     * @return TokyoTyrant This method returns the current object and
165021     *   throws TokyoTyrantException on failure.
165022     * @since PECL tokyo_tyrant >= 0.1.0
165023     **/
165024    public function copy($path){}
165025
165026    /**
165027     * Execute a remote script
165028     *
165029     * Executes a remote script extension.
165030     *
165031     * @param string $name Name of the function to execute
165032     * @param int $options Either TokyoTyrant::RDBXO_LCKREC for record
165033     *   locking and TokyoTyrant::RDBXO_LCKGLB for global locking.
165034     * @param string $key The key to pass to the function
165035     * @param string $value The value to pass to the function
165036     * @return string Returns the result of the script function
165037     * @since PECL tokyo_tyrant >= 0.1.0
165038     **/
165039    public function ext($name, $options, $key, $value){}
165040
165041    /**
165042     * Returns the forward matching keys
165043     *
165044     * Returns the forward matching keys from the database
165045     *
165046     * @param string $prefix Prefix of the keys
165047     * @param int $max_recs Maximum records to return
165048     * @return array Returns an array of matching keys. The values are not
165049     *   returned
165050     * @since PECL tokyo_tyrant >= 0.1.0
165051     **/
165052    public function fwmKeys($prefix, $max_recs){}
165053
165054    /**
165055     * The get purpose
165056     *
165057     * This method is used to return a value or multiple values. This method
165058     * accepts a string or an array as a value.
165059     *
165060     * @param mixed $keys A string key or an array of string keys
165061     * @return mixed Returns a string or an array based on the given
165062     *   parameters. Throws a TokyoTyrantException on error. If string is
165063     *   passed null is returned if the key is not found. In case an array is
165064     *   given as an parameter only existing keys will be returned. It is not
165065     *   an error to pass a key that does not exist.
165066     * @since PECL tokyo_tyrant >= 0.1.0
165067     **/
165068    public function get($keys){}
165069
165070    /**
165071     * Get an iterator
165072     *
165073     * Gets an iterator for iterating all keys / values in the database.
165074     *
165075     * @return TokyoTyrantIterator This method returns TokyoTyrantIterator
165076     *   object and throws TokyoTyrantException on failure.
165077     **/
165078    public function getIterator(){}
165079
165080    /**
165081     * Number of records in the database
165082     *
165083     * Returns the number of records in the database
165084     *
165085     * @return int Returns number of records in the database
165086     * @since PECL tokyo_tyrant >= 0.1.0
165087     **/
165088    public function num(){}
165089
165090    /**
165091     * Removes records
165092     *
165093     * Removes a record or multiple records. This method accepts a string for
165094     * a single key or an array of keys for multiple records.
165095     *
165096     * @param mixed $keys A string key or an array of string keys
165097     * @return TokyoTyrant This method returns the current object and
165098     *   throws TokyoTyrantException on failure.
165099     * @since PECL tokyo_tyrant >= 0.1.0
165100     **/
165101    public function out($keys){}
165102
165103    /**
165104     * Puts values
165105     *
165106     * Puts a key-value pair into the database or multiple key-value pairs.
165107     * If {@link keys} is string then the second parameter value defines the
165108     * value. The second parameter is mandatory if {@link keys} is a string.
165109     * If the key exists the value will be replaced with new value.
165110     *
165111     * @param mixed $keys A string key or an array of key-value pairs
165112     * @param string $value The value in case a string key is used
165113     * @return TokyoTyrant This method returns a reference to the current
165114     *   object and throws TokyoTyrantException on failure.
165115     * @since PECL tokyo_tyrant >= 0.1.0
165116     **/
165117    public function put($keys, $value){}
165118
165119    /**
165120     * Concatenates to a record
165121     *
165122     * Appends a value into existing key or multiple values if {@link keys}
165123     * is an array. The second parameter is mandatory if {@link keys} is a
165124     * string. If the record does not exist a new record is created.
165125     *
165126     * @param mixed $keys A string key or an array of key-value pairs
165127     * @param string $value The value in case a string key is used
165128     * @return TokyoTyrant This method returns a reference to the current
165129     *   object and throws TokyoTyrantException on failure.
165130     * @since PECL tokyo_tyrant >= 0.1.0
165131     **/
165132    public function putCat($keys, $value){}
165133
165134    /**
165135     * Puts a record
165136     *
165137     * Puts a key-value pair into the database or multiple key-value pairs.
165138     * If {@link keys} is string then the second parameter value defines the
165139     * value. The second parameter is mandatory if {@link keys} is a string.
165140     * If the key already exists this method throws an exception indicating
165141     * that the records exists.
165142     *
165143     * @param mixed $keys A string key or an array of key-value pairs
165144     * @param string $value The string value
165145     * @return TokyoTyrant This method returns a reference to the current
165146     *   object and throws TokyoTyrantException on failure.
165147     * @since PECL tokyo_tyrant >= 0.1.0
165148     **/
165149    public function putKeep($keys, $value){}
165150
165151    /**
165152     * Puts value
165153     *
165154     * Puts a key-value pair into the database or multiple key-value pairs.
165155     * If {@link keys} is string then the second parameter value defines the
165156     * value. The second parameter is mandatory if {@link keys} is a string.
165157     * This method does not wait for the response from the server.
165158     *
165159     * @param mixed $keys A string key or an array of key-value pairs
165160     * @param string $value The value in case a string key is used
165161     * @return TokyoTyrant This method returns a reference to the current
165162     *   object and throws TokyoTyrantException on failure.
165163     * @since PECL tokyo_tyrant >= 0.1.0
165164     **/
165165    public function putNr($keys, $value){}
165166
165167    /**
165168     * Concatenates to a record
165169     *
165170     * Concatenate to a record and shift to left.
165171     *
165172     * @param string $key A string key
165173     * @param string $value The value to concatenate
165174     * @param int $width The width of the record
165175     * @return mixed This method returns a reference to the current object
165176     *   and throws TokyoTyrantException on failure.
165177     * @since PECL tokyo_tyrant >= 0.1.0
165178     **/
165179    public function putShl($key, $value, $width){}
165180
165181    /**
165182     * Restore the database
165183     *
165184     * Restore the database from the update log.
165185     *
165186     * @param string $log_dir Directory where the log is
165187     * @param int $timestamp Beginning timestamp with microseconds
165188     * @param bool $check_consistency Whether to check consistency:
165189     *   Default: TRUE
165190     * @return mixed This method returns the current object and throws
165191     *   TokyoTyrantException on failure.
165192     * @since PECL tokyo_tyrant >= 0.1.0
165193     **/
165194    public function restore($log_dir, $timestamp, $check_consistency){}
165195
165196    /**
165197     * Set the replication master
165198     *
165199     * Sets the replication master of the database
165200     *
165201     * @param string $host Hostname of the replication master. If NULL the
165202     *   replication is disabled.
165203     * @param int $port Port of the replication master
165204     * @param int $timestamp Beginning timestamp with microseconds
165205     * @param bool $check_consistency Whether to check consistency.
165206     * @return mixed This method returns the current object and throws
165207     *   TokyoTyrantException on failure.
165208     * @since PECL tokyo_tyrant >= 0.1.0
165209     **/
165210    public function setMaster($host, $port, $timestamp, $check_consistency){}
165211
165212    /**
165213     * Returns the size of the value
165214     *
165215     * Returns the size of a value by key
165216     *
165217     * @param string $key The key of which size to fetch
165218     * @return int Returns the size of the key or throw
165219     *   TokyoTyrantException on error
165220     * @since PECL tokyo_tyrant >= 0.1.0
165221     **/
165222    public function size($key){}
165223
165224    /**
165225     * Get statistics
165226     *
165227     * Returns statistics of the remote database
165228     *
165229     * @return array Returns an array of key value pairs describing the
165230     *   statistics
165231     * @since PECL tokyo_tyrant >= 0.1.0
165232     **/
165233    public function stat(){}
165234
165235    /**
165236     * Synchronize the database
165237     *
165238     * Synchronizes the database on to the physical device
165239     *
165240     * @return mixed This method returns the current object and throws
165241     *   TokyoTyrantException on failure.
165242     * @since PECL tokyo_tyrant >= 0.1.0
165243     **/
165244    public function sync(){}
165245
165246    /**
165247     * Tunes connection values
165248     *
165249     * Tunes database connection options.
165250     *
165251     * @param float $timeout The objects timeout value (default: 5.0)
165252     * @param int $options Bitmask of options to tune. This can be either 0
165253     *   or TokyoTyrant::RDBT_RECON. It is recommended not to change the
165254     *   second parameter.
165255     * @return TokyoTyrant This method returns a reference to the current
165256     *   object and throws TokyoTyrantException on failure.
165257     * @since PECL tokyo_tyrant >= 0.2.0
165258     **/
165259    public function tune($timeout, $options){}
165260
165261    /**
165262     * Empties the database
165263     *
165264     * Empties a remote database
165265     *
165266     * @return mixed This method returns the current object and throws
165267     *   TokyoTyrantException on failure.
165268     * @since PECL tokyo_tyrant >= 0.1.0
165269     **/
165270    public function vanish(){}
165271
165272    /**
165273     * Construct a new TokyoTyrant object
165274     *
165275     * Constructs a new TokyoTyrant object and optionally connects to the
165276     * database
165277     *
165278     * @param string $host The hostname. Default: NULL
165279     * @param int $port port number. Default: 1978
165280     * @param array $options Connection options: timeout (default: 5.0),
165281     *   reconnect (default: TRUE) and persistent (default: TRUE)
165282     * @since PECL tokyo_tyrant >= 0.1.0
165283     **/
165284    public function __construct($host, $port, $options){}
165285
165286}
165287/**
165288 * TokyoTyrantException
165289 **/
165290class tokyotyrantexception extends Exception {
165291    /**
165292     * The exception code. This can be compared to TokyoTyrant::TTE_*
165293     * constants
165294     *
165295     * @var int
165296     **/
165297    protected $code;
165298
165299}
165300/**
165301 * Provides an iterator for TokyoTyrant and TokyoTyrantTable objects. The
165302 * iterator iterates over all keys and values in the database.
165303 * TokyoTyrantIterator was added in version 0.2.0.
165304 **/
165305class TokyoTyrantIterator implements Iterator {
165306    /**
165307     * Get the current value
165308     *
165309     * Returns the current value during iteration.
165310     *
165311     * @return mixed Returns the current value on success and false on
165312     *   failure.
165313     * @since PECL tokyo_tyrant >= 0.2.0
165314     **/
165315    public function current(){}
165316
165317    /**
165318     * Returns the current key
165319     *
165320     * @return mixed Returns the current key on success and false on
165321     *   failure.
165322     * @since PECL tokyo_tyrant >= 0.2.0
165323     **/
165324    public function key(){}
165325
165326    /**
165327     * Move to next key
165328     *
165329     * Move to next key during iteration and return it's value.
165330     *
165331     * @return mixed Returns the next value on success and false on
165332     *   failure.
165333     * @since PECL tokyo_tyrant >= 0.2.0
165334     **/
165335    public function next(){}
165336
165337    /**
165338     * Rewinds the iterator
165339     *
165340     * Rewinds the iterator for new iteration. Called automatically at the
165341     * beginning of foreach.
165342     *
165343     * @return void Throws TokyoTyrantException if iterator initialization
165344     *   fails.
165345     * @since PECL tokyo_tyrant >= 0.2.0
165346     **/
165347    public function rewind(){}
165348
165349    /**
165350     * Rewinds the iterator
165351     *
165352     * Checks whether the internal pointer points to valid element.
165353     *
165354     * @return bool Returns TRUE if the current item is valid and FALSE if
165355     *   not.
165356     * @since PECL tokyo_tyrant >= 0.2.0
165357     **/
165358    public function valid(){}
165359
165360    /**
165361     * Construct an iterator
165362     *
165363     * Construct a new TokyoTyrantIterator object. One connection can have
165364     * multiple iterators but it is not quaranteed that all items are
165365     * traversed in that case. {@link object} parameter can be either an of
165366     * instance TokyoTyrant or TokyoTyrantTable.
165367     *
165368     * @param mixed $object
165369     * @since PECL tokyo_tyrant >= 0.2.0
165370     **/
165371    public function __construct($object){}
165372
165373}
165374/**
165375 * This class is used to query the table databases
165376 **/
165377class TokyoTyrantQuery implements Iterator {
165378    /**
165379     * Adds a condition to the query
165380     *
165381     * Adds a condition to the query. Condition can be something like: get
165382     * all keys which value matches expr.
165383     *
165384     * @param string $name Name of the column in the condition
165385     * @param int $op The operator. One of the TokyoTyrant::RDBQC_*
165386     *   constants
165387     * @param string $expr The expression
165388     * @return mixed This method returns the current object and throws
165389     *   TokyoTyrantException on failure.
165390     * @since PECL tokyo_tyrant >= 0.1.0
165391     **/
165392    public function addCond($name, $op, $expr){}
165393
165394    /**
165395     * Counts records
165396     *
165397     * Returns a count of how many records a query returns.
165398     *
165399     * @return int Returns a count of matching rows and throws
165400     *   TokyoTyrantException on error
165401     **/
165402    public function count(){}
165403
165404    /**
165405     * Returns the current element
165406     *
165407     * Returns the current element. Part of Iterator interface
165408     *
165409     * @return array Returns the current row
165410     * @since PECL tokyo_tyrant >= 0.1.0
165411     **/
165412    public function current(){}
165413
165414    /**
165415     * Get the hint string of the query
165416     *
165417     * Get the hint string of the query. The hint string contains information
165418     * about an executed query and it could be compared to for example MySQL
165419     * EXPLAIN statement.
165420     *
165421     * @return string This method always returns a string
165422     **/
165423    public function hint(){}
165424
165425    /**
165426     * Returns the current key
165427     *
165428     * Returns the current key. Part of the Iterator interface
165429     *
165430     * @return string Returns the current key and throws
165431     *   TokyoTyrantException on error
165432     * @since PECL tokyo_tyrant >= 0.1.0
165433     **/
165434    public function key(){}
165435
165436    /**
165437     * Retrieve records with multiple queries
165438     *
165439     * Executes multiple queries on a database and returns matching records.
165440     * The current object is always the left most object in the search.
165441     *
165442     * @param array $queries Array of TokyoTyrantQuery objects
165443     * @param int $type One of the TokyoTyrant::RDBMS_* constants
165444     * @return array Returns the matching rows and throws
165445     *   TokyoTyrantException on error
165446     **/
165447    public function metaSearch($queries, $type){}
165448
165449    /**
165450     * Moves the iterator to next entry
165451     *
165452     * Returns the next result in the resultset. Part of the Iterator
165453     * interface.
165454     *
165455     * @return array Returns the next row and throws TokyoTyrantException
165456     *   on error.
165457     * @since PECL tokyo_tyrant >= 0.1.0
165458     **/
165459    public function next(){}
165460
165461    /**
165462     * Removes records based on query
165463     *
165464     * Removes all records that match the query. Works exactly like search
165465     * but removes the records instead of returning them.
165466     *
165467     * @return TokyoTyrantQuery This method returns the current object and
165468     *   throws TokyoTyrantException on failure.
165469     * @since PECL tokyo_tyrant >= 0.1.0
165470     **/
165471    public function out(){}
165472
165473    /**
165474     * Rewinds the iterator
165475     *
165476     * Rewind the resultset and executes the query if it has not been
165477     * executed. Part of the Iterator interface.
165478     *
165479     * @return bool Returns TRUE
165480     * @since PECL tokyo_tyrant >= 0.1.0
165481     **/
165482    public function rewind(){}
165483
165484    /**
165485     * Searches records
165486     *
165487     * Executes a search on the table database. Returns an array of arrays
165488     * containing the matching records. In the returned array the first level
165489     * is the primary key of the data and the second level is the row data.
165490     *
165491     * @return array Returns the matching rows and throws
165492     *   TokyoTyrantException on error
165493     * @since PECL tokyo_tyrant >= 0.1.0
165494     **/
165495    public function search(){}
165496
165497    /**
165498     * Limit results
165499     *
165500     * Set the maximum amount of records to return on a query.
165501     *
165502     * @param int $max Maximum amount of records. Default: -1
165503     * @param int $skip How many records to skip from the start. Default:
165504     *   -1
165505     * @return mixed This method returns the current object and throws
165506     *   TokyoTyrantException on failure.
165507     * @since PECL tokyo_tyrant >= 0.1.0
165508     **/
165509    public function setLimit($max, $skip){}
165510
165511    /**
165512     * Orders results
165513     *
165514     * Sets the order of a query
165515     *
165516     * @param string $name The column name to apply the ordering on.
165517     * @param int $type The {@link type} can be one of the following
165518     *   constants:
165519     * @return mixed This method returns the current object.
165520     * @since PECL tokyo_tyrant >= 0.1.0
165521     **/
165522    public function setOrder($name, $type){}
165523
165524    /**
165525     * Checks the validity of current item
165526     *
165527     * Checks if the current item is valid. Part of the Iterator interface
165528     *
165529     * @return bool Returns TRUE if the current item is valid and FALSE if
165530     *   not.
165531     * @since PECL tokyo_tyrant >= 0.1.0
165532     **/
165533    public function valid(){}
165534
165535    /**
165536     * Construct a new query
165537     *
165538     * Construct a new query object
165539     *
165540     * @param TokyoTyrantTable $table TokyoTyrantTable object with active
165541     *   database connection
165542     * @since PECL tokyo_tyrant >= 0.1.0
165543     **/
165544    public function __construct($table){}
165545
165546}
165547/**
165548 * Provides an API to the table databases. A table database can be create
165549 * using the following command: ttserver -port 1979 /tmp/tt_table.tct. In
165550 * Tokyo Tyrant the table API is a schemaless database which can store
165551 * arbitrary amount of key-value pairs under a single primary key.
165552 **/
165553class TokyoTyrantTable extends TokyoTyrant {
165554    /**
165555     * Adds a record
165556     *
165557     * This method is not supported with table databases.
165558     *
165559     * @param string $key The string key
165560     * @param mixed $increment The amount to increment
165561     * @param string $type TokyoTyrant::RDB_RECINT or
165562     *   TokyoTyrant::RDB_RECDBL constant. If this parameter is omitted the
165563     *   type is guessed from the {@link increment} parameters type.
165564     * @return void This method throws an TokyoTyrantException if used
165565     *   through this class.
165566     * @since PECL tokyo_tyrant >= 0.1.0
165567     **/
165568    public function add($key, $increment, $type){}
165569
165570    /**
165571     * Generate unique id
165572     *
165573     * Generates an unique id inside the table database. In table databases
165574     * rows are referenced using a numeric primary key.
165575     *
165576     * @return int Returns an unique id or throws TokyoTyrantException on
165577     *   error
165578     * @since PECL tokyo_tyrant >= 0.1.0
165579     **/
165580    public function genUid(){}
165581
165582    /**
165583     * Get a row
165584     *
165585     * Gets a row from table database. {@link keys} is a single integer for
165586     * the primary key of the row or an array of integers for multiple rows.
165587     *
165588     * @param mixed $keys The primary key, can be a string or an integer
165589     * @return array Returns the row as an array
165590     * @since PECL tokyo_tyrant >= 0.1.0
165591     **/
165592    public function get($keys){}
165593
165594    /**
165595     * Get an iterator
165596     *
165597     * Gets an iterator for iterating all keys / values in the database.
165598     *
165599     * @return TokyoTyrantIterator This method returns TokyoTyrantIterator
165600     *   object and throws TokyoTyrantException on failure.
165601     **/
165602    public function getIterator(){}
165603
165604    /**
165605     * Get a query object
165606     *
165607     * Get a query object to execute searches on the database
165608     *
165609     * @return TokyoTyrantQuery Returns TokyoTyrantQuery on success and
165610     *   throws TokyoTyrantException on error
165611     * @since PECL tokyo_tyrant >= 0.1.0
165612     **/
165613    public function getQuery(){}
165614
165615    /**
165616     * Remove records
165617     *
165618     * Removes records from a table database.
165619     *
165620     * @param mixed $keys A single integer key or an array of integers
165621     * @return void This method returns the current object and throws
165622     *   TokyoTyrantException on failure.
165623     * @since PECL tokyo_tyrant >= 0.1.0
165624     **/
165625    public function out($keys){}
165626
165627    /**
165628     * Store a row
165629     *
165630     * Puts a new row into the database. This method parameters are {@link
165631     * key} which is the primary key of the row, passing NULL will generate a
165632     * new unique id. {@link value} is an array containing the row contents
165633     * which is usually key value pairs.
165634     *
165635     * @param string $key The primary key of the row
165636     * @param array $columns The row contents
165637     * @return int Returns the primary key on success and throws
165638     *   TokyoTyrantException on error
165639     * @since PECL tokyo_tyrant >= 0.1.0
165640     **/
165641    public function put($key, $columns){}
165642
165643    /**
165644     * Concatenates to a row
165645     *
165646     * This method can be used to add new columns to existing records.
165647     * Existing keys will be left unmodified but any new columns will be
165648     * appended to the row. Passing null as key will generate a new row.
165649     *
165650     * @param string $key The primary key of the row or NULL
165651     * @param array $columns Array of row contents
165652     * @return void Returns the primary key and throws TokyoTyrantException
165653     *   on error.
165654     * @since PECL tokyo_tyrant >= 0.1.0
165655     **/
165656    public function putCat($key, $columns){}
165657
165658    /**
165659     * Put a new record
165660     *
165661     * Puts a new record into the database. If the key already exists this
165662     * method throws an exception indicating that the records exists.
165663     *
165664     * @param string $key The primary key of the row or NULL
165665     * @param array $columns Array of the row contents
165666     * @return void Returns the primary key and throws TokyoTyrantException
165667     *   on error.
165668     * @since PECL tokyo_tyrant >= 0.1.0
165669     **/
165670    public function putKeep($key, $columns){}
165671
165672    /**
165673     * Puts value
165674     *
165675     * This method is not supported on table databases. Calling this method
165676     * through TokyoTyrantTable is considered an error and an
165677     * TokyoTyrantException will be thrown.
165678     *
165679     * @param mixed $keys A string key or an array of key-value pairs
165680     * @param string $value The value in case a string key is used
165681     * @return void This method is not supported on table databases.
165682     *   Calling this method through TokyoTyrantTable is considered an error
165683     *   and an TokyoTyrantException will be thrown.
165684     * @since PECL tokyo_tyrant >= 0.1.0
165685     **/
165686    public function putNr($keys, $value){}
165687
165688    /**
165689     * Concatenates to a record
165690     *
165691     * This method is not supported on table databases. Calling this method
165692     * through TokyoTyrantTable is considered an error and an
165693     * TokyoTyrantException will be thrown.
165694     *
165695     * @param string $key A string key
165696     * @param string $value The value to concatenate
165697     * @param int $width The width of the record
165698     * @return void This method is not supported on table databases.
165699     * @since PECL tokyo_tyrant >= 0.1.0
165700     **/
165701    public function putShl($key, $value, $width){}
165702
165703    /**
165704     * Sets index
165705     *
165706     * Sets an index on a specified column. The index type is one of the
165707     * TokyoTyrant::RDBIT_* constants. Passing TokyoTyrant::RDBIT_VOID
165708     * removes the index.
165709     *
165710     * @param string $column The name of the column
165711     * @param int $type The index type
165712     * @return mixed This method returns the current object and throws
165713     *   TokyoTyrantException on failure.
165714     * @since PECL tokyo_tyrant >= 0.1.0
165715     **/
165716    public function setIndex($column, $type){}
165717
165718}
165719class Transliterator {
165720    /**
165721     * @var integer
165722     **/
165723    const FORWARD = 0;
165724
165725    /**
165726     * @var integer
165727     **/
165728    const REVERSE = 0;
165729
165730    /**
165731     * @var mixed
165732     **/
165733    public $id;
165734
165735    /**
165736     * Create a transliterator
165737     *
165738     * Opens a Transliterator by id.
165739     *
165740     * @param string $id The id.
165741     * @param int $direction The direction, defaults to
165742     *   >Transliterator::FORWARD. May also be set to
165743     *   Transliterator::REVERSE.
165744     * @return Transliterator Returns a Transliterator object on success,
165745     *   or NULL on failure.
165746     **/
165747    public static function create($id, $direction){}
165748
165749    /**
165750     * Create transliterator from rules
165751     *
165752     * Creates a Transliterator from rules.
165753     *
165754     * @param string $rules The rules as defined in Transform Rules Syntax
165755     *   of UTS #35: Unicode LDML.
165756     * @param string $direction The direction, defaults to
165757     *   >Transliterator::FORWARD. May also be set to
165758     *   Transliterator::REVERSE.
165759     * @return Transliterator Returns a Transliterator object on success,
165760     *   or NULL on failure.
165761     **/
165762    public static function createFromRules($rules, $direction){}
165763
165764    /**
165765     * Create an inverse transliterator
165766     *
165767     * Opens the inverse transliterator.
165768     *
165769     * @return Transliterator Returns a Transliterator object on success,
165770     *   or NULL on failure
165771     **/
165772    public function createInverse(){}
165773
165774    /**
165775     * Get last error code
165776     *
165777     * Gets the last error code for this transliterator.
165778     *
165779     * @return int The error code on success, or FALSE if none exists, or
165780     *   on failure.
165781     **/
165782    public function getErrorCode(){}
165783
165784    /**
165785     * Get last error message
165786     *
165787     * Gets the last error message for this transliterator.
165788     *
165789     * @return string The error message on success, or FALSE if none
165790     *   exists, or on failure.
165791     **/
165792    public function getErrorMessage(){}
165793
165794    /**
165795     * Get transliterator IDs
165796     *
165797     * Returns an array with the registered transliterator IDs.
165798     *
165799     * @return array An array of registered transliterator IDs on success,
165800     *   .
165801     **/
165802    public static function listIDs(){}
165803
165804    /**
165805     * Transliterate a string
165806     *
165807     * Transforms a string or part thereof using an ICU transliterator.
165808     *
165809     * @param string $subject In the procedural version, either a
165810     *   Transliterator or a string from which a Transliterator can be built.
165811     * @param int $start The string to be transformed.
165812     * @param int $end The start index (in UTF-16 code units) from which
165813     *   the string will start to be transformed, inclusive. Indexing starts
165814     *   at 0. The text before will be left as is.
165815     * @return string The transformed string on success, .
165816     **/
165817    public function transliterate($subject, $start, $end){}
165818
165819}
165820/**
165821 * There are three scenarios where a TypeError may be thrown. The first
165822 * is where the argument type being passed to a function does not match
165823 * its corresponding declared parameter type. The second is where a value
165824 * being returned from a function does not match the declared function
165825 * return type. The third is where an invalid number of arguments are
165826 * passed to a built-in PHP function (strict mode only).
165827 **/
165828class TypeError extends Error {
165829}
165830class UConverter {
165831    /**
165832     * @var integer
165833     **/
165834    const BOCU1 = 0;
165835
165836    /**
165837     * @var integer
165838     **/
165839    const CESU8 = 0;
165840
165841    /**
165842     * @var integer
165843     **/
165844    const DBCS = 0;
165845
165846    /**
165847     * @var integer
165848     **/
165849    const EBCDIC_STATEFUL = 0;
165850
165851    /**
165852     * @var integer
165853     **/
165854    const HZ = 0;
165855
165856    /**
165857     * @var integer
165858     **/
165859    const IMAP_MAILBOX = 0;
165860
165861    /**
165862     * @var integer
165863     **/
165864    const ISCII = 0;
165865
165866    /**
165867     * @var integer
165868     **/
165869    const ISO_2022 = 0;
165870
165871    /**
165872     * @var integer
165873     **/
165874    const LATIN_1 = 0;
165875
165876    /**
165877     * @var integer
165878     **/
165879    const LMBCS_1 = 0;
165880
165881    /**
165882     * @var integer
165883     **/
165884    const LMBCS_2 = 0;
165885
165886    /**
165887     * @var integer
165888     **/
165889    const LMBCS_3 = 0;
165890
165891    /**
165892     * @var integer
165893     **/
165894    const LMBCS_4 = 0;
165895
165896    /**
165897     * @var integer
165898     **/
165899    const LMBCS_5 = 0;
165900
165901    /**
165902     * @var integer
165903     **/
165904    const LMBCS_6 = 0;
165905
165906    /**
165907     * @var integer
165908     **/
165909    const LMBCS_8 = 0;
165910
165911    /**
165912     * @var integer
165913     **/
165914    const LMBCS_11 = 0;
165915
165916    /**
165917     * @var integer
165918     **/
165919    const LMBCS_16 = 0;
165920
165921    /**
165922     * @var integer
165923     **/
165924    const LMBCS_17 = 0;
165925
165926    /**
165927     * @var integer
165928     **/
165929    const LMBCS_18 = 0;
165930
165931    /**
165932     * @var integer
165933     **/
165934    const LMBCS_19 = 0;
165935
165936    /**
165937     * @var integer
165938     **/
165939    const LMBCS_LAST = 0;
165940
165941    /**
165942     * @var integer
165943     **/
165944    const MBCS = 0;
165945
165946    /**
165947     * @var integer
165948     **/
165949    const REASON_CLONE = 0;
165950
165951    /**
165952     * @var integer
165953     **/
165954    const REASON_CLOSE = 0;
165955
165956    /**
165957     * @var integer
165958     **/
165959    const REASON_ILLEGAL = 0;
165960
165961    /**
165962     * @var integer
165963     **/
165964    const REASON_IRREGULAR = 0;
165965
165966    /**
165967     * @var integer
165968     **/
165969    const REASON_RESET = 0;
165970
165971    /**
165972     * @var integer
165973     **/
165974    const REASON_UNASSIGNED = 0;
165975
165976    /**
165977     * @var integer
165978     **/
165979    const SBCS = 0;
165980
165981    /**
165982     * @var integer
165983     **/
165984    const SCSU = 0;
165985
165986    /**
165987     * @var integer
165988     **/
165989    const UNSUPPORTED_CONVERTER = 0;
165990
165991    /**
165992     * @var integer
165993     **/
165994    const US_ASCII = 0;
165995
165996    /**
165997     * @var integer
165998     **/
165999    const UTF7 = 0;
166000
166001    /**
166002     * @var integer
166003     **/
166004    const UTF8 = 0;
166005
166006    /**
166007     * @var integer
166008     **/
166009    const UTF16 = 0;
166010
166011    /**
166012     * @var integer
166013     **/
166014    const UTF16_BigEndian = 0;
166015
166016    /**
166017     * @var integer
166018     **/
166019    const UTF16_LittleEndian = 0;
166020
166021    /**
166022     * @var integer
166023     **/
166024    const UTF32 = 0;
166025
166026    /**
166027     * @var integer
166028     **/
166029    const UTF32_BigEndian = 0;
166030
166031    /**
166032     * @var integer
166033     **/
166034    const UTF32_LittleEndian = 0;
166035
166036    /**
166037     * Convert string from one charset to another
166038     *
166039     * @param string $str
166040     * @param bool $reverse
166041     * @return string
166042     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166043     **/
166044    public function convert($str, $reverse){}
166045
166046    /**
166047     * Default "from" callback function
166048     *
166049     * @param int $reason
166050     * @param string $source
166051     * @param string $codePoint
166052     * @param int $error
166053     * @return mixed
166054     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166055     **/
166056    public function fromUCallback($reason, $source, $codePoint, &$error){}
166057
166058    /**
166059     * Get the aliases of the given name
166060     *
166061     * @param string $name
166062     * @return array
166063     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166064     **/
166065    public static function getAliases($name){}
166066
166067    /**
166068     * Get the available canonical converter names
166069     *
166070     * @return array
166071     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166072     **/
166073    public static function getAvailable(){}
166074
166075    /**
166076     * Get the destination encoding
166077     *
166078     * @return string
166079     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166080     **/
166081    public function getDestinationEncoding(){}
166082
166083    /**
166084     * Get the destination converter type
166085     *
166086     * @return int
166087     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166088     **/
166089    public function getDestinationType(){}
166090
166091    /**
166092     * Get last error code on the object
166093     *
166094     * @return int
166095     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166096     **/
166097    public function getErrorCode(){}
166098
166099    /**
166100     * Get last error message on the object
166101     *
166102     * @return string
166103     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166104     **/
166105    public function getErrorMessage(){}
166106
166107    /**
166108     * Get the source encoding
166109     *
166110     * @return string
166111     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166112     **/
166113    public function getSourceEncoding(){}
166114
166115    /**
166116     * Get the source converter type
166117     *
166118     * @return int
166119     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166120     **/
166121    public function getSourceType(){}
166122
166123    /**
166124     * Get standards associated to converter names
166125     *
166126     * @return array
166127     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166128     **/
166129    public static function getStandards(){}
166130
166131    /**
166132     * Get substitution chars
166133     *
166134     * @return string
166135     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166136     **/
166137    public function getSubstChars(){}
166138
166139    /**
166140     * Get string representation of the callback reason
166141     *
166142     * @param int $reason
166143     * @return string
166144     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166145     **/
166146    public static function reasonText($reason){}
166147
166148    /**
166149     * Set the destination encoding
166150     *
166151     * @param string $encoding
166152     * @return void
166153     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166154     **/
166155    public function setDestinationEncoding($encoding){}
166156
166157    /**
166158     * Set the source encoding
166159     *
166160     * @param string $encoding
166161     * @return void
166162     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166163     **/
166164    public function setSourceEncoding($encoding){}
166165
166166    /**
166167     * Set the substitution chars
166168     *
166169     * @param string $chars
166170     * @return void
166171     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166172     **/
166173    public function setSubstChars($chars){}
166174
166175    /**
166176     * Default "to" callback function
166177     *
166178     * @param int $reason
166179     * @param string $source
166180     * @param string $codeUnits
166181     * @param int $error
166182     * @return mixed
166183     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166184     **/
166185    public function toUCallback($reason, $source, $codeUnits, &$error){}
166186
166187    /**
166188     * Convert string from one charset to another
166189     *
166190     * @param string $str
166191     * @param string $toEncoding
166192     * @param string $fromEncoding
166193     * @param array $options
166194     * @return string
166195     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166196     **/
166197    public static function transcode($str, $toEncoding, $fromEncoding, $options){}
166198
166199    /**
166200     * Create UConverter object
166201     *
166202     * @param string $destination_encoding
166203     * @param string $source_encoding
166204     * @since PHP 5 >= 5.5.0, PHP 7, PECL >= 3.0.0a1
166205     **/
166206    public function __construct($destination_encoding, $source_encoding){}
166207
166208}
166209namespace UI {
166210class Area extends UI\Control {
166211    /**
166212     * Draw Callback
166213     *
166214     * Shall be invoked when this Area requires redrawing
166215     *
166216     * @param UI\Draw\Pen $pen A Pen suitable for drawing in this Area
166217     * @param UI\Size $areaSize The size of the Area
166218     * @param UI\Point $clipPoint The clip point of the Area
166219     * @param UI\Size $clipSize The clip size of the Area
166220     **/
166221    protected function onDraw($pen, $areaSize, $clipPoint, $clipSize){}
166222
166223    /**
166224     * Key Callback
166225     *
166226     * Shall be executed on key events
166227     *
166228     * @param string $key The key pressed
166229     * @param int $ext The extended key pressed
166230     * @param int $flags Event modifiers
166231     **/
166232    protected function onKey($key, $ext, $flags){}
166233
166234    /**
166235     * Mouse Callback
166236     *
166237     * Shall be executed on mouse events
166238     *
166239     * @param UI\Point $areaPoint The co-ordinates of the event
166240     * @param UI\Size $areaSize The size of the area of the event
166241     * @param int $flags Event modifiers
166242     **/
166243    protected function onMouse($areaPoint, $areaSize, $flags){}
166244
166245    /**
166246     * Redraw Area
166247     *
166248     * Requests that this Area is redrawn
166249     **/
166250    public function redraw(){}
166251
166252    /**
166253     * Area Scroll
166254     *
166255     * Scroll this Area
166256     *
166257     * @param UI\Point $point The point to scroll to
166258     * @param UI\Size $size The size of the scroll pane
166259     **/
166260    public function scrollTo($point, $size){}
166261
166262    /**
166263     * Set Size
166264     *
166265     * Sets the size of this Area
166266     *
166267     * @param UI\Size $size The new size
166268     **/
166269    public function setSize($size){}
166270
166271}
166272}
166273namespace UI {
166274final class Control {
166275    /**
166276     * Destroy Control
166277     *
166278     * Shall destroy this Control
166279     **/
166280    public function destroy(){}
166281
166282    /**
166283     * Disable Control
166284     *
166285     * Shall disable this Control
166286     **/
166287    public function disable(){}
166288
166289    /**
166290     * Enable Control
166291     *
166292     * Shall enable this Control
166293     **/
166294    public function enable(){}
166295
166296    /**
166297     * Get Parent Control
166298     *
166299     * Shall return the parent Control
166300     *
166301     * @return UI\Control
166302     **/
166303    public function getParent(){}
166304
166305    /**
166306     * Get Top Level
166307     *
166308     * @return int
166309     **/
166310    public function getTopLevel(){}
166311
166312    /**
166313     * Hide Control
166314     *
166315     * Shall hide this Control
166316     **/
166317    public function hide(){}
166318
166319    /**
166320     * Determine if Control is enabled
166321     *
166322     * Shall detect if this Control is enabled
166323     *
166324     * @return bool
166325     **/
166326    public function isEnabled(){}
166327
166328    /**
166329     * Determine if Control is visible
166330     *
166331     * Shall detect if this Control is visible
166332     *
166333     * @return bool
166334     **/
166335    public function isVisible(){}
166336
166337    /**
166338     * Set Parent Control
166339     *
166340     * Shall set the parent Control of this Control
166341     *
166342     * @param UI\Control $parent The parent Control
166343     **/
166344    public function setParent($parent){}
166345
166346    /**
166347     * Control Show
166348     *
166349     * Shall show this Control
166350     **/
166351    public function show(){}
166352
166353}
166354}
166355namespace UI\Controls {
166356class Box extends UI\Control {
166357    /**
166358     * @var mixed
166359     **/
166360    protected $controls;
166361
166362    /**
166363     * Append Control
166364     *
166365     * Shall append the given control to this Box
166366     *
166367     * @param Control $control The control to append
166368     * @param bool $stretchy Set true to stretch the control
166369     * @return int Shall return the index of the appended control, may be 0
166370     **/
166371    public function append($control, $stretchy){}
166372
166373    /**
166374     * Delete Control
166375     *
166376     * Shall delete the control at the given index from this Box
166377     *
166378     * @param int $index The index of the control to delete
166379     * @return bool Indication of success
166380     **/
166381    public function delete($index){}
166382
166383    /**
166384     * Get Orientation
166385     *
166386     * Shall retrieve the orientation of this Box
166387     *
166388     * @return int
166389     **/
166390    public function getOrientation(){}
166391
166392    /**
166393     * Padding Detection
166394     *
166395     * Shall detect if padding is enabled on this Box
166396     *
166397     * @return bool
166398     **/
166399    public function isPadded(){}
166400
166401    /**
166402     * Set Padding
166403     *
166404     * Shall enable or disable padding on this Box
166405     *
166406     * @param bool $padded
166407     **/
166408    public function setPadded($padded){}
166409
166410}
166411}
166412namespace UI\Controls {
166413class Button extends UI\Control {
166414    /**
166415     * Get Text
166416     *
166417     * Shall retrieve the text (label) for this Button
166418     *
166419     * @return string The current text (label)
166420     **/
166421    public function getText(){}
166422
166423    /**
166424     * Click Handler
166425     *
166426     * Shall be executed when this Button is clicked
166427     **/
166428    protected function onClick(){}
166429
166430    /**
166431     * Set Text
166432     *
166433     * Shall set the text (label) for this Button
166434     *
166435     * @param string $text The new text (label)
166436     **/
166437    public function setText($text){}
166438
166439}
166440}
166441namespace UI\Controls {
166442class Check extends UI\Control {
166443    /**
166444     * Get Text
166445     *
166446     * Shall return the text (label) for this Check
166447     *
166448     * @return string The current text (label)
166449     **/
166450    public function getText(){}
166451
166452    /**
166453     * Checked Detection
166454     *
166455     * Shall detect the status of this Check
166456     *
166457     * @return bool
166458     **/
166459    public function isChecked(){}
166460
166461    /**
166462     * Toggle Callback
166463     *
166464     * Shall be executed when the status of this Check is changed
166465     **/
166466    protected function onToggle(){}
166467
166468    /**
166469     * Set Checked
166470     *
166471     * Shall change the status of this Check
166472     *
166473     * @param bool $checked The new status
166474     **/
166475    public function setChecked($checked){}
166476
166477    /**
166478     * Set Text
166479     *
166480     * Shall set the text (label) for this Check
166481     *
166482     * @param string $text The new text (label)
166483     **/
166484    public function setText($text){}
166485
166486}
166487}
166488namespace UI\Controls {
166489class ColorButton extends UI\Control {
166490    /**
166491     * Get Color
166492     *
166493     * Shall retrieve the currently selected Color
166494     *
166495     * @return UI\Color
166496     **/
166497    public function getColor(){}
166498
166499    /**
166500     * Change Handler
166501     *
166502     * Shall be executed when the selected Color is changed
166503     **/
166504    protected function onChange(){}
166505
166506    /**
166507     * Set Color
166508     *
166509     * Shall set the currently selected Color
166510     *
166511     * @param UI\Draw\Color $color The new color
166512     **/
166513    public function setColor($color){}
166514
166515}
166516}
166517namespace UI\Controls {
166518class Combo extends UI\Control {
166519    /**
166520     * Append Option
166521     *
166522     * Append an option to this Combo
166523     *
166524     * @param string $text The text for the new option
166525     **/
166526    public function append($text){}
166527
166528    /**
166529     * Get Selected Option
166530     *
166531     * Shall retrieve the index of the option selected in this Combo
166532     *
166533     * @return int
166534     **/
166535    public function getSelected(){}
166536
166537    /**
166538     * Selected Handler
166539     *
166540     * Shall be executed when an option is selected in this Combo
166541     **/
166542    protected function onSelected(){}
166543
166544    /**
166545     * Set Selected Option
166546     *
166547     * Shall set the currently selected option in this Combo
166548     *
166549     * @param int $index The index of the option to select
166550     **/
166551    public function setSelected($index){}
166552
166553}
166554}
166555namespace UI\Controls {
166556class EditableCombo extends UI\Control {
166557    /**
166558     * Append Option
166559     *
166560     * Shall append a new option to this Editable Combo
166561     *
166562     * @param string $text The text for the new option
166563     **/
166564    public function append($text){}
166565
166566    /**
166567     * Get Text
166568     *
166569     * Get the value of the currently selected option in this Editable Combo
166570     *
166571     * @return string
166572     **/
166573    public function getText(){}
166574
166575    /**
166576     * Change Handler
166577     *
166578     * Shall be executed when the value of this Editable Combobox changes
166579     **/
166580    protected function onChange(){}
166581
166582    /**
166583     * Set Text
166584     *
166585     * Shall set the text of the currently selected option in this Editable
166586     * Combo
166587     *
166588     * @param string $text The new text
166589     **/
166590    public function setText($text){}
166591
166592}
166593}
166594namespace UI\Controls {
166595class Entry extends UI\Control {
166596    /**
166597     * Get Text
166598     *
166599     * Shall return the current text from this Entry
166600     *
166601     * @return string The current text
166602     **/
166603    public function getText(){}
166604
166605    /**
166606     * Detect Read Only
166607     *
166608     * Shall detect if this Entry is read only
166609     *
166610     * @return bool
166611     **/
166612    public function isReadOnly(){}
166613
166614    /**
166615     * Change Handler
166616     *
166617     * Shall be executed when the text in this Entry changes
166618     **/
166619    protected function onChange(){}
166620
166621    /**
166622     * Set Read Only
166623     *
166624     * Shall enable or disable read only for this Entry
166625     *
166626     * @param bool $readOnly
166627     **/
166628    public function setReadOnly($readOnly){}
166629
166630    /**
166631     * Set Text
166632     *
166633     * Shall set the text for this Entry
166634     *
166635     * @param string $text The new text
166636     **/
166637    public function setText($text){}
166638
166639}
166640}
166641namespace UI\Controls {
166642class Form extends UI\Control {
166643    /**
166644     * @var mixed
166645     **/
166646    protected $controls;
166647
166648    /**
166649     * Append Control
166650     *
166651     * Shall append the control to the form, and set the label
166652     *
166653     * @param string $label The text for the label
166654     * @param UI\Control $control A control
166655     * @param bool $stretchy Should be set true to stretch the control
166656     * @return int Shall return the index of the appended control, may be 0
166657     **/
166658    public function append($label, $control, $stretchy){}
166659
166660    /**
166661     * Delete Control
166662     *
166663     * Shall delete the control at the given index in this Form
166664     *
166665     * @param int $index The index of the control to remove
166666     * @return bool Indication of succcess
166667     **/
166668    public function delete($index){}
166669
166670    /**
166671     * Padding Detection
166672     *
166673     * Shall detect if padding is enabled on this Form
166674     *
166675     * @return bool
166676     **/
166677    public function isPadded(){}
166678
166679    /**
166680     * Set Padding
166681     *
166682     * Shall enable or disable padding on this Form
166683     *
166684     * @param bool $padded
166685     **/
166686    public function setPadded($padded){}
166687
166688}
166689}
166690namespace UI\Controls {
166691class Grid extends UI\Control {
166692    /**
166693     * @var mixed
166694     **/
166695    protected $controls;
166696
166697    /**
166698     * Append Control
166699     *
166700     * @param UI\Control $control The Control to append
166701     * @param int $left
166702     * @param int $top
166703     * @param int $xspan
166704     * @param int $yspan
166705     * @param bool $hexpand
166706     * @param int $halign
166707     * @param bool $vexpand
166708     * @param int $valign
166709     **/
166710    public function append($control, $left, $top, $xspan, $yspan, $hexpand, $halign, $vexpand, $valign){}
166711
166712    /**
166713     * Padding Detection
166714     *
166715     * Shall detect if padding is enabled on this Grid
166716     *
166717     * @return bool
166718     **/
166719    public function isPadded(){}
166720
166721    /**
166722     * Set Padding
166723     *
166724     * Shall enable or disable padding for this Grid
166725     *
166726     * @param bool $padding
166727     **/
166728    public function setPadded($padding){}
166729
166730}
166731}
166732namespace UI\Controls {
166733class Group extends UI\Control {
166734    /**
166735     * @var mixed
166736     **/
166737    protected $controls;
166738
166739    /**
166740     * Append Control
166741     *
166742     * Shall append a control to this Group
166743     *
166744     * @param UI\Control $control The control to append
166745     **/
166746    public function append($control){}
166747
166748    /**
166749     * Get Title
166750     *
166751     * Shall return the current title for this Group
166752     *
166753     * @return string The current title
166754     **/
166755    public function getTitle(){}
166756
166757    /**
166758     * Margin Detection
166759     *
166760     * Shall detect if this Group has a margin
166761     *
166762     * @return bool
166763     **/
166764    public function hasMargin(){}
166765
166766    /**
166767     * Set Margin
166768     *
166769     * Shall enable or disable margins for this Group
166770     *
166771     * @param bool $margin
166772     **/
166773    public function setMargin($margin){}
166774
166775    /**
166776     * Set Title
166777     *
166778     * Shall set the title for this Group
166779     *
166780     * @param string $title The text for the new title
166781     **/
166782    public function setTitle($title){}
166783
166784}
166785}
166786namespace UI\Controls {
166787class Label extends UI\Control {
166788    /**
166789     * Get Text
166790     *
166791     * Shall return the current text for this Label
166792     *
166793     * @return string
166794     **/
166795    public function getText(){}
166796
166797    /**
166798     * Set Text
166799     *
166800     * Shall set the text for this Label
166801     *
166802     * @param string $text The new text
166803     **/
166804    public function setText($text){}
166805
166806}
166807}
166808namespace UI\Controls {
166809class MultilineEntry extends UI\Control {
166810    /**
166811     * Append Text
166812     *
166813     * Shall append the given text to the text in this Multiline Entry
166814     *
166815     * @param string $text The text to append
166816     **/
166817    public function append($text){}
166818
166819    /**
166820     * Get Text
166821     *
166822     * Shall return the text in this Multiline Entry
166823     *
166824     * @return string
166825     **/
166826    public function getText(){}
166827
166828    /**
166829     * Read Only Detection
166830     *
166831     * Shall detect if this Multiline Entry is read only
166832     *
166833     * @return bool
166834     **/
166835    public function isReadOnly(){}
166836
166837    /**
166838     * Change Handler
166839     *
166840     * Shall be executed when the text in this Multiline Entry is changed
166841     **/
166842    protected function onChange(){}
166843
166844    /**
166845     * Set Read Only
166846     *
166847     * Shall enable or disable read only on this Multiline Entry
166848     *
166849     * @param bool $readOnly
166850     **/
166851    public function setReadOnly($readOnly){}
166852
166853    /**
166854     * Set Text
166855     *
166856     * Shall set the text in this Multiline Entry
166857     *
166858     * @param string $text The new text
166859     **/
166860    public function setText($text){}
166861
166862}
166863}
166864namespace UI\Controls {
166865class Picker extends UI\Control {
166866}
166867}
166868namespace UI\Controls {
166869class Progress extends UI\Control {
166870    /**
166871     * Get Value
166872     *
166873     * Shall retrieve the current value of this Progress bar
166874     *
166875     * @return int
166876     **/
166877    public function getValue(){}
166878
166879    /**
166880     * Set Value
166881     *
166882     * Shall set the value for this Progress bar
166883     *
166884     * @param int $value An integer between 0 and 100 (inclusive)
166885     **/
166886    public function setValue($value){}
166887
166888}
166889}
166890namespace UI\Controls {
166891class Radio extends UI\Control {
166892    /**
166893     * Append Option
166894     *
166895     * Shall append a new option to this Radio
166896     *
166897     * @param string $text The text (label) for the option
166898     **/
166899    public function append($text){}
166900
166901    /**
166902     * Get Selected Option
166903     *
166904     * Shall retrieve the index of the currently selected option in this
166905     * Radio
166906     *
166907     * @return int
166908     **/
166909    public function getSelected(){}
166910
166911    /**
166912     * Selected Handler
166913     *
166914     * Shall be executed when the option selected in this Radio changes
166915     **/
166916    protected function onSelected(){}
166917
166918    /**
166919     * Set Selected Option
166920     *
166921     * Shall set the currently selected option in this Radio
166922     *
166923     * @param int $index The index of the option to select
166924     **/
166925    public function setSelected($index){}
166926
166927}
166928}
166929namespace UI\Controls {
166930class Separator extends UI\Control {
166931}
166932}
166933namespace UI\Controls {
166934class Slider extends UI\Control {
166935    /**
166936     * Get Value
166937     *
166938     * Get the value from this Slider
166939     *
166940     * @return int
166941     **/
166942    public function getValue(){}
166943
166944    /**
166945     * Change Handler
166946     *
166947     * Shall be executed when the value of this Slider changes
166948     **/
166949    protected function onChange(){}
166950
166951    /**
166952     * Set Value
166953     *
166954     * Shall set the value for this Slider
166955     *
166956     * @param int $value The new value
166957     **/
166958    public function setValue($value){}
166959
166960}
166961}
166962namespace UI\Controls {
166963class Spin extends UI\Control {
166964    /**
166965     * Get Value
166966     *
166967     * Get the value in this Spin
166968     *
166969     * @return int
166970     **/
166971    public function getValue(){}
166972
166973    /**
166974     * Change Handler
166975     *
166976     * Shall be executed when the value in this Spin changes
166977     **/
166978    protected function onChange(){}
166979
166980    /**
166981     * Set Value
166982     *
166983     * Set the value in this Spin
166984     *
166985     * @param int $value The new value
166986     **/
166987    public function setValue($value){}
166988
166989}
166990}
166991namespace UI\Controls {
166992class Tab extends UI\Control {
166993    /**
166994     * @var mixed
166995     **/
166996    protected $controls;
166997
166998    /**
166999     * Append Page
167000     *
167001     * Append a new page to this Tab
167002     *
167003     * @param string $name The name for the new page
167004     * @param UI\Control $control The control for the new page
167005     * @return int Shall return the index of the appended control, may be 0
167006     **/
167007    public function append($name, $control){}
167008
167009    /**
167010     * Delete Page
167011     *
167012     * Shall remove the selected page from this Tab
167013     *
167014     * @param int $index The index of the page to remove
167015     * @return bool Indication of success
167016     **/
167017    public function delete($index){}
167018
167019    /**
167020     * Margin Detection
167021     *
167022     * Shall detect if the given page has a margin.
167023     *
167024     * @param int $page The index of the page
167025     * @return bool
167026     **/
167027    public function hasMargin($page){}
167028
167029    /**
167030     * Insert Page
167031     *
167032     * Shall insert a new page into this Tab
167033     *
167034     * @param string $name The name for the new page
167035     * @param int $page The index to perform the insertion before
167036     * @param UI\Control $control The control for the new page
167037     **/
167038    public function insertAt($name, $page, $control){}
167039
167040    /**
167041     * Page Count
167042     *
167043     * Shall return the number of pages in this Tab
167044     *
167045     * @return int The number of pages in this Tab
167046     **/
167047    public function pages(){}
167048
167049    /**
167050     * Set Margin
167051     *
167052     * Shall enable or disable margins on the selected page
167053     *
167054     * @param int $page The page to select
167055     * @param bool $margin Margin switch
167056     **/
167057    public function setMargin($page, $margin){}
167058
167059}
167060}
167061namespace UI\Draw {
167062class Brush {
167063    /**
167064     * Get Color
167065     *
167066     * Shall return a UI\Draw\Color for this brush
167067     *
167068     * @return UI\Draw\Color The current color of the brush
167069     **/
167070    public function getColor(){}
167071
167072    /**
167073     * Set Color
167074     *
167075     * Shall set the color of this brush to the color provided
167076     *
167077     * @param UI\Draw\Color $color Can be a UI\Draw\Color or RRGGBBAA
167078     * @return void
167079     **/
167080    public function setColor($color){}
167081
167082}
167083}
167084namespace UI\Draw\Brush {
167085abstract class Gradient extends UI\Draw\Brush {
167086    /**
167087     * Stop Manipulation
167088     *
167089     * Shall at a stop of the given color at the given position
167090     *
167091     * @param float $position The position for the new stop
167092     * @param UI\Draw\Color $color The color for the new stop, may be
167093     *   UI\Draw\Color or RRGGBBAA
167094     * @return int Total number of stops
167095     **/
167096    public function addStop($position, $color){}
167097
167098    /**
167099     * Stop Manipulation
167100     *
167101     * @param int $index
167102     * @return int Total number of stops
167103     **/
167104    public function delStop($index){}
167105
167106    /**
167107     * Stop Manipulation
167108     *
167109     * @param int $index The index of the stop to set
167110     * @param float $position The position for the stop
167111     * @param UI\Draw\Color $color The color for the stop, may be
167112     *   UI\Draw\Color or RRGGBBAA
167113     * @return bool Indication of success
167114     **/
167115    public function setStop($index, $position, $color){}
167116
167117}
167118}
167119namespace UI\Draw\Brush {
167120class LinearGradient extends UI\Draw\Brush\Gradient {
167121}
167122}
167123namespace UI\Draw\Brush {
167124class RadialGradient extends UI\Draw\Brush\Gradient {
167125}
167126}
167127namespace UI\Draw {
167128class Color {
167129    /**
167130     * @var mixed
167131     **/
167132    public $a;
167133
167134    /**
167135     * @var mixed
167136     **/
167137    public $b;
167138
167139    /**
167140     * @var mixed
167141     **/
167142    public $g;
167143
167144    /**
167145     * @var mixed
167146     **/
167147    public $r;
167148
167149    /**
167150     * Color Manipulation
167151     *
167152     * Shall retrieve the value for a channel
167153     *
167154     * @param int $channel Constant channel identity
167155     * @return float The current value of the requested channel
167156     **/
167157    public function getChannel($channel){}
167158
167159    /**
167160     * Color Manipulation
167161     *
167162     * Shall set the selected channel to the given value
167163     *
167164     * @param int $channel Constant channel identity
167165     * @param float $value The new value for the selected channel
167166     * @return void
167167     **/
167168    public function setChannel($channel, $value){}
167169
167170}
167171}
167172namespace UI\Draw\Line {
167173final class Cap {
167174}
167175}
167176namespace UI\Draw\Line {
167177final class Join {
167178}
167179}
167180namespace UI\Draw {
167181class Matrix {
167182    /**
167183     * Invert Matrix
167184     *
167185     * Shall invert this matrix
167186     **/
167187    public function invert(){}
167188
167189    /**
167190     * Invertible Detection
167191     *
167192     * Shall detect if this Matrix may be inverted
167193     *
167194     * @return bool
167195     **/
167196    public function isInvertible(){}
167197
167198    /**
167199     * Multiply Matrix
167200     *
167201     * Shall multiply this matrix with the given matrix
167202     *
167203     * @param UI\Draw\Matrix $matrix
167204     * @return UI\Draw\Matrix The new Matrix
167205     **/
167206    public function multiply($matrix){}
167207
167208    /**
167209     * Rotate Matrix
167210     *
167211     * Shall rotate this Matrix
167212     *
167213     * @param UI\Point $point
167214     * @param float $amount
167215     **/
167216    public function rotate($point, $amount){}
167217
167218    /**
167219     * Scale Matrix
167220     *
167221     * Shall scale this Matrix
167222     *
167223     * @param UI\Point $center
167224     * @param UI\Point $point
167225     **/
167226    public function scale($center, $point){}
167227
167228    /**
167229     * Skew Matrix
167230     *
167231     * Shall skew this Matrix
167232     *
167233     * @param UI\Point $point
167234     * @param UI\Point $amount
167235     **/
167236    public function skew($point, $amount){}
167237
167238    /**
167239     * Translate Matrix
167240     *
167241     * Shall translate this Matrix
167242     *
167243     * @param UI\Point $point
167244     **/
167245    public function translate($point){}
167246
167247}
167248}
167249namespace UI\Draw {
167250class Path {
167251    /**
167252     * Draw a Rectangle
167253     *
167254     * Shall map the path of a rectangle of the given size, at the given
167255     * point
167256     *
167257     * @param UI\Point $point The point to begin the shape
167258     * @param UI\Size $size The size of the rectangle
167259     **/
167260    public function addRectangle($point, $size){}
167261
167262    /**
167263     * Draw an Arc
167264     *
167265     * Shall map the path for an arc
167266     *
167267     * @param UI\Point $point The point to begin mapping
167268     * @param float $radius The radius of the arc
167269     * @param float $angle The angle of the arc
167270     * @param float $sweep The sweep of the arc
167271     * @param float $negative
167272     **/
167273    public function arcTo($point, $radius, $angle, $sweep, $negative){}
167274
167275    /**
167276     * Draw Bezier Curve
167277     *
167278     * Shall draw a bezier curve
167279     *
167280     * @param UI\Point $point The point at which to begin mapping
167281     * @param float $radius The radius of the curve
167282     * @param float $angle The angle of the curve
167283     * @param float $sweep The sweep of the curve
167284     * @param float $negative
167285     **/
167286    public function bezierTo($point, $radius, $angle, $sweep, $negative){}
167287
167288    /**
167289     * Close Figure
167290     *
167291     * Shall close the current figure
167292     **/
167293    public function closeFigure(){}
167294
167295    /**
167296     * Finalize Path
167297     *
167298     * Shall finalize this Path
167299     **/
167300    public function end(){}
167301
167302    /**
167303     * Draw a Line
167304     *
167305     * Shall map the path for a line
167306     *
167307     * @param UI\Point $point The point to begin mapping
167308     * @param float $radius
167309     * @param float $angle
167310     * @param float $sweep
167311     * @param float $negative
167312     **/
167313    public function lineTo($point, $radius, $angle, $sweep, $negative){}
167314
167315    /**
167316     * Draw Figure
167317     *
167318     * Shall map a new figure at the given point
167319     *
167320     * @param UI\Point $point The point to begin mapping
167321     **/
167322    public function newFigure($point){}
167323
167324    /**
167325     * Draw Figure with Arc
167326     *
167327     * @param UI\Point $point
167328     * @param float $radius
167329     * @param float $angle
167330     * @param float $sweep
167331     * @param float $negative
167332     **/
167333    public function newFigureWithArc($point, $radius, $angle, $sweep, $negative){}
167334
167335}
167336}
167337namespace UI\Draw {
167338final class Pen {
167339    /**
167340     * Clip a Path
167341     *
167342     * Shall clip the given Path
167343     *
167344     * @param UI\Draw\Path $path The path to clip
167345     **/
167346    public function clip($path){}
167347
167348    /**
167349     * Fill a Path
167350     *
167351     * Shall fill the given path
167352     *
167353     * @param UI\Draw\Path $path The path to fill
167354     * @param UI\Draw\Brush $with The color or brush to fill with
167355     **/
167356    public function fill($path, $with){}
167357
167358    /**
167359     * Restore
167360     *
167361     * Shall restore a previously saved Pen
167362     **/
167363    public function restore(){}
167364
167365    /**
167366     * Save
167367     *
167368     * Shall save the Pen
167369     **/
167370    public function save(){}
167371
167372    /**
167373     * Stroke a Path
167374     *
167375     * Shall stroke the given path
167376     *
167377     * @param UI\Draw\Path $path The path to stroke
167378     * @param UI\Draw\Brush $with The color or brush to stroke with
167379     * @param UI\Draw\Stroke $stroke The configuration of the stroke
167380     **/
167381    public function stroke($path, $with, $stroke){}
167382
167383    /**
167384     * Matrix Transform
167385     *
167386     * Shall perform matrix transformation
167387     *
167388     * @param UI\Draw\Matrix $matrix The matrix to use
167389     **/
167390    public function transform($matrix){}
167391
167392    /**
167393     * Draw Text at Point
167394     *
167395     * Shall draw the given text layout at the given point
167396     *
167397     * @param UI\Point $point The point to perform the drawing
167398     * @param UI\Draw\Text\Layout $layout The layout of the text to draw
167399     **/
167400    public function write($point, $layout){}
167401
167402}
167403}
167404namespace UI\Draw {
167405class Stroke {
167406    /**
167407     * Get Line Cap
167408     *
167409     * Shall retrieve the line cap setting of this Stroke
167410     *
167411     * @return int UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or
167412     *   UI\Draw\Line\Cap::Square
167413     **/
167414    public function getCap(){}
167415
167416    /**
167417     * Get Line Join
167418     *
167419     * Shall retrieve the line join setting of this Stroke
167420     *
167421     * @return int UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or
167422     *   UI\Draw\Line\Join::Bevel
167423     **/
167424    public function getJoin(){}
167425
167426    /**
167427     * Get Miter Limit
167428     *
167429     * Shall retrieve the miter limit of this Stroke
167430     *
167431     * @return float The current miter limit
167432     **/
167433    public function getMiterLimit(){}
167434
167435    /**
167436     * Get Thickness
167437     *
167438     * Shall retrieve the thickness of this Stroke
167439     *
167440     * @return float The current thickness
167441     **/
167442    public function getThickness(){}
167443
167444    /**
167445     * Set Line Cap
167446     *
167447     * Shall set the line cap setting for this Stroke
167448     *
167449     * @param int $cap UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or
167450     *   UI\Draw\Line\Cap::Square
167451     **/
167452    public function setCap($cap){}
167453
167454    /**
167455     * Set Line Join
167456     *
167457     * Shall set the line join setting for this Stroke
167458     *
167459     * @param int $join UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round,
167460     *   or UI\Draw\Line\Join::Bevel
167461     **/
167462    public function setJoin($join){}
167463
167464    /**
167465     * Set Miter Limit
167466     *
167467     * Set the miter limit for this Stroke
167468     *
167469     * @param float $limit The new limit
167470     **/
167471    public function setMiterLimit($limit){}
167472
167473    /**
167474     * Set Thickness
167475     *
167476     * Shall set the thickness for this Stroke
167477     *
167478     * @param float $thickness The new thickness
167479     **/
167480    public function setThickness($thickness){}
167481
167482}
167483}
167484namespace UI\Draw\Text {
167485class Font {
167486    /**
167487     * Font Metrics
167488     *
167489     * @return float
167490     **/
167491    public function getAscent(){}
167492
167493    /**
167494     * Font Metrics
167495     *
167496     * @return float
167497     **/
167498    public function getDescent(){}
167499
167500    /**
167501     * Font Metrics
167502     *
167503     * @return float
167504     **/
167505    public function getLeading(){}
167506
167507    /**
167508     * Font Metrics
167509     *
167510     * @return float
167511     **/
167512    public function getUnderlinePosition(){}
167513
167514    /**
167515     * Font Metrics
167516     *
167517     * @return float
167518     **/
167519    public function getUnderlineThickness(){}
167520
167521}
167522}
167523namespace UI\Draw\Text\Font {
167524class Descriptor {
167525    /**
167526     * Get Font Family
167527     *
167528     * Shall return the requested font family
167529     *
167530     * @return string
167531     **/
167532    public function getFamily(){}
167533
167534    /**
167535     * Style Detection
167536     *
167537     * Shall return constant setting
167538     *
167539     * @return int
167540     **/
167541    public function getItalic(){}
167542
167543    /**
167544     * Size Detection
167545     *
167546     * Shall return the requested size
167547     *
167548     * @return float
167549     **/
167550    public function getSize(){}
167551
167552    /**
167553     * Style Detection
167554     *
167555     * Shall return requested stretch
167556     *
167557     * @return int
167558     **/
167559    public function getStretch(){}
167560
167561    /**
167562     * Weight Detection
167563     *
167564     * Shall return requested weight
167565     *
167566     * @return int
167567     **/
167568    public function getWeight(){}
167569
167570}
167571}
167572namespace UI\Draw\Text\Font {
167573final class Italic {
167574}
167575}
167576namespace UI\Draw\Text\Font {
167577final class Stretch {
167578}
167579}
167580namespace UI\Draw\Text\Font {
167581final class Weight {
167582}
167583}
167584namespace UI\Draw\Text {
167585class Layout {
167586    /**
167587     * Set Color
167588     *
167589     * Shall set the Color for all of, or a range of the text in the Layout
167590     *
167591     * @param UI\Draw\Color $color The color to use
167592     * @param int $start The starting character
167593     * @param int $end The ending character, by default the end of the
167594     *   string
167595     **/
167596    public function setColor($color, $start, $end){}
167597
167598    /**
167599     * Set Width
167600     *
167601     * Shall set the width of this Text Layout
167602     *
167603     * @param float $width The new width
167604     **/
167605    public function setWidth($width){}
167606
167607}
167608}
167609namespace UI\Exception {
167610class InvalidArgumentException extends InvalidArgumentException implements Throwable {
167611}
167612}
167613namespace UI\Exception {
167614class RuntimeException extends RuntimeException implements Throwable {
167615}
167616}
167617namespace UI {
167618abstract class Executor {
167619    /**
167620     * Stop Executor
167621     *
167622     * Shall stop an executor, the executor cannot be restarted
167623     *
167624     * @return void
167625     **/
167626    public function kill(){}
167627
167628    /**
167629     * Execution Callback
167630     *
167631     * Shall be repetitively queued for execution in the main thread
167632     *
167633     * @return void
167634     **/
167635    abstract protected function onExecute();
167636
167637    /**
167638     * Interval Manipulation
167639     *
167640     * Shall set the new interval. An interval of 0 will pause the executor
167641     * until a new interval has been set
167642     *
167643     * @param int $microseconds
167644     * @return bool Indication of success
167645     **/
167646    public function setInterval($microseconds){}
167647
167648}
167649}
167650namespace UI {
167651final class Key {
167652}
167653}
167654namespace UI {
167655class Menu {
167656    /**
167657     * Append Menu Item
167658     *
167659     * Shall append a new Menu Item
167660     *
167661     * @param string $name The name (text) for the new item
167662     * @param string $type The type for the new item
167663     * @return UI\MenuItem A constructed object of the given type
167664     **/
167665    public function append($name, $type){}
167666
167667    /**
167668     * Append About Menu Item
167669     *
167670     * Shall append an About menu item
167671     *
167672     * @param string $type The type for the new item
167673     * @return UI\MenuItem A constructed About menu item of the given type
167674     **/
167675    public function appendAbout($type){}
167676
167677    /**
167678     * Append Checkable Menu Item
167679     *
167680     * Shall append a checkable menu item
167681     *
167682     * @param string $name The name (text) for the new item
167683     * @param string $type The type for the new item
167684     * @return UI\MenuItem A constructed checkable menu item of the given
167685     *   type
167686     **/
167687    public function appendCheck($name, $type){}
167688
167689    /**
167690     * Append Preferences Menu Item
167691     *
167692     * Shall append a Preferences menu item
167693     *
167694     * @param string $type The type for the new item
167695     * @return UI\MenuItem A constructed Preferences menu item of the given
167696     *   type
167697     **/
167698    public function appendPreferences($type){}
167699
167700    /**
167701     * Append Quit Menu Item
167702     *
167703     * Shall append a Quit menu item
167704     *
167705     * @param string $type The type for the new item
167706     * @return UI\MenuItem A constructed Quit menu item of the given type
167707     **/
167708    public function appendQuit($type){}
167709
167710    /**
167711     * Append Menu Item Separator
167712     *
167713     * Shall append a separator
167714     **/
167715    public function appendSeparator(){}
167716
167717}
167718}
167719namespace UI {
167720class MenuItem {
167721    /**
167722     * Disable Menu Item
167723     *
167724     * Shall disable this Menu Item
167725     **/
167726    public function disable(){}
167727
167728    /**
167729     * Enable Menu Item
167730     *
167731     * Shall enable this Menu Item
167732     **/
167733    public function enable(){}
167734
167735    /**
167736     * Detect Checked
167737     *
167738     * Shall detect if this Menu Item is checked
167739     *
167740     * @return bool
167741     **/
167742    public function isChecked(){}
167743
167744    /**
167745     * On Click Callback
167746     *
167747     * Shall be executed when this Menu Item is clicked
167748     **/
167749    protected function onClick(){}
167750
167751    /**
167752     * Set Checked
167753     *
167754     * Shall set the checked status of this Menu Item
167755     *
167756     * @param bool $checked The new status
167757     **/
167758    public function setChecked($checked){}
167759
167760}
167761}
167762namespace UI {
167763final class Point {
167764    /**
167765     * @var mixed
167766     **/
167767    public $x;
167768
167769    /**
167770     * @var mixed
167771     **/
167772    public $y;
167773
167774    /**
167775     * Size Coercion
167776     *
167777     * Shall return a UI\Point object where x and y are equal to those
167778     * supplied, either in float or UI\Size form
167779     *
167780     * @param float $point The value for x and y
167781     * @return UI\Point The resulting Point
167782     **/
167783    public static function at($point){}
167784
167785    /**
167786     * Retrieves X
167787     *
167788     * Retrieves the X co-ordinate
167789     *
167790     * @return float The current X co-ordinate
167791     **/
167792    public function getX(){}
167793
167794    /**
167795     * Retrieves Y
167796     *
167797     * Retrieves the Y co-ordinate
167798     *
167799     * @return float The current Y co-ordinate
167800     **/
167801    public function getY(){}
167802
167803    /**
167804     * Set X
167805     *
167806     * Set the X co-ordinate
167807     *
167808     * @param float $point The new X co-ordinate
167809     **/
167810    public function setX($point){}
167811
167812    /**
167813     * Set Y
167814     *
167815     * Set the Y co-ordinate
167816     *
167817     * @param float $point The new Y co-ordinate
167818     **/
167819    public function setY($point){}
167820
167821}
167822}
167823namespace UI {
167824final class Size {
167825    /**
167826     * @var mixed
167827     **/
167828    public $height;
167829
167830    /**
167831     * @var mixed
167832     **/
167833    public $width;
167834
167835    /**
167836     * Retrieves Height
167837     *
167838     * Retrieves the Height
167839     *
167840     * @return float The current Height
167841     **/
167842    public function getHeight(){}
167843
167844    /**
167845     * Retrives Width
167846     *
167847     * Retrieves the Width
167848     *
167849     * @return float The current Width
167850     **/
167851    public function getWidth(){}
167852
167853    /**
167854     * Point Coercion
167855     *
167856     * Shall return a UI\Size object where width and height are equal to
167857     * those supplied, either in float or UI\Point form
167858     *
167859     * @param float $size The value for width and height
167860     * @return UI\Size The resulting Size
167861     **/
167862    public static function of($size){}
167863
167864    /**
167865     * Set Height
167866     *
167867     * Set new Height
167868     *
167869     * @param float $size The new Height
167870     **/
167871    public function setHeight($size){}
167872
167873    /**
167874     * Set Width
167875     *
167876     * Set new Width
167877     *
167878     * @param float $size The new Width
167879     **/
167880    public function setWidth($size){}
167881
167882}
167883}
167884namespace UI {
167885class Window extends UI\Control {
167886    /**
167887     * @var mixed
167888     **/
167889    protected $controls;
167890
167891    /**
167892     * Add a Control
167893     *
167894     * Shall add a Control to this Window
167895     *
167896     * @param UI\Control $control The Control to add
167897     **/
167898    public function add($control){}
167899
167900    /**
167901     * Show Error Box
167902     *
167903     * Shall show an error box
167904     *
167905     * @param string $title The title of the error box
167906     * @param string $msg The message for the error box
167907     **/
167908    public function error($title, $msg){}
167909
167910    /**
167911     * Get Window Size
167912     *
167913     * Shall return the size of this Window
167914     *
167915     * @return UI\Size
167916     **/
167917    public function getSize(){}
167918
167919    /**
167920     * Get Title
167921     *
167922     * Shall retrieve the title of this Window
167923     *
167924     * @return string
167925     **/
167926    public function getTitle(){}
167927
167928    /**
167929     * Border Detection
167930     *
167931     * Shall detect if borders are used on this Window
167932     *
167933     * @return bool
167934     **/
167935    public function hasBorders(){}
167936
167937    /**
167938     * Margin Detection
167939     *
167940     * Shall detect if margins are used on this Window
167941     *
167942     * @return bool
167943     **/
167944    public function hasMargin(){}
167945
167946    /**
167947     * Full Screen Detection
167948     *
167949     * Shall detect if this Window us using the whole screen
167950     *
167951     * @return bool
167952     **/
167953    public function isFullScreen(){}
167954
167955    /**
167956     * Show Message Box
167957     *
167958     * Shall show a message box
167959     *
167960     * @param string $title The title of the message box
167961     * @param string $msg The message
167962     **/
167963    public function msg($title, $msg){}
167964
167965    /**
167966     * Closing Callback
167967     *
167968     * Should gracefully destroy this Window
167969     *
167970     * @return int
167971     **/
167972    protected function onClosing(){}
167973
167974    /**
167975     * Open Dialog
167976     *
167977     * Shall show an open file dialog
167978     *
167979     * @return string Returns the name of the file selected for opening
167980     **/
167981    public function open(){}
167982
167983    /**
167984     * Save Dialog
167985     *
167986     * Shall show a save dialog
167987     *
167988     * @return string Returns the file name selecting for saving
167989     **/
167990    public function save(){}
167991
167992    /**
167993     * Border Use
167994     *
167995     * Shall enable or disable the use of borders on this Window
167996     *
167997     * @param bool $borders
167998     **/
167999    public function setBorders($borders){}
168000
168001    /**
168002     * Full Screen Use
168003     *
168004     * Shall enable or disable the use of the full screen for this Window
168005     *
168006     * @param bool $full
168007     **/
168008    public function setFullScreen($full){}
168009
168010    /**
168011     * Margin Use
168012     *
168013     * Shall enable or disable the use of margins for this Window
168014     *
168015     * @param bool $margin
168016     **/
168017    public function setMargin($margin){}
168018
168019    /**
168020     * Set Size
168021     *
168022     * Shall set the size of this Window
168023     *
168024     * @param UI\Size $size
168025     **/
168026    public function setSize($size){}
168027
168028    /**
168029     * Window Title
168030     *
168031     * Shall set the title for this Window
168032     *
168033     * @param string $title The new title
168034     **/
168035    public function setTitle($title){}
168036
168037}
168038}
168039/**
168040 * Exception thrown when performing an invalid operation on an empty
168041 * container, such as removing an element.
168042 **/
168043class UnderflowException extends RuntimeException {
168044}
168045/**
168046 * Exception thrown if a value does not match with a set of values.
168047 * Typically this happens when a function calls another function and
168048 * expects the return value to be of a certain type or value not
168049 * including arithmetic or buffer related errors.
168050 **/
168051class UnexpectedValueException extends RuntimeException {
168052}
168053/**
168054 * This is the core class for V8Js extension. Each instance created from
168055 * this class has own context in which all JavaScript is compiled and
168056 * executed. See {@link V8Js::__construct} for more information.
168057 **/
168058class V8Js {
168059    /**
168060     * @var integer
168061     **/
168062    const FLAG_FORCE_ARRAY = 0;
168063
168064    /**
168065     * @var integer
168066     **/
168067    const FLAG_NONE = 0;
168068
168069    /**
168070     * @var string
168071     **/
168072    const V8_VERSION = '';
168073
168074    /**
168075     * Execute a string as Javascript code
168076     *
168077     * Compiles and executes the string passed with {@link script} as
168078     * Javascript code.
168079     *
168080     * @param string $script The code string to be executed.
168081     * @param string $identifier Identifier string for the executed code.
168082     *   Used for debugging.
168083     * @param int $flags Execution flags. This value must be one of the
168084     *   V8Js::FLAG_* constants, defaulting to V8Js::FLAG_NONE.
168085     *   V8Js::FLAG_NONE: no flags V8Js::FLAG_FORCE_ARRAY: forces all
168086     *   Javascript objects passed to PHP to be associative arrays
168087     * @return mixed Returns the last variable instantiated in the
168088     *   Javascript code converted to matching PHP variable type.
168089     * @since PECL v8js >= 0.1.0
168090     **/
168091    public function executeString($script, $identifier, $flags){}
168092
168093    /**
168094     * Return an array of registered extensions
168095     *
168096     * This function returns array of Javascript extensions registered using
168097     * {@link V8Js::registerExtension}.
168098     *
168099     * @return array Returns an array of registered extensions or an empty
168100     *   array if there are none.
168101     * @since PECL v8js >= 0.1.0
168102     **/
168103    public static function getExtensions(){}
168104
168105    /**
168106     * Return pending uncaught Javascript exception
168107     *
168108     * Returns any pending uncaught Javascript exception as V8JsException
168109     * left from earlier {@link V8Js::executeString} call(s).
168110     *
168111     * @return V8JsException Either V8JsException or NULL.
168112     * @since PECL v8js >= 0.1.0
168113     **/
168114    public function getPendingException(){}
168115
168116    /**
168117     * Register Javascript extensions for V8Js
168118     *
168119     * Registers passed Javascript {@link script} as extension to be used in
168120     * V8Js contexts.
168121     *
168122     * @param string $extension_name Name of the extension to be
168123     *   registered.
168124     * @param string $script The Javascript code to be registered.
168125     * @param array $dependencies Array of extension names the extension to
168126     *   be registered depends on. Any such extension is enabled
168127     *   automatically when this extension is loaded. All extensions,
168128     *   including the dependencies, must be registered before any V8Js are
168129     *   created which use them.
168130     * @param bool $auto_enable If set to TRUE, the extension will be
168131     *   enabled automatically in all V8Js contexts.
168132     * @return bool Returns TRUE if extension was registered successfully,
168133     *   FALSE otherwise.
168134     * @since PECL v8js >= 0.1.0
168135     **/
168136    public static function registerExtension($extension_name, $script, $dependencies, $auto_enable){}
168137
168138    /**
168139     * Construct a new object
168140     *
168141     * Constructs a new V8Js object.
168142     *
168143     * @param string $object_name The name of the object passed to
168144     *   Javascript.
168145     * @param array $variables Map of PHP variables that will be available
168146     *   in Javascript. Must be an associative array in format
168147     *   array("name-for-js" => "name-of-php-variable"). Defaults to empty
168148     *   array.
168149     * @param array $extensions List of extensions registered using {@link
168150     *   V8Js::registerExtension} which should be available in the Javascript
168151     *   context of the created V8Js object. Extensions registered to be
168152     *   enabled automatically do not need to be listed in this array. Also
168153     *   if an extension has dependencies, those dependencies can be omitted
168154     *   as well. Defaults to empty array.
168155     * @param bool $report_uncaught_exceptions Controls whether uncaught
168156     *   Javascript exceptions are reported immediately or not. Defaults to
168157     *   TRUE. If set to FALSE the uncaught exception can be accessed using
168158     *   {@link V8Js::getPendingException}.
168159     * @since PECL v8js >= 0.1.0
168160     **/
168161    public function __construct($object_name, $variables, $extensions, $report_uncaught_exceptions){}
168162
168163}
168164class V8JsException extends Exception {
168165    /**
168166     * @var mixed
168167     **/
168168    protected $JsFileName;
168169
168170    /**
168171     * @var mixed
168172     **/
168173    protected $JsLineNumber;
168174
168175    /**
168176     * @var mixed
168177     **/
168178    protected $JsSourceLine;
168179
168180    /**
168181     * @var mixed
168182     **/
168183    protected $JsTrace;
168184
168185    /**
168186     * The getJsFileName purpose
168187     *
168188     * @return string
168189     * @since PECL v8js >= 0.1.0
168190     **/
168191    final public function getJsFileName(){}
168192
168193    /**
168194     * The getJsLineNumber purpose
168195     *
168196     * @return int
168197     * @since PECL v8js >= 0.1.0
168198     **/
168199    final public function getJsLineNumber(){}
168200
168201    /**
168202     * The getJsSourceLine purpose
168203     *
168204     * @return string
168205     * @since PECL v8js >= 0.1.0
168206     **/
168207    final public function getJsSourceLine(){}
168208
168209    /**
168210     * The getJsTrace purpose
168211     *
168212     * @return string
168213     * @since PECL v8js >= 0.1.0
168214     **/
168215    final public function getJsTrace(){}
168216
168217}
168218/**
168219 * The VARIANT is COM's equivalent of the PHP zval; it is a structure
168220 * that can contain a value with a range of different possible types. The
168221 * variant class provided by the COM extension allows you to have more
168222 * control over the way that PHP passes values to and from COM.
168223 **/
168224class variant {
168225}
168226class VarnishAdmin {
168227    /**
168228     * Authenticate on a varnish instance
168229     *
168230     * @return bool
168231     * @since PECL varnish >= 0.3
168232     **/
168233    public function auth(){}
168234
168235    /**
168236     * Ban URLs using a VCL expression
168237     *
168238     * @param string $vcl_regex Varnish VCL expression. It's based on the
168239     *   varnish ban command.
168240     * @return int Returns the varnish command status.
168241     * @since PECL varnish >= 0.3
168242     **/
168243    public function ban($vcl_regex){}
168244
168245    /**
168246     * Ban an URL using a VCL expression
168247     *
168248     * @param string $vcl_regex URL regular expression in PCRE compatible
168249     *   syntax. It's based on the ban.url varnish command.
168250     * @return int Returns the varnish command status.
168251     * @since PECL varnish >= 0.3
168252     **/
168253    public function banUrl($vcl_regex){}
168254
168255    /**
168256     * Clear varnish instance panic messages
168257     *
168258     * @return int Returns the varnish command status.
168259     * @since PECL varnish >= 0.4
168260     **/
168261    public function clearPanic(){}
168262
168263    /**
168264     * Connect to a varnish instance administration interface
168265     *
168266     * @return bool
168267     * @since PECL varnish >= 0.3
168268     **/
168269    public function connect(){}
168270
168271    /**
168272     * Disconnect from a varnish instance administration interface
168273     *
168274     * @return bool
168275     * @since PECL varnish >= 1.0.0
168276     **/
168277    public function disconnect(){}
168278
168279    /**
168280     * Get the last panic message on a varnish instance
168281     *
168282     * @return string Returns the last panic message on the current varnish
168283     *   instance.
168284     * @since PECL varnish >= 0.4
168285     **/
168286    public function getPanic(){}
168287
168288    /**
168289     * Fetch current varnish instance configuration parameters
168290     *
168291     * @return array Returns an array with the varnish configuration
168292     *   parameters.
168293     * @since PECL varnish >= 0.4
168294     **/
168295    public function getParams(){}
168296
168297    /**
168298     * Check if the varnish slave process is currently running
168299     *
168300     * @return bool
168301     * @since PECL varnish >= 0.3
168302     **/
168303    public function isRunning(){}
168304
168305    /**
168306     * Set the class compat configuration param
168307     *
168308     * @param int $compat Varnish compatibility option.
168309     * @return void
168310     * @since PECL varnish >= 0.9.2
168311     **/
168312    public function setCompat($compat){}
168313
168314    /**
168315     * Set the class host configuration param
168316     *
168317     * @param string $host Connection host configuration parameter.
168318     * @return void
168319     * @since PECL varnish >= 0.8
168320     **/
168321    public function setHost($host){}
168322
168323    /**
168324     * Set the class ident configuration param
168325     *
168326     * @param string $ident Connection ident configuration parameter.
168327     * @return void
168328     * @since PECL varnish >= 0.8
168329     **/
168330    public function setIdent($ident){}
168331
168332    /**
168333     * Set configuration param on the current varnish instance
168334     *
168335     * @param string $name Varnish configuration param name.
168336     * @param string|integer $value Varnish configuration param value.
168337     * @return int Returns the varnish command status.
168338     * @since PECL varnish >= 0.4
168339     **/
168340    public function setParam($name, $value){}
168341
168342    /**
168343     * Set the class port configuration param
168344     *
168345     * @param int $port Connection port configuration parameter.
168346     * @return void
168347     * @since PECL varnish >= 0.8
168348     **/
168349    public function setPort($port){}
168350
168351    /**
168352     * Set the class secret configuration param
168353     *
168354     * @param string $secret Connection secret configuration parameter.
168355     * @return void
168356     * @since PECL varnish >= 0.8
168357     **/
168358    public function setSecret($secret){}
168359
168360    /**
168361     * Set the class timeout configuration param
168362     *
168363     * @param int $timeout Connection timeout configuration parameter.
168364     * @return void
168365     * @since PECL varnish >= 0.8
168366     **/
168367    public function setTimeout($timeout){}
168368
168369    /**
168370     * Start varnish worker process
168371     *
168372     * @return int Returns the varnish command status.
168373     * @since PECL varnish >= 0.3
168374     **/
168375    public function start(){}
168376
168377    /**
168378     * Stop varnish worker process
168379     *
168380     * @return int Returns the varnish command status.
168381     * @since PECL varnish >= 0.3
168382     **/
168383    public function stop(){}
168384
168385    /**
168386     * VarnishAdmin constructor
168387     *
168388     * @param array $args Configuration arguments. The possible keys are:
168389     *
168390     *   VARNISH_CONFIG_IDENT - local varnish instance ident
168391     *   VARNISH_CONFIG_HOST - varnish instance ip VARNISH_CONFIG_PORT -
168392     *   varnish instance port VARNISH_CONFIG_SECRET - varnish instance
168393     *   secret VARNISH_CONFIG_TIMEOUT - connection read timeout
168394     *   VARNISH_CONFIG_COMPAT - varnish major version compatibility
168395     * @since PECL varnish >= 0.3
168396     **/
168397    public function __construct($args){}
168398
168399}
168400class VarnishException extends Exception {
168401}
168402class VarnishLog {
168403    /**
168404     * @var integer
168405     **/
168406    const TAG_Backend = 0;
168407
168408    /**
168409     * @var integer
168410     **/
168411    const TAG_BackendClose = 0;
168412
168413    /**
168414     * @var integer
168415     **/
168416    const TAG_BackendOpen = 0;
168417
168418    /**
168419     * @var integer
168420     **/
168421    const TAG_BackendReuse = 0;
168422
168423    /**
168424     * @var integer
168425     **/
168426    const TAG_BackendXID = 0;
168427
168428    /**
168429     * @var integer
168430     **/
168431    const TAG_Backend_health = 0;
168432
168433    /**
168434     * @var integer
168435     **/
168436    const TAG_CLI = 0;
168437
168438    /**
168439     * @var integer
168440     **/
168441    const TAG_Debug = 0;
168442
168443    /**
168444     * @var integer
168445     **/
168446    const TAG_Error = 0;
168447
168448    /**
168449     * @var integer
168450     **/
168451    const TAG_ESI_xmlerror = 0;
168452
168453    /**
168454     * @var integer
168455     **/
168456    const TAG_ExpBan = 0;
168457
168458    /**
168459     * @var integer
168460     **/
168461    const TAG_ExpKill = 0;
168462
168463    /**
168464     * @var integer
168465     **/
168466    const TAG_FetchError = 0;
168467
168468    /**
168469     * @var integer
168470     **/
168471    const TAG_Fetch_Body = 0;
168472
168473    /**
168474     * @var integer
168475     **/
168476    const TAG_Gzip = 0;
168477
168478    /**
168479     * @var integer
168480     **/
168481    const TAG_Hash = 0;
168482
168483    /**
168484     * @var integer
168485     **/
168486    const TAG_Hit = 0;
168487
168488    /**
168489     * @var integer
168490     **/
168491    const TAG_HitPass = 0;
168492
168493    /**
168494     * @var integer
168495     **/
168496    const TAG_HttpGarbage = 0;
168497
168498    /**
168499     * @var integer
168500     **/
168501    const TAG_Length = 0;
168502
168503    /**
168504     * @var integer
168505     **/
168506    const TAG_LostHeader = 0;
168507
168508    /**
168509     * @var integer
168510     **/
168511    const TAG_ObjHeader = 0;
168512
168513    /**
168514     * @var integer
168515     **/
168516    const TAG_ObjProtocol = 0;
168517
168518    /**
168519     * @var integer
168520     **/
168521    const TAG_ObjRequest = 0;
168522
168523    /**
168524     * @var integer
168525     **/
168526    const TAG_ObjResponse = 0;
168527
168528    /**
168529     * @var integer
168530     **/
168531    const TAG_ObjStatus = 0;
168532
168533    /**
168534     * @var integer
168535     **/
168536    const TAG_ObjURL = 0;
168537
168538    /**
168539     * @var integer
168540     **/
168541    const TAG_ReqEnd = 0;
168542
168543    /**
168544     * @var integer
168545     **/
168546    const TAG_ReqStart = 0;
168547
168548    /**
168549     * @var integer
168550     **/
168551    const TAG_RxHeader = 0;
168552
168553    /**
168554     * @var integer
168555     **/
168556    const TAG_RxProtocol = 0;
168557
168558    /**
168559     * @var integer
168560     **/
168561    const TAG_RxRequest = 0;
168562
168563    /**
168564     * @var integer
168565     **/
168566    const TAG_RxResponse = 0;
168567
168568    /**
168569     * @var integer
168570     **/
168571    const TAG_RxStatus = 0;
168572
168573    /**
168574     * @var integer
168575     **/
168576    const TAG_RxURL = 0;
168577
168578    /**
168579     * @var integer
168580     **/
168581    const TAG_SessionClose = 0;
168582
168583    /**
168584     * @var integer
168585     **/
168586    const TAG_SessionOpen = 0;
168587
168588    /**
168589     * @var integer
168590     **/
168591    const TAG_StatSess = 0;
168592
168593    /**
168594     * @var integer
168595     **/
168596    const TAG_TTL = 0;
168597
168598    /**
168599     * @var integer
168600     **/
168601    const TAG_TxHeader = 0;
168602
168603    /**
168604     * @var integer
168605     **/
168606    const TAG_TxProtocol = 0;
168607
168608    /**
168609     * @var integer
168610     **/
168611    const TAG_TxRequest = 0;
168612
168613    /**
168614     * @var integer
168615     **/
168616    const TAG_TxResponse = 0;
168617
168618    /**
168619     * @var integer
168620     **/
168621    const TAG_TxStatus = 0;
168622
168623    /**
168624     * @var integer
168625     **/
168626    const TAG_TxURL = 0;
168627
168628    /**
168629     * @var integer
168630     **/
168631    const TAG_VCL_acl = 0;
168632
168633    /**
168634     * @var integer
168635     **/
168636    const TAG_VCL_call = 0;
168637
168638    /**
168639     * @var integer
168640     **/
168641    const TAG_VCL_error = 0;
168642
168643    /**
168644     * @var integer
168645     **/
168646    const TAG_VCL_Log = 0;
168647
168648    /**
168649     * @var integer
168650     **/
168651    const TAG_VCL_return = 0;
168652
168653    /**
168654     * @var integer
168655     **/
168656    const TAG_VCL_trace = 0;
168657
168658    /**
168659     * @var integer
168660     **/
168661    const TAG_WorkThread = 0;
168662
168663    /**
168664     * Get next log line
168665     *
168666     * @return array Returns an array with the log line data.
168667     * @since PECL varnish >= 0.6
168668     **/
168669    public function getLine(){}
168670
168671    /**
168672     * Get the log tag string representation by its index
168673     *
168674     * @param int $index Log tag index.
168675     * @return string Returns the log tag name as .
168676     * @since PECL varnish >= 0.6
168677     **/
168678    public static function getTagName($index){}
168679
168680    /**
168681     * Varnishlog constructor
168682     *
168683     * @param array $args Configuration arguments. The possible keys are:
168684     *
168685     *   VARNISH_CONFIG_IDENT - local varnish instance ident path
168686     * @since PECL varnish >= 0.6
168687     **/
168688    public function __construct($args){}
168689
168690}
168691class VarnishStat {
168692    /**
168693     * Get the current varnish instance statistics snapshot
168694     *
168695     * @return array Array with the varnish statistic snapshot. The array
168696     *   keys are identical to that in the varnishstat tool.
168697     * @since PECL varnish >= 0.3
168698     **/
168699    public function getSnapshot(){}
168700
168701    /**
168702     * VarnishStat constructor
168703     *
168704     * @param array $args Configuration arguments. The possible keys are:
168705     *
168706     *   VARNISH_CONFIG_IDENT - local varnish instance ident path
168707     * @since PECL varnish >= 0.3
168708     **/
168709    public function __construct($args){}
168710
168711}
168712/**
168713 * The Volatile class is new to pthreads v3. Its introduction is a
168714 * consequence of the new immutability semantics of Threaded members of
168715 * Threaded classes. The Volatile class enables for mutability of its
168716 * Threaded members, and is also used to store PHP arrays in Threaded
168717 * contexts.
168718 **/
168719class Volatile extends Threaded implements Collectable, Traversable {
168720}
168721namespace Vtiful\Kernel {
168722class Excel {
168723    /**
168724     * Vtiful\Kernel\Excel addSheet
168725     *
168726     * Create a new worksheet in the xlsx file.
168727     *
168728     * @param string $sheetName Worksheet name
168729     **/
168730    public function addSheet($sheetName){}
168731
168732    /**
168733     * Vtiful\Kernel\Excel autoFilter
168734     *
168735     * Add autofilter to a worksheet.
168736     *
168737     * @param string $scope Cell start and end coordinate string.
168738     **/
168739    public function autoFilter($scope){}
168740
168741    /**
168742     * Vtiful\Kernel\Excel constMemory
168743     *
168744     * Write a large file with constant memory usage.
168745     *
168746     * @param string $fileName XLSX file name
168747     * @param string $sheetName Worksheet name
168748     **/
168749    public function constMemory($fileName, $sheetName){}
168750
168751    /**
168752     * Vtiful\Kernel\Excel data
168753     *
168754     * Write a data in the worksheet.
168755     *
168756     * @param array $data worksheet data
168757     **/
168758    public function data($data){}
168759
168760    /**
168761     * Vtiful\Kernel\Excel fileName
168762     *
168763     * Create a brand new xlsx file and create a worksheet.
168764     *
168765     * @param string $fileName XLSX file name
168766     * @param string $sheetName Worksheet name
168767     **/
168768    public function fileName($fileName, $sheetName){}
168769
168770    /**
168771     * Vtiful\Kernel\Excel getHandle
168772     *
168773     * Get the xlsx text resource handle.
168774     **/
168775    public function getHandle(){}
168776
168777    /**
168778     * Vtiful\Kernel\Excel header
168779     *
168780     * Write a header in the worksheet.
168781     *
168782     * @param array $headerData worksheet header data
168783     **/
168784    public function header($headerData){}
168785
168786    /**
168787     * Vtiful\Kernel\Excel insertFormula
168788     *
168789     * Insert calculation formula.
168790     *
168791     * @param int $row cell row
168792     * @param int $column cell column
168793     * @param string $formula formula string
168794     **/
168795    public function insertFormula($row, $column, $formula){}
168796
168797    /**
168798     * Vtiful\Kernel\Excel insertImage
168799     *
168800     * Insert a local image into the cell.
168801     *
168802     * @param int $row cell row
168803     * @param int $column cell column
168804     * @param string $localImagePath local image path
168805     **/
168806    public function insertImage($row, $column, $localImagePath){}
168807
168808    /**
168809     * Vtiful\Kernel\Excel insertText
168810     *
168811     * Write text in a cell.
168812     *
168813     * @param int $row cell row
168814     * @param int $column cell column
168815     * @param string $data data to be written
168816     * @param string $format String format
168817     **/
168818    public function insertText($row, $column, $data, $format){}
168819
168820    /**
168821     * Vtiful\Kernel\Excel mergeCells
168822     *
168823     * Merge Cells.
168824     *
168825     * @param string $scope cell start and end coordinate strings
168826     * @param string $data string data
168827     **/
168828    public function mergeCells($scope, $data){}
168829
168830    /**
168831     * Vtiful\Kernel\Excel output
168832     *
168833     * Output xlsx file to disk.
168834     **/
168835    public function output(){}
168836
168837    /**
168838     * Vtiful\Kernel\Excel setColumn
168839     *
168840     * Set the format of the column.
168841     *
168842     * @param string $range cell start and end coordinate strings
168843     * @param float $width column width
168844     * @param resource $format cell format resource
168845     **/
168846    public function setColumn($range, $width, $format){}
168847
168848    /**
168849     * Vtiful\Kernel\Excel setRow
168850     *
168851     * Set the format of the column.
168852     *
168853     * @param string $range cell start and end coordinate strings
168854     * @param float $height row height
168855     * @param resource $format cell format resource
168856     **/
168857    public function setRow($range, $height, $format){}
168858
168859    /**
168860     * Vtiful\Kernel\Excel constructor
168861     *
168862     * Vtiful\Kernel\Excel constructor, create a class object.
168863     *
168864     * @param array $config XLSX file export configuration
168865     **/
168866    public function __construct($config){}
168867
168868}
168869}
168870namespace Vtiful\Kernel {
168871class Format {
168872    /**
168873     * Vtiful\Kernel\Format align
168874     *
168875     * set cell align
168876     *
168877     * @param resource $handle xlsx file handle
168878     * @param int $style Vtiful\Kernel\Format constant
168879     **/
168880    public function align($handle, $style){}
168881
168882    /**
168883     * Vtiful\Kernel\Format bold
168884     *
168885     * Vtiful\Kernel\Format bold format
168886     *
168887     * @param resource $handle xlsx file handle
168888     **/
168889    public function bold($handle){}
168890
168891    /**
168892     * Vtiful\Kernel\Format italic
168893     *
168894     * Vtiful\Kernel\Format italic format
168895     *
168896     * @param resource $handle xlsx file handle
168897     **/
168898    public function italic($handle){}
168899
168900    /**
168901     * Vtiful\Kernel\Format underline
168902     *
168903     * Vtiful\Kernel\Format underline format
168904     *
168905     * @param resource $handle xlsx file handle
168906     * @param int $style Vtiful\Kernel\Format constant
168907     **/
168908    public function underline($handle, $style){}
168909
168910}
168911}
168912/**
168913 * Weakmap usage example
168914 **/
168915class WeakMap implements Countable, ArrayAccess, Iterator {
168916    /**
168917     * Counts the number of live entries in the map
168918     *
168919     * @return int Returns the number of live entries in the map.
168920     * @since PECL weakref >= 0.2.0
168921     **/
168922    public function count(){}
168923
168924    /**
168925     * Returns the current value under iteration
168926     *
168927     * Returns the current value being iterated on in the map.
168928     *
168929     * @return mixed The value currently being iterated on.
168930     * @since PECL weakref >= 0.2.0
168931     **/
168932    public function current(){}
168933
168934    /**
168935     * Returns the current key under iteration
168936     *
168937     * Returns the object serving as key in the map, at the current iterating
168938     * position.
168939     *
168940     * @return object The object key currently being iterated.
168941     * @since PECL weakref >= 0.2.0
168942     **/
168943    public function key(){}
168944
168945    /**
168946     * Advances to the next map element
168947     *
168948     * @return void
168949     * @since PECL weakref >= 0.2.0
168950     **/
168951    public function next(){}
168952
168953    /**
168954     * Checks whether a certain object is in the map
168955     *
168956     * Checks whether the passed object is referenced in the map.
168957     *
168958     * @param object $object Object to check for.
168959     * @return bool Returns TRUE if the object is contained in the map,
168960     *   FALSE otherwise.
168961     * @since PECL weakref >= 0.2.0
168962     **/
168963    public function offsetExists($object){}
168964
168965    /**
168966     * Returns the value pointed to by a certain object
168967     *
168968     * @param object $object Some object contained as key in the map.
168969     * @return mixed Returns the value associated to the object passed as
168970     *   argument, NULL otherwise.
168971     * @since PECL weakref >= 0.2.0
168972     **/
168973    public function offsetGet($object){}
168974
168975    /**
168976     * Updates the map with a new key-value pair
168977     *
168978     * Updates the map with a new key-value pair. If the key already existed
168979     * in the map, the old value is replaced with the new.
168980     *
168981     * @param object $object The object serving as key of the key-value
168982     *   pair.
168983     * @param mixed $value The arbitrary data serving as value of the
168984     *   key-value pair.
168985     * @return void
168986     * @since PECL weakref >= 0.2.0
168987     **/
168988    public function offsetSet($object, $value){}
168989
168990    /**
168991     * Removes an entry from the map
168992     *
168993     * @param object $object The key object to remove from the map.
168994     * @return void
168995     * @since PECL weakref >= 0.2.0
168996     **/
168997    public function offsetUnset($object){}
168998
168999    /**
169000     * Rewinds the iterator to the beginning of the map
169001     *
169002     * @return void
169003     * @since PECL weakref >= 0.2.0
169004     **/
169005    public function rewind(){}
169006
169007    /**
169008     * Returns whether the iterator is still on a valid map element
169009     *
169010     * @return bool Returns TRUE if the iterator is on a valid element that
169011     *   can be accessed, FALSE otherwise.
169012     * @since PECL weakref >= 0.2.0
169013     **/
169014    public function valid(){}
169015
169016    /**
169017     * Constructs a new map
169018     *
169019     * @since PECL weakref >= 0.2.0
169020     **/
169021    public function __construct(){}
169022
169023}
169024/**
169025 * The WeakRef class provides a gateway to objects without preventing the
169026 * garbage collector from freeing those objects. It also provides a way
169027 * to turn a weak reference into a strong one. WeakRef usage example
169028 *
169029 * Object still exists! object(MyClass)#1 (0) { } Destroying object!
169030 * Object is dead!
169031 **/
169032class Weakref {
169033    /**
169034     * Acquires a strong reference on that object
169035     *
169036     * Acquires a strong reference on that object, virtually turning the weak
169037     * reference into a strong one.
169038     *
169039     * The Weakref instance maintains an internal acquired counter to track
169040     * outstanding strong references. If the call to Weakref::acquire is
169041     * successful, this counter will be incremented by one.
169042     *
169043     * @return bool Returns TRUE if the reference was valid and could be
169044     *   turned into a strong reference, FALSE otherwise.
169045     * @since PECL weakref >= 0.1.0
169046     **/
169047    public function acquire(){}
169048
169049    /**
169050     * Returns the object pointed to by the weak reference
169051     *
169052     * @return object Returns the object if the reference is still valid,
169053     *   NULL otherwise.
169054     * @since PECL weakref >= 0.1.0
169055     **/
169056    public function get(){}
169057
169058    /**
169059     * Releases a previously acquired reference
169060     *
169061     * Releases a previously acquired reference, potentially turning a strong
169062     * reference back into a weak reference.
169063     *
169064     * The Weakref instance maintains an internal acquired counter to track
169065     * outstanding strong references. If the call to Weakref::release is
169066     * successful, this counter will be decremented by one. Once this counter
169067     * reaches zero, the strong reference is turned back into a weak
169068     * reference.
169069     *
169070     * @return bool Returns TRUE if the reference was previously acquired
169071     *   and thus could be released, FALSE otherwise.
169072     * @since PECL weakref >= 0.1.0
169073     **/
169074    public function release(){}
169075
169076    /**
169077     * Checks whether the object referenced still exists
169078     *
169079     * @return bool Returns TRUE if the object still exists and is thus
169080     *   still accessible via Weakref::get, FALSE otherwise.
169081     * @since PECL weakref >= 0.1.0
169082     **/
169083    public function valid(){}
169084
169085}
169086/**
169087 * Weak references allow the programmer to retain a reference to an
169088 * object which does not prevent the object from being destroyed. They
169089 * are useful for implementing cache like structures. WeakReferences
169090 * cannot be serialized. Basic WeakReference Usage
169091 *
169092 * object(stdClass)#1 (0) { } NULL
169093 **/
169094class WeakReference {
169095    /**
169096     * Create a new weak reference
169097     *
169098     * Creates a new WeakReference.
169099     *
169100     * @param object $referent The object to be weakly referenced.
169101     * @return WeakReference Returns the freshly instantiated object.
169102     * @since PHP 7 >= 7.4.0
169103     **/
169104    public static function create($referent){}
169105
169106    /**
169107     * Get a weakly referenced Object
169108     *
169109     * Gets a weakly referenced object. If the object has already been
169110     * destroyed, NULL is returned.
169111     *
169112     * @return ?object Returns the referenced , or NULL if the object has
169113     *   been destroyed.
169114     * @since PHP 7 >= 7.4.0
169115     **/
169116    public function get(){}
169117
169118}
169119namespace wkhtmltox\Image {
169120class Converter {
169121    /**
169122     * Perform Image conversion
169123     *
169124     * Performs conversion of the input buffer
169125     *
169126     * @return ?string Where the return value is used, it will be populated
169127     *   with the contents of the conversion buffer
169128     **/
169129    public function convert(){}
169130
169131    /**
169132     * Determine version of Converter
169133     *
169134     * Determines the version of Converter as reported by libwkhtmltox
169135     *
169136     * @return string Returns a version string
169137     **/
169138    public function getVersion(){}
169139
169140}
169141}
169142namespace wkhtmltox\PDF {
169143class Converter {
169144    /**
169145     * Add an object for conversion
169146     *
169147     * Adds the given object to conversion
169148     *
169149     * @param wkhtmltox\PDF\Object $object The object to add
169150     * @return void
169151     **/
169152    public function add($object){}
169153
169154    /**
169155     * Perform PDF conversion
169156     *
169157     * Performs conversion of all previously added Objects
169158     *
169159     * @return ?string Where the return value is used, it will be populated
169160     *   with the contents of the conversion buffer
169161     **/
169162    public function convert(){}
169163
169164    /**
169165     * Determine version of Converter
169166     *
169167     * Determines the version of Converter as reported by libwkhtmltox
169168     *
169169     * @return string Returns a version string
169170     **/
169171    public function getVersion(){}
169172
169173}
169174}
169175namespace wkhtmltox\PDF {
169176class Object {
169177}
169178}
169179/**
169180 * Worker Threads have a persistent context, as such should be used over
169181 * Threads in most cases. When a Worker is started, the run method will
169182 * be executed, but the Thread will not leave until one of the following
169183 * conditions are met: This means the programmer can reuse the context
169184 * throughout execution; placing objects on the stack of the Worker will
169185 * cause the Worker to execute the stacked objects run method.
169186 **/
169187class Worker extends Thread implements Traversable, Countable, ArrayAccess {
169188    /**
169189     * Collect references to completed tasks
169190     *
169191     * Allows the worker to collect references determined to be garbage by
169192     * the optionally given collector.
169193     *
169194     * @param Callable $collector A Callable collector that returns a
169195     *   boolean on whether the task can be collected or not. Only in rare
169196     *   cases should a custom collector need to be used.
169197     * @return int The number of remaining tasks on the worker's stack to
169198     *   be collected.
169199     * @since PECL pthreads >= 3.0.0
169200     **/
169201    public function collect($collector){}
169202
169203    /**
169204     * Gets the remaining stack size
169205     *
169206     * Returns the number of tasks left on the stack
169207     *
169208     * @return int Returns the number of tasks currently waiting to be
169209     *   executed by the worker
169210     * @since PECL pthreads >= 2.0.0
169211     **/
169212    public function getStacked(){}
169213
169214    /**
169215     * State Detection
169216     *
169217     * Whether the worker has been shutdown or not.
169218     *
169219     * @return bool Returns whether the worker has been shutdown or not.
169220     * @since PECL pthreads >= 2.0.0
169221     **/
169222    public function isShutdown(){}
169223
169224    /**
169225     * State Detection
169226     *
169227     * Tell if a Worker is executing Stackables
169228     *
169229     * @return bool A boolean indication of state
169230     * @since PECL pthreads >= 2.0.0
169231     **/
169232    public function isWorking(){}
169233
169234    /**
169235     * Shutdown the worker
169236     *
169237     * Shuts down the worker after executing all of the stacked tasks.
169238     *
169239     * @return bool Whether the worker was successfully shutdown or not.
169240     * @since PECL pthreads >= 2.0.0
169241     **/
169242    public function shutdown(){}
169243
169244    /**
169245     * Stacking work
169246     *
169247     * Appends the new work to the stack of the referenced worker.
169248     *
169249     * @param Threaded $work A Threaded object to be executed by the
169250     *   worker.
169251     * @return int The new size of the stack.
169252     * @since PECL pthreads >= 2.0.0
169253     **/
169254    public function stack(&$work){}
169255
169256    /**
169257     * Unstacking work
169258     *
169259     * Removes the first task (the oldest one) in the stack.
169260     *
169261     * @return int The new size of the stack.
169262     * @since PECL pthreads >= 2.0.0
169263     **/
169264    public function unstack(){}
169265
169266}
169267namespace XMLDiff {
169268abstract class Base {
169269    /**
169270     * Produce diff of two XML documents
169271     *
169272     * Abstract diff method to be implemented by inheriting classes.
169273     *
169274     * The basic purpose of this method is to produce diff of the two
169275     * documents. The param order matters and will produce different output.
169276     *
169277     * @param mixed $from Source XML document.
169278     * @param mixed $to Target XML document.
169279     * @return mixed Implementation dependent.
169280     **/
169281    abstract public function diff($from, $to);
169282
169283    /**
169284     * Produce new XML document based on diff
169285     *
169286     * Abstract merge method to be implemented by inheriting classes.
169287     *
169288     * Basically the method purpose is to produce a new XML document based on
169289     * the diff information.
169290     *
169291     * @param mixed $src Source XML document.
169292     * @param mixed $diff Document produced by the diff method.
169293     * @return mixed Implementation dependent.
169294     **/
169295    abstract public function merge($src, $diff);
169296
169297    /**
169298     * Constructor
169299     *
169300     * Base constructor for all the worker classes in the xmldiff extension.
169301     *
169302     * @param string $nsname Custom namespace name for the diff document.
169303     *   The default namespace is http://www.locus.cz/diffmark and that's
169304     *   enough to avoid namespace conflicts. Use this parameter if you want
169305     *   to change it for some reason.
169306     **/
169307    public function __construct($nsname){}
169308
169309}
169310}
169311namespace XMLDiff {
169312class DOM extends XMLDiff\Base {
169313    /**
169314     * Diff two DOMDocument objects
169315     *
169316     * Diff two DOMDocument instances and produce the new one containing the
169317     * diff information.
169318     *
169319     * @param DOMDocument $from Source DOMDocument object.
169320     * @param DOMDocument $to Target DOMDocument object.
169321     * @return DOMDocument DOMDocument with the diff information or NULL.
169322     **/
169323    public function diff($from, $to){}
169324
169325    /**
169326     * Produce merged DOMDocument
169327     *
169328     * Create new DOMDocument based on the diff.
169329     *
169330     * @param DOMDocument $src Source DOMDocument object.
169331     * @param DOMDocument $diff DOMDocument object containing the diff
169332     *   information.
169333     * @return DOMDocument Merged DOMDocument or NULL.
169334     **/
169335    public function merge($src, $diff){}
169336
169337}
169338}
169339namespace XMLDiff {
169340class Exception extends Exception {
169341}
169342}
169343namespace XMLDiff {
169344class File extends XMLDiff\Base {
169345    /**
169346     * Diff two XML files
169347     *
169348     * Diff two local XML files and produce string with the diff information.
169349     *
169350     * @param string $from Path to the source document.
169351     * @param string $to Path to the target document.
169352     * @return string String with the XML document containing the diff
169353     *   information or NULL.
169354     **/
169355    public function diff($from, $to){}
169356
169357    /**
169358     * Produce merged XML document
169359     *
169360     * Create new XML document based on diffs and source document.
169361     *
169362     * @param string $src Path to the source XML document.
169363     * @param string $diff Path to the XML document with the diff
169364     *   information.
169365     * @return string String with the new XML document or NULL.
169366     **/
169367    public function merge($src, $diff){}
169368
169369}
169370}
169371namespace XMLDiff {
169372class Memory extends XMLDiff\Base {
169373    /**
169374     * Diff two XML documents
169375     *
169376     * Diff two strings containing XML documents and produce the diff
169377     * information.
169378     *
169379     * @param string $from Source XML document.
169380     * @param string $to Target XML document.
169381     * @return string String with the XML document containing the diff
169382     *   information or NULL.
169383     **/
169384    public function diff($from, $to){}
169385
169386    /**
169387     * Produce merged XML document
169388     *
169389     * Create new XML document based on diffs and source document.
169390     *
169391     * @param string $src Source XML document.
169392     * @param string $diff XML document containing diff information.
169393     * @return string String with the new XML document or NULL.
169394     **/
169395    public function merge($src, $diff){}
169396
169397}
169398}
169399/**
169400 * The XMLReader extension is an XML Pull parser. The reader acts as a
169401 * cursor going forward on the document stream and stopping at each node
169402 * on the way.
169403 **/
169404class XMLReader {
169405    /**
169406     * Attribute node
169407     *
169408     * @var int
169409     **/
169410    const ATTRIBUTE = 0;
169411
169412    /**
169413     * CDATA node
169414     *
169415     * @var int
169416     **/
169417    const CDATA = 0;
169418
169419    /**
169420     * Comment node
169421     *
169422     * @var int
169423     **/
169424    const COMMENT = 0;
169425
169426    /**
169427     * Load DTD and default attributes but do not validate
169428     *
169429     * @var int
169430     **/
169431    const DEFAULTATTRS = 0;
169432
169433    /**
169434     * Document node
169435     *
169436     * @var int
169437     **/
169438    const DOC = 0;
169439
169440    /**
169441     * @var int
169442     **/
169443    const DOC_FRAGMENT = 0;
169444
169445    /**
169446     * @var int
169447     **/
169448    const DOC_TYPE = 0;
169449
169450    /**
169451     * Start element
169452     *
169453     * @var int
169454     **/
169455    const ELEMENT = 0;
169456
169457    /**
169458     * @var int
169459     **/
169460    const END_ELEMENT = 0;
169461
169462    /**
169463     * @var int
169464     **/
169465    const END_ENTITY = 0;
169466
169467    /**
169468     * Entity Declaration node
169469     *
169470     * @var int
169471     **/
169472    const ENTITY = 0;
169473
169474    /**
169475     * @var int
169476     **/
169477    const ENTITY_REF = 0;
169478
169479    /**
169480     * Load DTD but do not validate
169481     *
169482     * @var int
169483     **/
169484    const LOADDTD = 0;
169485
169486    /**
169487     * No node type
169488     *
169489     * @var int
169490     **/
169491    const NONE = 0;
169492
169493    /**
169494     * Notation node
169495     *
169496     * @var int
169497     **/
169498    const NOTATION = 0;
169499
169500    /**
169501     * Processing Instruction node
169502     *
169503     * @var int
169504     **/
169505    const PI = 0;
169506
169507    /**
169508     * @var int
169509     **/
169510    const SIGNIFICANT_WHITESPACE = 0;
169511
169512    /**
169513     * @var int
169514     **/
169515    const SUBST_ENTITIES = 0;
169516
169517    /**
169518     * Text node
169519     *
169520     * @var int
169521     **/
169522    const TEXT = 0;
169523
169524    /**
169525     * Load DTD and validate while parsing
169526     *
169527     * @var int
169528     **/
169529    const VALIDATE = 0;
169530
169531    /**
169532     * Whitespace node
169533     *
169534     * @var int
169535     **/
169536    const WHITESPACE = 0;
169537
169538    /**
169539     * @var int
169540     **/
169541    const XML_DECLARATION = 0;
169542
169543    /**
169544     * @var int
169545     **/
169546    public $attributeCount;
169547
169548    /**
169549     * @var string
169550     **/
169551    public $baseURI;
169552
169553    /**
169554     * Depth of the node in the tree, starting at 0
169555     *
169556     * @var int
169557     **/
169558    public $depth;
169559
169560    /**
169561     * @var bool
169562     **/
169563    public $hasAttributes;
169564
169565    /**
169566     * @var bool
169567     **/
169568    public $hasValue;
169569
169570    /**
169571     * @var bool
169572     **/
169573    public $isDefault;
169574
169575    /**
169576     * @var bool
169577     **/
169578    public $isEmptyElement;
169579
169580    /**
169581     * @var string
169582     **/
169583    public $localName;
169584
169585    /**
169586     * The qualified name of the node
169587     *
169588     * @var string
169589     **/
169590    public $name;
169591
169592    /**
169593     * @var string
169594     **/
169595    public $namespaceURI;
169596
169597    /**
169598     * @var int
169599     **/
169600    public $nodeType;
169601
169602    /**
169603     * The prefix of the namespace associated with the node
169604     *
169605     * @var string
169606     **/
169607    public $prefix;
169608
169609    /**
169610     * The text value of the node
169611     *
169612     * @var string
169613     **/
169614    public $value;
169615
169616    /**
169617     * @var string
169618     **/
169619    public $xmlLang;
169620
169621    /**
169622     * Close the XMLReader input
169623     *
169624     * Closes the input the XMLReader object is currently parsing.
169625     *
169626     * @return bool
169627     * @since PHP 5 >= 5.1.0, PHP 7
169628     **/
169629    public function close(){}
169630
169631    /**
169632     * Returns a copy of the current node as a DOM object
169633     *
169634     * This method copies the current node and returns the appropriate DOM
169635     * object.
169636     *
169637     * @param DOMNode $basenode A DOMNode defining the target DOMDocument
169638     *   for the created DOM object.
169639     * @return DOMNode The resulting DOMNode or FALSE on error.
169640     * @since PHP 5 >= 5.1.0, PHP 7
169641     **/
169642    public function expand($basenode){}
169643
169644    /**
169645     * Get the value of a named attribute
169646     *
169647     * Returns the value of a named attribute or NULL if the attribute does
169648     * not exist or not positioned on an element node.
169649     *
169650     * @param string $name The name of the attribute.
169651     * @return string The value of the attribute, or NULL if no attribute
169652     *   with the given {@link name} is found or not positioned on an element
169653     *   node.
169654     * @since PHP 5 >= 5.1.0, PHP 7
169655     **/
169656    public function getAttribute($name){}
169657
169658    /**
169659     * Get the value of an attribute by index
169660     *
169661     * Returns the value of an attribute based on its position or an empty
169662     * string if attribute does not exist or not positioned on an element
169663     * node.
169664     *
169665     * @param int $index The position of the attribute.
169666     * @return string The value of the attribute, or an empty string
169667     *   (before PHP 5.6) or NULL (from PHP 5.6 onwards) if no attribute
169668     *   exists at {@link index} or is not positioned on the element.
169669     * @since PHP 5 >= 5.1.0, PHP 7
169670     **/
169671    public function getAttributeNo($index){}
169672
169673    /**
169674     * Get the value of an attribute by localname and URI
169675     *
169676     * Returns the value of an attribute by name and namespace URI or an
169677     * empty string if attribute does not exist or not positioned on an
169678     * element node.
169679     *
169680     * @param string $localName The local name.
169681     * @param string $namespaceURI The namespace URI.
169682     * @return string The value of the attribute, or an empty string
169683     *   (before PHP 5.6) or NULL (from PHP 5.6 onwards) if no attribute with
169684     *   the given {@link localName} and {@link namespaceURI} is found or not
169685     *   positioned of element.
169686     * @since PHP 5 >= 5.1.0, PHP 7
169687     **/
169688    public function getAttributeNs($localName, $namespaceURI){}
169689
169690    /**
169691     * Indicates if specified property has been set
169692     *
169693     * Indicates if specified property has been set.
169694     *
169695     * @param int $property One of the parser option constants.
169696     * @return bool
169697     * @since PHP 5 >= 5.1.0, PHP 7
169698     **/
169699    public function getParserProperty($property){}
169700
169701    /**
169702     * Indicates if the parsed document is valid
169703     *
169704     * Returns a boolean indicating if the document being parsed is currently
169705     * valid.
169706     *
169707     * @return bool
169708     * @since PHP 5 >= 5.1.0, PHP 7
169709     **/
169710    public function isValid(){}
169711
169712    /**
169713     * Lookup namespace for a prefix
169714     *
169715     * Lookup in scope namespace for a given prefix.
169716     *
169717     * @param string $prefix String containing the prefix.
169718     * @return string
169719     * @since PHP 5 >= 5.1.0, PHP 7
169720     **/
169721    public function lookupNamespace($prefix){}
169722
169723    /**
169724     * Move cursor to a named attribute
169725     *
169726     * Positions cursor on the named attribute.
169727     *
169728     * @param string $name The name of the attribute.
169729     * @return bool
169730     * @since PHP 5 >= 5.1.0, PHP 7
169731     **/
169732    public function moveToAttribute($name){}
169733
169734    /**
169735     * Move cursor to an attribute by index
169736     *
169737     * Positions cursor on attribute based on its position.
169738     *
169739     * @param int $index The position of the attribute.
169740     * @return bool
169741     * @since PHP 5 >= 5.1.0, PHP 7
169742     **/
169743    public function moveToAttributeNo($index){}
169744
169745    /**
169746     * Move cursor to a named attribute
169747     *
169748     * Positions cursor on the named attribute in specified namespace.
169749     *
169750     * @param string $localName The local name.
169751     * @param string $namespaceURI The namespace URI.
169752     * @return bool
169753     * @since PHP 5 >= 5.1.0, PHP 7
169754     **/
169755    public function moveToAttributeNs($localName, $namespaceURI){}
169756
169757    /**
169758     * Position cursor on the parent Element of current Attribute
169759     *
169760     * Moves cursor to the parent Element of current Attribute.
169761     *
169762     * @return bool Returns TRUE if successful and FALSE if it fails or not
169763     *   positioned on Attribute when this method is called.
169764     * @since PHP 5 >= 5.1.0, PHP 7
169765     **/
169766    public function moveToElement(){}
169767
169768    /**
169769     * Position cursor on the first Attribute
169770     *
169771     * Moves cursor to the first Attribute.
169772     *
169773     * @return bool
169774     * @since PHP 5 >= 5.1.0, PHP 7
169775     **/
169776    public function moveToFirstAttribute(){}
169777
169778    /**
169779     * Position cursor on the next Attribute
169780     *
169781     * Moves cursor to the next Attribute if positioned on an Attribute or
169782     * moves to first attribute if positioned on an Element.
169783     *
169784     * @return bool
169785     * @since PHP 5 >= 5.1.0, PHP 7
169786     **/
169787    public function moveToNextAttribute(){}
169788
169789    /**
169790     * Move cursor to next node skipping all subtrees
169791     *
169792     * Positions cursor on the next node skipping all subtrees.
169793     *
169794     * @param string $localname The name of the next node to move to.
169795     * @return bool
169796     * @since PHP 5 >= 5.1.0, PHP 7
169797     **/
169798    public function next($localname){}
169799
169800    /**
169801     * Set the URI containing the XML to parse
169802     *
169803     * Set the URI containing the XML document to be parsed.
169804     *
169805     * @param string $URI URI pointing to the document.
169806     * @param string $encoding The document encoding or NULL.
169807     * @param int $options A bitmask of the LIBXML_* constants.
169808     * @return bool If called statically, returns an XMLReader.
169809     * @since PHP 5 >= 5.1.0, PHP 7
169810     **/
169811    public function open($URI, $encoding, $options){}
169812
169813    /**
169814     * Move to next node in document
169815     *
169816     * Moves cursor to the next node in the document.
169817     *
169818     * @return bool
169819     * @since PHP 5 >= 5.1.0, PHP 7
169820     **/
169821    public function read(){}
169822
169823    /**
169824     * Retrieve XML from current node
169825     *
169826     * Reads the contents of the current node, including child nodes and
169827     * markup.
169828     *
169829     * @return string Returns the contents of the current node as a string.
169830     *   Empty string on failure.
169831     * @since PHP 5 >= 5.2.0, PHP 7
169832     **/
169833    public function readInnerXml(){}
169834
169835    /**
169836     * Retrieve XML from current node, including itself
169837     *
169838     * Reads the contents of the current node, including the node itself.
169839     *
169840     * @return string Returns the contents of current node, including
169841     *   itself, as a string. Empty string on failure.
169842     * @since PHP 5 >= 5.2.0, PHP 7
169843     **/
169844    public function readOuterXml(){}
169845
169846    /**
169847     * Reads the contents of the current node as a string
169848     *
169849     * @return string Returns the content of the current node as a string.
169850     *   Empty string on failure.
169851     * @since PHP 5 >= 5.2.0, PHP 7
169852     **/
169853    public function readString(){}
169854
169855    /**
169856     * Set parser options
169857     *
169858     * Set parser options. The options must be set after XMLReader::open or
169859     * XMLReader::xml are called and before the first XMLReader::read call.
169860     *
169861     * @param int $property One of the parser option constants.
169862     * @param bool $value If set to TRUE the option will be enabled
169863     *   otherwise will be disabled.
169864     * @return bool
169865     * @since PHP 5 >= 5.1.0, PHP 7
169866     **/
169867    public function setParserProperty($property, $value){}
169868
169869    /**
169870     * Set the filename or URI for a RelaxNG Schema
169871     *
169872     * Set the filename or URI for the RelaxNG Schema to use for validation.
169873     *
169874     * @param string $filename filename or URI pointing to a RelaxNG
169875     *   Schema.
169876     * @return bool
169877     * @since PHP 5 >= 5.1.0, PHP 7
169878     **/
169879    public function setRelaxNGSchema($filename){}
169880
169881    /**
169882     * Set the data containing a RelaxNG Schema
169883     *
169884     * Set the data containing a RelaxNG Schema to use for validation.
169885     *
169886     * @param string $source String containing the RelaxNG Schema.
169887     * @return bool
169888     * @since PHP 5 >= 5.1.0, PHP 7
169889     **/
169890    public function setRelaxNGSchemaSource($source){}
169891
169892    /**
169893     * Validate document against XSD
169894     *
169895     * Use W3C XSD schema to validate the document as it is processed.
169896     * Activation is only possible before the first Read().
169897     *
169898     * @param string $filename The filename of the XSD schema.
169899     * @return bool
169900     * @since PHP 5 >= 5.2.0, PHP 7
169901     **/
169902    public function setSchema($filename){}
169903
169904    /**
169905     * Set the data containing the XML to parse
169906     *
169907     * @param string $source String containing the XML to be parsed.
169908     * @param string $encoding The document encoding or NULL.
169909     * @param int $options A bitmask of the LIBXML_* constants.
169910     * @return bool If called statically, returns an XMLReader.
169911     * @since PHP 5 >= 5.1.0, PHP 7
169912     **/
169913    public function xml($source, $encoding, $options){}
169914
169915}
169916class XMLWriter {
169917    /**
169918     * End attribute
169919     *
169920     * Ends the current attribute.
169921     *
169922     * @return bool
169923     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
169924     **/
169925    function endAttribute(){}
169926
169927    /**
169928     * End current CDATA
169929     *
169930     * Ends the current CDATA section.
169931     *
169932     * @return bool
169933     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
169934     **/
169935    function endCdata(){}
169936
169937    /**
169938     * Create end comment
169939     *
169940     * Ends the current comment.
169941     *
169942     * @return bool
169943     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 1.0.0
169944     **/
169945    function endComment(){}
169946
169947    /**
169948     * End current document
169949     *
169950     * Ends the current document.
169951     *
169952     * @return bool
169953     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
169954     **/
169955    function endDocument(){}
169956
169957    /**
169958     * End current DTD
169959     *
169960     * Ends the DTD of the document.
169961     *
169962     * @return bool
169963     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
169964     **/
169965    function endDtd(){}
169966
169967    /**
169968     * End current DTD AttList
169969     *
169970     * Ends the current DTD attribute list.
169971     *
169972     * @return bool
169973     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
169974     **/
169975    function endDtdAttlist(){}
169976
169977    /**
169978     * End current DTD element
169979     *
169980     * Ends the current DTD element.
169981     *
169982     * @return bool
169983     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
169984     **/
169985    function endDtdElement(){}
169986
169987    /**
169988     * End current DTD Entity
169989     *
169990     * Ends the current DTD entity.
169991     *
169992     * @return bool
169993     * @since PHP 5 >= 5.2.1, PHP 7, PECL xmlwriter >= 0.1.0
169994     **/
169995    function endDtdEntity(){}
169996
169997    /**
169998     * End current element
169999     *
170000     * Ends the current element.
170001     *
170002     * @return bool
170003     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170004     **/
170005    function endElement(){}
170006
170007    /**
170008     * End current PI
170009     *
170010     * Ends the current processing instruction.
170011     *
170012     * @return bool
170013     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170014     **/
170015    function endPi(){}
170016
170017    /**
170018     * Flush current buffer
170019     *
170020     * Flushes the current buffer.
170021     *
170022     * @param bool $empty Whether to empty the buffer or not. Default is
170023     *   TRUE.
170024     * @return mixed If you opened the writer in memory, this function
170025     *   returns the generated XML buffer, Else, if using URI, this function
170026     *   will write the buffer and return the number of written bytes.
170027     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 1.0.0
170028     **/
170029    function flush($empty){}
170030
170031    /**
170032     * End current element
170033     *
170034     * End the current xml element. Writes an end tag even if the element is
170035     * empty.
170036     *
170037     * @return bool
170038     * @since PHP 5 >= 5.2.0, PHP 7, PECL xmlwriter >= 2.0.4
170039     **/
170040    function fullEndElement(){}
170041
170042    /**
170043     * Create new xmlwriter using memory for string output
170044     *
170045     * Creates a new XMLWriter using memory for string output.
170046     *
170047     * @return bool :
170048     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170049     **/
170050    function openMemory(){}
170051
170052    /**
170053     * Create new xmlwriter using source uri for output
170054     *
170055     * Creates a new XMLWriter using {@link uri} for the output.
170056     *
170057     * @param string $uri The URI of the resource for the output.
170058     * @return bool :
170059     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170060     **/
170061    function openUri($uri){}
170062
170063    /**
170064     * Returns current buffer
170065     *
170066     * Returns the current buffer.
170067     *
170068     * @param bool $flush Whether to flush the output buffer or not.
170069     *   Default is TRUE.
170070     * @return string Returns the current buffer as a string.
170071     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170072     **/
170073    function outputMemory($flush){}
170074
170075    /**
170076     * Toggle indentation on/off
170077     *
170078     * Toggles indentation on or off.
170079     *
170080     * @param bool $indent Whether indentation is enabled.
170081     * @return bool
170082     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170083     **/
170084    function setIndent($indent){}
170085
170086    /**
170087     * Set string used for indenting
170088     *
170089     * Sets the string which will be used to indent each element/attribute of
170090     * the resulting xml.
170091     *
170092     * @param string $indentString The indentation string.
170093     * @return bool
170094     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170095     **/
170096    function setIndentString($indentString){}
170097
170098    /**
170099     * Create start attribute
170100     *
170101     * Starts an attribute.
170102     *
170103     * @param string $name The attribute name.
170104     * @return bool
170105     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170106     **/
170107    function startAttribute($name){}
170108
170109    /**
170110     * Create start namespaced attribute
170111     *
170112     * Starts a namespaced attribute.
170113     *
170114     * @param string $prefix The namespace prefix.
170115     * @param string $name The attribute name.
170116     * @param string $uri The namespace URI.
170117     * @return bool
170118     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170119     **/
170120    function startAttributeNs($prefix, $name, $uri){}
170121
170122    /**
170123     * Create start CDATA tag
170124     *
170125     * Starts a CDATA.
170126     *
170127     * @return bool
170128     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170129     **/
170130    function startCdata(){}
170131
170132    /**
170133     * Create start comment
170134     *
170135     * Starts a comment.
170136     *
170137     * @return bool
170138     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 1.0.0
170139     **/
170140    function startComment(){}
170141
170142    /**
170143     * Create document tag
170144     *
170145     * Starts a document.
170146     *
170147     * @param string $version The version number of the document as part of
170148     *   the XML declaration.
170149     * @param string $encoding The encoding of the document as part of the
170150     *   XML declaration.
170151     * @param string $standalone yes or no.
170152     * @return bool
170153     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170154     **/
170155    function startDocument($version, $encoding, $standalone){}
170156
170157    /**
170158     * Create start DTD tag
170159     *
170160     * Starts a DTD.
170161     *
170162     * @param string $qualifiedName The qualified name of the document type
170163     *   to create.
170164     * @param string $publicId The external subset public identifier.
170165     * @param string $systemId The external subset system identifier.
170166     * @return bool
170167     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170168     **/
170169    function startDtd($qualifiedName, $publicId, $systemId){}
170170
170171    /**
170172     * Create start DTD AttList
170173     *
170174     * Starts a DTD attribute list.
170175     *
170176     * @param string $name The attribute list name.
170177     * @return bool
170178     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170179     **/
170180    function startDtdAttlist($name){}
170181
170182    /**
170183     * Create start DTD element
170184     *
170185     * Starts a DTD element.
170186     *
170187     * @param string $qualifiedName The qualified name of the document type
170188     *   to create.
170189     * @return bool
170190     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170191     **/
170192    function startDtdElement($qualifiedName){}
170193
170194    /**
170195     * Create start DTD Entity
170196     *
170197     * Starts a DTD entity.
170198     *
170199     * @param string $name The name of the entity.
170200     * @param bool $isparam
170201     * @return bool
170202     * @since PHP 5 >= 5.2.1, PHP 7, PECL xmlwriter >= 0.1.0
170203     **/
170204    function startDtdEntity($name, $isparam){}
170205
170206    /**
170207     * Create start element tag
170208     *
170209     * Starts an element.
170210     *
170211     * @param string $name The element name.
170212     * @return bool
170213     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170214     **/
170215    function startElement($name){}
170216
170217    /**
170218     * Create start namespaced element tag
170219     *
170220     * Starts a namespaced element.
170221     *
170222     * @param string $prefix The namespace prefix.
170223     * @param string $name The element name.
170224     * @param string $uri The namespace URI.
170225     * @return bool
170226     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170227     **/
170228    function startElementNs($prefix, $name, $uri){}
170229
170230    /**
170231     * Create start PI tag
170232     *
170233     * Starts a processing instruction tag.
170234     *
170235     * @param string $target The target of the processing instruction.
170236     * @return bool
170237     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170238     **/
170239    function startPi($target){}
170240
170241    /**
170242     * Write text
170243     *
170244     * Writes a text.
170245     *
170246     * @param string $content The contents of the text.
170247     * @return bool
170248     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170249     **/
170250    function text($content){}
170251
170252    /**
170253     * Write full attribute
170254     *
170255     * Writes a full attribute.
170256     *
170257     * @param string $name The name of the attribute.
170258     * @param string $value The value of the attribute.
170259     * @return bool
170260     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170261     **/
170262    function writeAttribute($name, $value){}
170263
170264    /**
170265     * Write full namespaced attribute
170266     *
170267     * Writes a full namespaced attribute.
170268     *
170269     * @param string $prefix The namespace prefix.
170270     * @param string $name The attribute name.
170271     * @param string $uri The namespace URI.
170272     * @param string $content The attribute value.
170273     * @return bool
170274     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170275     **/
170276    function writeAttributeNs($prefix, $name, $uri, $content){}
170277
170278    /**
170279     * Write full CDATA tag
170280     *
170281     * Writes a full CDATA.
170282     *
170283     * @param string $content The contents of the CDATA.
170284     * @return bool
170285     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170286     **/
170287    function writeCdata($content){}
170288
170289    /**
170290     * Write full comment tag
170291     *
170292     * Writes a full comment.
170293     *
170294     * @param string $content The contents of the comment.
170295     * @return bool
170296     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170297     **/
170298    function writeComment($content){}
170299
170300    /**
170301     * Write full DTD tag
170302     *
170303     * Writes a full DTD.
170304     *
170305     * @param string $name The DTD name.
170306     * @param string $publicId The external subset public identifier.
170307     * @param string $systemId The external subset system identifier.
170308     * @param string $subset The content of the DTD.
170309     * @return bool
170310     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170311     **/
170312    function writeDtd($name, $publicId, $systemId, $subset){}
170313
170314    /**
170315     * Write full DTD AttList tag
170316     *
170317     * Writes a DTD attribute list.
170318     *
170319     * @param string $name The name of the DTD attribute list.
170320     * @param string $content The content of the DTD attribute list.
170321     * @return bool
170322     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170323     **/
170324    function writeDtdAttlist($name, $content){}
170325
170326    /**
170327     * Write full DTD element tag
170328     *
170329     * Writes a full DTD element.
170330     *
170331     * @param string $name The name of the DTD element.
170332     * @param string $content The content of the element.
170333     * @return bool
170334     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170335     **/
170336    function writeDtdElement($name, $content){}
170337
170338    /**
170339     * Write full DTD Entity tag
170340     *
170341     * Writes a full DTD entity.
170342     *
170343     * @param string $name The name of the entity.
170344     * @param string $content The content of the entity.
170345     * @param bool $pe
170346     * @param string $pubid
170347     * @param string $sysid
170348     * @param string $ndataid
170349     * @return bool
170350     * @since PHP 5 >= 5.2.1, PHP 7, PECL xmlwriter >= 0.1.0
170351     **/
170352    function writeDtdEntity($name, $content, $pe, $pubid, $sysid, $ndataid){}
170353
170354    /**
170355     * Write full element tag
170356     *
170357     * Writes a full element tag.
170358     *
170359     * @param string $name The element name.
170360     * @param string $content The element contents.
170361     * @return bool
170362     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170363     **/
170364    function writeElement($name, $content){}
170365
170366    /**
170367     * Write full namespaced element tag
170368     *
170369     * Writes a full namespaced element tag.
170370     *
170371     * @param string $prefix The namespace prefix.
170372     * @param string $name The element name.
170373     * @param string $uri The namespace URI.
170374     * @param string $content The element contents.
170375     * @return bool
170376     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170377     **/
170378    function writeElementNs($prefix, $name, $uri, $content){}
170379
170380    /**
170381     * Writes a PI
170382     *
170383     * Writes a processing instruction.
170384     *
170385     * @param string $target The target of the processing instruction.
170386     * @param string $content The content of the processing instruction.
170387     * @return bool
170388     * @since PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0
170389     **/
170390    function writePi($target, $content){}
170391
170392    /**
170393     * Write a raw XML text
170394     *
170395     * Writes a raw xml text.
170396     *
170397     * @param string $content The text string to write.
170398     * @return bool
170399     * @since PHP 5 >= 5.2.0, PHP 7, PECL xmlwriter >= 2.0.4
170400     **/
170401    function writeRaw($content){}
170402
170403}
170404class XSLTProcessor {
170405    /**
170406     * Get value of a parameter
170407     *
170408     * Gets a parameter if previously set by {@link
170409     * XSLTProcessor::setParameter}.
170410     *
170411     * @param string $namespaceURI The namespace URI of the XSLT parameter.
170412     * @param string $localName The local name of the XSLT parameter.
170413     * @return string The value of the parameter (as a string), or FALSE if
170414     *   it's not set.
170415     * @since PHP 5, PHP 7
170416     **/
170417    function getParameter($namespaceURI, $localName){}
170418
170419    /**
170420     * Get security preferences
170421     *
170422     * Gets the security preferences.
170423     *
170424     * @return int A bitmask consisting of XSL_SECPREF_READ_FILE,
170425     *   XSL_SECPREF_WRITE_FILE, XSL_SECPREF_CREATE_DIRECTORY,
170426     *   XSL_SECPREF_READ_NETWORK, XSL_SECPREF_WRITE_NETWORK.
170427     * @since PHP >= 5.4.0
170428     **/
170429    public function getSecurityPrefs(){}
170430
170431    /**
170432     * Determine if PHP has EXSLT support
170433     *
170434     * This method determines if PHP was built with the EXSLT library.
170435     *
170436     * @return bool
170437     * @since PHP 5 >= 5.0.4, PHP 7
170438     **/
170439    function hasExsltSupport(){}
170440
170441    /**
170442     * Import stylesheet
170443     *
170444     * This method imports the stylesheet into the XSLTProcessor for
170445     * transformations.
170446     *
170447     * @param object $stylesheet The imported style sheet as a DOMDocument
170448     *   or SimpleXMLElement object.
170449     * @return bool
170450     * @since PHP 5, PHP 7
170451     **/
170452    public function importStylesheet($stylesheet){}
170453
170454    /**
170455     * Enables the ability to use PHP functions as XSLT functions
170456     *
170457     * This method enables the ability to use PHP functions as XSLT functions
170458     * within XSL stylesheets.
170459     *
170460     * @param mixed $restrict Use this parameter to only allow certain
170461     *   functions to be called from XSLT. This parameter can be either a
170462     *   string (a function name) or an array of functions.
170463     * @return void
170464     * @since PHP 5 >= 5.0.4, PHP 7
170465     **/
170466    function registerPHPFunctions($restrict){}
170467
170468    /**
170469     * Remove parameter
170470     *
170471     * Removes a parameter, if set. This will make the processor use the
170472     * default value for the parameter as specified in the stylesheet.
170473     *
170474     * @param string $namespaceURI The namespace URI of the XSLT parameter.
170475     * @param string $localName The local name of the XSLT parameter.
170476     * @return bool
170477     * @since PHP 5, PHP 7
170478     **/
170479    function removeParameter($namespaceURI, $localName){}
170480
170481    /**
170482     * Set value for a parameter
170483     *
170484     * Sets the value of one or more parameters to be used in subsequent
170485     * transformations with XSLTProcessor. If the parameter doesn't exist in
170486     * the stylesheet it will be ignored.
170487     *
170488     * @param string $namespace The namespace URI of the XSLT parameter.
170489     * @param string $name The local name of the XSLT parameter.
170490     * @param string $value The new value of the XSLT parameter.
170491     * @return bool
170492     * @since PHP 5, PHP 7
170493     **/
170494    function setParameter($namespace, $name, $value){}
170495
170496    /**
170497     * Sets profiling output file
170498     *
170499     * Sets the file to output profiling information when processing a
170500     * stylesheet.
170501     *
170502     * @param string $filename Path to the file to dump profiling
170503     *   information.
170504     * @return bool
170505     * @since PHP >= 5.3.0
170506     **/
170507    function setProfiling($filename){}
170508
170509    /**
170510     * Set security preferences
170511     *
170512     * Sets the security preferences.
170513     *
170514     * @param int $securityPrefs The new security preferences. The
170515     *   following constants can be ORed: XSL_SECPREF_READ_FILE,
170516     *   XSL_SECPREF_WRITE_FILE, XSL_SECPREF_CREATE_DIRECTORY,
170517     *   XSL_SECPREF_READ_NETWORK, XSL_SECPREF_WRITE_NETWORK. Alternatively,
170518     *   XSL_SECPREF_NONE or XSL_SECPREF_DEFAULT can be passed.
170519     * @return int Returns the old security preferences.
170520     * @since PHP >= 5.4.0
170521     **/
170522    public function setSecurityPrefs($securityPrefs){}
170523
170524    /**
170525     * Transform to a DOMDocument
170526     *
170527     * Transforms the source node to a DOMDocument applying the stylesheet
170528     * given by the {@link XSLTProcessor::importStylesheet} method.
170529     *
170530     * @param DOMNode $doc The node to be transformed.
170531     * @return DOMDocument The resulting DOMDocument or FALSE on error.
170532     * @since PHP 5, PHP 7
170533     **/
170534    function transformToDoc($doc){}
170535
170536    /**
170537     * Transform to URI
170538     *
170539     * Transforms the source node to an URI applying the stylesheet given by
170540     * the {@link XSLTProcessor::importStylesheet} method.
170541     *
170542     * @param DOMDocument $doc The document to transform.
170543     * @param string $uri The target URI for the transformation.
170544     * @return int Returns the number of bytes written or FALSE if an error
170545     *   occurred.
170546     * @since PHP 5, PHP 7
170547     **/
170548    function transformToURI($doc, $uri){}
170549
170550    /**
170551     * Transform to XML
170552     *
170553     * Transforms the source node to a string applying the stylesheet given
170554     * by the {@link xsltprocessor::importStylesheet} method.
170555     *
170556     * @param object $doc The DOMDocument or SimpleXMLElement object to be
170557     *   transformed.
170558     * @return string The result of the transformation as a string or FALSE
170559     *   on error.
170560     * @since PHP 5, PHP 7
170561     **/
170562    function transformToXml($doc){}
170563
170564}
170565class Yac {
170566    /**
170567     * @var mixed
170568     **/
170569    protected $_prefix;
170570
170571    /**
170572     * Store into cache
170573     *
170574     * Added a item into cache.
170575     *
170576     * @param string $keys key
170577     * @param mixed $value mixed value, All php value type could be stored
170578     *   except
170579     * @param int $ttl expire time
170580     * @return bool , TRUE on success, FALSE on failure Yac::add may fail
170581     *   if cas lock could not obtain, so, if you need the value to be stored
170582     *   properly, you may write codes like: Make sure the item is stored
170583     *   while(!$yac->set("key", "vale));
170584     * @since PECL yac >= 1.0.0
170585     **/
170586    public function add($keys, $value, $ttl){}
170587
170588    /**
170589     * Remove items from cache
170590     *
170591     * remove items from cache
170592     *
170593     * @param string|array $keys string key, or array of multiple keys to
170594     *   be removed
170595     * @param int $ttl if delay is set, delete will mark the items to be
170596     *   invalid in ttl second.
170597     * @return bool
170598     * @since PECL yac >= 1.0.0
170599     **/
170600    public function delete($keys, $ttl){}
170601
170602    /**
170603     * Dump cache
170604     *
170605     * Dump values stored in cache
170606     *
170607     * @param int $num Maximum number of items should be returned
170608     * @return mixed mixed
170609     * @since PECL yac >= 1.0.0
170610     **/
170611    public function dump($num){}
170612
170613    /**
170614     * Flush the cache
170615     *
170616     * Remove all cached values
170617     *
170618     * @return bool bool, always true
170619     * @since PECL yac >= 1.0.0
170620     **/
170621    public function flush(){}
170622
170623    /**
170624     * Retrieve values from cache
170625     *
170626     * @param string|array $key keys, or of multiple keys.
170627     * @param int $cas if not NULL, it will be set to the retrieved item's
170628     *   cas.
170629     * @return mixed mixed on success, false on failure
170630     * @since PECL yac >= 1.0.0
170631     **/
170632    public function get($key, &$cas){}
170633
170634    /**
170635     * Status of cache
170636     *
170637     * Get status of cache system
170638     *
170639     * @return array Return an array, consistent with: "memory_size",
170640     *   "slots_memory_size", "values_memory_size", "segment_size",
170641     *   "segment_num", "miss", "hits", "fails", "kicks", "recycles",
170642     *   "slots_size", "slots_used"
170643     * @since PECL yac >= 1.0.0
170644     **/
170645    public function info(){}
170646
170647    /**
170648     * Store into cache
170649     *
170650     * Add a item into cache, it the key is already exists, override it.
170651     *
170652     * @param string $keys key
170653     * @param mixed $value mixed value, All php value type could be stored
170654     *   except
170655     * @param int $ttl expire time
170656     * @return bool the value self
170657     * @since PECL yac >= 1.0.0
170658     **/
170659    public function set($keys, $value, $ttl){}
170660
170661    /**
170662     * Getter
170663     *
170664     * Retrieve values from cache
170665     *
170666     * @param string $key key
170667     * @return mixed mixed on success, NULL on failure
170668     * @since PECL yac >= 1.0.0
170669     **/
170670    public function __get($key){}
170671
170672    /**
170673     * Setter
170674     *
170675     * store a item into cache
170676     *
170677     * @param string $keys key
170678     * @param mixed $value mixed value, All php value type could be stored
170679     *   except
170680     * @return mixed Always return the value self
170681     * @since PECL yac >= 1.0.0
170682     **/
170683    public function __set($keys, $value){}
170684
170685}
170686/**
170687 * Yaconf is a configurations container, it parses INIT files, stores the
170688 * result in PHP when PHP is started, the result lives with the whole PHP
170689 * lifecycle.
170690 **/
170691class Yaconf {
170692    /**
170693     * Retrieve a item
170694     *
170695     * @param string $name Configuration key, the key looks like
170696     *   "filename.key", or "filename.sectionName,key".
170697     * @param mixed $default_value if the key doesn't exists, Yaconf::get
170698     *   will return this as result.
170699     * @return mixed Returns configuration result(string or array) if the
170700     *   key exists, return default_value if not.
170701     * @since PECL yaconf >= 1.0.0
170702     **/
170703    public static function get($name, $default_value){}
170704
170705    /**
170706     * Determine if a item exists
170707     *
170708     * @param string $name
170709     * @return bool
170710     * @since PECL yaconf >= 1.0.0
170711     **/
170712    public static function has($name){}
170713
170714}
170715/**
170716 * A action can be defined in a separate file in Yaf(see
170717 * Yaf_Controller_Abstract). that is a action method can also be a
170718 * Yaf_Action_Abstract class. Since there should be a entry point which
170719 * can be called by Yaf (as of PHP 5.3, there is a new magic method
170720 * __invoke, but Yaf is not only works with PHP 5.3+, Yaf choose another
170721 * magic method execute), you must implement the abstract method
170722 * Yaf_Action_Abstract::execute in your custom action class.
170723 **/
170724abstract class Yaf_Action_Abstract extends Yaf_Controller_Abstract {
170725    /**
170726     * @var mixed
170727     **/
170728    protected $_controller;
170729
170730    /**
170731     * Action entry point
170732     *
170733     * user should always define this method for a action, this is the entry
170734     * point of an action. Yaf_Action_Abstract::execute may have agruments.
170735     * The value retrived from the request is not safe. you should do some
170736     * filtering work before you use it.
170737     *
170738     * @param mixed $arg
170739     * @param mixed ...$vararg
170740     * @return mixed
170741     * @since Yaf >=1.0.0
170742     **/
170743    abstract public function execute($arg, ...$vararg);
170744
170745    /**
170746     * Retrieve controller object
170747     *
170748     * retrieve current controller object.
170749     *
170750     * @return Yaf_Controller_Abstract Yaf_Controller_Abstract instance
170751     * @since Yaf >=1.0.0
170752     **/
170753    public function getController(){}
170754
170755    /**
170756     * Get controller name
170757     *
170758     * get the controller's name
170759     *
170760     * @return string , controller name
170761     **/
170762    public function getControllerName(){}
170763
170764}
170765/**
170766 * Yaf_Application provides a bootstrapping facility for applications
170767 * which provides reusable resources, common- and module-based bootstrap
170768 * classes and dependency checking. Yaf_Application implements the
170769 * singleton pattern, and Yaf_Application can not be serialized or
170770 * unserialized which will cause problem when you try to use PHPUnit to
170771 * write some test case for Yaf. You may use @backupGlobals annotation of
170772 * PHPUnit to control the backup and restore operations for global
170773 * variables. thus can solve this problem.
170774 **/
170775final class Yaf_Application {
170776    /**
170777     * @var mixed
170778     **/
170779    protected $config;
170780
170781    /**
170782     * @var mixed
170783     **/
170784    protected $dispatcher;
170785
170786    /**
170787     * @var mixed
170788     **/
170789    protected static $_app;
170790
170791    /**
170792     * @var mixed
170793     **/
170794    protected $_environ;
170795
170796    /**
170797     * @var mixed
170798     **/
170799    protected $_modules;
170800
170801    /**
170802     * @var mixed
170803     **/
170804    protected $_running;
170805
170806    /**
170807     * Retrieve an Application instance
170808     *
170809     * Retrieve the Yaf_Application instance. Alternatively, we also could
170810     * use Yaf_Dispatcher::getApplication.
170811     *
170812     * @return mixed A Yaf_Application instance, if no Yaf_Application was
170813     *   initialized before, NULL will be returned.
170814     * @since Yaf >=1.0.0
170815     **/
170816    public static function app(){}
170817
170818    /**
170819     * Call bootstrap
170820     *
170821     * Run a Bootstrap, all the methods defined in the Bootstrap and named
170822     * with prefix "_init" will be called according to their declaration
170823     * order, if the parameter bootstrap is not supplied, Yaf will look for a
170824     * Bootstrap under application.directory.
170825     *
170826     * @param Yaf_Bootstrap_Abstract $bootstrap A Yaf_Bootstrap_Abstract
170827     *   instance
170828     * @return void Yaf_Application instance
170829     * @since Yaf >=1.0.0
170830     **/
170831    public function bootstrap($bootstrap){}
170832
170833    /**
170834     * Clear the last error info
170835     *
170836     * @return Yaf_Application
170837     * @since Yaf >=2.1.2
170838     **/
170839    public function clearLastError(){}
170840
170841    /**
170842     * Retrive environ
170843     *
170844     * Retrive environ which was defined in yaf.environ which has a default
170845     * value "product".
170846     *
170847     * @return void
170848     * @since Yaf >=1.0.0
170849     **/
170850    public function environ(){}
170851
170852    /**
170853     * Execute a callback
170854     *
170855     * This method is typically used to run Yaf_Application in a crontab
170856     * work. Make the crontab work can also use the autoloader and Bootstrap
170857     * mechanism.
170858     *
170859     * @param callable $entry a valid callback
170860     * @param string ...$vararg parameters will pass to the callback
170861     * @return void
170862     * @since Yaf >=1.0.0
170863     **/
170864    public function execute($entry, ...$vararg){}
170865
170866    /**
170867     * Get the application directory
170868     *
170869     * @return Yaf_Application
170870     * @since Yaf >=2.1.4
170871     **/
170872    public function getAppDirectory(){}
170873
170874    /**
170875     * Retrive the config instance
170876     *
170877     * @return Yaf_Config_Abstract A Yaf_Config_Abstract instance
170878     * @since Yaf >=1.0.0
170879     **/
170880    public function getConfig(){}
170881
170882    /**
170883     * Get Yaf_Dispatcher instance
170884     *
170885     * @return Yaf_Dispatcher
170886     * @since Yaf >=1.0.0
170887     **/
170888    public function getDispatcher(){}
170889
170890    /**
170891     * Get message of the last occurred error
170892     *
170893     * @return string
170894     * @since Yaf >=2.1.2
170895     **/
170896    public function getLastErrorMsg(){}
170897
170898    /**
170899     * Get code of last occurred error
170900     *
170901     * @return int
170902     * @since Yaf >=2.1.2
170903     **/
170904    public function getLastErrorNo(){}
170905
170906    /**
170907     * Get defined module names
170908     *
170909     * Get the modules list defined in config, if no one defined, there will
170910     * always be a module named "Index".
170911     *
170912     * @return array
170913     * @since Yaf >=1.0.0
170914     **/
170915    public function getModules(){}
170916
170917    /**
170918     * Start Yaf_Application
170919     *
170920     * Run a Yaf_Application, let the Yaf_Application accept a request and
170921     * route this request, dispatch to controller/action and render response.
170922     * Finally, return the response to the client.
170923     *
170924     * @return void
170925     * @since Yaf >=1.0.0
170926     **/
170927    public function run(){}
170928
170929    /**
170930     * Change the application directory
170931     *
170932     * @param string $directory
170933     * @return Yaf_Application
170934     * @since Yaf >=2.1.4
170935     **/
170936    public function setAppDirectory($directory){}
170937
170938    /**
170939     * Yaf_Application constructor
170940     *
170941     * Instance a Yaf_Application.
170942     *
170943     * @param mixed $config A ini config file path, or a config array If is
170944     *   a ini config file, there should be a section named as the one
170945     *   defined by yaf.environ, which is "product" by default. If you use a
170946     *   ini configuration file as your applicatioin's config container. you
170947     *   would open the yaf.cache_config to improve performance. And the
170948     *   config entry(and there default value) list blow: A ini config file
170949     *   example
170950     *
170951     *   [product] ;this one should alway be defined, and have no default
170952     *   value application.directory=APPLICATION_PATH
170953     *
170954     *   ;following configs have default value, you may no need to define
170955     *   them application.library = APPLICATION_PATH . "/library"
170956     *   application.dispatcher.throwException=1
170957     *   application.dispatcher.catchException=1
170958     *
170959     *   application.baseUri=""
170960     *
170961     *   ;the php script ext name ap.ext=php
170962     *
170963     *   ;the view template ext name ap.view.ext=phtml
170964     *
170965     *   ap.dispatcher.defaultModuel=Index
170966     *   ap.dispatcher.defaultController=Index
170967     *   ap.dispatcher.defaultAction=index
170968     *
170969     *   ;defined modules ap.modules=Index
170970     * @param string $envrion Which section will be loaded as the final
170971     *   config
170972     * @since Yaf >=1.0.0
170973     **/
170974    public function __construct($config, $envrion){}
170975
170976    /**
170977     * The __destruct purpose
170978     *
170979     * @return void
170980     * @since Yaf >=1.0.0
170981     **/
170982    public function __destruct(){}
170983
170984}
170985/**
170986 * Bootstrap is a mechanism used to do some initial config before a
170987 * Application run. User may define their own Bootstrap class by
170988 * inheriting Yaf_Bootstrap_Abstract Any method declared in Bootstrap
170989 * class with leading "_init", will be called by
170990 * Yaf_Application::bootstrap one by one according to their defined
170991 * order.
170992 **/
170993abstract class Yaf_Bootstrap_Abstract {
170994}
170995abstract class Yaf_Config_Abstract {
170996    /**
170997     * @var mixed
170998     **/
170999    protected $_config;
171000
171001    /**
171002     * @var mixed
171003     **/
171004    protected $_readonly;
171005
171006    /**
171007     * Getter
171008     *
171009     * @param string $name
171010     * @param mixed $value
171011     * @return mixed
171012     * @since Yaf >=1.0.0
171013     **/
171014    abstract public function get($name, $value);
171015
171016    /**
171017     * Find a config whether readonly
171018     *
171019     * @return bool
171020     * @since Yaf >=1.0.0
171021     **/
171022    abstract public function readonly();
171023
171024    /**
171025     * Setter
171026     *
171027     * @return Yaf_Config_Abstract
171028     * @since Yaf >=1.0.0
171029     **/
171030    abstract public function set();
171031
171032    /**
171033     * Cast to array
171034     *
171035     * @return array
171036     * @since Yaf >=1.0.0
171037     **/
171038    abstract public function toArray();
171039
171040}
171041/**
171042 * Yaf_Config_Ini enables developers to store configuration data in a
171043 * familiar INI format and read them in the application by using nested
171044 * object property syntax. The INI format is specialized to provide both
171045 * the ability to have a hierarchy of configuration data keys and
171046 * inheritance between configuration data sections. Configuration data
171047 * hierarchies are supported by separating the keys with the dot or
171048 * period character ("."). A section may extend or inherit from another
171049 * section by following the section name with a colon character (":") and
171050 * the name of the section from which data are to be inherited.
171051 * Yaf_Config_Ini utilizes the » parse_ini_file() PHP function. Please
171052 * review this documentation to be aware of its specific behaviors, which
171053 * propagate to Yaf_Config_Ini, such as how the special values of "TRUE",
171054 * "FALSE", "yes", "no", and "NULL" are handled.
171055 **/
171056class Yaf_Config_Ini extends Yaf_Config_Abstract implements Iterator, ArrayAccess, Countable {
171057    /**
171058     * Count all elements in Yaf_Config.ini
171059     *
171060     * @return void
171061     * @since Yaf >=1.0.0
171062     **/
171063    public function count(){}
171064
171065    /**
171066     * Retrieve the current value
171067     *
171068     * @return void
171069     * @since Yaf >=1.0.0
171070     **/
171071    public function current(){}
171072
171073    /**
171074     * Fetch current element's key
171075     *
171076     * @return void
171077     * @since Yaf >=1.0.0
171078     **/
171079    public function key(){}
171080
171081    /**
171082     * Advance the internal pointer
171083     *
171084     * @return void
171085     * @since Yaf >=1.0.0
171086     **/
171087    public function next(){}
171088
171089    /**
171090     * The offsetExists purpose
171091     *
171092     * @param string $name
171093     * @return void
171094     * @since Yaf >=1.0.0
171095     **/
171096    public function offsetExists($name){}
171097
171098    /**
171099     * The offsetGet purpose
171100     *
171101     * @param string $name
171102     * @return void
171103     * @since Yaf >=1.0.0
171104     **/
171105    public function offsetGet($name){}
171106
171107    /**
171108     * The offsetSet purpose
171109     *
171110     * @param string $name
171111     * @param string $value
171112     * @return void
171113     * @since Yaf >=1.0.0
171114     **/
171115    public function offsetSet($name, $value){}
171116
171117    /**
171118     * The offsetUnset purpose
171119     *
171120     * @param string $name
171121     * @return void
171122     * @since Yaf >=1.0.0
171123     **/
171124    public function offsetUnset($name){}
171125
171126    /**
171127     * The readonly purpose
171128     *
171129     * @return void
171130     * @since Yaf >=1.0.0
171131     **/
171132    public function readonly(){}
171133
171134    /**
171135     * The rewind purpose
171136     *
171137     * @return void
171138     * @since Yaf >=1.0.0
171139     **/
171140    public function rewind(){}
171141
171142    /**
171143     * Return config as a PHP array
171144     *
171145     * Returns a PHP array from the Yaf_Config_Ini
171146     *
171147     * @return array
171148     * @since Yaf >=1.0.0
171149     **/
171150    public function toArray(){}
171151
171152    /**
171153     * The valid purpose
171154     *
171155     * @return void
171156     * @since Yaf >=1.0.0
171157     **/
171158    public function valid(){}
171159
171160    /**
171161     * Yaf_Config_Ini constructor
171162     *
171163     * Yaf_Config_Ini constructor
171164     *
171165     * @param string $config_file path to an INI configure file
171166     * @param string $section which section in that INI file you want to be
171167     *   parsed
171168     * @since Yaf >=1.0.0
171169     **/
171170    public function __construct($config_file, $section){}
171171
171172    /**
171173     * Retrieve a element
171174     *
171175     * @param string $name
171176     * @return void
171177     * @since Yaf >=1.0.0
171178     **/
171179    public function __get($name){}
171180
171181    /**
171182     * Determine if a key is exists
171183     *
171184     * @param string $name
171185     * @return void
171186     * @since Yaf >=1.0.0
171187     **/
171188    public function __isset($name){}
171189
171190    /**
171191     * The __set purpose
171192     *
171193     * @param string $name
171194     * @param mixed $value
171195     * @return void
171196     * @since Yaf >=1.0.0
171197     **/
171198    public function __set($name, $value){}
171199
171200}
171201class Yaf_Config_Simple extends Yaf_Config_Abstract implements Iterator, ArrayAccess, Countable {
171202    /**
171203     * @var mixed
171204     **/
171205    protected $_readonly;
171206
171207    /**
171208     * The count purpose
171209     *
171210     * @return void
171211     * @since Yaf >=1.0.0
171212     **/
171213    public function count(){}
171214
171215    /**
171216     * The current purpose
171217     *
171218     * @return void
171219     * @since Yaf >=1.0.0
171220     **/
171221    public function current(){}
171222
171223    /**
171224     * The key purpose
171225     *
171226     * @return void
171227     * @since Yaf >=1.0.0
171228     **/
171229    public function key(){}
171230
171231    /**
171232     * The next purpose
171233     *
171234     * @return void
171235     * @since Yaf >=1.0.0
171236     **/
171237    public function next(){}
171238
171239    /**
171240     * The offsetExists purpose
171241     *
171242     * @param string $name
171243     * @return void
171244     * @since Yaf >=1.0.0
171245     **/
171246    public function offsetExists($name){}
171247
171248    /**
171249     * The offsetGet purpose
171250     *
171251     * @param string $name
171252     * @return void
171253     * @since Yaf >=1.0.0
171254     **/
171255    public function offsetGet($name){}
171256
171257    /**
171258     * The offsetSet purpose
171259     *
171260     * @param string $name
171261     * @param string $value
171262     * @return void
171263     * @since Yaf >=1.0.0
171264     **/
171265    public function offsetSet($name, $value){}
171266
171267    /**
171268     * The offsetUnset purpose
171269     *
171270     * @param string $name
171271     * @return void
171272     * @since Yaf >=1.0.0
171273     **/
171274    public function offsetUnset($name){}
171275
171276    /**
171277     * The readonly purpose
171278     *
171279     * @return void
171280     * @since Yaf >=1.0.0
171281     **/
171282    public function readonly(){}
171283
171284    /**
171285     * The rewind purpose
171286     *
171287     * @return void
171288     * @since Yaf >=1.0.0
171289     **/
171290    public function rewind(){}
171291
171292    /**
171293     * Returns a PHP array
171294     *
171295     * Returns a PHP array from the Yaf_Config_Simple
171296     *
171297     * @return array
171298     * @since Yaf >=1.0.0
171299     **/
171300    public function toArray(){}
171301
171302    /**
171303     * The valid purpose
171304     *
171305     * @return void
171306     * @since Yaf >=1.0.0
171307     **/
171308    public function valid(){}
171309
171310    /**
171311     * The __construct purpose
171312     *
171313     * @param array $configs
171314     * @param bool $readonly
171315     * @since Yaf >=1.0.0
171316     **/
171317    public function __construct($configs, $readonly){}
171318
171319    /**
171320     * The __get purpose
171321     *
171322     * @param string $name
171323     * @return void
171324     * @since Yaf >=1.0.0
171325     **/
171326    public function __get($name){}
171327
171328    /**
171329     * The __isset purpose
171330     *
171331     * @param string $name
171332     * @return void
171333     * @since Yaf >=1.0.0
171334     **/
171335    public function __isset($name){}
171336
171337    /**
171338     * The __set purpose
171339     *
171340     * @param string $name
171341     * @param string $value
171342     * @return void
171343     * @since Yaf >=1.0.0
171344     **/
171345    public function __set($name, $value){}
171346
171347}
171348/**
171349 * Yaf_Controller_Abstract is the heart of Yaf's system. MVC stands for
171350 * Model-View-Controller and is a design pattern targeted at separating
171351 * application logic from display logic. Every custom controller shall
171352 * inherit Yaf_Controller_Abstract. You will find that you can not define
171353 * __construct function for your custom controller, thus,
171354 * Yaf_Controller_Abstract provides a magic method:
171355 * Yaf_Controller_Abstract::init. If you have defined a init() method in
171356 * your custom controller, it will be called as long as the controller
171357 * was instantiated. Action may have arguments, when a request coming, if
171358 * there are the same name variable in the request parameters(see
171359 * Yaf_Request_Abstract::getParam) after routed, Yaf will pass them to
171360 * the action method (see Yaf_Action_Abstract::execute). These arguments
171361 * are directly fetched without filtering, it should be carefully
171362 * processed before use them.
171363 **/
171364abstract class Yaf_Controller_Abstract {
171365    /**
171366     * @var mixed
171367     **/
171368    public $actions;
171369
171370    /**
171371     * @var mixed
171372     **/
171373    protected $_invoke_args;
171374
171375    /**
171376     * @var mixed
171377     **/
171378    protected $_module;
171379
171380    /**
171381     * @var mixed
171382     **/
171383    protected $_name;
171384
171385    /**
171386     * @var mixed
171387     **/
171388    protected $_request;
171389
171390    /**
171391     * @var mixed
171392     **/
171393    protected $_response;
171394
171395    /**
171396     * @var mixed
171397     **/
171398    protected $_view;
171399
171400    /**
171401     * The display purpose
171402     *
171403     * @param string $tpl
171404     * @param array $parameters
171405     * @return bool
171406     * @since Yaf >=1.0.0
171407     **/
171408    protected function display($tpl, $parameters){}
171409
171410    /**
171411     * Foward to another action
171412     *
171413     * forward current execution process to other action. this method doesn't
171414     * switch to the destination action immediately, it will take place after
171415     * current flow finish.
171416     *
171417     * @param string $action destination module name, if NULL was given,
171418     *   then default module name is assumed
171419     * @param array $paramters destination controller name
171420     * @return void return FALSE on failure
171421     * @since Yaf >=1.0.0
171422     **/
171423    public function forward($action, $paramters){}
171424
171425    /**
171426     * The getInvokeArg purpose
171427     *
171428     * @param string $name
171429     * @return void
171430     * @since Yaf >=1.0.0
171431     **/
171432    public function getInvokeArg($name){}
171433
171434    /**
171435     * The getInvokeArgs purpose
171436     *
171437     * @return void
171438     * @since Yaf >=1.0.0
171439     **/
171440    public function getInvokeArgs(){}
171441
171442    /**
171443     * Get module name
171444     *
171445     * get the controller's module name
171446     *
171447     * @return string
171448     * @since Yaf >=1.0.0
171449     **/
171450    public function getModuleName(){}
171451
171452    /**
171453     * Get self name
171454     *
171455     * get the controller's name
171456     *
171457     * @return string , controller name
171458     * @since Yaf >=3.2.0
171459     **/
171460    public function getName(){}
171461
171462    /**
171463     * Retrieve current request object
171464     *
171465     * retrieve current request object
171466     *
171467     * @return Yaf_Request_Abstract Yaf_Request_Abstract instance
171468     * @since Yaf >=1.0.0
171469     **/
171470    public function getRequest(){}
171471
171472    /**
171473     * Retrieve current response object
171474     *
171475     * retrieve current response object
171476     *
171477     * @return Yaf_Response_Abstract Yaf_Response_Abstract instance
171478     * @since Yaf >=1.0.0
171479     **/
171480    public function getResponse(){}
171481
171482    /**
171483     * Retrieve the view engine
171484     *
171485     * retrieve view engine
171486     *
171487     * @return Yaf_View_Interface
171488     * @since Yaf >=1.0.0
171489     **/
171490    public function getView(){}
171491
171492    /**
171493     * The getViewpath purpose
171494     *
171495     * @return string
171496     * @since Yaf >=1.0.0
171497     **/
171498    public function getViewpath(){}
171499
171500    /**
171501     * Controller initializer
171502     *
171503     * Yaf_Controller_Abstract::__construct is final, which means users can
171504     * not override it. but users can define Yaf_Controller_Abstract::init,
171505     * which will be called after controller object is instantiated.
171506     *
171507     * @return void
171508     * @since Yaf >=1.0.0
171509     **/
171510    public function init(){}
171511
171512    /**
171513     * The initView purpose
171514     *
171515     * @param array $options
171516     * @return void
171517     * @since Yaf >=1.0.0
171518     **/
171519    public function initView($options){}
171520
171521    /**
171522     * Redirect to a URL
171523     *
171524     * redirect to a URL by sending a 302 header
171525     *
171526     * @param string $url a location URL
171527     * @return bool bool
171528     * @since Yaf >=1.0.0
171529     **/
171530    public function redirect($url){}
171531
171532    /**
171533     * Render view template
171534     *
171535     * @param string $tpl
171536     * @param array $parameters
171537     * @return string
171538     * @since Yaf >=1.0.0
171539     **/
171540    protected function render($tpl, $parameters){}
171541
171542    /**
171543     * The setViewpath purpose
171544     *
171545     * @param string $view_directory
171546     * @return void
171547     * @since Yaf >=1.0.0
171548     **/
171549    public function setViewpath($view_directory){}
171550
171551    /**
171552     * Yaf_Controller_Abstract constructor
171553     *
171554     * Yaf_Controller_Abstract::__construct is final, which means it can not
171555     * be overridden. You may want to see Yaf_Controller_Abstract::init
171556     * instead.
171557     *
171558     * @since Yaf >=1.0.0
171559     **/
171560    final private function __construct(){}
171561
171562}
171563/**
171564 * Yaf_Dispatcher purpose is to initialize the request environment, route
171565 * the incoming request, and then dispatch any discovered actions; it
171566 * aggregates any responses and returns them when the process is
171567 * complete. Yaf_Dispatcher also implements the Singleton pattern,
171568 * meaning only a single instance of it may be available at any given
171569 * time. This allows it to also act as a registry on which the other
171570 * objects in the dispatch process may draw.
171571 **/
171572final class Yaf_Dispatcher {
171573    /**
171574     * @var mixed
171575     **/
171576    protected $_auto_render;
171577
171578    /**
171579     * @var mixed
171580     **/
171581    protected $_default_action;
171582
171583    /**
171584     * @var mixed
171585     **/
171586    protected $_default_controller;
171587
171588    /**
171589     * @var mixed
171590     **/
171591    protected $_default_module;
171592
171593    /**
171594     * @var mixed
171595     **/
171596    protected static $_instance;
171597
171598    /**
171599     * @var mixed
171600     **/
171601    protected $_instantly_flush;
171602
171603    /**
171604     * @var mixed
171605     **/
171606    protected $_plugins;
171607
171608    /**
171609     * @var mixed
171610     **/
171611    protected $_request;
171612
171613    /**
171614     * @var mixed
171615     **/
171616    protected $_return_response;
171617
171618    /**
171619     * @var mixed
171620     **/
171621    protected $_router;
171622
171623    /**
171624     * @var mixed
171625     **/
171626    protected $_view;
171627
171628    /**
171629     * Switch on/off autorendering
171630     *
171631     * Yaf_Dispatcher will render automatically after dispatches a incoming
171632     * request, you can prevent the rendering by calling this method with
171633     * {@link flag} TRUE you can simply return FALSE in a action to prevent
171634     * the auto-rendering of that action
171635     *
171636     * @param bool $flag bool since 2.2.0, if this parameter is not given,
171637     *   then the current state will be renturned
171638     * @return Yaf_Dispatcher
171639     * @since Yaf >=1.0.0
171640     **/
171641    public function autoRender($flag){}
171642
171643    /**
171644     * Switch on/off exception catching
171645     *
171646     * While the application.dispatcher.throwException is On(you can also
171647     * calling to Yaf_Dispatcher::throwException(TRUE) to enable it), Yaf
171648     * will throw Exception whe error occurrs instead of trigger error.
171649     *
171650     * then if you enable Yaf_Dispatcher::catchException(also can enabled by
171651     * set application.dispatcher.catchException), all uncaught Exceptions
171652     * will be caught by ErrorController::error if you have defined one.
171653     *
171654     * @param bool $flag bool
171655     * @return Yaf_Dispatcher
171656     * @since Yaf >=1.0.0
171657     **/
171658    public function catchException($flag){}
171659
171660    /**
171661     * Disable view rendering
171662     *
171663     * disable view engine, used in some app that user will output by
171664     * theirself you can simply return FALSE in a action to prevent the
171665     * auto-rendering of that action
171666     *
171667     * @return bool
171668     * @since Yaf >=1.0.0
171669     **/
171670    public function disableView(){}
171671
171672    /**
171673     * Dispatch a request
171674     *
171675     * This method does the heavy work of the Yaf_Dispatcher. It take a
171676     * request object.
171677     *
171678     * The dispatch process has three distinct events: Routing Dispatching
171679     * Response Routing takes place exactly once, using the values in the
171680     * request object when dispatch() is called. Dispatching takes place in a
171681     * loop; a request may either indicate multiple actions to dispatch, or
171682     * the controller or a plugin may reset the request object to force
171683     * additional actions to dispatch(see Yaf_Plugin_Abstract. When all is
171684     * done, the Yaf_Dispatcher returns a response.
171685     *
171686     * @param Yaf_Request_Abstract $request
171687     * @return Yaf_Response_Abstract
171688     * @since Yaf >=1.0.0
171689     **/
171690    public function dispatch($request){}
171691
171692    /**
171693     * Enable view rendering
171694     *
171695     * @return Yaf_Dispatcher
171696     * @since Yaf >=1.0.0
171697     **/
171698    public function enableView(){}
171699
171700    /**
171701     * Switch on/off the instant flushing
171702     *
171703     * @param bool $flag bool since 2.2.0, if this parameter is not given,
171704     *   then the current state will be renturned
171705     * @return Yaf_Dispatcher
171706     * @since Yaf >=1.0.0
171707     **/
171708    public function flushInstantly($flag){}
171709
171710    /**
171711     * Retrive the application
171712     *
171713     * Retrive the Yaf_Application instance. same as Yaf_Application::app.
171714     *
171715     * @return Yaf_Application
171716     * @since Yaf >=1.0.0
171717     **/
171718    public function getApplication(){}
171719
171720    /**
171721     * Retrive the default action name
171722     *
171723     * get the default action name
171724     *
171725     * @return string , default action name, default is "index"
171726     * @since Yaf >=3.2.0
171727     **/
171728    public function getDefaultAction(){}
171729
171730    /**
171731     * Retrive the default controller name
171732     *
171733     * get the default controller name
171734     *
171735     * @return string , default controller name, default is "Index"
171736     * @since Yaf >=3.2.0
171737     **/
171738    public function getDefaultController(){}
171739
171740    /**
171741     * Retrive the default module name
171742     *
171743     * get the default module name
171744     *
171745     * @return string , module name, default is "Index"
171746     * @since Yaf >=3.2.0
171747     **/
171748    public function getDefaultModule(){}
171749
171750    /**
171751     * Retrive the dispatcher instance
171752     *
171753     * @return Yaf_Dispatcher
171754     * @since Yaf >=1.0.0
171755     **/
171756    public static function getInstance(){}
171757
171758    /**
171759     * Retrive the request instance
171760     *
171761     * @return Yaf_Request_Abstract
171762     * @since Yaf >=1.0.0
171763     **/
171764    public function getRequest(){}
171765
171766    /**
171767     * Retrive router instance
171768     *
171769     * @return Yaf_Router
171770     * @since Yaf >=1.0.0
171771     **/
171772    public function getRouter(){}
171773
171774    /**
171775     * Initialize view and return it
171776     *
171777     * @param string $templates_dir
171778     * @param array $options
171779     * @return Yaf_View_Interface
171780     * @since Yaf >=1.0.0
171781     **/
171782    public function initView($templates_dir, $options){}
171783
171784    /**
171785     * Register a plugin
171786     *
171787     * Register a plugin(see Yaf_Plugin_Abstract). Generally, we register
171788     * plugins in Bootstrap(see Yaf_Bootstrap_Abstract).
171789     *
171790     * @param Yaf_Plugin_Abstract $plugin
171791     * @return Yaf_Dispatcher
171792     * @since Yaf >=1.0.0
171793     **/
171794    public function registerPlugin($plugin){}
171795
171796    /**
171797     * The returnResponse purpose
171798     *
171799     * @param bool $flag
171800     * @return Yaf_Dispatcher
171801     * @since Yaf >=1.0.0
171802     **/
171803    public function returnResponse($flag){}
171804
171805    /**
171806     * Change default action name
171807     *
171808     * @param string $action
171809     * @return Yaf_Dispatcher
171810     * @since Yaf >=1.0.0
171811     **/
171812    public function setDefaultAction($action){}
171813
171814    /**
171815     * Change default controller name
171816     *
171817     * @param string $controller
171818     * @return Yaf_Dispatcher
171819     * @since Yaf >=1.0.0
171820     **/
171821    public function setDefaultController($controller){}
171822
171823    /**
171824     * Change default module name
171825     *
171826     * @param string $module
171827     * @return Yaf_Dispatcher
171828     * @since Yaf >=1.0.0
171829     **/
171830    public function setDefaultModule($module){}
171831
171832    /**
171833     * Set error handler
171834     *
171835     * Set error handler for Yaf. when application.dispatcher.throwException
171836     * is off, Yaf will trigger catchable error while unexpected errors
171837     * occrred.
171838     *
171839     * Thus, this error handler will be called while the error raise.
171840     *
171841     * @param call $callback A callable callback
171842     * @param int $error_types
171843     * @return Yaf_Dispatcher
171844     * @since Yaf >=1.0.0
171845     **/
171846    public function setErrorHandler($callback, $error_types){}
171847
171848    /**
171849     * The setRequest purpose
171850     *
171851     * @param Yaf_Request_Abstract $request
171852     * @return Yaf_Dispatcher
171853     * @since Yaf >=1.0.0
171854     **/
171855    public function setRequest($request){}
171856
171857    /**
171858     * Set a custom view engine
171859     *
171860     * This method proviods a solution for that if you want use a custom view
171861     * engine instead of Yaf_View_Simple
171862     *
171863     * @param Yaf_View_Interface $view A Yaf_View_Interface instance
171864     * @return Yaf_Dispatcher
171865     * @since Yaf >=1.0.0
171866     **/
171867    public function setView($view){}
171868
171869    /**
171870     * Switch on/off exception throwing
171871     *
171872     * Siwtch on/off exception throwing while unexpected error occurring.
171873     * When this is on, Yaf will throwing exceptions instead of triggering
171874     * catchable errors.
171875     *
171876     * You can also use application.dispatcher.throwException to achieve the
171877     * same purpose.
171878     *
171879     * @param bool $flag bool
171880     * @return Yaf_Dispatcher
171881     * @since Yaf >=1.0.0
171882     **/
171883    public function throwException($flag){}
171884
171885    /**
171886     * Yaf_Dispatcher constructor
171887     *
171888     * @since Yaf >=1.0.0
171889     **/
171890    public function __construct(){}
171891
171892}
171893class Yaf_Exception extends Exception {
171894    /**
171895     * The getPrevious purpose
171896     *
171897     * @return void
171898     * @since Yaf >=1.0.0
171899     **/
171900    public function getPrevious(){}
171901
171902    /**
171903     * The __construct purpose
171904     *
171905     * @since Yaf >=1.0.0
171906     **/
171907    public function __construct(){}
171908
171909}
171910class Yaf_Exception_DispatchFailed extends Yaf_Exception {
171911}
171912class Yaf_Exception_LoadFailed extends Yaf_Exception {
171913}
171914class Yaf_Exception_LoadFailed_Action extends Yaf_Exception_LoadFailed {
171915}
171916class Yaf_Exception_LoadFailed_Controller extends Yaf_Exception_LoadFailed {
171917}
171918class Yaf_Exception_LoadFailed_Module extends Yaf_Exception_LoadFailed {
171919}
171920class Yaf_Exception_LoadFailed_View extends Yaf_Exception_LoadFailed {
171921}
171922class Yaf_Exception_RouterFailed extends Yaf_Exception {
171923}
171924class Yaf_Exception_StartupError extends Yaf_Exception {
171925}
171926class Yaf_Exception_TypeError extends Yaf_Exception {
171927}
171928/**
171929 * Yaf_Loader introduces a comprehensive autoloading solution for Yaf.
171930 * The first time an instance of Yaf_Application is retrieved, Yaf_Loader
171931 * will instance a singleton, and registers itself with spl_autoload. You
171932 * retrieve an instance using the Yaf_Loader::getInstance Yaf_Loader
171933 * attempt to load a class only one shot, if failed, depend on
171934 * yaf.use_spl_auload, if this config is On Yaf_Loader::autoload will
171935 * return FALSE, thus give the chance to other autoload function. if it
171936 * is Off (by default), Yaf_Loader::autoload will return TRUE, and more
171937 * important is that a very useful warning will be triggered (very useful
171938 * to find out why a class could not be loaded). Please keep
171939 * yaf.use_spl_autoload Off unless there is some library have their own
171940 * autoload mechanism and impossible to rewrite it. By default,
171941 * Yaf_Loader assume all library (class defined script) store in the
171942 * global library directory, which is defined in the
171943 * php.ini(yaf.library). If you want Yaf_Loader search some
171944 * classes(libraries) in the local class directory(which is defined in
171945 * application.ini, and by default, it is application.directory .
171946 * "/library"), you should register the class prefix using the
171947 * Yaf_Loader::registerLocalNameSpace Let's see some examples(assuming
171948 * APPLICATION_PATH is application.directory): Config example
171949 *
171950 * // Assuming the following configure in php.ini: yaf.library =
171951 * "/global_dir"
171952 *
171953 * //Assuming the following configure in application.ini
171954 * application.library = APPLICATION_PATH "/library"
171955 *
171956 * Assuming the following local name space is registered: Register
171957 * localnamespace
171958 *
171959 * Then the autoload examples: Load class example
171960 *
171961 * class Foo_Bar_Test => // APPLICATION_PATH/library/Foo/Bar/Test.php
171962 * class GLO_Name => // /global_dir/Glo/Name.php class BarNon_Test //
171963 * /global_dir/Barnon/Test.php
171964 *
171965 * As of PHP 5.3, you can use namespace: Load namespace class example
171966 *
171967 * class \Foo\Bar\Dummy => // APPLICATION_PATH/library/Foo/Bar/Dummy.php
171968 *
171969 * class \FooBar\Bar\Dummy => // /global_dir/FooBar/Bar/Dummy.php You may
171970 * noticed that all the folder with the first letter capitalized, you can
171971 * make them lowercase by set yaf.lowcase_path = On in php.ini Yaf_Loader
171972 * is also designed to load the MVC classes, and the rule is: MVC class
171973 * loading example
171974 *
171975 * Controller Classes => // APPLICATION_PATH/controllers/
171976 *
171977 * Model Classes => // APPLICATION_PATH/models/
171978 *
171979 * Plugin Classes => // APPLICATION_PATH/plugins/
171980 *
171981 * Yaf identify a class's suffix(this is by default, you can also change
171982 * to the prefix by change the configure yaf.name_suffix) to decide
171983 * whether it is a MVC class: MVC class distinctions
171984 *
171985 * Controller Classes => // ***Controller
171986 *
171987 * Model Classes => // ***Model
171988 *
171989 * Plugin Classes => // ***Plugin
171990 *
171991 * some examples: MVC loading example
171992 *
171993 * class IndexController // APPLICATION_PATH/controllers/Index.php
171994 *
171995 * class DataModel => // APPLICATION_PATH/models/Data.php
171996 *
171997 * class DummyPlugin => // APPLICATION_PATH/plugins/Dummy.php
171998 *
171999 * class A_B_TestModel => // APPLICATION_PATH/models/A/B/Test.php
172000 *
172001 * As of 2.1.18, Yaf supports Controllers autoloading for user script
172002 * side, (which means the autoloading triggered by user php script, eg:
172003 * access a controller static property in Bootstrap or Plugins), but
172004 * autoloader only try to locate controller class script under the
172005 * default module folder, which is "APPLICATION_PATH/controllers/". also,
172006 * the directory will be affected by yaf.lowcase_path.
172007 **/
172008class Yaf_Loader {
172009    /**
172010     * @var mixed
172011     **/
172012    protected $_global_library;
172013
172014    /**
172015     * @var mixed
172016     **/
172017    static $_instance;
172018
172019    /**
172020     * @var mixed
172021     **/
172022    protected $_library;
172023
172024    /**
172025     * @var mixed
172026     **/
172027    protected $_local_ns;
172028
172029    /**
172030     * The autoload purpose
172031     *
172032     * @return void
172033     * @since Yaf >=1.0.0
172034     **/
172035    public function autoload(){}
172036
172037    /**
172038     * The clearLocalNamespace purpose
172039     *
172040     * @return void
172041     * @since Yaf >=1.0.0
172042     **/
172043    public function clearLocalNamespace(){}
172044
172045    /**
172046     * The getInstance purpose
172047     *
172048     * @return void
172049     * @since Yaf >=1.0.0
172050     **/
172051    public static function getInstance(){}
172052
172053    /**
172054     * Get the library path
172055     *
172056     * @param bool $is_global
172057     * @return Yaf_Loader
172058     * @since Yaf >=2.1.4
172059     **/
172060    public function getLibraryPath($is_global){}
172061
172062    /**
172063     * The getLocalNamespace purpose
172064     *
172065     * @return void
172066     * @since Yaf >=1.0.0
172067     **/
172068    public function getLocalNamespace(){}
172069
172070    /**
172071     * Retieve path of a registered namespace
172072     *
172073     * retrieve path of a registered namespace
172074     *
172075     * @param string $namespaces a string of namespace.
172076     * @return string path, if the namespace is not registered, then NULL
172077     *   default library will be returned
172078     * @since Yaf >=3.2.0
172079     **/
172080    public function getNamespacePath($namespaces){}
172081
172082    /**
172083     * Retrive all register namespaces info
172084     *
172085     * get registered namespaces info
172086     *
172087     * @return array
172088     * @since Yaf >=3.2.0
172089     **/
172090    public function getNamespaces(){}
172091
172092    /**
172093     * The import purpose
172094     *
172095     * @return void
172096     * @since Yaf >=1.0.0
172097     **/
172098    public static function import(){}
172099
172100    /**
172101     * The isLocalName purpose
172102     *
172103     * @return void
172104     * @since Yaf >=1.0.0
172105     **/
172106    public function isLocalName(){}
172107
172108    /**
172109     * Register local class prefix
172110     *
172111     * Register local class prefix name, Yaf_Loader search classes in two
172112     * library directories, the one is configured via
172113     * application.library.directory(in application.ini) which is called
172114     * local libraray directory; the other is configured via yaf.library (in
172115     * php.ini) which is callled global library directory, since it can be
172116     * shared by many applications in the same server.
172117     *
172118     * When an autloading is trigger, Yaf_Loader will determine which library
172119     * directory should be searched in by exame the prefix name of the missed
172120     * classname.
172121     *
172122     * If the prefix name is registered as a localnamespack then look for it
172123     * in local library directory, otherwise look for it in global library
172124     * directory. If yaf.library is not configured, then the global library
172125     * directory is assumed to be the local library directory. in that case,
172126     * all autoloading will look for local library directory.
172127     *
172128     * But if you want your Yaf application be strong, then always register
172129     * your own classes as local classes.
172130     *
172131     * @param mixed $prefix a string or a array of class name prefix. all
172132     *   class prefix with these prefix will be loaded in local library path.
172133     * @return void bool
172134     * @since Yaf >=1.0.0
172135     **/
172136    public function registerLocalNamespace($prefix){}
172137
172138    /**
172139     * Register namespace with searching path
172140     *
172141     * Register a namespace with searching path, Yaf_Loader searchs classes
172142     * under this namespace in path, the one is also could be configureded
172143     * via application.library.directory.namespace(in application.ini);
172144     *
172145     * Yaf still think underline as folder separator.
172146     *
172147     * @param string|array $namespaces a string of namespace, or a array of
172148     *   namespaces with paths.
172149     * @param string $path a string of path, it it better to use abosolute
172150     *   path here for performance
172151     * @return bool bool
172152     * @since Yaf >=3.2.0
172153     **/
172154    public function registerNamespace($namespaces, $path){}
172155
172156    /**
172157     * Change the library path
172158     *
172159     * @param string $directory
172160     * @param bool $is_global
172161     * @return Yaf_Loader
172162     * @since Yaf >=2.1.4
172163     **/
172164    public function setLibraryPath($directory, $is_global){}
172165
172166    /**
172167     * The __construct purpose
172168     *
172169     * @since Yaf >=1.0.0
172170     **/
172171    private function __construct(){}
172172
172173}
172174/**
172175 * Plugins allow for easy extensibility and customization of the
172176 * framework. Plugins are classes. The actual class definition will vary
172177 * based on the component -- you may need to implement this interface,
172178 * but the fact remains that the plugin is itself a class. A plugin could
172179 * be loaded into Yaf by using Yaf_Dispatcher::registerPlugin, after
172180 * registering, All the methods which the plugin implemented according to
172181 * this interface, will be called at the proper time.
172182 **/
172183class Yaf_Plugin_Abstract {
172184    /**
172185     * The dispatchLoopShutdown purpose
172186     *
172187     * This is the latest hook in Yaf plugin hook system, if a custom plugin
172188     * implement this method, then it will be called after the dispatch loop
172189     * finished.
172190     *
172191     * @param Yaf_Request_Abstract $request
172192     * @param Yaf_Response_Abstract $response
172193     * @return void
172194     * @since Yaf >=1.0.0
172195     **/
172196    public function dispatchLoopShutdown($request, $response){}
172197
172198    /**
172199     * Hook before dispatch loop
172200     *
172201     * @param Yaf_Request_Abstract $request
172202     * @param Yaf_Response_Abstract $response
172203     * @return void
172204     * @since Yaf >=1.0.0
172205     **/
172206    public function dispatchLoopStartup($request, $response){}
172207
172208    /**
172209     * The postDispatch purpose
172210     *
172211     * @param Yaf_Request_Abstract $request
172212     * @param Yaf_Response_Abstract $response
172213     * @return void
172214     * @since Yaf >=1.0.0
172215     **/
172216    public function postDispatch($request, $response){}
172217
172218    /**
172219     * The preDispatch purpose
172220     *
172221     * @param Yaf_Request_Abstract $request
172222     * @param Yaf_Response_Abstract $response
172223     * @return void
172224     * @since Yaf >=1.0.0
172225     **/
172226    public function preDispatch($request, $response){}
172227
172228    /**
172229     * The preResponse purpose
172230     *
172231     * @param Yaf_Request_Abstract $request
172232     * @param Yaf_Response_Abstract $response
172233     * @return void
172234     * @since Yaf >=1.0.0
172235     **/
172236    public function preResponse($request, $response){}
172237
172238    /**
172239     * The routerShutdown purpose
172240     *
172241     * This hook will be trigged after the route process finished, this hook
172242     * is usually used for login check.
172243     *
172244     * @param Yaf_Request_Abstract $request
172245     * @param Yaf_Response_Abstract $response
172246     * @return void
172247     * @since Yaf >=1.0.0
172248     **/
172249    public function routerShutdown($request, $response){}
172250
172251    /**
172252     * RouterStartup hook
172253     *
172254     * This is the earliest hook in Yaf plugin hook system, if a custom
172255     * plugin implement this method, then it will be called before routing a
172256     * request.
172257     *
172258     * @param Yaf_Request_Abstract $request
172259     * @param Yaf_Response_Abstract $response
172260     * @return void
172261     * @since Yaf >=1.0.0
172262     **/
172263    public function routerStartup($request, $response){}
172264
172265}
172266/**
172267 * All methods of Yaf_Registry declared as static, making it unversally
172268 * accessible. This provides the ability to get or set any custom data
172269 * from anyway in your code as necessary.
172270 **/
172271class Yaf_Registry {
172272    /**
172273     * @var mixed
172274     **/
172275    protected $_entries;
172276
172277    /**
172278     * @var mixed
172279     **/
172280    static $_instance;
172281
172282    /**
172283     * Remove an item from registry
172284     *
172285     * @param string $name
172286     * @return void
172287     * @since Yaf >=1.0.0
172288     **/
172289    public static function del($name){}
172290
172291    /**
172292     * Retrieve an item from registry
172293     *
172294     * @param string $name
172295     * @return mixed
172296     * @since Yaf >=1.0.0
172297     **/
172298    public static function get($name){}
172299
172300    /**
172301     * Check whether an item exists
172302     *
172303     * @param string $name
172304     * @return bool
172305     * @since Yaf >=1.0.0
172306     **/
172307    public static function has($name){}
172308
172309    /**
172310     * Add an item into registry
172311     *
172312     * @param string $name
172313     * @param string $value
172314     * @return bool
172315     * @since Yaf >=1.0.0
172316     **/
172317    public static function set($name, $value){}
172318
172319    /**
172320     * Yaf_Registry implements singleton
172321     *
172322     * @since Yaf >=1.0.0
172323     **/
172324    private function __construct(){}
172325
172326}
172327class Yaf_Request_Abstract {
172328    /**
172329     * @var string
172330     **/
172331    const SCHEME_HTTP = '';
172332
172333    /**
172334     * @var string
172335     **/
172336    const SCHEME_HTTPS = '';
172337
172338    /**
172339     * @var mixed
172340     **/
172341    public $action;
172342
172343    /**
172344     * @var mixed
172345     **/
172346    public $controller;
172347
172348    /**
172349     * @var mixed
172350     **/
172351    protected $dispatched;
172352
172353    /**
172354     * @var mixed
172355     **/
172356    protected $language;
172357
172358    /**
172359     * @var mixed
172360     **/
172361    public $method;
172362
172363    /**
172364     * @var mixed
172365     **/
172366    public $module;
172367
172368    /**
172369     * @var mixed
172370     **/
172371    protected $params;
172372
172373    /**
172374     * @var mixed
172375     **/
172376    protected $routed;
172377
172378    /**
172379     * @var mixed
172380     **/
172381    protected $uri;
172382
172383    /**
172384     * @var mixed
172385     **/
172386    protected $_base_uri;
172387
172388    /**
172389     * @var mixed
172390     **/
172391    protected $_exception;
172392
172393    /**
172394     * Remove all params
172395     *
172396     * Remove all params set by router, or Yaf_Request_Abstract::setParam
172397     *
172398     * @return bool
172399     **/
172400    public function clearParams(){}
172401
172402    /**
172403     * The getActionName purpose
172404     *
172405     * @return void
172406     * @since Yaf >=1.0.0
172407     **/
172408    public function getActionName(){}
172409
172410    /**
172411     * The getBaseUri purpose
172412     *
172413     * @return void
172414     * @since Yaf >=1.0.0
172415     **/
172416    public function getBaseUri(){}
172417
172418    /**
172419     * The getControllerName purpose
172420     *
172421     * @return void
172422     * @since Yaf >=1.0.0
172423     **/
172424    public function getControllerName(){}
172425
172426    /**
172427     * Retrieve ENV varialbe
172428     *
172429     * Retrieve ENV variable
172430     *
172431     * @param string $name the variable name
172432     * @param string $default if this parameter is provide, this will be
172433     *   returned if the varialbe can not be found
172434     * @return void Returns string
172435     * @since Yaf >=1.0.0
172436     **/
172437    public function getEnv($name, $default){}
172438
172439    /**
172440     * The getException purpose
172441     *
172442     * @return void
172443     * @since Yaf >=1.0.0
172444     **/
172445    public function getException(){}
172446
172447    /**
172448     * Retrieve client's prefered language
172449     *
172450     * @return void Returns a string
172451     * @since Yaf >=1.0.0
172452     **/
172453    public function getLanguage(){}
172454
172455    /**
172456     * Retrieve the request method
172457     *
172458     * @return string Return a string, like "POST", "GET" etc.
172459     * @since Yaf >=1.0.0
172460     **/
172461    public function getMethod(){}
172462
172463    /**
172464     * The getModuleName purpose
172465     *
172466     * @return void
172467     * @since Yaf >=1.0.0
172468     **/
172469    public function getModuleName(){}
172470
172471    /**
172472     * Retrieve calling parameter
172473     *
172474     * @param string $name
172475     * @param string $default
172476     * @return mixed
172477     * @since Yaf >=1.0.0
172478     **/
172479    public function getParam($name, $default){}
172480
172481    /**
172482     * Retrieve all calling parameters
172483     *
172484     * @return array
172485     * @since Yaf >=1.0.0
172486     **/
172487    public function getParams(){}
172488
172489    /**
172490     * The getRequestUri purpose
172491     *
172492     * @return void
172493     * @since Yaf >=1.0.0
172494     **/
172495    public function getRequestUri(){}
172496
172497    /**
172498     * Retrieve SERVER variable
172499     *
172500     * @param string $name the variable name
172501     * @param string $default if this parameter is provide, this will be
172502     *   returned if the variable can not be found
172503     * @return void
172504     * @since Yaf >=1.0.0
172505     **/
172506    public function getServer($name, $default){}
172507
172508    /**
172509     * Determine if request is CLI request
172510     *
172511     * @return bool bolean
172512     * @since Yaf >=1.0.0
172513     **/
172514    public function isCli(){}
172515
172516    /**
172517     * Determin if the request is dispatched
172518     *
172519     * @return bool boolean
172520     * @since Yaf >=1.0.0
172521     **/
172522    public function isDispatched(){}
172523
172524    /**
172525     * Determine if request is GET request
172526     *
172527     * @return bool boolean
172528     * @since Yaf >=1.0.0
172529     **/
172530    public function isGet(){}
172531
172532    /**
172533     * Determine if request is HEAD request
172534     *
172535     * @return bool boolean
172536     * @since Yaf >=1.0.0
172537     **/
172538    public function isHead(){}
172539
172540    /**
172541     * Determine if request is OPTIONS request
172542     *
172543     * @return bool boolean
172544     * @since Yaf >=1.0.0
172545     **/
172546    public function isOptions(){}
172547
172548    /**
172549     * Determine if request is POST request
172550     *
172551     * @return bool boolean
172552     * @since Yaf >=1.0.0
172553     **/
172554    public function isPost(){}
172555
172556    /**
172557     * Determine if request is PUT request
172558     *
172559     * @return bool boolean
172560     * @since Yaf >=1.0.0
172561     **/
172562    public function isPut(){}
172563
172564    /**
172565     * Determin if request has been routed
172566     *
172567     * @return bool boolean
172568     * @since Yaf >=1.0.0
172569     **/
172570    public function isRouted(){}
172571
172572    /**
172573     * Determine if request is AJAX request
172574     *
172575     * @return bool boolean
172576     * @since Yaf >=1.0.0
172577     **/
172578    public function isXmlHttpRequest(){}
172579
172580    /**
172581     * Set action name
172582     *
172583     * set action name to request, this is usually used by custom router to
172584     * set route result controller name.
172585     *
172586     * @param string $action , action name, it should in lower case style,
172587     *   like "index" or "foo_bar"
172588     * @param bool $format_name this is introduced in Yaf 3.2.0, by default
172589     *   Yaf will format the name into lower case style, if this is set to
172590     *   FALSE , Yaf will set the original name to request.
172591     * @return void
172592     * @since Yaf >=1.0.0
172593     **/
172594    public function setActionName($action, $format_name){}
172595
172596    /**
172597     * Set base URI
172598     *
172599     * Set base URI, base URI is used when doing routing, in routing phase
172600     * request URI is used to route a request, while base URI is used to skip
172601     * the leadding part(base URI) of request URI.
172602     *
172603     * That is, if comes a request with request URI a/b/c, then if you set
172604     * base URI to "a/b", only "/c" will be used in routing phase. generally,
172605     * you don't need to set this, Yaf will determine it automatically.
172606     *
172607     * @param string $uir base URI
172608     * @return bool bool
172609     * @since Yaf >=1.0.0
172610     **/
172611    public function setBaseUri($uir){}
172612
172613    /**
172614     * Set controller name
172615     *
172616     * set controller name to request, this is usually used by custom router
172617     * to set route result controller name.
172618     *
172619     * @param string $controller , controller name, this should be in camel
172620     *   style, like "Index" or "Foo_Bar"
172621     * @param bool $format_name this is introduced in Yaf 3.2.0, by default
172622     *   Yaf will format the name into camel mode, if this is set to FALSE ,
172623     *   Yaf will set the original name to request.
172624     * @return void
172625     * @since Yaf >=1.0.0
172626     **/
172627    public function setControllerName($controller, $format_name){}
172628
172629    /**
172630     * The setDispatched purpose
172631     *
172632     * @return void
172633     * @since Yaf >=1.0.0
172634     **/
172635    public function setDispatched(){}
172636
172637    /**
172638     * Set module name
172639     *
172640     * set module name to request, this is usually used by custom router to
172641     * set route result module name.
172642     *
172643     * @param string $module module name, it should be in camel style, like
172644     *   "Index" or "Foo_Bar"
172645     * @param bool $format_name this is introduced in Yaf 3.2.0, by default
172646     *   Yaf will format the name into camel mode, if this is set to FALSE ,
172647     *   Yaf will set the original name to request.
172648     * @return void
172649     * @since Yaf >=1.0.0
172650     **/
172651    public function setModuleName($module, $format_name){}
172652
172653    /**
172654     * Set a calling parameter to a request
172655     *
172656     * Set a parameter to request, which can be retrieved by
172657     * Yaf_Request_Abstract::getParam
172658     *
172659     * @param string $name
172660     * @param string $value
172661     * @return bool
172662     * @since Yaf >=1.0.0
172663     **/
172664    public function setParam($name, $value){}
172665
172666    /**
172667     * The setRequestUri purpose
172668     *
172669     * @param string $uir
172670     * @return void
172671     * @since Yaf >=2.1.0
172672     **/
172673    public function setRequestUri($uir){}
172674
172675    /**
172676     * The setRouted purpose
172677     *
172678     * @param string $flag
172679     * @return void
172680     * @since Yaf >=1.0.0
172681     **/
172682    public function setRouted($flag){}
172683
172684}
172685/**
172686 * Any request from client is initialized as a Yaf_Request_Http. you can
172687 * get the request information like, uri query and post parameters via
172688 * methods of this class. For security, $_GET/$_POST are readonly in Yaf,
172689 * which means if you set a value to these global variables, you can not
172690 * get it from Yaf_Request_Http::getQuery or Yaf_Request_Http::getPost.
172691 * But there do is some usage need such feature, like unit testing. thus
172692 * Yaf can be built with --enable-yaf-debug, which will allow Yaf read
172693 * the value user set via script. in such case, Yaf will throw a E_STRICT
172694 * warning to remind you about that: Strict Standards: you are running
172695 * yaf in debug mode
172696 **/
172697class Yaf_Request_Http extends Yaf_Request_Abstract {
172698    /**
172699     * Retrieve variable from client
172700     *
172701     * Retrieve variable from client, this method will search the {@link
172702     * name} in request pramas, if the name is not found, then will search in
172703     * POST, GET, Cookie, Server
172704     *
172705     * @param string $name the variable name
172706     * @param string $default if this parameter is provide, this will be
172707     *   returned if the varialbe can not be found
172708     * @return mixed
172709     * @since Yaf >=1.0.0
172710     **/
172711    public function get($name, $default){}
172712
172713    /**
172714     * Retrieve Cookie variable
172715     *
172716     * @param string $name the cookie name
172717     * @param string $default if this parameter is provide, this will be
172718     *   returned if the cookie can not be found
172719     * @return mixed
172720     * @since Yaf >=1.0.0
172721     **/
172722    public function getCookie($name, $default){}
172723
172724    /**
172725     * The getFiles purpose
172726     *
172727     * @return void
172728     * @since Yaf >=1.0.0
172729     **/
172730    public function getFiles(){}
172731
172732    /**
172733     * Retrieve POST variable
172734     *
172735     * @param string $name the variable name
172736     * @param string $default if this parameter is provide, this will be
172737     *   returned if the varialbe can not be found
172738     * @return mixed
172739     * @since Yaf >=1.0.0
172740     **/
172741    public function getPost($name, $default){}
172742
172743    /**
172744     * Fetch a query parameter
172745     *
172746     * Retrieve GET variable
172747     *
172748     * @param string $name the variable name
172749     * @param string $default if this parameter is provide, this will be
172750     *   returned if the variable can not be found
172751     * @return mixed
172752     * @since Yaf >=1.0.0
172753     **/
172754    public function getQuery($name, $default){}
172755
172756    /**
172757     * Retrieve Raw request body
172758     *
172759     * @return mixed Return string on success, FALSE on failure.
172760     * @since Yaf >=3.0.7
172761     **/
172762    public function getRaw(){}
172763
172764    /**
172765     * The getRequest purpose
172766     *
172767     * @return void
172768     * @since Yaf >=1.0.0
172769     **/
172770    public function getRequest(){}
172771
172772    /**
172773     * Determin if request is Ajax Request
172774     *
172775     * Check the request whether it is a Ajax Request. This method depends on
172776     * the request header: HTTP_X_REQUESTED_WITH, some Javascript library
172777     * doesn't set this header while doing Ajax request
172778     *
172779     * @return bool boolean
172780     * @since Yaf >=1.0.0
172781     **/
172782    public function isXmlHttpRequest(){}
172783
172784    /**
172785     * Constructor of Yaf_Request_Http
172786     *
172787     * @param string $request_uri
172788     * @param string $base_uri
172789     * @since Yaf >=1.0.0
172790     **/
172791    public function __construct($request_uri, $base_uri){}
172792
172793}
172794/**
172795 * Yaf_Request_Simple is particularlly used for test puporse. ie.
172796 * simulate some espacial request under CLI mode.
172797 **/
172798class Yaf_Request_Simple extends Yaf_Request_Abstract {
172799    /**
172800     * @var string
172801     **/
172802    const SCHEME_HTTP = '';
172803
172804    /**
172805     * @var string
172806     **/
172807    const SCHEME_HTTPS = '';
172808
172809    /**
172810     * The get purpose
172811     *
172812     * @return void
172813     * @since Yaf >=1.0.0
172814     **/
172815    public function get(){}
172816
172817    /**
172818     * The getCookie purpose
172819     *
172820     * @return void
172821     * @since Yaf >=1.0.0
172822     **/
172823    public function getCookie(){}
172824
172825    /**
172826     * The getFiles purpose
172827     *
172828     * @return void
172829     * @since Yaf >=1.0.0
172830     **/
172831    public function getFiles(){}
172832
172833    /**
172834     * The getPost purpose
172835     *
172836     * @return void
172837     * @since Yaf >=1.0.0
172838     **/
172839    public function getPost(){}
172840
172841    /**
172842     * The getQuery purpose
172843     *
172844     * @return void
172845     * @since Yaf >=1.0.0
172846     **/
172847    public function getQuery(){}
172848
172849    /**
172850     * The getRequest purpose
172851     *
172852     * @return void
172853     * @since Yaf >=1.0.0
172854     **/
172855    public function getRequest(){}
172856
172857    /**
172858     * Determin if request is AJAX request
172859     *
172860     * @return void Always returns false for Yaf_Request_Simple
172861     * @since Yaf >=1.0.0
172862     **/
172863    public function isXmlHttpRequest(){}
172864
172865    /**
172866     * Constructor of Yaf_Request_Simple
172867     *
172868     * @param string $method
172869     * @param string $module
172870     * @param string $controller
172871     * @param string $action
172872     * @param array $params
172873     * @since Yaf >=1.0.0
172874     **/
172875    public function __construct($method, $module, $controller, $action, $params){}
172876
172877}
172878class Yaf_Response_Abstract {
172879    /**
172880     * @var string
172881     **/
172882    const DEFAULT_BODY = '';
172883
172884    /**
172885     * @var mixed
172886     **/
172887    protected $_body;
172888
172889    /**
172890     * @var mixed
172891     **/
172892    protected $_header;
172893
172894    /**
172895     * @var mixed
172896     **/
172897    protected $_sendheader;
172898
172899    /**
172900     * Append to response body
172901     *
172902     * Append a content to a exists content block
172903     *
172904     * @param string $content content string
172905     * @param string $key the content key, you can set a content with a
172906     *   key, if you don't specific, then Yaf_Response_Abstract::DEFAULT_BODY
172907     *   will be used this parameter is introduced as of 2.2.0
172908     * @return bool bool
172909     * @since Yaf >=1.0.0
172910     **/
172911    public function appendBody($content, $key){}
172912
172913    /**
172914     * Discard all exists response body
172915     *
172916     * Clear existsed content
172917     *
172918     * @param string $key the content key, if you don't specific, then all
172919     *   contents will be cleared. this parameter is introduced as of 2.2.0
172920     * @return bool
172921     * @since Yaf >=1.0.0
172922     **/
172923    public function clearBody($key){}
172924
172925    /**
172926     * Discard all set headers
172927     *
172928     * @return void
172929     * @since Yaf >=1.0.0
172930     **/
172931    public function clearHeaders(){}
172932
172933    /**
172934     * Retrieve a exists content
172935     *
172936     * @param string $key the content key, if you don't specific, then
172937     *   Yaf_Response_Abstract::DEFAULT_BODY will be used. if you pass in a
172938     *   NULL, then all contents will be returned as a array this parameter
172939     *   is introduced as of 2.2.0
172940     * @return mixed
172941     * @since Yaf >=1.0.0
172942     **/
172943    public function getBody($key){}
172944
172945    /**
172946     * The getHeader purpose
172947     *
172948     * @return void
172949     * @since Yaf >=1.0.0
172950     **/
172951    public function getHeader(){}
172952
172953    /**
172954     * The prependBody purpose
172955     *
172956     * prepend a content to a exists content block
172957     *
172958     * @param string $content content string
172959     * @param string $key the content key, you can set a content with a
172960     *   key, if you don't specific, then Yaf_Response_Abstract::DEFAULT_BODY
172961     *   will be used this parameter is introduced as of 2.2.0
172962     * @return bool bool
172963     * @since Yaf >=1.0.0
172964     **/
172965    public function prependBody($content, $key){}
172966
172967    /**
172968     * Send response
172969     *
172970     * send response
172971     *
172972     * @return void
172973     * @since Yaf >=1.0.0
172974     **/
172975    public function response(){}
172976
172977    /**
172978     * The setAllHeaders purpose
172979     *
172980     * @return void
172981     * @since Yaf >=1.0.0
172982     **/
172983    protected function setAllHeaders(){}
172984
172985    /**
172986     * Set content to response
172987     *
172988     * @param string $content content string
172989     * @param string $key the content key, you can set a content with a
172990     *   key, if you don't specific, then Yaf_Response_Abstract::DEFAULT_BODY
172991     *   will be used this parameter is introduced as of 2.2.0
172992     * @return bool
172993     * @since Yaf >=1.0.0
172994     **/
172995    public function setBody($content, $key){}
172996
172997    /**
172998     * Set reponse header
172999     *
173000     * Used to send a HTTP header
173001     *
173002     * @param string $name
173003     * @param string $value
173004     * @param bool $replace
173005     * @return bool
173006     * @since Yaf >=1.0.0
173007     **/
173008    public function setHeader($name, $value, $replace){}
173009
173010    /**
173011     * The setRedirect purpose
173012     *
173013     * @return void
173014     * @since Yaf >=1.0.0
173015     **/
173016    public function setRedirect(){}
173017
173018    /**
173019     * The __construct purpose
173020     *
173021     * @since Yaf >=1.0.0
173022     **/
173023    public function __construct(){}
173024
173025    /**
173026     * The __destruct purpose
173027     *
173028     * @return void
173029     * @since Yaf >=1.0.0
173030     **/
173031    public function __destruct(){}
173032
173033    /**
173034     * Retrieve all bodys as string
173035     *
173036     * @return string
173037     * @since Yaf >=1.0.0
173038     **/
173039    private function __toString(){}
173040
173041}
173042class Yaf_Response_Cli extends Yaf_Response_Abstract {
173043}
173044class Yaf_Response_Http extends Yaf_Response_Abstract {
173045    /**
173046     * @var mixed
173047     **/
173048    protected $_response_code;
173049
173050    /**
173051     * @var mixed
173052     **/
173053    protected $_sendheader;
173054
173055}
173056/**
173057 * Yaf_Router is the standard framework router. Routing is the process of
173058 * taking a URI endpoint (that part of the URI which comes after the base
173059 * URI: see Yaf_Request_Abstract::setBaseUri) and decomposing it into
173060 * parameters to determine which module, controller, and action of that
173061 * controller should receive the request. This values of the module,
173062 * controller, action and other parameters are packaged into a
173063 * Yaf_Request_Abstract object which is then processed by Yaf_Dispatcher.
173064 * Routing occurs only once: when the request is initially received and
173065 * before the first controller is dispatched.
173066 *
173067 * Yaf_Router is designed to allow for mod_rewrite-like functionality
173068 * using pure PHP structures. It is very loosely based on Ruby on Rails
173069 * routing and does not require any prior knowledge of webserver URL
173070 * rewriting. It is designed to work with a single Apache mod_rewrite
173071 * rule (one of): Rewrite rule for Apache
173072 *
173073 * RewriteEngine on RewriteRule !\.(js|ico|gif|jpg|png|css|html)$
173074 * index.php
173075 *
173076 * or (preferred): Rewrite rule for Apache
173077 *
173078 * RewriteEngine On RewriteCond %{REQUEST_FILENAME} -s [OR] RewriteCond
173079 * %{REQUEST_FILENAME} -l [OR] RewriteCond %{REQUEST_FILENAME} -d
173080 * RewriteRule ^.*$ - [NC,L] RewriteRule ^.*$ index.php [NC,L]
173081 *
173082 * If using Lighttpd, the following rewrite rule is valid: Rewrite rule
173083 * for Lighttpd
173084 *
173085 * url.rewrite-once = ( ".*\?(.*)$" => "/index.php?$1",
173086 * ".*\.(js|ico|gif|jpg|png|css|html)$" => "$0", "" => "/index.php" )
173087 *
173088 * If using Nginx, use the following rewrite rule: Rewrite rule for Nginx
173089 *
173090 * server { listen ****; server_name yourdomain.com; root document_root;
173091 * index index.php index.html;
173092 *
173093 * if (!-e $request_filename) { rewrite ^/(.*) /index.php/$1 last; } }
173094 * Yaf_Router comes preconfigured with a default route Yaf_Route_Static,
173095 * which will match URIs in the shape of controller/action. Additionally,
173096 * a module name may be specified as the first path element, allowing
173097 * URIs of the form module/controller/action. Finally, it will also match
173098 * any additional parameters appended to the URI by default -
173099 * controller/action/var1/value1/var2/value2. Module name must be defined
173100 * in config, considering application.module="Index,Foo,Bar", in this
173101 * case, only index, foo and bar can be considered as a module name. if
173102 * doesn't config, there is only one module named "Index". Some examples
173103 * of how such routes are matched: Yaf_Route_Static(default route)example
173104 *
173105 * // Assuming the following configure: $conf = array( "application" =>
173106 * array( "modules" => "Index,Blog", ), );
173107 *
173108 * Controller only: http://example/news controller == news Action
173109 * only(when defined yaf.action_prefer=1 in php.ini) action == news
173110 * Invalid module maps to controller name: http://example/foo controller
173111 * == foo Module + controller: http://example/blog/archive module == blog
173112 * controller == archive Module + controller + action:
173113 * http://example/blog/archive/list module == blog controller == archive
173114 * action == list Module + controller + action + params:
173115 * http://example/blog/archive/list/sort/alpha/date/desc module == blog
173116 * controller == archive action == list sort == alpha date == desc
173117 **/
173118class Yaf_Router {
173119    /**
173120     * Add config-defined routes into Router
173121     *
173122     * Add routes defined by configs into Yaf_Router's route stack
173123     *
173124     * @param Yaf_Config_Abstract $config
173125     * @return bool An Yaf_Config_Abstract instance, which should contains
173126     *   one or more valid route configs
173127     * @since Yaf >=1.0.0
173128     **/
173129    public function addConfig($config){}
173130
173131    /**
173132     * Add new Route into Router
173133     *
173134     * defaultly, Yaf_Router using a Yaf_Route_Static as its defualt route.
173135     * you can add new routes into router's route stack by calling this
173136     * method.
173137     *
173138     * the newer route will be called before the older(route stack), and if
173139     * the newer router return TRUE, the router process will be end.
173140     * otherwise, the older one will be called.
173141     *
173142     * @param string $name
173143     * @param Yaf_Route_Abstract $route
173144     * @return bool
173145     * @since Yaf >=1.0.0
173146     **/
173147    public function addRoute($name, $route){}
173148
173149    /**
173150     * Get the effective route name
173151     *
173152     * Get the name of the route which is effective in the route process. You
173153     * should call this method after the route process finished, since before
173154     * that, this method will always return NULL.
173155     *
173156     * @return string String, the name of the effective route.
173157     * @since Yaf >=1.0.0
173158     **/
173159    public function getCurrentRoute(){}
173160
173161    /**
173162     * Retrieve a route by name
173163     *
173164     * Retrieve a route by name, see also Yaf_Router::getCurrentRoute
173165     *
173166     * @param string $name
173167     * @return Yaf_Route_Interface
173168     * @since Yaf >=1.0.0
173169     **/
173170    public function getRoute($name){}
173171
173172    /**
173173     * Retrieve registered routes
173174     *
173175     * @return mixed
173176     * @since Yaf >=1.0.0
173177     **/
173178    public function getRoutes(){}
173179
173180    /**
173181     * The route purpose
173182     *
173183     * @param Yaf_Request_Abstract $request
173184     * @return bool
173185     * @since Yaf >=1.0.0
173186     **/
173187    public function route($request){}
173188
173189    /**
173190     * Yaf_Router constructor
173191     *
173192     * @since Yaf >=1.0.0
173193     **/
173194    public function __construct(){}
173195
173196}
173197/**
173198 * Yaf_Route_Interface used for developer defined their custom route.
173199 **/
173200interface Yaf_Route_Interface {
173201    /**
173202     * Assemble a request
173203     *
173204     * this method returns a url according to the argument info, and append
173205     * query strings to the url according to the argument query.
173206     *
173207     * a route should implement this method according to its own route rules,
173208     * and do a reverse progress.
173209     *
173210     * @param array $info
173211     * @param array $query
173212     * @return string
173213     * @since Yaf >=2.3.0
173214     **/
173215    public function assemble($info, $query);
173216
173217    /**
173218     * Route a request
173219     *
173220     * Yaf_Route_Interface::route is the only method that a custom route
173221     * should implement. since of 2.3.0, there is another method should also
173222     * be implemented, see Yaf_Route_Interface::assemble.
173223     *
173224     * if this method return TRUE, then the route process will be end.
173225     * otherwise, Yaf_Router will call next route in the route stack to route
173226     * request.
173227     *
173228     * This method would set the route result to the parameter request, by
173229     * calling Yaf_Request_Abstract::setControllerName,
173230     * Yaf_Request_Abstract::setActionName and
173231     * Yaf_Request_Abstract::setModuleName.
173232     *
173233     * This method should also call Yaf_Request_Abstract::setRouted to make
173234     * the request routed at last.
173235     *
173236     * @param Yaf_Request_Abstract $request A Yaf_Request_Abstract
173237     *   instance.
173238     * @return bool
173239     * @since Yaf >=1.0.0
173240     **/
173241    public function route($request);
173242
173243}
173244/**
173245 * Yaf_Route_Map is a built-in route, it simply convert a URI endpoint
173246 * (that part of the URI which comes after the base URI: see
173247 * Yaf_Request_Abstract::setBaseUri) to a controller name or action
173248 * name(depends on the parameter passed to Yaf_Route_Map::__construct) in
173249 * following rule: A => controller A. A/B/C => controller A_B_C.
173250 * A/B/C/D/E => controller A_B_C_D_E. If the second parameter of
173251 * Yaf_Route_Map::__construct is specified, then only the part before
173252 * delimiter of URI will used to routing, the part after it is used to
173253 * routing request parameters (see the example section of
173254 * Yaf_Route_Map::__construct).
173255 **/
173256class Yaf_Route_Map implements Yaf_Route_Interface {
173257    /**
173258     * @var mixed
173259     **/
173260    protected $_ctl_router;
173261
173262    /**
173263     * @var mixed
173264     **/
173265    protected $_delimiter;
173266
173267    /**
173268     * Assemble a url
173269     *
173270     * @param array $info
173271     * @param array $query
173272     * @return string
173273     * @since Yaf >=2.3.0
173274     **/
173275    public function assemble($info, $query){}
173276
173277    /**
173278     * The route purpose
173279     *
173280     * @param Yaf_Request_Abstract $request
173281     * @return bool
173282     * @since Yaf >=1.0.0
173283     **/
173284    public function route($request){}
173285
173286    /**
173287     * The __construct purpose
173288     *
173289     * @param string $controller_prefer Whether the result should
173290     *   considering as controller or action
173291     * @param string $delimiter
173292     * @since Yaf >=1.0.0
173293     **/
173294    public function __construct($controller_prefer, $delimiter){}
173295
173296}
173297/**
173298 * Yaf_Route_Regex is the most flexible route among the Yaf built-in
173299 * routes.
173300 **/
173301class Yaf_Route_Regex extends Yaf_Route_Interface implements Yaf_Route_Interface {
173302    /**
173303     * @var mixed
173304     **/
173305    protected $_default;
173306
173307    /**
173308     * @var mixed
173309     **/
173310    protected $_maps;
173311
173312    /**
173313     * @var mixed
173314     **/
173315    protected $_route;
173316
173317    /**
173318     * @var mixed
173319     **/
173320    protected $_verify;
173321
173322    /**
173323     * Assemble a url
173324     *
173325     * @param array $info
173326     * @param array $query
173327     * @return string
173328     * @since Yaf >=2.3.0
173329     **/
173330    public function assemble($info, $query){}
173331
173332    /**
173333     * The route purpose
173334     *
173335     * Route a incoming request.
173336     *
173337     * @param Yaf_Request_Abstract $request
173338     * @return bool If the pattern given by the first parameter of
173339     *   Yaf_Route_Regex::_construct matche the request uri, return TRUE,
173340     *   otherwise return FALSE.
173341     * @since Yaf >=1.0.0
173342     **/
173343    public function route($request){}
173344
173345    /**
173346     * Yaf_Route_Regex constructor
173347     *
173348     * @param string $match A complete Regex pattern, will be used to match
173349     *   a request uri, if doesn't matched, Yaf_Route_Regex will return
173350     *   FALSE.
173351     * @param array $route When the match pattern matches the request uri,
173352     *   Yaf_Route_Regex will use this to decide which m/c/a to routed.
173353     *   either of m/c/a in this array is optianl, if you don't assgian a
173354     *   specific value, it will be routed to default.
173355     * @param array $map A array to assign name to the captrues in the
173356     *   match result.
173357     * @param array $verify
173358     * @param string $reverse a string, used to assemble url, see
173359     *   Yaf_Route_Regex::assemble. this parameter is introduced in 2.3.0
173360     * @since Yaf >=1.0.0
173361     **/
173362    public function __construct($match, $route, $map, $verify, $reverse){}
173363
173364}
173365/**
173366 * For usage, please see the example section of
173367 * Yaf_Route_Rewrite::__construct
173368 **/
173369class Yaf_Route_Rewrite extends Yaf_Route_Interface implements Yaf_Route_Interface {
173370    /**
173371     * @var mixed
173372     **/
173373    protected $_default;
173374
173375    /**
173376     * @var mixed
173377     **/
173378    protected $_route;
173379
173380    /**
173381     * @var mixed
173382     **/
173383    protected $_verify;
173384
173385    /**
173386     * Assemble a url
173387     *
173388     * @param array $info
173389     * @param array $query
173390     * @return string
173391     * @since Yaf >=2.3.0
173392     **/
173393    public function assemble($info, $query){}
173394
173395    /**
173396     * The route purpose
173397     *
173398     * @param Yaf_Request_Abstract $request
173399     * @return bool
173400     * @since Yaf >=1.0.0
173401     **/
173402    public function route($request){}
173403
173404    /**
173405     * Yaf_Route_Rewrite constructor
173406     *
173407     * @param string $match A pattern, will be used to match a request uri,
173408     *   if it doesn't match, Yaf_Route_Rewrite will return FALSE. You can
173409     *   use :name style to name segments matched, and use * to match the
173410     *   rest of the URL segments.
173411     * @param array $route When the match pattern matches the request uri,
173412     *   Yaf_Route_Rewrite will use this to decide which
173413     *   module/controller/action is the destination. Either of
173414     *   module/controller/action in this array is optional, if you don't
173415     *   assign a specific value, it will be routed to default.
173416     * @param array $verify
173417     * @since Yaf >=1.0.0
173418     **/
173419    public function __construct($match, $route, $verify){}
173420
173421}
173422/**
173423 * Yaf_Route_Simple will match the query string, and find the route info.
173424 * all you need to do is tell Yaf_Route_Simple what key in the $_GET is
173425 * module, what key is controller, and what key is action.
173426 * Yaf_Route_Simple::route will always return TRUE, so it is important
173427 * put Yaf_Route_Simple in the front of the Route stack, otherwise all
173428 * the other routes will not be called.
173429 **/
173430class Yaf_Route_Simple implements Yaf_Route_Interface {
173431    /**
173432     * @var mixed
173433     **/
173434    protected $action;
173435
173436    /**
173437     * @var mixed
173438     **/
173439    protected $controller;
173440
173441    /**
173442     * @var mixed
173443     **/
173444    protected $module;
173445
173446    /**
173447     * Assemble a url
173448     *
173449     * @param array $info
173450     * @param array $query
173451     * @return string
173452     * @since Yaf >=2.3.0
173453     **/
173454    public function assemble($info, $query){}
173455
173456    /**
173457     * Route a request
173458     *
173459     * see Yaf_Route_Simple::__construct
173460     *
173461     * @param Yaf_Request_Abstract $request
173462     * @return bool always be TRUE
173463     * @since Yaf >=1.0.0
173464     **/
173465    public function route($request){}
173466
173467    /**
173468     * Yaf_Route_Simple constructor
173469     *
173470     * Yaf_Route_Simple will get route info from query string. and the
173471     * parameters of this constructor will used as keys while searching for
173472     * the route info in $_GET.
173473     *
173474     * @param string $module_name The key name of the module info.
173475     * @param string $controller_name the key name of the controller info.
173476     * @param string $action_name the key name of the action info.
173477     * @since Yaf >=1.0.0
173478     **/
173479    public function __construct($module_name, $controller_name, $action_name){}
173480
173481}
173482/**
173483 * Defaultly, Yaf_Router only have a Yaf_Route_Static as its default
173484 * route. And Yaf_Route_Static is designed to handle the 80% requirement.
173485 * please *NOTE* that it is unnecessary to instance a Yaf_Route_Static,
173486 * also unecesary to add it into Yaf_Router's routes stack, since there
173487 * is always be one in Yaf_Router's routes stack, and always be called at
173488 * the last time.
173489 **/
173490class Yaf_Route_Static implements Yaf_Router {
173491    /**
173492     * Assemble a url
173493     *
173494     * @param array $info
173495     * @param array $query
173496     * @return string
173497     * @since Yaf >=2.3.0
173498     **/
173499    public function assemble($info, $query){}
173500
173501    /**
173502     * The match purpose
173503     *
173504     * @param string $uri
173505     * @return void
173506     * @since Yaf >=1.0.0
173507     **/
173508    public function match($uri){}
173509
173510    /**
173511     * Route a request
173512     *
173513     * @param Yaf_Request_Abstract $request
173514     * @return bool always be TRUE
173515     * @since Yaf >=1.0.0
173516     **/
173517    public function route($request){}
173518
173519}
173520class Yaf_Route_Supervar implements Yaf_Route_Interface {
173521    /**
173522     * @var mixed
173523     **/
173524    protected $_var_name;
173525
173526    /**
173527     * Assemble a url
173528     *
173529     * @param array $info
173530     * @param array $query
173531     * @return string
173532     * @since Yaf >=2.3.0
173533     **/
173534    public function assemble($info, $query){}
173535
173536    /**
173537     * The route purpose
173538     *
173539     * @param Yaf_Request_Abstract $request
173540     * @return bool If there is a key(which was defined in
173541     *   Yaf_Route_Supervar::__construct) in $_GET, return TRUE. otherwise
173542     *   return FALSE.
173543     * @since Yaf >=1.0.0
173544     **/
173545    public function route($request){}
173546
173547    /**
173548     * The __construct purpose
173549     *
173550     * Yaf_Route_Supervar is similar with Yaf_Route_Static, the difference is
173551     * Yaf_Route_Supervar will look for path info in query string, and the
173552     * parameter supervar_name is the key.
173553     *
173554     * @param string $supervar_name The name of key.
173555     * @since Yaf >=1.0.0
173556     **/
173557    public function __construct($supervar_name){}
173558
173559}
173560class Yaf_Session implements Iterator, ArrayAccess, Countable {
173561    /**
173562     * @var mixed
173563     **/
173564    protected static $_instance;
173565
173566    /**
173567     * @var mixed
173568     **/
173569    protected $_session;
173570
173571    /**
173572     * @var mixed
173573     **/
173574    protected $_started;
173575
173576    /**
173577     * The count purpose
173578     *
173579     * @return void
173580     * @since Yaf >=1.0.0
173581     **/
173582    public function count(){}
173583
173584    /**
173585     * The current purpose
173586     *
173587     * @return void
173588     * @since Yaf >=1.0.0
173589     **/
173590    public function current(){}
173591
173592    /**
173593     * The del purpose
173594     *
173595     * @param string $name
173596     * @return void
173597     * @since Yaf >=1.0.0
173598     **/
173599    public function del($name){}
173600
173601    /**
173602     * The getInstance purpose
173603     *
173604     * @return void
173605     * @since Yaf >=1.0.0
173606     **/
173607    public static function getInstance(){}
173608
173609    /**
173610     * The has purpose
173611     *
173612     * @param string $name
173613     * @return void
173614     * @since Yaf >=1.0.0
173615     **/
173616    public function has($name){}
173617
173618    /**
173619     * The key purpose
173620     *
173621     * @return void
173622     * @since Yaf >=1.0.0
173623     **/
173624    public function key(){}
173625
173626    /**
173627     * The next purpose
173628     *
173629     * @return void
173630     * @since Yaf >=1.0.0
173631     **/
173632    public function next(){}
173633
173634    /**
173635     * The offsetExists purpose
173636     *
173637     * @param string $name
173638     * @return void
173639     * @since Yaf >=1.0.0
173640     **/
173641    public function offsetExists($name){}
173642
173643    /**
173644     * The offsetGet purpose
173645     *
173646     * @param string $name
173647     * @return void
173648     * @since Yaf >=1.0.0
173649     **/
173650    public function offsetGet($name){}
173651
173652    /**
173653     * The offsetSet purpose
173654     *
173655     * @param string $name
173656     * @param string $value
173657     * @return void
173658     * @since Yaf >=1.0.0
173659     **/
173660    public function offsetSet($name, $value){}
173661
173662    /**
173663     * The offsetUnset purpose
173664     *
173665     * @param string $name
173666     * @return void
173667     * @since Yaf >=1.0.0
173668     **/
173669    public function offsetUnset($name){}
173670
173671    /**
173672     * The rewind purpose
173673     *
173674     * @return void
173675     * @since Yaf >=1.0.0
173676     **/
173677    public function rewind(){}
173678
173679    /**
173680     * The start purpose
173681     *
173682     * @return void
173683     * @since Yaf >=1.0.0
173684     **/
173685    public function start(){}
173686
173687    /**
173688     * The valid purpose
173689     *
173690     * @return void
173691     * @since Yaf >=1.0.0
173692     **/
173693    public function valid(){}
173694
173695    /**
173696     * Constructor of Yaf_Session
173697     *
173698     * @since Yaf >=1.0.0
173699     **/
173700    private function __construct(){}
173701
173702    /**
173703     * The __get purpose
173704     *
173705     * @param string $name
173706     * @return void
173707     * @since Yaf >=1.0.0
173708     **/
173709    public function __get($name){}
173710
173711    /**
173712     * The __isset purpose
173713     *
173714     * @param string $name
173715     * @return void
173716     * @since Yaf >=1.0.0
173717     **/
173718    public function __isset($name){}
173719
173720    /**
173721     * The __set purpose
173722     *
173723     * @param string $name
173724     * @param string $value
173725     * @return void
173726     * @since Yaf >=1.0.0
173727     **/
173728    public function __set($name, $value){}
173729
173730    /**
173731     * The __unset purpose
173732     *
173733     * @param string $name
173734     * @return void
173735     * @since Yaf >=1.0.0
173736     **/
173737    public function __unset($name){}
173738
173739}
173740/**
173741 * Yaf provides a ability for developers to use custom view engine
173742 * instead of built-in engine which is Yaf_View_Simple. There is a
173743 * example to explain how to do this, please see Yaf_Dispatcher::setView.
173744 **/
173745interface Yaf_View_Interface {
173746    /**
173747     * Assign value to View engine
173748     *
173749     * Assigan values to View engine, then the value can access directly by
173750     * name in template.
173751     *
173752     * @param string $name
173753     * @param string $value
173754     * @return bool
173755     * @since Yaf >=1.0.0
173756     **/
173757    public function assign($name, $value);
173758
173759    /**
173760     * Render and output a template
173761     *
173762     * Render a template and output the result immediatly.
173763     *
173764     * @param string $tpl
173765     * @param array $tpl_vars
173766     * @return bool
173767     * @since Yaf >=1.0.0
173768     **/
173769    public function display($tpl, $tpl_vars);
173770
173771    /**
173772     * The getScriptPath purpose
173773     *
173774     * @return void
173775     * @since Yaf >=1.0.0
173776     **/
173777    public function getScriptPath();
173778
173779    /**
173780     * Render a template
173781     *
173782     * Render a template and return the result.
173783     *
173784     * @param string $tpl
173785     * @param array $tpl_vars
173786     * @return string
173787     * @since Yaf >=1.0.0
173788     **/
173789    public function render($tpl, $tpl_vars);
173790
173791    /**
173792     * The setScriptPath purpose
173793     *
173794     * Set the templates base directory, this is usually called by
173795     * Yaf_Dispatcher
173796     *
173797     * @param string $template_dir A absolute path to the template
173798     *   directory, by default, Yaf_Dispatcher use application.directory .
173799     *   "/views" as this paramter.
173800     * @return void
173801     * @since Yaf >=1.0.0
173802     **/
173803    public function setScriptPath($template_dir);
173804
173805}
173806/**
173807 * Yaf_View_Simple is the built-in template engine in Yaf, it is a simple
173808 * but fast template engine, and only support PHP script template.
173809 **/
173810class Yaf_View_Simple implements Yaf_View_Interface {
173811    /**
173812     * @var mixed
173813     **/
173814    protected $_tpl_dir;
173815
173816    /**
173817     * @var mixed
173818     **/
173819    protected $_tpl_vars;
173820
173821    /**
173822     * Assign values
173823     *
173824     * assign variable to view engine
173825     *
173826     * @param string $name A string or an array. if is string, then the
173827     *   next argument $value is required.
173828     * @param mixed $value mixed value
173829     * @return bool
173830     * @since Yaf >=1.0.0
173831     **/
173832    public function assign($name, $value){}
173833
173834    /**
173835     * The assignRef purpose
173836     *
173837     * unlike Yaf_View_Simple::assign, this method assign a ref value to
173838     * engine.
173839     *
173840     * @param string $name A string name which will be used to access the
173841     *   value in the tempalte.
173842     * @param mixed $value mixed value
173843     * @return bool
173844     * @since Yaf >=1.0.0
173845     **/
173846    public function assignRef($name, &$value){}
173847
173848    /**
173849     * Clear Assigned values
173850     *
173851     * clear assigned variable
173852     *
173853     * @param string $name assigned variable name if empty, will clear all
173854     *   assigned variables
173855     * @return bool
173856     * @since Yaf >=2.2.0
173857     **/
173858    public function clear($name){}
173859
173860    /**
173861     * Render and display
173862     *
173863     * Render a template and display the result instantly.
173864     *
173865     * @param string $tpl
173866     * @param array $tpl_vars
173867     * @return bool
173868     * @since Yaf >=1.0.0
173869     **/
173870    public function display($tpl, $tpl_vars){}
173871
173872    /**
173873     * Render template
173874     *
173875     * Render a string tempalte and return the result.
173876     *
173877     * @param string $tpl_content string template
173878     * @param array $tpl_vars
173879     * @return string
173880     * @since Yaf >=2.2.0
173881     **/
173882    public function eval($tpl_content, $tpl_vars){}
173883
173884    /**
173885     * Get templates directory
173886     *
173887     * @return string
173888     * @since Yaf >=1.0.0
173889     **/
173890    public function getScriptPath(){}
173891
173892    /**
173893     * Render template
173894     *
173895     * Render a template and return the result.
173896     *
173897     * @param string $tpl
173898     * @param array $tpl_vars
173899     * @return string
173900     * @since Yaf >=1.0.0
173901     **/
173902    public function render($tpl, $tpl_vars){}
173903
173904    /**
173905     * Set tempaltes directory
173906     *
173907     * @param string $template_dir
173908     * @return bool
173909     * @since Yaf >=1.0.0
173910     **/
173911    public function setScriptPath($template_dir){}
173912
173913    /**
173914     * Constructor of Yaf_View_Simple
173915     *
173916     * @param string $template_dir The base directory of the templates, by
173917     *   default, it is APPLICATOIN . "/views" for Yaf.
173918     * @param array $options Options for the engine, as of Yaf 2.1.13, you
173919     *   can use short tag "<?=$var?>" in your template(regardless of
173920     *   "short_open_tag"), so comes a option named "short_tag", you can
173921     *   switch this off to prevent use short_tag in template.
173922     * @since Yaf >=1.0.0
173923     **/
173924    final public function __construct($template_dir, $options){}
173925
173926    /**
173927     * Retrieve assigned variable
173928     *
173929     * Retrieve assigned varaiable parameter can be empty since 2.1.11
173930     *
173931     * @param string $name the assigned variable name if this is empty, all
173932     *   assigned variables will be returned
173933     * @return void
173934     * @since Yaf >=1.0.0
173935     **/
173936    public function __get($name){}
173937
173938    /**
173939     * The __isset purpose
173940     *
173941     * @param string $name
173942     * @return void
173943     * @since Yaf >=1.0.0
173944     **/
173945    public function __isset($name){}
173946
173947    /**
173948     * Set value to engine
173949     *
173950     * This is a alternative and easier way to Yaf_View_Simple::assign.
173951     *
173952     * @param string $name A string value name.
173953     * @param mixed $value Mixed value.
173954     * @return void
173955     * @since Yaf >=1.0.0
173956     **/
173957    public function __set($name, $value){}
173958
173959}
173960class Yar_Client {
173961    /**
173962     * @var mixed
173963     **/
173964    protected $_options;
173965
173966    /**
173967     * @var mixed
173968     **/
173969    protected $_protocol;
173970
173971    /**
173972     * @var mixed
173973     **/
173974    protected $_running;
173975
173976    /**
173977     * @var mixed
173978     **/
173979    protected $_uri;
173980
173981    /**
173982     * Set calling contexts
173983     *
173984     * @param int $name it can be: YAR_OPT_PACKAGER, YAR_OPT_PERSISTENT
173985     *   (Need server support), YAR_OPT_TIMEOUT, YAR_OPT_CONNECT_TIMEOUT
173986     *   YAR_OPT_HEADER (Since 2.0.4)
173987     * @param mixed $value
173988     * @return Yar_Client Returns $this on success.
173989     * @since PECL yar >= 1.0.0
173990     **/
173991    public function setOpt($name, $value){}
173992
173993    /**
173994     * Call service
173995     *
173996     * Issue a call to remote RPC method.
173997     *
173998     * @param string $method Remote RPC method name.
173999     * @param array $parameters Parameters.
174000     * @return void
174001     * @since PECL yar >= 1.0.0
174002     **/
174003    public function __call($method, $parameters){}
174004
174005    /**
174006     * Create a client
174007     *
174008     * Create a Yar_Client to a Yar_Server.
174009     *
174010     * @param string $url Yar Server URL.
174011     * @param array $options
174012     * @since PECL yar >= 1.0.0
174013     **/
174014    final public function __construct($url, $options){}
174015
174016}
174017class Yar_Client_Exception extends Exception {
174018    /**
174019     * Retrieve exception's type
174020     *
174021     * @return string Returns "Yar_Exception_Client".
174022     * @since PECL yar >= 1.0.0
174023     **/
174024    public function getType(){}
174025
174026}
174027class Yar_Client_Packager_Exception extends Yar_Client_Exception {
174028}
174029class Yar_Client_Protocol_Exception extends Yar_Client_Exception {
174030}
174031class Yar_Client_Transport_Exception extends Yar_Client_Exception {
174032}
174033class Yar_Concurrent_Client {
174034    /**
174035     * @var mixed
174036     **/
174037    static $_callback;
174038
174039    /**
174040     * @var mixed
174041     **/
174042    static $_callstack;
174043
174044    /**
174045     * @var mixed
174046     **/
174047    static $_error_callback;
174048
174049    /**
174050     * Register a concurrent call
174051     *
174052     * Register a RPC call, but won't sent it immediately, it will be send
174053     * while further call to Yar_Concurrent_Client::loop
174054     *
174055     * @param string $uri The RPC server URI(http, tcp)
174056     * @param string $method Service name(aka the method name)
174057     * @param array $parameters Parameters
174058     * @param callable $callback A function callback, which will be called
174059     *   while the response return.
174060     * @param callable $error_callback
174061     * @param array $options
174062     * @return int An unique id, can be used to identified which call it
174063     *   is.
174064     * @since PECL yar >= 1.0.0
174065     **/
174066    public static function call($uri, $method, $parameters, $callback, $error_callback, $options){}
174067
174068    /**
174069     * Send all calls
174070     *
174071     * Send all registed remote RPC calls.
174072     *
174073     * @param callable $callback If this callback is set, then Yar will
174074     *   call this callback after all calls are sent and before any response
174075     *   return, with a $callinfo NULL. Then, if user didn't specify callback
174076     *   when registering concurrent call, this callback will be used to
174077     *   handle response, otherwise, the callback specified while registering
174078     *   will be used.
174079     * @param callable $error_callback If this callback is set, then Yar
174080     *   will call this callback while error occurred.
174081     * @return bool
174082     * @since PECL yar >= 1.0.0
174083     **/
174084    public static function loop($callback, $error_callback){}
174085
174086    /**
174087     * Clean all registered calls
174088     *
174089     * @return bool
174090     * @since PECL yar >= 1.2.4
174091     **/
174092    public static function reset(){}
174093
174094}
174095class Yar_Server {
174096    /**
174097     * @var mixed
174098     **/
174099    protected $_executor;
174100
174101    /**
174102     * Start RPC Server
174103     *
174104     * Start a RPC HTTP server, and ready for accpet RPC requests. Usual RPC
174105     * calls will be issued as HTTP POST requests. If a HTTP GET request is
174106     * issued to the uri, the service information (commented section above)
174107     * will be printed on the page
174108     *
174109     * @return bool boolean
174110     * @since PECL yar >= 1.0.0
174111     **/
174112    public function handle(){}
174113
174114    /**
174115     * Register a server
174116     *
174117     * Set up a Yar HTTP RPC Server, All the public methods of $obj will be
174118     * register as a RPC service.
174119     *
174120     * @param Object $obj An Object, all public methods of its will be
174121     *   registered as RPC services.
174122     * @since PECL yar >= 1.0.0
174123     **/
174124    final public function __construct($obj){}
174125
174126}
174127/**
174128 * If service threw exceptions, A Yar_Server_Exception will be threw in
174129 * client side.
174130 **/
174131class Yar_Server_Exception extends Exception {
174132    /**
174133     * @var mixed
174134     **/
174135    protected $_type;
174136
174137    /**
174138     * Retrieve exception's type
174139     *
174140     * Get the exception original type threw by server
174141     *
174142     * @return string string
174143     * @since PECL yar >= 1.0.0
174144     **/
174145    public function getType(){}
174146
174147}
174148class Yar_Server_Output_Exception extends Yar_Server_Exception {
174149}
174150class Yar_Server_Packager_Exception extends Yar_Server_Exception {
174151}
174152class Yar_Server_Protocol_Exception extends Yar_Server_Exception {
174153}
174154class Yar_Server_Request_Exception extends Yar_Server_Exception {
174155}
174156/**
174157 * A file archive, compressed with Zip.
174158 **/
174159class ZipArchive implements Countable {
174160    const CHECKCONS = 0;
174161
174162    const CM_BZIP2 = 0;
174163
174164    const CM_DEFAULT = 0;
174165
174166    const CM_DEFLATE = 0;
174167
174168    const CM_DEFLATE64 = 0;
174169
174170    const CM_IMPLODE = 0;
174171
174172    const CM_LZMA = 0;
174173
174174    const CM_LZMA2 = 0;
174175
174176    const CM_PKWARE_IMPLODE = 0;
174177
174178    const CM_REDUCE_1 = 0;
174179
174180    const CM_REDUCE_2 = 0;
174181
174182    const CM_REDUCE_3 = 0;
174183
174184    const CM_REDUCE_4 = 0;
174185
174186    const CM_SHRINK = 0;
174187
174188    const CM_STORE = 0;
174189
174190    const CM_XZ = 0;
174191
174192    const CM_ZSTD = 0;
174193
174194    const CREATE = 0;
174195
174196    const EM_AES_128 = 0;
174197
174198    const EM_AES_192 = 0;
174199
174200    const EM_AES_256 = 0;
174201
174202    const EM_NONE = 0;
174203
174204    const EM_TRAD_PKWARE = 0;
174205
174206    const EM_UNKNOWN = 0;
174207
174208    const ER_CANCELLED = 0;
174209
174210    const ER_CHANGED = '';
174211
174212    const ER_CLOSE = 0;
174213
174214    const ER_COMPNOTSUPP = 0;
174215
174216    const ER_CRC = 0;
174217
174218    const ER_DELETED = 0;
174219
174220    const ER_ENCRNOTSUPP = 0;
174221
174222    const ER_EOF = 0;
174223
174224    const ER_EXISTS = 0;
174225
174226    const ER_INCONS = 0;
174227
174228    const ER_INTERNAL = 0;
174229
174230    const ER_INVAL = 0;
174231
174232    const ER_MEMORY = 0;
174233
174234    const ER_MULTIDISK = 0;
174235
174236    const ER_NOENT = 0;
174237
174238    const ER_NOPASSWD = 0;
174239
174240    const ER_NOZIP = 0;
174241
174242    const ER_OK = 0;
174243
174244    const ER_OPEN = 0;
174245
174246    const ER_RDONLY = 0;
174247
174248    const ER_READ = 0;
174249
174250    const ER_REMOVE = 0;
174251
174252    const ER_RENAME = 0;
174253
174254    const ER_SEEK = 0;
174255
174256    const ER_TMPOPEN = 0;
174257
174258    const ER_WRITE = 0;
174259
174260    const ER_WRONGPASSWD = 0;
174261
174262    const ER_ZIPCLOSED = 0;
174263
174264    const ER_ZLIB = 0;
174265
174266    const EXCL = 0;
174267
174268    const FL_COMPRESSED = 0;
174269
174270    const FL_ENCRYPTED = 0;
174271
174272    const FL_ENC_CP437 = 0;
174273
174274    const FL_ENC_GUESS = 0;
174275
174276    const FL_ENC_RAW = 0;
174277
174278    const FL_ENC_STRICT = 0;
174279
174280    const FL_ENC_UTF_8 = 0;
174281
174282    const FL_LOCAL = 0;
174283
174284    const FL_NOCASE = 0;
174285
174286    const FL_NODIR = 0;
174287
174288    const FL_OVERWRITE = 0;
174289
174290    const FL_RECOMPRESS = 0;
174291
174292    const FL_UNCHANGED = 0;
174293
174294    const LIBZIP_VERSION = '';
174295
174296    const OPSYS_DOS = 0;
174297
174298    const OVERWRITE = 0;
174299
174300    const RDONLY = 0;
174301
174302    const ZIP_ER_COMPRESSED_DATA = 0;
174303
174304    const ZIP_ER_INUSE = 0;
174305
174306    const ZIP_ER_OPNOTSUPP = 0;
174307
174308    const ZIP_ER_TELL = 0;
174309
174310    const ZIP_FL_CENTRAL = 0;
174311
174312    /**
174313     * Comment for the archive
174314     *
174315     * @var string
174316     **/
174317    public $comment;
174318
174319    /**
174320     * File name in the file system
174321     *
174322     * @var string
174323     **/
174324    public $filename;
174325
174326    /**
174327     * @var int
174328     **/
174329    public $lastId;
174330
174331    /**
174332     * @var int
174333     **/
174334    public $numFiles;
174335
174336    /**
174337     * Status of the Zip Archive. Available for closed archive, as of PHP
174338     * 8.0.0 and PECL zip 1.18.0.
174339     *
174340     * @var int
174341     **/
174342    public $status;
174343
174344    /**
174345     * @var int
174346     **/
174347    public $statusSys;
174348
174349    /**
174350     * Add a new directory
174351     *
174352     * Adds an empty directory in the archive.
174353     *
174354     * @param string $dirname The directory to add.
174355     * @param int $flags Bitmask consisting of ZipArchive::FL_ENC_GUESS,
174356     *   ZipArchive::FL_ENC_UTF_8, ZipArchive::FL_ENC_CP437. The behaviour of
174357     *   these constants is described on the ZIP constants page.
174358     * @return bool
174359     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.8.0
174360     **/
174361    public function addEmptyDir($dirname, $flags){}
174362
174363    /**
174364     * Adds a file to a ZIP archive from the given path
174365     *
174366     * Adds a file to a ZIP archive from a given path.
174367     *
174368     * @param string $filename The path to the file to add.
174369     * @param string $localname If supplied, this is the local name inside
174370     *   the ZIP archive that will override the {@link filename}.
174371     * @param int $start For partial copy, start position.
174372     * @param int $length For partial copy, length to be copied, if 0 or -1
174373     *   the whole file (starting from {@link start}) is used.
174374     * @param int $flags Bitmask consisting of ZipArchive::FL_OVERWRITE,
174375     *   ZipArchive::FL_ENC_GUESS, ZipArchive::FL_ENC_UTF_8,
174376     *   ZipArchive::FL_ENC_CP437. The behaviour of these constants is
174377     *   described on the ZIP constants page.
174378     * @return bool
174379     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.1.0
174380     **/
174381    public function addFile($filename, $localname, $start, $length, $flags){}
174382
174383    /**
174384     * Add a file to a ZIP archive using its contents
174385     *
174386     * @param string $localname The name of the entry to create.
174387     * @param string $contents The contents to use to create the entry. It
174388     *   is used in a binary safe mode.
174389     * @param int $flags Bitmask consisting of ZipArchive::FL_OVERWRITE,
174390     *   ZipArchive::FL_ENC_GUESS, ZipArchive::FL_ENC_UTF_8,
174391     *   ZipArchive::FL_ENC_CP437. The behaviour of these constants is
174392     *   described on the ZIP constants page.
174393     * @return bool
174394     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.1.0
174395     **/
174396    public function addFromString($localname, $contents, $flags){}
174397
174398    /**
174399     * Add files from a directory by glob pattern
174400     *
174401     * Add files from a directory which match the glob {@link pattern}.
174402     *
174403     * @param string $pattern A {@link glob} pattern against which files
174404     *   will be matched.
174405     * @param int $flags A bit mask of glob() flags.
174406     * @param array $options An associative array of options. Available
174407     *   options are: "add_path" Prefix to prepend when translating to the
174408     *   local path of the file within the archive. This is applied after any
174409     *   remove operations defined by the "remove_path" or "remove_all_path"
174410     *   options. "remove_path" Prefix to remove from matching file paths
174411     *   before adding to the archive. "remove_all_path" TRUE to use the file
174412     *   name only and add to the root of the archive. "flags" Bitmask
174413     *   consisting of ZipArchive::FL_OVERWRITE, ZipArchive::FL_ENC_GUESS,
174414     *   ZipArchive::FL_ENC_UTF_8, ZipArchive::FL_ENC_CP437. The behaviour of
174415     *   these constants is described on the ZIP constants page.
174416     *   "comp_method" Compression method, one of the ZipArchive::CM_*
174417     *   constants, see ZIP constants page. "comp_flags" Compression level.
174418     *   "enc_method" Encryption method, one of the ZipArchive::EM_*
174419     *   constants, see ZIP constants page. "enc_password" Password used for
174420     *   encryption.
174421     * @return array An array of added files on success
174422     * @since PHP 5 >= 5.3.0, PHP 7, PECL zip >= 1.9.0
174423     **/
174424    public function addGlob($pattern, $flags, $options){}
174425
174426    /**
174427     * Add files from a directory by PCRE pattern
174428     *
174429     * Add files from a directory which match the regular expression {@link
174430     * pattern}. The operation is not recursive. The pattern will be matched
174431     * against the file name only.
174432     *
174433     * @param string $pattern A PCRE pattern against which files will be
174434     *   matched.
174435     * @param string $path The directory that will be scanned. Defaults to
174436     *   the current working directory.
174437     * @param array $options An associative array of options accepted by
174438     *   ZipArchive::addGlob.
174439     * @return array An array of added files on success
174440     * @since PHP 5 >= 5.3.0, PHP 7, PECL zip >= 1.9.0
174441     **/
174442    public function addPattern($pattern, $path, $options){}
174443
174444    /**
174445     * Close the active archive (opened or newly created)
174446     *
174447     * Close opened or created archive and save changes. This method is
174448     * automatically called at the end of the script.
174449     *
174450     * @return bool
174451     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.1.0
174452     **/
174453    public function close(){}
174454
174455    /**
174456     * Counts the number of files in the archive
174457     *
174458     * @return int Returns the number of files in the archive.
174459     * @since PHP 7 >= 7.2.0, PECL zip >= 1.15.0
174460     **/
174461    public function count(){}
174462
174463    /**
174464     * Delete an entry in the archive using its index
174465     *
174466     * @param int $index Index of the entry to delete.
174467     * @return bool
174468     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.5.0
174469     **/
174470    public function deleteIndex($index){}
174471
174472    /**
174473     * Delete an entry in the archive using its name
174474     *
174475     * @param string $name Name of the entry to delete.
174476     * @return bool
174477     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.5.0
174478     **/
174479    public function deleteName($name){}
174480
174481    /**
174482     * Extract the archive contents
174483     *
174484     * Extract the complete archive or the given files to the specified
174485     * destination.
174486     *
174487     * @param string $destination Location where to extract the files.
174488     * @param mixed $entries The entries to extract. It accepts either a
174489     *   single entry name or an array of names.
174490     * @return bool
174491     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.1.0
174492     **/
174493    public function extractTo($destination, $entries){}
174494
174495    /**
174496     * Returns the Zip archive comment
174497     *
174498     * @param int $flags If flags is set to ZipArchive::FL_UNCHANGED, the
174499     *   original unchanged comment is returned.
174500     * @return string Returns the Zip archive comment.
174501     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.1.0
174502     **/
174503    public function getArchiveComment($flags){}
174504
174505    /**
174506     * Returns the comment of an entry using the entry index
174507     *
174508     * @param int $index Index of the entry
174509     * @param int $flags If flags is set to ZipArchive::FL_UNCHANGED, the
174510     *   original unchanged comment is returned.
174511     * @return string Returns the comment on success.
174512     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.4.0
174513     **/
174514    public function getCommentIndex($index, $flags){}
174515
174516    /**
174517     * Returns the comment of an entry using the entry name
174518     *
174519     * @param string $name Name of the entry
174520     * @param int $flags If flags is set to ZipArchive::FL_UNCHANGED, the
174521     *   original unchanged comment is returned.
174522     * @return string Returns the comment on success.
174523     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.4.0
174524     **/
174525    public function getCommentName($name, $flags){}
174526
174527    /**
174528     * Retrieve the external attributes of an entry defined by its index
174529     *
174530     * @param int $index Index of the entry.
174531     * @param int $opsys On success, receive the operating system code
174532     *   defined by one of the ZipArchive::OPSYS_ constants.
174533     * @param int $attr On success, receive the external attributes. Value
174534     *   depends on operating system.
174535     * @param int $flags If flags is set to ZipArchive::FL_UNCHANGED, the
174536     *   original unchanged attributes are returned.
174537     * @return bool
174538     * @since PHP 5 >= 5.6.0, PHP 7, PECL zip >= 1.12.4
174539     **/
174540    public function GetExternalAttributesIndex($index, &$opsys, &$attr, $flags){}
174541
174542    /**
174543     * Retrieve the external attributes of an entry defined by its name
174544     *
174545     * @param string $name Name of the entry.
174546     * @param int $opsys On success, receive the operating system code
174547     *   defined by one of the ZipArchive::OPSYS_ constants.
174548     * @param int $attr On success, receive the external attributes. Value
174549     *   depends on operating system.
174550     * @param int $flags If flags is set to ZipArchive::FL_UNCHANGED, the
174551     *   original unchanged attributes are returned.
174552     * @return bool
174553     * @since PHP 5 >= 5.6.0, PHP 7, PECL zip >= 1.12.4
174554     **/
174555    public function getExternalAttributesName($name, &$opsys, &$attr, $flags){}
174556
174557    /**
174558     * Returns the entry contents using its index
174559     *
174560     * @param int $index Index of the entry
174561     * @param int $length The length to be read from the entry. If 0, then
174562     *   the entire entry is read.
174563     * @param int $flags The flags to use to open the archive. the
174564     *   following values may be ORed to it. ZipArchive::FL_UNCHANGED
174565     *   ZipArchive::FL_COMPRESSED
174566     * @return string Returns the contents of the entry on success.
174567     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.1.0
174568     **/
174569    public function getFromIndex($index, $length, $flags){}
174570
174571    /**
174572     * Returns the entry contents using its name
174573     *
174574     * @param string $name Name of the entry
174575     * @param int $length The length to be read from the entry. If 0, then
174576     *   the entire entry is read.
174577     * @param int $flags The flags to use to find the entry. The following
174578     *   values may be ORed. ZipArchive::FL_UNCHANGED
174579     *   ZipArchive::FL_COMPRESSED ZipArchive::FL_NOCASE
174580     * @return string Returns the contents of the entry on success.
174581     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.1.0
174582     **/
174583    public function getFromName($name, $length, $flags){}
174584
174585    /**
174586     * Returns the name of an entry using its index
174587     *
174588     * @param int $index Index of the entry.
174589     * @param int $flags If flags is set to ZipArchive::FL_UNCHANGED, the
174590     *   original unchanged name is returned.
174591     * @return string Returns the name on success.
174592     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.5.0
174593     **/
174594    public function getNameIndex($index, $flags){}
174595
174596    /**
174597     * Returns the status error message, system and/or zip messages
174598     *
174599     * @return string Returns a string with the status message on success.
174600     * @since PHP 5 >= 5.2.7, PHP 7
174601     **/
174602    public function getStatusString(){}
174603
174604    /**
174605     * Get a file handler to the entry defined by its name (read only)
174606     *
174607     * Get a file handler to the entry defined by its name. For now it only
174608     * supports read operations.
174609     *
174610     * @param string $name The name of the entry to use.
174611     * @return resource Returns a file pointer (resource) on success.
174612     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.1.0
174613     **/
174614    public function getStream($name){}
174615
174616    /**
174617     * Check if a compression method is supported by libzip
174618     *
174619     * @param int $method The compression method, one of the
174620     *   ZipArchive::CM_* constants.
174621     * @param bool $encode If TRUE check for compression, else check for
174622     *   decompression.
174623     * @return bool
174624     * @since PHP >= 8.0.0, PECL zip >= 1.19.0
174625     **/
174626    public function isCompressionMethodSupported($method, $encode){}
174627
174628    /**
174629     * Check if a encryption method is supported by libzip
174630     *
174631     * Check if a compression method is supported by libzip.
174632     *
174633     * @param int $method The encryption method, one of the
174634     *   ZipArchive::EM_* constants.
174635     * @param bool $encode If TRUE check for encryption, else check for
174636     *   decryption.
174637     * @return bool
174638     * @since PHP >= 8.0.0, PECL zip >= 1.19.0
174639     **/
174640    public function isEncryptionMethodSupported($method, $encode){}
174641
174642    /**
174643     * Returns the index of the entry in the archive
174644     *
174645     * Locates an entry using its name.
174646     *
174647     * @param string $name The name of the entry to look up
174648     * @param int $flags The flags are specified by ORing the following
174649     *   values, or 0 for none of them. ZipArchive::FL_NOCASE
174650     *   ZipArchive::FL_NODIR
174651     * @return int Returns the index of the entry on success.
174652     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.5.0
174653     **/
174654    public function locateName($name, $flags){}
174655
174656    /**
174657     * Open a ZIP file archive
174658     *
174659     * Opens a new or existing zip archive for reading, writing or modifying.
174660     *
174661     * Since libzip 1.6.0, a empty file is not a valid archive any longer.
174662     *
174663     * @param string $filename The file name of the ZIP archive to open.
174664     * @param int $flags The mode to use to open the archive.
174665     *   ZipArchive::OVERWRITE ZipArchive::CREATE ZipArchive::RDONLY
174666     *   ZipArchive::EXCL ZipArchive::CHECKCONS
174667     * @return mixed {@link Error codes} Returns TRUE on success or the
174668     *   error code. ZipArchive::ER_EXISTS File already exists.
174669     *   ZipArchive::ER_INCONS Zip archive inconsistent. ZipArchive::ER_INVAL
174670     *   Invalid argument. ZipArchive::ER_MEMORY Malloc failure.
174671     *   ZipArchive::ER_NOENT No such file. ZipArchive::ER_NOZIP Not a zip
174672     *   archive. ZipArchive::ER_OPEN Can't open file. ZipArchive::ER_READ
174673     *   Read error. ZipArchive::ER_SEEK Seek error.
174674     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.1.0
174675     **/
174676    public function open($filename, $flags){}
174677
174678    /**
174679     * Register a callback to allow cancellation during archive close.
174680     *
174681     * Register a {@link callback} function to allow cancellation during
174682     * archive close.
174683     *
174684     * @param callable $callback If this function return 0 operation will
174685     *   continue, other value it will be cancelled.
174686     * @return bool
174687     * @since PHP >= 8.0.0, PECL zip >= 1.17.0
174688     **/
174689    public function registerCancelCallback($callback){}
174690
174691    /**
174692     * Register a callback to provide updates during archive close.
174693     *
174694     * Register a {@link callback} function to provide updates during archive
174695     * close.
174696     *
174697     * @param float $rate Change between each call of the callback (from
174698     *   0.0 to 1.0).
174699     * @param callable $callback This function will receive the current
174700     *   {@link state} as a float (from 0.0 to 1.0).
174701     * @return bool
174702     * @since PHP >= 8.0.0, PECL zip >= 1.17.0
174703     **/
174704    public function registerProgressCallback($rate, $callback){}
174705
174706    /**
174707     * Renames an entry defined by its index
174708     *
174709     * @param int $index Index of the entry to rename.
174710     * @param string $newname New name.
174711     * @return bool
174712     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.5.0
174713     **/
174714    public function renameIndex($index, $newname){}
174715
174716    /**
174717     * Renames an entry defined by its name
174718     *
174719     * @param string $name Name of the entry to rename.
174720     * @param string $newname New name.
174721     * @return bool
174722     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.5.0
174723     **/
174724    public function renameName($name, $newname){}
174725
174726    /**
174727     * Replace file in ZIP archive with a given path
174728     *
174729     * @param string $filename The path to the file to add.
174730     * @param int $index The index of the file to be replaced, its name is
174731     *   unchanged.
174732     * @param int $start For partial copy, start position.
174733     * @param int $length For partial copy, length to be copied, if 0 or -1
174734     *   the whole file (starting from {@link start}) is used.
174735     * @param int $flags Bitmask consisting of ZipArchive::FL_ENC_GUESS,
174736     *   ZipArchive::FL_ENC_UTF_8, ZipArchive::FL_ENC_CP437. The behaviour of
174737     *   these constants is described on the ZIP constants page.
174738     * @return bool
174739     * @since PHP >= 8.0.0, PECL zip >= 1.18.0
174740     **/
174741    public function replaceFile($filename, $index, $start, $length, $flags){}
174742
174743    /**
174744     * Set the comment of a ZIP archive
174745     *
174746     * @param string $comment The contents of the comment.
174747     * @return bool
174748     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.4.0
174749     **/
174750    public function setArchiveComment($comment){}
174751
174752    /**
174753     * Set the comment of an entry defined by its index
174754     *
174755     * @param int $index Index of the entry.
174756     * @param string $comment The contents of the comment.
174757     * @return bool
174758     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.4.0
174759     **/
174760    public function setCommentIndex($index, $comment){}
174761
174762    /**
174763     * Set the comment of an entry defined by its name
174764     *
174765     * @param string $name Name of the entry.
174766     * @param string $comment The contents of the comment.
174767     * @return bool
174768     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.4.0
174769     **/
174770    public function setCommentName($name, $comment){}
174771
174772    /**
174773     * Set the compression method of an entry defined by its index
174774     *
174775     * @param int $index Index of the entry.
174776     * @param int $comp_method The compression method, one of the
174777     *   ZipArchive::CM_* constants.
174778     * @param int $comp_flags Compression level.
174779     * @return bool
174780     * @since PHP 7, PECL zip >= 1.13.0
174781     **/
174782    public function setCompressionIndex($index, $comp_method, $comp_flags){}
174783
174784    /**
174785     * Set the compression method of an entry defined by its name
174786     *
174787     * @param string $name Name of the entry.
174788     * @param int $comp_method The compression method, one of the
174789     *   ZipArchive::CM_* constants.
174790     * @param int $comp_flags Compression level.
174791     * @return bool
174792     * @since PHP 7, PECL zip >= 1.13.0
174793     **/
174794    public function setCompressionName($name, $comp_method, $comp_flags){}
174795
174796    /**
174797     * Set the encryption method of an entry defined by its index
174798     *
174799     * @param int $index Index of the entry.
174800     * @param string $method The encryption method defined by one of the
174801     *   ZipArchive::EM_ constants.
174802     * @param string $password Optional password, default used when
174803     *   missing.
174804     * @return bool
174805     * @since PHP >= 7.2.0, PECL zip >= 1.14.0
174806     **/
174807    public function setEncryptionIndex($index, $method, $password){}
174808
174809    /**
174810     * Set the encryption method of an entry defined by its name
174811     *
174812     * @param string $name Name of the entry.
174813     * @param int $method The encryption method defined by one of the
174814     *   ZipArchive::EM_ constants.
174815     * @param string $password Optional password, default used when
174816     *   missing.
174817     * @return bool
174818     * @since PHP >= 7.2.0, PECL zip >= 1.14.0
174819     **/
174820    public function setEncryptionName($name, $method, $password){}
174821
174822    /**
174823     * Set the external attributes of an entry defined by its index
174824     *
174825     * @param int $index Index of the entry.
174826     * @param int $opsys The operating system code defined by one of the
174827     *   ZipArchive::OPSYS_ constants.
174828     * @param int $attr The external attributes. Value depends on operating
174829     *   system.
174830     * @param int $flags Optional flags. Currently unused.
174831     * @return bool
174832     * @since PHP 5 >= 5.6.0, PHP 7, PECL zip >= 1.12.4
174833     **/
174834    public function setExternalAttributesIndex($index, $opsys, $attr, $flags){}
174835
174836    /**
174837     * Set the external attributes of an entry defined by its name
174838     *
174839     * @param string $name Name of the entry.
174840     * @param int $opsys The operating system code defined by one of the
174841     *   ZipArchive::OPSYS_ constants.
174842     * @param int $attr The external attributes. Value depends on operating
174843     *   system.
174844     * @param int $flags Optional flags. Currently unused.
174845     * @return bool
174846     * @since PHP 5 >= 5.6.0, PHP 7, PECL zip >= 1.12.4
174847     **/
174848    public function setExternalAttributesName($name, $opsys, $attr, $flags){}
174849
174850    /**
174851     * Set the modification time of an entry defined by its index
174852     *
174853     * @param int $index Index of the entry.
174854     * @param int $timestamp The modification time (unix timestamp) of the
174855     *   file.
174856     * @param int $flags Optional flags, unused for now.
174857     * @return bool
174858     * @since PHP >= 8.0.0, PECL zip >= 1.16.0
174859     **/
174860    public function setMtimeIndex($index, $timestamp, $flags){}
174861
174862    /**
174863     * Set the modification time of an entry defined by its name
174864     *
174865     * @param string $name Name of the entry.
174866     * @param int $timestamp The modification time (unix timestamp) of the
174867     *   file.
174868     * @param int $flags Optional flags, unused for now.
174869     * @return bool
174870     * @since PHP >= 8.0.0, PECL zip >= 1.16.0
174871     **/
174872    public function setMtimeName($name, $timestamp, $flags){}
174873
174874    /**
174875     * Set the password for the active archive
174876     *
174877     * Sets the password for the active archive.
174878     *
174879     * @param string $password The password to be used for the archive.
174880     * @return bool
174881     * @since PHP 5 >= 5.6.0, PHP 7, PECL zip >= 1.12.4
174882     **/
174883    public function setPassword($password){}
174884
174885    /**
174886     * Get the details of an entry defined by its index
174887     *
174888     * The function obtains information about the entry defined by its index.
174889     *
174890     * @param int $index Index of the entry
174891     * @param int $flags ZipArchive::FL_UNCHANGED may be ORed to it to
174892     *   request information about the original file in the archive, ignoring
174893     *   any changes made.
174894     * @return array Returns an array containing the entry details.
174895     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.1.0
174896     **/
174897    public function statIndex($index, $flags){}
174898
174899    /**
174900     * Get the details of an entry defined by its name
174901     *
174902     * The function obtains information about the entry defined by its name.
174903     *
174904     * @param string $name Name of the entry
174905     * @param int $flags The flags argument specifies how the name lookup
174906     *   should be done. Also, ZipArchive::FL_UNCHANGED may be ORed to it to
174907     *   request information about the original file in the archive, ignoring
174908     *   any changes made. ZipArchive::FL_NOCASE ZipArchive::FL_NODIR
174909     *   ZipArchive::FL_UNCHANGED
174910     * @return array Returns an array containing the entry details .
174911     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.5.0
174912     **/
174913    public function statName($name, $flags){}
174914
174915    /**
174916     * Undo all changes done in the archive
174917     *
174918     * @return bool
174919     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.1.0
174920     **/
174921    public function unchangeAll(){}
174922
174923    /**
174924     * Revert all global changes done in the archive
174925     *
174926     * Revert all global changes to the archive. For now, this only reverts
174927     * archive comment changes.
174928     *
174929     * @return bool
174930     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.1.0
174931     **/
174932    public function unchangeArchive(){}
174933
174934    /**
174935     * Revert all changes done to an entry at the given index
174936     *
174937     * @param int $index Index of the entry.
174938     * @return bool
174939     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.1.0
174940     **/
174941    public function unchangeIndex($index){}
174942
174943    /**
174944     * Revert all changes done to an entry with the given name
174945     *
174946     * Revert all changes done to an entry.
174947     *
174948     * @param string $name Name of the entry.
174949     * @return bool
174950     * @since PHP 5 >= 5.2.0, PHP 7, PECL zip >= 1.5.0
174951     **/
174952    public function unchangeName($name){}
174953
174954}
174955class ZMQ {
174956    /**
174957     * @var integer
174958     **/
174959    const CTXOPT_MAX_SOCKETS = 0;
174960
174961    /**
174962     * Forwarder device
174963     *
174964     * @var mixed
174965     **/
174966    const DEVICE_FORWARDER = 0;
174967
174968    /**
174969     * Queue device
174970     *
174971     * @var mixed
174972     **/
174973    const DEVICE_QUEUE = 0;
174974
174975    /**
174976     * Streamer device
174977     *
174978     * @var mixed
174979     **/
174980    const DEVICE_STREAMER = 0;
174981
174982    /**
174983     * @var integer
174984     **/
174985    const ERR_EAGAIN = 0;
174986
174987    /**
174988     * @var integer
174989     **/
174990    const ERR_EFSM = 0;
174991
174992    /**
174993     * @var integer
174994     **/
174995    const ERR_ENOTSUP = 0;
174996
174997    /**
174998     * @var integer
174999     **/
175000    const ERR_ETERM = 0;
175001
175002    /**
175003     * @var integer
175004     **/
175005    const ERR_INTERNAL = 0;
175006
175007    /**
175008     * @var integer
175009     **/
175010    const MODE_DONTWAIT = 0;
175011
175012    /**
175013     * @var integer
175014     **/
175015    const MODE_NOBLOCK = 0;
175016
175017    /**
175018     * @var integer
175019     **/
175020    const MODE_SNDMORE = 0;
175021
175022    /**
175023     * @var integer
175024     **/
175025    const POLL_IN = 0;
175026
175027    /**
175028     * @var integer
175029     **/
175030    const POLL_OUT = 0;
175031
175032    /**
175033     * @var integer
175034     **/
175035    const SOCKET_DEALER = 0;
175036
175037    /**
175038     * @var integer
175039     **/
175040    const SOCKET_PAIR = 0;
175041
175042    /**
175043     * @var integer
175044     **/
175045    const SOCKET_PUB = 0;
175046
175047    /**
175048     * @var integer
175049     **/
175050    const SOCKET_PULL = 0;
175051
175052    /**
175053     * @var integer
175054     **/
175055    const SOCKET_PUSH = 0;
175056
175057    /**
175058     * @var integer
175059     **/
175060    const SOCKET_REP = 0;
175061
175062    /**
175063     * @var integer
175064     **/
175065    const SOCKET_REQ = 0;
175066
175067    /**
175068     * @var integer
175069     **/
175070    const SOCKET_ROUTER = 0;
175071
175072    /**
175073     * @var integer
175074     **/
175075    const SOCKET_STREAM = 0;
175076
175077    /**
175078     * @var integer
175079     **/
175080    const SOCKET_SUB = 0;
175081
175082    /**
175083     * @var integer
175084     **/
175085    const SOCKET_XPUB = 0;
175086
175087    /**
175088     * @var integer
175089     **/
175090    const SOCKET_XREP = 0;
175091
175092    /**
175093     * @var integer
175094     **/
175095    const SOCKET_XREQ = 0;
175096
175097    /**
175098     * @var integer
175099     **/
175100    const SOCKET_XSUB = 0;
175101
175102    /**
175103     * @var integer
175104     **/
175105    const SOCKOPT_AFFINITY = 0;
175106
175107    /**
175108     * @var integer
175109     **/
175110    const SOCKOPT_BACKLOG = 0;
175111
175112    /**
175113     * @var integer
175114     **/
175115    const SOCKOPT_DELAY_ATTACH_ON_CONNECT = 0;
175116
175117    /**
175118     * @var integer
175119     **/
175120    const SOCKOPT_HWM = 0;
175121
175122    /**
175123     * @var integer
175124     **/
175125    const SOCKOPT_IDENTITY = 0;
175126
175127    /**
175128     * @var integer
175129     **/
175130    const SOCKOPT_IPV4ONLY = 0;
175131
175132    /**
175133     * @var integer
175134     **/
175135    const SOCKOPT_IPV6 = 0;
175136
175137    /**
175138     * @var integer
175139     **/
175140    const SOCKOPT_LAST_ENDPOINT = 0;
175141
175142    /**
175143     * @var integer
175144     **/
175145    const SOCKOPT_LINGER = 0;
175146
175147    /**
175148     * @var integer
175149     **/
175150    const SOCKOPT_MAXMSGSIZE = 0;
175151
175152    /**
175153     * @var integer
175154     **/
175155    const SOCKOPT_MCAST_LOOP = 0;
175156
175157    /**
175158     * @var integer
175159     **/
175160    const SOCKOPT_RATE = 0;
175161
175162    /**
175163     * @var integer
175164     **/
175165    const SOCKOPT_RCVBUF = 0;
175166
175167    /**
175168     * @var integer
175169     **/
175170    const SOCKOPT_RCVHWM = 0;
175171
175172    /**
175173     * @var integer
175174     **/
175175    const SOCKOPT_RCVMORE = 0;
175176
175177    /**
175178     * @var integer
175179     **/
175180    const SOCKOPT_RCVTIMEO = 0;
175181
175182    /**
175183     * @var integer
175184     **/
175185    const SOCKOPT_RECONNECT_IVL = 0;
175186
175187    /**
175188     * @var integer
175189     **/
175190    const SOCKOPT_RECONNECT_IVL_MAX = 0;
175191
175192    /**
175193     * @var integer
175194     **/
175195    const SOCKOPT_RECOVERY_IVL = 0;
175196
175197    /**
175198     * @var integer
175199     **/
175200    const SOCKOPT_ROUTER_RAW = 0;
175201
175202    /**
175203     * @var integer
175204     **/
175205    const SOCKOPT_SNDBUF = 0;
175206
175207    /**
175208     * @var integer
175209     **/
175210    const SOCKOPT_SNDHWM = 0;
175211
175212    /**
175213     * @var integer
175214     **/
175215    const SOCKOPT_SNDTIMEO = 0;
175216
175217    /**
175218     * @var integer
175219     **/
175220    const SOCKOPT_SUBSCRIBE = 0;
175221
175222    /**
175223     * @var integer
175224     **/
175225    const SOCKOPT_TCP_ACCEPT_FILTER = 0;
175226
175227    /**
175228     * @var integer
175229     **/
175230    const SOCKOPT_TCP_KEEPALIVE_CNT = 0;
175231
175232    /**
175233     * @var integer
175234     **/
175235    const SOCKOPT_TCP_KEEPALIVE_IDLE = 0;
175236
175237    /**
175238     * @var integer
175239     **/
175240    const SOCKOPT_TCP_KEEPALIVE_INTVL = 0;
175241
175242    /**
175243     * @var integer
175244     **/
175245    const SOCKOPT_TYPE = 0;
175246
175247    /**
175248     * @var integer
175249     **/
175250    const SOCKOPT_UNSUBSCRIBE = 0;
175251
175252    /**
175253     * @var integer
175254     **/
175255    const SOCKOPT_XPUB_VERBOSE = 0;
175256
175257    /**
175258     * ZMQ constructor
175259     *
175260     * Private constructor to prevent direct initialization. This class holds
175261     * the constants for ZMQ extension.
175262     *
175263     * @since PECL zmq >= 0.5.0
175264     **/
175265    private function __construct(){}
175266
175267}
175268class ZMQContext {
175269    /**
175270     * Get context option
175271     *
175272     * Returns the value of a context option.
175273     *
175274     * @param string $key An integer representing the option. See the
175275     *   ZMQ::CTXOPT_* constants.
175276     * @return mixed Returns either a or an depending on {@link key}.
175277     *   Throws ZMQContextException on error.
175278     * @since PECL zmq >= 1.0.4
175279     **/
175280    public function getOpt($key){}
175281
175282    /**
175283     * Create a new socket
175284     *
175285     * Shortcut for creating new sockets from the context. If the context is
175286     * not persistent the {@link persistent_id} parameter is ignored and the
175287     * socket falls back to being non-persistent. The {@link on_new_socket}
175288     * is called only when a new underlying socket structure is created.
175289     *
175290     * @param int $type ZMQ::SOCKET_* constant to specify socket type.
175291     * @param string $persistent_id If {@link persistent_id} is specified
175292     *   the socket will be persisted over multiple requests.
175293     * @param callback $on_new_socket Callback function, which is executed
175294     *   when a new socket structure is created. This function does not get
175295     *   invoked if the underlying persistent connection is re-used. The
175296     *   callback takes ZMQSocket and persistent_id as two arguments.
175297     * @return ZMQSocket Returns a ZMQSocket object on success. Throws
175298     *   ZMQSocketException on error.
175299     * @since PECL zmq >= 0.5.0
175300     **/
175301    public function getSocket($type, $persistent_id, $on_new_socket){}
175302
175303    /**
175304     * Whether the context is persistent
175305     *
175306     * Whether the context is persistent. Persistent context is needed for
175307     * persistent connections as each socket is allocated from a context.
175308     *
175309     * @return bool Returns TRUE if the context is persistent and FALSE if
175310     *   the context is non-persistent.
175311     * @since PECL zmq >= 0.5.0
175312     **/
175313    public function isPersistent(){}
175314
175315    /**
175316     * Set a socket option
175317     *
175318     * Sets a ZMQ context option. The type of the {@link value} depends on
175319     * the {@link key}. See ZMQ Constant Types for more information.
175320     *
175321     * @param int $key One of the ZMQ::CTXOPT_* constants.
175322     * @param mixed $value The value of the parameter.
175323     * @return ZMQContext Returns the current object. Throws
175324     *   ZMQContextException on error.
175325     * @since PECL zmq >= 1.0.4
175326     **/
175327    public function setOpt($key, $value){}
175328
175329    /**
175330     * Construct a new ZMQContext object
175331     *
175332     * Constructs a new ZMQ context. The context is used to initialize
175333     * sockets. A persistent context is required to initialize persistent
175334     * sockets.
175335     *
175336     * @param int $io_threads Number of io-threads in the context.
175337     * @param bool $is_persistent Whether the context is persistent.
175338     *   Persistent context is stored over multiple requests and is a
175339     *   requirement for persistent sockets.
175340     * @since PECL zmq >= 0.5.0
175341     **/
175342    function __construct($io_threads, $is_persistent){}
175343
175344}
175345class ZMQContextException extends ZMQException {
175346}
175347class ZMQDevice {
175348    /**
175349     * Get the idle timeout
175350     *
175351     * Gets the idle callback timeout value. Added in ZMQ extension version
175352     * 1.1.0.
175353     *
175354     * @return ZMQDevice This method returns the idle callback timeout
175355     *   value.
175356     **/
175357    public function getIdleTimeout(){}
175358
175359    /**
175360     * Get the timer timeout
175361     *
175362     * Gets the timer callback timeout value. Added in ZMQ extension version
175363     * 1.1.0.
175364     *
175365     * @return ZMQDevice This method returns the timer timeout value.
175366     **/
175367    public function getTimerTimeout(){}
175368
175369    /**
175370     * Run the new device
175371     *
175372     * Runs the device.
175373     *
175374     * @return void Call to this method will block until the device is
175375     *   running. It is not recommended that devices are used from
175376     *   interactive scripts. On failure this method will throw
175377     *   ZMQDeviceException.
175378     **/
175379    public function run(){}
175380
175381    /**
175382     * Set the idle callback function
175383     *
175384     * Sets the idle callback function. If idle timeout is defined the idle
175385     * callback function shall be called if the internal poll loop times out
175386     * without events. If the callback function returns false or a value that
175387     * evaluates to false the device is stopped.
175388     *
175389     * The callback function signature is callback (mixed $user_data).
175390     *
175391     * @param callable $cb_func Callback function to invoke when the device
175392     *   is idle. Returning false or a value that evaluates to false from
175393     *   this function will cause the device to stop.
175394     * @param int $timeout How often to invoke the idle callback in
175395     *   milliseconds. The idle callback is invoked periodically when there
175396     *   is no activity on the device. The timeout value guarantees that
175397     *   there is at least this amount of milliseconds between invocations of
175398     *   the callback function.
175399     * @param mixed $user_data Additional data to pass to the callback
175400     *   function.
175401     * @return ZMQDevice On success this method returns the current object.
175402     **/
175403    public function setIdleCallback($cb_func, $timeout, $user_data){}
175404
175405    /**
175406     * Set the idle timeout
175407     *
175408     * Sets the idle callback timeout value. The idle callback is invoked
175409     * periodically when the device is idle.
175410     *
175411     * @param int $timeout The idle callback timeout value.
175412     * @return ZMQDevice On success this method returns the current object.
175413     **/
175414    public function setIdleTimeout($timeout){}
175415
175416    /**
175417     * Set the timer callback function
175418     *
175419     * Sets the timer callback function. The timer callback will be invoked
175420     * after timeout has passed. The difference between idle and timer
175421     * callbacks are that idle callback is invoked only when the device is
175422     * idle.
175423     *
175424     * The callback function signature is callback (mixed $user_data). Added
175425     * in ZMQ extension version 1.1.0.
175426     *
175427     * @param callable $cb_func Callback function to invoke when the device
175428     *   is idle. Returning false or a value that evaluates to false from
175429     *   this function will cause the device to stop.
175430     * @param int $timeout How often to invoke the idle callback in
175431     *   milliseconds. The idle callback is invoked periodically when there
175432     *   is no activity on the device. The timeout value guarantees that
175433     *   there is at least this amount of milliseconds between invocations of
175434     *   the callback function.
175435     * @param mixed $user_data Additional data to pass to the callback
175436     *   function.
175437     * @return ZMQDevice On success this method returns the current object.
175438     **/
175439    public function setTimerCallback($cb_func, $timeout, $user_data){}
175440
175441    /**
175442     * Set the timer timeout
175443     *
175444     * Sets the timer callback timeout value. The timer callback is invoked
175445     * periodically if it's set. Added in ZMQ extension version 1.1.0.
175446     *
175447     * @param int $timeout The timer callback timeout value.
175448     * @return ZMQDevice On success this method returns the current object.
175449     **/
175450    public function setTimerTimeout($timeout){}
175451
175452    /**
175453     * Construct a new device
175454     *
175455     * "ØMQ devices can do intermediation of addresses, services, queues, or
175456     * any other abstraction you care to define above the message and socket
175457     * layers." -- zguide
175458     *
175459     * @param ZMQSocket $frontend Frontend parameter for the devices.
175460     *   Usually where there messages are coming.
175461     * @param ZMQSocket $backend Backend parameter for the devices. Usually
175462     *   where there messages going to.
175463     * @param ZMQSocket $listener Listener socket, which receives a copy of
175464     *   all messages going both directions. The type of this socket should
175465     *   be SUB, PULL or DEALER.
175466     * @since PECL zmq >= 0.5.0
175467     **/
175468    function __construct($frontend, $backend, $listener){}
175469
175470}
175471class ZMQDeviceException extends ZMQException {
175472}
175473class ZMQException extends Exception {
175474}
175475class ZMQPoll {
175476    /**
175477     * Add item to the poll set
175478     *
175479     * Adds a new item to the poll set and returns the internal id of the
175480     * added item. The item can be removed from the poll set using the
175481     * returned string id.
175482     *
175483     * @param mixed $entry ZMQSocket object or a PHP stream resource
175484     * @param int $type Defines what activity the socket is polled for. See
175485     *   ZMQ::POLL_IN and ZMQ::POLL_OUT constants.
175486     * @return string Returns a string id of the added item which can be
175487     *   later used to remove the item. Throws ZMQPollException on error.
175488     * @since PECL zmq >= 0.5.0
175489     **/
175490    public function add($entry, $type){}
175491
175492    /**
175493     * Clear the poll set
175494     *
175495     * Clears all elements from the poll set.
175496     *
175497     * @return ZMQPoll Returns the current object.
175498     * @since PECL zmq >= 0.5.0
175499     **/
175500    public function clear(){}
175501
175502    /**
175503     * Count items in the poll set
175504     *
175505     * Count the items in the poll set.
175506     *
175507     * @return int Returns an representing the amount of items in the poll
175508     *   set.
175509     * @since PECL zmq >= 0.5.0
175510     **/
175511    public function count(){}
175512
175513    /**
175514     * Get poll errors
175515     *
175516     * Returns the ids of the objects that had errors in the last poll.
175517     *
175518     * @return array Returns an array containing ids for the items that had
175519     *   errors in the last poll. Empty array is returned if there were no
175520     *   errors.
175521     * @since PECL zmq >= 0.5.0
175522     **/
175523    public function getLastErrors(){}
175524
175525    /**
175526     * Poll the items
175527     *
175528     * Polls the items in the current poll set. The readable and writable
175529     * items are returned in the {@link readable} and {@link writable}
175530     * parameters. {@link ZMQPoll::getLastErrors} can be used to check if
175531     * there were errors.
175532     *
175533     * @param array $readable Array where readable ZMQSockets/PHP streams
175534     *   are returned. The array will be cleared at the beginning of the
175535     *   operation.
175536     * @param array $writable Array where writable ZMQSockets/PHP streams
175537     *   are returned. The array will be cleared at the beginning of the
175538     *   operation.
175539     * @param int $timeout Timeout for the operation. -1 means that poll
175540     *   waits until at least one item has activity. Please note that
175541     *   starting from version 1.0.0 the poll timeout is defined in
175542     *   milliseconds, rather than microseconds.
175543     * @return int Returns an integer representing amount of items with
175544     *   activity. Throws ZMQPollException on error.
175545     * @since PECL zmq >= 0.5.0
175546     **/
175547    public function poll(&$readable, &$writable, $timeout){}
175548
175549    /**
175550     * Remove item from poll set
175551     *
175552     * Remove item from the poll set. The {@link item} parameter can be
175553     * ZMQSocket object, a stream resource or the id returned from {@link
175554     * ZMQPoll::add} method.
175555     *
175556     * @param mixed $item The ZMQSocket object, PHP stream or id of the
175557     *   item.
175558     * @return bool Returns true if the item was removed and false if the
175559     *   object with given id does not exist in the poll set.
175560     * @since PECL zmq >= 0.5.0
175561     **/
175562    public function remove($item){}
175563
175564}
175565class ZMQPollException extends ZMQException {
175566}
175567class ZMQSocket {
175568    /**
175569     * Bind the socket
175570     *
175571     * Bind the socket to an endpoint. The endpoint is defined in format
175572     * transport://address where transport is one of the following: inproc,
175573     * ipc, tcp, pgm or epgm.
175574     *
175575     * @param string $dsn The bind dsn, for example transport://address.
175576     * @param bool $force Tries to bind even if the socket has already been
175577     *   bound to the given endpoint.
175578     * @return ZMQSocket Returns the current object. Throws
175579     *   ZMQSocketException on error.
175580     * @since PECL zmq >= 0.5.0
175581     **/
175582    public function bind($dsn, $force){}
175583
175584    /**
175585     * Connect the socket
175586     *
175587     * Connect the socket to a remote endpoint. The endpoint is defined in
175588     * format transport://address where transport is one of the following:
175589     * inproc, ipc, tcp, pgm or epgm.
175590     *
175591     * @param string $dsn The connect dsn, for example transport://address.
175592     * @param bool $force Tries to connect even if the socket has already
175593     *   been connected to given endpoint.
175594     * @return ZMQSocket Returns the current object. Throws
175595     *   ZMQSocketException on error.
175596     * @since PECL zmq >= 0.5.0
175597     **/
175598    public function connect($dsn, $force){}
175599
175600    /**
175601     * Disconnect a socket
175602     *
175603     * Disconnect the socket from a previously connected remote endpoint. The
175604     * endpoint is defined in format transport://address where transport is
175605     * one of the following: inproc, ipc, tcp, pgm or epgm.
175606     *
175607     * @param string $dsn The connect dsn, for example transport://address.
175608     * @return ZMQSocket Returns the current object. Throws
175609     *   ZMQSocketException on error.
175610     * @since PECL zmq >= 1.0.4
175611     **/
175612    public function disconnect($dsn){}
175613
175614    /**
175615     * Get list of endpoints
175616     *
175617     * Returns a list of endpoints where the socket is connected or bound to.
175618     *
175619     * @return array Returns an array containing elements 'bind' and
175620     *   'connect'.
175621     * @since PECL zmq >= 0.5.0
175622     **/
175623    public function getEndpoints(){}
175624
175625    /**
175626     * Get the persistent id
175627     *
175628     * Returns the persistent id of the socket.
175629     *
175630     * @return string Returns the persistent id string assigned of the
175631     *   object and NULL if socket is not persistent.
175632     * @since PECL zmq >= 0.5.0
175633     **/
175634    public function getPersistentId(){}
175635
175636    /**
175637     * Get the socket type
175638     *
175639     * Gets the socket type.
175640     *
175641     * @return int Returns an integer representing the socket type. The
175642     *   integer can be compared against ZMQ::SOCKET_* constants.
175643     * @since PECL zmq >= 0.5.0
175644     **/
175645    public function getSocketType(){}
175646
175647    /**
175648     * Get socket option
175649     *
175650     * Returns the value of a socket option.
175651     *
175652     * @param string $key An integer representing the option. See the
175653     *   ZMQ::SOCKOPT_* constants.
175654     * @return mixed Returns either a or an depending on {@link key}.
175655     *   Throws ZMQSocketException on error.
175656     * @since PECL zmq >= 0.5.0
175657     **/
175658    public function getSockOpt($key){}
175659
175660    /**
175661     * Whether the socket is persistent
175662     *
175663     * Check whether the socket is persistent.
175664     *
175665     * @return bool Returns a based on whether the socket is persistent or
175666     *   not.
175667     * @since PECL zmq >= 0.5.0
175668     **/
175669    public function isPersistent(){}
175670
175671    /**
175672     * Receives a message
175673     *
175674     * Receive a message from a socket. By default receiving will block until
175675     * a message is available unless ZMQ::MODE_DONTWAIT flag is used.
175676     * ZMQ::SOCKOPT_RCVMORE socket option can be used for receiving
175677     * multi-part messages. See {@link ZMQSocket::setSockOpt} for more
175678     * information.
175679     *
175680     * @param int $mode Pass mode flags to receive multipart messages or
175681     *   non-blocking operation. See ZMQ::MODE_* constants.
175682     * @return string Returns the message. Throws ZMQSocketException in
175683     *   error. If ZMQ::MODE_DONTWAIT is used and the operation would block
175684     *   false shall be returned.
175685     * @since PECL zmq >= 0.5.0
175686     **/
175687    public function recv($mode){}
175688
175689    /**
175690     * Receives a multipart message
175691     *
175692     * Receive an array multipart message from a socket. By default receiving
175693     * will block until a message is available unless ZMQ::MODE_NOBLOCK flag
175694     * is used.
175695     *
175696     * @param int $mode Pass mode flags to receive multipart messages or
175697     *   non-blocking operation. See ZMQ::MODE_* constants.
175698     * @return array Returns the array of message parts. Throws
175699     *   ZMQSocketException in error. If ZMQ::MODE_NOBLOCK is used and the
175700     *   operation would block false shall be returned.
175701     * @since PECL zmq >= 0.8.0
175702     **/
175703    public function recvMulti($mode){}
175704
175705    /**
175706     * Sends a message
175707     *
175708     * Send a message using the socket. The operation can block unless
175709     * ZMQ::MODE_NOBLOCK is used.
175710     *
175711     * @param string $message The message to send.
175712     * @param int $mode Pass mode flags to receive multipart messages or
175713     *   non-blocking operation. See ZMQ::MODE_* constants.
175714     * @return ZMQSocket Returns the current object. Throws
175715     *   ZMQSocketException on error. If ZMQ::MODE_NOBLOCK is used and the
175716     *   operation would block false shall be returned.
175717     * @since PECL zmq >= 0.5.0
175718     **/
175719    public function send($message, $mode){}
175720
175721    /**
175722     * Sends a multipart message
175723     *
175724     * Send a multipart message using the socket. The operation can block
175725     * unless ZMQ::MODE_NOBLOCK is used.
175726     *
175727     * @param array $message The message to send - an array of strings
175728     * @param int $mode Pass mode flags to receive multipart messages or
175729     *   non-blocking operation. See ZMQ::MODE_* constants.
175730     * @return ZMQSocket Returns the current object. Throws
175731     *   ZMQSocketException on error. If ZMQ::MODE_NOBLOCK is used and the
175732     *   operation would block false shall be returned.
175733     * @since PECL zmq >= 0.8.0
175734     **/
175735    public function sendmulti($message, $mode){}
175736
175737    /**
175738     * Set a socket option
175739     *
175740     * Sets a ZMQ socket option. The type of the {@link value} depends on the
175741     * {@link key}. See ZMQ Constant Types for more information.
175742     *
175743     * @param int $key One of the ZMQ::SOCKOPT_* constants.
175744     * @param mixed $value The value of the parameter.
175745     * @return ZMQSocket Returns the current object. Throws
175746     *   ZMQSocketException on error.
175747     * @since PECL zmq >= 0.5.0
175748     **/
175749    public function setSockOpt($key, $value){}
175750
175751    /**
175752     * Unbind the socket
175753     *
175754     * Unbind the socket from an endpoint. The endpoint is defined in format
175755     * transport://address where transport is one of the following: inproc,
175756     * ipc, tcp, pgm or epgm.
175757     *
175758     * @param string $dsn The previously bound dsn, for example
175759     *   transport://address.
175760     * @return ZMQSocket Returns the current object. Throws
175761     *   ZMQSocketException on error.
175762     * @since PECL zmq >= 1.0.4
175763     **/
175764    public function unbind($dsn){}
175765
175766    /**
175767     * Construct a new ZMQSocket
175768     *
175769     * Constructs a ZMQSocket object. {@link persistent_id} parameter can be
175770     * used to allocated a persistent socket. A persistent socket has to be
175771     * allocated from a persistent context and it stays connected over
175772     * multiple requests. The {@link persistent_id} parameter can be used to
175773     * recall the same socket over multiple requests. The {@link
175774     * on_new_socket} is called only when a new underlying socket structure
175775     * is created.
175776     *
175777     * @param ZMQContext $context ZMQContext object.
175778     * @param int $type The socket type. See ZMQ::SOCKET_* constants.
175779     * @param string $persistent_id If {@link persistent_id} is specified
175780     *   the socket will be persisted over multiple requests. If {@link
175781     *   context} is not persistent the socket falls back to non-persistent
175782     *   mode.
175783     * @param callback $on_new_socket Callback function, which is executed
175784     *   when a new socket structure is created. This function does not get
175785     *   invoked if the underlying persistent connection is re-used.
175786     * @since PECL zmq >= 0.5.0
175787     **/
175788    function __construct($context, $type, $persistent_id, $on_new_socket){}
175789
175790}
175791class ZMQSocketException extends ZMQException {
175792}
175793/**
175794 * Represents ZooKeeper session.
175795 **/
175796class Zookeeper {
175797    /**
175798     * This is never thrown by the server, it shouldn't be used other than to
175799     * indicate a range. Specifically error codes greater than this value are
175800     * API errors (while values less than this indicate a
175801     * Zookeeper::SYSTEMERROR).
175802     *
175803     * @var mixed
175804     **/
175805    const APIERROR = 0;
175806
175807    /**
175808     * Associating
175809     *
175810     * @var mixed
175811     **/
175812    const ASSOCIATING_STATE = 0;
175813
175814    /**
175815     * Client authentication failed.
175816     *
175817     * @var mixed
175818     **/
175819    const AUTHFAILED = 0;
175820
175821    /**
175822     * Connected but auth failed
175823     *
175824     * @var mixed
175825     **/
175826    const AUTH_FAILED_STATE = 0;
175827
175828    /**
175829     * Invalid arguments.
175830     *
175831     * @var mixed
175832     **/
175833    const BADARGUMENTS = 0;
175834
175835    /**
175836     * Version conflict.
175837     *
175838     * @var mixed
175839     **/
175840    const BADVERSION = 0;
175841
175842    /**
175843     * A node has changed
175844     *
175845     * @var mixed
175846     **/
175847    const CHANGED_EVENT = 0;
175848
175849    /**
175850     * A change as occurred in the list of children
175851     *
175852     * @var mixed
175853     **/
175854    const CHILD_EVENT = 0;
175855
175856    /**
175857     * ZooKeeper is closing.
175858     *
175859     * @var mixed
175860     **/
175861    const CLOSING = 0;
175862
175863    /**
175864     * Connected
175865     *
175866     * @var mixed
175867     **/
175868    const CONNECTED_STATE = 0;
175869
175870    /**
175871     * Connecting
175872     *
175873     * @var mixed
175874     **/
175875    const CONNECTING_STATE = 0;
175876
175877    /**
175878     * Connection to the server has been lost.
175879     *
175880     * @var mixed
175881     **/
175882    const CONNECTIONLOSS = 0;
175883
175884    /**
175885     * A node has been created
175886     *
175887     * @var mixed
175888     **/
175889    const CREATED_EVENT = 0;
175890
175891    /**
175892     * A data inconsistency was found.
175893     *
175894     * @var mixed
175895     **/
175896    const DATAINCONSISTENCY = 0;
175897
175898    /**
175899     * A node has been deleted
175900     *
175901     * @var mixed
175902     **/
175903    const DELETED_EVENT = 0;
175904
175905    /**
175906     * If Zookeeper::EPHEMERAL flag is set, the node will automatically get
175907     * removed if the client session goes away.
175908     *
175909     * @var mixed
175910     **/
175911    const EPHEMERAL = 0;
175912
175913    /**
175914     * Attempt to create ephemeral node on a local session.
175915     *
175916     * @var mixed
175917     **/
175918    const EPHEMERALONLOCALSESSION = 0;
175919
175920    /**
175921     * Connected but session expired
175922     *
175923     * @var mixed
175924     **/
175925    const EXPIRED_SESSION_STATE = 0;
175926
175927    /**
175928     * Invalid ACL specified.
175929     *
175930     * @var mixed
175931     **/
175932    const INVALIDACL = 0;
175933
175934    /**
175935     * Invalid callback specified.
175936     *
175937     * @var mixed
175938     **/
175939    const INVALIDCALLBACK = 0;
175940
175941    /**
175942     * Invliad zhandle state.
175943     *
175944     * @var mixed
175945     **/
175946    const INVALIDSTATE = 0;
175947
175948    /**
175949     * Outputs all
175950     *
175951     * @var mixed
175952     **/
175953    const LOG_LEVEL_DEBUG = 0;
175954
175955    /**
175956     * Outputs only error mesages
175957     *
175958     * @var mixed
175959     **/
175960    const LOG_LEVEL_ERROR = 0;
175961
175962    /**
175963     * Outputs big action messages besides errors/warnings
175964     *
175965     * @var mixed
175966     **/
175967    const LOG_LEVEL_INFO = 0;
175968
175969    /**
175970     * Outputs errors/warnings
175971     *
175972     * @var mixed
175973     **/
175974    const LOG_LEVEL_WARN = 0;
175975
175976    /**
175977     * Error while marshalling or unmarshalling data.
175978     *
175979     * @var mixed
175980     **/
175981    const MARSHALLINGERROR = 0;
175982
175983    /**
175984     * No quorum of new config is connected and up-to-date with the leader of
175985     * last committed config - try invoking reconfiguration after new servers
175986     * are connected and synced.
175987     *
175988     * @var mixed
175989     **/
175990    const NEWCONFIGNOQUORUM = 0;
175991
175992    /**
175993     * Not authenticated.
175994     *
175995     * @var mixed
175996     **/
175997    const NOAUTH = 0;
175998
175999    /**
176000     * Ephemeral nodes may not have children.
176001     *
176002     * @var mixed
176003     **/
176004    const NOCHILDRENFOREPHEMERALS = 0;
176005
176006    /**
176007     * The node already exists.
176008     *
176009     * @var mixed
176010     **/
176011    const NODEEXISTS = 0;
176012
176013    /**
176014     * Node does not exist.
176015     *
176016     * @var mixed
176017     **/
176018    const NONODE = 0;
176019
176020    /**
176021     * Connection failed
176022     *
176023     * @var mixed
176024     **/
176025    const NOTCONNECTED_STATE = 0;
176026
176027    /**
176028     * The node has children.
176029     *
176030     * @var mixed
176031     **/
176032    const NOTEMPTY = 0;
176033
176034    /**
176035     * (not error) No server responses to process.
176036     *
176037     * @var mixed
176038     **/
176039    const NOTHING = 0;
176040
176041    /**
176042     * State-changing request is passed to read-only server.
176043     *
176044     * @var mixed
176045     **/
176046    const NOTREADONLY = 0;
176047
176048    /**
176049     * A watch has been removed
176050     *
176051     * @var mixed
176052     **/
176053    const NOTWATCHING_EVENT = 0;
176054
176055    /**
176056     * The watcher couldn't be found.
176057     *
176058     * @var mixed
176059     **/
176060    const NOWATCHER = 0;
176061
176062    /**
176063     * Everything is OK.
176064     *
176065     * @var mixed
176066     **/
176067    const OK = 0;
176068
176069    /**
176070     * Operation timeout.
176071     *
176072     * @var mixed
176073     **/
176074    const OPERATIONTIMEOUT = 0;
176075
176076    /**
176077     * Can execute set_acl()
176078     *
176079     * @var mixed
176080     **/
176081    const PERM_ADMIN = 0;
176082
176083    /**
176084     * All of the above flags ORd together
176085     *
176086     * @var mixed
176087     **/
176088    const PERM_ALL = 0;
176089
176090    /**
176091     * Can create children
176092     *
176093     * @var mixed
176094     **/
176095    const PERM_CREATE = 0;
176096
176097    /**
176098     * Can delete children
176099     *
176100     * @var mixed
176101     **/
176102    const PERM_DELETE = 0;
176103
176104    /**
176105     * Can read nodes value and list its children
176106     *
176107     * @var mixed
176108     **/
176109    const PERM_READ = 0;
176110
176111    /**
176112     * Can set the nodes value
176113     *
176114     * @var mixed
176115     **/
176116    const PERM_WRITE = 0;
176117
176118    /**
176119     * TODO: help us improve this extension.
176120     *
176121     * @var mixed
176122     **/
176123    const READONLY_STATE = 0;
176124
176125    /**
176126     * Attempts to perform a reconfiguration operation when reconfiguration
176127     * feature is disabled.
176128     *
176129     * @var mixed
176130     **/
176131    const RECONFIGDISABLED = 0;
176132
176133    /**
176134     * Reconfiguration requested while another reconfiguration is currently
176135     * in progress. This is currently not supported. Please retry.
176136     *
176137     * @var mixed
176138     **/
176139    const RECONFIGINPROGRESS = 0;
176140
176141    /**
176142     * A runtime inconsistency was found.
176143     *
176144     * @var mixed
176145     **/
176146    const RUNTIMEINCONSISTENCY = 0;
176147
176148    /**
176149     * If the Zookeeper::SEQUENCE flag is set, a unique monotonically
176150     * increasing sequence number is appended to the path name. The sequence
176151     * number is always fixed length of 10 digits, 0 padded.
176152     *
176153     * @var mixed
176154     **/
176155    const SEQUENCE = 0;
176156
176157    /**
176158     * The session has been expired by the server.
176159     *
176160     * @var mixed
176161     **/
176162    const SESSIONEXPIRED = 0;
176163
176164    /**
176165     * Session moved to another server, so operation is ignored.
176166     *
176167     * @var mixed
176168     **/
176169    const SESSIONMOVED = 0;
176170
176171    /**
176172     * A session has been lost
176173     *
176174     * @var mixed
176175     **/
176176    const SESSION_EVENT = 0;
176177
176178    /**
176179     * This is never thrown by the server, it shouldn't be used other than to
176180     * indicate a range. Specifically error codes greater than this value,
176181     * but lesser than Zookeeper::APIERROR, are system errors.
176182     *
176183     * @var mixed
176184     **/
176185    const SYSTEMERROR = 0;
176186
176187    /**
176188     * Operation is unimplemented.
176189     *
176190     * @var mixed
176191     **/
176192    const UNIMPLEMENTED = 0;
176193
176194    /**
176195     * Specify application credentials
176196     *
176197     * The application calls this function to specify its credentials for
176198     * purposes of authentication. The server will use the security provider
176199     * specified by the scheme parameter to authenticate the client
176200     * connection. If the authentication request has failed: - the server
176201     * connection is dropped. - the watcher is called with the
176202     * ZOO_AUTH_FAILED_STATE value as the state parameter.
176203     *
176204     * @param string $scheme The id of authentication scheme. Natively
176205     *   supported: "digest" password-based authentication
176206     * @param string $cert Application credentials. The actual value
176207     *   depends on the scheme.
176208     * @param callable $completion_cb The routine to invoke when the
176209     *   request completes. One of the following result codes may be passed
176210     *   into the completion callback: - ZOK operation completed successfully
176211     *   - ZAUTHFAILED authentication failed
176212     * @return bool
176213     * @since PECL zookeeper >= 0.1.0
176214     **/
176215    public function addAuth($scheme, $cert, $completion_cb){}
176216
176217    /**
176218     * Close the zookeeper handle and free up any resources
176219     *
176220     * @return void
176221     * @since PECL zookeeper >= 0.5.0
176222     **/
176223    public function close(){}
176224
176225    /**
176226     * Create a handle to used communicate with zookeeper
176227     *
176228     * This method creates a new handle and a zookeeper session that
176229     * corresponds to that handle. Session establishment is asynchronous,
176230     * meaning that the session should not be considered established until
176231     * (and unless) an event of state ZOO_CONNECTED_STATE is received.
176232     *
176233     * @param string $host Comma separated host:port pairs, each
176234     *   corresponding to a zk server. e.g.
176235     *   "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002"
176236     * @param callable $watcher_cb The global watcher callback function.
176237     *   When notifications are triggered this function will be invoked.
176238     * @param int $recv_timeout The timeout for this session, only valid if
176239     *   the connections is currently connected (ie. last watcher state is
176240     *   ZOO_CONNECTED_STATE).
176241     * @return void
176242     * @since PECL zookeeper >= 0.2.0
176243     **/
176244    public function connect($host, $watcher_cb, $recv_timeout){}
176245
176246    /**
176247     * Create a node synchronously
176248     *
176249     * This method will create a node in ZooKeeper. A node can only be
176250     * created if it does not already exists. The Create Flags affect the
176251     * creation of nodes. If ZOO_EPHEMERAL flag is set, the node will
176252     * automatically get removed if the client session goes away. If the
176253     * ZOO_SEQUENCE flag is set, a unique monotonically increasing sequence
176254     * number is appended to the path name.
176255     *
176256     * @param string $path The name of the node. Expressed as a file name
176257     *   with slashes separating ancestors of the node.
176258     * @param string $value The data to be stored in the node.
176259     * @param array $acls The initial ACL of the node. The ACL must not be
176260     *   null or empty.
176261     * @param int $flags this parameter can be set to 0 for normal create
176262     *   or an OR of the Create Flags
176263     * @return string Returns the path of the new node (this might be
176264     *   different than the supplied path because of the ZOO_SEQUENCE flag)
176265     *   on success, and false on failure.
176266     * @since PECL zookeeper >= 0.1.0
176267     **/
176268    public function create($path, $value, $acls, $flags){}
176269
176270    /**
176271     * Delete a node in zookeeper synchronously
176272     *
176273     * @param string $path The name of the node. Expressed as a file name
176274     *   with slashes separating ancestors of the node.
176275     * @param int $version The expected version of the node. The function
176276     *   will fail if the actual version of the node does not match the
176277     *   expected version. If -1 is used the version check will not take
176278     *   place.
176279     * @return bool
176280     * @since PECL zookeeper >= 0.2.0
176281     **/
176282    public function delete($path, $version){}
176283
176284    /**
176285     * Checks the existence of a node in zookeeper synchronously
176286     *
176287     * @param string $path The name of the node. Expressed as a file name
176288     *   with slashes separating ancestors of the node.
176289     * @param callable $watcher_cb if nonzero, a watch will be set at the
176290     *   server to notify the client if the node changes. The watch will be
176291     *   set even if the node does not
176292     * @return array Returns the value of stat for the path if the given
176293     *   node exists, otherwise false.
176294     * @since PECL zookeeper >= 0.1.0
176295     **/
176296    public function exists($path, $watcher_cb){}
176297
176298    /**
176299     * Gets the data associated with a node synchronously
176300     *
176301     * @param string $path The name of the node. Expressed as a file name
176302     *   with slashes separating ancestors of the node.
176303     * @param callable $watcher_cb If nonzero, a watch will be set at the
176304     *   server to notify the client if the node changes.
176305     * @param array $stat If not NULL, will hold the value of stat for the
176306     *   path on return.
176307     * @param int $max_size Max size of the data. If 0 is used, this method
176308     *   will return the whole data.
176309     * @return string Returns the data on success, and false on failure.
176310     * @since PECL zookeeper >= 0.1.0
176311     **/
176312    public function get($path, $watcher_cb, &$stat, $max_size){}
176313
176314    /**
176315     * Gets the acl associated with a node synchronously
176316     *
176317     * @param string $path The name of the node. Expressed as a file name
176318     *   with slashes separating ancestors of the node.
176319     * @return array Return acl array on success and false on failure.
176320     * @since PECL zookeeper >= 0.1.0
176321     **/
176322    public function getAcl($path){}
176323
176324    /**
176325     * Lists the children of a node synchronously
176326     *
176327     * @param string $path The name of the node. Expressed as a file name
176328     *   with slashes separating ancestors of the node.
176329     * @param callable $watcher_cb If nonzero, a watch will be set at the
176330     *   server to notify the client if the node changes.
176331     * @return array Returns an array with children paths on success, and
176332     *   false on failure.
176333     * @since PECL zookeeper >= 0.1.0
176334     **/
176335    public function getChildren($path, $watcher_cb){}
176336
176337    /**
176338     * Return the client session id, only valid if the connections is
176339     * currently connected (ie. last watcher state is ZOO_CONNECTED_STATE)
176340     *
176341     * @return int Returns the client session id on success, and false on
176342     *   failure.
176343     * @since PECL zookeeper >= 0.1.0
176344     **/
176345    public function getClientId(){}
176346
176347    /**
176348     * Get instance of ZookeeperConfig
176349     *
176350     * @return ZookeeperConfig Returns instance of ZookeeperConfig.
176351     * @since PECL zookeeper >= 0.6.0, ZooKeeper >= 3.5.0
176352     **/
176353    public function getConfig(){}
176354
176355    /**
176356     * Return the timeout for this session, only valid if the connections is
176357     * currently connected (ie. last watcher state is ZOO_CONNECTED_STATE).
176358     * This value may change after a server re-connect
176359     *
176360     * @return int Returns the timeout for this session on success, and
176361     *   false on failure.
176362     * @since PECL zookeeper >= 0.1.0
176363     **/
176364    public function getRecvTimeout(){}
176365
176366    /**
176367     * Get the state of the zookeeper connection
176368     *
176369     * @return int Returns the state of zookeeper connection on success,
176370     *   and false on failure.
176371     * @since PECL zookeeper >= 0.1.0
176372     **/
176373    public function getState(){}
176374
176375    /**
176376     * Checks if the current zookeeper connection state can be recovered
176377     *
176378     * The application must close the handle and try to reconnect.
176379     *
176380     * @return bool Returns true/false on success, and false on failure.
176381     * @since PECL zookeeper >= 0.1.0
176382     **/
176383    public function isRecoverable(){}
176384
176385    /**
176386     * Sets the data associated with a node
176387     *
176388     * @param string $path The name of the node. Expressed as a file name
176389     *   with slashes separating ancestors of the node.
176390     * @param string $value The data to be stored in the node.
176391     * @param int $version The expected version of the node. The function
176392     *   will fail if the actual version of the node does not match the
176393     *   expected version. If -1 is used the version check will not take
176394     *   place.
176395     * @param array $stat If not NULL, will hold the value of stat for the
176396     *   path on return.
176397     * @return bool
176398     * @since PECL zookeeper >= 0.1.0
176399     **/
176400    public function set($path, $value, $version, &$stat){}
176401
176402    /**
176403     * Sets the acl associated with a node synchronously
176404     *
176405     * @param string $path The name of the node. Expressed as a file name
176406     *   with slashes separating ancestors of the node.
176407     * @param int $version The expected version of the path.
176408     * @param array $acl The acl to be set on the path.
176409     * @return bool
176410     * @since PECL zookeeper >= 0.1.0
176411     **/
176412    public function setAcl($path, $version, $acl){}
176413
176414    /**
176415     * Sets the debugging level for the library
176416     *
176417     * @param int $logLevel ZooKeeper log level constants.
176418     * @return bool
176419     * @since PECL zookeeper >= 0.1.0
176420     **/
176421    public static function setDebugLevel($logLevel){}
176422
176423    /**
176424     * Enable/disable quorum endpoint order randomization
176425     *
176426     * If passed a true value, will make the client connect to quorum peers
176427     * in the order as specified in the zookeeper_init() call. A false value
176428     * causes zookeeper_init() to permute the peer endpoints which is good
176429     * for more even client connection distribution among the quorum peers.
176430     * ZooKeeper C Client uses false by default.
176431     *
176432     * @param bool $yesOrNo Disable/enable quorum endpoint order
176433     *   randomization.
176434     * @return bool
176435     * @since PECL zookeeper >= 0.1.0
176436     **/
176437    public static function setDeterministicConnOrder($yesOrNo){}
176438
176439    /**
176440     * Sets the stream to be used by the library for logging
176441     *
176442     * The zookeeper library uses stderr as its default log stream.
176443     * Application must make sure the stream is writable. Passing in NULL
176444     * resets the stream to its default value (stderr).
176445     *
176446     * @param resource $stream The stream to be used by the library for
176447     *   logging.
176448     * @return bool
176449     * @since PECL zookeeper >= 0.1.0
176450     **/
176451    public function setLogStream($stream){}
176452
176453    /**
176454     * Set a watcher function
176455     *
176456     * @param callable $watcher_cb A watch will be set at the server to
176457     *   notify the client if the node changes.
176458     * @return bool
176459     * @since PECL zookeeper >= 0.1.0
176460     **/
176461    public function setWatcher($watcher_cb){}
176462
176463}
176464/**
176465 * The ZooKeeper authentication exception handling class.
176466 **/
176467class ZookeeperAuthenticationException extends ZookeeperException {
176468}
176469/**
176470 * The ZooKeeper Config handling class.
176471 **/
176472class ZookeeperConfig {
176473    /**
176474     * Add servers to the ensemble
176475     *
176476     * @param string $members Comma separated list of servers to be added
176477     *   to the ensemble. Each has a configuration line for a server to be
176478     *   added (as would appear in a configuration file), only for maj.
176479     *   quorums.
176480     * @param int $version The expected version of the node. The function
176481     *   will fail if the actual version of the node does not match the
176482     *   expected version. If -1 is used the version check will not take
176483     *   place.
176484     * @param array $stat If not NULL, will hold the value of stat for the
176485     *   path on return.
176486     * @return void
176487     * @since PECL zookeeper >= 0.6.0, ZooKeeper >= 3.5.0
176488     **/
176489    public function add($members, $version, &$stat){}
176490
176491    /**
176492     * Gets the last committed configuration of the ZooKeeper cluster as it
176493     * is known to the server to which the client is connected, synchronously
176494     *
176495     * @param callable $watcher_cb If nonzero, a watch will be set at the
176496     *   server to notify the client if the node changes.
176497     * @param array $stat If not NULL, will hold the value of stat for the
176498     *   path on return.
176499     * @return string Returns the configuration string on success, and
176500     *   false on failure.
176501     * @since PECL zookeeper >= 0.6.0, ZooKeeper >= 3.5.0
176502     **/
176503    public function get($watcher_cb, &$stat){}
176504
176505    /**
176506     * Remove servers from the ensemble
176507     *
176508     * @param string $id_list Comma separated list of server IDs to be
176509     *   removed from the ensemble. Each has an id of a server to be removed,
176510     *   only for maj. quorums.
176511     * @param int $version The expected version of the node. The function
176512     *   will fail if the actual version of the node does not match the
176513     *   expected version. If -1 is used the version check will not take
176514     *   place.
176515     * @param array $stat If not NULL, will hold the value of stat for the
176516     *   path on return.
176517     * @return void
176518     * @since PECL zookeeper >= 0.6.0, ZooKeeper >= 3.5.0
176519     **/
176520    public function remove($id_list, $version, &$stat){}
176521
176522    /**
176523     * Change ZK cluster ensemble membership and roles of ensemble peers
176524     *
176525     * @param string $members Comma separated list of new membership (e.g.,
176526     *   contents of a membership configuration file) - for use only with a
176527     *   non-incremental reconfiguration.
176528     * @param int $version The expected version of the node. The function
176529     *   will fail if the actual version of the node does not match the
176530     *   expected version. If -1 is used the version check will not take
176531     *   place.
176532     * @param array $stat If not NULL, will hold the value of stat for the
176533     *   path on return.
176534     * @return void
176535     * @since PECL zookeeper >= 0.6.0, ZooKeeper >= 3.5.0
176536     **/
176537    public function set($members, $version, &$stat){}
176538
176539}
176540/**
176541 * The ZooKeeper connection exception handling class.
176542 **/
176543class ZookeeperConnectionException extends ZookeeperException {
176544}
176545/**
176546 * The ZooKeeper exception handling class.
176547 **/
176548class ZookeeperException extends Exception {
176549}
176550/**
176551 * The ZooKeeper exception (while marshalling or unmarshalling data)
176552 * handling class.
176553 **/
176554class ZookeeperMarshallingException extends ZookeeperException {
176555}
176556/**
176557 * The ZooKeeper exception (when node does not exist) handling class.
176558 **/
176559class ZookeeperNoNodeException extends ZookeeperException {
176560}
176561/**
176562 * The ZooKeeper operation timeout exception handling class.
176563 **/
176564class ZookeeperOperationTimeoutException extends ZookeeperException {
176565}
176566/**
176567 * The ZooKeeper session exception handling class.
176568 **/
176569class ZookeeperSessionException extends ZookeeperException {
176570}
176571/**
176572 * fifo
176573 **/
176574define('0010000', 0);
176575/**
176576 * directory
176577 **/
176578define('0040000', 0);
176579/**
176580 * block device
176581 **/
176582define('0060000', 0);
176583/**
176584 * regular file
176585 **/
176586define('0100000', 0);
176587/**
176588 * link
176589 **/
176590define('0120000', 0);
176591/**
176592 * Abbreviated name of n-th day of the week.
176593 **/
176594define('ABDAY_1', 0);
176595/**
176596 * Abbreviated name of n-th day of the week.
176597 **/
176598define('ABDAY_2', 0);
176599/**
176600 * Abbreviated name of n-th day of the week.
176601 **/
176602define('ABDAY_3', 0);
176603/**
176604 * Abbreviated name of n-th day of the week.
176605 **/
176606define('ABDAY_4', 0);
176607/**
176608 * Abbreviated name of n-th day of the week.
176609 **/
176610define('ABDAY_5', 0);
176611/**
176612 * Abbreviated name of n-th day of the week.
176613 **/
176614define('ABDAY_6', 0);
176615/**
176616 * Abbreviated name of n-th day of the week.
176617 **/
176618define('ABDAY_7', 0);
176619/**
176620 * Abbreviated name of the n-th month of the year.
176621 **/
176622define('ABMON_1', 0);
176623/**
176624 * Abbreviated name of the n-th month of the year.
176625 **/
176626define('ABMON_2', 0);
176627/**
176628 * Abbreviated name of the n-th month of the year.
176629 **/
176630define('ABMON_3', 0);
176631/**
176632 * Abbreviated name of the n-th month of the year.
176633 **/
176634define('ABMON_4', 0);
176635/**
176636 * Abbreviated name of the n-th month of the year.
176637 **/
176638define('ABMON_5', 0);
176639/**
176640 * Abbreviated name of the n-th month of the year.
176641 **/
176642define('ABMON_6', 0);
176643/**
176644 * Abbreviated name of the n-th month of the year.
176645 **/
176646define('ABMON_7', 0);
176647/**
176648 * Abbreviated name of the n-th month of the year.
176649 **/
176650define('ABMON_8', 0);
176651/**
176652 * Abbreviated name of the n-th month of the year.
176653 **/
176654define('ABMON_9', 0);
176655/**
176656 * Abbreviated name of the n-th month of the year.
176657 **/
176658define('ABMON_10', 0);
176659/**
176660 * Abbreviated name of the n-th month of the year.
176661 **/
176662define('ABMON_11', 0);
176663/**
176664 * Abbreviated name of the n-th month of the year.
176665 **/
176666define('ABMON_12', 0);
176667/**
176668 * IPv4 Internet based protocols. TCP and UDP are common protocols of
176669 * this protocol family.
176670 **/
176671define('AF_INET', 0);
176672/**
176673 * IPv6 Internet based protocols. TCP and UDP are common protocols of
176674 * this protocol family.
176675 **/
176676define('AF_INET6', 0);
176677/**
176678 * Local communication protocol family. High efficiency and low overhead
176679 * make it a great form of IPC (Interprocess Communication).
176680 **/
176681define('AF_UNIX', 0);
176682define('ALC_FREQUENCY', 0);
176683define('ALC_REFRESH', 0);
176684define('ALC_SYNC', 0);
176685define('ALL_MATCHES', 0);
176686define('AL_BITS', 0);
176687define('AL_BUFFER', 0);
176688define('AL_CHANNELS', 0);
176689define('AL_CONE_INNER_ANGLE', 0);
176690define('AL_CONE_OUTER_ANGLE', 0);
176691define('AL_CONE_OUTER_GAIN', 0);
176692define('AL_DIRECTION', 0);
176693define('AL_FALSE', 0);
176694define('AL_FORMAT_MONO8', 0);
176695define('AL_FORMAT_MONO16', 0);
176696define('AL_FORMAT_STEREO8', 0);
176697define('AL_FORMAT_STEREO16', 0);
176698define('AL_FREQUENCY', 0);
176699define('AL_GAIN', 0);
176700define('AL_INITIAL', 0);
176701define('AL_LOOPING', 0);
176702define('AL_MAX_DISTANCE', 0);
176703define('AL_MAX_GAIN', 0);
176704define('AL_MIN_GAIN', 0);
176705define('AL_ORIENTATION', 0);
176706define('AL_PAUSED', 0);
176707define('AL_PITCH', 0);
176708define('AL_PLAYING', 0);
176709define('AL_POSITION', 0);
176710define('AL_REFERENCE_DISTANCE', 0);
176711define('AL_ROLLOFF_FACTOR', 0);
176712define('AL_SIZE', 0);
176713define('AL_SOURCE_RELATIVE', 0);
176714define('AL_SOURCE_STATE', 0);
176715define('AL_STOPPED', 0);
176716define('AL_TRUE', 0);
176717define('AL_VELOCITY', 0);
176718/**
176719 * String for Ante meridian.
176720 **/
176721define('AM_STR', 0);
176722define('APACHE_MAP', 0);
176723define('APC_BIN_VERIFY_CRC32', 0);
176724define('APC_BIN_VERIFY_MD5', 0);
176725define('APC_ITER_ALL', 0);
176726define('APC_ITER_ATIME', 0);
176727define('APC_ITER_CTIME', 0);
176728define('APC_ITER_DEVICE', 0);
176729define('APC_ITER_DTIME', 0);
176730define('APC_ITER_FILENAME', 0);
176731define('APC_ITER_INODE', 0);
176732define('APC_ITER_KEY', 0);
176733define('APC_ITER_MD5', 0);
176734define('APC_ITER_MEM_SIZE', 0);
176735define('APC_ITER_MTIME', 0);
176736define('APC_ITER_NONE', 0);
176737define('APC_ITER_NUM_HITS', 0);
176738define('APC_ITER_REFCOUNT', 0);
176739define('APC_ITER_TTL', 0);
176740define('APC_ITER_TYPE', 0);
176741define('APC_ITER_VALUE', 0);
176742define('APC_LIST_ACTIVE', 0);
176743define('APC_LIST_DELETED', 0);
176744define('APD_VERSION', '');
176745define('APIERROR', 0);
176746define('ARGS_TRACE', 0);
176747define('ARRAY_AS_PROPS', 0);
176748define('ARRAY_FILTER_USE_BOTH', 0);
176749define('ARRAY_FILTER_USE_KEY', 0);
176750define('ASSERT_ACTIVE', 0);
176751define('ASSERT_BAIL', 0);
176752define('ASSERT_CALLBACK', 0);
176753define('ASSERT_QUIET_EVAL', 0);
176754define('ASSERT_WARNING', 0);
176755define('ASSIGNMENT_TRACE', 0);
176756define('ASSOCIATING_STATE', 0);
176757define('AUTHFAILED', 0);
176758define('AUTH_FAILED_STATE', 0);
176759define('BADARGUMENTS', 0);
176760define('BADVERSION', 0);
176761define('BBCODE_ARG_DOUBLE_QUOTE', 0);
176762define('BBCODE_ARG_HTML_QUOTE', 0);
176763define('BBCODE_ARG_QUOTE_ESCAPING', 0);
176764define('BBCODE_ARG_SINGLE_QUOTE', 0);
176765define('BBCODE_AUTO_CORRECT', 0);
176766define('BBCODE_CORRECT_REOPEN_TAGS', 0);
176767define('BBCODE_DEFAULT_SMILEYS_OFF', 0);
176768define('BBCODE_DEFAULT_SMILEYS_ON', 0);
176769define('BBCODE_DISABLE_TREE_BUILD', 0);
176770define('BBCODE_FLAGS_ARG_PARSING', 0);
176771define('BBCODE_FLAGS_CDATA_NOT_ALLOWED', 0);
176772define('BBCODE_FLAGS_DENY_REOPEN_CHILD', 0);
176773define('BBCODE_FLAGS_ONE_OPEN_PER_LEVEL', 0);
176774define('BBCODE_FLAGS_REMOVE_IF_EMPTY', 0);
176775define('BBCODE_FLAGS_SMILEYS_OFF', 0);
176776define('BBCODE_FLAGS_SMILEYS_ON', 0);
176777define('BBCODE_FORCE_SMILEYS_OFF', 0);
176778define('BBCODE_SET_FLAGS_ADD', 0);
176779define('BBCODE_SET_FLAGS_REMOVE', 0);
176780define('BBCODE_SET_FLAGS_SET', 0);
176781define('BBCODE_SMILEYS_CASE_INSENSITIVE', 0);
176782define('BBCODE_TYPE_ARG', 0);
176783define('BBCODE_TYPE_NOARG', 0);
176784define('BBCODE_TYPE_OPTARG', 0);
176785define('BBCODE_TYPE_ROOT', 0);
176786define('BBCODE_TYPE_SINGLE', 0);
176787define('BLENC_EXT_VERSION', '');
176788define('BUS_ADRALN', 0);
176789define('BUS_ADRERR', 0);
176790define('BUS_OBJERR', 0);
176791define('CAIRO_ANTIALIAS_DEFAULT', 0);
176792define('CAIRO_ANTIALIAS_GRAY', 0);
176793define('CAIRO_ANTIALIAS_NONE', 0);
176794define('CAIRO_ANTIALIAS_SUBPIXEL', 0);
176795define('CAIRO_CONTENT_ALPHA', 0);
176796define('CAIRO_CONTENT_COLOR', 0);
176797define('CAIRO_CONTENT_COLOR_ALPHA', 0);
176798define('CAIRO_EXTEND_NONE', 0);
176799define('CAIRO_EXTEND_PAD', 0);
176800define('CAIRO_EXTEND_REFLECT', 0);
176801define('CAIRO_EXTEND_REPEAT', 0);
176802define('CAIRO_FILL_RULE_EVEN_ODD', 0);
176803define('CAIRO_FILL_RULE_WINDING', 0);
176804define('CAIRO_FILTER_BEST', 0);
176805define('CAIRO_FILTER_BILINEAR', 0);
176806define('CAIRO_FILTER_FAST', 0);
176807define('CAIRO_FILTER_GAUSSIAN', 0);
176808define('CAIRO_FILTER_GOOD', 0);
176809define('CAIRO_FILTER_NEAREST', 0);
176810define('CAIRO_FONT_SLANT_ITALIC', 0);
176811define('CAIRO_FONT_SLANT_NORMAL', 0);
176812define('CAIRO_FONT_SLANT_OBLIQUE', 0);
176813define('CAIRO_FONT_TYPE_FT', 0);
176814define('CAIRO_FONT_TYPE_QUARTZ', 0);
176815define('CAIRO_FONT_TYPE_TOY', 0);
176816define('CAIRO_FONT_TYPE_WIN32', 0);
176817define('CAIRO_FONT_WEIGHT_BOLD', 0);
176818define('CAIRO_FONT_WEIGHT_NORMAL', 0);
176819define('CAIRO_FORMAT_A1', 0);
176820define('CAIRO_FORMAT_A8', 0);
176821define('CAIRO_FORMAT_ARGB32', 0);
176822define('CAIRO_FORMAT_RGB24', 0);
176823define('CAIRO_HINT_METRICS_DEFAULT', 0);
176824define('CAIRO_HINT_METRICS_OFF', 0);
176825define('CAIRO_HINT_METRICS_ON', 0);
176826define('CAIRO_HINT_STYLE_DEFAULT', 0);
176827define('CAIRO_HINT_STYLE_FULL', 0);
176828define('CAIRO_HINT_STYLE_MEDIUM', 0);
176829define('CAIRO_HINT_STYLE_NONE', 0);
176830define('CAIRO_HINT_STYLE_SLIGHT', 0);
176831define('CAIRO_LINE_CAP_BUTT', 0);
176832define('CAIRO_LINE_CAP_ROUND', 0);
176833define('CAIRO_LINE_CAP_SQUARE', 0);
176834define('CAIRO_LINE_JOIN_BEVEL', 0);
176835define('CAIRO_LINE_JOIN_MITER', 0);
176836define('CAIRO_LINE_JOIN_ROUND', 0);
176837define('CAIRO_OPERATOR_ADD', 0);
176838define('CAIRO_OPERATOR_ATOP', 0);
176839define('CAIRO_OPERATOR_CLEAR', 0);
176840define('CAIRO_OPERATOR_DEST', 0);
176841define('CAIRO_OPERATOR_DEST_ATOP', 0);
176842define('CAIRO_OPERATOR_DEST_IN', 0);
176843define('CAIRO_OPERATOR_DEST_OUT', 0);
176844define('CAIRO_OPERATOR_DEST_OVER', 0);
176845define('CAIRO_OPERATOR_IN', 0);
176846define('CAIRO_OPERATOR_OUT', 0);
176847define('CAIRO_OPERATOR_OVER', 0);
176848define('CAIRO_OPERATOR_SATURATE', 0);
176849define('CAIRO_OPERATOR_SOURCE', 0);
176850define('CAIRO_OPERATOR_XOR', 0);
176851define('CAIRO_PATTERN_TYPE_LINEAR', 0);
176852define('CAIRO_PATTERN_TYPE_RADIAL', 0);
176853define('CAIRO_PATTERN_TYPE_SOLID', 0);
176854define('CAIRO_PATTERN_TYPE_SURFACE', 0);
176855define('CAIRO_PS_LEVEL_2', 0);
176856define('CAIRO_PS_LEVEL_3', 0);
176857define('CAIRO_STATUS_CLIP_NOT_REPRESENTABLE', 0);
176858define('CAIRO_STATUS_FILE_NOT_FOUND', 0);
176859define('CAIRO_STATUS_INVALID_CONTENT', 0);
176860define('CAIRO_STATUS_INVALID_DASH', 0);
176861define('CAIRO_STATUS_INVALID_DSC_COMMENT', 0);
176862define('CAIRO_STATUS_INVALID_FORMAT', 0);
176863define('CAIRO_STATUS_INVALID_INDEX', 0);
176864define('CAIRO_STATUS_INVALID_MATRIX', 0);
176865define('CAIRO_STATUS_INVALID_PATH_DATA', 0);
176866define('CAIRO_STATUS_INVALID_POP_GROUP', 0);
176867define('CAIRO_STATUS_INVALID_RESTORE', 0);
176868define('CAIRO_STATUS_INVALID_STATUS', 0);
176869define('CAIRO_STATUS_INVALID_STRIDE', 0);
176870define('CAIRO_STATUS_INVALID_STRING', 0);
176871define('CAIRO_STATUS_INVALID_VISUAL', 0);
176872define('CAIRO_STATUS_NO_CURRENT_POINT', 0);
176873define('CAIRO_STATUS_NO_MEMORY', 0);
176874define('CAIRO_STATUS_NULL_POINTER', 0);
176875define('CAIRO_STATUS_PATTERN_TYPE_MISMATCH', 0);
176876define('CAIRO_STATUS_READ_ERROR', 0);
176877define('CAIRO_STATUS_SUCCESS', 0);
176878define('CAIRO_STATUS_SURFACE_FINISHED', 0);
176879define('CAIRO_STATUS_SURFACE_TYPE_MISMATCH', 0);
176880define('CAIRO_STATUS_TEMP_FILE_ERROR', 0);
176881define('CAIRO_STATUS_WRITE_ERROR', 0);
176882define('CAIRO_SUBPIXEL_ORDER_BGR', 0);
176883define('CAIRO_SUBPIXEL_ORDER_DEFAULT', 0);
176884define('CAIRO_SUBPIXEL_ORDER_RGB', 0);
176885define('CAIRO_SUBPIXEL_ORDER_VBGR', 0);
176886define('CAIRO_SUBPIXEL_ORDER_VRGB', 0);
176887define('CAIRO_SURFACE_TYPE_BEOS', 0);
176888define('CAIRO_SURFACE_TYPE_DIRECTFB', 0);
176889define('CAIRO_SURFACE_TYPE_GLITZ', 0);
176890define('CAIRO_SURFACE_TYPE_IMAGE', 0);
176891define('CAIRO_SURFACE_TYPE_OS2', 0);
176892define('CAIRO_SURFACE_TYPE_PDF', 0);
176893define('CAIRO_SURFACE_TYPE_PS', 0);
176894define('CAIRO_SURFACE_TYPE_QUARTZ', 0);
176895define('CAIRO_SURFACE_TYPE_QUARTZ_IMAGE', 0);
176896define('CAIRO_SURFACE_TYPE_SVG', 0);
176897define('CAIRO_SURFACE_TYPE_WIN32', 0);
176898define('CAIRO_SURFACE_TYPE_WIN32_PRINTING', 0);
176899define('CAIRO_SURFACE_TYPE_XCB', 0);
176900define('CAIRO_SURFACE_TYPE_XLIB', 0);
176901define('CAIRO_SVG_VERSION_1_1', 0);
176902define('CAIRO_SVG_VERSION_1_2', 0);
176903define('CAL_DOW_DAYNO', 0);
176904define('CAL_DOW_LONG', 0);
176905define('CAL_DOW_SHORT', 0);
176906define('CAL_EASTER_ALWAYS_GREGORIAN', 0);
176907define('CAL_EASTER_ALWAYS_JULIAN', 0);
176908define('CAL_EASTER_DEFAULT', 0);
176909define('CAL_EASTER_ROMAN', 0);
176910define('CAL_FRENCH', 0);
176911define('CAL_GREGORIAN', 0);
176912define('CAL_JEWISH', 0);
176913define('CAL_JEWISH_ADD_ALAFIM', 0);
176914define('CAL_JEWISH_ADD_ALAFIM_GERESH', 0);
176915define('CAL_JEWISH_ADD_GERESHAYIM', 0);
176916define('CAL_JULIAN', 0);
176917/**
176918 * French Republican
176919 **/
176920define('CAL_MONTH_FRENCH', 0);
176921/**
176922 * Gregorian
176923 **/
176924define('CAL_MONTH_GREGORIAN_LONG', 0);
176925/**
176926 * Gregorian - abbreviated
176927 **/
176928define('CAL_MONTH_GREGORIAN_SHORT', 0);
176929/**
176930 * Jewish
176931 **/
176932define('CAL_MONTH_JEWISH', 0);
176933/**
176934 * Julian
176935 **/
176936define('CAL_MONTH_JULIAN_LONG', 0);
176937/**
176938 * Julian - abbreviated
176939 **/
176940define('CAL_MONTH_JULIAN_SHORT', 0);
176941define('CAL_NUM_CALS', 0);
176942define('CASE_LOWER', 0);
176943define('CASE_UPPER', 0);
176944define('CHANGED_EVENT', 0);
176945define('CHAR_MAX', 0);
176946define('CHILD_ARRAYS_ONLY', 0);
176947define('CHILD_EVENT', 0);
176948define('CLASSKIT_ACC_PRIVATE', 0);
176949define('CLASSKIT_ACC_PROTECTED', 0);
176950define('CLASSKIT_ACC_PUBLIC', 0);
176951define('CLASSKIT_AGGREGATE_OVERRIDE', 0);
176952define('CLASSKIT_VERSION', '');
176953define('CLD_CONTINUED', 0);
176954define('CLD_DUMPED', 0);
176955define('CLD_EXITED', 0);
176956define('CLD_KILLED', 0);
176957define('CLD_STOPPED', 0);
176958define('CLD_TRAPPED', 0);
176959define('CLOSING', 0);
176960define('CLSCTX_ALL', 0);
176961/**
176962 * The code that manages objects of this class is an in-process handler.
176963 * This is a DLL that runs in the client process and implements
176964 * client-side structures of this class when instances of the class are
176965 * accessed remotely.
176966 **/
176967define('CLSCTX_INPROC_HANDLER', 0);
176968/**
176969 * The code that creates and manages objects of this class is a DLL that
176970 * runs in the same process as the caller of the function specifying the
176971 * class context.
176972 **/
176973define('CLSCTX_INPROC_SERVER', 0);
176974/**
176975 * The EXE code that creates and manages objects of this class runs on
176976 * same machine but is loaded in a separate process space.
176977 **/
176978define('CLSCTX_LOCAL_SERVER', 0);
176979/**
176980 * A remote context. The code that creates and manages objects of this
176981 * class is run on a different computer.
176982 **/
176983define('CLSCTX_REMOTE_SERVER', 0);
176984define('CLSCTX_SERVER', 0);
176985define('CL_EXPUNGE', 0);
176986/**
176987 * Return a string with the name of the character encoding.
176988 **/
176989define('CODESET', 0);
176990define('CONNECTED_STATE', 0);
176991define('CONNECTING_STATE', 0);
176992define('CONNECTIONLOSS', 0);
176993define('CONNECTION_ABORTED', 0);
176994define('CONNECTION_NORMAL', 0);
176995define('CONNECTION_TIMEOUT', 0);
176996define('COUNT_NORMAL', 0);
176997define('COUNT_RECURSIVE', 0);
176998/**
176999 * Default to ANSI code page.
177000 **/
177001define('CP_ACP', 0);
177002/**
177003 * Macintosh code page.
177004 **/
177005define('CP_MACCP', 0);
177006define('CP_MOVE', 0);
177007/**
177008 * Default to OEM code page.
177009 **/
177010define('CP_OEMCP', 0);
177011define('CP_SYMBOL', 0);
177012/**
177013 * Current thread's ANSI code page
177014 **/
177015define('CP_THREAD_ACP', 0);
177016define('CP_UID', 0);
177017/**
177018 * Unicode (UTF-7).
177019 **/
177020define('CP_UTF7', 0);
177021/**
177022 * Unicode (UTF-8).
177023 **/
177024define('CP_UTF8', 0);
177025define('CREATED_EVENT', 0);
177026define('CREDITS_ALL', 0);
177027define('CREDITS_DOCS', 0);
177028define('CREDITS_FULLPAGE', 0);
177029define('CREDITS_GENERAL', 0);
177030define('CREDITS_GROUP', 0);
177031define('CREDITS_MODULES', 0);
177032define('CREDITS_QA', 0);
177033define('CREDITS_SAPI', 0);
177034/**
177035 * Same value as CURRENCY_SYMBOL.
177036 **/
177037define('CRNCYSTR', 0);
177038define('CRYPT_BLOWFISH', 0);
177039define('CRYPT_EXT_DES', 0);
177040define('CRYPT_MD5', 0);
177041define('CRYPT_SALT_LENGTH', 0);
177042define('CRYPT_STD_DES', 0);
177043define('CURLAUTH_ANY', 0);
177044define('CURLAUTH_ANYSAFE', 0);
177045define('CURLAUTH_BASIC', 0);
177046define('CURLAUTH_BEARER', 0);
177047define('CURLAUTH_DIGEST', 0);
177048define('CURLAUTH_GSSAPI', 0);
177049define('CURLAUTH_GSSNEGOTIATE', 0);
177050define('CURLAUTH_NEGOTIATE', 0);
177051define('CURLAUTH_NTLM', 0);
177052define('CURLAUTH_NTLM_WB', 0);
177053define('CURLCLOSEPOLICY_CALLBACK', 0);
177054define('CURLCLOSEPOLICY_LEAST_RECENTLY_USED', 0);
177055define('CURLCLOSEPOLICY_LEAST_TRAFFIC', 0);
177056define('CURLCLOSEPOLICY_OLDEST', 0);
177057define('CURLCLOSEPOLICY_SLOWEST', 0);
177058define('CURLE_ABORTED_BY_CALLBACK', 0);
177059define('CURLE_BAD_CALLING_ORDER', 0);
177060define('CURLE_BAD_CONTENT_ENCODING', 0);
177061define('CURLE_BAD_FUNCTION_ARGUMENT', 0);
177062define('CURLE_BAD_PASSWORD_ENTERED', 0);
177063define('CURLE_COULDNT_CONNECT', 0);
177064define('CURLE_COULDNT_RESOLVE_HOST', 0);
177065define('CURLE_COULDNT_RESOLVE_PROXY', 0);
177066define('CURLE_FAILED_INIT', 0);
177067define('CURLE_FILESIZE_EXCEEDED', 0);
177068define('CURLE_FILE_COULDNT_READ_FILE', 0);
177069define('CURLE_FTP_ACCESS_DENIED', 0);
177070define('CURLE_FTP_BAD_DOWNLOAD_RESUME', 0);
177071define('CURLE_FTP_CANT_GET_HOST', 0);
177072define('CURLE_FTP_CANT_RECONNECT', 0);
177073define('CURLE_FTP_COULDNT_GET_SIZE', 0);
177074define('CURLE_FTP_COULDNT_RETR_FILE', 0);
177075define('CURLE_FTP_COULDNT_SET_ASCII', 0);
177076define('CURLE_FTP_COULDNT_SET_BINARY', 0);
177077define('CURLE_FTP_COULDNT_STOR_FILE', 0);
177078define('CURLE_FTP_COULDNT_USE_REST', 0);
177079define('CURLE_FTP_PORT_FAILED', 0);
177080define('CURLE_FTP_QUOTE_ERROR', 0);
177081define('CURLE_FTP_SSL_FAILED', 0);
177082define('CURLE_FTP_USER_PASSWORD_INCORRECT', 0);
177083define('CURLE_FTP_WEIRD_227_FORMAT', 0);
177084define('CURLE_FTP_WEIRD_PASS_REPLY', 0);
177085define('CURLE_FTP_WEIRD_PASV_REPLY', 0);
177086define('CURLE_FTP_WEIRD_SERVER_REPLY', 0);
177087define('CURLE_FTP_WEIRD_USER_REPLY', 0);
177088define('CURLE_FTP_WRITE_ERROR', 0);
177089define('CURLE_FUNCTION_NOT_FOUND', 0);
177090define('CURLE_GOT_NOTHING', 0);
177091define('CURLE_HTTP_NOT_FOUND', 0);
177092define('CURLE_HTTP_PORT_FAILED', 0);
177093define('CURLE_HTTP_POST_ERROR', 0);
177094define('CURLE_HTTP_RANGE_ERROR', 0);
177095define('CURLE_LDAP_CANNOT_BIND', 0);
177096define('CURLE_LDAP_INVALID_URL', 0);
177097define('CURLE_LDAP_SEARCH_FAILED', 0);
177098define('CURLE_LIBRARY_NOT_FOUND', 0);
177099define('CURLE_MALFORMAT_USER', 0);
177100define('CURLE_OBSOLETE', 0);
177101define('CURLE_OK', 0);
177102define('CURLE_OPERATION_TIMEOUTED', 0);
177103define('CURLE_OUT_OF_MEMORY', 0);
177104define('CURLE_PARTIAL_FILE', 0);
177105define('CURLE_READ_ERROR', 0);
177106define('CURLE_RECV_ERROR', 0);
177107define('CURLE_SEND_ERROR', 0);
177108define('CURLE_SHARE_IN_USE', 0);
177109define('CURLE_SSH', 0);
177110define('CURLE_SSL_CACERT', 0);
177111define('CURLE_SSL_CERTPROBLEM', 0);
177112define('CURLE_SSL_CIPHER', 0);
177113define('CURLE_SSL_CONNECT_ERROR', 0);
177114define('CURLE_SSL_ENGINE_NOTFOUND', 0);
177115define('CURLE_SSL_ENGINE_SETFAILED', 0);
177116define('CURLE_SSL_PEER_CERTIFICATE', 0);
177117define('CURLE_TELNET_OPTION_SYNTAX', 0);
177118define('CURLE_TOO_MANY_REDIRECTS', 0);
177119define('CURLE_UNKNOWN_TELNET_OPTION', 0);
177120define('CURLE_UNSUPPORTED_PROTOCOL', 0);
177121define('CURLE_URL_MALFORMAT', 0);
177122define('CURLE_URL_MALFORMAT_USER', 0);
177123define('CURLE_WEIRD_SERVER_REPLY', 0);
177124define('CURLE_WRITE_ERROR', 0);
177125define('CURLFTPAUTH_DEFAULT', 0);
177126define('CURLFTPAUTH_SSL', 0);
177127define('CURLFTPAUTH_TLS', 0);
177128define('CURLFTPSSL_ALL', 0);
177129define('CURLFTPSSL_CONTROL', 0);
177130define('CURLFTPSSL_NONE', 0);
177131define('CURLFTPSSL_TRY', 0);
177132define('CURLFTP_CREATE_DIR', 0);
177133define('CURLFTP_CREATE_DIR_NONE', 0);
177134define('CURLFTP_CREATE_DIR_RETRY', 0);
177135define('CURLHEADER_SEPARATE', 0);
177136define('CURLHEADER_UNIFIED', 0);
177137define('CURLINFO_APPCONNECT_TIME_T', 0);
177138define('CURLINFO_CONNECT_TIME', 0);
177139define('CURLINFO_CONNECT_TIME_T', 0);
177140define('CURLINFO_CONTENT_LENGTH_DOWNLOAD', 0);
177141define('CURLINFO_CONTENT_LENGTH_DOWNLOAD_T', 0);
177142define('CURLINFO_CONTENT_LENGTH_UPLOAD', 0);
177143define('CURLINFO_CONTENT_LENGTH_UPLOAD_T', 0);
177144define('CURLINFO_CONTENT_TYPE', 0);
177145define('CURLINFO_EFFECTIVE_URL', 0);
177146define('CURLINFO_FILETIME', 0);
177147define('CURLINFO_FILETIME_T', 0);
177148/**
177149 * TRUE to track the handle's request string.
177150 **/
177151define('CURLINFO_HEADER_OUT', 0);
177152define('CURLINFO_HEADER_SIZE', 0);
177153define('CURLINFO_HTTP_CODE', 0);
177154define('CURLINFO_HTTP_VERSION', 0);
177155define('CURLINFO_LOCAL_IP', '');
177156define('CURLINFO_LOCAL_PORT', 0);
177157define('CURLINFO_NAMELOOKUP_TIME', 0);
177158define('CURLINFO_NAMELOOKUP_TIME_T', 0);
177159define('CURLINFO_PRETRANSFER_TIME', 0);
177160define('CURLINFO_PRETRANSFER_TIME_T', 0);
177161define('CURLINFO_PRIMARY_IP', '');
177162define('CURLINFO_PRIMARY_PORT', 0);
177163define('CURLINFO_PRIVATE', 0);
177164define('CURLINFO_PROTOCOL', 0);
177165define('CURLINFO_PROXY_SSL_VERIFYRESULT', 0);
177166define('CURLINFO_REDIRECT_COUNT', 0);
177167define('CURLINFO_REDIRECT_TIME', 0);
177168define('CURLINFO_REDIRECT_TIME_T', 0);
177169define('CURLINFO_REDIRECT_URL', '');
177170define('CURLINFO_REQUEST_SIZE', 0);
177171define('CURLINFO_RESPONSE_CODE', 0);
177172define('CURLINFO_SCHEME', 0);
177173define('CURLINFO_SIZE_DOWNLOAD', 0);
177174define('CURLINFO_SIZE_DOWNLOAD_T', 0);
177175define('CURLINFO_SIZE_UPLOAD', 0);
177176define('CURLINFO_SIZE_UPLOAD_T', 0);
177177define('CURLINFO_SPEED_DOWNLOAD', 0);
177178define('CURLINFO_SPEED_DOWNLOAD_T', 0);
177179define('CURLINFO_SPEED_UPLOAD', 0);
177180define('CURLINFO_SPEED_UPLOAD_T', 0);
177181define('CURLINFO_SSL_VERIFYRESULT', 0);
177182define('CURLINFO_STARTTRANSFER_TIME', 0);
177183define('CURLINFO_STARTTRANSFER_TIME_T', 0);
177184define('CURLINFO_TOTAL_TIME', 0);
177185define('CURLINFO_TOTAL_TIME_T', 0);
177186/**
177187 * Pass a number that specifies the chunk length threshold for pipelining
177188 * in bytes.
177189 **/
177190define('CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE', 0);
177191/**
177192 * Pass a number that specifies the size threshold for pipelining penalty
177193 * in bytes.
177194 **/
177195define('CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE', 0);
177196/**
177197 * Pass a number that will be used as the maximum amount of
177198 * simultaneously open connections that libcurl may cache. By default the
177199 * size will be enlarged to fit four times the number of handles added
177200 * via {@link curl_multi_add_handle}. When the cache is full, curl closes
177201 * the oldest one in the cache to prevent the number of open connections
177202 * from increasing.
177203 **/
177204define('CURLMOPT_MAXCONNECTS', 0);
177205/**
177206 * Pass a number that specifies the maximum number of connections to a
177207 * single host.
177208 **/
177209define('CURLMOPT_MAX_HOST_CONNECTIONS', 0);
177210/**
177211 * Pass a number that specifies the maximum number of requests in a
177212 * pipeline.
177213 **/
177214define('CURLMOPT_MAX_PIPELINE_LENGTH', 0);
177215/**
177216 * Pass a number that specifies the maximum number of simultaneously open
177217 * connections.
177218 **/
177219define('CURLMOPT_MAX_TOTAL_CONNECTIONS', 0);
177220/**
177221 * Pass 1 to enable or 0 to disable. Enabling pipelining on a multi
177222 * handle will make it attempt to perform HTTP Pipelining as far as
177223 * possible for transfers using this handle. This means that if you add a
177224 * second request that can use an already existing connection, the second
177225 * request will be "piped" on the same connection. As of cURL 7.43.0, the
177226 * value is a bitmask, and you can also pass 2 to try to multiplex the
177227 * new transfer over an existing HTTP/2 connection if possible. Passing 3
177228 * instructs cURL to ask for pipelining and multiplexing independently of
177229 * each other. As of cURL 7.62.0, setting the pipelining bit has no
177230 * effect. Instead of integer literals, you can also use the CURLPIPE_*
177231 * constants if available.
177232 **/
177233define('CURLMOPT_PIPELINING', 0);
177234/**
177235 * Pass a callable that will be registered to handle server pushes and
177236 * should have the following signature: intpushfunction resource{@link
177237 * parent_ch} resource{@link pushed_ch} array{@link headers} {@link
177238 * parent_ch} The parent cURL handle (the request the client made).
177239 * {@link pushed_ch} A new cURL handle for the pushed request. {@link
177240 * headers} The push promise headers. The push function is supposed to
177241 * return either CURL_PUSH_OK if it can handle the push, or
177242 * CURL_PUSH_DENY to reject it.
177243 **/
177244define('CURLMOPT_PUSHFUNCTION', 0);
177245define('CURLMSG_DONE', 0);
177246define('CURLM_BAD_EASY_HANDLE', 0);
177247define('CURLM_BAD_HANDLE', 0);
177248define('CURLM_CALL_MULTI_PERFORM', 0);
177249define('CURLM_INTERNAL_ERROR', 0);
177250define('CURLM_OK', 0);
177251define('CURLM_OUT_OF_MEMORY', 0);
177252/**
177253 * Enables the use of an abstract Unix domain socket instead of
177254 * establishing a TCP connection to a host and sets the path to the given
177255 * string. This option shares the same semantics as
177256 * CURLOPT_UNIX_SOCKET_PATH. These two options share the same storage and
177257 * therefore only one of them can be set per handle.
177258 **/
177259define('CURLOPT_ABSTRACT_UNIX_SOCKET', 0);
177260/**
177261 * TRUE to automatically set the Referer: field in requests where it
177262 * follows a Location: redirect.
177263 **/
177264define('CURLOPT_AUTOREFERER', 0);
177265/**
177266 * TRUE to return the raw output when CURLOPT_RETURNTRANSFER is used.
177267 **/
177268define('CURLOPT_BINARYTRANSFER', 0);
177269/**
177270 * The size of the buffer to use for each read. There is no guarantee
177271 * this request will be fulfilled, however.
177272 **/
177273define('CURLOPT_BUFFERSIZE', 0);
177274/**
177275 * The name of a file holding one or more certificates to verify the peer
177276 * with. This only makes sense when used in combination with
177277 * CURLOPT_SSL_VERIFYPEER.
177278 **/
177279define('CURLOPT_CAINFO', 0);
177280/**
177281 * A directory that holds multiple CA certificates. Use this option
177282 * alongside CURLOPT_SSL_VERIFYPEER.
177283 **/
177284define('CURLOPT_CAPATH', 0);
177285/**
177286 * TRUE to output SSL certification information to STDERR on secure
177287 * transfers.
177288 **/
177289define('CURLOPT_CERTINFO', 0);
177290/**
177291 * One of the CURLCLOSEPOLICY_* values. This option is deprecated, as it
177292 * was never implemented in cURL and never had any effect.
177293 **/
177294define('CURLOPT_CLOSEPOLICY', 0);
177295/**
177296 * The number of seconds to wait while trying to connect. Use 0 to wait
177297 * indefinitely.
177298 **/
177299define('CURLOPT_CONNECTTIMEOUT', 0);
177300/**
177301 * The number of milliseconds to wait while trying to connect. Use 0 to
177302 * wait indefinitely. If libcurl is built to use the standard system name
177303 * resolver, that portion of the connect will still use full-second
177304 * resolution for timeouts with a minimum timeout allowed of one second.
177305 **/
177306define('CURLOPT_CONNECTTIMEOUT_MS', 0);
177307/**
177308 * TRUE tells the library to perform all the required proxy
177309 * authentication and connection setup, but no data transfer. This option
177310 * is implemented for HTTP, SMTP and POP3.
177311 **/
177312define('CURLOPT_CONNECT_ONLY', 0);
177313/**
177314 * Connect to a specific host and port instead of the URL's host and
177315 * port. Accepts an array of strings with the format
177316 * HOST:PORT:CONNECT-TO-HOST:CONNECT-TO-PORT.
177317 **/
177318define('CURLOPT_CONNECT_TO', 0);
177319/**
177320 * The contents of the "Cookie: " header to be used in the HTTP request.
177321 * Note that multiple cookies are separated with a semicolon followed by
177322 * a space (e.g., "fruit=apple; colour=red")
177323 **/
177324define('CURLOPT_COOKIE', 0);
177325/**
177326 * The name of the file containing the cookie data. The cookie file can
177327 * be in Netscape format, or just plain HTTP-style headers dumped into a
177328 * file. If the name is an empty string, no cookies are loaded, but
177329 * cookie handling is still enabled.
177330 **/
177331define('CURLOPT_COOKIEFILE', 0);
177332/**
177333 * The name of a file to save all internal cookies to when the handle is
177334 * closed, e.g. after a call to curl_close.
177335 **/
177336define('CURLOPT_COOKIEJAR', 0);
177337/**
177338 * A cookie string (i.e. a single line in Netscape/Mozilla format, or a
177339 * regular HTTP-style Set-Cookie header) adds that single cookie to the
177340 * internal cookie store. "ALL" erases all cookies held in memory. "SESS"
177341 * erases all session cookies held in memory. "FLUSH" writes all known
177342 * cookies to the file specified by CURLOPT_COOKIEJAR. "RELOAD" loads all
177343 * cookies from the files specified by CURLOPT_COOKIEFILE.
177344 **/
177345define('CURLOPT_COOKIELIST', 0);
177346/**
177347 * TRUE to mark this as a new cookie "session". It will force libcurl to
177348 * ignore all cookies it is about to load that are "session cookies" from
177349 * the previous session. By default, libcurl always stores and loads all
177350 * cookies, independent if they are session cookies or not. Session
177351 * cookies are cookies without expiry date and they are meant to be alive
177352 * and existing for this "session" only.
177353 **/
177354define('CURLOPT_COOKIESESSION', 0);
177355/**
177356 * TRUE to convert Unix newlines to CRLF newlines on transfers.
177357 **/
177358define('CURLOPT_CRLF', 0);
177359/**
177360 * A custom request method to use instead of "GET" or "HEAD" when doing a
177361 * HTTP request. This is useful for doing "DELETE" or other, more obscure
177362 * HTTP requests. Valid values are things like "GET", "POST", "CONNECT"
177363 * and so on; i.e. Do not enter a whole HTTP request line here. For
177364 * instance, entering "GET /index.html HTTP/1.0\r\n\r\n" would be
177365 * incorrect. Don't do this without making sure the server supports the
177366 * custom request method first.
177367 **/
177368define('CURLOPT_CUSTOMREQUEST', 0);
177369/**
177370 * The default protocol to use if the URL is missing a scheme name.
177371 **/
177372define('CURLOPT_DEFAULT_PROTOCOL', 0);
177373/**
177374 * TRUE to not allow URLs that include a username. Usernames are allowed
177375 * by default (0).
177376 **/
177377define('CURLOPT_DISALLOW_USERNAME_IN_URL', 0);
177378/**
177379 * The number of seconds to keep DNS entries in memory. This option is
177380 * set to 120 (2 minutes) by default.
177381 **/
177382define('CURLOPT_DNS_CACHE_TIMEOUT', 0);
177383/**
177384 * Set the name of the network interface that the DNS resolver should
177385 * bind to. This must be an interface name (not an address).
177386 **/
177387define('CURLOPT_DNS_INTERFACE', 0);
177388/**
177389 * Set the local IPv4 address that the resolver should bind to. The
177390 * argument should contain a single numerical IPv4 address as a string.
177391 **/
177392define('CURLOPT_DNS_LOCAL_IP4', 0);
177393/**
177394 * Set the local IPv6 address that the resolver should bind to. The
177395 * argument should contain a single numerical IPv6 address as a string.
177396 **/
177397define('CURLOPT_DNS_LOCAL_IP6', 0);
177398/**
177399 * TRUE to shuffle the order of all returned addresses so that they will
177400 * be used in a random order, when a name is resolved and more than one
177401 * IP address is returned. This may cause IPv4 to be used before IPv6 or
177402 * vice versa.
177403 **/
177404define('CURLOPT_DNS_SHUFFLE_ADDRESSES', 0);
177405/**
177406 * TRUE to use a global DNS cache. This option is not thread-safe. It is
177407 * conditionally enabled by default if PHP is built for non-threaded use
177408 * (CLI, FCGI, Apache2-Prefork, etc.).
177409 **/
177410define('CURLOPT_DNS_USE_GLOBAL_CACHE', 0);
177411/**
177412 * Like CURLOPT_RANDOM_FILE, except a filename to an Entropy Gathering
177413 * Daemon socket.
177414 **/
177415define('CURLOPT_EGDSOCKET', 0);
177416/**
177417 * The contents of the "Accept-Encoding: " header. This enables decoding
177418 * of the response. Supported encodings are "identity", "deflate", and
177419 * "gzip". If an empty string, "", is set, a header containing all
177420 * supported encoding types is sent.
177421 **/
177422define('CURLOPT_ENCODING', 0);
177423/**
177424 * The timeout for Expect: 100-continue responses in milliseconds.
177425 * Defaults to 1000 milliseconds.
177426 **/
177427define('CURLOPT_EXPECT_100_TIMEOUT_MS', 0);
177428/**
177429 * TRUE to fail verbosely if the HTTP code returned is greater than or
177430 * equal to 400. The default behavior is to return the page normally,
177431 * ignoring the code.
177432 **/
177433define('CURLOPT_FAILONERROR', 0);
177434/**
177435 * The file that the transfer should be written to. The default is STDOUT
177436 * (the browser window).
177437 **/
177438define('CURLOPT_FILE', 0);
177439/**
177440 * TRUE to attempt to retrieve the modification date of the remote
177441 * document. This value can be retrieved using the CURLINFO_FILETIME
177442 * option with {@link curl_getinfo}.
177443 **/
177444define('CURLOPT_FILETIME', 0);
177445/**
177446 * TRUE to follow any "Location: " header that the server sends as part
177447 * of the HTTP header (note this is recursive, PHP will follow as many
177448 * "Location: " headers that it is sent, unless CURLOPT_MAXREDIRS is
177449 * set).
177450 **/
177451define('CURLOPT_FOLLOWLOCATION', 0);
177452/**
177453 * TRUE to force the connection to explicitly close when it has finished
177454 * processing, and not be pooled for reuse.
177455 **/
177456define('CURLOPT_FORBID_REUSE', 0);
177457/**
177458 * TRUE to force the use of a new connection instead of a cached one.
177459 **/
177460define('CURLOPT_FRESH_CONNECT', 0);
177461/**
177462 * TRUE to append to the remote file instead of overwriting it.
177463 **/
177464define('CURLOPT_FTPAPPEND', 0);
177465/**
177466 * An alias of CURLOPT_TRANSFERTEXT. Use that instead.
177467 **/
177468define('CURLOPT_FTPASCII', 0);
177469/**
177470 * TRUE to only list the names of an FTP directory.
177471 **/
177472define('CURLOPT_FTPLISTONLY', 0);
177473/**
177474 * The value which will be used to get the IP address to use for the FTP
177475 * "PORT" instruction. The "PORT" instruction tells the remote server to
177476 * connect to our specified IP address. The string may be a plain IP
177477 * address, a hostname, a network interface name (under Unix), or just a
177478 * plain '-' to use the systems default IP address.
177479 **/
177480define('CURLOPT_FTPPORT', 0);
177481/**
177482 * The FTP authentication method (when is activated): CURLFTPAUTH_SSL
177483 * (try SSL first), CURLFTPAUTH_TLS (try TLS first), or
177484 * CURLFTPAUTH_DEFAULT (let cURL decide).
177485 **/
177486define('CURLOPT_FTPSSLAUTH', 0);
177487/**
177488 * TRUE to create missing directories when an FTP operation encounters a
177489 * path that currently doesn't exist.
177490 **/
177491define('CURLOPT_FTP_CREATE_MISSING_DIRS', 0);
177492/**
177493 * Tell curl which method to use to reach a file on a FTP(S) server.
177494 * Possible values are CURLFTPMETHOD_MULTICWD, CURLFTPMETHOD_NOCWD and
177495 * CURLFTPMETHOD_SINGLECWD.
177496 **/
177497define('CURLOPT_FTP_FILEMETHOD', 0);
177498define('CURLOPT_FTP_SSL', 0);
177499/**
177500 * TRUE to use EPRT (and LPRT) when doing active FTP downloads. Use FALSE
177501 * to disable EPRT and LPRT and use PORT only.
177502 **/
177503define('CURLOPT_FTP_USE_EPRT', 0);
177504/**
177505 * TRUE to first try an EPSV command for FTP transfers before reverting
177506 * back to PASV. Set to FALSE to disable EPSV.
177507 **/
177508define('CURLOPT_FTP_USE_EPSV', 0);
177509/**
177510 * Head start for ipv6 for the happy eyeballs algorithm. Happy eyeballs
177511 * attempts to connect to both IPv4 and IPv6 addresses for dual-stack
177512 * hosts, preferring IPv6 first for timeout milliseconds. Defaults to
177513 * CURL_HET_DEFAULT, which is currently 200 milliseconds.
177514 **/
177515define('CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS', 0);
177516/**
177517 * TRUE to send an HAProxy PROXY protocol v1 header at the start of the
177518 * connection. The default action is not to send this header.
177519 **/
177520define('CURLOPT_HAPROXYPROTOCOL', 0);
177521/**
177522 * TRUE to include the header in the output.
177523 **/
177524define('CURLOPT_HEADER', 0);
177525/**
177526 * A callback accepting two parameters. The first is the cURL resource,
177527 * the second is a string with the header data to be written. The header
177528 * data must be written by this callback. Return the number of bytes
177529 * written.
177530 **/
177531define('CURLOPT_HEADERFUNCTION', 0);
177532/**
177533 * How to deal with headers. One of the following constants:
177534 * CURLHEADER_UNIFIED: the headers specified in CURLOPT_HTTPHEADER will
177535 * be used in requests both to servers and proxies. With this option
177536 * enabled, CURLOPT_PROXYHEADER will not have any effect.
177537 * CURLHEADER_SEPARATE: makes CURLOPT_HTTPHEADER headers only get sent to
177538 * a server and not to a proxy. Proxy headers must be set with
177539 * CURLOPT_PROXYHEADER to get used. Note that if a non-CONNECT request is
177540 * sent to a proxy, libcurl will send both server headers and proxy
177541 * headers. When doing CONNECT, libcurl will send CURLOPT_PROXYHEADER
177542 * headers only to the proxy and then CURLOPT_HTTPHEADER headers only to
177543 * the server. Defaults to CURLHEADER_SEPARATE as of cURL 7.42.1, and
177544 * CURLHEADER_UNIFIED before.
177545 **/
177546define('CURLOPT_HEADEROPT', 0);
177547/**
177548 * Whether to allow HTTP/0.9 responses. Defaults to FALSE as of libcurl
177549 * 7.66.0; formerly it defaulted to TRUE.
177550 **/
177551define('CURLOPT_HTTP09_ALLOWED ', 0);
177552/**
177553 * An array of HTTP 200 responses that will be treated as valid responses
177554 * and not as errors.
177555 **/
177556define('CURLOPT_HTTP200ALIASES', 0);
177557/**
177558 * The HTTP authentication method(s) to use. The options are:
177559 * CURLAUTH_BASIC, CURLAUTH_DIGEST, CURLAUTH_GSSNEGOTIATE, CURLAUTH_NTLM,
177560 * CURLAUTH_ANY, and CURLAUTH_ANYSAFE. The bitwise | (or) operator can be
177561 * used to combine more than one method. If this is done, cURL will poll
177562 * the server to see what methods it supports and pick the best one.
177563 * CURLAUTH_ANY is an alias for CURLAUTH_BASIC | CURLAUTH_DIGEST |
177564 * CURLAUTH_GSSNEGOTIATE | CURLAUTH_NTLM. CURLAUTH_ANYSAFE is an alias
177565 * for CURLAUTH_DIGEST | CURLAUTH_GSSNEGOTIATE | CURLAUTH_NTLM.
177566 **/
177567define('CURLOPT_HTTPAUTH', 0);
177568/**
177569 * TRUE to reset the HTTP request method to GET. Since GET is the
177570 * default, this is only necessary if the request method has been
177571 * changed.
177572 **/
177573define('CURLOPT_HTTPGET', 0);
177574/**
177575 * An array of HTTP header fields to set, in the format
177576 * array('Content-type: text/plain', 'Content-length: 100')
177577 **/
177578define('CURLOPT_HTTPHEADER', 0);
177579/**
177580 * TRUE to tunnel through a given HTTP proxy.
177581 **/
177582define('CURLOPT_HTTPPROXYTUNNEL', 0);
177583/**
177584 * FALSE to get the raw HTTP response body.
177585 **/
177586define('CURLOPT_HTTP_CONTENT_DECODING', 0);
177587/**
177588 * CURL_HTTP_VERSION_NONE (default, lets CURL decide which version to
177589 * use), CURL_HTTP_VERSION_1_0 (forces HTTP/1.0), CURL_HTTP_VERSION_1_1
177590 * (forces HTTP/1.1), CURL_HTTP_VERSION_2_0 (attempts HTTP 2),
177591 * CURL_HTTP_VERSION_2 (alias of CURL_HTTP_VERSION_2_0),
177592 * CURL_HTTP_VERSION_2TLS (attempts HTTP 2 over TLS (HTTPS) only) or
177593 * CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE (issues non-TLS HTTP requests
177594 * using HTTP/2 without HTTP/1.1 Upgrade).
177595 **/
177596define('CURLOPT_HTTP_VERSION', 0);
177597/**
177598 * The file that the transfer should be read from when uploading.
177599 **/
177600define('CURLOPT_INFILE', 0);
177601/**
177602 * The expected size, in bytes, of the file when uploading a file to a
177603 * remote site. Note that using this option will not stop libcurl from
177604 * sending more data, as exactly what is sent depends on
177605 * CURLOPT_READFUNCTION.
177606 **/
177607define('CURLOPT_INFILESIZE', 0);
177608/**
177609 * The name of the outgoing network interface to use. This can be an
177610 * interface name, an IP address or a host name.
177611 **/
177612define('CURLOPT_INTERFACE', 0);
177613/**
177614 * Allows an application to select what kind of IP addresses to use when
177615 * resolving host names. This is only interesting when using host names
177616 * that resolve addresses using more than one version of IP, possible
177617 * values are CURL_IPRESOLVE_WHATEVER, CURL_IPRESOLVE_V4,
177618 * CURL_IPRESOLVE_V6, by default CURL_IPRESOLVE_WHATEVER.
177619 **/
177620define('CURLOPT_IPRESOLVE', 0);
177621/**
177622 * TRUE to keep sending the request body if the HTTP code returned is
177623 * equal to or larger than 300. The default action would be to stop
177624 * sending and close the stream or connection. Suitable for manual NTLM
177625 * authentication. Most applications do not need this option.
177626 **/
177627define('CURLOPT_KEEP_SENDING_ON_ERROR', 0);
177628/**
177629 * The password required to use the CURLOPT_SSLKEY or
177630 * CURLOPT_SSH_PRIVATE_KEYFILE private key.
177631 **/
177632define('CURLOPT_KEYPASSWD', 0);
177633/**
177634 * The KRB4 (Kerberos 4) security level. Any of the following values (in
177635 * order from least to most powerful) are valid: "clear", "safe",
177636 * "confidential", "private".. If the string does not match one of these,
177637 * "private" is used. Setting this option to NULL will disable KRB4
177638 * security. Currently KRB4 security only works with FTP transactions.
177639 **/
177640define('CURLOPT_KRB4LEVEL', 0);
177641/**
177642 * Can be used to set protocol specific login options, such as the
177643 * preferred authentication mechanism via "AUTH=NTLM" or "AUTH=*", and
177644 * should be used in conjunction with the CURLOPT_USERNAME option.
177645 **/
177646define('CURLOPT_LOGIN_OPTIONS', 0);
177647/**
177648 * The transfer speed, in bytes per second, that the transfer should be
177649 * below during the count of CURLOPT_LOW_SPEED_TIME seconds before PHP
177650 * considers the transfer too slow and aborts.
177651 **/
177652define('CURLOPT_LOW_SPEED_LIMIT', 0);
177653/**
177654 * The number of seconds the transfer speed should be below
177655 * CURLOPT_LOW_SPEED_LIMIT before PHP considers the transfer too slow and
177656 * aborts.
177657 **/
177658define('CURLOPT_LOW_SPEED_TIME', 0);
177659/**
177660 * The maximum amount of persistent connections that are allowed. When
177661 * the limit is reached, CURLOPT_CLOSEPOLICY is used to determine which
177662 * connection to close.
177663 **/
177664define('CURLOPT_MAXCONNECTS', 0);
177665/**
177666 * The maximum amount of HTTP redirections to follow. Use this option
177667 * alongside CURLOPT_FOLLOWLOCATION.
177668 **/
177669define('CURLOPT_MAXREDIRS', 0);
177670/**
177671 * If a download exceeds this speed (counted in bytes per second) on
177672 * cumulative average during the transfer, the transfer will pause to
177673 * keep the average rate less than or equal to the parameter value.
177674 * Defaults to unlimited speed.
177675 **/
177676define('CURLOPT_MAX_RECV_SPEED_LARGE', 0);
177677/**
177678 * If an upload exceeds this speed (counted in bytes per second) on
177679 * cumulative average during the transfer, the transfer will pause to
177680 * keep the average rate less than or equal to the parameter value.
177681 * Defaults to unlimited speed.
177682 **/
177683define('CURLOPT_MAX_SEND_SPEED_LARGE', 0);
177684/**
177685 * TRUE to be completely silent with regards to the cURL functions.
177686 **/
177687define('CURLOPT_MUTE', 0);
177688/**
177689 * TRUE to scan the ~/.netrc file to find a username and password for the
177690 * remote site that a connection is being established with.
177691 **/
177692define('CURLOPT_NETRC', 0);
177693/**
177694 * TRUE to exclude the body from the output. Request method is then set
177695 * to HEAD. Changing this to FALSE does not change it to GET.
177696 **/
177697define('CURLOPT_NOBODY', 0);
177698/**
177699 * TRUE to disable the progress meter for cURL transfers. PHP
177700 * automatically sets this option to TRUE, this should only be changed
177701 * for debugging purposes.
177702 **/
177703define('CURLOPT_NOPROGRESS', 0);
177704/**
177705 * TRUE to ignore any cURL function that causes a signal to be sent to
177706 * the PHP process. This is turned on by default in multi-threaded SAPIs
177707 * so timeout options can still be used.
177708 **/
177709define('CURLOPT_NOSIGNAL', 0);
177710/**
177711 * A callback accepting three parameters. The first is the cURL resource,
177712 * the second is a string containing a password prompt, and the third is
177713 * the maximum password length. Return the string containing the
177714 * password.
177715 **/
177716define('CURLOPT_PASSWDFUNCTION', 0);
177717/**
177718 * TRUE to not handle dot dot sequences.
177719 **/
177720define('CURLOPT_PATH_AS_IS', 0);
177721/**
177722 * Set the pinned public key. The string can be the file name of your
177723 * pinned public key. The file format expected is "PEM" or "DER". The
177724 * string can also be any number of base64 encoded sha256 hashes preceded
177725 * by "sha256//" and separated by ";".
177726 **/
177727define('CURLOPT_PINNEDPUBLICKEY', 0);
177728/**
177729 * TRUE to wait for pipelining/multiplexing.
177730 **/
177731define('CURLOPT_PIPEWAIT', 0);
177732/**
177733 * An alternative port number to connect to.
177734 **/
177735define('CURLOPT_PORT', 0);
177736/**
177737 * TRUE to do a regular HTTP POST. This POST is the normal
177738 * application/x-www-form-urlencoded kind, most commonly used by HTML
177739 * forms.
177740 **/
177741define('CURLOPT_POST', 0);
177742/**
177743 * The full data to post in a HTTP "POST" operation. To post a file,
177744 * prepend a filename with @ and use the full path. The filetype can be
177745 * explicitly specified by following the filename with the type in the
177746 * format ';type=mimetype'. This parameter can either be passed as a
177747 * urlencoded string like 'para1=val1&para2=val2&...' or as an array with
177748 * the field name as key and field data as value. If {@link value} is an
177749 * array, the Content-Type header will be set to multipart/form-data. As
177750 * of PHP 5.2.0, {@link value} must be an array if files are passed to
177751 * this option with the @ prefix. As of PHP 5.5.0, the @ prefix is
177752 * deprecated and files can be sent using CURLFile. The @ prefix can be
177753 * disabled for safe passing of values beginning with @ by setting the
177754 * CURLOPT_SAFE_UPLOAD option to TRUE.
177755 **/
177756define('CURLOPT_POSTFIELDS', 0);
177757/**
177758 * An array of FTP commands to execute on the server after the FTP
177759 * request has been performed.
177760 **/
177761define('CURLOPT_POSTQUOTE', 0);
177762/**
177763 * A bitmask of 1 (301 Moved Permanently), 2 (302 Found) and 4 (303 See
177764 * Other) if the HTTP POST method should be maintained when
177765 * CURLOPT_FOLLOWLOCATION is set and a specific type of redirect occurs.
177766 **/
177767define('CURLOPT_POSTREDIR', 0);
177768/**
177769 * Set a string holding the host name or dotted numerical IP address to
177770 * be used as the preproxy that curl connects to before it connects to
177771 * the HTTP(S) proxy specified in the CURLOPT_PROXY option for the
177772 * upcoming request. The preproxy can only be a SOCKS proxy and it should
177773 * be prefixed with [scheme]:// to specify which kind of socks is used. A
177774 * numerical IPv6 address must be written within [brackets]. Setting the
177775 * preproxy to an empty string explicitly disables the use of a preproxy.
177776 * To specify port number in this string, append :[port] to the end of
177777 * the host name. The proxy's port number may optionally be specified
177778 * with the separate option CURLOPT_PROXYPORT. Defaults to using port
177779 * 1080 for proxies if a port is not specified.
177780 **/
177781define('CURLOPT_PRE_PROXY', 0);
177782/**
177783 * Any data that should be associated with this cURL handle. This data
177784 * can subsequently be retrieved with the CURLINFO_PRIVATE option of
177785 * {@link curl_getinfo}. cURL does nothing with this data. When using a
177786 * cURL multi handle, this private data is typically a unique key to
177787 * identify a standard cURL handle.
177788 **/
177789define('CURLOPT_PRIVATE', 0);
177790/**
177791 * A callback accepting five parameters. The first is the cURL resource,
177792 * the second is the total number of bytes expected to be downloaded in
177793 * this transfer, the third is the number of bytes downloaded so far, the
177794 * fourth is the total number of bytes expected to be uploaded in this
177795 * transfer, and the fifth is the number of bytes uploaded so far. The
177796 * callback is only called when the CURLOPT_NOPROGRESS option is set to
177797 * FALSE. Return a non-zero value to abort the transfer. In which case,
177798 * the transfer will set a CURLE_ABORTED_BY_CALLBACK error.
177799 **/
177800define('CURLOPT_PROGRESSFUNCTION', 0);
177801/**
177802 * Bitmask of CURLPROTO_* values. If used, this bitmask limits what
177803 * protocols libcurl may use in the transfer. This allows you to have a
177804 * libcurl built to support a wide range of protocols but still limit
177805 * specific transfers to only be allowed to use a subset of them. By
177806 * default libcurl will accept all protocols it supports. See also
177807 * CURLOPT_REDIR_PROTOCOLS. Valid protocol options are: CURLPROTO_HTTP,
177808 * CURLPROTO_HTTPS, CURLPROTO_FTP, CURLPROTO_FTPS, CURLPROTO_SCP,
177809 * CURLPROTO_SFTP, CURLPROTO_TELNET, CURLPROTO_LDAP, CURLPROTO_LDAPS,
177810 * CURLPROTO_DICT, CURLPROTO_FILE, CURLPROTO_TFTP, CURLPROTO_ALL
177811 **/
177812define('CURLOPT_PROTOCOLS', 0);
177813/**
177814 * The HTTP proxy to tunnel requests through.
177815 **/
177816define('CURLOPT_PROXY', 0);
177817/**
177818 * The HTTP authentication method(s) to use for the proxy connection. Use
177819 * the same bitmasks as described in CURLOPT_HTTPAUTH. For proxy
177820 * authentication, only CURLAUTH_BASIC and CURLAUTH_NTLM are currently
177821 * supported.
177822 **/
177823define('CURLOPT_PROXYAUTH', 0);
177824/**
177825 * An array of custom HTTP headers to pass to proxies.
177826 **/
177827define('CURLOPT_PROXYHEADER', 0);
177828/**
177829 * The port number of the proxy to connect to. This port number can also
177830 * be set in CURLOPT_PROXY.
177831 **/
177832define('CURLOPT_PROXYPORT', 0);
177833/**
177834 * Either CURLPROXY_HTTP (default), CURLPROXY_SOCKS4, CURLPROXY_SOCKS5,
177835 * CURLPROXY_SOCKS4A or CURLPROXY_SOCKS5_HOSTNAME.
177836 **/
177837define('CURLOPT_PROXYTYPE', 0);
177838/**
177839 * A username and password formatted as "[username]:[password]" to use
177840 * for the connection to the proxy.
177841 **/
177842define('CURLOPT_PROXYUSERPWD', 0);
177843/**
177844 * The path to proxy Certificate Authority (CA) bundle. Set the path as a
177845 * string naming a file holding one or more certificates to verify the
177846 * HTTPS proxy with. This option is for connecting to an HTTPS proxy, not
177847 * an HTTPS server. Defaults set to the system path where libcurl's
177848 * cacert bundle is assumed to be stored.
177849 **/
177850define('CURLOPT_PROXY_CAINFO', 0);
177851/**
177852 * The directory holding multiple CA certificates to verify the HTTPS
177853 * proxy with.
177854 **/
177855define('CURLOPT_PROXY_CAPATH', 0);
177856/**
177857 * Set the file name with the concatenation of CRL (Certificate
177858 * Revocation List) in PEM format to use in the certificate validation
177859 * that occurs during the SSL exchange.
177860 **/
177861define('CURLOPT_PROXY_CRLFILE', 0);
177862/**
177863 * Set the string be used as the password required to use the
177864 * CURLOPT_PROXY_SSLKEY private key. You never needed a passphrase to
177865 * load a certificate but you need one to load your private key. This
177866 * option is for connecting to an HTTPS proxy, not an HTTPS server.
177867 **/
177868define('CURLOPT_PROXY_KEYPASSWD', 0);
177869/**
177870 * Set the pinned public key for HTTPS proxy. The string can be the file
177871 * name of your pinned public key. The file format expected is "PEM" or
177872 * "DER". The string can also be any number of base64 encoded sha256
177873 * hashes preceded by "sha256//" and separated by ";"
177874 **/
177875define('CURLOPT_PROXY_PINNEDPUBLICKEY', 0);
177876/**
177877 * The proxy authentication service name.
177878 **/
177879define('CURLOPT_PROXY_SERVICE_NAME', 0);
177880/**
177881 * The file name of your client certificate used to connect to the HTTPS
177882 * proxy. The default format is "P12" on Secure Transport and "PEM" on
177883 * other engines, and can be changed with CURLOPT_PROXY_SSLCERTTYPE. With
177884 * NSS or Secure Transport, this can also be the nickname of the
177885 * certificate you wish to authenticate with as it is named in the
177886 * security database. If you want to use a file from the current
177887 * directory, please precede it with "./" prefix, in order to avoid
177888 * confusion with a nickname.
177889 **/
177890define('CURLOPT_PROXY_SSLCERT', 0);
177891/**
177892 * The format of your client certificate used when connecting to an HTTPS
177893 * proxy. Supported formats are "PEM" and "DER", except with Secure
177894 * Transport. OpenSSL (versions 0.9.3 and later) and Secure Transport (on
177895 * iOS 5 or later, or OS X 10.7 or later) also support "P12" for
177896 * PKCS#12-encoded files. Defaults to "PEM".
177897 **/
177898define('CURLOPT_PROXY_SSLCERTTYPE', 0);
177899/**
177900 * The file name of your private key used for connecting to the HTTPS
177901 * proxy. The default format is "PEM" and can be changed with
177902 * CURLOPT_PROXY_SSLKEYTYPE. (iOS and Mac OS X only) This option is
177903 * ignored if curl was built against Secure Transport.
177904 **/
177905define('CURLOPT_PROXY_SSLKEY', 0);
177906/**
177907 * The format of your private key. Supported formats are "PEM", "DER" and
177908 * "ENG".
177909 **/
177910define('CURLOPT_PROXY_SSLKEYTYPE', 0);
177911/**
177912 * One of CURL_SSLVERSION_DEFAULT, CURL_SSLVERSION_TLSv1,
177913 * CURL_SSLVERSION_TLSv1_0, CURL_SSLVERSION_TLSv1_1,
177914 * CURL_SSLVERSION_TLSv1_2, CURL_SSLVERSION_TLSv1_3,
177915 * CURL_SSLVERSION_MAX_DEFAULT, CURL_SSLVERSION_MAX_TLSv1_0,
177916 * CURL_SSLVERSION_MAX_TLSv1_1, CURL_SSLVERSION_MAX_TLSv1_2,
177917 * CURL_SSLVERSION_MAX_TLSv1_3 or CURL_SSLVERSION_SSLv3. Your best bet is
177918 * to not set this and let it use the default CURL_SSLVERSION_DEFAULT
177919 * which will attempt to figure out the remote SSL protocol version.
177920 **/
177921define('CURLOPT_PROXY_SSLVERSION', 0);
177922/**
177923 * The list of ciphers to use for the connection to the HTTPS proxy. The
177924 * list must be syntactically correct, it consists of one or more cipher
177925 * strings separated by colons. Commas or spaces are also acceptable
177926 * separators but colons are normally used, !, - and + can be used as
177927 * operators.
177928 **/
177929define('CURLOPT_PROXY_SSL_CIPHER_LIST', 0);
177930/**
177931 * Set proxy SSL behavior options, which is a bitmask of any of the
177932 * following constants: CURLSSLOPT_ALLOW_BEAST: do not attempt to use any
177933 * workarounds for a security flaw in the SSL3 and TLS1.0 protocols.
177934 * CURLSSLOPT_NO_REVOKE: disable certificate revocation checks for those
177935 * SSL backends where such behavior is present. (curl >= 7.44.0)
177936 * CURLSSLOPT_NO_PARTIALCHAIN: do not accept "partial" certificate
177937 * chains, which it otherwise does by default. (curl >= 7.68.0)
177938 **/
177939define('CURLOPT_PROXY_SSL_OPTIONS', 0);
177940/**
177941 * Set to 2 to verify in the HTTPS proxy's certificate name fields
177942 * against the proxy name. When set to 0 the connection succeeds
177943 * regardless of the names used in the certificate. Use that ability with
177944 * caution! 1 treated as a debug option in curl 7.28.0 and earlier. From
177945 * curl 7.28.1 to 7.65.3 CURLE_BAD_FUNCTION_ARGUMENT is returned. From
177946 * curl 7.66.0 onwards 1 and 2 is treated as the same value. In
177947 * production environments the value of this option should be kept at 2
177948 * (default value).
177949 **/
177950define('CURLOPT_PROXY_SSL_VERIFYHOST', 0);
177951/**
177952 * FALSE to stop cURL from verifying the peer's certificate. Alternate
177953 * certificates to verify against can be specified with the
177954 * CURLOPT_CAINFO option or a certificate directory can be specified with
177955 * the CURLOPT_CAPATH option. When set to false, the peer certificate
177956 * verification succeeds regardless.
177957 **/
177958define('CURLOPT_PROXY_SSL_VERIFYPEER', 0);
177959/**
177960 * The list of cipher suites to use for the TLS 1.3 connection to a
177961 * proxy. The list must be syntactically correct, it consists of one or
177962 * more cipher suite strings separated by colons. This option is
177963 * currently used only when curl is built to use OpenSSL 1.1.1 or later.
177964 * If you are using a different SSL backend you can try setting TLS 1.3
177965 * cipher suites by using the CURLOPT_PROXY_SSL_CIPHER_LIST option.
177966 **/
177967define('CURLOPT_PROXY_TLS13_CIPHERS', 0);
177968/**
177969 * The password to use for the TLS authentication method specified with
177970 * the CURLOPT_PROXY_TLSAUTH_TYPE option. Requires that the
177971 * CURLOPT_PROXY_TLSAUTH_USERNAME option to also be set.
177972 **/
177973define('CURLOPT_PROXY_TLSAUTH_PASSWORD', 0);
177974/**
177975 * The method of the TLS authentication used for the HTTPS connection.
177976 * Supported method is "SRP". Secure Remote Password (SRP) authentication
177977 * for TLS provides mutual authentication if both sides have a shared
177978 * secret. To use TLS-SRP, you must also set the
177979 * CURLOPT_PROXY_TLSAUTH_USERNAME and CURLOPT_PROXY_TLSAUTH_PASSWORD
177980 * options.
177981 **/
177982define('CURLOPT_PROXY_TLSAUTH_TYPE', 0);
177983/**
177984 * Tusername to use for the HTTPS proxy TLS authentication method
177985 * specified with the CURLOPT_PROXY_TLSAUTH_TYPE option. Requires that
177986 * the CURLOPT_PROXY_TLSAUTH_PASSWORD option to also be set.
177987 **/
177988define('CURLOPT_PROXY_TLSAUTH_USERNAME', 0);
177989/**
177990 * TRUE to HTTP PUT a file. The file to PUT must be set with
177991 * CURLOPT_INFILE and CURLOPT_INFILESIZE.
177992 **/
177993define('CURLOPT_PUT', 0);
177994/**
177995 * An array of FTP commands to execute on the server prior to the FTP
177996 * request.
177997 **/
177998define('CURLOPT_QUOTE', 0);
177999/**
178000 * A filename to be used to seed the random number generator for SSL.
178001 **/
178002define('CURLOPT_RANDOM_FILE', 0);
178003/**
178004 * Range(s) of data to retrieve in the format "X-Y" where X or Y are
178005 * optional. HTTP transfers also support several intervals, separated
178006 * with commas in the format "X-Y,N-M".
178007 **/
178008define('CURLOPT_RANGE', 0);
178009/**
178010 * A callback accepting three parameters. The first is the cURL resource,
178011 * the second is a stream resource provided to cURL through the option
178012 * CURLOPT_INFILE, and the third is the maximum amount of data to be
178013 * read. The callback must return a string with a length equal or smaller
178014 * than the amount of data requested, typically by reading it from the
178015 * passed stream resource. It should return an empty string to signal
178016 * EOF.
178017 **/
178018define('CURLOPT_READFUNCTION', 0);
178019/**
178020 * Bitmask of CURLPROTO_* values. If used, this bitmask limits what
178021 * protocols libcurl may use in a transfer that it follows to in a
178022 * redirect when CURLOPT_FOLLOWLOCATION is enabled. This allows you to
178023 * limit specific transfers to only be allowed to use a subset of
178024 * protocols in redirections. By default libcurl will allow all protocols
178025 * except for FILE and SCP. This is a difference compared to pre-7.19.4
178026 * versions which unconditionally would follow to all protocols
178027 * supported. See also CURLOPT_PROTOCOLS for protocol constant values.
178028 **/
178029define('CURLOPT_REDIR_PROTOCOLS', 0);
178030/**
178031 * The contents of the "Referer: " header to be used in a HTTP request.
178032 **/
178033define('CURLOPT_REFERER', 0);
178034define('CURLOPT_REQUEST_TARGET', 0);
178035/**
178036 * Provide a custom address for a specific host and port pair. An array
178037 * of hostname, port, and IP address strings, each element separated by a
178038 * colon. In the format: array("example.com:80:127.0.0.1")
178039 **/
178040define('CURLOPT_RESOLVE', 0);
178041/**
178042 * The offset, in bytes, to resume a transfer from.
178043 **/
178044define('CURLOPT_RESUME_FROM', 0);
178045/**
178046 * TRUE to return the transfer as a string of the return value of {@link
178047 * curl_exec} instead of outputting it directly.
178048 **/
178049define('CURLOPT_RETURNTRANSFER', 0);
178050/**
178051 * TRUE to disable support for the @ prefix for uploading files in
178052 * CURLOPT_POSTFIELDS, which means that values starting with @ can be
178053 * safely passed as fields. CURLFile may be used for uploads instead.
178054 **/
178055define('CURLOPT_SAFE_UPLOAD', 0);
178056/**
178057 * TRUE to enable sending the initial response in the first packet.
178058 **/
178059define('CURLOPT_SASL_IR', 0);
178060/**
178061 * The authentication service name.
178062 **/
178063define('CURLOPT_SERVICE_NAME', 0);
178064/**
178065 * A result of {@link curl_share_init}. Makes the cURL handle to use the
178066 * data from the shared handle.
178067 **/
178068define('CURLOPT_SHARE', 0);
178069/**
178070 * The SOCKS5 authentication method(s) to use. The options are:
178071 * CURLAUTH_BASIC, CURLAUTH_GSSAPI, CURLAUTH_NONE. The bitwise | (or)
178072 * operator can be used to combine more than one method. If this is done,
178073 * cURL will poll the server to see what methods it supports and pick the
178074 * best one. CURLAUTH_BASIC allows username/password authentication.
178075 * CURLAUTH_GSSAPI allows GSS-API authentication. CURLAUTH_NONE allows no
178076 * authentication. Defaults to CURLAUTH_BASIC|CURLAUTH_GSSAPI. Set the
178077 * actual username and password with the CURLOPT_PROXYUSERPWD option.
178078 **/
178079define('CURLOPT_SOCKS5_AUTH', 0);
178080/**
178081 * A bitmask consisting of one or more of CURLSSH_AUTH_PUBLICKEY,
178082 * CURLSSH_AUTH_PASSWORD, CURLSSH_AUTH_HOST, CURLSSH_AUTH_KEYBOARD. Set
178083 * to CURLSSH_AUTH_ANY to let libcurl pick one.
178084 **/
178085define('CURLOPT_SSH_AUTH_TYPES', 0);
178086/**
178087 * TRUE to enable built-in SSH compression. This is a request, not an
178088 * order; the server may or may not do it.
178089 **/
178090define('CURLOPT_SSH_COMPRESSION', 0);
178091/**
178092 * A string containing 32 hexadecimal digits. The string should be the
178093 * MD5 checksum of the remote host's public key, and libcurl will reject
178094 * the connection to the host unless the md5sums match. This option is
178095 * only for SCP and SFTP transfers.
178096 **/
178097define('CURLOPT_SSH_HOST_PUBLIC_KEY_MD5', 0);
178098/**
178099 * The file name for your private key. If not used, libcurl defaults to
178100 * $HOME/.ssh/id_dsa if the HOME environment variable is set, and just
178101 * "id_dsa" in the current directory if HOME is not set. If the file is
178102 * password-protected, set the password with CURLOPT_KEYPASSWD.
178103 **/
178104define('CURLOPT_SSH_PRIVATE_KEYFILE', 0);
178105/**
178106 * The file name for your public key. If not used, libcurl defaults to
178107 * $HOME/.ssh/id_dsa.pub if the HOME environment variable is set, and
178108 * just "id_dsa.pub" in the current directory if HOME is not set.
178109 **/
178110define('CURLOPT_SSH_PUBLIC_KEYFILE', 0);
178111/**
178112 * The name of a file containing a PEM formatted certificate.
178113 **/
178114define('CURLOPT_SSLCERT', 0);
178115/**
178116 * The password required to use the CURLOPT_SSLCERT certificate.
178117 **/
178118define('CURLOPT_SSLCERTPASSWD', 0);
178119/**
178120 * The format of the certificate. Supported formats are "PEM" (default),
178121 * "DER", and "ENG". As of OpenSSL 0.9.3, "P12" (for PKCS#12-encoded
178122 * files) is also supported.
178123 **/
178124define('CURLOPT_SSLCERTTYPE', 0);
178125/**
178126 * The identifier for the crypto engine of the private SSL key specified
178127 * in CURLOPT_SSLKEY.
178128 **/
178129define('CURLOPT_SSLENGINE', 0);
178130/**
178131 * The identifier for the crypto engine used for asymmetric crypto
178132 * operations.
178133 **/
178134define('CURLOPT_SSLENGINE_DEFAULT', 0);
178135/**
178136 * The name of a file containing a private SSL key.
178137 **/
178138define('CURLOPT_SSLKEY', 0);
178139/**
178140 * The secret password needed to use the private SSL key specified in
178141 * CURLOPT_SSLKEY. Since this option contains a sensitive password,
178142 * remember to keep the PHP script it is contained within safe.
178143 **/
178144define('CURLOPT_SSLKEYPASSWD', 0);
178145/**
178146 * The key type of the private SSL key specified in CURLOPT_SSLKEY.
178147 * Supported key types are "PEM" (default), "DER", and "ENG".
178148 **/
178149define('CURLOPT_SSLKEYTYPE', 0);
178150/**
178151 * One of CURL_SSLVERSION_DEFAULT (0), CURL_SSLVERSION_TLSv1 (1),
178152 * CURL_SSLVERSION_SSLv2 (2), CURL_SSLVERSION_SSLv3 (3),
178153 * CURL_SSLVERSION_TLSv1_0 (4), CURL_SSLVERSION_TLSv1_1 (5) or
178154 * CURL_SSLVERSION_TLSv1_2 (6). The maximum TLS version can be set by
178155 * using one of the CURL_SSLVERSION_MAX_* constants. It is also possible
178156 * to OR one of the CURL_SSLVERSION_* constants with one of the
178157 * CURL_SSLVERSION_MAX_* constants. CURL_SSLVERSION_MAX_DEFAULT (the
178158 * maximum version supported by the library),
178159 * CURL_SSLVERSION_MAX_TLSv1_0, CURL_SSLVERSION_MAX_TLSv1_1,
178160 * CURL_SSLVERSION_MAX_TLSv1_2, or CURL_SSLVERSION_MAX_TLSv1_3. Your best
178161 * bet is to not set this and let it use the default. Setting it to 2 or
178162 * 3 is very dangerous given the known vulnerabilities in SSLv2 and
178163 * SSLv3.
178164 **/
178165define('CURLOPT_SSLVERSION', 0);
178166/**
178167 * A list of ciphers to use for SSL. For example, RC4-SHA and TLSv1 are
178168 * valid cipher lists.
178169 **/
178170define('CURLOPT_SSL_CIPHER_LIST', 0);
178171/**
178172 * FALSE to disable ALPN in the SSL handshake (if the SSL backend libcurl
178173 * is built to use supports it), which can be used to negotiate http2.
178174 **/
178175define('CURLOPT_SSL_ENABLE_ALPN', 0);
178176/**
178177 * FALSE to disable NPN in the SSL handshake (if the SSL backend libcurl
178178 * is built to use supports it), which can be used to negotiate http2.
178179 **/
178180define('CURLOPT_SSL_ENABLE_NPN', 0);
178181/**
178182 * TRUE to enable TLS false start.
178183 **/
178184define('CURLOPT_SSL_FALSESTART', 0);
178185/**
178186 * Set SSL behavior options, which is a bitmask of any of the following
178187 * constants: CURLSSLOPT_ALLOW_BEAST: do not attempt to use any
178188 * workarounds for a security flaw in the SSL3 and TLS1.0 protocols.
178189 * CURLSSLOPT_NO_REVOKE: disable certificate revocation checks for those
178190 * SSL backends where such behavior is present.
178191 **/
178192define('CURLOPT_SSL_OPTIONS', 0);
178193/**
178194 * 1 to check the existence of a common name in the SSL peer certificate.
178195 * 2 to check the existence of a common name and also verify that it
178196 * matches the hostname provided. 0 to not check the names. In production
178197 * environments the value of this option should be kept at 2 (default
178198 * value).
178199 **/
178200define('CURLOPT_SSL_VERIFYHOST', 0);
178201/**
178202 * FALSE to stop cURL from verifying the peer's certificate. Alternate
178203 * certificates to verify against can be specified with the
178204 * CURLOPT_CAINFO option or a certificate directory can be specified with
178205 * the CURLOPT_CAPATH option.
178206 **/
178207define('CURLOPT_SSL_VERIFYPEER', 0);
178208/**
178209 * TRUE to verify the certificate's status.
178210 **/
178211define('CURLOPT_SSL_VERIFYSTATUS', 0);
178212/**
178213 * An alternative location to output errors to instead of STDERR.
178214 **/
178215define('CURLOPT_STDERR', 0);
178216/**
178217 * Set the numerical stream weight (a number between 1 and 256).
178218 **/
178219define('CURLOPT_STREAM_WEIGHT', 0);
178220/**
178221 * TRUE to suppress proxy CONNECT response headers from the user callback
178222 * functions CURLOPT_HEADERFUNCTION and CURLOPT_WRITEFUNCTION, when
178223 * CURLOPT_HTTPPROXYTUNNEL is used and a CONNECT request is made.
178224 **/
178225define('CURLOPT_SUPPRESS_CONNECT_HEADERS', 0);
178226/**
178227 * TRUE to enable TCP Fast Open.
178228 **/
178229define('CURLOPT_TCP_FASTOPEN', 0);
178230/**
178231 * If set to 1, TCP keepalive probes will be sent. The delay and
178232 * frequency of these probes can be controlled by the
178233 * CURLOPT_TCP_KEEPIDLE and CURLOPT_TCP_KEEPINTVL options, provided the
178234 * operating system supports them. If set to 0 (default) keepalive probes
178235 * are disabled.
178236 **/
178237define('CURLOPT_TCP_KEEPALIVE', 0);
178238/**
178239 * Sets the delay, in seconds, that the operating system will wait while
178240 * the connection is idle before sending keepalive probes, if
178241 * CURLOPT_TCP_KEEPALIVE is enabled. Not all operating systems support
178242 * this option. The default is 60.
178243 **/
178244define('CURLOPT_TCP_KEEPIDLE', 0);
178245/**
178246 * Sets the interval, in seconds, that the operating system will wait
178247 * between sending keepalive probes, if CURLOPT_TCP_KEEPALIVE is enabled.
178248 * Not all operating systems support this option. The default is 60.
178249 **/
178250define('CURLOPT_TCP_KEEPINTVL', 0);
178251/**
178252 * TRUE to disable TCP's Nagle algorithm, which tries to minimize the
178253 * number of small packets on the network.
178254 **/
178255define('CURLOPT_TCP_NODELAY', 0);
178256/**
178257 * TRUE to not send TFTP options requests.
178258 **/
178259define('CURLOPT_TFTP_NO_OPTIONS', 0);
178260/**
178261 * How CURLOPT_TIMEVALUE is treated. Use CURL_TIMECOND_IFMODSINCE to
178262 * return the page only if it has been modified since the time specified
178263 * in CURLOPT_TIMEVALUE. If it hasn't been modified, a "304 Not Modified"
178264 * header will be returned assuming CURLOPT_HEADER is TRUE. Use
178265 * CURL_TIMECOND_IFUNMODSINCE for the reverse effect.
178266 * CURL_TIMECOND_IFMODSINCE is the default.
178267 **/
178268define('CURLOPT_TIMECONDITION', 0);
178269/**
178270 * The maximum number of seconds to allow cURL functions to execute.
178271 **/
178272define('CURLOPT_TIMEOUT', 0);
178273/**
178274 * The maximum number of milliseconds to allow cURL functions to execute.
178275 * If libcurl is built to use the standard system name resolver, that
178276 * portion of the connect will still use full-second resolution for
178277 * timeouts with a minimum timeout allowed of one second.
178278 **/
178279define('CURLOPT_TIMEOUT_MS', 0);
178280/**
178281 * The time in seconds since January 1st, 1970. The time will be used by
178282 * CURLOPT_TIMECONDITION. By default, CURL_TIMECOND_IFMODSINCE is used.
178283 **/
178284define('CURLOPT_TIMEVALUE', 0);
178285/**
178286 * The time in seconds since January 1st, 1970. The time will be used by
178287 * CURLOPT_TIMECONDITION. Defaults to zero. The difference between this
178288 * option and CURLOPT_TIMEVALUE is the type of the argument. On systems
178289 * where 'long' is only 32 bit wide, this option has to be used to set
178290 * dates beyond the year 2038.
178291 **/
178292define('CURLOPT_TIMEVALUE_LARGE', 0);
178293/**
178294 * The list of cipher suites to use for the TLS 1.3 connection. The list
178295 * must be syntactically correct, it consists of one or more cipher suite
178296 * strings separated by colons. This option is currently used only when
178297 * curl is built to use OpenSSL 1.1.1 or later. If you are using a
178298 * different SSL backend you can try setting TLS 1.3 cipher suites by
178299 * using the CURLOPT_SSL_CIPHER_LIST option.
178300 **/
178301define('CURLOPT_TLS13_CIPHERS', 0);
178302/**
178303 * TRUE to use ASCII mode for FTP transfers. For LDAP, it retrieves data
178304 * in plain text instead of HTML. On Windows systems, it will not set
178305 * STDOUT to binary mode.
178306 **/
178307define('CURLOPT_TRANSFERTEXT', 0);
178308/**
178309 * Enables the use of Unix domain sockets as connection endpoint and sets
178310 * the path to the given string.
178311 **/
178312define('CURLOPT_UNIX_SOCKET_PATH', 0);
178313/**
178314 * TRUE to keep sending the username and password when following
178315 * locations (using CURLOPT_FOLLOWLOCATION), even when the hostname has
178316 * changed.
178317 **/
178318define('CURLOPT_UNRESTRICTED_AUTH', 0);
178319/**
178320 * TRUE to prepare for an upload.
178321 **/
178322define('CURLOPT_UPLOAD', 0);
178323/**
178324 * The URL to fetch. This can also be set when initializing a session
178325 * with {@link curl_init}.
178326 **/
178327define('CURLOPT_URL', 0);
178328/**
178329 * The contents of the "User-Agent: " header to be used in a HTTP
178330 * request.
178331 **/
178332define('CURLOPT_USERAGENT', 0);
178333/**
178334 * The user name to use in authentication.
178335 **/
178336define('CURLOPT_USERNAME', 0);
178337/**
178338 * A username and password formatted as "[username]:[password]" to use
178339 * for the connection.
178340 **/
178341define('CURLOPT_USERPWD', 0);
178342/**
178343 * TRUE to output verbose information. Writes output to STDERR, or the
178344 * file specified using CURLOPT_STDERR.
178345 **/
178346define('CURLOPT_VERBOSE', 0);
178347/**
178348 * A callback accepting two parameters. The first is the cURL resource,
178349 * and the second is a string with the data to be written. The data must
178350 * be saved by this callback. It must return the exact number of bytes
178351 * written or the transfer will be aborted with an error.
178352 **/
178353define('CURLOPT_WRITEFUNCTION', 0);
178354/**
178355 * The file that the header part of the transfer is written to.
178356 **/
178357define('CURLOPT_WRITEHEADER', 0);
178358/**
178359 * Specifies the OAuth 2.0 access token.
178360 **/
178361define('CURLOPT_XOAUTH2_BEARER', 0);
178362define('CURLPAUSE_ALL', 0);
178363define('CURLPAUSE_CONT', 0);
178364define('CURLPAUSE_RECV', 0);
178365define('CURLPAUSE_RECV_CONT', 0);
178366define('CURLPAUSE_SEND', 0);
178367define('CURLPAUSE_SEND_CONT', 0);
178368define('CURLPIPE_HTTP1', 0);
178369define('CURLPIPE_MULTIPLEX', 0);
178370define('CURLPIPE_NOTHING', 0);
178371define('CURLPROTO_SMB', 0);
178372define('CURLPROTO_SMBS', 0);
178373define('CURLPROXY_HTTP', 0);
178374define('CURLPROXY_HTTPS', 0);
178375define('CURLPROXY_HTTP_1_0', 0);
178376define('CURLPROXY_SOCKS4', 0);
178377define('CURLPROXY_SOCKS4A', 0);
178378define('CURLPROXY_SOCKS5', 0);
178379define('CURLPROXY_SOCKS5_HOSTNAME', 0);
178380/**
178381 * Specifies a type of data that should be shared.
178382 **/
178383define('CURLSHOPT_SHARE', 0);
178384/**
178385 * Specifies a type of data that will be no longer shared.
178386 **/
178387define('CURLSHOPT_UNSHARE', 0);
178388define('CURLSSH_AUTH_AGENT', 0);
178389define('CURLSSH_AUTH_ANY', 0);
178390define('CURLSSH_AUTH_DEFAULT', 0);
178391define('CURLSSH_AUTH_GSSAPI', 0);
178392define('CURLSSH_AUTH_HOST', 0);
178393define('CURLSSH_AUTH_KEYBOARD', 0);
178394define('CURLSSH_AUTH_NONE', 0);
178395define('CURLSSH_AUTH_PASSWORD', 0);
178396define('CURLSSH_AUTH_PUBLICKEY', 0);
178397define('CURLSSLOPT_ALLOW_BEAST', 0);
178398define('CURLSSLOPT_NO_REVOKE', 0);
178399define('CURLVERSION_NOW', 0);
178400define('CURL_HTTP_VERSION_1_0', 0);
178401define('CURL_HTTP_VERSION_1_1', 0);
178402define('CURL_HTTP_VERSION_2', 0);
178403define('CURL_HTTP_VERSION_2TLS', 0);
178404define('CURL_HTTP_VERSION_2_0', 0);
178405define('CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE', 0);
178406define('CURL_HTTP_VERSION_NONE', 0);
178407define('CURL_LOCK_DATA_CONNECT', 0);
178408/**
178409 * Shares cookie data.
178410 **/
178411define('CURL_LOCK_DATA_COOKIE', 0);
178412/**
178413 * Shares DNS cache. Note that when you use cURL multi handles, all
178414 * handles added to the same multi handle will share DNS cache by
178415 * default.
178416 **/
178417define('CURL_LOCK_DATA_DNS', 0);
178418define('CURL_LOCK_DATA_PSL', 0);
178419/**
178420 * Shares SSL session IDs, reducing the time spent on the SSL handshake
178421 * when reconnecting to the same server. Note that SSL session IDs are
178422 * reused within the same handle by default.
178423 **/
178424define('CURL_LOCK_DATA_SSL_SESSION', 0);
178425define('CURL_MAX_READ_SIZE', 0);
178426define('CURL_NETRC_IGNORED', 0);
178427define('CURL_NETRC_OPTIONAL', 0);
178428define('CURL_NETRC_REQUIRED', 0);
178429define('CURL_PUSH_DENY', 0);
178430define('CURL_PUSH_OK', 0);
178431define('CURL_REDIR_POST_301', 0);
178432define('CURL_REDIR_POST_302', 0);
178433define('CURL_REDIR_POST_303', 0);
178434define('CURL_REDIR_POST_ALL', 0);
178435define('CURL_SSLVERSION_DEFAULT', 0);
178436define('CURL_SSLVERSION_MAX_DEFAULT', 0);
178437define('CURL_SSLVERSION_MAX_NONE', 0);
178438define('CURL_SSLVERSION_MAX_TLSv1_0', 0);
178439define('CURL_SSLVERSION_MAX_TLSv1_1', 0);
178440define('CURL_SSLVERSION_MAX_TLSv1_2', 0);
178441define('CURL_SSLVERSION_MAX_TLSv1_3', 0);
178442define('CURL_SSLVERSION_SSLv2', 0);
178443define('CURL_SSLVERSION_SSLv3', 0);
178444define('CURL_SSLVERSION_TLSv1', 0);
178445define('CURL_SSLVERSION_TLSv1_0', 0);
178446define('CURL_SSLVERSION_TLSv1_1', 0);
178447define('CURL_SSLVERSION_TLSv1_2', 0);
178448define('CURL_SSLVERSION_TLSv1_3', 0);
178449define('CURL_TIMECOND_IFMODSINCE', 0);
178450define('CURL_TIMECOND_IFUNMODSINCE', 0);
178451define('CURL_TIMECOND_LASTMOD', 0);
178452define('CURL_VERSION_ALTSVC', 0);
178453define('CURL_VERSION_ASYNCHDNS', 0);
178454define('CURL_VERSION_BROTLI', 0);
178455define('CURL_VERSION_CONV', 0);
178456define('CURL_VERSION_CURLDEBUG', 0);
178457define('CURL_VERSION_DEBUG', 0);
178458define('CURL_VERSION_GSSAPI', 0);
178459define('CURL_VERSION_GSSNEGOTIATE', 0);
178460define('CURL_VERSION_HTTP2', 0);
178461define('CURL_VERSION_HTTPS_PROXY', 0);
178462define('CURL_VERSION_IDN', 0);
178463define('CURL_VERSION_IPV6', 0);
178464define('CURL_VERSION_KERBEROS4', 0);
178465define('CURL_VERSION_KERBEROS5', 0);
178466define('CURL_VERSION_LIBZ', 0);
178467define('CURL_VERSION_MULTI_SSL', 0);
178468define('CURL_VERSION_NTLM', 0);
178469define('CURL_VERSION_NTLM_WB', 0);
178470define('CURL_VERSION_PSL', 0);
178471define('CURL_VERSION_SPNEGO', 0);
178472define('CURL_VERSION_SSL', 0);
178473define('CURL_VERSION_SSPI', 0);
178474define('CURL_VERSION_TLSAUTH_SRP', 0);
178475define('CURL_VERSION_UNIX_SOCKETS', 0);
178476define('CURL_WRAPPERS_ENABLED', 0);
178477/**
178478 * Local currency symbol.
178479 **/
178480define('CURRENCY_SYMBOL', 0);
178481define('CYRUS_CALLBACK_NOLITERAL', 0);
178482define('CYRUS_CALLBACK_NUMBERED', 0);
178483define('CYRUS_CONN_INITIALRESPONSE', 0);
178484define('CYRUS_CONN_NONSYNCLITERAL', 0);
178485define('DATAINCONSISTENCY', 0);
178486define('DATE_ATOM', 0);
178487define('DATE_COOKIE', 0);
178488define('DATE_ISO8601', 0);
178489define('DATE_RFC822', 0);
178490define('DATE_RFC850', 0);
178491define('DATE_RFC1036', 0);
178492define('DATE_RFC1123', 0);
178493define('DATE_RFC2822', 0);
178494define('DATE_RFC3339', 0);
178495define('DATE_RFC3339_EXTENDED', 0);
178496define('DATE_RFC7231', 0);
178497define('DATE_RSS', 0);
178498define('DATE_W3C', 0);
178499/**
178500 * Name of the n-th day of the week (DAY_1 = Sunday).
178501 **/
178502define('DAY_1', 0);
178503/**
178504 * Name of the n-th day of the week (DAY_1 = Sunday).
178505 **/
178506define('DAY_2', 0);
178507/**
178508 * Name of the n-th day of the week (DAY_1 = Sunday).
178509 **/
178510define('DAY_3', 0);
178511/**
178512 * Name of the n-th day of the week (DAY_1 = Sunday).
178513 **/
178514define('DAY_4', 0);
178515/**
178516 * Name of the n-th day of the week (DAY_1 = Sunday).
178517 **/
178518define('DAY_5', 0);
178519/**
178520 * Name of the n-th day of the week (DAY_1 = Sunday).
178521 **/
178522define('DAY_6', 0);
178523/**
178524 * Name of the n-th day of the week (DAY_1 = Sunday).
178525 **/
178526define('DAY_7', 0);
178527define('DB2_AUTOCOMMIT_OFF', 0);
178528define('DB2_AUTOCOMMIT_ON', 0);
178529define('DB2_BINARY', 0);
178530define('DB2_CASE_LOWER', 0);
178531define('DB2_CASE_NATURAL', 0);
178532define('DB2_CASE_UPPER', 0);
178533define('DB2_CHAR', 0);
178534define('DB2_CONVERT', 0);
178535define('DB2_DEFERRED_PREPARE_OFF', 0);
178536define('DB2_DEFERRED_PREPARE_ON', 0);
178537define('DB2_DOUBLE', 0);
178538define('DB2_FORWARD_ONLY', 0);
178539define('DB2_LONG', 0);
178540define('DB2_PARAM_FILE', 0);
178541define('DB2_PARAM_IN', 0);
178542define('DB2_PARAM_INOUT', 0);
178543define('DB2_PARAM_OUT', 0);
178544define('DB2_PASSTHRU', 0);
178545define('DB2_SCROLLABLE', 0);
178546define('DBASE_RDONLY', 0);
178547define('DBASE_RDWR', 0);
178548define('DBASE_TYPE_DBASE', 0);
178549define('DBASE_TYPE_FOXPRO', 0);
178550define('DBASE_VERSION', '');
178551/**
178552 * The server can't close
178553 **/
178554define('DBPLUS_ERR_CLOSE', 0);
178555/**
178556 * A client sent a corrupt tuple
178557 **/
178558define('DBPLUS_ERR_CORRUPT_TUPLE', 0);
178559/**
178560 * Invalid crc in the superpage
178561 **/
178562define('DBPLUS_ERR_CRC', 0);
178563/**
178564 * Create() system call failed
178565 **/
178566define('DBPLUS_ERR_CREATE', 0);
178567/**
178568 * Error in the parser
178569 **/
178570define('DBPLUS_ERR_DBPARSE', 0);
178571/**
178572 * Exit condition caused by prexit() * procedure
178573 **/
178574define('DBPLUS_ERR_DBPREEXIT', 0);
178575/**
178576 * Run error in db
178577 **/
178578define('DBPLUS_ERR_DBRUNERR', 0);
178579/**
178580 * Tried to insert a duplicate tuple
178581 **/
178582define('DBPLUS_ERR_DUPLICATE', 0);
178583/**
178584 * Relation is empty (server)
178585 **/
178586define('DBPLUS_ERR_EMPTY', 0);
178587/**
178588 * End of scan from rget()
178589 **/
178590define('DBPLUS_ERR_EOSCAN', 0);
178591/**
178592 * Can't create a fifo
178593 **/
178594define('DBPLUS_ERR_FIFO', 0);
178595/**
178596 * Tuple exceeds maximum length
178597 **/
178598define('DBPLUS_ERR_LENGTH', 0);
178599/**
178600 * Relation was already locked
178601 **/
178602define('DBPLUS_ERR_LOCKED', 0);
178603/**
178604 * Lseek() system call failed
178605 **/
178606define('DBPLUS_ERR_LSEEK', 0);
178607/**
178608 * File is not a relation
178609 **/
178610define('DBPLUS_ERR_MAGIC', 0);
178611/**
178612 * Malloc() call failed
178613 **/
178614define('DBPLUS_ERR_MALLOC', 0);
178615/**
178616 * Too many secondary indices
178617 **/
178618define('DBPLUS_ERR_NIDX', 0);
178619/**
178620 * Null error condition
178621 **/
178622define('DBPLUS_ERR_NOERR', 0);
178623/**
178624 * Relation cannot be locked
178625 **/
178626define('DBPLUS_ERR_NOLOCK', 0);
178627/**
178628 * Error use of max users
178629 **/
178630define('DBPLUS_ERR_NUSERS', 0);
178631/**
178632 * Caused by a signal
178633 **/
178634define('DBPLUS_ERR_ONTRAP', 0);
178635/**
178636 * Open() system call failed
178637 **/
178638define('DBPLUS_ERR_OPEN', 0);
178639/**
178640 * The server should not really die but after a disaster send ERR_PANIC
178641 * to all its clients
178642 **/
178643define('DBPLUS_ERR_PANIC', 0);
178644/**
178645 * Permission denied
178646 **/
178647define('DBPLUS_ERR_PERM', 0);
178648/**
178649 * Relation uses a different page size
178650 **/
178651define('DBPLUS_ERR_PGSIZE', 0);
178652/**
178653 * Piped relation requires lseek()
178654 **/
178655define('DBPLUS_ERR_PIPE', 0);
178656/**
178657 * Caused by invalid usage
178658 **/
178659define('DBPLUS_ERR_PREEXIT', 0);
178660/**
178661 * Error in the preprocessor
178662 **/
178663define('DBPLUS_ERR_PREPROC', 0);
178664/**
178665 * Read error on relation
178666 **/
178667define('DBPLUS_ERR_READ', 0);
178668/**
178669 * Only two users
178670 **/
178671define('DBPLUS_ERR_RESTRICTED', 0);
178672/**
178673 * TCL_error
178674 **/
178675define('DBPLUS_ERR_TCL', 0);
178676define('DBPLUS_ERR_UNKNOWN', 0);
178677/**
178678 * An error in the use of the library by an application programmer
178679 **/
178680define('DBPLUS_ERR_USER', 0);
178681/**
178682 * File is a very old relation
178683 **/
178684define('DBPLUS_ERR_VERSION', 0);
178685/**
178686 * Wait a little (Simple only)
178687 **/
178688define('DBPLUS_ERR_WAIT', 0);
178689/**
178690 * The Simple routines encountered a non fatal error which was corrected
178691 **/
178692define('DBPLUS_ERR_WARNING0', 0);
178693/**
178694 * The record is write locked
178695 **/
178696define('DBPLUS_ERR_WLOCKED', 0);
178697/**
178698 * Relation already opened for writing
178699 **/
178700define('DBPLUS_ERR_WOPEN', 0);
178701/**
178702 * Write error on relation
178703 **/
178704define('DBPLUS_ERR_WRITE', 0);
178705define('DBX_CMP_ASC', 0);
178706define('DBX_CMP_DESC', 0);
178707define('DBX_CMP_NATIVE', 0);
178708define('DBX_CMP_NUMBER', 0);
178709define('DBX_CMP_TEXT', 0);
178710define('DBX_COLNAMES_LOWERCASE', 0);
178711define('DBX_COLNAMES_UNCHANGED', 0);
178712define('DBX_COLNAMES_UPPERCASE', 0);
178713define('DBX_FBSQL', 0);
178714define('DBX_MSSQL', 0);
178715define('DBX_MYSQL', 0);
178716define('DBX_OCI8', 0);
178717define('DBX_ODBC', 0);
178718define('DBX_PERSISTENT', 0);
178719define('DBX_PGSQL', 0);
178720define('DBX_RESULT_ASSOC', 0);
178721define('DBX_RESULT_INDEX', 0);
178722define('DBX_RESULT_INFO', 0);
178723define('DBX_RESULT_UNBUFFERED', 0);
178724define('DBX_SQLITE', 0);
178725define('DBX_SYBASECT', 0);
178726/**
178727 * Don't include the argument information for functions in the stack
178728 * trace.
178729 **/
178730define('DEBUG_BACKTRACE_IGNORE_ARGS', 0);
178731/**
178732 * Default.
178733 **/
178734define('DEBUG_BACKTRACE_PROVIDE_OBJECT', 0);
178735/**
178736 * Decimal point character.
178737 **/
178738define('DECIMAL_POINT', 0);
178739define('DEFAULT_INCLUDE_PATH', '');
178740define('DELETED_EVENT', 0);
178741define('DIRECTORY_SEPARATOR', '');
178742/**
178743 * An error that indicates that an array index does not exist.
178744 **/
178745define('DISP_E_BADINDEX', 0);
178746/**
178747 * A return error that indicates a divide by zero error.
178748 **/
178749define('DISP_E_DIVBYZERO', 0);
178750/**
178751 * An error that indicates that a value could not be coerced to its
178752 * expected representation.
178753 **/
178754define('DISP_E_OVERFLOW', 0);
178755define('DNS_A', 0);
178756define('DNS_AAAA', 0);
178757define('DNS_ALL', 0);
178758define('DNS_ANY', 0);
178759define('DNS_CAA', 0);
178760define('DNS_CNAME', 0);
178761define('DNS_HINFO', 0);
178762define('DNS_MX', 0);
178763define('DNS_NS', 0);
178764define('DNS_PTR', 0);
178765define('DNS_SOA', 0);
178766define('DNS_TXT', 0);
178767define('DOMSTRING_SIZE_ERR', 0);
178768/**
178769 * If any node is inserted somewhere it doesn't belong
178770 **/
178771define('DOM_HIERARCHY_REQUEST_ERR', 0);
178772/**
178773 * If index or size is negative, or greater than the allowed value.
178774 **/
178775define('DOM_INDEX_SIZE_ERR', 0);
178776/**
178777 * If an attempt is made to add an attribute that is already in use
178778 * elsewhere.
178779 **/
178780define('DOM_INUSE_ATTRIBUTE_ERR', 0);
178781/**
178782 * If a parameter or an operation is not supported by the underlying
178783 * object.
178784 **/
178785define('DOM_INVALID_ACCESS_ERR', 0);
178786/**
178787 * If an invalid or illegal character is specified, such as in a name.
178788 **/
178789define('DOM_INVALID_CHARACTER_ERR', 0);
178790/**
178791 * If an attempt is made to modify the type of the underlying object.
178792 **/
178793define('DOM_INVALID_MODIFICATION_ERR', 0);
178794/**
178795 * If an attempt is made to use an object that is not, or is no longer,
178796 * usable.
178797 **/
178798define('DOM_INVALID_STATE_ERR', 0);
178799/**
178800 * If an attempt is made to create or change an object in a way which is
178801 * incorrect with regard to namespaces.
178802 **/
178803define('DOM_NAMESPACE_ERR', 0);
178804/**
178805 * If an attempt is made to reference a node in a context where it does
178806 * not exist.
178807 **/
178808define('DOM_NOT_FOUND_ERR', 0);
178809/**
178810 * If the implementation does not support the requested type of object or
178811 * operation.
178812 **/
178813define('DOM_NOT_SUPPORTED_ERR', 0);
178814/**
178815 * If data is specified for a node which does not support data.
178816 **/
178817define('DOM_NO_DATA_ALLOWED_ERR', 0);
178818/**
178819 * If an attempt is made to modify an object where modifications are not
178820 * allowed.
178821 **/
178822define('DOM_NO_MODIFICATION_ALLOWED_ERR', 0);
178823/**
178824 * Error code not part of the DOM specification. Meant for PHP errors.
178825 **/
178826define('DOM_PHP_ERR', 0);
178827/**
178828 * If an invalid or illegal string is specified.
178829 **/
178830define('DOM_SYNTAX_ERR', 0);
178831/**
178832 * If a call to a method such as insertBefore or removeChild would make
178833 * the Node invalid with respect to "partial validity", this exception
178834 * would be raised and the operation would not be done.
178835 **/
178836define('DOM_VALIDATION_ERR', 0);
178837/**
178838 * If a node is used in a different document than the one that created
178839 * it.
178840 **/
178841define('DOM_WRONG_DOCUMENT_ERR', 0);
178842/**
178843 * String that can be used as the format string for {@link strftime} to
178844 * represent date.
178845 **/
178846define('D_FMT', 0);
178847/**
178848 * String that can be used as the format string for {@link strftime} to
178849 * represent time and date.
178850 **/
178851define('D_T_FMT', 0);
178852define('EIO_DT_BLK', 0);
178853define('EIO_DT_CHR', 0);
178854define('EIO_DT_CMP', 0);
178855define('EIO_DT_DIR', 0);
178856define('EIO_DT_DOOR', 0);
178857define('EIO_DT_FIFO', 0);
178858define('EIO_DT_LNK', 0);
178859define('EIO_DT_MAX', 0);
178860define('EIO_DT_MPB', 0);
178861define('EIO_DT_MPC', 0);
178862define('EIO_DT_NAM', 0);
178863define('EIO_DT_NWK', 0);
178864define('EIO_DT_REG', 0);
178865define('EIO_DT_SOCK', 0);
178866define('EIO_DT_UNKNOWN', 0);
178867define('EIO_DT_WHT', 0);
178868define('EIO_FALLOC_FL_KEEP_SIZE', 0);
178869define('EIO_O_APPEND', 0);
178870define('EIO_O_CREAT', 0);
178871define('EIO_O_EXCL', 0);
178872define('EIO_O_FSYNC', 0);
178873define('EIO_O_NONBLOCK', 0);
178874define('EIO_O_RDONLY', 0);
178875define('EIO_O_RDWR', 0);
178876define('EIO_O_TRUNC', 0);
178877define('EIO_O_WRONLY', 0);
178878define('EIO_PRI_DEFAULT', 0);
178879define('EIO_PRI_MAX', 0);
178880define('EIO_PRI_MIN', 0);
178881define('EIO_READDIR_DENTS', 0);
178882define('EIO_READDIR_DIRS_FIRST', 0);
178883define('EIO_READDIR_FOUND_UNKNOWN', 0);
178884define('EIO_READDIR_STAT_ORDER', 0);
178885define('EIO_SEEK_CUR', 0);
178886define('EIO_SEEK_END', 0);
178887define('EIO_SEEK_SET', 0);
178888define('EIO_SYNC_FILE_RANGE_WAIT_AFTER', 0);
178889define('EIO_SYNC_FILE_RANGE_WAIT_BEFORE', 0);
178890define('EIO_SYNC_FILE_RANGE_WRITE', 0);
178891define('EIO_S_IFBLK', 0);
178892define('EIO_S_IFCHR', 0);
178893define('EIO_S_IFIFO', 0);
178894define('EIO_S_IFREG', 0);
178895define('EIO_S_IFSOCK', 0);
178896define('EIO_S_IRGRP', 0);
178897define('EIO_S_IROTH', 0);
178898define('EIO_S_IRUSR', 0);
178899define('EIO_S_IWGRP', 0);
178900define('EIO_S_IWOTH', 0);
178901define('EIO_S_IWUSR', 0);
178902define('EIO_S_IXGRP', 0);
178903define('EIO_S_IXOTH', 0);
178904define('EIO_S_IXUSR', 0);
178905define('ENC7BIT', 0);
178906define('ENC8BIT', 0);
178907define('ENCBASE64', 0);
178908define('ENCBINARY', 0);
178909define('ENCHANT_ISPELL', 0);
178910define('ENCHANT_MYSPELL', 0);
178911define('ENCOTHER', 0);
178912define('ENCQUOTEDPRINTABLE', 0);
178913/**
178914 * Will convert double-quotes and leave single-quotes alone.
178915 **/
178916define('ENT_COMPAT', 0);
178917/**
178918 * Replace invalid code points for the given document type with a Unicode
178919 * Replacement Character U+FFFD (UTF-8) or � (otherwise) instead of
178920 * leaving them as is. This may be useful, for instance, to ensure the
178921 * well-formedness of XML documents with embedded external content.
178922 **/
178923define('ENT_DISALLOWED', 0);
178924/**
178925 * Handle code as HTML 5.
178926 **/
178927define('ENT_HTML5', 0);
178928/**
178929 * Handle code as HTML 4.01.
178930 **/
178931define('ENT_HTML401', 0);
178932/**
178933 * Silently discard invalid code unit sequences instead of returning an
178934 * empty string. Using this flag is discouraged as it may have security
178935 * implications.
178936 **/
178937define('ENT_IGNORE', 0);
178938/**
178939 * Will leave both double and single quotes unconverted.
178940 **/
178941define('ENT_NOQUOTES', 0);
178942/**
178943 * Will convert both double and single quotes.
178944 **/
178945define('ENT_QUOTES', 0);
178946/**
178947 * Replace invalid code unit sequences with a Unicode Replacement
178948 * Character U+FFFD (UTF-8) or � (otherwise) instead of returning an
178949 * empty string.
178950 **/
178951define('ENT_SUBSTITUTE', 0);
178952/**
178953 * Handle code as XHTML.
178954 **/
178955define('ENT_XHTML', 0);
178956/**
178957 * Handle code as XML 1.
178958 **/
178959define('ENT_XML1', 0);
178960define('EPHEMERAL', 0);
178961define('EPHEMERALONLOCALSESSION', 0);
178962/**
178963 * Alternate era.
178964 **/
178965define('ERA', 0);
178966/**
178967 * Date in alternate era format (string can be used in {@link strftime}).
178968 **/
178969define('ERA_D_FMT', 0);
178970/**
178971 * Date and time in alternate era format (string can be used in {@link
178972 * strftime}).
178973 **/
178974define('ERA_D_T_FMT', 0);
178975/**
178976 * Time in alternate era format (string can be used in {@link strftime}).
178977 **/
178978define('ERA_T_FMT', 0);
178979/**
178980 * Year in alternate era format.
178981 **/
178982define('ERA_YEAR', 0);
178983define('ERROR_TRACE', 0);
178984define('EVLOOP_NONBLOCK', 0);
178985define('EVLOOP_ONCE', 0);
178986define('EV_PERSIST', 0);
178987define('EV_READ', 0);
178988define('EV_SIGNAL', 0);
178989define('EV_TIMEOUT', 0);
178990define('EV_WRITE', 0);
178991define('EXIF_USE_MBSTRING', 0);
178992define('EXPIRED_SESSION_STATE', 0);
178993define('EXP_EOF', 0);
178994define('EXP_EXACT', 0);
178995define('EXP_FULLBUFFER', 0);
178996define('EXP_GLOB', 0);
178997define('EXP_REGEXP', 0);
178998define('EXP_TIMEOUT', 0);
178999define('EXTR_IF_EXISTS', 0);
179000define('EXTR_OVERWRITE', 0);
179001define('EXTR_PREFIX_ALL', 0);
179002define('EXTR_PREFIX_IF_EXISTS', 0);
179003define('EXTR_PREFIX_INVALID', 0);
179004define('EXTR_PREFIX_SAME', 0);
179005define('EXTR_REFS', 0);
179006define('EXTR_SKIP', 0);
179007/**
179008 * 32767 in PHP 5.4.x, 30719 in PHP 5.3.x, 6143 in PHP 5.2.x, 2047
179009 * previously
179010 **/
179011define('E_ALL', 0);
179012define('E_COMPILE_ERROR', 0);
179013define('E_COMPILE_WARNING', 0);
179014define('E_CORE_ERROR', 0);
179015define('E_CORE_WARNING', 0);
179016/**
179017 * As of PHP 5.3.0
179018 **/
179019define('E_DEPRECATED', 0);
179020define('E_ERROR', 0);
179021define('E_NOTICE', 0);
179022define('E_PARSE', 0);
179023/**
179024 * As of PHP 5.2.0
179025 **/
179026define('E_RECOVERABLE_ERROR', 0);
179027define('E_STRICT', 0);
179028/**
179029 * As of PHP 5.3.0
179030 **/
179031define('E_USER_DEPRECATED', 0);
179032define('E_USER_ERROR', 0);
179033define('E_USER_NOTICE', 0);
179034define('E_USER_WARNING', 0);
179035define('E_WARNING', 0);
179036define('FAMAcknowledge', 0);
179037define('FAMChanged', 0);
179038define('FAMCreated', 0);
179039define('FAMDeleted', 0);
179040define('FAMEndExist', 0);
179041define('FAMExists', 0);
179042define('FAMMoved', 0);
179043define('FAMStartExecuting', 0);
179044define('FAMStopExecuting', 0);
179045define('FANN_COS', 0);
179046define('FANN_COS_SYMMETRIC', 0);
179047define('FANN_ELLIOT', 0);
179048define('FANN_ELLIOT_SYMMETRIC', 0);
179049define('FANN_ERRORFUNC_LINEAR', 0);
179050define('FANN_ERRORFUNC_TANH', 0);
179051define('FANN_E_CANT_ALLOCATE_MEM', 0);
179052define('FANN_E_CANT_OPEN_CONFIG_R', 0);
179053define('FANN_E_CANT_OPEN_CONFIG_W', 0);
179054define('FANN_E_CANT_OPEN_TD_R', 0);
179055define('FANN_E_CANT_OPEN_TD_W', 0);
179056define('FANN_E_CANT_READ_CONFIG', 0);
179057define('FANN_E_CANT_READ_CONNECTIONS', 0);
179058define('FANN_E_CANT_READ_NEURON', 0);
179059define('FANN_E_CANT_READ_TD', 0);
179060define('FANN_E_CANT_TRAIN_ACTIVATION', 0);
179061define('FANN_E_CANT_USE_ACTIVATION', 0);
179062define('FANN_E_CANT_USE_TRAIN_ALG', 0);
179063define('FANN_E_INDEX_OUT_OF_BOUND', 0);
179064define('FANN_E_INPUT_NO_MATCH', 0);
179065define('FANN_E_NO_ERROR', 0);
179066define('FANN_E_OUTPUT_NO_MATCH', 0);
179067define('FANN_E_SCALE_NOT_PRESENT', 0);
179068define('FANN_E_TRAIN_DATA_MISMATCH', 0);
179069define('FANN_E_TRAIN_DATA_SUBSET', 0);
179070define('FANN_E_WRONG_CONFIG_VERSION', 0);
179071define('FANN_E_WRONG_NUM_CONNECTIONS', 0);
179072define('FANN_GAUSSIAN', 0);
179073define('FANN_GAUSSIAN_STEPWISE', 0);
179074define('FANN_GAUSSIAN_SYMMETRIC', 0);
179075define('FANN_LINEAR', 0);
179076define('FANN_LINEAR_PIECE', 0);
179077define('FANN_LINEAR_PIECE_SYMMETRIC', 0);
179078define('FANN_NETTYPE_LAYER', 0);
179079define('FANN_NETTYPE_SHORTCUT', 0);
179080define('FANN_SIGMOID', 0);
179081define('FANN_SIGMOID_STEPWISE', 0);
179082define('FANN_SIGMOID_SYMMETRIC', 0);
179083define('FANN_SIGMOID_SYMMETRIC_STEPWISE', 0);
179084define('FANN_SIN', 0);
179085define('FANN_SIN_SYMMETRIC', 0);
179086define('FANN_STOPFUNC_BIT', 0);
179087define('FANN_STOPFUNC_MSE', 0);
179088define('FANN_THRESHOLD', 0);
179089define('FANN_THRESHOLD_SYMMETRIC', 0);
179090define('FANN_TRAIN_BATCH', 0);
179091define('FANN_TRAIN_INCREMENTAL', 0);
179092define('FANN_TRAIN_QUICKPROP', 0);
179093define('FANN_TRAIN_RPROP', 0);
179094define('FANN_TRAIN_SARPROP', 0);
179095define('FBSQL_ASSOC', 0);
179096define('FBSQL_BOTH', 0);
179097define('FBSQL_ISO_READ_COMMITTED', 0);
179098define('FBSQL_ISO_READ_UNCOMMITTED', 0);
179099define('FBSQL_ISO_REPEATABLE_READ', 0);
179100define('FBSQL_ISO_SERIALIZABLE', 0);
179101define('FBSQL_ISO_VERSIONED', 0);
179102define('FBSQL_LOB_DIRECT', 0);
179103define('FBSQL_LOB_HANDLE', 0);
179104define('FBSQL_LOCK_DEFERRED', 0);
179105define('FBSQL_LOCK_OPTIMISTIC', 0);
179106define('FBSQL_LOCK_PESSIMISTIC', 0);
179107define('FBSQL_NOEXEC', 0);
179108define('FBSQL_NUM', 0);
179109define('FBSQL_RUNNING', 0);
179110define('FBSQL_STARTING', 0);
179111define('FBSQL_STOPPED', 0);
179112define('FBSQL_STOPPING', 0);
179113define('FBSQL_UNKNOWN', 0);
179114define('FDFAA', 0);
179115define('FDFAction', 0);
179116define('FDFAP', 0);
179117define('FDFAPRef', 0);
179118define('FDFAS', 0);
179119define('FDFCalculate', 0);
179120define('FDFClearFf', 0);
179121define('FDFClrF', 0);
179122define('FDFDown', 0);
179123define('FDFDownAP', 0);
179124define('FDFEnter', 0);
179125define('FDFExit', 0);
179126define('FDFFf', 0);
179127define('FDFFile', 0);
179128define('FDFFlags', 0);
179129define('FDFFormat', 0);
179130define('FDFID', 0);
179131define('FDFIF', 0);
179132define('FDFKeystroke', 0);
179133define('FDFNormalAP', 0);
179134define('FDFRolloverAP', 0);
179135define('FDFSetF', 0);
179136define('FDFSetFf', 0);
179137define('FDFStatus', 0);
179138define('FDFUp', 0);
179139define('FDFValidate', 0);
179140define('FDFValue', 0);
179141define('FILEINFO_COMPRESS', 0);
179142define('FILEINFO_CONTINUE', 0);
179143define('FILEINFO_DEVICES', 0);
179144define('FILEINFO_EXTENSION', 0);
179145define('FILEINFO_MIME', 0);
179146define('FILEINFO_MIME_ENCODING', 0);
179147define('FILEINFO_MIME_TYPE', 0);
179148define('FILEINFO_NONE', 0);
179149define('FILEINFO_PRESERVE_ATIME', 0);
179150define('FILEINFO_RAW', 0);
179151define('FILEINFO_SYMLINK', 0);
179152/**
179153 * If file {@link filename} already exists, append the data to the file
179154 * instead of overwriting it.
179155 **/
179156define('FILE_APPEND', 0);
179157define('FILE_BINARY', 0);
179158define('FILE_IGNORE_NEW_LINES', 0);
179159define('FILE_NO_DEFAULT_CONTEXT', 0);
179160define('FILE_SKIP_EMPTY_LINES', 0);
179161define('FILE_TEXT', 0);
179162/**
179163 * Search for {@link filename} in the include directory. See include_path
179164 * for more information.
179165 **/
179166define('FILE_USE_INCLUDE_PATH', 0);
179167define('FILTER_CALLBACK', 0);
179168define('FILTER_DEFAULT', 0);
179169define('FILTER_FLAG_ALLOW_FRACTION', 0);
179170define('FILTER_FLAG_ALLOW_HEX', 0);
179171define('FILTER_FLAG_ALLOW_OCTAL', 0);
179172define('FILTER_FLAG_ALLOW_SCIENTIFIC', 0);
179173define('FILTER_FLAG_ALLOW_THOUSAND', 0);
179174define('FILTER_FLAG_EMAIL_UNICODE', 0);
179175define('FILTER_FLAG_EMPTY_STRING_NULL', 0);
179176define('FILTER_FLAG_ENCODE_AMP', 0);
179177define('FILTER_FLAG_ENCODE_HIGH', 0);
179178define('FILTER_FLAG_ENCODE_LOW', 0);
179179define('FILTER_FLAG_HOSTNAME', 0);
179180define('FILTER_FLAG_HOST_REQUIRED', 0);
179181define('FILTER_FLAG_IPV4', 0);
179182define('FILTER_FLAG_IPV6', 0);
179183define('FILTER_FLAG_NONE', 0);
179184define('FILTER_FLAG_NO_ENCODE_QUOTES', 0);
179185define('FILTER_FLAG_NO_PRIV_RANGE', 0);
179186define('FILTER_FLAG_NO_RES_RANGE', 0);
179187define('FILTER_FLAG_PATH_REQUIRED', 0);
179188define('FILTER_FLAG_QUERY_REQUIRED', 0);
179189define('FILTER_FLAG_SCHEME_REQUIRED', 0);
179190define('FILTER_FLAG_STRIP_BACKTICK', 0);
179191define('FILTER_FLAG_STRIP_HIGH', 0);
179192define('FILTER_FLAG_STRIP_LOW', 0);
179193define('FILTER_FORCE_ARRAY', 0);
179194define('FILTER_NULL_ON_FAILURE', 0);
179195define('FILTER_REQUIRE_ARRAY', 0);
179196define('FILTER_REQUIRE_SCALAR', 0);
179197define('FILTER_SANITIZE_ADD_SLASHES', 0);
179198define('FILTER_SANITIZE_EMAIL', 0);
179199define('FILTER_SANITIZE_ENCODED', 0);
179200define('FILTER_SANITIZE_MAGIC_QUOTES', 0);
179201define('FILTER_SANITIZE_NUMBER_FLOAT', 0);
179202define('FILTER_SANITIZE_NUMBER_INT', 0);
179203define('FILTER_SANITIZE_SPECIAL_CHARS', 0);
179204define('FILTER_SANITIZE_STRING', 0);
179205define('FILTER_SANITIZE_STRIPPED', 0);
179206define('FILTER_SANITIZE_URL', 0);
179207define('FILTER_UNSAFE_RAW', 0);
179208define('FILTER_VALIDATE_BOOLEAN', 0);
179209define('FILTER_VALIDATE_DOMAIN', 0);
179210define('FILTER_VALIDATE_EMAIL', 0);
179211define('FILTER_VALIDATE_FLOAT', 0);
179212define('FILTER_VALIDATE_INT', 0);
179213define('FILTER_VALIDATE_IP', 0);
179214define('FILTER_VALIDATE_MAC', 0);
179215define('FILTER_VALIDATE_REGEXP', 0);
179216define('FILTER_VALIDATE_URL', 0);
179217/**
179218 * Caseless match. Part of the GNU extension.
179219 **/
179220define('FNM_CASEFOLD', 0);
179221/**
179222 * Disable backslash escaping.
179223 **/
179224define('FNM_NOESCAPE', 0);
179225/**
179226 * Slash in string only matches slash in the given pattern.
179227 **/
179228define('FNM_PATHNAME', 0);
179229/**
179230 * Leading period in string must be exactly matched by period in the
179231 * given pattern.
179232 **/
179233define('FNM_PERIOD', 0);
179234define('FORCE_DEFLATE', 0);
179235define('FORCE_GZIP', 0);
179236define('FPE_FLTDIV', 0);
179237define('FPE_FLTINV', 0);
179238define('FPE_FLTOVF', 0);
179239define('FPE_FLTRES', 0);
179240define('FPE_FLTSUB', 0);
179241define('FPE_FLTUND', 0);
179242define('FPE_INTDIV', 0);
179243define('FPE_INTOVF', 0);
179244/**
179245 * Local fractional digits.
179246 **/
179247define('FRAC_DIGITS', 0);
179248define('FRIBIDI_AUTO', 0);
179249define('FRIBIDI_CHARSET_8859_6', 0);
179250define('FRIBIDI_CHARSET_8859_8', 0);
179251define('FRIBIDI_CHARSET_CAP_RTL', 0);
179252define('FRIBIDI_CHARSET_CP1255', 0);
179253define('FRIBIDI_CHARSET_CP1256', 0);
179254define('FRIBIDI_CHARSET_ISIRI_3342', 0);
179255define('FRIBIDI_CHARSET_UTF8', 0);
179256define('FRIBIDI_LTR', 0);
179257define('FRIBIDI_RTL', 0);
179258define('FTP_ASCII', 0);
179259define('FTP_AUTORESUME', 0);
179260/**
179261 * Returns TRUE if this option is on, FALSE otherwise.
179262 **/
179263define('FTP_AUTOSEEK', 0);
179264define('FTP_BINARY', 0);
179265define('FTP_FAILED', 0);
179266define('FTP_FINISHED', 0);
179267define('FTP_IMAGE', 0);
179268define('FTP_MOREDATA', 0);
179269define('FTP_TEXT', 0);
179270/**
179271 * Returns the current timeout used for network related operations.
179272 **/
179273define('FTP_TIMEOUT_SEC', 0);
179274/**
179275 * When disabled, PHP will ignore the IP address returned by the FTP
179276 * server in response to the PASV command and instead use the IP address
179277 * that was supplied in the ftp_connect(). {@link value} must be a
179278 * boolean.
179279 **/
179280define('FTP_USEPASVADDRESS', 0);
179281define('FT_INTERNAL', 0);
179282define('FT_NOT', 0);
179283define('FT_PEEK', 0);
179284define('FT_PREFETCHTEXT', 0);
179285define('FT_UID', 0);
179286define('FUNCTION_TRACE', 0);
179287define('F_DUPFD', 0);
179288define('F_GETFD', 0);
179289define('F_GETFL', 0);
179290define('F_GETLK', 0);
179291define('F_GETOWN', 0);
179292define('F_RDLCK', 0);
179293define('F_SETFL', 0);
179294define('F_SETLK', 0);
179295define('F_SETLKW', 0);
179296define('F_SETOWN', 0);
179297define('F_UNLCK', 0);
179298define('F_WRLCK', 0);
179299define('GD_BUNDLED', 0);
179300define('GD_EXTRA_VERSION', '');
179301define('GD_MAJOR_VERSION', 0);
179302define('GD_MINOR_VERSION', 0);
179303define('GD_RELEASE_VERSION', 0);
179304define('GD_VERSION', '');
179305define('GEARMAN_ARGS_BUFFER_SIZE', 0);
179306define('GEARMAN_CLIENT_FREE_TASKS', 0);
179307define('GEARMAN_CLIENT_GENERATE_UNIQUE', 0);
179308define('GEARMAN_CLIENT_NON_BLOCKING', 0);
179309define('GEARMAN_CLIENT_UNBUFFERED_RESULT', 0);
179310define('GEARMAN_COULD_NOT_CONNECT', 0);
179311define('GEARMAN_DEFAULT_SOCKET_RECV_SIZE', 0);
179312define('GEARMAN_DEFAULT_SOCKET_SEND_SIZE', 0);
179313define('GEARMAN_DEFAULT_SOCKET_TIMEOUT', 0);
179314define('GEARMAN_DEFAULT_TCP_HOST', '');
179315define('GEARMAN_DEFAULT_TCP_PORT', 0);
179316define('GEARMAN_ECHO_DATA_CORRUPTION', 0);
179317define('GEARMAN_ERRNO', 0);
179318define('GEARMAN_GETADDRINFO', 0);
179319define('GEARMAN_INVALID_FUNCTION_NAME', 0);
179320define('GEARMAN_INVALID_WORKER_FUNCTION', 0);
179321define('GEARMAN_IO_WAIT', 0);
179322define('GEARMAN_JOB_HANDLE_SIZE', 0);
179323define('GEARMAN_LOST_CONNECTION', 0);
179324define('GEARMAN_MAX_COMMAND_ARGS', 0);
179325define('GEARMAN_MAX_ERROR_SIZE', 0);
179326define('GEARMAN_MEMORY_ALLOCATION_FAILURE', 0);
179327define('GEARMAN_NEED_WORKLOAD_FN', 0);
179328define('GEARMAN_NO_ACTIVE_FDS', 0);
179329define('GEARMAN_NO_JOBS', 0);
179330define('GEARMAN_NO_REGISTERED_FUNCTIONS', 0);
179331define('GEARMAN_NO_SERVERS', 0);
179332define('GEARMAN_OPTION_SIZE', 0);
179333define('GEARMAN_PACKET_HEADER_SIZE', 0);
179334define('GEARMAN_PAUSE', 0);
179335define('GEARMAN_RECV_BUFFER_SIZE', 0);
179336define('GEARMAN_SEND_BUFFER_SIZE', 0);
179337define('GEARMAN_SEND_BUFFER_TOO_SMALL', 0);
179338define('GEARMAN_SERVER_ERROR', 0);
179339define('GEARMAN_SUCCESS', 0);
179340define('GEARMAN_TIMEOUT', 0);
179341define('GEARMAN_UNEXPECTED_PACKET', 0);
179342define('GEARMAN_UNIQUE_SIZE', 0);
179343define('GEARMAN_UNKNOWN_STATE', 0);
179344define('GEARMAN_WORKER_GRAB_UNIQ', 0);
179345define('GEARMAN_WORKER_NON_BLOCKING', 0);
179346define('GEARMAN_WORKER_WAIT_TIMEOUT', 0);
179347define('GEARMAN_WORK_DATA', 0);
179348define('GEARMAN_WORK_EXCEPTION', 0);
179349define('GEARMAN_WORK_FAIL', 0);
179350define('GEARMAN_WORK_STATUS', 0);
179351define('GEARMAN_WORK_WARNING', 0);
179352define('GEOIP_ASNUM_EDITION', 0);
179353define('GEOIP_CABLEDSL_SPEED', 0);
179354define('GEOIP_CITY_EDITION_REV0', 0);
179355define('GEOIP_CITY_EDITION_REV1', 0);
179356define('GEOIP_CORPORATE_SPEED', 0);
179357define('GEOIP_COUNTRY_EDITION', 0);
179358define('GEOIP_DIALUP_SPEED', 0);
179359define('GEOIP_DOMAIN_EDITION', 0);
179360define('GEOIP_ISP_EDITION', 0);
179361define('GEOIP_NETSPEED_EDITION', 0);
179362define('GEOIP_ORG_EDITION', 0);
179363define('GEOIP_PROXY_EDITION', 0);
179364define('GEOIP_REGION_EDITION_REV0', 0);
179365define('GEOIP_REGION_EDITION_REV1', 0);
179366define('GEOIP_UNKNOWN_SPEED', 0);
179367define('GET_MATCH', 0);
179368define('GLOB_AVAILABLE_FLAGS', 0);
179369define('GLOB_BRACE', 0);
179370define('GLOB_MARK', 0);
179371define('GLOB_NOCHECK', 0);
179372define('GLOB_NOESCAPE', 0);
179373define('GLOB_NOSORT', 0);
179374define('GLOB_ONLYDIR', 0);
179375define('GMP_BIG_ENDIAN', 0);
179376define('GMP_LITTLE_ENDIAN', 0);
179377define('GMP_LSW_FIRST', 0);
179378define('GMP_MSW_FIRST', 0);
179379define('GMP_NATIVE_ENDIAN', 0);
179380define('GMP_ROUND_MINUSINF', 0);
179381define('GMP_ROUND_PLUSINF', 0);
179382define('GMP_ROUND_ZERO', 0);
179383define('GMP_VERSION', '');
179384define('GNUPG_ERROR_EXCEPTION', 0);
179385define('GNUPG_ERROR_SILENT', 0);
179386define('GNUPG_ERROR_WARNING', 0);
179387define('GNUPG_PROTOCOL_CMS', 0);
179388define('GNUPG_PROTOCOL_OpenPGP', 0);
179389define('GNUPG_SIGSUM_BAD_POLICY', 0);
179390define('GNUPG_SIGSUM_CRL_MISSING', 0);
179391define('GNUPG_SIGSUM_CRL_TOO_OLD', 0);
179392define('GNUPG_SIGSUM_GREEN', 0);
179393define('GNUPG_SIGSUM_KEY_EXPIRED', 0);
179394define('GNUPG_SIGSUM_KEY_MISSING', 0);
179395define('GNUPG_SIGSUM_KEY_REVOKED', 0);
179396define('GNUPG_SIGSUM_RED', 0);
179397define('GNUPG_SIGSUM_SIG_EXPIRED', 0);
179398define('GNUPG_SIGSUM_SYS_ERROR', 0);
179399define('GNUPG_SIGSUM_VALID', 0);
179400define('GNUPG_SIG_MODE_CLEAR', 0);
179401define('GNUPG_SIG_MODE_DETACH', 0);
179402define('GNUPG_SIG_MODE_NORMAL', 0);
179403define('GNUPG_VALIDITY_FULL', 0);
179404define('GNUPG_VALIDITY_MARGINAL', 0);
179405define('GNUPG_VALIDITY_NEVER', 0);
179406define('GNUPG_VALIDITY_ULTIMATE', 0);
179407define('GNUPG_VALIDITY_UNDEFINED', 0);
179408define('GNUPG_VALIDITY_UNKNOWN', 0);
179409define('GOPHER_BINARY', 0);
179410define('GOPHER_BINHEX', 0);
179411define('GOPHER_DIRECTORY', 0);
179412define('GOPHER_DOCUMENT', 0);
179413define('GOPHER_DOSBINARY', 0);
179414define('GOPHER_HTTP', 0);
179415define('GOPHER_INFO', 0);
179416define('GOPHER_UNKNOWN', 0);
179417define('GOPHER_UUENCODED', 0);
179418define('GROUPING', 0);
179419define('GSLC_SSL_NO_AUTH', 0);
179420define('GSLC_SSL_ONEWAY_AUTH', 0);
179421define('GSLC_SSL_TWOWAY_AUTH', 0);
179422define('GUPNP_CONTROL_ERROR_ACTION_FAILED', 0);
179423define('GUPNP_CONTROL_ERROR_INVALID_ACTION', 0);
179424define('GUPNP_CONTROL_ERROR_INVALID_ARGS', 0);
179425define('GUPNP_CONTROL_ERROR_OUT_OF_SYNC', 0);
179426define('GUPNP_SIGNAL_ACTION_INVOKED', 0);
179427define('GUPNP_SIGNAL_DEVICE_PROXY_AVAILABLE', 0);
179428define('GUPNP_SIGNAL_DEVICE_PROXY_UNAVAILABLE', 0);
179429define('GUPNP_SIGNAL_NOTIFY_FAILED', 0);
179430define('GUPNP_SIGNAL_SERVICE_PROXY_AVAILABLE', 0);
179431define('GUPNP_SIGNAL_SERVICE_PROXY_UNAVAILABLE', 0);
179432define('GUPNP_SIGNAL_SUBSCRIPTION_LOST', 0);
179433define('GUPNP_TYPE_BOOLEAN', 0);
179434define('GUPNP_TYPE_DOUBLE', 0);
179435define('GUPNP_TYPE_FLOAT', 0);
179436define('GUPNP_TYPE_INT', 0);
179437define('GUPNP_TYPE_LONG', 0);
179438define('GUPNP_TYPE_STRING', 0);
179439define('HASH_HMAC', 0);
179440define('HTML_ENTITIES', 0);
179441define('HTML_SPECIALCHARS', 0);
179442define('IBASE_BKP_CONVERT', 0);
179443define('IBASE_BKP_IGNORE_CHECKSUMS', 0);
179444define('IBASE_BKP_IGNORE_LIMBO', 0);
179445define('IBASE_BKP_METADATA_ONLY', 0);
179446define('IBASE_BKP_NON_TRANSPORTABLE', 0);
179447define('IBASE_BKP_NO_GARBAGE_COLLECT', 0);
179448define('IBASE_BKP_OLD_DESCRIPTIONS', 0);
179449define('IBASE_PRP_ACCESS_MODE', 0);
179450define('IBASE_PRP_ACTIVATE', 0);
179451define('IBASE_PRP_AM_READONLY', 0);
179452define('IBASE_PRP_AM_READWRITE', 0);
179453define('IBASE_PRP_DB_ONLINE', 0);
179454define('IBASE_PRP_DENY_NEW_ATTACHMENTS', 0);
179455define('IBASE_PRP_DENY_NEW_TRANSACTIONS', 0);
179456define('IBASE_PRP_PAGE_BUFFERS', 0);
179457define('IBASE_PRP_RES', 0);
179458define('IBASE_PRP_RESERVE_SPACE', 0);
179459define('IBASE_PRP_RES_USE_FULL', 0);
179460define('IBASE_PRP_SET_SQL_DIALECT', 0);
179461define('IBASE_PRP_SHUTDOWN_DB', 0);
179462define('IBASE_PRP_SWEEP_INTERVAL', 0);
179463define('IBASE_PRP_WM_ASYNC', 0);
179464define('IBASE_PRP_WM_SYNC', 0);
179465define('IBASE_PRP_WRITE_MODE', 0);
179466define('IBASE_REC_VERSION', 0);
179467define('IBASE_RES_CREATE', 0);
179468define('IBASE_RES_DEACTIVATE_IDX', 0);
179469define('IBASE_RES_NO_SHADOW', 0);
179470define('IBASE_RES_NO_VALIDITY', 0);
179471define('IBASE_RES_ONE_AT_A_TIME', 0);
179472define('IBASE_RES_REPLACE', 0);
179473define('IBASE_RES_USE_ALL_SPACE', 0);
179474define('IBASE_RPR_CHECK_DB', 0);
179475define('IBASE_RPR_FULL', 0);
179476define('IBASE_RPR_IGNORE_CHECKSUM', 0);
179477define('IBASE_RPR_KILL_SHADOWS', 0);
179478define('IBASE_RPR_MEND_DB', 0);
179479define('IBASE_RPR_SWEEP_DB', 0);
179480define('IBASE_RPR_VALIDATE_DB', 0);
179481define('IBASE_STS_DATA_PAGES', 0);
179482define('IBASE_STS_DB_LOG', 0);
179483define('IBASE_STS_HDR_PAGES', 0);
179484define('IBASE_STS_IDX_PAGES', 0);
179485define('IBASE_STS_SYS_RELATIONS', 0);
179486define('IBASE_SVC_GET_ENV', 0);
179487define('IBASE_SVC_GET_ENV_LOCK', 0);
179488define('IBASE_SVC_GET_ENV_MSG', 0);
179489define('IBASE_SVC_GET_USERS', 0);
179490define('IBASE_SVC_IMPLEMENTATION', 0);
179491define('IBASE_SVC_SERVER_VERSION', 0);
179492define('IBASE_SVC_SVR_DB_INFO', 0);
179493define('IBASE_SVC_USER_DBPATH', 0);
179494define('IBASE_TEXT', 0);
179495define('ICONV_IMPL', 0);
179496define('ICONV_MIME_DECODE_CONTINUE_ON_ERROR', 0);
179497define('ICONV_MIME_DECODE_STRICT', 0);
179498define('ICONV_VERSION', 0);
179499define('ID3_BEST', 0);
179500define('ID3_V1_0', 0);
179501define('ID3_V1_1', 0);
179502define('ID3_V2_1', 0);
179503define('ID3_V2_2', 0);
179504define('ID3_V2_3', 0);
179505define('ID3_V2_4', 0);
179506define('IDNA_ALLOW_UNASSIGNED', 0);
179507define('IDNA_CHECK_BIDI', 0);
179508define('IDNA_CHECK_CONTEXTJ', 0);
179509define('IDNA_DEFAULT', 0);
179510define('IDNA_ERROR_EMPTY_LABEL', 0);
179511define('IDNA_NONTRANSITIONAL_TO_ASCII', 0);
179512define('IDNA_NONTRANSITIONAL_TO_UNICODE', 0);
179513define('IDNA_USE_STD3_RULES', 0);
179514define('IFX_HOLD', 0);
179515define('IFX_LO_APPEND', 0);
179516define('IFX_LO_BUFFER', 0);
179517define('IFX_LO_NOBUFFER', 0);
179518define('IFX_LO_RDONLY', 0);
179519define('IFX_LO_RDWR', 0);
179520define('IFX_LO_WRONLY', 0);
179521define('IFX_SCROLL', 0);
179522define('IIS_ANONYMOUS', 0);
179523define('IIS_BASIC', 0);
179524define('IIS_EXECUTE', 0);
179525define('IIS_NTLM', 0);
179526define('IIS_PAUSED', 0);
179527define('IIS_READ', 0);
179528define('IIS_RUNNING', 0);
179529define('IIS_SCRIPT', 0);
179530define('IIS_STARTING', 0);
179531define('IIS_STOPPED', 0);
179532define('IIS_WRITE', 0);
179533define('ILL_BADSTK', 0);
179534define('ILL_COPROC', 0);
179535define('ILL_ILLADR', 0);
179536define('ILL_ILLOPC', 0);
179537define('ILL_ILLOPN', 0);
179538define('ILL_ILLTRP', 0);
179539define('ILL_PRVOPC', 0);
179540define('ILL_PRVREG', 0);
179541/**
179542 * image/bmp
179543 **/
179544define('IMAGETYPE_BMP', 0);
179545/**
179546 * image/gif
179547 **/
179548define('IMAGETYPE_GIF', 0);
179549/**
179550 * image/vnd.microsoft.icon
179551 **/
179552define('IMAGETYPE_ICO', 0);
179553/**
179554 * image/iff
179555 **/
179556define('IMAGETYPE_IFF', 0);
179557/**
179558 * application/octet-stream
179559 **/
179560define('IMAGETYPE_JB2', 0);
179561/**
179562 * image/jp2
179563 **/
179564define('IMAGETYPE_JP2', 0);
179565/**
179566 * application/octet-stream
179567 **/
179568define('IMAGETYPE_JPC', 0);
179569/**
179570 * image/jpeg
179571 **/
179572define('IMAGETYPE_JPEG', 0);
179573define('IMAGETYPE_JPEG2000', 0);
179574/**
179575 * application/octet-stream
179576 **/
179577define('IMAGETYPE_JPX', 0);
179578/**
179579 * image/png
179580 **/
179581define('IMAGETYPE_PNG', 0);
179582/**
179583 * image/psd
179584 **/
179585define('IMAGETYPE_PSD', 0);
179586/**
179587 * application/x-shockwave-flash
179588 **/
179589define('IMAGETYPE_SWC', 0);
179590/**
179591 * application/x-shockwave-flash
179592 **/
179593define('IMAGETYPE_SWF', 0);
179594/**
179595 * image/tiff
179596 **/
179597define('IMAGETYPE_TIFF_II', 0);
179598/**
179599 * image/tiff
179600 **/
179601define('IMAGETYPE_TIFF_MM', 0);
179602/**
179603 * image/vnd.wap.wbmp
179604 **/
179605define('IMAGETYPE_WBMP', 0);
179606/**
179607 * image/webp
179608 **/
179609define('IMAGETYPE_WEBP', 0);
179610/**
179611 * image/xbm
179612 **/
179613define('IMAGETYPE_XBM', 0);
179614define('IMAP_CLOSETIMEOUT', 0);
179615define('IMAP_GC_ELT', 0);
179616define('IMAP_GC_ENV', 0);
179617define('IMAP_GC_TEXTS', 0);
179618define('IMAP_OPENTIMEOUT', 0);
179619define('IMAP_READTIMEOUT', 0);
179620define('IMAP_WRITETIMEOUT', 0);
179621define('IMG_AFFINE_ROTATE', 0);
179622define('IMG_AFFINE_SCALE', 0);
179623define('IMG_AFFINE_SHEAR_HORIZONTAL', 0);
179624define('IMG_AFFINE_SHEAR_VERTICAL', 0);
179625define('IMG_AFFINE_TRANSLATE', 0);
179626define('IMG_ARC_CHORD', 0);
179627define('IMG_ARC_EDGED', 0);
179628define('IMG_ARC_NOFILL', 0);
179629define('IMG_ARC_PIE', 0);
179630define('IMG_ARC_ROUNDED', 0);
179631define('IMG_BELL', 0);
179632define('IMG_BESSEL', 0);
179633define('IMG_BICUBIC', 0);
179634define('IMG_BICUBIC_FIXED', 0);
179635define('IMG_BILINEAR_FIXED', 0);
179636define('IMG_BLACKMAN', 0);
179637define('IMG_BMP', 0);
179638define('IMG_BOX', 0);
179639define('IMG_BSPLINE', 0);
179640define('IMG_CATMULLROM', 0);
179641define('IMG_COLOR_BRUSHED', 0);
179642define('IMG_COLOR_STYLED', 0);
179643define('IMG_COLOR_STYLEDBRUSHED', 0);
179644define('IMG_COLOR_TILED', 0);
179645define('IMG_COLOR_TRANSPARENT', 0);
179646define('IMG_EFFECT_ALPHABLEND', 0);
179647define('IMG_EFFECT_MULTIPLY', 0);
179648define('IMG_EFFECT_NORMAL', 0);
179649define('IMG_EFFECT_OVERLAY', 0);
179650define('IMG_EFFECT_REPLACE', 0);
179651define('IMG_FILTER_BRIGHTNESS', 0);
179652define('IMG_FILTER_COLORIZE', 0);
179653define('IMG_FILTER_CONTRAST', 0);
179654define('IMG_FILTER_EDGEDETECT', 0);
179655define('IMG_FILTER_EMBOSS', 0);
179656define('IMG_FILTER_GAUSSIAN_BLUR', 0);
179657define('IMG_FILTER_GRAYSCALE', 0);
179658define('IMG_FILTER_MEAN_REMOVAL', 0);
179659define('IMG_FILTER_NEGATE', 0);
179660define('IMG_FILTER_PIXELATE', 0);
179661define('IMG_FILTER_SCATTER', 0);
179662define('IMG_FILTER_SELECTIVE_BLUR', 0);
179663define('IMG_FILTER_SMOOTH', 0);
179664/**
179665 * Flips the image both horizontally and vertically.
179666 **/
179667define('IMG_FLIP_BOTH', 0);
179668/**
179669 * Flips the image horizontally.
179670 **/
179671define('IMG_FLIP_HORIZONTAL', 0);
179672/**
179673 * Flips the image vertically.
179674 **/
179675define('IMG_FLIP_VERTICAL', 0);
179676define('IMG_GAUSSIAN', 0);
179677define('IMG_GD2_COMPRESSED', 0);
179678define('IMG_GD2_RAW', 0);
179679define('IMG_GENERALIZED_CUBIC', 0);
179680define('IMG_GIF', 0);
179681define('IMG_HAMMING', 0);
179682define('IMG_HANNING', 0);
179683define('IMG_HERMITE', 0);
179684define('IMG_JPEG', 0);
179685define('IMG_JPG', 0);
179686define('IMG_MITCHELL', 0);
179687define('IMG_NEAREST_NEIGHBOUR', 0);
179688define('IMG_PNG', 0);
179689define('IMG_POWER', 0);
179690define('IMG_QUADRATIC', 0);
179691define('IMG_SINC', 0);
179692define('IMG_TRIANGLE', 0);
179693define('IMG_WBMP', 0);
179694define('IMG_WEBP', 0);
179695define('IMG_WEIGHTED4', 0);
179696define('IMG_XPM', 0);
179697define('INF', 0);
179698define('INFO_ALL', 0);
179699define('INFO_BASE_PRIORITY', 0);
179700define('INFO_CONFIGURATION', 0);
179701define('INFO_CREDITS', 0);
179702define('INFO_DELAYED_START', 0);
179703define('INFO_DEPENDENCIES', 0);
179704define('INFO_ENVIRONMENT', 0);
179705define('INFO_ERROR_CONTROL', 0);
179706define('INFO_GENERAL', 0);
179707define('INFO_LICENSE', 0);
179708define('INFO_LOAD_ORDER', 0);
179709define('INFO_MODULES', 0);
179710define('INFO_RECOVERY_ACTION_1', 0);
179711define('INFO_RECOVERY_ACTION_2', 0);
179712define('INFO_RECOVERY_ACTION_3', 0);
179713define('INFO_RECOVERY_COMMAND', 0);
179714define('INFO_RECOVERY_DELAY', 0);
179715define('INFO_RECOVERY_ENABLED', 0);
179716define('INFO_RECOVERY_REBOOT_MSG', 0);
179717define('INFO_RECOVERY_RESET_PERIOD', 0);
179718define('INFO_SVC_TYPE', 0);
179719define('INFO_VARIABLES', 0);
179720define('INGRES_API_VERSION', 0);
179721define('INGRES_ASSOC', 0);
179722define('INGRES_BOTH', 0);
179723define('INGRES_CURSOR_READONLY', 0);
179724define('INGRES_CURSOR_UPDATE', 0);
179725define('INGRES_DATE_DMY', 0);
179726define('INGRES_DATE_FINNISH', 0);
179727define('INGRES_DATE_GERMAN', 0);
179728define('INGRES_DATE_ISO', 0);
179729define('INGRES_DATE_ISO4', 0);
179730define('INGRES_DATE_MDY', 0);
179731define('INGRES_DATE_MULTINATIONAL', 0);
179732define('INGRES_DATE_MULTINATIONAL4', 0);
179733define('INGRES_DATE_YMD', 0);
179734define('INGRES_EXT_VERSION', '');
179735define('INGRES_MONEY_LEADING', 0);
179736define('INGRES_MONEY_TRAILING', 0);
179737define('INGRES_NUM', 0);
179738define('INGRES_STRUCTURE_BTREE', 0);
179739define('INGRES_STRUCTURE_CBTREE', 0);
179740define('INGRES_STRUCTURE_CHASH', 0);
179741define('INGRES_STRUCTURE_CHEAP', 0);
179742define('INGRES_STRUCTURE_CISAM', 0);
179743define('INGRES_STRUCTURE_HASH', 0);
179744define('INGRES_STRUCTURE_HEAP', 0);
179745define('INGRES_STRUCTURE_ISAM', 0);
179746define('INI_SCANNER_NORMAL', 0);
179747define('INI_SCANNER_RAW', 0);
179748define('INI_SCANNER_TYPED', 0);
179749define('INPUT_COOKIE', 0);
179750define('INPUT_ENV', 0);
179751define('INPUT_GET', 0);
179752define('INPUT_POST', 0);
179753define('INPUT_REQUEST', 0);
179754define('INPUT_SERVER', 0);
179755define('INPUT_SESSION', 0);
179756define('INTL_ICU_VERSION', '');
179757define('INTL_IDNA_VARIANT_2003', 0);
179758define('INTL_IDNA_VARIANT_UTS46', 0);
179759define('INTL_MAX_LOCALE_LEN', 0);
179760/**
179761 * International currency symbol.
179762 **/
179763define('INT_CURR_SYMBOL', 0);
179764/**
179765 * International fractional digits.
179766 **/
179767define('INT_FRAC_DIGITS', 0);
179768define('INVALIDACL', 0);
179769define('INVALIDCALLBACK', 0);
179770define('INVALIDSTATE', 0);
179771define('IN_ACCESS', 0);
179772define('IN_ALL_EVENTS', 0);
179773define('IN_ATTRIB', 0);
179774define('IN_CLOSE', 0);
179775define('IN_CLOSE_NOWRITE', 0);
179776define('IN_CLOSE_WRITE', 0);
179777define('IN_CREATE', 0);
179778define('IN_DELETE', 0);
179779define('IN_DELETE_SELF', 0);
179780define('IN_DONT_FOLLOW', 0);
179781define('IN_IGNORED', 0);
179782define('IN_ISDIR', 0);
179783define('IN_MASK_ADD', 0);
179784define('IN_MODIFY', 0);
179785define('IN_MOVE', 0);
179786define('IN_MOVED_FROM', 0);
179787define('IN_MOVED_TO', 0);
179788define('IN_MOVE_SELF', 0);
179789define('IN_ONESHOT', 0);
179790define('IN_ONLYDIR', 0);
179791define('IN_OPEN', 0);
179792define('IN_Q_OVERFLOW', 0);
179793define('IN_UNMOUNT', 0);
179794/**
179795 * Analogous to IP_MULTICAST_TTL, but for IPv6 packets. The value -1 is
179796 * also accepted, meaning the route default should be used. (added in PHP
179797 * 5.4)
179798 **/
179799define('IPV6_MULTICAST_HOPS', 0);
179800/**
179801 * The outgoing interface for IPv6 multicast packets. (added in PHP 5.4)
179802 **/
179803define('IPV6_MULTICAST_IF', 0);
179804/**
179805 * Analogous to IP_MULTICAST_LOOP, but for IPv6. (added in PHP 5.4)
179806 **/
179807define('IPV6_MULTICAST_LOOP', 0);
179808/**
179809 * The outgoing interface for IPv4 multicast packets. (added in PHP 5.4)
179810 **/
179811define('IP_MULTICAST_IF', 0);
179812/**
179813 * The multicast loopback policy for IPv4 packets, which determines
179814 * whether multicast packets sent by this socket also reach receivers in
179815 * the same host that have joined the same multicast group on the
179816 * outgoing interface used by this socket. This is the case by default.
179817 * (added in PHP 5.4)
179818 **/
179819define('IP_MULTICAST_LOOP', 0);
179820/**
179821 * The time-to-live of outgoing IPv4 multicast packets. This should be a
179822 * value between 0 (don't leave the interface) and 255. The default value
179823 * is 1 (only the local network is reached). (added in PHP 5.4)
179824 **/
179825define('IP_MULTICAST_TTL', 0);
179826define('JSON_BIGINT_AS_STRING', 0);
179827/**
179828 * Control character error, possibly incorrectly encoded
179829 **/
179830define('JSON_ERROR_CTRL_CHAR', 0);
179831/**
179832 * The maximum stack depth has been exceeded
179833 **/
179834define('JSON_ERROR_DEPTH', 0);
179835/**
179836 * One or more NAN or INF values in the value to be encoded
179837 **/
179838define('JSON_ERROR_INF_OR_NAN', 0);
179839/**
179840 * A property name that cannot be encoded was given
179841 **/
179842define('JSON_ERROR_INVALID_PROPERTY_NAME', 0);
179843/**
179844 * No error has occurred
179845 **/
179846define('JSON_ERROR_NONE', 0);
179847/**
179848 * One or more recursive references in the value to be encoded
179849 **/
179850define('JSON_ERROR_RECURSION', 0);
179851/**
179852 * Invalid or malformed JSON
179853 **/
179854define('JSON_ERROR_STATE_MISMATCH', 0);
179855/**
179856 * Syntax error
179857 **/
179858define('JSON_ERROR_SYNTAX', 0);
179859/**
179860 * A value of a type that cannot be encoded was given
179861 **/
179862define('JSON_ERROR_UNSUPPORTED_TYPE', 0);
179863/**
179864 * Malformed UTF-8 characters, possibly incorrectly encoded
179865 **/
179866define('JSON_ERROR_UTF8', 0);
179867/**
179868 * Malformed UTF-16 characters, possibly incorrectly encoded
179869 **/
179870define('JSON_ERROR_UTF16', 0);
179871define('JSON_FORCE_OBJECT', 0);
179872define('JSON_HEX_AMP', 0);
179873define('JSON_HEX_APOS', 0);
179874define('JSON_HEX_QUOT', 0);
179875define('JSON_HEX_TAG', 0);
179876define('JSON_INVALID_UTF8_IGNORE', 0);
179877define('JSON_INVALID_UTF8_SUBSTITUTE', 0);
179878define('JSON_NUMERIC_CHECK', 0);
179879define('JSON_OBJECT_AS_ARRAY', 0);
179880define('JSON_PARTIAL_OUTPUT_ON_ERROR', 0);
179881define('JSON_PRESERVE_ZERO_FRACTION', 0);
179882define('JSON_PRETTY_PRINT', 0);
179883define('JSON_THROW_ON_ERROR', 0);
179884define('JSON_UNESCAPED_LINE_TERMINATORS', 0);
179885define('JSON_UNESCAPED_SLASHES', 0);
179886define('JSON_UNESCAPED_UNICODE', 0);
179887define('LATT_HASCHILDREN', 0);
179888define('LATT_HASNOCHILDREN', 0);
179889define('LATT_MARKED', 0);
179890define('LATT_NOINFERIORS', 0);
179891define('LATT_NOSELECT', 0);
179892define('LATT_REFERRAL', 0);
179893define('LATT_UNMARKED', 0);
179894define('LC_ALL', 0);
179895define('LC_COLLATE', 0);
179896define('LC_CTYPE', 0);
179897define('LC_MESSAGES', 0);
179898define('LC_MONETARY', 0);
179899define('LC_NUMERIC', 0);
179900define('LC_TIME', 0);
179901define('LDAP_CONTROL_ASSERT', '');
179902define('LDAP_CONTROL_AUTHZID_REQUEST', '');
179903define('LDAP_CONTROL_AUTHZID_RESPONSE', '');
179904define('LDAP_CONTROL_DONTUSECOPY', '');
179905define('LDAP_CONTROL_MANAGEDSAIT', '');
179906define('LDAP_CONTROL_PAGEDRESULTS', '');
179907define('LDAP_CONTROL_PASSWORDPOLICYREQUEST', '');
179908define('LDAP_CONTROL_PASSWORDPOLICYRESPONSE', '');
179909define('LDAP_CONTROL_POST_READ', '');
179910define('LDAP_CONTROL_PRE_READ', '');
179911define('LDAP_CONTROL_PROXY_AUTHZ', '');
179912define('LDAP_CONTROL_SORTREQUEST', '');
179913define('LDAP_CONTROL_SORTRESPONSE', '');
179914define('LDAP_CONTROL_SUBENTRIES', '');
179915define('LDAP_CONTROL_SYNC', '');
179916define('LDAP_CONTROL_SYNC_DONE', '');
179917define('LDAP_CONTROL_SYNC_STATE', '');
179918define('LDAP_CONTROL_VALUESRETURNFILTER', '');
179919define('LDAP_CONTROL_VLVREQUEST', '');
179920define('LDAP_CONTROL_VLVRESPONSE', '');
179921define('LDAP_CONTROL_X_DOMAIN_SCOPE', '');
179922define('LDAP_CONTROL_X_EXTENDED_DN', '');
179923define('LDAP_CONTROL_X_INCREMENTAL_VALUES', '');
179924define('LDAP_CONTROL_X_PERMISSIVE_MODIFY', '');
179925define('LDAP_CONTROL_X_SEARCH_OPTIONS', '');
179926define('LDAP_CONTROL_X_TREE_DELETE', '');
179927define('LDAP_DEREF_ALWAYS', 0);
179928define('LDAP_DEREF_FINDING', 0);
179929define('LDAP_DEREF_NEVER', 0);
179930define('LDAP_DEREF_SEARCHING', 0);
179931define('LDAP_EXOP_MODIFY_PASSWD', '');
179932define('LDAP_EXOP_REFRESH', '');
179933define('LDAP_EXOP_START_TLS', '');
179934define('LDAP_EXOP_TURN', '');
179935define('LDAP_EXOP_WHO_AM_I', '');
179936/**
179937 * array
179938 **/
179939define('LDAP_OPT_CLIENT_CONTROLS', 0);
179940define('LDAP_OPT_DEBUG_LEVEL', 0);
179941/**
179942 * integer
179943 **/
179944define('LDAP_OPT_DEREF', 0);
179945/**
179946 * integer
179947 **/
179948define('LDAP_OPT_DIAGNOSTIC_MESSAGE', 0);
179949/**
179950 * integer
179951 **/
179952define('LDAP_OPT_ERROR_NUMBER', 0);
179953/**
179954 * string
179955 **/
179956define('LDAP_OPT_ERROR_STRING', 0);
179957/**
179958 * string
179959 **/
179960define('LDAP_OPT_HOST_NAME', 0);
179961/**
179962 * string
179963 **/
179964define('LDAP_OPT_MATCHED_DN', 0);
179965/**
179966 * integer
179967 **/
179968define('LDAP_OPT_NETWORK_TIMEOUT', 0);
179969/**
179970 * integer
179971 **/
179972define('LDAP_OPT_PROTOCOL_VERSION', 0);
179973/**
179974 * bool
179975 **/
179976define('LDAP_OPT_REFERRALS', 0);
179977/**
179978 * bool
179979 **/
179980define('LDAP_OPT_RESTART', 0);
179981/**
179982 * array
179983 **/
179984define('LDAP_OPT_SERVER_CONTROLS', 0);
179985/**
179986 * integer
179987 **/
179988define('LDAP_OPT_SIZELIMIT', 0);
179989/**
179990 * integer
179991 **/
179992define('LDAP_OPT_TIMELIMIT', 0);
179993/**
179994 * int
179995 **/
179996define('LDAP_OPT_X_KEEPALIVE_IDLE', 0);
179997/**
179998 * int
179999 **/
180000define('LDAP_OPT_X_KEEPALIVE_INTERVAL', 0);
180001/**
180002 * int
180003 **/
180004define('LDAP_OPT_X_KEEPALIVE_PROBES', 0);
180005/**
180006 * string
180007 **/
180008define('LDAP_OPT_X_TLS_CACERTDIR', 0);
180009/**
180010 * string
180011 **/
180012define('LDAP_OPT_X_TLS_CACERTFILE', 0);
180013/**
180014 * string
180015 **/
180016define('LDAP_OPT_X_TLS_CERTFILE', 0);
180017/**
180018 * string
180019 **/
180020define('LDAP_OPT_X_TLS_CIPHER_SUITE', 0);
180021/**
180022 * integer
180023 **/
180024define('LDAP_OPT_X_TLS_CRLCHECK', 0);
180025/**
180026 * string
180027 **/
180028define('LDAP_OPT_X_TLS_CRLFILE', 0);
180029/**
180030 * integer
180031 **/
180032define('LDAP_OPT_X_TLS_CRL_ALL', 0);
180033/**
180034 * integer
180035 **/
180036define('LDAP_OPT_X_TLS_CRL_NONE', 0);
180037/**
180038 * integer
180039 **/
180040define('LDAP_OPT_X_TLS_CRL_PEER', 0);
180041/**
180042 * string
180043 **/
180044define('LDAP_OPT_X_TLS_DHFILE', 0);
180045/**
180046 * string
180047 **/
180048define('LDAP_OPT_X_TLS_KEYFILE', 0);
180049/**
180050 * string
180051 **/
180052define('LDAP_OPT_X_TLS_KEYILE', 0);
180053/**
180054 * string
180055 **/
180056define('LDAP_OPT_X_TLS_PACKAGE', 0);
180057/**
180058 * integer
180059 **/
180060define('LDAP_OPT_X_TLS_PROTOCOL_MIN', 0);
180061/**
180062 * string
180063 **/
180064define('LDAP_OPT_X_TLS_RANDOM_FILE', 0);
180065/**
180066 * integer
180067 **/
180068define('LDAP_OPT_X_TLS_REQUIRE_CERT', 0);
180069define('LIBEXSLT_DOTTED_VERSION', '');
180070define('LIBEXSLT_VERSION', 0);
180071define('LIBXML_BIGLINES', 0);
180072define('LIBXML_COMPACT', 0);
180073define('LIBXML_DOTTED_VERSION', '');
180074define('LIBXML_DTDATTR', 0);
180075define('LIBXML_DTDLOAD', 0);
180076define('LIBXML_DTDVALID', 0);
180077define('LIBXML_ERR_ERROR', 0);
180078define('LIBXML_ERR_FATAL', 0);
180079define('LIBXML_ERR_NONE', 0);
180080define('LIBXML_ERR_WARNING', 0);
180081define('LIBXML_HTML_NODEFDTD', 0);
180082define('LIBXML_HTML_NOIMPLIED', 0);
180083define('LIBXML_NOBLANKS', 0);
180084define('LIBXML_NOCDATA', 0);
180085define('LIBXML_NOEMPTYTAG', 0);
180086define('LIBXML_NOENT', 0);
180087define('LIBXML_NOERROR', 0);
180088define('LIBXML_NONET', 0);
180089define('LIBXML_NOWARNING', 0);
180090define('LIBXML_NOXMLDECL', 0);
180091define('LIBXML_NSCLEAN', 0);
180092define('LIBXML_PARSEHUGE', 0);
180093define('LIBXML_PEDANTIC', 0);
180094define('LIBXML_SCHEMA_CREATE', 0);
180095define('LIBXML_VERSION', 0);
180096define('LIBXML_XINCLUDE', 0);
180097define('LIBXSLT_DOTTED_VERSION', '');
180098define('LIBXSLT_VERSION', 0);
180099/**
180100 * Acquire an exclusive lock on the file while proceeding to the writing.
180101 * In other words, a {@link flock} call happens between the {@link fopen}
180102 * call and the {@link fwrite} call. This is not identical to an {@link
180103 * fopen} call with mode "x".
180104 **/
180105define('LOCK_EX', 0);
180106define('LOCK_NB', 0);
180107define('LOCK_SH', 0);
180108define('LOCK_UN', 0);
180109/**
180110 * action must be taken immediately
180111 **/
180112define('LOG_ALERT', 0);
180113/**
180114 * security/authorization messages (use LOG_AUTHPRIV instead in systems
180115 * where that constant is defined)
180116 **/
180117define('LOG_AUTH', 0);
180118/**
180119 * security/authorization messages (private)
180120 **/
180121define('LOG_AUTHPRIV', 0);
180122/**
180123 * if there is an error while sending data to the system logger, write
180124 * directly to the system console
180125 **/
180126define('LOG_CONS', 0);
180127/**
180128 * critical conditions
180129 **/
180130define('LOG_CRIT', 0);
180131/**
180132 * clock daemon (cron and at)
180133 **/
180134define('LOG_CRON', 0);
180135/**
180136 * other system daemons
180137 **/
180138define('LOG_DAEMON', 0);
180139/**
180140 * debug-level message
180141 **/
180142define('LOG_DEBUG', 0);
180143/**
180144 * system is unusable
180145 **/
180146define('LOG_EMERG', 0);
180147/**
180148 * error conditions
180149 **/
180150define('LOG_ERR', 0);
180151/**
180152 * informational message
180153 **/
180154define('LOG_INFO', 0);
180155/**
180156 * kernel messages
180157 **/
180158define('LOG_KERN', 0);
180159define('LOG_LEVEL_DEBUG', 0);
180160define('LOG_LEVEL_ERROR', 0);
180161define('LOG_LEVEL_INFO', 0);
180162define('LOG_LEVEL_WARN', 0);
180163/**
180164 * reserved for local use, these are not available in Windows
180165 **/
180166define('LOG_LOCAL0', 0);
180167define('LOG_LOCAL1', 0);
180168define('LOG_LOCAL2', 0);
180169define('LOG_LOCAL3', 0);
180170define('LOG_LOCAL4', 0);
180171define('LOG_LOCAL5', 0);
180172define('LOG_LOCAL6', 0);
180173define('LOG_LOCAL7', 0);
180174/**
180175 * line printer subsystem
180176 **/
180177define('LOG_LPR', 0);
180178/**
180179 * mail subsystem
180180 **/
180181define('LOG_MAIL', 0);
180182/**
180183 * open the connection to the logger immediately
180184 **/
180185define('LOG_NDELAY', 0);
180186/**
180187 * USENET news subsystem
180188 **/
180189define('LOG_NEWS', 0);
180190/**
180191 * normal, but significant, condition
180192 **/
180193define('LOG_NOTICE', 0);
180194define('LOG_NOWAIT', 0);
180195/**
180196 * (default) delay opening the connection until the first message is
180197 * logged
180198 **/
180199define('LOG_ODELAY', 0);
180200/**
180201 * print log message also to standard error
180202 **/
180203define('LOG_PERROR', 0);
180204/**
180205 * include PID with each message
180206 **/
180207define('LOG_PID', 0);
180208/**
180209 * messages generated internally by syslogd
180210 **/
180211define('LOG_SYSLOG', 0);
180212/**
180213 * generic user-level messages
180214 **/
180215define('LOG_USER', 0);
180216/**
180217 * UUCP subsystem
180218 **/
180219define('LOG_UUCP', 0);
180220/**
180221 * warning conditions
180222 **/
180223define('LOG_WARNING', 0);
180224define('MAILPARSE_EXTRACT_OUTPUT', 0);
180225define('MAILPARSE_EXTRACT_RETURN', 0);
180226define('MAILPARSE_EXTRACT_STREAM', 0);
180227define('MARSHALLINGERROR', 0);
180228define('MATCH', 0);
180229/**
180230 * The application to be connected to the database.
180231 **/
180232define('MAXDB_APPLICATION', 0);
180233/**
180234 * The version of the application.
180235 **/
180236define('MAXDB_APPVERSION', 0);
180237/**
180238 * The component name used to initialise the SQLDBC runtime environment.
180239 **/
180240define('MAXDB_COMPNAME', 0);
180241/**
180242 * The prefix to use for result tables that are automatically named.
180243 **/
180244define('MAXDB_CURSORPREFIX', 0);
180245/**
180246 * Specifies whether and how shared locks and exclusive locks are
180247 * implicitly requested or released.
180248 **/
180249define('MAXDB_ISOLATIONLEVEL', 0);
180250/**
180251 * The number of different request packets used for the connection.
180252 **/
180253define('MAXDB_PACKETCOUNT', 0);
180254/**
180255 * The SQL mode.
180256 **/
180257define('MAXDB_SQLMODE', 0);
180258/**
180259 * The number of prepared statements to be cached for the connection for
180260 * re-use.
180261 **/
180262define('MAXDB_STATEMENTCACHESIZE', 0);
180263/**
180264 * The maximum allowed time of inactivity after which the connection to
180265 * the database is closed by the system.
180266 **/
180267define('MAXDB_TIMEOUT', 0);
180268/**
180269 * TRUE, if the connection is an unicode (UCS2) client or FALSE, if not.
180270 **/
180271define('MAXDB_UNICODE', 0);
180272define('MB_CASE_FOLD', 0);
180273define('MB_CASE_FOLD_SIMPLE', 0);
180274define('MB_CASE_LOWER', 0);
180275define('MB_CASE_LOWER_SIMPLE', 0);
180276define('MB_CASE_TITLE', 0);
180277define('MB_CASE_TITLE_SIMPLE', 0);
180278define('MB_CASE_UPPER', 0);
180279define('MB_CASE_UPPER_SIMPLE', 0);
180280define('MB_ONIGURUMA_VERSION', '');
180281define('MB_OVERLOAD_MAIL', 0);
180282define('MB_OVERLOAD_REGEX', 0);
180283define('MB_OVERLOAD_STRING', 0);
180284/**
180285 * Blocks packets arriving from a specific source to a specific multicast
180286 * group, which must have been previously joined. (added in PHP 5.4)
180287 **/
180288define('MCAST_BLOCK_SOURCE', 0);
180289/**
180290 * Joins a multicast group. (added in PHP 5.4)
180291 **/
180292define('MCAST_JOIN_GROUP', 0);
180293/**
180294 * Receive packets destined to a specific multicast group whose source
180295 * address matches a specific value. (added in PHP 5.4)
180296 **/
180297define('MCAST_JOIN_SOURCE_GROUP', 0);
180298/**
180299 * Leaves a multicast group. (added in PHP 5.4)
180300 **/
180301define('MCAST_LEAVE_GROUP', 0);
180302/**
180303 * Stop receiving packets destined to a specific multicast group whose
180304 * source address matches a specific value. (added in PHP 5.4)
180305 **/
180306define('MCAST_LEAVE_SOURCE_GROUP', 0);
180307/**
180308 * Unblocks (start receiving again) packets arriving from a specific
180309 * source address to a specific multicast group, which must have been
180310 * previously joined. (added in PHP 5.4)
180311 **/
180312define('MCAST_UNBLOCK_SOURCE', 0);
180313define('MCRYPT_3DES', 0);
180314define('MCRYPT_ARCFOUR', 0);
180315define('MCRYPT_ARCFOUR_IV', 0);
180316define('MCRYPT_BLOWFISH', 0);
180317define('MCRYPT_CAST_128', 0);
180318define('MCRYPT_CAST_256', 0);
180319define('MCRYPT_CRYPT', 0);
180320define('MCRYPT_DECRYPT', 0);
180321define('MCRYPT_DES', 0);
180322define('MCRYPT_DES_COMPAT', 0);
180323define('MCRYPT_DEV_RANDOM', 0);
180324define('MCRYPT_DEV_URANDOM', 0);
180325define('MCRYPT_ENCRYPT', 0);
180326define('MCRYPT_ENIGMA', 0);
180327define('MCRYPT_GOST', 0);
180328define('MCRYPT_IDEA', 0);
180329define('MCRYPT_LOKI97', 0);
180330define('MCRYPT_MARS', 0);
180331define('MCRYPT_MODE_CBC', 0);
180332define('MCRYPT_MODE_CFB', 0);
180333define('MCRYPT_MODE_ECB', 0);
180334define('MCRYPT_MODE_NOFB', 0);
180335define('MCRYPT_MODE_OFB', 0);
180336define('MCRYPT_MODE_STREAM', 0);
180337define('MCRYPT_PANAMA', 0);
180338define('MCRYPT_RAND', 0);
180339define('MCRYPT_RC2', 0);
180340define('MCRYPT_RC4', 0);
180341define('MCRYPT_RC6', 0);
180342define('MCRYPT_RC6_128', 0);
180343define('MCRYPT_RC6_192', 0);
180344define('MCRYPT_RC6_256', 0);
180345define('MCRYPT_RIJNDAEL_128', 0);
180346define('MCRYPT_RIJNDAEL_192', 0);
180347define('MCRYPT_RIJNDAEL_256', 0);
180348define('MCRYPT_SAFER64', 0);
180349define('MCRYPT_SAFER128', 0);
180350define('MCRYPT_SAFERPLUS', 0);
180351define('MCRYPT_SERPENT', 0);
180352define('MCRYPT_SERPENT_128', 0);
180353define('MCRYPT_SERPENT_192', 0);
180354define('MCRYPT_SERPENT_256', 0);
180355define('MCRYPT_SKIPJACK', 0);
180356define('MCRYPT_TEAN', 0);
180357define('MCRYPT_THREEWAY', 0);
180358define('MCRYPT_TRIPLEDES', 0);
180359define('MCRYPT_TWOFISH', 0);
180360define('MCRYPT_TWOFISH128', 0);
180361define('MCRYPT_TWOFISH192', 0);
180362define('MCRYPT_TWOFISH256', 0);
180363define('MCRYPT_WAKE', 0);
180364define('MCRYPT_XTEA', 0);
180365define('MEMCACHE_COMPRESSED', 0);
180366define('MEMCACHE_HAVE_SESSION', 0);
180367define('MEMCACHE_USER1', 0);
180368define('MEMCACHE_USER2', 0);
180369define('MEMCACHE_USER3', 0);
180370define('MEMCACHE_USER4', 0);
180371define('MEMORY_TRACE', 0);
180372define('MHASH_ADLER32', 0);
180373define('MHASH_CRC32', 0);
180374define('MHASH_CRC32B', 0);
180375define('MHASH_GOST', 0);
180376define('MHASH_HAVAL128', 0);
180377define('MHASH_HAVAL160', 0);
180378define('MHASH_HAVAL192', 0);
180379define('MHASH_HAVAL224', 0);
180380define('MHASH_HAVAL256', 0);
180381define('MHASH_MD2', 0);
180382define('MHASH_MD4', 0);
180383define('MHASH_MD5', 0);
180384define('MHASH_RIPEMD128', 0);
180385define('MHASH_RIPEMD256', 0);
180386define('MHASH_RIPEMD320', 0);
180387define('MHASH_SHA1', 0);
180388define('MHASH_SHA192', 0);
180389define('MHASH_SHA224', 0);
180390define('MHASH_SHA256', 0);
180391define('MHASH_SHA384', 0);
180392define('MHASH_SHA512', 0);
180393define('MHASH_SNEFRU128', 0);
180394define('MHASH_SNEFRU256', 0);
180395define('MHASH_TIGER', 0);
180396define('MHASH_TIGER128', 0);
180397define('MHASH_TIGER160', 0);
180398define('MHASH_WHIRLPOOL', 0);
180399define('MING_NEW', 0);
180400define('MING_ZLIB', 0);
180401/**
180402 * iMoniker COM status code, return on errors where the function call
180403 * failed due to unavailability.
180404 **/
180405define('MK_E_UNAVAILABLE', 0);
180406define('MONGODB_STABILITY', '');
180407define('MONGODB_VERSION', '');
180408define('MONGO_STREAMS', 0);
180409define('MONGO_STREAM_NOTIFY_IO_COMPLETED', 0);
180410define('MONGO_STREAM_NOTIFY_IO_PROGRESS', 0);
180411define('MONGO_STREAM_NOTIFY_IO_READ', 0);
180412define('MONGO_STREAM_NOTIFY_IO_WRITE', 0);
180413define('MONGO_STREAM_NOTIFY_LOG_BATCHINSERT', 0);
180414define('MONGO_STREAM_NOTIFY_LOG_CMD_DELETE', 0);
180415define('MONGO_STREAM_NOTIFY_LOG_CMD_INSERT', 0);
180416define('MONGO_STREAM_NOTIFY_LOG_CMD_UPDATE', 0);
180417define('MONGO_STREAM_NOTIFY_LOG_DELETE', 0);
180418define('MONGO_STREAM_NOTIFY_LOG_GETMORE', 0);
180419define('MONGO_STREAM_NOTIFY_LOG_INSERT', 0);
180420define('MONGO_STREAM_NOTIFY_LOG_KILLCURSOR', 0);
180421define('MONGO_STREAM_NOTIFY_LOG_QUERY', 0);
180422define('MONGO_STREAM_NOTIFY_LOG_RESPONSE_HEADER', 0);
180423define('MONGO_STREAM_NOTIFY_LOG_UPDATE', 0);
180424define('MONGO_STREAM_NOTIFY_LOG_WRITE_BATCH', 0);
180425define('MONGO_STREAM_NOTIFY_LOG_WRITE_REPLY', 0);
180426define('MONGO_STREAM_NOTIFY_TYPE_IO_INIT', 0);
180427define('MONGO_STREAM_NOTIFY_TYPE_LOG', 0);
180428define('MONGO_SUPPORTS_AUTH_MECHANISM_GSSAPI', 0);
180429define('MONGO_SUPPORTS_AUTH_MECHANISM_MONGODB_CR', 0);
180430define('MONGO_SUPPORTS_AUTH_MECHANISM_MONGODB_X509', 0);
180431define('MONGO_SUPPORTS_AUTH_MECHANISM_PLAIN', 0);
180432define('MONGO_SUPPORTS_SSL', 0);
180433define('MONGO_SUPPORTS_STREAMS', 0);
180434/**
180435 * Name of the n-th month of the year.
180436 **/
180437define('MON_1', 0);
180438/**
180439 * Name of the n-th month of the year.
180440 **/
180441define('MON_2', 0);
180442/**
180443 * Name of the n-th month of the year.
180444 **/
180445define('MON_3', 0);
180446/**
180447 * Name of the n-th month of the year.
180448 **/
180449define('MON_4', 0);
180450/**
180451 * Name of the n-th month of the year.
180452 **/
180453define('MON_5', 0);
180454/**
180455 * Name of the n-th month of the year.
180456 **/
180457define('MON_6', 0);
180458/**
180459 * Name of the n-th month of the year.
180460 **/
180461define('MON_7', 0);
180462/**
180463 * Name of the n-th month of the year.
180464 **/
180465define('MON_8', 0);
180466/**
180467 * Name of the n-th month of the year.
180468 **/
180469define('MON_9', 0);
180470/**
180471 * Name of the n-th month of the year.
180472 **/
180473define('MON_10', 0);
180474/**
180475 * Name of the n-th month of the year.
180476 **/
180477define('MON_11', 0);
180478/**
180479 * Name of the n-th month of the year.
180480 **/
180481define('MON_12', 0);
180482/**
180483 * Decimal point character.
180484 **/
180485define('MON_DECIMAL_POINT', 0);
180486/**
180487 * Like "grouping" element.
180488 **/
180489define('MON_GROUPING', 0);
180490/**
180491 * Thousands separator (groups of three digits).
180492 **/
180493define('MON_THOUSANDS_SEP', 0);
180494/**
180495 * Bypass routing, use direct interface.
180496 **/
180497define('MSG_DONTROUTE', 0);
180498/**
180499 * With this flag set, the function returns even if it would normally
180500 * have blocked.
180501 **/
180502define('MSG_DONTWAIT', 0);
180503/**
180504 * Close the sender side of the socket and include an appropriate
180505 * notification of this at the end of the sent data. The sent data
180506 * completes the transaction.
180507 **/
180508define('MSG_EOF', 0);
180509/**
180510 * Indicate a record mark. The sent data completes the record.
180511 **/
180512define('MSG_EOR', 0);
180513/**
180514 * Using this flag in combination with a {@link desiredmsgtype} greater
180515 * than 0 will cause the function to receive the first message that is
180516 * not equal to {@link desiredmsgtype}.
180517 **/
180518define('MSG_EXCEPT', 0);
180519/**
180520 * If there are no messages of the {@link desiredmsgtype}, return
180521 * immediately and do not wait. The function will fail and return an
180522 * integer value corresponding to MSG_ENOMSG.
180523 **/
180524define('MSG_IPC_NOWAIT', 0);
180525/**
180526 * If the message is longer than {@link maxsize}, setting this flag will
180527 * truncate the message to {@link maxsize} and will not signal an error.
180528 **/
180529define('MSG_NOERROR', 0);
180530/**
180531 * Send OOB (out-of-band) data.
180532 **/
180533define('MSG_OOB', 0);
180534/**
180535 * Receive data from the beginning of the receive queue without removing
180536 * it from the queue.
180537 **/
180538define('MSG_PEEK', 0);
180539/**
180540 * Block until at least {@link len} are received. However, if a signal is
180541 * caught or the remote host disconnects, the function may return less
180542 * data.
180543 **/
180544define('MSG_WAITALL', 0);
180545define('MSQL_ASSOC', 0);
180546define('MSQL_BOTH', 0);
180547define('MSQL_NUM', 0);
180548define('MSSQL_ASSOC', 0);
180549define('MSSQL_BOTH', 0);
180550define('MSSQL_NUM', 0);
180551/**
180552 * Uses the fixed, correct, Mersenne Twister implementation, available as
180553 * of PHP 7.1.0.
180554 **/
180555define('MT_RAND_MT19937', 0);
180556/**
180557 * Uses an incorrect Mersenne Twister implementation which was used as
180558 * the default up till PHP 7.1.0. This mode is available for backward
180559 * compatibility.
180560 **/
180561define('MT_RAND_PHP', 0);
180562define('MYSQLI_ASSOC', 0);
180563define('MYSQLI_AUTO_INCREMENT_FLAG', 0);
180564define('MYSQLI_BINARY_FLAG', 0);
180565define('MYSQLI_BLOB_FLAG', 0);
180566define('MYSQLI_BOTH', 0);
180567/**
180568 * Use compression protocol
180569 **/
180570define('MYSQLI_CLIENT_COMPRESS', 0);
180571/**
180572 * return number of matched rows, not the number of affected rows
180573 **/
180574define('MYSQLI_CLIENT_FOUND_ROWS', 0);
180575/**
180576 * Allow spaces after function names. Makes all function names reserved
180577 * words.
180578 **/
180579define('MYSQLI_CLIENT_IGNORE_SPACE', 0);
180580/**
180581 * Allow interactive_timeout seconds (instead of wait_timeout seconds) of
180582 * inactivity before closing the connection
180583 **/
180584define('MYSQLI_CLIENT_INTERACTIVE', 0);
180585define('MYSQLI_CLIENT_MULTI_QUERIES', 0);
180586define('MYSQLI_CLIENT_NO_SCHEMA', 0);
180587/**
180588 * Use SSL (encryption)
180589 **/
180590define('MYSQLI_CLIENT_SSL', 0);
180591/**
180592 * Like MYSQLI_CLIENT_SSL, but disables validation of the provided SSL
180593 * certificate. This is only for installations using MySQL Native Driver
180594 * and MySQL 5.6 or later.
180595 **/
180596define('MYSQLI_CLIENT_SSL_DONT_VERIFY_SERVER_CERT', 0);
180597define('MYSQLI_CURSOR_TYPE_FOR_UPDATE', 0);
180598define('MYSQLI_CURSOR_TYPE_NO_CURSOR', 0);
180599define('MYSQLI_CURSOR_TYPE_READ_ONLY', 0);
180600define('MYSQLI_CURSOR_TYPE_SCROLLABLE', 0);
180601define('MYSQLI_DATA_TRUNCATED', 0);
180602define('MYSQLI_DEBUG_TRACE_ENABLED', 0);
180603define('MYSQLI_ENUM_FLAG', 0);
180604define('MYSQLI_GROUP_FLAG', 0);
180605/**
180606 * command to execute after when connecting to MySQL server
180607 **/
180608define('MYSQLI_INIT_COMMAND', 0);
180609define('MYSQLI_MULTIPLE_KEY_FLAG', 0);
180610define('MYSQLI_NEED_DATA', 0);
180611define('MYSQLI_NOT_NULL_FLAG', 0);
180612define('MYSQLI_NO_DATA', 0);
180613define('MYSQLI_NUM', 0);
180614define('MYSQLI_NUM_FLAG', 0);
180615/**
180616 * connection timeout in seconds (supported on Windows with TCP/IP since
180617 * PHP 5.3.1)
180618 **/
180619define('MYSQLI_OPT_CONNECT_TIMEOUT', 0);
180620/**
180621 * Convert integer and float columns back to PHP numbers. Only valid for
180622 * mysqlnd. Available since PHP 5.3.0.
180623 **/
180624define('MYSQLI_OPT_INT_AND_FLOAT_NATIVE', 0);
180625/**
180626 * enable/disable use of LOAD LOCAL INFILE
180627 **/
180628define('MYSQLI_OPT_LOCAL_INFILE', 0);
180629/**
180630 * The size of the internal command/network buffer. Only valid for
180631 * mysqlnd. Available since PHP 5.3.0.
180632 **/
180633define('MYSQLI_OPT_NET_CMD_BUFFER_SIZE', 0);
180634/**
180635 * Maximum read chunk size in bytes when reading the body of a MySQL
180636 * command packet. Only valid for mysqlnd. Available since PHP 5.3.0.
180637 **/
180638define('MYSQLI_OPT_NET_READ_BUFFER_SIZE', 0);
180639/**
180640 * Available since PHP 5.3.0.
180641 **/
180642define('MYSQLI_OPT_SSL_VERIFY_SERVER_CERT', 0);
180643define('MYSQLI_PART_KEY_FLAG', 0);
180644define('MYSQLI_PRI_KEY_FLAG', 0);
180645/**
180646 * Read options from named option file instead of my.cnf
180647 **/
180648define('MYSQLI_READ_DEFAULT_FILE', 0);
180649/**
180650 * Read options from the named group from my.cnf or the file specified
180651 * with MYSQL_READ_DEFAULT_FILE.
180652 **/
180653define('MYSQLI_READ_DEFAULT_GROUP', 0);
180654define('MYSQLI_REFRESH_GRANT', 0);
180655define('MYSQLI_REFRESH_HOSTS', 0);
180656define('MYSQLI_REFRESH_LOG', 0);
180657define('MYSQLI_REFRESH_MASTER', 0);
180658define('MYSQLI_REFRESH_SLAVE', 0);
180659define('MYSQLI_REFRESH_STATUS', 0);
180660define('MYSQLI_REFRESH_TABLES', 0);
180661define('MYSQLI_REFRESH_THREADS', 0);
180662/**
180663 * Set all options (report all)
180664 **/
180665define('MYSQLI_REPORT_ALL', 0);
180666/**
180667 * Report errors from mysqli function calls
180668 **/
180669define('MYSQLI_REPORT_ERROR', 0);
180670/**
180671 * Report if no index or bad index was used in a query
180672 **/
180673define('MYSQLI_REPORT_INDEX', 0);
180674/**
180675 * Turns reporting off
180676 **/
180677define('MYSQLI_REPORT_OFF', 0);
180678/**
180679 * Throw mysqli_sql_exception for errors instead of warnings
180680 **/
180681define('MYSQLI_REPORT_STRICT', 0);
180682/**
180683 * RSA public key file used with the SHA-256 based authentication.
180684 * Available since PHP 5.5.0.
180685 **/
180686define('MYSQLI_SERVER_PUBLIC_KEY', 0);
180687define('MYSQLI_SERVER_QUERY_NO_GOOD_INDEX_USED', 0);
180688define('MYSQLI_SERVER_QUERY_NO_INDEX_USED', 0);
180689define('MYSQLI_SET_CHARSET_NAME', 0);
180690define('MYSQLI_SET_FLAG', 0);
180691define('MYSQLI_STMT_ATTR_CURSOR_TYPE', 0);
180692define('MYSQLI_STMT_ATTR_PREFETCH_ROWS', 0);
180693define('MYSQLI_STMT_ATTR_UPDATE_MAX_LENGTH', 0);
180694define('MYSQLI_STORE_RESULT', 0);
180695/**
180696 * Copy results from the internal mysqlnd buffer into the PHP variables
180697 * fetched. By default, mysqlnd will use a reference logic to avoid
180698 * copying and duplicating results held in memory. For certain result
180699 * sets, for example, result sets with many small rows, the copy approach
180700 * can reduce the overall memory usage because PHP variables holding
180701 * results may be released earlier (available with mysqlnd only, since
180702 * PHP 5.6.0)
180703 **/
180704define('MYSQLI_STORE_RESULT_COPY_DATA', 0);
180705define('MYSQLI_TIMESTAMP_FLAG', 0);
180706define('MYSQLI_TRANS_COR_AND_CHAIN', 0);
180707define('MYSQLI_TRANS_COR_AND_NO_CHAIN', 0);
180708define('MYSQLI_TRANS_COR_NO_RELEASE', 0);
180709define('MYSQLI_TRANS_COR_RELEASE', 0);
180710define('MYSQLI_TRANS_START_CONSISTENT_SNAPSHOT', 0);
180711define('MYSQLI_TRANS_START_READ_ONLY', 0);
180712define('MYSQLI_TRANS_START_READ_WRITE', 0);
180713define('MYSQLI_TYPE_BIT', 0);
180714define('MYSQLI_TYPE_BLOB', 0);
180715define('MYSQLI_TYPE_CHAR', 0);
180716define('MYSQLI_TYPE_DATE', 0);
180717define('MYSQLI_TYPE_DATETIME', 0);
180718define('MYSQLI_TYPE_DECIMAL', 0);
180719define('MYSQLI_TYPE_DOUBLE', 0);
180720define('MYSQLI_TYPE_ENUM', 0);
180721define('MYSQLI_TYPE_FLOAT', 0);
180722define('MYSQLI_TYPE_GEOMETRY', 0);
180723define('MYSQLI_TYPE_INT24', 0);
180724define('MYSQLI_TYPE_INTERVAL', 0);
180725define('MYSQLI_TYPE_LONG', 0);
180726define('MYSQLI_TYPE_LONGLONG', 0);
180727define('MYSQLI_TYPE_LONG_BLOB', 0);
180728define('MYSQLI_TYPE_MEDIUM_BLOB', 0);
180729define('MYSQLI_TYPE_NEWDATE', 0);
180730define('MYSQLI_TYPE_NEWDECIMAL', 0);
180731define('MYSQLI_TYPE_NULL', 0);
180732define('MYSQLI_TYPE_SET', 0);
180733define('MYSQLI_TYPE_SHORT', 0);
180734define('MYSQLI_TYPE_STRING', 0);
180735define('MYSQLI_TYPE_TIME', 0);
180736define('MYSQLI_TYPE_TIMESTAMP', 0);
180737define('MYSQLI_TYPE_TINY', 0);
180738define('MYSQLI_TYPE_TINY_BLOB', 0);
180739define('MYSQLI_TYPE_VAR_STRING', 0);
180740define('MYSQLI_TYPE_YEAR', 0);
180741define('MYSQLI_UNIQUE_KEY_FLAG', 0);
180742define('MYSQLI_UNSIGNED_FLAG', 0);
180743define('MYSQLI_USE_RESULT', 0);
180744define('MYSQLI_ZEROFILL_FLAG', 0);
180745define('MYSQLND_MEMCACHE_DEFAULT_REGEXP', '');
180746define('MYSQLND_MEMCACHE_VERSION', '');
180747define('MYSQLND_MEMCACHE_VERSION_ID', 0);
180748define('MYSQLND_MS_LAST_USED_SWITCH', '');
180749define('MYSQLND_MS_MASTER_SWITCH', '');
180750define('MYSQLND_MS_QOS_CONSISTENCY_EVENTUAL', 0);
180751define('MYSQLND_MS_QOS_CONSISTENCY_SESSION', 0);
180752define('MYSQLND_MS_QOS_CONSISTENCY_STRONG', 0);
180753define('MYSQLND_MS_QOS_OPTION_AGE', 0);
180754define('MYSQLND_MS_QOS_OPTION_GTID', 0);
180755define('MYSQLND_MS_QUERY_USE_LAST_USED', 0);
180756define('MYSQLND_MS_QUERY_USE_MASTER', 0);
180757define('MYSQLND_MS_QUERY_USE_SLAVE', 0);
180758define('MYSQLND_MS_SLAVE_SWITCH', '');
180759define('MYSQLND_MS_VERSION', '');
180760define('MYSQLND_MS_VERSION_ID', 0);
180761define('MYSQLND_MUX_VERSION', '');
180762define('MYSQLND_MUX_VERSION_ID', 0);
180763define('MYSQLND_QC_CONDITION_META_SCHEMA_PATTERN', 0);
180764define('MYSQLND_QC_DISABLE_SWITCH', '');
180765define('MYSQLND_QC_ENABLE_SWITCH', '');
180766define('MYSQLND_QC_SERVER_ID_SWITCH', '');
180767define('MYSQLND_QC_TTL_SWITCH', '');
180768define('MYSQLND_QC_VERSION', '');
180769define('MYSQLND_QC_VERSION_ID', 0);
180770define('MYSQLND_UH_MYSQLND_CHG_USER_RESP_PACKET', 0);
180771define('MYSQLND_UH_MYSQLND_CLOSE_DISCONNECTED', 0);
180772define('MYSQLND_UH_MYSQLND_CLOSE_EXPLICIT', 0);
180773define('MYSQLND_UH_MYSQLND_CLOSE_IMPLICIT', 0);
180774define('MYSQLND_UH_MYSQLND_CLOSE_LAST', 0);
180775define('MYSQLND_UH_MYSQLND_COM_BINLOG_DUMP', 0);
180776define('MYSQLND_UH_MYSQLND_COM_CHANGE_USER', 0);
180777define('MYSQLND_UH_MYSQLND_COM_CONNECT', 0);
180778define('MYSQLND_UH_MYSQLND_COM_CONNECT_OUT', 0);
180779define('MYSQLND_UH_MYSQLND_COM_CREATE_DB', 0);
180780define('MYSQLND_UH_MYSQLND_COM_DAEMON', 0);
180781define('MYSQLND_UH_MYSQLND_COM_DEBUG', 0);
180782define('MYSQLND_UH_MYSQLND_COM_DELAYED_INSERT', 0);
180783define('MYSQLND_UH_MYSQLND_COM_DROP_DB', 0);
180784define('MYSQLND_UH_MYSQLND_COM_END', 0);
180785define('MYSQLND_UH_MYSQLND_COM_FIELD_LIST', 0);
180786define('MYSQLND_UH_MYSQLND_COM_INIT_DB', 0);
180787define('MYSQLND_UH_MYSQLND_COM_PING', 0);
180788define('MYSQLND_UH_MYSQLND_COM_PROCESS_INFO', 0);
180789define('MYSQLND_UH_MYSQLND_COM_PROCESS_KILL', 0);
180790define('MYSQLND_UH_MYSQLND_COM_QUERY', 0);
180791define('MYSQLND_UH_MYSQLND_COM_QUIT', 0);
180792define('MYSQLND_UH_MYSQLND_COM_REFRESH', 0);
180793define('MYSQLND_UH_MYSQLND_COM_REGISTER_SLAVED', 0);
180794define('MYSQLND_UH_MYSQLND_COM_SET_OPTION', 0);
180795define('MYSQLND_UH_MYSQLND_COM_SHUTDOWN', 0);
180796define('MYSQLND_UH_MYSQLND_COM_SLEEP', 0);
180797define('MYSQLND_UH_MYSQLND_COM_STATISTICS', 0);
180798define('MYSQLND_UH_MYSQLND_COM_STMT_CLOSE', 0);
180799define('MYSQLND_UH_MYSQLND_COM_STMT_EXECUTE', 0);
180800define('MYSQLND_UH_MYSQLND_COM_STMT_FETCH', 0);
180801define('MYSQLND_UH_MYSQLND_COM_STMT_PREPARE', 0);
180802define('MYSQLND_UH_MYSQLND_COM_STMT_RESET', 0);
180803define('MYSQLND_UH_MYSQLND_COM_STMT_SEND_LONG_DATA', 0);
180804define('MYSQLND_UH_MYSQLND_COM_TABLE_DUMP', 0);
180805define('MYSQLND_UH_MYSQLND_COM_TIME', 0);
180806define('MYSQLND_UH_MYSQLND_OPTION_INIT_COMMAND', 0);
180807define('MYSQLND_UH_MYSQLND_OPTION_OPT_COMPRESS', 0);
180808define('MYSQLND_UH_MYSQLND_OPTION_OPT_CONNECT_TIMEOUT', 0);
180809define('MYSQLND_UH_MYSQLND_OPTION_OPT_NAMED_PIPE', 0);
180810define('MYSQLND_UH_MYSQLND_OPT_AUTH_PROTOCOL', 0);
180811define('MYSQLND_UH_MYSQLND_OPT_GUESS_CONNECTION', 0);
180812define('MYSQLND_UH_MYSQLND_OPT_INT_AND_FLOAT_NATIVE', 0);
180813define('MYSQLND_UH_MYSQLND_OPT_LOCAL_INFILE', 0);
180814define('MYSQLND_UH_MYSQLND_OPT_MAX_ALLOWED_PACKET', 0);
180815define('MYSQLND_UH_MYSQLND_OPT_NET_CMD_BUFFER_SIZE', 0);
180816define('MYSQLND_UH_MYSQLND_OPT_NET_READ_BUFFER_SIZE', 0);
180817define('MYSQLND_UH_MYSQLND_OPT_PROTOCOL', 0);
180818define('MYSQLND_UH_MYSQLND_OPT_READ_TIMEOUT', 0);
180819define('MYSQLND_UH_MYSQLND_OPT_RECONNECT', 0);
180820define('MYSQLND_UH_MYSQLND_OPT_SSL_CA', 0);
180821define('MYSQLND_UH_MYSQLND_OPT_SSL_CAPATH', 0);
180822define('MYSQLND_UH_MYSQLND_OPT_SSL_CERT', 0);
180823define('MYSQLND_UH_MYSQLND_OPT_SSL_CIPHER', 0);
180824define('MYSQLND_UH_MYSQLND_OPT_SSL_KEY', 0);
180825define('MYSQLND_UH_MYSQLND_OPT_SSL_PASSPHRASE', 0);
180826define('MYSQLND_UH_MYSQLND_OPT_SSL_VERIFY_SERVER_CERT', 0);
180827define('MYSQLND_UH_MYSQLND_OPT_USE_EMBEDDED_CONNECTION', 0);
180828define('MYSQLND_UH_MYSQLND_OPT_USE_REMOTE_CONNECTION', 0);
180829define('MYSQLND_UH_MYSQLND_OPT_USE_RESULT', 0);
180830define('MYSQLND_UH_MYSQLND_OPT_WRITE_TIMEOUT', 0);
180831define('MYSQLND_UH_MYSQLND_PREPARE_RESP_PACKET', 0);
180832define('MYSQLND_UH_MYSQLND_PROT_AUTH_PACKET', 0);
180833define('MYSQLND_UH_MYSQLND_PROT_CMD_PACKET', 0);
180834define('MYSQLND_UH_MYSQLND_PROT_EOF_PACKET', 0);
180835define('MYSQLND_UH_MYSQLND_PROT_GREET_PACKET', 0);
180836define('MYSQLND_UH_MYSQLND_PROT_LAST', 0);
180837define('MYSQLND_UH_MYSQLND_PROT_OK_PACKET', 0);
180838define('MYSQLND_UH_MYSQLND_PROT_ROW_PACKET', 0);
180839define('MYSQLND_UH_MYSQLND_PROT_RSET_FLD_PACKET', 0);
180840define('MYSQLND_UH_MYSQLND_PROT_RSET_HEADER_PACKET', 0);
180841define('MYSQLND_UH_MYSQLND_PROT_STATS_PACKET', 0);
180842define('MYSQLND_UH_MYSQLND_READ_DEFAULT_FILE', 0);
180843define('MYSQLND_UH_MYSQLND_READ_DEFAULT_GROUP', 0);
180844define('MYSQLND_UH_MYSQLND_REPORT_DATA_TRUNCATION', 0);
180845define('MYSQLND_UH_MYSQLND_SECURE_AUTH', 0);
180846define('MYSQLND_UH_MYSQLND_SET_CHARSET_DIR', 0);
180847define('MYSQLND_UH_MYSQLND_SET_CHARSET_NAME', 0);
180848define('MYSQLND_UH_MYSQLND_SET_CLIENT_IP', 0);
180849define('MYSQLND_UH_MYSQLND_SHARED_MEMORY_BASE_NAME', 0);
180850define('MYSQLND_UH_SERVER_OPTION_DEFAULT_AUTH', 0);
180851define('MYSQLND_UH_SERVER_OPTION_MULTI_STATEMENTS_OFF', 0);
180852define('MYSQLND_UH_SERVER_OPTION_MULTI_STATEMENTS_ON', 0);
180853define('MYSQLND_UH_SERVER_OPTION_PLUGIN_DIR', 0);
180854define('MYSQLND_UH_SERVER_OPTION_SET_CLIENT_IP', 0);
180855define('MYSQLND_UH_VERSION', '');
180856define('MYSQLND_UH_VERSION_ID', 0);
180857define('MYSQLX_CLIENT_SSL', 0);
180858define('MYSQLX_LOCK_DEFAULT', 0);
180859define('MYSQLX_LOCK_NOWAIT', 0);
180860define('MYSQLX_LOCK_SKIP_LOCKED', 0);
180861define('MYSQLX_TYPE_BIGINT', 0);
180862define('MYSQLX_TYPE_BIT', 0);
180863define('MYSQLX_TYPE_BLOB', 0);
180864define('MYSQLX_TYPE_BYTES', 0);
180865define('MYSQLX_TYPE_CHAR', 0);
180866define('MYSQLX_TYPE_DATE', 0);
180867define('MYSQLX_TYPE_DATETIME', 0);
180868define('MYSQLX_TYPE_DECIMAL', 0);
180869define('MYSQLX_TYPE_DOUBLE', 0);
180870define('MYSQLX_TYPE_ENUM', 0);
180871define('MYSQLX_TYPE_FLOAT', 0);
180872define('MYSQLX_TYPE_GEOMETRY', 0);
180873define('MYSQLX_TYPE_INT', 0);
180874define('MYSQLX_TYPE_INT24', 0);
180875define('MYSQLX_TYPE_INTERVAL', 0);
180876define('MYSQLX_TYPE_JSON', 0);
180877define('MYSQLX_TYPE_LONG', 0);
180878define('MYSQLX_TYPE_LONGLONG', 0);
180879define('MYSQLX_TYPE_LONG_BLOB', 0);
180880define('MYSQLX_TYPE_MEDIUMINT', 0);
180881define('MYSQLX_TYPE_MEDIUM_BLOB', 0);
180882define('MYSQLX_TYPE_NEWDATE', 0);
180883define('MYSQLX_TYPE_NEWDECIMAL', 0);
180884define('MYSQLX_TYPE_NULL', 0);
180885define('MYSQLX_TYPE_SET', 0);
180886define('MYSQLX_TYPE_SHORT', 0);
180887define('MYSQLX_TYPE_SMALLINT', 0);
180888define('MYSQLX_TYPE_STRING', 0);
180889define('MYSQLX_TYPE_TIME', 0);
180890define('MYSQLX_TYPE_TIMESTAMP', 0);
180891define('MYSQLX_TYPE_TINY', 0);
180892define('MYSQLX_TYPE_TINY_BLOB', 0);
180893define('MYSQLX_TYPE_VAR_STRING', 0);
180894define('MYSQLX_TYPE_YEAR', 0);
180895define('MYSQL_ASSOC', 0);
180896define('MYSQL_BOTH', 0);
180897define('MYSQL_CLIENT_COMPRESS', 0);
180898define('MYSQL_CLIENT_IGNORE_SPACE', 0);
180899define('MYSQL_CLIENT_INTERACTIVE', 0);
180900define('MYSQL_CLIENT_SSL', 0);
180901define('MYSQL_NUM', 0);
180902define('M_1_PI', 0);
180903define('M_2_PI', 0);
180904define('M_2_SQRTPI', 0);
180905define('M_DONE', 0);
180906define('M_E', 0);
180907define('M_ERROR', 0);
180908define('M_EULER', 0);
180909define('M_FAIL', 0);
180910define('M_LN2', 0);
180911define('M_LN10', 0);
180912define('M_LNPI', 0);
180913define('M_LOG2E', 0);
180914define('M_LOG10E', 0);
180915define('M_PENDING', 0);
180916define('M_PI', 0);
180917define('M_PI_2', 0);
180918define('M_PI_4', 0);
180919define('M_SQRT1_2', 0);
180920define('M_SQRT2', 0);
180921define('M_SQRT3', 0);
180922define('M_SQRTPI', 0);
180923define('M_SUCCESS', 0);
180924define('NAN', 0);
180925/**
180926 * report all mouse events
180927 **/
180928define('NCURSES_ALL_MOUSE_EVENTS', 0);
180929/**
180930 * button (1-4) clicked
180931 **/
180932define('NCURSES_BUTTON1_CLICKED', 0);
180933/**
180934 * button (1-4) double clicked
180935 **/
180936define('NCURSES_BUTTON1_DOUBLE_CLICKED', 0);
180937/**
180938 * button (1-4) pressed
180939 **/
180940define('NCURSES_BUTTON1_PRESSED', 0);
180941/**
180942 * button (1-4) released
180943 **/
180944define('NCURSES_BUTTON1_RELEASED', 0);
180945/**
180946 * button (1-4) triple clicked
180947 **/
180948define('NCURSES_BUTTON1_TRIPLE_CLICKED', 0);
180949/**
180950 * alt pressed during click
180951 **/
180952define('NCURSES_BUTTON_ALT', 0);
180953/**
180954 * ctrl pressed during click
180955 **/
180956define('NCURSES_BUTTON_CTRL', 0);
180957/**
180958 * shift pressed during click
180959 **/
180960define('NCURSES_BUTTON_SHIFT', 0);
180961/**
180962 * no color (black)
180963 **/
180964define('NCURSES_COLOR_BLACK', 0);
180965/**
180966 * blue - supported when terminal is in color mode
180967 **/
180968define('NCURSES_COLOR_BLUE', 0);
180969/**
180970 * cyan - supported when terminal is in color mode
180971 **/
180972define('NCURSES_COLOR_CYAN', 0);
180973/**
180974 * green - supported when terminal is in color mode
180975 **/
180976define('NCURSES_COLOR_GREEN', 0);
180977/**
180978 * magenta - supported when terminal is in color mode
180979 **/
180980define('NCURSES_COLOR_MAGENTA', 0);
180981/**
180982 * red - supported when terminal is in color mode
180983 **/
180984define('NCURSES_COLOR_RED', 0);
180985/**
180986 * white
180987 **/
180988define('NCURSES_COLOR_WHITE', 0);
180989/**
180990 * yellow - supported when terminal is in color mode
180991 **/
180992define('NCURSES_COLOR_YELLOW', 0);
180993/**
180994 * upper left of keypad
180995 **/
180996define('NCURSES_KEY_A1', 0);
180997/**
180998 * upper right of keypad
180999 **/
181000define('NCURSES_KEY_A3', 0);
181001/**
181002 * center of keypad
181003 **/
181004define('NCURSES_KEY_B2', 0);
181005/**
181006 * backspace
181007 **/
181008define('NCURSES_KEY_BACKSPACE', 0);
181009/**
181010 * beginning
181011 **/
181012define('NCURSES_KEY_BEG', 0);
181013/**
181014 * back tab
181015 **/
181016define('NCURSES_KEY_BTAB', 0);
181017/**
181018 * lower left of keypad
181019 **/
181020define('NCURSES_KEY_C1', 0);
181021/**
181022 * lower right of keypad
181023 **/
181024define('NCURSES_KEY_C3', 0);
181025/**
181026 * cancel
181027 **/
181028define('NCURSES_KEY_CANCEL', 0);
181029/**
181030 * clear all tabs
181031 **/
181032define('NCURSES_KEY_CATAB', 0);
181033/**
181034 * clear screen
181035 **/
181036define('NCURSES_KEY_CLEAR', 0);
181037/**
181038 * close
181039 **/
181040define('NCURSES_KEY_CLOSE', 0);
181041/**
181042 * cmd (command)
181043 **/
181044define('NCURSES_KEY_COMMAND', 0);
181045/**
181046 * copy
181047 **/
181048define('NCURSES_KEY_COPY', 0);
181049/**
181050 * create
181051 **/
181052define('NCURSES_KEY_CREATE', 0);
181053/**
181054 * clear tab
181055 **/
181056define('NCURSES_KEY_CTAB', 0);
181057/**
181058 * delete character
181059 **/
181060define('NCURSES_KEY_DC', 0);
181061/**
181062 * delete line
181063 **/
181064define('NCURSES_KEY_DL', 0);
181065/**
181066 * down arrow
181067 **/
181068define('NCURSES_KEY_DOWN', 0);
181069/**
181070 * exit insert char mode
181071 **/
181072define('NCURSES_KEY_EIC', 0);
181073/**
181074 * end
181075 **/
181076define('NCURSES_KEY_END', 0);
181077/**
181078 * clear to end of line
181079 **/
181080define('NCURSES_KEY_EOL', 0);
181081/**
181082 * clear to end of screen
181083 **/
181084define('NCURSES_KEY_EOS', 0);
181085/**
181086 * exit
181087 **/
181088define('NCURSES_KEY_EXIT', 0);
181089/**
181090 * function keys F1 - F64
181091 **/
181092define('NCURSES_KEY_F0', 0);
181093/**
181094 * find
181095 **/
181096define('NCURSES_KEY_FIND', 0);
181097/**
181098 * help
181099 **/
181100define('NCURSES_KEY_HELP', 0);
181101/**
181102 * home key (upward+left arrow)
181103 **/
181104define('NCURSES_KEY_HOME', 0);
181105/**
181106 * insert char or enter insert mode
181107 **/
181108define('NCURSES_KEY_IC', 0);
181109/**
181110 * insert line
181111 **/
181112define('NCURSES_KEY_IL', 0);
181113/**
181114 * left arrow
181115 **/
181116define('NCURSES_KEY_LEFT', 0);
181117/**
181118 * lower left
181119 **/
181120define('NCURSES_KEY_LL', 0);
181121/**
181122 * mark
181123 **/
181124define('NCURSES_KEY_MARK', 0);
181125/**
181126 * maximum key value
181127 **/
181128define('NCURSES_KEY_MAX', 0);
181129/**
181130 * message
181131 **/
181132define('NCURSES_KEY_MESSAGE', 0);
181133/**
181134 * mouse event has occurred
181135 **/
181136define('NCURSES_KEY_MOUSE', 0);
181137/**
181138 * move
181139 **/
181140define('NCURSES_KEY_MOVE', 0);
181141/**
181142 * next
181143 **/
181144define('NCURSES_KEY_NEXT', 0);
181145/**
181146 * next page
181147 **/
181148define('NCURSES_KEY_NPAGE', 0);
181149/**
181150 * open
181151 **/
181152define('NCURSES_KEY_OPEN', 0);
181153/**
181154 * options
181155 **/
181156define('NCURSES_KEY_OPTIONS', 0);
181157/**
181158 * previous page
181159 **/
181160define('NCURSES_KEY_PPAGE', 0);
181161/**
181162 * previous
181163 **/
181164define('NCURSES_KEY_PREVIOUS', 0);
181165/**
181166 * print
181167 **/
181168define('NCURSES_KEY_PRINT', 0);
181169/**
181170 * redo
181171 **/
181172define('NCURSES_KEY_REDO', 0);
181173/**
181174 * ref (reference)
181175 **/
181176define('NCURSES_KEY_REFERENCE', 0);
181177/**
181178 * refresh
181179 **/
181180define('NCURSES_KEY_REFRESH', 0);
181181/**
181182 * replace
181183 **/
181184define('NCURSES_KEY_REPLACE', 0);
181185/**
181186 * reset or hard reset
181187 **/
181188define('NCURSES_KEY_RESET', 0);
181189/**
181190 * restart
181191 **/
181192define('NCURSES_KEY_RESTART', 0);
181193/**
181194 * resume
181195 **/
181196define('NCURSES_KEY_RESUME', 0);
181197/**
181198 * right arrow
181199 **/
181200define('NCURSES_KEY_RIGHT', 0);
181201/**
181202 * save
181203 **/
181204define('NCURSES_KEY_SAVE', 0);
181205/**
181206 * shiftet beg (beginning)
181207 **/
181208define('NCURSES_KEY_SBEG', 0);
181209/**
181210 * shifted cancel
181211 **/
181212define('NCURSES_KEY_SCANCEL', 0);
181213/**
181214 * shifted command
181215 **/
181216define('NCURSES_KEY_SCOMMAND', 0);
181217/**
181218 * shifted copy
181219 **/
181220define('NCURSES_KEY_SCOPY', 0);
181221/**
181222 * shifted create
181223 **/
181224define('NCURSES_KEY_SCREATE', 0);
181225/**
181226 * shifted delete char
181227 **/
181228define('NCURSES_KEY_SDC', 0);
181229/**
181230 * shifted delete line
181231 **/
181232define('NCURSES_KEY_SDL', 0);
181233/**
181234 * select
181235 **/
181236define('NCURSES_KEY_SELECT', 0);
181237/**
181238 * shifted end
181239 **/
181240define('NCURSES_KEY_SEND', 0);
181241/**
181242 * shifted end of line
181243 **/
181244define('NCURSES_KEY_SEOL', 0);
181245/**
181246 * shifted exit
181247 **/
181248define('NCURSES_KEY_SEXIT', 0);
181249/**
181250 * scroll one line forward
181251 **/
181252define('NCURSES_KEY_SF', 0);
181253/**
181254 * shifted find
181255 **/
181256define('NCURSES_KEY_SFIND', 0);
181257/**
181258 * shifted help
181259 **/
181260define('NCURSES_KEY_SHELP', 0);
181261/**
181262 * shifted home
181263 **/
181264define('NCURSES_KEY_SHOME', 0);
181265/**
181266 * shifted input
181267 **/
181268define('NCURSES_KEY_SIC', 0);
181269/**
181270 * shifted left arrow
181271 **/
181272define('NCURSES_KEY_SLEFT', 0);
181273/**
181274 * shifted message
181275 **/
181276define('NCURSES_KEY_SMESSAGE', 0);
181277/**
181278 * shifted move
181279 **/
181280define('NCURSES_KEY_SMOVE', 0);
181281/**
181282 * shifted next
181283 **/
181284define('NCURSES_KEY_SNEXT', 0);
181285/**
181286 * shifted options
181287 **/
181288define('NCURSES_KEY_SOPTIONS', 0);
181289/**
181290 * shifted previous
181291 **/
181292define('NCURSES_KEY_SPREVIOUS', 0);
181293/**
181294 * shifted print
181295 **/
181296define('NCURSES_KEY_SPRINT', 0);
181297/**
181298 * scroll one line backward
181299 **/
181300define('NCURSES_KEY_SR', 0);
181301/**
181302 * shifted redo
181303 **/
181304define('NCURSES_KEY_SREDO', 0);
181305/**
181306 * shifted replace
181307 **/
181308define('NCURSES_KEY_SREPLACE', 0);
181309/**
181310 * soft (partial) reset
181311 **/
181312define('NCURSES_KEY_SRESET', 0);
181313/**
181314 * shifted right arrow
181315 **/
181316define('NCURSES_KEY_SRIGHT', 0);
181317/**
181318 * shifted resume
181319 **/
181320define('NCURSES_KEY_SRSUME', 0);
181321/**
181322 * shifted save
181323 **/
181324define('NCURSES_KEY_SSAVE', 0);
181325/**
181326 * shifted suspend
181327 **/
181328define('NCURSES_KEY_SSUSPEND', 0);
181329/**
181330 * set tab
181331 **/
181332define('NCURSES_KEY_STAB', 0);
181333/**
181334 * undo
181335 **/
181336define('NCURSES_KEY_UNDO', 0);
181337/**
181338 * up arrow
181339 **/
181340define('NCURSES_KEY_UP', 0);
181341/**
181342 * report mouse position
181343 **/
181344define('NCURSES_REPORT_MOUSE_POSITION', 0);
181345/**
181346 * Sign for negative values.
181347 **/
181348define('NEGATIVE_SIGN', 0);
181349define('NEWCONFIGNOQUORUM', 0);
181350define('NEWT_ANCHOR_BOTTOM', 0);
181351define('NEWT_ANCHOR_LEFT', 0);
181352define('NEWT_ANCHOR_RIGHT', 0);
181353define('NEWT_ANCHOR_TOP', 0);
181354define('NEWT_ARG_APPEND', 0);
181355define('NEWT_ARG_LAST', 0);
181356define('NEWT_CHECKBOXTREE_COLLAPSED', 0);
181357define('NEWT_CHECKBOXTREE_EXPANDED', 0);
181358define('NEWT_CHECKBOXTREE_HIDE_BOX', 0);
181359define('NEWT_CHECKBOXTREE_SELECTED', 0);
181360define('NEWT_CHECKBOXTREE_UNSELECTABLE', 0);
181361define('NEWT_CHECKBOXTREE_UNSELECTED', 0);
181362define('NEWT_COLORSET_ACTBUTTON', 0);
181363define('NEWT_COLORSET_ACTCHECKBOX', 0);
181364define('NEWT_COLORSET_ACTLISTBOX', 0);
181365define('NEWT_COLORSET_ACTSELLISTBOX', 0);
181366define('NEWT_COLORSET_ACTTEXTBOX', 0);
181367define('NEWT_COLORSET_BORDER', 0);
181368define('NEWT_COLORSET_BUTTON', 0);
181369define('NEWT_COLORSET_CHECKBOX', 0);
181370define('NEWT_COLORSET_COMPACTBUTTON', 0);
181371define('NEWT_COLORSET_DISENTRY', 0);
181372define('NEWT_COLORSET_EMPTYSCALE', 0);
181373define('NEWT_COLORSET_ENTRY', 0);
181374define('NEWT_COLORSET_FULLSCALE', 0);
181375define('NEWT_COLORSET_HELPLINE', 0);
181376define('NEWT_COLORSET_LABEL', 0);
181377define('NEWT_COLORSET_LISTBOX', 0);
181378define('NEWT_COLORSET_ROOT', 0);
181379define('NEWT_COLORSET_ROOTTEXT', 0);
181380define('NEWT_COLORSET_SELLISTBOX', 0);
181381define('NEWT_COLORSET_SHADOW', 0);
181382define('NEWT_COLORSET_TEXTBOX', 0);
181383define('NEWT_COLORSET_TITLE', 0);
181384define('NEWT_COLORSET_WINDOW', 0);
181385define('NEWT_ENTRY_DISABLED', 0);
181386define('NEWT_ENTRY_HIDDEN', 0);
181387define('NEWT_ENTRY_RETURNEXIT', 0);
181388define('NEWT_ENTRY_SCROLL', 0);
181389/**
181390 * some component has caused form to exit
181391 **/
181392define('NEWT_EXIT_COMPONENT', 0);
181393/**
181394 * file descriptor specified in {@link newt_form_watch_fd} is ready to be
181395 * read or written to
181396 **/
181397define('NEWT_EXIT_FDREADY', 0);
181398/**
181399 * hotkey defined by {@link newt_form_add_hot_key} was pressed
181400 **/
181401define('NEWT_EXIT_HOTKEY', 0);
181402/**
181403 * time specified in {@link newt_form_set_timer} has elapsed
181404 **/
181405define('NEWT_EXIT_TIMER', 0);
181406define('NEWT_FD_EXCEPT', 0);
181407define('NEWT_FD_READ', 0);
181408define('NEWT_FD_WRITE', 0);
181409define('NEWT_FLAGS_RESET', 0);
181410define('NEWT_FLAGS_SET', 0);
181411define('NEWT_FLAGS_TOGGLE', 0);
181412define('NEWT_FLAG_BORDER', 0);
181413/**
181414 * Component is checkbox
181415 **/
181416define('NEWT_FLAG_CHECKBOX', 0);
181417/**
181418 * Component is disabled
181419 **/
181420define('NEWT_FLAG_DISABLED', 0);
181421/**
181422 * Component is hidden
181423 **/
181424define('NEWT_FLAG_HIDDEN', 0);
181425define('NEWT_FLAG_MULTIPLE', 0);
181426/**
181427 * Don't exit form on pressing F12
181428 **/
181429define('NEWT_FLAG_NOF12', 0);
181430/**
181431 * Entry component is password entry
181432 **/
181433define('NEWT_FLAG_PASSWORD', 0);
181434/**
181435 * Exit form, when component is activated
181436 **/
181437define('NEWT_FLAG_RETURNEXIT', 0);
181438/**
181439 * Component is scrollable
181440 **/
181441define('NEWT_FLAG_SCROLL', 0);
181442/**
181443 * Component is selected
181444 **/
181445define('NEWT_FLAG_SELECTED', 0);
181446/**
181447 * Show cursor
181448 **/
181449define('NEWT_FLAG_SHOWCURSOR', 0);
181450/**
181451 * Wrap text
181452 **/
181453define('NEWT_FLAG_WRAP', 0);
181454/**
181455 * Don't exit form on F12 press
181456 **/
181457define('NEWT_FORM_NOF12', 0);
181458define('NEWT_GRID_COMPONENT', 0);
181459define('NEWT_GRID_EMPTY', 0);
181460define('NEWT_GRID_FLAG_GROWX', 0);
181461define('NEWT_GRID_FLAG_GROWY', 0);
181462define('NEWT_GRID_SUBGRID', 0);
181463define('NEWT_KEY_BKSPC', 0);
181464define('NEWT_KEY_DELETE', 0);
181465define('NEWT_KEY_DOWN', 0);
181466define('NEWT_KEY_END', 0);
181467define('NEWT_KEY_ENTER', 0);
181468define('NEWT_KEY_ESCAPE', 0);
181469define('NEWT_KEY_EXTRA_BASE', 0);
181470define('NEWT_KEY_F1', 0);
181471define('NEWT_KEY_F2', 0);
181472define('NEWT_KEY_F3', 0);
181473define('NEWT_KEY_F4', 0);
181474define('NEWT_KEY_F5', 0);
181475define('NEWT_KEY_F6', 0);
181476define('NEWT_KEY_F7', 0);
181477define('NEWT_KEY_F8', 0);
181478define('NEWT_KEY_F9', 0);
181479define('NEWT_KEY_F10', 0);
181480define('NEWT_KEY_F11', 0);
181481define('NEWT_KEY_F12', 0);
181482define('NEWT_KEY_HOME', 0);
181483define('NEWT_KEY_INSERT', 0);
181484define('NEWT_KEY_LEFT', 0);
181485define('NEWT_KEY_PGDN', 0);
181486define('NEWT_KEY_PGUP', 0);
181487define('NEWT_KEY_RESIZE', 0);
181488define('NEWT_KEY_RETURN', 0);
181489define('NEWT_KEY_RIGHT', 0);
181490define('NEWT_KEY_SUSPEND', 0);
181491define('NEWT_KEY_TAB', 0);
181492define('NEWT_KEY_UNTAB', 0);
181493define('NEWT_KEY_UP', 0);
181494define('NEWT_LISTBOX_RETURNEXIT', 0);
181495/**
181496 * Scroll text in the textbox
181497 **/
181498define('NEWT_TEXTBOX_SCROLL', 0);
181499/**
181500 * Wrap text in the textbox
181501 **/
181502define('NEWT_TEXTBOX_WRAP', 0);
181503define('NIL', 0);
181504define('NOAUTH', 0);
181505define('NOCHILDRENFOREPHEMERALS', 0);
181506define('NODEEXISTS', 0);
181507/**
181508 * Regex string for matching "no" input.
181509 **/
181510define('NOEXPR', 0);
181511define('NONODE', 0);
181512/**
181513 * Compare case insensitively
181514 **/
181515define('NORM_IGNORECASE', 0);
181516/**
181517 * Ignore Kana type
181518 **/
181519define('NORM_IGNOREKANATYPE', 0);
181520/**
181521 * Ignore Arabic kashida characters
181522 **/
181523define('NORM_IGNOREKASHIDA', 0);
181524/**
181525 * Ignore nonspacing characters
181526 **/
181527define('NORM_IGNORENONSPACE', 0);
181528/**
181529 * Ignore symbols
181530 **/
181531define('NORM_IGNORESYMBOLS', 0);
181532/**
181533 * Ignore string width
181534 **/
181535define('NORM_IGNOREWIDTH', 0);
181536/**
181537 * Output string for "no".
181538 **/
181539define('NOSTR', 0);
181540define('NOTCONNECTED_STATE', 0);
181541define('NOTEMPTY', 0);
181542define('NOTHING', 0);
181543define('NOTREADONLY', 0);
181544define('NOTWATCHING_EVENT', 0);
181545define('NOWATCHER', 0);
181546/**
181547 * Returns 1 if CURRENCY_SYMBOL precedes a negative value.
181548 **/
181549define('N_CS_PRECEDES', 0);
181550/**
181551 * Returns 1 if a space separates CURRENCY_SYMBOL from a negative value.
181552 **/
181553define('N_SEP_BY_SPACE', 0);
181554define('N_SIGN_POSN', 0);
181555define('OAUTH_AUTH_TYPE_AUTHORIZATION', '');
181556define('OAUTH_AUTH_TYPE_FORM', '');
181557define('OAUTH_AUTH_TYPE_NONE', '');
181558define('OAUTH_AUTH_TYPE_URI', '');
181559define('OAUTH_BAD_NONCE', 0);
181560define('OAUTH_BAD_TIMESTAMP', 0);
181561define('OAUTH_CONSUMER_KEY_REFUSED', 0);
181562define('OAUTH_CONSUMER_KEY_UNKNOWN', 0);
181563define('OAUTH_HTTP_METHOD_DELETE', '');
181564define('OAUTH_HTTP_METHOD_GET', '');
181565define('OAUTH_HTTP_METHOD_HEAD', '');
181566define('OAUTH_HTTP_METHOD_POST', '');
181567define('OAUTH_HTTP_METHOD_PUT', '');
181568define('OAUTH_INVALID_SIGNATURE', 0);
181569define('OAUTH_OK', 0);
181570define('OAUTH_PARAMETER_ABSENT', 0);
181571define('OAUTH_REQENGINE_CURL', 0);
181572define('OAUTH_REQENGINE_STREAMS', 0);
181573define('OAUTH_SIGNATURE_METHOD_REJECTED', 0);
181574define('OAUTH_SIG_METHOD_HMACSHA1', '');
181575define('OAUTH_SIG_METHOD_HMACSHA256', '');
181576define('OAUTH_SIG_METHOD_RSASHA1', '');
181577define('OAUTH_TOKEN_EXPIRED', 0);
181578define('OAUTH_TOKEN_REJECTED', 0);
181579define('OAUTH_TOKEN_REVOKED', 0);
181580define('OAUTH_TOKEN_USED', 0);
181581define('OAUTH_VERIFIER_INVALID', 0);
181582/**
181583 * Returns an associative array.
181584 **/
181585define('OCI_ASSOC', 0);
181586/**
181587 * Returns an array with both associative and numeric indices. This is
181588 * the same as OCI_ASSOC + OCI_NUM and is the default behavior.
181589 **/
181590define('OCI_BOTH', 0);
181591define('OCI_B_BFILE', 0);
181592define('OCI_B_BIN', 0);
181593define('OCI_B_BLOB', 0);
181594define('OCI_B_BOL', 0);
181595define('OCI_B_CFILEE', 0);
181596define('OCI_B_CLOB', 0);
181597define('OCI_B_CURSOR', 0);
181598define('OCI_B_INT', 0);
181599define('OCI_B_NTY', 0);
181600define('OCI_B_NUM', 0);
181601define('OCI_B_ROWID', 0);
181602define('OCI_B_SQLT_NTY', 0);
181603/**
181604 * Automatically commit all outstanding changes for this connection when
181605 * the statement has succeeded. This is the default.
181606 **/
181607define('OCI_COMMIT_ON_SUCCESS', 0);
181608define('OCI_CRED_EXT', 0);
181609define('OCI_DEFAULT', 0);
181610/**
181611 * Make query meta data available to functions like {@link
181612 * oci_field_name} but do not create a result set. Any subsequent fetch
181613 * call such as {@link oci_fetch_array} will fail.
181614 **/
181615define('OCI_DESCRIBE_ONLY', 0);
181616define('OCI_DTYPE_FILE', 0);
181617define('OCI_DTYPE_LOB', 0);
181618define('OCI_DTYPE_ROWID', 0);
181619define('OCI_D_FILE', 0);
181620define('OCI_D_LOB', 0);
181621define('OCI_D_ROWID', 0);
181622define('OCI_EXACT_FETCH', 0);
181623/**
181624 * The outer array will contain one sub-array per query column. This is
181625 * the default.
181626 **/
181627define('OCI_FETCHSTATEMENT_BY_COLUMN', 0);
181628/**
181629 * The outer array will contain one sub-array per query row.
181630 **/
181631define('OCI_FETCHSTATEMENT_BY_ROW', 0);
181632define('OCI_LOB_BUFFER_FREE', 0);
181633/**
181634 * Do not automatically commit changes. Prior to PHP 5.3.2 (PECL OCI8
181635 * 1.4) use OCI_DEFAULT which is equivalent to OCI_NO_AUTO_COMMIT.
181636 **/
181637define('OCI_NO_AUTO_COMMIT', 0);
181638/**
181639 * Returns a numeric array.
181640 **/
181641define('OCI_NUM', 0);
181642/**
181643 * Returns the contents of LOBs instead of the LOB descriptors.
181644 **/
181645define('OCI_RETURN_LOBS', 0);
181646/**
181647 * Creates elements for NULL fields. The element values will be a PHP
181648 * NULL.
181649 **/
181650define('OCI_RETURN_NULLS', 0);
181651define('OCI_SEEK_CUR', 0);
181652define('OCI_SEEK_END', 0);
181653define('OCI_SEEK_SET', 0);
181654define('OCI_SYSDATE', 0);
181655define('OCI_SYSDBA', 0);
181656define('OCI_SYSOPER', 0);
181657define('OCI_TEMP_BLOB', 0);
181658define('OCI_TEMP_CLOB', 0);
181659/**
181660 * >0
181661 **/
181662define('ODBC_BINMODE_CONVERT', 0);
181663/**
181664 * >0
181665 **/
181666define('ODBC_BINMODE_PASSTHRU', 0);
181667/**
181668 * >0
181669 **/
181670define('ODBC_BINMODE_RETURN', 0);
181671define('ODBC_TYPE', 0);
181672define('OGGVORBIS_PCM_S8', 0);
181673define('OGGVORBIS_PCM_S16_BE', 0);
181674define('OGGVORBIS_PCM_S16_LE', 0);
181675define('OGGVORBIS_PCM_U8', 0);
181676define('OGGVORBIS_PCM_U16_BE', 0);
181677define('OGGVORBIS_PCM_U16_LE', 0);
181678define('OK', 0);
181679define('OPENSSL_ALGO_DSS1', 0);
181680define('OPENSSL_ALGO_MD2', 0);
181681define('OPENSSL_ALGO_MD4', 0);
181682define('OPENSSL_ALGO_MD5', 0);
181683define('OPENSSL_ALGO_RMD160', 0);
181684define('OPENSSL_ALGO_SHA1', 0);
181685define('OPENSSL_ALGO_SHA224', 0);
181686define('OPENSSL_ALGO_SHA256', 0);
181687define('OPENSSL_ALGO_SHA384', 0);
181688define('OPENSSL_ALGO_SHA512', 0);
181689define('OPENSSL_CIPHER_3DES', 0);
181690define('OPENSSL_CIPHER_AES_128_CBC', 0);
181691define('OPENSSL_CIPHER_AES_192_CBC', 0);
181692define('OPENSSL_CIPHER_AES_256_CBC', 0);
181693define('OPENSSL_CIPHER_DES', 0);
181694define('OPENSSL_CIPHER_RC2_40', 0);
181695define('OPENSSL_CIPHER_RC2_64', 0);
181696define('OPENSSL_CIPHER_RC2_128', 0);
181697define('OPENSSL_KEYTYPE_DH', 0);
181698define('OPENSSL_KEYTYPE_DSA', 0);
181699define('OPENSSL_KEYTYPE_EC', 0);
181700define('OPENSSL_KEYTYPE_RSA', 0);
181701define('OPENSSL_NO_PADDING', 0);
181702define('OPENSSL_PKCS1_OAEP_PADDING', 0);
181703define('OPENSSL_PKCS1_PADDING', 0);
181704define('OPENSSL_SSLV23_PADDING', 0);
181705define('OPENSSL_TLSEXT_SERVER_NAME', '');
181706define('OPENSSL_VERSION_NUMBER', 0);
181707define('OPENSSL_VERSION_TEXT', '');
181708define('OPERATIONTIMEOUT', 0);
181709define('OP_ANONYMOUS', 0);
181710define('OP_DEBUG', 0);
181711define('OP_EXPUNGE', 0);
181712define('OP_HALFOPEN', 0);
181713define('OP_PROTOTYPE', 0);
181714define('OP_READONLY', 0);
181715define('OP_SECURE', 0);
181716define('OP_SHORTCACHE', 0);
181717define('OP_SILENT', 0);
181718define('O_APPEND', 0);
181719define('O_ASYNC', 0);
181720define('O_CREAT', 0);
181721define('O_EXCL', 0);
181722define('O_NDELAY', 0);
181723define('O_NOCTTY', 0);
181724define('O_NONBLOCK', 0);
181725define('O_RDONLY', 0);
181726define('O_RDWR', 0);
181727define('O_SYNC', 0);
181728define('O_TRUNC', 0);
181729define('O_WRONLY', 0);
181730define('Parle\INTERNAL_UTF32', 0);
181731define('PARSEKIT_EXTENDED_VALUE', 0);
181732define('PARSEKIT_IS_CONST', 0);
181733define('PARSEKIT_IS_TMP_VAR', 0);
181734define('PARSEKIT_IS_UNUSED', 0);
181735define('PARSEKIT_IS_VAR', 0);
181736define('PARSEKIT_QUIET', 0);
181737define('PARSEKIT_RESULT_CONST', 0);
181738define('PARSEKIT_RESULT_EA_TYPE', 0);
181739define('PARSEKIT_RESULT_JMP_ADDR', 0);
181740define('PARSEKIT_RESULT_OPARRAY', 0);
181741define('PARSEKIT_RESULT_OPLINE', 0);
181742define('PARSEKIT_RESULT_VAR', 0);
181743define('PARSEKIT_SIMPLE', 0);
181744define('PARSEKIT_USAGE_UNKNOWN', 0);
181745define('PARSEKIT_ZEND_ADD', 0);
181746define('PARSEKIT_ZEND_ADD_ARRAY_ELEMENT', 0);
181747define('PARSEKIT_ZEND_ADD_CHAR', 0);
181748define('PARSEKIT_ZEND_ADD_INTERFACE', 0);
181749define('PARSEKIT_ZEND_ADD_STRING', 0);
181750define('PARSEKIT_ZEND_ADD_VAR', 0);
181751define('PARSEKIT_ZEND_ASSIGN', 0);
181752define('PARSEKIT_ZEND_ASSIGN_ADD', 0);
181753define('PARSEKIT_ZEND_ASSIGN_BW_AND', 0);
181754define('PARSEKIT_ZEND_ASSIGN_BW_OR', 0);
181755define('PARSEKIT_ZEND_ASSIGN_BW_XOR', 0);
181756define('PARSEKIT_ZEND_ASSIGN_CONCAT', 0);
181757define('PARSEKIT_ZEND_ASSIGN_DIM', 0);
181758define('PARSEKIT_ZEND_ASSIGN_DIV', 0);
181759define('PARSEKIT_ZEND_ASSIGN_MOD', 0);
181760define('PARSEKIT_ZEND_ASSIGN_MUL', 0);
181761define('PARSEKIT_ZEND_ASSIGN_OBJ', 0);
181762define('PARSEKIT_ZEND_ASSIGN_REF', 0);
181763define('PARSEKIT_ZEND_ASSIGN_SL', 0);
181764define('PARSEKIT_ZEND_ASSIGN_SR', 0);
181765define('PARSEKIT_ZEND_ASSIGN_SUB', 0);
181766define('PARSEKIT_ZEND_BEGIN_SILENCE', 0);
181767define('PARSEKIT_ZEND_BOOL', 0);
181768define('PARSEKIT_ZEND_BOOL_NOT', 0);
181769define('PARSEKIT_ZEND_BOOL_XOR', 0);
181770define('PARSEKIT_ZEND_BRK', 0);
181771define('PARSEKIT_ZEND_BW_AND', 0);
181772define('PARSEKIT_ZEND_BW_NOT', 0);
181773define('PARSEKIT_ZEND_BW_OR', 0);
181774define('PARSEKIT_ZEND_BW_XOR', 0);
181775define('PARSEKIT_ZEND_CASE', 0);
181776define('PARSEKIT_ZEND_CAST', 0);
181777define('PARSEKIT_ZEND_CATCH', 0);
181778define('PARSEKIT_ZEND_CLONE', 0);
181779define('PARSEKIT_ZEND_CONCAT', 0);
181780define('PARSEKIT_ZEND_CONT', 0);
181781define('PARSEKIT_ZEND_DECLARE_CLASS', 0);
181782define('PARSEKIT_ZEND_DECLARE_FUNCTION', 0);
181783define('PARSEKIT_ZEND_DECLARE_INHERITED_CLASS', 0);
181784define('PARSEKIT_ZEND_DIV', 0);
181785define('PARSEKIT_ZEND_DO_FCALL', 0);
181786define('PARSEKIT_ZEND_DO_FCALL_BY_NAME', 0);
181787define('PARSEKIT_ZEND_ECHO', 0);
181788define('PARSEKIT_ZEND_END_SILENCE', 0);
181789define('PARSEKIT_ZEND_EVAL_CODE', 0);
181790define('PARSEKIT_ZEND_EXIT', 0);
181791define('PARSEKIT_ZEND_EXT_FCALL_BEGIN', 0);
181792define('PARSEKIT_ZEND_EXT_FCALL_END', 0);
181793define('PARSEKIT_ZEND_EXT_NOP', 0);
181794define('PARSEKIT_ZEND_EXT_STMT', 0);
181795define('PARSEKIT_ZEND_FETCH_CLASS', 0);
181796define('PARSEKIT_ZEND_FETCH_CONSTANT', 0);
181797define('PARSEKIT_ZEND_FETCH_DIM_FUNC_ARG', 0);
181798define('PARSEKIT_ZEND_FETCH_DIM_IS', 0);
181799define('PARSEKIT_ZEND_FETCH_DIM_R', 0);
181800define('PARSEKIT_ZEND_FETCH_DIM_RW', 0);
181801define('PARSEKIT_ZEND_FETCH_DIM_TMP_VAR', 0);
181802define('PARSEKIT_ZEND_FETCH_DIM_UNSET', 0);
181803define('PARSEKIT_ZEND_FETCH_DIM_W', 0);
181804define('PARSEKIT_ZEND_FETCH_FUNC_ARG', 0);
181805define('PARSEKIT_ZEND_FETCH_IS', 0);
181806define('PARSEKIT_ZEND_FETCH_OBJ_FUNC_ARG', 0);
181807define('PARSEKIT_ZEND_FETCH_OBJ_IS', 0);
181808define('PARSEKIT_ZEND_FETCH_OBJ_R', 0);
181809define('PARSEKIT_ZEND_FETCH_OBJ_RW', 0);
181810define('PARSEKIT_ZEND_FETCH_OBJ_UNSET', 0);
181811define('PARSEKIT_ZEND_FETCH_OBJ_W', 0);
181812define('PARSEKIT_ZEND_FETCH_R', 0);
181813define('PARSEKIT_ZEND_FETCH_RW', 0);
181814define('PARSEKIT_ZEND_FETCH_UNSET', 0);
181815define('PARSEKIT_ZEND_FETCH_W', 0);
181816define('PARSEKIT_ZEND_FE_FETCH', 0);
181817define('PARSEKIT_ZEND_FE_RESET', 0);
181818define('PARSEKIT_ZEND_FREE', 0);
181819define('PARSEKIT_ZEND_HANDLE_EXCEPTION', 0);
181820define('PARSEKIT_ZEND_IMPORT_CLASS', 0);
181821define('PARSEKIT_ZEND_IMPORT_CONST', 0);
181822define('PARSEKIT_ZEND_IMPORT_FUNCTION', 0);
181823define('PARSEKIT_ZEND_INCLUDE_OR_EVAL', 0);
181824define('PARSEKIT_ZEND_INIT_ARRAY', 0);
181825define('PARSEKIT_ZEND_INIT_CTOR_CALL', 0);
181826define('PARSEKIT_ZEND_INIT_FCALL_BY_NAME', 0);
181827define('PARSEKIT_ZEND_INIT_METHOD_CALL', 0);
181828define('PARSEKIT_ZEND_INIT_STATIC_METHOD_CALL', 0);
181829define('PARSEKIT_ZEND_INIT_STRING', 0);
181830define('PARSEKIT_ZEND_INSTANCEOF', 0);
181831define('PARSEKIT_ZEND_INTERNAL_CLASS', 0);
181832define('PARSEKIT_ZEND_INTERNAL_FUNCTION', 0);
181833define('PARSEKIT_ZEND_ISSET_ISEMPTY', 0);
181834define('PARSEKIT_ZEND_ISSET_ISEMPTY_DIM_OBJ', 0);
181835define('PARSEKIT_ZEND_ISSET_ISEMPTY_PROP_OBJ', 0);
181836define('PARSEKIT_ZEND_ISSET_ISEMPTY_VAR', 0);
181837define('PARSEKIT_ZEND_IS_EQUAL', 0);
181838define('PARSEKIT_ZEND_IS_IDENTICAL', 0);
181839define('PARSEKIT_ZEND_IS_NOT_EQUAL', 0);
181840define('PARSEKIT_ZEND_IS_NOT_IDENTICAL', 0);
181841define('PARSEKIT_ZEND_IS_SMALLER', 0);
181842define('PARSEKIT_ZEND_IS_SMALLER_OR_EQUAL', 0);
181843define('PARSEKIT_ZEND_JMP', 0);
181844define('PARSEKIT_ZEND_JMPNZ', 0);
181845define('PARSEKIT_ZEND_JMPNZ_EX', 0);
181846define('PARSEKIT_ZEND_JMPZ', 0);
181847define('PARSEKIT_ZEND_JMPZNZ', 0);
181848define('PARSEKIT_ZEND_JMPZ_EX', 0);
181849define('PARSEKIT_ZEND_JMP_NO_CTOR', 0);
181850define('PARSEKIT_ZEND_MOD', 0);
181851define('PARSEKIT_ZEND_MUL', 0);
181852define('PARSEKIT_ZEND_NEW', 0);
181853define('PARSEKIT_ZEND_NOP', 0);
181854define('PARSEKIT_ZEND_OP_DATA', 0);
181855define('PARSEKIT_ZEND_OVERLOADED_FUNCTION', 0);
181856define('PARSEKIT_ZEND_OVERLOADED_FUNCTION_TEMPORARY', 0);
181857define('PARSEKIT_ZEND_POST_DEC', 0);
181858define('PARSEKIT_ZEND_POST_DEC_OBJ', 0);
181859define('PARSEKIT_ZEND_POST_INC', 0);
181860define('PARSEKIT_ZEND_POST_INC_OBJ', 0);
181861define('PARSEKIT_ZEND_PRE_DEC', 0);
181862define('PARSEKIT_ZEND_PRE_DEC_OBJ', 0);
181863define('PARSEKIT_ZEND_PRE_INC', 0);
181864define('PARSEKIT_ZEND_PRE_INC_OBJ', 0);
181865define('PARSEKIT_ZEND_PRINT', 0);
181866define('PARSEKIT_ZEND_QM_ASSIGN', 0);
181867define('PARSEKIT_ZEND_RAISE_ABSTRACT_ERROR', 0);
181868define('PARSEKIT_ZEND_RECV', 0);
181869define('PARSEKIT_ZEND_RECV_INIT', 0);
181870define('PARSEKIT_ZEND_RETURN', 0);
181871define('PARSEKIT_ZEND_SEND_REF', 0);
181872define('PARSEKIT_ZEND_SEND_VAL', 0);
181873define('PARSEKIT_ZEND_SEND_VAR', 0);
181874define('PARSEKIT_ZEND_SEND_VAR_NO_REF', 0);
181875define('PARSEKIT_ZEND_SL', 0);
181876define('PARSEKIT_ZEND_SR', 0);
181877define('PARSEKIT_ZEND_SUB', 0);
181878define('PARSEKIT_ZEND_SWITCH_FREE', 0);
181879define('PARSEKIT_ZEND_THROW', 0);
181880define('PARSEKIT_ZEND_TICKS', 0);
181881define('PARSEKIT_ZEND_UNSET_DIM_OBJ', 0);
181882define('PARSEKIT_ZEND_UNSET_VAR', 0);
181883define('PARSEKIT_ZEND_USER_CLASS', 0);
181884define('PARSEKIT_ZEND_USER_FUNCTION', 0);
181885define('PARSEKIT_ZEND_VERIFY_ABSTRACT_CLASS', 0);
181886define('PASSWORD_ARGON2I', '');
181887define('PASSWORD_ARGON2ID', '');
181888define('PASSWORD_ARGON2_DEFAULT_MEMORY_COST', 0);
181889define('PASSWORD_ARGON2_DEFAULT_THREADS', 0);
181890define('PASSWORD_ARGON2_DEFAULT_TIME_COST', 0);
181891define('PASSWORD_BCRYPT', 0);
181892define('PASSWORD_DEFAULT', 0);
181893define('PATHINFO_BASENAME', 0);
181894define('PATHINFO_DIRNAME', 0);
181895define('PATHINFO_EXTENSION', 0);
181896define('PATHINFO_FILENAME', 0);
181897define('PATH_SEPARATOR', '');
181898define('PCRE_VERSION', 0);
181899define('PEAR_EXTENSION_DIR', '');
181900define('PEAR_INSTALL_DIR', '');
181901define('PERM_ADMIN', 0);
181902define('PERM_ALL', 0);
181903define('PERM_CREATE', 0);
181904define('PERM_DELETE', 0);
181905define('PERM_READ', 0);
181906define('PERM_WRITE', 0);
181907define('PGSQL_ASSOC', 0);
181908define('PGSQL_BAD_RESPONSE', 0);
181909define('PGSQL_BOTH', 0);
181910define('PGSQL_COMMAND_OK', 0);
181911define('PGSQL_CONNECTION_AUTH_OK', 0);
181912define('PGSQL_CONNECTION_AWAITING_RESPONSE', 0);
181913define('PGSQL_CONNECTION_BAD', 0);
181914define('PGSQL_CONNECTION_MADE', 0);
181915define('PGSQL_CONNECTION_OK', 0);
181916define('PGSQL_CONNECTION_SETENV', 0);
181917define('PGSQL_CONNECTION_SSL_STARTUP', 0);
181918define('PGSQL_CONNECTION_STARTED', 0);
181919define('PGSQL_CONNECT_ASYNC', 0);
181920define('PGSQL_CONNECT_FORCE_NEW', 0);
181921define('PGSQL_CONV_FORCE_NULL', 0);
181922define('PGSQL_CONV_IGNORE_DEFAULT', 0);
181923define('PGSQL_CONV_IGNORE_NOT_NULL', 0);
181924define('PGSQL_COPY_IN', 0);
181925define('PGSQL_COPY_OUT', 0);
181926define('PGSQL_DIAG_COLUMN_NAME', '');
181927define('PGSQL_DIAG_CONSTRAINT_NAME', '');
181928define('PGSQL_DIAG_CONTEXT', 0);
181929define('PGSQL_DIAG_DATATYPE_NAME', '');
181930define('PGSQL_DIAG_INTERNAL_POSITION', 0);
181931define('PGSQL_DIAG_INTERNAL_QUERY', 0);
181932define('PGSQL_DIAG_MESSAGE_DETAIL', 0);
181933define('PGSQL_DIAG_MESSAGE_HINT', 0);
181934define('PGSQL_DIAG_MESSAGE_PRIMARY', 0);
181935define('PGSQL_DIAG_SCHEMA_NAME', '');
181936define('PGSQL_DIAG_SEVERITY', 0);
181937define('PGSQL_DIAG_SEVERITY_NONLOCALIZED', 0);
181938define('PGSQL_DIAG_SOURCE_FILE', 0);
181939define('PGSQL_DIAG_SOURCE_FUNCTION', 0);
181940define('PGSQL_DIAG_SOURCE_LINE', 0);
181941define('PGSQL_DIAG_SQLSTATE', 0);
181942define('PGSQL_DIAG_STATEMENT_POSITION', 0);
181943define('PGSQL_DIAG_TABLE_NAME', '');
181944define('PGSQL_DML_ASYNC', 0);
181945define('PGSQL_DML_ESCAPE', 0);
181946define('PGSQL_DML_EXEC', 0);
181947define('PGSQL_DML_NO_CONV', 0);
181948define('PGSQL_DML_STRING', 0);
181949define('PGSQL_EMPTY_QUERY', 0);
181950define('PGSQL_ERRORS_DEFAULT', 0);
181951define('PGSQL_ERRORS_TERSE', 0);
181952define('PGSQL_ERRORS_VERBOSE', 0);
181953define('PGSQL_FATAL_ERROR', 0);
181954define('PGSQL_LIBPQ_VERSION', '');
181955define('PGSQL_LIBPQ_VERSION_STR', '');
181956define('PGSQL_NONFATAL_ERROR', 0);
181957define('PGSQL_NOTICE_ALL', 0);
181958define('PGSQL_NOTICE_CLEAR', 0);
181959define('PGSQL_NOTICE_LAST', 0);
181960define('PGSQL_NUM', 0);
181961define('PGSQL_POLLING_ACTIVE', 0);
181962define('PGSQL_POLLING_FAILED', 0);
181963define('PGSQL_POLLING_OK', 0);
181964define('PGSQL_POLLING_READING', 0);
181965define('PGSQL_POLLING_WRITING', 0);
181966define('PGSQL_SEEK_CUR', 0);
181967define('PGSQL_SEEK_END', 0);
181968define('PGSQL_SEEK_SET', 0);
181969define('PGSQL_STATUS_LONG', 0);
181970define('PGSQL_STATUS_STRING', 0);
181971define('PGSQL_TRANSACTION_ACTIVE', 0);
181972define('PGSQL_TRANSACTION_IDLE', 0);
181973define('PGSQL_TRANSACTION_INERROR', 0);
181974define('PGSQL_TRANSACTION_INTRANS', 0);
181975define('PGSQL_TRANSACTION_UNKNOWN', 0);
181976define('PGSQL_TUPLES_OK', 0);
181977define('PHPDBG_COLOR_ERROR', 0);
181978define('PHPDBG_COLOR_NOTICE', 0);
181979define('PHPDBG_COLOR_PROMPT', 0);
181980define('PHPDBG_FILE', 0);
181981define('PHPDBG_FUNC', 0);
181982define('PHPDBG_LINENO', 0);
181983define('PHPDBG_METHOD', 0);
181984define('PHPDBG_VERSION', '');
181985define('PHP_BINARY', '');
181986define('PHP_BINARY_READ', 0);
181987define('PHP_BINDIR', '');
181988define('PHP_CONFIG_FILE_PATH', '');
181989define('PHP_CONFIG_FILE_SCAN_DIR', '');
181990define('PHP_DATADIR', '');
181991define('PHP_DEBUG', 0);
181992define('PHP_EOL', '');
181993define('PHP_EXTENSION_DIR', '');
181994define('PHP_EXTRA_VERSION', '');
181995define('PHP_FD_SETSIZE', '');
181996define('PHP_FLOAT_DIG', 0);
181997define('PHP_FLOAT_EPSILON', 0.0);
181998define('PHP_FLOAT_MAX', 0.0);
181999define('PHP_FLOAT_MIN', 0.0);
182000define('PHP_INT_MAX', 0);
182001define('PHP_INT_MIN', 0);
182002define('PHP_INT_SIZE', 0);
182003define('PHP_LIBDIR', '');
182004define('PHP_LOCALSTATEDIR', '');
182005define('PHP_MAJOR_VERSION', 0);
182006define('PHP_MANDIR', '');
182007define('PHP_MAXPATHLEN', 0);
182008define('PHP_MINOR_VERSION', 0);
182009define('PHP_NORMAL_READ', 0);
182010define('PHP_OS', '');
182011define('PHP_OS_FAMILY', '');
182012define('PHP_OUTPUT_HANDLER_CLEAN', 0);
182013/**
182014 * {@link ob_clean}, {@link ob_end_clean}, and {@link ob_get_clean}.
182015 **/
182016define('PHP_OUTPUT_HANDLER_CLEANABLE', 0);
182017define('PHP_OUTPUT_HANDLER_CONT', 0);
182018define('PHP_OUTPUT_HANDLER_END', 0);
182019define('PHP_OUTPUT_HANDLER_FINAL', 0);
182020define('PHP_OUTPUT_HANDLER_FLUSH', 0);
182021/**
182022 * {@link ob_end_flush}, {@link ob_flush}, and {@link ob_get_flush}.
182023 **/
182024define('PHP_OUTPUT_HANDLER_FLUSHABLE', 0);
182025/**
182026 * {@link ob_end_clean}, {@link ob_end_flush}, and {@link ob_get_flush}.
182027 **/
182028define('PHP_OUTPUT_HANDLER_REMOVABLE', 0);
182029define('PHP_OUTPUT_HANDLER_START', 0);
182030define('PHP_OUTPUT_HANDLER_STDFLAGS', 0);
182031define('PHP_OUTPUT_HANDLER_WRITE', 0);
182032define('PHP_PREFIX', '');
182033define('PHP_QUERY_RFC1738', 0);
182034define('PHP_QUERY_RFC3986', 0);
182035define('PHP_RELEASE_VERSION', 0);
182036/**
182037 * Round {@link val} down to {@link precision} decimal places towards
182038 * zero, when it is half way there. Making 1.5 into 1 and -1.5 into -1.
182039 **/
182040define('PHP_ROUND_HALF_DOWN', 0);
182041/**
182042 * Round {@link val} to {@link precision} decimal places towards the
182043 * nearest even value.
182044 **/
182045define('PHP_ROUND_HALF_EVEN', 0);
182046/**
182047 * Round {@link val} to {@link precision} decimal places towards the
182048 * nearest odd value.
182049 **/
182050define('PHP_ROUND_HALF_ODD', 0);
182051/**
182052 * Round {@link val} up to {@link precision} decimal places away from
182053 * zero, when it is half way there. Making 1.5 into 2 and -1.5 into -2.
182054 **/
182055define('PHP_ROUND_HALF_UP', 0);
182056define('PHP_SAPI', '');
182057define('PHP_SESSION_ACTIVE', 0);
182058define('PHP_SESSION_DISABLED', 0);
182059define('PHP_SESSION_NONE', 0);
182060define('PHP_SHLIB_SUFFIX', '');
182061define('PHP_SVN_AUTH_PARAM_IGNORE_SSL_VERIFY_ERRORS', '');
182062define('PHP_SYSCONFDIR', '');
182063define('PHP_URL_FRAGMENT', 0);
182064define('PHP_URL_HOST', 0);
182065define('PHP_URL_PASS', 0);
182066define('PHP_URL_PATH', 0);
182067define('PHP_URL_PORT', 0);
182068define('PHP_URL_QUERY', 0);
182069define('PHP_URL_SCHEME', 0);
182070define('PHP_URL_USER', 0);
182071define('PHP_VERSION', '');
182072define('PHP_VERSION_ID', 0);
182073define('PHP_WINDOWS_EVENT_CTRL_BREAK', 0);
182074define('PHP_WINDOWS_EVENT_CTRL_C', 0);
182075define('PHP_WINDOWS_NT_DOMAIN_CONTROLLER', 0);
182076define('PHP_WINDOWS_NT_SERVER', 0);
182077define('PHP_WINDOWS_NT_WORKSTATION', 0);
182078define('PHP_WINDOWS_VERSION_BUILD', 0);
182079define('PHP_WINDOWS_VERSION_MAJOR', 0);
182080define('PHP_WINDOWS_VERSION_MINOR', 0);
182081define('PHP_WINDOWS_VERSION_PLATFORM', 0);
182082define('PHP_WINDOWS_VERSION_PRODUCTTYPE', 0);
182083define('PHP_WINDOWS_VERSION_SP_MAJOR', 0);
182084define('PHP_WINDOWS_VERSION_SP_MINOR', 0);
182085define('PHP_WINDOWS_VERSION_SUITEMASK', 0);
182086define('PHP_ZTS', 0);
182087/**
182088 * Normally the input message is converted to "canonical" format which is
182089 * effectively using CR and LF as end of line: as required by the S/MIME
182090 * specification. When this option is present, no translation occurs.
182091 * This is useful when handling binary data which may not be in MIME
182092 * format.
182093 **/
182094define('PKCS7_BINARY', 0);
182095/**
182096 * When signing a message, use cleartext signing with the MIME type
182097 * "multipart/signed". This is the default if you do not specify any
182098 * {@link flags} to {@link openssl_pkcs7_sign}. If you turn this option
182099 * off, the message will be signed using opaque signing, which is more
182100 * resistant to translation by mail relays but cannot be read by mail
182101 * agents that do not support S/MIME.
182102 **/
182103define('PKCS7_DETACHED', 0);
182104/**
182105 * Normally when a message is signed, a set of attributes are included
182106 * which include the signing time and the supported symmetric algorithms.
182107 * With this option they are not included.
182108 **/
182109define('PKCS7_NOATTR', 0);
182110/**
182111 * When signing a message the signer's certificate is normally included -
182112 * with this option it is excluded. This will reduce the size of the
182113 * signed message but the verifier must have a copy of the signers
182114 * certificate available locally (passed using the {@link extracerts} to
182115 * {@link openssl_pkcs7_verify} for example).
182116 **/
182117define('PKCS7_NOCERTS', 0);
182118/**
182119 * Do not chain verification of signers certificates: that is don't use
182120 * the certificates in the signed message as untrusted CAs.
182121 **/
182122define('PKCS7_NOCHAIN', 0);
182123/**
182124 * When verifying a message, certificates (if any) included in the
182125 * message are normally searched for the signing certificate. With this
182126 * option only the certificates specified in the {@link extracerts}
182127 * parameter of {@link openssl_pkcs7_verify} are used. The supplied
182128 * certificates can still be used as untrusted CAs however.
182129 **/
182130define('PKCS7_NOINTERN', 0);
182131/**
182132 * Don't try and verify the signatures on a message
182133 **/
182134define('PKCS7_NOSIGS', 0);
182135/**
182136 * Do not verify the signers certificate of a signed message.
182137 **/
182138define('PKCS7_NOVERIFY', 0);
182139/**
182140 * Adds text/plain content type headers to encrypted/signed message. If
182141 * decrypting or verifying, it strips those headers from the output - if
182142 * the decrypted or verified message is not of MIME type text/plain then
182143 * an error will occur.
182144 **/
182145define('PKCS7_TEXT', 0);
182146/**
182147 * String for Post meridian.
182148 **/
182149define('PM_STR', 0);
182150define('PNG_ALL_FILTERS', 0);
182151define('PNG_FILTER_AVG', 0);
182152define('PNG_FILTER_NONE', 0);
182153define('PNG_FILTER_PAETH', 0);
182154define('PNG_FILTER_SUB', 0);
182155define('PNG_FILTER_UP', 0);
182156define('PNG_NO_FILTER', 0);
182157define('POLL_ERR', 0);
182158define('POLL_HUP', 0);
182159define('POLL_IN', 0);
182160define('POLL_MSG', 0);
182161define('POLL_OUT', 0);
182162define('POLL_PRI', 0);
182163/**
182164 * Sign for positive values.
182165 **/
182166define('POSITIVE_SIGN', 0);
182167define('POSIX_F_OK', 0);
182168define('POSIX_RLIMIT_AS', 0);
182169define('POSIX_RLIMIT_CORE', 0);
182170define('POSIX_RLIMIT_CPU', 0);
182171define('POSIX_RLIMIT_DATA', 0);
182172define('POSIX_RLIMIT_FSIZE', 0);
182173define('POSIX_RLIMIT_INFINITY', 0);
182174define('POSIX_RLIMIT_LOCKS', 0);
182175define('POSIX_RLIMIT_MEMLOCK', 0);
182176define('POSIX_RLIMIT_MSGQUEUE', 0);
182177define('POSIX_RLIMIT_NICE', 0);
182178define('POSIX_RLIMIT_NOFILE', 0);
182179define('POSIX_RLIMIT_NPROC', 0);
182180define('POSIX_RLIMIT_RSS', 0);
182181define('POSIX_RLIMIT_RTPRIO', 0);
182182define('POSIX_RLIMIT_RTTIME', 0);
182183define('POSIX_RLIMIT_SIGPENDING', 0);
182184define('POSIX_RLIMIT_STACK', 0);
182185define('POSIX_R_OK', 0);
182186define('POSIX_S_IFBLK', 0);
182187define('POSIX_S_IFCHR', 0);
182188define('POSIX_S_IFIFO', 0);
182189define('POSIX_S_IFREG', 0);
182190define('POSIX_S_IFSOCK', 0);
182191define('POSIX_W_OK', 0);
182192define('POSIX_X_OK', 0);
182193define('PREG_BACKTRACK_LIMIT_ERROR', 0);
182194define('PREG_BAD_UTF8_ERROR', 0);
182195define('PREG_BAD_UTF8_OFFSET_ERROR', 0);
182196define('PREG_INTERNAL_ERROR', 0);
182197define('PREG_JIT_STACKLIMIT_ERROR', 0);
182198define('PREG_NO_ERROR', 0);
182199define('PREG_OFFSET_CAPTURE', 0);
182200define('PREG_PATTERN_ORDER', 0);
182201define('PREG_RECURSION_LIMIT_ERROR', 0);
182202define('PREG_SET_ORDER', 0);
182203define('PREG_SPLIT_DELIM_CAPTURE', 0);
182204define('PREG_SPLIT_NO_EMPTY', 0);
182205define('PREG_SPLIT_OFFSET_CAPTURE', 0);
182206define('PREG_UNMATCHED_AS_NULL', 0);
182207define('PROF_TRACE', 0);
182208/**
182209 * The filter experienced an unrecoverable error and cannot continue.
182210 **/
182211define('PSFS_ERR_FATAL', 0);
182212/**
182213 * Filter processed successfully, however no data was available to
182214 * return. More data is required from the stream or prior filter.
182215 **/
182216define('PSFS_FEED_ME', 0);
182217define('PSFS_FLAG_FLUSH_CLOSE', 0);
182218define('PSFS_FLAG_FLUSH_INC', 0);
182219define('PSFS_FLAG_NORMAL', 0);
182220/**
182221 * Filter processed successfully with data available in the {@link out}
182222 * bucket brigade.
182223 **/
182224define('PSFS_PASS_ON', 0);
182225define('PSPELL_BAD_SPELLERS', 0);
182226define('PSPELL_FAST', 0);
182227define('PSPELL_NORMAL', 0);
182228define('PSPELL_RUN_TOGETHER', 0);
182229define('PTHREADS_ALLOW_HEADERS', 0);
182230define('PTHREADS_INHERIT_ALL', 0);
182231define('PTHREADS_INHERIT_CLASSES', 0);
182232define('PTHREADS_INHERIT_COMMENTS', 0);
182233define('PTHREADS_INHERIT_CONSTANTS', 0);
182234define('PTHREADS_INHERIT_FUNCTIONS', 0);
182235define('PTHREADS_INHERIT_INCLUDES', 0);
182236define('PTHREADS_INHERIT_INI', 0);
182237define('PTHREADS_INHERIT_NONE', 0);
182238/**
182239 * Returns 1 if CURRENCY_SYMBOL precedes a positive value.
182240 **/
182241define('P_CS_PRECEDES', 0);
182242/**
182243 * Returns 1 if a space separates CURRENCY_SYMBOL from a positive value.
182244 **/
182245define('P_SEP_BY_SPACE', 0);
182246/**
182247 * Returns 0 if parentheses surround the quantity and CURRENCY_SYMBOL.
182248 * Returns 1 if the sign string precedes the quantity and
182249 * CURRENCY_SYMBOL. Returns 2 if the sign string follows the quantity and
182250 * CURRENCY_SYMBOL. Returns 3 if the sign string immediately precedes the
182251 * CURRENCY_SYMBOL. Returns 4 if the sign string immediately follows the
182252 * CURRENCY_SYMBOL.
182253 **/
182254define('P_SIGN_POSN', 0);
182255define('RADIUS_ACCESS_ACCEPT', 0);
182256define('RADIUS_ACCESS_CHALLENGE', 0);
182257define('RADIUS_ACCESS_REJECT', 0);
182258define('RADIUS_ACCESS_REQUEST', 0);
182259define('RADIUS_ACCOUNTING_REQUEST', 0);
182260define('RADIUS_ACCOUNTING_RESPONSE', 0);
182261define('RADIUS_ACCT_AUTHENTIC', 0);
182262define('RADIUS_ACCT_DELAY_TIME', 0);
182263define('RADIUS_ACCT_INPUT_OCTETS', 0);
182264define('RADIUS_ACCT_INPUT_PACKETS', 0);
182265define('RADIUS_ACCT_LINK_COUNT', 0);
182266define('RADIUS_ACCT_MULTI_SESSION_ID', 0);
182267define('RADIUS_ACCT_OUTPUT_OCTETS', 0);
182268define('RADIUS_ACCT_OUTPUT_PACKETS', 0);
182269define('RADIUS_ACCT_SESSION_ID', 0);
182270define('RADIUS_ACCT_SESSION_TIME', 0);
182271define('RADIUS_ACCT_STATUS_TYPE', 0);
182272define('RADIUS_ACCT_TERMINATE_CAUSE', 0);
182273define('RADIUS_CALLBACK_ID', 0);
182274define('RADIUS_CALLBACK_NUMBER', 0);
182275define('RADIUS_CALLED_STATION_ID', 0);
182276define('RADIUS_CALLING_STATION_ID', 0);
182277define('RADIUS_CHAP_CHALLENGE', 0);
182278define('RADIUS_CHAP_PASSWORD', 0);
182279define('RADIUS_CLASS', 0);
182280define('RADIUS_COA_ACK', 0);
182281define('RADIUS_COA_NAK', 0);
182282define('RADIUS_COA_REQUEST', 0);
182283define('RADIUS_CONNECT_INFO', 0);
182284define('RADIUS_DISCONNECT_ACK', 0);
182285define('RADIUS_DISCONNECT_NAK', 0);
182286define('RADIUS_DISCONNECT_REQUEST', 0);
182287define('RADIUS_FILTER_ID', 0);
182288define('RADIUS_FRAMED_APPLETALK_LINK', 0);
182289define('RADIUS_FRAMED_APPLETALK_NETWORK', 0);
182290define('RADIUS_FRAMED_APPLETALK_ZONE', 0);
182291define('RADIUS_FRAMED_COMPRESSION', 0);
182292define('RADIUS_FRAMED_IPX_NETWORK', 0);
182293define('RADIUS_FRAMED_IP_ADDRESS', 0);
182294define('RADIUS_FRAMED_IP_NETMASK', 0);
182295define('RADIUS_FRAMED_MTU', 0);
182296define('RADIUS_FRAMED_PROTOCOL', 0);
182297define('RADIUS_FRAMED_ROUTE', 0);
182298define('RADIUS_FRAMED_ROUTING', 0);
182299define('RADIUS_IDLE_TIMEOUT', 0);
182300define('RADIUS_LOGIN_IP_HOST', 0);
182301define('RADIUS_LOGIN_LAT_GROUP', 0);
182302define('RADIUS_LOGIN_LAT_NODE', 0);
182303define('RADIUS_LOGIN_LAT_PORT', 0);
182304define('RADIUS_LOGIN_LAT_SERVICE', 0);
182305define('RADIUS_LOGIN_SERVICE', 0);
182306define('RADIUS_LOGIN_TCP_PORT', 0);
182307define('RADIUS_MPPE_KEY_LEN', 0);
182308define('RADIUS_NAS_IDENTIFIER', 0);
182309define('RADIUS_NAS_IP_ADDRESS', 0);
182310define('RADIUS_NAS_PORT', 0);
182311define('RADIUS_NAS_PORT_TYPE', 0);
182312define('RADIUS_OPTION_SALT', 0);
182313define('RADIUS_OPTION_TAGGED', 0);
182314define('RADIUS_PORT_LIMIT', 0);
182315define('RADIUS_PROXY_STATE', 0);
182316define('RADIUS_REPLY_MESSAGE', 0);
182317define('RADIUS_SERVICE_TYPE', 0);
182318define('RADIUS_SESSION_TIMEOUT', 0);
182319define('RADIUS_STATE', 0);
182320define('RADIUS_TERMINATION_ACTION', 0);
182321define('RADIUS_USER_NAME', 0);
182322define('RADIUS_USER_PASSWORD', 0);
182323define('RADIUS_VENDOR_MICROSOFT', 0);
182324define('RADIUS_VENDOR_SPECIFIC', 0);
182325/**
182326 * Same value as DECIMAL_POINT.
182327 **/
182328define('RADIXCHAR', 0);
182329define('RAR_HOST_BEOS', 0);
182330define('RAR_HOST_MSDOS', 0);
182331define('RAR_HOST_OS2', 0);
182332define('RAR_HOST_UNIX', 0);
182333define('RAR_HOST_WIN32', 0);
182334define('READLINE_LIB', '');
182335define('READONLY_STATE', 0);
182336define('RECONFIGDISABLED', 0);
182337define('RECONFIGINPROGRESS', 0);
182338define('REPLACE', 0);
182339define('RPMMIRE_DEFAULT', 0);
182340define('RPMMIRE_GLOB', 0);
182341define('RPMMIRE_REGEX', 0);
182342define('RPMMIRE_STRCMP', 0);
182343define('RPMREADER_ARCH', 0);
182344define('RPMREADER_ARCHIVESIZE', 0);
182345define('RPMREADER_BASENAMES', 0);
182346define('RPMREADER_BUILDARCHS', 0);
182347define('RPMREADER_BUILDHOST', 0);
182348define('RPMREADER_BUILDTIME', 0);
182349define('RPMREADER_CACHECTIME', 0);
182350define('RPMREADER_CACHEPKGMTIME', 0);
182351define('RPMREADER_CACHEPKGPATH', 0);
182352define('RPMREADER_CACHEPKGSIZE', 0);
182353define('RPMREADER_CHANGELOGNAME', 0);
182354define('RPMREADER_CHANGELOGTEXT', 0);
182355define('RPMREADER_CHANGELOGTIME', 0);
182356define('RPMREADER_CLASSDICT', 0);
182357define('RPMREADER_CONFLICTFLAGS', 0);
182358define('RPMREADER_CONFLICTNAME', 0);
182359define('RPMREADER_CONFLICTVERSION', 0);
182360define('RPMREADER_COOKIE', 0);
182361define('RPMREADER_COPYRIGHT', 0);
182362define('RPMREADER_DEPENDSDICT', 0);
182363define('RPMREADER_DESCRIPTION', 0);
182364define('RPMREADER_DIRINDEXES', 0);
182365define('RPMREADER_DIRNAMES', 0);
182366define('RPMREADER_DISTRIBUTION', 0);
182367define('RPMREADER_DISTURL', 0);
182368define('RPMREADER_EPOCH', 0);
182369define('RPMREADER_EXCLUDEARCH', 0);
182370define('RPMREADER_EXCLUDEOS', 0);
182371define('RPMREADER_EXCLUSIVEARCH', 0);
182372define('RPMREADER_EXCLUSIVEOS', 0);
182373define('RPMREADER_FILECLASS', 0);
182374define('RPMREADER_FILECOLORS', 0);
182375define('RPMREADER_FILECONTEXTS', 0);
182376define('RPMREADER_FILEDEPENDSN', 0);
182377define('RPMREADER_FILEDEPENDSX', 0);
182378define('RPMREADER_FILEDEVICES', 0);
182379define('RPMREADER_FILEFLAGS', 0);
182380define('RPMREADER_FILEGROUPNAME', 0);
182381define('RPMREADER_FILEINODES', 0);
182382define('RPMREADER_FILELANGS', 0);
182383define('RPMREADER_FILELINKTOS', 0);
182384define('RPMREADER_FILEMD5S', 0);
182385define('RPMREADER_FILEMODES', 0);
182386define('RPMREADER_FILEMTIMES', 0);
182387define('RPMREADER_FILERDEVS', 0);
182388define('RPMREADER_FILESIZES', 0);
182389define('RPMREADER_FILESTATES', 0);
182390define('RPMREADER_FILEUSERNAME', 0);
182391define('RPMREADER_FILEVERIFYFLAGS', 0);
182392define('RPMREADER_FSCONTEXTS', 0);
182393define('RPMREADER_GIF', 0);
182394define('RPMREADER_GROUP', 0);
182395define('RPMREADER_ICON', 0);
182396define('RPMREADER_INSTALLCOLOR', 0);
182397define('RPMREADER_INSTALLTID', 0);
182398define('RPMREADER_INSTALLTIME', 0);
182399define('RPMREADER_INSTPREFIXES', 0);
182400define('RPMREADER_LICENSE', 0);
182401define('RPMREADER_MAXIMUM', 0);
182402define('RPMREADER_MINIMUM', 0);
182403define('RPMREADER_NAME', 0);
182404define('RPMREADER_OBSOLETEFLAGS', 0);
182405define('RPMREADER_OBSOLETENAME', 0);
182406define('RPMREADER_OBSOLETES', 0);
182407define('RPMREADER_OBSOLETEVERSION', 0);
182408define('RPMREADER_OLDFILENAMES', 0);
182409define('RPMREADER_OPTFLAGS', 0);
182410define('RPMREADER_OS', 0);
182411define('RPMREADER_PACKAGER', 0);
182412define('RPMREADER_PATCH', 0);
182413define('RPMREADER_PATCHESFLAGS', 0);
182414define('RPMREADER_PATCHESNAME', 0);
182415define('RPMREADER_PATCHESVERSION', 0);
182416define('RPMREADER_PAYLOADCOMPRESSOR', 0);
182417define('RPMREADER_PAYLOADFLAGS', 0);
182418define('RPMREADER_PAYLOADFORMAT', 0);
182419define('RPMREADER_PLATFORM', 0);
182420define('RPMREADER_POLICIES', 0);
182421define('RPMREADER_POSTIN', 0);
182422define('RPMREADER_POSTINPROG', 0);
182423define('RPMREADER_POSTUN', 0);
182424define('RPMREADER_POSTUNPROG', 0);
182425define('RPMREADER_PREFIXES', 0);
182426define('RPMREADER_PREIN', 0);
182427define('RPMREADER_PREINPROG', 0);
182428define('RPMREADER_PREUN', 0);
182429define('RPMREADER_PREUNPROG', 0);
182430define('RPMREADER_PROVIDEFLAGS', 0);
182431define('RPMREADER_PROVIDENAME', 0);
182432define('RPMREADER_PROVIDES', 0);
182433define('RPMREADER_PROVIDEVERSION', 0);
182434define('RPMREADER_RECONTEXTS', 0);
182435define('RPMREADER_RELEASE', 0);
182436define('RPMREADER_REMOVETID', 0);
182437define('RPMREADER_REQUIREFLAGS', 0);
182438define('RPMREADER_REQUIRENAME', 0);
182439define('RPMREADER_REQUIREVERSION', 0);
182440define('RPMREADER_RHNPLATFORM', 0);
182441define('RPMREADER_RPMVERSION', 0);
182442define('RPMREADER_SERIAL', 0);
182443define('RPMREADER_SIZE', 0);
182444define('RPMREADER_SOURCE', 0);
182445define('RPMREADER_SOURCEPKGID', 0);
182446define('RPMREADER_SOURCERPM', 0);
182447define('RPMREADER_SUMMARY', 0);
182448define('RPMREADER_TRIGGERFLAGS', 0);
182449define('RPMREADER_TRIGGERINDEX', 0);
182450define('RPMREADER_TRIGGERNAME', 0);
182451define('RPMREADER_TRIGGERSCRIPTPROG', 0);
182452define('RPMREADER_TRIGGERSCRIPTS', 0);
182453define('RPMREADER_TRIGGERVERSION', 0);
182454define('RPMREADER_URL', 0);
182455define('RPMREADER_VENDOR', 0);
182456define('RPMREADER_VERIFYSCRIPT', 0);
182457define('RPMREADER_VERIFYSCRIPTPROG', 0);
182458define('RPMREADER_VERSION', 0);
182459define('RPMREADER_XPM', 0);
182460define('RPMSENSE_ANY', 0);
182461define('RPMSENSE_CONFIG', 0);
182462define('RPMSENSE_EQUAL', 0);
182463define('RPMSENSE_FIND_PROVIDES', 0);
182464define('RPMSENSE_FIND_REQUIRES', 0);
182465define('RPMSENSE_GREATER', 0);
182466define('RPMSENSE_INTERP', 0);
182467define('RPMSENSE_KEYRING', 0);
182468define('RPMSENSE_LESS', 0);
182469define('RPMSENSE_MISSINGOK', 0);
182470define('RPMSENSE_POSTTRANS', 0);
182471define('RPMSENSE_PREREQ', 0);
182472define('RPMSENSE_PRETRANS', 0);
182473define('RPMSENSE_RPMLIB', 0);
182474define('RPMSENSE_SCRIPT_POST', 0);
182475define('RPMSENSE_SCRIPT_POSTUN', 0);
182476define('RPMSENSE_SCRIPT_PRE', 0);
182477define('RPMSENSE_SCRIPT_PREUN', 0);
182478define('RPMSENSE_SCRIPT_VERIFY', 0);
182479define('RPMSENSE_TRIGGERIN', 0);
182480define('RPMSENSE_TRIGGERPOSTUN', 0);
182481define('RPMSENSE_TRIGGERPREIN', 0);
182482define('RPMSENSE_TRIGGERUN', 0);
182483define('RPMTAG_ARCH', 0);
182484define('RPMTAG_ARCHIVESIZE', 0);
182485define('RPMTAG_BASENAMES', 0);
182486define('RPMTAG_BUGURL', 0);
182487define('RPMTAG_BUILDARCHS', 0);
182488define('RPMTAG_BUILDHOST', 0);
182489define('RPMTAG_BUILDTIME', 0);
182490define('RPMTAG_C', 0);
182491define('RPMTAG_CHANGELOGNAME', 0);
182492define('RPMTAG_CHANGELOGTEXT', 0);
182493define('RPMTAG_CHANGELOGTIME', 0);
182494define('RPMTAG_CLASSDICT', 0);
182495define('RPMTAG_CONFLICTFLAGS', 0);
182496define('RPMTAG_CONFLICTNAME', 0);
182497define('RPMTAG_CONFLICTNEVRS', 0);
182498define('RPMTAG_CONFLICTS', 0);
182499define('RPMTAG_CONFLICTVERSION', 0);
182500define('RPMTAG_COOKIE', 0);
182501define('RPMTAG_DBINSTANCE', 0);
182502define('RPMTAG_DEPENDSDICT', 0);
182503define('RPMTAG_DESCRIPTION', 0);
182504define('RPMTAG_DIRINDEXES', 0);
182505define('RPMTAG_DIRNAMES', 0);
182506define('RPMTAG_DISTRIBUTION', 0);
182507define('RPMTAG_DISTTAG', 0);
182508define('RPMTAG_DISTURL', 0);
182509define('RPMTAG_DSAHEADER', 0);
182510define('RPMTAG_E', 0);
182511define('RPMTAG_ENCODING', 0);
182512define('RPMTAG_ENHANCEFLAGS', 0);
182513define('RPMTAG_ENHANCENAME', 0);
182514define('RPMTAG_ENHANCENEVRS', 0);
182515define('RPMTAG_ENHANCES', 0);
182516define('RPMTAG_ENHANCEVERSION', 0);
182517define('RPMTAG_EPOCH', 0);
182518define('RPMTAG_EPOCHNUM', 0);
182519define('RPMTAG_EVR', 0);
182520define('RPMTAG_EXCLUDEARCH', 0);
182521define('RPMTAG_EXCLUDEOS', 0);
182522define('RPMTAG_EXCLUSIVEARCH', 0);
182523define('RPMTAG_EXCLUSIVEOS', 0);
182524define('RPMTAG_FILECAPS', 0);
182525define('RPMTAG_FILECLASS', 0);
182526define('RPMTAG_FILECOLORS', 0);
182527define('RPMTAG_FILECONTEXTS', 0);
182528define('RPMTAG_FILEDEPENDSN', 0);
182529define('RPMTAG_FILEDEPENDSX', 0);
182530define('RPMTAG_FILEDEVICES', 0);
182531define('RPMTAG_FILEDIGESTALGO', 0);
182532define('RPMTAG_FILEDIGESTS', 0);
182533define('RPMTAG_FILEFLAGS', 0);
182534define('RPMTAG_FILEGROUPNAME', 0);
182535define('RPMTAG_FILEINODES', 0);
182536define('RPMTAG_FILELANGS', 0);
182537define('RPMTAG_FILELINKTOS', 0);
182538define('RPMTAG_FILEMD5S', 0);
182539define('RPMTAG_FILEMODES', 0);
182540define('RPMTAG_FILEMTIMES', 0);
182541define('RPMTAG_FILENAMES', 0);
182542define('RPMTAG_FILENLINKS', 0);
182543define('RPMTAG_FILEPROVIDE', 0);
182544define('RPMTAG_FILERDEVS', 0);
182545define('RPMTAG_FILEREQUIRE', 0);
182546define('RPMTAG_FILESIGNATURELENGTH', 0);
182547define('RPMTAG_FILESIGNATURES', 0);
182548define('RPMTAG_FILESIZES', 0);
182549define('RPMTAG_FILESTATES', 0);
182550define('RPMTAG_FILETRIGGERCONDS', 0);
182551define('RPMTAG_FILETRIGGERFLAGS', 0);
182552define('RPMTAG_FILETRIGGERINDEX', 0);
182553define('RPMTAG_FILETRIGGERNAME', 0);
182554define('RPMTAG_FILETRIGGERPRIORITIES', 0);
182555define('RPMTAG_FILETRIGGERSCRIPTFLAGS', 0);
182556define('RPMTAG_FILETRIGGERSCRIPTPROG', 0);
182557define('RPMTAG_FILETRIGGERSCRIPTS', 0);
182558define('RPMTAG_FILETRIGGERTYPE', 0);
182559define('RPMTAG_FILETRIGGERVERSION', 0);
182560define('RPMTAG_FILEUSERNAME', 0);
182561define('RPMTAG_FILEVERIFYFLAGS', 0);
182562define('RPMTAG_FSCONTEXTS', 0);
182563define('RPMTAG_GIF', 0);
182564define('RPMTAG_GROUP', 0);
182565define('RPMTAG_HDRID', 0);
182566define('RPMTAG_HEADERCOLOR', 0);
182567define('RPMTAG_HEADERI18NTABLE', 0);
182568define('RPMTAG_HEADERIMAGE', 0);
182569define('RPMTAG_HEADERIMMUTABLE', 0);
182570define('RPMTAG_HEADERREGIONS', 0);
182571define('RPMTAG_HEADERSIGNATURES', 0);
182572define('RPMTAG_ICON', 0);
182573define('RPMTAG_INSTALLCOLOR', 0);
182574define('RPMTAG_INSTALLTID', 0);
182575define('RPMTAG_INSTALLTIME', 0);
182576define('RPMTAG_INSTFILENAMES', 0);
182577define('RPMTAG_INSTPREFIXES', 0);
182578define('RPMTAG_LICENSE', 0);
182579define('RPMTAG_LONGARCHIVESIZE', 0);
182580define('RPMTAG_LONGFILESIZES', 0);
182581define('RPMTAG_LONGSIGSIZE', 0);
182582define('RPMTAG_LONGSIZE', 0);
182583define('RPMTAG_MODULARITYLABEL', 0);
182584define('RPMTAG_N', 0);
182585define('RPMTAG_NAME', 0);
182586define('RPMTAG_NEVR', 0);
182587define('RPMTAG_NEVRA', 0);
182588define('RPMTAG_NOPATCH', 0);
182589define('RPMTAG_NOSOURCE', 0);
182590define('RPMTAG_NVR', 0);
182591define('RPMTAG_NVRA', 0);
182592define('RPMTAG_O', 0);
182593define('RPMTAG_OBSOLETEFLAGS', 0);
182594define('RPMTAG_OBSOLETENAME', 0);
182595define('RPMTAG_OBSOLETENEVRS', 0);
182596define('RPMTAG_OBSOLETES', 0);
182597define('RPMTAG_OBSOLETEVERSION', 0);
182598define('RPMTAG_OLDENHANCES', 0);
182599define('RPMTAG_OLDENHANCESFLAGS', 0);
182600define('RPMTAG_OLDENHANCESNAME', 0);
182601define('RPMTAG_OLDENHANCESVERSION', 0);
182602define('RPMTAG_OLDFILENAMES', 0);
182603define('RPMTAG_OLDSUGGESTS', 0);
182604define('RPMTAG_OLDSUGGESTSFLAGS', 0);
182605define('RPMTAG_OLDSUGGESTSNAME', 0);
182606define('RPMTAG_OLDSUGGESTSVERSION', 0);
182607define('RPMTAG_OPTFLAGS', 0);
182608define('RPMTAG_ORDERFLAGS', 0);
182609define('RPMTAG_ORDERNAME', 0);
182610define('RPMTAG_ORDERVERSION', 0);
182611define('RPMTAG_ORIGBASENAMES', 0);
182612define('RPMTAG_ORIGDIRINDEXES', 0);
182613define('RPMTAG_ORIGDIRNAMES', 0);
182614define('RPMTAG_ORIGFILENAMES', 0);
182615define('RPMTAG_OS', 0);
182616define('RPMTAG_P', 0);
182617define('RPMTAG_PACKAGER', 0);
182618define('RPMTAG_PATCH', 0);
182619define('RPMTAG_PATCHESFLAGS', 0);
182620define('RPMTAG_PATCHESNAME', 0);
182621define('RPMTAG_PATCHESVERSION', 0);
182622define('RPMTAG_PAYLOADCOMPRESSOR', 0);
182623define('RPMTAG_PAYLOADDIGEST', 0);
182624define('RPMTAG_PAYLOADDIGESTALGO', 0);
182625define('RPMTAG_PAYLOADFLAGS', 0);
182626define('RPMTAG_PAYLOADFORMAT', 0);
182627define('RPMTAG_PKGID', 0);
182628define('RPMTAG_PLATFORM', 0);
182629define('RPMTAG_POLICIES', 0);
182630define('RPMTAG_POLICYFLAGS', 0);
182631define('RPMTAG_POLICYNAMES', 0);
182632define('RPMTAG_POLICYTYPES', 0);
182633define('RPMTAG_POLICYTYPESINDEXES', 0);
182634define('RPMTAG_POSTIN', 0);
182635define('RPMTAG_POSTINFLAGS', 0);
182636define('RPMTAG_POSTINPROG', 0);
182637define('RPMTAG_POSTTRANS', 0);
182638define('RPMTAG_POSTTRANSFLAGS', 0);
182639define('RPMTAG_POSTTRANSPROG', 0);
182640define('RPMTAG_POSTUN', 0);
182641define('RPMTAG_POSTUNFLAGS', 0);
182642define('RPMTAG_POSTUNPROG', 0);
182643define('RPMTAG_PREFIXES', 0);
182644define('RPMTAG_PREIN', 0);
182645define('RPMTAG_PREINFLAGS', 0);
182646define('RPMTAG_PREINPROG', 0);
182647define('RPMTAG_PRETRANS', 0);
182648define('RPMTAG_PRETRANSFLAGS', 0);
182649define('RPMTAG_PRETRANSPROG', 0);
182650define('RPMTAG_PREUN', 0);
182651define('RPMTAG_PREUNFLAGS', 0);
182652define('RPMTAG_PREUNPROG', 0);
182653define('RPMTAG_PROVIDEFLAGS', 0);
182654define('RPMTAG_PROVIDENAME', 0);
182655define('RPMTAG_PROVIDENEVRS', 0);
182656define('RPMTAG_PROVIDES', 0);
182657define('RPMTAG_PROVIDEVERSION', 0);
182658define('RPMTAG_PUBKEYS', 0);
182659define('RPMTAG_R', 0);
182660define('RPMTAG_RECOMMENDFLAGS', 0);
182661define('RPMTAG_RECOMMENDNAME', 0);
182662define('RPMTAG_RECOMMENDNEVRS', 0);
182663define('RPMTAG_RECOMMENDS', 0);
182664define('RPMTAG_RECOMMENDVERSION', 0);
182665define('RPMTAG_RECONTEXTS', 0);
182666define('RPMTAG_RELEASE', 0);
182667define('RPMTAG_REMOVETID', 0);
182668define('RPMTAG_REQUIREFLAGS', 0);
182669define('RPMTAG_REQUIRENAME', 0);
182670define('RPMTAG_REQUIRENEVRS', 0);
182671define('RPMTAG_REQUIRES', 0);
182672define('RPMTAG_REQUIREVERSION', 0);
182673define('RPMTAG_RPMVERSION', 0);
182674define('RPMTAG_RSAHEADER', 0);
182675define('RPMTAG_SHA1HEADER', 0);
182676define('RPMTAG_SHA256HEADER', 0);
182677define('RPMTAG_SIGGPG', 0);
182678define('RPMTAG_SIGMD5', 0);
182679define('RPMTAG_SIGPGP', 0);
182680define('RPMTAG_SIGSIZE', 0);
182681define('RPMTAG_SIZE', 0);
182682define('RPMTAG_SOURCE', 0);
182683define('RPMTAG_SOURCEPACKAGE', 0);
182684define('RPMTAG_SOURCEPKGID', 0);
182685define('RPMTAG_SOURCERPM', 0);
182686define('RPMTAG_SUGGESTFLAGS', 0);
182687define('RPMTAG_SUGGESTNAME', 0);
182688define('RPMTAG_SUGGESTNEVRS', 0);
182689define('RPMTAG_SUGGESTS', 0);
182690define('RPMTAG_SUGGESTVERSION', 0);
182691define('RPMTAG_SUMMARY', 0);
182692define('RPMTAG_SUPPLEMENTFLAGS', 0);
182693define('RPMTAG_SUPPLEMENTNAME', 0);
182694define('RPMTAG_SUPPLEMENTNEVRS', 0);
182695define('RPMTAG_SUPPLEMENTS', 0);
182696define('RPMTAG_SUPPLEMENTVERSION', 0);
182697define('RPMTAG_TRANSFILETRIGGERCONDS', 0);
182698define('RPMTAG_TRANSFILETRIGGERFLAGS', 0);
182699define('RPMTAG_TRANSFILETRIGGERINDEX', 0);
182700define('RPMTAG_TRANSFILETRIGGERNAME', 0);
182701define('RPMTAG_TRANSFILETRIGGERPRIORITIES', 0);
182702define('RPMTAG_TRANSFILETRIGGERSCRIPTFLAGS', 0);
182703define('RPMTAG_TRANSFILETRIGGERSCRIPTPROG', 0);
182704define('RPMTAG_TRANSFILETRIGGERSCRIPTS', 0);
182705define('RPMTAG_TRANSFILETRIGGERTYPE', 0);
182706define('RPMTAG_TRANSFILETRIGGERVERSION', 0);
182707define('RPMTAG_TRIGGERCONDS', 0);
182708define('RPMTAG_TRIGGERFLAGS', 0);
182709define('RPMTAG_TRIGGERINDEX', 0);
182710define('RPMTAG_TRIGGERNAME', 0);
182711define('RPMTAG_TRIGGERSCRIPTFLAGS', 0);
182712define('RPMTAG_TRIGGERSCRIPTPROG', 0);
182713define('RPMTAG_TRIGGERSCRIPTS', 0);
182714define('RPMTAG_TRIGGERTYPE', 0);
182715define('RPMTAG_TRIGGERVERSION', 0);
182716define('RPMTAG_URL', 0);
182717define('RPMTAG_V', 0);
182718define('RPMTAG_VCS', 0);
182719define('RPMTAG_VENDOR', 0);
182720define('RPMTAG_VERBOSE', 0);
182721define('RPMTAG_VERIFYSCRIPT', 0);
182722define('RPMTAG_VERIFYSCRIPTFLAGS', 0);
182723define('RPMTAG_VERIFYSCRIPTPROG', 0);
182724define('RPMTAG_VERSION', 0);
182725define('RPMTAG_XPM', 0);
182726define('RPMVERSION', '');
182727define('RUNKIT7_ACC_PRIVATE', 0);
182728define('RUNKIT7_ACC_PROTECTED', 0);
182729define('RUNKIT7_ACC_PUBLIC', 0);
182730define('RUNKIT7_ACC_RETURN_REFERENCE', 0);
182731define('RUNKIT7_ACC_STATIC', 0);
182732define('RUNKIT7_FEATURE_MANIPULATION', 0);
182733define('RUNKIT7_FEATURE_SANDBOX', 0);
182734define('RUNKIT7_FEATURE_SUPERGLOBALS', 0);
182735define('RUNKIT7_IMPORT_CLASSES', 0);
182736define('RUNKIT7_IMPORT_CLASS_*', 0);
182737define('RUNKIT7_IMPORT_CLASS_CONSTS', 0);
182738define('RUNKIT7_IMPORT_CLASS_METHODS', 0);
182739define('RUNKIT7_IMPORT_CLASS_PROPS', 0);
182740define('RUNKIT7_IMPORT_CLASS_STATIC_PROPS', 0);
182741define('RUNKIT7_IMPORT_FUNCTIONS', 0);
182742define('RUNKIT7_IMPORT_OVERRIDE', 0);
182743define('RUNKIT_ACC_PRIVATE', 0);
182744define('RUNKIT_ACC_PROTECTED', 0);
182745define('RUNKIT_ACC_PUBLIC', 0);
182746define('RUNKIT_ACC_STATIC', 0);
182747define('RUNKIT_IMPORT_CLASSES', 0);
182748define('RUNKIT_IMPORT_CLASS_CONSTS', 0);
182749define('RUNKIT_IMPORT_CLASS_METHODS', 0);
182750define('RUNKIT_IMPORT_CLASS_PROPS', 0);
182751define('RUNKIT_IMPORT_CLASS_STATIC_PROPS', 0);
182752define('RUNKIT_IMPORT_FUNCTIONS', 0);
182753define('RUNKIT_IMPORT_OVERRIDE', 0);
182754define('RUNKIT_VERSION', '');
182755define('RUNTIMEINCONSISTENCY', 0);
182756define('SAM_AUTO', '');
182757/**
182758 * Any value passed will be interpreted as logical true or false. If the
182759 * value cannot be interpreted as a PHP boolean value the value passed to
182760 * the messaging system is undefined.
182761 **/
182762define('SAM_BOOLEAN', 0);
182763define('SAM_BUS', '');
182764/**
182765 * An 8-bit signed integer value. SAM will attempt to convert the
182766 * property value specified into a single byte value to pass to the
182767 * messaging system. If a string value is passed an attempt will be made
182768 * to interpret the string as a numeric value. If the numeric value
182769 * cannot be expressed as an 8-bit signed binary value data may be lost
182770 * in the conversion.
182771 **/
182772define('SAM_BYTE', 0);
182773define('SAM_BYTES', '');
182774define('SAM_CORRELID', '');
182775define('SAM_DELIVERYMODE', '');
182776/**
182777 * A long floating point value. SAM will attempt to convert the property
182778 * value specified into a floating point value with 15 digits of
182779 * precision. If a string value is passed an attempt will be made to
182780 * interpret the string as a numeric value. If the passed value cannot be
182781 * expressed as a 15 digit floating point value data may be lost in the
182782 * conversion.
182783 **/
182784define('SAM_DOUBLE', 0);
182785define('SAM_ENDPOINTS', '');
182786/**
182787 * A short floating point value. SAM will attempt to convert the property
182788 * value specified into a floating point value with 7 digits of
182789 * precision. If a string value is passed an attempt will be made to
182790 * interpret the string as a numeric value. If the passed value cannot be
182791 * expressed as a 7 digit floating point value data may be lost in the
182792 * conversion.
182793 **/
182794define('SAM_FLOAT', 0);
182795define('SAM_HOST', '');
182796/**
182797 * An 32-bit signed integer value. SAM will attempt to convert the
182798 * property value specified into a 32-bit value to pass to the messaging
182799 * system. If a string value is passed an attempt will be made to
182800 * interpret the string as a numeric value. If the numeric value cannot
182801 * be expressed as an 32-bit signed binary value data may be lost in the
182802 * conversion.
182803 **/
182804define('SAM_INT', 0);
182805/**
182806 * An 64-bit signed integer value. SAM will attempt to convert the
182807 * property value specified into a 64-bit value to pass to the messaging
182808 * system. If a string value is passed an attempt will be made to
182809 * interpret the string as a numeric value. If the numeric value cannot
182810 * be expressed as an 64-bit signed binary value data may be lost in the
182811 * conversion.
182812 **/
182813define('SAM_LONG', 0);
182814define('SAM_MANUAL', '');
182815/**
182816 * When a message is received this field contains the unique identifier
182817 * of the message as allocated by the underlying messaging system. When
182818 * sending a message this field is ignored.
182819 **/
182820define('SAM_MESSAGEID', 0);
182821define('SAM_MQTT', '');
182822define('SAM_MQTT_CLEANSTART', false);
182823define('SAM_NON_PERSISTENT', '');
182824define('SAM_PASSWORD', '');
182825define('SAM_PERSISTENT', '');
182826define('SAM_PORT', '');
182827define('SAM_PRIORITY', '');
182828/**
182829 * A string providing the identity of the queue on to which responses to
182830 * this message should be posted.
182831 **/
182832define('SAM_REPLY_TO', 0);
182833define('SAM_RTT', '');
182834/**
182835 * SAM will interpret the property value specified as a string and pass
182836 * it to the messaging system accordingly.
182837 **/
182838define('SAM_STRING', 0);
182839define('SAM_TARGETCHAIN', '');
182840define('SAM_TEXT', '');
182841define('SAM_TIMETOLIVE', '');
182842define('SAM_TRANSACTIONS', '');
182843/**
182844 * An indication of the type of message to be sent. The value may be
182845 * SAM_TEXT indicating the contents of the message body is a text string,
182846 * or SAM_BYTES indicating the contents of the message body are some
182847 * application defined format. The way in which this property is used may
182848 * depend on the underlying messaging server. For instance a messaging
182849 * server that supports the JMS (Java Message Service) specification may
182850 * interpret this value and send messages of type "jms_text" and
182851 * "jms_bytes". In addition, if the SAM_TYPE property is set to SAM_TEXT
182852 * the data provided for the message body is expected to be a UTF8
182853 * encoded string.
182854 **/
182855define('SAM_TYPE', 0);
182856define('SAM_USERID', '');
182857define('SAM_WAIT', '');
182858define('SAM_WMQ', '');
182859define('SAM_WMQ_BINDINGS', '');
182860define('SAM_WMQ_CLIENT', '');
182861define('SAM_WMQ_TARGET_CLIENT', '');
182862define('SAM_WPM', '');
182863define('SA_ALL', 0);
182864define('SA_MESSAGES', 0);
182865define('SA_RECENT', 0);
182866define('SA_UIDNEXT', 0);
182867define('SA_UIDVALIDITY', 0);
182868define('SA_UNSEEN', 0);
182869define('SCANDIR_SORT_ASCENDING', 0);
182870define('SCANDIR_SORT_DESCENDING', 0);
182871define('SCANDIR_SORT_NONE', 0);
182872define('SEARCHD_ERROR', 0);
182873define('SEARCHD_OK', 0);
182874define('SEARCHD_RETRY', 0);
182875define('SEARCHD_WARNING', 0);
182876define('SEASLOG_ALERT', '');
182877define('SEASLOG_ALL', '');
182878define('SEASLOG_APPENDER_FILE', 0);
182879define('SEASLOG_APPENDER_TCP', 0);
182880define('SEASLOG_APPENDER_UDP', 0);
182881define('SEASLOG_AUTHOR', '');
182882define('SEASLOG_CLOSE_LOGGER_STREAM_MOD_ALL', 0);
182883define('SEASLOG_CLOSE_LOGGER_STREAM_MOD_ASSIGN', 0);
182884define('SEASLOG_CRITICAL', '');
182885define('SEASLOG_DEBUG', '');
182886define('SEASLOG_DETAIL_ORDER_ASC', 0);
182887define('SEASLOG_DETAIL_ORDER_DESC', 0);
182888define('SEASLOG_EMERGENCY', '');
182889define('SEASLOG_ERROR', '');
182890define('SEASLOG_INFO', '');
182891define('SEASLOG_NOTICE', '');
182892define('SEASLOG_REQUEST_VARIABLE_CLIENT_IP', 0);
182893define('SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT', 0);
182894define('SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD', 0);
182895define('SEASLOG_REQUEST_VARIABLE_REQUEST_URI', 0);
182896define('SEASLOG_VERSION', '');
182897define('SEASLOG_WARNING', '');
182898define('SEEK_CUR', 0);
182899define('SEEK_END', 0);
182900define('SEEK_SET', 0);
182901define('SEGV_ACCERR', 0);
182902define('SEGV_MAPERR', 0);
182903define('SEQUENCE', 0);
182904define('SESSIONEXPIRED', 0);
182905define('SESSIONMOVED', 0);
182906define('SESSION_EVENT', 0);
182907define('SE_FREE', 0);
182908define('SE_NOPREFETCH', 0);
182909define('SE_UID', 0);
182910define('SID', '');
182911define('SIGABRT', 0);
182912define('SIGALRM', 0);
182913define('SIGBABY', 0);
182914define('SIGBUS', 0);
182915define('SIGCHLD', 0);
182916define('SIGCLD', 0);
182917define('SIGCONT', 0);
182918define('SIGFPE', 0);
182919define('SIGHUP', 0);
182920define('SIGILL', 0);
182921define('SIGINT', 0);
182922define('SIGIO', 0);
182923define('SIGIOT', 0);
182924define('SIGKILL', 0);
182925define('SIGPIPE', 0);
182926define('SIGPOLL', 0);
182927define('SIGPROF', 0);
182928define('SIGPWR', 0);
182929define('SIGQUIT', 0);
182930define('SIGSEGV', 0);
182931define('SIGSTKFLT', 0);
182932define('SIGSTOP', 0);
182933define('SIGSYS', 0);
182934define('SIGTERM', 0);
182935define('SIGTRAP', 0);
182936define('SIGTSTP', 0);
182937define('SIGTTIN', 0);
182938define('SIGTTOU', 0);
182939define('SIGURG', 0);
182940define('SIGUSR1', 0);
182941define('SIGUSR2', 0);
182942define('SIGVTALRM', 0);
182943define('SIGWINCH', 0);
182944define('SIGXCPU', 0);
182945define('SIGXFSZ', 0);
182946define('SIG_BLOCK', 0);
182947define('SIG_DFL', 0);
182948define('SIG_ERR', 0);
182949define('SIG_IGN', 0);
182950define('SIG_SETMASK', 0);
182951define('SIG_UNBLOCK', 0);
182952define('SI_ASYNCIO', 0);
182953define('SI_KERNEL', 0);
182954define('SI_MSGGQ', 0);
182955define('SI_NOINFO', 0);
182956define('SI_QUEUE', 0);
182957define('SI_SIGIO', 0);
182958define('SI_TIMER', 0);
182959define('SI_TKILL', 0);
182960define('SI_USER', 0);
182961define('SNMP_BIT_STR', 0);
182962define('SNMP_COUNTER', 0);
182963define('SNMP_COUNTER64', 0);
182964define('SNMP_INTEGER', 0);
182965define('SNMP_IPADDRESS', 0);
182966define('SNMP_NULL', 0);
182967define('SNMP_OBJECT_ID', 0);
182968define('SNMP_OCTET_STR', 0);
182969/**
182970 * .iso.org.dod.internet.mgmt.mib-2.system.sysUpTime.sysUpTimeInstance
182971 **/
182972define('SNMP_OID_OUTPUT_FULL', 0);
182973/**
182974 * DISMAN-EVENT-MIB::sysUpTimeInstance
182975 **/
182976define('SNMP_OID_OUTPUT_MODULE', 0);
182977/**
182978 * Undefined
182979 **/
182980define('SNMP_OID_OUTPUT_NONE', 0);
182981/**
182982 * .1.3.6.1.2.1.1.3.0
182983 **/
182984define('SNMP_OID_OUTPUT_NUMERIC', 0);
182985/**
182986 * sysUpTimeInstance
182987 **/
182988define('SNMP_OID_OUTPUT_SUFFIX', 0);
182989/**
182990 * system.sysUpTime.sysUpTimeInstance
182991 **/
182992define('SNMP_OID_OUTPUT_UCD', 0);
182993define('SNMP_OPAQUE', 0);
182994define('SNMP_TIMETICKS', 0);
182995define('SNMP_UINTEGER', 0);
182996define('SNMP_UNSIGNED', 0);
182997define('SNMP_VALUE_LIBRARY', 0);
182998define('SNMP_VALUE_OBJECT', 0);
182999define('SNMP_VALUE_PLAIN', 0);
183000define('SOAP_1_1', 0);
183001define('SOAP_1_2', 0);
183002define('SOAP_ACTOR_NEXT', 0);
183003define('SOAP_ACTOR_NONE', 0);
183004define('SOAP_ACTOR_UNLIMATERECEIVER', 0);
183005define('SOAP_AUTHENTICATION_BASIC', 0);
183006define('SOAP_AUTHENTICATION_DIGEST', 0);
183007define('SOAP_COMPRESSION_ACCEPT', 0);
183008define('SOAP_COMPRESSION_DEFLATE', 0);
183009define('SOAP_COMPRESSION_GZIP', 0);
183010define('SOAP_DOCUMENT', 0);
183011define('SOAP_ENCODED', 0);
183012define('SOAP_ENC_ARRAY', 0);
183013define('SOAP_ENC_OBJECT', 0);
183014define('SOAP_FUNCTIONS_ALL', 0);
183015define('SOAP_LITERAL', 0);
183016define('SOAP_PERSISTENCE_REQUEST', 0);
183017define('SOAP_PERSISTENCE_SESSION', 0);
183018define('SOAP_RPC', 0);
183019define('SOAP_SINGLE_ELEMENT_ARRAYS', 0);
183020/**
183021 * Since PHP 5.5.0.
183022 **/
183023define('SOAP_SSL_METHOD_SSLv2', 0);
183024/**
183025 * Since PHP 5.5.0.
183026 **/
183027define('SOAP_SSL_METHOD_SSLv3', 0);
183028/**
183029 * Since PHP 5.5.0.
183030 **/
183031define('SOAP_SSL_METHOD_SSLv23', 0);
183032/**
183033 * Since PHP 5.5.0.
183034 **/
183035define('SOAP_SSL_METHOD_TLS', 0);
183036define('SOAP_USE_XSI_ARRAY_TYPE', 0);
183037define('SOAP_WAIT_ONE_WAY_CALLS', 0);
183038define('SOCKET_ADDRINUSE', 0);
183039define('SOCKET_E2BIG', 0);
183040define('SOCKET_EACCES', 0);
183041define('SOCKET_EADDRINUSE', 0);
183042define('SOCKET_EADDRNOTAVAIL', 0);
183043define('SOCKET_EADV', 0);
183044define('SOCKET_EAFNOSUPPORT', 0);
183045define('SOCKET_EAGAIN', 0);
183046define('SOCKET_EALREADY', 0);
183047define('SOCKET_EBADE', 0);
183048define('SOCKET_EBADF', 0);
183049define('SOCKET_EBADFD', 0);
183050define('SOCKET_EBADMSG', 0);
183051define('SOCKET_EBADR', 0);
183052define('SOCKET_EBADRQC', 0);
183053define('SOCKET_EBADSLT', 0);
183054define('SOCKET_EBUSY', 0);
183055define('SOCKET_ECHRNG', 0);
183056define('SOCKET_ECOMM', 0);
183057define('SOCKET_ECONNABORTED', 0);
183058define('SOCKET_ECONNREFUSED', 0);
183059define('SOCKET_ECONNRESET', 0);
183060define('SOCKET_EDESTADDRREQ', 0);
183061define('SOCKET_EDISCON', 0);
183062define('SOCKET_EDQUOT', 0);
183063define('SOCKET_EDUOT', 0);
183064define('SOCKET_EEXIST', 0);
183065define('SOCKET_EFAULT', 0);
183066define('SOCKET_EHOSTDOWN', 0);
183067define('SOCKET_EHOSTUNREACH', 0);
183068define('SOCKET_EIDRM', 0);
183069define('SOCKET_EINPROGRESS', 0);
183070define('SOCKET_EINTR', 0);
183071define('SOCKET_EINVAL', 0);
183072define('SOCKET_EIO', 0);
183073define('SOCKET_EISCONN', 0);
183074define('SOCKET_EISDIR', 0);
183075define('SOCKET_EISNAM', 0);
183076define('SOCKET_EL2HLT', 0);
183077define('SOCKET_EL2NSYNC', 0);
183078define('SOCKET_EL3HLT', 0);
183079define('SOCKET_EL3RST', 0);
183080define('SOCKET_ELNRNG', 0);
183081define('SOCKET_ELOOP', 0);
183082define('SOCKET_EMEDIUMTYPE', 0);
183083define('SOCKET_EMFILE', 0);
183084define('SOCKET_EMLINK', 0);
183085define('SOCKET_EMSGSIZE', 0);
183086define('SOCKET_EMULTIHOP', 0);
183087define('SOCKET_ENAMETOOLONG', 0);
183088define('SOCKET_ENETDOWN', 0);
183089define('SOCKET_ENETRESET', 0);
183090define('SOCKET_ENETUNREACH', 0);
183091define('SOCKET_ENFILE', 0);
183092define('SOCKET_ENOANO', 0);
183093define('SOCKET_ENOBUFS', 0);
183094define('SOCKET_ENOCSI', 0);
183095define('SOCKET_ENODATA', 0);
183096define('SOCKET_ENODEV', 0);
183097define('SOCKET_ENOENT', 0);
183098define('SOCKET_ENOLCK', 0);
183099define('SOCKET_ENOLINK', 0);
183100define('SOCKET_ENOMEDIUM', 0);
183101define('SOCKET_ENOMEM', 0);
183102define('SOCKET_ENOMSG', 0);
183103define('SOCKET_ENONET', 0);
183104define('SOCKET_ENOPROTOOPT', 0);
183105define('SOCKET_ENOSPC', 0);
183106define('SOCKET_ENOSR', 0);
183107define('SOCKET_ENOSTR', 0);
183108define('SOCKET_ENOSYS', 0);
183109define('SOCKET_ENOTBLK', 0);
183110define('SOCKET_ENOTCONN', 0);
183111define('SOCKET_ENOTDIR', 0);
183112define('SOCKET_ENOTEMPTY', 0);
183113define('SOCKET_ENOTSOCK', 0);
183114define('SOCKET_ENOTTY', 0);
183115define('SOCKET_ENOTUNIQ', 0);
183116define('SOCKET_ENXIO', 0);
183117define('SOCKET_EOPNOTSUPP', 0);
183118define('SOCKET_EPERM', 0);
183119define('SOCKET_EPFNOSUPPORT', 0);
183120define('SOCKET_EPIPE', 0);
183121define('SOCKET_EPROCLIM', 0);
183122define('SOCKET_EPROTO', 0);
183123define('SOCKET_EPROTONOSUPPORT', 0);
183124define('SOCKET_EPROTOOPT', 0);
183125define('SOCKET_EPROTOTYPE', 0);
183126define('SOCKET_EREMCHG', 0);
183127define('SOCKET_EREMOTE', 0);
183128define('SOCKET_EREMOTEIO', 0);
183129define('SOCKET_ERESTART', 0);
183130define('SOCKET_EROFS', 0);
183131define('SOCKET_ESHUTDOWN', 0);
183132define('SOCKET_ESOCKTNOSUPPORT', 0);
183133define('SOCKET_ESPIPE', 0);
183134define('SOCKET_ESRMNT', 0);
183135define('SOCKET_ESTALE', 0);
183136define('SOCKET_ESTRPIPE', 0);
183137define('SOCKET_ETIME', 0);
183138define('SOCKET_ETIMEDOUT', 0);
183139define('SOCKET_ETOOMANYREFS', 0);
183140define('SOCKET_ETOOMYREFS', 0);
183141define('SOCKET_EUNATCH', 0);
183142define('SOCKET_EUSERS', 0);
183143define('SOCKET_EWOULDBLOCK', 0);
183144define('SOCKET_EXDEV', 0);
183145define('SOCKET_EXFULL', 0);
183146define('SOCKET_HOST_NOT_FOUND', 0);
183147define('SOCKET_NOTINITIALISED', 0);
183148define('SOCKET_NO_ADDRESS', 0);
183149define('SOCKET_NO_DATA', 0);
183150define('SOCKET_NO_RECOVERY', 0);
183151define('SOCKET_SYSNOTREADY', 0);
183152define('SOCKET_TRY_AGAIN', 0);
183153define('SOCKET_VERNOTSUPPORTED', 0);
183154/**
183155 * Supports datagrams (connectionless, unreliable messages of a fixed
183156 * maximum length). The UDP protocol is based on this socket type.
183157 **/
183158define('SOCK_DGRAM', 0);
183159/**
183160 * Provides raw network protocol access. This special type of socket can
183161 * be used to manually construct any type of protocol. A common use for
183162 * this socket type is to perform ICMP requests (like ping).
183163 **/
183164define('SOCK_RAW', 0);
183165/**
183166 * Provides a reliable datagram layer that does not guarantee ordering.
183167 * This is most likely not implemented on your operating system.
183168 **/
183169define('SOCK_RDM', 0);
183170/**
183171 * Provides a sequenced, reliable, two-way connection-based data
183172 * transmission path for datagrams of fixed maximum length; a consumer is
183173 * required to read an entire packet with each read call.
183174 **/
183175define('SOCK_SEQPACKET', 0);
183176/**
183177 * Provides sequenced, reliable, full-duplex, connection-based byte
183178 * streams. An out-of-band data transmission mechanism may be supported.
183179 * The TCP protocol is based on this socket type.
183180 **/
183181define('SOCK_STREAM', 0);
183182define('SODIUM_CRYPTO_AEAD_AES256GCM_ABYTES', 0);
183183define('SODIUM_CRYPTO_AEAD_AES256GCM_KEYBYTES', 0);
183184define('SODIUM_CRYPTO_AEAD_AES256GCM_NPUBBYTES', 0);
183185define('SODIUM_CRYPTO_AEAD_AES256GCM_NSECBYTES', 0);
183186define('SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTES', 0);
183187define('SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_ABYTES', 0);
183188define('SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES', 0);
183189define('SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES', 0);
183190define('SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_NSECBYTES', 0);
183191define('SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_KEYBYTES', 0);
183192define('SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_NPUBBYTES', 0);
183193define('SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_NSECBYTES', 0);
183194define('SODIUM_CRYPTO_AUTH_BYTES', 0);
183195define('SODIUM_CRYPTO_AUTH_KEYBYTES', 0);
183196define('SODIUM_CRYPTO_BOX_KEYPAIRBYTES', 0);
183197define('SODIUM_CRYPTO_BOX_MACBYTES', 0);
183198define('SODIUM_CRYPTO_BOX_NONCEBYTES', 0);
183199define('SODIUM_CRYPTO_BOX_PUBLICKEYBYTES', 0);
183200define('SODIUM_CRYPTO_BOX_SEALBYTES', 0);
183201define('SODIUM_CRYPTO_BOX_SECRETKEYBYTES', 0);
183202define('SODIUM_CRYPTO_BOX_SEEDBYTES', 0);
183203define('SODIUM_CRYPTO_GENERICHASH_BYTES', 0);
183204define('SODIUM_CRYPTO_GENERICHASH_BYTES_MAX', 0);
183205define('SODIUM_CRYPTO_GENERICHASH_BYTES_MIN', 0);
183206define('SODIUM_CRYPTO_GENERICHASH_KEYBYTES', 0);
183207define('SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MAX', 0);
183208define('SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MIN', 0);
183209define('SODIUM_CRYPTO_KDF_BYTES_MAX', 0);
183210define('SODIUM_CRYPTO_KDF_BYTES_MIN', 0);
183211define('SODIUM_CRYPTO_KDF_CONTEXTBYTES', 0);
183212define('SODIUM_CRYPTO_KDF_KEYBYTES', 0);
183213define('SODIUM_CRYPTO_KX_KEYPAIRBYTES', 0);
183214define('SODIUM_CRYPTO_KX_PUBLICKEYBYTES', 0);
183215define('SODIUM_CRYPTO_KX_SECRETKEYBYTES', 0);
183216define('SODIUM_CRYPTO_KX_SEEDBYTES', 0);
183217define('SODIUM_CRYPTO_KX_SESSIONKEYBYTES', 0);
183218define('SODIUM_CRYPTO_PWHASH_ALG_ARGON2I13', 0);
183219define('SODIUM_CRYPTO_PWHASH_ALG_ARGON2ID13', 0);
183220define('SODIUM_CRYPTO_PWHASH_ALG_DEFAULT', 0);
183221define('SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE', 0);
183222define('SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE', 0);
183223define('SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE', 0);
183224define('SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE', 0);
183225define('SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE', 0);
183226define('SODIUM_CRYPTO_PWHASH_OPSLIMIT_SENSITIVE', 0);
183227define('SODIUM_CRYPTO_PWHASH_SALTBYTES', 0);
183228define('SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_MEMLIMIT_INTERACTIVE', 0);
183229define('SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_MEMLIMIT_SENSITIVE', 0);
183230define('SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_OPSLIMIT_INTERACTIVE', 0);
183231define('SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_OPSLIMIT_SENSITIVE', 0);
183232define('SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_SALTBYTES', 0);
183233define('SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_STRPREFIX', '');
183234define('SODIUM_CRYPTO_PWHASH_STRPREFIX', '');
183235define('SODIUM_CRYPTO_SCALARMULT_BYTES', 0);
183236define('SODIUM_CRYPTO_SCALARMULT_SCALARBYTES', 0);
183237define('SODIUM_CRYPTO_SECRETBOX_KEYBYTES', 0);
183238define('SODIUM_CRYPTO_SECRETBOX_MACBYTES', 0);
183239define('SODIUM_CRYPTO_SECRETBOX_NONCEBYTES', 0);
183240define('SODIUM_CRYPTO_SHORTHASH_BYTES', 0);
183241define('SODIUM_CRYPTO_SHORTHASH_KEYBYTES', 0);
183242define('SODIUM_CRYPTO_SIGN_BYTES', 0);
183243define('SODIUM_CRYPTO_SIGN_KEYPAIRBYTES', 0);
183244define('SODIUM_CRYPTO_SIGN_PUBLICKEYBYTES', 0);
183245define('SODIUM_CRYPTO_SIGN_SECRETKEYBYTES', 0);
183246define('SODIUM_CRYPTO_SIGN_SEEDBYTES', 0);
183247define('SODIUM_CRYPTO_STREAM_KEYBYTES', 0);
183248define('SODIUM_CRYPTO_STREAM_NONCEBYTES', 0);
183249define('SODIUM_LIBRARY_MAJOR_VERSION', 0);
183250define('SODIUM_LIBRARY_MINOR_VERSION', 0);
183251define('SODIUM_LIBRARY_VERSION', '');
183252define('SOLR_EXTENSION_VERSION', '');
183253define('SOLR_MAJOR_VERSION', 0);
183254define('SOLR_MINOR_VERSION', 0);
183255define('SOLR_PATCH_VERSION', 0);
183256define('SOL_SOCKET', 0);
183257define('SOL_TCP', 0);
183258define('SOL_UDP', 0);
183259define('SORTARRIVAL', 0);
183260define('SORTCC', 0);
183261define('SORTDATE', 0);
183262define('SORTFROM', 0);
183263define('SORTSIZE', 0);
183264define('SORTSUBJECT', 0);
183265define('SORTTO', 0);
183266define('SORT_ASC', 0);
183267define('SORT_DESC', 0);
183268define('SORT_FLAG_CASE', 0);
183269define('SORT_LOCALE_STRING', 0);
183270define('SORT_NATURAL', 0);
183271define('SORT_NUMERIC', 0);
183272define('SORT_REGULAR', 0);
183273define('SORT_STRING', 0);
183274/**
183275 * Reports whether transmission of broadcast messages is supported.
183276 **/
183277define('SO_BROADCAST', 0);
183278/**
183279 * Reports whether debugging information is being recorded.
183280 **/
183281define('SO_DEBUG', 0);
183282/**
183283 * Reports whether outgoing messages bypass the standard routing
183284 * facilities.
183285 **/
183286define('SO_DONTROUTE', 0);
183287/**
183288 * Reports information about error status and clears it.
183289 **/
183290define('SO_ERROR', 0);
183291define('SO_FREE', 0);
183292/**
183293 * Reports whether connections are kept active with periodic transmission
183294 * of messages. If the connected socket fails to respond to these
183295 * messages, the connection is broken and processes writing to that
183296 * socket are notified with a SIGPIPE signal.
183297 **/
183298define('SO_KEEPALIVE', 0);
183299/**
183300 * Reports whether the {@link socket} lingers on {@link socket_close} if
183301 * data is present. By default, when the socket is closed, it attempts to
183302 * send all unsent data. In the case of a connection-oriented socket,
183303 * {@link socket_close} will wait for its peer to acknowledge the data.
183304 * If l_onoff is non-zero and l_linger is zero, all the unsent data will
183305 * be discarded and RST (reset) is sent to the peer in the case of a
183306 * connection-oriented socket. On the other hand, if l_onoff is non-zero
183307 * and l_linger is non-zero, {@link socket_close} will block until all
183308 * the data is sent or the time specified in l_linger elapses. If the
183309 * socket is non-blocking, {@link socket_close} will fail and return an
183310 * error.
183311 **/
183312define('SO_LINGER', 0);
183313define('SO_NOSERVER', 0);
183314/**
183315 * Reports whether the {@link socket} leaves out-of-band data inline.
183316 **/
183317define('SO_OOBINLINE', 0);
183318/**
183319 * Reports the size of the receive buffer.
183320 **/
183321define('SO_RCVBUF', 0);
183322/**
183323 * Reports the minimum number of bytes to process for {@link socket}
183324 * input operations.
183325 **/
183326define('SO_RCVLOWAT', 0);
183327/**
183328 * Reports the timeout value for input operations.
183329 **/
183330define('SO_RCVTIMEO', 0);
183331/**
183332 * Reports whether local addresses can be reused.
183333 **/
183334define('SO_REUSEADDR', 0);
183335/**
183336 * Reports whether local ports can be reused.
183337 **/
183338define('SO_REUSEPORT', 0);
183339/**
183340 * Reports the size of the send buffer.
183341 **/
183342define('SO_SNDBUF', 0);
183343/**
183344 * Reports the minimum number of bytes to process for {@link socket}
183345 * output operations.
183346 **/
183347define('SO_SNDLOWAT', 0);
183348/**
183349 * Reports the timeout value specifying the amount of time that an output
183350 * function blocks because flow control prevents data from being sent.
183351 **/
183352define('SO_SNDTIMEO', 0);
183353/**
183354 * Reports the {@link socket} type (e.g. SOCK_STREAM).
183355 **/
183356define('SO_TYPE', 0);
183357define('SPH_ATTR_BOOL', 0);
183358define('SPH_ATTR_FLOAT', 0);
183359define('SPH_ATTR_INTEGER', 0);
183360define('SPH_ATTR_MULTI', 0);
183361define('SPH_ATTR_ORDINAL', 0);
183362define('SPH_ATTR_TIMESTAMP', 0);
183363define('SPH_FILTER_FLOATRANGE', 0);
183364define('SPH_FILTER_RANGE', 0);
183365define('SPH_FILTER_VALUES', 0);
183366define('SPH_GROUPBY_ATTR', 0);
183367define('SPH_GROUPBY_ATTRPAIR', 0);
183368define('SPH_GROUPBY_DAY', 0);
183369define('SPH_GROUPBY_MONTH', 0);
183370define('SPH_GROUPBY_WEEK', 0);
183371define('SPH_GROUPBY_YEAR', 0);
183372define('SPH_MATCH_ALL', 0);
183373define('SPH_MATCH_ANY', 0);
183374define('SPH_MATCH_BOOLEAN', 0);
183375define('SPH_MATCH_EXTENDED', 0);
183376define('SPH_MATCH_EXTENDED2', 0);
183377define('SPH_MATCH_FULLSCAN', 0);
183378define('SPH_MATCH_PHRASE', 0);
183379define('SPH_RANK_BM25', 0);
183380define('SPH_RANK_NONE', 0);
183381define('SPH_RANK_PROXIMITY_BM25', 0);
183382define('SPH_RANK_WORDCOUNT', 0);
183383define('SPH_SORT_ATTR_ASC', 0);
183384define('SPH_SORT_ATTR_DESC', 0);
183385define('SPH_SORT_EXPR', 0);
183386define('SPH_SORT_EXTENDED', 0);
183387define('SPH_SORT_RELEVANCE', 0);
183388define('SPH_SORT_TIME_SEGMENTS', 0);
183389define('SPLIT', 0);
183390define('SQLBIT', 0);
183391define('SQLCHAR', 0);
183392define('SQLFLT4', 0);
183393define('SQLFLT8', 0);
183394define('SQLINT1', 0);
183395define('SQLINT2', 0);
183396define('SQLINT4', 0);
183397define('SQLITE3_ASSOC', 0);
183398define('SQLITE3_BLOB', 0);
183399define('SQLITE3_BOTH', 0);
183400define('SQLITE3_DETERMINISTIC', 0);
183401define('SQLITE3_FLOAT', 0);
183402define('SQLITE3_INTEGER', 0);
183403define('SQLITE3_NULL', 0);
183404define('SQLITE3_NUM', 0);
183405define('SQLITE3_OPEN_CREATE', 0);
183406define('SQLITE3_OPEN_READONLY', 0);
183407define('SQLITE3_OPEN_READWRITE', 0);
183408define('SQLITE3_TEXT', 0);
183409define('SQLITE_ABORT', 0);
183410define('SQLITE_ASSOC', 0);
183411define('SQLITE_AUTH', 0);
183412define('SQLITE_BOTH', 0);
183413define('SQLITE_BUSY', 0);
183414define('SQLITE_CANTOPEN', 0);
183415define('SQLITE_CONSTRAINT', 0);
183416define('SQLITE_CORRUPT', 0);
183417define('SQLITE_DONE', 0);
183418define('SQLITE_EMPTY', 0);
183419define('SQLITE_ERROR', 0);
183420define('SQLITE_FORMAT', 0);
183421define('SQLITE_FULL', 0);
183422define('SQLITE_INTERNAL', 0);
183423define('SQLITE_INTERRUPT', 0);
183424define('SQLITE_IOERR', 0);
183425define('SQLITE_LOCKED', 0);
183426define('SQLITE_MISMATCH', 0);
183427define('SQLITE_MISUSE', 0);
183428define('SQLITE_NOLFS', 0);
183429define('SQLITE_NOMEM', 0);
183430define('SQLITE_NOTADB', 0);
183431define('SQLITE_NOTFOUND', 0);
183432define('SQLITE_NUM', 0);
183433define('SQLITE_OK', 0);
183434define('SQLITE_PERM', 0);
183435define('SQLITE_PROTOCOL', 0);
183436define('SQLITE_READONLY', 0);
183437define('SQLITE_ROW', 0);
183438define('SQLITE_SCHEMA', 0);
183439define('SQLITE_TOOBIG', 0);
183440define('SQLSRV_CURSOR_BUFFERED', 0);
183441define('SQLSRV_CURSOR_DYNAMIC', 0);
183442define('SQLSRV_CURSOR_FORWARD', 0);
183443define('SQLSRV_CURSOR_KEYSET', 0);
183444define('SQLSRV_CURSOR_STATIC', 0);
183445define('SQLSRV_ENC_BINARY', 0);
183446define('SQLSRV_ENC_CHAR', 0);
183447define('SQLSRV_ERR_ALL', 0);
183448define('SQLSRV_ERR_ERRORS', 0);
183449define('SQLSRV_ERR_WARNINGS', 0);
183450define('SQLSRV_FETCH_ASSOC', 0);
183451define('SQLSRV_FETCH_BOTH', 0);
183452define('SQLSRV_FETCH_NUMERIC', 0);
183453define('SQLSRV_LOG_SEVERITY_ALL', 0);
183454define('SQLSRV_LOG_SEVERITY_ERROR', 0);
183455define('SQLSRV_LOG_SEVERITY_NOTICE', 0);
183456define('SQLSRV_LOG_SEVERITY_WARNING', 0);
183457define('SQLSRV_LOG_SYSTEM_ALL', 0);
183458define('SQLSRV_LOG_SYSTEM_CONN', 0);
183459define('SQLSRV_LOG_SYSTEM_INIT', 0);
183460define('SQLSRV_LOG_SYSTEM_OFF', 0);
183461define('SQLSRV_LOG_SYSTEM_STMT', 0);
183462define('SQLSRV_LOG_SYSTEM_UTIL', 0);
183463define('SQLSRV_NULLABLE_NO', 0);
183464define('SQLSRV_NULLABLE_UNKNOWN', 0);
183465define('SQLSRV_NULLABLE_YES', 0);
183466define('SQLSRV_PARAM_IN', 0);
183467define('SQLSRV_PARAM_INOUT', 0);
183468define('SQLSRV_PARAM_OUT', 0);
183469define('SQLSRV_PHPTYPE_DATETIME', 0);
183470define('SQLSRV_PHPTYPE_FLOAT', 0);
183471define('SQLSRV_PHPTYPE_INT', 0);
183472define('SQLSRV_PHPTYPE_STREAM', 0);
183473define('SQLSRV_PHPTYPE_STRING', 0);
183474define('SQLSRV_SCROLL_ABSOLUTE', 0);
183475define('SQLSRV_SCROLL_FIRST', 0);
183476define('SQLSRV_SCROLL_LAST', 0);
183477define('SQLSRV_SCROLL_NEXT', 0);
183478define('SQLSRV_SCROLL_PRIOR', 0);
183479define('SQLSRV_SCROLL_RELATIVE', 0);
183480define('SQLSRV_SQLTYPE_BIGINT', 0);
183481define('SQLSRV_SQLTYPE_BINARY', 0);
183482define('SQLSRV_SQLTYPE_BIT', 0);
183483define('SQLSRV_SQLTYPE_CHAR', 0);
183484define('SQLSRV_SQLTYPE_DATE', 0);
183485define('SQLSRV_SQLTYPE_DATETIME', 0);
183486define('SQLSRV_SQLTYPE_DATETIME2', 0);
183487define('SQLSRV_SQLTYPE_DATETIMEOFFSET', 0);
183488define('SQLSRV_SQLTYPE_DECIMAL', 0);
183489define('SQLSRV_SQLTYPE_FLOAT', 0);
183490define('SQLSRV_SQLTYPE_IMAGE', 0);
183491define('SQLSRV_SQLTYPE_INT', 0);
183492define('SQLSRV_SQLTYPE_MONEY', 0);
183493define('SQLSRV_SQLTYPE_NCHAR', 0);
183494define('SQLSRV_SQLTYPE_NTEXT', 0);
183495define('SQLSRV_SQLTYPE_NUMERIC', 0);
183496define('SQLSRV_SQLTYPE_NVARCHAR', 0);
183497define('SQLSRV_SQLTYPE_REAL', 0);
183498define('SQLSRV_SQLTYPE_SMALLDATETIME', 0);
183499define('SQLSRV_SQLTYPE_SMALLINT', 0);
183500define('SQLSRV_SQLTYPE_SMALLMONEY', 0);
183501define('SQLSRV_SQLTYPE_TEXT', 0);
183502define('SQLSRV_SQLTYPE_TIME', 0);
183503define('SQLSRV_SQLTYPE_TIMESTAMP', 0);
183504define('SQLSRV_SQLTYPE_TINYINT', 0);
183505define('SQLSRV_SQLTYPE_UDT', 0);
183506define('SQLSRV_SQLTYPE_UNIQUEIDENTIFIER', 0);
183507define('SQLSRV_SQLTYPE_VARBINARY', 0);
183508define('SQLSRV_SQLTYPE_VARCHAR', 0);
183509define('SQLSRV_SQLTYPE_XML', 0);
183510define('SQLSRV_TXN_READ_COMMITTED', 0);
183511define('SQLSRV_TXN_READ_SERIALIZABLE', 0);
183512define('SQLSRV_TXN_READ_UNCOMMITTED', 0);
183513define('SQLSRV_TXN_REPEATABLE_READ', 0);
183514define('SQLSRV_TXN_SNAPSHOT', 0);
183515define('SQLTEXT', 0);
183516define('SQLT_AFC', 0);
183517define('SQLT_AVC', 0);
183518define('SQLT_BDOUBLE', 0);
183519define('SQLT_BFILEE', 0);
183520define('SQLT_BFLOAT', 0);
183521define('SQLT_BIN', 0);
183522define('SQLT_BLOB', 0);
183523define('SQLT_BOL', 0);
183524define('SQLT_CFILEE', 0);
183525define('SQLT_CHR', 0);
183526define('SQLT_CLOB', 0);
183527define('SQLT_FLT', 0);
183528define('SQLT_INT', 0);
183529define('SQLT_LBI', 0);
183530define('SQLT_LNG', 0);
183531define('SQLT_LVC', 0);
183532define('SQLT_NTY', 0);
183533define('SQLT_NUM', 0);
183534define('SQLT_ODT', 0);
183535define('SQLT_RDD', 0);
183536define('SQLT_RSET', 0);
183537define('SQLT_STR', 0);
183538define('SQLT_UIN', 0);
183539define('SQLT_VCS', 0);
183540define('SQLVARCHAR', 0);
183541define('SQL_BEST_ROWID', 0);
183542define('SQL_BIGINT', 0);
183543define('SQL_BINARY', 0);
183544define('SQL_BIT', 0);
183545define('SQL_CHAR', 0);
183546define('SQL_CONCURRENCY', 0);
183547define('SQL_CONCUR_LOCK', 0);
183548define('SQL_CONCUR_READ_ONLY', 0);
183549define('SQL_CONCUR_ROWVER', 0);
183550define('SQL_CONCUR_VALUES', 0);
183551define('SQL_CURSOR_DYNAMIC', 0);
183552define('SQL_CURSOR_FORWARD_ONLY', 0);
183553define('SQL_CURSOR_KEYSET_DRIVEN', 0);
183554define('SQL_CURSOR_STATIC', 0);
183555define('SQL_CURSOR_TYPE', 0);
183556define('SQL_CUR_USE_DRIVER', 0);
183557define('SQL_CUR_USE_IF_NEEDED', 0);
183558define('SQL_CUR_USE_ODBC', 0);
183559define('SQL_DATE', 0);
183560define('SQL_DECIMAL', 0);
183561define('SQL_DOUBLE', 0);
183562define('SQL_ENSURE', 0);
183563define('SQL_FLOAT', 0);
183564define('SQL_INDEX_ALL', 0);
183565define('SQL_INDEX_UNIQUE', 0);
183566define('SQL_INTEGER', 0);
183567define('SQL_KEYSET_SIZE', 0);
183568define('SQL_LONGVARBINARY', 0);
183569define('SQL_LONGVARCHAR', 0);
183570define('SQL_NO_NULLS', 0);
183571define('SQL_NULLABLE', 0);
183572define('SQL_NUMERIC', 0);
183573define('SQL_ODBC_CURSORS', 0);
183574define('SQL_QUICK', 0);
183575define('SQL_REAL', 0);
183576define('SQL_ROWVER', 0);
183577define('SQL_SCOPE_CURROW', 0);
183578define('SQL_SCOPE_SESSION', 0);
183579define('SQL_SCOPE_TRANSACTION', 0);
183580define('SQL_SMALLINT', 0);
183581define('SQL_TIME', 0);
183582define('SQL_TIMESTAMP', 0);
183583define('SQL_TINYINT', 0);
183584define('SQL_TYPE_DATE', 0);
183585define('SQL_TYPE_TIME', 0);
183586define('SQL_TYPE_TIMESTAMP', 0);
183587define('SQL_VARBINARY', 0);
183588define('SQL_VARCHAR', 0);
183589define('SSH2_DEFAULT_TERMINAL', '');
183590define('SSH2_DEFAULT_TERM_HEIGHT', 0);
183591define('SSH2_DEFAULT_TERM_UNIT', 0);
183592define('SSH2_DEFAULT_TERM_WIDTH', 0);
183593define('SSH2_FINGERPRINT_HEX', 0);
183594define('SSH2_FINGERPRINT_MD5', 0);
183595define('SSH2_FINGERPRINT_RAW', 0);
183596define('SSH2_FINGERPRINT_SHA1', 0);
183597define('SSH2_STREAM_STDERR', 0);
183598define('SSH2_STREAM_STDIO', 0);
183599define('SSH2_TERM_UNIT_CHARS', 0);
183600define('SSH2_TERM_UNIT_PIXELS', 0);
183601define('STATEMENT_TRACE', 0);
183602/**
183603 * An already opened stream to stderr. This saves opening it with
183604 *
183605 * <?php $stderr = fopen('php://stderr', 'w'); ?>
183606 **/
183607define('STDERR', 0);
183608/**
183609 * An already opened stream to stdin. This saves opening it with
183610 *
183611 * <?php $stdin = fopen('php://stdin', 'r'); ?>
183612 *
183613 * If you want to read single line from stdin, you can use
183614 *
183615 * <?php $line = trim(fgets(STDIN)); // reads one line from STDIN
183616 * fscanf(STDIN, "%d\n", $number); // reads number from STDIN ?>
183617 **/
183618define('STDIN', 0);
183619/**
183620 * An already opened stream to stdout. This saves opening it with
183621 *
183622 * <?php $stdout = fopen('php://stdout', 'w'); ?>
183623 **/
183624define('STDOUT', 0);
183625define('STD_PROP_LIST', 0);
183626define('STREAM_CAST_AS_STREAM', 0);
183627define('STREAM_CAST_FOR_SELECT', 0);
183628define('STREAM_CLIENT_ASYNC_CONNECT', 0);
183629define('STREAM_CLIENT_CONNECT', 0);
183630define('STREAM_CLIENT_PERSISTENT', 0);
183631define('STREAM_FILTER_ALL', 0);
183632define('STREAM_FILTER_READ', 0);
183633define('STREAM_FILTER_WRITE', 0);
183634define('STREAM_IPPROTO_ICMP', 0);
183635define('STREAM_IPPROTO_IP', 0);
183636define('STREAM_IPPROTO_RAW', 0);
183637define('STREAM_IPPROTO_TCP', 0);
183638define('STREAM_IPPROTO_UDP', 0);
183639define('STREAM_META_ACCESS', 0);
183640define('STREAM_META_GROUP', 0);
183641define('STREAM_META_GROUP_NAME', 0);
183642define('STREAM_META_OWNER', 0);
183643define('STREAM_META_OWNER_NAME', 0);
183644define('STREAM_META_TOUCH', 0);
183645define('STREAM_NOTIFY_AUTH_REQUIRED', 0);
183646define('STREAM_NOTIFY_AUTH_RESULT', 0);
183647define('STREAM_NOTIFY_COMPLETED', 0);
183648define('STREAM_NOTIFY_CONNECT', 0);
183649define('STREAM_NOTIFY_FAILURE', 0);
183650define('STREAM_NOTIFY_FILE_SIZE_IS', 0);
183651define('STREAM_NOTIFY_MIME_TYPE_IS', 0);
183652define('STREAM_NOTIFY_PROGRESS', 0);
183653define('STREAM_NOTIFY_REDIRECTED', 0);
183654define('STREAM_NOTIFY_RESOLVE', 0);
183655define('STREAM_NOTIFY_SEVERITY_ERR', 0);
183656define('STREAM_NOTIFY_SEVERITY_INFO', 0);
183657define('STREAM_NOTIFY_SEVERITY_WARN', 0);
183658/**
183659 * Process OOB (out-of-band) data.
183660 **/
183661define('STREAM_OOB', 0);
183662/**
183663 * Retrieve data from the socket, but do not consume the buffer.
183664 * Subsequent calls to {@link fread} or {@link stream_socket_recvfrom}
183665 * will see the same data.
183666 **/
183667define('STREAM_PEEK', 0);
183668define('STREAM_PF_INET', 0);
183669define('STREAM_PF_INET6', 0);
183670define('STREAM_PF_UNIX', 0);
183671/**
183672 * If this flag is set, you are responsible for raising errors using
183673 * {@link trigger_error} during opening of the stream. If this flag is
183674 * not set, you should not raise any errors.
183675 **/
183676define('STREAM_REPORT_ERRORS', 0);
183677define('STREAM_SERVER_BIND', 0);
183678define('STREAM_SERVER_LISTEN', 0);
183679define('STREAM_SHUT_RD', 0);
183680define('STREAM_SHUT_RDWR', 0);
183681define('STREAM_SHUT_WR', 0);
183682define('STREAM_SOCK_DGRAM', 0);
183683define('STREAM_SOCK_RAW', 0);
183684define('STREAM_SOCK_RDM', 0);
183685define('STREAM_SOCK_SEQPACKET', 0);
183686define('STREAM_SOCK_STREAM', 0);
183687/**
183688 * For resources with the ability to link to other resource (such as an
183689 * HTTP Location: forward, or a filesystem symlink). This flag specified
183690 * that only information about the link itself should be returned, not
183691 * the resource pointed to by the link. This flag is set in response to
183692 * calls to {@link lstat}, {@link is_link}, or {@link filetype}.
183693 **/
183694define('STREAM_URL_STAT_LINK', 0);
183695/**
183696 * If this flag is set, your wrapper should not raise any errors. If this
183697 * flag is not set, you are responsible for reporting errors using the
183698 * {@link trigger_error} function during stating of the path.
183699 **/
183700define('STREAM_URL_STAT_QUIET', 0);
183701/**
183702 * If {@link path} is relative, search for the resource using the
183703 * include_path.
183704 **/
183705define('STREAM_USE_PATH', 0);
183706define('STR_PAD_BOTH', 0);
183707define('STR_PAD_LEFT', 0);
183708define('STR_PAD_RIGHT', 0);
183709define('ST_SET', 0);
183710define('ST_SILENT', 0);
183711define('ST_UID', 0);
183712define('SUMMARY_TRACE', 0);
183713define('SUNFUNCS_RET_DOUBLE', 0);
183714define('SUNFUNCS_RET_STRING', 0);
183715define('SUNFUNCS_RET_TIMESTAMP', 0);
183716define('SVN_AUTH_PARAM_CONFIG', '');
183717define('SVN_AUTH_PARAM_CONFIG_DIR', '');
183718define('SVN_AUTH_PARAM_DEFAULT_PASSWORD', '');
183719define('SVN_AUTH_PARAM_DEFAULT_USERNAME', '');
183720define('SVN_AUTH_PARAM_DONT_STORE_PASSWORDS', '');
183721define('SVN_AUTH_PARAM_NON_INTERACTIVE', '');
183722define('SVN_AUTH_PARAM_NO_AUTH_CACHE', '');
183723define('SVN_AUTH_PARAM_SERVER_GROUP', '');
183724define('SVN_AUTH_PARAM_SSL_SERVER_CERT_INFO', '');
183725define('SVN_AUTH_PARAM_SSL_SERVER_FAILURES', '');
183726define('SVN_FS_CONFIG_FS_TYPE', '');
183727define('SVN_FS_TYPE_BDB', '');
183728define('SVN_FS_TYPE_FSFS', '');
183729define('SVN_NODE_DIR', 0);
183730define('SVN_NODE_FILE', 0);
183731define('SVN_NODE_NONE', 0);
183732define('SVN_NODE_UNKNOWN', 0);
183733define('SVN_PROP_REVISION_AUTHOR', '');
183734define('SVN_PROP_REVISION_DATE', '');
183735define('SVN_PROP_REVISION_LOG', '');
183736define('SVN_PROP_REVISION_ORIG_DATE', '');
183737define('SVN_REVISION_HEAD', 0);
183738define('SVN_WC_STATUS_ADDED', 0);
183739define('SVN_WC_STATUS_CONFLICTED', 0);
183740define('SVN_WC_STATUS_DELETED', 0);
183741define('SVN_WC_STATUS_EXTERNAL', 0);
183742define('SVN_WC_STATUS_IGNORED', 0);
183743define('SVN_WC_STATUS_INCOMPLETE', 0);
183744define('SVN_WC_STATUS_MERGED', 0);
183745define('SVN_WC_STATUS_MISSING', 0);
183746define('SVN_WC_STATUS_MODIFIED', 0);
183747define('SVN_WC_STATUS_NONE', 0);
183748define('SVN_WC_STATUS_NORMAL', 0);
183749define('SVN_WC_STATUS_OBSTRUCTED', 0);
183750define('SVN_WC_STATUS_REPLACED', 0);
183751define('SVN_WC_STATUS_UNVERSIONED', 0);
183752define('SWFACTION_DATA', 0);
183753define('SWFACTION_ENTERFRAME', 0);
183754define('SWFACTION_KEYDOWN', 0);
183755define('SWFACTION_KEYUP', 0);
183756define('SWFACTION_MOUSEDOWN', 0);
183757define('SWFACTION_MOUSEMOVE', 0);
183758define('SWFACTION_MOUSEUP', 0);
183759define('SWFACTION_ONLOAD', 0);
183760define('SWFACTION_UNLOAD', 0);
183761define('SWFBUTTON_DOWN', 0);
183762define('SWFBUTTON_DRAGOUT', 0);
183763define('SWFBUTTON_DRAGOVER', 0);
183764define('SWFBUTTON_HIT', 0);
183765define('SWFBUTTON_MOUSEDOWN', 0);
183766define('SWFBUTTON_MOUSEOUT', 0);
183767define('SWFBUTTON_MOUSEOVER', 0);
183768define('SWFBUTTON_MOUSEUP', 0);
183769define('SWFBUTTON_MOUSEUPOUTSIDE', 0);
183770define('SWFBUTTON_OVER', 0);
183771define('SWFBUTTON_UP', 0);
183772define('SWFFILL_CLIPPED_BITMAP', 0);
183773define('SWFFILL_LINEAR_GRADIENT', 0);
183774define('SWFFILL_RADIAL_GRADIENT', 0);
183775define('SWFFILL_TILED_BITMAP', 0);
183776define('SWFTEXTFIELD_ALIGN_CENTER', 0);
183777define('SWFTEXTFIELD_ALIGN_JUSTIFY', 0);
183778define('SWFTEXTFIELD_ALIGN_LEFT', 0);
183779define('SWFTEXTFIELD_ALIGN_RIGHT', 0);
183780define('SWFTEXTFIELD_DRAWBOX', 0);
183781define('SWFTEXTFIELD_HASLENGTH', 0);
183782define('SWFTEXTFIELD_HTML', 0);
183783define('SWFTEXTFIELD_MULTILINE', 0);
183784define('SWFTEXTFIELD_NOEDIT', 0);
183785define('SWFTEXTFIELD_NOSELECT', 0);
183786define('SWFTEXTFIELD_PASSWORD', 0);
183787define('SWFTEXTFIELD_WORDWRAP', 0);
183788define('SWOOLE_AIO_BASE', 0);
183789define('SWOOLE_AIO_LINUX', 0);
183790define('SWOOLE_ASYNC', 0);
183791define('SWOOLE_BASE', 0);
183792define('SWOOLE_EVENT_READ', 0);
183793define('SWOOLE_EVENT_WRITE', 0);
183794define('SWOOLE_FAST_PACK', 0);
183795define('SWOOLE_FILELOCK', 0);
183796define('SWOOLE_IPC_MSGQUEUE', 0);
183797define('SWOOLE_IPC_PREEMPTIVE', 0);
183798define('SWOOLE_IPC_UNSOCK', 0);
183799define('SWOOLE_KEEP', 0);
183800define('SWOOLE_MUTEX', 0);
183801define('SWOOLE_PROCESS', 0);
183802define('SWOOLE_RWLOCK', 0);
183803define('SWOOLE_SEM', 0);
183804define('SWOOLE_SOCK_ASYNC', 0);
183805define('SWOOLE_SOCK_SYNC', 0);
183806define('SWOOLE_SOCK_TCP', 0);
183807define('SWOOLE_SOCK_TCP6', 0);
183808define('SWOOLE_SOCK_UDP', 0);
183809define('SWOOLE_SOCK_UDP6', 0);
183810define('SWOOLE_SOCK_UNIX_DGRAM', 0);
183811define('SWOOLE_SOCK_UNIX_STREAM', 0);
183812define('SWOOLE_SYNC', 0);
183813define('SWOOLE_TCP', 0);
183814define('SWOOLE_TCP6', 0);
183815define('SWOOLE_THREAD', 0);
183816define('SWOOLE_UDP', 0);
183817define('SWOOLE_UDP6', 0);
183818define('SWOOLE_UNIX_DGRAM', 0);
183819define('SWOOLE_UNIX_STREAM', 0);
183820define('SWOOLE_VERSION', '');
183821define('SYSTEMERROR', 0);
183822define('S_ALL', 0);
183823define('S_EXECUTOR', 0);
183824define('S_FILES', 0);
183825define('S_INCLUDE', 0);
183826define('S_INTERNAL', 0);
183827define('S_IRGRP', 0);
183828define('S_IROTH', 0);
183829define('S_IRUSR', 0);
183830define('S_IRWXG', 0);
183831define('S_IRWXO', 0);
183832define('S_IRWXU', 0);
183833define('S_IWGRP', 0);
183834define('S_IWOTH', 0);
183835define('S_IWUSR', 0);
183836define('S_IXGRP', 0);
183837define('S_IXOTH', 0);
183838define('S_IXUSR', 0);
183839define('S_MAIL', 0);
183840define('S_MEMORY', 0);
183841define('S_MISC', 0);
183842define('S_SESSION', 0);
183843define('S_SQL', 0);
183844define('S_VARS', 0);
183845/**
183846 * Reports whether the Nagle TCP algorithm is disabled.
183847 **/
183848define('TCP_NODELAY', 0);
183849/**
183850 * Separator character for thousands (groups of three digits).
183851 **/
183852define('THOUSANDS_SEP', 0);
183853/**
183854 * Same value as THOUSANDS_SEP.
183855 **/
183856define('THOUSEP', 0);
183857define('TIDY_NODETYPE_ASP', 0);
183858define('TIDY_NODETYPE_CDATA', 0);
183859define('TIDY_NODETYPE_COMMENT', 0);
183860define('TIDY_NODETYPE_DOCTYPE', 0);
183861define('TIDY_NODETYPE_END', 0);
183862define('TIDY_NODETYPE_JSTE', 0);
183863define('TIDY_NODETYPE_PHP', 0);
183864define('TIDY_NODETYPE_PROCINS', 0);
183865define('TIDY_NODETYPE_ROOT', 0);
183866define('TIDY_NODETYPE_SECTION', 0);
183867define('TIDY_NODETYPE_START', 0);
183868define('TIDY_NODETYPE_STARTEND', 0);
183869define('TIDY_NODETYPE_TEXT', 0);
183870define('TIDY_NODETYPE_XMLDECL', 0);
183871define('TIDY_TAG_A', 0);
183872define('TIDY_TAG_ABBR', 0);
183873define('TIDY_TAG_ACRONYM', 0);
183874define('TIDY_TAG_ALIGN', 0);
183875define('TIDY_TAG_APPLET', 0);
183876define('TIDY_TAG_AREA', 0);
183877define('TIDY_TAG_ARTICLE', 0);
183878define('TIDY_TAG_ASIDE', 0);
183879define('TIDY_TAG_AUDIO', 0);
183880define('TIDY_TAG_B', 0);
183881define('TIDY_TAG_BASE', 0);
183882define('TIDY_TAG_BASEFONT', 0);
183883define('TIDY_TAG_BDI', 0);
183884define('TIDY_TAG_BDO', 0);
183885define('TIDY_TAG_BGSOUND', 0);
183886define('TIDY_TAG_BIG', 0);
183887define('TIDY_TAG_BLINK', 0);
183888define('TIDY_TAG_BLOCKQUOTE', 0);
183889define('TIDY_TAG_BODY', 0);
183890define('TIDY_TAG_BR', 0);
183891define('TIDY_TAG_BUTTON', 0);
183892define('TIDY_TAG_CANVAS', 0);
183893define('TIDY_TAG_CAPTION', 0);
183894define('TIDY_TAG_CENTER', 0);
183895define('TIDY_TAG_CITE', 0);
183896define('TIDY_TAG_CODE', 0);
183897define('TIDY_TAG_COL', 0);
183898define('TIDY_TAG_COLGROUP', 0);
183899define('TIDY_TAG_COMMAND', 0);
183900define('TIDY_TAG_COMMENT', 0);
183901define('TIDY_TAG_DATALIST', 0);
183902define('TIDY_TAG_DD', 0);
183903define('TIDY_TAG_DEL', 0);
183904define('TIDY_TAG_DETAILS', 0);
183905define('TIDY_TAG_DFN', 0);
183906define('TIDY_TAG_DIALOG', 0);
183907define('TIDY_TAG_DIR', 0);
183908define('TIDY_TAG_DIV', 0);
183909define('TIDY_TAG_DL', 0);
183910define('TIDY_TAG_DT', 0);
183911define('TIDY_TAG_EM', 0);
183912define('TIDY_TAG_EMBED', 0);
183913define('TIDY_TAG_FIELDSET', 0);
183914define('TIDY_TAG_FIGCAPTION', 0);
183915define('TIDY_TAG_FIGURE', 0);
183916define('TIDY_TAG_FONT', 0);
183917define('TIDY_TAG_FOOTER', 0);
183918define('TIDY_TAG_FORM', 0);
183919define('TIDY_TAG_FRAME', 0);
183920define('TIDY_TAG_FRAMESET', 0);
183921define('TIDY_TAG_H1', 0);
183922define('TIDY_TAG_H2', 0);
183923define('TIDY_TAG_H3', 0);
183924define('TIDY_TAG_H4', 0);
183925define('TIDY_TAG_H5', 0);
183926define('TIDY_TAG_H6', 0);
183927define('TIDY_TAG_HEAD', 0);
183928define('TIDY_TAG_HEADER', 0);
183929define('TIDY_TAG_HGROUP', 0);
183930define('TIDY_TAG_HR', 0);
183931define('TIDY_TAG_HTML', 0);
183932define('TIDY_TAG_I', 0);
183933define('TIDY_TAG_IFRAME', 0);
183934define('TIDY_TAG_ILAYER', 0);
183935define('TIDY_TAG_IMG', 0);
183936define('TIDY_TAG_INPUT', 0);
183937define('TIDY_TAG_INS', 0);
183938define('TIDY_TAG_ISINDEX', 0);
183939define('TIDY_TAG_KBD', 0);
183940define('TIDY_TAG_KEYGEN', 0);
183941define('TIDY_TAG_LABEL', 0);
183942define('TIDY_TAG_LAYER', 0);
183943define('TIDY_TAG_LEGEND', 0);
183944define('TIDY_TAG_LI', 0);
183945define('TIDY_TAG_LINK', 0);
183946define('TIDY_TAG_LISTING', 0);
183947define('TIDY_TAG_MAIN', 0);
183948define('TIDY_TAG_MAP', 0);
183949define('TIDY_TAG_MARK', 0);
183950define('TIDY_TAG_MARQUEE', 0);
183951define('TIDY_TAG_MENU', 0);
183952define('TIDY_TAG_MENUITEM', 0);
183953define('TIDY_TAG_META', 0);
183954define('TIDY_TAG_METER', 0);
183955define('TIDY_TAG_MULTICOL', 0);
183956define('TIDY_TAG_NAV', 0);
183957define('TIDY_TAG_NOBR', 0);
183958define('TIDY_TAG_NOEMBED', 0);
183959define('TIDY_TAG_NOFRAMES', 0);
183960define('TIDY_TAG_NOLAYER', 0);
183961define('TIDY_TAG_NOSAVE', 0);
183962define('TIDY_TAG_NOSCRIPT', 0);
183963define('TIDY_TAG_OBJECT', 0);
183964define('TIDY_TAG_OL', 0);
183965define('TIDY_TAG_OPTGROUP', 0);
183966define('TIDY_TAG_OPTION', 0);
183967define('TIDY_TAG_OUTPUT', 0);
183968define('TIDY_TAG_P', 0);
183969define('TIDY_TAG_PARAM', 0);
183970define('TIDY_TAG_PLAINTEXT', 0);
183971define('TIDY_TAG_PRE', 0);
183972define('TIDY_TAG_PROGRESS', 0);
183973define('TIDY_TAG_Q', 0);
183974define('TIDY_TAG_RB', 0);
183975define('TIDY_TAG_RBC', 0);
183976define('TIDY_TAG_RP', 0);
183977define('TIDY_TAG_RT', 0);
183978define('TIDY_TAG_RTC', 0);
183979define('TIDY_TAG_RUBY', 0);
183980define('TIDY_TAG_S', 0);
183981define('TIDY_TAG_SAMP', 0);
183982define('TIDY_TAG_SCRIPT', 0);
183983define('TIDY_TAG_SECTION', 0);
183984define('TIDY_TAG_SELECT', 0);
183985define('TIDY_TAG_SERVER', 0);
183986define('TIDY_TAG_SERVLET', 0);
183987define('TIDY_TAG_SMALL', 0);
183988define('TIDY_TAG_SOURCE', 0);
183989define('TIDY_TAG_SPACER', 0);
183990define('TIDY_TAG_SPAN', 0);
183991define('TIDY_TAG_STRIKE', 0);
183992define('TIDY_TAG_STRONG', 0);
183993define('TIDY_TAG_STYLE', 0);
183994define('TIDY_TAG_SUB', 0);
183995define('TIDY_TAG_SUMMARY', 0);
183996define('TIDY_TAG_SUP', 0);
183997define('TIDY_TAG_TABLE', 0);
183998define('TIDY_TAG_TBODY', 0);
183999define('TIDY_TAG_TD', 0);
184000define('TIDY_TAG_TEMPLATE', 0);
184001define('TIDY_TAG_TEXTAREA', 0);
184002define('TIDY_TAG_TFOOT', 0);
184003define('TIDY_TAG_TH', 0);
184004define('TIDY_TAG_THEAD', 0);
184005define('TIDY_TAG_TIME', 0);
184006define('TIDY_TAG_TITLE', 0);
184007define('TIDY_TAG_TR', 0);
184008define('TIDY_TAG_TRACK', 0);
184009define('TIDY_TAG_TT', 0);
184010define('TIDY_TAG_U', 0);
184011define('TIDY_TAG_UL', 0);
184012define('TIDY_TAG_UNKNOWN', 0);
184013define('TIDY_TAG_VAR', 0);
184014define('TIDY_TAG_VIDEO', 0);
184015define('TIDY_TAG_WBR', 0);
184016define('TIDY_TAG_XMP', 0);
184017define('TIMING_TRACE', 0);
184018define('TRADER_COMPATIBILITY_DEFAULT', 0);
184019define('TRADER_COMPATIBILITY_METASTOCK', 0);
184020define('TRADER_ERR_ALLOC_ERR', 0);
184021define('TRADER_ERR_BAD_OBJECT', 0);
184022define('TRADER_ERR_BAD_PARAM', 0);
184023define('TRADER_ERR_FUNC_NOT_FOUND', 0);
184024define('TRADER_ERR_GROUP_NOT_FOUND', 0);
184025define('TRADER_ERR_INPUT_NOT_ALL_INITIALIZE', 0);
184026define('TRADER_ERR_INTERNAL_ERROR', 0);
184027define('TRADER_ERR_INVALID_HANDLE', 0);
184028define('TRADER_ERR_INVALID_LIST_TYPE', 0);
184029define('TRADER_ERR_INVALID_PARAM_FUNCTION', 0);
184030define('TRADER_ERR_INVALID_PARAM_HOLDER', 0);
184031define('TRADER_ERR_INVALID_PARAM_HOLDER_TYPE', 0);
184032define('TRADER_ERR_LIB_NOT_INITIALIZE', 0);
184033define('TRADER_ERR_NOT_SUPPORTED', 0);
184034define('TRADER_ERR_OUTPUT_NOT_ALL_INITIALIZE', 0);
184035define('TRADER_ERR_OUT_OF_RANGE_END_INDEX', 0);
184036define('TRADER_ERR_OUT_OF_RANGE_START_INDEX', 0);
184037define('TRADER_ERR_SUCCESS', 0);
184038define('TRADER_ERR_UNKNOWN_ERROR', 0);
184039define('TRADER_FUNC_UNST_ADX', 0);
184040define('TRADER_FUNC_UNST_ADXR', 0);
184041define('TRADER_FUNC_UNST_ALL', 0);
184042define('TRADER_FUNC_UNST_ATR', 0);
184043define('TRADER_FUNC_UNST_CMO', 0);
184044define('TRADER_FUNC_UNST_DX', 0);
184045define('TRADER_FUNC_UNST_EMA', 0);
184046define('TRADER_FUNC_UNST_HT_DCPERIOD', 0);
184047define('TRADER_FUNC_UNST_HT_DCPHASE', 0);
184048define('TRADER_FUNC_UNST_HT_PHASOR', 0);
184049define('TRADER_FUNC_UNST_HT_SINE', 0);
184050define('TRADER_FUNC_UNST_HT_TRENDLINE', 0);
184051define('TRADER_FUNC_UNST_HT_TRENDMODE', 0);
184052define('TRADER_FUNC_UNST_KAMA', 0);
184053define('TRADER_FUNC_UNST_MAMA', 0);
184054define('TRADER_FUNC_UNST_MFI', 0);
184055define('TRADER_FUNC_UNST_MINUS_DI', 0);
184056define('TRADER_FUNC_UNST_MINUS_DM', 0);
184057define('TRADER_FUNC_UNST_NATR', 0);
184058define('TRADER_FUNC_UNST_NONE', 0);
184059define('TRADER_FUNC_UNST_PLUS_DI', 0);
184060define('TRADER_FUNC_UNST_PLUS_DM', 0);
184061define('TRADER_FUNC_UNST_RSI', 0);
184062define('TRADER_FUNC_UNST_STOCHRSI', 0);
184063define('TRADER_FUNC_UNST_T3', 0);
184064define('TRADER_MA_TYPE_DEMA', 0);
184065define('TRADER_MA_TYPE_EMA', 0);
184066define('TRADER_MA_TYPE_KAMA', 0);
184067define('TRADER_MA_TYPE_MAMA', 0);
184068define('TRADER_MA_TYPE_SMA', 0);
184069define('TRADER_MA_TYPE_T3', 0);
184070define('TRADER_MA_TYPE_TEMA', 0);
184071define('TRADER_MA_TYPE_TRIMA', 0);
184072define('TRADER_MA_TYPE_WMA', 0);
184073define('TRADER_REAL_MAX', 0.0);
184074define('TRADER_REAL_MIN', 0.0);
184075define('TRAP_BRKPT', 0);
184076define('TRAP_TRACE', 0);
184077define('TYPEAPPLICATION', 0);
184078define('TYPEAUDIO', 0);
184079define('TYPEIMAGE', 0);
184080define('TYPEMESSAGE', 0);
184081define('TYPEMODEL', 0);
184082define('TYPEMULTIPART', 0);
184083define('TYPEOTHER', 0);
184084define('TYPETEXT', 0);
184085define('TYPEVIDEO', 0);
184086define('T_ABSTRACT', 0);
184087define('T_AND_EQUAL', 0);
184088define('T_ARRAY', 0);
184089define('T_ARRAY_CAST', 0);
184090define('T_AS', 0);
184091define('T_BAD_CHARACTER', 0);
184092define('T_BOOLEAN_AND', 0);
184093define('T_BOOLEAN_OR', 0);
184094define('T_BOOL_CAST', 0);
184095define('T_BREAK', 0);
184096define('T_CALLABLE', 0);
184097define('T_CASE', 0);
184098define('T_CATCH', 0);
184099define('T_CHARACTER', 0);
184100define('T_CLASS', 0);
184101define('T_CLASS_C', 0);
184102define('T_CLONE', 0);
184103define('T_CLOSE_TAG', 0);
184104define('T_COALESCE', 0);
184105define('T_COALESCE_EQUAL', 0);
184106define('T_COMMENT', 0);
184107define('T_CONCAT_EQUAL', 0);
184108define('T_CONST', 0);
184109define('T_CONSTANT_ENCAPSED_STRING', 0);
184110define('T_CONTINUE', 0);
184111define('T_CURLY_OPEN', 0);
184112define('T_DEC', 0);
184113define('T_DECLARE', 0);
184114define('T_DEFAULT', 0);
184115define('T_DIR', 0);
184116define('T_DIV_EQUAL', 0);
184117define('T_DNUMBER', 0);
184118define('T_DO', 0);
184119define('T_DOC_COMMENT', 0);
184120define('T_DOLLAR_OPEN_CURLY_BRACES', 0);
184121define('T_DOUBLE_ARROW', 0);
184122define('T_DOUBLE_CAST', 0);
184123define('T_DOUBLE_COLON', 0);
184124define('T_ECHO', 0);
184125define('T_ELLIPSIS', 0);
184126define('T_ELSE', 0);
184127define('T_ELSEIF', 0);
184128define('T_EMPTY', 0);
184129define('T_ENCAPSED_AND_WHITESPACE', 0);
184130define('T_ENDDECLARE', 0);
184131define('T_ENDFOR', 0);
184132define('T_ENDFOREACH', 0);
184133define('T_ENDIF', 0);
184134define('T_ENDSWITCH', 0);
184135define('T_ENDWHILE', 0);
184136define('T_END_HEREDOC', 0);
184137define('T_EVAL', 0);
184138define('T_EXIT', 0);
184139define('T_EXTENDS', 0);
184140define('T_FILE', 0);
184141define('T_FINAL', 0);
184142define('T_FINALLY', 0);
184143/**
184144 * String that can be used as the format string for {@link strftime} to
184145 * represent time.
184146 **/
184147define('T_FMT', 0);
184148/**
184149 * String that can be used as the format string for {@link strftime} to
184150 * represent time in 12-hour format with ante/post meridian.
184151 **/
184152define('T_FMT_AMPM', 0);
184153define('T_FN', 0);
184154define('T_FOR', 0);
184155define('T_FOREACH', 0);
184156define('T_FUNCTION', 0);
184157define('T_FUNC_C', 0);
184158define('T_GLOBAL', 0);
184159define('T_GOTO', 0);
184160define('T_HALT_COMPILER', 0);
184161define('T_IF', 0);
184162define('T_IMPLEMENTS', 0);
184163define('T_INC', 0);
184164define('T_INCLUDE', 0);
184165define('T_INCLUDE_ONCE', 0);
184166define('T_INLINE_HTML', 0);
184167define('T_INSTANCEOF', 0);
184168define('T_INSTEADOF', 0);
184169define('T_INTERFACE', 0);
184170define('T_INT_CAST', 0);
184171define('T_ISSET', 0);
184172define('T_IS_EQUAL', 0);
184173define('T_IS_GREATER_OR_EQUAL', 0);
184174define('T_IS_IDENTICAL', 0);
184175define('T_IS_NOT_EQUAL', 0);
184176define('T_IS_NOT_IDENTICAL', 0);
184177define('T_IS_SMALLER_OR_EQUAL', 0);
184178define('T_LINE', 0);
184179define('T_LIST', 0);
184180define('T_LNUMBER', 0);
184181define('T_LOGICAL_AND', 0);
184182define('T_LOGICAL_OR', 0);
184183define('T_LOGICAL_XOR', 0);
184184define('T_METHOD_C', 0);
184185define('T_MINUS_EQUAL', 0);
184186define('T_MOD_EQUAL', 0);
184187define('T_MUL_EQUAL', 0);
184188define('T_NAMESPACE', 0);
184189define('T_NEW', 0);
184190define('T_NS_C', 0);
184191define('T_NS_SEPARATOR', 0);
184192define('T_NUM_STRING', 0);
184193define('T_OBJECT_CAST', 0);
184194define('T_OBJECT_OPERATOR', 0);
184195define('T_OPEN_TAG', 0);
184196define('T_OPEN_TAG_WITH_ECHO', 0);
184197define('T_OR_EQUAL', 0);
184198define('T_PAAMAYIM_NEKUDOTAYIM', 0);
184199define('T_PLUS_EQUAL', 0);
184200define('T_POW', 0);
184201define('T_POW_EQUAL', 0);
184202define('T_PRINT', 0);
184203define('T_PRIVATE', 0);
184204define('T_PROTECTED', 0);
184205define('T_PUBLIC', 0);
184206define('T_REQUIRE', 0);
184207define('T_REQUIRE_ONCE', 0);
184208define('T_RETURN', 0);
184209define('T_SL', 0);
184210define('T_SL_EQUAL', 0);
184211define('T_SPACESHIP', 0);
184212define('T_SR', 0);
184213define('T_SR_EQUAL', 0);
184214define('T_START_HEREDOC', 0);
184215define('T_STATIC', 0);
184216define('T_STRING', 0);
184217define('T_STRING_CAST', 0);
184218define('T_STRING_VARNAME', 0);
184219define('T_SWITCH', 0);
184220define('T_THROW', 0);
184221define('T_TRAIT', 0);
184222define('T_TRAIT_C', 0);
184223define('T_TRY', 0);
184224define('T_UNSET', 0);
184225define('T_UNSET_CAST', 0);
184226define('T_USE', 0);
184227define('T_VAR', 0);
184228define('T_VARIABLE', 0);
184229define('T_WHILE', 0);
184230define('T_WHITESPACE', 0);
184231define('T_XOR_EQUAL', 0);
184232define('T_YIELD', 0);
184233define('T_YIELD_FROM', 0);
184234define('UDM_CACHE_DISABLED', 0);
184235define('UDM_CACHE_ENABLED', 0);
184236define('UDM_CROSSWORDS_DISABLED', 0);
184237define('UDM_CROSSWORDS_ENABLED', 0);
184238define('UDM_CROSS_WORDS_DISABLED', 0);
184239define('UDM_CROSS_WORDS_ENABLED', 0);
184240define('UDM_FIELD_CATEGORY', 0);
184241define('UDM_FIELD_CHARSET', 0);
184242define('UDM_FIELD_CONTENT', 0);
184243define('UDM_FIELD_CRC', 0);
184244define('UDM_FIELD_DESC', 0);
184245define('UDM_FIELD_DESCRIPTION', 0);
184246define('UDM_FIELD_KEYWORDS', 0);
184247define('UDM_FIELD_LANG', 0);
184248define('UDM_FIELD_MODIFIED', 0);
184249define('UDM_FIELD_ORDER', 0);
184250define('UDM_FIELD_RATING', 0);
184251define('UDM_FIELD_SCORE', 0);
184252define('UDM_FIELD_SIZE', 0);
184253define('UDM_FIELD_TEXT', 0);
184254define('UDM_FIELD_TITLE', 0);
184255define('UDM_FIELD_URL', 0);
184256define('UDM_FIELD_URLID', 0);
184257define('UDM_ISPELL_PREFIXES_DISABLED', 0);
184258define('UDM_ISPELL_PREFIXES_ENABLED', 0);
184259define('UDM_ISPELL_PREFIX_DISABLED', 0);
184260define('UDM_ISPELL_PREFIX_ENABLED', 0);
184261define('UDM_ISPELL_TYPE_AFFIX', 0);
184262define('UDM_ISPELL_TYPE_DB', 0);
184263define('UDM_ISPELL_TYPE_SERVER', 0);
184264define('UDM_ISPELL_TYPE_SPELL', 0);
184265define('UDM_LIMIT_CAT', 0);
184266define('UDM_LIMIT_DATE', 0);
184267define('UDM_LIMIT_LANG', 0);
184268define('UDM_LIMIT_TAG', 0);
184269define('UDM_LIMIT_URL', 0);
184270define('UDM_MATCH_BEGIN', 0);
184271define('UDM_MATCH_END', 0);
184272define('UDM_MATCH_SUBSTR', 0);
184273define('UDM_MATCH_WORD', 0);
184274define('UDM_MODE_ALL', 0);
184275define('UDM_MODE_ANY', 0);
184276define('UDM_MODE_BOOL', 0);
184277define('UDM_MODE_PHRASE', 0);
184278define('UDM_PARAM_BROWSER_CHARSET', 0);
184279define('UDM_PARAM_CACHE_MODE', 0);
184280define('UDM_PARAM_CHARSET', 0);
184281define('UDM_PARAM_CROSSWORDS', 0);
184282define('UDM_PARAM_CROSS_WORDS', 0);
184283define('UDM_PARAM_DATADIR', 0);
184284define('UDM_PARAM_FIRST_DOC', 0);
184285define('UDM_PARAM_FOUND', 0);
184286define('UDM_PARAM_HLBEG', 0);
184287define('UDM_PARAM_HLEND', 0);
184288define('UDM_PARAM_ISPELL_PREFIX', 0);
184289define('UDM_PARAM_ISPELL_PREFIXES', 0);
184290define('UDM_PARAM_LAST_DOC', 0);
184291define('UDM_PARAM_LOCAL_CHARSET', 0);
184292define('UDM_PARAM_MAX_WORDLEN', 0);
184293define('UDM_PARAM_MAX_WORD_LEN', 0);
184294define('UDM_PARAM_MIN_WORDLEN', 0);
184295define('UDM_PARAM_MIN_WORD_LEN', 0);
184296define('UDM_PARAM_NUM_ROWS', 0);
184297define('UDM_PARAM_PAGE_NUM', 0);
184298define('UDM_PARAM_PAGE_SIZE', 0);
184299define('UDM_PARAM_PHRASE_MODE', 0);
184300define('UDM_PARAM_PREFIX', 0);
184301define('UDM_PARAM_PREFIXES', 0);
184302define('UDM_PARAM_QSTRING', 0);
184303define('UDM_PARAM_REMOTE_ADDR', 0);
184304define('UDM_PARAM_SEARCHD', 0);
184305define('UDM_PARAM_SEARCHTIME', 0);
184306define('UDM_PARAM_SEARCH_MODE', 0);
184307define('UDM_PARAM_SEARCH_TIME', 0);
184308define('UDM_PARAM_STOPFILE', 0);
184309define('UDM_PARAM_STOPTABLE', 0);
184310define('UDM_PARAM_STOP_FILE', 0);
184311define('UDM_PARAM_STOP_TABLE', 0);
184312define('UDM_PARAM_SYNONYM', 0);
184313define('UDM_PARAM_TRACK_MODE', 0);
184314define('UDM_PARAM_VARDIR', 0);
184315define('UDM_PARAM_WEIGHT_FACTOR', 0);
184316define('UDM_PARAM_WORDINFO', 0);
184317define('UDM_PARAM_WORD_INFO', 0);
184318define('UDM_PARAM_WORD_MATCH', 0);
184319define('UDM_PHRASE_DISABLED', 0);
184320define('UDM_PHRASE_ENABLED', 0);
184321define('UDM_PREFIXES_DISABLED', 0);
184322define('UDM_PREFIXES_ENABLED', 0);
184323define('UDM_PREFIX_DISABLED', 0);
184324define('UDM_PREFIX_ENABLED', 0);
184325define('UDM_TRACK_DISABLED', 0);
184326define('UDM_TRACK_ENABLED', 0);
184327define('UNIMPLEMENTED', 0);
184328define('UNKNOWN_TYPE', 0);
184329/**
184330 * Value: 7; Failed to write file to disk. Introduced in PHP 5.1.0.
184331 **/
184332define('UPLOAD_ERR_CANT_WRITE', 0);
184333/**
184334 * Value: 8; A PHP extension stopped the file upload. PHP does not
184335 * provide a way to ascertain which extension caused the file upload to
184336 * stop; examining the list of loaded extensions with {@link phpinfo} may
184337 * help. Introduced in PHP 5.2.0.
184338 **/
184339define('UPLOAD_ERR_EXTENSION', 0);
184340/**
184341 * Value: 2; The uploaded file exceeds the MAX_FILE_SIZE directive that
184342 * was specified in the HTML form.
184343 **/
184344define('UPLOAD_ERR_FORM_SIZE', 0);
184345/**
184346 * Value: 1; The uploaded file exceeds the upload_max_filesize directive
184347 * in .
184348 **/
184349define('UPLOAD_ERR_INI_SIZE', 0);
184350/**
184351 * Value: 4; No file was uploaded.
184352 **/
184353define('UPLOAD_ERR_NO_FILE', 0);
184354/**
184355 * Value: 6; Missing a temporary folder. Introduced in PHP 5.0.3.
184356 **/
184357define('UPLOAD_ERR_NO_TMP_DIR', 0);
184358/**
184359 * Value: 0; There is no error, the file uploaded with success.
184360 **/
184361define('UPLOAD_ERR_OK', 0);
184362/**
184363 * Value: 3; The uploaded file was only partially uploaded.
184364 **/
184365define('UPLOAD_ERR_PARTIAL', 0);
184366define('USE_KEY', 0);
184367define('UTF-8', 0);
184368/**
184369 * {@link left} is equal to {@link right}
184370 **/
184371define('VARCMP_EQ', 0);
184372/**
184373 * {@link left} is greater than {@link right}
184374 **/
184375define('VARCMP_GT', 0);
184376/**
184377 * {@link left} is less than {@link right}
184378 **/
184379define('VARCMP_LT', 0);
184380/**
184381 * Either {@link left}, {@link right} or both are NULL
184382 **/
184383define('VARCMP_NULL', 0);
184384define('VARNISH_COMPAT_2', 0);
184385define('VARNISH_COMPAT_3', 0);
184386define('VARNISH_CONFIG_COMPAT', '');
184387define('VARNISH_CONFIG_HOST', '');
184388define('VARNISH_CONFIG_IDENT', '');
184389define('VARNISH_CONFIG_PORT', '');
184390define('VARNISH_CONFIG_SECRET', '');
184391define('VARNISH_CONFIG_TIMEOUT', '');
184392define('VARNISH_STATUS_AUTH', 0);
184393define('VARNISH_STATUS_CANT', 0);
184394define('VARNISH_STATUS_CLOSE', 0);
184395define('VARNISH_STATUS_COMMS', 0);
184396define('VARNISH_STATUS_OK', 0);
184397define('VARNISH_STATUS_PARAM', 0);
184398define('VARNISH_STATUS_SYNTAX', 0);
184399define('VARNISH_STATUS_TOOFEW', 0);
184400define('VARNISH_STATUS_TOOMANY', 0);
184401define('VARNISH_STATUS_UNIMPL', 0);
184402define('VARNISH_STATUS_UNKNOWN', 0);
184403define('VT_ARRAY', 0);
184404/**
184405 * Boolean value.
184406 **/
184407define('VT_BOOL', 0);
184408/**
184409 * Pointer to a null-terminated Unicode string.
184410 **/
184411define('VT_BSTR', 0);
184412define('VT_BYREF', 0);
184413/**
184414 * 8-byte two's complement integer (scaled by 10,000).
184415 **/
184416define('VT_CY', 0);
184417define('VT_DATE', 0);
184418/**
184419 * A decimal structure.
184420 **/
184421define('VT_DECIMAL', 0);
184422/**
184423 * A pointer to a pointer to an object was specified.
184424 **/
184425define('VT_DISPATCH', 0);
184426define('VT_EMPTY', 0);
184427/**
184428 * Error code; containing the status code associated with the error.
184429 **/
184430define('VT_ERROR', 0);
184431/**
184432 * 1-byte signed integer.
184433 **/
184434define('VT_I1', 0);
184435/**
184436 * Two bytes representing a 2-byte signed integer value.
184437 **/
184438define('VT_I2', 0);
184439/**
184440 * 4-byte signed integer value.
184441 **/
184442define('VT_I4', 0);
184443/**
184444 * 8-byte signed integer value.
184445 **/
184446define('VT_I8', 0);
184447define('VT_INT', 0);
184448/**
184449 * NULL pointer reference.
184450 **/
184451define('VT_NULL', 0);
184452/**
184453 * 32-bit IEEE floating point value.
184454 **/
184455define('VT_R4', 0);
184456/**
184457 * 64-bit IEEE floating point value.
184458 **/
184459define('VT_R8', 0);
184460/**
184461 * 1-byte unsigned integer.
184462 **/
184463define('VT_UI1', 0);
184464/**
184465 * 2-byte unsigned integer.
184466 **/
184467define('VT_UI2', 0);
184468/**
184469 * 4-byte unsigned integer.
184470 **/
184471define('VT_UI4', 0);
184472/**
184473 * 8-byte unsigned integer.
184474 **/
184475define('VT_UI8', 0);
184476define('VT_UINT', 0);
184477/**
184478 * A pointer to an object that implements the IUnknown interface.
184479 **/
184480define('VT_UNKNOWN', 0);
184481define('VT_VARIANT', 0);
184482define('WEBSOCKET_OPCODE_BINARY', 0);
184483define('WEBSOCKET_OPCODE_PING', 0);
184484define('WEBSOCKET_OPCODE_TEXT', 0);
184485define('WEBSOCKET_STATUS_ACTIVE', 0);
184486define('WEBSOCKET_STATUS_CONNECTION', 0);
184487define('WEBSOCKET_STATUS_FRAME', 0);
184488define('WEBSOCKET_STATUS_HANDSHAKE', 0);
184489/**
184490 * Process that has priority above WIN32_NORMAL_PRIORITY_CLASS but below
184491 * WIN32_HIGH_PRIORITY_CLASS.
184492 **/
184493define('WIN32_ABOVE_NORMAL_PRIORITY_CLASS', 0);
184494/**
184495 * Process that has priority above WIN32_IDLE_PRIORITY_CLASS but below
184496 * WIN32_NORMAL_PRIORITY_CLASS.
184497 **/
184498define('WIN32_BELOW_NORMAL_PRIORITY_CLASS', 0);
184499/**
184500 * The handle to the SCM database does not have the appropriate access
184501 * rights.
184502 **/
184503define('WIN32_ERROR_ACCESS_DENIED', 0);
184504/**
184505 * A circular service dependency was specified.
184506 **/
184507define('WIN32_ERROR_CIRCULAR_DEPENDENCY', 0);
184508/**
184509 * The specified database does not exist.
184510 **/
184511define('WIN32_ERROR_DATABASE_DOES_NOT_EXIST', 0);
184512/**
184513 * The service cannot be stopped because other running services are
184514 * dependent on it.
184515 **/
184516define('WIN32_ERROR_DEPENDENT_SERVICES_RUNNING', 0);
184517/**
184518 * The display name already exists in the service control manager
184519 * database either as a service name or as another display name.
184520 **/
184521define('WIN32_ERROR_DUPLICATE_SERVICE_NAME', 0);
184522/**
184523 * This error is returned if the program is being run as a console
184524 * application rather than as a service. If the program will be run as a
184525 * console application for debugging purposes, structure it such that
184526 * service-specific code is not called.
184527 **/
184528define('WIN32_ERROR_FAILED_SERVICE_CONTROLLER_CONNECT', 0);
184529/**
184530 * The buffer is too small for the service status structure. Nothing was
184531 * written to the structure.
184532 **/
184533define('WIN32_ERROR_INSUFFICIENT_BUFFER', 0);
184534/**
184535 * The specified service status structure is invalid.
184536 **/
184537define('WIN32_ERROR_INVALID_DATA', 0);
184538/**
184539 * The handle to the specified service control manager database is
184540 * invalid.
184541 **/
184542define('WIN32_ERROR_INVALID_HANDLE', 0);
184543/**
184544 * The InfoLevel parameter contains an unsupported value.
184545 **/
184546define('WIN32_ERROR_INVALID_LEVEL', 0);
184547/**
184548 * The specified service name is invalid.
184549 **/
184550define('WIN32_ERROR_INVALID_NAME', 0);
184551/**
184552 * A parameter that was specified is invalid.
184553 **/
184554define('WIN32_ERROR_INVALID_PARAMETER', 0);
184555/**
184556 * The user account name specified in the {@link user} parameter does not
184557 * exist. See {@link win32_create_service}.
184558 **/
184559define('WIN32_ERROR_INVALID_SERVICE_ACCOUNT', 0);
184560/**
184561 * The requested control code is not valid, or it is unacceptable to the
184562 * service.
184563 **/
184564define('WIN32_ERROR_INVALID_SERVICE_CONTROL', 0);
184565/**
184566 * The service binary file could not be found.
184567 **/
184568define('WIN32_ERROR_PATH_NOT_FOUND', 0);
184569/**
184570 * An instance of the service is already running.
184571 **/
184572define('WIN32_ERROR_SERVICE_ALREADY_RUNNING', 0);
184573/**
184574 * The requested control code cannot be sent to the service because the
184575 * state of the service is WIN32_SERVICE_STOPPED,
184576 * WIN32_SERVICE_START_PENDING, or WIN32_SERVICE_STOP_PENDING.
184577 **/
184578define('WIN32_ERROR_SERVICE_CANNOT_ACCEPT_CTRL', 0);
184579/**
184580 * The database is locked.
184581 **/
184582define('WIN32_ERROR_SERVICE_DATABASE_LOCKED', 0);
184583/**
184584 * The service depends on a service that does not exist or has been
184585 * marked for deletion.
184586 **/
184587define('WIN32_ERROR_SERVICE_DEPENDENCY_DELETED', 0);
184588/**
184589 * The service depends on another service that has failed to start.
184590 **/
184591define('WIN32_ERROR_SERVICE_DEPENDENCY_FAIL', 0);
184592/**
184593 * The service has been disabled.
184594 **/
184595define('WIN32_ERROR_SERVICE_DISABLED', 0);
184596/**
184597 * The specified service does not exist as an installed service.
184598 **/
184599define('WIN32_ERROR_SERVICE_DOES_NOT_EXIST', 0);
184600/**
184601 * The specified service already exists in this database.
184602 **/
184603define('WIN32_ERROR_SERVICE_EXISTS', 0);
184604/**
184605 * The service did not start due to a logon failure. This error occurs if
184606 * the service is configured to run under an account that does not have
184607 * the "Log on as a service" right.
184608 **/
184609define('WIN32_ERROR_SERVICE_LOGON_FAILED', 0);
184610/**
184611 * The specified service has already been marked for deletion.
184612 **/
184613define('WIN32_ERROR_SERVICE_MARKED_FOR_DELETE', 0);
184614/**
184615 * The service has not been started.
184616 **/
184617define('WIN32_ERROR_SERVICE_NOT_ACTIVE', 0);
184618/**
184619 * A thread could not be created for the service.
184620 **/
184621define('WIN32_ERROR_SERVICE_NO_THREAD', 0);
184622/**
184623 * The process for the service was started, but it did not call
184624 * StartServiceCtrlDispatcher, or the thread that called
184625 * StartServiceCtrlDispatcher may be blocked in a control handler
184626 * function.
184627 **/
184628define('WIN32_ERROR_SERVICE_REQUEST_TIMEOUT', 0);
184629/**
184630 * The service has returned a service-specific error code.
184631 **/
184632define('WIN32_ERROR_SERVICE_SPECIFIC_ERROR', 0);
184633/**
184634 * The system is shutting down; this function cannot be called.
184635 **/
184636define('WIN32_ERROR_SHUTDOWN_IN_PROGRESS', 0);
184637/**
184638 * Process that performs time-critical tasks that must be executed
184639 * immediately. The threads of the process preempt the threads of normal
184640 * or idle priority class processes. An example is the Task List, which
184641 * must respond quickly when called by the user, regardless of the load
184642 * on the operating system. Use extreme care when using the high-priority
184643 * class, because a high-priority class application can use nearly all
184644 * available CPU time.
184645 **/
184646define('WIN32_HIGH_PRIORITY_CLASS', 0);
184647/**
184648 * Process whose threads run only when the system is idle. The threads of
184649 * the process are preempted by the threads of any process running in a
184650 * higher priority class. An example is a screen saver. The idle-priority
184651 * class is inherited by child processes.
184652 **/
184653define('WIN32_IDLE_PRIORITY_CLASS', 0);
184654define('WIN32_INFO_DESCRIPTION', 0);
184655define('WIN32_INFO_DISPLAY', 0);
184656define('WIN32_INFO_PARAMS', 0);
184657define('WIN32_INFO_PASSWORD', 0);
184658define('WIN32_INFO_PATH', 0);
184659define('WIN32_INFO_SERVICE', 0);
184660define('WIN32_INFO_START_TYPE', 0);
184661define('WIN32_INFO_USER', 0);
184662/**
184663 * Process with no special scheduling needs.
184664 **/
184665define('WIN32_NORMAL_PRIORITY_CLASS', 0);
184666/**
184667 * No error.
184668 **/
184669define('WIN32_NO_ERROR', 0);
184670/**
184671 * Process that has the highest possible priority. The threads of the
184672 * process preempt the threads of all other processes, including
184673 * operating system processes performing important tasks. For example, a
184674 * real-time process that executes for more than a very brief interval
184675 * can cause disk caches not to flush or cause the mouse to be
184676 * unresponsive.
184677 **/
184678define('WIN32_REALTIME_PRIORITY_CLASS', 0);
184679/**
184680 * No action.
184681 **/
184682define('WIN32_SC_ACTION_NONE', 0);
184683/**
184684 * Restart the server.
184685 **/
184686define('WIN32_SC_ACTION_REBOOT', 0);
184687/**
184688 * Restart the service.
184689 **/
184690define('WIN32_SC_ACTION_RESTART', 0);
184691/**
184692 * Run a command.
184693 **/
184694define('WIN32_SC_ACTION_RUN_COMMAND', 0);
184695/**
184696 * The service is notified when the computer's hardware profile has
184697 * changed. This enables the system to send
184698 * WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE notifications to the
184699 * service.
184700 **/
184701define('WIN32_SERVICE_ACCEPT_HARDWAREPROFILECHANGE', 0);
184702/**
184703 * The service is a network component that can accept changes in its
184704 * binding without being stopped and restarted. This control code allows
184705 * the service to receive WIN32_SERVICE_CONTROL_NETBINDADD,
184706 * WIN32_SERVICE_CONTROL_NETBINDREMOVE,
184707 * WIN32_SERVICE_CONTROL_NETBINDENABLE, and
184708 * WIN32_SERVICE_CONTROL_NETBINDDISABLE notifications.
184709 **/
184710define('WIN32_SERVICE_ACCEPT_NETBINDCHANGE', 0);
184711/**
184712 * The service can reread its startup parameters without being stopped
184713 * and restarted. This control code allows the service to receive
184714 * WIN32_SERVICE_CONTROL_PARAMCHANGE notifications.
184715 **/
184716define('WIN32_SERVICE_ACCEPT_PARAMCHANGE', 0);
184717/**
184718 * The service can be paused and continued. This control code allows the
184719 * service to receive WIN32_SERVICE_CONTROL_PAUSE and
184720 * WIN32_SERVICE_CONTROL_CONTINUE notifications.
184721 **/
184722define('WIN32_SERVICE_ACCEPT_PAUSE_CONTINUE', 0);
184723/**
184724 * The service is notified when the computer's power status has changed.
184725 * This enables the system to send WIN32_SERVICE_CONTROL_POWEREVENT
184726 * notifications to the service.
184727 **/
184728define('WIN32_SERVICE_ACCEPT_POWEREVENT', 0);
184729/**
184730 * The service can perform preshutdown tasks. This control code enables
184731 * the service to receive WIN32_SERVICE_CONTROL_PRESHUTDOWN
184732 * notifications. This value is not supported by Windows Server 2003 and
184733 * Windows XP/2000.
184734 **/
184735define('WIN32_SERVICE_ACCEPT_PRESHUTDOWN', 0);
184736/**
184737 * The service is notified when the computer's session status has
184738 * changed. This enables the system to send
184739 * WIN32_SERVICE_CONTROL_SESSIONCHANGE notifications to the service.
184740 * Windows 2000: This value is not supported
184741 **/
184742define('WIN32_SERVICE_ACCEPT_SESSIONCHANGE', 0);
184743/**
184744 * The service is notified when system shutdown occurs. This control code
184745 * allows the service to receive WIN32_SERVICE_CONTROL_SHUTDOWN
184746 * notifications.
184747 **/
184748define('WIN32_SERVICE_ACCEPT_SHUTDOWN', 0);
184749/**
184750 * The service can be stopped. This control code allows the service to
184751 * receive WIN32_SERVICE_CONTROL_STOP notifications.
184752 **/
184753define('WIN32_SERVICE_ACCEPT_STOP', 0);
184754/**
184755 * The service is notified when the system time has changed. This enables
184756 * the system to send WIN32_SERVICE_CONTROL_TIMECHANGE notifications to
184757 * the service. Windows Server 2008, Windows Vista, Windows Server 2003,
184758 * and Windows XP/2000: This control code is not supported.
184759 **/
184760define('WIN32_SERVICE_ACCEPT_TIMECHANGE', 0);
184761/**
184762 * The service is notified when an event for which the service has
184763 * registered occurs. This enables the system to send
184764 * WIN32_SERVICE_CONTROL_TRIGGEREVENT notifications to the service.
184765 * Windows Server 2008, Windows Vista, Windows Server 2003, and Windows
184766 * XP/2000: This control code is not supported.
184767 **/
184768define('WIN32_SERVICE_ACCEPT_TRIGGEREVENT', 0);
184769/**
184770 * A service started automatically by the service control manager during
184771 * system startup.
184772 **/
184773define('WIN32_SERVICE_AUTO_START', 0);
184774/**
184775 * A device driver started by the system loader. This value is valid only
184776 * for driver services.
184777 **/
184778define('WIN32_SERVICE_BOOT_START', 0);
184779/**
184780 * The service continue is pending.
184781 **/
184782define('WIN32_SERVICE_CONTINUE_PENDING', 0);
184783/**
184784 * Notifies a paused service that it should resume.
184785 **/
184786define('WIN32_SERVICE_CONTROL_CONTINUE', 0);
184787define('WIN32_SERVICE_CONTROL_DEVICEEVENT', 0);
184788define('WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE', 0);
184789/**
184790 * Notifies a service that it should report its current status
184791 * information to the service control manager.
184792 **/
184793define('WIN32_SERVICE_CONTROL_INTERROGATE', 0);
184794/**
184795 * Notifies a network service that there is a new component for binding.
184796 **/
184797define('WIN32_SERVICE_CONTROL_NETBINDADD', 0);
184798/**
184799 * Notifies a network service that one of its bindings has been disabled.
184800 **/
184801define('WIN32_SERVICE_CONTROL_NETBINDDISABLE', 0);
184802/**
184803 * Notifies a network service that a disabled binding has been enabled.
184804 **/
184805define('WIN32_SERVICE_CONTROL_NETBINDENABLE', 0);
184806/**
184807 * Notifies a network service that a component for binding has been
184808 * removed.
184809 **/
184810define('WIN32_SERVICE_CONTROL_NETBINDREMOVE', 0);
184811/**
184812 * Notifies a service that its startup parameters have changed.
184813 **/
184814define('WIN32_SERVICE_CONTROL_PARAMCHANGE', 0);
184815/**
184816 * Notifies a service that it should pause.
184817 **/
184818define('WIN32_SERVICE_CONTROL_PAUSE', 0);
184819define('WIN32_SERVICE_CONTROL_POWEREVENT', 0);
184820/**
184821 * Notifies a service that the system will be shutting down. A service
184822 * that handles this notification blocks system shutdown until the
184823 * service stops or the preshutdown time-out interval expires. This value
184824 * is not supported by Windows Server 2003 and Windows XP/2000.
184825 **/
184826define('WIN32_SERVICE_CONTROL_PRESHUTDOWN', 0);
184827define('WIN32_SERVICE_CONTROL_SESSIONCHANGE', 0);
184828/**
184829 * Notifies a service that the system is shutting down so the service can
184830 * perform cleanup tasks. If a service accepts this control code, it must
184831 * stop after it performs its cleanup tasks. After the SCM sends this
184832 * control code, it will not send other control codes to the service.
184833 **/
184834define('WIN32_SERVICE_CONTROL_SHUTDOWN', 0);
184835/**
184836 * Notifies a service that it should stop.
184837 **/
184838define('WIN32_SERVICE_CONTROL_STOP', 0);
184839define('WIN32_SERVICE_CONTROL_TIMECHANGE', 0);
184840define('WIN32_SERVICE_CONTROL_TRIGGEREVENT', 0);
184841/**
184842 * A service started by the service control manager when a process calls
184843 * the StartService function.
184844 **/
184845define('WIN32_SERVICE_DEMAND_START', 0);
184846/**
184847 * A service that cannot be started. Attempts to start the service result
184848 * in the error code WIN32_ERROR_SERVICE_DISABLED.
184849 **/
184850define('WIN32_SERVICE_DISABLED', 0);
184851/**
184852 * The startup program logs the error in the event log, if possible. If
184853 * the last-known-good configuration is being started, the startup
184854 * operation fails. Otherwise, the system is restarted with the
184855 * last-known good configuration.
184856 **/
184857define('WIN32_SERVICE_ERROR_CRITICAL', 0);
184858/**
184859 * The startup program ignores the error and continues the startup
184860 * operation.
184861 **/
184862define('WIN32_SERVICE_ERROR_IGNORE', 0);
184863/**
184864 * The startup program logs the error in the event log but continues the
184865 * startup operation.
184866 **/
184867define('WIN32_SERVICE_ERROR_NORMAL', 0);
184868/**
184869 * The startup program logs the error in the event log. If the
184870 * last-known-good configuration is being started, the startup operation
184871 * continues. Otherwise, the system is restarted with the last-known-good
184872 * configuration.
184873 **/
184874define('WIN32_SERVICE_ERROR_SEVERE', 0);
184875/**
184876 * The service can interact with the desktop. This option is not
184877 * available on Windows Vista or later.
184878 **/
184879define('WIN32_SERVICE_INTERACTIVE_PROCESS', 0);
184880/**
184881 * The service is paused.
184882 **/
184883define('WIN32_SERVICE_PAUSED', 0);
184884/**
184885 * The service pause is pending.
184886 **/
184887define('WIN32_SERVICE_PAUSE_PENDING', 0);
184888/**
184889 * The service is running.
184890 **/
184891define('WIN32_SERVICE_RUNNING', 0);
184892/**
184893 * The service runs in a system process that must always be running.
184894 **/
184895define('WIN32_SERVICE_RUNS_IN_SYSTEM_PROCESS', 0);
184896/**
184897 * The service is starting.
184898 **/
184899define('WIN32_SERVICE_START_PENDING', 0);
184900/**
184901 * The service is not running.
184902 **/
184903define('WIN32_SERVICE_STOPPED', 0);
184904/**
184905 * The service is stopping.
184906 **/
184907define('WIN32_SERVICE_STOP_PENDING', 0);
184908/**
184909 * A device driver started by the IoInitSystem function. This value is
184910 * valid only for driver services.
184911 **/
184912define('WIN32_SERVICE_SYSTEM_START', 0);
184913/**
184914 * The service runs in its own process.
184915 **/
184916define('WIN32_SERVICE_WIN32_OWN_PROCESS', 0);
184917/**
184918 * The service runs in its own process and can interact with the desktop.
184919 * This option is not available on Windows Vista or later.
184920 **/
184921define('WIN32_SERVICE_WIN32_OWN_PROCESS_INTERACTIVE', 0);
184922define('WNOHANG', 0);
184923define('WSDL_CACHE_BOTH', 0);
184924define('WSDL_CACHE_DISK', 0);
184925define('WSDL_CACHE_MEMORY', 0);
184926define('WSDL_CACHE_NONE', 0);
184927define('WUNTRACED', 0);
184928define('X509_PURPOSE_ANY', 0);
184929define('X509_PURPOSE_CRL_SIGN', 0);
184930define('X509_PURPOSE_NS_SSL_SERVER', 0);
184931define('X509_PURPOSE_SMIME_ENCRYPT', 0);
184932define('X509_PURPOSE_SMIME_SIGN', 0);
184933define('X509_PURPOSE_SSL_CLIENT', 0);
184934define('X509_PURPOSE_SSL_SERVER', 0);
184935/**
184936 * Function will fail if extended attribute already exists.
184937 **/
184938define('XATTR_CREATE', 0);
184939/**
184940 * Do not follow the symbolic link but operate on symbolic link itself.
184941 **/
184942define('XATTR_DONTFOLLOW', 0);
184943/**
184944 * Function will fail if extended attribute doesn't exist.
184945 **/
184946define('XATTR_REPLACE', 0);
184947/**
184948 * Set attribute in root (trusted) namespace. Requires root privileges.
184949 **/
184950define('XATTR_ROOT', 0);
184951define('XDIFF_PATCH_NORMAL', 0);
184952define('XDIFF_PATCH_REVERSE', 0);
184953define('XHPROF_FLAGS_CPU', 0);
184954define('XHPROF_FLAGS_MEMORY', 0);
184955define('XHPROF_FLAGS_NO_BUILTINS', 0);
184956define('XML_ATTRIBUTE_CDATA', 0);
184957define('XML_ATTRIBUTE_DECL_NODE', 0);
184958define('XML_ATTRIBUTE_ENTITY', 0);
184959define('XML_ATTRIBUTE_ENUMERATION', 0);
184960define('XML_ATTRIBUTE_ID', 0);
184961define('XML_ATTRIBUTE_IDREF', 0);
184962define('XML_ATTRIBUTE_IDREFS', 0);
184963define('XML_ATTRIBUTE_NMTOKEN', 0);
184964define('XML_ATTRIBUTE_NMTOKENS', 0);
184965define('XML_ATTRIBUTE_NODE', 0);
184966define('XML_ATTRIBUTE_NOTATION', 0);
184967define('XML_CDATA_SECTION_NODE', 0);
184968define('XML_COMMENT_NODE', 0);
184969define('XML_DOCUMENT_FRAG_NODE', 0);
184970define('XML_DOCUMENT_NODE', 0);
184971define('XML_DOCUMENT_TYPE_NODE', 0);
184972define('XML_DTD_NODE', 0);
184973define('XML_ELEMENT_DECL_NODE', 0);
184974define('XML_ELEMENT_NODE', 0);
184975define('XML_ENTITY_DECL_NODE', 0);
184976define('XML_ENTITY_NODE', 0);
184977define('XML_ENTITY_REF_NODE', 0);
184978define('XML_ERROR_ASYNC_ENTITY', 0);
184979define('XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF', 0);
184980define('XML_ERROR_BAD_CHAR_REF', 0);
184981define('XML_ERROR_BINARY_ENTITY_REF', 0);
184982define('XML_ERROR_DUPLICATE_ATTRIBUTE', 0);
184983define('XML_ERROR_EXTERNAL_ENTITY_HANDLING', 0);
184984define('XML_ERROR_INCORRECT_ENCODING', 0);
184985define('XML_ERROR_INVALID_TOKEN', 0);
184986define('XML_ERROR_JUNK_AFTER_DOC_ELEMENT', 0);
184987define('XML_ERROR_MISPLACED_XML_PI', 0);
184988define('XML_ERROR_NONE', 0);
184989define('XML_ERROR_NO_ELEMENTS', 0);
184990define('XML_ERROR_NO_MEMORY', 0);
184991define('XML_ERROR_PARAM_ENTITY_REF', 0);
184992define('XML_ERROR_PARTIAL_CHAR', 0);
184993define('XML_ERROR_RECURSIVE_ENTITY_REF', 0);
184994define('XML_ERROR_SYNTAX', 0);
184995define('XML_ERROR_TAG_MISMATCH', 0);
184996define('XML_ERROR_UNCLOSED_CDATA_SECTION', 0);
184997define('XML_ERROR_UNCLOSED_TOKEN', 0);
184998define('XML_ERROR_UNDEFINED_ENTITY', 0);
184999define('XML_ERROR_UNKNOWN_ENCODING', 0);
185000define('XML_HTML_DOCUMENT_NODE', 0);
185001define('XML_NAMESPACE_DECL_NODE', 0);
185002define('XML_NOTATION_NODE', 0);
185003/**
185004 * integer
185005 **/
185006define('XML_OPTION_CASE_FOLDING', 0);
185007/**
185008 * integer
185009 **/
185010define('XML_OPTION_SKIP_TAGSTART', 0);
185011/**
185012 * integer
185013 **/
185014define('XML_OPTION_SKIP_WHITE', 0);
185015/**
185016 * string
185017 **/
185018define('XML_OPTION_TARGET_ENCODING', 0);
185019define('XML_PI_NODE', 0);
185020define('XML_SAX_IMPL', '');
185021define('XML_TEXT_NODE', 0);
185022define('XSD_1999_NAMESPACE', 0);
185023define('XSD_1999_TIMEINSTANT', 0);
185024define('XSD_ANYTYPE', 0);
185025define('XSD_ANYURI', 0);
185026define('XSD_ANYXML', 0);
185027define('XSD_BASE64BINARY', 0);
185028define('XSD_BOOLEAN', 0);
185029define('XSD_BYTE', 0);
185030define('XSD_DATE', 0);
185031define('XSD_DATETIME', 0);
185032define('XSD_DECIMAL', 0);
185033define('XSD_DOUBLE', 0);
185034define('XSD_DURATION', 0);
185035define('XSD_ENTITIES', 0);
185036define('XSD_ENTITY', 0);
185037define('XSD_FLOAT', 0);
185038define('XSD_GDAY', 0);
185039define('XSD_GMONTH', 0);
185040define('XSD_GMONTHDAY', 0);
185041define('XSD_GYEAR', 0);
185042define('XSD_GYEARMONTH', 0);
185043define('XSD_HEXBINARY', 0);
185044define('XSD_ID', 0);
185045define('XSD_IDREF', 0);
185046define('XSD_IDREFS', 0);
185047define('XSD_INT', 0);
185048define('XSD_INTEGER', 0);
185049define('XSD_LANGUAGE', 0);
185050define('XSD_LONG', 0);
185051define('XSD_NAME', 0);
185052define('XSD_NAMESPACE', 0);
185053define('XSD_NCNAME', 0);
185054define('XSD_NEGATIVEINTEGER', 0);
185055define('XSD_NMTOKEN', 0);
185056define('XSD_NMTOKENS', 0);
185057define('XSD_NONNEGATIVEINTEGER', 0);
185058define('XSD_NONPOSITIVEINTEGER', 0);
185059define('XSD_NORMALIZEDSTRING', 0);
185060define('XSD_NOTATION', 0);
185061define('XSD_POSITIVEINTEGER', 0);
185062define('XSD_QNAME', 0);
185063define('XSD_SHORT', 0);
185064define('XSD_STRING', 0);
185065define('XSD_TIME', 0);
185066define('XSD_TOKEN', 0);
185067define('XSD_UNSIGNEDBYTE', 0);
185068define('XSD_UNSIGNEDINT', 0);
185069define('XSD_UNSIGNEDLONG', 0);
185070define('XSD_UNSIGNEDSHORT', 0);
185071define('XSL_CLONE_ALWAYS', 0);
185072define('XSL_CLONE_AUTO', 0);
185073define('XSL_CLONE_NEVER', 0);
185074define('XSL_SECPREF_CREATE_DIRECTORY', 0);
185075define('XSL_SECPREF_DEFAULT', 0);
185076define('XSL_SECPREF_NONE', 0);
185077define('XSL_SECPREF_READ_FILE', 0);
185078define('XSL_SECPREF_READ_NETWORK', 0);
185079define('XSL_SECPREF_WRITE_FILE', 0);
185080define('XSL_SECPREF_WRITE_NETWORK', 0);
185081define('YAC_MAX_KEY_LEN', 0);
185082define('YAC_MAX_RAW_COMPRESSED_LEN', 0);
185083define('YAC_MAX_VALUE_RAW_LEN', 0);
185084define('YAC_SERIALIZER', '');
185085define('YAC_SERIALIZER_IGBINARY', 0);
185086define('YAC_SERIALIZER_JSON', 0);
185087define('YAC_SERIALIZER_MSGPACK', 0);
185088define('YAC_SERIALIZER_PHP', 0);
185089define('YAC_VERSION', '');
185090define('YAF_ENVIRON', '');
185091define('YAF_ERR_AUTOLOAD_FAILED', 0);
185092define('YAF_ERR_CALL_FAILED', 0);
185093define('YAF_ERR_DISPATCH_FAILED', 0);
185094define('YAF_ERR_NOTFOUND_ACTION', 0);
185095define('YAF_ERR_NOTFOUND_CONTROLLER', 0);
185096define('YAF_ERR_NOTFOUND_MODULE', 0);
185097define('YAF_ERR_NOTFOUND_VIEW', 0);
185098define('YAF_ERR_ROUTE_FAILED', 0);
185099define('YAF_ERR_STARTUP_FAILED', 0);
185100define('YAF_ERR_TYPE_ERROR', 0);
185101define('YAF_VERSION', '');
185102define('YAML_ANY_BREAK', 0);
185103define('YAML_ANY_ENCODING', 0);
185104define('YAML_ANY_SCALAR_STYLE', 0);
185105define('YAML_BOOL_TAG', '');
185106define('YAML_CRLN_BREAK', 0);
185107define('YAML_CR_BREAK', 0);
185108define('YAML_DOUBLE_QUOTED_SCALAR_STYLE', 0);
185109define('YAML_FLOAT_TAG', '');
185110define('YAML_FOLDED_SCALAR_STYLE', 0);
185111define('YAML_INT_TAG', '');
185112define('YAML_LITERAL_SCALAR_STYLE', 0);
185113define('YAML_LN_BREAK', 0);
185114define('YAML_MAP_TAG', '');
185115define('YAML_NULL_TAG', '');
185116define('YAML_PHP_TAG', '');
185117define('YAML_PLAIN_SCALAR_STYLE', 0);
185118define('YAML_SEQ_TAG', '');
185119define('YAML_SINGLE_QUOTED_SCALAR_STYLE', 0);
185120define('YAML_STR_TAG', '');
185121define('YAML_TIMESTAMP_TAG', '');
185122define('YAML_UTF8_ENCODING', 0);
185123define('YAML_UTF16BE_ENCODING', 0);
185124define('YAML_UTF16LE_ENCODING', 0);
185125define('YAR_CLIENT_PROTOCOL_HTTP', 0);
185126define('YAR_ERR_EXCEPTION', 0);
185127define('YAR_ERR_OKEY', 0);
185128define('YAR_ERR_OUTPUT', 0);
185129define('YAR_ERR_PACKAGER', 0);
185130define('YAR_ERR_PROTOCOL', 0);
185131define('YAR_ERR_REQUEST', 0);
185132define('YAR_ERR_TRANSPORT', 0);
185133define('YAR_OPT_CONNECT_TIMEOUT', 0);
185134define('YAR_OPT_HEADER', 0);
185135define('YAR_OPT_PACKAGER', 0);
185136define('YAR_OPT_TIMEOUT', 0);
185137define('YAR_PACKAGER_JSON', '');
185138define('YAR_PACKAGER_PHP', '');
185139define('YAR_VERSION', '');
185140/**
185141 * Regex string for matching "yes" input.
185142 **/
185143define('YESEXPR', 0);
185144/**
185145 * Output string for "yes".
185146 **/
185147define('YESSTR', 0);
185148define('YPERR_ACCESS', 0);
185149define('YPERR_BADARGS', 0);
185150define('YPERR_BADDB', 0);
185151define('YPERR_BUSY', 0);
185152define('YPERR_DOMAIN', 0);
185153define('YPERR_KEY', 0);
185154define('YPERR_MAP', 0);
185155define('YPERR_NODOM', 0);
185156define('YPERR_NOMORE', 0);
185157define('YPERR_PMAP', 0);
185158define('YPERR_RESRC', 0);
185159define('YPERR_RPC', 0);
185160define('YPERR_VERS', 0);
185161define('YPERR_YPBIND', 0);
185162define('YPERR_YPERR', 0);
185163define('YPERR_YPSERV', 0);
185164define('ZEND_ACC_ABSTRACT', 0);
185165define('ZEND_ACC_CLASS', 0);
185166define('ZEND_ACC_FETCH', 0);
185167define('ZEND_ACC_FINAL', 0);
185168define('ZEND_ACC_INTERFACE', 0);
185169define('ZEND_ACC_PRIVATE', 0);
185170define('ZEND_ACC_PROTECTED', 0);
185171define('ZEND_ACC_PUBLIC', 0);
185172define('ZEND_ACC_STATIC', 0);
185173define('ZEND_ACC_TRAIT', 0);
185174define('ZEND_ADD_INTERFACE', 0);
185175define('ZEND_ADD_TRAIT', 0);
185176define('ZEND_EXIT', 0);
185177define('ZEND_FETCH_CLASS', 0);
185178define('ZEND_INSTANCEOF', 0);
185179define('ZEND_NEW', 0);
185180define('ZEND_THROW', 0);
185181define('ZEND_USER_OPCODE_CONTINUE', 0);
185182define('ZEND_USER_OPCODE_DISPATCH', 0);
185183define('ZEND_USER_OPCODE_DISPATCH_TO', 0);
185184define('ZEND_USER_OPCODE_ENTER', 0);
185185define('ZEND_USER_OPCODE_LEAVE', 0);
185186define('ZEND_USER_OPCODE_RETURN', 0);
185187define('ZLIB_BLOCK', 0);
185188define('ZLIB_DEFAULT_STRATEGY', 0);
185189define('ZLIB_ENCODING_DEFLATE', 0);
185190define('ZLIB_ENCODING_GZIP', 0);
185191define('ZLIB_ENCODING_RAW', 0);
185192define('ZLIB_FILTERED', 0);
185193define('ZLIB_FINISH', 0);
185194define('ZLIB_FIXED', 0);
185195define('ZLIB_FULL_FLUSH', 0);
185196define('ZLIB_HUFFMAN_ONLY', 0);
185197define('ZLIB_NO_FLUSH', 0);
185198define('ZLIB_PARTIAL_FLUSH', 0);
185199define('ZLIB_RLE', 0);
185200define('ZLIB_SYNC_FLUSH', 0);
185201define('__COMPILER_HALT_OFFSET__', 0);
185202